Add-Ins and Integrations

Learn more about how you can extend the functionality of
Clarity
.
ccppmop1591
HID_addins_and_connectors
To extend product functionality, you can install optional content add-ins (PMO, APM, EVM, NPD, PMBOK, and PRINCE2) and configure integrations with
Rally
, CA Open Workbench, Microsoft Project, and CA SSO.
Classic PPM
platform offers a comprehensive set of integration options to work with data from multiple sources. As shown in the following image, you have the flexibility to integrate with the right solution for your business.
Extend
Classic PPM
functionality with optional add-ins and integrations
Extend Clarity> functionality with optional add-ins and integrations
You can extend the functionality of
Classic PPM
by installing one or more of the available add-ins that are included with the product. Add-ins are included with the product and are ready to be installed. You do not need to download separate add-in installation image files.
The following image describes how a system administrator installs an add-in.
This image shows the steps for installing an add-in
This image shows the steps for installing an add-in
Additional licensing and fees may apply to procure additional software.
The Microsoft Project (MSP) and Open Workbench (OWB) documentation appears in the
Using
section under
Project Management
. This documentation is available only in English. These optional scheduling programs are available to help you work with projects, tasks, and other work items.
Install an Add-in
Thoroughly review and follow the documentation.
Review the Prerequisites
  • Back up the file system and database before installing an add-in. You can use the
    admin backup
    command to take a backup of the file system. This precaution ensures that you can restore the application, if necessary.
  • Each add-in delivers a specific solution. Although you can install more than one add-in, the resulting system configuration will be a combination of different solutions. In this case, additional configuration in Studio might be necessary to make the new system configuration useful.
  • As a precaution, install an add-in a test environment before you install it into your production environment. The test environment allows you to see the system configuration changes that an add-in produces.
  • Installing and applying an add-in can change the views for objects such as projects. If your organization uses customized views, install in a test environment to review the results and make more Studio configurations if necessary.
  • To verify that the add-in that you are installing or upgrading works with your product version, review the required versions for add-ins, integrations, and other compatible software in the Release Notes.
  • Beginning with Release 15.3, the APM and PMO add-ins require the data warehouse. These add-ins include Jaspersoft Advanced Reporting content items. Before you install the PMO or APM add-ins in Release 15.3, verify that you have already installed the data warehouse. See
    Install and Configure the Data Warehouse
    in the English edition of the documentation. These add-ins include items that are based on the data warehouse schema. If the data warehouse schema is unavailable, the add-ins won't work. If the installation or upgrade script for these add-ins does not detect the data warehouse, it cannot continue and exits.
  • After you install an add-in, you cannot uninstall it.
Stop the Services
Stop the
Classic PPM
Application (app) and
Classic PPM
Background (bg) services before installing an add-in.
Follow these steps:
  1. From the command prompt, navigate to the
    bin
    folder in the
    Classic PPM
    home directory.
  2. Enter the following command:
    service stop app bg
  3. If there are cloned services (app2, app3, bg2, bg3, and so on), add those service IDs to the command or use the following command:
    service stop all
Install the Add-in
The following table contains the add-in installation IDs that are required for the installation process.
Add-in
Installation ID
Application Portfolio Management
apm
Rally Integration
agl
Earned Value Manager
evms
New Product Development (NPD) Accelerator
npd
PMBOK® Guide Accelerator
pbk
PMO Accelerator
csk
PRINCE2™Accelerator
pr2
Follow these steps:
  1. From the command prompt, navigate to the
    bin
    folder in the
    Classic PPM
    home directory.
  2. Enter this command: admin content <id>
    The installation process begins and information appears on the screen. The information is captured and stored in the admin.log file in the
    logs
    directory.
  3. Review the screen output and the logs for important information after the installation completes.
Start the Services
Follow these steps if all services use Apache Tomcat as the
Classic PPM
app server, running on a single server.
Follow these steps:
  1. From the command prompt, navigate to the
    bin
    folder in the
    Classic PPM
    home directory.
  2. Enter this command:
    service start app bg
  3. If there are cloned services (app2, app3, bg2, bg3, and so on), add those service IDs to the command or use this command:
    service start all
  4. If you have only one server, you are finished here. If you have multiple servers, log in to CSA and continue with the following steps.
  5. Open Home and click All Services.
  6. Clear the check box for any remote app and bg services.
  7. Open the Distribution menu, and click Distribute All.
  8. Select the remote servers and click Distribute.
    Wait until the distribution is complete before continuing.
  9. Open Home, and click All Services.
  10. Select the
    Classic PPM
    Application (app) and
    Classic PPM
    Background (bg) service checkboxes, and click Start.
Apply the Add-in Content Items (Upgrades Only)
For upgraded add-ins, you apply the add-in content items after the installation. To apply the add-in, review the add-in items in the product, then select and apply the upgrade ready or uninstalled items.
Follow these steps:
  1. Log in to
    Classic PPM
    .
  2. Click
    Administration
    ,
    Studio
    ,
    Content Add-ins
    .
  3. Click the name of the newly installed add-in.
  4. Review the existing configurations carefully before you apply the new or changed content.
    Previously configured views are not overwritten during the installation. From this page, you can select which new or updated views to apply. Applying a Studio object overwrites the existing configuration of that Studio object's views.
  5. Click the
    Items
    tab.
    By default, the items that are new or modified are pre-selected. Clear the checkbox for any that you do not want to apply.
  6. Select the items that are marked
    Upgrade Ready
    or
    Not Installed
    that you want to upgrade to the new version.
  7. For all active process instances that display the
    Upgrade Ready
    status, cancel and delete the process instances.
  8. Click
    Install
    .
    A confirmation page displays the list of selected and required dependent items.
  9. Click
    Yes
    to apply the add-in items.
If a user previously personalized an item that is listed on the confirmation page, publish the item to push the update to all users.
More Information
: