Upgrade Code42 User Directory Sync

Last updated
Save as PDF

Overview

Code42 User Directory Sync allows you to automatically manage users in your cloud Code42 environment. Once configured, it connects your directory service (for example, Active Directory) to your Code42 environment and automatically creates users, updates their organization and role assignments, and deactivates users in Code42 based on changes made within your directory service.

This article explains how to upgrade the Code42 User Directory Sync tool to the most recent version.

Before you begin

Before upgrading to the latest version of Code42 User Directory Sync, you must already have an instance of Code42 User Directory Sync installed. For installation directions, see Configure Code42 User Directory Sync.

Contact your Customer Success Manager (CSM) to engage the Professional Services team, who will provide you a link to download the latest version of the Code42 User Directory Sync tool installation package. You install the tool using the steps below.

Steps

Step 1: Run a full synchronization

Run a full synchronization to ensure that the current setup of your Code42 User Directory Sync is clean and error-free before you perform an upgrade. For more information about synchronization, see Run synchronization for Code42 User Directory Sync.

Open a command prompt on the host computer where Code42 User Directory Sync tool is installed.
Navigate to the \bin folder of the Code42 User Directory Sync tool.
Run the following command:
C42UserDirectorySync --sync-now --full-sync
Review logs in the \logs directory, and view the provisioning changes in the sync log.
If there are errors, correct them before proceeding with the upgrade.

Step 2: Back up files

Back up files from the location in which the Code42 User Directory Sync tool is installed and store them in a separate directory. You can use the backed-up files to restore your Code42 User Directory Sync environment should you need to.

Configuration files:
- config.properties
- c42db.mv
Script files:
- activescript.js
- orgscript.js
- rolescript.js
- Any other active, org, or role script files in this location
Directories (optional):
- logs

Step 3: Install the latest version

The installation package only contains the latest supported version of the Java executable, JAR, and dependencies. Extracting the package to the original installation location preserves your scripts, configuration, and database. New instances of these files are only initialized if they are missing at runtime.

Download the installation package for the latest version of the Code42 User Directory Sync tool using the link provided by your Professional Services team representative.
Extract the installation package into the same directory as the existing installation of the Code42 User Directory Sync.
All the previous configuration files persist and the new tool will be able to run without any additional configuration. New and updated properties from the upgrade are added to the config.properties file after the initial synchronization run after the upgrade.

Install to a new directory

Follow these steps if you want to install to a new directory on the same host machine where your current Code42 User Directory Sync is installed.

Download the latest version of the Code42 User Directory Sync tool using the link provided by your Professional Services team representative.
Extract the installation package to the new directory.
Copy into that directory the configuration files and script files you backed up in Step 2.

Install to a new host machine

Follow these steps if you want to install on a different host machine than where your current Code42 User Directory Sync is installed.

Download the latest version of the Code42 User Directory Sync tool using the link provided by your Professional Services team representative.
Extract the installation package to a directory on the new host machine.
Copy into that directory the configuration files and script files you backed up in Step 2.
If you are installing Code42 User Directory Sync to a new host machine, you must reset the passwords. Because encryption is specific to the user/host on Windows and to the host on Linux, new servers can't decrypt passwords unless they are reset. Run the following commands to reset passwords:
- C42UserDirectorySync --ldap-bind-password
  Enter the password for the LDAP service user. You will be prompted only once.
- C42UserDirectorySync.bat --scim-password
  Enter the password for the Code42 User Directory Sync user. You will be prompted only once.

Step 4: Verify upgrade

Run the following command to verify that the new version is installed:
C42UserDirectorySync --version
Run the following command to perform a dry-run and to load new and updated properties to the config.properties file:
C42UserDirectorySync
If there are any errors, correct them before running a synchronization using the --sync-now operation.

For more information about synchronization, see Run synchronization for Code42 User Directory Sync.

Step 5: Verify scheduling still works

If you use a scheduler to run synchronization, verify that it runs with the upgraded Code42 User Directory Sync.

If you installed to a different directory or a new machine, ensure that the scheduler is still pointing at the correct .\bin\C42UserDirectorySync script.
If you are a different user than the user who installed the previous version of Code42 User Directory Sync, ensure that the scheduler is configured to work with the new credentials.