Auto-Lookup > OData Service > Name/Value

Access Token

Function:

Specifies the access token that connects to your data source.

Accepted Values:

A list of access tokens configured for your environment.

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.

Add New

Opens this Screen:

Access Token for OData

Function of this Screen:

Configure an access token to connect to an OData service.

Lookup Name

Function:

Specifies the name you want to give to your lookup procedure.

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Accepts Process Data Variables:

No

Example:

Refer to:

• (Example) How Do I Configure a Pop-Up Select Control to Bind the Lookup Values to a Data Grid?
• (Example) Configure an Auto-Lookup Form Control with Microsoft Excel

Lookup Type

Function:

Specifies the type of lookup procedure to do.

Accepted Values:

• Name/Value - The lookup gets data for specified name/value pairs.
• Multiple Columns - The lookup gets data for more than one column.

Default Value:

Name/Value

Example:

Refer to:

• (Example) How Do I Configure a Pop-Up Select Control to Bind the Lookup Values to a Data Grid?
• (Example) Configure an Auto-Lookup Form Control with Microsoft Excel

Entity

Function:

Specifies the name for your entity.

Accepted Values:

An entity name from the list.

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

Default Value:

None

Example:

Refer to:

• (Example) How Do I Configure a Pop-Up Select Control to Bind the Lookup Values to a Data Grid?

Configuration

Function:

Specifies the type of configuration.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.

Accepted Values:

• Quick Config - Configures the conditions to use in your query to filter the entity sets.
• Manual Setup - Specifies a query string to filter the entity sets.

Default Value:

Quick Config

Add Filter

Function:

Adds a row to configure a condition for the filter.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.

Expand

Function:

Shows the field list options.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.

Collapse

Function:

Closes the field list.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.

Column

Function:

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

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.
2. Click Add Filter

Accepted Values:

An entity property from the list.

When you select an entity from the Entity field, this field shows the entity property names associated with the entity.

Default Value:

None

Operator

Function:

Specifies the operator to use in the filter.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.
2. Click Add Filter

Accepted Values:

• =
• !=
• >
• >=
• <
• <=
• Contains
• Does Not Contain
• Starts With
• Ends With

Default Value:

=

Value

Function:

Specifies the value for the entity property to use in the filter.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.
2. Click Add Filter

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 AND and OR logical operators to filter the lookup.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.
2. Click Add Filter

Accepted Values:

• AND - Specifies the AND operator.
• OR - Specifies the OR operator.

Default Value:

And

Delete

Function:

Deletes the selected row.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.
2. Click Add Filter

Sort By

Function:

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

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.

Accepted Values:

An entity property from the list.

When you select an entity from the Entity field, this field shows the entity property names associated with the entity.

Default Value:

None

Order By

Function:

Specifies the sort order for the result set.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.

Accepted Values:

• Ascending - Sorts the entity sets in ascending order.
• Descending - Sorts the entity sets in descending order.

Default Value:

Ascending.

Top

Function:

Specifies to only retrieve the specified number of entity sets, starting with the first result.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.

Accepted Values:

A positive integer.

Default Value:

None

Skip

Function:

Specifies a number of entity sets from the first result not to retrieve.

To Open this Field:

1. On the Configure Lookup screen, in the Entity list, select an entity.

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. On the Configure Lookup screen, 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?

Entity

Function:

Specifies the name for your entity.

Accepted Values:

An entity name from the list.

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

Default Value:

None

Example:

Refer to:

• (Example) How Do I Configure a Pop-Up Select Control to Bind the Lookup Values to a Data Grid?

Store The Response In This Form Field / Map Response to App Schema

Function:

Specifies where to store the response from OData.

Accepted Values:

• Store The Response In This Form Field – Select this option if you expect OData to return only one data item.

  In the text field, specify a variable to store the data OData returns.

• Map Response to App Schema – Select this option if you expect OData to return more than one data item.

  Click the Schema Mapping button to open the Schema Mapper.

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

  Because the query can return more than one result, the parent node in the external data source must be mapped to a node in the AgilePoint NX process schema that is a repeating schema element. The child nodes in both data models must also be mapped, but child nodes in AgilePoint NX inherit the repeating behavior from their parent node

Default Value:

Map Response To App Schema

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?

Entity

Function:

Specifies the name for your entity.

Accepted Values:

An entity name from the list.

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

Default Value:

None

Example:

Refer to:

• (Example) How Do I Configure a Pop-Up Select Control to Bind the Lookup Values to a Data Grid?

No Items Retrieved

Function:

Specifies the error message to show if the lookup does not return any data.

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Lookup Failed

Function:

Specifies the message to show if the data fails to load.

Accepted Values:

More than one line of text.

Default Value:

Failed to load data.