Automated SyncTool synchronisation using Windows Task Scheduler

Introduction

This document explains how to set up automated AD synchronisation with the ZIVVER SyncTool via Windows Task Scheduler. The SyncTool has no built-in feature to run daily, therefore the Task Scheduler must be used to fulfill this task.

Setting up Windows Task Scheduler

  1. Open Task Scheduler from the Windows menu.
  2. In the right pane, click Create Basic Task….
  3. Enter a name.
    For example: ZIVVER SyncTool
  4. Click Next >.
  5. Select Daily.
  6. Click Next >.
  7. Select a time that is convenient.
    It is common to select a time outside of office hours.
  8. Click Next >.
  9. Select Start a program.
  10. Click Next >.
  11. Browse to the SyncTool folder and double-click the Zivver.SyncTool executable.
  12. At Add arguments (optional): enter the following parameters:
    -s
    This will run the SyncTool in the background (Silent Mode). If you do not add this argument the SyncTool will start up at the configured time, but you have to run it manually.
    -p "Name profile"
    Enter the name of the SyncTool profiles you want to run. Find the names of profiles in the SyncTool at Step 1: Select sync profile. Profile names are capital and space sensitive. If you want to add multiple profiles, add another:
    -p "User profile" -p "Shared mailbox profile"

    The argument field for running two profiles in the SyncTool will usually look something like this:
    -s -p "User profile" -p "Shared mailbox profile"
  13. Click Next >.

  14. Click Finish.

You can find the task in the Task Scheduler Library and run it manually to verify the task works. If the task works correctly you will find logfiles in the %appdata%/Zivver/SyncTool/Logs folder for all profiles you specified after the task is finished.

Try to make a separate Basic Task for each SyncTool profile if you entered two or more profile names in the arguments, but not all profiles are synchronised.

Security options

Open Properties of your SyncTool task by double-click it from the Task Scheduler Library. At Properties you can specify if you want to run the task whether the user is logged in or not. This is recommended. If you do not turn on this property, ZIVVER accounts will not be updated automatically when the user assigned to execute the task is logged in.

You can also specify which user should run the task. Make sure that whoever is used to run the task, the SyncTool profiles are present in the %appdata%/Zivver/SyncTool folder of that user. Because the SyncTool will automatically fetch the SyncTool configuration from this location for the logged in user. Additionally, this means logs will be saved in the %appdata%/Zivver/SyncTool/Logs folder of the user which is used to run this task.

Was this article helpful?

thumb_up thumb_down