Contact Us 1-800-596-4880

Microsoft Dynamics NAV Connector 2.1 Reference - Mule 4

Limitations

  • Microsoft Dynamics NAV Connector isn’t supported in CloudHub 2.0 because the underlying CXF library requires a JDK to generate schema classes.

Dynamics Nav Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

  • NTLM

  • OAuth

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.

NTLM Connection Type

The JAXB-XJC external library is required for the NTLM and OAuth connection types for Java 8, 11, and 17:

  • JAXB-XJC v2.3.2

    • Mule runtime 4.3.0 with Java 8 and 11

    • Mule runtime 4.4.0 with Java 8 and 11

  • JAXB-XJC v2.3.9

    • Mule runtime 4.5.0 with Java 8 and 11

    • Mule runtime 4.6.0 with Java 8, 11, and 17

Parameters

Name Type Description Default Value Required

Domain

String

Domain of the Dynamics NAV instance

Username

String

The Windows username to connect to Dynamics NAV

x

Password

String

The Windows password to connect to Dynamics NAV

x

Soap Url

String

Base URL where the SOAP services are exposed in the form https://<Server>:<WebServicePort>/<ServerInstance>/WS. Example: https://hostname:7047/DynamicsNAV90/WS

x

OData Url

String

Base URL where the OData services are exposed in the form https://<Server>:<WebServicePort>/<ServerInstance>/OData. Example: https://hostname:7048/DynamicsNAV90/OData.

x

Company Name

String

Dynamics NAV Company to which connect. In case the field is left blank, the default configured one is used.

Disable SSL certificate validation

Boolean

false

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

Pooling Profile

PoolingProfile

Characteristics of the connection pool

OAuth Connection Type

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.

The JAXB-XJC external library is required for the NTLM and OAuth connection types for Java 8, 11, and 17:

  • JAXB-XJC v2.3.2

    • Mule runtime 4.3.0 with Java 8 and 11

    • Mule runtime 4.4.0 with Java 8 and 11

  • JAXB-XJC v2.3.9

    • Mule runtime 4.5.0 with Java 8 and 11

    • Mule runtime 4.6.0 with Java 8, 11, and 17

Parameters

Name Type Description Default Value Required

Username

String

The Windows username to connect to Dynamics NAV

x

Access Token

String

The Windows password to connect to Dynamics NAV

x

Soap Url

String

Base URL where the SOAP services are exposed in the form https://<Server>:<WebServicePort>/<ServerInstance>/WS. Example: https://hostname:7047/DynamicsNAV90/WS

x

OData Url

String

Base URL where the OData services are exposed in the form https://<Server>:<WebServicePort>/<ServerInstance>/OData. Example: https://hostname:7048/DynamicsNAV90/OData.

x

Company Name

String

Dynamics NAV Company to which connect. In case the field is left blank, the default configured one is used.

Disable SSL certificate validation

Boolean

false

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

Pooling Profile

PoolingProfile

Characteristics of the connection pool

Associated Operations

  • Codeunit Operation

  • OData Query

  • Page Operation

Codeunit Operation

<nav:codeunit-operation>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity

Object

#[payload]

Service

String

x

Operation

String

x

Target Variable

String

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

Target Value

String

An expression that will be evaluated 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

Any

For Configurations

  • dynamics-nav-config

Throws

  • NAV:CONNECTIVITY

  • NAV:INCORRECT_CREDENTIALS

  • NAV:RETRY_EXHAUSTED

  • NAV:UNKNOWN

OData Query

<nav:odata-query>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

x

Fetch Size

Number

x

Streaming Strategy

  • Repeatable In Memory Iterable

  • Repeatable File Store Iterable

Configure if repeatable streams should be used 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 that will be evaluated 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-nav-config

Throws

  • NAV:CONNECTIVITY

  • NAV:INCORRECT_CREDENTIALS

  • NAV:UNKNOWN

Page Operation

<nav:page-operation>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity

Object

#[payload]

Service

String

x

Operation

String

x

Target Variable

String

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

Target Value

String

An expression that will be evaluated 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

Any

For Configurations

  • dynamics-nav-config

Throws

  • NAV:CONNECTIVITY

  • NAV:INCORRECT_CREDENTIALS

  • NAV:RETRY_EXHAUSTED

  • NAV:UNKNOWN

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

Field Type Description Default Value Required

Frequency

Number

How often to reconnect (in milliseconds)

Count

Number

The number of reconnection attempts to make

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread

true

Pooling Profile Type

Field Type Description Default Value Required

Max Active

Number

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Number

Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which will throw a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which will block by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it will block indefinitely.

Initialisation Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (will load one initial component into the pool on startup), or INITIALISE_ALL (will load all components in the pool on startup)

Disabled

Boolean

Whether pooling should be disabled

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 Iterable Type

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

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

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be 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 that will be kept 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

View on GitHub