Nav

Microsoft Dynamics AX Connector Reference

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Gateway Username Password

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances as it sees fit.

Gateway Username Password Connection Type

Parameters

Name Type Description Default Value Required

Disable SSL Certificate validation

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception. To prevent this it is possible to disable the CN (Common Name) check. Note: this is not recommended for production environments.

false

Gateway Router Service Address

String

The address of the gateway service that routes the requests to the CRM instance (https://mygateway.com/router).

x

Aos Endpoint Port

String

For overriding the port returned in the Service’s WSDL.

Connection Timeout

Number

Used to set connection timeout for connector requests. This optional value is in milliseconds (0 for unlimited timeout).

Receive Timeout

Number

Use to set receiving timeout for connector requests. This optional value is in milliseconds (0 for unlimited timeout).

Company

String

Sets the company to use within all calls (this setting can be overridden using the 'dynamicsax.callcontext.company' outbound property).

Language

String

Sets the language to use within all calls (this setting can be overridden using the 'dynamicsax.callcontext.language' outbound property).

Logon As User

String

Sets the user to use within all calls (this setting can be overridden using the 'dynamicsax.callcontext.logonAsUser' outbound property).

Message Id

String

Sets the message id to use within all calls (this setting can be overridden using the 'dynamicsax.callcontext.messageId' outbound property).

Partition Key

String

Sets the partition key to use within all calls (this setting can be overridden using the 'dynamicsax.callcontext.partitionKey' outbound property).

Username

String

x

Password

String

x

Aos Server Name

String

The Application Object Server (AOS) WSDL server name.

x

Aos Wsdl Port

String

The Application Object Server (AOS) WSDL port.

x

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy

Associated Operations

  • Invoke Document Service Operation

  • Query Table

  • Static Query

Invoke Document Service Operation

<microsoft-dynamics-ax:invoke-document-service-operation>

Executes a Document Service operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Action Input

Binary

#[payload]

Streaming Strategy

  • Repeatable In Memory Iterable Type

  • Repeatable File Store Stream Type

Configure to use repeatable and their behavior.

Service

String

The service group name (first level metadata key)

x

Action

String

The action name (second level metadata key)

x

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

  • Reconnect

  • Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations

  • dynamics-ax-config

Throws

  • MICROSOFT-DYNAMICS-AX:CONNECTIVITY

  • MICROSOFT-DYNAMICS-AX:INVALID_SESSION

  • MICROSOFT-DYNAMICS-AX:RETRY_EXHAUSTED

  • MICROSOFT-DYNAMICS-AX:TRANSACTION

  • MICROSOFT-DYNAMICS-AX:TRANSFORMATION

  • MICROSOFT-DYNAMICS-AX:UNKNOWN

  • MICROSOFT-DYNAMICS-AX:VALIDATION

Query Table

<microsoft-dynamics-ax:query-table>

Create a new record.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

x

Items Per Page

Number

x

Streaming Strategy

  • Repeatable In Memory Iterable

  • Repeatable File Store Iterable

Configure to use repeatable and their behavior.

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

  • Reconnect

  • Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

  • dynamics-ax-config

Throws

  • MICROSOFT-DYNAMICS-AX:CONNECTIVITY

  • MICROSOFT-DYNAMICS-AX:INVALID_SESSION

  • MICROSOFT-DYNAMICS-AX:TRANSACTION

  • MICROSOFT-DYNAMICS-AX:TRANSFORMATION

  • MICROSOFT-DYNAMICS-AX:UNKNOWN

  • MICROSOFT-DYNAMICS-AX:VALIDATION

Static Query

<microsoft-dynamics-ax:static-query>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Static Query Name

String

x

Ranges

Object

#[payload]

Items Per Page

Number

Streaming Strategy

  • Repeatable In Memory Stream

  • Repeatable File Store Iterable

Configure to use repeatable and their behavior.

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

  • Reconnect

  • Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

  • dynamics-ax-config

Throws

  • MICROSOFT-DYNAMICS-AX:CONNECTIVITY

  • MICROSOFT-DYNAMICS-AX:INVALID_SESSION

  • MICROSOFT-DYNAMICS-AX:TRANSACTION

  • MICROSOFT-DYNAMICS-AX:TRANSFORMATION

  • MICROSOFT-DYNAMICS-AX:UNKNOWN

  • MICROSOFT-DYNAMICS-AX:VALIDATION

Reconnection Type

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

  • Reconnect

  • Reconnect Forever

The reconnection strategy to use

Reconnect Type

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever Type

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Expiration Policy Type

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Repeatable In Memory Stream Type

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream Type

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Repeatable In Memory Iterable Type

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially allow to keep in memory to consume the stream and provide random access to the stream. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

By how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, and to raise a STREAM_MAXIMUM_SIZE_EXCEEDED error when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable Type

Field Type Description Default Value Required

Max In Memory Size

Number

This is the maximum amount of instances to keep in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed