Skip to end of banner
Go to start of banner

Migration from the Field to Productized Snap Pack - Microsoft Dynamics AX

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

This document helps users migrate from the field-developed Microsoft Dynamics AX Snap Pack to the product version of the Microsoft Dynamics AX 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 AX Snap Pack.


Migration to the Productized Snap Packs

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-msdynamicsax-create_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-msdynamicsax-create_2).

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

          

Migrating from the Field to the Product Versions with a Different 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 for the Field Snap Pack (for example, 18 pipelines).
  5. Create the new accounts in the pipelines or from the Manager interface.
  6. For all existing pipelines that have a Field Snap, update the pipelines with the respective Product Snap:
    1. Drag the Product Snap from the catalog.
    2. Configure the Accounts/properties for the Product Snap.
    3. Replace the Field Snap with the Product Snap.
    4. Validate the pipeline.
    5. Repeat these steps for all the impacted pipelines.
  7. Navigate to Manager > Snap Statistics and note the total number of pipelines associated with the Field and the Product Snap Packs. If the migration is complete and you have successfully updated all the Snaps:
    • The total number of pipelines associated with the Product Snap Pack should match the total number of pipelines that were associated with the Field Snap Pack in step 4. (for example, 18 pipelines).
    • The Field Snap Pack should show  '0 pipelines' - to indicate the Field Snap Pack is no longer used in any pipeline.
  8. Delete the Field Snap Pack from SnapLogic Manager: 
    1. Find the project in which the Field Snap Pack is located.
    2. Delete the Field Snap Pack and then delete the old accounts. 


If you delete the Field Snap Pack before replacing each Field Snap in the pipelines, the Field Snaps contained in the impacted pipelines appear red - which means they have failed to execute. Instead, SnapLogic recommends that you wait until all the Field Snaps are deleted from all pipelines and replaced with Product Snaps before you delete the Field Snap Pack. This way, the pipelines you haven't updated yet are still functional (since the Snap FQIDs are different) and can be validated, too. It is always safe to wait and delete the Field Snap Pack post migration because you can get the pipeline statistics before and after the migration to compare the results.

 

Microsoft Dynamics AX Account 

The Product On-premises version of Dynamics AX Snap Pack consists of account that support the On-Premises: 

UI changes on the Product version

  • There is only one account currently on the Product version and be provided with the respective settings.
  • The dynamic accounts for the Dynamics AX Snap Pack are available for the Product version, however, the values are passed using the pipeline parameters. 

Passing the values dynamically using the pipeline parameters

Values passed (Username, Password and Domain) to the Dynamics AX Account using the pipeline parameters:  


     

Microsoft Dynamics AX NTLM account

Refer the Dynamics AX Accounts for more information.

  • The * mark in the property represents as mandatory Fields
  • Pass the values dynamically using the pipeline parameters for the Dynamic Account (view the screenshots in the above Account section) 



Field Snap PackProduct Snap PackChange on the Product Feature
1Label*Label*No change
2Username*Username*No change
3Password*Password*No change
4Domain*Domain*

No change

5AIF Endpoint*
6Object Type*

7AX Company Nme

8Remove Nil XML Nodes

Microsoft Dynamics AX Create 

The Dynamics AX Create Snap creates records in Dynamics AX instance. This Snap uses Microsoft Dynamics AX Application Integration Framework (AIF) to communicate with Microsoft Dynamics AX 2012 servers. 

Refer the Documentation Dynamics AX Create to know more about the Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, go to the Snap in the pipelines and configure the new properties as required.
  • Note to provide the mandatory fields such as AIF Endpoint, Object Type, ID Key and so on for the pipeline to validate/execute.
  • Verify the Info section, the Product AX Create Snap appears with the updated FQID and the Snap Pack build number. 
  • The output preview displays the Original data and the result (Key Field and Value) for the Product Snap.



Field Snap Pack PropertiesProduct Snap Pack PropertiesChange on the Product Feature
1Label*Label*
2
Company NameNew property
3
AIF Endpoint*New property
4
Object Type*New property
5
Execute during preview

Microsoft Dynamics AX Delete

The Dynamics AX Delete Snap deletes records from the Dynamics AX instance according to a specific ID key and ID value.

Refer the Documentation Dynamics AX Delete here to know more about the Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, go to the Snap in the pipelines and configure the new properties as required.
  • The target schema is non suggestible for the Product Delete Snap (suggestible for the Field Snap), however, the ID value is passed directly into the Snap or can pass the values via an upstream by enabling the expressions for the Id key and Id value properties in the Snap. 
  • Note to provide the mandatory fields such as AIF Endpoint, Object Type, ID Key and so on for the pipeline to validate/execute.
  • Verify the Info section, the Product AX Delete Snap appears with the updated FQID and the Snap Pack build number. 
  • The output preview displays the Original data and the result ( Key Field and Value) for the Product Snap.



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

Label*

Label*
2 

Company

New property
3
AIF Endpoint*New property
4
Object Type*New property
5 Id key*New property
6
Id value*New property
7Execute during previewExecute during preview

 

Microsoft Dynamics AX Read

This Dynamics AX Read Snap reads record from the Dynamics AX instance according to a specific ID key and ID value.

Refer the Documentation Dynamics AX Read here to know more about the Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, go to the Snap in the pipelines and configure the new properties as required.
  • Note to provide the mandatory fields such as AIF Endpoint, Object Type, ID Key and so on for the pipeline to validate/execute.
  • Verify the Info section, the Product AX Read Snap appears with the updated FQID and the Snap Pack build number. 
  • The output preview displays the Original data and the result ( Key Field and Value) for the Product Snap.
  • The target schema is non suggestible for the Product Read Snap (suggestible for the Field Snap), however, the ID value is passed directly into the Snap or can pass the values via an upstream by enabling the expressions for the Id key and Id value properties in the Snap. 



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

Label*

Label*


2

Company

New property
3
AIF Endpoint*New property
4
Object Type*New property
5
Id keyNew property
6
Id valueNew property
7 Execute during previewNew property

Microsoft Dynamics AX Search 

The Product AX Search Snap searches records from Dynamics AX 2012 instance using identifiers such as Company, Object Type, and so on based on specified search queries.

Refer the Documentation Dynamics AX Search here to know more about the Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, go to the Snap in the pipelines and configure the new properties as required.
  • Note to provide the mandatory fields such as AIF Endpoint, Object Type, ID Key and so on for the pipeline to validate/execute.
  • Verify the Info section, the Product AX Search Snap appears with the updated FQID and the Snap Pack build number. 
  • The output preview displays the Original data and the result ( Key Field and Value) for the Product Snap.
  • The target schema is non suggestible for the Product Read Snap (suggestible for the Field Snap), however, the ID value is passed directly into the Snap or can pass the values via an upstream by enabling the expressions for the Id key and Id value properties in the Snap. 



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

Label*

Label*


2
CompanyNew property
3
AIF Endpoint*New property
4

Object Type*

New property
5

Fetch Keys only (check box)

New property
6Dynamics AX Query TableQuery CriteriaRenamed property
7Execute during PreviewExecute during Preview

Microsoft Dynamics AX Update

The Dynamics AX Update Snap Updates an existing record in the Dynamics AX instance.

Refer the Documentation Dynamics AX Update here to know more about the Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, go to the Snap in the pipelines and configure the new properties as required.
  • Verify the Info section, the Product AX Update Snap appears with the updated FQID and the Snap Pack build number.   
  • Note to provide the mandatory fields such as AIF Endpoint, Object Type, ID Key and so on for the pipeline to validate/execute.
  • The output preview displays the Original data and the result (Key Field and Value) for the Product Snap.

 


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

Label*

Label*


2

Company

New property
3
AIF Endpoint*New property
4
Object Type*New property
5

Id key*

New property
6

Id value*

New property
7Execute during previewExecute during preview

 

Microsoft Dynamics AX Execute

This Dynamics AX Execute Snap calls the Dynamics AX AIF endpoint using the incoming data and writes out a SOAP response. This is a new Snap in the Product MS Dyamics AX Snap Pack.

Refer the Documentation Dynamics AX Execute here to know more about the Product Snap.

Post migration steps:

  • Refresh the page after deleting the Field Snap Pack, drag the Snap on the canvas and configure the new properties as required.
  • Note to provide the mandatory fields such as AIF Endpoint, Object Type, ID Key and so on for the pipeline to validate/execute. 



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


 



 
The Microsoft Dynamics AX Execute Snap does not exist in the Field Snap Pack.









Label*

New property
2

WSDL URL*

New property
3Service*New property
4Endpoint*New property
5Operation*New property
6Timeout*New property
7Trust all certificatesNew property
8Output SOAP envelopeNew property
9Output HTTP response headersNew property
10SSL ProtocolNew property
11Response to null SOAP call return valueNew property
12Maximum request attemptsNew property
13Retry intervalNew property
14Success conditionNew property
15Customize EnvelopeNew property
16HTTP headerNew property
17AttachmentsNew property
18Execute during previewNew property



Important Notes

  • Reload the Designer page after deleting the Field Snap pack so the latest version is displayed on the catalog.
  • Verify and validate the accounts for all the Snaps.
  • Verify the Info section in all the Snaps for the latest FQIDs.  
  • Note to provide the mandatory fields such as AIF Endpoint, Object Type, ID Key and so on for the pipeline to validate/execute.
  • No labels