DEPRECATED | Dynamics CRM Search

On this Page

Snap type:Read
Description:
This Snap searches Dynamics CRM for an object type matching provided filter and returning the resulting object(s) attributes.
  • Expected upstream Snaps: Upstream Snap is optional.  Upstream Snap's output document may be used in CRM Search expressions.
  • Expected downstream Snaps: Expected downstream Snap optional.  Downstream Snaps use search output results to help complete the integration solution use case.
  • Expected input: Input is not expected unless CRM Search expressions require variable data.
  • Expected output: CRM Search object results that match the filter and containing the configured output attributes.

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 searching and retrieving the corresponding 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 Search Snap in order to search and retrieve the CRM object(s)

The Search is internally performed using FetchXML and QueryExpression.

Input & Output

  • InputSearch criteria for the CRM Object(s) to be retrieved. The information can either be provided directly in the Snap or in the upstream Snaps when expressions are used in the Search Snap

  • Output: A document with the result set. If the Search is successful, then the output document will contain the CRM object(s) that match the filter
Prerequisites:None
Support and Limitations:
  • Works in Ultra Task Pipelines.
  • The kind of search that can be performed is limited to the search criteria that can be created using the Search Snap's User Interface.

The Snap supports a page size of up to 10000 records; however, reduce the page size if you receive a "Read timeout exception" error.

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 can have at most one input view.
OutputThis Snap can have at most one 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. The Dynamics CRM Object Type.
Example: account
Default value: account
Page SizeUse the page size feature to make paging in an application faster for large datasets.Default Value: 1000Max Value: 10000
Start Page NumberStarts 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 NumberThe 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
Filter
 


        Type

The Dynamics CRM filter type.
Example: and
Default value: and
Notes only "and" and "or" are supported by Dynamics CRM



        Attribute
The Dynamics CRM filter attribute.
Example: name
Default value: none
The Dynamics object type attribute to apply the filter.

  
        Operator

The Dynamics CRM filter operator.
Example: eq
Default value: eq
The operator to be applied to the filter attribute.


       Value
The Dynamics CRM filter value.
Example: MyAccountName
Default value: none
The value to be applied to the filter operator.

 Output attributesSpecifies the list defining the output attributes to be returned for the object results. If no attributes are defined then all attributes for the object type are returned.

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 


The following pipeline describes how the Snap functions as a standalone Snap in a pipeline:


In this pipeline, the CRM Search Snap searches the records from the object type, account. The Page Size is set to the default 1000 from the starting of the page. The Filter properties for the search operation are provided with the attributes and values. The required Output attributes from the search operation are also provided with. If the Output attributes are left blank, the Snap retrieves all the fields available on the object type.


Successful execution of the pipeline displays the below output preview:

  



Typical Snap Configurations


The key Snap configurations are:

  • WIthout Expression

In this pipeline, the Max Page Number is set to 5, and the search attributes are set to search for all the records in the 5 pages where the accountnumber is greater than 1000.

In case when the Max Page number is set to 0, it searches and displays all the records from the object type,



  • With Expression
    • Query from the upstream

In the below pipeline, the Mapper Snap passes the search parameters into the CRM Search Snap.


 The value 'accountnumber' is mapped to the taget field $account:


The CRM Search Snap uses the search attribute value from the upstream dynamically and displays all the results that have an account number equals to 1000.



Advanced Use Case


The following describes a pipeline, with a broader business logic involving multiple ETL transformations, that shows how typically in an enterprise environment, CRM Search functionality is used.  Pipeline download link is available below.

This pipeline reads files from the CRM instance and moves them to the ServiceNow instance.

  

  1. Extract: The CRM Read Snap reads and retrieves the records from an object type on CRM instance.
  2. Transform: The Mapper Snap maps the input schema and passes the search attribute value to the CRM Search Snap.
  3. Transform: The second Mapper Snap maps the input schema to the target fields on the ServiceNow instance.
  4. Load: The CRM Search Snap retrieves the records as specified in the search configuration.
  5. Load: The ServiceNow Snap inserts the documents into a specified object type on the ServiceNow instance.

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.


See Also


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