Configuring Publisher Entities

The publisher objects tell the Microsoft Dynamics 365 server which objects to publish messages for and what to include in the message:

Configure Scribe Publisher entities for Dynamics 365
Configure Scribe Publisher objects for Dynamics CRM 4.x

To Configure A Dynamics 365 Publisher Entity

If you have not already done so, create a plug-in publisher process.
Click Step 4 Publisher/Bridge Properties and click Add. The Entity Configuration dialog box appears.
From the Dynamics 365 Entity list, select the object that you want to configure for publication.
In the Events section, select one or more events you want detected for publication:
- Insert — Sends a message to the PubIn queue when a new Dynamics 365 Entity is created.
- Update — Sends a message to the PubIn queue when an existing Dynamics 365 Entity is updated.
- Delete — Sends a message to the PubIn queue when an existing Dynamics 365 Entity is deleted.
In the Identifiers section, add a label:
- Message Label — Enter a label to use when the message is written to the message queue. TIBCO recommends that you always add a message label. Unlabeled messages are moved to the ScribeIn queue, but cannot be called or filtered for further processing.
- "ScribeLabel" Attribute — Optionally, type a label to be added to the XML message as an attribute. This label can be used to filter messages for processing, or as a link in Workbench.
Note: Both label settings support substitution variables. The supported substitution variables are listed in the dialog box.
In the Message section, determine whether you need to include additional related information with an entity that has changed:
- Retrieve Entire Object — By default, Retrieve Entire Object is checked, which forces the publisher to query the Dynamics 365 server when the message is processed so that all information in the message is returned. Clear this check box to include only data in the message that has been updated.
  Note: If the size of the changed fields exceeds 4K characters, such as when lart attachments are included in the message, and Retrieve Entire Object is not selected, the Publisher for Dynamics 365 retrieves the entire object.
- Include Parent Entity — Select a parent entity, if available, if you want the publisher to fetch a related parent record and include the data in the XML message when the selected Dynamics 365 Entity changes.
- Include Child Entity — Select a child entity, if available, if you want the publisher to fetch all of the related child records and include the data in the XML message when the selected Dynamics 365 Entity changes.
  Note: If you include parent or child objects in your message and fields exist in the included objects with the same name, the generated schema file assumes the fields are all of the same type. If the fields are not of the same type, unexpected results may occur when processing the field values.
- Priority — Optionally, set the priority for this message. Priority ranges from 0 (lowest) to 7 (highest). To change the priority from the default setting (3), select a priority level from the drop-down list.
Use the Message Filters section to describe specific conditions to either publish or ignore a message:
1. Select a field name from the list, for example, statuscode.
2. Select the criteria operation that the field must meet, for example, is equal to.
3. Enter the value for the process criteria, for example, closed.
  Note: To filter for updated fields, use changed from with the value #NULL!.
The choices are:
- Ignore Changes From — Lets you specify a user whose changes to the entity are ignored. This feature is used to avoid sending changes in an endless loop between your Dynamics 365 application and other applications, or to avoid sending changes made by an administrator or special process. This setting is for the object level. A similar setting in Step 4 Publisher/Bridge Properties is a global setting affecting all published objects on the Dynamics 365 server.
- Process Only If — Lets you define criteria that must be met before the message is processed. Only messages that satisfy the defined filter are published.
When you are done, click OK to save your changes and close the Entity Configuration dialog box.

Next step

To Configure A Dynamics CRM 4.x Publisher Object

If you have not already done so, create a plug-in publisher process.
Click Step 4 Publisher/Bridge Properties and click Add. The Publisher Entry dialog box appears.
From the Dynamics CRM 4.x Object list, select the object that you want to configure for publication.
In the Events section, select one or more events you want detected for publication:
- Insert — Sends a message to the PubIn queue when a new Dynamics CRM 4.x Entity is created.
- Update — Sends a message to the PubIn queue when an existing Dynamics CRM 4.x Entity is updated.
- Delete — Sends a message to the PubIn queue when an existing Dynamics CRM 4.x Entity is deleted.
In the Identifiers section, add a label:
- Message Label — Enter a label to use when the message is written to the message queue. TIBCO recommends that you always add a message label. Unlabeled messages are moved to the ScribeIn queue, but cannot be called or filtered for further processing.
- "ScribeLabel" Attribute — Optionally, type a label to be added to the XML message as an attribute. This label can be used to filter messages for processing, or as a link in Workbench.
Note: Both label settings support substitution variables. The supported substitution variables are listed in the dialog box.

In the Message section, determine whether you need to include additional related information with an entity that has changed:

Retrieve Entire Object — Check if you want the publisher to query the Dynamics CRM 4.x server when the message is processed so that all information is returned. By default, the Microsoft Dynamics CRM 4.x publisher includes only the data in the message that has been updated.
Include Parent Object — Select a parent entity, if available, if you want the publisher to fetch a related parent record and include the data in the XML message when the selected Dynamics CRM 4.x Entity changes.
Include Child Objects — Select a child entity, if available, if you want the publisher to fetch all of the related child records and include the data in the XML message when the selected Dynamics CRM 4.x Entity changes.

Note:

If you include parent or child objects in your message and fields with the same name exist in the included objects, the generated schema file assumes the fields are all of the same type. If the fields are not of the same type, unexpected results may occur when processing the field values.
If the following error message occurs when you try to create a DTS with an XML connection, your schema file has duplicate nodes: Invalid Schema or document: Node list not unique.

See Creating Schemas With Duplicate Entity/Parent/Child Names for more information

Use the Filters section to describe specific conditions to either publish or ignore a message. The choice are:
- Process Only If — Lets you define criteria that must be met before the message is processed. Only messages that satisfy the defined filter are published. The only available filter is statecode.
- Ignore Changes From — Lets you specify a user whose changes to the entity are ignored. This feature is used to avoid sending changes in an endless loop between your Dynamics CRM 4.x application and other applications, or to avoid sending changes made by an administrator or special process.
  Note: This setting is for the object level. A similar setting in Step 4 Publisher/Bridge Properties is a global level setting affecting all published objects on the Dynamics CRM 4.x server.
When you are done, click OK to save your changes and close the Entity Configuration dialog box.

Next step