Contact Us 1-800-596-4880

Microsoft Dynamics 365 Connector 2.5 Reference - Mule 4

Anypoint Connector for Microsoft Dynamics 365 (Microsoft Dynamics 365 Connector) enables integration with the Microsoft Dynamics 365 Cloud API.

Configuration

Default Configuration for Microsoft Dynamics 365 Connector.

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

Encoding

Body encoding.

  • If no value is specified, set the Mule default encoding.

  • If a value is specified, set the -M-Dmule.encoding VM argument to the same value to avoid an encoding mismatch.

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 (OAuth 2.0) Connection Type

Connects to servers that manage authorization and token access.

Name Type Description Default Value Required

Version

String

Version number of the API to connect to.

9.0

(Deprecated) Scope

String

Do not use this parameter. This parameter cannot be used for the authentication request. The authentication fails if both the Scope and Scopes parameters are used, since they both provide the same functionality. This parameter will be removed in a future version.

openid

Resource

String

Endpoint URL.

x

Response Type

String

Response type must be query.

query

Read Timeout

Number

How long the consumer waits for a response before it times out, in milliseconds. Default value is 0, which means infinite.

0

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Default value is 0, which means infinite.

0

Host

String

Hostname of the proxy. If this property is not set, then no proxy is used; otherwise, a proxy is 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 authentication is not applied to the proxy.

Password

String

Password used to authenticate against the proxy.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

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.

https://login.microsoftonline.com/oauth2/authorize

Access Token Url

String

URL of the service provider’s access token endpoint.

https://login.microsoftonline.com/oauth2/token

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 if the component does not have another reference.

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.

OAuth Client Credentials Connection Type

Uses a client ID and a client secret to authenticate the connection to the server.

Name Type Description Default Value Required

Version

String

Version number of the API to connect to.

9.0

Endpoint

String

Location where to send the requests.

x

Read Timeout

Number

How long the consumer waits for a response before it times out, in milliseconds. Default value is 0, which means infinite.

0

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Default value is 0, which means infinite.

0

Host

String

Hostname of the proxy. If this property is not set, then no proxy is used; otherwise, a proxy is 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 authentication is not applied to the proxy.

Password

String

Password used to authenticate against the proxy.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

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.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

OAuth Username Password Connection Type

Uses a username and a password to authenticate the connection to the server.

Name Type Description Default Value Required

Version

String

Version number of the API to connect to.

9.0

Read Timeout

Number

How long the consumer waits for a response before it times out, in milliseconds. Default value is 0, which means infinite.

0

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Default value is 0, which means infinite.

0

Host

String

Hostname of the proxy. If this property is not set, then no proxy is used; otherwise, a proxy is 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 authentication is not applied to the proxy.

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

Application ID URI of the web API (secured resource).

x

Client Id

String

Application ID assigned to your application when you register the application with Azure AD. You can find this Client Id in the Azure Portal. Click Active Directory, select the directory, choose the application, and click Configure.

x

Client Secret

String

Application secret that you create in the application registration portal for your application. This Client Secret must 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 store the client secret securely on the server side.

x

Token Request Endpoint

String

Token request endpoint.

x

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Sources

Microsoft Dynamics 365 Connector sources use Object Store to save watermarks. You might experience limitations that are specific to the Object Store implementation you are using (Object Store for CloudHub deployments or Object Store for on-premises deployments), so configure Object Store to suit your needs.
For more information, see The Different Types of Object Stores Explained.

On Deleted Object

<dynamics:on-deleted-object>

Starts your app when an object is deleted.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Entity Type

String

Describes business data. Example values are account and contact, which are defined in the Microsoft Dynamics 365 instance.

x

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

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

Any

Associated Configurations

On Modified Object

<dynamics:on-modified-object>

Starts your app when an object is modified.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Since

String

Required date format is 'yyyy-MM-dd’T’HH:mm:ss’Z'.

Entity Type

String

Describes business data. Example values are account and contact, which are defined in the Microsoft Dynamics 365 instance.

x

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

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

Any

Associated Configurations

On New Object

<dynamics:on-new-object>

Starts your app when a new object is created.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Since

String

Required date format is 'yyyy-MM-dd’T’HH:mm:ss’Z'.

Entity Type

String

Describes business data. Example values are account and contact, which are defined in the Microsoft Dynamics 365 instance.

x

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

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

Any

Associated Configurations

Operations

Create

<dynamics:create>

Creates a new entity.

  • Create New Entity - https://msdn.microsoft.com/en-us/library/gg328090.aspx

  • Associate Entity Upon Creation - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4

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 to create as a map.

#[payload]

Encoding

Body encoding.

  • If no value is specified, set the Mule default encoding.

  • If a value is specified, set the -M-Dmule.encoding VM argument to the same value to avoid an encoding mismatch.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

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

String

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Create Multiple

<dynamics:create-multiple>

Creates multiple entities.

  • Create New Entity - https://msdn.microsoft.com/en-us/library/gg328090.aspx

  • Associate Entity Upon Creation - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4

  • Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx

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

Entities Attributes

Array of Object

List of the entities' attributes to create as a list of maps.

#[payload]

Use Single Transaction

Boolean

Use a single transaction for creation. If the entity creation fails, the transaction is rolled back.

false

Encoding

Body encoding.

  • If no value is specified, set the Mule default encoding.

  • If a value is specified, set the -M-Dmule.encoding VM argument to the same value to avoid an encoding mismatch.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

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

Bulk Operation Result

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Delete

<dynamics:delete>

Deletes an entity.

  • Delete an Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx

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

Id

String

ID of the entity to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Delete Multiple

<dynamics:delete-multiple>

Deletes multiple entities.

  • Delete an Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx

  • Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx

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

Ids

Array of String

List of IDs to delete.

#[payload]

Use Single Transaction

Boolean

Use a single transaction for deletion. If the deletion fails, the transaction is rolled back.

true

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

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

Bulk Operation Result

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Disassociate

<dynamics:disassociate>

Removes a reference to an entity.

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

Disassociates a request’s payload.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Do Action

<dynamics:do-action>

Call an action.

  • Use Web API Actions - https://msdn.microsoft.com/en-us/library/mt607600.aspx

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Action Name

String

Action name to call.

x

Bounded Entity Type

String

Optional bounded entity type. You must provide this value if the action is bounded.

Bounded Entity Id

String

Optional bounded entity ID. You must provide this value if the action is bounded.

Related Entities

Object

Body to send in the request as a map.

#[payload]

Encoding

Body encoding.

  • If no value is specified, set the Mule default encoding.

  • If a value is specified, set the -M-Dmule.encoding VM argument to the same value to avoid an encoding mismatch.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

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

Object

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Invoke

<dynamics:invoke>

Generic simple invoke.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Uri

String

URI to invoke.

x

Http Method

Enumeration, one of:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP method to invoke.

x

Headers

Object

HTTP headers used in the request.

Body

String

String placed in the body of the request.

Encoding

Body encoding.

  • If no value is specified, set the Mule default encoding.

  • If a value is specified, set the -M-Dmule.encoding VM argument to the same value to avoid an encoding mismatch.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

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

Object

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Retrieve

<dynamics:retrieve>

Retrieves an entity.

  • Retrieve an Entity - https://msdn.microsoft.com/en-us/library/mt607871.aspx

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

Id

String

ID of the entity to retrieve.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

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

Object

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Retrieve Multiple

<dynamics:retrieve-multiple>

Retrieve multiple by URL.

  • Query Data using the Web API - https://msdn.microsoft.com/en-us/library/gg334767.aspx

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Data Query URL

String

URL to use for data retrieval.

x

Page Size

Number

Number of items in a results page.

5000

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

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 Object

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Retrieve Multiple By Query

<dynamics:retrieve-multiple-by-query>

Retrieve multiple by DSQL query.

  • Query Data using the Web API - https://msdn.microsoft.com/en-us/library/gg334767.aspx

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Datasense Query

String

DSQL query used to retrieve. The query is transformed in a retrieve URL internally.

x

Page Size

Number

Number of items in a results page.

5000

Expand

String

Information about the specified relationship to include in the response.

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

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 Object

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Unauthorize

<dynamics: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.

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

Associated Configurations

Update

<dynamics:update>

Updates an entity.

  • Create New Entity - https://msdn.microsoft.com/en-us/library/gg328090.aspx

  • Associate Entity Upon Creation - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4

  • Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx

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.

#[payload]

Encoding

Body encoding.

  • If no value is specified, set the Mule default encoding.

  • If a value is specified, set the -M-Dmule.encoding VM argument to the same value to avoid an encoding mismatch.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Update Multiple

<dynamics:update-multiple>

Updates multiple entities.

  • Update Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx

  • Associate Entities Upon Update - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4

  • Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx

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

Entities Attributes

Array of Object

List of the entities' attributes to create as a list of maps.

#[payload]

Use Single Transaction

Boolean

Use a single transaction for an update. If the update fails, the transaction is rolled back.

false

Encoding

Body encoding.

  • If no value is specified, set the Mule default encoding.

  • If a value is specified, set the -M-Dmule.encoding VM argument to the same value to avoid an encoding mismatch.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

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

Bulk Operation Result

Associated Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:INVALID_PAGE_SIZE

  • DYNAMICS:NOT_FOUND

  • DYNAMICS:OPERATION_FAILED

  • DYNAMICS:PARSE_ERROR

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:TIMEOUT

  • DYNAMICS:UNAUTHORIZED

  • DYNAMICS:UNKNOWN

Object Types

Bulk Item

Information about a bulk item.

Field Type Description Default Value Required

Exception

Any

Exception if the item fails.

Id

Any

Item ID.

Message

String

Message to add context to this item, such as an error description, a warning, or information related to the operation.

Payload

Object

Actual data the entity represents.

Status Code

String

Optional status code.

Successful

Boolean

Whether or not the request is successful.

Bulk Operation Result

Information about a bulk operation.

Field Type Description Default Value Required

Id

Any

Operation ID.

Items

Array of Bulk Item

Ordered list of bulk items.

Successful

Boolean

Whether or not the operation is successful. Must be true if and only if all the child DynamicsBulkItem entities are also successful.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

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 false, the reconnection strategy runs in a separate, non-blocking thread.

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 false, the reconnection strategy runs in a separate, non-blocking thread.

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:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

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.

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Id Expression

String

One or more expressions that determine if a message is redelivered. This property can be set only if the Use Secure Hash field is false.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Repeatable File Store Iterable

Repeatable file store iterable type.

Field Type Description Default Value Required

Max In Memory Size

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Max In Memory Size field.

Repeatable In Memory Iterable

Repeatable in memory iterable type.

Field Type Description Default Value Required

Initial Buffer Size

Number

Amount 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 Max In Memory Size. Default value is 100 instances.

Buffer Size Increment

Number

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

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

View on GitHub