# mulesoft Microsoft Dynamics NAV Connector - Full Documentation
---
product: Microsoft Dynamics NAV Connector
version: 3.0
---
# Microsoft Dynamics NAV Connector 3.0
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Connector for Microsoft Dynamics NAV (NAV Connector) enables Mule apps to interact with
Microsoft Dynamics NAV Web Services. Microsoft Dynamics NAV is a global enterprise resource planning
(ERP) solution to assist with finance, manufacturing, customer relationship management, supply
chains, analytics, and electronic commerce for small and medium-sized enterprise and local
subsidiaries of large international groups.
The versions of Microsoft Dynamics NAV supported by this connector are:
- 2013 R2
- 2015
- 2016
- 2017
Release Notes:
[Microsoft Dynamics NAV Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/ms-dynamics-nav-connector-release-notes-mule-4)
Exchange:
[Microsoft Dynamics NAV Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-microsoft-dynamics-nav-connector/)
## Before You Begin
To use this information, you should be familiar with Microsoft Dynamics NAV, Mule runtime engine
(Mule), Anypoint Connectors, Anypoint Studio, Mule concepts, elements in a Mule flow, and Global
Elements.
You need login credentials to test your connection to your target resource.
For hardware and software requirements and compatibility information, see the Connector Release
Notes.
To use this connector with Maven, view the pom.xml dependency information in the Dependency Snippets
in Anypoint Exchange.
## POM File Information
```xml
| Operation | Description |
|---|---|
Page Operation | Execute one of the operations defined in published Page SOAP services. |
Codeunit Operation | Execute one of the operations defined in published Codeunit SOAP services. |
OData Query | Execute a Query against one of the NAV entities using the OData endpoint. |
| Parameter | Description |
|---|---|
Domain | Domain of the Dynamics NAV instance. |
Username | The Windows username to connect to Dynamics NAV. |
Password | The password for the user to connect to Dynamics NAV. |
SOAP URL | Base URL where the SOAP services are exposed in the form |
OData URL | Base URL where the OData services are exposed in the form |
Company Name (Optional) | Dynamics NAV Company to which connect. In case the field is left blank, the default configured one is used. |
Disable Cn Check | For 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. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | The name for this configuration. Connectors reference the configuration with this name. | x | |
Connection |
| 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. |
| 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 | x | |
OData Url | String | Base URL where the OData services are exposed in the form | 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 |
| 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 | x | |
OData Url | String | Base URL where the OData services are exposed in the form | 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 |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Entity | Object |
| ||
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
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 |
| |
Error Mappings | Array of Error Mapping | Set of error mappings. | ||
Reconnection Strategy |
| A retry strategy in case of connectivity errors |
Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Query | String | x | ||
Fetch Size | Number | x | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| 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 |
| |
Error Mappings | Array of Error Mapping | Set of error mappings. | ||
Reconnection Strategy |
| A retry strategy in case of connectivity errors |
Type | Array of Object |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Entity | Object |
| ||
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
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 |
| |
Error Mappings | Array of Error Mapping | Set of error mappings. | ||
Reconnection Strategy |
| A retry strategy in case of connectivity errors |
Type | Any |
| 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 |
| The reconnection strategy to use |
| 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 |
| 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 |
| 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:
| 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:
| 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 |
| 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:
| A time unit that qualifies the maxIdleTime attribute |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Source | Enumeration, one of:
| Source. | ||
Target | String | Target. | x |
| 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. |
| 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:
| The unit in which maxInMemorySize is expressed |
| Operation | Description |
|---|---|
Page Operation | Execute one of the operations defined in published Page SOAP services. |
Codeunit Operation | Execute one of the operations defined in published Codeunit SOAP services. |
OData Query | Execute a Query against one of the NAV entities using the OData endpoint. |
| Parameter | Description |
|---|---|
Domain | Domain of the Dynamics NAV instance. |
Username | The Windows username to connect to Dynamics NAV. |
Password | The Windows password to connect to Dynamics NAV. |
Soap Url | Base URL where the SOAP services are exposed in the form |
Odata Url | Base URL where the OData services are exposed in the form |
Company Name | Dynamics NAV Company to which connect. In case the field is left blank, the default configured one is used. |
Disable SSL certificate validation | For HTTPS certificates, if the certificate isn’t signed by a trusted partner, the server might respond with an exception. You can disable the CN (Common Name) check. This isn’t recommended for production environments. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | The name for this configuration. Connectors reference the configuration with this name. | x | |
Connection |
| The connection types that can be provided to this configuration. | x | |
Expiration Policy | 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. |
| 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 | x | |
Odata Url | String | Base URL where the OData services are exposed in the form | 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 | ||
Response Timeout | Number | HTTP response timeout. This field is on the Advanced tab. Expressions aren’t supported. | 5000 | |
Response Timeout Unit | Enumeration, one of:
| Time unit for the response timeout. This field is on the Advanced tab. Expressions aren’t supported. | MILLISECONDS | |
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 | Characteristics of the connection pool |
| 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 | x | |
Odata Url | String | Base URL where the OData services are exposed in the form | 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 | ||
Response Timeout | Number | HTTP response timeout. This field is on the Advanced tab. Expressions aren’t supported. | 5000 | |
Response Timeout Unit | Enumeration, one of:
| Time unit for the response timeout. This field is on the Advanced tab. Expressions aren’t supported. | MILLISECONDS | |
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 | Characteristics of the connection pool |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Entity | Object |
| ||
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
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 |
| |
Error Mappings | Array of Error Mapping | Set of error mappings. | ||
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Query | String | x | ||
Fetch Size | Number | x | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy | 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 |
| |
Error Mappings | Array of Error Mapping | Set of error mappings. | ||
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Object |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Entity | Object |
| ||
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
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 |
| |
Error Mappings | Array of Error Mapping | Set of error mappings. | ||
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
| 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 | The reconnection strategy to use |
| 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 |
| 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 |
| 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:
| 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:
| 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 |
| 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:
| A time unit that qualifies the maxIdleTime attribute |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Source | Enumeration, one of:
| Source. | ||
Target | String | Target. | x |
| 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. |
| 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:
| The unit in which maxInMemorySize is expressed |
| From Version | To Version |
|---|---|
2.x | 3.x |
| From Version | To Version |
|---|---|
3.x | 4.x |
| Application/Service | Version |
|---|---|
Mule runtime | 4.9.0 and later |
Java | 17 |
Microsoft Dynamics NAV |
|