Query Advanced Records 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 Records activity

Configure the Query Advanced Records activity

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

Examples

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Salesforce tab.

    Salesforce tab
  3. On the Salesforce tab, drag the Query Advanced Records activity onto your process.

    Query Advanced Records activity

General Configuration

Specifies the basic settings for the Query Advanced Records activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
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.

Description

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

Connection Timeout (Seconds)

Description:
Specifies the number of seconds permitted to complete an action before the connection stops.
Allowed Values:
An integer.

Represents

  • A number of seconds
Default Value:
600
Accepts Variables:
No

Salesforce Query Advanced Records Configuration

Specifies your query to get Salesforce records.

Figure: Salesforce Query Advanced Records Configuration screen

Salesforce Query Advanced Records Configuration screen

Fields

Field NameDefinition

Salesforce

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

Create 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

Description:
Specifies the select statement that defines the SQL query the activity does to get records from Salesforce.
Allowed Values:
A valid SQL select query.
Default Value:
None
Accepts 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

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

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

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

Accepts Variables:
Yes

Schema Mapper

Description:
Connects the query to your process schema.
Allowed Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

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