Synchronization Server - User Tasks

This manual topic describes a number of typical user tasks. For each task, the sessions and commands to be used are mentioned.

Change the settings for a synchronization object

In the Synchronization Objects (danch2510m000) session, you can define a synchronization object. Then create the runtime using the command in that session. Normally this task is not done via the Synchronization Server user interface, because a synchronization object is created automatically when a PublishChanges request arrives for a business object.

Note: Before you can start publishing, the audit profile must be converted to runtime. This is an application administrator's task, which may impact end users of LN. To convert the audit profile to runtime, you must run the Create Runtime Audit Definitions (ttaud3200s000), which can be started from the Audit Profiles (ttaud3110m000) session. After the setup and the conversion to runtime, run a test through the Test Synchronization Object command in the Synchronization Objects (danch2510m000) session. Events will be written to a file and the contents of that file will be displayed after stopping the server.

Start publishing

Run the Start command in the Synchronization Objects (danch2510m000) details session. If a range of servers must be started and/or a specific starting moment is required, you can start the Start Publishing (danch2213m000) session from the Synchronization Objects (danch2510m000) overview session.

A specific starting moment is needed if:

  • The server did not run before and should start at some moment in the past instead of the current moment. E.g. publish all events using transactions executed since the beginning of this week.
  • The server ran before but has a large backlog. For example, if it has not been running for a month then it could be started at the current time, instead of continuing where it stopped (provided the clients for the change events do not need the events from that month anymore).
  • A range of servers must be started at the same point in time, for example, because the business objects are related and consequently the change events may be interdependent.

View Status and Solve Issues

View the status (whether the server is running or not) in the Synchronization Objects (danch2510m000) details session.

If needed, you can view the history by starting the SyncChanges Server Runs (danch2520m000) session. Through that session, you can also view the log file for each run, which contains the exceptions that occurred.

If needed, you can reset the complete status of the synchronization object via the Synchronization Objects (danch2510m000) details session.

Change a synchronization object

You can change the settings for an existing synchronization object via the Synchronization Objects (danch2510m000) details session. After such a change, if the business object, selection or filter was changed, the configuration library and audit profile are regenerated.

Finally, if a server is running for processing change events, that server must be stopped and started again (continued) to make use of the new settings.

Make sure servers keep running

Add the Check and Continue Servers (danch2210m000) session to a job that is executed according to a predefined interval or calendar.

Cleanup

To clear the history, use the Purge Server Runs (danch2220m000) session. You can start this session through the History command in the Synchronization Objects (danch2510m000) details session.

Do not clear the last run, unless you want to reset the current status. After clearing the last run, the server cannot continue anymore from the point where it stopped last time.

You can also reset the synchronization object (including the current status) through the Reset command in the Synchronization Objects (danch2510m000) details session. This command removes all history and status data.

You can cleanup the Audit Trail through the Audit Management sessions.

You do not have to cleanup any transaction data for the Synchronization Server, because after an event is passed on to the publication channel (bus component) it is not available anymore in the Synchronization Server.

Stop publishing

Run the Stop command in the Synchronization Objects (danch2510m000) details session. If a range of servers must be stopped, you can start the Stop Publishing (danch2214m000) session from the Synchronization Objects (danch2510m000) overview session.

Delete a synchronization object

If the server is running, first stop it through the Synchronization Objects (danch2510m000) details session. Then delete the synchronization object via the overview session.

Normally this action is not required, because a synchronization object is deleted automatically when an UnpublishChanges request arrives for a business object.