Skip to content

Updating user IDs

The updates feature of the Sametime Database utility changes specified first names, last names, display names, or group names.

Stop the Sametime server prior to running the Sametime Database utility. Refer to Starting and stopping the Sametime server for the steps.

The following is the format for the update task in the CVS file. Each ID to be updated is listed on a separate line. The syntax for the update task in the CVS files is:

ID
"existing\_ID", "new\_ID"[,"new_display_name"]​

CSV files are case-sensitive and sensitive to spaces.

The ID task works by comparing existing user IDs with the names provided in the CSV list, and replacing the IDs when a match is found. By default, comparisons are case sensitive. To allow case-insensitive comparisons of user IDs by adding the following statement to the sametime.ini file.

NC_ID_TASK_CASE_INSENSITIVE=1

For more information, refer to Configuring the sametime.ini file.

  1. Create a CSV file. The file must be saved in UTF-8 format.

    In the CVS file, specify the ID descriptor followed by the UIDs to be deleted. Specify each UID on a separate line. Note that

    ID
"existing\_ID", "new\_ID"[,"new_display_name"]​

    For example,

    ID
"Maria Smith," "Maria Smith-Brown"[,"Maria Brown"]

    Note: The brackets [ ] indicate that the new display name is optional. If you use it, you must precede it with a comma. The new display name must immediately follow the comma. Do not leave a blank space between the comma and the new display name.

  2. Copy the CSV file into an accessible read or writable location.

  3. Create or edit a file that contains the environment variables.

    1. Add the MongoDB access information to the file.

      MONGO_CONNECTION_URL=mongodb://username:password@ip-address:port​

    2. Add the location of the CVS file.

      DELETE_CSV=/temp/test_delete.csv

    3. To delete the chat history of the affected IDs, add the following line.

      DEEP_DELETE=1

    The following is an example env_file_name file.

    MONGO_CONNECTION_URL=mongodb://sametimeUser:xxxxxxxx@192.168.1.1:27017/admin?authSource=admin&authMechanism=SCRAM-SHA-256&readPreference=primary&directConnection=true&ssl=false
DELETE_CSV=/temp/test_delete.csv
DEEP_DELETE=1

  4. Run the Database utility using the following command. The CSV file is mounted in the container in the/temp directory in the following example for the application to access and process. The tag attribute is the image tag to use.

    docker run -v /temp:/temp:rw --env-file env_file_name.env hclcr.io/st/sametime-db-utility:tag

  5. Copy the CSV file into an accessible read or writable location.

  6. To verify your changes, view the report created in the data directory.

Parent Topic: Using the Sametime Database utility