New Admin Server configuration file

In Planning Analytics 2.1.7 and earlier, TM1 Admin Server configuration was performed in Cognos Configuration.

In Planning Analytics 2.1.8 and later, TM1 Admin Server configuration is managed in a .json file named config.tm1admsrv.json, located in the <install_dir>/bin64 directory. The config.tm1admsrv.json file contains all of the same default settings as Cognos Configuration from previous releases.

Configuration of the TM1 Server database remains in the tm1s.cfg file.

config.tm1admsrv.json parameters

The config.tm1admsrv.json files includes the following parameters that you can set to configure your TM1 Admin Server.

Table 1. Admin Server configuration parameters
Parameter Description
tm1AdminNonSSLPortNumber

Default: 5495

Modifying the default port number is not recommended.

tm1AdminSSLPortNumber

Default: 5498

Modifying the default port number is not recommended.

tm1AdminHTTPPortNumber

Default: 5895

Modifying the default port number is not recommended.

tm1AdminHTTPSPortNumber

Default: 5898

Modifying the default port number is not recommended.

tm1AdminSupportNonSSLClients

This setting determines if the Admin Server supports non-SSL Planning Analytics clients.

Set this property to True to configure the Admin Server to support non-SSL clients and to listen for client connections on both secured and unsecured ports.

Set this property to False to configure the Admin Server to support only secure client connections on a single secured port.

Valid settings: True, False

Default: False

tm1AdminKeyFile Specifies the path to the key database file for the Admin Server.

The default path is <install_dir>\bin64\ssl\ibmtm1.kdb

tm1AdminKeyStashFile Specifies the path to the stash file that stores a password for the tm1AdminKeyFile.

The default path is <install_dir>\bin64\ssl\ibmtm1.sth

tm1AdminKeyLabel

The label for the certificate in the tm1AdminKeyFile.

Default: ibmtm1_server

tm1AdminTLSCipherList

Specifies a comma-separated list of supported cipher suites in priority sequence.

If this parameter is empty, all ciphers are allowed.

tm1AdminSupportPreTLSv12Clients

Determines if the Admin Server supports client connections using Transport Layer Security prior to TLS 1.2.

Valid settings: True, False

Default: False

tm1AdminNIST_SP800_131A_MODE

Determines if the Admin Server operates in compliance with the SP800-131A encryption standard. When SP800-131 encryption is enforced, the signed certificate must comply with the standard as defined by the National Institute of Standards and Technology (NIST) Special Publication SP800-131. This standard requires a minimum key size of 2048 bits and a signature algorithm of RSA with SHA-224 or higher.

Valid settings: True, False

Default: False

tm1AdminIPVersion

Specifies the Internet protocol used by the Admin Server.

Valid settings are:

  • ipv4 - Used for IPv4 networks.
  • dual - Used to transition from IPv4 to IPv6. Both protocols are supported.
  • ipv6 - Used for IPv6 networks.

Default: IPv4

tm1AdminActivityInterval

The amount of time, in seconds, that the Admin Server polls for activity on registered TM1 Servers.

Default: 10

tm1AdminInactivityTimeout

The inactivity period, in seconds, after which the Admin Server removes a server from the list of registered TM1 Servers.

Default: 10