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
Description:
Specifies the name you want to give to your lookup procedure.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
Refer to:

Lookup Type
Description:
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.

Allowed 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

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

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

Data Mapping - Name
Description:
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.
Allowed Values:
The name of your entity field.
Default Value:
None

Data Mapping - Value
Description:
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.
Allowed Values:
A valid object value.
Default Value:
None

Add expression Add Expression icon

Function:
Creates a condition row.
To Open this Field:
  1. On the Configure Lookup screen, in the Entity list, select an entity.
Limitations:

This field is available in these releases:

Add group Add Group icon

Function:
Creates a new conditional expression group.
To Open this Field:
  1. On the Configure Lookup screen, in the Entity list, select an entity.
Limitations:

This field is available in these releases:

Select Nest Type
Description:
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.
Allowed Values:
  • AND - Specifies the AND operator.
  • OR - Specifies the OR operator.
Default Value:
And

Column Name
Description:
Specifies the name of the entity column.
To Open this Field:
  1. On the Configure Lookup screen, in the Entity list, select an entity.
  2. Click Add expression Add Expression icon.
Allowed Values:
A column name from the list.
Default Value:
None

Operator
Description:
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 expression Add Expression icon.
Allowed Values:
  • !=
  • =
  • >
  • <
  • >=
  • <=
  • Like
  • Not Like
  • Contains
  • Does Not Contain
  • Begins with
  • Does Not Begin With
  • Ends With
  • Does Not End With
  • In
  • Is Null
  • Is Not Null
Default Value:
=
Limitations:

Value
Description:
Specifies the value for an entity field to use in filter.
To Open this Field:
  1. On the Configure Lookup screen, in the Entity list, select an entity.
  2. Click Add expression Add Expression icon.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes

Delete Delete icon

Function:
Deletes the condition row.
To Open this Field:
  1. On the Configure Lookup screen, in the Entity list, select an entity.
  2. Click Add expression Add Expression icon.

Sort By
Description:
Specifies the name of the column to sequence the query results.
To Open this Field:
  1. On the Configure Lookup screen, in the Entity list, select an entity.
Allowed Values:
A column name from the list.
Default Value:
None

Sort Order
Description:
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.
Allowed 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

Field NameDefinition

Query
Description:
Specifies the WHERE clause for your query with the conditions and logical operators
Allowed Values:
  • A valid SQL WHERE clause.
  • A valid stored procedure.
  • A valid SQL view.
Default Value:
None
Example:
  • SELECT [Account Owner] "Name", [Account Number] "Value" FROM Account
  • SELECT PositionCode, FirstName, LastName, Email, City, StateCode, ZipCode FROM [appApplicants] WHERE PositionCode = ${PositionCode}

Perform SQL Query Escaping
Description:
Specifies whether the query condition value escapes the apostrophe (') character.
Allowed Values:
  • Selected - Apostrophe (') characters are escaped in your query condition value.
  • Deselected - The query condition value does not escape apostrophe (') characters.
Default Value:
Deselected
Example:
  • SELECT [Account Owner] "Name", [Account Number] "Value" FROM Account
  • SELECT PositionCode, FirstName, LastName, Email, City, StateCode, ZipCode FROM [appApplicants] WHERE PositionCode = ${PositionCode}

Validate Query
Function:
Does a test to make sure the query is correct, and displays the error message if an error occurs.

Result
Function:
Shows the result of the WHERE clause query.

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
Description:
Specifies the error message to show if the lookup does not return any data.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

Lookup Failed
Description:
Specifies the message to show if the data fails to load.
Allowed Values:
More than one line of text.
Default Value:
Failed to load data.