IBM Support

How to Upgrade Planning Analytics Database (as a service)

How To


Summary

This document outlines the steps to connect to and upgrade a Planning Analytics as a Service Database, using the REST API

Environment

Document is applicable only to Planning Analytics as a Service

Steps

PRE-REQUISITE: Before you proceed with this document, you must already be familiar with connecting to the Planning Analytics Service using the REST API.  See the following for further details:  
LINK: How to Connect to Planning Analytics as a Service Database using REST API

See release notes for version details: https://cloud.ibm.com/docs/planning-analytics?topic=planning-analytics-planning-analytics-relnotes
Prior to any upgrades, ensure you have taken a backup of your database and have downloaded your backup to a local disk.
UPGRADE PLANNING ANALYTICS DATABASE
  • Connect to IBM Cloud and retrieve access_token
  • Use access_token to connect to Planning Analytics Database
  • Stop the Planning Analytics Database (all replicas)
    • PATCH: {{host}}/api/{{tenant}}/v0/tm1/{{tm1db}}
    • BODY:  { "Replicas": 0 }
  • Get the Planning Analytics Database status to ensure database has stopped
    • GET: {{host}}/api/{{tenant}}/v0/pakate/v0
  • Upgrade Planning Analytics Database to available version
    • POST: {{host}}/api/{{tenant}}/v0/tm1/{{tm1db}}/tm1s.Upgrade
    • BODY: { "ProductVersion": "12.3.3" }
  • Start the Planning Analytics Database
    • PATCH: {{host}}/api/{{tenant}}/v0/tm1/{{tm1db}}
    • BODY:  { "Replicas": 1 }
      • The number of replicas depends on your high availability configuration
      • If no high availability is configured, start the server by specifying 1 replica
  • Get the Planning Analytics Database status to ensure database has started
    • GET: {{host}}/api/{{tenant}}/v0/pakate/v0
​​​

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSEAI8G","label":"Planning Analytics as a Service"},"ARM Category":[{"code":"a8m3p000000LQtUAAW","label":"Planning Analytics"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
10 October 2023

UID

ibm17049112

Page Feedback