Add-Ins and Integrations

Learn more about how you can extend the functionality of CA PPM.
ccppmop142
HID_addins_and_connectors
To extend product functionality, you can install optional content add-ins (PMO, APM, EVM, NPD, PMBOK, PRINCE2, and SharePoint) and configure integrations with 
CA Agile Central
, CA SSO, CA Open Workbench, or Microsoft Project. The CA 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 CA PPM functionality with optional add-ins and integrations
Extend CA PPM functionality with optional add-ins and integrations
You can extend the functionality of CA 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
. These optional scheduling programs are available to help you work with projects, tasks, and other work items.
 
Install an Add-in
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 can 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 Add-ins Compatibilities in the Release Notes (On Premise).
  • In Release 15.3, the APM and PMO add-ins require the data warehouse. If you are installing the PMO or APM add-ins in Release 15.3, verify that you have already installed the data warehouse. 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.
  • After you install an add-in, you cannot uninstall it.
Stop the Services
Stop the 
Clarity Project and Portfolio Management (PPM)
 Application (app) and 
Clarity Project and Portfolio Management (PPM)
 Background (bg) services before installing an add-in.
Follow these steps:
  1. From the command prompt, navigate to the 
    bin 
    folder in the 
    Clarity Project and Portfolio Management (PPM)
     home directory.
  2. Enter the following command:
    service stop app bg
    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
Business Relationship Manager
bupAddIn
Clarity Solution Pack1
csp
Earned Value Manager
evms
Integration Adaptor
iad
New Product Development (NPD) Accelerator
npd
PMBOK® Guide Accelerator
pbk
PMO Accelerator
csk
PPM Essentials Accelerator
odmd
PRINCE2™Accelerator
pr2
Service Connect
scremedy
Unicenter Asset Portfolio Management
uapm
Connector for CA Unicenter® Service Desk & CA Software Change Manager for Distributed
cai
VersionOne Connector
pl_remote_v1
1: The Clarity Solution Pack (CSP) is supported only for existing customers. This add-in is not supported with new installations.
Follow these steps:
  1. From the command prompt, navigate to the 
    bin 
    folder in the 
    Clarity Project and Portfolio Management (PPM)
     home directory.
  2. Enter this command:
    admin content <id>
    The installation process begins and information displays on the screen. The information is captured and stored in the admin.log file that is located in the 
    logs
     directory.
  3. Review the screen output and the logs for important information after the installation completes.
Start the Services (Tomcat)
Follow these steps if all services use Apache Tomcat as the 
Clarity Project and Portfolio Management (PPM)
 app server, running on a single server.
Follow these steps:
  1. From the command prompt, navigate to the 
    bin 
    folder in the 
    Clarity Project and Portfolio Management (PPM)
     home directory.
  2. Enter this command:
    service start app bg
    : 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
  3. If you have multiple servers, log in to 
    Clarity Project and Portfolio Management (PPM)
     System Administration (CSA) and continue with the following steps.
  4. Open Home and click All Services.
  5. Clear the check box for any remote app and bg services.
  6. Open the Distribution menu, and click Distribute All.
  7. Select the remote servers and click Distribute.
    Wait until the distribution is complete before continuing.
  8. Open Home, and click All Services.
  9. Select the 
    Clarity Project and Portfolio Management (PPM)
     Application (app) and 
    Clarity Project and Portfolio Management (PPM)
     Background (bg) service check boxes, and click Start.
Start the Services (IBM WebSphere)
Follow these steps if all services use IBM WebSphere as the CA Clarity application server.
Follow these steps:
  1. Log in to CA Clarity System Administration.
  2. Open the Installation menu, and click Install and Upgrade.
  3. Click Package Application Ear.
  4. Click Create Package.
    The application creates a package and the niku.ear.
  5. At the command prompt, run the following command:
    admin general upload-all-config
  6. Deploy the (niku.ear) package using the J2EE application server administration console.
 
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 
    Clarity Project and Portfolio Management (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 view configuration for the object.
  5. Click the Items tab.
    By default, the items that are new or modified are preselected. Clear the check box for any that you do not want to apply.
  6. For all active process instances that display the Upgrade Ready status, cancel and delete the process instances.
  7. Select the items that are marked 
    Upgrade Ready
     or 
    Not Installed
     that you want to upgrade to the new version.
  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.
End-of-Life (EOL) Announcement for Select CA PPM Add-ins
Originally Published
: June 30, 2015
EOL Date
: June 30, 2016
  • Business Relationship Manager (BRM)
  • Catalyst Connector
  • Connector for Unicenter Asset Portfolio Manager
  • Connector for Unicenter Service Desk and Software Change Manager
  • PPM Essentials Accelerator
  • Service Connect
: Documentation for these EOL add-ins is still available on the CA PPM Support site in on-premise and SaaS editions. (The Release 14.2 documentation bookshelf with HTML and PDF content appears. Valid ca.com registration and login required.)
In order to focus our development efforts and to help our customer base achieve their strategic business initiatives, we are investing our resources in new technology and software and will be dropping support for select content add-ins. Some of this content was found in the CA Clarity PPM for IT Governance product option; however, that solution has also reached its end-of-life (EOL) milestone.
Add-in content will no longer be enhanced and maintenance and technical support will be discontinued beginning June 30, 2016. After June 30, 2016 in accordance with our EOL policies, CA Technologies will continue to provide self-service support until the expiration of your current contractual support period. The add-ins are content offerings, not product functionality; therefore, when they reach EOL we do not offer functional alternatives. Existing customers may continue to leverage the content, but it will not be available for new customers.
  • A new customer installing future releases will not get these add-ins.
  • Existing customers upgrading to future releases will not get new versions of the add-ins.
  • Existing customers will have whatever version of the content they previously installed before upgrading.
  • Future releases will not include new versions of the add-ins.
Customers may continue to use these add-ins in production and non-production environments after their EOL dates. However, after June 30, 2016, CA Technologies will no longer provide any fixes, patches, service packs, updates, upgrades, programmatic changes, new features, or coverage for updated or new operating systems, databases, browsers, or any additional components.
If you have any questions regarding the support schedule or our technical support policies, contact CA PPM Support.
Your success is very important to us, and we look forward to continuing our successful partnership with you.