Home
HCL Sametime® Administration Guide 12.0.1
Administering
This section provides information on administering on Sametime environments.
Using the Sametime Database utility
The Sametime Database utility is used to synchronize the information with that of the Sametime server database.

HCL Sametime® Administration Guide 12.0.1
- Accessibility features for Sametime
  Accessibility features help users who have a disability, such as restricted mobility or limited vision, use information technology products successfully. HCL® strives to provide products with usable access for everyone.
- What's new
  HCL Sametime and HCL Sametime Premium 12.0.1 provide many new features, enhancements and fixes to servers and clients. Additional releases to version 12.0.1 also provides updates to the product.
- Planning
  This section describes the system requirements and server configurations needed for HCL Sametime and HCL Sametime Premium.
- Installing
  This section provides information on installing the servers for Sametime and Sametime Premium.
- Configuring
  This section provides information on configuring the HCL Sametime server. Configuration tasks are dependent on the deployment environment.
- Securing
  This section provides information on securing your HCL Sametime environments.
- Administering
  This section provides information on administering on Sametime environments.
  - Managing Sametime clients
    This section provides information on managing Sametime clients.
  - Managing file transfer data
    As with meeting recordings and reports, files that are shared in the chat are stored in a Docker volume or a Kubernetes persistent volume. By default, you can download these files within 90 days.
  - Testing Sametime chat and meeting clients
    This article assumes that you have successfully installed and configured Sametime or Sametime Premium.
  - Starting and stopping the Sametime server
    Starting and stopping the Sametime server involves starting and stopping the Sametime services running in the container management system.
  - Starting and stopping MongoDB
  - Managing policies
    Sametime policies allow administrators to control user access to features.
  - Configuration files
    Configuration files maintain information used by the Sametime server for various reasons.
  - Enabling multi-tenancy
    Multi-tenancy allows multiple organizations to be part of the Sametime community. With multi-tenancy, Sametime users can chat, add users and groups to contact lists, and have awareness of users in their organization or in other organizations that are configured to be visible to them.
  - Using the Sametime Database utility
    The Sametime Database utility is used to synchronize the information with that of the Sametime server database.
    - Converting chat history owner data from Domino directory to LDAP format
      The convert feature of the Sametime Database utility changes all contact list information from the Domino Directory format to LDAP format.
    - Deleting user IDs
      The delete feature of the Sametime Database utility removes specified individual contact names from contact lists and privacy lists.
    - Moving users
      The move feature of the Sametime Database utility allows you to move users from one organization to another.
    - Updating user IDs
      The updates feature of the Sametime Database utility changes specified first names, last names, display names, or group names.
  - MongoDB
    This section provides information relating to administering MongoDB.
  - Managing Sametime Meetings
    This topic explains the features you can enable or disable for meetings. Currently, the settings that you can change are global settings that apply to the entire server. User policies cannot control the settings.
- Troubleshooting
  This section provides information on troubleshooting and supporting Sametime environments.
- Uninstalling Sametime
  In the event that Sametime must be removed, follow the procedure for the platform that Sametime is installed on.
- Migrating and Upgrading
  This section provides information on migrating data from an earlier release to Sametime 12.
- Notices

Using the Sametime Database utility

The Sametime Database utility is used to synchronize the information with that of the Sametime server database.

When you change user or group names in the directory, the change is not reflected in Sametime databases. In order to synchronize the directory names with the names in the Sametime databases, you must run the name conversion utility. You can run the name conversion utility manually on a stand-alone Community Server, or on a server in a cluster which replicates the change throughout the cluster.

Note: You do not need to run the Sametime Database utility when adding new users or groups to the Domino or LDAP directory.

The tool performs the following functions:

Convert
Delete
Move
Update

Note: Refer to the Converting chat history owner data from Domino directory to LDAP format topic for the convert function.

The utility is loaded to your Docker repository during the Sametime install process, it is located in the image repository. The name of the utility image is sametime-db-utility. The Sametime Database utility uses a comma-separated value (CVS) file that you compile to update, convert, or delete names which includes the descriptor that corresponds to the task to be completed. To use the utility, create a CVS that corresponds to the task to be completed. The CVS file must contain only one type of task, that is you cannot run an update and convert using the same CVS file. Note that CSV files are case-sensitive and sensitive to spaces.


Descriptor	Purpose
DELETE	Removes specified individual contact names from contact lists and privacy lists.
ID	Changes specified first names, last names, display names, or group names.
TASK_LDAP	Changes all contact list information from Domino Directory format to LDAP format.
ORGANIZATION	Change the organization name for all users.

At the end of the Sametime Database utility run, a report file is generated containing a summary of changes applied to the database. You can view the report to verify your changes. The report contains a summary of changes applied to the database, including records touched, modified or deleted. It also has the count of records modified or deleted and which attribute is modified. The report file is created in the data folder. The report file name is in following format:

name_change_summary_report_[date_time].log

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site.