IBM Serviceability Tool for Sametime Guide v 8.5.2.x Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Copyright IBM Corporation, 2013. 1
Table of Contents Introduction...3 Sametime Configuration Validator...3 Sametime Support Bot...3 Sametime Community Monitoring...3 Sametime Deployment Planner...3 Sametime Versions...3 Feedback...4 Installation...5 Installation Requirements...5 Installation Instructions...5 Using the IBM Serviceability Tool...13 Workspace icons...13 Sametime Support Bot Icons...14 Configuration View Icons...14 Report Listing Icon...14 BIRT Report Viewer Icons...15 Adding a Server...15 Configuration Validator...18 Adding Configuration Data to a Server...18 Loading the Configuration...27 Validate Configuration...28 Sametime Support Bot...29 Extending the Support Bot Reporting...30 Extending the Support Bot Troubleshooting...31 Modifying the System Responses in the Bot...31 Sametime Community Monitor...32 Using the Sametime Deployment Planner...33 Understanding the Reports...37 Servers Category...37 Settings Category...38 Report Listing...38 Appendix 1 Collecting the WebSphere Configuration Backup...39 Appendix 2 Copying Database Exporter to a machine with IBM Notes...39 2
Introduction Thank you for using the IBM Serviceability Tool for Sametime. Version 8.5.2.x is the first release of this tool. Development is continuing, and we will release updates periodically. The IBM Serviceability Tool consists of the following four components. Sametime Configuration Validator The Sametime Configuration Validator is a plug-in designed to load the entire configuration information for your Sametime environment, and validate the configuration. It examines configuration settings to verify consistency, and then produces a Configuration Report. Please note, items reported in the Configuration Report do not necessarily indicate that there is a problem with that setting. The Configuration Validation is intended to call attention to areas that are not as expected, with the intent of using this report when the environment is experiencing a problem. The report can be reviewed for areas that might be contributing to the problem. Sametime Support Bot The Sametime Support Bot plug-in provides a Sametime bot within a Sametime Community. Sametime users can contact the Sametime bot and receive automated responses that can be used for troubleshooting or for reporting a Sametime issue. Data is collected, and then administrators can generate a PDF report of the collected data to submit to IBM Support. Sametime Community Monitoring The Sametime Community Monitoring plug-in provides a view for monitoring the Sametime Community Statistics generated. Updates can be configured from 5 secs to 10 minutes. The administrator can monitor multiple Sametime Community Servers and see totals, such as current logins for example, across all servers and for individual servers. This component is for live monitoring only. Sametime Deployment Planner The Sametime Deployment Planner is a plug-in that helps to expose what the new 8.5.x product servers and features have to offer. Additionally, it reveals tips and tricks for successfully planning and deploying the environment. Sametime Versions This tool is designed for use with the following: All Sametime components versions 8.5 and later Sametime Community 8.0, and later 3
Feedback Feedback such as information on problems, enhancement requests, and usability concerns can be posted to the IBM Serviceability Tool for Sametime community on IBM Greenhouse. IBM reviews all feedback but makes no commitments regarding changes to the product or its documentation. To access IBM Serviceability Tool for Sametime community follow these steps: 1. Sign up for IBM Greenhouse at http://greenhouse.lotus.com 2. Access the following Link: https://greenhouse.lotus.com/communities/service/html/communityview? communityuuid=61769f09-1c86-47e0-8f5b-bbdfa3fb831b 4
Installation Installation Requirements Windows 64-bit Operating System 4 GB RAM 2 GB Hard Drive Space 500 MB Installation Space 1.5 GB recommended for data Installation Instructions 1. Select your Language and click OK. 2. Wait for it to complete its extraction. 5
3. Click Next to start the installation. 4. Accept the License Agreement and click Next. 6
5. Accept the default installation folder or choose another folder then click Next. 6. Click Install to begin the installation. 7
7. Wait for the installation to complete the install. 8. Click Finish to leave the install. 8
Using the IBM Serviceability Tool Upon starting the tool, you are in Serviceability perspective. In this perspective you can view the Workspace, Sametime Support Bot, Sametime Deployment Planner, Report Listing and the Configuration View. You can reset the perspective at any time by clicking Window Reset Perspective from the menu. Workspace icons Expand All Fully expands the workspace tree. Collapse All Collapses the workspace tree to the server level. Add Server to Workspace Opens a wizard to select the type of server to add to the workspace and to provide the name of the server. Clear Workspace Clears all data from the Sametime Workspace and Configuration View. Export Workspace Copies all relevant data on the current workspace to a file. 9
Import Workspace Imports in a workspace file that was previously exported. Update Workspace Updates the workspace with remote data. Validate Configuration Performs the configuration validation using the loaded configuration data. Load All Configurations Loads all of the configuration data into the Configuration View. Monitor Statistics Opens the Monitor to view statistics from all accessible Sametime Community servers. Drop Down Menu Provides a workspace menu that includes Create, Remove, Switch, Import, Export, Clear and Update. Sametime Support Bot Icons Bot Login Manual button to log the Sametime Support Bot in. Bot Logout Manual button to log the Sametime Support Bot out. Clear Log Removes all reports from the Sametime Support Bot. Configuration View Icons Copy Config ID Copies the complete configuration id of the selected configuration setting to the clipboard. Copy Config Value Copies the value of the selected configuration setting to the clipboard. Search for Configuration Key Searches the configuration tree for a key. Expand All Fully expands the workspace tree Collapse All Collapses the workspace tree to the server level. Validate Configuration Performs the configuration validation using the loaded configuration data. Report Listing Icon Clears the entire Report Listing, removing & erasing all reports. 10
BIRT Report Viewer Icons Table of Contents Displays the table of contents for easier navigation. Run Report Runs the process and displays the report again. Note: Not useful -- no data changes with this. Export Data Exports the raw data from the report. Note: Not useful. Export report - Exports the report to different formats, including PDF. Print report Prints the report. Print the report on the server Prints the report when the local client is also the server. Adding a Server 1. Click to add a server to the workspace. 2. Enter the name of the server and select the server type. The add server wizard guides you through adding the type of server you selected. Click Next. 11
3. Provide information about the server. The Hostname and Platform type are required information. 4. If you selected a Sametime server as your type you must enter in a Domino Username and Password for a user who has access to the statistics system on the server. This is used by the Sametime Community Monitoring to access that information. 12
5. Review the information about the server you are adding. Click Back to change any information, or click Finish to complete the action. 6. Your server is added to the workspace. 13
Configuration Validator After you have added a server, you then add the configuration data to the server, load the configuration into the Configuration View, and then validate the configuration. Adding Configuration Data to a Server Use the following steps to add the configuration data to the server: 1. Right-click the Configuration item for the server you just added. Description WebSphere Sametime Domino 2. From the menu that displays, add any of the of configuration information that applies. The following table shows the type of information available, by server type: Notes.ini Collected from any Domino based server. Provides information on the Domino server configuration. Domino Structured Text The Domino Directory (names.nsf), Sametime Configuration (stconfig.nsf), and Directory Assistance (da.nsf), databases are the main sources. If you select this configuration type, Notes opens the Sametime L3 Tool Database Exporter (stl3dbexport.nsf) database to export your Domino database as structured text for use by the Sametime Configuration Validator. Sametime.ini Collected from Sametime Community and/or Classic Meeting servers. This file provides additional Sametime Configuration information. WebSphere Config Backup From a WebSphere based Sametime server, you collect the backup configuration file. This file provides the configuration information for this WebSphere node. See Appendix 1 for how to prepare the backup. 3. To export a Domino Structured Text file, right-click Configuration, and then select Structured Text. a) The Notes client opens the Sametime L3 Tool Database Exporter. Note: See Appendix 2 for details if you do not have a Notes client installed on this system. 14
b) Click the Export Database option. c) Select the database to export to structured text, then click Open. 15
d) Switch back to the IBM Serviceability Tool. Select the exporter text file (.txt file) that was stored in the same directory as your database. Click Open. 4. For a Notes.ini, Sametime.ini, or WebSphere Config Backup, a window opens for you to select a file. Select the file, and then click Open. 16
Best Practice: Add all servers and the configurations of all servers to your Workspace when validating the configuration. Failure to load the complete environment leads to missing important portions of the configuration. Loading the Configuration You must load the configuration into the Configuration View, if you want to review it manually. To do so, click the icon. All configuration information is loaded automatically for validation. This step is necessary only if you want to review the configuration information manually. The length of time it takes to load the configuration depends on the number of servers, and the number of configuration files. WebSphere configurations and Domino Structured Text can take an extended period of time. A Loading Configuration dialog displays the status while configuration information is loading. 17
Once completed, your Configuration View shows the data loaded: You can review this data, using marking and highlights. Markings indicate specific configuration values that you should review. Highlighting allows you to highlight specific settings. This release of the documentation does not contain an extensive overview of how to review the configuration tree in the Configuration View. Validate Configuration To run the configuration validation routines, simply click the icon to start the Validation process. When the Validation Selection window displays, select the validation routines to perform. 18
The Loading Configurations window shows the status of the validation process, as first the configuration is loaded, then the validation routines are executed: Sametime Support Bot The Sametime Support Bot is a chat Bot. It is designed to collect information about problems reported by end users, and to assist end users. The beauty of the Bot is that it is also easily extensible. To generate a report simply right-click the User column head and select Report. 19
To configure the user ID and password that the Support Bot should use, click in Window Preferences Serviceability Sametime Support BOT. Complete the fields in the Sametime Support Bot Preferences using the following information: Server The Sametime Community Server that the Support Bot should log in to. UserName - The user name that this particular Support Bot should use to log in. Password The password for the user name. Automatically Login If you select this option, the Support Bot will automatically log in to the Community Server when the server is available. Help Message A message for users regarding who to contact for additional help other than the Support Bot. Extending the Support Bot Reporting To extend the topic areas or to address questions asked about a particular topic area, you can create new files or edit existing files located in the following folder: plugins\com.ibm.serviceability.resources_build num\bot\questions To create a new Topic Area 1. Create a new text file that includes the topic area in the name, using the format TopicArea.txt 2. Edit the text file. 3. On each line add a single question for an enduser to answer. The Support Bot asks questions in the order they appear in this file. 20
4. Save the text file. To edit a Topic Area 1. Edit the file corresponding to the topic area you want, such as TopicArea.txt. 2. Modify any line, or add new lines. Remember that each text line is a single question, and that questions are asked in the order they appear in this file. 3. Save the text file. Extending the Support Bot Troubleshooting To extend the topic areas or to add troubleshooting tips in a topic area, you can create new files or edit existing files located in the following folder: plugins\com.ibm.serviceability.resources_build num\bot\trouble To create a new Topic Area 1. Create a new text file that includes the topic area in the name, using the format TopicArea.txt 2. Edit the text file. 3. On each line add a single tip for an enduser to answer. Tips are given in the order they appear in this file. 4. Save the text file. To edit a Topic Area 4. Edit the file corresponding to the topic area you want, such as TopicArea.txt. 1. Modify any line, or add lines. Remember that each text line is a single tip. Tips are given in the order they appear in this file. 2. Save the text file. Modifying the System Responses in the Bot To modify or translate the system responses given by the Bot by editing the resources.properties file located in the following folder: plugins\com.ibm.serviceability.resources_build num\com\ibm\serviceability\resources\localization You can modify this file by editing the content or changing the language. 21
Sametime Community Monitor This provides a way for you to view Sametime Community Statistics live, for any number of servers. These are live statistics only. Open the Monitor Statistics View, and you will be presented with the following: You can right-click the column titles to add or remove additional statistics to monitor. In addition you can change the default settings by clicking Window Preferences Serviceability Monitor. 22
In the Monitor preferences, you can change the font, and specify which Community or Classic Meeting Statistics to monitor. All Sametime servers in your workspace that have a Domino user name and password set will be monitored. You can add servers to monitor at any time and they will be included at the next refresh interval. You can adjust the on the statistics by using the slider in the toolbar. The update interval default is 30 seconds. Using the Sametime Deployment Planner If the Deployment Planner is not visible display it by selecting Window Show View Sametime Serviceability Deployment Planner. 1. Hold down the Ctrl key and left-click the current features in use or similar features that you might want to use in the new or upgraded environment. You can select multiple values. 23
2. After selecting the features click Retrieve Upgrade Considerations. 24
3. Click on the tabs at the bottom of the window to view the relevant product information and tips for deploying those components. For example, click the Meeting Server tab to view information about deploying a Sametime Meeting Server. 25
4. The various product tabs also open a browser window within the tool, displaying the basic information on the component currently selected. 26
Understanding the Reports Important: Items reported in the Configuration Report do not necessarily mean there is a problem with that setting. The Configuration Validation is intended to call attention to areas that are not as expected, with the intent of using this report when the environment is experiencing a problem. The report can be reviewed for areas that might be contributing to the problem. There are two reports generated by the Configuration Validation -- a Sametime Environment Summary and a Configuration Report. The Sametime Environment Summary report provides a complete summary of your environment for Sametime Support to review. The Sametime Configuration Report provides you with detected problems in your configuration. This report lists the various tests that are performed. The tests are divided into categories that might include one or more of the following tests, for example: Domino LDAP Settings STResolve Tuneup Web SSO Settings Others Each test has a flag indicating success or failure: Test was a success. Test failed. Important: Take particular note of the Tune-up Checks and the Whitespace Category reports. Tune-up Checks -- These tests look for certain configuration settings to determine if you have optimized your environment for performance. These settings are not required, but if performance is an issue, these settings can be tuned to help improve performance. It is NOT recommended to perform this tuning unless your environment is experiencing performance related issues. Whitespace Category -- You will have failures in this category. These failures occr because some Default configuration settings contain whitespace in the beginning or end of a setting. We are working to remedy this whitespace. The purpose of this test is to identify those areas that contain whitespace, and to flag any unexpected settings with whitespace when reviewed by Sametime Support. Servers Category This report category lists all identified servers found in the loaded configuration. This list includes the following servers: Deployment Server Cluster Nodes Meeting Server 27
Community Server Community Cluster Domino Servers System Console Media Server Proxy Server Gateway server Settings Category This category of the report contains a number of basic tests that do not fall into a larger category. Report Listing A Report Listing view is available which when a report is created, the report is added to the Report Listing. This view allows you to open and review past reports that you have generated. Double-click a report to open it in the Report View. Right-click a report to remove or rename it. 28
Appendix 1 Collecting the WebSphere Configuration Backup To create the zip file to select for the configuration type WebSphere Config Backup, perform these steps: 1. Go to the Websphere/appserver/profiles/profilename/bin directory, where profilename is the profile for which you want to create the backup. 2. Shut down the server, unless you are running everything in a single Cell. If so, then do this from the deployment manager (dmgr) profile, and shut down only the deployment manager. 3. Run backupconfig.bat 4. This command returns a new zip file in the bin folder. Rename this file to the name of the server. Appendix 2 Copying Database Exporter to a machine with IBM Notes If you do not have a Notes client installed on the system where you are running the Sametime Configuration Validator, you can copy the Sametime L3 Tool Database Exporter to another system that has a Notes client and run it from there. The Sametime L3 Tool Database Exporter Database is located in the following directory: EclipseDirectory\plugins\com.lotus.sametime.serviceability.resources_ *\configuration\stl3dbexport.nsf Copy this file to another system that has Notes installed so that you can export Domino databases into Domino Structured Text. 29