Data Connections - Automate_Studio_Manager - Automate_Evolve

Table 1. Changes in this topic
Change type	Description
Added in version 25.2	Added how to create Precisely APIs data connection.

A data connection is a connection between your solution and an external data source such as a database, Reference Data, or Solution Data. You can use data connections to both query and submit data. There are two possible loading types for data connections.

You can create ("add") the following types of data connections:

For a workflow solution to query and/or submit data, you must first connect it to a data source.

Note: When using raw query option with Solution Data Library or Reference Data connections, provide the Query or Filter with brackets around the connection column name.

To create form fields for all types of data connections (except for Reference Data and EnterWorks data connections), Right click the data connection name and select Create Form Field.

To create form fields for Reference Data and EnterWorks data connections, select Create Field Mapping. Using this option enables you to use the Get/Save operation - to get or save the data via a form.

When using the Data Connection feature in the Form solution to download the data to Evolve Form, you can either,

Download the data on the user actions on the Form.
Download the data in the background using the Data connection Adapter plugin.

It is recommended to design a solution that does not download a high volume (more than 1000 records) of data to the form. Saving such a high volume of data to Form may cause high resource usage of RAM or CPU. This may impact other functions of the application causing slow response or delay in processing the jobs.

For example, Form fields the input parameter for the query should be set in a way that query never returns more than 1000 records. To do this, you can make the input parameter as mandatory. If you are using any REST API and if that API does support the max number of records to return for any query or filter (like OData API usually has count or $count parameters), such parameter should be set with some limit value (less than 1000) at design time of solution. So that if form’s end user unintentionally provides wrong filter or input, it shouldn’t return thousands of records.

Creating data connections:

To create data connections:

In data connections, use only those fields which have been used on the form. For example, for an LDAP data connection, if Manager fields are not on the form, do not use Manager columns as you create the data connection.
When creating data connections for a participant resolver, select async by unchecking the Automatically retrieve data when form is opened checkbox. If you use an LDAP data connection as a participant resolver, filter and create an async data connection and do not check the Manager field; this will result in stronger participant resolver performance.

Editing data connections:

Once a data connection has been added to a data connection library, you can only edit the data connection if it has not been used in a solution.

Create a SQL Server, OLEDB, or ODBC data connection

To create an SQL Server or OLEDB or ODBC data connection, first create a connection at the app (local) or global level.

Solution Designers creating data connections in a solution can see connections created at the global level and those created at the level of the app they are working with (the local level). For more information on how to create connections, see Create Database Connections.

To create an SQL Server or OLEDB or ODBC data connection:

Open User App.
Go to Solutions page.
Select the Solution and click Edit Solution. This will open Solution Designer / Composer.
Under Composer, on the ribbon, click the Solution Tab, and then click Add Data Connection.
Under Name, enter a descriptive name for the connection.
Under Type, click the drop-down arrow and select SQL Server or OLEDB or ODBC.
Select the connection from the connection drop-down list. All connections created at the global level and at the level of the app in which you’re creating a solution will be visible.
Under Table, click the drop-down arrow and select the table you want to access.
Under Columns, check the boxes for the column(s) you want to access.
Under Sort By, click Add Sort Fields. A field for sorting the values in the data connection will be added. You can sort on multiple fields.
Select the sorting order – ascending or descending.
Click OK.

Create a Reference Data data connection

To use Reference Data in a solution, first create a data connection. To create a Reference Data data connection, create a reference datalist in either the User app or the Reference Data app.

Solution Designers creating data connections in a solution can see all reference data lists created in the User app or in the Reference Data app (the local level). For more information on how to create reference data, see Reference Data.

To create a Reference Data data connection:

Open User App.
Go to Solutions page.
Select the Solution and click Edit Solution. This will open Solution Designer / Composer.
Under Composer, on the ribbon, click the Solution Tab, and then click Add Data Connection.
Under Name, enter a descriptive name for the connection.
Under Type, click the drop-down arrow and select Reference Data.
Select the Reference Data solution name. All reference data lists established at the global level and in the Reference Data app (the local level) will be visible.
Under Columns, check the boxes for the column(s) you want to access.
Under Sort By, click Add Sort Fields. A field for sorting the values in the data connection will be added. You can sort on multiple fields.
Select the sorting order – ascending or descending.
Click OK.

Note:

When reading reference data column names, Forms treat all special characters as the following character: '_'. Column names such as col-1 or col_1 can cause issues - so please create the reference data schema carefully.
While using comparison operators (like, greater than) in dropdown field filters and no default value is provided in Right Hand Side, then complete data from the data connection is returned. For "Number" type fields, a blank value is considered as 0 and filter results are displayed accordingly.
Functionality with data connection (PR, dropdown, Query) are not supported when opening the Form solution from task via operations page on admin app. The Form utilizes reference list defined at App level.

Create a Solution Data data connection

To use Solution Data in a solution, first create a data connection. To create a Solution Data data connection, create a Solution Data list at the app or global level.

Solution Designers creating data connections in a solution can see all solution data libraries created at the global level and at the level of the User app they are working with (the local level).

To create a Solution Data data connection:

Open User App.
Go to Solutions page.
Select the Solution and click Edit Solution. This will open Solution Designer / Composer.
Under Composer, on the ribbon, click the Solution Tab, and then click Add Data Connection.
Under Name, enter a descriptive name for the connection.
Under Type, click the drop arrow and select Solution Data.
Select the Solution Data library name. All solution data libraries established at the global level and within the app you are creating the solution in (the local level) will be visible.
Under Columns, check the boxes for the column(s) you want to access.
Under Sort By, click Add Sort Fields. A field for sorting the values in the data connection will be added. You can sort on multiple fields.
Select the sorting order – ascending or descending.
Click OK.

Create a Users From Group data connection

To create a solution that includes a specific group of users from a given app, use the Users From Group data connection. Solution Designers creating data connections in a solution can see all User Groups from the user app they are working with. For more information on creating user groups, see Manage Groups.

To create a Users From Group data connection:

Open User App.
Go to Solutions page.
Select the Solution and click Edit Solution. This will open Solution Designer / Composer.
Under Composer, on the ribbon, click the Solution Tab, and then click Add Data Connection.
Under Name, enter a descriptive name for the connection.
Under Type, click the drop-down arrow and select Users From Group.
Select the name of the group from the Group Name drop-down list. All User Groups in the user app (inside which the solution is being created) will be visible.
Under Columns, check the boxes for the column(s) you want to access.
Under Sort By, click Add Sort Fields. A field for sorting the values in the data connection will be added. You can sort on multiple fields.
Select the sorting order – ascending or descending.
Click OK.

Note:

In the Users From Group data connection (async mode), the filter does not work when populating data in a drop down.
When a User adds any invalid IDP group data connection and deploys the solution, an error is received at the run time.
The User should enter the valid group name to avoid the error.
If Users From Group type data connection is selected in Lookup Control , then Raw where clause will be disabled. This will impact upgraded solution, however, Search Criteria will still be editable.

Create an LDAP Query data connection

LDAP Query allows you to query your Active Directory structure and use that structure in your solution. Use the LDAP Query data connection to bring Active Directory users into your solution.

To create an LDAP Query data connection:

Open User App.
Go to Solutions page.
Select the Solution and click Edit Solution. This will open Solution Designer / Composer.
Under Composer, on the ribbon, click the Solution Tab, and then click Add Data Connection.
Under Name, enter a descriptive name for the connection.
Under Type, click the drop-down arrow and select LDAP Query.
Under Columns, check the boxes for the column(s) you want to access.
Under Sort By, click Add Sort Fields. A field for sorting the values in the data connection will be added. You can sort on multiple fields.
Select the sorting order – ascending or descending.
Click OK.

Create a SharePoint Library or List data connection

Note: We support SharePoint 2013 and SharePoint 2016 for use with a SharePoint Library or List data connection.

To create an SharePoint List or Librarydata connection:

Open User App.
Go to Solutions page.
Select the Solution and click Edit Solution. This will open Solution Designer / Composer.
Under Composer, on the ribbon, click the Solution Tab, and then click Add Data Connection.
Under Name, enter a descriptive name for the connection.
Under Type, click the drop-down arrow and select SharePoint Library or List.
Under Columns, check the boxes for the column(s) you want to access.
Under Sort By, click Add Sort Fields. A field for sorting the values in the data connection will be added. You can sort on multiple fields.
Select the sorting order – ascending or descending.
Click OK.

Create EnterWorks Repository data connection

Open User App.
Go to Solutions page.
Select the Solution and click Edit Solution. This will open Solution Designer / Composer.
Under Composer, on the ribbon, click the Solution Tab, and then click Add Data Connection.
Under Name, enter a descriptive name for the connection.
Under Type, click the drop-down arrow and select EnterWorks Repository.
Under Connection, select a database connection reference, of type EnterWorks.
Under Repository, select the desired repository from the repositories fetched by using above connection.
Under User Preference, select a preference from all the preferences defined on the above repository.
Under Saved Set, select and add a value.
Under Saved Search, select and add a value.
Under Columns, select attributes from the list of attributes available in repository. Only the attributes selected here become part of data set.
Click OK.

Note: While creating EnterWorks repository data connection, list of attributes available in repository contain only those attributes which are non repeating and do not belong to any associated group.

Create EnterWorks CodeSet data connection

Open User App.
Go to Solutions page.
Select the Solution and click Edit Solution. This will open Solution Designer / Composer.
Under Composer, on the ribbon, click the Solution Tab, and then click Add Data Connection.
Under Name, enter a descriptive name for the connection.
Under Type, click the drop-down arrow and select EnterWorks Code Set.
Under Connection, select a database connection reference, of type EnterWorks.
Under EnterWorks Code Set, select an available code set in EnterWorks.
Under Columns, select attributes from the list of attributes available in code set. Codeis the value of code set item and Description is the description of code set item.
Click OK.

Create REST API data Connection

Open User App.
Go to Solutions page.
Select the Solution and click Edit Solution. This will open Solution Designer / Composer.
Under Composer, on the ribbon, click the Solution Tab, and then click Add Data Connection.
Under Name, enter a descriptive name for the connection.
Under Type, click the drop-down arrow and select REST API.
Under Connection, select from available REST API connections.
API URL by default, shows the Base API URL, as defined while creating the Data Connection. Configure this URL as per requirement to get data from a specific end point.
Under HTTP operations, select a value as per current API connection usage. REST API uses HTTP Verb to specify the request type i.e. Read / Update / Delete or Create.
Under API Input Schema, click on Browse and provide JSON schema either from File or by directly copying to Text field. Input schema is of the data, that will be sent to API (i.e. Request payload in JSON).
Under API Output Schema, click on Browse and provide JSON schema either from File or by directly copying to Text field. Output schema is of the data that will be received from the API (i.e. Response payload in JSON).
Under API Error Schema, click on Browse and provide JSON schema either from ile or by directly coping to Text field.
Under Request Header, specify the expected request headers as per API specification in key value pair.
Under Response Header, Specify the expected response headers as per API specification in key value pair.
Click OK.

Note: While creating new REST API data connection, name of data connection is not auto-populated.

See REST API Data Connections for detailed information on data connections of type REST API. For examples of REST API integration, see Salesforce Integration and SAP S4 HANA integration.

Create Precisely APIs data connection

Open User App.
Go to Solutions page.
Select the Solution and click Add Solution. Add Solution window will be displayed.
Add Name to the Solution and click Add.
Click Data Connections button from Solution page options on top. OR
Right-click Data Connection folder from tree structure in the right navigation and then click Add Data Connection.
Under Name, enter a descriptive name for the connection.
Under Type, click the drop-down arrow and select Precisely APIs.
Under Connection, select from available Precisely API connections.
API URL is automatically populated using the values from the connection properties.
HTTP operation is automatically populated using the values from the connection properties.
Under API Input Schema field:
1. Browse: You can browse and select an alternative schema, which will replace the default schema.
2. View: You can view predefined default schema.
3. Clear: You can clear all schema in Browse and View (Only available for Edit)
Under API Output Schema field:
1. Browse: You can browse and select an alternative schema, which will replace the default schema.
2. View: You can view predefined default schema.
3. Clear: You can clear all schema in Browse and View (Only available for Edit)
Under API Error Schema field:
1. Browse: You can browse and select an alternative schema, which will replace the default schema.
2. View: You can view predefined default schema.
3. Clear: You can clear all schema in Browse and View (Only available for Edit)
Click OK. Data connection will be saved.

Note: The Precisely APIs will be consumed as REST API Data Connections.

Loading types

Data connections have two loading types. To select the loading type, use the Automatically retrieve data when the form is opened checkbox. If you check the checkbox, you set the loading type to synchronous; if you leave the checkbox unchecked, you set the loading type to asynchronous.

Asynchronous (async) loading allows the form to load faster in the browser because the data connection is not invoked until you implement a drop-down list (or similar element) which relies on the data connection. Note that async requires the full data set to be loaded and therefore does not work with elements that filter on the data connection.
Synchronous (sync) loading loads the data connections data set as part of the process by which the form loads into the browser – which may delay the launch of the form. However, properly indexed SQL Server tables can reduce the loading delay to a negligible amount of time.

If you know the entire data source will be used unfiltered, uncheck the Automatically load data when the form is opened checkbox.

Known Limitation

Column Name with restricted characters like 〆 , are not supported in Composer Data Connection of type SQL , ODBC,OLEDB .

There can be some more characters which can cause issue with Form XML generation are also not supported.

If any such data connection is added, then on form launch error will be thrown.

Precisely APIs

Precisely APIs do not support complex schemas when used with repeating tables.

Data Connections - Automate_Studio_Manager - Automate_Evolve - Latest

Automate Evolve User Guide