06.TM1 Operations Console Guide 10.1.1

TM1 Operations Console Guide 10.1.1

Contents

1. Introduction

2. New features in the Cognos TM1 10.1.1 Operations Console Guide

3. Features of the Cognos TM1 Operations Console

4. Installing the Cognos TM1 Operations Console

4.1. Using the provided Apache Tomcat with the Cognos TM1 Operations Console

4.1.1. Add certificates to the JRE keystore

4.1.2. Deploy Cognos TM1 Operations Console with the provided version of Apache Tomcat

4.1.3. Create a user group for the Cognos TM1 Operations Console

4.1.4. Edit the OpsConfig.xml file

4.1.5. Configure Microsoft Internet Explorer 8 for the Cognos TM1 Operations Console

4.1.6. Start and log into the Cognos TM1 Operations Console

4.2. Using your own version of Apache Tomcat

4.2.1. Verify JRE user environment variable


4.2.3. Deploy the Cognos TM1 Operations Console

4.2.4. Create a user group for the Cognos TM1 Operations Console

4.2.5. Edit the OpsConfig.xml file



4.3. Using Websphere 7.0 and 8.0

4.3.1. Import Websphere certificates

4.3.2. Deploying Cognos TM1 Operations Console on Websphere

4.3.3. Starting the Cognos TM1 Operations Console on Websphere

5. Using the Cognos TM1 Operations Console

5.1. Display user names

5.2. Create an Operation Group for monitoring

5.3. Add an AdminHost and Cognos TM1 server name to the Cognos TM1 Operations Console

5.4. Set the log file and server numeric parameters

5.5. Download or upload the configuration file

5.6. Dynamic reporting using the Monitor option

5.7. Health check indicator

5.8. Health status tab

5.9. Monitor server memory and performance data

5.10. Set a filter

5.11. Schedule the log file

5.12. Download the log file

5.13. View the log file

6. Accessibility features

6.1. Keyboard shortcuts

6.2. IBM and accessibility

7. Notices

7.1. ©

TM1 Operations Console Guide 10.1.1 http://pic.dhe.ibm.com/infocenter/ctm1/v10r1m0/advanced/print.jsp?topi...

1 of 38 26-09-2014 11:23

1. IntroductionThis document is intended for use with IBM® Cognos® TM1® .

It provides the information you need to install, configure, and use the Cognos TM1 Operations Console. The Cognos TM1 Operations Console is an optional

software component used to monitor the activity of Cognos TM1 servers.

Audience

To use this guide, you should be familiar with:

Installation tasks

Web-server software

Java(tm) Runtime Environment (JRE)

Cognos TM1 server operation

Finding information

To find IBM Cognos product documentation on the web, including all translated documentation, access one of the IBM Cognos Information Centers

(http://publib.boulder.ibm.com/infocenter/cogic/v1r0m0/index.jsp). Release Notes are published directly to Information Centers, and include links to the latest

technotes and APARs.

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.

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 development, release, and timing of features or functionality remain at the sole discretion of IBM.


2 of 38 26-09-2014 11:23

2. New features in the Cognos TM1 10.1.1 Operations Console Guide

This release enhances many of the monitoring capabilities of the Cognos® TM1® Operations Console.

Monitor Cognos TM1 server memory and performance information

Cognos TM1 system memory and performance statistics are now available through the Cognos TM1 Operations Console.

See Monitor server memory and performance data.

Instant server health check across all monitored servers

The Cognos TM1 Operations Console Health Status tab shows the current status of all Cognos TM1 servers in the tree using the Health Check icons.

See Health status tab.

Filtering log messages

Administrators can now filter the types of messages included in the Cognos TM1 Operations Console logs to eliminate repetitive or unwanted messages and

control the log file size.

See Schedule the log file.


3 of 38 26-09-2014 11:23

3. Features of the Cognos TM1 Operations ConsoleThe IBM® Cognos® TM1® Operations Console is an optional component that IBM Cognos TM1 administrators can use to generate logs, monitor multiple server

activity, and manage Cognos TM1 servers.

The Cognos TM1 Operations Console provides the basic server monitoring functionality provided by the TM1Top utility with some important additions:

The Cognos TM1 Operations Console can monitor multiple Cognos TM1 servers at the same time.

The Health Status tabs allows for instant feedback on the current state of multiple servers.

Filtering helps highlight specific states for multiple servers.

Sorting allows administrators to quickly identify which servers are in specific states.

The Cognos TM1 Operations Console can use Scheduled Logging to monitor activity offline.

The following sample show multiple servers being monitored in the Cognos TM1 Operations Console:

The following graphic shows that multiple states can be shown for the logs reports.

You can drag and organize the displays offered by the Cognos TM1 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 Cognos TM1 Operations Console.

The Cognos TM1 Operations Console is installed as part of the standard installation and is run from a web browser.


4 of 38 26-09-2014 11:23

4. Installing the Cognos TM1 Operations ConsoleThe IBM® Cognos® TM1® Operations Console is a Java-based web application that enables Cognos TM1 administrators to monitor and take action on Cognos

TM1 server activity.

Before you begin

The Cognos TM1 Operations Console is deployed on a Java-based web application server such as the version of Apache Tomcat supplied with the Cognos TM1

installation. You can instead use your own version of Apache Tomcat. Determine which way you want to install.

Before installing the Cognos TM1 Operations Console:

Ensure that the Cognos TM1 prerequisite software is installed.

Ensure that the Cognos TM1 Admin Server and the Cognos TM1 server that you want to monitor are installed and running.

Ensure that you can start Cognos TM1 Architect and can log in as an administrator to the Cognos TM1 server that you want to monitor.

If you are not planning to use the version of Apache Tomcat provided with Cognos TM1, ensure that you have your own version of a supported web

application server installed and running.

The Cognos TM1 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 Cognos TM1 server by deselecting it during the standard installation, then running the installation on the separate computer and selecting only the

Cognos TM1 Operations Console.

Procedure

On Microsoft Windows Vista, Windows 7 or Windows Server 2008 operating system software, right-click the issetup.exe command and click Run as

Administrator. For other operating systems, double-click the issetup.exe file on the IBMCognosTM1 installation disk or from the location where the

CognosTM1 installation files were downloaded and extracted.

1.

Select and install the Web Application Tier > Cognos TM1 Operations Console component.

Remember: Install IBM Cognos TM1 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.

2.

What to do next

Follow the instructions for the web server software you want to use with the Cognos TM1 Operations Console:

Using the provided Apache Tomcat with the Cognos TM1 Operations Console

Using your own version of Apache Tomcat

Using Websphere 7.0 and 8.0

Using the provided Apache Tomcat with the Cognos TM1 Operations Console

Use the following set of steps to install the IBM Cognos TM1 Operations Console if you are using the version of Apache Tomcat provided with Cognos TM1 .

Using your own version of Apache Tomcat

Use the following set of steps if you are using your own version of Apache Tomcat.

Using Websphere 7.0 and 8.0

You can install the IBM Cognos TM1 Operation Console on Websphere.


5 of 38 26-09-2014 11:23

4.1. Using the provided Apache Tomcat with the Cognos TM1 Operations Console

Use the following set of steps to install the IBM® Cognos® TM1® Operations Console if you are using the version of Apache Tomcat provided with Cognos TM1 .

Add certificates to the JRE keystore

The IBM Cognos TM1 Operations Console requires a certificate in the Java™ Runtime Environment (JRE) keystore.

Deploy Cognos TM1 Operations Console with the provided version of Apache Tomcat

Use the IBM Cognos Configuration tool to deploy the IBM Cognos TM1 Operations Console with the version of Apache Tomcat provided with the Cognos TM1

installation. The Cognos TM1 Operations Console uses the same version of Tomcat as the IBM Cognos TM1 Application Server.

Create a user group for the Cognos TM1 Operations Console

The IBM Cognos TM1 Operations Console requires a designated Cognos TM1 user group that you create in Cognos TM1 Architect.

Edit the OpsConfig.xml file

The IBM Cognos TM1 Operations Console uses an XML file for authentication to identify the user group, server, and admin host to use. Before you can run

the Cognos TM1 Operations Console, you need to update this configuration file with the information that describes your new monitoring group.

Configure Microsoft Internet Explorer 8 for the Cognos TM1 Operations Console

You need to do some additional configuration to use the Microsoft Internet Explorer 8 web browser with the IBM Cognos TM1 Operations Console.

Start and log into the Cognos TM1 Operations Console

To run the IBM Cognos TM1 Operations Console enter the URL that identifies the port and server name for the component.

Parent topic: Installing the Cognos TM1 Operations Console


6 of 38 26-09-2014 11:23


The IBM® Cognos® TM1® Operations Console requires a certificate in the Java™ Runtime Environment (JRE) keystore.

Procedure

Run the Java keytool command to import the certificate into the keystore.

Open a command prompt and change to the following directory:

location \bin\jre\6.0\bin

where location is the file directory where Cognos TM1 is installed.

CAUTION:

On 64-bit computers, be sure to add the certificates to the bin64 folder.

a.

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.

b.

Enter yes when prompted to trust or add the certificate.c.

The following message displays: Certificate was added to keystore

1.

You may need to restart Apache Tomcat to have the change take effect.

Remember: Re-add certificates any time you re-install Cognos TM1 .

2.

Parent topic: Using the provided Apache Tomcat with the Cognos TM1 Operations Console

Parent topic: Using your own version of Apache Tomcat


7 of 38 26-09-2014 11:23

4.1.2. Deploy Cognos TM1 Operations Console with the provided version of Apache Tomcat

Use the IBM® Cognos® Configuration tool to deploy the IBM Cognos TM1® Operations Console with the version of Apache Tomcat provided with the Cognos

TM1 installation. The Cognos TM1 Operations Console uses the same version of Tomcat as the IBM Cognos TM1 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.

Procedure

Click Start > All Programs > IBM Cognos TM1 > IBM Cognos Configuration.1.

Right-click TM1 Applications and click Start.

This step starts the version of Tomcat provided with Cognos TM1 , and automatically deploys the Cognos TM1 Operations Console.

2.

Save the configuration data by clicking File > Save.3.

Close Cognos Configuration by clicking File > Exit.4.



8 of 38 26-09-2014 11:23

4.1.3. Create a user group for the Cognos TM1 Operations ConsoleThe IBM® Cognos® TM1® Operations Console requires a designated Cognos TM1 user group that you create in Cognos TM1 Architect.

Procedure

Run Cognos TM1 Architect.

Remember: If the TM1 Admin server and the server you want to monitor have not been started yet, use Cognos Configuration to start them before running

Cognos TM1 Architect.

1.

In Cognos TM1 Architect, double-click TM1 to see the servers that are running and available to you.2.

Double-click the server you want to monitor and log into it with the username and password for that server.3.

Right-click the server and select Security > Clients and groups to add a new user group specifically for the Cognos TM1 Operations Console.4.

Select Groups > Add new group and enter a group name, such as monitor or another easily-identifiable name for the Cognos TM1 Operations Console

group.

You may need to scroll the window to see the new group that you have just added.

5.

Click OK.6.

Assign a user to the new group:

Only these users will be able to log into the Cognos TM1 Operations Console.

For administrator-type users, assign them to the new group and also to the built-in SecurityAdmin, and/or the ADMIN group.

If you want the monitoring user to be a standard user, assign that user to the new group and to the Cognos TM1 DataAdmin group.

See the IBM Cognos TM1 Operation Guide for details on assigning security groups in Cognos TM1 .

7.

Click OK to return to the Server Explorer. You can close Cognos TM1 Architect.8.




9 of 38 26-09-2014 11:23

4.1.4. Edit the OpsConfig.xml fileThe IBM® Cognos® TM1® Operations Console uses an XML file for authentication to identify the user group, server, and admin host to use. Before you can run


Before you begin

Ensure that you added and configured a designated user group in Cognos TM1 Architect specifically for the Cognos TM1 Operations Console.

Procedure

Edit the OpsConfig.xml file using an XML or text editor.

For the Apache Tomcat provided with the Cognos TM1 installation, the file is located here:

TM1_location\webapps\tm1operationsconsole\WEB-INF\configuration

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

1.

Update the OpsConfig.xml file with the adminhost, server, and group names.

The following sample OpsConfig.xml file is configured for the sdata sample Cognos TM1 server running on the local computer with a user group named

"monitor."

<ops><adminhost name="localhost">

<server name = "sdata"><group>monitor</group>

</server></adminhost>

</ops>

2.

Save and close the OpsConfig.xml file.3.




10 of 38 26-09-2014 11:23


You need to do some additional configuration to use the Microsoft Internet Explorer 8 web browser with the IBM® Cognos® TM1® Operations Console.

Procedure

In Internet Explorer 8, enable the option to refresh web pages with every visit.1.

Disable the options for script debugging.

For more information, see your Microsoft Internet Explorer documentation.

2.




11 of 38 26-09-2014 11:23


To run the IBM® Cognos® TM1® Operations Console enter the URL that identifies the port and server name for the component.

Procedure

In a web browser, type the following web address:

http://server_name:port_number/tm1operationsconsole

where

server_name is the computer where the Cognos TM1 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 Cognos TM1 Application Web. Or you can use

the machine name, domain name, or IP address of the Web server hosting the application.

port_number is the port number where your web application server is running. For the version of Apache Tomcat that is provided with the Cognos TM1

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.

1.

On the log in page, enter values for the following fields, and then click Log In.

TM1 Admin Host

Server Name

Group Name

User Name

Password Name

Tip: If you receive the error message No server specified in OpsConfig.xml, check the following:

Ensure that the Cognos TM1 server you configured in the OpsConfig.xml file is running.

Ensure that you performed the steps to add the certificates to the Java™ Runtime Environment (JRE) keystore for the Cognos TM1 Operations Console.

Ensure that your entered the name of the Cognos TM1 Operations Console user group accurately in the OpsConfig.xml file.

See the IBM Cognos TM1 Operations Console Guide to begin using the Cognos TM1 Operations Console.

2.




12 of 38 26-09-2014 11:23

4.2. 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

Cognos TM1 Operations Console needs the classpath user environment variable set.

Add certificates to the JRE keystore

The IBM Cognos TM1 Operations Console requires a certificate in the Java™ Runtime Environment (JRE) keystore.

Deploy the Cognos TM1 Operations Console

Before you can start using the IBM Cognos TM1 Operations Console, you must deploy it to Apache Tomcat.

Create a user group for the Cognos TM1 Operations Console

The IBM Cognos TM1 Operations Console requires a designated Cognos TM1 user group that you create in Cognos TM1 Architect.

Edit the OpsConfig.xml file

The IBM Cognos TM1 Operations Console uses an XML file for authentication to identify the user group, server, and admin host to use. Before you can run


Configure Microsoft Internet Explorer 8 for the Cognos TM1 Operations Console

You need to do some additional configuration to use the Microsoft Internet Explorer 8 web browser with the IBM Cognos TM1 Operations Console.

Start and log into the Cognos TM1 Operations Console

To run the IBM Cognos TM1 Operations Console enter the URL that identifies the port and server name for the component.



13 of 38 26-09-2014 11:23

4.2.1. Verify JRE user environment variable

Cognos® TM1® 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 Microsoft Windows user environment variable for the JRE path.

Variable name: classpath

Variable value: .;C:\Program Files\Java\jre6\bin

If you are using the Tomcat provided with the Cognos TM1 installation, the variable is set for you.



14 of 38 26-09-2014 11:23

4.2.3. Deploy the Cognos TM1 Operations Console

Before you can start using the IBM® Cognos® TM1® Operations Console, you must deploy it to Apache Tomcat.

Before you begin

Start an instance of Apache Tomcat on the computer where you want to deploy the Cognos TM1 Operations Console.

Ensure that you can access the Apache Tomcat Manager console.

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

With Apache Tomcat running, click Start > Programs > Tomcat Manager. Enter the username and password if they are required by your Apache Tomcat

instance.

1.

In Tomcat Manager, scroll down to the Deploy section and locate the WAR file to deploy subsection.

CAUTION:

If an earlier version of the Cognos TM1 Operations Console has already been deployed, use the undeploy option in Tomcat Manager to

undeploy the earlier version.

2.

Click Browse to locate the Cognos TM1 Operations Console web application archive file, tm1operationsconsole.war. The typical location of this file is

install_location/webapps/tm1operationsconsole.war

3.

Click OK.4.

In Tomcat Manager, click Deploy.

When the deployment is complete, the Cognos TM1 Operations Console displays as /tm1operationsconsole in the Applications section of Tomcat

Manager.

5.



15 of 38 26-09-2014 11:23

4.3. Using Websphere 7.0 and 8.0

You can install the IBM® Cognos® TM1® Operation Console on Websphere.

Import Websphere certificates

Follow these steps to import the certificates you need to run the IBM Cognos TM1 Operations Console on IBM Websphere.

Deploying Cognos TM1 Operations Console on Websphere

Follow these steps to deploy the IBM Cognos TM1 Operations Console on an IBM Websphere web server.

Starting the Cognos TM1 Operations Console on Websphere

After adding certificates and deploying the IBM Cognos TM1 Operations Console, start it from a web browser.



16 of 38 26-09-2014 11:23

4.3.1. Import Websphere certificates

Follow these steps to import the certificates you need to run the IBM® Cognos® TM1® Operations Console on IBM Websphere.

Procedure

Open the Websphere Admin Console.1.

In Websphere Administration Console, go to Security > SSL certificates and key management Configuration settings, select Manage endpoint

security configurations .

2.

Select the appropriate Outbound Configuration to get to the cell, then click Node.3.

At Related Items, click Key stores and certificates and click NodeDefaultTrustStore keystore.4.

At Additional Properties, click Signer certificates and Retrieve from Port.5.

Define the Cognos TM1 Admin settings.

Hostname: Enter the name of the computer where the Cognos TM1 Admin Server is running.a.

Port: 5498b.

Alias: <an alias for this field>.c.

Click Retrieve Signer Information.d.

Verify that the certificate information is for a certificate that you can trust.e.

Click Apply and Save to save the Master Configuration.f.

6.

After you have successfully saved the Master Configuration for the Cognos TM1 Admin server, use the same screen to define the settings for the Cognos TM1

Server:

Hostname: Enter the name of the computer where Cognos TM1 is running.a.

Port: enter the port number listed in this server's tm1s.cfg file.b.

Alias: <an alias for this field>.c.

Click Retrieve Signer Information.d.

Verify that the certificate information is for a certificate that you can trust.e.

Click Apply and Save to save the Master Configuration again.f.

7.

Parent topic: Using Websphere 7.0 and 8.0


17 of 38 26-09-2014 11:23

4.3.2. Deploying Cognos TM1 Operations Console on Websphere

Follow these steps to deploy the IBM® Cognos® TM1® 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 Cognos TM1 Operations Console was installed when you installed Cognos TM1 . Cognos TM1 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 Cognos TM1 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

Open and log into the Websphere Administrative Console.1.

In the right pane under Applications , click New Application > New Enterprise Application.2.

Specify the address of the tm1operationsconsole.war file and click Next.3.

Select Fast path and click Next.4.

In Select Install Applications, accept the defaults by clicking Next.5.

In Map Module to Servers, select the server(s) where you want to install the modules that are in your application and click Next.6.

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.7.

In Map Context Roots For Web Modules, enter the Context Root as /tm1operationsconsole8.

Click Save to save the Master Configuration.9.

Add a monitoring user group in Cognos TM1 . See Create a user group for the Cognos TM1 Operations Console for details.10.

Edit the OpsConfig.xml file. See Edit the OpsConfig.xml file for details.11.



18 of 38 26-09-2014 11:23

4.3.3. Starting the Cognos TM1 Operations Console on Websphere

After adding certificates and deploying the IBM® Cognos® TM1® Operations Console, start it from a web browser.

Procedure

In the Websphere Enterprise Application, check the tm1operationsconsole.war1.

Click Start.2.

Open a web browser.3.

Enter the URL for the Cognos TM1 Operations Console, for example, http://localhost:9080/tm1operationsconsole/4.



19 of 38 26-09-2014 11:23

5. Using the Cognos TM1 Operations Console

After installation and configuration, run the IBM® Cognos® TM1® 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 TM1 Operations Console displays.

Create an Operation Group for monitoring

Before you can monitor a IBM Cognos TM1 server using the Cognos TM1 Operations Console, define a logical grouping for the servers being monitored.

Add an AdminHost and Cognos TM1 server name to the Cognos TM1 Operations Console

To identify the IBM Cognos TM1 server to the Cognos TM1 Operations Console, add it to the database instance.

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.

Download or upload the configuration file

To make changes to the tm1operationsconsole.xml file, you can use the Upload and Download options.

Dynamic reporting using the Monitor option

The Monitor option on the IBM Cognos TM1 Operations Console opens a dynamically-refreshed display of the server activity that can be further focused

using the Filter settings.

Health check indicator

The Health check indicator provides almost instant feedback on the status of the server.

Health status tab

The IBM Cognos TM1 Operations Console displays the Health Check status of multiple servers.

Monitor server memory and performance data

The IBM Cognos TM1 Operations Console can monitor Cognos TM1 Server memory and performance data.

Set a filter

The Filters dialog box lets you focus the type of activity shown in the Status display.

Schedule the log file

You can define the schedule for how often the log file runs.

Download the log file

The Download option generates a text version of the log file, similar to the TM1Top output.

View the log file

The View Log option provides a compact, static snapshot of the log.


20 of 38 26-09-2014 11:23

5.1. Display user names

The MaskUserNameInServerTools parameter determines if user names are displayed or masked out in the IBM® Cognos® TM1® Operations Console displays.

When MaskUserNameInServerTools=TRUE is set in the Tm1s.cfg, user names are masked in theCognos TM1 Operations Console for security purposes. To

unmask the names, the administrator can right-click the server in the Cognos TM1 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 Cognos TM1 Operations Console displays user names even

when administrator access has not been verified.

Parent topic: Using the Cognos TM1 Operations Console


21 of 38 26-09-2014 11:23

5.2. Create an Operation Group for monitoringBefore you can monitor a IBM® Cognos® TM1® server using the Cognos TM1 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:

Click the operation group icon from the toolbar or use the Action menu to select Add Operation Group.1.

Enter a name for the group.2.

Click Create.3.

After the group is created, use the right-click or Action button option to add the AdminHost and Cognos TM1 server name.

After the group is defined, use the log file options to design the way you want to monitor the servers.



22 of 38 26-09-2014 11:23

5.3. Add an AdminHost and Cognos TM1 server name to the Cognos TM1 Operations Console

To identify the IBM® Cognos® TM1® server to the Cognos TM1 Operations Console, add it to the database instance.

About this task

After you have added a Database Instance, you can identify the AdminHost.

Procedure

Right-click the database instance and select Add Adminhost1.

Enter the fully-qualified name of the AdminHost.2.

Click OK3.

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 Cognos TM1 server running on that host

that you want to monitor.



23 of 38 26-09-2014 11:23

5.4. 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® TM1® 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.

Memory Stats refresh period

By default, the log waits 2 minutes before refreshing the data. You can enter a longer or shorter time for the refresh here in minutes.

Memory Stats tolerance factor

By default, the data is new (0). To permit data in the memory statistics to be older, enter a number here in seconds for how old the data can be before

requiring a new polling.

Memory Stats timeout

By default, attempts to connect to the server end after 2 minutes. You can change this number to shorten or lengthen the time the log will keep trying

before giving up.

If the IBM Cognos TM1 Operations Console server does not get the updated status in the minutes specified here, then the old data (if it exists) is sent with

an indication that a timeout has occurred.



24 of 38 26-09-2014 11:23

5.5. 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® TM1® 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.

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.



25 of 38 26-09-2014 11:23

5.6. Dynamic reporting using the Monitor option

The Monitor option on the IBM® Cognos® TM1® 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.

Performance Statistics

An Admin user can also access the Performance Statistics available for this server. See Monitor server memory and performance data for more

information.



26 of 38 26-09-2014 11:23

5.7. 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.

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 Cognos® TM1® Operations Console.

Stopping

Server is in the process of stopping.

Unsupported

Server is unsupported. The health check is not available for servers running a Cognos TM1 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.



27 of 38 26-09-2014 11:23

5.8. Health status tab

The IBM® Cognos® TM1® Operations Console displays the Health Check status of multiple servers.

The Health status tab shows the current state of all the TM1 servers in the current session. This is the default display for the TM1 Operations Console.



28 of 38 26-09-2014 11:23

5.9. Monitor server memory and performance data

The IBM® Cognos® TM1® Operations Console can monitor Cognos TM1 Server memory and performance data.

In order to use the Performance Monitoring features available in the Cognos TM1 Operations Console, you must first:

In Cognos TM1 Architect, right-click the server from the Server Explorer and select Server, Start Performance Monitor.

Only Admin users can run the system performance monitoring reports of the Cognos TM1 Operations Console. Before accessing the Performance Statistics

option, select the Verify Admin Access option from the Cognos TM1 Operations Console Monitor menu and enter a valid Administrator username and

password.

The following statistics are available on the Performance Statistics report:

Memory Used for Views

Memory Used for Calculations

Memory Used for Feeders

Memory Used for Input Data

Total Memory Used

In addition, the Status options for each server being monitor displays the following statistics:

Memory Used

Garbage Memory



29 of 38 26-09-2014 11:23

5.10. 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.

You can also filter the log entries. See Schedule the log file.



30 of 38 26-09-2014 11:23

5.11. 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® TM1® 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.

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.

Administrators can also filter the log files to eliminate duplicate entries and to reduce the log file size. The log file menus offer states to use when filtering

logging messages.



31 of 38 26-09-2014 11:23

5.12. 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.



32 of 38 26-09-2014 11:23

5.13. 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.



33 of 38 26-09-2014 11:23

6. 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.

IBM and accessibility

See the IBM® Accessibility Center for more information about the commitment that IBM has to accessibility.


34 of 38 26-09-2014 11:23

6.1. 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

Action Shortcut key

Perform the command for an active command button 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

Move backward through the panes of the application Shift+F6

Move the focus to the Application Bar (blue dot) 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

Open and display the contents of a drop-down list 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

Move to the previous selectable node Up arrow

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

Add a database instance Alt+N

Upload a configuration file Alt+U

Download a configuration file Alt+S

Tile vertically Alt+Q

Tile horizontally Alt+W

Box tile Alt+E

Refresh the tree Alt+R

Parent topic: Accessibility features


35 of 38 26-09-2014 11:23

6.2. 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)

Parent topic: Accessibility features


36 of 38 26-09-2014 11:23

7. Notices

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.

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.

©


37 of 38 26-09-2014 11:23

©

7.1. Product Information

This document applies to IBM Cognos TM1 Version 10.1.1 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).

Copyright

Licensed Materials - Property of IBM

© Copyright IBM Corp. 2011, 2012.

US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

IBM, the IBM logo, ibm.com, TM1, 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:

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.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.

Microsoft product screen shot(s) used with permission from Microsoft.

Parent topic: Notices


38 of 38 26-09-2014 11:23

Documents

06.TM1 Operations Console Guide 10.1.1