Auto-Lookup > Salesforce > Salesforce (SOQL) > Name/Value

This topic shows how to create a lookup with Salesforce as the data source and uses a SOQL query based on a name/value pair for the Auto-Lookup form control.

Background and Setup

Video: Build a Custom Search Screen

Examples

Good to Know

How to Start

  1. On the Auto-Lookup form control configuration screen, on the Configure tab, click Add Lookup.

    For information about how to open this screen, refer to Auto-Lookup form control.


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

    Select Salesforce
  3. Click Next.

Salesforce Type

Specifies the type of Salesforce lookup.

Figure: Salesforce Type screen

Salesforce Type screen

Good to Know

Fields

Field NameDefinition

Salesforce Type
Description:
Specifies the type of lookup to create.
Allowed Values:
  • Salesforce Lookup - Creates a Salesforce lookup with a SOQL query.
  • Salesforce Translation Workbench Lookup - Creates a lookup that uses Translation Workbench to specify languages you want to translate.
Default Value:
Salesforce Lookup

Lookup Details

Specifies the basic configuration for a lookup.

Figure: Lookup Details screen

Lookup Details screen

Good to Know

Fields

Field NameDefinition

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
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 Add New icon
Opens this Screen:
Access Token for Salesforce.
Function of this Screen:
Configure an access token to connect to Salesforce.
Example:
Refer to:

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 type of lookup procedure to do.
Allowed 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:

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
Description:
Specifies the name for your entity.
Allowed Values:
The name of your entity.
Default Value:
None
Example:
Refer to:

Name
Description:
The name of an item, such as a property or attribute in a name/value pair.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None

Value
Description:
The value for an item, such as the value for a process data variable in a key-value pair.
Allowed Values:
A valid object value.
Default Value:
None

Expand Expand icon

Function:
Shows the field list options.

Collapse Collapse icon

Function:
Closes the field list.

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

Operator
Description:
Specifies the operator to use in the filter.
To Open this Field:
  1. Click Add Filter Add Filter icon
Allowed Values:
  • =
  • !=
  • >
  • <
  • >=
  • <=
  • Is Null
  • Is Not Null
Default Value:
=
Limitations:

The Is Null and Is Not Null options are available in these releases:

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

Delete Filter Delete Filter icon

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.

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.
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}

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

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.