Single Select Lookup > Database

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

Background and Setup

Prerequisites

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

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

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.
On the Select Data Source Type screen, select Database.
Click Next.

Lookup Details

Specifies the basic configuration for a lookup.

Fields

Field Name	Definition
Access Token	Description: Specifies the access token that connects to your data source. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No
Add New	Opens this Screen: Access Token for Database Function of this Screen: Configure an access token to connect to a database.
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: (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	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.

Fields

Field Name	Definition
Schema	Description: Specifies your database schema. Allowed Values: A schema name from the list. When you select a database, the schemas associated with the database show in this field. Default Value: None
Table	Description: Specifies the name of the your database table. Allowed Values: The name of your table. When you select a schema, the tables associated with the database show in this field. Default Value: None
Columns - Name	Description: Specifies the column name of the database table in a key-value pair. To Open this Field: Select a table from the Table list. Allowed Values: A column name from the list. When you select a database table, the columns and its values associated with the database table show in this field. Default Value: None
Columns - Value	Description: Specifies the value for a database column in a key-value pair. To Open this Field: Select a table from the Table list. Allowed Values: A column value from the list. When you select a database table, the columns and its values associated with the database table show in this field. Default Value: None
Column Name	Description: Specifies the name of the database column. To Open this Field: Click Add Filter Allowed Values: A valid database column name. Default Value: None
Operator	Description: Specifies the operator to use in the filter. To Open this Field: Click Add Filter Allowed Values: = != > < In Is Null Is Not Null Default Value: = Limitations: The In operator is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 2 or higher The Is Null and Is Not Null options are available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v8.0 Software Update 2 or higher
Filter Condition - Value	Description: Specifies one or more values for the column or process data variables that contains the column value. To Open this Field: Click Add Filter Allowed Values: One or more column values. Default Value: None Accepts Variables: Yes Limitations: The option to use more than one value is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 2 or higher
Delete Filter	Function: Deletes the filter condition.
Filter Condition - Sort By	Description: Specifies the name of the column to sequence the query results. Allowed Values: The name of your list column. Default Value: None
Filter Condition - Sort Order	Description: Specifies the sort order for the result set. Allowed Values: Ascending Descending Default Value: Ascending

Configure Lookup > Advanced tab

Configures a WHERE clause for your query.

Fields

Field Name	Definition
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: Selected Example: SELECT [Account Owner] "Name", [Account Number] "Value" FROM Account SELECT PositionCode, FirstName, LastName, Email, City, StateCode, ZipCode FROM [appApplicants] WHERE PositionCode = ${PositionCode} Limitations: AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 or higher.
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.

Fields

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