Query Multiple (Database) activity

An activity that executes a WHERE clause statements to get more than one record from a database.


Query Multiple activity

Configure the Query Multiple activity

To configure the Query Multiple activity, do the procedure in this topic.

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Database tab.

    Open Database tab
  3. On the Database tab, drag the Query Multiple activity onto your process.

    Drag Query Multiple activity

General Configuration

Specifies the basic settings for the Query Multiple activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field NameDefinition

Display Name
Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description
Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Database Type
Description:
Specifies the type of database to be used.
Allowed Values:
  • SQL Server
  • MySQL
  • Oracle
Default Value:
SQL Server

Connection Timeout (Seconds)
Description:
Specifies the number of seconds permitted to complete an action before the connection stops.
Allowed Values:
An integer.

Represents

  • A number of seconds
Default Value:
600
Accepts Variables:
No

Query Multiple Record Configuration > Quick Config tab

Specifies where and how the data is retrieved from the database with a WHERE clause.

Figure: Query Multiple Record Configuration > Quick Config tab

Query Multiple Record Configuration Quick Config tab

Fields

Field NameDefinition

Database
Description:
Specifies the access token that connects to your database.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon
Opens this Screen:
Access Token for Database
Function of this Screen:
Configure an access token to connect to a database..

Schema
Description:
Specifies your database schema.
Allowed Values:
A schema name from the list.

When you select a database, the schemas associated with the database show in this field.

Default Value:
None

Table Name
Description:
Specifies the name of the database table where this activity gets the records.
Allowed Values:
A valid database table name.
Default Value:
None
Accepts Variables:
Yes

Include Synonyms in the list Include Synonyms in the list icon
Description:
Specifies whether to show the synonyms that exist in the database in the Table Name list.
Allowed Values:
  • Selected - Shows the synonyms in the Table Name list.
  • Deselected - Does not show the synonyms in the Table Name list.
Default Value:
None

Include Views in the list Include Views in the list icon
Description:
Specifies whether to show the views that exist in the database in the Table Name list.
Allowed Values:
  • Selected - Shows the views in the Table Name list.
  • Deselected - Does not show the view in the Table Name list.
Default Value:
None

Where Condition
Description:
Shows the code snippet for the WHERE clause to search for the records in the database. The WHERE clause is specified using the conditions and logical operators.
Allowed Values:
A valid WHERE clause.

You can add more than one condition with AND operator.

Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Order By
Description:
Specifies the name of the column to sequence the query results.
Allowed Values:
The name of your list column.
Default Value:
None
Accepts Variables:
No

Sort By
Description:
Specifies the sort order for the result set.
Allowed Values:
  • Ascending
  • Descending
Default Value:
Ascending

Row Limit
Description:
Specifies the maximum number of rows to get with the WHERE clause.
Allowed Values:
Any integer up to 10,000.
Default Value:
Deselected
Accepts Variables:
No

Query Mapping
Description:
Connects the query to your process schema.
Allowed Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

Use this screen to connect the query to your process schema.

Default Value:
None
Accepts Variables:
No
Example:
Refer to:

Query Multiple Record Configuration > Manual Config tab

Specifies the SQL WHERE clause to retrieve one or more records from database.

Figure: Query Multiple Record Configuration > Manual Config tab

Query Multiple Record Configuration Manual Config tab

Fields

Field NameDefinition

Database
Description:
Specifies the access token that connects to your database.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon
Opens this Screen:
Access Token for Database
Function of this Screen:
Configure an access token to connect to a database..

Manual Query
Description:
Specifies the SQL WHERE clause to retrieve one or more records from the database.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Special characters

Not Accepted:

  • Spaces
Default Value:
None
Accepts Variables:
Yes
Limitations:

This field is available in these releases:

Execute Query
Function:
Makes sure the query is correct, and shows the necessary error message if an error occurs.

If the query runs successfully, the result shows in the box.

Query Mapping
Description:
Connects the query to your process schema.
Allowed Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

Use this screen to connect the query to your process schema.

Default Value:
None
Accepts Variables:
No
Example:
Refer to: