Table of Contents

XML File Sync Notifications

Starting with version 6.0, the framework will start moving its configuration information from XML files to the database. To minimise potential issues on users, this move will be slowly and gradually in different phases.

Currently, as in the first phase the framework is adapted to synchronise all XML files to the database, and they remain the leading source of the configuration definitions. This means the database records are constantly updated with the configuration as present in the XML files. The notable exception to this, are the language labels which are synchronised only once, changes will only go directly to the database and the XML files are ignored.

Important

At this moment there is no impact of XML sync issues. But they should be solved as quickly as possible. During the subsequent modification stages the use of XML files for configuration definitions will be phased out and the database will become more leading with every completed phase which will result in the entire removal of the XML files.

Business Connector Notifications

Despite all good efforts to copy over the XML definitions to the database, there could still be issues with the files themselves which will lead to failing in the synchronisation process. For example, one such problem is the absence of an object while it is still being referred to from a method job or framework synchronisation.

To let users know whether the XML files are correctly synchronised to the database or not, a notification will be shown next to a couple of items in case the underlying XML file is not properly handled or not synchronised yet. The items are: objects, method jobs, synchronisations (of the framework itself) and the corresponding schedules.

XML Sync Notifications on Objects

Note

Any other item is also synchronised to the database but do not receive a notification in the Business Connector application. In case of issues with those items, look in the BAM logging.

See paragraph XML Sync Errors in BAM Logging for more information.

XML Sync Errors in BAM Logging

All XML file synchronisation issues can be easily identified in the BAM logging as every such message has the prefix 'Database sync error:'. Additional logs lines related to the sync process may be present as well and can help providing extra information identifying the underlying causes.

These error log lines are not only generated for the synchronisation of XML files of objects, method jobs, etc. but also for other types that do not show a notification, for example templates, profiles, etc.

Solving XML File Synchronisation Issues

Solving those XML file synchronisation issues is just fixing the configuration of the objects, method jobs, etc. or the items they refer to. During the save action the item, the BCM service attempts to synchronise the XML file to the database.

Steps to resolve any issues and get rid of the notifications:

  1. First, check what the potential issue is of the item having the notification.
  2. Make the necessary changes and save the item (object, job, schedule, etc.).
  3. If no error messages are shown, click on the Refresh button to reload the XML sync information. (*)
  4. In case the issue is not located in the item itself, e.g. a method is renamed but the method job is still referring to the old name. Fix that issue first, go back to the main item, make a small change to the description field to force a save action in the framework to trigger the XML sync as well.
  5. Go to step 3 to reload the sync notifications.
  6. Repeat all previous steps until all XML sync notifications are removed.
Note

(*) The XML sync notification information is not automatically returned from BCM back to the Business Connector application. Therefor it is necessary to manually refresh all items to get the updated notification status.

Patcher

During installation or upgrading the framework, the patcher will already sync existing XML files to the framework database. Depending on the success of the sync process, some items may show the notification when opening the Business Connection application.

Rerunning the patcher will also rerun the XML file sync process.