Version 9.0.0
Operations Guide
Product Information
This document applies to IBM Cognos Express Version 9.0.0 and may also apply to subsequent releases. To check for newer versions of this
document, visit the IBM Cognos Information Centers (http://publib.boulder.ibm.com/infocenter/cogic/v1r0m0/index.jsp).
Copyright
Licensed Materials - Property of IBM
© Copyright IBM Corp. 2007, 2009.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
IBM, the IBM logo, ibm.com, and Cognos are trademarks or registered trademarks of International Business Machines Corp., 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 www.ibm.com/legal/copytrade.shtml.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium
are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.
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 of Sun Microsystems, Inc. in the United States, other countries, or both.
Microsoft product screen shot(s) reprinted with permission from Microsoft Corporation.
Table of Contents
Introduction 13
DownTime 31
ExcelWebPublishEnabled 31
GroupsCreationLimit 32
IdleConnectionTimeOut Seconds 32
IntegratedSecurityMode 32
IPAddress 32
Language 33
LDAPUseServerAccount 33
LDAPPasswordFile 33
LDAPPasswordKeyFile 34
LoggingDirectory 34
MaximumCubeLoadThreads 34
MaximumLoginAttempts 34
MaximumMemoryFor SubsetUndo 35
MaximumViewSize 35
MethodViewConsolidationOptimizationMethod 35
MessageCompression 36
PasswordMinimumLength 36
PasswordSource 36
PerformanceMonitorOn 36
PortNumber 36
PrivilegeGenerationOptimization 36
ProgressMessage 37
ReceiveProgressResponseTimeoutSecs 37
Reevaluate ConditionalFeeders 38
RunningInBackground 39
SAPLoggingEnabled 39
SAPLogFilePath 39
SaveTime 39
SecurityPackageName 39
ServerCAMURI 40
ServerLogging 40
ServerName 40
SkipLoadingAliases 40
SkipSSLCAMHostCheck 40
SpreadingPrecision 41
SpreadingPrecision 41
UserDefinedCalculations 42
UseSQLFetch UseSQLFetchScroll UseExtenedFetch 42
UseSSL 42
UseStargateForRules 43
ViewConsolidationOptimization 43
The Tm1p.ini File 43
Location of the TM1p.ini File 43
AdminHost 44
AdminSvrSSLCertAuthority 44
AdminSvrSSLCertID 44
AdminSvrSSLCertRevList 44
AdminSvrSSLExportKeyID 44
AdvancedRulesEditor 45
AllowImportCamClients 45
BrowseDisplayReadsRightToLeft 45
ClassicSliceMode 45
CognosGatewayURI 45
ConnectLocalAtStartup 45
DataBaseDirectory 46
DimensionDownloadMaxSize 46
DisplayApplications 46
DisplayChores 46
DisplayControlCubes 46
DisplayCubes 46
DisplayDimensions 46
DisplayExplorerPropertiesWindow 46
DisplayProcesses 47
DisplayReplications 47
ExpandRowHeaderWidth 47
ExportAdminSvrSSLCert 47
InSpreadsheetBrowser 47
IntegratedLogin 48
Language 48
LocalServerNetworkProtocol 48
MainWindowLayoutInfo 48
PreviousAdminHosts 48
PreviousDataDirectories 48
SecurityAssignmentWindowLayoutInfo 49
SentMsgsToServerCountWarning 49
ShowAdminHostChangeWarning 49
ShowAliasAttributeWarning 49
ShowChoresSchedulingWarning 49
ShowCubeReplicationWarning 49
ShowDimDeleteElementWarning 49
ShowDimensionAccessWarning 50
ShowDynamicSubsetWarning 50
ShowPickOperationWarning 50
ShowProcessUNASCIIWarning 50
ShowProcessUNODBCWarning 50
SliceNewWorkbook 50
SubsetWindowLayoutInfo 51
Operations Guide 5
Table of Contents
Operations Guide 7
Table of Contents
Operations Guide 9
Table of Contents
LDAPPasswordKeyFile 197
Configuring LDAP Validation 197
Run the TM1 Installation Wizard and Select LDAP Authentication 197
Change the Parameter in TM1S.cfg to TM1 197
Run the ETLDAP Utility 198
Modify Group Assignments for New Users 198
Change the PasswordSource Parameter in TM1S.cfg to LDAP 198
Operations Guide 11
Table of Contents
}Groups 254
}Hold 254
}PerfClients 254
}PerfCubes 255
}Processes 255
}StatsStatsByClient 255
}StatsStatsByCube 255
}StatsStatsByCubeByClient 256
}StatsStatsForServer 257
}TimeIntervals 257
Glossary 263
Index 269
IBM® Cognos® TM1 integrates business planning, performance measurement and operational
data to enable companies to optimize business effectiveness and customer interaction regardless of
geography or structure. TM1 provides immediate visibility into data, accountability within a col-
laborative process and a consistent view of information, allowing managers to quickly stabilize
operational fluctuations and take advantage of new opportunities.
Audience
The TM1 Operations Guide is written for TM1 system administrators who want to gain a basic
understanding of TM1 architecture, server operations, authentication, and component security.
You should have a programming background.
Related Documentation
Our documentation includes user guides, getting started guides, new features guides, release notes,
and other materials to meet the needs of our varied audience. The following documents contain
related information.
Note: For online product help users of this document, a Web page such as The page cannot be
found may appear when clicking individual links in the following table. Documents are made
available for your particular installation and translation configuration. If a link is unavailable, you
can access the document on one of the IBM Cognos Information Centers at http://publib.boulder.
ibm.com/infocenter/cogic/v1r0m0/index.jsp.
Document Description
IBM Cognos TM1 API Describes the functions and features of the IBM Cognos TM1 API.
The API is intended to give complete access to all the features and
functionality of the TM1 OLAP engine.
IBM Cognos TM1 Describes how to create and maintain objects on a TM1 server,
Developers Guide administer security, and develop TM1 applications.
Document Description
IBM Cognos TM1 Install- Describes how to install the IBM Cognos TM1 Software components
ation Guide on Windows and UNIX operating systems.
IBM Cognos TM1 Refer- A collection of reference materials that describes TM1 functions,
ence Guide variables, and other programming elements.
IBM Cognos TM1 Rules Describes how to use TM1 rules to build an application that reveals
Guide business data in sophisticated and useful ways based on simple raw
data.
IBM Cognos TM1 Tur- Describes how to use TM1 TurboIntegrator to import data and
boIntegrator Guide metadata into TM1 from a variety of sources.
IBM Cognos TM1 Users Describes how to use the TM1 Windows clients: TM1 Architect,
Guide TM1 Perspectives, and TM1 Client. It also describes the Web-based
client, TM1 Web.
Finding Information
Product documentation is available in online help from the Help menu or button in IBM Cognos
products.
To find the most current product documentation, including all localized documentation, access one
of the IBM Cognos Information Centers at http://publib.boulder.ibm.com/infocenter/cogic/v1r0m0/
index.jsp.
You can also read PDF versions of the product release notes and installation guides directly from
IBM Cognos product disks.
Getting Help
For more information about using this product, technical assistance, and education, visit the IBM
Cognos support pages at http://www.ibm.com.
This chapter describes the basic data structures that define IBM® Cognos® TM1.
TM1 Architecture
TM1 employs a distributed, client-server architecture that consists of remote TM1 servers to which
a combination of the following clients can connect:
● TM1 Perspectives
● TM1 Architect
In this environment, corporate data resides on remote servers, which authorized clients can access.
Depending on how you set up the system, clients can access one or more remote servers to obtain
different kinds of data. TM1 clients are described in detail in the IBM Cognos TM1 Users Guide.
TM1 Perspectives and TM1 Architect can connect to a local TM1 server, which acts as a repository
for private TM1 data. If you have the proper authority, you can copy data from a remote server to
your local server by replicating that data, and then synchronize your updates back to the remote
server.
TM1 Perspectives, TM1 Architect, and TM1 Client are standard TM1 clients. In a normal
LAN/WAN environment, these clients all communicate with a remote server using the TCP/IP
network protocol.
TM1 Clients
3 2 3
1 1
2. TM1 clients contact the Admin Server and receive information about the TM1 Servers that are
available.
3. After determining which servers are available, TM1 clients establish connections with TM1
Servers.
The Admin Server maintains the following information for each available TM1 server:
● Server name
● IP address
● Protocol
● Port number
All this information is supplied by a TM1 server when the server registers itself on the Admin Server.
An Admin Server must be running before a TM1 server can start. If you have specified an Admin
Host in the Tm1s.cfg file or the server command line, the TM1 server will attempt to connect to
an Admin Server on that host. The TM1 server will fail to come up if it is unable to connect to the
Admin Server for any reason.
If you have not specified an Admin Host, the TM1 server attempts to connect to an Admin Server
on the local machine. If an Admin Server is not currently running on the local machine, the TM1
server starts a new Admin Server and connects to it.
The Admin Server becomes aware of TM1 servers on the network by listening for notification from
the servers. Usually, a TM1 server sends notification of its presence at a regular interval called the
"heartbeat interval," which is 60 seconds by default. When the Admin Server detects a TM1 server,
that TM1 server becomes registered and available to clients on the network. However, if the Admin
Server does not detect the presence of a registered TM1 server over a period equal to three times
the heartbeat interval, that TM1 server is removed from the list of servers available on the network.
Consequently, the TM1 server will not be available to clients on the network.
By default, the Admin Server uses port 5495. If port 5495 is already in use, you can assign a new
port number by creating a new service called Tm1admsrv. All TM1 applications look for a named
service called Tm1admsrv, and if that service exists, the applications use the port number assigned
to the service. If the service does not exist, TM1 applications use port 5495.
4. Click Add.
The Create Shortcut dialog box opens.
5. Enter the full path to Tm1admsrv.exe in the Command line field, or click Browse to navigate
to the file.
6. If necessary, specify a command line parameter to set the heartbeat interval for the Admin
Server.
Parameter Description
7. Click Next.
The Select Program Folder dialog box opens.
Operations Guide 17
Chapter 1: TM1 System Architecture
8. Select Startup.
9. Click Next.
The Select a Title dialog box opens.
● Details of each TM1 server currently registered with the Admin Server
To shut down an Admin Server running as an application, click Stop Admin Server.
You cannot view the status of an Admin Server running as a Windows service.
● Details of each TM1 server currently registered with the Admin Server
● Specify the Admin Host with which remote servers register by using either the AdminHost
parameter in the Tm1s.cfg file or the -v command-line parameter when you bring up the Win-
dows® TM1 server.
For information on server parameters, see "The Tm1s.cfg File" (p. 23).
TM1 Files
TM1 requires numerous object and system files, most of which are stored in the TM1 server's data
directory. Some of these are installed with the product, while others are generated for each dimension
and cube you create. Yet other files are generated by TM1 to store metadata, such as security
information.
The following table lists the files that define cubes, dimensions, and other TM1 objects. These files
are located in the data directory, which is described later in this chapter.
Operations Guide 19
Chapter 1: TM1 System Architecture
Data Directory
The data directory contains the cubes, dimensions, and system information that are loaded into
memory when a TM1 server is started. When you access a server from TM1 Perspectives, TM1
Architect, or TM1 Client, TM1 reads data from that server's data directory.
When you run TM1, the changes you make to cube values are immediately stored in memory and
in the transaction log (Tm1s.log). TM1 then saves the data back to the data directory when any of
the following occur:
● TM1 server is shut down.
● An administrator right-clicks a server icon in Server Explorer and choose Save Data from the
pop-up menu. This directs TM1 to save the changes to the selected server.
● An administrator chooses File, Save Data All in Server Explorer. This directs TM1 to save the
changes to all the connected servers, if you have the proper authority.
Choose the path for your data directory when you install TM1.
You can change the.ini file by using the TM1 Options menu in Server Explorer.
For more information, see "The Tm1p.ini File" (p. 43).
● For a remote server, specify the location of the data directory by using either the DatabaseDir-
ectory parameter in the Tm1s.cfg file or the -d command-line parameter when you bring up
the server.
For information on server parameters, see "The Tm1s.cfg File" (p. 23).
A remote server must be able to recognize the drive where the data directory resides. If the directory
is on a remote drive, you must map that drive to a local drive letter.
Note: When you access a remote server, you do not need to map to the drive where the server data
directory resides.
If you do not specify the location of the data directory, the TM1 server will not be able to start and
the following error displays.
"Data Directory not specified. Aborting server startup."
● Writes changes to the directory where the object is located. When you create a new object,
TM1 writes to the first directory you had specified.
For example, suppose you want to store dimensions in a directory called tm1dims, and cubes in a
directory called tm1cubes. You would specify the following in the Tm1s.cfg file:
DatabaseDirectory="c:\tm1dims;c:\tm1cubes"
By concatenating the two directories, you can access these objects through Server Explorer as if
they were in a single location.
Operations Guide 21
Chapter 1: TM1 System Architecture
This chapter describes how you can configure the IBM® Cognos® TM1 server and clients.
● If you are running a TM1 remote server as a Windows application (Tm1s.exe), you specify the
location of the Tm1s.cfg file by using the -z parameter in the command line when you start the
server, either from a shortcut or from a command prompt.
For example, this command specifies that TM1 will use the Tm1s.cfg file located in the
c:\salesdata directory:
c:\Program Files\Cognos\TM1\bin\tm1s.exe
-z c:\salesdata
If the -z parameter points to a directory containing spaces, you must enclose the directory in
double quotes. For example, -z "c:\sales data".
● If you are running a TM1 UNIX® server, and you used the TM1 installation program to install
the server, the system uses the Tm1s.cfg file that is located in the server data directory you
specified during installation.
SaveTime=
DownTime=
PasswordSource=LDAP
LDAPPORT=389
LDAPHost=aplxmadc0
Note: The TM1 local server never polls for changes in the Tm1s.cfg file, so all parameters in a local
server's .cfg file must be considered static. If you change any Tm1s.cfg parameter values for a local
server, you must restart the server to apply the new parameter values.
Spaces in Values
If a parameter value contains spaces, you must enclose the parameter values within double quotes.
AdminHost
This parameter is required.
Specifies the computer name or IP address of the Admin Host on which an Admin Server is running.
You can specify multiple Admin Hosts by separating each host name with a semicolon on a Windows
TM1 server, or a colon on a UNIX® TM1 server. For example:
● Use the format AdminHost=hostname1;hostname2 on a Windows TM1 server.
● AdminHost=192.168.1.17;192.168.1.22
● AdminHost=boston;192.168.1.17;192.168.1.22;myserver;192.168.1.40
Note: The string specifying the admin host(s) is limited to 1020 characters or bytes.
AllowDynamicSlice
This parameter is optional.
Enables or disables dynamic slices on the TM1 server.
To disable dynamic slices, add the line AllowDynamicSlice=F to Tm1s.cfg.
To enable dynamic slices, add the line AllowDynamicSlice=T to Tm1s.cfg.
If you do not include the AllowDynamicSlice parameter in Tm1s.cfg, dynamic slices are enabled
by default on the TM1 server.
For details, see the IBM Cognos TM1 Users Guide.
AllowReadOnlyChore Reschedule
This parameter is optional.
Provides users with READ access to a chore, and the ability to activate, deactivate, and reschedule
chores.
When the line AllowReadOnlyChoreReschedule=T is added to the Tm1s.cfg file for a server, users
with READ access to a chore can right-click a chore in Server Explorer, and toggle the Activate
Schedule option or choose the Edit Chore option. The Edit Chore option is available only when a
chore is not activated.
When a user with READ access to a chore selects the Edit Chore option, only the scheduling screen
of the Chore Setup Wizard opens.
The scheduling screen lets the user set scheduling parameters for the chore, but does not allow the
user to edit the list of processes that compose the chore.
AllowSeparateNandCRules
This parameter is optional.
Specifies expressions for N: and C: levels on separate lines using identical AREA definitions,
maintaining the rules conventions of TM1 7.x.
For example,
['Budget','Argentina']=N:Expression;
['Budget','Argentina']=C:Expression;
are both valid rules statements when you include the AllowSeparateNandCRules parameter in the
Tm1s.cfg file and set to T.
To set the parameter to T, add the following line to Tm1s.cfg:
AllowSeparateNandCRules=T
AuditLogMaxFileSize
This parameter is optional.
Indicates the maximum file size that an audit log file can grow to before it is closed and a new file
is created.
Operations Guide 25
Chapter 2: TM1 System Configuration
This value must include units of KB (kilobytes), MB (megabytes), or GB (gigabytes). For example,
to limit the log file size to 100 MB, enter the following:
AuditLogMaxFileSize=100
MB
Default value: 100 MB
Minimum value: 1 KB
Maximum value: 2 GB
AuditLogMaxQueryMemory
This parameter is optional.
Indicates the maximum amount of memory that TM1 can use when running an audit log query
and retrieving the set of results.
This value must include units of KB (kilobytes), MB (megabytes), or GB (gigabytes). For example:
AuditLogMaxQueryMemory=100
MB
Default value: 100 MB
Minimum value: 1 KB
Maximum value: 2 GB
AuditLogMaxTempFileSize
This parameter is optional.
Indicates the maximum file size that the temporary audit log file can grow to before TM1 moves
the file's data into the final audit log.
This value must include units of KB (kilobytes), MB (megabytes), or GB (gigabytes). For example:
AuditLogMaxTempFileSize=100
MB
Default value: 100 MB
Minimum value: 1 KB
Maximum value: 2 GB
AuditLogOn
This parameter is optional.
Turns audit logging on (T) or off (F).
For example:
● To enable audit logging, set AuditLogOn=T.
Note: If you change this parameter value, you must restart the TM1 server to apply the new value.
AuditLogUpdateInterval
This parameter is optional.
Indicates the maximum amount of time, in minutes, that TM1 waits before moving the events from
the temporary audit file into the final audit log.
Example: AuditLogUpdateInterval=60
Default value is 60 (sixty minutes).
Minimum value is 1 (one minute).
Note: You can manually update the audit log with the latest events anytime you want by using the
Process Audit Log Events command in TM1 Server Explorer. For details, see "Updating the Audit
Log with the Latest Events".
CalculationThresholdFor Storage
This parameter is optional.
Defines a minimum number of rule calculations required for a single cell or Stargate view, beyond
which the TM1 server stores the calculations for use during the current server session.
For example, when a user requests rule-derived values from a TM1 server, either from a single cell
or a Stargate view, the server usually has to perform multiple rule calculations to arrive at the
requested rule-derived values.
CalculationThresholdForStorage has a direct effect on memory consumption and performance. A
high parameter value results in decreased memory consumption and slower performance. A low
parameter value results in increased memory consumption and faster performance.
If you do not include CalculationThresholdForStorage in Tm1s.cfg, the default calculation threshold
is 50.
CAMSSLCertificate
This parameter is optional.
The full path and name of the SSL certificate to be used when connecting to the internal dispatcher.
For example, C:\AxTM1\Install_Dir\ssl\CognosCert.cer.
This parameter is required only if the CAM server is configured to use SSL.
CheckFeedersMaximumCells
This parameter is optional.
Limits the number of cells checked by the Check Feeders option in the Cube Viewer. The Check-
FeedersMaximumCells is an optional parameter that you can add to Tm1s.cfg. If you do not include
this parameter in Tm1s.cfg, Check Feeders checks 3,000,000 cells, by default.
When TM1 checks feeders from a highly consolidated cell, TM1 must check all intersections that
apply to the cell. In large applications, the TM1 server will be unavailable for a significant amount
of time while TM1 is checking all intersections.
To limit the number of cells checked when using Check Feeders (which in turn limits the amount
of time the TM1 server is unavailable), add CheckFeedersMaximumCells to Tm1s.cfg and set the
parameter to the number of cells you want to check.
For example, to limit Check Feeders to 1,000,000 cells, enter the following line:
Operations Guide 27
Chapter 2: TM1 System Configuration
CheckFeedersMaximumCells=1,000,000
ClientCAMURI
This parameter is optional.
The URI for the IBM® Cognos® 8 Server IBM® Cognos Connection used to authenticate TM1
clients. The URI is specified in the form http[s]://host/cognos8/cgi-bin/cognos.cgi.
For example, http://10.121.25.121/cognos8/cgi-bin/cognos.cgi.
ClientPingCAMPassport
This parameter is optional.
Indicates the interval, in seconds, that a client should ping the CAM server to keep their passport
alive.
If an error occurs or the passport expires the user will be disconnected from the TM1 server.
CAMPortalVariableFile
This parameter is optional.
The path to the variables_TM1.xml in your C8 installation. In most cases, the path will be c8_
location\templates\ps\portal\variables_TM1.xml..
The variables_TM1.xml file is included as part of the TM1 Viewer Portlets installation. For details
on installing and configuring Viewer Portlets, see the IBM Cognos TM1 Installation Guide.
The CAMPortalVariableField parameter is required only when running TM1 Web.
ClientMessagePortNumber
This parameter is optional.
Identifies a secondary port used to accept client messages concerning the progress and ultimate
cancellation of a lengthy operation without tying up thread reserves.
This additional port ensures that other server requests can continue to process while waiting for a
cancellation from the user.
By default, this port number is automatically and dynamically assigned when the TM1 server starts.
You do not have to set ClientMessagePortNumber to a specific number unless firewalls or other
network issues require the listener port to be a well-known number.
Note: Be sure to assign unique port numbers for the server and client message ports. If you have
two servers running on the same machine with the same port number, the message activity may
cause a system failure.
See also "PortNumber" (p. 36) and "ProgressMessage" (p. 37).
ClientPropertiesSyncInterval
This parameter is optional.
Specifies the the frequency (in seconds) at which client properties are updated in the }ClientProperties
control cube.
ClientVersionMaximum
This parameter is optional.
Specifies the maximum client version that can connect to the TM1 server.
The parameter value is expressed as a three digit number without decimal points, corresponding
to the first three digits of the build number for the TM1 client version. For example, the build
number for TM1 9.0 SP3 is 9.0.3.173, so the correct parameter value for this client version is 903.
To determine the build number, choose Help, About from Server Explorer.
If this parameter is not explicitly set, the default value is equal to the currently installed server version.
Valid parameter values fall within the range x00 - currently installed server version, where x is the
base version of the currently installed TM1 server. For example, valid parameter values for TM1
server 9.0 SP3 fall within the range 900 - 903.
You cannot set ClientVersionMaximum to a value greater than the currently installed server version.
You cannot connect newer client versions to older server versions.
ClientVersionMinimum
This parameter is optional.
Specifies the minimum client version that can connect to the TM1 server.
The parameter value is expressed as a three digit number without decimal points, corresponding
to the first three digits of the build number for the TM1 client. For example, the build number for
TM1 9.0 SP3 is 9.0.3.173, so the correct parameter value for this client version is 903.
To determine the build number for a TM1 client, choose Help, About from Server Explorer.
If this parameter is not explicitly set, the default value is equal to the base version of the currently
installed TM1 server. Using TM1 server 9.0 SP3 as an example, the default value of ClientVersion-
Minimum is 900, which corresponds to the base version of the server.
You cannot set ClientVersionMinimum to a value lower than the base version of the currently
installed TM1 server. There is no upper limit for ClientVersionMinimum. However, if ClientVer-
sionMinimum is larger than ClientVersionMaximum, only clients with a version number equal to
ClientVersionMaximum can connect to the server.
DataBaseDirectory
This parameter is required.
Specifies the data directory from which the server loads cubes, dimensions, and other objects. You
can list multiple data directories by separating them with semicolons.
For details, see "Data Directory".
Operations Guide 29
Chapter 2: TM1 System Configuration
DefaultMeasuresDimension
This parameter is optional.
TM1 does not require that a measures dimension be defined for a cube. You can optionally define
a measures dimension by modifying the cube properties. For more information, see "Control
Cubes" (p. 235).
However, some OLAP applications do require that a measures dimension be present in all cubes,
and may fail if such a dimension is not present. To accommodate these applications, set Default-
MeasureDimension=T to instruct the TM1 server to automatically define the last dimension in a
cube as the measures dimension when a new cube is created on the TM1 server.
If DefaultMeasureDimension is set to F or is ommitted from Tm1s.cfg, a measures dimension is
not defined for when a cube is created.
DisableMemoryCache
This parameter is optional.
Disables the memory cache used by TM1 memory manager. Enable this parameter only to debug
memory leaks. When you enable this parameter, there might be a decrease in server performance.
DisableWorksheetView
This parameter is optional.
Please contact customer support to determine if this parameter is applicable to your TM1 system.
DisableWorksheetView disables any VIEW functions contained in slice worksheets. Any slice
worksheets containing a VIEW function remain functional, but the function does not generate a
Stargate view.
Generally, you should disable the worksheet VIEW functions when you work with extremely large
row or column dimensions in slice worksheets. The VIEW function generates a Stargate view that
contains all row and column dimension elements, and not just those elements contained in the
current row and column subsets. With the Stargate view, you might experience decreased performance
when, for example, a row dimension contains 9,000 elements but only 20 elements are actually
used in the row subset.
To disable the slice worksheet VIEW functions, add the following line to Tm1s.cfg:
DisableWorksheetView=T
Display_Info_DBType_R8
This parameter is optional.
Please contact customer support to determine if this parameter is applicable to your TM1 system.
Display_Info_DBType_R8 instructs the TM1 server to store DISPLAY_INFO column data as
DBTYPE_R8.
By default, TM1 stores the DISPLAY_INFO as DBTYPE_UI4. When the TM1 OLE DB provider
processes a request from ADO 2.7 for the DISPLAY_INFO column data, the provider has to convert
TM1 column data from DBTYPE_UI4 to a DBTYPE_R8. The TM1 OLE DB provider then returns
the converted column data to the OLE DB client (ADO in this case).
ADO 2.7 expects IRowset::GetData to return an integer, and uses only the first 4 bytes of the con-
verted column data. However, the returned data is an 8-byte real number, and as a result, all
information in the last 4 bytes is lost. This causes ADO 2.7 to return zeroes for all the items of the
DISPLAY_INFO column.
When you include the Display_Info_DBType_R8 parameter in the Tm1s.cfg file and set the parameter
to T, the TM1 server stores DISPLAY_INFO column data as DBTYPE_R8 with the relevant 4 bytes
of information in the first 4 bytes. The Display_Info_DBType_R8 parameter ensures that the
information is not lost when ADO converts the data back to an integer of 4 bytes. The parameter
also ensures that ADO 2.7 returns the correct values for the properties of an axis rowset member.
Additionally, the parameter ensures that any OLE DB client (such as ADO 2.6) requesting the
DISPLAY_INFO property as a 4 byte value, gets the correct values.
DownTime
This parameter is optional.
Specifies a time when the server will come down automatically. The format of the DownTime
parameter is dd:hh:mm where:
● dd is the number of days from today. (For example, 00 is today, and 01 is tomorrow.)
For example, DownTime = 01:03:30 specifies that you want to bring the server down on the fol-
lowing day at 3:30 in the morning.
The DownTime parameter is not available when you run the TM1 server as a Windows service.
When you use the DownTime parameter on the UNIX® TM1 server, you must set the RunningIn-
Background parameter to T. If RunningInBackground=F, the server prompts for confirmation
before shutting down and cannot shut down without manual confirmation from an administrator.
ExcelWebPublishEnabled
This parameter is optional.
Use this parameter to enable the publication of Excel files to TM1 Web, as well as the export of
Excel files from TM1 Web, when Excel is not installed on the Web Server.
If ExcelWebPublishEnabled=T, Excel files in TM1 Applications can be published to TM1 Web
without using Excel on the Web server. Similarly, Websheets and Cubeviewers can be exported
from TM1 Web without using Excel on the Web server.
When Excel is not available on the Web server, Excel files in TM1 Applications must be explicitly
published to TM1 Web.
For details about the procedure required to publish Excel files, see the IBM Cognos TM1 Developers
Guide.
For details about limitations exporting from TM1 Web without using Excel on the Web server, see
the IBM Cognos TM1 Users Guide.
Operations Guide 31
Chapter 2: TM1 System Configuration
GroupsCreationLimit
This parameter is optional.
Sets the maximum number of groups that can be created in one TM1 server session. The
GroupsCreationLimit parameter accepts a value of any positive integer. The maximum number of
groups for GroupsCreationLimit is 65535. The maximum number of groups that can exist on a
server is 65535. If you do not use the parameter, the default number of groups is 20.
For example, to create 50 groups per server session, enter the following line:
GroupsCreationLimit=50
Note: When TM1 allocates memory to store security information, the server calculates the amount
of memory required based in part on the value of GroupsCreationLimit. In some circumstances
when your TM1 model is large and the GroupsCreationLimit parameter is set to an exceptionally
high value, the server will attempt to allocate memory beyond the available capacity on the server.
The TM1 server will fail to load and will issue a Server Out of Memory message. To avoid this
situation, set GroupsCreationLimit to a value that accurately reflects the maximum number of user
groups you may need to create during a server session.
The GroupsCreationLimit value is not enforced when you create groups with the AddGroup function
in TurboIntegrator.
IdleConnectionTimeOut Seconds
This parameter is optional.
Specifies a timeout limit for idle client connections, in seconds.
For example, if you include the line IdleConnectionTimeOutSeconds=900 in Tm1s.cfg, the server
disconnects idle client connections after 900 seconds.
IntegratedSecurityMode
This parameter is optional.
This parameter sets the authentication mode to be used by the TM1 server.
If IntegratedSecurityMode=1, the server uses secure mode.
If IntegratedSecurityMode=2, the server uses mixed mode.
If IntegratedSecurityMode=3, the server uses Integrated Login.
If IntegratedSecurityMode=4, the server uses IBM® Cognos® Access Manager (CAM) authentication.
When you install the TM1 server, the IntegratedSecurityMode parameter is set to 2. This is mixed
mode, which allows you to login to TM1 using either standard TM1 security or LDAP security.
The reason the IntegratedSecurityMode parameter is set this way is that it is often necessary to log
in to TM1 using standard TM1 security when you are setting up Integrated Login or CAM
authentication.
IPAddress
This parameter is optional.
This parameter lets you specify multiple IP addresses for an individual TM1 server. For example,
a server can use one IP address for clients within a firewall and a different IP address for clients
outside the firewall.
Note:When this parameter is used in the Tm1s.cfg file, both the TM1 Server and TM1 Admin Server
must run on the same computer. If this parameter is used in the Tm1s.cfg file, but the TM1 Server
and TM1 Admin Server reside on different computers, TM1 clients will receive an error when they
attempt to log in to the TM1 Server.
If the TM1 Server and TM1 Admin Server reside on different computers, you can configure the
Admin Server to use multiple IP addresses for an individual TM1 Server by adding an initialization
file named Tm1admsrv.ini to the directory where the Admin Server executable resides. For details,
please see "TM1 Admin Server" (p. 15).
The following example specifies two IP addresses for a TM1 server:
IPAddress="130.5.32.0; 130.5.64.0"
Note: The addresses must be enclosed in a single set of quotation marks and separated by a semi-
colon.
When you specify multiple IP addresses for a server, the associated Admin Server recognizes all
addresses but displays only the first IP address in the Admin Server window.
Language
This parameter is optional.
Sets the language used in the TM1 interface.
Valid values are:
● ENG - English
● FRA - French
● DEU - German
● JPN - Japanese
● ITA - Italian
● ESP - Spanish
LDAPUseServerAccount
See "LDAP Authentication" (p. 195).
LDAPPasswordFile
See "LDAP Authentication" (p. 195).
Operations Guide 33
Chapter 2: TM1 System Configuration
LDAPPasswordKeyFile
See "LDAP Authentication" (p. 195).
LoggingDirectory
This parameter is optional.
Specifies the directory to which the server saves its log files. If you do not supply this parameter,
the log files are saved to the first data directory specified by the DataBaseDirectory parameter.
MaximumCubeLoadThreads
This parameter is optional.
Specifies whether the cube load and feeder calculation phases of server loading are multi-threaded,
so multiple processors can be used in parallel. This results in decreased server load times.
To run in multi-threaded mode, you should set MaximumCubeLoadThreads to the number of
processors on the TM1 server that you want to dedicate to cube loading and feeder processing.
Generally, the best performance is achieved when the parameter is set to a value equal to (number
off available processors) - 1. For example, if the TM1 server is running on a four-processor machine,
MaximumCubeLoadThreads should be set to 3. This ensures that one processor is available to run
other applications while the TM1 server is loading.
When MaximumCubeLoadThreads is set to 0, cube loading and feeder processing is NOT multi-
threaded. This is the default behavior when MaximumCubeLoadThreads is not explicitly set in the
Tm1s.cfg file.
Note: When MaximumCubeLoadThreads is enabled, TM1 cannot manage the order in which
feeders are calculated. There may be cases where processing order has an adverse effect on your
application due to some order-of-evaluation dependencies in the multi-threaded environment.
If your TM1 model uses conditional feeders where the condition clause contains a fed value, you
should set MaximumCubeLoadThreads=0 or exclude the parameter from the Tm1s.cfg file to disable
the use of multiple threads at load time.
MaximumLoginAttempts
This parameter is optional.
Sets the maximum number of failed user login attempts permissible on the server. If you do not
include MaximumLoginAttempts in Tm1s.cfg, by default, the server allows three login attempts.
For example, if you add the line MaximumLoginAttempts=5 to Tm1s.cfg, the server enforces a
limit of five failed login attempts per user. If a user does not successfully log in to the TM1 server
within the specified number of attempts, the server issues an error.
After a user has exceeded the specified maximum number of failed login attempts, the TM1 server
rejects any subsequent login attempts by the user.
The MaximumLoginAttempts parameter is enforced per server session. If a user exceeds the maximum
number of attempts, he cannot log in to the current TM1 server session, unless the TM1 adminis-
trator changes his password. However, after the TM1 server recycles, the user can log in with his
existing password.
MaximumMemoryFor SubsetUndo
This parameter is optional.
Sets the maximum amount of memory, in kilobytes, to be dedicated to storing the Undo/Redo stack
for the Subset Editor. For example, adding the line MaximumMemoryForSubsetUndo=20480 to
the configuration file instructs the server to allot 20480 kilobytes (20 MB) of memory for the
Undo/Redo stack.
Generally, larger subsets require greater amounts of memory to store a useable Undo/Redo stack.
If you find that the TM1 server is not storing a sufficient number of Undo/Redo steps for your
subsets, increase the value of MaximumMemoryForSubsetUndo.
If this parameter is not explicitly set in the Tm1s.cfg file, the maximum amount of memory dedicated
to the Undo/Redo feature of the Subset Editor is 10240 kilobytes (10 MB).
MaximumViewSize
This parameter is optional.
Sets the maximum amount of memory (in MB) to be allocated when a user accesses a view. If you
do not set the MaximumViewSize parameter, the default maximum view size is 100MB on a 32-
bit system, and 500 MB on a 64-bit system.
To specify a maximum amount of memory allocation for views, add the following line to Tm1s.cfg:
MaximumViewSize=n
where n represents the amount of memory in MB to be allocated.
MethodViewConsolidationOptimizationMethod
This parameter defines the method used to achieve view consolidation optimization when the
ViewConsolidationOptimization parameter is enabled on the TM1 server.
There are two methods that ViewConsolidationOptimization can use to calculate and store consol-
idations: ARRAY or TREE. The ARRAY method stores consolidations in a temporary array. The
TREE method stores consolidations in a tree.
ViewConsolidationOptimizationMethod should be set to TREE in most circumstances. This setting
provides the best performance in normal operations and when data is sparse along the view axes.
In the uncommon circumstance when axes dimensions have just a few leaf elements rolling up to
many consolidations, ViewConsolidationOptimizationMethod should be set to ARRAY.
To set this parameter, add the appropriate line to your configuration file:
ViewConsolidationOptimizationMethod=TREE
ViewConsolidationOptimizationMethod=ARRAY
If ViewConsolidationOptimizationMethod is not explicilty
set in the Tm1s.cfg file, the ARRAY method is used by default.
Operations Guide 35
Chapter 2: TM1 System Configuration
MessageCompression
This parameter is optional.
Enables message compression for large messages that significantly reduces network traffic. The
parameter is enabled by default.
To disable message compression, add the following line to Tm1s.cfg:
MessageCompression=F
PasswordMinimumLength
This parameter is optional.
Specifies a minimum password length for clients accessing the server.
PasswordSource
This parameter is optional.
See "LDAP Authentication" (p. 195).
PerformanceMonitorOn
This parameter is optional.
Automatically starts populating the }Stats control cubes when a server starts. The control cubes
contain statistics that you can review to monitor the system performance. For details on control
cubes, see "Control Cubes" (p. 235).
PortNumber
This parameter is optional.
Sets the server port number used to distinguish between multiple servers running on the same
computer. When multiple TM1 servers are installed on a single computer, each server must use a
unique port number.
When you install a TM1 server, the default port number is 12345. Valid port numbers are between
5001 and 49151.
If the Tm1s.cfg file does not contain the PortNumber parameter, the TM1 server uses port 5000.
Local TM1 servers use port 5000. The port used for Client Messages must also be a unique port
number and is set to 5001 by default when the ClientMessagePortNumberparameter is used.
PrivilegeGenerationOptimization
This parameter is optional.
When the TM1 server generates security privileges from a security control cube, it reads every cell
from that cube. If the security control cube is sparsely populated, this results in unnecessary pro-
cessing and a longer loading time. An example of a sparsely populated security cube would be one
that has a greater ratio of default security settings compared to defined security settings.
To address this issue, the PrivilegeGenerationOptimization parameter can be added to the Tm1s.cfg
file as follows:
PrivilegeGenerationOptimization=T
When this parameter is set to T, the TM1 server will read only the populated cells in security cubes.
In the case of a sparsely populated security cube, this will dramatically shorten the TM1 server's
load time.
Note: If you populate the security settings via rules and want to use this parameter, you must write
feeders for the rules that populate your security cubes. Because security settings are stored as strings,
the rules that populate your security cubes must include the FeedStrings function.
ProgressMessage
This parameter is optional.
This parameter determines whether users have the option to cancel lengthy view calculations. When
a user opens a view that takes a significant amount of time to calculate (usually a view with high
levels of consolidation or complex rules), TM1 monitors the progress of the process. When Progress-
Message=T a dialog box opens that allows the user to Stop Building View.
If the user clicks Stop Building View, the view is discarded on the client, but view calculation con-
tinues on the server. In some instances, this can tie up the server.
● If ProgressMessage=F, the Stop Building View option is not offered and the user cannot cancel
lengthy operations. This setting helps avoid potential server tie ups in versions 9.1 SP3 through
9.4.
● When ProgressMessage=T or is not present in the Tm1s.cfg file, the Stop Building View option
opens during lengthy view calculations so the user can cancel the process if necessary. For ver-
sions 9.4 or later, the user can assign a unique Port Number using ClientMessagePortNumber.
This additional port allows these progress messages to travel via a secondary port so that server
processing can continue without tying up thread reserves.
Note:To avoid potentially tying up servers, TM1 9.1 SP3 through 9.4 have ProgressMessage=F
inserted into the Tm1s.cfg file during server installation. As of TM1 9.4, progress messages can
travel via the secondary port assigned by ClientMessagePortNumber so TM1 9.4 and later have
ProgressMessage=T set by default.
ReceiveProgressResponseTimeoutSecs
This parameter is optional.
When the TM1 server is performing lengthy operations for a client, periodic "progress" messages
are sent to the TM1 client application. The client responds to these messages with an indication of
whether the user has pressed the Cancel button, in which case the lengthy operation is terminated.
These responses are generated automatically by the network code in the client application; there is
no user interaction involved. After sending the progress message the server waits for a response
from the client application. As the server is waiting, the client's thread will continue to hold resource
locks on the TM1 server, preventing other users from making other server requests which require
the same resource locks.
Operations Guide 37
Chapter 2: TM1 System Configuration
In some particular situations, most notably running TM1 clients under a Citrix environment, the
response from the client application never arrives back at the TM1 server, causing the server to
wait for an infinite amount of time. This results in a system lockup, because the client's thread holds
resource locks that are never released.
The ReceiveProgressResponseTimeoutSecs parameter lets you configure your server to detect this
situation and to sever the client connection, releasing the resources. When the parameter is set to
a valid interval (in seconds), the server process will terminate the client connection, releasing any
resource locks, if the server does not detect the client application's response within the specified
interval.
For example, if ReceiveProgressResponseTimeoutSecs=20 and the client application does not respond
to the progress message sent from the server within 20 seconds, the client connection is terminated.
Again, no user action is required to generate this response. The response is automatically generated
by the client application, so that if the response does not arrive within 20 seconds, it is an indication
that there is something seriously wrong with the client or the underlying network.
ReceiveProgressResponseTimeoutSecs is an optional Tm1s.cfg parameter. If the parameter is not
present in the Tm1s.cfg file, processes are not terminated when a client does not respond to a progress
message from the TM1 server.
For some TM1 installations (version 9.4 or later), the ClientMessagePortNumber defines a separate
thread to use for cancellation messages without tying up reserves. When ClientMessagePortNumber
is available, ReceiveProgressResponseTimeoutSecs is not used.
Reevaluate ConditionalFeeders
This parameter is optional.
In some instances, when a cell is fed based on a condition being either true or false, a change in the
condition value does not trigger the feeder. For example, suppose your rule has the following feeder
structure:
● Cell A feeds cell B.
Assuming condition D is false, a change in the value of cell A triggers the feeding of cell B, but the
feeding of cell B does not trigger the feeding of cell C. At this point, condition D is false, and cell
C is fed only when the condition is true.
If condition D subsequently becomes true but the value of cell A does not change, cell C remains
unfed. This can lead to inconsistencies in data.
If you add the line ReevaluateConditionalFeeders=T to Tm1s.cfg, any changes to cell values refer-
enced by conditional feeders will force the feeder to be re-evaluated.
In the above example, any change to a cell value that causes condition D to become true would
force a re-evaluation of the conditional feeder, resulting in cell B feeding cell C. Other changes to
the cube, such as changes to attributes, do not force the feeder to be re-evaluated. Only cell value
changes trigger the re-evaluation.
RunningInBackground
This parameter is optional.
When you add the line RunningInBackground=T to Tm1s.cfg, the UNIX® TM1 server runs in
background mode.
SAPLoggingEnabled
This parameter is optional.
When a TurboIntegrator process imports objects and/or data from SAP RFC, you can configure
your TM1 server to log all activity between TM1 and SAP.
Add the line SapLoggingEnabled=T to your Tm1s.cfg file to enable SAP logging. If this parameter
is not present in the Tm1s.cfg file, or if the parameter is set to F, SAP activity is not logged.
If SapLoggingEnabled=T you must also set the SapLogFilePath parameter.
SAPLogFilePath
This parameter is optional.
This parameter sets the log file to receive SAP logging information.
You should specify the full path to the log file, for example, SapLogFilePath=c:\SAPdata\tm1_sap.
log.
SaveTime
This parameter is optional.
Sets the time of day to execute an automatic save of server data; saves the cubes every succeeding
day at the same time. As with a regular shutdown, SaveTime renames the log file, opens a new log
file, and continues to run after the save.
The SaveTime parameter is not available when running the TM1 server as a Windows service.
The format of the SaveTime parameter is dd:hh:mm where:
● dd is the number of days from today that the system will start automatically saving data. For
example, 00 is today, 01 is tomorrow.
SecurityPackageName
This parameter is optional.
If you configure the TM1 server to use Integrated Login, the SecurityPackageName parameter
defines the security package that authenticates your user name and password in Windows.
Valid values are:
● Kerberos (default) - Windows 2000 or later.
Operations Guide 39
Chapter 2: TM1 System Configuration
For complete descriptions of all login security modes, including Integrated Login, see "Integrated
Login" (p. 183).
ServerCAMURI
This parameter is optional.
The URI for the internal dispatcher that the TM1 server should use to connect to CAM. The URI
is specified in the form http[s]://<host IP address>:<port>/p2pd/servlet/dispatch.
For example, http://10.121.25.121:9300/p2pd/servlet/dispatch or https://10.121.25.121:9300/p2pd/
servlet/dispatch
ServerLogging
This parameter is optional.
Generates a log with the security activity details on the TM1 server that are associated with Integrated
Login. The log file, named Tm1server.log, is saved to the TM1 server data directory. The Server-
Logging parameter is useful only if your TM1 server is configured to use Integrated Login.
Set ServerLogging to T in Tm1s.cfg.
ServerName
This parameter is optional.
Sets the name of the TM1 server. If you do not supply this parameter, TM1 names the server Local
and treats it as a local server.
SkipLoadingAliases
This parameter is optional.
Please contact customer support to determine if this parameter is applicable to your TM1 system.
Use SkipLoadingAliases to speed up the loading of the server and updating of views by skipping
the loading of aliases.
Valid values are:
● T - Aliases skipped
● F - Aliases loaded
SkipSSLCAMHostCheck
This parameter is optional.
Indicates whether the SSL certificate ID confirmation process can be skipped. The default is FALSE.
Important: This parameter should be set to TRUE only if using a generic certificate for demonstration
purposes.
SpreadingPrecision
Floating point arithmetic on computers is not 100% precise. When a computer calculates very small
numbers, a margin of error is applied to the calculation. If the computer adds a set of numbers,
and the resulting sum is close to the target value within the margin of error, the sum is considered
accurate.
The margin of error for certain TM1 calculations is controlled through the SpreadingPrecision
parameter. The default value is SpreadingPrecision=1e-8. This value is used in the following
spreading scenarios:
● Spreading from a consolidated cell.
● SpreadingPrecision=1e-8
● SpreadingPrecision=1e-10
● SpreadingPrecision=1e-12
SpreadingPrecision
Spreading and Consolidated Holds
You can also use SpreadingPrecision under these conditions:
● When you spread values to some leaf cells that roll up into a consolidation
For example, suppose you have the consolidation Q1 with values Jan, Feb, and Mar.
If Q1- has a consolidated hold applied, and you spread values to Jan and Feb, TM1 does the fol-
lowing:
● Applies the spreading to Jan and Feb.
Operations Guide 41
Chapter 2: TM1 System Configuration
● Adjusts Mar.
If the sum is accurate to within the margin of error specified by the SpreadingPrecision parameter,
the spread succeeds. If the sum falls outside the margin of error specified by the SpreadingPrecision
parameter, TM1 generates an error.
UserDefinedCalculations
Enables user-defined consolidations on a TM1 server. By default, UserDefinedCalculations is
enabled.
To disable user-defined consolidations on a server, add the following line to Tm1s.cfg:
UserDefinedCalculations=F
UseSSL
Enables or disables SSL on the TM1 server.
Set UseSSL=T to enable SSL. With this setting, only TM1 9.1 and later clients will be able to securely
connect to the server.
Set UseSSL=F to disable SSL. With this setting, all TM1 clients, including older clients that do not
support SSL, will be able to connect to the server in insecure mode.
When UseSSL=T, you must set several other Tm1s.cfg parameters that manage SSL implementation.
For details on these parameters, see "Running TM1 in Secure Mode Using SSL" (p. 209).
UseStargateForRules
By default, any time a rule references a calculated value, the value is retrieved from a Stargate view
stored in memory (if available). By using the Stargate view for rules, in most cases, there is a signi-
ficant improvement in performance. It is more efficient to retrieve a calculated value from memory
than to request and retrieve a calculation from the server.
In some unique instances that are difficult, if not impossible, to determine in advance and can only
be determined through trial and error, retrieving a calculated value from a Stargate view is actually
slower than requesting and retrieving the value from the server. In these instances, add the following
line to Tm1s.cfg to instruct the TM1 rules to always retrieve the calculated values from the server
and improve performance.
UseStargateForRules=F
We strongly recommend that you contact Customer Support to review any performance issues you
might be experiencing before adding the UseStargateForRules parameter.
ViewConsolidationOptimization
Enables or disables view consolidation optimization on the TM1 server, which improves the per-
formance of calculating consolidated elements. By default, ViewConsolidationOptimization is
enabled on the TM1 server.
View consolidation optimization stores the consolidated values that use leaf element components
on either the row or column axis. For example, consider the dimension structure Year, 1Quarter
with values Jan, Feb, and Mar.
When either a row or column subset uses the Jan element, both the 1 Quarter and Year consolidations
are calculated and stored for future reference. This improves performance but increases the amount
of memory required for a given view.
To disable view consolidation optimization, add the following line to Tm1s.cfg:
ViewConsolidationOptimization=F
Operations Guide 43
Chapter 2: TM1 System Configuration
The system default version of Tm1p.ini allows multiple users to use TM1 on a given computer.
Tm1p.ini must be present the first time a user starts TM1on the computer, as the parameters in the
system default version govern the behavior of the initial startup of the TM1 client for each user.
After a user starts TM1 on the computer, a user-specific copy of Tm1p.ini is created in %APPDATA
%\Applix\TM1\Tm1p.ini. In most cases, the full path to the Tm1p.ini file is
C:\Documents and Settings\<user name>\Application
Data\Applix\TM1\Tm1p.ini.
The user-specific copy of Tm1p.ini accepts all parameters settings and changes for the user and
governs the behavior of the TM1 client for all subsequent user sessions of the TM1 client.
The TM1 Options dialog box also stores many of these settings. You can change these settings
using either the TM1 Options dialog box or by editing the Tm1p.ini file. The Tm1p.ini parameters
and TM1 Options are described here.
AdminHost
Displays the Admin Host name on which an Admin Server is running. On TM1 Options, use Login
Parameters Admin Host.
AdminSvrSSLCertAuthority
The full path of the certificate authority file that issued the TM1 Admin Server's certificate. On
TM1 Options, use Certificate Authority.
AdminSvrSSLCertID
The name of the principal to whom the TM1 Admin Server's certificate is issued.
Note: The value of this parameter should be identical to the SSLCertificateIDparameter in the
Tm1admsrv.ini file.
On TM1 Options, use Certificate ID.
AdminSvrSSLCertRevList
The full path of the certificate revocation file issued by the certificate authority that issued the TM1
Admin Server's certificate.
A certificate revocation file will only exist in the event a certificate had been revoked. On TM1
Options, use Certificate Revocation List.
AdminSvrSSLExportKeyID
The identity key used to export the certificate authority certificate, which originally issued the TM1
Admin Server's certificate, from the certificate store.
This parameter is required only if you choose to use the certificate store by setting ExportAdminS-
vrSSLCert=T.
On TM1 Options, use Export Certificate ID.
AdvancedRulesEditor
Indicates the type of Rules Editor used. The Advanced Rules Editor has an enhanced interface.
● T - The Enhanced Rules Editor is used.
AllowImportCamClients
This parameter is required only when configuring TM1 to use CAM authentication. It must be set
to T when importing an administrative user from CAM into TM1.
If your TM1 server is not configured to use CAM authentication, this parameter should be set to
F or omitted from the Tm1p.ini file.
For details, see "Setting Up a TM1 Server to Use IBM Cognos 8 Security" (p. 201).
BrowseDisplayReadsRightToLeft
Indicates how data is oriented in the Cube Viewer. Data can display right to left or left to right.
● T - Data is oriented right to left.
ClassicSliceMode
Indicates whether the Slice option in the Cube Viewer generates classic slices or dynamic slices.
● T - Slice option generates classic slices.
CognosGatewayURI
This parameter is required only when configuring TM1 to use CAM authentication. It must be set
to the URI of your IBM Cognos 8 gateway. The URI is specified in the form http[s]://host/cognos8/
cgi-bin/cognos.cgi. For example, http://win2003test/cognos8/cgi-bin/cognos.cgi.
If your TM1 server is not configured to use CAM authentication, this parameter should be omitted
from the Tm1p.ini file.
For details, see "Setting Up a TM1 Server to Use IBM Cognos 8 Security" (p. 201).
ConnectLocalAtStartup
Indicates whether TM1 Architect or TM1 Perspectives automatically connects to the local server
at startup.
● T (Default) - TM1 connects to the local server at startup.
Operations Guide 45
Chapter 2: TM1 System Configuration
DataBaseDirectory
Uses the full path to the local server data directory. You can specify multiple data directories by
separating the directory names with semicolons.
DimensionDownloadMaxSize
A threshold value of the number of elements in a dimension, beyond which the dimension is
downloaded and cached on the TM1 client. To improve performance when you work with large
dimensions, add DimensionDownloadMaxSize so that large dimensions will cache on the client.
DisplayApplications
Indicates whether the Applications group is visible in Server Explorer on startup.
● T - Applications group is visible in Server Explorer.
DisplayChores
Indicates whether the Chores group is visible in Server Explorer on startup.
● T - Chores group is visible in Server Explorer.
DisplayControlCubes
Indicates whether the Control Cube group is visible in Server Explorer on startup.
● T - ControlCube group is visible in Server Explorer.
DisplayCubes
Indicates whether the Cubes group is visible in Server Explorer on startup.
● T - Cubes group is visible in Server Explorer.
DisplayDimensions
Indicates whether the Dimensions group is visible in Server Explorer on startup.
● T - Dimensions group is visible in Server Explorer.
DisplayExplorerPropertiesWindow
Indicates whether the Properties pane is visible in Server Explorer on startup.
DisplayProcesses
Indicates whether the Processes group is visible in Server Explorer at startup.
● T - Processes group is visible in Server Explorer.
DisplayReplications
Indicates whether the Replications group is visible in Server Explorer at startup.
● T - Replications group is visible in Server Explorer.
ExpandRowHeaderWidth
Indicates if the Row Headers will automatically expand to accommodate the width of the longest
entry in the column.
● T(Default) - Row headers auto-expand.
ExportAdminSvrSSLCert
Select this option if you want the certificate authority certificate which originally issued the TM1
Admin Server's certificate to be exported from the Windows certificate store at runtime.
● T(Default) - Original certificate is exported from the Windows certificate store.
InSpreadsheetBrowser
Indicates if the In-Spreadsheet Browseror the Cube Viewer is the default browser.
● T - In-Spreadsheet Browser is the default browser. When you double-click a cube or view, it
opens in an Excel document.
● F (Default) - Cube Viewer is the default browser. When you double-click a cube or view, it
opens in the Cube Viewer.
Operations Guide 47
Chapter 2: TM1 System Configuration
IntegratedLogin
Indicates if your TM1 client uses Integrated Login or the standard TM1 security to log in to the
TM1 server and other TM1 components.
● T - Client uses Integrated login, where your Windows login username and password are used
to access the TM1 server and other components.
● F (Default) - Client uses standard TM1 security, where a username and password must be
explicitly provided, when logging in to the TM1 server and other components.
Before you enable this parameter, consult with your TM1 administrator to determine if Integrated
Login is implemented on your TM1 server.
On TM1 Options, use Integrated Login.
Language
Indicates the language used in the TM1 interface.
● ENG - English
● FRA - French
● DEU - German
● JPN - Japanese
● ITA - Italian
● ESP - Spanish
LocalServerNetworkProtocol
Determines the protocol that the local TM1 server uses to communicate with clients. Currently,
the only valid setting is TCP.
MainWindowLayoutInfo
Generates dimension and position coordinates for the Server Explorer window; allows Server
Explorer dimensions and position to be maintained between sessions.
The coordinates are automatically generated when you move or resize the Server Explorer window.
PreviousAdminHosts
Lists up to six of the most recently accessed Admin Hosts from the TM1 OptionsAdmin Host list.
PreviousDataDirectories
Lists up to six of the most recently accessed data directories in the Local Server Data Directory list
from the TM1 Options.
The directories accessed within a single session are separated by semicolons. The directories accessed
in different sessions are separated by commas.
SecurityAssignmentWindowLayoutInfo
Generates dimension and position coordinates for the Clients/Groups window; allows Clients/Groups
dimensions and position to be maintained between sessions.
The coordinates are automatically generated when you move or resize the Clients/Groups window.
SentMsgsToServerCountWarning
The SentMsgsToServerCountWarning parameter is for development use only. The parameter is set
to F by default. Be sure not to change the default setting.
ShowAdminHostChangeWarning
Between session storage of whether to display or suppress a warning when the AdminHost is
changed.
● T (Default)- When an AdminHost is changed, a warning message displays.
ShowAliasAttributeWarning
Between session storage of whether to display or suppress a warning when the Alias Attribute is
changed.
● T (Default)- When an Alias Attribute is changed, a warning message displays.
ShowChoresSchedulingWarning
Between session storage of whether to display or suppress a warning when a chore schedule is
changed.
● T (Default)- When a chore schedule is changed, a warning message displays.
ShowCubeReplicationWarning
Between session storage of whether to display or suppress a warning when a cube is replicated.
● T (Default)- When a cube is replicated, a warning message displays.
ShowDimDeleteElementWarning
Between session storage of whether to display or suppress a warning when a dimension element is
deleted.
Operations Guide 49
Chapter 2: TM1 System Configuration
ShowDimensionAccessWarning
Between session storage of whether to display or suppress a warning when a dimension is accessed.
● T (Default)- When a dimension is accessed, a warning message displays.
ShowDynamicSubsetWarning
Between session storage of whether to display or suppress a warning when a Dynamic Subset is
changed.
● T (Default)- When a Dynamic Subset is changed, a warning message displays.
ShowPickOperationWarning
Between session storage of whether to display or suppress a warning when data is copied using the
Pick Elements option.
● T (Default)- A warning message displays any time data is copied using the Pick Elements option.
● F - No message displays when data is copied using the Pick Elements option.
ShowProcessUNASCIIWarning
Between session storage of whether to display or suppress a warning when an ASCII datasource is
processed.
is changed.
● T (Default)- When an ASCII datasource is processed, a warning message displays.
ShowProcessUNODBCWarning
Between session storage of whether to display or suppress a warning when an ODBC datasource
is processed.
● T (Default)- Any time an ODBC datasource is processed, a warning message displays.
SliceNewWorkbook
Determines how slices are generated from the Cube Viewer.
● T - Inserts slices in a new workbook.
SubsetWindowLayoutInfo
Generates dimension and position coordinates for the Subset Editor window; allows Subset Editor
dimensions and position to be maintained between sessions.
The coordinates are automatically generated when you move or resize the Subset Editor window.
Operations Guide 51
Chapter 2: TM1 System Configuration
This chapter describes how IBM® Cognos® TM1 remote servers work, and how you can manage
their operations.
❑ On startup, the remote server loads dimensions and cubes from the data directory into the
server machine RAM. At the same time, the server opens a new transactional log file called
Tm1s.log in the data directory. After the cubes are loaded, the remote server is available.
❑ The remote TM1 server registers itself with one or more Admin Servers so that clients can
connect to the remote TM1 server.
❑ Client applications contact Admin Servers to locate available TM1 servers. The clients log into
the TM1 servers whose data they want to access.
❑ Clients edit the cube data, sending the values back to the TM1 server.
❑ As new values are received from clients, the TM1 server writes the records to the Tm1s.log file,
keeping track of every data change, including the date and time the edit occurred, and the ID
of the client who made the edit.
❑ As the server calculates new values in response to client requests, the server stores them in
memory, increasing the amount of memory used by the server.
❑ When the server shuts down, all records in the Tm1s.log file are saved to disk, and the
transaction log file is renamed by appending a date/time stamp to it. The Tm1s.log file is saved
in the server's data directory to back out data transactions, as described in "Backing Out
Records from the Transaction Log" (p. 64).
If the server is intentionally shut down without saving the changes, the log file is saved with a
time/date stamp and the extension is changed to .rej. You can process the Tm1syyyymmddh-
hmmss.rej file through TurboIntegrator to recover the transactions.
❑ To save all changes to the data on a TM1 server at any time without shutting down the server,
right-click a server in Server Explorer and Click Save Data. All records in the Tm1s.log file are
immediately written to disk, the transaction log file is renamed by appending a date/time stamp
to it, and a new Tm1s.log file is created to accept any subsequent edits to cube values.
Any changes to the metadata, such as dimension definitions and cube definitions, are immediately
saved to disk. The changes to the metadata are not written to the transaction log file.
Steps
1. Open the <install_dir>\bin directory in Windows Internet Explorer.
2. Right-click Tm1s.exe.
5. Select Properties.
The Properties window opens.
7. In the Target field, add the -z flag and specify the full path to the directory containing the
Tm1s.cfg file for the server.
For example, -z C:\TM1\salesdata indicates that the Tm1s.cfg file for the server resides in the
C:\TM1\salesdata directory.
Note: If the path to the directory contains any blank spaces, enclose the entire path with double
quotes.
The contents of the Target field should resemble the following:
"C:\Program Files\Cognos\TM1\\bin\tm1s.exe" -z C:\TM1\salesdata
You might want to move the shortcut to the desktop for easy access.
Parameter Required/Optional
Description
-n Required
Name of the TM1 Server. This will become the Windows service name as
shown when you display the properties of an installed service.
-z Required
Data directory that contains the tm1.cfg file for the TM1 database.
-u Optional
Valid user name for the computer on which you are working. Use one of the
following formats:
● Domain and user name in the format Domain\username. For example,
entp\jsmith.
If you do not provide a user name, the current user account is used by default.
-w Optional
Password for the above account.
For example, the following command line installs the sdata TM1 server as a Windows service for
the current user.
tm1sd.exe -install -n sdata -z C:\Program Files\Cognos\TM1\Custom\TM1Data\SData
Operations Guide 55
Chapter 3: Remote Server Operations
where ServerName is the Microsoft® Windows® service name of the TM1 server you want to
remove.
For example, the following command line removes an existing service for the sdata TM1 server.
tm1sd.exe -remove -n sdata
Step
● Double-click the TM1 Sales Data icon.
A server window opens. The server window lists the cubes and dimensions loaded into the server
RAM.
Steps
1. Open Windows Control Panel.
2. Double-click the Services icon. (On Windows 2000 and XP, open the Administrative Tools
folder, and double-click the Services icon.)
A list of installed services opens.
3. Select the entry for the TM1 server you want to start, for example TM1 Server - Planning
Sample, and click the Start button.
An Admin Server must be running before a TM1 server can start. If you have specified an
Admin Host in the Tm1s.cfg file, the TM1 server will attempt to connect to an Admin Server
on that host. The TM1 server will fail to come up if it is unable to connect to an Admin Server
for any reason.
If you have not specified an Admin Host, the TM1 server attempts to connect to an Admin
Server on the local machine. If an Admin Server is not currently running on the local machine,
either as a service or an application, the TM1 server starts a new Admin Server application and
connects to it.
Steps
1. Open Windows Control Panel.
2. Double-click the Services icon.(On Windows 2000 and XP, open the Administrative Tools
folder, and double-click the Services icon.)
A list of installed services opens.
Steps
1. Open the file in a text editor.
2. Set the tm1_path parameter to the directory containing the tm1s.exe server executable file. In
most circumstances, this directory is <TM1_install_dir>/bin.
4. Set the TM1_PATH parameter to directory containing the tm1s.exe server executable file. In
most circumstances, this directory is <TM1_install_dir>/bin.
Note: You must set both tm1_path and TM1_PATH to the same directory.
Operations Guide 57
Chapter 3: Remote Server Operations
6. Run ./tm1s_start_example (or the new file name) to start your TM1 server.
You must manually add the RunningInBackground parameter to Tm1s.cfg. This parameter is not
part of the standard tm1s.cfg file created when you install the TM1 server.
When you run the TM1 server in background mode, you must use Tm1srvstop.exe to shut down
the server. For details, see "Shutting Down a Windows TM1 Server" (p. 59) .
Steps
1. Access Server Explorer.
2. Double-click the icon for the server to which you want to connect.
The Server Login dialog box opens.
3. Enter the correct user name and password, and click OK.
If the connection to the server is successful, TM1 displays the Cubes, Dimensions, Replications,
Processes, and Chores icons for that server. (The Replications icon displays only if you logged
in as a member of the ADMIN group.)
Note: A TM1 remote server comes with a predefined administrator ID of ADMIN, and a
password of apple.
Step
● Click File, Refresh Available Servers. TM1 displays all running servers that are registered on
the Admin Host to which the client is pointing.
Steps
1. From Server Explorer, click File, Options.
The TM1 Options dialog box opens.
2. Enter the name of the Admin Host in the Admin Host field. You can concatenate two or more
hosts by separating the host names with a semicolon.
You can also click the drop-down menu to select from previously accessed Admin Hosts.
3. Click OK.
When you change the Admin Host, TM1 disconnects you from the remote servers to which
you are connected and restarts your TM1 client. If a local server is running, that server is shut
down and restarted.
Connect to Local Server on Select or clear the Connect to Local Server on Startup check box
Startup to control whether the TM1 client automatically connects to the
local server at startup.
Steps
1. In Server Explorer, select the icon for the server from which you want to disconnect.
Step
● Click the Close button in the server window.
Operations Guide 59
Chapter 3: Remote Server Operations
Steps
1. Open Windows Control Panel.
2. Double-click the Services icon. (On Windows 2000, open the Administrative Tools folder, and
double-click the Services icon.)
A list of services opens.
A TM1 server running as a Windows service automatically shuts down during system shutdown.
In some instances, a server running a large or complex model, might not properly shut down during
system shutdown, power failure, or manual service shutdown. An improper shutdown is defined
as a shutdown in which the TM1 server is summarily terminated before it has completed all shutdown
procedures. This can happen during normal system shutdown because Windows allots a limited
time (approximately 20 seconds) for service shutdown. After the allotted time expires, the system
shutdown proceeds regardless of whether the service shutdown is complete.
A TM1 server running as a service automatically recovers any data changes from the previous sessions
in which an improper shutdown occurs. The changes are recovered from records in the server's
Tm1s.log file.
For details on Microsoft®'s approach to service shutdown, see:
http://msdn2.microsoft.com/en-us/library/ms683240.aspx
For details on increasing the amount of time allotted by Windows for service shutdown, see:
http://support.microsoft.com/?kbid=146092
Steps
1. Press CTRL+C in the window from which you started the server.
2. Before you exit, the server prompts you to save all data to disk. Press ENTER (or RETURN)
to save all data. Type No and press ENTER to shut down the server without saving the data.
Parameter Required/Optional
Description
-n Required
The name of the TM1 server you want to shut down. Note that this server
must have been started in background mode.
-v Required
IP address of the Admin Server on which the TM1 server is registered.
-user Required
User name of the person bringing down the server. This person must have
the necessary access and privileges to shut down the server.
-pwd Required
Password for the person bringing down the server.
-time Optional
Delay, in seconds, at which the server will be shut down after running
tm1srvstop.exe.
-cancel Optional
Cancels any previously issued Tm1srvstop.exe commands.Valid values are
T and F.
-unsave Optional
By default, TM1 saves the data before a TM1 server is shut down with the
Tm1srvstop.exe command. The -unsave parameter shuts down a server
without saving the data. Valid values are T and F.
For example, the following command line allows a user named Admin with a password of Admin-
istrator to shut down a TM1 server named TM1SERV registered on an Admin Host located at
207.110.100.206. The command line indicates a 30-second interval between the time the command
is issued and the time the server shuts down. The server is shut down without saving the data.
tm1srvstop.exe -n TM1SERV -v 207.110.100.206 -user ADMIN
-pwd Administrator -time 30 -unsave T
Logging Transactions
Each TM1 server tracks the data transactions made by its clients. When a client changes a cube
value, TM1 records the change in a transaction log file named Tm1s.log, which is located in the
TM1 server data directory.
The information recorded in the log file includes:
Operations Guide 61
Chapter 3: Remote Server Operations
● Whether the new data is simple data (N) or string data (S).
● Optional user-provided string that is attached to each transaction. You create the string with
the TM1ServerLogSetFlagString API function.
The log file is a comma-delimited ASCII file, as shown in the following sample:
"19980602212741","19980602212741","Admin","N","380.","250.
","salescube","Budget","Belgium","L
Series 1.6 L Sedan","Units","Jun",""
"19980602212744","19980602212744","Admin","N","430.","600.
","salescube","Budget","Belgium","L
Series 1.6 L Sedan","Units","Sep",""
"19980602212749","19980602212749","Admin","N","610.","800.
","salescube","Budget","Belgium","L
Series 1.6 L Sedan","Units","Oct",""
The time stamp, yyyymmddhhmmss, represents the current Greenwich Mean Time at the time the
server was brought down. For example, if the server came down on January 2, 2002, at 2:30 PM,
the name of the log file is Tm1s20020102143000.log.
TM1 recovers the data automatically in the event that a server comes down abnormally, and leaves
the Tm1s.log file on the disk. The next time you bring up the server, TM1 recovers the changes in
either of two ways:
● Automatically recovers the changes -- when you are running the TM1 server as a Windows
service
● Prompts you to recover the changes -- when you are running the TM1 server as an application
If you intentionally shut down a TM1 server without saving the data, TM1 saves the transaction
log with a time stamp and changes the file extension to .rej. For example, Tm1s20020102143000.
rej. The .rej log file ensures that you always have a record of the data transactions, even if you shut
down the server without saving the data. If you accidentally shut down the server without saving
the changes, you can process the .rej file through TurboIntegrator to recover the data.
Steps
1. Open Server Explorer.
2. Select the Cubes icon for the server you are working with.
4. Click the cell at the intersection of the Logging column and the cube name.
TM1 enables logging when a check box contains an X, and disables logging when the check
box is empty.
5. Click OK.
Steps
1. Select the server in Server Explorer.
3. Click the right arrow in a parameter field to set the parameters for the query.
There are four parameters you can set:
Parameter Description
Starting Time Queries all the records written to the transaction log on or after
the starting time.
Start date and time for the query. The date and time format is
MM/DD/YYYY HH:MM:SS GMT. The default start date and
time is 00:01:00 GMT on the date you launch the query.
Operations Guide 63
Chapter 3: Remote Server Operations
Parameter Description
End Time End date and time for the query. The date and time format is
MM/DD/YYYY HH:MM:SS
The default is __/__/____ __:__:__, which is an open end date
and time. If you accept the default, TM1 queries all the records
up to the time you launch the query.
4. Click OK.
The query returns a table with all the transaction records that satisfy the parameters you set.
The table displays in the Transaction Log Query Results dialog box.
By default, records are sorted in ascending order by LOGTIME.
5. To sort on a different column, click the column heading. To change the order of a column sort,
click the column heading a second time.
6. Click Edit, Find to search the records in the query results table.
Steps
1. Highlight the record(s) you want to back out.
To highlight an individual record, click the record.
To highlight multiple adjacent records, click the first record and SHIFT+click the last record.
To highlight multiple non-adjacent records, CTRL+click each record.
To select all the records without first highlighting them, click Edit, Select All.
TM1 backs out the records in reverse chronological order as identified by the LOGTIME
column.
Cube Description
}StatsByClient Tracks the message count, average message size, total elapsed time,
and other measures for each client on the server.
}StatsByCube Tracks the memory used for each cube on the server.
}StatsByCubeByClient Tracks the number and elapsed time of cell updates, cell retrievals,
view calculations, and view retrievals for each client and cube on the
server.
}StatsForServer Tracks the connected clients, active threads, and memory used by the
server.
Steps
1. Select the server in Server Explorer.
Operations Guide 65
Chapter 3: Remote Server Operations
Steps
1. In the left pane of Server Explorer, select the server on which you want to broadcast a message.
3. Select None to broadcast the message without shutting down the TM1 server.
5. Enter the message you want to broadcast in the Broadcast Message box.
7. Select the clients you want to receive the message and click OK.
Steps
1. In the left pane of Server Explorer, select the server from which you want to disconnect clients.
7. If you want to broadcast a more detailed message to the selected clients, you can select the
Broadcast Message to Selected Clients option and enter a message in the Broadcast Message
box.
Steps
1. In the left pane of Server Explorer, select the server you want to shut down.
4. Specify a Minutes interval to determine when the server will be shut down.
5. Click OK.
Any clients currently connected to the server receive a message that the server will be shut down
in the number of minutes you specified in Step 4.
Operations Guide 67
Chapter 3: Remote Server Operations
culated. The amount of memory the server uses increases incrementally. The server does not take
memory byte-by-byte, but rather takes a larger piece every so often.
TM1 does not release the memory back to the operating system until the TM1 server is terminated.
Instead, TM1 puts memory it no longer needs into a garbage list, to be reused as required.
Accordingly, the memory consumption for the TM1 server, as reported by the operating system, is
the total of the actual current memory usage and the garbage memory. You can view an accurate
report of the actual memory usage and garbage memory by viewing the }StatsForServer control
cube, which is described in "Control Cubes" (p. 235).
All the remote server platforms support virtual memory, where disk space is used as if it were RAM.
The server runs in virtual memory, but it slows down the performance significantly. The best
practice is for you to keep all the cubes in real RAM at all times.
You should keep an eye on the memory consumption by using the system-monitoring utilities. If
the system runs slowly, you might need to add more RAM to your server.
Some operating systems maintain a configurable limit on the memory they will allocate to any one
process. If your system appears unable to take all the memory that should be available to it, you
might want to look at the operating system parameters.
You can limit the amount of memory allocated to any individual view by adding the Maximum-
ViewSize parameter to the Tm1s.cfg file. The MaximumViewSize parameter is documented in "TM1
System Architecture" (p. 15).
This chapter describes how you can replicate cubes from one server to another, and synchronize
the updates across the copied cubes.
Replication Overview
Depending on your access privileges, you can copy cubes (and their associated dimensions, rules,
subsets, and views) from one server to another, and synchronize the updates among the copied
cubes either at specified time intervals or on demand. The process of copying cubes from one server
to another is called replication.
Note: Replication and synchronization operations inIBM® Cognos® TM1 should only be performed
by members of the ADMIN group. Members of the DataAdmin and SecurityAdmin groups do not
have all the required access privileges to perform these operations.
Replication offers the following advantages.
● Enhances response time because users can update a cube locally without having to communicate
across a network.
● Lets users access and update a copy of a cube, even when they are not connected to the remote
server on which the original cube resides.
TM1 provides bi-directional synchronization for replicated cubes. During the synchronization
process, TM1 copies the data updates and metadata from the original cube to its replicated versions,
and copies the data updates from the replicated versions back to the original cube.
The following considerations apply to replication:
● TM1 versions - All TM1 servers in a replication process must be the identical version.
● Remote servers - You can replicate cubes that reside on remote servers only. You cannot replicate
cubes that reside on local servers.
● Local servers -TM1 clients can replicate cubes to their local server only if they are running that
server as an independent process. The machine must have a network card. To run a local server
as an independent process, clients need to select the Local Server Execution Mode: Independent
Process option in the TM1 Options dialog box.
● Access privileges -When you replicate a source cube on a remote server to a local server, any
elements to which the local client has NONE access on the remote server, will have a value of
zero. If the client has READ (or higher) access to a consolidation that includes elements to
which the client has NONE access, the consolidation will appear to be the sum of only those
elements to which the client has READ (or higher) access. The consolidation, as reported to
the client, will not be the sum of all elements, as in the source cube.
Note: When you set security levels and establish replication to the local servers, you must know
the implications of replicating data to which a client does not have at least READ access.
● Tm1s.cfg file - The Tm1s.cfg file must be configured to register the target and source servers
with the same TM1 Admin Server. For details, see "Configuring the Tm1s.cfg File to Support
Replication" (p. 73).
● Length of directory path and cube name - The total length of the pathname for the target TM1
server's data directory and the name of the cube you are replicating can not exceed the Windows
pathname limit of approximately 256 characters. If this limit is exceeded, due to a long pathname
or cube name, TM1 displays the following error message attempting to perform: Could not
register the cube.
Cube Relationships
When you replicate a cube, the original cube is called the source cube, and a copy of that cube is
called the mirror cube. You can replicate a single cube on many different servers, and you can rep-
licate a replicated cube.
Server Relationships
To replicate a cube, you must log on to a remote server and create a replication connection. This
connection establishes the remote server that you just logged on to as a source server and the server
you logged in from as the target server.
After you establish a replication connection, you can replicate as many cubes as you want to through
this connection. TM1 uses the logon ID for the replication connection to determine your access
rights to the source data.
The same TM1 server can be both a target server for some cubes, and a source server for other
cubes. In this situation, there would be two replication connections between the target and source
servers, as illustrated in the following diagram.
Cube A
Region 1 Region 2
Cube B
The synchronization process occurs at the server level, rather than at the cube level. When you
synchronize the replication connection, TM1 updates all the mirror cubes that are part of the same
replication connection. For example, if you replicate Cubes A and B from a central server to the
Region 4 server, both of these cubes are updated when you initiate the synchronization process for
the replication connection between these two servers.
Note: As the TM1 administrator, you must ensure that no loops are created through a replication.
When you replicate a single cube on many different servers, you create a star configuration of
servers. For example, you can replicate Cube A from a central server to four regional servers.
Cube A1 Cube A1
(Mirror of cube A) (Mirror of cube A)
Region 1 Region 4
Cube A
Central server
Cube A1 Cube A1
(Mirror of cube A) (Mirror of cube A)
Region 2 Region 3
When you replicate a replicated cube, you create a chain configuration of servers. For example,
using the star configuration of servers, Cube A can be replicated from Region 3 to a local server.
Operations Guide 71
Chapter 4: Replicating Cubes
Cube A
(Mirror of cube A)
Central server
Cube A1
(Mirror of cube A)
Region 3
Cube A2
(Mirror of cube A)
Local server
You can combine the star and chain configurations, as shown below.
Cube A1 Cube A1
(Mirror of cube A) (Mirror of cube A)
Region 1 Region 4
Cube A
(Mirror of cube A)
Central server
Cube A1 Cube A1
(Mirror of cube A) (Mirror of cube A)
Region 2 Region 3
Cube A2 Cube A2
(Mirror of cube A1) (Mirror of cube A1)
● Admin access to the server where you are creating the replicated cube. You must be in the
ADMIN group on that server. Members of the DataAdmin and SecurityAdmin groups do not
have all the required access privileges to perform replication and synchronization operations.
Users have Admin access to their local servers and can replicate any cube for which they have Read
access to the local server.
As the TM1 administrator, you are responsible for replicating cubes on the remote servers.
Note: Although you can replicate a cube if you have Read access to it, you need Reserve access to
the cube to write updates back to cube during the synchronization process. See "Synchronization
Process" (p. 79).
Setting up Replication
There are three stages you must follow to set up a replication for a TM1 system.
❑ Create a replication connection between the target and source servers. See "Replication Pro-
cess" (p. 76).
❑ Replicate one or more cubes from the target server to the source server.
❑ After you make updates to the cubes, initiate the synchronization process, if synchronization
is done on demand. See "Synchronization Process" (p. 79) .
where:
● hostname1 is the computer name or IP address of the TM1 Admin Host where the target TM1
server is registered.
● hostname2 is the computer name or IP address of the TM1 Admin Host where the source TM1
server is registered.
You can use a mix of computer names and IP addresses and you can also list multiple Admin hosts:
For example:
AdminHost=boston;newyork
or
AdminHost=192.168.1.17;192.168.1.22
or
Operations Guide 73
Chapter 4: Replicating Cubes
AdminHost=boston;192.168.1.17;192.168.1.22;myserver;192.168.1.40
Steps
1. Open the Server Explorer.
Note: If the server already has a replication connection, you must select the Replications icon,
right-click the icon, and click Insert New Replication to open the Create Server Replication
dialog box.
● Specify the username and password with which you want to connect to the source server.
5. Click OK.
If your username and password are valid, the system connects you to the specified server, and
adds the server name under the Replications icon for the target server.
After you create a replication connection, you can manually synchronize data between the
target and source servers or create a chore to automate synchronization. For details, see "Syn-
chronization Process" (p. 79).
Steps
1. Open the Server Explorer.
2. Access the server that contains the replication connection you want to modify.
4. Right-click the server whose connection you want to modify, and click Modify Replication
Parameters.
The Modify Server Replication Object dialog box opens.
Operations Guide 75
Chapter 4: Replicating Cubes
Steps
1. Open the Server Explorer.
2. Access the server that contains the replication connection you want to delete.
4. Right-click the server whose connection you want to delete and click Delete Replication.
Note: If you created a chore to automate synchronization, you must delete the chore before
deleting the replication. For details on automating synchronization, see "Synchronization Pro-
cess" (p. 79).
Replication Process
After you create a replication connection between two servers, you can replicate the cubes from the
source server to the target server.
TM1 allows the replication of control cubes, including these cubes:
}DimensionProperties
}CubeProperties
}ConnectionProperties
In most circumstances, you should not replicate these cubes. If you do, be aware that the cubes on
the target server overwrite the cubes on the source server when synchronization occurs, thereby
removing all the replication and synchronization settings that were made through the UI.
Replicating a Cube
When replicating a cube, the total length of the pathname for the target TM1 server's data directory
and cube name can not exceed the Microsoft® Windows® pathname limit of approximately 256
characters. If this limit is exceeded, due to a long pathname or cube name, TM1 displays the follow-
ing error message: Could not register the cube.
Steps
1. Double-click the Replications icon for the target server.
The tree expands to list existing replication connections.
4. Fill in the Replicate Cube dialog box as described in "Specifying Information about the Replic-
ated Cube" (p. 77).
5. Click OK.
TM1 replicates the cube, as described in "What Happens when TM1 Replicates a Cube" (p. 79).
Note: After you click OK to replicate a cube, you cannot change the specifications for this
particular replication. However, you can create another replicated version of the source cube
with different specifications.
● Whether the mirror cube uses dimensions that are replicated from the source server or local
dimensions.
● Whether the dimensions replicated from the source server are synchronized when the cubes are
synchronized.
● Whether the mirror cube uses rules that are replicated from the source cube.
● Whether the rules replicated from the source server will be synchronized when the cubes are
synchronized.
The Replicated Cube dialog box that displays when you replicate the depletion cube from the
inventory server is shown in the following figure. The replication status might be different,
depending on whether you have already replicated the dimensions in the cube.
Note: The sections that follow describe how to change the TM1 default settings. We recommend
that you do not change any default settings unless you fully understand the implications of doing
so.
Steps
1. To specify another name for the mirror cube, enter the name in the Name field.
Note: Do not rename a cube if you are replicating rules in that cube.
2. To replicate the cube and allow later synchronization, select Copy Data and Set to Synchronize.
3. To replicate the cube but disable later synchronization, select Copy Data but Do Not Set to
Synchronize.
Operations Guide 77
Chapter 4: Replicating Cubes
Steps
1. To rename a dimension, slowly click the dimension twice (do not double-click), and type the
new name.
Warning: Do not rename a dimension if you are replicating rules in the associated cube.
2. To direct TM1 to copy a dimension but not synchronize it, select the dimension, and clear the
Set Dimension to Synchronize option.
Warning: By default, TM1 overwrites the local dimension with the source dimension. If you
do not want TM1 to overwrite the dimension, select the Don't Overwrite Dimension option.
This automatically directs TM1 to treat the local dimension as a stand-alone dimension.
Steps
1. To specify that you want TM1 to copy the rules but not synchronize them, clear the Set Rule
to Synchronize option.
2. To specify that you do not want TM1 to copy rules for the mirror cube, select the Do Not
Copy Rule option.
Step
● To specify that you do not want TM1 to copy views for the mirror cube, clear the Replicate
Views option.
Step
● To specify that you do not want TM1 to copy subsets for the mirror cube, clear the Replicate
Subsets option.
● Optionally, TM1 replicates the cube rules. When you initiate the replication process, you decide
which rules you want to replicate, and of those, which rules you want to synchronize when
you synchronize the cubes.
● Represents the cube as an icon under the Cubes icon on the target server.
● Names the source server in the Replication Server field on the attributes bar for each replicated
cube.
● Names the source server in the Replication Server field on the attributes bar for each replicated
dimension.
Synchronization Process
You always initiate the synchronization process from the target server, which is the server that
contains the mirror cubes. You must have administrator authority for this server to initiate the
synchronization process.
You can synchronize on demand or schedule the synchronization process to be automatic.
❑ TM1 updates the data in all the mirror cubes that are part of the same replication connection.
You cannot specify individual cubes to update.
❑ TM1 also updates the replicated dimensions if you made changes to their definitions and rules.
❑ TM1 always writes updates from the source cubes to the mirror cubes.
❑ TM1 does the following with updates you make to the mirror cube:
● Writes the updates back tothe source cube, if the updates were made by users with Reserve
access to the source cube.
● Does not write the updates back tothe source cube, if the updates were made by users with
Read orWrite access to the source cube.
Operations Guide 79
Chapter 4: Replicating Cubes
❑ TM1 uses log files to keep track of the changes made to the source and mirror cubes. During
the synchronization process, TM1 uses the log files to determine which updates to make.
If there is an update conflict for a particular cell, TM1 uses the most recent update, no matter
where this update was made (that is, in the source cube or the mirror cube).
Synchronizing on Demand
To synchronize updates on demand, complete the following steps.
Steps
1. In the Server Explorer, access the server that contains the mirror cubes.
3. Right-click the icon for the replication connection for whose cubes you want to synchronize,
and click Synchronize Data.
Scheduling Synchronization
You can create a chore to automatically synchronize data at a regular interval using Turbo Integrator.
For details on Turbo Integrator, see the IBM Cognos TM1 TurboIntegrator Guide.
Steps
1. In the Server Explorer, select the Chores icon beneath the target server for which you want to
automate synchronization.
4. Click the arrow button to move the replication from the Available list to the Selected List.
5. Click Next.
6. Use the calendar and Time field to set a start date and time for the initial synchronization.
7. Use the fields in the Chore Execution Frequency box to set the interval at which the synchron-
ization should be executed.
This chapter describes the available log files, tools, and utilities for monitoring the system perform-
ance of a TM1 server.
Message Logging Performance Monitoring with TM1 Top Utility Performance Counters
Control Cubes
Admin Transaction
Server Log Log
Server
Message Log Audit Log
● Admin Server log - A log file containing messages about communication between TM1 clients,
the Admin Server and individual TM1 servers.
● Transactions Log - A log file that tracks the data transactions made by the clients logged into
a TM1 server. Recorded information includes the date and time the change was made, name
of the client who made the change, before and after value, name of the cube in which the change
was made, and the elements that identify the cell that changed.
● Server Message Log - A log file containing details on the activity of the TM1 server, such as an
executed processes, chores, loaded cubes and dimensions, and a synchronized replication.
● Audit Log - A log file that monitors changes to TM1 objects and system-wide events, such as
modifications to dimensions, views and subsets and successful/ unsuccessful login activity.
● TM1 Top - A utility that dynamically monitors the threads and processes running in an instance
of a TM1 server. TM1 Top is a stand-alone utility that runs within a console (command) window
on a Microsoft® Windows® computer.
● TM1 clients contact the TM1 Admin Server for a list of available TM1 servers.
● SSL security is established between TM1 clients, the TM1 Admin Server, and individual TM1
servers. For more details on SSL, see "Running TM1 in Secure Mode Using SSL" (p. 209).
For details about the TM1 Admin Server, see the "TM1 Admin Server" (p. 15).
Parameter Description
DEBUG Detailed, technical messages that are useful when customer support or develop-
ment engineering need to debug the application.
When logging is configured to this level, DEBUG, INFO, and ERROR messages
are logged.
INFO Informational messages that highlight the progress of the application and report
normal transitions within the application.
When logging is configured to this level, INFO and ERROR messages are
logged.
Parameter Description
ERROR An error condition of which you should be aware. Action should be taken to
fix or report the issue to customer support.
When logging is configured to this level, only ERROR messages are logged.
Message level
Log file name
Logger section
Appender section
● Logger section - Configures the TM1 sub-components and message severity level that you want
to log.
● Appender section - Controls the output destination of the logging. The default configuration
uses the RollingFileAppender option to write messages to the tm1admsrv.log file.
● Pattern Layout section - Controls the output fields and formatting of the messages that are
written to the log file. The default settings use a time reference of GMT.
The default logging configuration logs all INFO level messages. You can adjust the logging message
level by editing the following two statements in the logging properties file:
log4j.rootLogger=INFO, R1
log4j.logger.TM1=INFO
Note: The default logging configuration is intended for every-day use and does not typically require
adjustment. Contact customer support for assistance if you need to configure the logging properties
file for troubleshooting purposes.
Operations Guide 83
Chapter 5: System and Performance Monitoring
Steps
1. Locate the tm1admsrv.log file in the <TM1_install_dir>\bin directory.
2. Open and view the log file with a text editor, such as Microsoft Windows Notepad.
Each line in the log file represents one unique message, arranged in the following format:
Thread ID Message level Date and time TM1 sub-component name Message text
Logging Transactions
Each TM1 server tracks the data transactions made by its clients. When a client changes a cube
value, TM1 records the change in a transaction log file named Tm1s.log, which is located in the
TM1 server data directory.
The information recorded in the log file includes:
● Date and time the change was made.
● Whether the new data is simple data (N) or string data (S).
● Optional user-provided string that is attached to each transaction. You create the string with
the TM1ServerLogSetFlagString API function.
The log file is a comma-delimited ASCII file, as shown in the following sample:
"19980602212741","19980602212741","Admin","N","380.","250.
","salescube","Budget","Belgium","L
Series 1.6 L Sedan","Units","Jun",""
"19980602212744","19980602212744","Admin","N","430.","600.
","salescube","Budget","Belgium","L
Series 1.6 L Sedan","Units","Sep",""
"19980602212749","19980602212749","Admin","N","610.","800.
","salescube","Budget","Belgium","L
Series 1.6 L Sedan","Units","Oct",""
The time stamp, yyyymmddhhmmss, represents the current Greenwich Mean Time at the time the
server was brought down. For example, if the server came down on January 2, 2002, at 2:30 PM,
the name of the log file is Tm1s20020102143000.log.
TM1 recovers the data automatically in the event that a server comes down abnormally, and leaves
the Tm1s.log file on the disk. The next time you bring up the server, TM1 recovers the changes in
either of two ways:
● Automatically recovers the changes -- when you are running the TM1 server as a Microsoft®
Windows® service
● Prompts you to recover the changes -- when you are running the TM1 server as an application
If you intentionally shut down a TM1 server without saving the data, TM1 saves the transaction
log with a time stamp and changes the file extension to .rej. For example, Tm1s20020102143000.
rej. The .rej log file ensures that you always have a record of the data transactions, even if you shut
down the server without saving the data. If you accidentally shut down the server without saving
the changes, you can process the .rej file through TurboIntegrator to recover the data.
Operations Guide 85
Chapter 5: System and Performance Monitoring
When you disable logging, TM1 accelerates updating the data but you cannot recover the updates
in the event of a system failure.
2. Select the Cubes icon for the server you are working with.
4. Click the cell at the intersection of the Logging column and the cube name.
TM1 enables logging when a check box contains an X, and disables logging when the check
box is empty.
5. Click OK.
Steps
1. Select the server in Server Explorer.
3. Click the right arrow in a parameter field to set the parameters for the query.
There are four parameters you can set:
Parameter Description
Starting Time Queries all the records written to the transaction log on or after
the starting time.
Start date and time for the query. The date and time format is
MM/DD/YYYY HH:MM:SS GMT. The default start date and
time is 00:01:00 GMT on the date you launch the query.
Parameter Description
End Time End date and time for the query. The date and time format is
MM/DD/YYYY HH:MM:SS
The default is __/__/____ __:__:__, which is an open end date
and time. If you accept the default, TM1 queries all the records
up to the time you launch the query.
4. Click OK.
The query returns a table with all the transaction records that satisfy the parameters you set.
The table displays in the Transaction Log Query Results dialog box.
By default, records are sorted in ascending order by LOGTIME.
5. To sort on a different column, click the column heading. To change the order of a column sort,
click the column heading a second time.
6. Click Edit, Find to search the records in the query results table.
Steps
1. Highlight the record(s) you want to back out.
● To highlight an individual record, click the record.
● To highlight multiple adjacent records, click the first record and SHIFT+click the last
record.
To select all the records without first highlighting them, click Edit, Select All.
Operations Guide 87
Chapter 5: System and Performance Monitoring
Example of mesages in the TM1 server message log indicating a corrupt transaction log file.
If you select No, the server will continue running, but the problem that caused the unexpected
shutdown may still exist.
If you select Yes, TM1 displays the following warning message and also writes a message to the
TM1 server message log as described above.
● Message severity levels - Categories for classifying and reporting messages by severity; DEBUG,
INFO, WARN, ERROR, and FATAL.
● TM1 loggers - Parameters that provide enhanced control for selectively logging specific areas
or sub-components of TM1.
Operations Guide 89
Chapter 5: System and Performance Monitoring
● Logging properties file - A text-based file that enables you to configure and enable logging for
a specific TM1 server.
● Message log viewer - A tool for viewing the message log in Server Explorer and TM1 Architect.
Parameter Description
DEBUG Detailed, technical messages that are useful when customer support or
engineering need to debug the application.
Examples: "SSL Connection opened", "Removing SQL Connection from
memory"
INFO Informational messages that highlight the progress of the application and
report normal transitions within the application.
Examples: "TM1 Server is ready", "Loading dimension..."
ERROR An error condition of which you should be aware. Action should be taken
to fix or report the issue to customer support. The error may be so severe
that the server shuts down or it may result in the current client request being
canceled.
Examples: "Error connecting to remote machine", "Failed to create a cube"
FATAL A very severe error event that will possibly cause the server to shut down
or result in the current client request being canceled. You should immediately
take action to fix the issue and report the event to customer support.
TM1 Loggers
TM1 loggers represent the different areas or sub-components of TM1 that produce log messages.
For example, dimensions and cubes produce messages when loading and the server reports messages
when starting and stopping.
You can control the quantity and focus of the logging by selectively turning on or off individual
TM1 loggers in the logging properties file.
The default logging configuration is INFO level messages for all areas of TM1.
Note: Customer support can provide you with guidance and assistance to enable individual TM1
loggers.
Note: A TM1 local server only checks the logging properties file, tm1s-log.properties, when the
local server starts up. For details, see "Enabling and Disabling Logging" (p. 85).
A sample logging properties file is provided in the directory of each sample TM1 database that you
install. Sample TM1 databases are installed in the following locations:
Where <TM1_sample_dir> is the directory for a sample TM1 database. For example:
Operations Guide 91
Chapter 5: System and Performance Monitoring
2. Place the logging properties file, tm1s-log.properties, into the same directory where the config-
uration file, Tm1s.cfg, is located for the TM1 server you want to monitor.
The location of the Tm1s.cfg file is typically the data directory of the TM1 server, but could
be a different location depending on your specific TM1 configuration. For example, if your
Tm1s.cfg file is located in the C:\salesdata directory on a Microsoft® Windows® system, then
copy the logging properties file into this directory.
After the tm1s-log.properties file is placed in the same directory as the Tm1s.cfg file, the server
will start logging based on the settings configured in the logging properties file. It is not necessary
to restart the TM1 server to initialize logging, unless you are running a TM1 local server.
Note: A TM1 local server only checks the logging properties file, tm1s-log.properties, when
the local server starts up. After startup, a TM1 local server never checks for changes in the
logging properties file, so all settings in a local server's logging properties file must be considered
static. If you change any logging properties for a local server, you must restart the server to
apply the new logging settings.
3. To temporarily turn off logging, set the TM1 logger values to either INFO or OFF. Using a
value of INFO is recommended.
● Setting a TM1 logger value to INFO will continue some logging, but at a much decreased
amount compared to a setting of DEBUG. Using a setting of INFO, instead of OFF, is
useful because TM1 will still log important messages for WARN, ERROR and FATAL
messages.
● Setting a TM1 logger value to OFF will stop all logging for the TM1 logger, and you could
miss any potential WARN, ERROR and FATAL messages.
Where:
● TM1 logger is the name of the TM1 sub-component that you want to log. Contact customer
support for assistance using TM1 loggers.
● Message level is the message severity level that you want to log. Valid values include: DEBUG,
INFO, WARN, ERROR, FATAL, or OFF, as described in the section "Message Severity Levels."
● Setting logging to WARN will report WARN, ERROR, and FATAL messages.
● Setting logging to OFF disables all logging for the specific TM1 logger.
● Appender is the output destination. Use a value of S1 for the TM1 shared memory appender
which transfers messages to memory before saving them to a file.
For example, to turn on logging at the DEBUG level for all TM1 sub-components, you would use
the following statements:
log4j.rootLogger=DEBUG, S1
log4j.logger.TM1=DEBUG
● MaxFileSize
● MaxBackupIndex
● TimeZone
Parameter Description
MemorySize Specifies the size of the shared memory segment. This memory represents
the area of system memory where log messages are sent before being
written to the log file.
Default value is 5 MB.
Use the following format:
log4j.appender.S1.MemorySize=Size Units
where:
● Size is the numeric value for the memory size.
Operations Guide 93
Chapter 5: System and Performance Monitoring
Parameter Description
MaxFileSize Specifies the maximum file size that the log file is allowed to take up on
disk.
Default size is 100 MB.
Uses the following format:
log4j.appender.S1.MaxFileSize=SizeUnits
where:
● Size is the numeric value for the file size.
For example, to limit the log file size to 10 MB, enter the following:
log4j.appender.S1.MaxFileSize=10 MB
If the MaxBackupIndex parameter is set to 1 or greater, then the logging
process automatically creates a backup file when the log file reaches the
MaxFileSize. The total number of backup files is determined by Max-
BackupIndex option.
MaxBackupIndex A numeric value that specifies how many backup files are kept before the
oldest log file is erased.
Default value is 20.
● If set to 0 - no backup log files will be saved and the current log file
will be overwritten and restarted each time it reaches MaxFileSize.
The backup process repeats each time the MaxFileSize is reached, overwrit-
ing the oldest backup file so that only the newest backup files remains.
TimeZone Specifies the timezone for the message timestamps in the log file. Uses the
following format:
log4j.appender.S1.TimeZone=Zone
where Zone can be set to either GMT or Local.
● If set to Local, the log messages will have timestamps based on the
local time of the machine where the TM1 server is running.
Steps
1. Select the TM1 server in the Server Explorer.
Date and Time Date and time the message was logged, based on the
TimeZone parameter setting in the logging properties file.
Data and time can be recorded as either GMT or Local.
For more details, see "Configuring Logging Out-
put" (p. 93).
Reported in the format: yyyy-mm-dd hh:mm.ss,milliseconds
Example: 2006-10-02 16:49.01,925
Operations Guide 95
Chapter 5: System and Performance Monitoring
TM1 Logger Name Name of the TM1 sub-component that generated the
message or activity.
Message Text Pre-defined text message that describes the error or activity
being reported.
Steps
1. Click Edit, Find or press CTRL+F.
The Find dialog box opens.
2. Enter the text you to find and then click Find Next.
If the text is found, the line containing the matched text is highlighted and shown in the Message
Log window.
Steps
1. Select the line of text you want to copy.
Note: By default, audit logging is disabled and must be manually enabled for each server you want
to monitor. For details, see "Configuring Audit Logging" (p. 97).
● Chores
● Clients
● Cubes
● Dimensions
● Elements
● Groups
● Processes
● Rules
● Subsets
● Views.
A common set of events, such as object created or deleted, are logged for all these objects. Addition-
ally, TM1 logs events that are specific to each object. For example, the execution of a process is an
event that is logged only for process objects.
System-wide Events
System-wide events include operations related directly to the TM1 server such as:
● Successful and failed login attempts
Operations Guide 97
Chapter 5: System and Performance Monitoring
To enable audit logging for a specific TM1 server, complete the following steps.
Steps
1. Open the tm1s.cfg file for that server.
Note: After changing the value for the AuditLogOn parameter, you must restart the TM1 server
for the new value to be applied.
For detailed information about all of the audit log parameters, see "The Tm1s.cfg File" (p. 23).
Steps
1. Select a TM1 server in Server Explorer.
● Query panel - Use the Query panel to build queries that search the audit log for a specific time
period or type of event.
● Results panel - Use the Results panel to view and navigate the records retrieved by your query.
Steps
1. Select a TM1 server in Server Explorer.
You can then select the query parameters that you want and click the Run Query button
to retrieve the records for the query.
If you are looking for events from a specific time period, select Custom Time Period from the
Time Period option. Enter a start and end time.
● All - Searches for both types of audit events; system-wide and object related events.
● System-wide - Searches for only system-wide audit events. To search for a specific system-
wide event, select the event from the list. The default setting searches for all system-wide
events.
● Object Type - Limits the query to only a specific type of TM1 object. For example, events
related only to dimensions. Select an object from the Object Type list
● Object Name - Finds events for a specific object. Click the Object Name Selection button
to display a dialog box where you select objects by name.
Operations Guide 99
Chapter 5: System and Performance Monitoring
Note: When you set the Object Type option to Element, the Object Name Selection button
becomes disabled because the element list could be too large to display. If you want to search
for events related to a specific element, you must manually enter an element name using the
following format:
DimensionName:ElementName
● Event - Searches for a specific object event. You can select an event from the Event list.
This list changes depending on which type of object you have selected in the Object Type
list.
Viewing Results
The Results panel grid organizes the audit log records from the query into the following columns.
User TM1 client (user) or scheduled chore that was responsible for causing
the event.
Object Name Name of the TM1 object associated with the event.
Details Displays an icon to indicate that detailed information exists for the
specific event.
If an event has details, you can view the details by clicking on the
Details for that record.
You can sort the results in the grid in ascending or descending order for any column by clicking on
the column title.
Step
● To copy event data, highlight an individual cell in the Results grid and then click the Copy
button on the Results toolbar.
Steps
1. Click Find in the Results toolbar.
The Find dialog box appears.
Exporting Results
The Results panel also includes an export option for exporting results in XML, comma delimited,
and tab delimited file formats. The export feature is available in both the Audit Log and Audit Log
Details windows.
To export audit log data, complete the following steps.
Steps
1. Click Export in the Results toolbar.
The Save As dialog box appears.
4. Click Save.
}StatsByClient Tracks the message count, average message size, total elapsed
time, and other measures for each client on the server.
}StatsByCube Tracks the memory used for each cube on the server.
}StatsByCubeByClient Tracks the number and elapsed time of cell updates, cell
retrievals, view calculations, and view retrievals for each client
and cube on the server.
}StatsForServer Tracks the connected clients, active threads, and memory used
by the server.
Steps
1. Select the server in the Server Explorer.
Steps
1. Select the server in the Server Explorer.
Steps
1. In the Server Explorer, click View, Display Control Objects.
All of the Control Cubes will now be displayed, including the Performance Monitoring Control
Cubes.
2. Open any of the Performance Monitoring Control Cubes to view the cube.
The available control cubes include:
● StatsByClient
● StatsByCube
● StatsByCubeByClient
● StatsForServer
For details, see "Control Cubes" (p. 235) and "Control Dimensions" (p. 249).
Note: The TM1 Top user interface and help text are not translated and will appear in English in
non-English versions of TM1.
Steps
1. Run the TM1 Installation Wizard.
● If your system has a previous installation of TM1, click Next to advance to the Program
Maintenance screen. On the Program Maintenance screen, select the Modify option. Click
Next to advance to the Installation Options screen.
● If your system does not have a previous installation of TM1, follow the Installation Wizard
steps until the Installation Options screen opens.
2. On the Installation Options screen, select the Custom option for the Installation Type.
3. Click Next.
The Component Selection screen opens.
4. On the Component Selection screen, expand the Servers component category and select the
TM1 Top sub-category.
5. Select the This feature will be installed on local hard drive option for TM1 Top.
6. Follow the steps in the TM1 Installation Wizard to complete the installation.
If you configure TM1 to use SSL for secure data transmission, then you must configure the SSL
parameters in the Tm1top.ini file. For details about configuring TM1 Top to work with SSL, see
"Configuring the Tm1top.ini File" (p. 104).
Do not include any spaces between the parameter name and the parameter value when editing the
Tm1top.ini file.
The parameters in the Tm1top.ini file are described in the following table.
Parameter Description
ServerName TM1 server name. This is the ServerName from the server configur-
ation file, Tm1s.cfg.
Refresh Time interval between refreshing of the TM1 Top display. Format
is:
refresh=nn
where nn is the time interval in seconds.
Default value is 2 seconds.
LogFile Specifies the path and file to which the log information is written.
As TM1 Top is running, the status lines can be continuously written
to this ASCII file so that the activity over time can be monitored.
Format is: logfile=path-to-log-file
where path-to-log-file must specify the complete path, filename, and
file extension. A default filename and file extension is not provided.
LogPeriod Specifies the time interval between updates being written to the log
file. This value should be a multiple of the Refresh time parameter.
The format for this parameter is: logperiod=nn
where nn is the number of elapsed seconds between updates to the
log file. Setting this to zero disables logging.
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.
The default value is 2 seconds.
LogAppend Specifies if log data is appended to the log file that is set with the
LogFile parameter, or if the file is overwritten when a new session
is started. If the LogAppend parameter is not set, the existing log file
will be over-written.
Valid values are T and F as shown in the following examples:
If you set LogAppend=T, log data is appended to the log file specified
by the LogFile parameter.
If you set LogAppend=F, the existing log file will be over-written.
The default value is F, which overwrites the existing log file.
Note: You can also enter these values at the command prompt when starting TM1 Top, over-riding
the values in the Tm1top.ini file. For details, see "Running TM1 Top with Command-line
Options" (p. 106).
Steps
1. Edit the initialization file, Tm1top.ini, as described in "Configuring the Tm1top.ini File" (p. 104).
Note: By default, the Tm1top.exe file and a sample Tm1top.ini file are installed in the
<TM1_install_dir>\bin directory when you install the TM1 Server.
3. Run the Tm1top.exe file from a command prompt to start TM1 Top.
tm1top.exe
By default, the Tm1top.ini file is read from the same directory that contains the TM1 Top
executable. To specify a different location for the Tm1top.ini file, use the -i command-line
parameter as follows.
tm1top.exe -i path-to-initialization-file
Note: SSL security parameters can not be entered at the command line and must be specified in the
Tm1top.ini file if TM1 is configured to use SSL. For details, see "Configuring the TM1 Top Utility
to Use SSL."
Use the following format to run TM1 Top with command-line options:
tm1top.exe -OptionName1 OptionValue1 -OptionName2
OptionValue2 ..
Where OptionName and OptionValue can be any of the following parameter and value combinations:
● -adminhost admin-host-name
● -servername server-host-name
● -refresh refresh-period
● -logfile file-path
● -logperiod nnn
● -logappend T or F
For example, to run TM1 Top with the ServerName parameter set to sdata and the refresh parameter
set to 5 seconds, enter the following:
tm1top.exe -servername sdata -refresh 5
Note: Use quotes for parameter values that include spaces, as follows:
tm1top.exe -servername "planning sample"
For more details on TM1 Top parameters, see "Configuring the Tm1top.ini File" (p. 104).
Each row in the display represents one unique thread running in the TM1 server that you are
monitoring. The title bar of the console window displays the current values for the AdminHost,
ServerName, and Refresh parameters.
Note: To see more lines or a wider display, you can re-size the console window or use a smaller
font size. If the display fills the entire height of the console window, you can use the up and down
arrow keys on your keyboard to go to the next or previous page within the console window.
The following table describes the status fields displayed by TM1 Top.
User Name The name of the user or process that started the thread. This can be
one of three possible thread types.
● User Thread - Name of an actual user that is logged into TM1. A
value of ??? means the user is currently in the login stage.
C:chore-name
The name of the process running under the chore is displayed in the
Function field.
● System Thread - A TM1 system process running on the TM1 server.
Displayed in the following format:
● Th:Stats - The Stats thread represents the thread for the perform-
ance monitor feature that is started when a user selects the Start
Performance Monitor option in TM1 Architect and Server Explorer.
State The current processing state of a specific thread. This value can be one
of the following values:
● Idle
● Run
● Commit
● Rollback
● Wait
● Login
Obj Lock Status Lock status of the last object that was locked.
Displayed in the format: R<#> IX<#> W<#>
Where:
● R, IX, and W represent the different lock modes on the object. For
more information, see "Understanding TM1 Lock Modes" (p. 109).
User Lock Status Total lock status and count for all objects being used by a thread.
Displayed in the format: R<#> IX<#> W<#>
Where:
● R, IX, and W represent the different lock modes on the objects.
For more information, see "Understanding TM1 Lock
Modes" (p. 109).
● # is the total number of locks, across all objects, for each specific
lock mode.
Time The total time, in seconds, that the current API function or chore pro-
cess has been processing.
The name of the API function or chore process is displayed in the
Function field.
R R-lock (read lock) - A shared lock that allows many threads to read
from an object at the same time, but does not allow another thread to
modify or write to this object until all R-locks have been released.
W W-lock (write lock) - An exclusive lock that allows only one thread at
a time to access and write changes to an object. No other thread can
read or modify this object until the W-lock has been released.
State Description
Run Indicates the thread is actively running. Also displays the lock mode and
object being accessed by the thread in the following format:
Run: Lock Mode-(Object Name)-Object Type
Where:
● Lock Mode is one of the possible object lock modes; R, IX, or W. For
more information, see "Understanding TM1 Lock Modes" (p. 109).
● Object Name is the name of the last TM1 object that was being acted
on by the API function displayed in the Function field.
Rollback Indicates the thread encountered a conflict while committing and could not
proceed. The thread will automatically re-try until the conflict is resolved.
State Description
● Object Name is the name of the last TM1 object that was being acted
on by the API function displayed in the Function field.
Command Description
Command Description
Up, Down arrow keys Use the up and down arrow keys to scroll the status display if
there are more lines in the status than the height of the console
window.
● Threads in a Run state - TM1 can cancel only threads with a state of Run that are running
functions involving either TI processing, constructing a view, or calculating a view.
● Threads in a Wait state - Any thread that in a Wait state can be cancelled.
The state of a thread is indicated under the State field in the TM1 Top display.
This functionality provides a way to cancel an action that is negatively impacting other threads by
consuming too much of the server's processing time. For example, a TI process that gets stuck in
a loop, or when a user tries to compute a very large and demanding view.
To cancel a thread, you must use the Cancel and Verify commands together, as described below.
● If a thread is in the Wait state, the thread is cancelled in two steps. First, the cancel command
releases the thread's lock request, and then the cancel command cancels the thread's processing.
Steps
1. Enter V to display the following prompt to verify a TM1 Top session:
Verify Admin Access
Admin User Name:
4. After the session has been verified, enter C to initiate the Cancel process.
The following prompt displays:
Cancel processing of a thread
Thread-id:
5. Enter the ID of the thread to be canceled. You can find the thread ID displayed in the first
column of the TM1 Top display.
in real-time to track specific TM1 properties and activities for cubes, views, subsets, dimensions,
and read/write activity.
You can view TM1 performance counters with the following tools:
● TM1 PerfMon utility - A text-only display of TM1 performance counters that runs in a console
window on Microsoft® Windows® and UNIX® systems. The TM1 PerfMon utility can monitor
local TM1 servers only.
● The user must be a member of the Administrators group, on both the local and remote systems,
to monitor a remote TM1 server using the Microsoft Windows Performance Monitor.
Viewing TM1 performance counters with the Microsoft Windows Performance Monitor is not
supported on 64-bit Intel Itanium II systems. When running TM1 with this configuration, use the
TM1PerfMon console utility to view TM1 performance counters.
Note: To see a complete, updated list of available TM1 performance counters, with descriptions,
use the Microsoft Windows Performance Monitor as described in "Adding and Viewing TM1 Per-
formance Counters in the Microsoft Windows Performance Monitor" (p. 117) .
Running TM1PerfMon
Run the tm1perfmon.exe file from a command line on either a Microsoft Windows or UNIX system.
Use the following format and parameters:
tm1perfmon -servername <Name> [-loop <LoopCount>
-sleep <SleepTime>]
Where:
● ServerName is the name of the TM1 server to monitor. Use quotes when the server name
includes spaces. For example:
-servername "planning sample"
● LoopCount is the number of times to repeat, or refresh, the display of counter values. Default
value is 1, no loop. This value is optional.
A value of 0 causes TM1 PerfMon to loop indefinitely.
To cancel TM1 PerfMon while looping, press the CTRL+Break keys to return to the command
prompt.
● SleepTime is the time, in seconds, between loops. Default value is 5 seconds. This value is
optional.
For example, the following command line would run TM1 PerfMon continuously to monitor a
TM1 server named planning sample. The display would continue to refresh every 5 seconds, using
the default value for the sleep option, until you exit by pressing the CTRL+Break keys.
tm1perfmon -servername "planning sample" -loop 0
The following command line would run TM1 PerfMon to monitor the salesdata TM1 server,
looping a total of 10 times with a 5 second refresh rate between display updates.
tm1perfmon -servername salesdata -loop 10 -sleep 5
Note: If you do not include values for the loop and sleep options, as shown in the following example,
TM1 PerfMon will run and display the TM1 performance counters once only.
tm1perfmon -servername salesdata
Field Description
Counter Name Group name and counter name for each TM1 performance counter.
Displayed in the format: GroupName:CounterName
For example: Threads:Threads Created
Value Numeric value for the TM1 performance counter at the specific
output date and time.
Step
● Click Start, Settings, Control Panel, Administrative Tools, Performance.
The Microsoft Windows Performance Monitor opens.
Adding and Viewing TM1 Performance Counters in the Microsoft Windows Performance Monitor
You can view TM1 performance counters by adding them with the Add Counters dialog box in
the Microsoft Windows Performance Monitor. This dialog also lets you view a brief explanation
of each counter.
Steps
1. Click Add in the Performance Monitor toolbar.
The Add Counters dialog box displays.
Note: Microsoft Windows can sometimes display the following message when you open or
close the Add Counters dialog.
"At least one data sample is missing. Data collection is taking longer than expected.You might
avoid this message by increasing the sample interval. This message will not be shown again
during this session."
This message is informational only and typical if the system becomes too busy when adding
new counters. Click OK to clear the message.
6. Click Close to close the Add Counters dialog and return to the Performance Monitor.
The Performance Monitor will add the TM1 performance counters to the monitoring process
and update the display as shown in the following figure.
TM1 performance
counters
This chapter describes how to configure IBM® Cognos® TM1 to work over the Web.
● Build charts
Note: IBM Cognos TM1 Web requires the Microsoft® .NET Framework. For more information
about the exact requirements and configuration, see the ".NET Framework Requirements" section
in the IBM Cognos TM1 Installation Guide.
(1) The IIS Web server has a virtual directory that stores TM1 Web
ASP scripts.
(2) The IIS Web server must have Microsoft Excel 2002 (or later) installed.
This software is required to generate TM1 Websheets.
(3) Your IIS Web server must have Microsoft .NET Framework
version 3.0 installed.
Workstation with
(4) TM1 Web installs a Windows service - the TM1 Excel Service
Microsoft Internet Explorer
(TM1ExcelService.exe) - on your Web server. This service converts
Excel worksheets to TM1 Websheets. It also exports Websheets
back to Excel or to PDF.
Corporate Intranet
Workstation with
Microsoft Internet Explorer TM1 Server and TM1 Admin Server
(1) The TM1 Server can be installed on the same computer that
hosts your Web server, but installing on a separate computer
is more efficient.
Limiting Access to a Single TM1 Server from IBM Cognos TM1 Web
If you want to prevent IBM Cognos TM1 Web users from using multi-database support to access
other TM1 servers under the same Admin Server, you can use a different Admin Server to register
each TM1 server. For example, with this configuration, if you log into IBM Cognos TM1 Web and
try to open a Websheet that references another TM1 server registered under a different Admin
Server, the data will not display even if you have the same user name and password for that server.
Note: If you configure your TM1 servers to run under separate Admin Servers, but still want to
access them from IBM Cognos TM1 Web, TM1 Architect, or TM1 Perspectives, you can use the
AdminHost parameter. This parameter lets you specify multiple Admin Hosts so users can access
any TM1 servers that are registered with the Admin Servers on the specified hosts.
● For information about configuring IBM Cognos TM1 Web to access multiple Admin Servers,
see "Configuring the Login Page using the AdminHostName and TM1ServerName Paramet-
ers" (p. 146).
● For information about configuring TM1 Architect and TM1 Perspectives to access multiple
Admin Servers, see "The Tm1p.ini File" in the "TM1 System Configuration" section of the
IBM Cognos TM1 Operations Guide.
● "Running IBM Cognos TM1 Web in Mozilla Firefox Web Browser" (p. 124)
● "Running the 64-bit version of IBM Cognos TM1 Web on Windows x64" (p. 125)
● "Running IBM Cognos TM1 Web on a WAN Server and Exporting Excel and PDF Files" (p. 126)
Software Requirements
For a comprehensive list of supported operating systems, Web servers, and versions, see the IBM
Cognos TM1 Installation Guide.
Software Requirement
Windows Service Windows services run under a network user name and password. We
Account recommend that you establish a user account and password in your
network exclusively for the IBM Cognos TM1 Web services. The
account can have any name.
Steps
1. Insert the TM1 distribution CD in the CD-ROM drive.
The Installation Wizard runs.
Help in the TM1 Installation Wizard or see the IBM Cognos TM1 Installation Guide.
Steps
1. Open Microsoft Internet Explorer.
2. Click Tools, Internet Options from the Internet Explorer menu bar.
The Internet Options dialog box opens.
4. Click the Languages button located near the bottom of the General tab.
The Language Preference dialog box opens.
5. Verify that the primary language that you want IBM Cognos TM1 Web to use is displayed at
the top of the Language list.
If the desired language is not in the Language list, you must add it by clicking the Add button
to display the Add Language dialog box. Select the language that you want to use and then
click OK.
After you add the language, you must move it to the top of the Language list on the Language
Preference dialog by selecting it and then clicking the Move up button.
Configuring Microsoft Internet Explorer Version 7 for IBM Cognos TM1 Web
If you are using IBM Cognos TM1 Web with Microsoft® Internet Explorer 7, make sure you have
the following security setting enabled to allow IBM Cognos TM1 Web dialog windows to display
correctly. If Microsoft Internet Explorer 7 is not configured correctly, some IBM Cognos TM1 Web
dialogs can incorrectly display an address bar causing the OK and Cancel buttons to not display
as shown below.
Address bar
and buttons
display
incorrectly
Steps
1. In Microsoft Internet Explorer 7, select Tools, Internet Options.
The Internet Options dialog opens.
5. Locate the Allow websites to open windows without address or status bars option and click
Enable. This is the default setting for this option.
Enables
proper
display
Steps
1. Open the Firefox Options dialog box, depending on the type of system you are using:
If you are running Firefox on a Microsoft Windows system:
3. To enable the required JavaScript setting, select the Raise or lower windows option.
Steps
1. Open the Firefox fontEncoding.properties file in a text editor.
If you accepted the default installation directory when you installed Firefox, the full path to
this file is C:\Program Files\Mozilla Firefox\res\fonts\fontEncoding.properties.
Running the 64-bit version of IBM Cognos TM1 Web on Windows x64
To run the 64-bit version of IBM Cognos TM1 Web on a Microsoft Windows x64 system, you
must:
Note: IBM Cognos TM1 Web requires .NET 3.0, however, .NET 2.0 remains on your system
after installing .NET 3.0.
Your system is now configured to run the 64-bit version of IBM Cognos TM1 Web.
For more information about running the 64-bit version of ASP.NET, see the following Microsoft
technical article:
http://support.microsoft.com/?id=894435
Running IBM Cognos TM1 Web on a WAN Server and Exporting Excel and PDF
Files
If you are running IBM Cognos TM1 Web on a WAN (Wide Area Network) server and want to
allow users to export Excel and PDF® files from IBM Cognos TM1 Web, you need to configure
specific security settings in Internet Explorer.
Because a WAN server resides in the Internet zone, Internet Explorer applies a different security
profile as compared to servers in the Local Intranet zone. To successfully export files from IBM
Cognos TM1 Web in a WAN environment, you must add the IBM Cognos TM1 Web server as a
trusted site in the security settings for Internet Explorer.
Depending on which version of Internet Explorer you are using, perform the steps in the following
sections.
Steps
1. Click Tools, Internet Options.
4. Enter the URL of the IBM Cognos TM1 Web server in the Add this Web site to the zone box.
5. Click Add.
6. Click Close.
Steps
1. Perform the steps to add the IBM Cognos TM1 Web server as a trusted site, as described in
"Configuring Internet Explorer 6" (p. 126)
2. On the Security tab of the Internet Options dialog, click Trusted sites and then click the Custom
Level button.
The Security Settings - Trusted Sites Zone dialog opens.
3. Locate the settings for Downloads and click Enable for the Automatic prompting for file
downloads option.
4. Click OK.
Option Description
Processes Allows you to review and execute processes on the TM1 server.
Chores Allows you to review and execute chores on the TM1 server.
If you are a member of any other user group, the Administration node displays the Change Password
option. The Processes and Chores options might be available as well, depending on your security
privileges for processes and chores on the server. If you have Read privilege to any processes on the
server, the Processes option is available. Similarly, if you have Read privilege to any chores on the
server, the Chores option is available.
Steps
1. Log in to IBM Cognos TM1 Web as a TM1 administrator.
3. Click the option relevant to the administrative task you want to perform.
Each administrative task is described below.
Administering Processes
You can administer processes on the TM1 server.
Steps
1. In the Administration pane, click Processes.
IBM Cognos TM1 Web displays a list of processes you established on your TM1 server.
2. To display the control processes, select the Display Control Processes check box. To hide the
control processes, clear the Display Control Processes check box.
● Process Attributes - At the top right of the Processes page, TM1 displays the process
attributes for the selected process.
● Process Parameters - At the bottom right of the Processes page, TM1 displays the default
process parameters you established on the Parameters tab of the TurboIntegrator process.
Process Attributes
Process Parameters
Note: If your process does not use parameters, the Process Parameters box does not appear.
4. To change the process attributes, use the TM1 Server Explorer. For details, see the IBM Cognos
TM1 Users Guide.
5. To run a process, click a process in the list and click Execute Process .
Administering Chores
You can administer chores on the TM1 server.
Steps
1. In the Administration pane, click Chores.
IBM® Cognos® TM1 Web displays a list of chores you established on your TM1 server.
2. To display the control chores, select the Display Control Chores check box. To hide the control
chores, clear the Display Control Chores check box.
● Process list - Lists TM1 processes that run when you execute the chore. The processes run
in the order they appear in the list.
● Basic Chore Parameters - Indicates whether the schedule of the chore is active, the number
of processes in the chore, the last start time, and how often the chore runs.
● Chore schedule - Shows the days on which the chore is scheduled to run, and how often
the chore runs.
● Last execution time - Shows the last time the chore was run.
Process List
Chore Frequency
Chore Schedule
TM1 also displays the Chore Administration toolbar at the top of the page.
The Chore Administration toolbar contains the following buttons.
Execute Chore Runs the chore. IBM Cognos TM1 Web prompts
you for any parameters the chore requires.
Edit Chore Displays the Chore Process List Editor dialog box.
Use this dialog box to modify and arrange the list
of processes that run when you execute the chore.
4. To activate a chore to run on the set schedule, select a chore, and click Activate.
5. To deactivate a chore so that it no longer runs on schedule, select the chore, and click Deactivate.
IBM Cognos TM1 Web displays the Chore Process List Editor dialog box.
● Use the arrows to build and arrange a list of processes that run when you execute the chore.
Steps
1. In the Administration pane, click Client Properties.
IBM® Cognos® TM1 Web displays a list of clients you established on your TM1 server.
All but the Maximum # of Connections and Password Expiration properties are read-only.
3. To set the maximum number of connections that can be established on the TM1 server by the
selected client, highlight the Maximum # of Connections value and enter a new number.
4. To set the number of days that the clients password remains valid, highlight the Password
Expiration value and enter a new number.
A Password Expiration value of 0 means that the password does not expire.
Steps
1. In the Administration pane, click Cube Properties.
IBM® Cognos® TM1 Web displays a list of cubes available on your TM1 server.
2. To include control cubes in the list, select the Display Control Chores check box. To exclude
control cubes from the list, clear the Display Control Chores check box.
4. To change the value of a cube property, click the down arrow next to a property and select a
value.
Steps
1. In the Administration pane, click Dimension Properties.
IBM Cognos TM1 Web displays a list of dimensions on your TM1 server.
2. To display the control dimensions, select the Display Control Dimensions check box. To hide
the control dimensions, clear the Display Control Dimensions check box.
4. To change a property value for a dimension, click the down arrow next to a property and select
a new value.
Steps
1. Click the Administration node in the left Navigation pane.
5. Enter your new password a second time in the Verify New Password box.
For example, if you configure the homepage option to display an HTML file or other type of web
page, then you can provide users with instructions, tasks, links, or any other content that can be
displayed in a web page.
If a homepage is configured, it displays on the first tab in IBM Cognos TM1 Web and cannot be
closed by users. When configured, a Home link is displayed in the header area of IBM Cognos TM1
Web that allows users to easily return to the homepage.
An IBM Cognos TM1 Web homepage can be configured in one of the following two ways:
● Different homepage for different IBM Cognos TM1 Web users - Use the Client Settings dialog
in TM1 Architect and Server Explorer to configure a startup homepage for different clients
(users) of IBM Cognos TM1 Web.
● Global homepage for all IBM Cognos TM1 Web users - Use the HomePageObject parameter
in the web.config file to configure a homepage that applies globally to all IBM Cognos TM1
Web users.
Note: Any homepage assignment you make with the Client Settings dialog can over-ride the global
setting in the web.config if you set AllowOverwrite=true in the HomePageObject parameter of the
web.config file.
Note: You can use the Client Settings dialog to assign homepages for specific users, over-riding the
global homepage setting for the HomePageObject parameter in the web.config file.
Steps
1. In TM1 Architect or Server Explorer, right click on the server and select Security, Clients/Groups.
The Clients/Groups dialog opens.
2. Click Settings.
The Client Settings dialog opens.
3. Select the client from the Current Client list for which the homepage setting will apply.
Select client
● To select a Websheet or cube view as the homepage, click Browse. The Select an IBM
Cognos TM1 Web Homepage dialog opens where you can select a reference to a Websheet
or cube view from the Application tree.
After selecting a Websheet or cube view reference, click OK to return to the Client Settings
dialog.
5. Select the settings that control the appearance of the Navigation pane.
Note: The Navigation pane settings you set here will only apply if the corresponding parameter
in the web.config file is set to AllowOverwrite=true. For details, see "Configuring IBM Cognos
TM1 Web Startup and Appearance Settings" (p. 147).
The available settings for controlling the appearance of the Navigation pane include:
● Include the Navigation Pane - Determines if the Navigation pane is displayed or not dis-
played when the selected client logs in to IBM Cognos TM1 Web.
● Open pane on Login - Sets the Navigation pane to display in the expanded mode when the
selected client logs in to IBM Cognos TM1 Web.
● Close pane on Login - Sets the Navigation pane to display in its minimized mode when the
selected client logs in to IBM Cognos TM1 Web.
● Save Client's Navigation Pane Settings - Determines if the personal settings for the Navig-
ation pane are saved when the client logs out of IBM Cognos TM1 Web.
6. Select one of the options from the Apply To list to configure which client or clients will be able
to view the homepage.
● Current Client - Applies the homepage setting for only the client selected in the Current
Client list.
● Selected Clients - Enables the Select button so you can open the Subset Editor to select a
collection of clients that will use the same homepage setting.
● All Clients - Applies the same homepage setting to all TM1 clients.
If you choose Selected Clients, and then click Select, the Subset Editor opens so you can select
a subset of TM1 clients that can use the homepage.
Use the Subset Editor to select a subset of clients and then click OK to return to the Client
Settings dialog. The number of clients selected in the Subset Editor is summarized in the Client
Settings dialog.
7. Click Apply Settings to configure the homepage for the client or clients that you selected in the
Apply To list.
8. Repeat steps 4, 5, 6, and 7 to configure a homepage for a different set of TM1 clients.
Note: You can over-ride the global HomePageObject parameter by using the Client Settings dialog
to assign different homepages for individual TM1 clients. For details, see "Configuring Different
Homepages for Individual Users" (p. 133)
The HomePageObject parameter works for three types of objects:
● Cubeviewer
● Websheet
● URL
The homepage object displays after the user successfully logs in to IBM Cognos TM1 Web.
where:
● ObjectPath is the path to the Websheet, cube view, or URL object that you want to open. The
exact format of the path depends on the type of object.
● ObjectType is the keyword for the object you want to open; websheet, cubeviewer, or URL.
● ObjectTitle is a brief title you assign to the object that displays in the title bar of the web browser
and on the homepage tab in IBM Cognos TM1 Web.
If you set AllowOverwrite=true then the HomePageObject parameter can be overridden by setting
a different homepage for individual clients using the Client Settings dialog in TM1 Architect and
Server Explorer.
If you set AllowOverwrite=false then the HomePageObject parameter applies globally to all TM1
users and can not be individually configured with the Client Settings dialog in TM1 Architect and
Server Explorer.
The following sections describe using the HomePageObject parameter for Websheets, cube views,
and URLs.
Note: You must include a value of either PUBLIC or PRIVATE to correctly identify the specific
cube view that you want to open.
For example, to open a public view named Price from the SalesCube:
<add key="HomePageObject" value="SalesCube$$Price$$Public;Type=cubeviewer;
Description=MyStartCube;AllowOverwrite=true"
/>
● Uploaded Excel file - A Websheet that was added to TM1 as an uploaded Excel file and copied
to the TM1 server.
where WebsheetPath is the location and name of the Excel file. This can be either a path for a
local file, or a UNC path for a file located on a network.
For example, to set a UNC network path for Websheet:
value=//MySystem/Samples/classic_slice.xls
Steps to open a Websheet object that was uploaded to the TM1 server:
1. In Server Explorer, use the Properties pane to find the TM1 assigned name for the uploaded
Excel file.
User assigned name for an uploaded Excel file TM1 assigned name of an uploaded Excel file
value="TM1://ServerName/blob/PUBLIC/.\}Externals\
TM1_Filename
where:
● ServerName is the name of the TM1 sever where the Excel file is located.
● TM1_Filename is the name that TM1 assigned to the uploaded Excel file.
For example:
value="TM1://sdata/blob/PUBLIC/.\}Externals\Report_2006.xls_20070123212746.
xls
Where URL_Path can point to a web site or an individual web page file.
For example:
● To set the homepage to a URL that points to a file:
<add
key="HomePageObject" value="homepage.html;Type=URL;Description=My
Start Page;AllowOverwrite=true" />
● Administration node
Here are the most common IBM Cognos TM1 Web parameters in the Web.config file that you can
change.
● CustomToolbarURL - Establishes a target aspx file in the IBM Cognos TM1 Web virtual dir-
ectory. The aspx file defines a custom toolbar. For example, the file TM1WebPlanManToolbar.
aspx defines the TM1 Workflow toolbar.
Note: In IBM Cognos TM1 Web 9.x, TM1WebPlanManToolbar.aspx is the only custom toolbar
TM1 supports.
● NavTreeDisplayServerView - Hides or displays the Server View node in the Navigation tree.
● SmartAxisEnabled - Set to true by default. This parameter, set to false, disables our newer
smartaxis automatic scale (and interval) calculator, and reverts back to the legacy mode.
Steps
1. Log out of IBM Cognos TM1 Web.
4. In the left Navigation pane, expand your local computer folders. Locate and select the IBM
Cognos TM1 Web virtual directory.
5. Locate the Web.config file in the Content pane, right-click the file, and click Open.
Note: If Web.config is set to read-only on your hard disk, IBM Cognos TM1 Web prompts
you to overwrite the file. Click Yes to confirm overwriting the file.
7. Log in to IBM Cognos TM1 Web to see the result of your edits.
DisplayCustomToolbar N
Displays or hides the TM1 Workflow toolbar. The default is N.
Set this value to Y to display the TM1 Workflow toolbar.
CustomToolbarUrl TM1WebPlanManToolbar.aspx
Name of the custom toolbar executable. The only supported
toolbar is the default value shown here.
CustomToolbarHeight 28
Height in pixels, of the TM1 Workflow toolbar.
PM_ToolbarCaptionWidth 120
Width of the string caption on the TM1 Workflow toolbar cap-
tion.
PM_VersionCaption Process
Caption for the Process list in TM1 Workflow.
PM_VersionCaptionWidth 70
Width of the Caption for the Version list in the TM1 Workflow
toolbar.
PM_VersionListWidth 150
Width of the Version list in TM1 Workflow.
PM_TaskCaption Task
Caption for the Task list in the TM1 Workflow toolbar.
PM_TaskCaptionWidth 50
PM_TaskListWidth 200
PM_ActionCaption Action
PM_ActionCaptionWidth 55
PM_ActionListWidth 120
PM_AllTasksCaptionWidth 30
PM_StatusCaptionWidth 30
PM_CustomizeCaptionWidth 30
PM_LoadCaptionWidth 30
Steps
1. Edit the Web.config file in the IBM Cognos TM1 Web virtual directory.
2. Locate the DisplayCustomToolbar parameter, which contains a value of N. The default value
of N hides the custom toolbar, as shown below:
<!--DisplayCustomToolbar: Y/N - Whether to display
custom toolbar -->
<add key="DisplayCustomToolbar" value='N' />
3. To display the custom toolbar, change the DisplayCustomToolbar value to Y. Be sure to use
uppercase.
Note: The only supported setting for the CustomToolbarURL parameter is TM1WebPlanManTool-
bar.aspx. Do not change this setting.
<!-- CustomToolbarURL: URL to display content
for custom toolbar -->
<add key="CustomToolbarUrl" value="TM1WebPlanManToolbar.aspx"
/>
Steps
1. Edit Web.config in the IBM Cognos TM1 Web virtual directory.
2. Locate the CustomToolbarHeight parameter, which controls the display of the Server View
node. Note the value of 28 (in pixels).
<!-- CustomToolbarHeight: Height of custom toolbars
i n pixels -->
<add key="CustomToolbarHeight value="28" />
3. Change the number of pixels to change the height of the custom toolbar.
Steps
1. Edit Web.config in the IBM Cognos TM1 Web virtual directory.
2. Locate the NavTreeDisplayServerView, which controls the display of the Server View node.
The default value, Y, displays the Views node in the Navigation pane.
<!--NavTreeDisplayServerView: Y/N - Wether to display
"Server View" node in navigation tree -->
<add key="NavTreeDisplayServerView" value="Y" />
4. Save Web.config.
Steps
1. Edit Web.config in the IBM Cognos TM1 Web virtual directory.
4. Save Web.config.
Steps
1. Edit Web.config.
4. Save Web.config.
Steps
1. Edit Web.config.
CubeViewerRowPageSize
CubeViewerColumnPageSize
3. Change the value for the row and/or column page size.
4. Save Web.config.
Steps
1. Edit Web.config.
4. Save Web.config.
The executionTimeout parameter specifies the maximum number of seconds that a request, such
as opening a Websheet, is allowed to execute before being automatically shut down by Microsoft®
Internet Information Services (IIS).
Steps
1. Edit Web.config.
If a value is not specified in Web.config, then the value in the Microsoft® .NET Framework
configuration file, Machine.config, is used. If no value is specified in either file, then the default
value for this parameter is 90.
4. Save Web.config.
where PortNumber must be set to a valid port number, as shown in the following example:
<add key="TM1ExcelServicePortNumber" value="4785"
/>
AdminHostName Parameter
This parameter specifies the name of the Admin Host on which a TM1 Admin Server is running.
Edit the AdminHostName parameter in the Web.config file using the following format:
<add key="AdminHostName" value="HostName"
/>
● If HostName is set to the name of a valid TM1 Admin Host, then IBM Cognos TM1 Web uses
that Admin Host for the login process and does not prompt the user.
TM1ServerName Parameter
This parameter sets the name of the TM1 server. Edit the TM1ServerName parameter in the
Web.config file using the following format:
<add key="TM1ServerName" value="ServerName"
/>
● If ServerName is blank (default value), then the TM1 Server prompt is displayed on the IBM
Cognos TM1 Web login page, as shown below.
● If ServerName is set to a valid TM1 server name, then the login page does not display a prompt
for either the Admin Host or the TM1 Server.
After the user enters a valid User Name and Password, IBM Cognos TM1 Web will login to the
TM1 server specified by the TM1ServerName parameter in the Web.config file.
For example, the TM1ServerName parameter could be set to planning sample, as shown in the
following code.
<add key="TM1ServerName" value="planning sample" />
● NavTreeCollapsedOnStart
● HideTabBar
● HideWebsheetToolBar
● HideCubeviewerToolBar
These parameters are located in the <appSettings> section of the web.config file for IBM Cognos
TM1 Web and apply globally to all users of IBM Cognos TM1 Web.
Note: For details on using the HomePageObject parameter to set a custom homepage, see "Config-
uring a Custom Homepage for IBM Cognos TM1 Web" (p. 132).
NavTreeHidden Parameter
The NavTreeHidden parameter determines if the Navigation pane displays when users log in to
IBM Cognos TM1 Web. This can be helpful if you are displaying a custom homepage for users and
you want to completely hide the Navigation pane.
The NavTreeHidden parameter uses the following format in the web.config file:
<add key="NavTreeHidden" value="false;AllowOverwrite=true"
/>
where:
value can be either true or false
● If set to false, the Navigation pane will be displayed when user's log in to IBM Cognos TM1
Web.
● If set to true, the Navigation pane will not be displayed when user's log in to IBM Cognos TM1
Web.
● If you set AllowOverwrite=true, the NavTreeHidden parameter is assigned globally to all users,
but can be overridden for individual clients using the Client Settings dialog in TM1 Architect
and Server Explorer.
● If you set AllowOverwrite=false, the NavTreeHidden parameter applies globally to all TM1
users and can not be overridden for individual clients using the Client Settings dialog in TM1
Architect and Server Explorer.
NavTreeCollapsedOnStart Parameter
The NavTreeCollapsedOnStart parameter determines if the Navigation pane will be minimized or
expanded when users log in. If collapsed, a small vertical bar displays to provide the user with a
way to restore the pane.
The NavTreeCollapsedOnStart parameter uses the following format in the web.config file:
<add key="NavTreeCollapsedOnStart" value="false;AllowOverwrite=true"
/>
where:
value can be either true or false.
● If value is set to false, the Navigation pane will be expanded and display in its default mode
when user's log in to IBM Cognos TM1 Web.
● If value is set to true, the Navigation pane will be collapsed when user's log in to IBM Cognos
TM1 Web.
HideTabBar Parameter
The HideTabBar parameter determines if IBM Cognos TM1 Web can display multiple tabs when
a user opens multiple IBM Cognos TM1 Web objects, or if only one view is displayed. This can be
useful if you want to limit users to one view at a time.
The HideTabBar parameter uses the following format in the web.config file:
<add key="HideTabBar" value="false;AllowOverwrite=true"
/>
● If value is set to true, multiple tabs are not displayed and only one object can be opened at a
time.
HideWebsheetToolBar Parameter
The HideWebsheetToolBar parameter determines if the Websheet toolbar is displayed when users
open a Websheet.
The HideWebsheetToolBar parameter uses the following format in the web.config file:
<add key="HideWebsheetToolBar" value="false;AllowOverwrite=true"
/>
● If value is set to true, the Websheet toolbar will not display in IBM Cognos TM1 Web.
HideCubeviewerToolBar Parameter
The HideCubeviewerToolBar parameter determines if the Cubeviewer toolbar is displayed when
users open a cube view.
The HideCubeviewerToolBar parameter uses the following format in the web.config file:
<add key="HideCubeviewerToolBar" value="false;AllowOverwrite=true"
/>
● If value is set to true, the Websheet toolbar will not display in IBM Cognos TM1 Web.
Using the CustomLink Parameter to Open Other URLs and Web Pages
The CustomLink parameter displays a link in the IBM Cognos TM1 Web toolbar that can open a
URL address or web page. You can configure this parameter with your own custom text and URL
for the link. When you click the link, the target of the URL opens in a new window using your
system's default web browser.
The default setting for this parameter is disabled - all the values for the parameter are set to blank.
This prevents the link from displaying on the toolbar.
<add key="CustomLink" value=";Description=;Url=;"
/>
To configure the CustomLink parameter, edit the web.config file using the following format.
<add key="CustomLink" value="LinkTitle;Description=LinkTooltip;Url=LinkURL;"
/>
where
● LinkTitle is the text that displays for the link in the toolbar.
● LinkTooltip is the help text that displays when you hover the mouse over the link.
● LinkURL is the URL that you want to open when you click the link.
For example:
<add key="CustomLink" value="IBM Web Site;Description=Open
the IBM Web Site;Url=http://www.ibm.com"/>
Note: You must follow standard character escape rules for XML when adding a URL to the XML-
based web.config file. For example, replace the & character with the & escape sequence.
By default, the IBM Cognos TM1 Web installation configures this virtual directory in the following
location:
C:\Inetpub\wwwroot\TM1WebEx
Note: This configuration does not typically require any changes, however, if necessary, you can
configure this setting using the UseSeparateVirtualCache parameter in the web.config file as follows:
<add key="UseSeparateVirtualCache" value="Y;Url=;AbsolutePath="/>
where the Url and AbsolutePath parameters must resolve to the same location.
● Url is the URL path to the virtual directory that you want IBM Cognos TM1 Web to use as
the cache directory.
The default is Url=http://<WebServerName>/TM1WebEx.
● AbsolutePath is the path to the physical directory that you want IBM Cognos TM1 Web to use
as the cache directory.
The default is AbsolutePath=C:\Inetpub\wwwroot\TM1WebEx.
Important: The UseSeparateVirtualCache parameter must be set to either Y or not used at all. If
this parameter is excluded from the web.config file, IBM Cognos TM1 Web uses TM1WebEx as
the default location for the virtual cache directory.
Warning: IBM Cognos TM1 Web will not work if the UseSeparateVirtualCache parameter is set
to N.
To disable this parameter and use the IBM Cognos TM1 Web 9.0 charting, edit the web.config file
as follows:
<add key="SmartAxisEnabled" value="false" />
The Websheet paging toolbar is disabled by default. Use the WebsheetPaging parameter in the
web.config file to enable and configure the Websheet paging toolbar.
Steps
1. Open the web.config file and locate the <!-- Websheet Paging Settings --> line.
2. To enable the Websheet paging feature, set the value of the WebsheetPaging parameter to
Enabled=true as follows:
<!-- Websheet Paging Settings -->
<add key="WebsheetPaging" value="Enabled=true;PageSize=100"
/>
3. Set the approxiamte number of Websheet rows that you want viewable in IBM Cognos TM1
Web by configuring the PageSize parameter. For example:
<add key="WebsheetPaging" value="Enabled=true;
PageSize=50"
/>
4. To disable the Websheet paging feature, set the value of the WebsheetPaging parameter to
Enabled=false as follows:
<!-- Websheet Paging Settings -->
<add key="WebsheetPaging" value="Enabled=false;PageSize=100"
/>
Modifying the IBM Cognos TM1 Web Virtual Directory to Allow Anonymous
Access
The IBM Cognos TM1 Web installation automatically configures the IBM Cognos TM1 Web virtual
directory to allow anonymous access.
To verify or reset anonymous access for the IBM Cognos TM1 Web virtual directory, follow these
steps:
Steps
1. Open the Windows Control Panel.
6. Write down the user name of the anonymous access account; you will need this name in a later
step.
● UserTempDir
● TempCharts
The required security settings are automatically configured for these folders during the IBM Cognos
TM1 Web installation.
To verify or reset the security for these IBM Cognos TM1 Web folders:
Steps
1. In Windows® Explorer, navigate to the TM1Web directory on your Web server.
Note: If you accepted the default location during installation, the default directory is C:\Inetpub\
wwwroot\TM1Web.
5. Select a location:
● Click Locations.
● Click OK.
6. In the Enter the object names to select box, enter the anonymous user name that you noted in
the Authentication Methods dialog box, see "Modifying the IBM Cognos TM1 Web Virtual
Directory to Allow Anonymous Access" (p. 152).
7. Click Check Names to verify that the user name is valid, and click OK to close the Select Users
or Groups dialog box.
10. Select the anonymous Internet Guest Account and click Edit.
The Permission Entry for ExcelSheet dialog box opens.
11. Set all permissions from List Folder/Read Data through Read Permissions to Allow, as shown
in the following figure.
13. Repeat steps 2 through 12 to set up security for the UserTempDir and TempCharts folders.
● Tempcharts - When you generate a chart from a Cube Viewer, IBM Cognos TM1 Web writes
a temporary file to this folder.
These folders are located under the IBM Cognos TM1 Web directory. If you accepted the default
location during installation, the default IBM Cognos TM1 Web directory is C:\Inetpub\wwwroot\
TM1Web.
For best practice, monitor the Excelsheet and Tempcharts folders, and delete their contents period-
ically when the folders become full.
Parameter Description
DEBUG Detailed, technical messages that are useful when TM1 customer support
or development engineering need to debug the application.
When logging is configured to this level, DEBUG, INFO, and ERROR
messages are logged.
INFO Informational messages that highlight the progress of the application and
report normal transitions within the application.
When logging is configured to this level, INFO and ERROR messages are
logged.
ERROR An error condition of which you should be aware. Action should be taken
to fix or report the issue to TM1 customer support.
When logging is configured to this level, only ERROR messages are logged.
The web.config file is installed in the <TM1Web _install_directory>. If you installed IBM Cognos
TM1 Web to the default installation location, the web.config file is located in the directory C:\
Inetpub\wwwroot\TM1Web.
Note: The default web logging configuration is intended for every-day use and does not typically
require adjustment. For assistance if you need to configure the logging properties for
troubleshooting purposes, see the IBM CognosResource Center (http://www.ibm.com/software/
data/support/cognos_crc.html).
The following is a sample of the logging properties section in the web.config file.
<log4net>
<root>
<level value="ERROR" />
<appender-ref ref="LogFileAppender" />
</root>
<appender name="LogFileAppender" type="log4net.Appender.RollingFileAppender">
<file value="log\tm1web_err.log" />
<appendToFile value="true" />
<datePattern value="yyyyMMdd" />
<rollingStyle value="Date" />
<filter type="log4net.Filter.LevelRangeFilter">
<acceptOnMatch value="true" />
<levelMin value="INFO" />
<levelMax value="FATAL" />
</filter>
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level
%logger - %message%newline" />
</layout>
</appender>
</log4net>
Where:
The message level is indicated by: <level value="ERROR" />
the minimum and maximum message level ranges are indicated by:
<levelMin value="INFO" />
<levelMax value="FATAL" />
3. Change the level to one of the valid values; DEBUG, INFO, or ERROR.
For example, to change the message level to DEBUG, edit this line as follows:
<level value="DEBUG" />
Adjust the values for the levelMin and levelMax parameters to a range that includes the level
you want to log.
For example, to log DEBUG level messages, change the levelMin parameter to DEBUG.
<levelMin value="DEBUG" />
<levelMax value="FATAL" />
If you installed IBM Cognos TM1 Web to the default installation location, then the tm1web_err.log
file is located in the following directory:
C:\Inetpub\wwwroot\TM1Web\log
For backup purposes, a copy of the tm1web_err.log file is renamed and saved on a daily basis using
the following naming convention:
tm1web_err.log<year><mm><dd>
Steps
1. Locate the tm1web_err.log file in the <TM1Web install directory>\log\ directory.
2. Open and view the file with a text editor, such as Microsoft Windows Notepad.
Each line in the log file represents one unique message, arranged in the following format:
2007-01-17 11:13:36,916 [2600] ERROR Cognos.TM1.Web.PageTM1WebpageUtils
- <Chores> not localized
Where:
2007-01-17 11:13:36,916 is the date and time
Note: The default logging configuration is intended for every-day use and does not typically require
adjustment. Contact TM1 customer support for assistance if you need to configure the
TM1ExcelService.exe.config file for troubleshooting purposes.
A sample of the TM1ExcelService.exe.config file is shown:
<log4net>
<root>
<level value="ERROR" />
<appender-ref ref="LogFileAppender" />
</root>
<appender name="LogFileAppender" type="log4net.Appender.RollingFileAppender">
<file value="tm1excelservice_err.log" />
<appendToFile value="true" />
<datePattern value="yyyyMMdd" />
<rollingStyle value="Date" />
<filter type="log4net.Filter.LevelRangeFilter">
<acceptOnMatch value="true" />
<levelMin value="INFO" />
<levelMax value="FATAL" />
</filter>
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level
%logger - %message%newline" />
</layout>
</appender>
</log4net>
Where:
The message level is indicated by: <level value="ERROR" />
the minimum and maximum message level ranges are indicated by:
3. Change the level to one of the valid values; DEBUG, INFO, or ERROR.
For example, to change the message level to DEBUG, edit this line as follows:
<level value="DEBUG" />
Adjust the values for the levelMin and levelMax parameters to a range that includes the level
you want to log.
For example, to log DEBUG level messages, change the levelMin parameter to DEBUG.
<levelMin value="DEBUG" />
<levelMax value="FATAL" />
Steps
1. Locate the tm1excelservice_err.log file in the <TM1_install_dir>\bin directory.
2. Open and view the file with a text editor, such as Microsoft® Windows® Notepad.
Each line in the file represents one unique message, arranged in the following format:
2007-01-16 10:59:40,846 [3156] ERROR Cognos.TM1.ExcelServices.TM1ExcelService
- 'PDFcamp Printer' printer
Where:
2007-01-16 10:59:40,846 is the date and time
Overview
IBM Cognos TM1 9.4 updated TM1 Web to use the Cognos 8 corporate-style skin similar to other
IBM Cognos 8 applications. However, TM1 Web did not support an easy way to switch to the
other pre-defined IBM Cognos 8 skins or provide a way to use custom skins.
TM1 Web administrators and application developers can now use the IBM Cognos 8 skins and
related features with TM1 Web as follows:
● Easily configure TM1 Web to use any of the six built-in IBM Cognos 8 skins.
● Use the TM1 Web URL API to dynamically set the skin for applications that use the TM1 Web
URL API.
The following figures show the available predefined IBM Cognos 8 skins for TM1 Web 9.4 MR1.
Corporate
Classic
Business
Contemporary
Modern
Presentation
Configuration
Each skin for TM1 Web is defined by a Cascading Style Sheet (css) file and a set of supporting
images. These files are installed when you install IBM Cognos TM1 Web. TM1 Web is configured
to use the corporate style skin as the default skin.
The css file for each skin is given a unique name and installed to the location:
<TM1Web installation>\css
The supporting images for a skin are installed to a folder using the same name as the skin in the
following location:
<TM1Web installation>images\skins\skin name
When a skin is set, TM1 Web first checks to see if the corresponding css file exists in the /css sub-
directory. If the file does not exist, the specified skin will not be used. TM1 also verifies whether
there is a corresponding sub-directory under the /images/skins directory that contains the images
for the specified skin. If this directory does not exist, the images of the default skin will be used
instead.
You can select which skin to use by configuring the Web.config file or with the TM1 Web URL
API, depending on how you are using TM1 Web.
Steps
1. Open the Web.config file in a text editor.
3. Enter a skin name for the value of the parameter. For example:
<add key="CustomStyle" value="classic;AllowOverwrite=true"
/>
For backward compatibility, this value can also include a .css extension and the css directory
name. For example:
<add key="CustomStyle" value="classic.css;AllowOverwrite=true"
/>
<add key="CustomStyle" value="css/classic.css;AllowOverwrite=true"
/>
● Classic
● Business
● Contemporary
● Modern
● Presentation
Note: If the file contains multi-byte characters, you must save the file in UTF-8 format.
Using the TM1 Web URL API to Set a TM1 Web Skin
If you are using the TM1 Web URL API to show TM1 Web objects, such as the Cubeviewer,
Websheet or navigation tree, you can change the skin by using the UserStyle parameter in the
URL query string. Using this parameter, each user can overwrite the default skin for their session
and each TM1 Web object in that session will use that same skin.
Note: The TM1 Web URL API can change the skin only if the AllowOverwirte property is set to
true, in the Web.config file.
Steps
1. In the Web.config file, edit the CustomStyle parameter to set AllowOverwrite to true. This
setting allows users of the TM1 Web URL API to change the skin for their session.
<add key="CustomStyle" value="classic;AllowOverwrite=true"
/>
3. Add the UserStyle parameter to your TM1 Web URL API query string using the following
format:
&UserStyle=SkinName
● Classic
● Business
● Contemporary
● Modern
● Presentation
For example, the following URL string opens a TM1 Web cube view using the business skin.
http://WebServerName/TM1Web/TM1WebMain.
aspx?action=OpenObject&type=Cubeviewer&value=plan_BudgetPlan$$plan_budget_
input&UserStyle=business
Steps
1. In the <TM1Web installation>\css directory, copy and rename an existing css file to your own
file name.
For example, copy business.css to newskin.css.
2. In the <TM1 Web installation>\images\skins\ directory, copy one of the existing skin folders,
including all of its sub-folders, to your own folder using the same name as the css file that you
created.
For example, copy the ...\images\skins\business folder to ...\images\skins\newskin.
3. Edit the content of your custom css file. Make sure that any references to image files point to
the custom skin folder that you created under ...\images\skins\.
5. Open the Web.config file and edit the value for the CustomStyle parameter value so it includes
the name of your custom skin. For example:
<add key="CustomStyle" value="newskin;AllowOverwrite=true"
/>
IBM® Cognos® TM1 security features enable you to control who logs in to your TM1 server, and
what objects those users are allowed to access.
Authentication
When you install the TM1 server, you can select one of these authentication methods.
● TM1 Authentication - TM1 server asks you for a user name and password, and validates the
login information against the security cube login information.
● LDAP Authentication - TM1 server asks you for a user name and password, and validates the
login information against an external LDAP server.
After you install the TM1 server, you can change the authentication method by changing the
parameters in the TM1 configuration files.
TM1 Authentication
With TM1 authentication, the TM1 server checks the user name and password against the user
names and passwords in the TM1 database.
TM1 Architect
Ask for a User Name and Password
TM1 Perspectives
TM1 Web Client
Check Name
and Password
Establish Connection
Integrated Login
With Integrated Login, TM1 uses the Microsoft® Windows® network authentication to access
your TM1 data. After you log in to your Windows workstation, you can access TM1 without
entering a user name and password again.
Integrated Login is supported on Windows only. You cannot use Integrated Login to access a
UNIX® TM1 server.
Integrated Login
LDAP Authentication
With LDAP authentication, an LDAP security service that is external to TM1 authenticates a login
(as of TM1 version 8.2.2). You can add, modify, and delete user security information from one
location - the LDAP server or Windows Active Directory.
Suppose you have a group named Executives in your TM1 database. You want these executives to
review the company budget summary data, which is stored in the BudSummary cube in your TM1
database. You can use TM1 Architect or TM1 Perspectives to assign the Executives group Read
privileges to the BudSummary cube.
You set TM1 access control the same way for any of the products in the TM1 suite. For example,
if users in the Executives group have Read access to the BudSummary cube when they run TM1
Perspectives, they also have Read access to that cube when they run the TM1 Web client.
For more information about the procedures required to set security for TM1 objects, see the IBM
Cognos TM1 Developers Guide.
The ETLDAP utility allows you to move information from your LDAP directory to TM1.
● Populates the UniqueID field in the }ClientProperties cube with the domain-qualified user name
of the user you add to TM1 database. For example, ETLDAP writes the name robert@com-
pany.com to the }ClientProperties cube.
● Migrate information from a legacy LDAP database to TM1, when you install TM1.
● Perform one or more queries to specify the users you want to create in TM1, and then export
the users into the TM1 security cubes.
● Maintain user information after you initially load the user data into TM1, by synchronizing
the TM1 data with the LDAP server.
Note: The ETLDAP utility is not available when a TM1 server is configured to use IBM® Cognos®
Access Manager (CAM) authentication.
Using ETLDAP
Here are the major steps involved in using ETLDAP.
❑ Modify LDAP Attributes
❑ Run ETLDAP
Note: You must use ETLDAP with Integrated Login and LDAP authentication. Otherwise, you
will experience problems when you synchronize your TM1 users with your Windows® security
information.
At run time, this method is passed the name of each LDAP attribute that matches a mapping entry
and its value. The String it returns is added to the TM1 database.
The following code demonstrates the implementation of the stringFilter class, combining all users
from the R&D, Quality Assurance, and Documentation LDAP groups into a single TM1 group
named Engineering.
The stringFilter class looks for instances of the LDAP 'ou' attribute, which is the TM1 Group names
field. If the value is 'R&D', 'Quality Assurance', or 'Documentation', it returns 'Engineering'. The
users from any of the 3 LDAP groups is added to a single TM1 'Engineering' group. Any other
group value remains unchanged.
// The stringFilter class provides the ability
to transform
strings
// which are read from the LDAP database before they
are inserted into // TM1's datastore.
// To implement this feature, create a class which extends
stringFilter
// and contains a method 'filterString' with the following
signature:
//
// String filterString(String attrName, String value)
//
//
public class myStringFilter extends stringFilter
{
public String filterString(String attrName, String value)
{
if (attrName.equals("ou"))
{
if ( (attrName.equals("R&D")) ||
(attrName.equals("Quality Assurance")) ||
(attrName.equals("Documentation")) )
return "Engineering";
else
return value;
}
else
return value;
}
}
After you write and compile the Java™ code, put the class somewhere in your Classpath, and enter
its name in the Class Name field of the Options dialog on the Edit menu.
Running ETLDAP
You can run ETLDAP from Windows or the DOS command prompt.
Search DN Displays the LDAP node at which the search originates. ETLDAP
does not search for entries above this level in the tree.
Filter Displays the query string that filters the entries in the directory and
generates the matching records.
Attributes Displays the attribute values for LDAP entries that assist in validating
the records returned by the search. When you export the LDAP
information to TM1, ETLDAP retrieve the attributes required to create
valid TM1 users.
Search Scope Specifies the starting point of the search, and the search level. Select
One levelto specify all entries one level below the base Search DN,
but not the base DN itself. Select Sub-tree level to search all entries
beneath the base DN, including the base DN.
Results Table Displays the search results. Click the column headers to sort the data,
or right-click in a row and click View Entry to examine all attributes
for that entry.
Search Button Performs the search using the parameters you select.
Export Button Exports the displayed set of users to TM1 based on the settings in the
Options dialog box.
Steps
1. Click Start, Programs, Accessories, Command Prompt.
Parameter Description
-f <filename> Passes the name of a saved session file to load all configuration settings
from a previous session.
When you run ETLDAP in unattended (batch) mode, you must include
a name for the session save file. If this file does not contain the passwords
necessary to connect to the LDAP and TM1 servers, an error message is
written to the log file and the session is terminated.
-secure When you run ETLDAP in batch mode, passing this flag removes all
passwords from the session file referenced by the -f flag after they have
been read.
This parameter reads the save file at the beginning of the session, and
then re-writes the file with the passwords removed. While in use, you
would run ETLDAP and specify the passwords with the user interface.
Then you would exit ETLDAP and run the command line version specify-
ing the '-secure' option. This would insure that the passwords were only
available for the short period of time it takes for the utility to initialize.
Steps
1. In the LDAP Load Tool dialog box, click File, Connect.
Host Info Version ETLDAP will most likely ignore the version
number. Most LDAP servers support version
2 or version 3 type connections, ETLDAP does
use any functionality specific to either version.
User Info User DSN In many cases, your LDAP directory prevents
Anonymous users from accessing or modifying
data. In this case, you may need a Distin-
guished Name (DN) and password to complete
the extraction of your LDAP security informa-
tion.
For example, the name Norm Lodin might
refer to a person who works at Blodget, Inc.
Inside LDAP, he has a Distinguished Name
that uniquely distinguishes him from all other
entities in the network.
Norm might enter the following information
in the User Info field.
uid=nlodin, ou=People, o=Blodget.com
3. Click Test.
If you successfully connect to the LDAP server, the status bar displays the Connection Succeeded
message in green.
If you do not connect to the LDAP server, the status bar displays an error message in red.
4. Click OK.
You have established a connection to your LDAP server with the parameters you specified.
● Search DN - An LDAP directory is organized as a tree structure, with a root node and a number
of branches off this root. The Search DN specifies at which node the search originates. Entries
above this level in the tree are searched. You must specify the correct base DN to obtain the
results you want.
● Filter - A query string that filters the entries in the LDAP directory and generates the matching
records. You can create complex filters by using a combination of the following symbols:
● & (AND)
● | (OR)
● ! (NOT)
● * wildcard character
For instructions on building LDAP filter strings, refer to LDAP books and online resources,
including the LDAP standard, RFC 2254, The String Representation of LDAP Search Filters.
● Scope - While the Search DN specifies the starting point of the search, the Scope attribute
indicate the level of depth to which the search occurs. There are two Scope levels:
● One Level - Specifies that LDAP search all entries one level below the base DN, but does
not include the base DN itself.
● Sub-Tree Level - Indicates that LDAP search all records at all levels including the base DN.
The following diagram illustrates the effect that the Scope setting has on a search.
Scope: One
● Attributes - Describe every LDAP entry and their values. Includes a comma-separated list of
values to return for the records that match the filter string. There are two LDAP attributes:
● User attribute - You add this attribute to the LDAP directory. For example, cn or mail.
● Operational attribute - The LDAP server creates and maintains this attribute. For example,
numSubordinates.
● Not present. If an attribute is optional, the attribute may not exist for an entry.
Note: Be sure to request only the attributes you need. If you request all attributes, a large result set
can significantly increase processing time on the LDAP server and memory requirements on both
the server and the client.
Steps
1. Specify the Search DN, Filter String, Attributes, and Scope for your query.
2. Click Search.
If you did not make any syntax errors or create a filter string that does not match any records
in the directory, you should see a list of entries in the table. A status message indicates how
many records match your search requirements.
● Do you need to build multiple queries to capture the list of records you are interested in?
5. Click Search.
Note: You can use the saved LDAP query at a later time. To do so, click File, Open in the LDAP
Load Tool dialog box. ETLDAP fills in the DN, Filter String, Attributes, and Scope for your
LDAP query.
Steps
1. Click Edit, Login, TM1.
Field Description
Host The machine name of the server on which your TM1 Admin Server
is running.
Server The name of the TM1 server to which you want to connect. Click
Server and then the Browse button to select a server from the Server
list.
Field Description
Username The name of a user with Admin privileges on the target TM1 server.
3. Click Test.
The status bar displays the Connection Succeeded message in green.
4. Click OK.
Steps
1. Click Edit, Mapping, TM1.
The TM1 Mapping dialog box opens.
2. For each required (red) TM1 field, select an LDAP schema attribute.
For each user, TM1 requires a unique name and group name. For example, you could map the
name attribute in your LDAP schema to a TM1 user, and map the department attribute to a
TM1 group.
3. Click OK.
Steps
1. Click Edit, Options.
The Options dialog box opens.
3. Enter the realm name that contains the users you want to transfer.
6. Click OK.
Steps
1. Click Export.
ETLDAP moves the records you retrieved from the LDAP directory into TM1, and logs the
data export activity in a log file.
Note: You can open the log before you export records to track the export progress.
Note: If you use Integrated Login, TM1 users do not use the TM1 passwords, and you do not
have to coordinate passwords between TM1 and Windows. If you do not use Integrated Login,
TM1 users must change their password during their first login session. For details, see "Integrated
Login" (p. 167).
During an export session, ETLDAP examines all records as it processes them and stores the date
of the most recently changed record in the Session Log file, as shown in the following sample:
newest record modified: Thu Jan 23 07:00:42 EST 2003(20030123070042.0Z)
Steps
1. Locate the newest record line in the LDAP Session Log.
2. Insert the timestamp portion of the string in parentheses into your Filter line.
Important: Be sure to adhere to the syntax supported by LDAP Filters. See RFC 2254, The
String Representation of LDAP Search Filters.
The following table shows a sample Filter string without any changes, and after modification
for both LDAP and Active Directory servers.
Note: Remember, a standard LDAP server uses the modifytimestamp attribute, and an LDAP
server with Microsoft Active Directory uses the whenChanged attribute.
3. After you make the necessary changes to the Filter line, save the session data with a name that
clearly identifies it as an incremental update query.
This chapter describes the IBM® Cognos® TM1 Integrated Login feature.
Steps
1. Run the TM1 Installation Wizard.
Steps
1. Start TM1 Architect.
4. Click OK.
5. In the Tree pane of Server Explorer, double-click TM1 to open the list of servers.
8. Right-click the server name, and click Security, Clients and Groups.
The Clients/Groups dialog box opens.
Note: Use the scroll bar to scroll to the left, where the list of groups displays.
10. Click the check box for a user in the ADMIN column to add the user to the Admin group.
If you use the NTLM protocol, both the Web server and the TM1 server must reside on a single
computer. The NTLM protocol does not support system delegation. In a scenario where the Web
server and the TM1 server reside on different computers you should use the Kerberos security
protocol, as described in the next section. For complete details on authentication with IIS, see
http://msdn2.microsoft.com/en-us/library/aa292114.aspx
To set the SecurityPackageName parameter, complete the following steps.
Steps
1. Shut down your TM1 server.
4. Save Tm1s.cfg.
Steps
1. Run Computer Management.
3. Click Services.
If the Run WWW service in IIS 5.0 isolation modecheck box is selected, you are running your
web server in IIS 5 isolation mode.
Steps
1. Open a command prompt.
The Negotiate, NTLM parameter forces the Web server to try to use Kerberos first. If Kerberos
fails, the web server will use NTLM.
Steps
1. Run the Active Directory Users and Computers control panel.
5. Click OK.
This procedure will vary somewhat with other versions of Windows. Refer to your Windows
documentation for more information.
Steps
1. Edit machine.config on your web server. The machine.config file is located in the following
location:
C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG
password="AutoGenerate"
3. Change the userName and password fields to the domain-qualified name and password of the
TM1 service account.
Configuring TM1 Web with Integrated Login for a System Account on IIS 6 Using
Kerberos
To configure TM1 Web with Integrated Login on IIS 6 using Kerberos, you must complete the
following procedures:
❑ Step 1 - Select Integrated Login Option During TM1 Installation
Steps
1. Open a command prompt.
The Negotiate, NTLM setting forces the Web server to try to use Kerberos first. If Kerberos
fails, the web server will use NTLM.
Steps
1. Run the Active Directory Users and Computers control panel.
5. Click OK.
Configuring TM1 Web with Integrated Login for a Domain User on IIS 6 Using
Kerberos
To configure TM1 Web with Integrated Login on IIS 6 using Kerberos, you must complete the
following procedures.
❑ Step 1 - Set Your Security Protocol to Kerberos
❑ Step 3 - Set the TM1 Web Application Pool to Run Under the TM1 Network User ID
❑ Step 5 - Set the Application Pool for Your TM1 Web Virtual Directory
Steps
1. Open a command prompt.
The Negotiate, NTLM setting forces the Web server to try to use Kerberos first. If Kerberos
fails, the web server will use NTLM.
Steps
1. Right-click Application Pools and choose New→Application Pool. The Add New Application
Pool dialog box opens.
3. Choose Use Default settings for new application pool, and click OK.
Step 3 - Set the TM1 Web Application Pool to Run Under the TM1 Network User ID
The TM1 Web application pool should run using the network identity under which you run the
TM1 services.
Steps
1. Right-click the TM1 Web application pool and choose Properties.
3. Click Configurable.
4. Enter a valid domain user and password in the fields provided. This should be the same user
name and password as your TM1 services are running.
5. Click OK.
Steps
1. Run the Computer Management administration tool.
2. Navigate to the Groups folder under System Tools, Local Users and Groups, Groups.
3. Right-click the group IIS_WPG and choose Add to Group. The IIS_WPG properties dialog box
opens.
4. Click Add and add the domain-qualified name to the IIS_WPG group. This should be the same
name used by your TM1 services.
Step 5 - Set the Application Pool for Your TM1 Web Virtual Directory
This procedure describes how to configure the TM1 Web virtual directory to run in the TM1 Web
application pool.
Steps
1. Run the IIS Manager.
Steps
1. Run the Active Directory Users and Computers control panel.
5. Scroll down the Account Options list and enable the Account is Trusted for Delegation option.
This procedure will vary somewhat with other versions of Windows. Refer to your Windows
documentation for more information.
Steps
1. Download the SetSPN.exe utility from
http://www.microsoft.com/windows2000/techinfo/reskit/tools/existing/setspn-o.asp.
● On the Advanced tab under Tools, Internet Options, set Enable Integrated Windows Authen-
tication.
Additional Resources
The following online resources provide more information for setting up ASP applications on IIS
with Windows authentication.
● How to troubleshoot Kerberos-related issues in IIS
http://support.microsoft.com/default.aspx?scid=kb;en-us;326985
Steps
1. Run ETLDAP and import the user and group information from your LDAP server, as described
in Using ETLDAP.
3. Edit Tm1s.cfg in your TM1 server data directory, and set the IntegratedSecurityMode parameter
to 2.
4. Edit Tm1s.cfg in your TM1 server data directory, and set the SecurityPackageName parameter
to the security protocol you use for Integrated Login. In the following example, the server is
configured to use Kerberos.
[TM1S]
SecurityLogging=F
SecurityPackagename=Kerberos
IntegratedSecurityMode=2
Servername=myserver
DatabaseDirectory=C:\Program Files\
● TM1 Perspectives
● TM1 Web
Steps
1. Run TM1 Architect.
4. Click OK.
5. In the Tree pane of the Server Explorer, double-click TM1 to open the list of servers.
6. Double-click the server into which you exported your LDAP user and group information.
TM1 Architect should automatically log you in to TM1 without asking for a user name or
password.
Steps
1. Run Microsoft® Excel.
5. Click OK.
6. In the Tree pane of the Server Explorer, double-click TM1 to open the list of servers.
7. Double-click the server into which you exported your LDAP user and group information.
TM1 Perspectives should automatically log you in to TM1 without asking for a user name or
password.
Steps
1. Run Microsoft® Internet Explorer.
3. Enter a TM1 Admin Server host name in the Admin Host field.
5. Click Login.
This chapter describes how to set up IBM® Cognos® TM1 authentication using an LDAP server.
Note: Your LDAP server must be configured to use SSL to successfully communicate with TM1.
LDAP validation allows you to centralize all of your user passwords in an external LDAP server.
When your TM1 users log in, the user name and password they provide is validated against the
information held in your LDAP server. You can specify a password and key to use before the server
connects for LDAP authentication, or the server can directly connect without the use of a password.
PasswordSource
TM1 (Default)
Compares the user-entered password to the password in the TM1 database.
PasswordSource
LDAP
Compares the user-entered password to the password stored in on the LDAP server.
LDAPPort
636 (Default)
This must be a secure (SSL) port.
TM1 attempts to bind to an LDAP server on the specified secure port. If you do not enter an
LDAPPort value, TM1 uses the default value, port 636.
LDAPHost
host
Uses the domain name or dotted string representation of the IP address of the LDAP server host.
If you do enter a value for LDAPHost, TM1 uses the default value, localhost.
LDAPWellKnownUserName
An LDAP distinguished name. For example:
uid=bjensen,ou=people,o=company.com
TM1 server uses the well-known user name to log in to LDAP and look up the name submitted by
the user.
This is a required parameter when the LDAPUseServerAccount parameter is set to T.
LDAPSearchBase
A base distinguished name (DN) in the LDAP directory. For example:
ou=people,o=company.com
Specifies the node in the LDAP tree at which the search for the TM1 User being validated begins.
For example, if the distinguished names are of the form:
uid-bjensen, ou-people, o=company.com
then the search base would be:
ou-people, o=company.com
This is a required field.
LDAPSearchField
cn
The name of the LDAP attribute that is expected to contain the name of the TM1 user being valid-
ated. If you do not enter an LDAPSearchField value, the default value is cn, which is also the default
value for Microsoft® Active Directory.
LDAPUseServerAccount
T or F
Determines if a password is required to connect to the server when using LDAP authentication.
● To connect directly to the LDAP server using integrated authentication, set this parameter to
T. We recommend setting this parameter to T whenever the TM1 server and LDAP server exist
on the same domain.
LDAPPasswordFile
A full path to a .dat file
Defines the password file used when LDAPUseServerAccount is not used. This is the full path of
the .dat file that contains the encrypted password for the TM1 Admin Server's private key.
This parameter is required only when LDAPUseServerAccount=F.
LDAPPasswordKeyFile
A full path to a .dat file.
Defines the password key used when LDAPUseServerAccount is not used. This is the full path of
the .dat file that contains the key used to encrypt and decrypt the password for the private key.
This file must be generated using the tm1crypt utility, as described in"Run the TM1Crypt Util-
ity" (p. 220).
This parameter is required only when LDAPUseServerAccount=F.
● The SSL port on which your LDAP server is running. The default is 636.
● The name or IP address of the LDAP server you want to use for validation.
You can configure a TM1 component to use LDAP validation by completing the following proced-
ures:
❑ "Run the TM1 Installation Wizard and Select LDAP Authentication" (p. 197)
Steps
1. Run the TM1 Installation Wizard.
2. Select the LDAP authentication options, as described in the IBM Cognos TM1 Installation
Guide.
Steps
1. Edit TM1s.cfg in your TM1 server data directory.
Use the well known user you specified during the installation to log in to LDAP.
Steps
1. Log in to TM1 as an administrator.
2. Right-click the server name in Server Explorer and click Security, Clients and Groups.
Steps
1. Edit TM1s.cfg in your TM1 server data directory.
● To use a password before connecting to the server, add the following lines:
LDAPPasswordFile=<file>
LDAPPasswordKey=<key>
● The SSL port on which your LDAP server is running. The default is 636.
● The name or IP address of the LDAP server you want to use for validation.
This chapter describes how to use IBM® Cognos® 8 security with TM1.
For complete details on IBM Cognos 8 security concepts, terminology, and implementation, see the
IBM Cognos 8 Administration and Security Guide.
Note: Integrating TM1 security with IBM Cognos security requires at least TM1 9.4 and IBM
Cognos 8.4.
Note: To successfully complete these procedures, your IBM Cognos 8 server must not be configured
to allow anonymous access. If anonymous access is enabled on the IBM Cognos 8 server, you cannot
logon to a namespace from TM1 when importing Cognos groups into TM1.
Steps
1. Open the Tm1s.cfg configuration file in a text editor. Tm1s.cfg is located in the TM1 server's
data directory.
ServerCAMURI The URI for the internal dispatcher that the TM1 server should use
to connect to IBM Cognos 8 security. The URI is specified in the
form http[s]://<host IP address>:<port>/p2pd/servlet/dispatch.
For example, http://10.121.25.121:9300/p2pd/servlet/
dispatch or https://10.121.25.121:9300/p2pd/servlet/
dispatch
2. Click Environment.
ClientCAMURI The URI for the IBM Cognos 8 Server IBM Cognos Connection
used to authenticate TM1 clients. The URI is specified in the form:
http[s]://host/cognos8/cgi-bin/cognos.cgi.
CAMSSLCertificate The full path and name of the SSL certificate to be used when
connecting to the internal dispatcher. For example, C:\AxTM1\
Install_Dir\ssl\CognosCert.cer.
ClientPingCAMPass- Indicates the interval, in seconds, that a client should ping the IBM
port Cognos 8 server to keep their passport alive.
If an error occurs or the passport expires the user will be disconnec-
ted from the TM1 server.
Steps
1. Open the Tm1p.ini configuration file in a text editor. Tm1s.cfg is located in the C:\Documents
and Settings\<user name>\Application Data\Applix\TM1 directory.
CognosGatewayURI The URI for the IBM® Cognos® 8 Server IBM Cognos Connec-
tion used to authenticate TM1 clients. The URI is specified in
the form
http[s]://host/cognos8/cgi-bin/cognos.cgi
For example: http://10.121.25.121/cognos8/cgi-bin/
cognos.cgi
Steps
1. Log in to your TM1 server as an administrator.
2. From the Server Explorer, click Server, then Security, then Clients/Groups.
3. From the Clients/Groups dialog box, click Clients, then Add New Client.
5. In the Name box, click the namespace to which you are currently logged in.
Note: Only users from the namespace to which you are logged in can be imported into TM1.
Other namespaces may appear in the Name box, but you cannot import users from them.
The contents of the Name box update to display the directories available on the selected
namespace.
7. Navigate to the directory containing the Cognos user you want to define as a TM1 administrator.
In most circumstances, you will define your own Cognos user as a TM1 administrator, as you
must know the Cognos user's ID and password to complete administrative tasks.
9. Click the green arrow button to move the selected user to the Selected Entries list.
11. Assign the new user to the ADMIN group and click OK.
14. Set the IntegratedSecurityMode parameter to 4, indicating that the server should use IBM
Cognos 8 authentication.
IntegratedSecurityMode=4.
Steps
1. In the Server Explorer, double-click your TM1 server.
2. Log on as the Cognos user that you have defined as a TM1 administrator.
3. From the Server Explorer, click Server, then Security, then Clients/Groups.
4. From the Clients/Groups window, click Groups, then Add New Groups.
5. In the Names box, click the namespace to which you are currently connected.
Note: Only groups from the namespace to which you are connected can be imported into TM1.
Other namespaces may appear in the Name box, but you cannot import groups from them.
6. Navigate through the directory structure and select the Cognos groups you want to import into
TM1.
7. Click the green arrow button to move the selected user to the Selected Entries list.
If you review the User Group Assignment section of the Clients/Groups window, you should
see the Cognos groups added to your server.
Creating Users
When a TM1 server is configured to use IBM Cognos 8 authentication, you cannot create new clients
directly on the TM1 server. Instead, all client administration is performed in IBM Cognos 8.
When a Cognos user accesses TM1, the user is validated and automatically assigned to the appro-
priate TM1 groups. There is no need to manually assign users to groups in TM1.
Authentication Behavior
The following rules govern authentication behavior when logging on to a TM1 server that uses
IBM Cognos 8 authentication.
● If common logon is enabled in IBM Cognos 8 and you have previously logged in to an IBM
Cognos application and maintain an active session, you are not prompted for credentials when
logging on to the TM1 server.
● If common logon is enabled in IBM Cognos 8 and you have not previously logged in to an IBM
Cognos application, you are prompted for credentials when logging on to the TM1 server.
● If common logon is not enabled in IBM Cognos 8, you are prompted for credentials when
logging on to the TM1 server, even if the TM1 server is configured to use IBM Cognos 8
authentication.
Steps
1. From the Server Explorer, click Server, then Logon As.
2. In the Cognos Logon window, enter the User ID and Password you want to use to log on to
the TM1 server.
3. Click OK.
This chapter describes how to configure IBM® Cognos® TM1 to use SSL for secure data transmis-
sion.
TM1 Servers
not configured to use SSL
TM1 Servers
configured to use SSL
TM1-Generated Certificates
When you install TM1, all certificates and other files required to implement SSL are placed in the
<TM1_install_dir>\bin\SSL directory. The certificates contained in this directory are issued by the
Applix, Inc. certificate authority, which was created using OpenSSL. The password used was
"applix".
When you install TM1, the Admin Server, TM1 server, and TM1 client are all configured to use
SSL, relying on the certificates installed in the <TM1_install_dir>\bin\SSL directory. While the TM1
certificates allow an out-of-the-box SSL implementation, you should replace these certificates with
your own certificates (as well as a certificate revocation list) if you want to maximize security. For
TM1 Web, all root certificates must be installed in the certificate store on the machine that the
servers are using to runTM1 Web.
The <TM1_install_dir>\bin\SSL directory contains the following certificates and files. Files with a
.pem extension are Privacy Enhanced Mail format. Files with a .der extension are Distinguished
Encoding Rules.
● Applixca.pem - the public root authority certificate
● Applixca.der - the public root authority certificate in DER format used for Java™ certificate
stores
● tm1admsvrcert.pem - the Admin Server certificate containing the public/private key pair
● tm1svrcert.pem - the TM1 server certificate containing the public/private key pair
● dh512.pem - the file that contains the pre-generated Diffie-Hellman 512 bit key
● dh1024.pem - the file that contains the pre-generated Diffie-Hellman 1024 bit key
● tm1store - the Java certificate store containing the public root authority certificate
● tm1cipher.dat - the encrypted file containing the password used to access the server's private
key
Parameter Description
SSLCertAuthority The full path of the TM1 Admin Server's certificate authority file.
SSLCertificate The full path of the TM1 Admin Server's certificate file, which
contains the public/private key pair.
DHFile-512 The full path name of the file that contains a pre-generated Diffie-
Hellman 512 bit key.
The generation of Diffie-Hellman parameters can be computationally
expensive. To minimize the consumption of resources and to reduce
the amount of time required to load the TM1 server, the Diffie-
Hellman 512 bit key should be pre-generated and stored in a file
that is called when the Admin Server starts.
DHFile-1024 The full path of the file that contains a pre-generated Diffie-Hellman
1024 bit key.
The generation of Diffie-Hellman parameters can be computationally
expensive. To minimize the consumption of resources and to reduce
the amount of time required to load the TM1 server, the Diffie-
Hellman 1024 bit key should be pre-generated and stored in a file
that is called when the Admin Server starts.
SSLPrivateKeyPwdFile The full path of the file that contains the encrypted password for the
TM1 Admin Server's private key.
SSLPwdKeyFile The full path of the file that contains the key used to encrypt and
decrypt the password for the private key.
Parameter Description
SSLCertificateID Specifies the name of the principal to whom the TM1 Admin Server's
certificate is issued to.
SSLCertRevocationFile The full path of the TM1 Admin Server's certificate revocation file.
A certificate revocation file will only exist in the event a certificate
had been revoked.
SvrSSLExportKeyID Specifies the identity key used to export the Admin Server's certificate
from the Windows certificate store.
This parameter is required only if you choose to use the certificate
store.
Parameter Description
AdminSvrSSLCertID Specifies the name of the principal to whom the TM1 Admin
Server's certificate is issued.
AdminSvrSSLCertAuthority The full path of the certificate authority file that issued the TM1
Admin Server's certificate.
AdminSvrSSLCertRevList The full path of the certificate revocation file issued by the certificate
authority that originally issued the TM1 Admin Server's certificate.
A certificate revocation file will only exist in the event a certificate
had been revoked
AdminSvrSSLExportKeyID Specifies the identity key used to export the Admin Server's certific-
ate from the Windows certificate store.
SSLCertificate The full path of the certificate file that contains the public/private
key pair.
SSLCertAuthority The name of the TM1 server's certificate authority file. This file
must reside on the computer where the TM1 server is installed.
SSLCertRevocationFile The name the TM1 server's certificate revocation file. A certificate
revocation file will only exist in the event a certificate had been
revoked. This file must reside on the computer where the TM1
server is installed.
SSLCertificateID The name of the principal to whom the TM1 server's certificate is
issued.
Parameter Description
SvrSSLExportKeyID The identity key used to export the TM1 server's certificate from
the Windows certificate store.
This parameter is required only if you choose to use the certificate
store by setting ExportSvrSSLCert=T.
SSLPrivateKeyPwdFile The full path of the file that contains the encrypted password for
the private key.
SSLPwdKeyFile The full path of the file that contains the key used to encrypt and
decrypt the password for the private key.
ClientExportSSLSvrCert Specifies whether the TM1 client should retrieve the certificate
authority certificate, which was originally used to issue the TM1
server's certificate, from the Windows certificate store.
If ClientExportSSLSvrCert=T, the certificate authority certificate is
exported from the certificate store on the client computer the when
requested by the TM1 client.
Parameter Description
ClientExportSSLSvrKeyID The identity key used by the TM1 client to export the certificate
authority certificate, which was originally used to issue the TM1
server's certificate, from the Windows certificate store.
DHFile-512 The full path of the file that contains the pre-generated Diffie-
Hellman 512 bit key.
The generation of Diffie-Hellman parameters can be computation-
ally very expensive. To minimize this cost, the Diffie-Hellman 512
bit key can be pre-generated and stored in a file that is called when
the TM1 server starts.
DHFile-1024 The full path name of the file that contains the pre-generated Diffie-
Hellman 1024 bit key.
The generation of Diffie-Hellman parameters can be computation-
ally very expensive. To minimize this cost, the Diffie-Hellman 1024
bit key can be pre-generated and stored in a file that is called when
the TM1 server starts.
Certificate Authority AdminSvrSSLCertAu- The full path of the certificate authority file that
thority issued the TM1 Admin Server's certificate.
Certificate Revocation AdminSvrSSLCertRe- The full path of the certificate revocation file
List vList issued by the certificate authority that originally
issued the TM1 Admin Server's certificate. A cer-
tificate revocation file will only exist in the event
a certificate had been revoked.
Use Certificate Store ExportAdminS- Select this option if you want the certificate
vrSSLCert authority certificate which originally issued the
TM1 Admin Server's certificate to be exported
from the Windows® certificate store at runtime.
Selecting this option in the TM1 Options dialog
box is equivalent to setting ExportAdminS-
vrSSLCert=T in the Tm1p.ini file.
When this option is selected, you must also set a
value for Export Certificate ID in the TM1
Options dialog box.
Export Certificate ID AdminSvrSSLEx- The identity key used to export the certificate
portKeyID authority certificate, which originally issued the
TM1 Admin Server's certificate, from the certific-
ate store.
This parameter is required only if you choose to
use the certificate store by setting ExportAdminS-
vrSSLCert=T.
Parameter Description
AdminSvrSSLCertAuthority The full path of the certificate authority file that issued the TM1
Admin Server's certificate.
AdminSvrSSLCertID The name of the principal to whom the TM1 Admin Server's certi-
ficate is issued.
Parameter Description
AdminSvrSSLCertRevList The full path of the certificate revocation file issued by the certificate
authority that issued the TM1 Admin Server's certificate.
A certificate revocation file will only exist in the event a certificate
had been revoked.
AdminSvrSSLExportKeyID The identity key used to export the certificate authority certificate
which issued the TM1 Admin server's certificate from the Windows
certificate store.
This parameter is required only if you choose to use the certificate
store by setting ExportAdminSvrSSLCert=T.
This default entry configures TM1 Web to use SSL, relying on the TM1-generated certificates that
are included as part of your TM1 installation.
The default password for cacerts is "changeit". Java provides an executable named keytool.exe for
this very purpose. For example:
keytool -keystore ..\lib\security\cacerts -alias Company
-import -file Companyca.der
Optionally, if access is restricted to the system cacerts truststore, a truststore can be created. For
example:
keytool -keystore tm1store -alias Companyca -import -file
ACompanyca.der
When starting the Java application this keystore must be specified. If a password is required it must
be provided as well. For example:
java -Djavax.net.ssl.trustStore=bin\ssl\tm1store -Djavax.net.ssl.
trustStorePassword=Company
com.mycompany.MyApp
Further information is provided in the API specification for the Java 2 Platform Standard Edition.
The minimum Java version supported is 1.4.2.
In the above command, substitute the name of your certificate file for certificate_name.cer.
When prompted for the keystore password, enter 'applix'.
You will receive confirmation that the certificate was added to the TM1 keystore.
When connecting to the LDAP server, you must select the SSL option.
If you do not select the SSL option, the LDAP server will not be able to authenticate your user
information.
When running the ETLDAP utility from a command line, you must use the following two parameters
to enable SSL.
Parameter Description
-Djavax.net.sll.truststore Use this parameter to specify the full path to the Java™ certificate
store containing the public root authority certificate.
For example, to use the Java certificate store installed with TM1,
use the parameter -Djavax.net.sll.truststore= C:\Program Files\
Cognos\TM1\bin\ssl\tm1store
-Djavax.net.ssl.trustStore- Use this parameter to specify the password used to create the Java
Password certificate store.
For example, to specify the password used to create the Java certific-
ate store installed with TM1, use the parameter -Djavax.net.ssl.
trustStorePassword=applix
Steps
1. From the Windows Start menu, click Start, Run and enter mmc to open the Microsoft Manage-
ment Console.
3. Click Add.
The Add Standalone Snap-in dialog box opens.
7. Right-click Personal under Certificates - Current User and select All Tasks, Import.
8. Click Next.
The File to Import screen opens.
9. Click Browse and select the .pfx file that contains your certificate information.
11. Enter a password for the private key and select the Mark this key as exportable option.
14. Click Finish on the final screen of the Certificate Import Wizard.
Option Description
-pwd The password for the private key. This should be the same password you
used to encrypt your certificate in Step 11 above.
-keyfile The name of the .dat file that will be generated to contain the key used
to encrypt and decrypt the password for the private key.
If this parameter is not specified, TM1Crypt generates a file named
tm1key.dat.
-outfile The name of the .dat file that will be generated to contain the encrypted
password for the private key.
If this parameter is not specified, TM1Crypt generates a file named
tm1cipher.dat.
Option Description
-validate If you include the -validate parameter, the utility will decrypt the
encrypted password and display the results as clear text.
The displayed text should correspond to the password you specified with
the -pwd parameter.
● btprk.dat, which contains the encrypted password for the private key.
Parameter Value
SSLCertificateID The name of the principal to whom the TM1 Admin Server's certi-
ficate is issued.
You can determine this value by referring to the Microsoft Manage-
ment Console and clicking Certificates→Personal→Certificates. The
principal name displays in the Issued To column of the Properties
pane.
Parameter Value
SSLPrivateKeyPwdFile The full path to the .dat file that contains the encrypted password
for the private key.private key.
The name of this file is specified by the -outfile parameter when you
run the TM1Crypt utility.
For example, if you run the TM1Crypt utility from the following
command:
tm1crypt.exe -pwd abc123 -keyfile btkey.dat -outfile btprk.dat -
validate
the correct parameter value isSSLPrivateKeyPwdFile=C:\Program
Files\Cognos\TM1\bin\btprk.dat
SSLPwdKeyFile The full path to the .dat file that contains the key used to encrypt
and decrypt the password for the private key.
The name of this file is specified by the -keyfile parameter when you
run the TM1Crypt utility.
For example, if you run the TM1Crypt utility from the following
command:
tm1crypt.exe -pwd abc123 -keyfile btkey.dat -outfile btprk.dat -
validate
the correct parameter value isSSLPwdKeyFile=C:\Program Files\
Cognos\TM1\bin\btkey.dat
SvrSSLExportKeyID Specifies the identity key used to export the Admin Server's certificate
from the Windows certificate store.
In most cases, the value for SvrSSLExportKeyID will be identical to
the value for SSLCertificateID.
Parameter Value
AdminSvrSSLCertID Specifies the name of the principal to whom the TM1 Admin
Server's certificate is issued.
AdminSvrSSLExportKeyID Specifies the identity key used to export the Admin Server's certific-
ate from the Windows certificate store.
Parameter Value
ClientExportSSLSvrCert Specifies whether the TM1 client should retrieve the certificate
authority certificate, which was originally used to issue the TM1
server's certificate, from the Windows certificate store.
If ClientExportSSLSvrCert=T, the certificate authority certificate is
exported from the certificate store when requested by the TM1 cli-
ent.
ClientExportSSLSvrKeyID The identity key used by the TM1 client to export the certificate
authority certificate, which was originally used to issue the TM1
server's certificate, from the Windows certificate store.
ExportSvrSSLCert This parameter must be set to T to enable the TM1 server to retrieve
the certificate from the Certificate Store.
ExportSvrSSLCert=T
SSLCertificateID The name of the principal to whom the TM1 Admin Server's certi-
ficate is issued.
You can determine this value by referring to the Microsoft Manage-
ment Console and clicking Certificates→Personal→Certificates.
The principal name displays in the Issued To column of the Proper-
ties pane.
Parameter Value
SSLPrivateKeyPwdFile The full path to the .dat file that contains the encrypted password
for the private key.private key.
The name of this file is specified by the -outfile parameter when
you run the TM1Crypt utility.
For example, if you run the TM1Crypt utility from the following
command:
tm1crypt.exe -pwd abc123 -keyfile btkey.dat -outfile
btprk.dat -validate
SSLPwdKeyFile The full path to the .dat file that contains the key used to encrypt
and decrypt the password for the private key.
The name of this file is specified by the -keyfile parameter when
you run the TM1Crypt utility.
For example, if you run the TM1Crypt utility from the following
command:
tm1crypt.exe -pwd abc123 -keyfile btkey.dat -outfile btprk.dat -
validate
the correct parameter value is SSLPwdKeyFile=C:\Program Files\
Cognos\TM1\bin\btkey.dat
SvrSSLExportKeyID Specifies the identity key used to export the TM1 server's certificate
from the Windows certificate store.
In most cases, the value for SvrSSLExportKeyID will be identical
to the value for SSLCertificateID.
This chapter explains how to manage users and groups in IBM® Cognos® TM1. In TM1, security
is based on the groups users belong to.
● Administrative Groups - Includes only the predefined groups of ADMIN, DataAdmin and
SecurityAdmin. For more details, see "Understanding Administrative Groups and Authority".
● User Groups - Includes all user-created groups, which typically contain non-administrative
TM1 users.
You can use the TM1 Clients/Groups dialog box to manage TM1 users and groups. The
Clients/Groups dialog box organizes groups and users separately.
As a TM1 administrator, you must be running TM1 Architect or TM1 Perspectives on your machine
to administer security on the TM1 server.
Steps
1. Define security groups.
● Dimension-level security - Controls the ability to add, remove, and reorder the elements
in a dimension. This type of security is independent of cube-level and element-level security,
except when users have no access to a dimension.
Note: A TM1 client and server communicate directly over the network using a TM1 username
and password. This security is completely independent of standard file system security and is
not affected by user rights on network directories or file servers.
To view these groups and users, right-click the Sdata server in the Server Explorer and click Security,
Clients/Groups.
The TM1 Clients/Groups dialog box appears.
The following table contains the passwords for the sample users.
Note: Passwords are hidden in the Clients/Groups window and display as either Defined or
Undefined.
● ADMIN group - Members of the ADMIN group have access to all areas of TM1 and represent
super-users with all privileges.
● DataAdmin group - Members in the DataAdmin group have ADMIN privileges to everything
that is not related to security. This group can view, edit and save TM1 objects, such as cubes,
dimensions, rules and processes, Members in this group can view security settings in read-only
mode but are not allowed to modify security settings.
● SecurityAdmin group -The SecurityAdmin group can only perform security operations in TM1.
This includes creating, editing and deleting TM1 users and groups. This group can manage the
access rights of other users to TM1 objects, such as cubes, dimensions and rules, but this group
can not view the data in those same TM1 objects.
The security assignments for these three administrator groups are hard-coded and can not be
modified.
You can use these predefined administrator groups to control and separate TM1 administrative
roles among different users to satisfy internal or external security requirements and rules.
Note: Replication and synchronization operations in TM1 should only be performed by members
of the ADMIN group. Members of the DataAdmin and SecurityAdmin groups do not have all the
required access privileges to perform these operations.
The following sections provide details about each administrative group.
ADMIN Group
The ADMIN group, which is created for administrative purposes only, should contain only a very
small group of trusted TM1 administrators.
Members of the ADMIN group always have the highest level of security for all objects on the remote
server, and can do the following:
● Assign and revoke other user's access rights.
● Reserve and lock cubes, elements, and dimensions, so that other users cannot update them.
Joint membership in the ADMIN group and SecurityAdmin group or the ADMIN group and the
DataAdmin group is treated as ADMIN.
Members of the ADMIN group are the only TM1 users that can add users to the ADMIN group.
SecurityAdmin Group
The SecurityAdmin group can only perform security operations in TM1. Members can access the
security related features of TM1, but can not view the data in non-security TM1 objects, such as
cubes, dimensions and rules. The members in this group are allowed to create, edit and delete TM1
users and groups. Additionally, these users can manage the access rights of other users to TM1
objects such as cubes and dimensions.
If integrated login is not being used, the security administrator is also able to reset user passwords.
As a member of the SecurityAdmin group, you can manage TM1 security using the following tools
in Server Explorer:
● Clients/Groups window - Assign TM1 clients to TM1 groups.
● Security Assignments windows - Control user access to TM1 objects such as cubes, dimensions
and processes.
● Security control cubes - Manually apply security privileges for TM1 objects and user groups.
DataAdmin Group
Members in the DataAdmin group have ADMIN privileges to everything that is not related to
security. Users in this group can view, edit and save TM1 objects, including cubes, dimensions,
rules and processes. The DataAdmin group can view security settings in read-only mode, but is not
allowed to modify any security settings.
For example, as a member of the DataAdmin group, you can open the Clients/Groups window or
any of the Security Assignments windows for TM1 objects (cubes, dimensions, processes), however
these windows display in read-only mode and you can not make changes.
Adding a User
To add a user, complete the following steps.
Steps
1. Open the Server Explorer.
2. Select the icon for the server you are working with.
5. Enter the name of the new user in the Enter New Client Name box.
Note: TM1 ignores spaces in user names and passwords. For example, TM1 treats Mc Cormick
with a space and the name McCormick without a space as the same name.
6. Click OK.
TM1 adds the user as a new row in the Clients/Groups grid.
When you first add a new user, the user is granted default object security privileges according
to the following rules:
● If user groups are already defined for your server, the new user has None privilege to all
objects on the server. You must assign the user to a group to allow access to TM1 objects.
● If user groups are not defined for your server, the new user has Write privilege to all objects
on the server.
Adding a Group
A TM1 server can contain up to 65,535 groups. The GroupsCreationLimit parameter on the server's
TM1s.cfg file determines the number of groups you can create during a single TM1 server session.
Steps
1. Open the Server Explorer.
2. Select the icon for the server you are working with.
5. Enter the name of the new group in the Enter New Group Name box.
6. Click OK.
TM1 adds the group as a new column in the Clients/Groups dialog box.
Note: By default, you can add up to 20 groups per session. To increase the number of groups
you can add per session, change the value of the GroupsCreationLimit parameter in the TM1s.cfg
file.
Deleting a User
To delete a user, complete the following steps.
Steps
1. From the Server Explorer, right-click the server icon, and click Security, Clients/Groups.
2. In the Clients/Groups dialog box, click the user you want to delete.
Deleting a Group
To delete a group, complete the following steps.
Steps
1. From the Server Explorer, right-click the server icon, and click Security→Clients/Groups.
2. In the Clients/Groups dialog box, click a cell in the column that represents the group you want
to delete.
Steps
1. From the Server Explorer, right-click the server icon, and click Security, Clients/Groups.
2. In the Clients/Groups dialog box, click the check box at the intersection of the user name and
the group name.
3. Click OK.
● South America, which has Write access to the Argentina, Brazil, Chile, and Uruguay elements
in the Region dimension, and Read access to the other elements in the Region dimension.
TM1 gives Usr3Write access to the Argentina, Brazil, Canada, Chile, Mexico, United States, and
Uruguay elements, and Read access to the other elements in the Region dimension.
● Assigning Passwords
Assigning Passwords
Members of the ADMIN group have rights similar to those of super users or root users on network
systems; they can go anywhere and do anything. Give out ADMIN passwords carefully, and be
sure ADMIN users know they should not reveal or share their passwords with anyone.
● Passwords are not case sensitive. For example, the password ABC123 is equivalent to abc123.
● Spaces are allowed in passwords, but spaces are ignored by the TM1 server. The TM1 server
considers the password ABC 123 DEF to be equivalent to ABC123DEF.
Setting a Password
You can set up a password.
Steps
1. From the Server Explorer, right-click the server icon, and click Security, Clients/Groups.
2. In the Clients/Groups dialog box, click the cell at the intersection of the user name and the
Password column.
3. Type the new password for the user and press Enter.
A password can contain a maximum of 256 characters.
TM1 prompts you to retype the new password.
5. Click OK.
Clearing a Password
To clear a password, complete the following steps.
Steps
1. From the Server Explorer, right-click the server icon, and click Security, Clients/Groups.
2. In the Clients/Groups dialog box, select the cell at the intersection of the Password column and
the user name.
4. Click Yes.
TM1 clears the password, and displays a value of Undefined in the cell.
5. Click OK.
Note: When you clear a password, the user can re-establish it the next time they log in to the
TM1 server.
Changing a Password
Note: You can change your password any time you are connected to a remote server. Users who
are not administrators can do the same.
Steps
1. In the Server Explorer, select the icon for the server you are working with.
3. Type the new password in the Password box, and click OK.
TM1 prompts you to retype the new password.
Steps
1. From the Server Explorer, right-click the server icon, and click Security, Clients/Groups.
2. In the Clients/Groups dialog box, in the cell at the intersection of the user name and the
Expiration Days column, enter the number of days you want to allow the user to access the
TM1 server.
After the specified number of days, the user will not be able to log in to the server.
3. Click OK.
Note: For a complete description of the control dimensions, see Control Dimensions.
To toggle the display of control cubes and other control objects in Server Explorer, click View,
Display Control Objects. All control cubes appear in Server Explorer with a prefix of a right curly
brace ( }). For example, }CellSecurity_SalesCube.
}CellSecurity_CubeName
TM1 creates an empty }CellSecurity_CubeName control cube when you initiate the process of
defining the cell-level security. To do so, select a cube in Server Explorer, and click Security, Create
Cell Security Cube. You can use the control cube to define the cell-level security for the selected
cube. TM1 applies the cell-level security to the user groups.
The cells in a }CellSecurity_CubeName control cube can contain one of the following three strings,
which correspond to the security privileges that you can assign to the cells:
● Read
● Write
● None
For details on defining the cell-level security and for definitions of the security privileges, see the
IBM Cognos TM1 Developers Guide.
Dimensions
A }CellSecurity_CubeName cube contains all the dimensions that are present in the cube for which
you want to define the cell-level security. In addition, a }CellSecurity_CubeName cube contains the
following dimension:
Dimension Elements
For example, if you create a cell security control cube for SalesCube in the TM1 sample data, the
resulting }CellSecurity_SalesCube cube contains all the dimensions of SalesCube (actvsbud, region,
model, account1,and month), and the }Groups dimension.
}ChoreSecurity
The }ChoreSecurity control cube stores security privileges for all chores on the TM1 server. This
control cube is populated with the values applied in the TM1 Security Assignments window, which
you can access by clicking Chores, Security Assignments in Server Explorer.
You can also enter security privileges directly in the }ChoreSecurity cube.
The cells in the }ChoreSecurity cube can contain the string Read, which assigns the Read security
privilege. The cells can also be left empty, which assigns the None security privilege. The next figure
shows the }ChoreSecurity cube that corresponds with the settings in the TM1 Security Assignments
window.
For details on using the TM1 user interface to define chore security and for definitions of security
privileges, see the IBM Cognos TM1 Developers Guide.
Dimensions
The }ChoreSecurity controlcube contains the following dimensions:
Dimension Elements
}ClientSecurity
The }ClientSecurity control cube defines user group access to properties for individual clients on a
TM1 server.
For example, in the standard SData sample database that is included with the TM1 server, the
ADMIN group has ADMIN access to properties for all clients on the server. The North America
and South America groups have READ access to properties for all clients on the server.
The access privileges defined in the }ClientSecurity cube are important because several API functions
require specific privileges to read and/or set client properties. For instance, the
TM1ClientPasswordAssign function can be used only by clients who are members of a group with
ADMIN access to properties, for the client to whom a password is assigned. Similarly, the
TM1ObjectPropertyGet function requires READ access to client properties, while
TM1ObjectPropertySet requires WRITE access.
TM1 does not populate this cube through the UI, nor is access assigned when you create a new user
or new group. You must assign access privileges directly in the }ClientSecurity cube.
}CubeSecurity
The}CubeSecurity control cube stores security privileges for all cubes, including other control cubes
on the TM1 server.
This control cube is populated with the values applied in the TM1 Security Assignments window,
which you can access by clicking Cubes, Security Assignments in Server Explorer.
You can also enter security definitions directly in the }CubeSecurity cube.
The cells in the }CubeSecurity control cube can contain one of the following five strings, which
correspond to the security privileges that you can assign to cubes:
● Read
● Write
● Reserve
● Admin
● Lock
The cube does not accept the string None. To assign the None privilege to a cube, leave the
appropriate cell in the }CubeSecurity cube empty.
For details on defining cube security through the TM1 user interface and for definitions of security
privileges, see the IBM Cognos TM1 Developers Guide.
Dimensions
The }CubeSecurity control cube contains the following dimensions:
Dimension Elements
}DimensionSecurity
The}DimensionSecurity control cube stores security definitions for all dimensions, including control
dimensions on the TM1 server.
This control cube is populated with the values applied in the TM1 Security Assignments window,
which you can access by clicking Dimensions, Security Assignments in Server Explorer.
You can also enter security definitions directly in the }DimensionSecurity cube.
The cells in the }DimensionSecurity control cube can contain one of the following five strings, which
correspond to the security privileges that you can assign to dimensions:
● Read
● Write
● Reserve
● Admin
● Lock
The cube does not accept the string None. To assign the None privilege to a dimension, leave the
appropriate cell in the }DimensionSecurity cube empty.
For details on defining dimension security through the TM1 user interface and for definitions of
security privileges, see the IBM Cognos TM1 Developers Guide.
Dimensions
The }DimensionSecurity control cube contains the following dimensions:
Dimension Elements
}ElementSecurity_DimensionName
The }ElementSecurity_DimensionName control cube stores security definitions for all the elements
in the DimensionName dimension. A unique }ElementSecurity_DimensionName cube exists for
each dimension for which you have defined element security.
This control cube is populated with the values applied in the TM1 Security Assignments window,
which you can access by selecting a dimension and clicking Dimension,Security, Elements Security
Assignments in Server Explorer.
You can also enter security definitions directly in an }ElementSecurity_DimensionName cube.
The cells in this control cube can contain one of the following five strings, which correspond to the
security privileges that you can assign to dimensions:
● Read
● Write
● Reserve
● Admin
● Lock
The cube does not accept the string None. To assign the None privilege to an element, leave the
appropriate cell in the control cube empty.
For details on defining element security through the TM1 user interface and for definitions of
security privileges, see the IBM Cognos TM1 Developers Guide.
Dimensions
An }ElementSecurity_DimensionName cube contains the following dimensions:
Dimension Elements
}ProcessSecurity
The }ProcessSecurity control cube stores security definitions for all TurboIntegrator processes on
the TM1 server.
Dimensions
The }ProcessSecurity cube contains the following dimensions:
Dimension Elements
}ClientsGroups
The }ClientsGroups cube stores group assignments for all clients on a TM1 server. This control
cube is populated with values that reflect the assignments applied in the Clients/Groups window,
which you can access by clicking Server, Security, Clients/Groups in Server Explorer. You can also
enter values directly in the }ClientsGroups cube.
For details on assigning clients to user groups, see the IBM Cognos TM1 Developers Guide.
The cells in the }ClientsGroups cube contain strings that assign clients to one or more of the user
groups available on the TM1 server. For example, the following figure shows the group assignments
for the clients that are part of the sample data that ships with TM1.
In this example:
● Admin client is assigned to the ADMIN group
● Usr3 client is assigned to both the North America and South America groups
Dimensions
The }ClientsGroups control cube contains the following dimensions:
Dimension Elements
}ClientProperties
The}ClientProperties control cube stores property values for all clients on the TM1 server. You can
use client properties to define a client password, the maximum number of connections allowed,
client status, and more.
The }ClientProperties cube is populated with values that reflect the settings in the Clients/Groups
window, which you can access by clicking Server, Security, Clients/Groups from Server Explorer.
A MaximumPorts value of 0 for a client in the }ClientProperties cube indicates that a maximum
port limit is not defined for the client. When a maximum port limit is not defined, TM1 uses a
default value equivalent to the number of users for which your TM1 server is licensed. For example,
if your TM1 server is licensed for 50 users, the default maximum port limit for a client is 50.
You can enter or edit values for MaximumPorts and PasswordExpirationDays directly in the }Cli-
entProperties cube.
Note: You should not edit values for PASSWORD directly in the cube. The passwords are stored
in the cube in an encrypted format; if you edit passwords directly in the cube, the passwords are
unusable and prevent clients from logging on to the TM1 server.
Dimensions
The }ClientProperties cube contains the following dimensions:
Dimension Elements
}ClientProperties Properties that can be set for TM1 clients, including Password, Pass-
wordExpirationDays, and MaximumPorts.
For complete details on this dimension, see Control Dimensions.
● }CubeProperties
● }DimensionProperties
● }DimensionAttributes
● }ElementAttributes_DimensionName
}ConnectionProperties
The }ConnectionProperties control cube stores property values for all replication connections on
the TM1 server. The replication connection properties define the client and password to establish
a replication connection, and the synchronization status for the star and planet servers.
Dimensions
The }ConnectionProperties cube contains the following dimensions:
Dimension Elements
}CubeProperties
The }CubeProperties control cube stores property values for all cubes, both native and replicated,
on the TM1 server. This control cube is populated with values that reflect the settings in the Cube
Properties dialog box, which you can access by selecting a cube and clicking Cube, Properties in
Server Explorer.
With replicated cubes, the }CubeProperties cube is populated with values that reflect the settings
in the Replicate Cube dialog box, which you can access by selecting a cube under a replication
connection and clicking Cube, Replicate from Server Explorer.
The }CubeProperties control cube also stores several properties that can only be set directly in the
control cube, such as VMM and VMT.
The cube properties define how a cube is loaded on the TM1 server, which dimension to use as a
measures dimension, which dimension to use as a time dimension, and whether cube logging is
enabled. With replicated cubes, the values in the }CubeProperties cube also define the source cube
for a replication, the replication status of a cube, and whether rules and views should be synchron-
ized.
Dimensions
The }CubeProperties cube contains the following dimensions:
Dimension Elements
}DimensionProperties
The }DimensionProperties control cube stores property values for all dimensions, both native and
replicated, on the TM1 server. This control cube is populated with values that reflect the settings
in the DimensionElementOrdering dialog box, which you can access by selecting a dimension and
clicking Dimension, Set Elements Order from Server Explorer.
With replicated cubes, the }DimensionProperties cube is also populated with values that reflect the
settings in the Replicate Cube dialog box, which you can access by selecting a cube under a replic-
ation connection and clicking Cube, Replicate in Server Explorer.
The dimension properties define how a dimension is loaded and sorted on the TM1 server. With
replicated dimensions, the values in the }DimensionProperties cube also define the source dimension
for a replicated dimension, the replication status of a dimension, and whether subsets and attributes
should be synchronized.
Dimensions
The }DimensionProperties cube contains the following dimensions:
Dimension Elements
Dimension Elements
}DimensionAttributes
The }DimensionAttributes control cube stores attribute values for all dimensions, both native and
replicated, on the TM1 server.
This control cube cube is populated with values that reflect the settings in the Attributes Editor
window, which you can access by selecting a Dimensions group and clicking Dimensions, Edit
Attributes from Server Explorer. You can also enter attribute values directly in the }DimensionAt-
tributes cube.
Dimensions
The }DimensionAttributes cube contains the following dimensions:
Dimension Elements
}DimensionAttributes Attributes that have been defined for dimensions on the TM1
server.
}ElementAttributes_DimensionName
The }ElementAttributes_DimensionName control cube stores element attribute values for the
DimensionName dimension. A unique }ElementAttributes_DimensionName cube exists for each
dimension for which you have defined element attributes.
An }ElementAttributes_DimensionName cube is populated with values that reflect the settings in
the Attributes Editor window, which you can access by selecting a dimension and clicking Dimension,
Edit Element Attributes in Server Explorer. You can also enter element attribute values directly in
an }ElementAttributes_DimensionName cube.
Dimensions
An }ElementAttributes_DimensionName cube contains the following dimensions:
Dimension Elements
Dimension Elements
}StatsByClient
For each client on the server, the }StatsByClient control cube tracks the message count, average
message size, total elapsed time, and other measures.
Dimensions
The }StatsByClient cube contains the following dimensions:
Dimension Elements
}PerfClients Each client on the server, plus the consolidated element Clients Total,
which is a consolidation of all clients.
}StatsByCube
For each cube on the server, the}StatsByCube control cube tracks memory use, the number of
populated string cells, populated numeric cells, stored calculated cells, fed cells, and stored views.
Dimensions
The }StatsByCube cube contains the following dimensions:
Dimension Elements
}PerfCubes This dimension contains numeric elements for each cube on the
server, plus the consolidated element Cubes Total, which is a
consolidation of all clients.
}StatsByCubeByClient
For each client and cube on the server, the }StatsByCubeByClient control cube tracks the number
and elapsed time of cell updates, cell retrievals, view calculations, and view retrievals.
Dimensions
The }StatsByCubeByClient cube contains the following dimensions:
Dimension Elements
}PerfClients Each client on the server, plus the consolidated element Clients
Total, which is a consolidation of all clients.
}PerfCubes Each cube on the server, plus the consolidated element Cubes
Total, which is a consolidation of all cubes.
Dimension Elements
}StatsForServer
The }StatsForServer control cube tracks the connected clients, active threads, and memory used for
the server.
Dimensions
The }StatsForServer cube contains the following dimensions:
Dimension Elements
}Hold_UserName_CubeName
The }Hold_UserName_CubeName control cube tracks the cells held by the UserName client on the
CubeName cube.
Dimensions
The }Hold_UserName_CubeName cube contains the following dimensions:
Dimension Elements
The }Hold_UserName_CubeName cube also contains all of the dimensions present in the CubeName
cube. For example, the }Hold_Admin_Sales cube contains the }Hold dimension as well as all the
dimensions present in the Sales cube.
This appendix describes the control dimensions that TM1 uses to track performance statistics,
administer security, manage clients and groups, and store object attributes and properties.
The following information is provided for each dimension:
● Description of dimension elements
}Chores
The }Chores dimension is used only in the }ChoreSecurity control cube. The dimension contains
string elements corresponding to the names of the chores defined on the TM1 server.
}ClientProperties
This }ClientProperties dimension is used only in the }ClientProperties control cube. The dimension
contains the following string elements that corresponds to the following properties that can be
defined for clients on the TM1 server.
Element Description
PasswordExpira- Indicates the number of days for which a given client's password remains
tionDays valid.
PasswordLastTimeUp- Indicates the last time (GMT) the password for a given client was
dated updated. The time format is yyyymmddhhss .
STATUS When a client is logged on to the TM1 server, the STATUS value is
ACTIVE. Otherwise the STATUS value is empty.
}Clients
The }Clients dimension contains string elements that correspond to the clients defined on the TM1
server. This dimension is used in the }ClientGroups and }ClientProperties control cube.
}ConnectionProperties
The }ConnectionProperties dimension is used only in the }ConnectionProperties control cube. This
dimension contains the following string elements that correspond to the properties that can be
defined for replication connections on the TM1 server.
Element Description
LASTSYNC Time (GMT) at which the data was last synchronized on the planet
server, from which the replication connection was established. The
time format is yyyymmddhhss.
LASTSYNCSTAR Time (GMT) at which the data was last synchronized on the star server
for the replication connection. The time format is yyyymmddhhss.
PASSWORD Stores and displays the password in an encrypted format for establishing
a replication connection.
SYNCPLANET Determines if the data on the planet server is updated during the syn-
chronization process.
SYNCSTAR Determines if the data on the star server is updated during the synchron-
ization process.
USER For a given replication connection, stores the name of the user who
established the connection.
}Connections
The }Connections dimension contains string elements that correspond to the replication connections
defined on the TM1 server. This dimension is used only in the }ConnectionProperties control cube.
}CubeFunctions
The }CubeFunctions dimension is used only in the }StatsByCubeByClient control cube. The
dimension contains the following string elements corresponding to functions that can be performed
on a cube:
Element Description
Cell Retrieval Cells retrieved by a user in a non-stored view. This metric includes
calculated cells, such as rules, consolidations, and user-defined calcula-
tions.
Element Description
Cell Update Cell updates include user input through the Cube Viewer, In-Spread-
sheet Browser, TM1 Web, and slices.
Cells updated through rule calculations or other methods are not
included in this metric.
View Calculation Number of views requested, which can be user requests for Cube Viewer
or slices.
}CubeProperties
The }CubeProperties dimension is used only in the }CubeProperties control cube. The dimension
contains the following string elements corresponding to the properties that can be defined for cubes
on the TM1 server.
Element Description
Lock When a cube is locked, this property stores the name of the TM1 client
that has locked the cube.
Logging Indicates if logging is enabled for a given cube. When cube logging is
enabled, the value of this property is YES, otherwise the value is NO.
Measures_Dimension If a measures dimension has been defined for a given cube, this property
stores the name of the dimension.
Replication For replicated cubes, this property stores the name of the replication
connection with which the replicated cube is associated.
RepSrcName For replicated cubes, this property stores the name of the source cube.
SyncRule For replicated cubes, this property indicates whether rules are synchron-
ized when the associated cube is synchronized.
Element Description
SyncViews For replicated cubes, this property indicates whether views are synchron-
ized when the associated cube is synchronized.
Time_Dimension If a time dimension has been defined for a given cube, this property
stores the name of the dimension.
VMM For each cube, this property determines the amount of RAM reserved
on the server for the storage of stargate views. The more memory made
available for stargate views, the better performance will be. You must,
however, make sure sufficient memory is available for the TM1 server
to load all cubes.
If no VMM value is specified the default value is 65,536 bytes. The valid
range is 16,384 - 4,2934,943,296 bytes.
VMT For each cube, this property defines the time threshold, in seconds,
beyond which the algorithm that stores TM1 stargate views is triggered.
If the time required to calculate a cube view surpasses the specified
threshold, TM1 attempts to store a stargate view. If there is not enough
memory available to store the stargate view, TM1 purges the oldest
stargate view that is not currently in use, and continues to purge views
in this manner until sufficient memory is made available.
If no VMM value is specified the default value is five seconds. The valid
range is 1 - 259,200 seconds.
For details on stargate views, see "About Stargate Views" (p. 68).
}Cubes
The }Cubes dimension contains string elements corresponding to the cubes, including control cubes,
on the TM1 server. The }Cubes dimension is used only in the }DimensionAttributes control cube.
}DimensionAttributes
The }DimensionAttributes dimension contains numeric elements that correspond to the attributes
defined for dimensions on the TM1 server. The }DimensionAttributes dimension is used in the
}CubeSecurity and }CubeProperties control cube.
}DimensionProperties
The }DimensionProperties dimension is used only in the }DimensionProperties control cube. The
}DimensionProperties dimension contains the following string elements that correspond to the
properties that can be defined for dimensions on the TM1 server.
Element Description
Last_Time_Updated Time (GMT) at which a dimension was last updated. The time format
is yyyymmddhhss.
Lock When a dimension is locked, this property stores the name of the TM1
client that has locked the dimension.
Replication For replicated cubes, this property stores the name of the replication
connection with which the replicated cube is associated.
RepSrcName For replicated dimensions, this property stores the name of the source
dimension.
SortElementsSense When dimension elements are sorted automatically, this property stores
the sense applied to the selected sorting. Elements can be sorted in
either the Ascending or Descending sense.
SortElementsType When dimension elements are sorted automatically, this property stores
the type of sorting used. There are three types of automatic element
sorting: ByName, ByLevel, and ByHierarchy.
SyncAttributes For replicated cubes, this property indicates whether element attributes
are synchronized when the associated dimension is synchronized.
SyncSubsets For replicated cubes, this property indicates whether subsets are syn-
chronized when the associated dimension is synchronized.
}Dimensions
The }Dimensions dimension contains string elements the correspond to the dimensions, including
control dimensions, on the TM1 server. The }Dimensions dimension is used only in the }Dimension-
sProperties control cube.
}ElementAttributes_DimensionName
The}ElementAttributes_DimensionName dimension contains numeric elements that correspond to
the element attributes defined for the DimensionName dimension. The }ElementAttributes_
DimensionName dimension is used only in the }ElementAttributes_DimensionName control cube.
}Groups
The }Groups dimension contains string elements that correspond to the user groups defined on the
TM1 server. The }Groups dimension is used only in the }ClientGroups control cube.
}Hold
The }Hold dimension is used in any }Hold_UserName_CubeName cubes. UserName is the name
of the TM1 user who has applied holds against cube values, while CubeName is the name of the
cube in which values are being held.
The }Hold dimension contains the following elements:
Element Description
OriginalVal This numeric element tracks the most recent value of leaf cells that
are edited in the CubeName cube. These most recent values are
used for several data spreading methods and should not be edited.
HoldStatus This string element identifies cells held by UserName in the Cube-
Name cube.
A value of H indicates that UserName has applied a leaf hold to a
cell. A value of C indicates that UserName has applied a consolida-
tion hold against a cell.
}PerfClients
The }PerfClients dimension contains numeric elements that correspond to the clients defined on the
TM1 server as well as a consolidation of all clients named Clients Total. The }PerfClients dimension
is used in the following performance monitoring cubes:
● }StatsbyClient
● }StatsByCube
● }StatsByCubeByClient
The }PerfClients dimension differs from the }Clients dimension in that the }PerfClients dimension
contains numeric elements, while the }Clients dimension contains string elements.
}PerfCubes
The }PerfCubes dimension contains numeric elements that correspond to the cubes on the TM1
server and a consolidation of all cubes named Cubes Total. The }PerfCubes dimension is used in
the }StatsByCube and }StatsByCubeByClient performance monitoring cubes.
The }PerfCubes dimension differs from the }Cubes dimension in that the }PerfCubes dimension
contains numeric elements, while the }Cubes dimension contains string elements.
}Processes
The }Processes dimension contains string elements that correspond to the TurboIntegrator processes
defined on the TM1 server. The }Processes dimension is used only in the }ProcessSecurity control
cube.
}StatsStatsByClient
The }StatsStatsByClient dimension is used in the }StatsByClient control cube. This dimension contains
the following measures:
Element Description
Bytes/Message Average number of bytes per message. The value for this element
is calculated by the statement ['Bytes/Message']=['Message
Bytes']/['Message Count'] in the rule for the }StatsByClient cube.
Elapse Time (ms) Time (in milliseconds) required to process requests to the TM1
Server.
Message Bytes Number of bytes that have been sent across in the requests.
Message Count A message is a request to the TM1 server for a list of objects, such
as a list of dimensions,
Request Count Measures the number of requests for information from the TM1
server.
}StatsStatsByCube
The }StatsStatsByCube dimension is used only in the }StatsByCube control cube. This dimension
tracks performance statistics when performance monitoring is enabled, and contains the following
elements:
Element Description
Memory Used for Calcula- This metric measures the memory used in all TM1 calculations,
tions including consolidations, rules, and user-defined calculations.
Memory Used for Feeders This metric measures the amount of memory used to feed cells
through TM1 rules.
Memory Used for Input Data This includes memory allocated to data loaded through TurboIn-
tegrator or process worksheets. This measures the memory used
for all data input other than slice or Cube Viewer input.
Memory Used for Views This metric measured the amount of memory, in bytes, used to
store views for a given cube on the TM1 server.
Number of Fed Cells This is the number of cells in the cube targeted by feeders.
Number of Populated This metric counts all the populated string cells in a given cube.
Numeric Cells String cells are cells identified by at least one string element.
Number of Populated String This metric counts all the populated string cells in a given cube.
Cells String cells are cells identified by at least one string element.
Number of Stored Calculated This metric counts all stored calculated cells including rules,
Cells dimensional consolidations, and user-defined consolidations.
Number of Stored Views This metric measures the number of named views of a given cube.
Total Memory Used The total amount of memory used by a cube, measured in bytes.
}StatsStatsByCubeByClient
The }StatsStatsByCubeByClient dimension is used only in the }StatsByCubeByClient control cube.
The dimension contains the following elements:
Element Description
Count For a given cube function, this metric measures the number of
functions executed.
Elapsed Time (ms) For a given type of cube function, this metric measures the elapsed
time required to execute all functions.
}StatsStatsForServer
The}StatsStatsForServer dimension is used only in the }StatsForServer control cube. The dimension
tracks performance statistics when performance monitoring is enabled, and contains the following
elements:
Element Description
Memory In Garbage TM1 does not release memory back to the operating system while
the TM1 server is running. Instead, the server retains unused memory
in 'garbage' for later use. Memory that has been allocated to the
server but is not in use is represented by this metric.
Memory Used The total amount of memory used by the server, in bytes.
Number of Active Threads This measures the number of threads active on the TM1 server. Each
client connection constitutes a thread. Threads are also used to
execute chores and processes.
Number of Connected Cli- This statistic measures the number of active connections to the TM1
ents server. An individual client can have multiple connections to the
TM1 server active simultaneously. Each connection is counted in
this metric.
}TimeIntervals
All performance monitoring control cubes use the }Time Intervals control dimension. This dimension
contains 168 numeric elements for time intervals at the minute and hour level, as follows.
● 120 elements corresponding to the minutes of the current and the prior hour. Elements in the
current hour are named 0M00, 0M01, ... 0M59. Elements in the prior hour are named 1M00,
1M01, ... 1M59.
Sampling for the performance monitoring cubes is done every minute. New values are stored in
consecutive minutes of the current hour. When the hour is complete, the values of the current hour
are copied to the prior hour, and the current hour is cleared to accept new values.
● 48 elements corresponding to the hours of the current and the prior day. Elements in the current
day are named 0H00, 0H01, ... 0H23. Elements for the previous day are named 1H00, ...
1H01, 1H23. Every hour, a new summary (average) value from the minutes is posted in the
corresponding hourly element. When the day is over, the current day's data replaces that of
the prior day and the current day is cleared to accept new data.
Hours and minutes in this dimension reflect the system clock time when you started the performance
monitor. For example, if you start the performance monitor at 10:31 AM local system time, the
first }TimeIntervals element to receive a value is 0M31, whichis the 31st minute of the current hour.
The next element to receive a value would be 0M32.
When running the TM1 64-bit server on HP UX 11i, large cubes can cause the operating system
to run out of memory when default kernel parameter values are used. To resolve this issue, We
recommend editing several kernel parameters that govern memory management.
This appendix lists the parameters that should be edited and suggests parameter values. The proced-
ure described in this document is specific for editing the parameters required to optimize the per-
formance of TM1.
For complete details on kernel parameters, refer to the HP UX 11i man pages or review the online
documentation available at http://docs.hp.com.
Note: Improper kernel settings can render a system unbootable. Do not edit kernel parameter values
unless you understand the impact of such edits.You must reboot the system after applying edits to
kernel parameter values.
Steps
1. Log on to the HP UX 11i machine as root.
8. Click OK.
13. Select Move Kernel into Place and Shutdown/Reboot System Now.
maxdsiz_64bit
This parameter sets the maximum size (in bytes) of the data segment for any user process.
Recommended Value
We recommend setting this kernel parameter value to 0x400000000 (hex).
maxssiz_64bit
This parameter sets the maximum size (in bytes) of the stack for any user process.
Recommended Value
We recommend setting this kernel parameter value to 0x10000000 (hex).
max_thread_proc
This parameter sets the maximum number of threads allowed per process.
Recommended Value
We recommend setting this kernel parameter value to 0x200 (hex).
Note: This parameter value must be equal to or less than the value of nkthread, which limits the
total number of threads allowed to run simultaneously.
This appendix describes the Microsoft® Excel events that are handled by the TM1 add-in for TM1
Perspectives.
List of Events
WorkbookActivate This event is handled to correctly set the status of TM1 toolbars &
menu bars.
WorkbookAddinUninstall This event is handled to remove TM1 toolbars & menubars from
a workbook.
SheetActivate This event is handled to update the TM1 toolbar and menu bar
states, as well as to update sheet-specific variables.
SheetSelectionChange This event is handled to update TM1 menus & toolbar states
SheetChange This event is handled to update the TM1 database with the changes
made to a particular cell.
SheetBeforeRightClick This event is handled to add and modify excel context menu.
Licensed Materials – Property of IBM
© Copyright IBM Corp. 2007, 2009. 261
Appendix D: Excel Events Handled by TM1
access control
In computer security, the process of ensuring that users can access only those resources of a computer
system for which they are authorized.
admin console
In TM1 Workflow, a graphical interface that guides the Workflow Administrator through system
administration tasks.
admin group
In TM1, the access group that has completely open privileges to modify, create, and delete data.
alert
A notification message or email.
alias
An alternative name used instead of a primary name.
authentication
The process of validating the identity of a user or server.
cell security
The access control level assigned to the intersection of a row and column of data in a database or
spreadsheet.
child
A node that is subordinate to another node in a tree structure.
chore
In TM1, an object that executes one or more processes for importing data at a user-defined frequency.
client
A software program or computer that requests services from a server. Client can also refer to the
user, such as Admin, who initiates the request.
cube
A multidimensional representation of data used for online analytical processing and multidimensional
reporting.
data source
In TM1, the file or data used as the source for the TurboIntegrator import process.
Licensed Materials – Property of IBM
© Copyright IBM Corp. 2007, 2009. 263
Glossary
dimension
In multidimensional data, a structural attribute of a cube that organizes data at the highest consol-
idation level.
drill down
To access information by starting with a general category and moving through the hierarchy of
information.
drill-through
In TM1, the ability to see detail or context information about a cell’s contents.
element
In TM1, an element is a structural attribute of a dimension that organizes data one level below the
dimension.
feeder statements
In TM1, lines of code which cause placeholder values to be stored in rules-calculated cells so that
the cells are not skipped during consolidations.
filter
A device or program that separates data, signals, or material in accordance with specified criteria.
group
In TM1, an organizational structure of clients or users with the same access level.
Integrated Login
Using the Windows logon information as authentication for access to TM1 so that once the user
has logged into Windows, no additional login is required to log into TM1. Not available on a
UNIX® server.
LDAP
Lightweight Directory Access Protocol--an authentication standard used to manage access for dir-
ectories of users and passwords.
LDAP
Lightweight Directory Access Protocol--an authentication standard used to manage access for dir-
ectories of users and passwords.
LDAP authentication
Process used to authenticate users and passwords against an external LDAP directory on an LDAP
server, such as Active Directory.
leaf
In a data tree, an entry or node that has no children.
MDX
A query language for OLAP databases. It is also a calculation language, with syntax similar to
spreadsheet formulas.
metadata
Data that describes the characteristics of data; descriptive data.
navigation
In TM1 Workflow, the process of identifying objects or cells needed by the Workflow process.
object security
The ability to assign access levels to objects used by TM1.
OLAP
Online Analytical Processing; the process of collecting data from one or many sources; transforming
and analyzing the consolidated data quickly and interactively; and examining the results across
different dimensions of the data by looking for patterns, trends, and exceptions within complex
relationships of that data.
process
A progressively continuing procedure consisting of a series of controlled activities that are system-
atically directed toward a particular result or end.
process security
In TM1, controlling which user groups can perform a process.
read-only user
In TM1, a level of access assigned to a usergroup that can read but cannot modify data in a TM1
database.
rules
In TM1, a set of commands and tools used to create specific calculations and optimizations within
cubes.
rules tracer
The utility used to develop and debug TM1 rules.
scenario
In TM1, a dimension that stores budget data.
service
In TM1, a software program that runs in the background and manages requests to and from TM1
data, other machines, or other programs. To access a TM1 database, you "run" the appropriate
service, such as TM1 Admin, TM1 Excel, or a specific database such as Planning Sample.
sibling
One of several nodes within the scope of another node.
slice
In TM1, a snapshot of a database view.
spreading
In TM1, the distribution of values across a number range using a specific algorithm, such as percent
or increments.
subset
A set of elements from within another set.
task
In TM1 Workflow, a structured process defined by a Workflow administrator to review or modify
TM1 data.
TM1 object
In TM1, constructs such as TM1 databases, cubes, dimensions, elements, cells, chores, processes,
spreadsheets, views, or text files on a TM1 server that in object-oriented programming are defined
as instances of a class.
TurboIntegrator
In TM1, the software tool used to automate importing data into TM1.
version
In TM1 Workflow, a dimension that stores budget data.
websheet
In TM1, an Excel worksheet that is accessed via TM1 Web.
webskin
The visual attributes of the user interface used in a Web-based software program.
Workflow
In TM1, a software add-on used to manage structured processes, such as budget approval tasks,
using TM1 objects and data.
zero suppression
The substitution of blanks for leading zeros in a number. For example, 00057 becomes 57 with
zero suppression.
naming, 77 privilege
rules, 77, 78 read access, 72, 79
specify information, 77 write access, 79
synchronization, 79, 80 process
attributes, 128
N parameters, 128
navigation tree Process
administration node, 143 administration node, 127
views node, 143 process, properties, 128
non-SSL clients, 210 properties
cube, 131
O dimension, 132
object security, 168
operating system, 121 Q
out-of-process server, 69 quotation marks, 24
override dimension defaults, 78
overview, TM1, 119 R
read access privilege, 72, 79
P remote server, 23
parameters, SSL, 210 Admin host, 18
parameters, web.config, 138 and replication, 70
passport, 201 application, 54
passwords, 210 connecting, 58
assigning, 232 data directory, 20
change, 132 diagram, 53
for the ADMIN ID, 58 disconnecting, 59
passwords, admin group, 232 memory management, 67
passwords, change, 233 operations, 53
passwords, clearing, 233 refreshing servers, 58
passwords, setting, 232 replication, 70
PasswordSource, 195 source server, 70, 76
path data directory, 20 starting, 56
pdata, 20 target server, 70, 76
performance counters, 113 Windows service, 56
performance monitoring, 65, 102 removing log files, 65, 88
}StatsByClient, 245 rename a dimension, 78
}StatsByCube, 245 replicate
}StatsForServer, 247 a cube, 70, 76
control cubes, 102, 245 a dimension, 77, 78
permissions Admin Host considerations, 73
anonymous access, 152 advantages, 69
setting, 152 connection, 70, 74
Web folders, 153 dimension name, 77
Perspectives, 15, 20 mirror cube name, 77
Planning Manager toolbar, 142 outcome, 79
private key, 210 overview, 69
synchronization UNIX, 57
automatic, 80 UNIX, shutting down, 60
on-demand, 69, 80 UNIX, shutting down background mode, 60
overview, 70, 79 UNIX background mode, 58
required access privileges, 79 Windows shutting down, 59
system configuration, 15 tm1srvstop.exe, 55, 60
Tm1top.ini, 104
T TM1 Top utility
target server, 70, 76 canceling threads, 112
The ETLDAP Utility, 171 command prompt, 111
Thread ID, 95 configuring, 104
timeout, 144 installing, 103
TimeZone, 93 lock modes, 109
TM1 overview, 103
.cfg file, 15, 18, 20 parameters, 104
.ini file, 20, 58 SSL, 216
architecture, 15 thread processing states, 110
Client, 15 TM1 Web log, 156
log file, 63, 85 toolbars
new audit log, 161 Chore Administration, 129
securing data, 231 Planning Manager, 142
transaction log file, 53, 61, 84 toolbars, custom, 142
users and groups security overview, 225 top utility, 103
Web client, 15 transaction log, 61, 63, 64, 84, 86, 87
TM1, Client, 20 query result, 86
TM1, Top utility, 103 transaction log parameters, 86
Tm1admsrv.exe, 17 Cubes, 86
tm1admsrv-log.properties sample, 83 Starting Time, 86
TM1ExcelServicePortNumber Parameter, 146 transaction log parameters, Clients, 86
TM1 Excel Services log, 159
TM1 Logger Name, 95 U
tm1p.ini UNIX, 57
location, 43 UNIX¬
parameters, 43 server, 23
Tm1p.ini file, 20, 43, 58 user
TM1 PerfMon, 113, 114 adding, 229
tm1s_start_example, 57 user and group security, 225
Tm1s.cfg file, 15, 18, 20, 23 UseSSL, 212
location, 23
parameters, 24 V
sample, 23 value, 115
Tm1s.log verify TM1 Top, 111
properties, 91 view, Stargate, 68
removing old log files, 65, 88
TM1 server W
remote, 58 WARN logging system message severity, 90
Web
browser, 121
server, 121
TM1, 15
Web, setting folder security, 153
web.config
defined, 138
editing, 139
Windows
service, 17
service account, 121
Windows service, 56
W-lock, 109
write access privilege, 79