IBM Support

Setting up TM1 Server to run as a service

Troubleshooting


Problem

How to setup a TM1 Server to run as a Windows Service

Environment

Any supported Windows platform

Resolving The Problem

To setup a TM1 Server to run as a service:
1) Open a command prompt: Start > Run > cmd

2) Navigate to the TM1 bin directory using the cd command. Depending on the version of TM1 you have installed, the default location of the bin directory will be "C:\Program Files\Cognos\TM1\bin". If you installed TM1 to a different directory, navigate to the bin directory appropriately.

tm1sd.exe -install -nNameOfTM1Server -zPathtoTm1s.cfgFile

NameOfTM1Server (after the -n) is the name you want to give to this TM1 Server service. If the name you are going to use contains any spaces, this value must be specified in double quotes.
The PathtoTm1s.cfgFile (after the -z) is the path to the tm1s.cfg file for this the TM1 Server you are setting up. This parameter value MUST be surrounded by double quotes if there are any spaces in the path name.

For example:
tm1sd.exe -install -n"TM1 Production Server" -z"C:\Program Files\Cognos\TM1\Custom\TM1Data\PData"

If the command is successful, it will return a message indicating so. For example:
TM1 Server / tm1 production server installed.

4) You can then go into the services listing, and you will see the new TM1 Server service you setup. Following the above example, the service would be listed as:
TM1 Server / tm1 production server
You can then configure the service to run automatically, and to run under a specific domain user.

NOTE: If you are setting up a completely new TM1 Server for which you don't already have a tm1s.cfg file, you can copy the tm1s.cfg from the Planning Sample TM1 Server and modify it accordingly. At a minimum, you will need to modify the ServerName, DataBaseDirectory, and PortNumber parameter values.

If the service does not start (error message stating the service cannot be started), starting the same TM1 Logical server as a desktop application will usually provide more detailed information on the error.

If you wish to remove a TM1 Server service (again, following the example above), follow steps 1 and 2, then type the following command (substituting appropriate values where needed):
tm1sd.exe -remove -nNameOfTM1Server
The NameOfTM1Server (after the -n) is the name of the TM1 Server service you wish to remove. If the name you are going to use contains any spaces, this value must be specified in double quotes.

For example:
tm1sd.exe -remove -n"TM1 Production Server"

[{"Product":{"code":"SS9RXT","label":"Cognos TM1"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"TM1","Platform":[{"code":"PF033","label":"Windows"}],"Version":"9.5.2;9.5.1;9.5;9.4 MR1;9.4","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Historical Number

1041528

Document Information

Modified date:
15 June 2018

UID

swg21351401