10. Automated Synctool synchronisation using Windows Task Scheduler

Introduction

This document explains how to automate synchronisations with the Zivver Synctool via the Windows Task Scheduler. The Synctool has no built-in feature to run automatically, therefore the Task Scheduler must be used to automate synchronisations.

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.
    Zivver recommends 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). This parameter is required to run the Synctool automatically.
    -p "Full-path-and-file-name"
    Open the Synctool profile, click Profile > Profile details and copy and paste the entire string under Profile location.
    -p "c:\zivver\configuration\account-synchronisation.xml"

    The argument field for running two profiles in the Synctool will usually look something like this:
    -s -p "c:\zivver\configuration\account-synchronisation.xml"
  13. Click Next >.

  14. Click Finish.

    If you want to run multiple synchronisation profiles, then you should create a new Action in the scheduled task for each synchronisation profile you wish to run.

How do you know it worked?

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 either see newly created accounts in the Zivver admin portal or find logs in the configured logs and events folder.

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. Zivver recommends enabling this feature. 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.

Was this article helpful?

thumb_up thumb_down