Single Select Lookup > AgilePoint NX Data Entities

This topic shows how to create a lookup with Data Entities as the data source for the Single Select Lookup form control.

Background and Setup

Prerequisites

Good to Know

  • 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

  1. On the Single Select Lookup form control configuration screen, on the Configure tab, click Add Lookup.

    For information about how to open this screen, refer to Single Select Lookup form control.


    Click Add Lookup
  2. On the Select Data Source Type screen, select Data Entities.

    Select Data Entities
  3. Click Next.

Lookup Details

Specifies the basic configuration for a lookup.

Figure: Lookup Details screen

Lookup Details screen

Fields

Field NameDefinition

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:

Lookup Type
Function:
Specifies the Name/Value type for the lookup procedure.

The Single Select Lookup form control does not support Multiple Columns lookups. If you select the Multiple Columns, the configuration screen shows Name/Value lookup type.

Accepted Values:
Read only.
Default Value:
Name/Value

Configure Lookup > Quick Config tab

Configures a lookup with the existing data format from your data source.

Figure: Configure Lookup > Quick Config tab

Quick Config tab

Fields

Field NameDefinition

Entity
Function:
Specifies the name for your entity.
Accepted Values:
The name of your entity.
Default Value:
None
Example:
Refer to:

Show Custom Entities
Function:
Specifies whether to show only custom entities in the Select Entity list.
Accepted Values:
  • Selected - Shows only custom entities in the Select Entity list.
  • Deselected - Shows only standard entities in the Select Entity list.
Default Value:
Deselected

Columns - Name
Function:
Specifies the name of an entity field in a key-value pair.
To Open this Field:
  1. On the Configure Lookup screen, in the Entity list, select an entity.
Accepted Values:
The name of your entity field.
Default Value:
None

Columns - Value
Function:
Specifies the value for an entity field in a key-value pair.
To Open this Field:
  1. On the Configure Lookup screen, in the Entity list, select an entity.
Accepted Values:
A valid object value.
Default Value:
None

Expand Expand icon

Function:
Shows the field list options.
To Open this Field:
  1. On the Configure Lookup screen, in the Entity list, select an entity.

Collapse Collapse icon

Function:
Closes the field list.
To Open this Field:
  1. On the Configure Lookup screen, in the Entity list, select an entity.

Add Filter Add Filter icon

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.

Select Nest Type
Function:
Specifies the AND and OR logical operators to filter the lookup.
To Open this Field:
  1. Click Add Filter Add Filter icon
Accepted Values:
  • AND - Specifies the AND operator.
  • OR - Specifies the OR operator.
Default Value:
And

Column Name
Function:
Specifies the name of the entity column.
To Open this Field:
  1. Click Add Filter Add Filter icon
Accepted Values:
A valid entity column name.
Default Value:
None

Operator
Function:
Specifies the operator to use in the filter.
To Open this Field:
  1. Click Add Filter Add Filter icon
Accepted Values:
  • !=
  • =
  • >
  • <
  • >=
  • <=
  • Like
  • Not Like
  • Contains
  • Does Not Contain
  • Begins With
  • Does Not Begin With
  • Ends With
  • Does Not End With
Default Value:
=
Limitations:

The Contains and Does not Contain filter operators are available in these releases:

Filter Condition - Value
Function:
Specifies the value for an entity field to use in filter.
To Open this Field:
  1. Click Add Filter Add Filter icon
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

Delete Filter Delete Filter icon

Function:
Deletes the filter condition.

Filter Condition - Sort By
Function:
Specifies the name of the column to sequence the query results.
Accepted Values:
The name of your list column.
Default Value:
None

Filter Condition - Sort Order
Function:
Specifies the sort order for the result set.
Accepted Values:
  • Ascending
  • Descending
Default Value:
Ascending

Configure Lookup > Advanced tab

Configures a WHERE clause for your query.

Figure: Configure Lookup > Advanced tab

Advanced tab

Fields

The fields on this tab are disabled. They will be available in a future release.

Configure Lookup > Error Messages tab

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

Figure: Configure Lookup > Error Messages tab

Error Messages tab

Fields

Field NameDefinition

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.