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.



Configure the Upsert Entity activity

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

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

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.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a CRM Activity.

  2. Click Upsert Entity Upsert Entity icon.
  3. Complete the fields on the Upsert Entity Configuration screen.

    For more information, refer to Create or Change a Dynamics CRM Entity.

  4. (Optional) Click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic information for a CRM activity.

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:
Refer to:

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 that represents 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.

Screen



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

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.

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.

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.

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:

The configuration details AgilePoint NX Product Documentation can provide for third-party integrations is limited. For more information, refer to the relevant section in Third-Party Vendor Documentation.

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