Query Advanced Entity activity

An activity that gets Salesforce records with a custom SQL query. Use this activity if you want to use a advanced SQL statement against Salesforce.


Query Advanced Entity activity

Configure the Query Advanced Entity activity

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

Examples

Good to Know

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 Advanced Entity Query Advanced Entity icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Query Advanced 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 Advanced Entity Configuration

Specifies your query to get Salesforce records.

Figure: Salesforce Query Advanced Entity Configuration screen

Salesforce Query Advanced Entity Configuration screen

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:

Query

Function:
Specifies the select statement that defines the SQL query the activity does to get records from Salesforce.
Accepted Values:
A valid SQL select query.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
SELECT Id, Name FROM Account 
  WHERE Id IN ( SELECT AccountId FROM Contact WHERE LastName LIKE 'apple%' )
  AND Id IN ( SELECT AccountId FROM Opportunity WHERE isClosed = false)

Execute Query

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

If the query completes, the result shows in the Result Query box.

Query Result

Function:
When you click Execute Query, this field shows the response from your query in XML format.

You can change the XML to customize your response.

Accepted Values:
A valid XML query response.
Default Value:
None.

When you click Execute Query, a default query response shows.

Accepts Process Data Variables:
Yes

Schema Mapper

Function:
Connects the query to your schema.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the query to your process schema.

Default Value:
None
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?