Microsoft Dynamics AX Create [Deprecated]

On this Page

Snap Type:Write
Description:

This 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. There are mandatory input fields that must be provided by means of the input view to create AX objects of different object types. To decide which fields are mandatory, look at the Dynamics AX server's configuration.

ETL Transformations & Data Flow

This Snap enables the following ETL operations or flows:

  1. Extract data from the upstream Snap containing the data for creating the Dynamics AX object(s)
  2. Transform the input document into a SnapLogic-friendly JSON Document
  3. Load the data into the Dynamics AX Create Snap to create the AX object(s) Input & Output
  • InputNeeds to have an upstream Snap that contains the mandatory fields for creating the 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 creation is successful, then the output document will contain the ID key name and ID key value of the created AX object. The ID key name is usually different for each object type.

Modes

Prerequisites:

1. Microsoft Dynamics AX 2012 instance

2. An enhanced integration inbound port on the AX instance that has one or more create operations set up

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 at most one document input 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:

Settings

Label

Required. The name for the Snap.

Company

The company name on which to perform the create operation. The company should be defined on the AX instance side. The property can be provided through user input or pipeline parameters.

Default value: [None]

AIF endpoint

Required. 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.

Example: http://<host_name>/MicrosoftDynamicsAXAif60/CustomerService/xppservice.svc

Default value: [None]

Object type

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

Example: Customer

Default value: [None]

Snap execution

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Examples


Basic Use Case

The following pipeline describes how the Snap functions as a standalone Snap in a pipeline:

The pipeline uses a Mapper Snap to simulate the upstream pipeline that provides the data that is used by the Dynamics AX Create Snap to create an AX object.

Saving the pipeline allows the Dynamics AX Create Snap to populate the input schema to Mapper. This makes it easier to pick the fields:

The Dynamics AX Create Snap is configured as below:

The exported pipeline is available for download in the Downloads section below. 

Typical Configuration

Key configuration of the Snap lies in how the data is passed. There are two ways of doing so in the Microsoft Dynamics AX Create Snap:

  • Without Expressions

Data is passed directly into the Snap:

  • With Expressions
    • Using Pipeline parameters: Data is passed as a pipeline parameter. The parameters to be applied can be selected by enabling the corresponding checkbox under the Capture column.

Configuring using upstream parameters

Here are some JSON representations of the mandatory fields for AX object types. They can be copy-paste to JSON Generator Snap and used as the input for the Dynamics AX Create Snap.

Customer
[
  {
    "CustomerServiceCreateRequest": {
      "Customer": {
        "CustTable": [
          {
            "CustGroup": "TestGroup",
            "Currency": "USD",
            "Name": "test1",
            "class": "entity",
            "AccountNum": "terence-010",
            "DirParty": [
              {
                "class": "entity",
                "Name": "test create1",
                "xsiType": "AxdEntity_DirParty_DirOrganization"
              }
            ]
          }
        ]
      }
    }
  }
]


SalesOrder
[
  {
    "SalesOrderServiceCreateRequest": {
      "SalesOrder": {
        "SalesTable": [
          {
            "CustAccount": "DAT-000001",
            "LanguageId": "en-us",
            "class": "entity",
            "PurchOrderFormNum": "1234",
            "ReceiptDateRequested": "2017-10-10"
          }
        ]
      }
    }
  }
]

Advanced Use Case

The following describes a pipeline, with a broader business logic involving multiple ETL transformations. It shows how, in an enterprise environment, Create, Read, Search and Delete functionalities can typically be used. The pipeline download link is below.  

This pipeline moves records from a Salesforce instance to the Dynamics AX instance, where the records are created, searched and read for the required IDs and deleted as needed.

The ETL Transformations:

  1. Extract: The Salesforce Read Snap retrieves the records from an object type from the Salesforce instance.
  2. Transform: The Mapper Snap maps the records from the Salesforce object to the Dynamics AX instance.
  3. Load:The Dynamics AX Create Snap creates the records on the AX instance.

The pipeline further uses:

  • The Mapper Snap maps the records to be searched from an Object type.
  • The Dynamics AX Search Snap searches all the records.
  • The JSON Splitter Snap splits the the records based on the field names.
  • The Dynamics AX Read Snap reads the records based on the given fields. They are retrieved from the bottom using the Tail Snap.
  • The Mapper Snap maps the records to be deleted using the Dynamics AX Delete Snap.


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.


  File Modified

File Adanced Use Case_MS Dynamics AX Create.slp

Nov 02, 2017 by Mohammed Iqbal

File Basic Use Case_MS Dynamics AX Create.slp

Nov 02, 2017 by Mohammed Iqbal

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.