How to Upgrade Planning Analytics Workspace
Upgraded for PAW 2.0.57. Planning Analytics Workspace (PAW) is on a release cadence of about every month from IBM. So each month, IBM will release a new version of the PAW server components, usually alongside a new version of Planning Analytics for Excel (PAX) and Planning Analytics Spreadsheet Services (PASS). There will almost always be a new version of all three when a new version of the TM1/Planning Analytics core is released. This note takes you through step by step how to upgrade the PAW server on Windows Server 2016.
Planning Analytics Versions
Please note that PAW, PAX and PASS should be kept roughly in sync as PAX uses PAW to communicate with the PA/TM1 server and PASS uses PAX to generate the TM1Web views. So please update PAW, PAX and PASS together and keep your PA server up to date as well. Please check this post for more information on Planning Analytics version management.
Preparation for PAW Upgrade
- If PAW runs on a Virtual Machine, have a snapshot taken before you do anything.
- Check that there is enough space on the drive used by Docker. You will need at least as much as is consumed by ProgramData/Docker (or your customized docker data folder) before you upgrade (we have a client with over 100Gb of data here). If you need to move your docker data, please see this post.
- Check on IBM’s Software Product Capability report that your version of Docker is still supported.
- Download the installation files from Passport Advantage or IBM’s Fix Central.
- Unpack the zip file.
- Rename the unzipped folder PAW_nnnn, where “nnnn” stands for the version number (say, “PAW_2057” for version 2.0.57). Removing the dots makes it easier to refer to!
- Move the folder to your “PAW” folder, or whatever you have called the master folder where PAW is currently installed.
- In the new version, go to the config folder and rename the “certs” folder to “certs_old” and the “ssl” folder to “ssl_old”. I know you don’t need to, but it can’t hurt!
- Go to the installation files for the old version and copy the /config/paw.ps1 environment file, the config/certs folder and the config/ssl folder (so three objects from the config folder on the old location) to the config folder of the new installation location. Nothing should be overwritten as you have changed the names in the target location.
- Create a Backup of your existing PAW environment.
Update Planning Analytics Workspace
- Advise users that Planning Analytics Workspace (PAW) will not be available because of an upgrade. Also, let them know that PAX will also not work because they use PAW to connect PAX to TM1 and that PAX will also be updated.
- Open Windows PowerShell as an Administrator.
- Navigate to the new installation location, for example, E:\PAW_Install_Kits\PAW_2052\
- Type ./start.ps1 and press enter. This will start the installation process for Planning Analytics Workspace, making reference to your existing environment.
- This will initiate a series of scripted preflight checks of your environment, making sure that all the correct settings are in place.
- Reply “Y” when you are prompted to install the Docker images. Note that this may take quite a while as these images are HUGE! I have seen this process take well over half an hour.
- Reply “Y” when you are prompted to open the Planning Analytics Administration tool.
- That will open PAW Admin in a browser. Here you need to accept the two licence agreements.
- Then, in PAW Admin, check that the paths and URI’s are all correct.
- Validate and Update Planning Analytics Workspace. That will start or restart PAW services.
- Flip to the Status tab, and if necessary, Restart Planning Analytics Workspace there as well.
- Test that PAW and PAX are working as expected.
- Advise users that the Planning Analytics Workspace update is now complete and that PAW and PAX are available again.
Cleanup from your Planning Analytics Workspace Upgrade
Finally, now that the PAW upgrade is complete, you need to clean out the image files from the old installation of PAW. To do this run the scripts/clean.ps1 or scripts/clean.sh script from the OLD installation location. This will remove images for the release in which it is run, so make sure it is run for the old installation, not the one you have just upgraded to!
Disk Space Warning: Change Docker Drive
Remember that if you need to change the drive that the Docker images are stored on, you can do so by following the instructions in this post.
TM1 Server Upgrade
Also, you should be keeping the TM1/Planning Analytics core server components up to date as well. If you are looking for instructions to upgrade the core of TM1/Planning Analytics, please see this post.
If you have any questions or need some help with this upgrade, please let us at ExploringTM1 know. We’d love to help you with your update.