Upsert Record (Salesforce) activity

An activity that creates a record, or changes records if they exist. Salesforce recommends using Upsert Record as an alternative to Create Record so you do not create duplicate records.


Upsert Record activity

Configure the Upsert Record activity

To configure the Upsert Record 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 Upsert Record activity onto your process.

    Upsert Record activity

General Configuration

Specifies the basic settings for the Upsert Record activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field NameDefinition

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

Upsert Record Configuration

Specifies the information to create a record, or changes records if they exist.

Figure: Upsert Record Configuration > Request tab

Upsert Record Configuration Request tab

Fields

Field NameDefinition

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:

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:

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

External Field
Function:
Specifies an external field value connected to a record. The activity creates a check to find any records that have this external field value.
  • If the external field does not agree with any records, create a new record.
  • If the external field agrees with one record, change the record.
  • If the external field agrees with more than one record, give an error. No record is added or changed.
Accepted Values:
A valid external field value.
Default Value:
None

When you select the name of entity, the external field value shows in this field.

Accepts Process Data Variables:
No

Request Mapping
Function:
Connects the Salesforce API request parameter to your process 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 Upsert Entity Configuration screen, click the Request tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

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

Default Value:
None
Example:
Refer to:

Map Response to AgilePoint Schema
Function:
Specifies the connection from the Salesforce API response parameter to your process schema.
To Open this Field:
  1. On the Upsert Entity Configuration screen, click the Response tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

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

Default Value:
None
Example:
Refer to:

Store Response in This Variable
Function:
Specifies a process data variable that contains the entity ID from Salesforce.
To Open this Field:
  1. On the Upsert Entity Configuration screen, click the Response tab.
Accepted Values:
A process data variable that accepts an alphanumeric string with no spaces that represents the entity ID.
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. 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?

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: