Specifying TM1 Admin Host and TM1 Server parameters with the URL API

You can set the Cognos® TM1® Admin Host and server name in the URL string by using the AdminHost and TM1Server parameters.

The AdminHost and TM1Server parameters can be included in the URL with the #Action=Open command or implicitly specified with the use of a session token.

These values are optional in the URL, but must be provided to TM1 in one of the following ways.

In the tm1web_config.xml file
With a session token
In the URL string
Posted to the TM1 Web server using the form-based login
Provided by the user when prompted by TM1 Web

If these values are not found, then TM1 will prompt the user for this information with a mini pop up window.

The Admin Host and server name are determined in the following order:

If a session token is specified, the admin host and TM1 server are determined from that first since it points to a specific session.
If the AdminHost and TM1Server parameters are set in the URL, they will override the values in the tm1web_config.xml file.
If these values are absent in the URL string, TM1 Web tries to determine if they are set in the tm1web_config.xml file.
If the AdminHost and TM1Server parameters are absent from both the URL string and the tm1web_config.xml file, then the system prompts the user for this information in a pop up window.

Example

These parameters use the following format:

&AdminHost=AdminHostName&TM1Server=TM1ServerName

where:

AdminHostName: Name of the system where the TM1 Admin Host is running.
TM1ServerName: Name of the TM1 server to log in to.

For example, the following sample code uses the local system and the TM1 Planning Sample database.

&AdminHost=localhost&TM1Server=Planning Sample