Prerequisites

Before you install IBM® Planning Analytics Workspace, you must install IBM Planning Analytics Local version 2.0.0 or later.

Important: To review an up-to-date list of operating systems supported by IBM Planning Analytics Local, create a detailed system requirements report by using the Software Product Compatibility Reports tool (https://www.ibm.com/software/reports/compatibility/clarity/index.html).

Planning Analytics Workspace is included as part of IBM Planning Analytics Local. For more information, see the IBM Planning Analytics Local download document for instructions.

If you are using IBM Cognos® Analytics as your authentication provider, then you must have IBM Cognos Analytics 10.2.2 or later installed.

Planning Analytics Workspace communicates with TM1® servers by using the TM1 REST API. In the Tm1s.cfg file for all TM1 Servers, set the HTTPPortNumber property to a free port on the server.

The following list contains information about requirements and the installation kit name for different operating systems that are supported by Planning Analytics Workspace.

Microsoft Windows Server 2019
Microsoft Windows Server 2016
  • The installation kit is ipa_workspace_local_win_<version>.zip.
    Note: If you are using Planning Analytics Local version 2.0.74 or later, the installation kit is ipa_workspace_win_2016_<version>.zip.
  • When you run the start.ps1 script, validation checks run automatically and the host server is repaired if possible. The script checks your Windows Server version, prerequisite software, network configuration, and free ports. It also checks for unsupported anti-virus software that conflicts with Planning Analytics Workspace Local. You can jump directly to Install Planning Analytics Workspace Local on Windows Server 2016.
  • Docker runs on a physical Microsoft Windows Server 2016 or a VM with Microsoft Windows Server 2016 running under VMware or Microsoft Hyper-V.
  • You must have at least 100 GB of free space on the C:\ drive for Microsoft Windows Server 2016. By default, Docker stores its images and containers in C:\ProgramData\Docker. You can configure Docker to store data on another drive. For more information, see Configure Docker with a configuration file on the Docker documentation website (https://docs.microsoft.com/en-us/virtualization/windowscontainers/manage-docker/configure-docker-daemon#configure-docker-with-a-configuration-file).
Red Hat Enterprise Linux® 7
Red Hat Enterprise Linux 8
  • The installation kit is ipa_workspace_local_<version>.zip.
  • Podman 3.3.1 or later is required.
  • Planning Analytics Workspace on Red Hat Enterprise Linux 8 supports non-distributed installation on RHEL 8 using the Podman container engine and can be installed by either root or a non-root user.

    Although the user installing and running Planning Analytics Workspace can be non-root, rootless Podman containers are not currently supported. To run root containers as a non-root user, Planning Analytics Workspace relies on access to the root Podman socket (/run/podman/podman.sock) and connects to it using [podman --remote]. This means that the user executing Planning Analytics Workspace must have read and write access to the socket. This non-root socket access configuration is in effect the same as what is used by Planning Analytics Workspace on Docker.

    There are several ways to configure secure access to the Podman socket. Here are two examples:
    • Add the user running Planning Analytics Workspace to the root group
      $ sudo usermod -aG root pawuser
      then ensure group access to the directory containing the socket
      $ sudo chmod g+rx /run/podman
    • Run Podman.socket with a custom group and add the user running Planning Analytics Workspace to this group
      $ sudo groupadd groupname 
      $ sudo vi /usr/lib/systemd/system/podman.socket 
      … 
      [Socket] 
      …
      SocketMode=0660 
      SocketGroup=groupname 
      …
       $ sudo systemctl daemon-reload 
      $ sudo systemctl restart podman.socket 
      $ sudo chown root:groupname /run/podman 
      $ chmod g+rx /run/podman 
      $ sudo usermod -aG groupname pawuser

    You can consult the Podman documentation for more options.

  • When you run the start.sh script, validation checks run automatically. You can jump directly to Install Planning Analytics Workspace Local on Red Hat Enterprise Linux versions 7 or 8.
  • For all currently supported Linux distributions, overlay2 is the preferred storage driver and requires no extra configuration. For more information, see Docker storage drivers at https://docs.docker.com/storage/storagedriver/select-storage-driver/.
  • Storage requirements can vary, you need at least 100 GB for the /var/lib/docker directory and sufficient space for at least two Planning Analytics Workspace installation packages wherever you choose to install them.
Community Enterprise Operating System (CentOS)
CentOS is a free, community-supported, open source Linux distribution.
Planning Analytics Workspace Local on CentOS needs Docker Community Edition.
Docker Community Edition (CE) is free for anyone to use.
For more information, see Docker Engine - Community.