Dec 4, 2020

Migrating Pulse v5.x history into Pulse v6.x

This article explains the steps to migrate Pulse 5 data from one server to a new server where Pulse 6 is installed.

If you are installing Pulse 6 over Pulse 5, the migration will happen automatically.

Let’s take the following architecture with two servers DEV and PROD where TM1 and Pulse 5 is installed. In the example below there are two Pulse 5 installed, one on each server.

Now If you decide to install Pulse 6 on each server, then when upgrading Pulse with the installer, Pulse will migrate the Pulse 5 data into a Pulse 6 format automatically.

But by having Pulse 6 installed on each server, you are missing the centralised feature of Pulse.

The recommended architecture is to install Pulse 6 on a new server (The new server will start with a blank h2 database, the steps to migrate the historical Pulse 5 data from DEV and PROD to the new server are explained below) :

If a new server is not available, you can install Pulse 6 on one of the TM1 servers (DEV or PROD):

In the example above, as Pulse 6 will be installed on top of Pulse 5 on the DEV server, Pulse 6 will only have the historical Pulse data from DEV. To get the Pulse historical data from PROD, you will need to follow the steps below.

Step 1: Back-up Pulse 6

Back-up Pulse 6 data, before running the migration please make sure your Pulse 6 folders are backed-up:

Step 2: Creating a new Pulse Monitor

Before migrating the data from a Pulse server, you have to connect a Pulse 6 monitor from this server, steps can be found here:

  • Connecting a Pulse Monitor

In the example below, a connection to a Pulse Monitor in the server CW14 was added:

Now we need to migrate the Pulse 5 data from the CW14 server.

Step 3: Copy the Pulse 5 data

Grab the following folders from the server where Pulse 5 is installed.

  • conf: Stores the configuration files.
  • db: Stores the pulse databases.
  • history: Stores the history of processes and chores in text files.
  • packages: Stores the migration packages.
  • vcs: Stores the git source control repositories that contain the history of changes to your TM1 models.

Step 4: Paste the Pulse 5 data into the Pulse 6 migrate folder

Paste all these folders into a new folder in <Pulse installation folder>\Pulse for TM1\migrate\<servername> (If the migrate folder does not exist, just create it).

Step 5: Check ServerNameOverride parameter

In this example, we are migrating the Pulse 5 data from the server CW14, so we need to open the [Pulse for TM1]\migrate\CW14\conf\Pulse.cfg

Then only if the ServerNameOverride parameter is not used, you will need to add it with the Pulse 5 server name as below:

ServerNameOverride = CW14

⚠️If there is already a server name, please do not change it.

This step is very important because Pulse 6 will use this server name to connect to the database.

Step 6: Executing the migration

After few seconds, Pulse will display an icon at the top, click on it to open the migration page:

The migrate page will look like this:

Click the Migrate button to start the migration:

The migration might take a while. The connection to the Pulse server will be disconnected while the migration is happening.

Once the migration is done, you should see the check box on the Status column:

After the migration is done, you will need to reactivate the server manually, go to the Servers page and tick the Activate flag as below:

⚠️Warnings

  • Target service to be migrated under VCS folder should not exist – delete folder if present.

    • No support for VCS merge
    • Warn Users that it will be deleted
  • Target service to be migrated under DB folder should not exist – delete folder if present.

    • Run “Update Documentation” afterwards
    • Target Packages will not be overridden

What’s happening when Pulse 5 is configured with MS SQL Server

When Pulse 5 is configured with MS SQL server as its database. The only difference from the steps described above is that you don’t need to copy the db folder. Pulse 6 will connect to the Pulse 5 MS SQL databases with the settings from the pulse.cfg and then merge the data with the new Pulse 6 database.

In the example below, there are two Pulse 5 connected to its own MS SQL database:

If you choose to install Pulse 6 on one of the Pulse 5 servers (Server 1). DB1 will be upgraded the first time Pulse 6 starts. For DB2, you will only need to migrate the files from the Pulse 5 server 2, once the Pulse 6 migration process starts, Pulse 6 will connect to DB 2 with the settings from the Pulse.cfg (copied from server 2) and merge the data into the DB1 database:

If you choose to install Pulse 6 on a new server with a new database, you will then have to run the migration process twice, for server 1 and server 2:

Related content

Loading related content