Microsoft Dynamics AX Read (Deprecated)

Microsoft Dynamics AX Read (Deprecated)

On this Page

Snap type:

Read

Description:

This Snap reads record 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 or flows:

The Snap collects target Dynamics AX instance information from user input or pipeline parameters, and it gets the ID Key and ID Value from user input, pipeline parameters or an upstream Document. It will then use this information to send a SOAP request to the corresponding AIF inbound port on the Dynamics AX instance. The SOAP response from the server will be 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.

  • Output: This Snap has one Document output view that passes the records to the downstream Snaps.

Prerequisites:

1. Microsoft Dynamics AX 2012 instance

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

Limitations and Known Issues:

Works in Ultra Tasks.

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

Input

This Snap has at most one document input view.

Output

This Snap has exactly one document output view.

Error

This Snap has at most one document error view and produces zero or more documents in the view.

Troubleshooting:

[None]

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.

Company

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

Example: SnapLogic

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.

Examplehttps://samplelink.crm-snaplogic.com/snapfest 

Default value: [None]

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

Default value: [None]

Id key

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: Entity Keys Overview

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

The value of the record's ID. It reflects the EntityKey.value in the AIF request. See: Entity Keys Overview

When no ID value is provided, the Snap lists out all the records for the given object type. There can be multiple AX objects in the output document as a JSON array. When the ID value is set, there will be at most one AX object in the output document as a JSON object. However, to read a large data sets, you can use the Search Snap.

Example: 123

Default value: [None]

Snap Execution

Select one of the following three modes in which the Snap executes:

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

Default ValueExecute only
Example: Validate & Execute

Examples


Basic Use Case

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

The pipeline is using a Mapper to simulate an upstream pipeline, and generate a key and value for the Read Snap.

The Dynamics AX Read Snap is configured as shown:

AIF Endpoint

The AIF endpoint is our inbound port URI. Please replace it with your own URI.

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