OData Query Entity activity

An activity that queries an OData entity to retrieve an entity set.

Configure the OData Query Entity activity

To configure the OData Query Entity activity, do the procedure in this topic.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 or higher.

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?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Web Services tab.
On the Web Services tab, drag the OData Query Entity activity onto your process.

Procedure

Complete the fields on the General Configuration screen.
Click OData Query Entity Configuration .
Complete the fields on these screens:
For more information, refer to Get Entity Sets from OData.
(Optional) Click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the OData Query Entity activity.

Good to Know

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

Fields

Field Name	Definition
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

Field Name

Definition

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:

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

OData Query Entity Configuration > Query String Options tab

Configures the query to retrieve your entity sets from your OData service.

Fields

Field Name	Definition
OData Service	Description: Specifies the access token that connects to your OData service. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access Token for OData Function of this Screen: Configure an access token to connect to an OData service.
Entity	Description: Specifies the entity to query. When you select the access token, for your OData service, the name of entities show in this field. Allowed Values: An entity name from the list. Default Value: None
Configuration	Description: Specifies the type of configuration. Allowed Values: Quick Config - Uses the activity configuration UI to create the query to retrieve your entity sets. Manual Setup - Lets you specify an OData query string. Default Value: Quick Config Accepts Variables: No
Filter	Opens this Screen: OData Entity Sets Configuration > Create Conditions Function of this Screen: Configures the condition to use in your query to filter entity sets in OData. To Open this Field: Click Quick Config.
Order By	Description: Specifies the name of the entity property to make a sequence for the query results. To Open this Field: Click Quick Config. Allowed Values: An entity property from the list. Default Value: None Accepts Variables: Yes
Sort By	Description: Specifies the sort order for the result set. To Open this Field: Click Quick Config. Allowed Values: Ascending Descending Default Value: None
Top	Description: Specifies how many records to retrieve from the top of the entity result list. To Open this Field: Click Quick Config. Allowed Values: An integer. Range Greater than 0 Default Value: None
Skip	Description: Specifies how many records to ignore from the top of the entity results. To Open this Field: Click Quick Config. Allowed Values: An integer. Range Greater than 0 Default Value: None
Query String Parameter	Description: Specifies the query string to retrieve entity sets from OData. To Open this Field: Click Manual Setup. Allowed Values: One line of text (a string). Accepted: Letters Numbers Special characters Not Accepted: Spaces 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?

OData Query Entity Configuration > Create Conditions

Configures the condition to use in your query to filter entity sets in OData.

Fields

Field Name	Definition
Column	Description: Specifies the name of the entity property to use in your query. Allowed Values: A property from the list. Default Value: None. When you select the name of the entity from the Entity field, the list of properties shows in the Column field. 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?
Comparer	Description: Specifies the operator to use in your query. Allowed Values: = != >= > < <= Default Value: =
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?
Select Nest Type	Function: Specifies the use of operators to nest conditions to filter the entity sets. You must set the condition first, before you specify the nest type. To Open this Field: Click Add Row . Allowed Values: And - Specifies the logical AND operator. Or - Specifies the logical OR operator. Add - Addition. Sub - Subtraction. Mul - Multiplication. Div - Division. Mod - Modulo operation. Default Value: Or
Add Row	Function: Creates a condition row.
Indent Right	Function: Creates the statement that is a condition of a parent statement.
Delete	Function: Deletes the condition row.
Back	Function: Saves the rule and goes back to the activity configuration screen.

OData Query Entity Configuration > Response tab

Specifies how to store the information about entity sets in process data variables.

Fields

Field Name	Definition
OData Service	Description: Specifies the access token that connects to your OData service. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access Token for OData Function of this Screen: Configure an access token to connect to an OData service.
Entity	Description: Specifies the entity to query. When you select the access token, for your OData service, the name of entities show in this field. Allowed Values: An entity name from the list. Default Value: None
Map Response to AgilePoint Schema	Description: Maps information about entity sets from the OData data model to your process schema. Allowed Values: Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper
Store the Response in this Variable	Description: Specifies the process data variable that stores information about an entity set from the OData service. Allowed Values: A process data variable that accepts an alphanumeric string in JSON format. 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?