# User Sync Utility

Qommentary imports users/groups from Qlik Sense to the Qommentary environment enabling user token allocation, security and approval workflows management.

The *User Sync Utility* is a standalone executable which can be triggered from any task schedule manager to automate the user sync process in Qommentary.

![User Sync Flow](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5pwrW47mtIwOBKi3lT%2F-M5q6RCRqDDPL3sCXfSf%2Fimage.png?alt=media\&token=cab56f90-beab-422d-adb9-2d5d041d3b99)

By default, Qommentary supports the built-in *Windows Task Scheduler* application which can be configured to run on a frequent schedule and trigger the *Qommentary User Sync Utility*.

To setup an automated user sync task, please follow these steps:

### User Sync Utility

1\. Download the [**User Sync Utility**](mailto:support@qommentary.com?subject=%20Download%20Request%20%7C%20Qommentary%20User%20Sync%20Utility\&body=Please%20send%20download%20link%20to%20latest%20Qommentary%20User%20Sync%20Utility.)\
2\. Unzip contents to any folder on the server where Qommentary is hosted\
3\. Copy the **appsettings.json** file found on the Qommentary Engine folder under your installation path\
4\. Paste the file inside the *User Sync Utility* folder

### Windows Task Scheduler

1\. Open the **Server Manager**\
2\.  Click on **Tools** > **Task Scheduler**

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5oFgnYOUVLSoft8qra%2F-M5osWQDCGohkyCPxO1H%2Fimage.png?alt=media\&token=5ccb4d2a-6372-4bd0-8e12-82c19f013464)

3\. Click on **Create Basic Task**

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5oFgnYOUVLSoft8qra%2F-M5ov2MHRX4dm-RMukqu%2Fimage.png?alt=media\&token=ba0f7dc4-4cf7-4973-a025-3ee9b8e86dbe)

{% hint style="info" %}
You may also select **Create Task** if you would like a more advanced setup 
{% endhint %}

4\. Give your new task a name and click **Next**

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5oFgnYOUVLSoft8qra%2F-M5owbEosEZBKhVP7YaY%2Fimage.png?alt=media\&token=2acceba3-25f7-440b-9dc5-603921015b93)

5\. Choose the frequency of your task and click **Next**

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5oFgnYOUVLSoft8qra%2F-M5owphlvoheRzLUuuGp%2Fimage.png?alt=media\&token=8de3bfee-6192-4d9f-8492-da123dd4ba00)

6\. Choose when the task should start and click **Next**

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5oFgnYOUVLSoft8qra%2F-M5ox2nFYMCSyHU9n5u0%2Fimage.png?alt=media\&token=3bee5eba-7bd9-4be1-9e62-78ea7272d2f4)

7\. Choose **Start a program** and click **Next**

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5oFgnYOUVLSoft8qra%2F-M5oxLPCFymRsvEQYctB%2Fimage.png?alt=media\&token=744d8018-257e-46b9-8e57-a4aba1930aef)

8\. Browse to the *User Sychronization Utility* location, select **Qommentary.UserSync.exe** and click **Next**

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5oFgnYOUVLSoft8qra%2F-M5oyfZYHZeKbNUAV56j%2Fimage.png?alt=media\&token=0c7ed888-7e62-4cf7-b53d-d86c218a54bd)

9\. Review your details and click on **Finish**

Once the basic task has been created, we recommend reviewing each configuration tab to ensure it meets your requirements:

1\. Double-click on the newly created **Qommentary User Sync** task

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5oFgnYOUVLSoft8qra%2F-M5p1mlIHXG9rqr20YSI%2Fimage.png?alt=media\&token=947d9109-5d15-42b4-9844-fe8957b8bf1c)

2\. Select **Run whether user is logged on or not** and tick **Run with highest privileges**

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5p3zcbECEP7Lez0-jJ%2F-M5p4GIOjXLqyDGP0pI0%2Fimage.png?alt=media\&token=a1b80e24-80ed-4e13-8bb3-892b195f945e)

4\. Verify that the **Conditions** and **Settings** tabs display correct settings\
5\. Click on **OK** and enter your admin password

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5p3zcbECEP7Lez0-jJ%2F-M5p6nXf_yofM216fGcr%2Fimage.png?alt=media\&token=ecb28d9c-e87a-4993-bdd9-7f56cdfb7d24)

### **Logs**

The *User Sync Utility* will create a log file in a daily basis and store in the setup folder.

![](https://409486811-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M43RhGzV8Plu0tfknia%2F-M5p3zcbECEP7Lez0-jJ%2F-M5pXRUo1J-icuoWeizR%2Fimage.png?alt=media\&token=501784f0-1b50-45ba-a120-4067ad1c85cf)