Query Entity (Salesforce) activity

An activity that uses SQL to make a query to an entity for Salesforce.


Query Entity activity

Configure the Query Entity activity

To configure the Query Entity activity, do the procedure in this topic.

Video: Salesforce Query and Second Form

Examples

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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 Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Salesforce Salesforce icon tab.
      2. On the Salesforce Salesforce icon tab, drag the Query Entity (Salesforce) Query Entity icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a CRM Activity.

  2. Click Query Entity Query Entity icon.
  3. Complete the fields on these screens.
    1. Salesforce Query Entity Configuration > Column tab.
    2. Salesforce Query Entity Configuration > Where tab.
    3. Salesforce Query Entity Configuration > Output Mapping tab.
    4. Salesforce Query Entity Configuration > Test tab.

    For more information, refer to Get Records from Salesforce Using a SQL Query.

  4. (Optional) Click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Query Entity activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name
Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
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.

Description
Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Connection Timeout (Seconds)
Function:
Specifies the number of seconds permitted to complete an action before the connection stops.
Accepted Values:
An integer, representing a number of seconds.
Default Value:
600
Accepts Process Data Variables:
No

Salesforce Query Entity Configuration > Columns tab

Specifies the entity columns to query.

Figure: Salesforce Query Entity Configuration > Column tab

Salesforce Query Entity Configuration Column tab

Fields

Field Name Definition

Salesforce
Function:
Specifies the access token that connects to your Salesforce application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Add Token Add Token icon
Opens this Screen:
Access Token for Salesforce
Function of this Screen:
Configure an access token to connect to Salesforce.
Example:
Refer to:

Entity Name
Function:
Specifies the name for your entity.
Accepted Values:
An entity name from the list.
Default Value:
None

When you select the Salesforce access token, the name that shows in the Entity Name field.

Accepts Process Data Variables:
No
Example:
Refer to:

Entity Column Fields
Function:
Shows all the columns for the entity specified in the Entity Name field.
Accepted Values:
The list of columns for your entity.
Default Value:
None
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?

Configured Column Field
Function:
Specifies the columns from the entity to use in your query.
Accepted Values:
A list of columns moved from the Entity Column Fields list.

Use the left and right arrow buttons to add and remove columns in this list.

Default Value:
None
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?

Left Arrow Left Arrow icon

Function:
Moves the selected fields from the Configured Column Fields box to the Entity Column Fields box.

Right Arrow Right Arrow icon

Function:
Moves the selected fields from the Entity Column Fields box to the Configured Column Fields box.
Example:
Refer to:

Salesforce Query Entity Configuration > Where tab

Configures a SQL where clause to filter the results of a query in Salesforce. It gets only the records that obey the rules in the WHERE clause.

Figure: Salesforce Query Entity Configuration > Where tab

Salesforce Query Entity Configuration Where tab

Fields

Field Name Definition

Salesforce
Function:
Specifies the access token that connects to your Salesforce application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Add Token Add Token icon
Opens this Screen:
Access Token for Salesforce
Function of this Screen:
Configure an access token to connect to Salesforce.
Example:
Refer to:

Entity Name
Function:
Specifies the name for your entity.
Accepted Values:
An entity name from the list.
Default Value:
None

When you select the Salesforce access token, the name that shows in the Entity Name field.

Accepts Process Data Variables:
No

Where Clause Code Snippet Box
Function:
Shows the code snippet for the Where clause AgilePoint creates when you click Save Query. The WHERE clause is specified using the conditions and logical operators.
Accepted Values:
A valid SQL code snippet.

You can change the code in the code snippet box.

Default Value:
The SQL code AgilePoint creates for the WHERE clause.

Column
Function:
Specifies an entity column to use in your query.
Accepted Values:
A valid entity column shown in the list.
Default Value:
None.

When you select the name of the entity, the list of columns shows in Column field.

Example:
Refer to:

Comparer
Function:
Specifies the operator to use in your WHERE clause.
Accepted Values:
  • =
  • >=
  • >
  • <
  • <=
  • !=
  • Like
  • Not in
Default Value:
=
Example:
Refer to:

Value
Function:
Specifies the value for the column.
Accepted Values:
A valid column value.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?

Save Query
Function:
Saves the code snippet for the Where clause, and shows the code snippet in box.
Example:
Refer to:

Salesforce Query Entity Configuration > Output Mapping tab

Maps the columns of the query response to the schema for your process.

Figure: Salesforce Query Entity Configuration > Output Mapping tab

Salesforce Query Entity Configuration Output Mapping tab

Fields

Field Name Definition

Salesforce
Function:
Specifies the access token that connects to your Salesforce application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Add Token Add Token icon
Opens this Screen:
Access Token for Salesforce
Function of this Screen:
Configure an access token to connect to Salesforce.
Example:
Refer to:

Entity Name
Function:
Specifies the name for your entity.
Accepted Values:
An entity name from the list.
Default Value:
None

When you select the Salesforce access token, the name that shows in the Entity Name field.

Accepts Process Data Variables:
No

Map Response to AgilePoint Schema
Function:
Specifies the connection from the Salesforce API response parameter to your schema.
Accepted Values:
Click the Ellipses button to open the Schema Mapper.

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

Default Value:
None
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?

Salesforce Query Entity Configuration > Test tab

Makes sure your query is valid for Salesforce.

Figure: Salesforce Query Entity Configuration > Test tab

Salesforce Query Entity Configuration Test tab

Fields

Field Name Definition

Salesforce
Function:
Specifies the access token that connects to your Salesforce application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Add Token Add Token icon
Opens this Screen:
Access Token for Salesforce
Function of this Screen:
Configure an access token to connect to Salesforce.
Example:
Refer to:

Entity Name
Function:
Specifies the name for your entity.
Accepted Values:
An entity name from the list.
Default Value:
None

When you select the Salesforce access token, the name that shows in the Entity Name field.

Accepts Process Data Variables:
No

Execute Query
Function:
Makes sure the query is correct, and shows the necessary error message if an error occurs.

If the query runs successfully, the result shows in the box.

Example:
Refer to: