Upsert Entity (Dynamics CRM) activity

An activity that creates an entity, or changes entities if they exist. Dynamics CRM recommends using Upsert Entity as an alternative to Create Entity so you do not create duplicate entities.


Upsert Entity activity

Configure the Upsert Entity activity

To configure the Upsert 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 Dynamics CRM Dynamics CRM icon tab.
      2. On the Dynamics CRM Dynamics CRM icon tab, drag the Upsert Entity (Dynamics CRM) Upsert 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 Upsert 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

Upsert Entity Configuration

Specifies the information to create an entity, or changes entities if they exist.

Figure: Upsert Entity Configuration > Request tab

Upsert Entity Configuration Request tab

Fields

Field Name Definition

Dynamics CRM
Function:
Specifies the access token that connects to your Dynamics CRM application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Example:
Refer to:

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

Entity Name
Function:
Specifies the name for your entity.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

When you select the Dynamics CRM access token, the name of the entity shows in the Entity Name field.

Accepts Process Data Variables:
No

Field Name
Function:
Specifies the name of the field value connected to a record.
Accepted Values:
A valid field name.
Default Value:
None.

When you select the Entity Name, the name of the record shows in the Field Name.

Update Message for Multiple Entity
Function:
Specifies if you want to change one record or all the records.
Accepted Values:
  • Selected - Changes all the records.
  • Deselected - If one record exists, it changes. If more than one record exists, an error shows in the Manage Center.
Default Value:
Deselected

Request Mapping
Function:
Connects the Dynamics CRM API request parameter to your schema. This is mandatory only if the request passes data from the process schema to parameters in the Dynamics CRM 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.

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

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 Dynamics CRM API response parameter to your 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.

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

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 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, 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