Microsoft Dynamics AX Delete [Deprecated]

On this Page

Snap Type:

Write


Description:

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

ETL Transformations & Data Flow

This Snap enables the following ETL operations and flows:

The Snap collects target Dynamics AX instance information from user input or pipeline parameters.  The Snap gets the ID Key and ID Value from user input, pipeline parameters or the upstream Document. It uses this data to send a SOAP request to the corresponding AIF inbound port on the Dynamics AX instance. The SOAP response from the server is passed to the downstream Snaps.

Input & Output

  • InputThis Snap can have an upstream Snap that can pass a document output view such as Structure or JSON Generator.

  • OutputThis Snap has one Document output view that passes the results of the delete operations to the downstream Snaps.

Modes

Prerequisites:

1. Microsoft Dynamics AX 2012 instance

2. An enhanced integration inbound port on the AX instance that has one or more delete operations setup

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 Microsoft Dynamics AX Account for information on setting up this type of account.

Views

InputThis Snap has exactly 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 delete operation. The company should be defined on the AX instance side.

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

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.

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

Object type

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

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

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 ID value of the record that is to be deleted. It reflects the EntityKey.value in the AIF request. See: https://msdn.microsoft.com/en-us/library/aa638403(v=ax.10).aspx

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

Basic Use case


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


Successful execution of the pipeline displays the preview output shown below:


Typical Configuration


The key configuration of the Snap lies in how you pass statements to delete the Dynamics AX records. As it applies in SnapLogic, you can pass the statements in the following manner:

  • Without Expression: Directly passing the required values in the Dynamics AX Delete Snap.

  • With Expressions

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


  • Pipeline Parameter: Pipeline parameter set to pass the required statements to the Dynamics AX Delete Snap:


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 upon the field names.
  • The Dynamics AX Read Snap reads the records based on the given fields and 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 SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified

File Use_Case_Advance Dynamics AX.slp

Feb 28, 2022 by Subhajit Sengupta
 

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.