Query Multiple Records (Data Entities) activity

An activity that gets more than one record from an AgilePoint NX entity.


Query Multiple Records activity

Configure the Query Multiple Records activity

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

Prerequisites

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 Data Entities tab.

    AgilePoint Data Entities tab
  3. On the Data Entities tab, drag the Query Multiple Records activity onto your process.

    Query Multiple Records activity

General Configuration

Specifies the basic settings for the Query Multiple Records activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

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

Query Multiple Records Configuration > Where tab

Shows the code snippet that is generated from the Query Multiple Records Configuration > Create Conditions tab.

Figure: Query Multiple Records Configuration > Where tab

Query Multiple Records Configuration Where tab

Fields

Field NameDefinition

Entity
Description:
Specifies the name for your entity from the list.
Allowed Values:
An entity name from the list.
Default Value:
None
Example:
Refer to:

Standard Entities / Custom Entities
Description:
Specifies whether to show standard (out-of-the-box) entities or custom entities in the Entity Name list.
Allowed Values:
  • Standard Entities - Shows standard (out-of-the-box) entities in the Entity Name list.
  • Custom Entities - Shows custom entities in the Entity Name list.
Default Value:
Standard Entities

Sort By
Description:
Specifies the entity field to sequence how the records show on the query result.
Allowed Values:
An entity field from the list.

When you select the entity in the Entity field, this field shows the field names associated with the entity.

Default Value:
None
Limitations:
This field is available in these releases:

Order By
Description:
Specifies the sort order for the records.
Allowed Values:
  • Ascending - Sorts the records in ascending order.
  • Descending - Sorts the records in descending order.
Default Value:
None
Limitations:
This field is available in these releases:

Row Limit
Description:
Specifies the maximum number of records to retrieve from Data Entities.
Allowed Values:
An integer.

Range

  • 1-10000
Default Value:
10,000
Limitations:
This field is available in these releases:

Code Snippet
Description:
Shows the SQL code snippet that is created when you configure the filter condition for your query.
Allowed Values:
Read only.
Default Value:
None

Create Create icon

Opens this Screen:
Query Multiple Records Configuration > Create Conditions
Function of this Screen:
Configures the condition to use in your query to filter records

Delete Delete icon

Function:
Deletes the query from the code snippet.

Edit Edit icon

Function:
Lets you change the query.

Query Multiple Records Configuration > Create Conditions

Configures the condition to use in your query to filter records.

Figure: Query Multiple Records Configuration > Create Conditions screen

Query Multiple Records Configuration Create Conditions screen

Fields

Field NameDefinition

Add expression Add Expression icon

Function:
Creates a condition row.
Limitations:

This field is available in these releases:

Add group Add Group icon

Function:
Creates a new conditional expression group.
Limitations:

This field is available in these releases:

Delete Delete icon

Function:
Deletes the condition row.

Select Nest Type
Function:
Specifies the use of logical AND and OR operators to nest conditions to filter the record.

You must set the condition first, before you specify the nest type.

Allowed Values:
  • And - Specifies the logical AND operator.
  • Or - Specifies the logical OR operator.
Default Value:
Or

Column
Description:
Specifies the name of the AgilePoint NX entity field to use in your query.
Allowed Values:
A field from the list
Default Value:
None.

On the Query Multiple Records Configuration > Where tab, when you select the name of the entity from Entity Name field, the list of entity field associated with the selected entity shows in Column field.

Comparer
Description:
Specifies the operator to use in your query.
Allowed Values:
  • Equal
  • NotEqual
  • GreaterThan
  • LessThan
  • GreaterEqual
  • LessEqual
  • Like
  • NotLike
  • In
  • NotIn
  • Between
  • NotBetween
  • Null
  • NotNull
  • Yesterday
  • Today
  • Tomorrow
  • Last7Days
  • Next7Days
  • LastWeek
  • ThisWeek
  • NextWeek
  • LastMonth
  • ThisMonth
  • NextMonth
  • On
Default Value:
Equal

Value
Description:
Specifies the value for the column.
Allowed Values:
A valid column value.
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?

Data Type
Description:
Specifies the data type for your column.
Allowed Values:
  • String
  • Number
  • Boolean
Default Value:
String
Limitations:

This field is available in these releases:

Back Back icon

Function:
Saves the rule and goes back to the activity configuration screen.

Query Multiple Records Configuration > Response tab

Maps response data from an AgilePoint NX entity fields to your process schema.

Figure: Query Multiple Records Configuration > Response tab

Query Multiple Records Configuration Response tab

Fields

Field NameDefinition

Entity
Description:
Specifies the name for your entity from the list.
Allowed Values:
An entity name from the list.
Default Value:
None
Example:
Refer to:

Standard Entities / Custom Entities
Description:
Specifies whether to show standard (out-of-the-box) entities or custom entities in the Entity Name list.
Allowed Values:
  • Standard Entities - Shows standard (out-of-the-box) entities in the Entity Name list.
  • Custom Entities - Shows custom entities in the Entity Name list.
Default Value:
Standard Entities

Sort By
Description:
Specifies the entity field to sequence how the records show on the query result.
Allowed Values:
An entity field from the list.

When you select the entity in the Entity field, this field shows the field names associated with the entity.

Default Value:
None
Limitations:
This field is available in these releases:

Order By
Description:
Specifies the sort order for the records.
Allowed Values:
  • Ascending - Sorts the records in ascending order.
  • Descending - Sorts the records in descending order.
Default Value:
None
Limitations:
This field is available in these releases:

Row Limit
Description:
Specifies the maximum number of records to retrieve from Data Entities.
Allowed Values:
An integer.

Range

  • 1-10000
Default Value:
10,000
Limitations:
This field is available in these releases:

Map Response to AgilePoint Schema
Description:
Maps AgilePoint NX entity fields 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 response to the data model for your process.

Default Value:
None
Example:
Refer to: