Microsoft Dynamics CRM Snap Pack: Migrating from the Field version to the Product version

On this Page

This document helps users migrate from the field-developed Microsoft Dynamics CRM Snap Pack to the product version of the Microsoft Dynamics CRM Snap Pack. The list below provides the information on each item with reference to the Field and Product versions. For more information, refer to Microsoft Dynamics CRM Snap Pack.

Migration to the Product version

Before the migration begins, notice if the Snap to which you are migrating consists of the same FQID as before, or if there's a new version. See below for details. Your Technical Account Manager can assist you with this. 

Fully-Qualified ID (FQID) for a Snap

The FQID is used to uniquely identify the Snap. It consists of the Snap class ID and the class version. The FQID appears on the Info tab of the Snap.

Typically, a migration for a Snap will go from "<class_id>_<class_version>" to "<class_id>_<class_version + 1>". During migration, the Snap is updated with its version to match the incremented class version. The steps you take to migrate a Snap depend on whether a Product Snap has the same FQID as that of the Field Snap.

Locating the FQID for a Snap

Open the Info tab on the Snap to locate the Class FQID. If the FQIDs are same for the Field and the Product Snap (for example, com-snaplogic-snaps-dynamicscrm-read_1). The <class_id>_<class_version> are the same. If the FQIDs are not the same, the Product Snap would typically have an incremented version number (for example, com-snaplogic-snaps-dynamicscrm-read_2).

The following images show an example of the CRM Read Snap. The Product version is on the right and the Field version is on the left. The FQIDs are the same for both versions. Note that 'SNAPSHOT' and 'snapsrc851'  are the Snap Pack versions that change with every build. 


Migrating from the Field to the Product versions with the same FQID

  1. Subscribe to the Product Snap Pack. Your Technical Account Manager will initiate this process and inform when the Product version is enabled.
    1. Log in to SnapLogic as an org administrator.
    2. Navigate to Manager > Organizations
    3. Select the desired Product Snap Pack. 
       

  2. Refresh the application. The Product Snap Pack is displayed in the Snaps catalog.


  3. Get the list of pipelines to be updated from all the projects.
  4. Make a note of the account and the Snap configuration in each impacted pipeline.

                                                                                                                                                                                      
  5. Find the project in which the Field Snap Pack is located in order to delete it. 
  6. Delete the Field Snap Pack and then delete the old accounts.                                  
  7. Create new accounts either in the pipelines or from SnapLogic Manager. See steps 7 and 8 below. Configuring the Snaps within the existing pipelines is sufficient because the Snap FQID remains the same.
  8. To create the accounts from the Manager:
    1. Navigate to the Project in which the Product Snap Pack is added.
    2. Select the "+" plus symbol from top right on the Accounts tab. A list of the Snap Packs is displayed.
    3. Select the Snap Pack and the desired Account type to configure. 

       
  9. To create the Accounts and configure the Snap from a pipeline:  

    1. Configure the Accounts/Snap Settings within the pipeline. See example below.  
    2. Validate the pipeline.
  10. To confirm your changes, navigate to Manager > Snap Statistics and generate a Snap Statistics report. 
    Note the total number of pipelines belonging to the Product Snap Pack is the same as before the migration since the respective FQIDs of the Snaps remain the same. 


    The Snap Statistics Report as generated in the .csv format.

 

Dynamics CRM Account 

The Product online version of Dynamics CRM Snap Pack consists of accounts that support Online(Cloud) and On-Premises: 

UI Changes on the Product Version

  • There are four accounts on the Product version as mentioned above. These supported accounts can be selected and provided with the respective account settings.
  • The dynamic accounts for the Dynamics CRM Snap Pack are available for the Product version. The Field Snap Pack supports an Office 365 account only.
  • The Validate option is available on the Product version and for the normal accounts only. For the Dynamic Accounts, since the values are passed dynamically, the values are simply applied and not validated for saving.
Refer the section below to further note about the Dynamic Accounts:

Passing the values dynamically into the Dynamic Accounts and the Snap using the pipeline parameters

Dynamic Accounts

The difference between basic Account and the Dynamic Accounts is that in the latter you can specify the Account properties as expressions referencing pipeline parameters. You can Validate an account connection when creating a basic account, but not when creating the Dynamic Accounts because the account properties are provided dynamically. 

The following examples show the settings for a basic account and a dynamic account.

Example 1: In a basic account, the values are passed directly and validated. First Validate and then click Apply to save the credentials.

Example 2: For the CRM dynamic Account, the values, _snapserver and _CRMOrganization, are passed for the CRM Organization Service endpoint and CRM Organization properties using the pipeline parameters.


The Id Value is passed to the Dynamics CRM Upsert Snap(_Id) using the pipeline parameters.

 

Account Settings

Both, the Online and On-Premises accounts have the same features. The only differences are the expressions on the Dynamic Account's UI.

Refer to Dynamics CRM Accounts for more information.

AccountField Snap PackProduct Snap PackChange on the Product Feature
OnlineLabelLabelNo change
OnlineUsernameUsernameNo change
OnlinePasswordPasswordNo change
OnlineCRM endpointCRM Organization Service endpoint

Change in the Property name. The complete endpoint should be provided. For example, if the endpoint has the Field version as https://win-q34q3acu3ik.dev.dom:444/ , the sample CRM Organization Service Endpoint in the Product version is https://win-q34q3acu3ik.dev.dom:444/SnapLogic/services/2020/Company.ggf

OnlineCRM Organization

CRM Organization

No change


ADFS Kerberos Account/Dynamic Account For CRM OnPrem

Refer to Dynamics CRM Accounts for more information.

AccountField Snap Pack
Product Snap PackChange on the Product Feature
On-Premises

Label

LabelNo change
On-PremisesUsernameUsernameNo change
On-PremisesPasswordPasswordNo change
On-PremisesDomainDomainNo change
On-PremisesCRM endpoint*CRM Organization Service endpoint*Change in the Property name. The complete endpoint should be provided. For example, if the endpoint has the Field version as https://win-q34q3acu3ik.dev.dom:444/ , the CRM Organization Service Endpoint in the Product version is https://win-q34q3acu3ik.dev.dom:444/SnapLogic/services/2020/Company.ggf
On-PremisesKerberos distribution center*Kerberos distribution center*No change
On-PremisesKerberos Realm*Kerberos Realm*No change
On-PremisesKerberos SPN*Kerberos SPN*No change
On-PremisesCRM Organization*CRM Organization*No change
On-PremisesADFS Mex URLADFS Mex URLNo change

Dynamics CRM Create 

The Dynamics CRM Create Snap provides the functionality to add new records in Microsoft Dynamics CRM based on the input document Field values that match the Dynamics CRM object schema Field names.

Dynamics CRM Create for the Online Version

Refer to Dynamics CRM Create for more information about this Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines, select the account and configure the new account properties as required (or if a validation failure error occurs).
  • The Field Snap does not suggest the target schema and hence the ID is passed using the upstream Snap. For the Product Snap, the ID is passed either directly or via the upstream Snap by enabling the expression of the ID property.
  • For the Field Snap, the output preview displays the ID of the record. For the Product Snap, the output preview displays the GUID, original data, and the result.


Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1Label*Label*
2Object type*Object type*New property
3
Related object typeNew property
4
Related object relationshipNew property
5
Related object IDNew property
6
Batch size*New property
7Execute during previewExecute during previewNew property


Dynamics CRM Create for the On-Premises Version

Refer to Dynamics CRM Create for more information about this Product Snap. 

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines, select the account and configure the new account properties as required (or if or a validation failure error occurs).
  • The Field Snap does not suggest the target schema and hence the ID is passed using the upstream Snap. For the Product Snap, the ID is passed either directly or via the upstream Snap by enabling the expression of the ID property.
  • For the Field Snap, the output preview displays the ID of the record. For the Product Snap, the output preview displays the GUID, original data, and the result.



Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

Label*

Label*
2Object type*

Object type*


3Related object typeRelated object type
4Related object relationship

Related object relationship


5Related object ID

Related object ID


6Dynamics CRM Batch Size*Batch size*Change in the property name
7Batch Continue On Error*
This property does not exist.
8Execute during previewExecute during preview

Dynamics CRM Delete

The Dynamics CRM Delete Snap provides functionality to delete objects in Microsoft Dynamics CRM. 

Dynamics CRM Delete for the Online Version

Refer to Dynamics CRM Delete for more information about this Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines, select the account and configure the new account properties as required (or if a validation failure error occurs).
  • The Field Snap does not suggest the target schema and hence the ID is passed using the upstream Snap. For the Product Snap, the ID is passed either directly or via the upstream Snap by enabling the expression of the ID property.
  • For the Field Snap, the output preview displays the ID of the record. For the Product Snap, the output preview displays the GUID, original data, and the result.


Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

Label*

Label*
2Object type*

Object type*


3
ID*New property
4
Batch size*New property
5Execute during previewExecute during preview

Dynamics CRM Delete for the On-Premises Version

Refer to Dynamics CRM Delete for more information about this Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines, select the account and configure the new account properties as required (or if a validation failure error occurs).
  • The Field Snap does not suggest the target schema and hence the ID is passed using the upstream Snap. For the Product Snap, the ID is passed either directly or via the upstream Snap by enabling the expression of the ID property.
  • For the Field Snap, the output preview displays the ID of the record. For the Product Snap, the output preview displays the GUID, original data, and the result.


Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

Label*

Label*
2Object type*

Object type*


3
ID*New property
4
Batch size*New property
5Execute during previewExecute during preview

Dynamics CRM Read

The Dynamics CRM Read Snap provides functionality to read records from Microsoft Dynamics CRM.

Dynamics CRM Read for the Online Version

Refer to Dynamics CRM Read for more information about this Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines, select the account and configure the new account properties as required (or if a validation failure error occurs).
  • The Field Snap does not suggest the target schema and hence the ID is passed using the upstream Snap. For the Product Snap, the ID is passed either directly or via the upstream Snap by enabling the expression of the ID property.
  • For the Field Snap, the output preview displays the ID of the record. For the Product Snap, the output preview displays the GUID, original data, and the result.

Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

Label*

Label*


2Object type*

Object type*


3
ID New property
4
Page SizeNew property
5
Start Page NumberNew property
6
Max Page NumberNew property
7
Include name Fields
8Execute during previewExecute during preview

Dynamics CRM Read for the On-Premises Version

Refer to Dynamics CRM Read for more information about this Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines, select the account and configure the new account properties as required (or if a validation failure error occurs).
  • The Field Snap does not suggest the target schema and hence the ID is passed using the upstream Snap. For the Product Snap, the ID is passed either directly or via the upstream Snap by enabling the expression of the ID property.
  • For the Field Snap, the output preview displays the ID of the record. For the Product Snap, the output preview displays the GUID, original data, and the result.



Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

Label*

Label*


2Object type*

Object type*


3
ID New property
4
Page SizeNew property
5
Start Page NumberNew property
6
Max Page NumberNew property
7
Include name fields
8Execute during previewExecute during preview

Dynamics CRM Search

Dynamics CRM Search for the Online Version

Refer to Dynamics CRM Search for more information about this Product Snap.

The Product CRM Search Snap has a different FQID by virtue of its functionality. The Field CRM Search Snap uses an XML format for an input document while the Product CRM Search Snap uses the filter attributes to perform a search.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines. The Snap appears red because the Field Snap has already been deleted. Replace the Field Snap with a Product Snap from the catalog. Select the account and configure the new properties as required. 
  • Validate the pipeline.

The following images show the respective Field and the Product Search Snaps. Notice the FQIDs are different for the Snaps, the <class version> is different while the <class id> remains the same. 



Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

Label*

Label*


2

Object type*

New property
3
Page SizeNew property
4

Start Page Number

New property
5

Max Page Number

New property
6
FilterNew property
7
Output attributesNew property
8

Fetch XML Query*


This property does not exist.
9Include name fields
This property does not exist.
10Execute during preview
This property does not exist.

Dynamics CRM Search for the On-Premises Version

Refer to Dynamics CRM Search for more information about this Product Snap.


Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

Label*

Label*
2

Object type*

New property
3
Page SizeNew property
4

Start Page Number

New property
5

Max Page Number

New property
6

Filter

New property
7

Output attributes

New property
8Execute during preview
This property does not exist.
9Fetch XML Query*
This property does not exist.

Dynamics CRM Update

The Dynamics CRM Update Snap provides functionality to update an existing record in Microsoft Dynamics CRM based on the input document field values that match the Dynamics CRM object schema field names.

Dynamics CRM Update for the Online Version

Refer to Dynamics CRM Update for more information about this Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines, select the account and configure the new account properties as required (or if a validation failure error occurs).
  • The Field Snap does not suggest the target schema and hence the ID is passed using the upstream Snap. For the Product Snap, the ID is passed either directly or via the upstream Snap by enabling the expression of the ID property.
  • For the Field Snap, the output preview displays the ID of the record. For the Product Snap, the output preview displays the GUID, original data, and the result.

Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

Label*

Label*


2Object type*

Object type*


3
ID*New property
4
Related object typeNew property
5

Related object relationship

New property
6

Related object ID

New property
7
Batch size*New property
8Execute during previewExecute during preview


Dynamics CRM Update for the On-Premises Version

Refer to Dynamics CRM Update for more information about this Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines, select the account and configure the new account properties as required (or if a validation failure error occurs).
  • The Field Snap does not suggest the target schema and hence the ID is passed using the upstream Snap. For the Product Snap, the ID is passed either directly or via the upstream Snap by enabling the expression of the ID property.
  • For the Field Snap, the output preview displays the ID of the record. For the Product Snap, the output preview displays the GUID, original data, and the result.



Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

Label*

Label*
2Object type*

Object type*


3
ID*New property
4Related object typeRelated object type
5Related object relationship

Related object relationship


6Related object ID

Related object ID


7Dynamics CRM Batch Size*Batch size*Change in the property name
8Batch Continue On Error*
This property does not exist.
9Execute during previewExecute during preview

Dynamics CRM Upsert

The Dynamics CRM Upsert Snap provides functionality to update an existing record or insert a new record in Microsoft Dynamics CRM based on the input document field values that match the Dynamics CRM object schema field names.

Dynamics CRM Upsert for the Online Version

Refer to Dynamics CRM Upsert for more information about this Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines, select the account and configure the new account properties as required (or if a validation failure error occurs).
  • For the Product Snap:
    • The object can be created or updated.
    • The ID can be passed directly in the Snap itself for updating the Object.
    • The output preview displays the GUID, original data, and the result



Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

The Dynamics CRM Upsert Snap is not available on the Field Snap pack

Label*
2

Object type*


3ID
4Related object type
5

Related object ID


6This property does not exist.
7
This property does not exist.
8Upsert Multiple ObjectsNew property
9Upsert Query fields
10Execute during preview


Dynamics CRM Upsert for the On-Premises Version

Refer to Dynamics CRM Upsert for more information about this Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, then go to the Snap in the pipelines, select the account and configure the new account properties as required (or if a validation failure error occurs).
  • The Field Snap does not suggest the target schema and hence the ID is passed using the upstream Snap. For the Product Snap, the ID is passed either directly or via the upstream Snap by enabling the expression of the ID property.
  • For the Field Snap, the output preview displays the ID of the record. For the Product Snap, the output preview displays the GUID, original data, and the result.


Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1

Label*

Label*
2Object type*

Object type*


3
ID
4Related object typeRelated object type
5Related object ID

Related object ID


6Dynamics CRM Batch Size*This property does not exist.
7Batch Continue On Error*
This property does not exist.
8
Upsert Multiple ObjectsNew property
9Upsert Query fieldsUpsert Query fields
10Execute during previewExecute during preview

Important Notes

  • Reload the Designer page after deleting the Field Snap Pack so the latest version is displayed in the catalog.
  • Verify and validate the accounts for all the Snaps.
  • Verify for the Info section of the Search Snap, specifically because the FQID is different for this Snap (unlike the other Product CRM Snaps).
  • After migration, verify the output preview of Dynamics CRM Create Snap to make sure the ID is displayed as GUID.
  • For the Dynamics CRM Delete Snap, make sure the ID(s) are passed using the Snap settings. For the Field Snap, the ID(s) were passed via the upstream Snap.