Update Entity (Salesforce) activity

An activity that changes an entity in Salesforce. You can work with standard entities or custom entities.


Update Entity activity

Configure the Update Entity activity

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

Video: Add Conditions and Salesforce Actions

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 Update Entity (Salesforce) Update 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 Update 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

Update Entity Configuration

Configures the request settings to change an entity record

Figure: Update Entity Configuration screen

Update 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:

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:

Update Record
Function:
Specifies how to change an entity.
To Open this Field:
  1. On the Update Entity Configuration screen, click the Request tab.
Accepted Values:
  • Update Record Using the ID - Specifies an entity ID.
  • Update Record that meet all the conditions - Lets you connect the Salesforce API request parameter to your schema and specify a SQL WHERE clause to change the entity.
Default Value:
Update Record Using the ID
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?

Build Where Clause Build Where Clause icon
Opens this Screen:
Update Entity Configuration > WHERE Clause
Function of this Screen:
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.

Edit Edit icon

Function:
Lets you change the WHERE clause.

Request Mapping
Function:
Connects the Salesforce API request parameter to your schema. This is mandatory only if the request passes data from the process schema to parameters in the Salesforce API.
To Open this Field:
  1. On the Update Entity Configuration screen, click the Request tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the request 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?

Map Response to AgilePoint Schema
Function:
Specifies the connection from the Salesforce API response parameter to your schema.
To Open this Field:
  1. On the Update Entity Configuration screen, click the Response tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon 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?

Store the Response in Custom Attribute
Function:
Specifies the process data variable that contains the entity ID from Salesforce
To Open this Field:
  1. On the Update Entity Configuration screen, click the Response tab.
Accepted Values:
A process data variable that accepts an alphanumeric string with no spaces or special characters.
Default Value:
None
Accepts Process Data Variables:
Yes
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?

Record Ownership
Function:
Specifies the owner of the entity.
To Open this Field:
  1. Click the Record Ownership tab.
Accepted Values:
Default Value:
Service Account used in Access Token
Example:
Refer to:

Update Entity Configuration > WHERE Clause

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: Update Entity Configuration > WHERE Clause screen

Update Entity Configuration WHERE Clause screen

Fields

Field Name Definition

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.

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

Value
Function:
Specifies the value for the column.
Accepted Values:
A valid column value.
Default Value:
None
Accepts Process Data Variables:
Yes
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?

Add Add icon

Function:
Specifies another expression that can be joined to previous expression using the logical AND or OR operator.
  • AND - Specifies the AND operator.
  • OR - Specifies the OR operator.

Subcondition Subcondition icon

Function:
Creates the statement that is a condition of a parent statement.

Delete Delete icon

Function:
Deletes the selected item.
Example:
Refer to:

Back Back icon

Function:
Saves your rule and goes back to the activity configuration screen.