Cognos TM1 Web Configuration Parameters

The configuration parameters for IBM® Cognos® TM1® Web are stored in the tm1web_config.xml file.

The tm1web_config.xml file is located in the following location:

<TM1 install location>\webapps\tm1web\WEB-INF\configuration\

The following parameters are available.

AdminHostName
If set, users will not be asked to enter a value for Admin Host during login.

See Configuring the Cognos TM1 Web Login Page using AdminHostName and TM1ServerName parameters.

AdminHostPort
If set, the client will try to use this port instead of the default Admin Host port.
AdminHostSSLPort
If set, the client will try to use this port instead of the default Admin SSL Host port.
CrossDomainAccessList

Specifies the domain name where TM1 iWidgets are running. For example, add the name of the domain where IBM Cognos Workspace is running.

Use an asterisk (*) to allow Cognos TM1 Web and Cognos Workspace to access each other across different domains.

If you specify multiple URLs, separate each one using a comma.

CubeViewerColumnPageSize
Specifies the number of columns to fetch in a page of cubeviewer.

See Changing the Cube Viewer Page Size.

CubeViewerRowPageSize
Specifies the number of rows to fetch in a page of cubeviewer.

See Changing the Cube Viewer Page Size.

CubeviewerStringWrap
Settings for string cell wrapping in the cubeviewer.

See Wrapping string values in cube views.

CustomCAMLogoutUrl

Specifies the URL of a dedicated Logout page for CA SiteMinder when TM1 is configured to use CAM security (mode 4 or 5). This Logout page must be accessed on logout so that the SiteMinder session cookie can be invalidated.

When a user clicks Logoff in TM1 Web, the CAM logout occurs first. Then the SiteMinder Logout page is called.

GzipCompressionEnabled
Determines if the web server responses will be compressed. Valid values are true/false.
HideCubeviewerToolBar
If set to true, all Cubeviewer toolbars will not be displayed.

See HideCubeviewerToolBar Parameter.

HideTabBar
If set to true, multiple tabs will not be displayed.

See HideTabBar Parameter.

HideWebsheetToolBar
If set to true, all websheet toolbars will not be displayed.

See HideWebsheetToolBar Parameter.

HomePageObject
If set, the object of type of Websheet, Cubeviewer or URL will be displayed after a user logs in.

See Configuring a Global Homepage for All Users.

IntegratedSecurityModuleName
Specifies the name of the login module in the file pointed to by the java.security login configuration file.
MaximumSheetsForExport
Maximum number of sheets allowed to Export.

See Setting the Maximum Number of Sheets to Export from a Cube Viewer.

NavTreeCollapsedOnStart
Determines if the navigation panel will be collapsed or expanded after a user logs in.

See NavTreeCollapsedOnStart Parameter.

NavTreeDisplayServerView
Specifies whether to display the Server View node in the navigation tree. Valid values are Y and N.

See Displaying or Hiding the Views Node in the Navigation Pane.

NavTreeHidden
Determines if the navigation panel will be displayed after a user logs in.

See NavTreeHidden Parameter.

RecalcOnDataValidationChange

Specifies whether the default recalculation behavior will be overridden when changing the value of a data validation list.

If set to true, a recalculation will be triggered when a value in a data validation list is changed.

If set to false, a recalculation will not be triggered when a value in a data validation list is changed.

RecalcOnPicklistChange

Specifies whether the default recalculation behavior will be overridden when changing the value of a picklist.

If set to true, a recalculation will be triggered when a value in a picklist is changed.

If set to false, a recalculation will not be triggered when a value in a picklist is changed.

TM1ServerName
If set, users will not be asked to select a TM1 Server to connect to during login.

See Configuring the Cognos TM1 Web Login Page using AdminHostName and TM1ServerName parameters.

UseBookRecalcSetting

The UseBookRecalcSetting parameter is included in the tm1web_config.xml file. When set to true, the web server honors the mode in which the Excel sheet was published. If the Excel sheet was published in Manual recalc mode, websheet data is not re-sent to the client until a recalculation is performed.

The UseBookRecalcSetting parameter uses the following format in the tm1web_config.xml file: 

<add key="UseBookRecalcSetting" value="false" />

where value is either "false" or "true"

If you set UseBookRecalcSetting to true, TM1 Web will honor the recalculation settings in the Excel worksheet.

When Calculation Options is set to Automatic:

  • if you set UseBookRecalcSetting = "true", the websheet is recalculated automatically when you change the SUBNM function.
  • if you set UseBookRecalcSetting = "false", the websheet is recalculated automatically when you change the SUBNM function.

When Calculation Options is set to Manual:

  • if you set UseBookRecalcSetting = "true", the websheet is not recalculated automatically. To recalculate, you must manually click the recalc button.
  • if you set UseBookRecalcSetting = "false", the websheet is recalculated automatically when you change the SUBNM function.
WebsheetBackgroundRecalculationMode

Specifies the level of background recalculation that occurs for a websheet.

WebSheetService.scrollWebSheet calls can take several seconds because the data is not readily available. Use the WebsheetBackgroundRecalculationMode parameter to recalculate the book in the background so that the necessary data is ready when it is requested.

If set to 0 (default value), only the buffered (visible) area is calculated on a refresh of a sheet.

If set to 1, the area adjacent to the buffered area is calculated, in addition to the buffered area. This improves wait times if the user scrolls slightly away from the initially visible area.

If set to 2, the entire current worksheet is calculated. This improves wait times if the user scrolls to any area of the current sheet.

If set to 3, the entire current workbook is calculated. This improves wait times if the user moves to any area of the current worksheet or to another worksheet.

Note: The higher the setting number, the more cells are calculated meaning that there would be a higher load on the web server.
Parent topic: Modifying Cognos TM1 Web Configuration Parameters