Contact Free trial Login

Microsoft Dynamics 365 For Operations Connector 2.0 Reference - Mule 4

Support Category: Select

Compatibility:

  • Microsoft Dynamics 365 For Operations: 1611

  • Mule Runtime: 4.0.0 and later

  • Anypoint Studio: 7.0.0 and later

Configurations


Microsoft Dynamics 365 For Operations

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

OAuth2
Parameters
Name Type Description Default Value Required

Scope

String

openid

Resource

String

OAuth endpoint 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 infinite.

0

Connection Timeout

Number

Specifies the amount of time in milliseconds that the consumer attempts to establish a connection before it 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 is used; otherwise a proxy is used, but a proxy host must be specified.

Port

Number

Port of the proxy. If Host is set, 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; otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Reconnection

When the app is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Consumer Key

String

The OAuth consumerKey as registered with the service provider.

x

Consumer Secret

String

The OAuth consumerSecret as registered with the service provider.

x

Authorization Url

String

The service provider’s authorization endpoint URL.

https://login.microsoftonline.com/{tenant}/oauth2/authorize

Access Token Url

String

The service provider’s accessToken endpoint URL.

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

Scopes

String

The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation.

Resource Owner Id

String

The resourceOwnerId that each component should use if it doesn’t otherwise provide a reference.

Before

String

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

After

String

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

Listener Config

String

A reference to a <http:listener-config /> to use to create the listener that will catch 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, Mule automatically provisions the default object store.

OAuth Username Password (Deprecated)
Parameters
Name Type Description Default Value Required

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Resource

String

The Application 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 app, 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

When the app 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.

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 that the consumer attempts to establish a connection before it 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 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 no authentication is used against the proxy; otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Operations

Execute Operation

<dynamics365ForOperations:execute-operation>

Executes a request against a URL in the https://host_uri/api/Services/service_group_name/service_group_service_name/operation_name format.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Parameters

Object

Parameters of the operation to execute.

#[payload]

Service Group

String

The service group name (first level metadata key).

x

Service Name

String

The service name (second level metadata key).

x

Operation

String

The operation name (third level metadata key).

x

Target Variable

String

The name of a variable in which to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

Throws

  • DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS

  • DYNAMICS365FOROPERATIONS:INVALID_CONNECTION

  • DYNAMICS365FOROPERATIONS:LOGIN_FAILED

  • DYNAMICS365FOROPERATIONS:TIMEOUT

  • DYNAMICS365FOROPERATIONS:INVALID_INPUT

  • DYNAMICS365FOROPERATIONS:CONNECTIVITY

  • DYNAMICS365FOROPERATIONS:NOT_FOUND

  • DYNAMICS365FOROPERATIONS:UNKNOWN

  • DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED

Import Data Recurring Job

<dynamics365ForOperations:import-data-recurring-job>

Facilitates submitting data to recurring data jobs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Uri Path

String

Import URI for example, :/api/connector/enqueue/

api/connector/enqueue/

Activity Id

String

Activity ID.

x

Entity Name

String

Entity name.

x

File input

Binary

Data to be submitted.

#[payload]

Target Variable

String

The name of a variable in which to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Throws

  • DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS

  • DYNAMICS365FOROPERATIONS:INVALID_CONNECTION

  • DYNAMICS365FOROPERATIONS:LOGIN_FAILED

  • DYNAMICS365FOROPERATIONS:TIMEOUT

  • DYNAMICS365FOROPERATIONS:INVALID_INPUT

  • DYNAMICS365FOROPERATIONS:CONNECTIVITY

  • DYNAMICS365FOROPERATIONS:NOT_FOUND

  • DYNAMICS365FOROPERATIONS:UNKNOWN

  • DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED

Retrieve Multiple

<dynamics365ForOperations:retrieve-multiple>

Retrieve multiple entities by URL.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Data Query URL

String

The URL to use to retrieve the entities. The URL is in ODATA format.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a in variable in which to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

Throws

  • DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS

  • DYNAMICS365FOROPERATIONS:INVALID_CONNECTION

  • DYNAMICS365FOROPERATIONS:LOGIN_FAILED

  • DYNAMICS365FOROPERATIONS:TIMEOUT

  • DYNAMICS365FOROPERATIONS:INVALID_INPUT

  • DYNAMICS365FOROPERATIONS:CONNECTIVITY

  • DYNAMICS365FOROPERATIONS:NOT_FOUND

  • DYNAMICS365FOROPERATIONS:UNKNOWN

  • DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED

Retrieve Multiple By Query

<dynamics365ForOperations:retrieve-multiple-by-query>

Retrieve multiple entities by DSQL query.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DataSense Query

String

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

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

Throws

  • DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS

  • DYNAMICS365FOROPERATIONS:INVALID_CONNECTION

  • DYNAMICS365FOROPERATIONS:LOGIN_FAILED

  • DYNAMICS365FOROPERATIONS:TIMEOUT

  • DYNAMICS365FOROPERATIONS:INVALID_INPUT

  • DYNAMICS365FOROPERATIONS:CONNECTIVITY

  • DYNAMICS365FOROPERATIONS:NOT_FOUND

  • DYNAMICS365FOROPERATIONS:UNKNOWN

  • DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED

Unauthorize

<dynamics365ForOperations:unauthorize>

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

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

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the app is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

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

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Max Idle Time attribute.

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

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

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 less than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

The maximum number of instances to keep in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which Max In Memory Size is expressed.