Planning Analytics Administration agent (local only)

Local only To upgrade the Planning Analytics Administration agent, follow these steps.

Before you begin

  • You must have IBM® Planning Analytics Local version 2.0.5 or later installed wherever you have installed IBM TM1® Server.
  • You must ensure that port 9012 is available. The default port of the Planning Analytics Administration agent is 9012.
  • You must install and configure the Planning Analytics Administration agent. For more information, see Install and configure the Planning Analytics Administration agent (local only).

Download the Planning Analytics Administration agent in Planning Analytics Workspace

Procedure

  1. On the Planning Analytics Workspace Home page, click the Administration tile.
  2. On the Administration page, click Agents.
  3. Click the Download button Download icon, then click Download Agent.
    The installation is saved as an archive named paa-agent-pkg-<version>.zip in your Downloads directory.

Download the Planning Analytics Administration agent Planning Analytics Workspace Classic

Procedure

  1. Navigate to the Planning Analytics Administration page.
    Screen showing the Downloads link on the Planning Analytics Administration dashboard.
  2. Click Downloads. The Downloads dialog box opens.
  3. To download the Planning Analytics Administration agent, click the PAA Agent tab.
  4. Select the version of Planning Analytics Administration agent that you want to download.
    Only the latest version of the Planning Analytics Administration agent is available for download. You cannot downgrade your version of the Planning Analytics Administration agent from this dialog box.
  5. When prompted, save the archive to the location of your choice.
    For example, save paa-agent-pkg-1.0.<sc>.<nnn>.zip. The <sc> is the release of Planning Analytics Workspace and <nnn> is the version of the Planning Analytics Administration agent.

Update the Planning Analytics Administration agent

Procedure

  1. Extract the archive to a temporary location. .
  2. Open a command window and change to the directory where you extracted the compressed folder.
    Note: You will not be able to stop a service or modify files in <PA_install_location>\paa_agent\ unless you have the required permissions. On Windows, open the command window with Run as administrator.
    Tip: Put the full path to <PA_install_location> in quotation marks if it contains spaces.
    1. To update the Planning Analytics Administration agent Windows service, run UpdatePAAAgent.bat, passing in the full path to <PA_install_location>, that is, the parent of the paa_agent directory.
    2. To update the Planning Analytics Administration agent service on Linux, run UpdatePAAAgent.sh, passing in the full path to <PA_install_location>, that is, the parent of the paa_agent directory.

    The UpdatePAAAgent script stops the Planning Analytics Administration agent before updating it.

    Your existing bootstrap.properties file is preserved and updated with the new agent version number. For example, VERSION=1.0.39.736.

What to do next

Note: The UpdatePAAAgent script restarts the Planning Analytics Administration agent at the end of the script.