Microsoft Dynamics AX Update [Deprecated]

On this page

Snap type:Write
Description:

This Snap Updates an existing record in the Dynamics AX instance.

ETL Transformations & Data Flow

This Snap enables the following ETL operations or flows:

  • Extract data from the upstream snap containing the data for updating the Dynamics AX object(s)
  • Transform the input document into a SnapLogic friendly JSON Document
  • Load the data into the Dynamics AX Update Snap to update the AX object(s)

Expected upstream Snaps: Mapper Snap

Expected downstream Snaps: None

Input & Output

  • InputNeeds to have an upstream Snap that contains the mandatory fields for updating the existing AX object. Mapper snap is a preferred upstream snap as it populates the input schema for the selected Dynamics AX Object Type.

  • Output: A document with the result set. If the update is successful, then the output document will contain the IDs of the updated AX object(s)

Modes

Prerequisites:

1. Microsoft Dynamics AX 2012 R3 instance

2. An enhanced integration inbound port on the AX instance that containing the Update operation configured


Limitations and Known Issues:

NA

Configurations:

Account & Access

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Microsoft Dynamics AX Accounts [Deprecated] for information on setting up this type of account.

Views

InputThis Snap has exactly one document output view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.
Troubleshooting:For troubleshooting purposes, try performing the same operation directly on the User Interface or by sending the appropriate SOAP request to the Dynamics AX AIF Endpoint. Use Soap UI (version 4.6.3) and collect the necessary data. To see if there are any inconsistencies, compare the data used in the User Interface or Soap UI with the SnapLogic pipelines.

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.

CompanyThe company name on which to perform the read operation. The company should be defined on the AX instance side. The property can be provided through user input or pipeline parameters.
AIF endpointRequired. URI of the inbound port. You may find the information at the Dynamics AX instance: System administration > Setup > Services and Application Integration Framework > Inbound ports > [Your port name] > URI.
Object type

Required. The object type on which to perform the read operation. The value of the property depends on the object types contained in the target inbound port.

Example: Customer

Id key

Required. The field name of the record's Id. The field names are different among different object types. It reflects the EntityKey.field in the AIF request. See: https://msdn.microsoft.com/en-us/library/aa638403(v=ax.10).aspx

The Id Key property is suggestible and:

  • The Object type must support the findKeys operation.
  • The findKeys operation must be included in the inbound port.
  • There must be at least one record of the object type in the corresponding company (or DAT if not given).

The property can be provided through user input or pipeline parameters.

Example: AccountNum

Id value

Required. The value of the record's Id. It reflects the EntityKey.value in the AIF request. See: https://msdn.microsoft.com/en-us/library/aa638403(v=ax.10).aspx

When no Id value is provided, the Snap lists out all the records for the given object type. However, to read a large data sets, you can use the Search Snap.

Basic Use Case


In this pipeline, the Dynamics AX Update Snap updates the records fully in a Customer Object type with an Id key and an Id value. The pipeline reads the records from an Object type, maps the required records to the fields to be updated using the AX Update Snap. 

The Mapper Snap passes the values to be updated in the respective fields of the Object type:


The Dynamics AX Snap updates the Object type, Customer:


The successful execution of the pipeline displays the following output preview with a success message:


Typical Snap Configuration


Key configuration of the Snap lies in how the values are passed. The values can be passed: 

  • Without Expressions

Values are passed directly into the Snap.



  • With Expressions: In the following example, the values are passed using upstream as well as using the pipeline parameters in the same pipeline.

 

  • Query from an upstream Snap: Mapper Snap passing the required statements to the Dynamics AX Update Snap: 


  • Using Pipeline parameters: Value (endpoint) passed as pipeline parameters:

 

Downloads

Important steps to successfully reuse Pipelines

  1. Download and import the pipeline into the SnapLogic application.
  2. Configure Snap accounts as applicable.
  3. Provide pipeline parameters as applicable.

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates

February 2024

main25112

 

Stable

Updated and certified against the current SnapLogic Platform release.

August 2023main22460 StableUpdated and certified against the current SnapLogic Platform release.

May 2023

main21015 

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
November 2022main18944 StableUpgraded with the latest SnapLogic Platform release.
August 2022main17386 StableUpgraded with the latest SnapLogic Platform release.
4.29main15993StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.

4.27

main12833

 

Stable

Upgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
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.21 Patch421patches5851 Latest

Fixed an issue in the Microsoft Dynamics AX Execute Snap that fails when using the Apache HTTPComponents library API if the request XML has Unicode characters. 

4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20 Patch msdynamicsax8763 Latest

Fixed the Microsoft Dynamics AX Execute Snap to use the correct header list for returning the HTTP response code.

4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19 Patch msdynamicsax8376 Latest

The MS Dynamics AX Snaps have a Library API field. When the selected value is the non-default HTTP Components, there was a breaking change in the structure of the output response document between 4.19 GA version (snapsmrc528) and the latest patch version (msdynamicsax8376). 

We recommend that if you want to use the non-default (non-CXF) value for Library API, then you must use this latest patch version as subsequent GA releases may result in Pipeline executions failing. 

If your current or new Pipelines use CXF as the Library API value, or do not handle SOAP response bodies greater than 1000 lines, or do not rely on NTLM authentication, then you can continue using your existing Snap Pack version (stable distribution – snapsmrc528).

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.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.11snapsmrc465
 
Stable

Introduced the MS Dynamics AX Snap Pack for this release with the Dynamics AX NTLM account type and includes the Snaps, Dynamics AX Create, Dynamics AX Read, Dynamics AX Delete, Dynamics AX Execute, Dynamics AX Update and Dynamics AX Search.