Skip to main content

Work with Queries

The Queries feature allows you to improve user experience and ensure accurate data entry. However, to enable the feature, set the following property in the ae.properties file: ae.feature.fetch-parameter-values-from-datasource.enabled = true

The Process Studio allows input fields to be filled with values fetched from a database using the feature Named Queries. In AEUI, you can create SQL queries that run during workflow execution to fetch real-time data from the database. Creating queries will avoid using credentials and database connection steps in workflows when you run queries with predefined data sources in AE. This removes the need for additional configurations, reduces security risks, and simplifies query execution. For example, query helps populate input fields with up-to-date values, such as branch names, city, or zone. You can use the following API to retrieve data from an external database for general purposes.

API #executeQuery
Request URL http://localhost:4200/aeengine/rest/v1/queries/City/execute
Request Method POST
Payload/Request Body
{
"queryParams": {
"division": {
"type": "VARCHAR",
"value": [
"KONKAN_DIV",
"PUNE_DIV"
]
}
}
}
Response: 
{
"columnTypes": {
"city_name": "VARCHAR",
"city_code": "VARCHAR"
},
"data": [
{
"city_name": "Solapur",
"city_code": "MH13"
},
{
"city_name": "Ratnagiri",
"city_code": "MH08"
}
]
}

The request body must be in JSON format and include a queryParams object. The object can contain multiple key–value pairs, where the keys are used as named parameters in the query, and the values specify the parameter data and its type.

To create a new Query:

  1. In the menu, click Reports → Queries. The Queries page appear.

alt text

Figure: Queries page

  1. Click New Query. The New Query dialog appears.

alt text

Figure: New Query dialog

  1. Enter the following details:
Field nameDescription
Query Name*Enter the name of the query you want to create.
Datasource Name*Select the data source from the list.
Type*Select the type of query from the list. Currently support is available for SQL only.
Query*Enter the SQL query to retrieve values for the input field. The query must follow the JDBC syntax and include named parameters using the :parameterName format.
For example: SELECT * FROM city WHERE zone_code =: zone.

* indicates mandatory field.

  1. Click Create. A Query created successfully message appears.
tip
  • You can avoid using credentials when running queries by configuring secure connection methods, such as predefined data sources. Selecting the data source eliminates the need to include usernames and passwords in the query, reducing security risks and simplifying query execution.
  • You can use the queries created through AEUI in the Workflow properties → Parameters tab of the Process Studio. For details, see the Create a workflow section in AutomationEdge Process Studio User’s Guide.
Last updated on