Start Here: Common Steps Before All New Installs and Upgrades

You can set up instances of CA PPM on-premise or SaaS for development and testing, and upgrade those non-production environments, before upgrading and cutting over to production. After reading the documentation and preparing for your upgrade, SaaS customers can file a CA Support ticket to request an upgrade for a particular instance of CA PPM SaaS.
ccppmop153
You can set up instances of CA PPM on-premise or SaaS for development and testing, and upgrade those non-production environments, before upgrading and cutting over to production. After reading the documentation and preparing for your upgrade, SaaS customers can file a CA Support ticket to request an upgrade for a particular instance of CA PPM SaaS.
As an administrator for an on-prem or SaaS environment, follow these steps:
3
3
Activity:
Status:
Plan for All Required Components
The install and upgrade scripts require the installation or upgrade of certain system components.
Required Action:
All new installs and upgrades require that you perform the following steps. Plan ahead to include these steps before you consider your upgrade complete:
  • Install and Configure the Data Warehouse
  • Run the Load Data Warehouse Job
  • Install the PMO Accelerator add-in (required for the
    New User Experience
    and if using the optional APM add-in). For best performance and value, we recommend installing the PMO Accelerator and the PMO Accelerator Advanced Reporting content for all installations and upgrades, 14.x or 15.x, whether you plan to use Classic PPM, the Modern UX, or both.
__ Planned
__ Started
__ Completed
__ Not applicable
Upgrade Large Data Sets
If your upgrade processes a large volume of data, we recommend that you override the default memory settings that are used by the upgrade.
Recommended Action:
  1. Create your own
    memory.properties
    file and place it in the
    $cappm/config
    directory.
  2. Set the desired memory values in that file.
    Default pre-upgrade values:
    defaultScriptMaxMem=1024m
    defaultScriptPermGenMem=128m
  3. The following settings represent examples that you might add to your memory.properties file:
defaultScriptMaxMem=2560m
defaultScriptPermGenMem=512m
__ Planned
__ Started
__ Completed
__ Not applicable
Legacy Business Objects Reports
If upgrading from Release 14.4 or older to a newer 15.x release, no legacy SAP Business Objects or Xcelsius functionality is supported. All legacy Business Objects content is removed as part of the upgrade process for both on-premise and SaaS environments.
Recommended Action:
Migrate any legacy SAP Business Objects content that you want to keep before you start the upgrade process.
IMPORTANT
: In a SaaS upgrade from 14.x to 15.x, any legacy Business Objects reporting content is permanently destroyed.
: As a reminder, new releases of CA PPM include Advanced Reporting dashboards, views, and trending capabilities.
__ Planned
__ Started
__ Completed
__ Not applicable
Avoid Making Configuration Changes During the Upgrade
As a risk mitigation requirement, a stable configuration is mandatory during the upgrade cycle.
Required Action:
  1. Complete all your configuration changes, finish any processes or jobs, and migrate any data to the production environment prior to starting the upgrade cycle.
  2. Do not make any changes during the upgrade cycle.
  3. If a critical need arises that requires a change during the upgrade, notify your upgrade team. As a SaaS administrator, contact CA support and enter a new ticket to see what can be done. Do not make any changes yourself.
: Failure to follow this best practice can cause your production upgrade to fail or deviate from previous test environment results.
__ Planned
__ Started
__ Completed
__ Not applicable
As an administrator for an on-prem environment, in addition to the steps above, follow these additional steps:
Activity:
Status:
Run the Installation Checker
The Installation Checker (checkinstall) utility assesses an installation or an upgrade.
  • The utility runs automatically at the start of an installation or upgrade and at the end of an upgrade attempt.
  • You can also run it manually.
  • The utility produces a report results file (precheck-results.html) in the <install-root>/checkinstall/check-logs directory.
For best results, run the Installation Checker before starting the full installation or upgrade process. Carefully evaluate and resolve warnings before proceeding.
Required Action
:
  1. Extract the 
    Clarity PPM
     installer to the 
    Clarity PPM
     application server.
  2. Open a command prompt and navigate to the checkinstall directory located in the directory to which you extracted the installer.
  3. Invoke the checkinstall command:
    UNIX
    : sh checkinstall.sh
    Windows
    : checkinstall.bat
    You are asked for the Operator Username and Operator Email. This information refers to the user who is upgrading or installing and the email of the user. This information is stored as a record in the installation log.
  4. Verify the results. The results contain any warnings and errors and also indicate any customizations that you have made.
  5. Review the customizations and make adjustments as necessary before you start the upgrade.
__ Planned
__ Started
__ Completed
__ Not applicable
Checkinstall Script Workaround for Linux
The Checkinstall script for Linux contains DOS end of file characters and does not execute correctly.
Before planning an upgrade, we recommend that you run the checkinstall script to verify that all the pre-upgrade requirements are met. When you run checkinstall.sh on a Linux system, the script does not execute and produces an
unexpected end of file
 syntax error.
Workaround: Convert the Script to Unix Format
  1. Convert the checkinstall.sh script to Unix format by running dos2unix:
    # dos2unix ./checkinstall.sh
  2. Run checkinstall again:
    # sh ./checkinstall.sh
Alternately, you can use the following perl script to run checkinstall successfully:
 
perl -i -pe 'y|\r||d' checkinstall.sh
__ Planned
__ Started
__ Completed
__ Not applicable
Make Third-Party JAR Files Accessible to the Installer
Because of licensing restrictions for some third-party library JAR files (jgroups-all.jar and xinclude.jar), these files are shipped separately from the CA PPM ISO installer image. The
install.jar
image does not contain the files mentioned. Any install packages for a previous version included in the
install.jar
also exclude the JAR files.
Required Action
: For each release of CA PPM, the JAR files are bundled into a folder on the installation media containing the third-party libraries JAR file. For example, for CA PPM Release 15.x, the file is named 
thirdparty.libs.15.x.0.jar
.
  1. Retrieve the 
    thirdparty.libs.15.x.0.jar
     file from the installation media.
  2. Place the JAR file in a location in your file system so that it is accessible to the installer.
: To prevent the installer from prompting you for the file location, place the JAR file in the installation root directory. If you place the JAR file in another directory, the installer prompts you for the file location.
__ Planned
__ Started
__ Completed
__ Not applicable