The main purpose of this documentation is to help the user migrate from the field developed Microsoft Dynamics AX Snap pack to the productized version of the Microsoft Dynamics AX Snap Pack. The list below provides the information on each item with reference to the Field and the productized version. For more information, refer our product documentation site.
Migration to the Productized Snap Packs
Before the migration begins, it is important to identify and note if the Snap consists of the same FQID as before or a different version (your Technical Account Manager would assist the process).
FQID for a Snap
FQID consists of the Snap class ID and the class version and can be located on the Info section of the Snap. Typically, a migration for a Snap will go from "<class_id>_<class_version>" to "<class_id>_<class_version + 1>". The Snap is updated with its version to match the incremented class version.
Also, the steps for the process of migration depends on whether or not the Snap gets the same FQID as that of the Field Snap.
Locating the FQID for a Snap:
Go to the Info tab on the Snap to locate the Class FQID. In the following screen shots, note the FQIDs are same for the Field and the productized Snap respectively, com-snaplogic-snaps-msdynamicsax-create_1, meaning the <class_id>_<class_version> are the same. The productized Snaps with different FQIDs would have an incremented version number (<class_id>_<class_version + 1>).
The following images display the FQIDs (highlighted) being the same for the AX Create Snap on the Field and the productized versions respectively. Note 'A51' and 'snapsrc890' are the Snap Pack versions that change with every build.
The respective steps are enumerated below:
Steps to migrate from the Field to the productized versions with a different FQID
- Subscribe to the productized Snap Pack
- As an org admin, go to the Manager→Organizations→Select the desired productized Snap Pack (your Technical Account Manager will initiate the process and inform when enabled)
- The productized Snap Pack is displayed on the Snap catalog once the application is refreshed
- As an org admin, go to the Manager→Snap Statistics→Note the total number of pipelines belonging to the Field Snap Pack (For example, 18 pipelines)
- Get the list of pipelines to update from all the projects
- Create the new accounts in the pipelines or from the Manager interface
- Update all the existing pipelines that have a Field Snap with the respective productized Snap
- Drag the productized Snap from the catalog, configure the Accounts/properties, replace the Field Snap with it and validate the pipeline
- Repeat the process for all the impacted pipelines
- Go to the Snap Statistics and make a note the total number of pipelines on the Field and the Productized Snap Packs
- The Productized Snap Pack should display the total number of pipelines as that of its Field Snap Pack (i,e. 18 pipelines)
- The Field Snap Pack must display '0 pipelines' and that confirms the complete migration
- Delete the Field Snap Pack from the Manager interface. In order to delete:
- Find the project in which the Field Snap Pack is located
- Delete the Field Snap Pack and then delete the old accounts
If the Field Snap Pack is deleted after step-5, the Field Snaps within the impacted pipelines appears red meaning they had failed to execute. If deleted at the end, they would still be functional (since the FQIDs are different) and can be validated too. However, it is always safe to delete the Field Snap Pack post migration because the user can get the pipeline statistics before and after the migration to the productized Snap Pack.
Microsoft Dynamics AX Account
The productized On-premises version of Dynamics AX Snap Pack consists of account that support the On-Premises:
- Dynamics AX NTLM account
UI changes on the Productized version
- There is only one account currently on the productized version and be provided with the respective settings.
- The dynamic accounts for the Dynamics AX Snap Pack are available for the productized 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 Pack | Productized Snap Pack | Change on the Productized Feature | |
---|---|---|---|
1 | Label* | Label* | No change |
2 | Username* | Username* | No change |
3 | Password* | Password* | No change |
4 | Domain* | Domain* | No change |
5 | AIF Endpoint* | ||
6 | Object Type* | ||
7 | AX Company Nme | ||
8 | Remove 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 productized 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 productized 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 Productized Snap.
Field Snap Pack Properties | Productized Snap Pack Properties | Change on the Productized Feature | |
---|---|---|---|
1 | Label* | Label* | |
2 | Company Name | New 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 productized 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 productized 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 productized 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 Productized Snap.
Field Snap Pack Properties | Productized Snap Pack Properties | Change on the Productized 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 | |
7 | Execute during preview | Execute 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 productized 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 productized 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 Productized Snap.
- The target schema is non suggestible for the productized 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 Properties | Productized Snap Pack Properties | Change on the Productized 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 | |
7 | Execute during preview | New property |
Microsoft Dynamics AX Search
The productized 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 productized 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 productized 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 Productized Snap.
- The target schema is non suggestible for the productized 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 Properties | Productized Snap Pack Properties | Change on the Productized Feature | |
---|---|---|---|
1 | Label* | Label* | |
2 | Company | New property | |
3 | AIF Endpoint* | New property | |
4 | Object Type* | New property | |
5 | Fetch Keys only (check box) | New property | |
6 | Dynamics AX Query Table | Query Criteria | Renamed property |
7 | Execute during Preview | Execute 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 productized 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 productized 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 Productized Snap.
Field Snap Pack Properties | Productized Snap Pack Properties | Change on the Productized 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 | |
7 | Execute during preview | Execute 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 productized MS Dyamics AX Snap Pack.
Refer the Documentation Dynamics AX Execute here to know more about the productized 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 Properties | Productized Snap Pack Properties | Change on the Productized Feature | |
---|---|---|---|
1 | The Microsoft Dynamics AX Execute Snap does not exist in the Field Snap Pack. | Label* | New property |
2 | WSDL URL* | New property | |
3 | Service* | New property | |
4 | Endpoint* | New property | |
5 | Operation* | New property | |
6 | Timeout* | New property | |
7 | Trust all certificates | New property | |
8 | Output SOAP envelope | New property | |
9 | Output HTTP response headers | New property | |
10 | SSL Protocol | New property | |
11 | Response to null SOAP call return value | New property | |
12 | Maximum request attempts | New property | |
13 | Retry interval | New property | |
14 | Success condition | New property | |
15 | Customize Envelope | New property | |
16 | HTTP header | New property | |
17 | Attachments | New property | |
18 | Execute during preview | New 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.