DEPRECATED | Dynamics CRM Read

On this page

Snap type:Write
Description:

This Snap provides functionality to read records from Microsoft Dynamics CRM.

ETL Transformations & Data Flow

This Snap enables the following ETL operations/flows:

  1. Extract data from either directly in the Snap configuration or from the upstream Snap containing the data for reading the Dynamics CRM 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 CRM Read Snap in order to read the CRM object(s)

Input & Output

  • InputThe ID of the Dynamics CRM Object to be Read. The information can either be provided directly in the Snap or in the upstream Snaps.
  • OutputA document with the result set. If the Read is successful, then the output document will contain all the fields of the provided CRM object(s).
  • Expected upstream Snaps: None
  • Expected downstream Snaps: None
Prerequisites:[None]
Limitations and Known Issues:
  • Works in Ultra Task Pipelines.
  • When reading more than one CRM Object in batches, the Batch Size ranges from 1 to 1000. This is a limitation set by Microsoft Dynamics CRM.
Configurations:

Account and Access

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


Views

InputThis Snap has exactly one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.
Troubleshooting:

For trouble shooting purpose, try performing a similar operation directly on the Dynamics CRM 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.

In order to view the Object ID of the Dynamics CRM Object from the User Interface, the recommended approach is to install a browser plug-in. The plug-in will be available in the browser's Developer tools console. Contact your administrator for the preferred plug-in.

Settings

Label

Required. 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 CRM Object Type.

Example: account

Default Value: Selected

IDGuid of the Dynamics CRM 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 the end of records or the 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 no more records available. (0 to loads all pages) (if empty default value),

Default Value: 0

Include name fields

Creates name fields which represents human readable values for Dynamics CRM Entity that references GUIDS.

Default Value: Selected

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.

Basic Use Case 


This pipeline reads values from an object account without using an ID value.

Typical Snap Configurations


The key configuration of the Snap lies in how you pass the statements to read the CRM objects. As it applies in SnapLogic, you can pass the statements in the following manner: 

  • Without Expression: Directly passing the required statement in the CRM Read Snap.

This pipeline reads values from an object account, using an ID value, d8294ae5-182b-e711-80ed-c4346bac4304.

  • With Expressions

    • Query from an upstream Snap: The Mapper Snap passes the required ID to the CRM Read Snap.

 


Another Use case where multiple IDs are passed via upstream:

 CRM Read function using an ID as passed from the Upstream

In this pipeline, the Dynamics CRM Search Snap searches the records from an Object type, maps them to the CRM Read Snap to retrieve the values pertaining to the particular ID field as sent from the upstream Mapper Snap.


The CRM Search Snap searches the records from the Object type, account:


The output preview from the CRM Search Snap:


The Mapper Snap maps the $accountid from the input stream to the target $id:


The CRM Read Snap reads the values from the object type account using the $id, as passed from the upstream Snap:

The output preview from the CRM Read Snap that displays all the records with an accountid:


    • Pipeline Parameter: Pipeline parameter set to pass the ID to the CRM read Snap.


 


Advanced Use Case


The following describes a pipeline, with a broader business logic involving multiple ETL transformations.

Download the pipelines from Downloads link below.

This pipeline reads and moves several files to the Oracle Insert. The data is migrated to the Oracle Server, and the Snap helps in achieving this with high performance and ease of use. And then, the Oracle Execute Snap is used to read the inserted records.

  1. Extract: The Dynamics CRM Read Snap reads the records from an Object on the CRM.  

  2. Transform: The Mapper Snap maps the metadata from the input schema (Dynamics CRM) to the output schema (Oracle Database).

  3. Load: The Oracle Insert Snap inserts the records into the Oracle DB table.

  4. Read: The Oracle Execute Snap reads the inserted records into the Oracle Database.


Downloads

Important steps to successfully reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified

File CRM Read - Oracle_2017_07_25.slp

Aug 07, 2017 by Kalpana Malladi

File Example_CRM_Read_Oracle.slp

Feb 28, 2022 by Kalpana Malladi

  

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates
4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27main12833 StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10880 LatestImproved the Dynamics 365 for Sales Upsert Snap by caching the parameter lookups values.
4.25425patches9813 LatestFixed an issue with Dynamics CRM Search Snap where the Snap returns duplicate records when reading results from multiple pages.
4.25main9554
 
Stable

Upgraded 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.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19 Patch dynamicscrm8531 Latest
  • Fixes the following:

    • Dynamics CRM Upsert Snap to process GUID format.
    • Dynamics CRM Search Snap to parse additional object schema types.
4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
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.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.

4.14 Patch 

dynamicscrm5971

 Latest

Fixed an issue with the Upsert Snap wherein duplicate records were being created because the Snap was ignoring certain query fields.

4.14 Patch 

dynamicscrm5857

 Latest

Fixed an issue with Dynamics CRM Create operation for Owner id tags.

4.14 Patch dynamicscrm5753 Latest

Fixed an issue with Owner ID tags request process in the Dynamics CRM Create Snap.

4.14 Patch dynamicscrm5720 Latest

Enhanced the Dynamics CRM Read Snap with the following to optimize Pipeline execution time and data integrity:

  • Reduced cache time for Read suggestions to five minutes.
  • Removed cache for Entity Reads.
4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11 Patch dynamicscrm4359 Latest

Added support for Customer data type as an input parameter for the Dynamics CRM Snaps.

4.11 Patch dynamicscrm4286 Latest

Dynamics CRM Upsert - Added support for processing Dynamics CRM data types in the CRM Upsert Snap.

4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10 Patch dynamicscrm4185 

Support for Guid datatype as input parameter: Resolved an issue with Dynamics CRM Snaps that fails when record ID is specified.

4.10snapsmrc414

 


  • Introduced the CRM Upsert Snap in this release.
  • Performance enhancements for Microsoft Dynamics CRM Create.
4.9 Patchdynamicscrm3328

Addressed the issue: Dynamics CRM Create does not support some datatypes

4.9 Patchdynamicscrm3080

Addressed an issue with Dynamics CRM Read and Search Snap not converting OptionSetValues correctly.

4.9snapsmrc405 
  • This Snap Pack introduced in this release with the following Snaps:
    • Create
    • Update
    • Delete
    • Read
    • Search