Introduction

This document explains how to automate synchronizations 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 synchronizations.

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 synchronization profiles, then you should create a new Action in the scheduled task for each synchronization 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 not logged in.

Enable Log on as batch job rights

The steps below describe how you can enable the Log on as batch job rights for the service account.

1. Press the Win + R keys on your keyboard to open the Run dialog.
   
2. In the Run dialog, type secpol.msc.
   
3. Press Enter to open the Local Security Policy Editor.
   
4. In the Local Security Policy window, locate the Local Policies folder in the left-hand menu.
   
5. Expand Local Policies by clicking on the arrow next to it.
   
6. Click on User Rights Assignment to display the available policies in the right-hand pane.
   
7. In the list of policies on the right, scroll down to locate Log on as a batch job.
   
8. Double-click on Log on as a batch job to open its properties.
   
9. In the policy dialog box that appears, click the Add User or Group… button.
   
10. In the dialog box that appears, click Advanced… to open advanced search options.
    
11. Click Find Now to see a list of available accounts.
    
12. Select the service account from the list, or manually type the account name (e.g., Domain\AccountName for domain accounts or .\LocalAccountName for local accounts).
    
13. Click OK to confirm the selection and close the dialog.
    
14. In the Select Users, Computers, Service Accounts, or Groups dialog box, click OK.
    
15. In the policy dialog box, click Apply to save the changes.
    
16. Click OK to close the dialog box.
    
17. Once the changes are saved, close the Local Security Policy Editor window.
    Depending on your system configuration, the changes might require a restart to take effect.
    
18. If necessary, restart the server to ensure the policy is applied.