Jump to main content
IBM® Sametime® V9.0.1 FP1 documentation
Welcome to the Sametime® documentation, where you can find information about how to install and administer Sametime 9.0.1 Feature Pack 1.
Accessibility features for Sametime®
Accessibility features help users who have a disability, such as restricted mobility or limited vision, to use information technology products successfully. IBM® strives to provide products with usable access for everyone.
Learn more about how to install and configure IBM® Sametime® for instant messaging and web conferences.
What's new in this release?
Learn more about the new features in the current version of IBM® Sametime® 9.0.1.
Release notes
Review information about getting started with this product, descriptions of any known problems with the current release, and links to IBM® Tech Notes.
Supported languages
IBM® Sametime® is available in multiple languages.
Directory conventions
Directory variables are abbreviations for the default installation paths. This topic defines the directory variable and its matching default installation directory for each supported operating system.
What is IBM Sametime®?
IBM® Sametime® consists of the following offerings: Sametime Communicate, Sametime Conference, Sametime Complete, and Sametime Unified Telephony. These client and server applications enable a community of users to collaborate through instant messaging, online meetings, and telephony integrated with a PBX system over an intranet or the Internet.
Encryption usage in Sametime®
IBM® Sametime® uses several types of encryption to protect data.
Planning is critical to a successful deployment. Many deployment problems, growth problems, and capacity problems occur because not enough time is taken to carefully plan a deployment. Plan your IBM® Sametime® installation by determining features needed, reviewing system requirements, determining capacity requirements, and the servers and computers needed for your deployment.
Planning Sametime® features
This section describes best practices, requirements, tips, and things you should know when planning for instant messaging and presence services, meeting services, web client services, audio and video services, broadcast communities and persistent chat rooms, including IBM® Sametime® services in the extranet for remote users and customers. Included in this section are several sample topologies, everything from simple internal meetings to voice and video for intranet and extranet users.
Choosing a deployment
Determine the type of Sametime® deployment you need. Do you need a large enterprise deployment, requiring clustering for scalability, failover, and load balancing. Or, do you need a smaller deployment where you install everything on separate computers as a multiple-server configuration. If your deployment is small, do you only need to install your entire deployment on a single server? Use the information in this section to help you determine the size and scope of your Sametime deployment.
System and infrastructure requirements
Sametime® system and infrastructure requirements include network planning, policy planning, password and parameter planning and planning for single sign-on.
Security planning
When planning an IBM® Sametime® deployment, review the following security features and best practices to ensure that your clients, servers, and data are protected.
Client considerations
Review this section before deploying the IBM® Sametime® clients to your users.
Migration and upgrade planning
Review the process for migrating or upgrading from your current version of IBM Sametime® to V9.0.1.
IBM® Sametime® consists of a variety of servers and clients, and can be deployed to suit many different environments. The deployment instructions are organized by feature set, beginning with the minimum components that are necessary to support instant messaging, and then expanding the deployment to include features such as audio and video support, and conferencing.
Installation worksheets
The installation worksheets are organized according to feature area, such as instant messaging, audio video, and common components. Use the installation worksheets to record DNS-registered host names, database names, IP addresses, ports to open, credentials, and other information. The checklist contains sample tables already filled out, and blank tables for you to fill out.
Deploying fixes to Sametime® servers running on WebSphere® Application Server
Install an IBM® Sametime® fix by downloading packages and installing with the Update option.
Deploying common components
Many IBM® Sametime® servers use common components to support either an individual server or a server cluster. Installation Manager and WebSphere® Network Deployment are required prerequisites for most Sametime servers. DB2® and Sametime System Console must be installed once for the deployment. IBM Load Balancer is used in a clustered environment. Follow the instructions for each type of deployment to determine which common components you need to install.
Deploying instant messaging
Instant messaging features are provided primarily by the IBM® Sametime® Community Server, which supports presence, text chats, and two-way phone calls.
Deploying meetings
Meeting features are provided primarily by the IBM® Sametime® Meeting Server, which creates online "meeting rooms" where users can present information and share applications. If you deploy the Sametime Media Manager, conferences can include audio and video features as well.
Deploying audio and video
Audio and video features are provided primarily by the IBM® Sametime® Media Manager, which supports point-to-point and multipoint calls. The Sametime Media Manager uses standard audio and video codecs so that it works with products from other audio and video vendors.
Deploying SIP trunking
SIP trunking allows IBM® Sametime® users to make SIP-based phone calls from their installed Sametime clients.
Deploying First Party Call Control
Deploy the First Party Call Control (FPCC) feature by configuring settings in the IBM® Sametime® Connect and Sametime Embedded client installation packages and then distributing the updated packages to users.
Deploying an instant messaging gateway for external communities
Clients in a local IBM® Sametime® community can communicate with users in other communities through the Sametime Gateway.
Deploying the Sametime® client to users
The IBM® Sametime® Connect client or Sametime Embedded Client has to be installed on users' computers to use instant messaging and meetings. This section explains how to install these clients.
Deploying for mobile users
The Apple iOS client is distributed through the Apple App Store. The Android client is no longer available for download from the IBM® Sametime® Proxy Server. Customers with users who are unable to access the Google Play Store should contact IBM Support to request that a build be provided to them directly.
Clustering servers for high availability and failover
You can provide failover and load balancing in your deployment by creating a cluster of multiple IBM® Sametime® servers of the same type. All Sametime servers can be clustered except for the Sametime System Console, and the Video MCU and TURN Server components of the Sametime Media Manager.
Deploying Sametime® servers in the extranet
Ensure the security of your IBM® Sametime® deployment by deploying servers in the extranet. Deploying Sametime servers in the extranet allows external clients to access Sametime features without directly connecting to servers deployed in your intranet.
Integrating Sametime® with other products
Expand the range of features in your IBM® Sametime® deployment by integrating with other products.
Update IBM® Sametime® V9.0 and V9.0.1 servers to Feature Pack 1 by downloading packages and installing with the Update option.
Important considerations for updating to Feature Pack 1 from Sametime® 9.0.1
FP1 is an update to IBM Sametime V9.0.1. Before beginning the update process, review the following information on product versions and installation sequence. Updating servers in the wrong sequence or with the wrong software will result in errors.
Updating common components to FP1
Update common components before updating IBM Sametime® 9.0.1 servers to Feature Pack 1.
Updating Sametime® Community Server to FP1
Run the installation program to update IBM® Sametime® 9.0.1 Community Server to Feature Pack 1.
Updating Sametime® Proxy Server to FP1
Run the installation program to update the IBM® Sametime® 9.0.1 Proxy Server to Feature Pack 1.
Updating Sametime® Advanced Server to FP1
Run the installation program to update the IBM® Sametime® 9.0.1 Advanced Server to Feature Pack 1.
Updating Sametime® Meeting Server to FP1
Run the installation program to update the IBM® Sametime® 9.0.1 Meeting Server to Feature Pack 1.
Upgrading Sametime SIP Proxy/Registrar to FP1
Run the installation program to update the IBM® Sametime® 9.0.1 SIP Proxy/Registrar to Feature Pack 1.
Updating Sametime® Conference Manager to FP1
Run the installation program to update the IBM® Sametime® 9.0.1 Conference Manager to Feature Pack 1.
Updating Sametime® Video Manager to FP1
Run the installation program to update the IBM® Sametime® 9.0.1 Video Manager to Feature Pack 1.
Updating the combined PR+CF components to FP1
Run the installation program to update the IBM® Sametime® Media Manager 9.0.1 combined SIP Proxy/Registrar and Conference Manager (installed on the same computer) to Feature Pack 1.
Updating Sametime® Video MCU to FP1
Run the installation program to update the IBM® Sametime® 9.0.1 Video MCU to Feature Pack 1.
Updating Sametime® Gateway to FP1
Update the Sametime® 9.0.1 Gateway server to Feature Pack 1 by downloading the new package and running the appropriate script.
Updating security
After you finish upgrading your IBM® Sametime® deployment, you should immediately harden the security.
Migrate from IBM® Sametime® 8.5.2x by deploying Sametime 9.0.1 on separate computers, migrating environment settings and user data, and then redirecting users to the new deployment.
Migrating DB2® databases to Sametime® 9.0.1 format
Upgrade IBM® DB2® databases, migrate policies data, and optionally upgrade the DB2 server.
Deploying Sametime® 9.0.1
Deploy IBM® Sametime® 9.0.1 as described in the Sametime 9.0.1 Installation and Administration documentation, recreate environment settings, and then restore data for the Sametime Community Server and the Sametime Gateway server.
Upgrading Sametime® clients
Use the information in this section to help users upgrade their IBM® Sametime® 8.5.2.x and 9.0 Connect clients to the new release.
Switching over to the Sametime® 9.0.1 deployment for production
Change the IBM® Sametime® DNS settings to direct users to the new deployment.
Manage IBM® Sametime® servers and users to ensure proper access to the features in your deployment.
Deploying fixes to Sametime® servers running on WebSphere® Application Server
Install an IBM® Sametime® fix by downloading packages and installing with the Update option.
Sametime® component URLs
This section lists the URLs for IBM® Sametime® servers and components.
Logging in to the Sametime® System Console
Use the IBM® Sametime® system console to use guided activities to perform configuration tasks and administer any Sametime servers that are managed by the console.
Starting and stopping servers in a Sametime® deployment
An IBM® Sametime® deployment is made of up several component servers that can be started and stopped independently.
Restarting and synchronizing servers in the cluster
Complete the configuration for clustering servers using a WebSphere® Application Server network deployment by restarting and synchronizing nodes in the cluster and restarting the application servers in the cluster.
Backing up WebSphere® Application Server configurations
As part of a routine maintenance schedule or before upgrading Sametime® servers that run on the WebSphere® Application Server, back up the WebSphere Application Server configurations.
Changing administrator passwords for DB2®, LDAP, and WebSphere® servers
The following topics explain how to change your administrator password for the different types of servers used in an IBM® Sametime® deployment.
Setting up business cards
You can configure the IBM® Sametime® Community Server so that business card information about an individual displays when a user hovers over a name in a chat window or a contact list.
Creating policies to control user access to features
IBM® Sametime® policies control user access to features. All users are assigned to default policy settings, which you can modify. You can create additional user policies, and assign users and groups to these policies.
Administering a Sametime® System Console
This section describes how to manage the IBM® Sametime® System Console.
Administering a Sametime® Community Server
This section describes how to manage an IBM® Sametime® Community Server
Administering a Sametime® Proxy Server
This section describes how to manage a IBM® Sametime® Proxy Server.
Administering Sametime® Advanced
Set up and begin using IBM® Sametime® Advanced to let users create and use persistent chat rooms and broadcast communities. After installing Sametime Advanced, you can manage user access, enable workflow, set anonymous access, and integrate Sametime Advanced servers with other products.
Administering a Sametime® Media Manager
The audio/video services are enabled by default following an IBM® Sametime® Media Manager installation. You can enable and disable the audio/video services from the Sametime System Console. This section describes how to manage the Sametime Media Manager.
Administering a Sametime® Bandwidth Manager
IBM® Sametime® Bandwidth Manager provides a number of monitoring and management tools. Use these tools to ensure that the bandwidth management component is configured and tuned to best serve your organization's day-to-day needs and support the organization's network policies.
Administering a Sametime® Meeting Server
This section describes how to manage an IBM® Sametime® Meeting Server.
Administering a Sametime® Gateway Server
Set up and begin using the IBM® Sametime® Gateway Server to enable local IBM Sametime users to have real-time collaboration with users of other instant messaging systems. After installing the Sametime Gateway Server, you can create a local and external community, manage user access, add message handlers if necessary, and set properties such as session timeouts and blacklist domains.
Administering Widgets and Live Text
Widgets and Live Text enables end users to see and act on recognized Live Text in any supported content like chat windows, chat history, Notes® documents (Sametime® Embedded Client in Notes client only), and so on, using XML extensions (widgets) created specifically for their use.
Administering a Sametime® Gateway Server cluster
Use the topics in the section to administer the Sametime® Gateway Server cluster.
Maintaining Sametime® databases
Maintain your Sametime® environment by deleting unnecessary files from databases, moving files, managing DB2® and other maintenance tasks.
IBM® Sametime® administrators can make adjustments to the servers they maintain to provide optimal performance for users as they use instant messaging and web conferencing.
Setting JVM verbose garbage collection in the Sametime® Connect Client
Set verbose garbage collection logging in the IBM® Sametime® Connect Client.
Increasing the number of open files on a Sametime® server running on Linux™
If your IBM® Sametime® server is hosted on Linux™, increase the number of concurrent open files on the server to prevent performance problems.
Turning on full-text indexing in the Meeting Room Center
By default, the Meeting Room Center searches the Meeting Room Center database for rooms without using an index. If the database becomes too big, your deployment might experience performance degradation during searches. You can enable full-text indexing on the room name and owner name fields for enhanced performance on large datasets.
Tuning LDAP performance
Improve LDAP performance by configuring context pools using specific settings, disabling nested group search and configuring member and membership attributes.
Tuning a Sametime® Community Server
Complete the following tuning procedures to enhance performance.
Tuning a Sametime® Meeting Server
Improve IBM® Sametime® Meeting Server performance by setting custom properties.
Tuning a Sametime® Advanced Server
Complete the following tuning procedures to enhance performance on an IBM® Sametime® Advanced Server.
Tuning Sametime® Media Manager
Complete the following tuning procedures to enhance performance.
Tuning Sametime® Bandwidth Manager
Complete the following tuning procedures to enhance performance.
Tuning a WebSphere® proxy server
This section contains procedures for tuning an IBM® WebSphere® SIP proxy server that is deployed in front of a cluster of IBM Sametime® servers.
Tuning a Sametime® Proxy Server
Improve Sametime® Proxy Server performance by increasing JVM heap size, adjusting web container transport settings, as well as other setting other tuning parameters as explained in this section.
After setting up your initial IBM® Sametime® environment, you may want to make additional changes to safeguard information at your site, including limiting user access to certain features, using encryption, and modifying default security settings.
Configuring TLSv1.2 for the deployment
Improve the security of your IBM Sametime deployment by configuring TLSv1.2 for all of the servers.
Adding administrators to WebSphere-based Sametime® servers
Add yourself or others as administrators of IBM® Sametime® components that are hosted on IBM WebSphere® Application Server.
Configuring Citrix optimization
IBM® Sametime® supports the use of Citrix optimization for audio/video calls from the Sametime Connect and the Sametime Embedded client. Configure the use of Citrix optimization for your users by deploying a copy of the Sametime Connect client to the Citrix XenApp server and then ensuring that users install the related components on their computers.
Configuring SiteMinder for Sametime® components
SiteMinder uses agents to intercept HTTP requests in Sametime® servers, and then forwards them to the SiteMinder Policy Server for authentication.
Setting up compliance for FIPS 140-2
IBM® Sametime® supports the U.S. government-defined security requirements for cryptographic modules known as FIPS 140-2 (Federal Information Processing Standard 140-2). If your Sametime deployment must maintain FIPS 140-compliance for all data exchanged between clients and Sametime Community Servers, you must install the FIPS Server on the Sametime Proxy Server to accept data on behalf of Sametime Community Servers.
Setting up single sign-on for Sametime® clients
Configure servers for single sign-on (SSO) as a convenience to users running the IBM® Sametime® browser client. With SSO configured, users who log in once to any server in the DNS domain do not have to log in again when they access any other server running on IBM Domino® or WebSphere® Application Server. Enabling SSO between the servers also helps the Sametime Connect Client as well. If the community server is in the single sign-on domain, the component services can re-use the token from the Sametime Connect Client to login to other services.
Configuring virus scan for use during file transfer
Virus scanning of inbound and outbound file transfers occurs on the IBM® Sametime® Community Server. The Sametime Proxy Server does not offer any specific virus scanning support for files during file transfer through a Sametime Proxy Server. You can configure the file system location used for temporary storage of files and enforce virus scanning during file read and write.
Configuring secure access to an LDAP repository
Configure secure access to a Lightweight Directory Access Protocol (LDAP) repository used by IBM® Sametime® servers.
Replacing SSL certificates for Sametime® servers running on WebSphere®
Communications between IBM® Sametime® servers are encrypted when the servers are configured to use SSL (Secure Sockets Layer). Sametime servers that run on IBM WebSphere® Application Server install with SSL enabled, and with a default certificate in place. Replace that certificate with one that is signed by an accepted Certificate Authority. For the awareness feature to work with browser clients, the Sametime Advanced Server must use the same certificate that the Sametime Proxy Server uses.
Enabling anonymous access by token authentication
Enabling anonymous access by token authentication protects the IBM® Sametime® Community Server from overload and from possible security risks.
Changing the SIP transport protocol in the Sametime® Media Manager
You can change the transport protocol that IBM® Sametime® Media Manager uses for the SIP Proxy/Registrar, Video Manager, and Conference Manager components. Supported transport protocols are TCP and TLS.
Working with Domino® security in Sametime®
The IBM® Sametime® Community server uses the Internet and intranet security features of the IBM Domino® server on which it is installed to authenticate web browser users who access Domino databases on the server.
Use this information on troubleshooting and logging tools to diagnose and resolve problems affecting servers or users.
Setting up basic troubleshooting
Perform these common troubleshooting tasks on most WebSphere® application servers.
Troubleshooting Sametime® clients
Use the following information to troubleshoot problems with IBM® Sametime® Connect and browser-based clients.
Troubleshooting Sametime® servers
Use the following topics to troubleshoot problems with Sametime® servers.
Troubleshooting an IBM® Load Balancer
Use the following topics to troubleshoot audio/video problems related to the IBM® Load Balancer. This section includes problems you might encounter when using a Sametime® environment that is extended for high availability and failover, and where configuration changes to the Load Balancer are required to resolve a problem.
Troubleshooting IBM® Connections widgets
Use the information in these topics to troubleshoot issues with the IBM® Connections widgets.
Uninstall IBM® Sametime® servers to disconnect them from the deployment and cleanly remove them from computers.
Uninstalling the Sametime® client
Follow the instructions in this section to uninstall the Sametime® Connect client or the Sametime embedded client for Notes®.
Uninstalling Sametime® servers
If you want to remove an IBM® Sametime® product from a server, you can uninstall it.
Updating the Sametime® System Console when server unregistration fails
If you attempted to unregister an IBM® Sametime® server from the console using either the uninstallation program or the manual unregistration utility and it failed, you can update the console itself to complete the unregistration task. You can also use this method if the installed server has failed and cannot be uninstalled or unregistered.
Manually removing WebSphere® Application Server
Remove WebSphere® Application Server manually if it remains on the system after Sametime® fails to install or uninstall completely.
Uninstalling Sametime® servers on IBM® i
If you want to an IBM® Sametime® product from a server running on IBM i, you can uninstall it.
Updating the Sametime® System Console on IBM® i when server unregistration fails
If you attempted to unregister an IBM® Sametime® server from the console using either the uninstallation program or the manual unregistration utility and it failed, you can update the console itself to complete the unregistration task. You can also use this method if the installed server has failed and cannot be uninstalled or unregistered.
Glossary