The Microsoft Dynamics CRM connector provides unified connectivity to Dynamics CRM 2011, 2013 and 2015, On-Premises and On-Demand versions.

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.7.0 or higher

Configs

Claims Connection

<dynamicscrm:claims-connection-config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

User to authenticate with.

x 

password

String

Password for the user to authenticate with.

x 

organizationServiceUrl

String

The path to the Microsoft Dynamics CRM Organization service (https://crm.myorganization.com/XRMServices/2011/Organization.svc).

x 

disableCnCheck

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 it is possible to disable the CN (Common Name) check.

Note: this is not recommended for production environments.

false

 

connectionTimeout

Integer

Time to wait for a response in seconds. 0 (zero) means unlimited.

60

 

proxyConnection

String

Optional Proxy configuration.

 

Kerberos Connection

<dynamicscrm:kerberos-connection-config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

User to authenticate with.

x 

password

String

Password for the user to authenticate with.

x 

organizationServiceUrl

String

The path to the Microsoft Dynamics CRM Organization service (https://crm.myorganization.com/XRMServices/2011/Organization.svc).

x 

spn

String

 

realm

String

 

kdc

String

 

enableConnectionDebug

Boolean

Enable logging of debug information during Kerberos login.

false

 

loginPropertiesFilePath

String

 

kerberosPropertiesFilePath

String

 

disableCnCheck

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 it is possible to disable the CN (Common Name) check.

Note: this is not recommended for production environments.

false

 

connectionTimeout

Integer

Time to wait for a response in seconds. 0 (zero) means unlimited.

60

 

proxyConnection

String

Optional Proxy configuration.

 

Legacy Connection

<dynamicscrm:config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

User to authenticate with.

x 

password

String

Password for the user to authenticate with.

x 

organizationServiceUrl

String

The path to the Microsoft Dynamics CRM Organization service (https://crm.myorganization.com/XRMServices/2011/Organization.svc).

x 

authenticationType

AuthenticationType

The authentication scheme to be used when connecting against the CRM instance.

x 

authenticationRetries

int

If the authentication process against Microsoft Online fails the first time the connector will attempt to re-authenticate this many times.

3

 

gatewayRouterServiceAddress

String

/** The address of the gateway service that routes the requests to the CRM instance (https://mygateway.com/router).

 

autoDiscoverKerberos

Boolean

Obsolete setting. Automatic detection of Kerberos settings (like Domain Controller and Realm) is assumed when the 'Kerberos Properties File Path' is left blank. This usually works when the computer running the mule flow is joined to the domain that the 'Username' belongs to.

true

 

enableConnectionDebug

Boolean

Enable logging of debug information during Kerberos login.

false

 

spn

String

 

loginPropertiesFilePath

String

 

kerberosPropertiesFilePath

String

 

disableCnCheck

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 it is possible to disable the CN (Common Name) check.

Note: this is not recommended for production environments.

false

 

connectionTimeout

Integer

Time to wait for a response in seconds. 0 (zero) means unlimited.

60

 

proxyConnection

String

Optional Proxy configuration.

 

NTLM Connection

<dynamicscrm:ntlm-connection-config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

User to authenticate with.

x 

password

String

Password for the user to authenticate with.

x 

organizationServiceUrl

String

The path to the Microsoft Dynamics CRM Organization service (https://crm.myorganization.com/XRMServices/2011/Organization.svc).

x 

gatewayRouterServiceAddress

String

The address of the gateway service that routes the requests to the CRM instance (https://mygateway.com/router).

x 

disableCnCheck

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 it is possible to disable the CN (Common Name) check.

Note: this is not recommended for production environments.

false

 

connectionTimeout

Integer

Time to wait for a response in seconds. 0 (zero) means unlimited.

60

 

proxyConnection

String

Optional Proxy configuration.

 

Online Connection

<dynamicscrm:online-connection-config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

User to authenticate with.

x 

password

String

Password for the user to authenticate with.

x 

organizationServiceUrl

String

The path to the Microsoft Dynamics CRM Organization service (https://crm.myorganization.com/XRMServices/2011/Organization.svc).

x 

authenticationRetries

int

If the authentication process against Microsoft Online fails the first time the connector will attempt to re-authenticate this many times.

3

 

stsMetadataUrl

String

(Optional) The STS's metadata exchange url. For ADFS this is usually https://mycompany-sts.com/adfs/services/trust/mex.

 

stsUsernamePortQname

String

(Optional) The name of port that accepts username/password credentials as described in the STS's metadata exchange url. This value has to be specified as a Qname in the format '{http://schemas.microsoft.com/ws/2008/06/identity/securitytokenservice}UserNameWSTrustBinding_IWSTrust13Async'.

 

disableCnCheck

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 it is possible to disable the CN (Common Name) check.

Note: this is not recommended for production environments.

false

 

connectionTimeout

Integer

Time to wait for a response in seconds. 0 (zero) means unlimited.

60

 

proxyConnection

String

Optional Proxy configuration.

 

Processors

Create

<dynamicscrm:create>

  DataSense enabled

Create a new record. ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:create

XML Sample

<dynamicscrm:create logicalName="entityName" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

logicalName

String

The logical name of the entity.

x 

attributes

Map<String,Object>

The attributes of the record as a Map .

#[payload]

 

Returns

Return Java Type Description

String

The id of the created entity.

Create multiple

<dynamicscrm:create-multiple>

  DataSense enabled

Create a several new record. ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:create-multiple

XML Sample

<dynamicscrm:create-multiple logicalName="entityName" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

logicalName

String

The logical name of the entity.

x 

attributesList

List<Map<String,Object>>

The list of attributes of the record as a List >.

#[payload]

 

useSingleTransaction

boolean

If supported (CRM 2016 and above) use a single transaction to create all items, if anyone fails then rollback all.

false

 

Returns

Return Java Type Description

BulkOperationResult<Map<String,Object>>

The results of the created entities in form of BulkOperationResult >.

Update

<dynamicscrm:update>

  DataSense enabled

Update a record's attributes. ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:update

XML Sample

<dynamicscrm:update logicalName="entityName" id="entityId" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

logicalName

String

The logical name of the entity.

x 

id

String

The id of the record to update.

x 

attributes

Map<String,Object>

The attributes to be updated as a Map .

#[payload]

 

Update multiple

<dynamicscrm:update-multiple>

  DataSense enabled

Update a record's attributes. ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:update-multiple

XML Sample

<dynamicscrm:update-multiple logicalName="entityName" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

logicalName

String

The logical name of the entity.

x 

attributesList

List<Map<String,Object>>

The list of attributes of the record as a List >.

#[payload]

 

useSingleTransaction

boolean

If supported (CRM 2016 and above) use a single transaction to update all items, if anyone fails then rollback all.

false

 

Returns

Return Java Type Description

BulkOperationResult<Map<String,Object>>

The results of the created entities in form of BulkOperationResult >.

Delete

<dynamicscrm:delete>

  DataSense enabled

Delete a record. ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:delete

XML Sample

<dynamicscrm:delete logicalName="entityName" id="entityId" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

logicalName

String

The logical name of the entity.

x 

id

String

The id of the record to delete.

#[payload]

 

Delete multiple

<dynamicscrm:delete-multiple>

  DataSense enabled

Delete multiple records. ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:delete-multiple

XML Sample

<dynamicscrm:delete-multiple logicalName="entityName" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

logicalName

String

The logical name of the entity.

x 

ids

List<String>

The ids of the records to delete.

#[payload]

 

useSingleTransaction

boolean

If supported (CRM 2016 and above) use a single transaction to delete all items, if anyone fails then rollback all.

false

 

Returns

Return Java Type Description

BulkOperationResult<String>

The results of the created entities in form of BulkOperationResult .

Retrieve

<dynamicscrm:retrieve>

  DataSense enabled

Retrieve a record. ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:retrieve

XML Sample

<dynamicscrm:retrieve logicalName="entityName" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

logicalName

String

The logical name of the entity.

x 

id

String

The id of the record to retrieve.

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

attributes of specified entity in Map form

Retrieve multiple by query

<dynamicscrm:retrieve-multiple-by-query>

  Paged Operation

Retrieve multiple records.

The definition of the Microsoft XML Query Language can be found in the Schema Definition in this link: http://msdn.microsoft.com/en-us/library/gg328332.aspx

The aggregation examples can be found in this link: http://msdn.microsoft.com/en-us/library/gg328122.aspx ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:retrieve-multiple-by-query

XML Sample

<dynamicscrm:retrieve-multiple-by-query query="queryExpression" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

query

String

For DataSense Query Language, the DSQL query. For Native Query Language, the Fetch XML query.

x 

pagingConfiguration

PagingConfiguration

The configuration for the pagination feature.

x 

singlePageNumber

int

If greater than 0, returns only that specific page.

-1

 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Map<String,Object>,DynamicsCRMConnector>

A paging delegate with the records resulting from the query.

Associate

<dynamicscrm:associate>

  DataSense enabled

Create links between records. ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:associate

XML Sample

<dynamicscrm:associate logicalName="entityName" id="entityId" relationshipSchemaName="schema" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

logicalName

String

The logical name of the entity.

x 

id

String

The id of the record to which the related records are associated.

x 

relationshipEntityRoleIsReferenced

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

 

relationshipSchemaName

String

The name of the relationship to create the link.

x 

relatedEntitiesIds

List<String>

A List with the related entity records ids to associate.

#[payload]

 

Disassociate

<dynamicscrm:disassociate>

  DataSense enabled

Delete a link between records. ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:disassociate

XML Sample

<dynamicscrm:disassociate logicalName="entityName" id="entityId" relationshipSchemaName="schema" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

logicalName

String

The logical name of entity.

x 

id

String

The id of the record from which the related records are disassociated.

x 

relationshipEntityRoleIsReferenced

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

 

relationshipSchemaName

String

The name of the relationship to delete the link.

x 

relatedEntitiesIds

List<String>

A List with the related entity records ids to disassociate.

#[payload]

 

Execute

<dynamicscrm:execute>

  DataSense enabled

Executes a message in the form of a request, and returns a response. ../../../doc/mule-module-ms-dynamics-crm.xml.sample dynamicscrm:execute

XML Sample

<dynamicscrm:execute requestName="requestName" config-ref=" " />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

requestName

String

The logical name of request make.

x 

payload

Object

The current message payload is automatically transformed and injected to this parameter.
[DEPRECATED] This parameter will be removed from the configuration in the near future. Set the #[payload] correctly before calling the connector.

#[payload]

 

requestId

String

The id of the request to make.

 

Returns

Return Java Type Description

Object

The organization response as a OrganizationResponse.

Execute multiple

<dynamicscrm:execute-multiple>

Executes multiple messages in the form of a request, and returns their respective responses.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

payload

List<Object>

The current message payload is automatically transformed and injected to this parameter.
This parameter is a list of the requests (OrganizationRequest or Map). Set the #[payload] correctly before calling the connector.

#[payload]

 

requestId

String

The id of the request to make.

 

useSingleTransaction

boolean

If supported (CRM 2016 and above) use a single transaction to execute all requests, if anyone fails then rollback all.

false

 

Returns

Return Java Type Description

BulkOperationResult

The organization responses for each one of the requests performed.