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.

Examples

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 the 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

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a Database activity..

  2. Click Query Multiple Query Multiple icon.
  3. Configure Query Multiple Record screen.

    For more information, refer to Get More Than One Record from a Database.

  4. (Optional) Click Advanced Advanced icon > Email Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Query Multiple activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data 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

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Database Type

Function:
Specifies the type of database to be used.
Accepted Values:
  • SQL Server
  • MySQL
  • Oracle
Default Value:
SQL Server

Connection Timeout (Seconds)

Function:
Specifies the number of seconds permitted to complete an action before the connection stops.
Accepted Values:
An integer, representing a number of seconds.
Default Value:
600
Accepts Process Data Variables:
No

Query Multiple Record

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

Figure: Query Multiple Record Configuration screen

Query Multiple Record screen

Fields

Field Name Definition

Database

Function:
Specifies the access token that connects to your database.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Token for Database
Function of this Screen:
Configure an access token to connect to a database..
Example:
Refer to:

Schema

Function:
Specifies your database schema.
Accepted 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

Function:
Specifies the name of the database table where this activity gets the records.
Accepted Values:
A valid database table name.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
Refer to:

Include Synonyms in the list Include Synonyms in the list icon

Function:
Specifies whether to show the synonyms that exist in the database in the Table Name list.
Accepted 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

Function:
Specifies whether to show the views that exist in the database in the Table Name list.
Accepted Values:
  • Selected - Shows the views in the Table Name list.
  • Deselected - Does not show the view in the Table Name list.
Default Value:
None

Query Mapping

Function:
Connects the query to your process schema.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

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

Default Value:
None
Accepts Process Data Variables:
No
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?

Where Condition

Function:
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.
Accepted Values:
A valid WHERE clause.

You can add more than one condition with AND operator.

Default Value:
None
Accepts Process Data 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

Function:
Specifies the name of the column to sequence the query results.
Accepted Values:
The name of your list column.
Default Value:
None
Accepts Process Data Variables:
No

Order By - Sort Order

Function:
Specifies the sort order for the result set.
Accepted Values:
  • Ascending
  • Descending
Default Value:
Ascending

Row Limit

Function:
Specifies the maximum number of rows to get with the WHERE clause.
Accepted Values:
Any integer up to 10,000.
Default Value:
Deselected
Accepts Process Data Variables:
No