org.mule.module.dynamicscrm

Class DynamicsCRMConnector

java.lang.Object

org.mule.module.dynamicscrm.DynamicsCRMConnector

All Implemented Interfaces:

org.mule.api.context.MuleContextAware

@Connector(name="dynamicscrm",
           schemaVersion="2.0",
           friendlyName="Microsoft Dynamics CRM",
           minMuleVersion="3.7.0")
@MetaDataScope(value=EntitiesMetadataScope.class)
@ReconnectOn(exceptions=javax.xml.ws.soap.SOAPFaultException.class)
@RequiresEnterpriseLicense(allowEval=true)
public class DynamicsCRMConnector
extends Object
implements org.mule.api.context.MuleContextAware

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

Author:

MuleSoft, Inc.

Constructor Summary

Constructors

Constructor and Description
DynamicsCRMConnector()

Method Summary

Methods

Modifier and Type	Method and Description
void	associate(String logicalName, String id, boolean relationshipEntityRoleIsReferenced, String relationshipSchemaName, List<String> relatedEntitiesIds) Create links between records.
String	create(String logicalName, Map<String,Object> attributes) Create a new record.
org.mule.common.bulk.BulkOperationResult<Map<String,Object>>	createMultiple(String logicalName, List<Map<String,Object>> attributesList, boolean useSingleTransaction) Create a several new record.
void	delete(String logicalName, String id) Delete a record.
org.mule.common.bulk.BulkOperationResult<String>	deleteMultiple(String logicalName, List<String> ids, boolean useSingleTransaction) Delete multiple records.
void	disassociate(String logicalName, String id, boolean relationshipEntityRoleIsReferenced, String relationshipSchemaName, List<String> relatedEntitiesIds) Delete a link between records.
Object	execute(String requestName, Object requestParameters, String requestId) Executes a message in the form of a request, and returns a response.
org.mule.common.bulk.BulkOperationResult<OrganizationResponse>	executeMultiple(List<Object> requests, String requestId, boolean useSingleTransaction) Executes multiple messages in the form of a request, and returns their respective responses.
AttributesBaseRetriever	getAttributesRetriever(AttributesFactoryScope scope)
BaseCrmConnectionStrategy	getConnectionStrategy()
EntitiesRetriever	getEntitiesRetriever()
RelationshipsRetriever	getRelationshipsRetriever()
Map<String,Object>	retrieve(String logicalName, String id) Retrieve a record.
org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,DynamicsCRMConnector>	retrieveMultipleByQuery(String query, org.mule.streaming.PagingConfiguration pagingConfiguration, int singlePageNumber) Retrieve multiple records.
void	setConnectionStrategy(BaseCrmConnectionStrategy connectionStrategy)
void	setMuleContext(org.mule.api.MuleContext context)
String	translateQueryDsqlToNative(org.mule.common.query.DsqlQuery dsqlQuery) Method that handles the request to transform a query from DSQL to the Native Query Language.
void	update(String logicalName, String id, Map<String,Object> attributes) Update a record's attributes.
org.mule.common.bulk.BulkOperationResult<Map<String,Object>>	updateMultiple(String logicalName, List<Map<String,Object>> attributesList, boolean useSingleTransaction) Update a record's attributes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DynamicsCRMConnector

public DynamicsCRMConnector()

Method Detail

translateQueryDsqlToNative

@QueryTranslator
public String translateQueryDsqlToNative(org.mule.common.query.DsqlQuery dsqlQuery)

Method that handles the request to transform a query from DSQL to the Native Query Language.

Parameters:

dsqlQuery - the DSQL query object with the query to be translated into native format.

Returns:

the parsed native query

create

@Processor
public String create(@MetaDataKeyParam(affects=INPUT)
                      String logicalName,
                      @Default(value="#[payload]")@Placement(group="Attributes")
                      Map<String,Object> attributes)
              throws IOrganizationServiceCreateOrganizationServiceFaultFaultFaultMessage

Create a new record.

Parameters:

logicalName - The logical name of the entity.

attributes - The attributes of the record as a Map.

Returns:

The id of the created entity.

Throws:

IOrganizationServiceCreateOrganizationServiceFaultFaultFaultMessage - If create fails.

createMultiple

@Processor
public org.mule.common.bulk.BulkOperationResult<Map<String,Object>> createMultiple(@MetaDataKeyParam(affects=INPUT)@FriendlyName(value="Entity")
                                                                                    String logicalName,
                                                                                    @Default(value="#[payload]")@Placement(group="Attributes")
                                                                                    List<Map<String,Object>> attributesList,
                                                                                    @Default(value="false")@Optional
                                                                                    boolean useSingleTransaction)
                                                                            throws IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage

Create a several new record.

Parameters:

logicalName - The logical name of the entity.

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

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

Returns:

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

Throws:

IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage - If execute fails.

update

@Processor
public void update(@MetaDataKeyParam(affects=INPUT)
                    String logicalName,
                    String id,
                    @Default(value="#[payload]")@Placement(group="Attributes")
                    Map<String,Object> attributes)
            throws IOrganizationServiceUpdateOrganizationServiceFaultFaultFaultMessage

Update a record's attributes.

Parameters:

logicalName - The logical name of the entity.

id - The id of the record to update.

attributes - The attributes to be updated as a Map.

Throws:

IOrganizationServiceUpdateOrganizationServiceFaultFaultFaultMessage - If update fails.

updateMultiple

@Processor
public org.mule.common.bulk.BulkOperationResult<Map<String,Object>> updateMultiple(@MetaDataKeyParam(affects=INPUT)
                                                                                    String logicalName,
                                                                                    @Default(value="#[payload]")@Placement(group="Attributes")
                                                                                    List<Map<String,Object>> attributesList,
                                                                                    @Default(value="false")@Optional
                                                                                    boolean useSingleTransaction)
                                                                            throws IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage

Update a record's attributes.

Parameters:

logicalName - The logical name of the entity.

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

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

Returns:

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

Throws:

IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage - If update fails.

delete

@Processor
@MetaDataScope(value=DeleteMetadataScope.class)
public void delete(@MetaDataKeyParam(affects=INPUT)
                                                           String logicalName,
                                                           @Default(value="#[payload]")
                                                           String id)
            throws IOrganizationServiceDeleteOrganizationServiceFaultFaultFaultMessage

Delete a record.

Parameters:

logicalName - The logical name of the entity.

id - The id of the record to delete.

Throws:

IOrganizationServiceDeleteOrganizationServiceFaultFaultFaultMessage - If delete fails.

deleteMultiple

@Processor
@MetaDataScope(value=DeleteMetadataScope.class)
public org.mule.common.bulk.BulkOperationResult<String> deleteMultiple(@MetaDataKeyParam(affects=INPUT)
                                                                                                               String logicalName,
                                                                                                               @Default(value="#[payload]")
                                                                                                               List<String> ids,
                                                                                                               @Default(value="false")@Optional
                                                                                                               boolean useSingleTransaction)
                                                                throws IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage

Delete multiple records.

Parameters:

logicalName - The logical name of the entity.

ids - The ids of the records to delete.

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

Returns:

The results of the created entities in form of BulkOperationResult.

Throws:

IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage - If delete fails.

retrieve

@Processor
public Map<String,Object> retrieve(@MetaDataKeyParam(affects=OUTPUT)
                                    String logicalName,
                                    @Default(value="#[payload]")
                                    String id)
                            throws IOrganizationServiceRetrieveOrganizationServiceFaultFaultFaultMessage

Retrieve a record.

Parameters:

logicalName - The logical name of the entity.

id - The id of the record to retrieve.

Returns:

attributes of specified entity in Map form

Throws:

IOrganizationServiceRetrieveOrganizationServiceFaultFaultFaultMessage - If retrieve fails

retrieveMultipleByQuery

@Processor
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,DynamicsCRMConnector> retrieveMultipleByQuery(@Query(offset=false,limit=false)
                                                                                                                              String query,
                                                                                                                              org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                                              @Placement(group="One Page Only")@FriendlyName(value="Single Page Number")@Default(value="-1")
                                                                                                                              int singlePageNumber)
                                                                                                                throws IOrganizationServiceRetrieveMultipleOrganizationServiceFaultFaultFaultMessage

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

Parameters:

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

pagingConfiguration - The configuration for the pagination feature.

singlePageNumber - If greater than 0, returns only that specific page.

Returns:

A paging delegate with the records resulting from the query. Pagination is handled internally.

Throws:

IOrganizationServiceRetrieveMultipleOrganizationServiceFaultFaultFaultMessage - If retrieveMultiple fails.

associate

@Processor
@MetaDataScope(value=AssociateAndDisassociateMetadataScope.class)
public void associate(@MetaDataKeyParam(affects=INPUT)
                                                                                String logicalName,
                                                                                String id,
                                                                                @Default(value="false")
                                                                                boolean relationshipEntityRoleIsReferenced,
                                                                                String relationshipSchemaName,
                                                                                @Default(value="#[payload]")@Placement(group="Related entities attributes")
                                                                                List<String> relatedEntitiesIds)
               throws IOrganizationServiceAssociateOrganizationServiceFaultFaultFaultMessage

Create links between records.

Parameters:

logicalName - The logical name of the entity.

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

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

relationshipSchemaName - The name of the relationship to create the link.

relatedEntitiesIds - A List with the related entity records ids to associate.

Throws:

IOrganizationServiceAssociateOrganizationServiceFaultFaultFaultMessage - If associate fails.

disassociate

@Processor
@MetaDataScope(value=AssociateAndDisassociateMetadataScope.class)
public void disassociate(@MetaDataKeyParam(affects=INPUT)
                                                                                   String logicalName,
                                                                                   String id,
                                                                                   @Default(value="false")
                                                                                   boolean relationshipEntityRoleIsReferenced,
                                                                                   String relationshipSchemaName,
                                                                                   @Default(value="#[payload]")@Placement(group="Related entities attributes")
                                                                                   List<String> relatedEntitiesIds)
                  throws IOrganizationServiceDisassociateOrganizationServiceFaultFaultFaultMessage

Delete a link between records.

Parameters:

logicalName - The logical name of entity.

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

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

relationshipSchemaName - The name of the relationship to delete the link.

relatedEntitiesIds - A List with the related entity records ids to disassociate.

Throws:

IOrganizationServiceDisassociateOrganizationServiceFaultFaultFaultMessage - If disassociate fails.

execute

@Processor
@MetaDataScope(value=ExecuteMetadataScope.class)
public Object execute(@Placement(group="General",order=1)@MetaDataKeyParam(affects=BOTH)
                                                               String requestName,
                                                               @Payload
                                                               Object requestParameters,
                                                               @Placement(group="General",order=2)@Optional
                                                               String requestId)
               throws IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage

Executes a message in the form of a request, and returns a response.

Parameters:

requestName - The logical name of request make.

requestParameters - [DEPRECATED] This parameter will be removed from the configuration in the near future. Set the #[payload] correctly before calling the connector.

requestId - The id of the request to make.

Returns:

The organization response as a OrganizationResponse.

Throws:

IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage - If execute fails.

executeMultiple

@Processor
public org.mule.common.bulk.BulkOperationResult<OrganizationResponse> executeMultiple(@Payload
                                                                                       List<Object> requests,
                                                                                       @Placement(group="General",order=2)@Optional
                                                                                       String requestId,
                                                                                       @Default(value="false")@Optional
                                                                                       boolean useSingleTransaction)
                                                                               throws IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage

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

Parameters:

requests - This parameter is a list of the requests (OrganizationRequest or Map). Set the #[payload] correctly before calling the connector.

requestId - The id of the request to make.

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

Returns:

The organization responses for each one of the requests performed.

Throws:

IOrganizationServiceExecuteOrganizationServiceFaultFaultFaultMessage - If execute fails.

getConnectionStrategy

public BaseCrmConnectionStrategy getConnectionStrategy()

setConnectionStrategy

public void setConnectionStrategy(BaseCrmConnectionStrategy connectionStrategy)

getEntitiesRetriever

public EntitiesRetriever getEntitiesRetriever()

getRelationshipsRetriever

public RelationshipsRetriever getRelationshipsRetriever()

getAttributesRetriever

public AttributesBaseRetriever getAttributesRetriever(AttributesFactoryScope scope)

setMuleContext

public void setMuleContext(org.mule.api.MuleContext context)

Specified by:

setMuleContext in interface org.mule.api.context.MuleContextAware