String
Microsoft Dynamics 365 For Operations Connector 3.1 Reference - Mule 4
Anypoint Connector for Microsoft Dynamics 365 for Finance and Operations (Microsoft Dynamics 365 for Operations Connector) enables integration with Microsoft Dynamics 365 for Operations Web API.
Microsoft Dynamics 365 For Operations Configurations
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
The name for this configuration. Connectors reference the configuration with this name. |
x |
||
Connection |
The connection types to provide for this configuration. |
x |
||
Name |
String |
The identifier of this element, by which other components reference it. |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Connection Types
OAuth Client Credentials
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Resource |
String |
App ID URI of the web API. |
x |
|
TLS configuration |
Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the |
|||
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is |
0 |
|
Read Timeout Time unit |
Enumeration, one of:
|
Time unit to use for the Read Timeout parameter. |
SECONDS |
|
Host |
String |
Hostname of the proxy if a proxy is used. If this property is not set, then no proxy is used. |
||
Port |
Number |
Port number of the proxy. If the Host value is specified, this property is required and cannot be a negative number. |
||
Username |
String |
If a proxy is used, this is the username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy. |
||
Password |
String |
Password used to authenticate against the proxy. |
||
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. |
|||
Client Id |
String |
OAuth client ID as registered with the service provider. |
x |
|
Client Secret |
String |
OAuth client secret as registered with the service provider. |
x |
|
Token Url |
String |
The service provider’s token endpoint URL |
|
|
Scopes |
String |
OAuth scopes to request during the OAuth dance. If not provided, this defaults to the scopes specified in the annotation. |
||
Object Store |
String |
A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store. |
OAuth 2.0
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.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Scope |
String |
OpenID Connect scope. |
openid |
|
Resource |
String |
OAuth endpoint URL. |
x |
|
Response Type |
String |
Tells the authorization server what parameters to return from the authorization endpoint. |
query |
|
TLS configuration |
Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the |
|||
Read Timeout |
Number |
Specifies the amount of time in milliseconds that the consumer waits for a response before it times out. Default value is |
0 |
|
Read Timeout Time unit |
Enumeration, one of:
|
Time unit to use for the Connection Timeout and Read Timeout parameters. |
|
|
Host |
String |
Hostname of the proxy if a proxy is used. If this property is not set, then no proxy is used. |
||
Port |
Number |
Port number of the proxy. If the Host value is specified, this property is required and cannot be a negative number. |
||
Username |
String |
Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy. |
||
Password |
String |
Password used to authenticate against the proxy. |
||
Reconnection |
When the app is deployed, a connectivity test is performed on all connectors. If set to |
|||
Consumer Key |
String |
OAuth consumer key as registered with the service provider. |
x |
|
Consumer Secret |
String |
OAuth consumer secret as registered with the service provider. |
x |
|
Authorization Url |
String |
Service provider’s authorization endpoint URL. |
|
|
Access Token Url |
String |
Service provider’s access token endpoint URL. |
|
|
Scopes |
String |
OAuth scopes to request during the OAuth dance. If not provided, it defaults to the scopes provided in the annotation. |
||
Resource Owner Id |
String |
Resource Owner ID that each component uses if a reference is not otherwise provided. |
||
Before |
String |
Name of the flow to execute before starting the OAuth dance. |
||
After |
String |
Name of the flow to execute immediately after an access token is received. |
||
Listener Config |
String |
A reference to a |
x |
|
Callback Path |
String |
Path of the access token callback endpoint. |
x |
|
Authorize Path |
String |
Path of the local HTTP endpoint that triggers the OAuth dance. |
x |
|
External Callback Url |
String |
If the callback endpoint is behind a proxy or accessible through a non direct URL, use this parameter to specify the URL the OAuth provider should use to access the callback. |
||
Object Store |
String |
A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store. |
OAuth Username Password (Deprecated)
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
TLS configuration |
Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the |
|||
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite. |
0 |
|
Read Timeout Time unit |
Enumeration, one of:
|
Time unit to be used for the Read Timeout parameter |
SECONDS |
|
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified. |
||
Port |
Number |
Port of the proxy. If host is set then this property must be set and cannot be a negative number. |
||
Username |
String |
Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified. |
||
Password |
String |
Password used to authenticate against the proxy. |
||
Username |
String |
Username used to initialize the session |
x |
|
Password |
String |
Password used to authenticate the user |
x |
|
Resource |
String |
The App ID URI of the web API (secured resource). |
x |
|
Client Id |
String |
The Application Id assigned to your app when you registered it with Azure AD. You can find this in the Azure Portal. Click Active Directory, click the directory, choose the application, and click Configure. |
x |
|
Client Secret |
String |
The Application Secret that you created in the app registration portal for your app. It should not be used in a native app, because client_secrets cannot be reliably stored on devices. It is required for web apps and web APIs, which have the ability to store the client_secret securely on the server side. |
x |
|
Token Request Endpoint |
String |
The endpoint where the authorization request should be sent. |
x |
|
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |
|||
Connection Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Connection Timeout Time unit |
Enumeration, one of:
|
Time unit to be used for the Connection parameter |
SECONDS |
Associated Operations
Acknowledge Export From Recurring Job
<dynamics365ForOperations:acknowledge-export-from-recurring-job>
Performs the acknowledgment action for the downloaded data package from a recurring job, as described in this link.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Dequeue Recurring Job Response |
Any |
InputStream containing the required JSON text that has the response of the dequeue recurring job operation. |
#[payload] |
|
Activity Id |
String |
Activity ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
DYNAMICS365FOROPERATIONS:CONNECTIVITY
-
DYNAMICS365FOROPERATIONS:INVALID_CONNECTION
-
DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS
-
DYNAMICS365FOROPERATIONS:INVALID_INPUT
-
DYNAMICS365FOROPERATIONS:LOGIN_FAILED
-
DYNAMICS365FOROPERATIONS:NOT_FOUND
-
DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED
-
DYNAMICS365FOROPERATIONS:TIMEOUT
Create
<dynamics365ForOperations:create>
Creates a new entity. Refer to this link for creating an entity and this link for associating an entity upon creation.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Logical Name |
String |
Logical name of the entity. It is always the schema name in lower case. |
x |
|
Attributes |
Object |
Attributes of the entity created as a map. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
DYNAMICS365FOROPERATIONS:CONNECTIVITY
-
DYNAMICS365FOROPERATIONS:INVALID_CONNECTION
-
DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS
-
DYNAMICS365FOROPERATIONS:INVALID_INPUT
-
DYNAMICS365FOROPERATIONS:LOGIN_FAILED
-
DYNAMICS365FOROPERATIONS:NOT_FOUND
-
DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED
-
DYNAMICS365FOROPERATIONS:TIMEOUT
Dequeue Recurring Job
<dynamics365ForOperations:dequeue-recurring-job>
Performs the dequeue action for the activity specified, as described in this link.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Activity Id |
String |
Activity ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
DYNAMICS365FOROPERATIONS:CONNECTIVITY
-
DYNAMICS365FOROPERATIONS:INVALID_CONNECTION
-
DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS
-
DYNAMICS365FOROPERATIONS:INVALID_INPUT
-
DYNAMICS365FOROPERATIONS:LOGIN_FAILED
-
DYNAMICS365FOROPERATIONS:NOT_FOUND
-
DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED
-
DYNAMICS365FOROPERATIONS:TIMEOUT
Execute Operation
<dynamics365ForOperations:execute-operation>
Executes a request against a URL in the https://host_uri/api/Services/service_group_name/service_group_service_name/operation_name
format.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Parameters |
Object |
Parameters of the operation to execute. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Service Group |
String |
The service group name (first level metadata key). |
x |
|
Service Name |
String |
The service name (second level metadata key). |
x |
|
Operation |
String |
The operation name (third level metadata key). |
x |
|
Target Variable |
String |
The name of a variable in which to store the operation’s output. |
||
Target Value |
String |
An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
DYNAMICS365FOROPERATIONS:CONNECTIVITY
-
DYNAMICS365FOROPERATIONS:INVALID_CONNECTION
-
DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS
-
DYNAMICS365FOROPERATIONS:INVALID_INPUT
-
DYNAMICS365FOROPERATIONS:LOGIN_FAILED
-
DYNAMICS365FOROPERATIONS:NOT_FOUND
-
DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED
-
DYNAMICS365FOROPERATIONS:TIMEOUT
Export Data From Recurring Job
<dynamics365ForOperations:export-data-from-recurring-job>
Returns a data package that contains all of the data entities defined in the data project as described in this link.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Download URL |
String |
URL of the data package to download. It can be extracted from the response of the dequeue recurring job operation. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
DYNAMICS365FOROPERATIONS:CONNECTIVITY
-
DYNAMICS365FOROPERATIONS:INVALID_CONNECTION
-
DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS
-
DYNAMICS365FOROPERATIONS:INVALID_INPUT
-
DYNAMICS365FOROPERATIONS:LOGIN_FAILED
-
DYNAMICS365FOROPERATIONS:NOT_FOUND
-
DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED
-
DYNAMICS365FOROPERATIONS:TIMEOUT
Import Data Recurring Job
<dynamics365ForOperations:import-data-recurring-job>
Facilitates submitting data to recurring data jobs.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Uri Path |
String |
Import URI, for example: |
|
|
Activity Id |
String |
Activity ID. |
x |
|
Entity Name |
String |
Entity name. |
x |
|
File input |
Binary |
Data to submit. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Target Variable |
String |
The name of a variable in which to store the operation’s output. |
||
Target Value |
String |
An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
DYNAMICS365FOROPERATIONS:CONNECTIVITY
-
DYNAMICS365FOROPERATIONS:INVALID_CONNECTION
-
DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS
-
DYNAMICS365FOROPERATIONS:INVALID_INPUT
-
DYNAMICS365FOROPERATIONS:LOGIN_FAILED
-
DYNAMICS365FOROPERATIONS:NOT_FOUND
-
DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED
-
DYNAMICS365FOROPERATIONS:TIMEOUT
Retrieve Multiple
<dynamics365ForOperations:retrieve-multiple>
Retrieve multiple entities by URL.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Data Query URL |
String |
The URL, in ODATA format, to use to retrieve the entities. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Target Variable |
String |
The name of a variable in which to store the operation’s output. |
||
Target Value |
String |
An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Retrieve Multiple By Query
<dynamics365ForOperations:retrieve-multiple-by-query>
Retrieve multiple entities by DSQL query.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
DataSense Query |
String |
The DSQL query to use to retrieve entities. The query is transformed into a URL internally. |
|
|
Expand |
String |
|||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Target Variable |
String |
The name of a variable in which to store the operation’s output. |
||
Target Value |
String |
An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Unauthorize
<dynamics365ForOperations:unauthorize>
Deletes all of the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without repeating the authorization dance.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use |
x |
|
Resource Owner Id |
String |
ID of the resource owner for whom to invalidate access |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
Types
TLS
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Truststore
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location, which is resolved relative to the current classpath and file system, if possible, of the truststore. |
||
Password |
String |
The password used to protect the truststore. |
||
Type |
String |
The type of truststore used. |
||
Algorithm |
String |
The algorithm used by the truststore. |
||
Insecure |
Boolean |
If |
Keystore
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location, which is resolved relative to the current classpath and file system, if possible, of the keystore. |
||
Type |
String |
The type of keystore used. |
||
Alias |
String |
When the keystore contains many private keys, this attribute specifies the alias of the key to use. If not specified, the first key in the file is used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the keystore. |
||
Algorithm |
String |
The algorithm used by the keystore. |
Standard Revocation Check
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
If |
||
Prefer Crls |
Boolean |
If |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can’t be reached or is busy. |
Custom OCSP Responder
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the truststore), if present. |
Reconnection
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
When the app is deployed, a connectivity test is performed on all connectors. If set to |
||
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 Max Idle Time attribute. |
Repeatable In-Memory Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
100 |
|
Buffer Size Increment |
Number |
Specifies how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer does not expand, and that a |
100 |
|
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used, then a |
Repeatable File Store Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max In Memory Size |
Number |
The maximum number of instances to keep in memory. If more than is required, then content is buffered on to the disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which Max In Memory Size is expressed. |