REST Entity Event Source

The REST Entity Event Source activity is used to listen to the Create, Update, and Delete user events triggered on specified entity records.

This activity can use either the HTTP or HTTPS communication mode to communicate with a Microsoft Dynamics CRM server when receiving user event messages.

Microsoft Dynamics CRM SDK provides a Plug-in Registration tool to bind event handlers to entities. See Registering Specific Messages for more details.

Note: To receive events from the Microsoft Dynamics CRM Online server, the process containing this activity must be deployed on a Demilitarized Zone (DMZ) server. Therefore, you must have a DMZ server and install this plug-in on it.

General

On the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specify the entity you want to listen to.

The following table lists the configurations on the General tab of the REST Entity Event Source activity:

Field Module Property? Description
Name No Specify the name of the activity in the process definition.
Dynamics CRM REST Connection Yes Specify a shared connection resource.

Click the icon to select a Dynamics CRM REST connection. If no matching Dynamics CRM REST connections are found, click Create Shared Resource in the Select DynamicscrmRestResource Resource Template dialog to create one. See Creating a Dynamics CRM REST Connection for more details.

Dynamics CRM Entity No Specify the entity that you want to listen to.

Click Fetch Entity to open the Entity Selection Dialog that contains all the available entities. Select an entity from the list and click OK. The selected entity is automatically specified in this field.

After selecting the entity, click Build Schema to open the Attributes Selection Dialog that contains all the available attributes associated with the entity. Select the attributes that you want and click OK. The selected attributes are displayed on the Output tab.

Event On No Select the user event triggered on the entity record that is listened to:

  • Create Entity: triggered only when the specified entity record is created.
  • Update Entity: triggered only when the specified entity record is edited.
  • Delete Entity: triggered only when the specified entity record is deleted.

Note: To successfully receive the messages triggered by user events in the Microsoft Dynamics CRM server, the SDK message processing steps corresponding to the user events specified in this field must be enabled in the Microsoft Dynamics CRM server.

HTTP Connection Yes Specify an HTTP Connector shared resource.

Click the icon to select an HTTP connection. If no matching HTTP connector resources are found, click Create Shared Resource in the Select HttpConnResource Resource Template dialog to create one. See TIBCO ActiveMatrix BusinessWorks Bindings and Palettes Reference guide for more details.

Relative Path Yes Specify a URL path relative to the entity event source instance.
Note: Relative Path is case sensitive, and must be unique when there are multiple entity event source instances.

The relative path must be consistent with the value configured for the Dynamics CRM solution.

Username Yes Specify the user name that is used for basic authentication to the runtime REST Entity Event Source activity.
Password Yes Specify the password that is used for basic authentication to the runtime REST Entity Event Source activity.
Get Context Information No Select the checkbox to display the context information on the Output tab of REST Entity Event Source activity.

Description

On the Description tab, enter a short description for the REST Entity Event Source activity.

Advanced

On the Advanced tab, specify the running sequence of processes and the custom job ID for the process instance.

The following table lists the configurations on the Advanced tab of the REST Entity Event Source activity:

Field Module Property? Description
Sequence Key N/A An XPath expression specifies the order in which the processes run. Process instances with sequence keys that have the same value are executed sequentially in the order in which the process instances were created.
Custom Job Id N/A An XPath expression specifies a custom job ID for the process instance.

Output

On the Output tab, the output of this activity varies depending on the entity and attributes selected when configuring the General tab. See the Microsoft Dynamics CRM documentation for more details.

Note:

  • The output for Create and Update events varies according to the attributes selected in the Dynamics CRM plug-in registration tool. For more details, see Registering Specific Messages.

  • Ensure that the attributes selected using Build Schema matches with the parameters selected in the Dynamics CRM plug-in registration tool.

  • If the user selects the Get Context Information checkbox, then Event context information is displayed along with Entities data on the Output tab.

Fault

The error code and error message of the REST Entity Event Source activity are displayed on the Fault tab. See Error Codes for more details.

The following table lists error schema elements on the Fault tab of the REST Entity Event Source activity:

Error Schema Element Data Type Description
message String The error message returned by the plug-in.
messageCode String The error code returned by the plug-in.