Microsoft Dynamics GP Connector Reference - Mule 4
Microsoft Dynamics GP Connector v2.1
Release Notes: Microsoft Dynamics GP Connector Release Notes
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 |
The connection types to provide 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 purges the instances when it sees fit. |
Connection Types
Kerberos Authentication
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Username |
String |
x |
||
Password |
String |
x |
||
Endpoint URL |
String |
Base URL where the SOAP services are exposed. |
x |
|
SPN |
String |
The Service Principal Name that identifies the service instance |
x |
|
Login Conf. Location |
String |
Path to a customized Login Properties File |
x |
|
Krb5 Conf. Location |
String |
Path to a customized Kerberos Properties File |
x |
|
Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies Connection Timeout and Read Timeout attributes. Defaults to SECONDS. |
SECONDS |
|
Connection Timeout |
Number |
The HTTP connection timeout value. This attribute works in tandem with Timeout Unit. Defaults to 5. |
5 |
|
Read Timeout |
Number |
The HTTP read timeout value. This attribute works in tandem with Timeout Unit. Defaults to 5. |
5 |
|
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. |
Operations
Create Entity
<dynamicsgp:create-entity>
Creates a new entity in Dynamics GP.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Entity |
String |
The type of the entity to create. |
x |
|
Input |
Binary |
The web service input, containing the entity to create, the context and policy. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Delete Entity
<dynamicsgp:delete-entity>
Deletes an existing entity in Dynamics GP.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Entity |
String |
The type of the entity to delete. |
x |
|
Input |
Binary |
The web service input, containing the key object, the context and policy. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Get Entity By Key
<dynamicsgp:get-entity-by-key>
Retrieves an entity from Dynamics GP, based on the key values supplied.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Entity |
String |
The type of the entity to retrieve. |
x |
|
Input |
Binary |
The web service input, containing the key object and the context. |
|
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Get Entity List
<dynamicsgp:get-entity-list>
Retrieves a list of entities from Dynamics GP that match the specified criteria.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Entity |
String |
The type of the entity to fetch. |
x |
|
Input |
Binary |
The web service input, containing the search criteria and the context. |
|
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Multitenant Enabled
<dynamicsgp:multitenant-enabled>
Indicates whether the Dynamics GP service is installed in a multi-tenant configuration.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Update Entity
<dynamicsgp:update-entity>
Updates an existing entity in Dynamics GP.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Entity |
String |
The type of the entity to update. |
x |
|
Input |
Binary |
The web service input, containing the entity to update, the context and policy. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Void Entity
<dynamicsgp:void-entity>
Voids an existing entity in Dynamics GP.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Entity |
String |
The type of the entity to void. |
x |
|
Input |
Binary |
The web service input, containing the key object, the context and policy. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Types
Reconnection
| 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. |
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 |
Expiration Policy
| 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 |
Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
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 the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is 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, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. |
||
Max Buffer Size |
Number |
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 than or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
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:
|
The unit in which maxInMemorySize is expressed |