OData Query Entity activity

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

OData Service

Function:

Specifies the access token that connects to your OData service.

Accepted 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

Function:

Specifies the entity to query.

When you select the access token, for your OData service, the name of entities show in this field.

Accepted Values:

An entity name from the list.

Default Value:

None

Configuration

Function:

Specifies the type of configuration.

Accepted 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 Process Data 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:

1. Click Quick Config.

Order By

Function:

Specifies the name of the entity property to make a sequence for the query results.

To Open this Field:

1. Click Quick Config.

Accepted Values:

An entity property from the list.

Default Value:

None

Accepts Process Data Variables:

Yes

Sort By

Function:

Specifies the sort order for the result set.

To Open this Field:

1. Click Quick Config.

Accepted Values:

• Ascending
• Descending

Default Value:

None

Top

Function:

Specifies how many records to retrieve from the top of the entity result list.

To Open this Field:

1. Click Quick Config.

Accepted Values:

A positive integer.

Default Value:

None

Skip

Function:

Specifies how many records to ignore from the top of the entity results.

To Open this Field:

1. Click Quick Config.

Accepted Values:

A positive integer.

Default Value:

None

Query String Parameter

Function:

Specifies the query string to retrieve entity sets from OData.

To Open this Field:

1. Click Manual Setup.

Accepted Values:

One line of text (a 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?

Column

Function:

Specifies the name of the entity property to use in your query.

Accepted 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

Function:

Specifies the operator to use in your query.

Accepted Values:

• =
• !=
• >=
• >
• <
• <=

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?

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:

1. Click Add Row .

Accepted 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 your rule and goes back to the activity configuration screen.

OData Service

Function:

Specifies the access token that connects to your OData service.

Accepted 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

Function:

Specifies the entity to query.

When you select the access token, for your OData service, the name of entities show in this field.

Accepted Values:

An entity name from the list.

Default Value:

None

Map Response to AgilePoint Schema

Function:

Maps information about entity sets from the OData data model to your process schema.

Accepted 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

Function:

Specifies the process data variable that stores information about an entity set from the OData service.

Accepted Values:

A process data variable that accepts an alphanumeric string in JSON format.

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?