Pulse stores the IBM Planning Analytics (TM1) server name and instance name in the Pulse databases and folders. Pulse stores the data in the databases by server name and instance name.

If you have to rename the server name where TM1 is installed or to rename the TM1 instance name, you will have to update the databases with a script.

You would require to do this:

• If you’re migrating from one server to another where the server name will be different
• If the TM1 instance name changes.

Renaming the server or instance name in Pulse does not move historical data stored in OpenSearch (or Elasticsearch). The script updates the database references, but historical data will remain under the old environment name. New data will be stored under the new Server name moving forward.

To avoid complications when moving servers, we recommend using environment names such as dev1, dev2, etc., to make transitions smoother.

Important Considerations:

• The Environment page does not currently provide an option for renaming environments.
• The environment name should clearly indicate its purpose (e.g., DEV, PROD, FINANCE, SALES) rather than using the physical Server name.
• This naming approach ensures historical data remains accessible, even when upgrading to a new physical or virtual server in the future

Pulse provides two scripts in the installation directory to update the databases and rename the VCS folder:

Default location: C:\Program Files\Pulse for TM1\utils\TM1utils

• ServerNameUpdate.bat: rename the server name

• ServiceNameUpdate.bat: rename the service name

Steps to Rename the Server or Instance Name

Pulse services have to be stopped – Before making any changes, stop Pulse services and back up the Pulse directory.

In order to run a batch file:

• open the command lines:

• go to the utils folder cd C:\Program Files\Pulse for TM1\utils:

• Just type the bat file you want to run e.g ServerNameUpdate.bat to see the help

• To rename a server name from A to B you’ll need to type ServerNameUpdate.bat A B and then press enter (do not forget to stop the Pulse services).

To keep the information with the new server name and/or service name, you will have to rename all the following folders:

• In Pulse 5:

  • Pulse for TM1\history\<serviceName>

  • Pulse for TM1\vcs\git\<serviceName>

• In Pulse 6:

  • Pulse for TM1\vcs\git\<serverName>\<serviceName>

Remove ServerNameOverride from Pulse.cfg – If the old Server name still appears in Pulse, remove the ServerNameOverride parameter from Pulse.cfg.

Restart Pulse Services – After making these changes, restart Pulse services.

Run the Documentation Process – Execute the documentation process to update the records.

Verify Historical Data – Check that historical data is retained correctly under the new Server name.