Install the APM Add-In

 The APM add-in is included with cappm and is ready to install. 
 The APM add-in is included with 
Clarity PPM
 and is ready to install. 
  • The required version of the PMO Accelerator is a prerequisite for the APM add-in. Upgrade the PMO Accelerator before installing the APM add-in. See the APM Add-in Release Notes for the required version of the add-in for your 
    Clarity PPM
  • Verify that you have already installed and configured the Data Warehouse. See Install and Configure the Data Warehouse for details. The APM add-in includes items that are based on the Data Warehouse schema. If the Data Warehouse schema is unavailable, installation of the add-in is unsuccessful.
! We recommend that you back up the existing 
Clarity PPM
 installation directory and database before you install the add-in. A backup allows you to restore the application to the prior version, if necessary. After you install the add-in, you cannot uninstall it.
Install the APM Add-In
To enable the APM content, install the APM add-in on your 
Clarity PPM
 application server.
Follow these steps:
  1. Stop the services
    . Before you install the add-in, stop the 
    Clarity PPM
     application (app) and background (bg) services from 
    Clarity PPM
     System Administration (CSA).
  2. Execute the install script
    . The script installs APM lookups, queries, portlets, pages, views, and database objects.
    1. Open a command prompt and navigate to the 
      Clarity PPM
       runtime bin directory.
    2. Enter the following command: 
      admin content apm
      The installation process begins and information displays on the page. The information is captured and stored in the admin.log file that is saved in the logs directory. The output files are stored in the logs/content/xog/apm directory.
    3. Review the installation process output and the logs for important information after the installation completes.
  3. Start the Services
    . After you install the add-in, start the 
    Clarity PPM
     Application (app) and 
    Clarity PPM
     Background (bg) services from CSA.
: To learn more about stopping and starting services in CSA, see CSA: CA PPM System Administration
Install the APM Add-in Content Items
Install the APM add-in items after you install the APM add-in for the first time. 
Follow these steps:
  1. Log in to 
    Clarity PPM
  2. Open Administration, and from Studio, click Content Add-ins.
  3. Click the List icon for the Application Portfolio Management add-in (ID: apm). 
    The Content Add-In Items List page appears.
  4. Review the following items in the list and select the items that are
    Upgrade Ready
    • Application Object Filter View
    • Application Object List View
    • Application Object Property Views
      Use the Status filter that is available on this page. The Status indicates if the add-in item is installed in 
      Clarity PPM
      • Not Installed: 
        Items that are new to the add-in version or items that produced an error upon install. When the APM add-in is not upgraded after upgrading from a previous 
        Clarity PPM
         release, several items show as Not Installed and an alert message instructs you to install the add-in. Install the add-in to change the status of these items.
      • Upgrade Ready: 
        Items that you installed from a previous add-in version that contain updates to the items in the current add-in version. Also, views that were updated through the add-in that you also modified through Studio.
      • Installed: 
        Items that are installed.
        If you previously configured Studio Application object views, the configurations are preserved and are not overwritten during installation. You can decide which views to install by selecting them.
         Consider the configurations that you made to items before you install them. Installing modified items overwrites your configurations.
  5. Select the items that you want to install and click Install.
    The items that you selected appear on the Confirm Content Item Installation page. If selected items have dependencies on other items, the dependent items also appear on the page and must be installed.
  6. Click Yes to update or install the items.
    If a user previously changed an item that is listed on the confirmation or installation page, publish the item before displaying the update to users. For more information, see 
    Clarity PPM
     Studio Development
Import the Jaspersoft Advanced Reporting Content for APM
You can import the Jaspersoft Advanced Reporting content for APM. This process imports reports, input controls, localization bundles, images, and data sources.
This content is imported into the organization name that is specified in the 
Clarity PPM
 System Administration (CSA) Reporting subtab.
Verify that the following prerequisites have been met:
  • Specify the organization name, organization ID, and the user in the CSA Reporting subtab before you import the Jaspersoft Advanced Reporting content.
  • Verify that you have upgraded to the required PMO Accelerator for your release. Import the PMO Accelerator Jaspersoft Advanced Reporting content before importing the Jaspersoft Advanced Reporting content that is available with the APM add-in.
  • Set up Advanced Reporting in Jaspersoft and
    Clarity PPM
    . For more information, see 
    Installing and Upgrading
The import creates the following items:
  • Application Management subfolder under the Reports folder in the organization repository
  • Application Management reports
  • Entry for the Jaspersoft content in the Install History table (CMN_INSTALL_HISTORY)
Follow these steps:
  1. Open a command prompt and navigate to the 
    Clarity PPM
     runtime bin directory.
  2. Enter the following command: 
    admin content-jaspersoft apm -userName superuser -password <password>
    The import process begins and the import information is stored in the admin.log. The import process requires the superuser user.
  3. Review the admin.log for important information after the import completes.
  4. Open Administration, and from Studio, click Content Add-ins.
  5. Click the Application Portfolio Management add-in (ID: apm). 
    The Content Add-In Accelerator:  Application Portfolio Management - Properties page appears.
  6. Review the Jaspersoft Content Installed Date included in the Versions section of this page.