How to Install or Upgrade Planning Analytics for Excel (PAX/PAfE) TM1 Add-in
Updated for PAX v 2.0.61. Here we are going to detail how to upgrade or install the TM1 Planning Analytics for Excel (PAX – also sometimes known as PAfE) add-ins onto a user’s PC. PAX is a set of excel add-ins that need to be installed on a client PC. Together they provide Excel-based reporting and analysis from TM1.
What is Planning Analytics for Excel (PAX/PAfE)?
PAX is the Excel add-ins that provide access to TM1 cubes. With them, you can do ad-hoc exploration, create quick reports, create unlimited length reports and highly customised reports. It replaces the old TM1 Perspectives add-in.
Planning Analytics for Excel is NOT TM1 Perspectives!
Please note that if you are looking for instructions to install the old Perspectives add-in (rather than PAX/PAfE) to Excel, please see this post.
What is the PAX/PAfE Add-in?
PAX connects to the Planning Analytics Workspace (PAW) server (not the TM1 server). To do this it uses an Excel Add-in.
There is a separate add-in for both 32- and 64-bit versions of Excel. Don’t worry if you choose the wrong version, it will not let you install the wrong version.
There are new versions of the PAX/PAfE add-in released by IBM every month or so. You should have a recent, say within the last three months, version installed.
PAX/PAW/PASS/PA Server Version Sync
Planning Analytics needs to be kept roughly in sync between the core Planning Analytics (TM1) server, Planning Analytics Workspace (PAW), Planning Analytics for Excel (PAX/PAfE) and Planning Analytics Spreadsheet Services (PASS/TM1Web). IBM releases new version of PAX and PAW about every month and a new version of PA server about every quarter. Just make sure you upgrade all three, not just PAX and leave PA server or PAW, or it will clunk eventually!
If you need more information on AP version management, please see this post.
Instructions to Install Planning Analytics for Excel
Time needed: 10 minutes.
Here are the detailed, step by step instructions for installation of the Planning Analytics for Excel (PAfE) with screenshots.
- Check Supported Environment
First, check that your PC satisfies the supported environment from IBM. This is available here and includes: At least .Net 4.6.1 (if not present, download it from here).
If installing PAX onto an old version of Excel (2007, 2010), then install the Primary Interop Assemblies (PIA) for your version of MS Office Office 2007 here, Office 2010 here. For Office 2013, 2016 or 2019, Microsoft doesn’t publish a PIA as apparently they are not needed).
If you get errors installing please see this post.
- Backup PAX Connections
Backup the connections inside Planning Analytics for Excel if you are upgrading. Just copy and paste ht connection string out to Notepad.
- Uninstall Previous PAX
Uninstall any previous version of PAX.
Click Start menu, Programs, IBM Planning Analytics for Microsoft Office, Uninstall IBM Office Addins, Uninstall IBM Office Addins.
This will bring up the Uninstall Wizard and you should follow the steps in it to remove your current version of PAX.
Ensure you select the option to leave your configuration settings in place as you don’t want to lose them!
- Modify Antivirus
Make sure any Antivirus tools allow or unblock connections for both Excel and .Net Runtime.
- Quit from Excel
Exit from Excel, if it is still open.
- Run the Installer as Admin
Then find the correct client tool installation file for either 32 or 64 bit Excel. It will be called “issetup.exe” and then Run as Administrator.
- .Net Warning
If .NET 4.6.1 is not installed, you will get this message. Go get it, install .Net and restart the computer and then start installing Planning Analytics for Excel again.
- Set Your Language
Choose the language you want to install.
Agree to the license (and make sure you actually have enough licenses to install it!).
- Installation Location
Set the installation location.
- Confirm the Folder
Agree to add the new folder if it does not exist.
Confirm the components to be installed.
- Shortcuts for All Users
Set the shortcut and make it visible to all users.
- Installation Summary
Check the installation summary.
Create Connection to TM1 Model
Now that you have installed the Planning Analytics for Excel add-in, you need to create a connection to a TM1 model. Please see this post for detailed instructions on how to do this.