IBM Support

How to Obtain the Planning Analytics / TM1 Server Certificate

Troubleshooting


Problem

If you have an application which must connect to your Planning Analytics / TM1 Server, you will need to import the SSL Certificate used to secure your server in to the application you are configuring. These steps will help you obtain the details you need to connect as well as extract the certificate from the Planning Analytics / TM1 Server.

Resolving The Problem

  1. Determine if your Planning Analytics / TM1 Server is using SSL. Review the tm1s.cfg file (for the server you are attempting to connect to), and look for the UseSSL parameter. If UseSSL=T, SSL is enabled. If the UseSSL parameter is not in the tm1s.cfg file, SSL will be enabled by default.
  2. Determine the HTTPPortNumber the Planning Analytics / TM1 Server is using. Review the tm1s.cfg file (for the server you are attempting to connect to), and look for the HTTPPortNumber parameter. The number specified is the HTTPPortNumber that the server is listening on. If the HTTPPortNumber parameter is not specified, the default HTTPPortNumber is 5001.
  3. Build your Planning Analytics / TM1 Server URL based on the values above. For example, if your tm1s.cfg contained UseSSL=T, and HTTPPortNumber=8203, your URL will be: https://hostname:8203/api/v1/$metadata
  4. In your web browser (this document uses Chrome), input the address to your Planning Analytics / TM1 Server ( https://hostname:8203/api/v1/$metadata ).
  5. Press F12 in your browser to launch the Developer Tools. Click the Security tab to review the certificates. Click on View Certificate.
    ***Note that depending on the certificates used, you WILL see warnings. If you are using the Default TM1 SSL certificates, the warnings/errors are expected as the certificates were not issued specifically for YOUR server, but generically.
  6. When the certificate has opened, click on the Details tab to review the certificate details.
  7. On the Details tab, click Copy to File...
  8. Follow the prompts to export the certificate. Export it as Base-64 encoded X.509.
  9. Give the file a name and location, and complete the export wizard.
  10. You may now import the certificate in to the tool you are configuring to connect to your Planning Analytics / TM1 Server. You will need to review the steps available to the application you are configuring, to determine the import process that you must follow.

Depending on the SSL Implementation your Planning Analytics / TM1 Administrator has chosen, you may have more than one certificate that you need to import, for example a Root or Intermediate Certificate. If this is the case, use the same steps above with the addition of the Certification Path tab - to identify and view (and export) the additional certificates. For example:

[{"Product":{"code":"SSD29G","label":"IBM Planning Analytics"},"Business Unit":{"code":"BU002","label":"Business Analytics"},"Component":"Planning Analytics","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"Version Independent","Edition":""}]

Document Information

Modified date:
15 June 2018

UID

swg22010202