Query Multiple Records (Microsoft Dataverse) activity

An activity that retrieves one or more records from a Microsoft Dataverse entity.


Query Multiple Records activity

Configure the Query Multiple Records activity

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

Examples

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 the Process Builder, in the Activity Library, open the Microsoft Dataverse tab.

    Open Common Data Service tab
  3. On the Microsoft Dataverse tab, drag the Query Multiple Records activity onto your process.

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

Query Multiple Records Configuration > Filter Options tab

Specifies a filter condition to retrieve one or more records from a Microsoft Dataverse entity.

Figure: Query Multiple Records Configuration > Filter Options tab

Query Multiple Records Configuration Filter Options tab

Fields

Field Name Definition

Microsoft Dataverse

Function:
Specifies the access token that connects to your Microsoft Dataverse.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Dataverse
Function of this Screen:
Configure an access token to connect to Microsoft Dataverse.
Example:
Refer to:

Entity

Function:
Specifies the name of an entity from which to retrieve records.
Accepted Values:
An entity name from the list.

When you select the access token from the Microsoft Dataverse field, this field shows the entity names associated with the access token.

Default Value:
None
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?

Configuration

Function:
Specifies the type of configuration.
Accepted Values:
  • Quick Config - Configures the conditions to use in your query to filter records.
  • Manual Query - Specifies the query string to filter the records.
Default Value:
Quick Config

Code Snippet

Function:
Shows the code snippet that is created from your query.
Accepted 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.

Edit Edit icon

Function:
Lets you change the query.

Query String Parameter

Function:
Specifies the query string to retrieve one or more records from a Microsoft Dataverse entity.
To Open this Field:
  1. Click Manual Query.
Accepted Values:
A text string that can have special charaters with no spaces.
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?

Query Multiple Records Configuration > Create Conditions

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

Figure: Query Multiple Records Configuration > Create Conditions

Query Multiple Records Configuration Create Conditions

Fields

Field Name Definition

Add expression Add Expression icon

Function:
Creates a condition row.

Add group Add Group icon

Function:
Creates a new conditional expression group.

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.

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

Column

Function:
Specifies an entity column to use in your query.
Accepted Values:
An entity column name from the list.
Default Value:
None.

When you select the name of the entity, the list of columns shows in Column field.

Comparer

Function:
Specifies the operator to use in your query.
Accepted Values:
  • =
  • >
  • >=
  • <
  • <=
  • !=
  • Contains
  • DoesNotContain
  • EndsWith
  • StartsWith
Default Value:
=

Value

Function:
Specifies the value for the column.
Accepted Values:
A valid column value.
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?

Data Type

Function:
Specifies the data type for your column.
Accepted Values:
  • String
  • Number
  • Boolean
Default Value:
String

Back Back icon

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

Query Multiple Records Configuration > Response tab

Specifies how to store the information about one or more records in a process data variable.

Figure: Query Multiple Records Configuration > Response tab

Query Multiple Records Configuration Response tab

Fields

Field Name Definition

Microsoft Dataverse

Function:
Specifies the access token that connects to your Microsoft Dataverse.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Dataverse
Function of this Screen:
Configure an access token to connect to Microsoft Dataverse.
Example:
Refer to:

Entity

Function:
Specifies the name of an entity from which to retrieve records.
Accepted Values:
An entity name from the list.

When you select the access token from the Microsoft Dataverse field, this field shows the entity names associated with the access token.

Default Value:
None
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?

Store the Response in This Variable / Map Response to Application Schema

Function:
Specifies where to store the response from Microsoft Dataverse.
Accepted Values:
  • Store the Response in This VariableSelect this option if you expect Commom Data Service to return only one data item.

    In the text field, specify a variable to store the data Commom Data Service returns.

  • Map Response to Application SchemaSelect this option if you expect Commom Data Service to return more than one data item.

    Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

    Use this screen to connect the response to the data model for your process.

Default Value:
Map Response to Application Schema
Accepts Process Data Variables:
  • If you select Store the Response in This Variable, you must enter a variable.
  • If you select Map Response to Application Schema, this does not apply.
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?