Home
HCL Sametime® Administration Guide 12.0.1
Administering
This section provides information on administering on Sametime environments.
Managing policies
Sametime policies allow administrators to control user access to features.
Policy management
In previous versions of Sametime there was a graphical user interface available to configure policies. In Sametime 12.0, configuring policies are done in the policies.user.xml file, which is located on the Sametime server.
Managing policies on Kubernetes
As administrators, you define what end-users can do on a cluster to comply with organization requirements. This section outlines the steps on how to manage policies in a Kubernetes environment.

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.
    - Policy behaviors
      You can assign anonymous, default, or custom user policies to users or groups to allow or restrict access to certain Sametime features. Sametime uses policy weights and group nesting levels to determine which policies take precedence.
    - Policy management
      In previous versions of Sametime there was a graphical user interface available to configure policies. In Sametime 12.0, configuring policies are done in the policies.user.xml file, which is located on the Sametime server.
      - Default Sametime Premium policy template
        The policies.user.xml file contains the default and anonymous policies used by the Sametime server. Use the following as reference to the formatting requirements. You can create new policies by copying the default policy template and then updating the parts that require configuration. For details on assignments and weights, see admin_ssc_policies_understand.html.
      - Creating new policies
        When a user authenticates, Sametime applies a default policy if no other policy can be found for that user. You can create new policies by copying and editing the policy template. To create a new policy, follow these steps.
      - Managing policies on Docker and Podman
        This section outlines the steps on how to manage policies in a Docker and Podman environment.
      - Managing policies on Kubernetes
        As administrators, you define what end-users can do on a cluster to comply with organization requirements. This section outlines the steps on how to manage policies in a Kubernetes environment.
    - Sametime policy IDs
      This section describes the policies and configurations available in the Sametime deployment.
    - Mobile client policies
      While many user policies are available in the Sametime ecosystem, only a subset of these policies apply to the mobile clients. This section describes the policies and configurations available to the said clients.
    - Changing a user policy’s weight
      Each Sametime policy has a weight assigned to it. The weight should be unique. When assigning a weight to a policy, please ensure the weight is unique on each policy and not duplicated.
    - Assigning users and groups to policies
      Policies can be assigned to users or groups. Policy configuration is done inside the policies.user.xml file.
    - Allowing or restricting custom policies for Sametime clients
      Optionally allow or restrict features for clients by creating exception rules for the policy service in the policyExceptions.xml file.
  - 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.
  - 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

Managing policies on Kubernetes

As administrators, you define what end-users can do on a cluster to comply with organization requirements. This section outlines the steps on how to manage policies in a Kubernetes environment.

Before you begin

You need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster.

About this task

You can manage your policies on Kubernetes by modifying copies of policies.user.xml and policies.server.xml files and adding an overrideCommunityPolicy parameter to values.yaml.

To manage your policies on Kubernetes, follow these steps:

Procedure

Create a directory to store the extra community policy files. Move the copied files to the new directory. In the example below, the directory is called extra-community-policy.
```
extra-community-policy
```
Switch to the extra-community-policy directory. Edit the policy files and save the changes.
Copy the following extra community policy files out of the container to a local directory.
```
kubectl  exec -it <podID> --container community -- cat /local/notesdata/policies.user.xml > ./policies.user.xml
kubectl  exec -it <podID> --container community -- cat /local/notesdata/policies.server.xml > ./policies.server.xml
```
Note: Both files are needed even if you are updating only one file.
To find and identify the <podID>, run the command:
```
kubectl get po
```
Create the extra-community-policy ConfigMap from the directory with the policy files with the command:
```
kubectl create configmap extra-community-policy --from-file=./
```

Edit values.yaml and add:

overrideCommunityPolicy: extra-community-policy

Run the command:
```
helm upgrade <sametime_deployment>
```

Scale the community pod.

kubectl scale deploy community --replicas=0
kubectl scale deploy community --replicas=1

Updating configuration values

Before you begin

This procedure assumes that you have previously made adjustments to your policies, following the detailed steps above.

Procedure

Delete the ConfigMap extra-community-policy:
```
kubectl delete cm  extra-community-policy
```
Locate and edit the policies as necessary.

Create the extra-community-policy ConfigMap:

kubectl create configmap extra-community-policy --from-file=./

Scale the community pod.

kubectl scale deploy community --replicas=0
kubectl scale deploy community --replicas=1

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.