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

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

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

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:

Expand
titleCRM 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

Multiexcerpt include macro
namedownload_instructions
pageOpenAPI

Attachments
patterns*slp, *zip

  

Insert excerpt
DEPRECATED | Microsoft Dynamics CRM Snap Pack
DEPRECATED | Microsoft Dynamics CRM Snap Pack
nopaneltrue