In this article

Overview

This Snap enables you to update an existing record or insert a new record in MS Dynamics 365 for Sales based on the input document field values that match the MS Dynamics 365 for Sales object schema field names.

Input & Output

Expected upstream Snaps: Any Snap, such as the Mapper Snap, that offers a document view as output.
Expected downstream Snaps: None
Input: Fields of the MS Dynamics 365 for Sales object to be updated or created. It is optional to provide either the ID of the object or to use a query. If an ID or query is provided, then the corresponding record is updated; else new record(s) are created. The typical configuration is to have an upstream Snap that contains the mandatory fields for updating the existing MS Dynamics 365 for Sales object. Mapper Snap is a preferred upstream Snap as it populates the input schema for the selected MS Dynamics 365 for Sales object type.
Output: A document with the result set. If the update is successful, then the output document contains the GUID of the updated or inserted MS Dynamics 365 for Sales object.

Prerequisites

You must have a Dynamics 365 OAuth2 for an Online account, data to query, and access to the objects concerned.

Configuring Accounts

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Dynamics 365 for Sales Accounts for information on setting up this type of account.

Configuring Views

Input	This Snap has at most one document input view.
Output	This Snap has exactly one document output view.
Error	This Snap has at most one document error view.

Troubleshooting

For troubleshooting purposes, try performing a similar operation directly on the MS Dynamics 365 for Sales console and collect the necessary data. Compare the data used in the user interface with the SnapLogic pipelines to see if there are any inconsistencies.

Limitations and Known Issues

When deleting more than one object in batches, the Batch Size range is from 1 to 1000. This is a limitation by Microsoft Dynamics 365 for Sales.
MS Dynamics 365 for Sales limits the number of API calls to 60,000 per minute, per user org. This should be considered when configuring the size of any batch process.
The Object Type suggestions are limited to the object types available within MS Dynamics 365 for Sales v8.2 and v9.0. There is no current ability to suggest custom object types.
This Snap cannot create relationships using collection-valued navigation properties, such as contact_customer_accounts, due to current WebAPI limitations; however, it works correctly with single-valued navigation properties, such as primarycontactid.

Modes

Ultra Pipelines: Works in Ultra Pipelines.

Snap Settings

Label Required. The name for the Snap. Modify this to be more specific, especially if there are more than one of the same Snap in the pipeline.

Object type

Required. MS Dynamics 365 for Sales object type. For example, account.

Example: account.

Default Value: account

ID Optional. GUID of the MS Dynamics 365 for Sales object. This field is suggestible.

Alternate Keys Use this field set to configure columns to use as the alternate key for entities.

Key Columns

Specify a name for the column to use in an alternate key.

Default Value: N/A
Example: CompanyName, EmailAddress

Use the column’s actual name (instead of the Display name).You must look up for the actual column name in Power Apps menu and select Columns from the table menu.

Learn more about Configuring Alternate Keys in MS Dynamics 365 For Sales (Power Apps) .

Related object type

The object type of the related object.

Default Value: None

Related object relationship

Relationship between the MS Dynamics 365 for Sales object to be created with the related object.

This Snap cannot create relationships using collection-valued navigation properties, such as contact_customer_accounts, due to current WebAPI limitations. However, it works correctly with single-valued navigation properties, such as primarycontactid.

Default Value: None

Upsert Multiple Objects When enabled, the Snap updates multiple records per object type if the query returns more than one MS Dynamics 365 for Sales record.

Upsert Query Fields Query fields to use to upsert the corresponding MS Dynamics 365 for Sales records.

Batch size

A number of records processed in each request. The batch size can range from 1 to 1000.

This Snap does not guarantee Batch Size to function when one or more Upsert Query Fields are configured in the Snap settings. Hence, one input document can result in more than one output document due to the records in Dynamics 365 that match the Upsert Query Fields of the current input document.

Default Value: 200

HTTP header

Additional HTTP headers to pass when sending requests to the Dynamics 365 for Sales instance.

Example:

Key	Value
Prefer	odata.include-annotations="*"

Default value: No default value

Snap execution

Select one of the three modes in which the Snap executes. Available options are:

Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
Disabled: Disables the Snap and all Snaps that are downstream from it.

For all operations (Create, Upsert, Update, Delete), the default read timeout is 10 mins.

Examples

Updating customer details using Dynamics 365 for Sales Upsert Snap

Following is a detailed example that uses Upsert Query. The following Pipeline uses Snaps like Dynamics 365 for Sales Create, Dynamics 365 for Sales Read and Dynamics 365 for Sales Delete Snaps to create customer details from the sales report, read them, upsert them, whenever required, and delete them if required.

First, in this Pipeline, using the Mapper Snap, the details of the customer like Account ID, Batch size, and Page number are given as inputs.

Settings	Output

Create these details from the Mapper Snap with the help of Dynamics 365 for Sales Create Snap.

Settings	Output

Next, another Mapper Snap to add more details to the list of customer details:

Settings	Output

Update these details using Dynamics 365 for Sales for Upsert Snap.

Settings	Output

These results are copied and routed into two outputs. One output is to get these details and save them for further use and another output is used to delete the details using Dynamics 365 for Sales Delete Snap.

Settings	Output

Updating the Attributes of an Object

Basic use case, using the Dynamics 365 for Sales Upsert Snap with a Mapper

Updating the Object Type of an Object

In this pipeline, the Dynamics 365 for Sales Upsert Snap updates the 'address1_city' attribute of an account object.

We first update the pipeline's parameters to specify the city to which we want the 'address1_city' attribute to be updated:
We now add a Mapper Snap, so we can map the pipeline parameter to the address1_city attribute:
We've now established a connection between the pipeline parameter we defined with an actual attribute in the target object model. We now need to choose the required object and object ID whose values we want to update.
Once these settings are in place, execute the pipeline. Upon successful execution, you should see a confirmation message in your output as displayed below: