org.mule.modules

mule-module-ms-dynamics-crm-onpremise

config

Namespace	http://www.mulesoft.org/schema/mule/dynamicscrm-onpremise
Schema Location	http://www.mulesoft.org/schema/mule/dynamicscrm-onpremise/current/mule-dynamicscrm-onpremise.xsd (View Schema)
Schema Version	1.2
Minimum Mule Version	3.2

Module Overview

Microsoft Dynamics CRM 2011 Onpremise version

This connector allow the integration with MS Dynamics CRM 2011 Onpremise version.

The service of MS Dynamics CRM provide a few operations that are extensible for all the entities (default and custom) created. A list of the default entities can be found in the MSDN documentation link: "http://msdn.microsoft.com/en-us/library/bb959317.aspx

The connector uses Kerberos/SPNEGO with Active Directory for Authentication.

If you are going to use this connector be sure to have your environment well configured. This requires a CRM Onpremise 2011 Server (Windows 2008 Server x64) running in a Active Directory Domain with a SPN configured over HTTP/... Also the DNS configuration for the CRM server and the Kerberos/AD server.

Debug purposes:

---------------

To add debug in Kerberos/SPNEGO flow add this parameters in the VM params:

-Dsun.security.krb5.debug=true

-Dsun.security.spnego.debug=true

-----------------

Create a new file with the next configuration in your server:

********************************************************************************************

Kerberos {

com.sun.security.auth.module.Krb5LoginModule required debug=true;

};

********************************************************************************************

i.e. In this case, Kerberos is the only module configured, and it will be the param to be used in loginConfigModule=Kerberos

Kerberos Config File

--------------------

Create a new file with the next configuration in your server:

********************************************************************************************

[libdefaults]

default_realm = <YOUR_REALM>

default_tkt_enctypes = rc4-hmac aes128-cts des3-cbc-sha1 des-cbc-md5 des-cbc-crc

default_tgs_enctypes = rc4-hmac aes128-cts des3-cbc-sha1 des-cbc-md5 des-cbc-crc

permitted_enctypes = rc4-hmac aes128-cts des3-cbc-sha1 des-cbc-md5 des-cbc-crc

[realms]

<YOUR_REALM> = {

kdc = <Kerberos_location>

default_domain = <YOUR_REALM>

}

[domain_realm]

.<your_realm> = <YOUR_REALM>

<your_realm> = <YOUR_REALM>

********************************************************************************************

Please note the upper and lower case.

Summary

Configuration
<dynamicscrm-onpremise:config> Configure an instance of this module

Message Processors
<dynamicscrm-onpremise:associate> Associate a set of entities
<dynamicscrm-onpremise:create> Create entity
<dynamicscrm-onpremise:delete> Delete entity
<dynamicscrm-onpremise:disassociate> Disassociate a set of entities
<dynamicscrm-onpremise:execute> Execute a business logic method
<dynamicscrm-onpremise:retrieve> Retrieve entity
<dynamicscrm-onpremise:retrieve-multiple-by-attributes> Retrieve multiple entities by attributes values and sorting options
<dynamicscrm-onpremise:retrieve-multiple-by-query> Retrieve multiple entities by a query described by and XML 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/bb930489.aspx The aggregation examples can be found in this link: http://msdn.microsoft.com/en-us/library/gg309565.aspx
<dynamicscrm-onpremise:update> Update entity

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:dynamicscrm-onpremise="http://www.mulesoft.org/schema/mule/dynamicscrm-onpremise"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/dynamicscrm-onpremise
               http://www.mulesoft.org/schema/mule/dynamicscrm-onpremise/current/mule-dynamicscrm-onpremise.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <dynamicscrm-onpremise:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
username		Username	String	/	UTF-8
password		Password	String	/	UTF-8
organizationServiceUrl		The path to the MS Dynamics Configuration scv	String	/	UTF-8
loginConfigPath		The path where the LoginConfig file is	String	/	UTF-8
kerberosConfigPath		The path where the Kerberos config file is	String	/	UTF-8
loginConfigModule		The LoginModule configuration to use (this is defined inside of LoginConfig file)	String	/	UTF-8
spn		The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <dynamicscrm-onpremise:config>
         <reconnect count="5" frequency="1000"/>
    </dynamicscrm-onpremise:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<dynamicscrm-onpremise:associate>

Associate a set of entities

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
entityName	Logical name of entity	String	/	UTF-8
entityId	Guid of entity in string form	String	/	UTF-8
relationshipEntityRoleIsReferenced	If the role of the entity is "Referenced" (true) of "Referencing" (false)	Boolean	/
relationshipSchemaName	The type of relationship	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
organizationServiceUrl	Optional. The path to the MS Dynamics Configuration scv	String	/	UTF-8
loginConfigPath	Optional. The path where the LoginConfig file is	String	/	UTF-8
kerberosConfigPath	Optional. The path where the Kerberos config file is	String	/	UTF-8
loginConfigModule	Optional. The LoginModule configuration to use (this is defined inside of LoginConfig file)	String	/	UTF-8
spn	Optional. The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<dynamicscrm-onpremise:related-entities-attributes>		List of the attributes of related entities	List<Map<String, Object>>

Exception Payloads

Payload Class	Description
IOrganizationServiceAssociateOrganizationServiceFaultFaultFaultMessage

<dynamicscrm-onpremise:create>

Create entity

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
logicalName	A logical name	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
organizationServiceUrl	Optional. The path to the MS Dynamics Configuration scv	String	/	UTF-8
loginConfigPath	Optional. The path where the LoginConfig file is	String	/	UTF-8
kerberosConfigPath	Optional. The path where the Kerberos config file is	String	/	UTF-8
loginConfigModule	Optional. The LoginModule configuration to use (this is defined inside of LoginConfig file)	String	/	UTF-8
spn	Optional. The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<dynamicscrm-onpremise:entity>		An entity object represented as a map	Map<String, Object>

Returns

Return Type	Description
String	The GUID of the created entity.

Exception Payloads

Payload Class	Description
IOrganizationServiceCreateOrganizationServiceFaultFaultFaultMessage

<dynamicscrm-onpremise:delete>

Delete entity

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
logicalName	Logical name of the entity to be updated	String	/	UTF-8
guid	The guid of the entity to be retrieved	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
organizationServiceUrl	Optional. The path to the MS Dynamics Configuration scv	String	/	UTF-8
loginConfigPath	Optional. The path where the LoginConfig file is	String	/	UTF-8
kerberosConfigPath	Optional. The path where the Kerberos config file is	String	/	UTF-8
loginConfigModule	Optional. The LoginModule configuration to use (this is defined inside of LoginConfig file)	String	/	UTF-8
spn	Optional. The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOrganizationServiceDeleteOrganizationServiceFaultFaultFaultMessage

<dynamicscrm-onpremise:disassociate>

Disassociate a set of entities

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
entityName	Logical name of entity	String	/	UTF-8
entityId	Guid of entity in string form	String	/	UTF-8
relationshipEntityRoleIsReferenced	If the role of the entity is "Referenced" (true) of "Referencing" (false)	Boolean	/
relationshipSchemaName	The type of relationship	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
organizationServiceUrl	Optional. The path to the MS Dynamics Configuration scv	String	/	UTF-8
loginConfigPath	Optional. The path where the LoginConfig file is	String	/	UTF-8
kerberosConfigPath	Optional. The path where the Kerberos config file is	String	/	UTF-8
loginConfigModule	Optional. The LoginModule configuration to use (this is defined inside of LoginConfig file)	String	/	UTF-8
spn	Optional. The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<dynamicscrm-onpremise:related-entities-attributes>		List of the attributes of related entities	List<Map<String, Object>>

Exception Payloads

Payload Class	Description
IOrganizationServiceDisassociateOrganizationServiceFaultFaultFaultMessage

<dynamicscrm-onpremise:execute>

Execute a business logic method

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
requestName	Logical name of request to be made	String	/	UTF-8
requestGuid	Optional. The guid of the request to me made	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
organizationServiceUrl	Optional. The path to the MS Dynamics Configuration scv	String	/	UTF-8
loginConfigPath	Optional. The path where the LoginConfig file is	String	/	UTF-8
kerberosConfigPath	Optional. The path where the Kerberos config file is	String	/	UTF-8
loginConfigModule	Optional. The LoginModule configuration to use (this is defined inside of LoginConfig file)	String	/	UTF-8
spn	Optional. The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<dynamicscrm-onpremise:request-parameters>		A collection of parameters to the request in Map form	Map<String, Object>

Returns

Return Type	Description
Map<String, Object>	organization response to execute request

Exception Payloads

Payload Class	Description
IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage

<dynamicscrm-onpremise:retrieve>

Retrieve entity

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
logicalName	Name od the entity to be retrieved	String	/	UTF-8
guid	The guid of the entity to be retrieved	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
organizationServiceUrl	Optional. The path to the MS Dynamics Configuration scv	String	/	UTF-8
loginConfigPath	Optional. The path where the LoginConfig file is	String	/	UTF-8
kerberosConfigPath	Optional. The path where the Kerberos config file is	String	/	UTF-8
loginConfigModule	Optional. The LoginModule configuration to use (this is defined inside of LoginConfig file)	String	/	UTF-8
spn	Optional. The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<dynamicscrm-onpremise:attributes>		Attributes that will be retrieved from the entity specified	List<String>

Returns

Return Type	Description
Map<String, Object>	attributes of specified entity in Map form

Exception Payloads

Payload Class	Description
IOrganizationServiceRetrieveOrganizationServiceFaultFaultFaultMessage

<dynamicscrm-onpremise:retrieve-multiple-by-attributes>

Retrieve multiple entities by attributes values and sorting options

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
entityName	Name of the entity type	String	/	UTF-8
count	Optional. Number of rows to retrieve	Integer	/
pageNumber	Optional. Number of page to retrieve	Integer	/
pagingCookie	Optional. Paging cookie	String	/	UTF-8
returnTotalRecordCount	Optional. If total record count should be returned	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
organizationServiceUrl	Optional. The path to the MS Dynamics Configuration scv	String	/	UTF-8
loginConfigPath	Optional. The path where the LoginConfig file is	String	/	UTF-8
kerberosConfigPath	Optional. The path where the Kerberos config file is	String	/	UTF-8
loginConfigModule	Optional. The LoginModule configuration to use (this is defined inside of LoginConfig file)	String	/	UTF-8
spn	Optional. The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)	String	/	UTF-8

Child Elements

Name	Description	Java Type
<dynamicscrm-onpremise:columns>	Columns to retrieve	List<String>
<dynamicscrm-onpremise:attributes>	Attributes to filter by	List<String>
<dynamicscrm-onpremise:values>	Values of the attributes	List<String>
<dynamicscrm-onpremise:orders>	Optional. Ordering fields, key is the name, value is "Ascending" or "Descending"	Map<String, String>

Returns

Return Type	Description
List<Map<String, Object>>	entities retrieved

Exception Payloads

Payload Class	Description
IOrganizationServiceRetrieveMultipleOrganizationServiceFaultFaultFaultMessage

<dynamicscrm-onpremise:retrieve-multiple-by-query>

Retrieve multiple entities by a query described by and XML

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/bb930489.aspx

The aggregation examples can be found in this link: http://msdn.microsoft.com/en-us/library/gg309565.aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
queryXml	Query XML	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
organizationServiceUrl	Optional. The path to the MS Dynamics Configuration scv	String	/	UTF-8
loginConfigPath	Optional. The path where the LoginConfig file is	String	/	UTF-8
kerberosConfigPath	Optional. The path where the Kerberos config file is	String	/	UTF-8
loginConfigModule	Optional. The LoginModule configuration to use (this is defined inside of LoginConfig file)	String	/	UTF-8
spn	Optional. The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)	String	/	UTF-8

Returns

Return Type	Description
List<Map<String, Object>>	entities retrieved

Exception Payloads

Payload Class	Description
IOrganizationServiceRetrieveMultipleOrganizationServiceFaultFaultFaultMessage

<dynamicscrm-onpremise:update>

Update entity

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
logicalName	Logical name of the entity to be updated	String	/	UTF-8
guid	The guid of the entity to be retrieved	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
organizationServiceUrl	Optional. The path to the MS Dynamics Configuration scv	String	/	UTF-8
loginConfigPath	Optional. The path where the LoginConfig file is	String	/	UTF-8
kerberosConfigPath	Optional. The path where the Kerberos config file is	String	/	UTF-8
loginConfigModule	Optional. The LoginModule configuration to use (this is defined inside of LoginConfig file)	String	/	UTF-8
spn	Optional. The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<dynamicscrm-onpremise:attributes-to-update>		The attributes that will be updated, in Map form	Map<String, Object>

Exception Payloads

Payload Class	Description
IOrganizationServiceRetrieveOrganizationServiceFaultFaultFaultMessage
IOrganizationServiceUpdateOrganizationServiceFaultFaultFaultMessage

mule-module-ms-dynamics-crm-onpremise

Module Overview

Summary

Configuration

Connection Pool

Reconnection Strategies

Configuration

Message Processors

<dynamicscrm-onpremise:associate>

XML Sample

Attributes

Child Elements

Exception Payloads

<dynamicscrm-onpremise:create>

XML Sample

Attributes

Child Elements

Returns

Exception Payloads

<dynamicscrm-onpremise:delete>

XML Sample

Attributes

Exception Payloads

<dynamicscrm-onpremise:disassociate>

XML Sample

Attributes

Child Elements

Exception Payloads

<dynamicscrm-onpremise:execute>

XML Sample

Attributes

Child Elements

Returns

Exception Payloads

<dynamicscrm-onpremise:retrieve>

XML Sample

Attributes

Child Elements

Returns

Exception Payloads

<dynamicscrm-onpremise:retrieve-multiple-by-attributes>

XML Sample

Attributes

Child Elements

Returns

Exception Payloads

<dynamicscrm-onpremise:retrieve-multiple-by-query>

XML Sample

Attributes

Returns

Exception Payloads

<dynamicscrm-onpremise:update>

XML Sample

Attributes

Child Elements

Exception Payloads

Message Sources

Transformers