Operations Console Guide
-
Upload
others
-
View
10
-
Download
0
Embed Size (px)
Citation preview
IBM Cognos Analytic Server Version 10.1.0: Operations Console
GuideOperations Console Guide
Note Before using this information and the product it supports,
read the information in “Notices” on page 21.
Product Information
This document applies to IBM Cognos Express Version 10.1.0 and may
also apply to subsequent releases. To check for newer versions of
this document, visit the IBM Cognos Information Centers
(http://publib.boulder.ibm.com/
infocenter/cogic/v1r0m0/index.jsp).
Microsoft product screen shot(s) used with permission from
Microsoft.
Licensed Materials - Property of IBM
© Copyright IBM Corporation 2012. US Government Users Restricted
Rights – Use, duplication or disclosure restricted by GSA ADP
Schedule Contract with IBM Corp.
Chapter 1. Features of the ICAS Operations Console . . . . . . . .
. . . . . . . . 1
Chapter 2. Installing the ICAS Operations Console . . . . . . . . .
. . . . . . . . 3 Using the provided Apache Tomcat with the ICAS
Operations Console . . . . . . . . . . . . . . . . 3
Add certificates to the JRE keystore. . . . . . . . . . . . . . . .
. . . . . . . . . . . 4 Deploy ICAS Operations Console with the
provided version of Apache Tomcat . . . . . . . . . . . . 4 Create
a user group for the ICAS Operations Console . . . . . . . . . . .
. . . . . . . . . 5 Edit the OpsConfig.xml file . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . 5 Configure Microsoft
Internet Explorer 8 for the ICAS Operations Console . . . . . . . .
. . . . . . 6 Start and log into the ICAS Operations Console . . .
. . . . . . . . . . . . . . . . . . . 6
Using your own version of Apache Tomcat . . . . . . . . . . . . . .
. . . . . . . . . . . 7 Verify JRE user environment variable . . .
. . . . . . . . . . . . . . . . . . . . . . . 7 Add certificates to
the JRE keystore. . . . . . . . . . . . . . . . . . . . . . . . . .
. 7 Deploy the ICAS Operations Console . . . . . . . . . . . . . .
. . . . . . . . . . . . 8 Create a user group for the ICAS
Operations Console . . . . . . . . . . . . . . . . . . . . 9 Edit
the OpsConfig.xml file . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . 9 Configure Microsoft Internet Explorer 8 for the
ICAS Operations Console . . . . . . . . . . . . . 10 Start and log
into the ICAS Operations Console . . . . . . . . . . . . . . . . .
. . . . . 10
Using Websphere 7.0 and 8.0 . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . 11 Import Websphere certificates . . . . . . . .
. . . . . . . . . . . . . . . . . . . . 11 Deploying ICAS
Operations Console on Websphere . . . . . . . . . . . . . . . . . .
. . . 12 Starting the ICAS Operations Console on Websphere . . . .
. . . . . . . . . . . . . . . . 12
Chapter 3. Using the ICAS Operations Console . . . . . . . . . . .
. . . . . . . 13 Display user names. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . 13 Create an Operation Group for
monitoring . . . . . . . . . . . . . . . . . . . . . . . . . 13 Add
an AdminHost and ICAS server name to the ICAS Operations Console .
. . . . . . . . . . . . 13 Set the log file and server numeric
parameters. . . . . . . . . . . . . . . . . . . . . . . . 14
Download or upload the configuration file . . . . . . . . . . . . .
. . . . . . . . . . . . 14 Dynamic reporting using the Monitor
option . . . . . . . . . . . . . . . . . . . . . . . . 15 Health
check indicator. . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . 15 Set a filter . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . 16 Schedule the log file . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Download
the log file . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . 17 View the log file . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . 17
Appendix. Accessibility features. . . . . . . . . . . . . . . . . .
. . . . . . . 19 Keyboard shortcuts . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . 19 IBM and accessibility . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . 21
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . 25
iv IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
Introduction
This document is intended for use with IBM® Cognos® Express®
Xcelerator.
It provides the information you need to install, configure, and use
the IBM Cognos Analytic Server (ICAS) Operations Console. The ICAS
Operations Console is an optional software component used to
monitor the activity of ICAS servers.
Audience
To use this guide, you should be familiar with: v Installation
tasks v Web-server software v Java Runtime Environment (JRE) v ICAS
server operation
Finding information
Accessibility Features
Accessibility features help users who have a physical disability,
such as restricted mobility or limited vision, to use information
technology products. This product has accessibility features. For
information on these features, see “Accessibility features,” on
page 19.
Samples disclaimer
The Great Outdoors Company, GO Sales, any variation of the Great
Outdoors name, and Planning Sample depict fictitious business
operations with sample data used to develop sample applications for
IBM and IBM customers. These fictitious records include sample data
for sales transactions, product distribution, finance, and human
resources. Any resemblance to actual names, addresses, contact
numbers, or transaction values is coincidental. Other sample files
may contain fictional data manually or machine generated, factual
data compiled from academic or public sources, or data used with
permission of the copyright holder, for use as sample data to
develop sample applications. Product names referenced may be the
trademarks of their respective owners. Unauthorized duplication is
prohibited.
Forward-looking statements
This documentation describes the current functionality of the
product. References to items that are not currently available may
be included. No implication of any future availability should be
inferred. Any such references are not a commitment, promise, or
legal obligation to deliver any material, code, or functionality.
The
© Copyright IBM Corp. 2012 v
vi IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
Chapter 1. Features of the ICAS Operations Console
The IBM Cognos Analytic Server Operations Console is an optional
component that Xcelerator administrators can use to generate logs,
monitor multiple server activity, and manage ICAS servers.
The ICAS Operations Console provides the basic server monitoring
functionality provided by the TM1Top utility with some important
additions: v The ICAS Operations Console can monitor multiple ICAS
servers at the same
time. v The Health feature allows for instant feedback on the
current state of servers. v Filtering helps highlight specific
states for multiple servers. v Sorting allows administrators to
quickly identify which servers are in specific
states. v The ICAS Operations Console can use Scheduled Logging to
monitor activity
offline.
You can drag and organize the displays offered by the ICAS
Operations Console
using the Tile options , , and from the toolbar and customize the
reporting using many different attributes and server states. You
can also easily identify and terminate processes using the ICAS
Operations Console.
The ICAS Operations Console is installed as part of the standard
installation and is run from a web browser.
© Copyright IBM Corp. 2012 1
2 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
Chapter 2. Installing the ICAS Operations Console
The IBM Cognos Analytic Server Operations Console is a Java-based
web application that enables Xcelerator administrators to monitor
and take action on ICAS server activity.
Before you begin
The ICAS Operations Console is deployed on a Java-based web
application server such as the version of Apache Tomcat supplied
with the Xcelerator installation. You can instead use your own
version of Apache Tomcat. Determine which way you want to
install.
Before installing the ICAS Operations Console: v Ensure that the
Xcelerator prerequisite software is installed. v Ensure that the
ICAS Admin Server and the ICAS server that you want to
monitor are installed and running. v Ensure that you can start
Xcelerator Architect and can log in as an administrator
to the ICAS server that you want to monitor. v Ensure that Apache
Tomcat is installed and running.
The ICAS Operation Console is selected by default during
installation. You can instead choose to install it on a computer
separate from the computer used for the ICAS server by deselecting
it during the standard installation, then running the installation
on the separate computer and selecting only the ICAS Operations
Console.
Procedure 1. Run the installation from the installation location.
2. Select and install the Web Application Tier > ICAS Operations
Console
component.
Remember: Install Xcelerator components in a directory that
contains only ASCII characters in the path name. Some Windows web
servers do not support non-ASCII characters in directory
names.
What to do next
Follow the instructions for the webserver software you want to use
with the ICAS Operations Console: v “Using the provided Apache
Tomcat with the ICAS Operations Console” v “Using your own version
of Apache Tomcat” on page 7 v “Using Websphere 7.0 and 8.0” on page
11
Using the provided Apache Tomcat with the ICAS Operations Console
Use the following set of steps to install the ICAS Operations
Console if you are using the version of Apache Tomcat provided with
Xcelerator.
© Copyright IBM Corp. 2012 3
Add certificates to the JRE keystore The IBM Cognos Analytic Server
Operations Console requires a certificate in the Java Runtime
Environment (JRE) keystore.
Procedure 1. Run the Java keytool command to import the certificate
into the keystore.
a. Open a command prompt and change to the following directory:
<location> \bin\jre\6.0\bin
where <location> is the file directory where Xcelerator is
installed. CAUTION: On 64-bit computers, be sure to add the
certificates to the bin64 folder.
b. Run the following command line. For formatting purposes the
command is shown here with line breaks but you should enter the
command all on one line. keytool -import -file
"C:\<location>\bin\ssl\applixca.pem" -keystore
"C:\<location>\bin\jre\6.0\lib\security\cacerts" -storepass
"changeit"
For 64-bit installations, target the 64-bit folder when dealing
with the certificates. For example, this sample command targets the
64-bit jre: cd C:\Program Files
(x86)\ibm\cognos\TM1_64\bin64\jre\6.0\bin
The following command is an example used on 64-bit systems. For
formatting purposes this command is shown with line breaks but you
should enter the command all on one line. keytool -import -file
"C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\ ssl\applixca.pem"
-keystore "C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\
jre\6.0\lib\security\cacerts" -storepass "changeit"
If you do not correctly target the 64-bit locations for
certificates when running a 64-bit installation, you receive a
warning message indicating that you cannot contact the
servers.
c. Enter yes when prompted to trust or add the certificate.
The following message displays: Certificate was added to
keystore
2. You may need to restart Apache Tomcat to have the change take
effect.
Remember: Re-add certificates any time you re-install
Xcelerator.
Deploy ICAS Operations Console with the provided version of Apache
Tomcat
Use the IBM Cognos Configuration tool to deploy the IBM Cognos
Analytic Server Operations Console with the version of Apache
Tomcat provided with the Xcelerator installation. The ICAS
Operations Console uses the same version of Tomcat as the IBM
Cognos Xcelerator Application Server.
Before you begin
If you installed the product from the Program Files (x86) directory
on a computer running Microsoft Windows Vista, Windows 7, or
Windows 2008 operating system software, start IBM Cognos
Configuration as an Administrator.
4 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
Procedure 1. Click Start > All Programs > IBM Cognos
Xcelerator > IBM Cognos
Configuration. 2. Right-click Planner Applications and click
Start.
This step starts the version of Tomcat provided with Xcelerator,
and automatically deploys the ICAS Operations Console.
3. Save the configuration data by clicking File > Save. 4. Close
Cognos Configuration by clicking File > Exit.
Create a user group for the ICAS Operations Console The IBM Cognos
Analytic Server (ICAS) Operations Console requires a designated
ICAS user group that you create in Architect.
Procedure 1. Run Express Architect.
Remember: If the ICAS Admin server and the server you want to
monitor have not been started yet, use Cognos Configuration to
start them before running Express Architect.
2. In Express Architect, double-click Xcelerator to see the servers
that are running and available to you.
3. Double-click the server you want to monitor and log into it with
the username and password for that server.
4. Right-click the server and select Security > Clients and
groups to add a new user group specifically for the ICAS Operations
Console.
5. Select Groups > Add new group and enter a group name, such as
monitor or another easily-identifiable name for the ICAS Operations
Console group. You may need to scroll the window to see the new
group that you have just added.
6. Click OK. 7. Assign a user to the new group:
Only these users will be able to log into the ICAS Operations
Console. v For administrator-type users, assign them to the new
group and also to the
built-in SecurityAdmin, and/or the ADMIN group. v If you want the
monitoring user to be a standard user, assign that user to
the
new group and to the ICAS DataAdmin group. See the IBM Cognos
Express Xcelerator Operation Guide for details on assigning
security groups in ICAS.
8. Click OK to return to the Server Explorer. You can close Express
Architect.
Edit the OpsConfig.xml file The IBM Cognos Analytic Server (ICAS)
Operations Console uses an XML file to identify the user group,
server, and admin host to use. Before you can run the ICAS
Operations Console, you need to update this configuration file with
the information that describes your new monitoring group.
Before you begin
Ensure that you added and configured a designated user group in
Express Architect specifically for the ICAS Operations
Console.
Chapter 2. Installing the ICAS Operations Console 5
Procedure 1. Edit the OpsConfig.xml file using an XML or text
editor.
v For the Apache Tomcat provided with the Xcelerator installation,
the file is located here:
ICAS_location\webapps\tm1operationsconsole\WEB-INF\configuration
v If you are using your own version of Apache Tomcat, the file is
located here: C:\Program Files\Apache Software Foundation\Tomcat
6.0\webapps\ tm1operationsconsole\WEB-INF\configuration
2. Update the OpsConfig.xml file with the adminhost, server, and
group names. The following sample OpsConfig.xml file is configured
for the sdata sample ICAS server running on the local computer with
a user group named "monitor." <ops>
<adminhost name="localhost"> <server name =
"sdata">
<group>monitor</group> </server>
Configure Microsoft Internet Explorer 8 for the ICAS Operations
Console
You need to do some additional configuration to use the Microsoft
Internet Explorer 8 web browser with the IBM Cognos Analytic Server
(ICAS) Operations Console.
Procedure 1. In Internet Explorer 8, enable the option to refresh
web pages with every visit. 2. Disable the options for script
debugging.
For more information, see your Microsoft Internet Explorer
documentation.
Start and log into the ICAS Operations Console To run the IBM
Cognos Analytic Server (ICAS) Operations Console enter the URL that
identifies the port and server name for the component.
Procedure 1. In a web browser, type the following web
address:
http://server_name:port_number/tm1operationsconsole
where v server_name is the computer where the ICAS Operations
Console and your
web application server are installed.
Tip: You can use the keyword localhost if you are currently logged
on to the Web server that is running ICAS Application Web. Or you
can use the machine name, domain name, or IP address of the Web
server hosting the application.
v port_number is the port number where your web application server
is running. For the version of Apache Tomcat that is provided with
the ICAS installation, the default port number is 9510.
6 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
Tip: For a different version of Apache Tomcat, open the Apache
Tomcat server.xml file in the C:\Program Files\Apache Software
Foundation\Tomcat 6.0\conf\ location to determine the port setting
that your version of Tomcat is using.
2. On the log in page, enter values for the following fields, and
then click Log In. v ICASAdmin Host
v Server Name
v Group Name
v User Name
v Password Name
Tip: If you receive the error message No server specified in
OpsConfig.xml, check the following: v Ensure that the ICAS server
you configured in the OpsConfig.xml file is
running. v Ensure that you performed the steps to add the
certificates to the Java
Runtime Environment (JRE) keystore for the ICAS Operations Console.
v Ensure that your entered the name of the ICAS Operations Console
user
group accurately in the OpsConfig.xml file. See Chapter 3, “Using
the ICAS Operations Console,” on page 13 to begin using the ICAS
Operations Console.
Using your own version of Apache Tomcat Use the following set of
steps if you are using your own version of Apache Tomcat.
Verify JRE user environment variable ICAS Operations Console needs
the classpath user environment variable set.
If you are using your own installation of Apache Tomcat, verify
that you have the following Windows user environment variable for
the JRE path. v Variable name: classpath v Variable value:
.;C:\Program Files\Java\jre6\bin
If you are using the Tomcat provided with the Xcelerator
installation, the variable is set for you.
Add certificates to the JRE keystore The IBM Cognos Analytic Server
Operations Console requires a certificate in the Java Runtime
Environment (JRE) keystore.
Procedure 1. Run the Java keytool command to import the certificate
into the keystore.
a. Open a command prompt and change to the following directory:
<location> \bin\jre\6.0\bin
where <location> is the file directory where Xcelerator is
installed. CAUTION: On 64-bit computers, be sure to add the
certificates to the bin64 folder.
Chapter 2. Installing the ICAS Operations Console 7
b. Run the following command line. For formatting purposes the
command is shown here with line breaks but you should enter the
command all on one line. keytool -import -file
"C:\<location>\bin\ssl\applixca.pem" -keystore
"C:\<location>\bin\jre\6.0\lib\security\cacerts" -storepass
"changeit"
For 64-bit installations, target the 64-bit folder when dealing
with the certificates. For example, this sample command targets the
64-bit jre: cd C:\Program Files
(x86)\ibm\cognos\TM1_64\bin64\jre\6.0\bin
The following command is an example used on 64-bit systems. For
formatting purposes this command is shown with line breaks but you
should enter the command all on one line. keytool -import -file
"C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\ ssl\applixca.pem"
-keystore "C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\
jre\6.0\lib\security\cacerts" -storepass "changeit"
If you do not correctly target the 64-bit locations for
certificates when running a 64-bit installation, you receive a
warning message indicating that you cannot contact the
servers.
c. Enter yes when prompted to trust or add the certificate.
The following message displays: Certificate was added to
keystore
2. You may need to restart Apache Tomcat to have the change take
effect.
Remember: Re-add certificates any time you re-install
Xcelerator.
Deploy the ICAS Operations Console Before you can start using the
IBM Cognos Analytic Server (ICAS) Operations Console, you must
deploy it to Apache Tomcat.
Before you begin v Start an instance of Apache Tomcat on the
computer where you want to deploy
the ICAS Operations Console. v Ensure that you can access the
Apache Tomcat Manager console. v If you have not used Tomcat
Manager before, add a user and role to the
tomcat-users.xml file before you can log in. For more information,
see your Apache Tomcat documentation.
Procedure 1. With Apache Tomcat running, click Start > Programs
> Tomcat Manager. Enter
the username and password if they are required by your Apache
Tomcat instance.
2. In Tomcat Manager, scroll down to the Deploy section and locate
the WAR file to deploy subsection. CAUTION: If an earlier version
of the ICAS Operations Console has already been deployed, use the
undeploy option in Tomcat Manager to undeploy the earlier
version.
3. Click Browse to locate the ICAS Operations Console web
application archive file, tm1operationsconsole.war. The typical
location of this file is
install_location/webapps/tm1operationsconsole.war
4. Click OK. 5. In Tomcat Manager, click Deploy.
8 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
When the deployment is complete, the ICAS Operations Console
displays as /tm1operationsconsole in the Applications section of
Tomcat Manager.
Create a user group for the ICAS Operations Console The IBM Cognos
Analytic Server (ICAS) Operations Console requires a designated
ICAS user group that you create in Architect.
Procedure 1. Run Express Architect.
Remember: If the ICAS Admin server and the server you want to
monitor have not been started yet, use Cognos Configuration to
start them before running Express Architect.
2. In Express Architect, double-click Xcelerator to see the servers
that are running and available to you.
3. Double-click the server you want to monitor and log into it with
the username and password for that server.
4. Right-click the server and select Security > Clients and
groups to add a new user group specifically for the ICAS Operations
Console.
5. Select Groups > Add new group and enter a group name, such as
monitor or another easily-identifiable name for the ICAS Operations
Console group. You may need to scroll the window to see the new
group that you have just added.
6. Click OK. 7. Assign a user to the new group:
Only these users will be able to log into the ICAS Operations
Console. v For administrator-type users, assign them to the new
group and also to the
built-in SecurityAdmin, and/or the ADMIN group. v If you want the
monitoring user to be a standard user, assign that user to
the
new group and to the ICAS DataAdmin group. See the IBM Cognos
Express Xcelerator Operation Guide for details on assigning
security groups in ICAS.
8. Click OK to return to the Server Explorer. You can close Express
Architect.
Edit the OpsConfig.xml file The IBM Cognos Analytic Server (ICAS)
Operations Console uses an XML file to identify the user group,
server, and admin host to use. Before you can run the ICAS
Operations Console, you need to update this configuration file with
the information that describes your new monitoring group.
Before you begin
Ensure that you added and configured a designated user group in
Express Architect specifically for the ICAS Operations
Console.
Procedure 1. Edit the OpsConfig.xml file using an XML or text
editor.
v For the Apache Tomcat provided with the Xcelerator installation,
the file is located here:
ICAS_location\webapps\tm1operationsconsole\WEB-INF\configuration
v If you are using your own version of Apache Tomcat, the file is
located here:
Chapter 2. Installing the ICAS Operations Console 9
C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\
tm1operationsconsole\WEB-INF\configuration
2. Update the OpsConfig.xml file with the adminhost, server, and
group names. The following sample OpsConfig.xml file is configured
for the sdata sample ICAS server running on the local computer with
a user group named "monitor." <ops>
<adminhost name="localhost"> <server name =
"sdata">
<group>monitor</group> </server>
Configure Microsoft Internet Explorer 8 for the ICAS Operations
Console
You need to do some additional configuration to use the Microsoft
Internet Explorer 8 web browser with the IBM Cognos Analytic Server
(ICAS) Operations Console.
Procedure 1. In Internet Explorer 8, enable the option to refresh
web pages with every visit. 2. Disable the options for script
debugging.
For more information, see your Microsoft Internet Explorer
documentation.
Start and log into the ICAS Operations Console To run the IBM
Cognos Analytic Server (ICAS) Operations Console enter the URL that
identifies the port and server name for the component.
Procedure 1. In a web browser, type the following web
address:
http://server_name:port_number/tm1operationsconsole
where v server_name is the computer where the ICAS Operations
Console and your
web application server are installed.
Tip: You can use the keyword localhost if you are currently logged
on to the Web server that is running ICAS Application Web. Or you
can use the machine name, domain name, or IP address of the Web
server hosting the application.
v port_number is the port number where your web application server
is running. For the version of Apache Tomcat that is provided with
the ICAS installation, the default port number is 9510.
Tip: For a different version of Apache Tomcat, open the Apache
Tomcat server.xml file in the C:\Program Files\Apache Software
Foundation\Tomcat 6.0\conf\ location to determine the port setting
that your version of Tomcat is using.
2. On the log in page, enter values for the following fields, and
then click Log In. v ICASAdmin Host
v Server Name
v Group Name
10 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
v User Name
v Password Name
Tip: If you receive the error message No server specified in
OpsConfig.xml, check the following: v Ensure that the ICAS server
you configured in the OpsConfig.xml file is
running. v Ensure that you performed the steps to add the
certificates to the Java
Runtime Environment (JRE) keystore for the ICAS Operations Console.
v Ensure that your entered the name of the ICAS Operations Console
user
group accurately in the OpsConfig.xml file. See Chapter 3, “Using
the ICAS Operations Console,” on page 13 to begin using the ICAS
Operations Console.
Using Websphere 7.0 and 8.0 You can install the IBM Cognos Analytic
Server (ICAS) Operation Console on Websphere.
Import Websphere certificates Follow these steps to import the
certificates you need to run the IBM Cognos Analytic Server (ICAS)
Operations Console on IBM Websphere.
Procedure 1. Open the Websphere Admin Console. 2. In Websphere
Administration Console, go to Security > SSL certificates
and
key management Configuration settings, select Manage endpoint
security configurations .
3. Select the appropriate Outbound Configuration to get to the
cell, then click Node.
4. At Related Items, click Key stores and certificates and click
NodeDefaultTrustStore keystore.
5. At Additional Properties, click Signer certificates and Retrieve
from Port.
6. Define the ICAS Admin settings. a. Hostname: Enter the name of
the computer where the ICAS Admin Server
is running. b. Port: 5498 c. Alias: <an alias for this
field>.
d. Click Retrieve Signer Information. e. Verify that the
certificate information is for a certificate that you can trust. f.
Click Apply and Save to save the Master Configuration.
7. After you have successfully saved the Master Configuration for
the ICAS Admin server, use the same screen to define the settings
for the ICAS Server: a. Hostname: Enter the name of the computer
where ICAS is running. b. Port: enter the port number listed in
this server's tm1s.cfg file. c. Alias: <an alias for this
field>.
d. Click Retrieve Signer Information.
e. Verify that the certificate information is for a certificate
that you can trust. f. Click Apply and Save to save the Master
Configuration again.
Chapter 2. Installing the ICAS Operations Console 11
Deploying ICAS Operations Console on Websphere Follow these steps
to deploy the IBM Cognos Analytic Server (ICAS) Operations Console
on an IBM Websphere web server.
Before you begin
See the Websphere documentation for details on using IBM
Websphere.
Before deploying, ensure that the ICAS Operations Console was
installed when you installed Xcelerator. ICAS Operations Console is
a Web Application component that is selected by default. If you did
not install it, you can re-run the installation and select only the
ICAS Operations Console to install only that component.
After installation, determine the location of the tm1operations.war
file which is usually in
C:/<installation_location>/webapps
Procedure 1. Open and log into the Websphere Administrative
Console. 2. In the right pane under Applications , click New
Application > New
Enterprise Application. 3. Specify the address of the
tm1operationsconsole.war file and click Next. 4. Select Fast path
and click Next. 5. In Select Install Applications, accept the
defaults by clicking Next. 6. In Map Module to Servers, select the
server(s) where you want to install the
modules that are in your application and click Next. 7. In Map
Virtual Hosts For Web Modules, specify the virtual host where
you
want to install the Web modules that are in your application and
click Next. 8. In Map Context Roots For Web Modules, enter the
Context Root as
/tm1operationsconsole
9. Click Save to save the Master Configuration. 10. Add a
monitoring user group in Xcelerator. See “Create a user group for
the
ICAS Operations Console” on page 5 for details. 11. Edit the
OpsConfig.xml file. See “Edit the OpsConfig.xml file” on page 5
for
details.
Starting the ICAS Operations Console on Websphere After adding
certificates and deploying the IBM Cognos Analytic Server (ICAS)
Operations Console, start it from a web browser.
Procedure 1. In the Websphere Enterprise Application, check the
tm1operationsconsole.war
2. Click Start. 3. Open a web browser. 4. Enter the URL for the
ICAS Operations Console, for example,
http://localhost:9080/tm1operationsconsole/
12 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
Chapter 3. Using the ICAS Operations Console
After installation and configuration, run the IBM Cognos Analytic
Server Operations Console from a web browser.
The first time you use it you need to set up some organization
structures to identify the servers being monitored.
Display user names The MaskUserNameInServerTools parameter
determines if user names are displayed or masked out in the IBM
Cognos Analytic Server Operations Console displays.
When MaskUserNameInServerTools=TRUE is set in the Tm1s.cfg, user
names are masked in the ICAS Operations Console for security
purposes. To unmask the names, the administrator can right-click
the server in the ICAS Operations Console and then click
Authenticate to verify the administrator status.
This parameter is set to FALSE by default. If you do not explicitly
set this parameter to TRUE, the ICAS Operations Console displays
user names even when administrator access has not been
verified.
Create an Operation Group for monitoring Before you can monitor a
IBM Cognos Analytic Server server using the ICAS Operations
Console, define a logical grouping for the servers being
monitored.
For example, you might have a group of servers designated as
"Development," "Production," or "Test."
To add a new Operation Group:
1. Click the operation group icon from the toolbar or use the
Action menu to select Add Operation Group.
2. Enter a name for the group. 3. Click Create.
After the group is created, use the right-click or Action button
option to add the AdminHost and ICAS server name.
After the group is defined, use the log file options to design the
way you want to monitor the servers.
Add an AdminHost and ICAS server name to the ICAS Operations
Console
To identify the IBM Cognos Analytic Server server to the ICAS
Operations Console, add it to the database instance.
About this task
After you have added a Database Instance, you can identify the
AdminHost.
© Copyright IBM Corp. 2012 13
Procedure 1. Right-click the database instance and select Add
Adminhost
2. Enter the fully-qualified name of the AdminHost. 3. Click
OK
Results
The Adminhost is identified. Once the AdminHost is in the tree, you
can select it and right-click to add the name of the ICAS server
running on that host that you want to monitor.
Set the log file and server numeric parameters Use the Configure
option to set the numeric parameters that define how the log file
numerics and other server parameters are gathered.
Complete the following parameters for each log file.
Log period
Specifies the time interval between updates being written to the
log file.
For example, if the screen Refresh is set to 2 seconds, LogPeriod
could be set to 10 seconds so that every fifth screen display will
be output to decrease the amount of data written to the file.
Default is 2 seconds.
Log Append
By default a new log file is not appended, it overwrites the
existing log. Select True to append new logfiles to the existing
log.
Refresh period By default, the log waits 2 seconds before
refreshing the data. You can enter a longer or shorter time for the
refresh here in seconds.
Tolerance factor By default, the data is new (0). To permit data in
the log to be older, enter a number here in seconds for how old the
data can be before requiring a new polling.
Time Out By default, attempts to connect to the server end after 2
seconds. You can change this number to shorten or lengthen the time
the log will keep trying before giving up.
If the IBM Cognos Analytic Server Operations Console server does
not get the updated status in the seconds specified here, then the
old data (if it exists) is sent with an indication that a timeout
has occurred.
Download or upload the configuration file To make changes to the
tm1operationsconsole.xml file, you can use the Upload and Download
options.
Once you have populated the IBM Cognos Analytic Server Environment
pane with the configuration file, you can use the Upload and
Download options to make changes to the configuration. You can also
include sample data for a configuration file using these
commands.
14 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
When you choose Upload , you can browse to the location of the
configuration file and click OK.
Choose Download to see the configuration file as an xml file that
you can save on your local machine.
Dynamic reporting using the Monitor option The Monitor option on
the IBM Cognos Analytic Server Operations Console opens a
dynamically-refreshed display of the server activity that can be
further focused using the Filter settings.
The Monitor option displays general status, sandboxes, or sandbox
queue information dynamically based on the log file parameters you
have chosen. You can also combine these windows to monitor
different kinds of activity at the same time. Use the Filter dialog
box to focus the displays to specific kinds of activity, for
example, to only processes in a run state.
When there are processes displayed, you can right-click a process
to select Kill process to terminate the process.
To sort the display by a particular column, click the column
heading so that an arrow displays. Up arrow sorts on that column
heading; down arrow is the default sort.
The Health check gives an instant indication of the server's
status.
Status
By default the Status choice shows all states and lists the ID,
User, State, Function, Object Lock Status, User Lock Status, and
Time.
For Threads, you can monitor the Threads in Use, Queue Depth,
Average Queue Time, Dequeue Delta, Queue Time Delta, and API Calls
Delta.
Sandbox By default the Sandbox lists the ID, User, Active Sandbox,
Total Sandbox Memory and the Number of Sandboxes.
Sandbox Queue By default the Sandbox Queue lists the ID, Name,
User, Node Name, Status, and Time in Queue.
Health check indicator The Health check indicator provides almost
instant feedback on the status of the server.
The following list shows the indicators available:
Online Server is online. This server is running.
Starting The server is starting.
Chapter 3. Using the ICAS Operations Console 15
BulkLoad Mode Server is in BulkLoadMode.
Busy Server is busy. Server may be starting, stopping, be in Bulk
Load Mode, or no response was received from the server.
Offline Server is offline/not able to contact. This server is not
running or has been unable to connect to the ICAS Operations
Console.
Stopping Server is in the process of stopping.
Unsupported Server is unsupported. The health check is not
available for servers running a ICAS version prior to the 10.1.0
release.
The Health Check also displays the number of threads in the server
and the number of threads waiting for a lock to be granted.
Since the health status is updated every 10 seconds, the
information is current to within 10 seconds or less depending on
when the server status changed since the last refresh
If the report contains a refresh rate, the data is updated at the
refresh rate specified for that report.
Set a filter The Filters dialog box lets you focus the type of
activity shown in the Status display.
You can filter displays by specific threads or by their specific
states to quickly identify activity.
By default all states are shown in the status display. Check one or
many of these choices to focus on the state shown: Idle, Run,
Commit, Rollback, Wait, Login, Finish.
You can also focus the Thread information by System, Chores, and
User Threads.
Report columns can be sorted to allow faster identification of busy
servers.
Schedule the log file You can define the schedule for how often the
log file runs.
To schedule a new log file event, right-click the server in the IBM
Cognos Analytic Server Environment pane and select Logging
Scheduler.
By default the logging is set to Disable Logging. Automated Logging
generates a log file for whatever activity is taking place at that
time for the amount of time that the monitor window is open.
16 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
To examine or create a customized logging schedule, click Scheduled
Logging and complete the dialog box with the details for the start
and stop times of your logging schedule.
Log type Choose Status, Sandbox, or Sandbox Queue
Log Separately By default each log for status, sandbox, and sandbox
status is maintained separately. Choose False to combine all these
logs into a common file.
Remember: When Log Separately is True, the downloaded log option
provides that type of log file. When Log Separately is False, the
common log file is downloaded.
Log Duration Click the Start Date, Start Time, Stop Date, and Stop
Time to open a calendar to help set these parameters for when the
log is run.
Once you have a log event scheduled, you can use this dialog box to
edit or delete it.
Download the log file The Download option generates a text version
of the log file, similar to the TM1Top output.
Choose which type of log to download: Status, Sandbox, or Sandbox
Queue.
View the log file The View Log option provides a compact, static
snapshot of the log.
Choose which type of log to view: Status, Sandbox, or Sandbox
Queue.
Chapter 3. Using the ICAS Operations Console 17
18 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
Appendix. Accessibility features
Accessibility features help users who have a physical disability,
such as restricted mobility or limited vision, to use information
technology products.
Keyboard shortcuts Standard Microsoft Windows navigation keys are
used in addition to application-specific keys.
You can use keyboard shortcuts to navigate through the application
and perform tasks. If you are using a screen reader, you might want
to maximize your window so the keyboard shortcut table is
completely expanded and accessible.
Note: The following keyboard shortcuts are based on US standard
keyboards.
Table 1. Keyboard shortcuts
Enter
Close an object or pane that is closable Ctrl+F4
Go to the first item or object; Go Home Home
Go to the last item or object; Go to the End End
Move forward through the panes of the application
F6
Shift+F6
F10
Move to the next item in the tab index order at the same level;
cycle to the first tab index when you are at the end
Tab
Move to the previous item in the tab index order at the same level;
cycle to the last tab index when you are at the beginning
Shift+Tab
Toggle on or off Space bar
Move to the next option button and select it Right arrow, Down
arrow
Move to the previous option button and select it
Up arrow, Left arrow
Down arrow
Close an open drop-down list Esc
Move to the next selectable node after the current node. If the
node that you select has children nodes and is expanded, go to the
first child node
Down arrow
© Copyright IBM Corp. 2012 19
Table 1. Keyboard shortcuts (continued)
Action Shortcut key
Expand the current selection if it is not expanded. If the node is
expanded, go to the first child node
Right arrow and plus sign
Collapse the current selection if it is expanded. If the node is
collapsed, go to the parent node before the current selection
Left arrow and minus sign
Expand the children menu items Right arrow
Collapse the children menu items Left arrow
Open a context menu Right-click key
Close an open context menu Esc
Scroll down Down arrow or Page Down
Scroll up Up arrow or Page Up
Move to the next widget in the tab index order at the same level in
the canvas
Tab
Move to the previous widget in the tab index order at the same
level in the canvas
Shift+Tab
Tile vertically Alt+Q
Tile horizontally Alt+W
Box tile Alt+E
Refresh the tree Alt+R
IBM and accessibility See the IBM Accessibility Center for more
information about the commitment that IBM has to
accessibility.
IBM Accessibility Center(www.ibm.com/able)
20 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
This information was developed for products and services offered
worldwide.
IBM may not offer the products, services, or features discussed in
this document in other countries. Consult your local IBM
representative for information on the products and services
currently available in your area. Any reference to an IBM product,
program, or service is not intended to state or imply that only
that IBM product, program, or service may be used. Any functionally
equivalent product, program, or service that does not infringe any
IBM intellectual property right may be used instead. However, it is
the user's responsibility to evaluate and verify the operation of
any non-IBM product, program, or service. This document may
describe products, services, or features that are not included in
the Program or license entitlement that you have purchased.
IBM may have patents or pending patent applications covering
subject matter described in this document. The furnishing of this
document does not grant you any license to these patents. You can
send license inquiries, in writing, to:
IBM Director of Licensing IBM Corporation North Castle Drive
Armonk, NY 10504-1785 U.S.A.
For license inquiries regarding double-byte (DBCS) information,
contact the IBM Intellectual Property Department in your country or
send inquiries, in writing, to:
Intellectual Property Licensing Legal and Intellectual Property Law
IBM Japan Ltd. 1623-14, Shimotsuruma, Yamato-shi Kanagawa 242-8502
Japan
The following paragraph does not apply to the United Kingdom or any
other country where such provisions are inconsistent with local
law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Some states do not allow disclaimer of express or implied
warranties in certain transactions, therefore, this statement may
not apply to you.
This information could include technical inaccuracies or
typographical errors. Changes are periodically made to the
information herein; these changes will be incorporated in new
editions of the publication. IBM may make improvements and/or
changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are
provided for convenience only and do not in any manner serve as an
endorsement of those Web sites. The materials at those Web sites
are not part of the materials for this IBM product and use of those
Web sites is at your own risk.
© Copyright IBM Corp. 2012 21
IBM may use or distribute any of the information you supply in any
way it believes appropriate without incurring any obligation to
you.
Licensees of this program who wish to have information about it for
the purpose of enabling: (i) the exchange of information between
independently created programs and other programs (including this
one) and (ii) the mutual use of the information which has been
exchanged, should contact:
IBM Software Group Attention: Licensing 3755 Riverside Dr Ottawa,
ON K1V 1B7 Canada
Such information may be available, subject to appropriate terms and
conditions, including in some cases, payment of a fee.
The licensed program described in this document and all licensed
material available for it are provided by IBM under terms of the
IBM Customer Agreement, IBM International Program License Agreement
or any equivalent agreement between us.
Any performance data contained herein was determined in a
controlled environment. Therefore, the results obtained in other
operating environments may vary significantly. Some measurements
may have been made on development-level systems and there is no
guarantee that these measurements will be the same on generally
available systems. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of
this document should verify the applicable data for their specific
environment.
Information concerning non-IBM products was obtained from the
suppliers of those products, their published announcements or other
publicly available sources. IBM has not tested those products and
cannot confirm the accuracy of performance, compatibility or any
other claims related to non-IBM products. Questions on the
capabilities of non-IBM products should be addressed to the
suppliers of those products.
All statements regarding IBM's future direction or intent are
subject to change or withdrawal without notice, and represent goals
and objectives only.
This information contains examples of data and reports used in
daily business operations. To illustrate them as completely as
possible, the examples include the names of individuals, companies,
brands, and products. All of these names are fictitious and any
similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
If you are viewing this information softcopy, the photographs and
color illustrations may not appear.
22 IBM Cognos Analytic Server Version 10.1.0: Operations Console
Guide
Trademarks
IBM, the IBM logo, ibm.com, TM1, Express, and Cognos are trademarks
or registered trademarks of International Business Machines Corp.,
registered in many jurisdictions worldwide. Other product and
service names might be trademarks of IBM or other companies. A
current list of IBM trademarks is available on the Web at “
Copyright and trademark information ” at www.ibm.com/legal/
copytrade.shtml.
The following terms are trademarks or registered trademarks of
other companies: v Adobe, the Adobe logo, PostScript, and the
PostScript logo are either registered
trademarks or trademarks of Adobe Systems Incorporated in the
United States, and/or other countries.
v Microsoft, Windows, Windows NT, and the Windows logo are
trademarks of Microsoft Corporation in the United States, other
countries, or both.
v Linux is a registered trademark of Linus Torvalds in the United
States, other countries, or both.
v UNIX is a registered trademark of The Open Group in the United
States and other countries.
v Java and all Java-based trademarks and logos are trademarks or
registered trademarks of Oracle and/or its affiliates.
Notices 23
Index
A accessibility 19, 20
C classpath 7
D deploying
ICAS Operations Console 4, 8 Display user names 13 download
configuration 14 download log 17
F Filters 16
H health check 15
I ICAS Operation Console 11 ICAS operations console 13 ICAS
Operations Console 4, 7, 12
adding certificates 4, 7 creating user groups 5, 9 installing 3
logging into 6, 10 Microsoft Internet Explorer 8 6, 10
OpsConfig.xml file 5, 9 starting 4, 6, 10
K keyboard shortcuts
M MaskUserNameInServerTools parameter 13 monitor 15
N numeric parameters 14
O on Websphere 11 operation group 13 Operations Console 1
S schedule log 16 servername 13 starting
ICAS Operations Console 6, 10 Starting 12
U upload configuration 14 user group for TM1 Operations Console 5,
9 user groups for ICAS Operations Console 5, 9
V view log 17
Contents
Introduction
Chapter 2. Installing the ICAS Operations Console
Using the provided Apache Tomcat with the ICAS Operations
Console
Add certificates to the JRE keystore
Deploy ICAS Operations Console with the provided version of Apache
Tomcat
Create a user group for the ICAS Operations Console
Edit the OpsConfig.xml file
Configure Microsoft Internet Explorer 8 for the ICAS Operations
Console
Start and log into the ICAS Operations Console
Using your own version of Apache Tomcat
Verify JRE user environment variable
Add certificates to the JRE keystore
Deploy the ICAS Operations Console
Create a user group for the ICAS Operations Console
Edit the OpsConfig.xml file
Configure Microsoft Internet Explorer 8 for the ICAS Operations
Console
Start and log into the ICAS Operations Console
Using Websphere 7.0 and 8.0
Import Websphere certificates
Starting the ICAS Operations Console on Websphere
Chapter 3. Using the ICAS Operations Console
Display user names
Create an Operation Group for monitoring
Add an AdminHost and ICAS server name to the ICAS Operations
Console
Set the log file and server numeric parameters
Download or upload the configuration file
Dynamic reporting using the Monitor option
Health check indicator
Set a filter