Feb 3, 2023

Connecting Arc to Pulse

Starting with Arc v4, you can connect your Arc server to Pulse to unlock many new features in your Arc application, such as Instance/Server Monitoring, Full Model Search, Alerts and Change Tracking. We call this Pulse-powered mode “Arc+”.

This article explains how to connect Arc to Pulse.

Prerequisites

Pulse minimum version is v6.2.0

The connection to Pulse with Arc v4.0.0 is currently only working if you are using the default Pulse authentication. If you are logging in to Pulse with IBM ID or Windows SSO, you will need to wait for the next Arc release to use the Pulse integration.

Step 1: Setting up the Pulse URL

With Arc v4.0, one Arc server can connect to only one Pulse server. To tell Arc, where Pulse is, you need to set the Pulse URL in the Arc settings file (settings.yml).

Go to the Arc directory folder and open the settings.yml file. Then you need to add the pulseurl setting:

pulseurl: https://pulseServerName:pulsePortNumber

⚠️ One Arc server can connect to only one Pulse.

⚠️ The Pulse URL should not end with “/#/”

The Pulse URL is the URL to access the Pulse Web Client.

Step 2: Setting up the instances mapping

The way Arc and Pulse structure the TM1 instances is slightly different so you need to tell Arc where to find the TM1 instances in Pulse.

Pulse connects first to a Pulse Monitor (Environment) and then finds all TM1 instances. Arc can connect to an admin host or directly to a TM1 instance via the TM1 REST API. You need to tell Arc in which Environment it will find find the TM1 instances.

Let’s take the following two examples where we have one admin host setup (localhost) and in Pulse, the Environment name is SYDCLOUD01 and one connection with the Environment name called VIRCLOUD01:

⚠️ The TM1 instance name has to be the same between Arc and Pulse.

The Pulse Environment name can be found in the Environments page of the Pulse Web Client under Administration:

Below is an example of a connection with the instance name CRM and the environment name VIRCLOUD01:

connections: - url: https://pulseServerName:tm1RESTAPIport   name: crm   pulseenvironment: VIRCLOUD01   pulsetracking: true
adminhosts:- url: https://tm1ServerName:5898  pulseenvironment: VIRCLOUD01  pulsetracking: true

⚠️ When the url is the unique parameter of the adminhost or connection, adding the url: is optional. But when you add more than one parameter, you have to add it. That is why when adding the pulse settings into your connections and adminhosts, you have to add url:⚠️

For example, you need to change:

adminhosts:- https://localhost:5898

To:

adminhosts:- url: https://localhost:5898

Setting up object usage tracking

The pulsetracking setting is optional. It is set to false by default. You can set it to true to enable object usage tracking in Pulse. Each time an Arc user opens a cube view or subset editor, this information will be sent to Pulse.

settings.yml example

In the example below, the Arc server is connected to Pulse via https://pulse-url. You should see all TM1 instances on the admin host localhost and two other TM1 instances defined in connections:

Enabling the Pulse features in Arc

Once the settings.yml file is updated, you just need to refresh your browser and you should see the new Arc+ logo.

To login to Pulse in Arc, you just need to click the Pulse icon in the top right corner and enter your Pulse login:

Different ways to login to Pulse

Arc supports three ways to authenticate with Pulse:

  1. Native authentication: Using a username and password
  2. Windows SSO: Setting Up Windows (SSO) Authentication for Pulse
  3. Using IBM ID to login to Pulse

Logging to Pulse with native authentication

When you are using Pulse’s native authentication. In Arc, you will need to enter your Pulse username and password in the first section and then click the first Login button:

Logging to Pulse with IBM ID and Windows SSO

There are different ways to log in to Pulse. When Pulse is configured to use IBM ID, then you just need to click the Login by Pulse button in the Login through Pulse section.

When Pulse authentication is configured to use Windows SSO, you also need to click the second Login button but you need to make sure you did the following first:

  1. The Arc service needs to run under a service account
  2. The pulseurl setting in the settings.yml file needs to have the server name: pulseurl: https://pulseServerName:pulsePortNumber/

The login with Windows SSO won’t work if the pulseurl is using localhost in the url.

Using Server Groups

The Arc and Pulse integrations works with server groups as well. Don’t forget to update the pusleurl in the settings.yml file.

settings.yml:

server-groups.yml:

If you’ve never heard of server groups, it is a user-friendly way to group your servers and instances:

Related content

Loading related content