Microsoft Dynamics 365 Business Central Connector 1.0 Reference
Configurations
Config
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
Name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
Connection types for this configuration. |
x |
||
Default company ID |
String |
Default ID of the company. If left blank, each operation or source must specify the company ID separately. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
60 |
|
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
SECONDS |
|
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
AUTO |
|
Name |
String |
ID used to reference this configuration. |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
Connection Types
Basic Auth Connection Provider
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Object |
Default HTTP headers to include in requests. |
||
Query Parameters |
Object |
Default query parameters to include in requests. |
||
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
Indicates whether to use persistent connections:
|
true |
|
Max Connections |
Number |
Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput. By default, the number of connections is unlimited. |
-1 |
|
Connection Idle Timeout |
Number |
When persistent connections are enabled, how long a connection can remain idle before Mule closes it. The value of this attribute is used only when persistent connections are enabled. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Idle Timeout field. |
SECONDS |
|
Proxy Config |
Configures a proxy for outbound connections. A proxy element must define a host name and port attributes and can optionally define a username and a password. |
|||
Stream Response |
Boolean |
If this value is |
false |
|
Response Buffer Size |
Number |
Size of the buffer that stores the HTTP response, in bytes. |
-1 |
|
Base Uri |
String |
Parameter base URI. Each instance or tenant gets its own parameter base URI. |
|
|
Username |
String |
Username used to authenticate the requests. |
x |
|
Password |
String |
Password used to authenticate the requests. |
||
Protocol |
Enumeration, one of:
|
Protocol to use for communication. If |
HTTP |
|
TLS Configuration |
Reference to a TLS config element. This field enables |
|||
Reconnection |
What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:
|
OAuth2 Connection Provider
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 |
---|---|---|---|---|
Default Headers |
Object |
Default HTTP headers to include in requests. |
||
Query Parameters |
Object |
Default query parameters to include in requests. |
||
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
Indicates whether to use persistent connections:
|
true |
|
Max Connections |
Number |
Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput. By default the number of connections is unlimited. |
-1 |
|
Connection Idle Timeout |
Number |
When persistent connections are enabled, how long a connection can remain idle before Mule closes it. The value of this attribute is used only when persistent connections are enabled. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Idle Timeout field. |
SECONDS |
|
Proxy Config |
Configures a proxy for outbound connections. A proxy element must define a host name and port attributes and can optionally define a username and a password. |
|||
Stream Response |
Boolean |
If this value is |
false |
|
Response Buffer Size |
Number |
Size of the buffer that stores the HTTP response, in bytes. |
-1 |
|
Base Uri |
String |
Parameter base URI. Each instance or tenant gets its own parameter base URI. |
|
|
Protocol |
Enumeration, one of:
|
Protocol to use for communication. If |
HTTP |
|
TLS Configuration |
Reference to a TLS config element. This field enables |
|||
Reconnection |
What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:
|
|||
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 |
URL of the service provider’s authorization endpoint. |
|
|
Access Token Url |
String |
URL of the service provider’s access token endpoint. |
|
|
Scopes |
String |
OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation. |
|
|
Resource Owner Id |
String |
Resource owner ID to use with the authorization code grant type. |
||
Before |
String |
Name of the flow to execute immediately before starting the OAuth dance. |
||
After |
String |
Name of the flow to execute immediately after receiving an access token. |
||
Listener Config |
String |
Configuration for the HTTP listener that listens for requests on the access token callback endpoint. |
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 |
URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL. |
||
Object Store |
String |
Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store. |
Create Entity
<dynamics365-bc:create-entity>
Creates a single new entity.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Company ID |
String |
ID of the company. |
||
Entity |
String |
Name of the operation entity. |
x |
|
Body |
Binary |
x |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
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
-
DYNAMICS365-BC:BAD_REQUEST
-
DYNAMICS365-BC:COMPANY_NOT_FOUND
-
DYNAMICS365-BC:CONNECTIVITY
-
DYNAMICS365-BC:DIALOG_EXCEPTION
-
DYNAMICS365-BC:INVALID_CREDENTIALS
-
DYNAMICS365-BC:INVALID_OPTION_ENUM_VALUE
-
DYNAMICS365-BC:METHOD_NOT_ALLOWED
-
DYNAMICS365-BC:METHOD_NOT_IMPLEMENTED
-
DYNAMICS365-BC:NOT_FOUND
-
DYNAMICS365-BC:RESOURCE_NOT_FOUND
-
DYNAMICS365-BC:RETRY_EXHAUSTED
-
DYNAMICS365-BC:SERVER_ERROR
-
DYNAMICS365-BC:STRING_EXCEEDED_LENGTH
-
DYNAMICS365-BC:TIMEOUT
-
DYNAMICS365-BC:UNAUTHORIZED
-
DYNAMICS365-BC:UNKNOWN
-
DYNAMICS365-BC:VALIDATION
Delete Entity
<dynamics365-bc:delete-entity>
Deletes a single entity by ID.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Company ID |
String |
ID of the company. |
||
Entity |
String |
Name of the operation entity. |
x |
|
Entity ID |
String |
ID of the entity. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
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
-
DYNAMICS365-BC:BAD_REQUEST
-
DYNAMICS365-BC:COMPANY_NOT_FOUND
-
DYNAMICS365-BC:CONNECTIVITY
-
DYNAMICS365-BC:DIALOG_EXCEPTION
-
DYNAMICS365-BC:INVALID_CREDENTIALS
-
DYNAMICS365-BC:METHOD_NOT_ALLOWED
-
DYNAMICS365-BC:METHOD_NOT_IMPLEMENTED
-
DYNAMICS365-BC:NOT_FOUND
-
DYNAMICS365-BC:RESOURCE_NOT_FOUND
-
DYNAMICS365-BC:RETRY_EXHAUSTED
-
DYNAMICS365-BC:SERVER_ERROR
-
DYNAMICS365-BC:TIMEOUT
-
DYNAMICS365-BC:UNAUTHORIZED
-
DYNAMICS365-BC:UNKNOWN
-
DYNAMICS365-BC:VALIDATION
Get Entity
<dynamics365-bc:get-entity>
Retrieves a single entity by its ID if it exists.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Company ID |
String |
ID of the company. |
||
Entity ID |
String |
ID of the entity. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Entity |
String |
Name of the operation entity. |
x |
|
Expand properties |
Array of String |
Expands related entities. |
||
Select properties |
Array of String |
Selects properties to return. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
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
-
DYNAMICS365-BC:BAD_REQUEST
-
DYNAMICS365-BC:COMPANY_NOT_FOUND
-
DYNAMICS365-BC:CONNECTIVITY
-
DYNAMICS365-BC:DIALOG_EXCEPTION
-
DYNAMICS365-BC:FILTER_ERROR_EXCEPTION
-
DYNAMICS365-BC:INVALID_CREDENTIALS
-
DYNAMICS365-BC:INVALID_OPTION_ENUM_VALUE
-
DYNAMICS365-BC:METHOD_NOT_ALLOWED
-
DYNAMICS365-BC:METHOD_NOT_IMPLEMENTED
-
DYNAMICS365-BC:NOT_FOUND
-
DYNAMICS365-BC:RESOURCE_NOT_FOUND
-
DYNAMICS365-BC:RETRY_EXHAUSTED
-
DYNAMICS365-BC:SERVER_ERROR
-
DYNAMICS365-BC:TIMEOUT
-
DYNAMICS365-BC:UNAUTHORIZED
-
DYNAMICS365-BC:UNKNOWN
-
DYNAMICS365-BC:VALIDATION
List Entities
<dynamics365-bc:list-entities>
Retrieves a list of entities, applying the specified filters and search queries.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Company ID |
String |
ID of the company. |
||
Page Size |
Number |
Page size. |
50 |
|
Output Mime Type |
String |
MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Entity |
String |
Name of the operation entity. |
x |
|
Expand properties |
Array of String |
Expands related entities. |
||
Select properties |
Array of String |
Selects properties to return. |
||
Search |
String |
Searches items by search phrases. |
||
Filter |
String |
Filters items by property values. |
||
Order By |
Array of String |
Orders items by property values. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
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. |
Output
Type |
Array of Messages of String payload and HTTP Response Attributes |
Throws
-
DYNAMICS365-BC:BAD_REQUEST
-
DYNAMICS365-BC:COMPANY_NOT_FOUND
-
DYNAMICS365-BC:CONNECTIVITY
-
DYNAMICS365-BC:DIALOG_EXCEPTION
-
DYNAMICS365-BC:FILTER_ERROR_EXCEPTION
-
DYNAMICS365-BC:INVALID_CREDENTIALS
-
DYNAMICS365-BC:INVALID_OPTION_ENUM_VALUE
-
DYNAMICS365-BC:METHOD_NOT_ALLOWED
-
DYNAMICS365-BC:METHOD_NOT_IMPLEMENTED
-
DYNAMICS365-BC:NOT_FOUND
-
DYNAMICS365-BC:RESOURCE_NOT_FOUND
-
DYNAMICS365-BC:SERVER_ERROR
-
DYNAMICS365-BC:TIMEOUT
-
DYNAMICS365-BC:UNAUTHORIZED
-
DYNAMICS365-BC:UNKNOWN
-
DYNAMICS365-BC:VALIDATION
Unauthorize
<dynamics365-bc:unauthorize>
Deletes all the access token information of a given resource owner ID so that it is impossible to execute any operation for that user without doing the authorization dance again.
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 |
Name of the configuration used to execute this component. |
x |
Update Entity
<dynamics365-bc:update-entity>
Updates a single entity by its ID. You must provide the latest ETag value for the entity to update successfully.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Company ID |
String |
ID of the company. |
||
Entity |
String |
Name of the operation entity. |
x |
|
Entity ID |
String |
ID of the entity. |
x |
|
ETag |
String |
x |
||
Body |
Binary |
x |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
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
-
DYNAMICS365-BC:BAD_REQUEST
-
DYNAMICS365-BC:COMPANY_NOT_FOUND
-
DYNAMICS365-BC:CONNECTIVITY
-
DYNAMICS365-BC:DIALOG_EXCEPTION
-
DYNAMICS365-BC:ENTITY_CHANGED
-
DYNAMICS365-BC:INVALID_CREDENTIALS
-
DYNAMICS365-BC:INVALID_OPTION_ENUM_VALUE
-
DYNAMICS365-BC:METHOD_NOT_ALLOWED
-
DYNAMICS365-BC:METHOD_NOT_IMPLEMENTED
-
DYNAMICS365-BC:NOT_FOUND
-
DYNAMICS365-BC:RESOURCE_NOT_FOUND
-
DYNAMICS365-BC:RETRY_EXHAUSTED
-
DYNAMICS365-BC:SERVER_ERROR
-
DYNAMICS365-BC:STRING_EXCEEDED_LENGTH
-
DYNAMICS365-BC:TIMEOUT
-
DYNAMICS365-BC:UNAUTHORIZED
-
DYNAMICS365-BC:UNKNOWN
-
DYNAMICS365-BC:VALIDATION
On New or Updated Customer
<dynamics365-bc:on-new-or-updated-customer-listener>
Initiates a flow when a customer is created or updated.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Company ID |
String |
ID of the company. |
||
Since |
String |
Date in the yyyy-MM-dd’T’HH:mm:ss’Z' format, for example, 2014-01-01T00:00:00Z. |
1970-01-01T00:00:00.000Z |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On New or Updated Item
<dynamics365-bc:on-new-or-updated-item-listener>
Initiates a flow when an item is created or updated.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Company ID |
String |
ID of the company. |
||
Since |
String |
Date in the yyyy-MM-dd’T’HH:mm:ss’Z' format, for example, 2014-01-01T00:00:00Z. If this field is empty, this operation retrieves the selected objects from the time the Mule app is started. |
1970-01-01T00:00:00.000Z |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On New or Updated Sales Order
<dynamics365-bc:on-new-or-updated-salesorder-listener>
Initiates a flow when a sales order is created or updated.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Company ID |
String |
ID of the company. |
||
Since |
String |
Date in the yyyy-MM-dd’T’HH:mm:ss’Z' format, for example, 2014-01-01T00:00:00Z. If this field is empty, this operation retrieves the selected objects from the time the Mule app is started. |
1970-01-01T00:00:00.000Z |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Types
Proxy
Configures a proxy for outbound connections.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
Host where the proxy requests is sent. |
x |
|
Port |
Number |
Port where the proxy requests is sent. |
x |
|
Username |
String |
Username used to authenticate against the proxy. |
||
Password |
String |
Password used to authenticate against the proxy. |
||
Non Proxy Hosts |
String |
List of comma-separated hosts against which the proxy must not be used. |
TLS
Configures TLS to provide secure communications for the Mule app.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
Comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
Comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
Configures the TLS truststore. |
|||
Key Store |
Configures the TLS keystore. |
|||
Revocation Check |
Configures a revocation checking mechanism. |
Truststore
Configures the truststore for TLS.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the truststore. Mule resolves the path relative to the current classpath and file system. |
||
Password |
String |
Password used to protect the truststore. |
||
Type |
String |
Type of truststore. |
||
Algorithm |
String |
Encryption algorithm that the truststore uses. |
||
Insecure |
Boolean |
If |
Keystore
Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the keystore. Mule resolves the path relative to the current classpath and file system. |
||
Type |
String |
Type of keystore. |
||
Alias |
String |
Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file. |
||
Key Password |
String |
Password used to protect the private key. |
||
Password |
String |
Password used to protect the keystore. |
||
Algorithm |
String |
Encryption algorithm that the keystore uses. |
Standard Revocation Check
Configures standard revocation checks for TLS certificates.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Which elements to verify in the certificate chain:
|
||
Prefer Crls |
Boolean |
How to check certificate validity:
|
||
No Fallback |
Boolean |
Whether to use the secondary method to check certificate validity:
|
||
Soft Fail |
Boolean |
What to do if the revocation server can’t be reached or is busy:
|
Custom OCSP Responder
Configures a custom OCSP responder for certification revocation checks.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. |
CRL File
Specifies the location of the certification revocation list (CRL) file.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the CRL file. |
Reconnection
Configures a reconnection strategy for an operation.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:
Allow the deployment to fail.
Ignore the results of the connectivity test. |
||
Reconnection Strategy |
Reconnection strategy to use. |
Reconnect
Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often to attempt to reconnect, in milliseconds. |
||
Blocking |
Boolean |
If |
||
Count |
Number |
How many reconnection attempts the Mule app can make. |
Reconnect Forever
Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often to attempt to reconnect, in milliseconds. |
||
Blocking |
Boolean |
If |
Expiration Policy
Configures an expiration policy strategy.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
Time unit for the Max Idle Time field. |
HTTP Response Attributes
Configures HTTP response attributes for the configuration.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Status Code |
Number |
HTTP status code of the response. |
x |
|
Headers |
Object |
Map of HTTP headers in the message. |
x |
|
Reason Phrase |
String |
HTTP reason phrase of the response. |
x |
Repeatable In Memory Stream
Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value. |
||
Buffer Size Increment |
Number |
Amount by which the buffer size expands if it exceeds its initial size. Setting a value of |
||
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:
|
Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields. |
Repeatable File Store Stream
Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size |
Number |
Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:
|
||
Buffer Unit |
Enumeration, one of:
|
Unit for the In Memory Size field. |
Redelivery Policy
Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Redelivery Count |
Number |
Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error. |
||
Message Digest Algorithm |
String |
Secure hashing algorithm to use if the Use Secure Hash field is |
||
Message Identifier |
One or more expressions that determine if a message was redelivered. This property can be set only if the Use Secure Hash field is |
|||
Object Store |
ObjectStore |
Configures the object store that stores the redelivery counter for each message. |
Redelivery Policy Message Identifier
Configures how to identify a redelivered message and how to find out when the message was redelivered.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Use Secure Hash |
Boolean |
If |
||
Id Expression |
String |
One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is |
Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
Amount of instances that are initially allowed to be kept 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 Max In Memory Size. The default value is 100 instances. |
||
Buffer Size Increment |
Number |
How much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer must not expand, meaning that a |
||
Max Buffer Size |
Number |
Maximum amount of memory to use. If more than that is used, then a |