Nav

Microsoft Dynamics 365 For Operations Connector Reference

Dynamics 365 For Operations Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

  • OAuth2

  • OAuth Username Password

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

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

OAuth2 Connection Type

Parameters

Name Type Description Default Value Required

Scope

String

openid

Resource

String

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, 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, no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

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.

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, the connector defaults to those in the annotation.

Resource Owner Id

String

The resourceOwnerId which each component should use if it doesn’t reference otherwise.

Before

String

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

After

String

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

Listener Config

String

A reference to a <http:listener-config /> to use to create the listener to 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 connector 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 to use to access the callback.

Object Store

String

A reference to the object store to store each resource owner ID’s data. If not specified, the runtime automatically provisions the default one.

Oauth Username Password Connection Type

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

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, 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, no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Associated Operations

  • executeOperation

  • importDataRecurringJob

  • retrieveMultiple

  • retrieveMultipleByQuery

  • unauthorize

Operations

Execute Operation

<dynamics365ForOperations:execute-operation>

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

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 that stores the output of the operation.

Target Value

String

An expression that evaluates the operation’s output and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy to use for connectivity errors.

Output

Type

Object

For Configurations

  • dynamics-365-for-operations

Throws

  • DYNAMICS365FOROPERATIONS:UNKNOWN

  • DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS

  • DYNAMICS365FOROPERATIONS:CONNECTIVITY

  • DYNAMICS365FOROPERATIONS:INVALID_CONNECTION

  • DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED

  • DYNAMICS365FOROPERATIONS:LOGIN_FAILED

  • DYNAMICS365FOROPERATIONS:CONNECTIVITY

Import Data Recurring Job

<dynamics365ForOperations:import-data-recurring-job>

Operation that 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

the data to be submitted

#[payload]

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression that evaluates the operation’s output and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy to use for connectivity errors.

Output

Type

String

For Configurations

  • dynamics-365-for-operations

Throws

  • DYNAMICS365FOROPERATIONS:UNKNOWN

  • DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS

  • DYNAMICS365FOROPERATIONS:CONNECTIVITY

  • DYNAMICS365FOROPERATIONS:INVALID_CONNECTION

  • DYNAMICS365FOROPERATIONS:RETRY_EXHAUSTED

  • DYNAMICS365FOROPERATIONS:LOGIN_FAILED

  • DYNAMICS365FOROPERATIONS:CONNECTIVITY

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.

#[payload]

Streaming Strategy

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable

  • non-repeatable-iterable

Configure to use repeatable streams and their behavior.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression that evaluates the operation’s output and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy to use for connectivity errors.

Output

Type

Array of Object

For Configurations

  • dynamics-365-for-operations

Throws

  • DYNAMICS365FOROPERATIONS:UNKNOWN

  • DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS

  • DYNAMICS365FOROPERATIONS:INVALID_CONNECTION

  • DYNAMICS365FOROPERATIONS:LOGIN_FAILED

  • DYNAMICS365FOROPERATIONS:CONNECTIVITY

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 that is going to be used for retrieve. The query transforms internally into a URL.

#[payload]

Streaming Strategy

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable

  • non-repeatable-iterable

Configure to use repeatable streams and their behavior.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression that evaluates the operation’s output and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy to use for connectivity errors.

Output

Type

Array of Object

For Configurations

  • dynamics-365-for-operations

Throws

  • DYNAMICS365FOROPERATIONS:UNKNOWN

  • DYNAMICS365FOROPERATIONS:INVALID_CREDENTIALS

  • DYNAMICS365FOROPERATIONS:INVALID_CONNECTION

  • DYNAMICS365FOROPERATIONS:LOGIN_FAILED

  • DYNAMICS365FOROPERATIONS:CONNECTIVITY

Unauthorize

<dynamics365ForOperations:unauthorize>

Deletes all access token information for a resource owner ID so that it’s impossible to execute any operation for that user without doing 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.

For Configurations

  • dynamics-365-for-operations

Types

Reconnection

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.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time to allow a dynamic configuration instance to be idle before being eligible to expire.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

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

Buffer Size Increment

Number

How much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should 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

The maximum amount of memory to use. If more memory is needed, the STREAM_MAXIMUM_SIZE_EXCEEDED error occurs. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

The maximum amount of instances to keep in memory. If more are required, the connector starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.