Query Multiple 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

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, go to the Activity Library, and open the Database Database icon tab.
      2. On the Database Database icon tab, drag the Query Multiple Query Multiple icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your 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 > E-mail 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:
Refer to:

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

Add Token Add Token icon

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

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

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

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

Sort 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