05.cognos TM1 Operations Console Guide 10.1.0

Cognos TM1 Operations Console Guide 10.1.
0
Contents
1. Introduction
2. Features of the Cognos TM1 Operations Console
3. Installing the Cognos TM1 Operations Console
3.1. Using the provided Apache Tomcat ith the Cognos TM1 Operations Console
3.1.1. Add certificates to the !"# $e%store
3.1.2. &eplo% Cognos TM1 Operations Console ith the provided version of Apache Tomcat
3.1.3. Create a user group for the Cognos TM1 Operations Console
3.1.'. #dit the OpsConfig.(ml file
3.1.). Configure Microsoft Internet #(plorer * for the Cognos TM1 Operations Console
3.1.+. ,tart and log into the Cognos TM1 Operations Console
3.2. Using %our on version of Apache Tomcat
3.2.1. -erif% !"# user environment varia.le
3.2.2. Add certificates to the !"# $e%store
3.2.3. &eplo% the Cognos TM1 Operations Console
3.2.'. Create a user group for the Cognos TM1 Operations Console
3.2.). #dit the OpsConfig.(ml file
3.2.+. Configure Microsoft Internet #(plorer * for the Cognos TM1 Operations Console
3.2./. ,tart and log into the Cognos TM1 Operations Console
3.3. Using 0e.sphere /.1 and *.1
3.3.1. Import 0e.sphere certificates
3.3.2. &eplo%ing Cognos TM1 Operations Console on 0e.sphere
3.3.3. ,tarting the Cognos TM1 Operations Console on 0e.sphere
'. Using the Cognos TM1 Operations Console
'.1. &ispla% user names
'.2. Create an Operation 2roup for monitoring
'.3. Add an Admin3ost and Cognos TM1 server name to the Cognos TM1 Operations Console
'.'. ,et the log file and server numeric parameters
'.). &onload or upload the configuration file
'.+. &%namic reporting using the Monitor option
'./. 3ealth chec$ indicator
'.*. ,et a filter
'.4. ,chedule the log file
'.11. &onload the log file
'.11. -ie the log file
). Accessi.ilit% features
).1. 5e%.oard shortcuts
).2. I6M and accessi.ilit%
+. 7otices
+.1. 8
Cognos TM1 Operations Console Guide 10.1.0 http://pic.dhe.ibm.com/infocenter/ctm1/v10r1m0/advanced/print.jsp?topi...
1 of 35 26-09-2014 11:23
1. Introduction
This document is intended for use ith TM19 .
It provides the information %ou need to install: configure: and use the I6M9 Cognos9 TM1 Operations Console. The Cognos TM1 Operations Console is an
optional softare component used to monitor the activit% of Cognos TM1 servers.
Audience
To use this guide: %ou should .e familiar ith;
Installation tas$s
0e.<server softare
!ava "untime #nvironment =!"#>
Cognos TM1 server operation
Finding information
To find I6M Cognos product documentation on the e.: including all translated documentation: access one of the I6M Cognos Information Centers
=http;??pu.li...oulder.i.m.com?infocenter?cogic?v1r1m1?inde(.@sp>. "elease 7otes are pu.lished directl% to Information Centers: and include lin$s to the latest
technotes and AAA"s.
Accessibility Features
Accessi.ilit% features help users ho have a ph%sical disa.ilit%: such as restricted mo.ilit% or limited vision: to use information technolog% products. This product
has accessi.ilit% features. For information on these features: see Accessi.ilit% features.
Samples disclaimer
The 2reat Outdoors Compan%: 2O ,ales: an% variation of the 2reat Outdoors name: and Alanning ,ample depict fictitious .usiness operations ith sample data
used to develop sample applications for I6M and I6M customers. These fictitious records include sample data for sales transactions: product distri.ution:
finance: and human resources. An% resem.lance to actual names: addresses: contact num.ers: or transaction values is coincidental. Other sample files ma%
contain fictional data manuall% or machine generated: factual data compiled from academic or pu.lic sources: or data used ith permission of the cop%right
holder: for use as sample data to develop sample applications. Aroduct names referenced ma% .e the trademar$s of their respective oners. UnauthoriBed
duplication is prohi.ited.
Forard!loo"ing statements
This documentation descri.es the current functionalit% of the product. "eferences to items that are not currentl% availa.le ma% .e included. 7o implication of
an% future availa.ilit% should .e inferred. An% such references are not a commitment: promise: or legal o.ligation to deliver an% material: code: or functionalit%.
The development: release: and timing of features or functionalit% remain at the sole discretion of I6M.
2 of 35 26-09-2014 11:23
#. Features of t$e Cognos TM1 Operations Console
The I6M9 Cognos9 TM19 Operations Console is an optional component that I6M Cognos TM1 administrators can use to generate logs: monitor multiple server
activit%: and manage Cognos TM1 servers.
The Cognos TM1 Operations Console provides the .asic server monitoring functionalit% provided .% the TM1Top utilit% ith some important additions;
The Cognos TM1 Operations Console can monitor multiple Cognos TM1 servers at the same time.
The 3ealth feature allos for instant feed.ac$ on the current state of servers.
Filtering helps highlight specific states for multiple servers.
,orting allos administrators to Cuic$l% identif% hich servers are in specific states.
The Cognos TM1 Operations Console can use ,cheduled Dogging to monitor activit% offline.
The folloing sample sho multiple servers .eing monitored in the Cognos TM1 Operations Console;
Eou can drag and organiBe the displa%s offered .% the Cognos TM1 Operations Console using the Tile options : : and from the tool.ar and customiBe the
reporting using man% different attri.utes and server states. Eou can also easil% identif% 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 e. .roser.
3 of 35 26-09-2014 11:23
%. Installing t$e Cognos TM1 Operations Console
The I6M9 Cognos9 TM19 Operations Console is a !ava<.ased e. application that ena.les Cognos TM1 administrators to monitor and ta$e action on Cognos
TM1 server activit%.
&efore you begin
The Cognos TM1 Operations Console is deplo%ed on a !ava<.ased e. application server such as the version of Apache Tomcat supplied ith the Cognos TM1
installation. Eou can instead use %our on version of Apache Tomcat. &etermine hich a% %ou ant to install.
6efore installing the Cognos TM1 Operations Console;
#nsure that the Cognos TM1 prereCuisite softare is installed.
#nsure that theCognos TM1 Admin ,erver and the Cognos TM1 server that %ou ant to monitor are installed and running.
#nsure that %ou can start Cognos TM1 Architect and can log in as an administrator to the Cognos TM1 server that %ou ant to monitor.
#nsure that Apache Tomcat is installed and running.
The Cognos TM1 Operation Console is selected .% default during installation. Eou can instead choose to install it on a computer separate from the computer
used for the Cognos TM1 server .% deselecting it during the standard installation: then running the installation on the separate computer and selecting onl% the
Cognos TM1 Operations Console.
'rocedure
"un the installation from the installation location. 1.
,elect and install the (eb Application Tier ) Cognos TM1 Operations Console component.
*emember+ Install I6M Cognos TM1 components in a director% that contains onl% A,CII characters in the path name. ,ome 0indos e. servers do not
support non<A,CII characters in director% names.
2.
($at to do ne,t
Follo the instructions for the e.server softare %ou ant to use ith the Cognos TM1 Operations Console;
Using the provided Apache Tomcat ith the Cognos TM1 Operations Console
Using %our on version of Apache Tomcat
Using 0e.sphere /.1 and *.1
-sing t$e pro.ided Apac$e Tomcat it$ t$e Cognos TM1 Operations Console
Use the folloing set of steps to install the I6M Cognos TM1 Operations Console if %ou are using the version of Apache Tomcat provided ith Cognos TM1 .
-sing your on .ersion of Apac$e Tomcat
Use the folloing set of steps if %ou are using %our on version of Apache Tomcat.
-sing (ebsp$ere /.0 and 0.0
Eou can install the I6M Cognos TM1 Operation Console on 0e.sphere.
4 of 35 26-09-2014 11:23
%.1. -sing t$e pro.ided Apac$e Tomcat it$ t$e Cognos TM1 Operations Console
Use the folloing set of steps to install the I6M Cognos9 TM19 Operations Console if %ou are using the version of Apache Tomcat provided ith Cognos TM1 .
Add certificates to t$e 1*2 "eystore
The I6M Cognos TM1 Operations Console reCuires a certificate in the !ava "untime #nvironment =!"#> $e%store.
3eploy Cognos TM1 Operations Console it$ t$e pro.ided .ersion of Apac$e Tomcat
Use the I6M Cognos Configuration tool to deplo% the I6M Cognos TM1 Operations Console ith the version of Apache Tomcat provided ith the Cognos TM1
installation. The Cognos TM1 Operations Console uses the same version of Tomcat as the I6M Cognos TM1 Application ,erver.
Create a user group for t$e Cognos TM1 Operations Console
The I6M Cognos TM1 Operations Console reCuires a designated Cognos TM1 user group that %ou create in Cognos TM1 Architect.
2dit t$e OpsConfig.,ml file
The I6M Cognos TM1 Operations Console uses an FMD file to identif% the user group: server: and admin host to use. 6efore %ou can run the Cognos TM1
Operations Console: %ou need to update this configuration file ith the information that descri.es %our ne monitoring group.
Configure Microsoft Internet 2,plorer 0 for t$e Cognos TM1 Operations Console
Eou need to do some additional configuration to use the Microsoft Internet #(plorer * e. .roser ith the I6M Cognos TM1 Operations Console.
Start and log into t$e Cognos TM1 Operations Console
To run the I6M Cognos TM1 Operations Console enter the U"D that identifies the port and server name for the component.
'arent topic+ Installing the Cognos TM1 Operations Console
5 of 35 26-09-2014 11:23
%.1.1. Add certificates to t$e 1*2 "eystore
The I6M9 Cognos9 TM19 Operations Console reCuires a certificate in the !ava "untime #nvironment =!"#> $e%store.
'rocedure
"un the !ava $e%tool command to import the certificate into the $e%store.
Open a command prompt and change to the folloing director%;
<TM1_location> \bin\jre\6.0\bin
here <TM1_location> is the file director% here Cognos TM1 is installed.
CA-TIO4+
On 56!bit computers7 be sure to add t$e certificates to t$e bin64 folder.
a.
"un the folloing command line. For formatting purposes the command is shon here ith line .rea$s .ut %ou should enter the command all on one
line.
keytool -import -file "C:\<TM1_location>\bin\ssl\applixca.pem"
-keystore "C:\<TM1_location>\bin\jre\6.0\lib\security\cacerts"
-storepass "changeit"
For +'<.it installations: target the +'<.it folder hen dealing ith the certificates. For e(ample: this sample command targets the +'<.it @re;
cd C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\jre\6.0\bin
The folloing command is an e(ample used on +'<.it s%stems. For formatting purposes this command is shon ith line .rea$s .ut %ou 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 %ou do not correctl% target the +'<.it locations for certificates hen running a +'<.it installation: %ou receive a arning message indicating that %ou
cannot contact the servers.
..
#nter yes hen prompted to trust or add the certificate. c.
The folloing message displa%s; Certificate as added to "eystore
1.
Eou ma% need to restart Apache Tomcat to have the change ta$e effect.
*emember+ "e<add certificates an% time %ou re<install Cognos TM1 .
2.
'arent topic+ Using the provided Apache Tomcat ith the Cognos TM1 Operations Console
'arent topic+ Using %our on version of Apache Tomcat
6 of 35 26-09-2014 11:23
%.1.#. 3eploy Cognos TM1 Operations Console it$ t$e pro.ided .ersion of Apac$e Tomcat
Use the I6M9 Cognos9 Configuration tool to deplo% the I6M Cognos TM19 Operations Console ith the version of Apache Tomcat provided ith the Cognos
TM1 installation. The Cognos TM1 Operations Console uses the same version of Tomcat as the I6M Cognos TM1 Application ,erver.
&efore you begin
If %ou installed the product from the Arogram Files =(*+> director% on a computer running Microsoft 0indos -ista: 0indos /: or 0indos 211* operating
s%stem softare: start I6M Cognos Configuration as an Administrator.
'rocedure
Clic$ Start G All 'rograms G I&M Cognos TM1 G I&M Cognos Configuration. 1.
"ight<clic$ TM1 Applications and clic$ Start.
This step starts the version of Tomcat provided ith Cognos TM1 : and automaticall% deplo%s the Cognos TM1 Operations Console.
2.
,ave the configuration data .% clic$ing File G Sa.e. 3.
Close Cognos Configuration .% clic$ing File G 2,it. '.
7 of 35 26-09-2014 11:23
%.1.%. Create a user group for t$e Cognos TM1 Operations Console
The I6M9 Cognos9 TM19 Operations Console reCuires a designated Cognos TM1 user group that %ou create in Cognos TM1 Architect.
'rocedure
"un Cognos TM1 Architect.
*emember+ If the TM1 Admin server and the server %ou ant to monitor have not .een started %et: use Cognos Configuration to start them .efore running
Cognos TM1 Architect.
1.
In Cognos TM1 Architect: dou.le<clic$ TM1 to see the servers that are running and availa.le to %ou. 2.
&ou.le<clic$ the server %ou ant to monitor and log into it ith the username and passord for that server. 3.
"ight<clic$ the server and select Security G Clients and groups to add a ne user group specificall% for the Cognos TM1 Operations Console. '.
,elect Groups G Add ne group and enter a group name: such as monitor or another easil%<identifia.le name for the Cognos TM1 Operations Console
group.
Eou ma% need to scroll the indo to see the ne group that %ou have @ust added.
).
Clic$ O8. +.
Assign a user to the ne group;
Onl% these users ill .e a.le to log into the Cognos TM1 Operations Console.
For administrator<t%pe users: assign them to the ne group and also to the .uilt<in ,ecurit%Admin: and?or the A&MI7 group.
If %ou ant the monitoring user to .e a standard user: assign that user to the ne group and to the Cognos TM1 &ataAdmin group.
,ee the IBM Cognos TM1 Operation Guide for details on assigning securit% groups in Cognos TM1 .
/.
Clic$ O8 to return to the ,erver #(plorer. Eou can close Cognos TM1 Architect. *.
8 of 35 26-09-2014 11:23
%.1.6. 2dit t$e OpsConfig.,ml file
The I6M9 Cognos9 TM19 Operations Console uses an FMD file to identif% the user group: server: and admin host to use. 6efore %ou can run the Cognos TM1
&efore you begin
#nsure that %ou added and configured a designated user group in Cognos TM1 Architect specificall% for the Cognos TM1 Operations Console.
'rocedure
#dit the OpsConfig.xml file using an FMD or te(t editor.
For the Apache Tomcat provided ith the Cognos TM1 installation: the file is located here;
<TM1_location>\webapps\tm1operationsconsole\WEB-INF\configuration
If %ou are using %our on 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 ith the adminhost: server: and group names.
The folloing sample OpsConfig.xml file is configured for the sdata sample Cognos TM1 server running on the local computer ith a user group named
Hmonitor.H
<ops>
<adminhost name="localhost">
<server name = "sdata">
<group>monitor</group>
</server>
</adminhost>
</ops>
2.
,ave and close the OpsConfig.xml file. 3.
9 of 35 26-09-2014 11:23
%.1.9. Configure Microsoft Internet 2,plorer 0 for t$e Cognos TM1 Operations Console
Eou need to do some additional configuration to use the Microsoft Internet #(plorer * e. .roser ith the I6M9 Cognos9 TM19 Operations Console.
'rocedure
In Internet #(plorer *: ena.le the option to refresh e. pages ith ever% visit. 1.
&isa.le the options for script de.ugging.
For more information: see %our Microsoft Internet #(plorer documentation.
2.
10 of 35 26-09-2014 11:23
%.1.5. Start and log into t$e Cognos TM1 Operations Console
To run the I6M9 Cognos9 TM19 Operations Console enter the U"D that identifies the port and server name for the component.
'rocedure
In a e. .roser: t%pe the folloing e. address;
http://server_name:port_number/tm1operationsconsole
here
server_name is the computer here the Cognos TM1 Operations Console and %our e. application server are installed.
Tip+ Eou can use the $e%ord localhost if %ou are currentl% logged on to the 0e. server that is running Cognos TM1 Application 0e.. Or %ou can use
the machine name: domain name: or IA address of the 0e. server hosting the application.
port_number is the port num.er here %our e. application server is running. For the version of Apache Tomcat that is provided ith the Cognos TM1
installation: the default port num.er is 4)11.
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 %our version of Tomcat is using.
1.
On the log in page: enter values for the folloing fields: and then clic$ :og In.
TM1 Admin ;ost
Ser.er 4ame
Group 4ame
-ser 4ame
'assord 4ame
Tip+ If %ou receive the error message No server specified in OpsConfig.xml: chec$ the folloing;
#nsure that the Cognos TM1 server %ou configured in the OpsConfig.xml file is running.
#nsure that %ou performed the steps to add the certificates to the !ava "untime #nvironment =!"#> $e%store for the Cognos TM1 Operations Console.
#nsure that %our entered the name of the Cognos TM1 Operations Console user group accuratel% in the OpsConfig.(ml file.
,ee Using the Cognos TM1 Operations Console to .egin using the Cognos TM1 Operations Console.
2.
11 of 35 26-09-2014 11:23
%.#. -sing your on .ersion of Apac$e Tomcat
Use the folloing set of steps if %ou are using %our on version of Apache Tomcat.
<erify 1*2 user en.ironment .ariable
Cognos TM1 Operations Console needs the classpath user environment varia.le set.
Add certificates to t$e 1*2 "eystore
The I6M Cognos TM1 Operations Console reCuires a certificate in the !ava "untime #nvironment =!"#> $e%store.
3eploy t$e Cognos TM1 Operations Console
6efore %ou can start using the I6M Cognos TM1 Operations Console: %ou must deplo% it to Apache Tomcat.
Create a user group for t$e Cognos TM1 Operations Console
The I6M Cognos TM1 Operations Console reCuires a designated Cognos TM1 user group that %ou create in Cognos TM1 Architect.
2dit t$e OpsConfig.,ml file
The I6M Cognos TM1 Operations Console uses an FMD file to identif% the user group: server: and admin host to use. 6efore %ou can run the Cognos TM1
Configure Microsoft Internet 2,plorer 0 for t$e Cognos TM1 Operations Console
Eou need to do some additional configuration to use the Microsoft Internet #(plorer * e. .roser ith the I6M Cognos TM1 Operations Console.
Start and log into t$e Cognos TM1 Operations Console
To run the I6M Cognos TM1 Operations Console enter the U"D that identifies the port and server name for the component.
12 of 35 26-09-2014 11:23
%.#.1. <erify 1*2 user en.ironment .ariable
Cognos9 TM19 Operations Console needs the classpath user environment varia.le set.
If %ou are using %our on installation of Apache Tomcat: verif% that %ou have the folloing 0indos user environment varia.le for the !"# path.
<ariable name; classpath
<ariable .alue; .;C:\Program Files\Java\jre6\bin
If %ou are using the Tomcat provided ith the Cognos TM1 installation: the varia.le is set for %ou.
13 of 35 26-09-2014 11:23
%.#.%. 3eploy t$e Cognos TM1 Operations Console
6efore %ou can start using the I6M9 Cognos9 TM19 Operations Console: %ou must deplo% it to Apache Tomcat.
&efore you begin
,tart an instance of Apache Tomcat on the computer here %ou ant to deplo% the Cognos TM1 Operations Console.
#nsure that %ou can access the Apache Tomcat Manager console.
If %ou have not used Tomcat Manager .efore: add a user and role to the tomcat-users.xml file .efore %ou can log in. For more information: see %our
Apache Tomcat documentation.
'rocedure
0ith Apache Tomcat running: clic$ Start G 'rograms G Tomcat Manager. #nter the username and passord if the% are reCuired .% %our Apache Tomcat
instance.
1.
In Tomcat Manager: scroll don to the 3eploy section and locate the (A* file to deploy su.section.
CA-TIO4+
If an earlier .ersion of t$e Cognos TM1 Operations Console $as already been deployed7 use t$e undeploy option in Tomcat Manager to
undeploy t$e earlier .ersion.
2.
Clic$ &rose to locate the Cognos TM1 Operations Console e. application archive file: tm1operationsconsole.war. The t%pical location of this file is
install_location/webapps/tm1operationsconsole.war
3.
Clic$ O8. '.
In Tomcat Manager: clic$ 3eploy.
0hen the deplo%ment is complete: the Cognos TM1 Operations Console displa%s as =tm1operationsconsole in the Applications section of Tomcat
Manager.
).
14 of 35 26-09-2014 11:23
%.%. -sing (ebsp$ere /.0 and 0.0
Eou can install the I6M Cognos9 TM19 Operation Console on 0e.sphere.
Import (ebsp$ere certificates
Follo these steps to import the certificates %ou need to run the I6M Cognos TM1 Operations Console on I6M 0e.sphere.
3eploying Cognos TM1 Operations Console on (ebsp$ere
Follo these steps to deplo% the I6M Cognos TM1 Operations Console on an I6M 0e.sphere e. server.
Starting t$e Cognos TM1 Operations Console on (ebsp$ere
After adding certificates and deplo%ing the Cognos TM1 Operations Console: start it from a e. .roser.
15 of 35 26-09-2014 11:23
%.%.1. Import (ebsp$ere certificates
Follo these steps to import the certificates %ou need to run the I6M9 Cognos9 TM19 Operations Console on I6M 0e.sphere.
'rocedure
Open the 0e.sphere Admin Console. 1.
In 0e.sphere Administration Console: go to Security G SS: certificates and "ey management Configuration settings: select Manage endpoint
security configurations .
2.
,elect the appropriate Out.ound Configuration to get to the cell: then clic$ 4ode. 3.
At *elated Items: clic$ 8ey stores and certificates and clic$ 4ode3efaultTrustStore $e%store. '.
At Additional 'roperties: clic$ Signer certificates and *etrie.e from 'ort. ).
&efine the Cognos TM1 Admin settings.
;ostname; #nter the name of the computer here the Cognos TM1 Admin ,erver is running. a.
'ort; )'4* ..
Alias; <an alias for this field> c.
Clic$ *etrie.e Signer Information. d.
-erif% that the certificate information is for a certificate that %ou can trust. e.
Clic$ Apply and Sa.e to save the Master Configuration. f.
+.
After %ou have successfull% saved the Master Configuration for the Cognos TM1 Admin server: use the same screen to define the settings for the Cognos TM1
,erver;
;ostname; #nter the name of the computer here Cognos TM1 is running. a.
'ort; enter the port num.er listed in this serverIs tm1s.cfg file. ..
Alias; <an alias for this field> c.
Clic$ *etrie.e Signer Information. d.
-erif% that the certificate information is for a certificate that %ou can trust. e.
Clic$ Apply and Sa.e to save the Master Configuration again. f.
/.
'arent topic+ Using 0e.sphere /.1 and *.1
16 of 35 26-09-2014 11:23
%.%.#. 3eploying Cognos TM1 Operations Console on (ebsp$ere
Follo these steps to deplo% the I6M9 Cognos9 TM19 Operations Console on an I6M 0e.sphere e. server.
&efore you begin
,ee the 0e.sphere documentation for details on using I6M 0e.sphere.
6efore deplo%ing: ensure that the TM1 Operations Console as installed hen %ou installed Cognos TM1. TM1 Operations Console is a 0e. Application
component that is selected .% default. If %ou did not install it: %ou can re<run the installation and select onl% the TM1 Operations Console to install onl% that
component.
After installation: determine the location of the tm1operations.war file hich is usuall% in C:/<tm1_installation_location>/webapps
'rocedure
Open and log into the 0e.sphere Administrative Console. 1.
In the right pane under Applications : clic$ 4e Application G 4e 2nterprise Application. 2.
,pecif% the address of the tm1operationsconsole.war file and clic$ 4e,t. 3.
,elect Fast pat$ and clic$ 4e,t. '.
In Select Install Applications: accept the defaults .% clic$ing 4e,t. ).
In Map Module to Ser.ers: select the server=s> here %ou ant to install the modules that are in %our application and clic$ 4e,t. +.
In Map <irtual ;osts For (eb Modules: specif% the virtual host here %ou ant to install the 0e. modules that are in %our application and clic$ 4e,t. /.
In Map Conte,t *oots For (eb Modules: enter the Conte,t *oot as /tm1operationsconsole *.
Clic$ Sa.e to save the Master Configuration. 4.
Add a monitoring user group in Cognos TM1. ,ee Create a user group for the Cognos TM1 Operations Console for details. 11.
#dit the OpsConfig.xml file. ,ee #dit the OpsConfig.(ml file for details. 11.
17 of 35 26-09-2014 11:23
%.%.%. Starting t$e Cognos TM1 Operations Console on (ebsp$ere
After adding certificates and deplo%ing the Cognos9 TM19 Operations Console: start it from a e. .roser.
'rocedure
In the 0e.sphere #nterprise Application: chec$ the tm1operationsconsole.war 1.
Clic$ Start. 2.
Open a e. .roser. 3.
#nter the U"D for the Cognos TM1 Operations Console: for e(ample: http://localhost:9080/tm1operationsconsole/ '.
18 of 35 26-09-2014 11:23
6. -sing t$e Cognos TM1 Operations Console
After installation and configuration: run the I6M9 Cognos9 TM19 Operations Console from a e. .roser.
The first time %ou use it %ou need to set up some organiBation structures to identif% the servers .eing monitored.
3isplay user names
The MaskUserNameInServerTools parameter determines if user names are displa%ed or mas$ed out in the I6M Cognos TM1 Operations Console displa%s.
Create an Operation Group for monitoring
6efore %ou can monitor a I6M Cognos TM1 server using the Cognos TM1 Operations Console: define a logical grouping for the servers .eing monitored.
Add an Admin;ost and Cognos TM1 ser.er name to t$e Cognos TM1 Operations Console
To identif% the I6M Cognos TM1 server to the Cognos TM1 Operations Console: add it to the data.ase instance.
Set t$e log file and ser.er numeric parameters
Use the Configure option to set the numeric parameters that define ho the log file numerics and other server parameters are gathered.
3onload or upload t$e configuration file
To ma$e changes to the tm1operationsconsole.(ml file: %ou can use the Upload and &onload options.
3ynamic reporting using t$e Monitor option
The Monitor option on the I6M Cognos TM1 Operations Console opens a d%namicall%<refreshed displa% of the server activit% that can .e further focused
using the Filter settings.
;ealt$ c$ec" indicator
The 3ealth chec$ indicator provides almost instant feed.ac$ on the status of the server.
Set a filter
The Filters dialog .o( lets %ou focus the t%pe of activit% shon in the ,tatus displa%.
Sc$edule t$e log file
Eou can define the schedule for ho often the log file runs.
3onload t$e log file
The &onload option generates a te(t version of the log file: similar to the TM1Top output.
<ie t$e log file
The -ie Dog option provides a compact: static snapshot of the log.
19 of 35 26-09-2014 11:23
6.1. 3isplay user names
The MaskUserNameInServerTools parameter determines if user names are displa%ed or mas$ed out in the I6M9 Cognos9 TM19 Operations Console displa%s.
0hen MaskUserNameInServerTools=TRUE is set in the Tm1s.cfg: user names are mas$ed in theCognos TM1 Operations Console for securit% purposes. To
unmas$ the names: the administrator can right<clic$ the server in the Cognos TM1 Operations Console and then clic$ Aut$enticate to verif% the administrator
status.
This parameter is set to FAD,# .% default. If %ou do not e(plicitl% set this parameter to T"U#: the Cognos TM1 Operations Console displa%s user names even
hen administrator access has not .een verified.
'arent topic+ Using the Cognos TM1 Operations Console
20 of 35 26-09-2014 11:23
6.#. Create an Operation Group for monitoring
6efore %ou can monitor a I6M9 Cognos9 TM19 server using the Cognos TM1 Operations Console: define a logical grouping for the servers .eing monitored.
For e(ample: %ou might have a group of servers designated as H&evelopment:H HAroduction:H or HTest.H
To add a ne Operation 2roup;
Clic$ the operation group icon from the tool.ar or use the Action menu to select Add Operation Group. 1.
#nter a name for the group. 2.
Clic$ Create. 3.
After the group is created: use the right<clic$ or Action .utton option to add the Admin3ost and Cognos TM1 server name.
After the group is defined: use the log file options to design the a% %ou ant to monitor the servers.
21 of 35 26-09-2014 11:23
6.%. Add an Admin;ost and Cognos TM1 ser.er name to t$e Cognos TM1 Operations Console
To identif% the I6M9 Cognos9 TM19 server to the Cognos TM1 Operations Console: add it to the data.ase instance.
About t$is tas"
After %ou have added a &ata.ase Instance: %ou can identif% the Admin3ost.
'rocedure
"ight<clic$ the data.ase instance and select Add Admin$ost 1.
#nter the full%<Cualified name of the Admin3ost. 2.
Clic$ O8 3.
*esults
The Adminhost is identified. Once the Admin3ost is in the tree: %ou can select it and right<clic$ to add the name of the Cognos TM1 server running on that host
that %ou ant to monitor.
22 of 35 26-09-2014 11:23
6.6. Set t$e log file and ser.er numeric parameters
Use the Configure option to set the numeric parameters that define ho the log file numerics and other server parameters are gathered.
Complete the folloing parameters for each log file.
:og period
,pecifies the time interval .eteen updates .eing ritten to the log file.
For e(ample: if the screen "efresh is set to 2 seconds: DogAeriod could .e set to 11 seconds so that ever% fifth screen displa% ill .e output to decrease
the amount of data ritten to the file.
&efault is 2 seconds.
:og Append
6% default a ne log file is not appended: it overrites the e(isting log. ,elect True to append ne logfiles to the e(isting log.
*efres$ period
6% default: the log aits 2 seconds .efore refreshing the data. Eou can enter a longer or shorter time for the refresh here in seconds.
Tolerance factor
6% default: the data is ne =1>. To permit data in the log to .e older: enter a num.er here in seconds for ho old the data can .e .efore reCuiring a ne
polling.
Time Out
6% default: attempts to connect to the server end after 2 seconds. Eou can change this num.er to shorten or lengthen the time the log ill $eep tr%ing
.efore giving up.
If the I6M9 Cognos9 TM19 Operations Console server does not get the updated status in the seconds specified here: then the old data =if it e(ists> is
sent ith an indication that a timeout has occurred.
23 of 35 26-09-2014 11:23
6.9. 3onload or upload t$e configuration file
To ma$e changes to the tm1operationsconsole.(ml file: %ou can use the Upload and &onload options.
Once %ou have populated the I6M9 Cognos9 TM19 #nvironment pane ith the configuration file: %ou can use the Upload and &onload options to ma$e
changes to the configuration. Eou can also include sample data for a configuration file using these commands.
0hen %ou choose -pload : %ou can .rose to the location of the configuration file and clic$ O8.
Choose 3onload to see the configuration file as an (ml file that %ou can save on %our local machine.
24 of 35 26-09-2014 11:23
6.5. 3ynamic reporting using t$e Monitor option
The Monitor option on the I6M9 Cognos9 TM19 Operations Console opens a d%namicall%<refreshed displa% of the server activit% that can .e further focused
using the Filter settings.
The Monitor option displa%s general status: sand.o(es: or sand.o( Cueue information d%namicall% .ased on the log file parameters %ou have chosen. Eou can
also com.ine these indos to monitor different $inds of activit% at the same time. Use the Filter dialog .o( to focus the displa%s to specific $inds of activit%: for
e(ample: to onl% processes in a run state.
0hen there are processes displa%ed: %ou can right<clic$ a process to select 8ill process to terminate the process.
To sort the displa% .% a particular column: clic$ the column heading so that an arro displa%s. Up arro sorts on that column headingJ don arro is the default
sort.
The 3ealth chec$ gives an instant indication of the serverIs status.
Status
6% default the ,tatus choice shos all states and lists the I&: User: ,tate: Function: O.@ect Doc$ ,tatus: User Doc$ ,tatus: and Time.
For Threads: %ou can monitor the Threads in Use: Kueue &epth: Average Kueue Time: &eCueue &elta: Kueue Time &elta: and AAI Calls &elta.
Sandbo,
6% default the ,and.o( lists the I&: User: Active ,and.o(: Total ,and.o( Memor% and the 7um.er of ,and.o(es.
Sandbo, >ueue
6% default the ,and.o( Kueue lists the I&: 7ame: User: 7ode 7ame: ,tatus: and Time in Kueue.
25 of 35 26-09-2014 11:23
6./. ;ealt$ c$ec" indicator
The 3ealth chec$ indicator provides almost instant feed.ac$ on the status of the server.
The folloing list shos the indicators availa.le;
Online
,erver is online. This server is running.
Starting
The server is starting.
&ul":oad Mode
,erver is in 6ul$DoadMode.
&usy
,erver is .us%. ,erver ma% .e starting: stopping: .e in 6ul$ Doad Mode: or no response as received from the server.
Offline
,erver is offline?not a.le to contact. This server is not running or has .een una.le to connect to the Cognos TM19 Operations Console.
Stopping
,erver is in the process of stopping.
-nsupported
,erver is unsupported. The health chec$ is not availa.le for servers running a Cognos TM1 version prior to the 11.1.1 release.
The 3ealth Chec$ also displa%s the num.er of threads in the server and the num.er of threads aiting for a loc$ to .e granted.
,ince the health status is updated ever% 11 seconds: the information is current to ithin 11 seconds or less depending on hen 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.
26 of 35 26-09-2014 11:23
6.0. Set a filter
The Filters dialog .o( lets %ou focus the t%pe of activit% shon in the ,tatus displa%.
Eou can filter displa%s .% specific threads or .% their specific states to Cuic$l% identif% activit%.
6% default all states are shon in the status displa%. Chec$ one or man% of these choices to focus on the state shon; Idle: "un: Commit: "oll.ac$: 0ait: Dogin:
Finish.
Eou can also focus the Thread information .% ,%stem: Chores: and User Threads.
"eport columns can .e sorted to allo faster identification of .us% servers.
27 of 35 26-09-2014 11:23
6.?. Sc$edule t$e log file
Eou can define the schedule for ho often the log file runs.
To schedule a ne log file event: right<clic$ the server in the I6M9 Cognos9 TM19 #nvironment pane and select :ogging Sc$eduler.
6% default the logging is set to 3isable :ogging. Automated :ogging generates a log file for hatever activit% is ta$ing place at that time for the amount of
time that the monitor indo is open.
To e(amine or create a customiBed logging schedule: clic$ Sc$eduled :ogging and complete the dialog .o( ith the details for the start and stop times of %our
logging schedule.
:og type
Choose ,tatus: ,and.o(: or ,and.o( Kueue
:og Separately
6% default each log for status: sand.o(: and sand.o( status is maintained separatel%. Choose False to com.ine all these logs into a common file.
*emember+ 0hen Dog ,eparatel% is True: the donloaded log option provides that t%pe of log file. 0hen Dog ,eparatel% is False: the common log file is
donloaded.
:og 3uration
Clic$ the ,tart &ate: ,tart Time: ,top &ate: and ,top Time to open a calendar to help set these parameters for hen the log is run.
Once %ou have a log event scheduled: %ou can use this dialog .o( to edit or delete it.
28 of 35 26-09-2014 11:23
6.10. 3onload t$e log file
The &onload option generates a te(t version of the log file: similar to the TM1Top output.
Choose hich t%pe of log to donload; ,tatus: ,and.o(: or ,and.o( Kueue.
29 of 35 26-09-2014 11:23
6.11. <ie t$e log file
The -ie Dog option provides a compact: static snapshot of the log.
Choose hich t%pe of log to vie; ,tatus: ,and.o(: or ,and.o( Kueue.
30 of 35 26-09-2014 11:23
9. Accessibility features
Accessi.ilit% features help users ho have a ph%sical disa.ilit%: such as restricted mo.ilit% or limited vision: to use information technolog% products.
8eyboard s$ortcuts
,tandard Microsoft 0indos navigation $e%s are used in addition to application<specific $e%s.
I&M and accessibility
,ee the I6M9 Accessi.ilit% Center for more information a.out the commitment that I6M has to accessi.ilit%.
31 of 35 26-09-2014 11:23
9.1. 8eyboard s$ortcuts
,tandard Microsoft 0indos navigation $e%s are used in addition to application<specific $e%s.
Eou can use $e%.oard shortcuts to navigate through the application and perform tas$s. If %ou are using a screen reader: %ou might ant to ma(imiBe %our
indo so the $e%.oard shortcut ta.le is completel% e(panded and accessi.le.
7ote; The folloing $e%.oard shortcuts are .ased on U, standard $e%.oards.
Ta.le 1. 5e%.oard shortcuts
Action S$ortcut "ey
Aerform the command for an active command .utton #nter
Close an o.@ect or pane that is closa.le CtrlLF'
2o to the first item or o.@ectJ 2o 3ome 3ome
2o to the last item or o.@ectJ 2o to the #nd #nd
Move forard through the panes of the application F+
Move .ac$ard through the panes of the application ,hiftLF+
Move the focus to the Application 6ar =.lue dot> F11
Move to the ne(t item in the ta. inde( order at the same levelJ c%cle to the first ta. inde( hen %ou are at the end Ta.
Move to the previous item in the ta. inde( order at the same levelJ c%cle to the last ta. inde( hen %ou are at the .eginning ,hiftLTa.
Toggle on or off ,pace .ar
Move to the ne(t option .utton and select it "ight arro: &on arro
Move to the previous option .utton and select it Up arro: Deft arro
Open and displa% the contents of a drop<don list &on arro
Close an open drop<don list #sc
Move to the ne(t selecta.le node after the current node. If the node that %ou select has children nodes and is e(panded: go to the
first child node
&on arro
Move to the previous selecta.le node Up arro
#(pand the current selection if it is not e(panded. If the node is e(panded: go to the first child node "ight arro and plus
sign
Collapse the current selection if it is e(panded. If the node is collapsed: go to the parent node .efore the current selection Deft arro and minus
sign
#(pand the children menu items "ight arro
Collapse the children menu items Deft arro
Open a conte(t menu "ight<clic$ $e%
Close an open conte(t menu #sc
,croll don &on arro or Aage
&on
,croll up Up arro or Aage Up
Move to the ne(t idget in the ta. inde( order at the same level in the canvas Ta.
Move to the previous idget in the ta. inde( order at the same level in the canvas ,hiftLTa.
Add a data.ase instance AltL7
Upload a configuration file AltLU
&onload a configuration file AltL,
Tile verticall% AltLK
Tile horiBontall% AltL0
6o( tile AltL#
"efresh the tree AltL"
'arent topic+ Accessi.ilit% features
32 of 35 26-09-2014 11:23
9.#. I&M and accessibility
,ee the I6M9 Accessi.ilit% Center for more information a.out the commitment that I6M has to accessi.ilit%.
I6M Accessi.ilit% Center=.i.m.com?a.le>
'arent topic+ Accessi.ilit% features
33 of 35 26-09-2014 11:23
5. 4otices
This information as developed for products and services offered orldide.
I6M ma% not offer the products: services: or features discussed in this document in other countries. Consult %our local I6M representative for information on the
products and services currentl% availa.le in %our area. An% reference to an I6M product: program: or service is not intended to state or impl% that onl% that I6M
product: program: or service ma% .e used. An% functionall% eCuivalent product: program: or service that does not infringe an% I6M intellectual propert% right
ma% .e used instead. 3oever: it is the userIs responsi.ilit% to evaluate and verif% the operation of an% non<I6M product: program: or service.
I6M ma% have patents or pending patent applications covering su.@ect matter descri.ed in this document. The furnishing of this document does not grant %ou
an% license to these patents. Eou can send license inCuiries: in riting: to;
I6M &irector of Dicensing
I6M Corporation
7orth Castle &rive
Armon$: 7E 11)1'<1/*)
U.,.A.
For license inCuiries regarding dou.le<.%te =&6C,> information: contact the I6M Intellectual Aropert% &epartment in %our countr% or send inCuiries: in riting:
to;
Intellectual Aropert% Dicensing
Degal and Intellectual Aropert% Da
I6M !apan Dtd.
1+23<1': ,himotsuruma: Eamato<shi
5anagaa 2'2<*)12 !apan
The folloing paragraph does not appl% to the United 5ingdom or an% other countr% here such provisions are inconsistent ith local la; I7T#"7ATIO7AD
6U,I7#,, MAC3I7#, CO"AO"ATIO7 A"O-I&#, T3I, AU6DICATIO7 HA, I,H 0IT3OUT 0A""A7TE OF A7E 5I7&: #IT3#" #FA"#,, O" IMADI#&: I7CDU&I72:
6UT 7OT DIMIT#& TO: T3# IMADI#& 0A""A7TI#, OF 7O7<I7F"I72#M#7T: M#"C3A7TA6IDITE O" FIT7#,, FO" A AA"TICUDA" AU"AO,#. ,ome states do not
allo disclaimer of e(press or implied arranties in certain transactions: therefore: this statement ma% not appl% to %ou.
This information could include technical inaccuracies or t%pographical errors. Changes are periodicall% made to the information hereinJ these changes ill .e
incorporated in ne editions of the pu.lication. I6M ma% ma$e improvements and?or changes in the product=s> and?or the program=s> descri.ed in this
pu.lication at an% time ithout notice.
An% references in this information to non<I6M 0e. sites are provided for convenience onl% and do not in an% manner serve as an endorsement of those 0e.
sites. The materials at those 0e. sites are not part of the materials for this I6M product and use of those 0e. sites is at %our on ris$.
I6M ma% use or distri.ute an% of the information %ou suppl% in an% a% it .elieves appropriate ithout incurring an% o.ligation to %ou.
Dicensees of this program ho ish to have information a.out it for the purpose of ena.ling; =i> the e(change of information .eteen independentl% created
programs and other programs =including this one> and =ii> the mutual use of the information hich has .een e(changed: should contact;
I6M ,oftare 2roup
Attention; Dicensing
3/)) "iverside &r
Ottaa: O7 51- 16/
Canada
,uch information ma% .e availa.le: su.@ect to appropriate terms and conditions: including in some cases: pa%ment of a fee.
The licensed program descri.ed in this document and all licensed material availa.le for it are provided .% I6M under terms of the I6M Customer Agreement: I6M
International Arogram Dicense Agreement or an% eCuivalent agreement .eteen us.
An% performance data contained herein as determined in a controlled environment. Therefore: the results o.tained in other operating environments ma% var%
significantl%. ,ome measurements ma% have .een made on development<level s%stems and there is no guarantee that these measurements ill .e the same on
generall% availa.le s%stems. Furthermore: some measurements ma% have .een estimated through e(trapolation. Actual results ma% var%. Users of this
document should verif% the applica.le data for their specific environment.
Information concerning non<I6M products as o.tained from the suppliers of those products: their pu.lished announcements or other pu.licl% availa.le sources.
I6M has not tested those products and cannot confirm the accurac% of performance: compati.ilit% or an% other claims related to non<I6M products. Kuestions on
the capa.ilities of non<I6M products should .e addressed to the suppliers of those products.
All statements regarding I6MIs future direction or intent are su.@ect to change or ithdraal ithout notice: and represent goals and o.@ectives onl%.
This information contains e(amples of data and reports used in dail% .usiness operations. To illustrate them as completel% as possi.le: the e(amples include the
names of individuals: companies: .rands: and products. All of these names are fictitious and an% similarit% to the names and addresses used .% an actual
.usiness enterprise is entirel% coincidental.
If %ou are vieing this information softcop%: the photographs and color illustrations ma% not appear.
@
34 of 35 26-09-2014 11:23
@
5.1. 'roduct Information
This document applies to I6M Cognos TM1 -ersion 11.1.1 and ma% also appl% to su.seCuent releases. To chec$ for neer versions of this document: visit the
I6M Cognos Information Centers =http;??pu.li...oulder.i.m.com?infocenter?cogic?v1r1m1?inde(.@sp>.
Copyrig$t
Dicensed Materials < Aropert% of I6M
8 Cop%right I6M Corp. 2112.
U, 2overnment Users "estricted "ights M Use: duplication or disclosure restricted .% 2,A A&A ,chedule Contract ith I6M Corp.
I6M: the I6M logo: i.m.com: TM1: and Cognos are trademar$s or registered trademar$s of International 6usiness Machines Corp.: registered in man%
@urisdictions orldide. Other product and service names might .e trademar$s of I6M or other companies. A current list of I6M trademar$s is availa.le on the
0e. at H Cop%right and trademar$ information H at .i.m.com?legal?cop%trade.shtml.
The folloing terms are trademar$s or registered trademar$s of other companies;
Ado.e: the Ado.e logo: Aost,cript: and the Aost,cript logo are either registered trademar$s or trademar$s of Ado.e ,%stems Incorporated in the United
,tates: and?or other countries.
Microsoft: 0indos: 0indos 7T: and the 0indos logo are trademar$s of Microsoft Corporation in the United ,tates: other countries: or .oth.
Dinu( is a registered trademar$ of Dinus Torvalds in the United ,tates: other countries: or .oth.
U7IF is a registered trademar$ of The Open 2roup in the United ,tates and other countries.
!ava and all !ava<.ased trademar$s and logos are trademar$s or registered trademar$s of Oracle and?or its affiliates.
Microsoft product screen shot=s> used ith permission from Microsoft.
'arent topic+ 7otices
35 of 35 26-09-2014 11:23

05.cognos TM1 Operations Console Guide 10.1.0

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

05.cognos TM1 Operations Console Guide 10.1.0

Uploaded by

Copyright:

Available Formats

Cognos TM1 Operations Console Guide 10.1.

You might also like