Selection

To select the components and attributes to be included you must attach an XML text to the synchronization object. You must do this in the session. If a synchronization object is created automatically via the PublishChanges method, the default selection text is generated.

This selection text specifies what business object components and attributes must be included, and which components and attributes must also be included if they are unchanged. The attributes must be defined as public attributes in the Business Object Repository. In the Business Object Repository, the public layer does not have components defined explicitly, but still each public attribute belongs to a component (or to the object, if it has no components defined).

Note: The selection as defined for a synchronization object differs from the selection as used in the PublishList, PublishChanges, List and Show methods. The synchronization object selection contains more information and allows the user to fine-tune the publishing of change events.

Example

The selection text contains an XML structure. The format of the selection text is as follows:

<Order>
    <orderNumber key="true"/>
    <orderStatus includeUnchanged="true"/>
    <orderDate/>
    <OrderLine>
        <orderLineNumber key="true"/>
        <item includeUnchanged="true"/>
        <quantity/>
        <price/>
    </OrderLine>
</Order>

The root node holds the name of the root component (which can be the business object name or the main component name). All nodes having children are components; nodes that do not have children are attributes belonging to the component that is their parent. Components having a parent are child components of their parent component. The components (except the top-level component) and attributes must exist in the business object as specified in the Business Object Repository.

For all components and attributes you can specify additional settings:

  • key: if the attribute is within the key
  • includeUnchanged: whether the component or attribute must always be included (true) or only if it is changed (false). Default value if omitted is true for the root component and the key attributes and false otherwise.

For more information, including constraints that you must take into account, see the Synchronization and Event Publishing Deployment Guide.

More information

For more information:

  • Synchronization Server - User Interface Overview
  • Synchronization Server - User Tasks
  • Event Publishing Overview
  • Synchronization and Event Publishing Deployment Guide This deployment guide describes among other things:
    • The specifications for the PublishList, PublishChanges and UnpublishChanges methods.
    • How to use these methods.
    • How to use the Synchronization Server to set up, optimize and manage the event publishing.
    • Important things to take into account when setting up the synchronization or event handling.
    • What to do in case of problems.