Dynamics 365 for Sales Read

On this Page

Overview

This Snap enables you to read records from Microsoft Dynamics 365 for Sales.

ETL Transformations & Data Flow

The Dynamics 365 for Sales Read Snap enables the following ETL operations/flows:

  1. Extract data either directly from the Snap configuration or from the upstream snap containing the data for reading the MS Dynamics 365 for Sales object(s).
  2. Transform the input document into a SnapLogic friendly JSON Document if using an upstream snap.
  3. Load the data into the Dynamics 365 for Sales Read snap in order to read the MS Dynamics 365 for Sales objects.

Input and Output

  • Expected upstream Snaps: None
  • Expected downstream Snaps: None
  • InputThe ID of the MS Dynamics 365 for Sales object to be read. The information can either be provided directly in the Snap or in the upstream snaps when expressions are used in the Read snap
  • Output: A document with the result set. If the Read is successful, then the output document will contain all the fields of the provided MS Dynamics 365 for Sales object(s).

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 purpose, try performing a similar operation directly on the Microsoft Dynamics 365 for Sales user interface and collect the necessary data. Compare the data used in the User Interface with the SnapLogic pipelines to see if there are any inconsistencies.

Support

Known Issues

  • When reading multiple MS Dynamics 365 for Sales objects in batches, the Batch Size ranges from 1 to 1000. This is a limitation by MS Dynamics 365 for Sales.
  • 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.

Snap Settings


LabelRequired. 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.

Example: account

Default Value: account

IDGUID of the MS Dynamics 365 for Sales object. This field is suggestible.
Page Size

Use the Page Size feature to make paging in an application faster for large datasets.

Default Value: 1000

Max Value: 5000

Start Page Number

Starts loading the records from the specified page until end of records or Max Page Number, if specified (if empty default value used)

Default Value: 1

Max Page Number

The snap will stop loading when the specified page number is reached or when no more records available. Leave the value in this field at 0 to load all pages. If this field is left empty, it is interpreted as 0, and all pages are loaded.

Default Value: 0

Read Query Fields

Use this field to specify the query fields that you want read. If you provide any query fields here, the Object ID property in the Snap will be ignored in favor of these fields. It is expected that upstream documents will contain the fields specified. The values of those fields will be used to query MS 365 records.

If you want to use a numeric value drawn from an upstream Snap, ensure that the parameter is declared as a float in an Mapper Snap upstream; else, the upsert operation may fail. For more information on working with numeric values in the Mapper Snap, see Managing Numeric Inputs in Mapper Expressions.

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 performing operations (Create, Upsert, Update, Delete), the default read time out is 10 mins.

Examples


Using the Dynamics 365 for Sales Snap to Read an Object

Basic use case: Using the Snap to read an object.

 Using the Dynamics 365 for Sales Snap to Read an Object

The following pipeline demonstrates a basic use case of the Dynamics 365 for Sales Read Snap, where the Snap logs in and reads from an object:

Select the Object Type of the object that you want to read. You can also enter the ID of the object that you want to read and specify the query field you want to read. Save your changes and execute the pipeline.

Once the pipeline completes execution, you should see object details in the output, as shown below:

Download the pipeline

Using Upstream Snaps with the Dynamics 365 Read Snap

Basic use case: Using a Mapper Snap to supply the object ID of the object that must be read.

 Using the Upstream Snaps with the 365 Read Snap

The Dynamics 365 Read Snap can also be used with upstream Snaps. In this example, we shall use a Mapper Snap to supply the Read Snap with the object ID of the object that we want it to read.

We configure the Mapper Snap to label and supply the object ID that must be read, as '$id':

We add a Dynamics 365 for Sales Read Snap downstream to the Mapper and configure it to use the object ID label we configured in the Mapper Snap, as follows:

Save your settings and execute the pipeline. If your settings are valid, the pipeline should execute to display a single row of data related to the object ID indicated by the label you provided in the Mapper Snap:

Download the sample pipeline

Downloads

  File Modified

File MSD365_Read_Basic.slp

Jul 27, 2018 by Rakesh Chaudhary

File MSD365_Read_Upstream.slp

Jul 27, 2018 by Rakesh Chaudhary

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates
4.27main12833 StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10303 LatestFixed an error in Dynamics 365 for Sales Create Snap where the Snap does not send the original documents to the error view in the output when the batch size property is set to greater than 1.
4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
StableUpgraded with the latest SnapLogic Platform release.
4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21 Patch dynamics365forsales8856 Latest

Fixes Pipeline validation error that occurs when writing data from Dynamics 365 for Sales Update Snap to output documents.

4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19 Patchexpensify8335 Latest

Fixed the broken doc link for the Expensify Export Report Snap.

4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18 Patch dynamics365forsales7957 Latest
  • Fixed a NullPointerException issue with the Dynamics 365 for Sales Delete Snap wherein the Object ID is invalid.
  • Fixed a concurrency issue with multiple Dynamics 365 for Sales Snaps when running in parallel.
4.18 Patch dynamics365forsales7952 Latest

Added support for lookup type in the input document to be formatted per MS Dynamics 365 for Sales syntax.

4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Latest

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16 Patch dynamics365forsales7232 Latest

Dynamics 365 for Sales Read Snap now supports custom object types. 

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
Stable
  • New Snap Pack: MS Dynamics 365 for Sales Snap Pack introduced in this release with the following Snaps:
    • Create
    • Delete
    • Execute
    • Read
    • Search
    • Update
    • Upsert