Changes between Version 63 and Version 64 of UserGuidelines/Admin/Synchronization

Timestamp:

09/26/11 07:51:44 (13 years ago)

Author:

Dominic König

Comment:

--

UserGuidelines/Admin/Synchronization

@@ -162 +162 @@
 === Synchronization Schedule ===
 
-Go to the [#SynchronizationHomepage Synchronization Homepage], click '''Repositories''', then '''Open''' the repository configuration you want to schedule a synchronization job for and change to the '''Schedule''' tab:
+Go to the [#SynchronizationHomepage Synchronization Homepage], click '''Repositories''', then '''Open''' the repository configuration you want to schedule a synchronization job for and change to the '''Schedule''' tab. If there are already jobs configured for this repository, you will see a list of those jobs. Otherwise (or by clicking '''Add Job'''), you get to this form:
 
 [[Image(sync_schedule_add.png)]]
 
+With every '''Job''', ''all'' resources configured for this repository will be synchronized.
+
 Fill in the fields as follows:
 
   ||'''Field'''||'''Instructions'''||'''Example'''||
-
+  ||Enabled||Set to True if the job shall actually be run, or set False to disable the job||True||
+  ||Start Time||Select date and time for the first run of this job (UTC)||2011-09-21 08:30||
+  ||End Time||Select date and time after which the job shall not be run anymore (UTC)||2012-09-21 08:30||
+  ||Repeat ''n'' times||Select how often the job shall be run, set to 0 to set no limit||0||
+  ||Run every||Select the time interval after which to repeat the job||5 minutes||
+  ||Timeout||Set a maximum time after which to abort the action||600 seconds||
+
+If you need to switch between jobs (e.g. for maintenance periods, low-traffic periods), you can set up multiple schedules, and disable/enable them as needed
+
+Please choose meaningful time interval and timeout settings: the more resources are to be synchronized, the longer it will take (in this regard, also note that THIS- and OTHER-policies will exchange all records in a resource, thus taking significantly longer).
+
+How many record have to be exchanged per each run depends on the average update frequency and the time internal in the job: e.g. if there are on average 100 updates per minute, and you set a 2-minute interval, then there would be 200 records to be transmitted on average. The import rate on medium-range server has been tested at on average 18 records/second, which means, the synchronization process would take around 11 seconds. To be on the safe side, choose a timeout value at least 10 times as high as that - e.g. 120 seconds in this case.
+
+Note that with NEWER-policies, the amount of network traffic arising from synchronization does not mainly depend on the frequency of synchronization, but on the record update rate at the sites. Smaller synchronization intervals would increase the traffic only slightly, but reduce the rate of conflicts and the risk of network-related problems. However, too small intervals (below the update rate of the site) may cause unnecessary network traffic with just empty transmissions.
 
   - ''go back to the [#Checklist Checklist]''