String
Microsoft Dynamics CRM Connector 3.2 Reference
Anypoint Connector for Microsoft Dynamics CRM (Microsoft Dynamics CRM Connector) enables the integration of data to and from Microsoft Dynamics CRM systems.
Microsoft Dynamics CRM Connector 3.2.15 and later supports Java 17, but with some environment setup restrictions for the Kerberos connection type. Specifically, the CRM instance must be configured to support more secure encryption types (aes128-cts-hmac-sha1-96 or aes128-cts-hmac-sha256-128 ), as Java 17 enforces these by default. Alternatively, you can set the allow_weak_crypto flag to true in the krb5.conf file as a workaround.
|
Dynamics CRM Configurations
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
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
Claims
This authentication method includes directory sources that contain additional information (claims) about users to verify their identity.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Username |
String |
Username to connect to Dynamics CRM. |
x |
|
Password |
String |
Microsoft Windows password to connect to Dynamics NAV. |
x |
|
Organization Service Url |
String |
Base URL where the SOAP services are exposed in the form |
x |
|
Disable Cn Check |
Boolean |
Disable SSL certificate validation. |
false |
|
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 |
|
Enable Logging |
Boolean |
If this is |
|
|
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 going to be uses for 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 |
|||
Pooling Profile |
Characteristics of the connection pool. |
Kerberos
Clients obtain tickets from the Kerberos Key Distribution Center (KDC) and present the tickets to the server when the connection is established.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Username |
String |
Username that you want to login with. Domain should not be included. |
x |
|
Password |
String |
Password for the user that you are going to login. |
x |
|
Organization Service Url |
String |
URL for the SharePoint instance that the connector is going to interact with. |
x |
|
SPN |
String |
Service Principal Names (SPN) for the SharePoint web service. |
||
Realm |
String |
The case-sensitive default realm (domain name) that the user belongs to. |
||
KDC |
String |
The Key Distribution Center (KDC), usually the domain controller name, to authenticate the user. |
||
Login Properties File Path |
String |
Path to a customized login properties file. When not specified, default values which usually work for most cases are set up. |
||
Kerberos Properties File Path |
String |
Path to a customized Kerberos properties file. |
||
Disable SSL certificate validation |
Boolean |
When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an exception. To prevent this, you can disable the Common Name (CN) check. Note: This is not recommended for production environments. |
|
|
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 a Host value 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 with the proxy, otherwise this value must be specified. |
||
Password |
String |
Password used to authenticate against the proxy. |
||
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 |
|
Enable Logging |
Boolean |
If this is |
|
|
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
|||
Pooling Profile |
Characteristics of the connection pool |
NTLM
This authentication type is used on networks that include systems running on both Windows and stand-alone systems and uses an encrypted challenge-response protocol to authenticate the user.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Username |
String |
Username to connect to Dynamics CRM. |
x |
|
Password |
String |
The Windows password to connect to Dynamics NAV. |
x |
|
Organization Service Url |
String |
Base URL where the SOAP services are exposed in the form |
x |
|
Disable Cn Check |
Boolean |
Disable SSL certificate validation. |
|
|
Gateway Router Service Address |
String |
Gateway router service address. |
||
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 |
|
Enable Logging |
Boolean |
If this is true, requests and responses display in the console log. |
false |
|
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 a Host value 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 going to use against 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 |
|||
Pooling Profile |
Characteristics of the connection pool. |
Online
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Username |
String |
Username to connect to Dynamics CRM |
x |
|
Password |
String |
Windows password to connect to Dynamics NAV |
x |
|
Organization Service Url |
String |
Base URL where the SOAP services are exposed in the form |
x |
|
Disable Cn Check |
Boolean |
Disable SSL certificate validation. |
|
|
Authentication Retries |
Number |
If the authentication process to Microsoft fails the first time, the connector attempts to re-authenticate this many times. |
x |
|
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 |
|
Enable Logging |
Boolean |
If this is |
false |
|
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 a Host value 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 going to use against the proxy, otherwise this value must be specified. |
||
Password |
String |
Password used to authenticate against the proxy. |
||
Sts Metadata Url |
String |
The security token service’s metadata exchange URL. For Active Directory federation services (ADFS), this is usually |
||
Sts Username Port Qname |
String |
The name of port that accepts username and password credentials as described in the STS’s metadata exchange URL. This value has to be specified as a QName in the format |
||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
|||
Pooling Profile |
Characteristics of the connection pool |
Sources
Microsoft Dynamics CRM Connector sources (listeners) 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. |
Deleted Object
<microsoft-dynamics-crm:deleted-object>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Since |
String |
Required date format is |
||
Field Type |
String |
x |
||
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running 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 |
A retry strategy in case of connectivity errors. |
Modified Object
<microsoft-dynamics-crm:modified-object>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Since |
String |
Required date format is |
||
Field Type |
String |
x |
||
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running 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 |
A retry strategy in case of connectivity errors. |
New Object
<microsoft-dynamics-crm:new-object>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Since |
String |
Required date format is |
||
Field Type |
String |
x |
||
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running 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 |
A retry strategy in case of connectivity errors. |
Operations
Supported operations:
Associate
<microsoft-dynamics-crm:associate>
Create links between records.
Parameters
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. |
x |
|
Id |
String |
The ID of the record to which the related records are associated. |
x |
|
Relationship Entity Role Is Referenced |
Boolean |
|
false |
|
Relationship Schema Name |
String |
The name of the relationship to create the link. |
x |
|
Related Entities IDs |
Array of String |
A List<String> with the related entity records IDs to associate. |
x |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Create
<microsoft-dynamics-crm:create>
Create a new record.
Parameters
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. |
x |
|
Attributes |
Object |
The attributes of the record as a |
|
|
Target Variable |
String |
The name of a variable 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 |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Create Multiple
<microsoft-dynamics-crm:create-multiple>
Create multiple new records.
Parameters
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. |
x |
|
List Of Attributes |
Array of Object |
The list of attributes of the record as a |
|
|
Use Single Transaction |
Boolean |
If supported (CRM 2016 and above), use a single transaction to create all items, if anyone fails then rollback all. |
false |
|
Target Variable |
String |
The name of a variable 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 |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Delete
<microsoft-dynamics-crm:delete>
Delete a record.
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Delete Multiple
<microsoft-dynamics-crm:delete-multiple>
Delete multiple records.
Parameters
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. |
x |
|
IDs |
Array of String |
The IDs of the records to delete. |
x |
|
Use Single Transaction |
Boolean |
If supported (CRM 2016 and above) use a single transaction to delete all items, if anyone fails then rollback all. |
false |
|
Target Variable |
String |
The name of a variable 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 |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Disassociate
<microsoft-dynamics-crm:disassociate>
Delete a link between records.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Logical Name |
String |
The logical name of entity. |
x |
|
Id |
String |
The ID of the record from which the related records are disassociated. |
x |
|
Relationship Entity Role Is Referenced |
Boolean |
false: when the primary entity record is Referencing the record to associate; true: when the primary entity record is Referenced by the record to associate. |
false |
|
Relationship Schema Name |
String |
The name of the relationship to delete the link. |
x |
|
Related Entities IDs |
Array of String |
A List<String> with the related entity records IDs to disassociate. |
x |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Execute
<microsoft-dynamics-crm:execute>
Executes a message in the form of a request, and returns a response.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Request Name |
String |
The logical name of request make. |
x |
|
Request Parameters |
Any |
[DEPRECATED] This parameter will be removed from the configuration in the near future. Set the |
|
|
Request Id |
String |
The ID of the request to make. |
||
Target Variable |
String |
The name of a variable 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 |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Execute Multiple
<microsoft-dynamics-crm:execute-multiple>
Executes multiple messages in the form of a request, and returns their respective responses.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Requests |
Array of Any |
This parameter is a list of the requests ( |
|
|
Use Single Transaction |
Boolean |
If supported (CRM 2016 and above) use a single transaction to execute all requests, if anyone fails then rollback all. |
false |
|
Target Variable |
String |
The name of a variable 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 |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Retrieve
<microsoft-dynamics-crm:retrieve>
Retrieve a record.
Parameters
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. |
x |
|
Id |
String |
The ID of the record to retrieve. |
x |
|
Target Variable |
String |
The name of a variable 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 |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Retrieve Multiple By Query
<microsoft-dynamics-crm:retrieve-multiple-by-query>
Use a query to retrieve multiple records. You can find the definition of the Microsoft XML query language in the schema definition in http://msdn.microsoft.com/en-us/library/gg328332.aspx
.
You can find the aggregation examples here http://msdn.microsoft.com/en-us/library/gg328122.aspx
.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Query |
String |
For DataSense Query Language, the DSQL query. For native query language, the Fetch XML query. |
|
|
Items Per Page |
Number |
The number of items returned per page. |
50 |
|
Single Page Number |
Number |
If greater than 0, returns only that specific page. |
-1 |
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable 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 |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Update
<microsoft-dynamics-crm:update>
Update a record’s attributes.
Parameters
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. |
x |
|
Id |
String |
The ID of the record to update. |
x |
|
Attributes |
Object |
The attributes to update as a |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
Update Multiple
<microsoft-dynamics-crm:update-multiple>
Update a record’s attributes.
Parameters
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. |
x |
|
List Of Attributes |
Array of Object |
The list of attributes of the record as a |
|
|
Use Single Transaction |
Boolean |
If supported (CRM 2016 and above) use a single transaction to update all items, if anyone fails then rollback all. |
false |
|
Target Variable |
String |
The name of a variable 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 |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
MICROSOFT-DYNAMICS-CRM:CONNECTIVITY
-
MICROSOFT-DYNAMICS-CRM:INCOMPLETE_WSDL
-
MICROSOFT-DYNAMICS-CRM:INVALID_CERTIFICATE
-
MICROSOFT-DYNAMICS-CRM:INVALID_CREDENTIALS
-
MICROSOFT-DYNAMICS-CRM:INVALID_CRYPTOGRAPHIC_ALGORITHM
-
MICROSOFT-DYNAMICS-CRM:INVALID_JDK_VERSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_SESSION
-
MICROSOFT-DYNAMICS-CRM:INVALID_URL
-
MICROSOFT-DYNAMICS-CRM:RETRY_EXHAUSTED
-
MICROSOFT-DYNAMICS-CRM:TRANSACTION
-
MICROSOFT-DYNAMICS-CRM:TRANSFORMATION
-
MICROSOFT-DYNAMICS-CRM:UNKNOWN
-
MICROSOFT-DYNAMICS-CRM:VALIDATION
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 |
||
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 |
Pooling Profile
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
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 may be active at one time. When maxActive is exceeded, the pool is said to be 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 may 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 exhaustedAction is set to WHEN_EXHAUSTED_WAIT. |
||
Min Eviction Millis |
Number |
Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be 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:
|
Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are:
|
||
Initialisation Policy |
Enumeration, one of:
|
Determines how components in a pool should be initialized. The possible values are:
|
||
Disabled |
Boolean |
Whether pooling should be 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 should be allowed to be idle before it’s considered eligible for expiration |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute |
Redelivery Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Redelivery Count |
Number |
The maximum number of times a message can be redelivered and processed unsuccessfully before triggering 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. If not set, the default is 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 Use Secure Hash is |
||
Object Store |
Object Store |
The object store where the redelivery counter for each message is stored. |
Bulk Operation Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Id |
Any |
|||
Items |
Array of Bulk Item |
|||
Successful |
Boolean |
Bulk Item
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Exception |
Any |
|||
Id |
Any |
|||
Message |
String |
|||
Payload |
Object |
|||
Status Code |
String |
|||
Successful |
Boolean |
Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The 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 Buffer 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 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 than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
Repeatable File Store Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Objects |
Number |
The maximum amount of instances to keep in memory. If more than that is required, then it starts to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed. |