| Namespace | http://www.mulesoft.org/schema/mule/dynamicscrm |
| Schema Location | http://www.mulesoft.org/schema/mule/dynamicscrm/current/mule-dynamicscrm.xsd (View Schema) |
| Schema Version | 1.0 |
| Minimum Mule Version | 3.2 |
Module Overview
Microsoft Dynamics CRM 2011 Ondemand version
This connector allow the integration with MS Dynamics CRM 2011 Ondemand version.
The connector uses Windows Live ID for Authentication.
The service of MS Dynamics CRM provide a few operations that are extensible for all the entities (default and custom)
created.
To use this connector you need a Windows Live ID Account and a Microsoft Dynamics CRM (2011) Online Account
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="http://www.mulesoft.org/schema/mule/dynamicscrm"
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
http://www.mulesoft.org/schema/mule/dynamicscrm/current/mule-dynamicscrm.xsd">
<!-- here goes your flows and configuration elements -->
</mule>
This module is configured using the config element. This element must be placed outside of your flows and at
the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries
its own name.
Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to
specify which configuration to use.
| Attributes |
|---|
| Type | Name | Default Value | Description | Java Type | MIME Type | Encoding |
|---|
xs:string |
name |
|
Optional. Give a name to this configuration so it can be later referenced. |
| | |
|
xs:string |
organizationServiceUrl |
|
Configurable
|
|
|
|
|
xs:string |
password |
|
Password
|
|
|
|
|
xs:string |
username |
|
Username
|
|
|
|
Message Processors
<dynamicscrm:associate>
Associate a set of entities
Attributes
| Name | Default Value | 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 |
Child Elements
| Name | Default Value | Description | Java Type |
|---|
| <dynamicscrm:related-entities-attributes> |
|
List of the attributes of related entities |
List<Map<String, Object>> |
<dynamicscrm:create>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
|---|
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| logicalName |
|
A logical name |
String |
*/* |
UTF-8 |
Child Elements
| Name | Default Value | Description | Java Type |
|---|
| <dynamicscrm:entity> |
|
An entity object represented as a map |
Map<String, Object> |
Returns
| Return Type |
Description |
| String |
The GUID of the created entity. |
<dynamicscrm:delete>
Attributes
| Name | Default Value | 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 |
<dynamicscrm:disassociate>
Disassociate a set of entities
Attributes
| Name | Default Value | 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 |
Child Elements
| Name | Default Value | Description | Java Type |
|---|
| <dynamicscrm:related-entities-attributes> |
|
List of the attributes of related entities |
List<Map<String, Object>> |
<dynamicscrm:execute>
Execute a business logic method
Attributes
| Name | Default Value | 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 |
Child Elements
| Name | Default Value | Description | Java Type |
|---|
| <dynamicscrm: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 |
<dynamicscrm:retrieve>
Attributes
| Name | Default Value | 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 |
Child Elements
| Name | Default Value | Description | Java Type |
|---|
| <dynamicscrm: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 |
<dynamicscrm:retrieve-multiple-by-attributes>
Retrieve multiple entities by attributes values and sorting options
Attributes
| Name | Default Value | 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 |
*/* |
|
Child Elements
| Name | Default Value | Description | Java Type |
|---|
| <dynamicscrm:columns> |
|
Columns to retrieve |
List<String> |
| <dynamicscrm:attributes> |
|
Attributes to filter by |
List<String> |
| <dynamicscrm:values> |
|
Values of the attributes |
List<String> |
| <dynamicscrm: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 |
<dynamicscrm:retrieve-multiple-by-query>
Retrieve multiple entities by a query described by and XML
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
|---|
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| queryXml |
|
Query XML |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| List<Map<String, Object>> |
entities retrieved |
<dynamicscrm:update>
Attributes
| Name | Default Value | 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 |
Child Elements
| Name | Default Value | Description | Java Type |
|---|
| <dynamicscrm:attributes-to-update> |
|
The attributes that will be updated, in Map form |
Map<String, Object> |
Message Sources
Transformers
