Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Peer edits, Phase 1
The main purpose of this documentation is to help the user migrate from the field developed Microsoft Dynamics AX Snap pack to the productized

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 the productized versionProduct versions. For more information, refer our product documentation site. to Microsoft Dynamics AX Snap Pack.


Table of Contents


Migration to the Productized Snap Packs

Before the migration begins, it is important to identify and note notice if the Snap to which you are migrating consists of the same FQID as before, or if there's a different version (your new version. See below for details. Your Technical Account Manager would assist the process)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 and can be located on the Info section . 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>". The During migration, 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 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

:

Go to Open the Info tab on the Snap to locate the Class FQID. In the following screen shots, note If the FQIDs are same for the Field and the productized Product Snap respectively(for examplecom-snaplogic-snaps-msdynamicsax-create_1, meaning the). The <class_id>_<class_version> are the same. The productized Snaps with different FQIDs would If the FQIDs are not the same, the Product Snap would typically have an incremented version number (<class_id>_<class_version + 1>for example, com-snaplogic-snaps-msdynamicsax-create_2).

The following images display the FQIDs (highlighted) being the same for the AX Create Snap on the Field and the productized versions respectively. Note 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. 

          

The respective steps are enumerated below:

 Steps to migrate

Migrating from the Field to the

productized versions

Product Versions with a

different

Different FQID

Subscribe to the productized Snap Pack As an org admin, go to the Manager→Organizations→Select the desired productized Snap Pack (your
  1. Subscribe to the Product Snap Pack. Your Technical Account Manager will initiate
the
  1. this 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)
    1. 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
    update
    1. be updated from all the projects.
    2. Make a note of the account and the Snap configuration in each impacted pipeline for the Field Snap Pack (for example, 18 pipelines).
    3. Create the new accounts in the pipelines or from the Manager interface.
    Update
    1. For all
    the
    1. existing pipelines that have a Field Snap, update the pipelines with the
    respective productized Snap 
    1. respective Product Snap:
      1. Drag
    the productized
      1. the Product Snap from the catalog
    , configure
      1. .
      2. Configure the Accounts/properties
    , replace
      1. for the Product Snap.
      2. Replace the Field Snap with
    it and validate
      1. the Product Snap.
      2. Validate the pipeline.
      3. Repeat
    the process
      1. these steps for all the impacted pipelines.
    Go
    1. Navigate to
    the Snap Statistics and make a note
    1. Manager > Snap Statistics and note the total number of pipelines
    on
    1. associated with the Field and
    the Productized
    1. the Product Snap Packs
    The Productized
    1. . 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
    display
      • match the total number of pipelines
    as that of its
      • that were associated with the Field Snap Pack
    (i,e.
      • in step 4. (for example, 18 pipelines)
     
      • .
      • The Field Snap Pack
    must display  
      • should show  '0 pipelines'
     and that confirms the complete migration
      • - to indicate the Field Snap Pack is no longer used in any pipeline.
    1. Delete the Field Snap Pack from
    the Manager interface. In order to delete:
    1. SnapLogic Manager: 
      1. Find the project in which the Field Snap Pack is located
     
      1. .
      2. Delete the Field Snap Pack and then
    delete the old accounts  InfoIf 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
      1. delete the old accounts. 


    Info

    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 are still  functional (since the FQIDs are different) and can be validated, too. However, it It is always safe to wait and delete the Field Snap Pack post migration because the user you can get the pipeline statistics before and after the migration to compare the productized Snap Packresults. 

     

    Microsoft Dynamics AX Account 

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

    UI changes on the Productized the Product version

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


    Note
    titlePassing the values dynamically using the pipeline parameters

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

    Image ModifiedImage Modified


         


    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 PackProductized Product Snap PackChange on the Productized 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 productized 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 productized 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 Productized the Product Snap.



    Field Snap Pack PropertiesProductized Product Snap Pack PropertiesChange on the Productized 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 productized 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 productized 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 productized 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 Productized the Product Snap.



    Field Snap Pack PropertiesProductized Product Snap Pack PropertiesChange on the Productized 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 productized 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 productized 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 Productized the Product Snap.
    • The target schema is non suggestible for the productized 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 PropertiesProductized Product Snap Pack PropertiesChange on the Productized 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 productized 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 productized 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 productized 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 Productized the Product Snap.
    • The target schema is non suggestible for the productized 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 PropertiesProductized Product Snap Pack PropertiesChange on the Productized 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 productized 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 productized 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 Productized the Product Snap.

     


    Field Snap Pack PropertiesProductized Product Snap Pack PropertiesChange on the Productized 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 productized the Product MS Dyamics AX Snap Pack.

    Refer the Documentation Dynamics AX Execute here to know more about the productized 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 PropertiesProductized Product Snap Pack PropertiesChange on the Productized 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.