Query Records (MS Dynamics 365) activity

An activity that uses a SQL WHERE clause to query one or more entity records in Microsoft Dynamics 365.


Query Records activity

Configure the Query Records activity

To configure the Query Records 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 Process Builder, in the Activity Library, open the MS Dynamics 365 tab.

    Open MS Dynamics 365 tab
  3. On the MS Dynamics 365 tab, drag the Query Records activity onto your process.

    Drag Query Records activity

General Configuration

Specifies the basic settings for the Query Records 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

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 Records Configuration > Columns tab

Specifies the entity columns to query.

Figure: Query Records Configuration > Column tab

Query Records Configuration Column tab

Fields

Field NameDefinition

MS Dynamics 365
Description:
Specifies the access token that connects to your Microsoft Dynamics 365 application.
Allowed 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 Dynamics 365
Function of this Screen:
Configure an access token to connect to Microsoft Dynamics 365.
Example:
Refer to:

Entity Name
Description:
Specifies the name for your entity.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

When you select the Microsoft Dynamics 365 access token, the name of the entity shows in the Entity Name field.

Accepts Variables:
No

Entity Column Fields
Description:
Shows all the columns for the entity specified in the Entity Name field.
Allowed Values:
The list of columns for your entity.
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?

Configured Column Field
Description:
Specifies the columns from the entity to use in your query.
Allowed Values:
A list of columns moved from the Entity Column Fields list.

Use the left and right arrow buttons to add and remove columns in this list.

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?

Left Arrow Left Arrow icon

Function:
Moves the selected fields from the Configured Column Fields box to the Entity Column Fields box.

Right Arrow Right Arrow icon

Function:
Moves the selected fields from the Entity Column Fields box to the Configured Column Fields box.

Query Records Configuration > Where tab

Configures a SQL where clause to filter the results of a query It gets only the records that obey the rules in the WHERE clause.

Figure: Query Records Configuration > Where tab

Query Records Configuration Where tab

Fields

Field NameDefinition

MS Dynamics 365
Description:
Specifies the access token that connects to your Microsoft Dynamics 365 application.
Allowed 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 Dynamics 365
Function of this Screen:
Configure an access token to connect to Microsoft Dynamics 365.
Example:
Refer to:

Entity Name
Description:
Specifies the name for your entity.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

When you select the Microsoft Dynamics 365 access token, the name of the entity shows in the Entity Name field.

Accepts Variables:
No

Where Clause Code Snippet Box
Description:
Shows the code snippet for the Where clause AgilePoint creates when you click Save Query. The WHERE clause is specified using the conditions and logical operators.
Allowed Values:
A valid SQL code snippet.

You can change the code in the code snippet box.

Default Value:
The SQL code AgilePoint creates for the WHERE clause.

Column
Description:
Specifies an entity column to use in your query.
Allowed 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
Description:
Specifies the operator to use in your WHERE clause.
Allowed Values:
  • Like
  • Contains
  • DoesNotContain
  • Equal
  • NotEqual
  • BeginsWith
  • DoesNotBeginWith
  • EndsWith
  • DoesNotEndWith
Default Value:
Like

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?

Save Query
Function:
Saves the code snippet for the Where clause, and shows the code snippet in box.

Query Records Configuration > Output Mapping tab

Maps the columns of the query response to the schema for your process.

Figure: Query Records Configuration > Output Mapping tab

Query Records Configuration Output Mapping tab

Fields

Field NameDefinition

MS Dynamics 365
Description:
Specifies the access token that connects to your Microsoft Dynamics 365 application.
Allowed 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 Dynamics 365
Function of this Screen:
Configure an access token to connect to Microsoft Dynamics 365.
Example:
Refer to:

Entity Name
Description:
Specifies the name for your entity.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

When you select the Microsoft Dynamics 365 access token, the name of the entity shows in the Entity Name field.

Accepts Variables:
No

Map Response to AgilePoint Schema
Description:
Specifies the connection from the Microsoft Dynamics 365 API response parameter 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:

Query Records Configuration > Test tab

Makes sure your query is valid for Microsoft Dynamics 365.

Figure: Query Records Configuration > Test tab

Query Records Configuration Test tab

Fields

Field NameDefinition

MS Dynamics 365
Description:
Specifies the access token that connects to your Microsoft Dynamics 365 application.
Allowed 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 Dynamics 365
Function of this Screen:
Configure an access token to connect to Microsoft Dynamics 365.
Example:
Refer to:

Entity Name
Description:
Specifies the name for your entity.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

When you select the Microsoft Dynamics 365 access token, the name of the entity shows in the Entity Name field.

Accepts Variables:
No

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.