Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Overview

This Snap enables you to add new records for objects (entities in Microsoft terminology) based on the input document field values that match the MS Dynamics object schema field names.

Image Modified

Input & Output

  • Expected upstream Snaps: Required. Any Snap with a document output view, such as the Mapper Snap, can be connected upstream.

  • Expected downstream Snaps: None

  • Input:

    Prerequisites

    None.

    Snap Views

    TypeFormatNumber of ViewsExamples of Upstream and Downstream SnapsDescription
    InputDocumentMin:1
    Max:1
     Mapper SnapNeeds to have an upstream Snap that contains the mandatory fields for creating the Microsoft Dynamics 365 Sales object. Mapper Snap is a preferred upstream Snap as it populates the input schema for the selected MS Dynamics 365 Sales Object Type.
    OutputDocumentMin:1
    Max:1
    NoneA document with the result set. If the creation is successful, then the output document contains the Guid of the created object.

    Prerequisites

    None.

    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 exactly one document input view.OutputThis Snap has exactly one document output view.ErrorThis Snap has at most one document error view.

    Troubleshooting

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

    Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

    • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

    • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.

    • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

    Learn more about Error handling in Pipelines.


    Support

    Works in Ultra Task Pipelines.

    Known Issues

    This Snap cannot create relationships using collection-valued navigation properties, such as contact_customer_accounts, due to because of current WebAPI limitations; however, it works correctly with single-valued navigation properties, such as primary contact id.


    Snap Settings


    LabelRequired. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.
    Object type

    Required. Microsoft Dynamics 365 Sales object type. For example, account.

    Default Value: account

    Related object type

    Microsoft Dynamics 365 Sales object type of the object to which it must be related.

    Default Value: None

    Related object relationship

    Relationship Schema between the Microsoft Dynamics 365 Sales object to be created with the related object.

    Note

    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

    Related object ID

    GUID of the related Microsoft Dynamics 365 Sales object.

    Default Value: None

    Batch Size

    Required. Number of records processed in each request. Batch size range is from 1 to 1000.

    Default Value: 200

    Batch processing results can contain both successful and unsuccessful results.  Successful results will be written to the output view.  Unsuccessful results, along with intuitive error information will be written to the error view; therefore, it is recommended to activate the error view within the Snap.  A single unsuccessful batch processing document will not halt the batch processing, unless there is a configuration problem; in this special case, the Snap would fail with intuitive error information.

    Number of Retries

    Specify the maximum number of retry attempts in case of failure (if 0, retries are disabled).

    Default Value: 0
    Example: 5

    Retry Intervals (seconds)

    Amount of time, in seconds, between retry attempts.

    Default Value: 1
    Example: 3

    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

    Multiexcerpt include macro
    nameSnap Execution
    pageSOAP Execute


    Multiexcerpt include macro
    nameExecution_Detail_Write
    pageSOAP Execute


    Note

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


    Troubleshooting

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

    Examples

    Create a Record in MS Dynamics for Sales and Perform a Bulk Delete

    In this example, we shall create a new set of entities in an MS Dynamics 365 Sales DB table, view the output preview, and delete the data using a Dynamics 365 For Sales Delete Snap.

    Expand
    titleCreate a Record in MS Dynamics for Sales and Perform a Bulk Delete

    In this example, we shall create a new set of records in an MS Dynamics 365 Sales DB table, view the output preview, and delete the data using a Dynamics 365 For Sales Delete Snap. This way, we can see each of these Snaps in action and learn how to work with them, while leaving the sample pipeline ready for reuse.

    Step 1: Prepare Records for Upload

    In this example, we are using the JSON Generator Snap to create and store records to be uploaded to the MS Dynamics 365 Sales DB table. You can also use a Mapper Snap to send in the data needed to create the records.

    Step 2: Create Records in the MS Dynamics 365 Sales DB Table

    Connect a Dynamics 365 For Sales Create Snap to the JSON Generator Snap and configure it to add new records into the as follows:

    Step 3: Map '$accountid' in Created Records to '$guid' to simplify identification

    We intend to delete the records we just created. To simplify isolating these records, we map the '$accountid' attribute in these records to '$guid', so we can search for these records by '$guid' and delete them later in the pipeline.

    Step 4: Delete all Account Records with Attribute '$guid'

    Now that we have replaced the attribute '$accountid' with '$guid', we can perform a simple delete operation, removing all records that contain the '$guid' attribute:

    Download the sample pipeline


    Downloads

    Multiexcerpt include macro
    namedownload_instructions
    pageOpenAPI

    Attachments
    uploadfalse
    oldfalse
    patterns*.slp,*.zip

    Insert excerpt
    MS Dynamics 365 for Sales Snap Pack
    MS Dynamics 365 for Sales Snap Pack
    nopaneltrue