How to Test the Connection to TM1

How to Test the Connection to TM1

How to Test the Connection to TM1

Before Pulse can monitor a TM1 instance, the connection between Pulse and TM1 must be verified. This article explains how to test TM1 connectivity from Pulse and from the network level.

Method 1 β€” Via the Pulse REST API Tool

The Pulse REST API Tool allows you to send test requests directly to a TM1 instance from the Pulse web client.

  1. Enable the tool in Pulse.cfg:

    [WebServer] EnableRESTAPITool = true
  2. Restart the Pulse Application Server.

  3. Log in to Pulse and navigate to About β†’ REST API Tool.

  4. Select the TM1 instance from the dropdown.

  5. Send a test request to the $metadata endpoint:

    GET /api/v1/$metadata
  6. A successful response (HTTP 200 with XML content) confirms the connection is working.

Method 2 β€” Via Browser (Direct REST API Test)

From the Pulse server, open a browser and navigate to:

http://<TM1Server>:<HTTPPortNumber>/api/v1/$metadata

If TM1 uses HTTPS:

https://<TM1Server>:<HTTPSPortNumber>/api/v1/$metadata

A valid response confirms:

  • The TM1 REST API is enabled and running.

  • The port is accessible from the Pulse server.

  • No firewall is blocking the connection.

If you receive a connection error or no response, the REST API port is not reachable.

Method 3 β€” Via Pulse Administration

  1. Log in to Pulse as an Admin.

  2. Go to Administration β†’ Servers.

  3. Locate the TM1 instance.

  4. Check the connection status icon β€” green indicates connected, red indicates a connection failure.

  5. If red, hover over the icon or check pulse.log for the specific error message.

Method 4 β€” Test Authentication Separately

If the REST API is reachable but Pulse reports an authentication error:

  1. Go to Administration β†’ Instance Settings.

  2. Select the instance.

  3. Use the Test button (if available) to verify the username/password combination.

  4. For CAM instances, also verify the CAM Namespace field is correct and case-matching.

Common Test Results and Meanings

Result

Meaning

Result

Meaning

HTTP 200 with $metadata XML

Connection successful

HTTP 401 Unauthorized

REST API reachable but credentials are wrong

HTTP 403 Forbidden

Credentials are correct but user lacks Admin rights

Connection refused

REST API port not reachable β€” check firewall and TM1 service

SSL handshake failure

Certificate not trusted β€” import it into the Pulse Java truststore