Microsoft Dynamics 365 Connector 2.4 Reference - Mule 4

Release Notes: Microsoft Dynamics 365 Connector Release Notes

Configurations

Dynamics 365

Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	Connection OAuth Username Password	The connection types that can be provided to this configuration.	x
Expiration Policy	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.
Encoding		The default body encoding type. If the encoding type is not specified at the operation level, this encoding type is used.

Name

Type

Description

Default Value

Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

Connection

Connection
OAuth Username Password

The connection types that can be provided to this configuration.

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.

Encoding

The default body encoding type. If the encoding type is not specified at the operation level, this encoding type is used.

Connection Types

Connection

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Version	String	The version number of the API to which to connect	9.0
Scope	String		openid
Resource	String	Connector resource URL		x
Response Type	String		query
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, which means a maximum of 30 seconds for bulk-operations and indefinite for the rest operations.	0
Connection Timeout	Number	Specifies the amount of time, in milliseconds, for which the consumer attempts to establish a connection before the connection times out. Default value is 0, which means infinite.	0
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 authentication is not applied to the proxy, otherwise this value must be specified.
Password	String	Password used to authenticate against the proxy.
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to `true`, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Pooling Profile	Pooling Profile	Characteristics of the connection pool
Consumer Key	String	The OAuth key registered with the service provider		x
Consumer Secret	String	The OAuth consumer secret registered with the service provider		x
Authorization Url	String	The service provider’s authorization endpoint URL	`https://login.microsoftonline.com/oauth2/authorize`
Access Token Url	String	The service provider’s accessToken endpoint URL	`https://login.microsoftonline.com/oauth2/token`
Scopes	String	The OAuth scopes to request during the dance. If not provided, this value defaults to the scopes in the annotation.
Resource Owner Id	String	The ID each component should use if it doesn’t have another reference.
Before	String	The name of a flow to execute immediately before starting the OAuth dance.
After	String	The name of a flow to execute immediately after an accessToken is received.
Listener Config	String	A reference to an `<http:listener-config />` to use to create the listener that catches the access token callback endpoint.		x
Callback Path	String	The path of the access token callback endpoint		x
Authorize Path	String	The 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 should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it 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, the runtime automatically provisions the default object store.

Version

String

The version number of the API to which to connect

9.0

Scope

String

openid

Resource

String

Connector resource URL

Response Type

String

query

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, which means a maximum of 30 seconds for bulk-operations and indefinite for the rest operations.

Connection Timeout

Number

Specifies the amount of time, in milliseconds, for which the consumer attempts to establish a connection before the connection times out. Default value is 0, which means infinite.

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 authentication is not applied to the proxy, otherwise this value must be specified.

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.

Pooling Profile

Characteristics of the connection pool

Consumer Key

String

The OAuth key registered with the service provider

Consumer Secret

String

The OAuth consumer secret registered with the service provider

Authorization Url

String

The service provider’s authorization endpoint URL

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

Access Token Url

String

The service provider’s accessToken endpoint URL

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

Scopes

String

The OAuth scopes to request during the dance. If not provided, this value defaults to the scopes in the annotation.

Resource Owner Id

String

The ID each component should use if it doesn’t have another reference.

Before

String

The name of a flow to execute immediately before starting the OAuth dance.

After

String

The name of a flow to execute immediately after an accessToken is received.

Listener Config

String

A reference to an <http:listener-config /> to use to create the listener that catches the access token callback endpoint.

Callback Path

String

The path of the access token callback endpoint

Authorize Path

String

The path of the local HTTP endpoint that triggers the OAuth dance

External Callback Url

String

If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it 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, the runtime automatically provisions the default object store.

OAuth Username Password

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Version	String	The version number of the API to which to connect	9.0
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, which means infinite.	0
Connection Timeout	Number	Specifies the amount of time, in milliseconds, for which the consumer attempts to establish a connection before the connection times out. Default value is 0, which means infinite.	0
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 used against the proxy.
Password	String	Password used to authenticate against the proxy.
Username	String	User name 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			x
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to `true`, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Pooling Profile	Pooling Profile	Characteristics of the connection pool

Version

String

The version number of the API to which to connect

9.0

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, which means infinite.

Connection Timeout

Number

Specifies the amount of time, in milliseconds, for which the consumer attempts to establish a connection before the connection times out. Default value is 0, which means infinite.

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 used against the proxy.

Password

String

Password used to authenticate against the proxy.

Username

String

User name used to initialize the session

Password

String

Password used to authenticate the user

Resource

String

The App ID URI of the web API (secured resource).

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.

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.

Token Request Endpoint

String

Reconnection

Pooling Profile

Characteristics of the connection pool

Sources

On Modified Object
On New Object

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.

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

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Logical Name	String	The logical name of the entity. It is always the schema name in lower case.		x
Attributes	Object	The attributes of the entity to be created as a Map.	`#[payload]`
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.
Encoding	String	The body encoding type

Configuration

String

The name of the configuration to use.

Logical Name

String

The logical name of the entity. It is always the schema name in lower case.

Attributes

Object

The attributes of the entity to be created as a Map.

#[payload]

Target Variable

String

The name of a variable that stores 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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Encoding

String

The body encoding type

Output

Type

String

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:RETRY_EXHAUSTED
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

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Logical Name	String	The logical name of the entities to be created. It is always the schema name in lower case.		x
Entities Attributes	Array of Object	A list with the attributes of the entities to be created 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
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.
Encoding	String	The body encoding type

Configuration

String

The name of the configuration to use.

Logical Name

String

The logical name of the entities to be created. It is always the schema name in lower case.

Entities Attributes

Array of Object

A list with the attributes of the entities to be created 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

Target Variable

String

The name of a variable that stores 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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Encoding

String

The body encoding type

Output

Type	Bulk Operation Result

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:RETRY_EXHAUSTED
DYNAMICS:UNAUTHORIZED
DYNAMICS:UNKNOWN

Delete

<dynamics:delete>

Delete an Entity:

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

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Logical Name	String	The logical name of the entity. It is always the schema name in lower case.		x
Id	String	The ID of the entity to delete.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Logical Name

String

The logical name of the entity. It is always the schema name in lower case.

String

The ID of the entity to delete.

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:RETRY_EXHAUSTED
DYNAMICS:UNAUTHORIZED
DYNAMICS:UNKNOWN

Delete Multiple

<dynamics:delete-multiple>

Delete 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

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Logical Name	String	The logical name of the entity. It is always the schema name in lower case.		x
Ids	Array of String	The 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
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Logical Name

String

The logical name of the entity. It is always the schema name in lower case.

Ids

Array of String

The 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

Target Variable

String

The name of a variable that stores 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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type	Bulk Operation Result

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:RETRY_EXHAUSTED
DYNAMICS:UNAUTHORIZED
DYNAMICS:UNKNOWN

Disassociate

<dynamics:disassociate>

Removes a reference to an entity.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Logical Name	String	The logical name of the entity. It is always the schema name in lower case.		x
Attributes	Object	Disassociates a request’s payload.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Logical Name

String

The logical name of the entity. It is always the schema name in lower case.

Attributes

Object

Disassociates a request’s payload.

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:RETRY_EXHAUSTED
DYNAMICS:UNAUTHORIZED
DYNAMICS:UNKNOWN

Do Action

<dynamics:do-action>

Call Action:

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

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Action Name	String	The action name to call		x
Bounded Entity Type	String	An optional bounded entity type. You must provide this Value if the action is bounded.
Bounded Entity Id	String	An optional bounded entity ID. You must provide this value if the action is bounded.
Related Entities	Object	The body to send in the request as a Map.	`#[payload]`
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.
Encoding	String	The body encoding type

Configuration

String

The name of the configuration to use.

Action Name

String

The action name to call

Bounded Entity Type

String

An optional bounded entity type. You must provide this Value if the action is bounded.

Bounded Entity Id

String

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

Related Entities

Object

The body to send in the request as a Map.

#[payload]

Target Variable

String

The name of a variable that stores 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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Encoding

String

The body encoding type

Output

Type

Object

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:RETRY_EXHAUSTED
DYNAMICS:UNAUTHORIZED
DYNAMICS:UNKNOWN

Invoke

<dynamics:invoke>

Generic Simple Invoke.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Uri	String	The URI to invoke		x
Http Method	Enumeration, one of: GET POST PUT PATCH DELETE	The HTTP Method to invoke		x
Headers	Object	The HTTP headers used in the request. There are some default headers that are used; read more in the documentation.
Body	String	The string that will be placed in the body of the request.
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.
Encoding	String	The body encoding type

Configuration

String

The name of the configuration to use.

Uri

String

The URI to invoke

Http Method

Enumeration, one of:

GET
POST
PUT
PATCH
DELETE

The HTTP Method to invoke

Headers

Object

The HTTP headers used in the request. There are some default headers that are used; read more in the documentation.

Body

String

The string that will be placed in the body of the request.

Target Variable

String

The name of a variable that stores 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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Encoding

String

The body encoding type

Output

Type

Object

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:RETRY_EXHAUSTED
DYNAMICS:UNAUTHORIZED
DYNAMICS:UNKNOWN

Retrieve

<dynamics:retrieve>

Retrieve an Entity:

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

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Logical Name	String	The logical name of the entity. It is always the schema name in lower case.		x
Id	String	The id of the entity that is going to be retrieved.	`#[payload]`
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Logical Name

String

The logical name of the entity. It is always the schema name in lower case.

String

The id of the entity that is going to be retrieved.

#[payload]

Target Variable

String

The name of a variable that stores 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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:RETRY_EXHAUSTED
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

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Data Query URL	String	The URL to use for data retrieval		x
Page Size	Number	The size of a page	5000
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Data Query URL

String

The URL to use for data retrieval

Page Size

Number

The size of a page

5000

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

The name of a variable that stores 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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type	Array of Object

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
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

Parameters

Name Type Description Default Value Required

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. The query is transformed in a retrieve URL internally.		x
Page Size	Number	Number of items in a results page	5000
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Datasense Query

String

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

Page Size

Number

Number of items in a results page

5000

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

The name of a variable that stores 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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type	Array of Object

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:UNAUTHORIZED
DYNAMICS:UNKNOWN

Unauthorize

<dynamics:unauthorize>

Deletes all the access token information for a given resource owner ID so that it’s impossible to execute any operation for that user without re-performing the authorization dance.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Resource Owner Id	String	The ID of the resource owner to invalidate.

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Resource Owner Id

String

The ID of the resource owner to invalidate.

For Configurations

Dynamics 365

Update

<dynamics:update>

Update:

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

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Logical Name	String	The logical name of the entity. It is always the schema name in lower case.		x
Attributes	Object	The attributes of the entity.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.
Encoding	String	The body encoding type

Configuration

String

The name of the configuration to use.

Logical Name

String

The logical name of the entity. It is always the schema name in lower case.

Attributes

Object

The attributes of the entity.

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Encoding

String

The body encoding type

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:RETRY_EXHAUSTED
DYNAMICS:UNAUTHORIZED
DYNAMICS:UNKNOWN

Update Multiple

<dynamics:update-multiple>

Update 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

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Logical Name	String	The logical name of the entity. It is always the schema name in lower case.		x
Entities Attributes	Array of Object	A list with the attributes of the entities that are going to be updated 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
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.
Encoding	String	The body encoding type

Configuration

String

The name of the configuration to use.

Logical Name

String

The logical name of the entity. It is always the schema name in lower case.

Entities Attributes

Array of Object

A list with the attributes of the entities that are going to be updated 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

Target Variable

String

The name of a variable that stores 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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Encoding

String

The body encoding type

Output

Type	Bulk Operation Result

For Configurations

Dynamics 365

Throws

DYNAMICS:CONNECTIVITY
DYNAMICS:INVALID_PAGE_SIZE
DYNAMICS:NOT_FOUND
DYNAMICS:OPERATION_FAILED
DYNAMICS:PARSE_ERROR
DYNAMICS:RETRY_EXHAUSTED
DYNAMICS:UNAUTHORIZED
DYNAMICS:UNKNOWN

Sources Definitions

On Modified Object

<dynamics:on-modified-object>

Starts your app when an object is modified

Parameters

Name Type Description Default Value Required

Name	Type	Description	Required
Configuration	String	The name of the configuration to use.	x
Since	String	The 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
Primary Node Only	Boolean	Whether to execute this source on only the primary node when running in a cluster.
Scheduling Strategy	scheduling-strategy	Configures the scheduler that triggers the polling.	x
Redelivery Policy	Redelivery Policy	Defines a policy for processing the redelivery of the same message.
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Since

String

The 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.

Primary Node Only

Boolean

Whether to execute this source on only the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

Redelivery Policy

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

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

Any

For Configurations

Dynamics 365

On New Object

<dynamics:on-new-object>

Starts your app when a new object is created

Parameters

Name Type Description Default Value Required

Name	Type	Description	Required
Configuration	String	The name of the configuration to use.	x
Since	String	The 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
Primary Node Only	Boolean	Whether to execute this source on only the primary node when running in a cluster.
Scheduling Strategy	scheduling-strategy	Configures the scheduler that triggers the polling.	x
Redelivery Policy	Redelivery Policy	Defines a policy for processing the redelivery of the same message.
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Since

String

The 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.

Primary Node Only

Boolean

Whether to execute this source on only the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

Redelivery Policy

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

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

Any

For Configurations

Dynamics 365

Types

Reconnection

Field Type Description Default Value Required

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	Reconnect Reconnect Forever	The reconnection strategy to use.

Fails Deployment

Boolean

Reconnection Strategy

Reconnect
Reconnect Forever

The reconnection strategy to use.

Reconnect

Field	Type	Description	Default Value
Frequency	Number	How often to reconnect (in milliseconds).
Count	Number	The number of reconnection attempts to make.
blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.	true

Field

Type

Description

Default Value

Required

Frequency

Number

How often 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

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

Pooling Profile

Field Type Description Default Value Required

Field	Type	Description
Max Active	Number	Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that can be active at one time. When Max Active is exceeded, the pool is exhausted.
Max Idle	Number	Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that can be idle at one time.
Max Wait	Number	Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the Exhausted Action is set to `WHEN_EXHAUSTED_WAIT`
Min Eviction Millis	Number	Determines the minimum amount of time an object can sit idle in the pool before it is eligible for eviction. When non-positive, no objects are evicted from the pool due to idle time alone.
Eviction Check Interval Millis	Number	Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.
Exhausted Action	Enumeration, one of: WHEN_EXHAUSTED_GROW WHEN_EXHAUSTED_WAIT WHEN_EXHAUSTED_FAIL	Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: WHEN_EXHAUSTED_FAIL, which throws a NoSuchElementException WHEN_EXHAUSTED_WAIT, which blocks by invoking Object.wait(long) until a new or idle object is available WHEN_EXHAUSTED_GROW, which creates a new Mule instance and returns it, which makes the Max Active value meaningless. If a positive Max Wait value is supplied, it blocks for at most that many milliseconds, after which a NoSuchElementException is thrown. If Max Thread Wait is a negative value, it blocks indefinitely.
Initialisation Policy	Enumeration, one of: INITIALISE_NONE INITIALISE_ONE INITIALISE_ALL	Determines how components in a pool should be initialized: Possible values are: INITIALISE_NONE, which does not load components into the pool at startup INITIALISE_ONE, which loads one initial component into the pool at startup INITIALISE_ALL, which loads all components into the pool at startup
Disabled	Boolean	Whether pooling is disabled

Max Active

Number

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that can be active at one time. When Max Active is exceeded, the pool is exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that can be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the Exhausted Action is set to WHEN_EXHAUSTED_WAIT

Min Eviction Millis

Number

Determines the minimum amount of time an object can sit idle in the pool before it is eligible for eviction. When non-positive, no objects are evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

WHEN_EXHAUSTED_GROW
WHEN_EXHAUSTED_WAIT
WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are:

WHEN_EXHAUSTED_FAIL, which throws a NoSuchElementException
WHEN_EXHAUSTED_WAIT, which blocks by invoking Object.wait(long) until a new or idle object is available
WHEN_EXHAUSTED_GROW, which creates a new Mule instance and returns it, which makes the Max Active value meaningless. If a positive Max Wait value is supplied, it blocks for at most that many milliseconds, after which a NoSuchElementException is thrown. If Max Thread Wait is a negative value, it blocks indefinitely.

Initialisation Policy

Enumeration, one of:

INITIALISE_NONE
INITIALISE_ONE
INITIALISE_ALL

Determines how components in a pool should be initialized: Possible values are:

INITIALISE_NONE, which does not load components into the pool at startup
INITIALISE_ONE, which loads one initial component into the pool at startup
INITIALISE_ALL, which loads all components into the pool at startup

Disabled

Boolean

Whether pooling is disabled

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 is allowed to be idle before it’s considered eligible for expiration
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Max Idle Time attribute

Field

Type

Description

Default Value

Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Max Idle Time attribute

Redelivery Policy

Field Type Description Default Value Required

Field	Type	Description	Default Value
Max Redelivery Count	Number	The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a process-failed message
Use Secure Hash	Boolean	Whether to use a secure hash algorithm to identify a redelivered message.
Message Digest Algorithm	String	The secure hashing algorithm to use.	`SHA-256`
Id Expression	String	Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.
Object Store	Object Store	The object store where the redelivery counter for each message is stored.

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a process-failed message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use.

SHA-256

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

The object store where the redelivery counter for each message is stored.

Bulk Operation Result

Field

Type

Description

Default Value

Required

Any

Items

Array of Bulk Item

Successful

Boolean

Bulk Item

Field

Type

Description

Default Value

Required

Exception

Any

Message

String

Payload

Object

Status Code

String

Successful

Boolean

Repeatable In Memory Iterable

Field	Type	Description	Default Value
Initial Buffer Size	Number	The number of instances to 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 it expands according to the bufferSizeIncrement attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.	100
Buffer Size Increment	Number	Specifies how much the buffer size expands if it exceeds its initial specified size. Setting a value of zero or lower means that the buffer should not expand, and that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.	100
Max Buffer Size	Number	The maximum amount of memory to use. If more memory is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value of zero or lower means no limit.

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

The number of instances to 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 it expands according to the bufferSizeIncrement attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.

100

Buffer Size Increment

Number

Specifies how much the buffer size expands if it exceeds its initial specified size. Setting a value of zero or lower means that the buffer should not expand, and that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

100

Max Buffer Size

Number

The maximum amount of memory to use. If more memory is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value of zero or lower means no limit.

Repeatable File Store Iterable

Field	Type	Description	Default Value	Required
Max In Memory Size	Number	The maximum number of instances that are kept in memory. If more instances are required, then the connector starts to buffer the contents onto disk.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	The unit in which maxInMemorySize is expressed.

Field

Type

Description

Default Value

Required

Max In Memory Size

Number

The maximum number of instances that are kept in memory. If more instances are required, then the connector starts to buffer the contents onto disk.

Buffer Unit

Enumeration, one of: