CSV User Sync Technical Details

Sync App Installation

1. Get your Credentials

Ask your Starmind Solution Architect, to provide you the necessary credentials.
Get Credentials

2. Download the Sync App

You can download the Sync App from here:
Download Sync App

3. Install the App

Extract the zip file to a temporary folder and run install.bat
Then answer the questions to complete the install process.

Question Description
Domain The Active Directory domain which will be queried.
Group The Active Directory group which will be queried. If you leave the field empty, the entire domain will be synched.
Nr of Executions Choose if the script should run daily or weekly. Starmind recommends to run the script daily.
Execution Time At which time the script will be executed.
Report Upload If this is set to true, the file will be uploaded to the SFTP Server. Otherwise, the script will skip the upload.
Username The username to login to the SFTP server (provided by Starmind).
SSH Certificate This is only required, if the authentication should be done with a certificate instead of username & password. If this is required enter the path to the certificate.
Password Enter the password of your SFTP Login (provided by Starmind).
Report Location If you want to store the generated csv file with the user, enter the location here.


4. Test the Script

You can test the App by executing the export-users file. You can find this file here:

C:\Program Files\Starmind\UserUpdater\export-users

When you have executed the script, login to the SFTP Server and check if the file was generated as expected.


Changing the configuration

Changing configuration options

If you wish to change the schedule or other options, the easiest thing to do is simply re-run the installer. Any existing configuration will be overwritten.

Advanced users can edit the configuration file directly, it is JSON format and located here:

C:\ProgramData\Starmind\userUpdater.config

Complex Schedules

If you require the update script to run on a complex schedule, you may edit the scheduled task manually.

  1. Open Task Scheduler from the Start Menu
  2. Select the Task Scheduler Library node from the tree
  3. Locate the update service scheduled task, by default it is named starmind_update_users
  4. Right-click the task and select properties
  5. Adjust the schedule as required on the Triggers tab


Uninstalling

For an automatic uninstall, run uninstall.bat from the the program directory (C:\Program Files\Starmind\UserUpdater\uninstall.bat by default) or from the original zip file.

For a manual uninstall:

  1. Open Task Scheduler
  2. Select the Task Scheduler Library node from the tree
  3. Locate the update service scheduled task, by default it is named starmind_update_users
  4. Right-click the task and select delete
  5. Close Task Scheduler
  6. Open the Windows Explorer and navigate to C:\ProgramData\Starmind\
  7. Delete the userUpdater.config and uploadCertificate.ppk files

Manual CSV Sync

1. Get your Credentials

Ask your Starmind Solution Architect, to provide you the necessary credentials.
Get Credentials

2. Export Active Users as CSV

All the users eligible to access Starmind need to be exported in CSV format. All user fields can be updated (except custom fields) but only first-, lastname, email address, and unique ID are required.

Example CSV

3. Upload CSV

Upload the exported user list to Starmind's SFTP server. In your home directory there is a folder "upload" which must be used for new CSV files. The syncronization job will run over night and check if there is a file present and move it to the "processed" or "error" folder depending on the result of the synchronization.

4. Schedule Upload

Starmind does not require a periodic update of users. However, it is recommended to sync users at least once a month.