Registering Specific Messages

You can use the Plug-in Registration tool to register specific messages for the plug-in. After you register specific messages for the plug-in, the Dynamics CRM solution can send events triggered on a specified entity.

The PluginRegistration.exe Plug-in Registration tool file is located in the SDK_HOME\Tools\PluginRegistration directory. You can download Dynamics CRM SDK from the Microsoft website. See the Microsoft documentation for more details about the Plug-in Registration tool.

Prerequisites

Ensure that you have imported the Dynamics CRM solution to the Microsoft Dynamics CRM server. See Importing Dynamics CRM Solution to Microsoft Dynamics CRM Server for more details.

Procedure

  1. Open the Plug-in Registration tool and click CREATE NEW CONNECTION.
  2. Enter the connection information on the Login page and click Login.
  3. Register a step for the Create, Update, and Delete messages one by one:
    1. Right-click the TIBCO.BW.DynamicsCRMPluginEventListenerPlugin node and click Register New Step.
    2. Configure the step information:
      Field Value
      Message Create, Update, or Delete
      Event Handler Tibco.BW.DynamicsCRM.Plugin.EventListenerPlugin
      Eventing Pipeline Stage of Execution The following value must be selected depending on the message:
      • Post Operation must be selected for Create message
      • Pre Operation value must be selected for Update message
      • Pre Operation must be selected for Delete message
      Execution Mode Synchronous or Asynchronous
      Deployment Server
    3. Click Register New Step.
  4. Register an image for the step, such as Create, Update, or Delete step:
    Note: The registration of an image is mandatory for the Delete step, but it is optional for the Create step and the Update step.
    1. Right-click the specific step, for example, Create step and click Register New Image.
    2. Configure the Image Information.
      Ensure that the following values are specified in the corresponding fields:
      Field Value
      Image Type The following value must be selected depending on the step:
      • Post Image must be selected for Create step
      • Pre Image must be selected for Update step
      • Pre Image must be selected for Delete step
      Name The following value must be entered depending on the step:
      • PostImageCrtEntityAlias must be entered for Create step
      • PreImageUpdtEntityAlias must be entered for Update step
      • PreImageEntityAlias must be entered for Delete step
      Entity Alias The following value must be entered depending on the step:
      • PostImageCrtEntityAlias must be entered for Create step
      • PreImageUpdtEntityAlias must be entered for Update step
      • PreImageEntityAlias must be entered for Delete step
      Parameters By default, all the attributes of the entity are selected. If required, you can click the button beside the field and choose only specific attributes.
      Note: Make sure that the parameters chosen here match with the attributes selected while configuring Entity Event Source/REST Entity Event Source activities.
      Note:
      • If the image for Create Entity event type is not created, the details of all the attributes are sent in the event data.
      • If the image for Update Entity event type is not created, the details of only those updated attributes are sent in the event data.
    3. Click Update Image.