TM1RunTI syntax

The TM1RunTI syntax is described here.

     tm1runti -?
                or tm1runti -help
                or tm1runt1 [<cmd_parm>...] [<ti_parm>...]
               
                   where <cmd_parm> is one of:
                        -i <filespec>
                        -process <string>
                        -chore <string>
                        -connect <string>
                        <connect_parm>...
                   
                   where <ti_parm> is:
                        <parm_name> '=' <parm_value>
                   
                   where <connect_parm> is one of:
                        -adminhost <string>
                        -server <string>
                        -user <string>
                        -securitymode
                        -retryattempts
                        -retryinterval
                        <password_parm>
                        -AdminSvrSSLCertAuthority <filespec>
                        -AdminSvrSSLCertID <id>
                        -AdminSvrSSLCertRevList <filespec>
                        -AdminSvrSSLExportKeyId <id>
                        -ExportAdminSvrSSLCert <T|F>
                        -CAMNamespace <string>
                   
                   where <password_parm> is one of:
                        -pwd <string>
                        -passwordfile <filespec> -passwordkeyfile <filespec>

Parameters

Parameters can be either in a configuration file or passed on the command line. Command line parameters take precedence over parameters that are in the configuration file. This makes it possible to have persistent default parameters for relatively static parameters (such as adminhost and server) and to supply just the few parameters needed to either override the defaults or to provide values that are not easily defaulted, such as the user name or the TurboIntegrator process name.

The parameters have a different format when passed on the command line. While all parameters are passed in a "-parameter_name value" fashion, everything that is passed as "parameter_name=value" is treated as a TurboIntegrator process parameter.

There are four types of parameters:

Command parameters
Used to specify the config file to use, which group of connection parameters to use, which TurboIntegrator process to run, or which TurboIntegrator chore to run.

Only one command parameter should be specified at a time. If both a -process and -chore are present on the command line, TM1RunTI will run the TurboIntegrator process and ignore the -chore parameter.
Connection parameters
Used to specify the servername, username and other information needed to connect to the Cognos TM1 server.
Password parameters
Can either be a username and plain text password or can be a filename containing an encrypted password and associated keyfile used for decryption.
TurboIntegrator parameters
Passed to the named TurboIntegrator.

Parameters specified on the command line must begin with dash (-) or slash (/). The parameter value is separated from the parameter name by a space, and the value can be specified as is or in quotes (if there are embedded spaces).

For example:

tm1runti –server MyTM1Server –username John –pwd "my secret"
         ti_parm1=yes ti_parm2="my value"

TM1RunTI Parameters

Parameter	Description Value/Required/Default
`i`	Path to configuration files String/No/None
`connect`	This parameter can be used to specify a section in the configuration file containing parameters used to make server connections, such as user, pwd, CAMnamespace, etc. String/No/None
`process`	Name of the TurboIntegrator process to call. String/No/None
`chore`	Name of the TurboIntegrator chore to call. String/No/None
`help`	Display help text to the command window (stdout). not applicable/No/not application
`?`	Display a synopsis of command line parameters to the command window (stdout). not applicable/No/not application

Connect Parameters

Connect parameters are common among TM1 tools, and can be defined in their own section to enhance reuse and avoid the effort and risks associated with maintaining multiple copies.

Parameter	Value/Required/Default	Description
`adminhost`	String/No/None	Cognos TM1 admin host
`sever`	String/No/None	Cognos TM1 server name
`user`	String/No/None	Cognos TM1 or CAM name
`retryattempts`	Numeric/No/none	Number of attempts to connect to the TM1 server when the server is unavailable due to temporary network issues or instances when the TM1 Server is not able to handle incoming connections. If the TM1 server is not running, any connection attempt fails and returns an error. There are no further connection attempts, regardless of `retryattempts` parameter setting.
`retryinterval`	Numeric/No/0	Time interval, in seconds, to retry connection to the TM1 server. The number of connections attempted is determined by the `retryattempts` parameter value. When `retryinterval` is not specified or is set to 0 (default), connection attempts occur immediately without a wait interval.
`AdminSvrSSLCertAuthority`	String/No/none	The full path of the certificate authority file that issued the Cognos TM1 Admin Server's certificate
`AdminSvrSSLCertID`	String/No/none: API Default is : `tm1adminserver`	The name of the principal to whom the Cognos TM1 Admin Server's certificate is issued. Note: The value of this parameter should be identical to the SSLCertificateID parameter in the `Tm1admsrv.ini` file.
`AdminSvrSSLCertRevList`	String/No/None	The full path of the certificate revoca-tion file issued by the certificate authority that originally issued the Cognos TM1 Admin Server's certificate. A certificate revocation file will only exist in the event a certificate had been revoked.
`ExportAdminSvrSSLCert`	Boolean/No/F	Specifies whether you want the certificate authority certificate which originally issued the Cognos TM1 Admin Server's certificate to be exported from the Microsoft Windows certificate store at runtime. When this option is selected, you must also set a value for `AdminSvrSSLEx-portKeyID` as described here. Refer to IBM Planning Analytics Installation and Configuration for appropriate TM1Server configuration.
`AdminSvrSSLExportKeyId`	String/No/None	The identity key used to export the certificate authority certificate, which originally issued the Cognos TM1 Admin Server's certificate, from the certificate store. This parameter is required only if you choose to use the certificate store by setting `ExportAdminSvrSSLCert=T`. Refer to IBM Planning Analytics Installation and Configuration for appropriate TM1Server configuration.
`CAMNamespace`	String/No/none	CAM namespace id. Note: This not the CAM namespace name. This value is needed only if the Cognos TM1 Server authenticates using CAM.

TurboIntegrator Parameters

These parameters are defined by the TurboIntegrator process and must be of the correct type (number or string).

Parameter

Parameter	Description Value/Required/Default
`<ti_parm>`	Provide the string or number value `<value>` to the parameter named `<ti_parm>` which must be a valid parameter name accepted by the TurboIntegrator being run. <value>/No/None

Description

Value/Required/Default

<ti_parm>

Provide the string or number value <value> to the parameter named <ti_parm> which must be a valid parameter name accepted by the TurboIntegrator being run.

<value>/No/None

Password Parameters

Passwords are either provided in cleartext (not recommended) using the pwd parameter, or using an encrypted file provided by the passwordfile parameter.

Parameter	Value/Required/Default	Description
`pwd`	String/No/None	Cognos TM1 or CAM password
`passwordfile`	String/No/None	The full path of the file containing the encrypted password for the specified user. If no path is specified, the Cognos TM1 server directory is assumed. When this option is used, you cannot use `-pwd`.
`passwordkeyfile`	String/No/None	If `passwordfile` is set, the full path to the key file is also required in order to decrypt the password. The password file and key file can be created using TM1Crypt tool. Refer to IBM Planning Analytics Installation and Configuration.