Administrating › How to Integrate CA Clarity™ Agile with CA Clarity™ PPM

How to Integrate CA Clarity™ Agile with CA Clarity™ PPM

As a system administrator, you can integrate Version One with CA Clarity™ PPM. Using this integration, product owners can create and manage requirements in an agile environment while adhering to the traditional project governing process.

The integration allows the following capabilities:

• Create and manage CA Clarity™ Agile products and users from CA Clarity™ PPM.
• Associate the requirements in CA Clarity™ Agile with CA Clarity™ PPM tasks.
• Build the CA Clarity™ PPM work breakdown structure (WBS) from Agile sprints, kanban, user stories, and tasks.
• Auto-populate CA Clarity™ PPM timesheets using CA Clarity™ Agile task worklogs.
• Download the roles from CA Clarity™ PPM for use in CA Clarity™ Agile.
• Synchronization jobs can run in the background at predefined intervals to transfer information between CA Clarity™ Agile and CA Clarity™ PPM.

The following diagram describes how a system administrator can integrate CA Clarity™ Agile with CA Clarity™ PPM.

To integrate CA Clarity™ PPM with CA Clarity™ Agile, follow these steps:

1. Review the prerequisites.
2. If integrating with CA Clarity™ PPM Release 13.2.00 or above, do the following steps:
   1. Deploy CA Clarity™ Agile Add-in.
   2. Go to Step 7.
3. Download and extract the CA Clarity™ Agile add-in.
4. Stop the CA Clarity™ PPM services.
5. Install the add-in.
6. Configure the add-in on CA Clarity™ PPM.
7. Configure the Agile Setup Page on CA Clarity™ PPM.
8. Set up data transfers from CA Clarity™ PPM.
9. Review the project integration status.

Review the Prerequisites

Before you integrate CA Clarity™ Agile with CA Clarity™ PPM, ensure that CA Clarity™ Agile license is available.

Deploy CA Clarity™ Agile Add-in

For CA Clarity™ PPM Release 13.2 and above, the CA Clarity™ Agile add-in files are included in the installation. Any updates to add-ins are delivered with CA Clarity™ PPM updates. You execute a command to deploy CA Clarity™ Agile add-in.

Follow these steps:

1. Open a command prompt and navigate to the CA Clarity™ PPM runtime bin directory.
2. Enter the command:

   admin content avee
   

3. 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.
4. Review the screen output and the logs for important information after the installation completes.

The add-in is deployed and you can see the Agile subpage on CA Clarity™ PPM. After you complete the installation, configure CA Clarity™ PPM and set up data transfers to complete the integration.

Download and Extract the CA Clarity™ Agile Add-In

For CA Clarity™ PPM 13.1.x or earlier releases, you can download the required files from support.ca.com to your computer or an accessible network location. The files contain the required installation scripts CA Clarity™ Agile add-in.

Follow these steps:

1. Log in to www.support.ca.com using your CA email address and password.
2. Click Download Center from the Support menu.
3. Select the following product information and click Go:
   • CA Clarity PPM Integration with CA Clarity Agile - FORCE.COM
   • Release 5.0
   • Gen level 0000
4. From the Product Components section download and unzip the GEN10091324M.zip file.
5. Copy the following files to the <Clarity installation directory>/lib directory on the CA Clarity™ PPM application server.

   avee.1.8.0.0205.v12.jar

   For v12 CA Clarity™ PPM

   avee.1.8.0.0205.v13.jar

   For v13 CA Clarity™ PPM

   The .jar file includes the following files:

   installation script

   The .jar file iX installation script.

   install.bat

   The Windows installation script.

   install.xml

   The Ant installation script includes the following files:

   install.sh

   The UNIX installation script.

   package

   The directory of updated files.

   tools

   The directory of supporting files.

Stop the CA Clarity™ PPM Services

Before you install the add-in, stop the CA Clarity™ PPM application (app) and background (bg) services to avoid any problem.

Follow these steps:

1. Log in to Clarity System Administration (NSA).
2. Stop the CA Clarity™ PPM application (app) and background (bg) services.

Install the Add-in

After you have stopped the CA Clarity™ PPM application and background services, Install the add-in to update the objects, reports, and database.

Important! Back up your CA Clarity™ PPM installation before installing this add-in so that you can restore the application to the prior version if necessary. When you install an add-in, you can overwrite your customized views for out-of-the-box CA Clarity™ PPM objects, such as projects. If your organization has customized views, carefully consider the installation in a test environment before installing this add-in into your production environment. Once you have installed the add-in, you cannot uninstall it.

Follow these steps:

1. Open a command prompt window in the directory where you extracted the .jar files and provide the following command:

   install
   

2. Press Enter.
3. Follow the on-screen directions and complete the add-in installation.

Configure the Add-in on CA Clarity™ PPM

You can configure the CA Clarity™ Agile add-in on CA Clarity™ PPM, so that the add-in subpages are available on CA Clarity™ PPM. You can follow one of the following instructions:

• Configure a new installation of CA Clarity™ Agile add-in.
• Configure CA Clarity™ Agile add-in upgrade.

Configure a New Installation of CA Clarity™ Agile Add-in

For a fresh installation of CA Clarity™ Agile add-in for CA Clarity™ PPM, you can use the following instructions to configure.

Follow these steps:

1. Log in to Clarity System Administration (NSA).
2. Restart the CA Clarity™ PPM application (app) and background (bg) services.
3. Log in to the CA Clarity™ PPM application.
4. Click Administration, and from Studio, click Objects.
5. Filter using the Object Name as Project.

   The objects list appears.

6. Click the Project object and click the Views tab.
7. Click the Layout: Edit link for the Project Properties view.

   The property layout appears.

8. Expand the Agile project properties and then expand the Integration Status section.
9. Click the Properties and Layout icon for the Integration Status section.

   The section properties and layout appear.

10. Change the layout, and click Save and Return.
11. Click Back to return to the object definition view.
12. Click Publish to publish the view.
13. Click Yes to confirm publishing the view.
14. Click Home, and from Personal, click Reports and Jobs.
15. Select Scheduled Jobs from the Jobs tab.
16. Reschedule the following jobs to run at the predefined levels:
    • Agile Product Sync
    • Agile Worklog Sync
    • Agile Requirement and Task Mapping Sync
    • Agile Role Sync
17. Click Administration, and from Data Administration, click Processes.

    The available processes list appears.

18. Click Agile Fields Locking process, and click Validation tab.
19. Select all the validation objects, and click Validate All and Activate.

    When validation completes, the status of the objects changes to Validated and mode changes to Active.

20. Repeat steps 18 and 19 for the following processes:
    • Create Agile Requirement Mapped Task
    • Populate Agile Task Types
    • Agile Sync Project and Task Information
21. Restart the Clarity app and bg services.

Configure the CA Clarity™ Agile Add-in Upgrade

If you are upgrading CA Clarity™ Agile add-in for CA Clarity™ PPM, you can use the following instructions to configure.

Follow these steps:

1. Log in to Clarity System Administration (NSA).
2. Restart the CA Clarity™ PPM application (app) and background (bg) services.
3. Log in to the CA Clarity™ PPM application.
4. Click Home, and from Personal, click Reports and Jobs.
5. Select Scheduled Jobs from the Jobs tab.
6. Delete the following scheduled jobs and ensure that there are no running instances of the following jobs:
   • Agile Product Sync
   • Agile Timesheet Sync
   • Agile Requirement and Task Mapping Sync
   • Agile Role Sync
7. Click Organizer from Home.
8. Click Initiated from the Processes tab.
9. Select the following processes and click Cancel Process:
   • Agile Fields Locking
   • Create Agile Requirement Mapped Task
   • Populate Agile Task Types
   • Agile Sync Project and Task Information
10. Click Add-Ins from Studio.
11. Click Agile.
12. Select all and click Apply.
13. Click Yes and wait for the process to complete.

    The Add-In Details page shows the status for all the items as installed.

14. Click Administration, and from Data Administration, click Processes.

    The available processes list appears.

15. Click Agile Fields Locking process, and click Validation tab:
16. Select all the validation objects, and click Validate All and Activate.

    When validation completes, the status of the objects changes to Validated and mode changes to Active.

17. Repeat steps 15 and 16 for the following processes:
    • Create Agile Requirement Mapped Task
    • Populate Agile Task Types
    • Agile Sync Project and Task Information
18. Click Administration, and from Studio, click Objects.
19. Filter using the object name as Project.

    The objects list appears.

20. Click open the Project object.
21. Click the Attributes tab, and click Linked to Agile.
22. Clear Presence Required check box, and click Save and Return.
23. Click the Views tab, and click [Fields] for the Project Properties.

    The Project Properties - property fields displays.

24. Change the property label of Linked to Agile and Requirements to Linked to Agile.
25. Click Save and Return.

    The object definition view appears.

26. Click Attributes, and click Linked to Agile.
27. Select Presence Required, and click Save and Return.
28. Click Views, and click Publish.

    A confirmation prompt appears.

29. Click Yes to confirm publishing the view.
30. Reschedule the following jobs to run at the predefined levels:
    • Agile Product Sync
    • Agile Timesheet Sync
31. Restart the Clarity app and bg services.

Configure the Agile Setup Page on CA Clarity™ PPM

You can set up CA Clarity™ PPM to link to CA Clarity™ Agile, so that they can communicate and transfer data. After you install the CA Clarity™ Agile add-in, and before starting the background services, you can edit the URL that CA Clarity™ PPM uses to access Salesforce.com. The default URL points to the regular environment. You can create a Sandbox environment for CA Clarity™ Agile and can change the URL to allow the add-in to access the Sandbox environment instead.

Note: Change the URL only if you want to access a CA Clarity Agile Sandbox environment. Perform this step only if you have configured a sandbox environment. See the Salesforce.com Help & Training for more information.

Follow these steps:

1. Log in to the CA Clarity™ PPM and access the Administration Tool.
2. Click Administration, and from General Settings, click Agile Setup.

   The Agile Admin Settings page appears.

3. Complete the following fields in the Agile Login Info section:

   User Name

   Defines the user name to login to CA Clarity™ Agile with system administrator privileges.

   Password

   Defines the password to login to CA Clarity™ Agile with system administrator privileges.

   Security Token

   Defines the security token used for server identification in case the login fails or if the CA Clarity™ PPM server is running from an untrusted network. You can retrieve this token from SalesForce.com from the Personal Setup Page. See the SalesForce.com online help for more information.

   Agile Environment URL

   Specifies the URL that CA Clarity™ PPM uses to access the CA Clarity™ Agile production or sandbox environment.

   Production Environment

   https://login.salesforce.com/services/Soap/u/27.0
   

   Test Environment

   https://test.salesforce.com/services/Soap/u/27.0
   

   Agile URL

   Specifies the URL that CA Clarity™ PPM uses to access the requirements list in CA Clarity™ Agile.

   Important! Do not change the default URL.

4. (Optional) Complete the following fields in the Proxy Server Info section:

   Host Name

   Defines the proxy server host name.

   Port

   Defines the proxy server port.

   User Name

   Defines the proxy server user name.

   Password

   Defines the proxy server password.

5. Save your changes.

Set Up Data Transfers from CA Clarity™ PPM

To set up data transfers, specify the CA Clarity™ Agile product details in a CA Clarity™ PPM project that you have associated. The following tasks show how to set up data transfers:

• Link CA Clarity™ Agile Product and Release with CA Clarity™ PPM by one the following methods:
  • Create a product and release from CA Clarity™ PPM.
  • Link to an existing product and release in CA Clarity™ Agile.
  • Create a release in an existing CA Clarity™ Agile product.
• Map CA Clarity™ Agile task types to CA Clarity™ PPM charge codes.
• Link CA Clarity™ PPM tasks with CA Clarity™ Agile.
• Update Roles in CA Clarity™ Agile from CA Clarity™ PPM

The following rules apply for linking projects between CA Clarity™ PPM and CA Clarity™ Agile:

• If you specify a product ID and a release name but leave the release ID blank, a new release is created for the specified product.
• If you specify both product and release IDs and names, the names are ignored and the IDs are used for linking to an existing product.
• The CA Clarity™ PPM project description is added as the description for the product or release when creating a product or release. A superuser can change this description, and can avoid having it overwritten from CA Clarity™ PPM.
• If you leave all the fields blank, the synchronization job fails and nothing is created or linked in CA Clarity™ Agile.

Best Practice: To link a CA Clarity™ PPM project to CA Clarity™ Agile, verify the following prerequisites:

• The option for automatic creation of effort tasks is turned off.
• No tasks currently exist in the CA Clarity™ PPM project.

Create a Product and Release from CA Clarity™ PPM

You can create a project in CA Clarity™ PPM, and specify the product name and release name in the project. When the synchronization job runs, a release in CA Clarity™ Agile is created.

Follow these steps:

1. Log in to CA Clarity™ PPM.
2. Select Projects from the Portfolio Management menu.

   The projects list page appears.

3. Click New to create a project, complete the required fields, and click Save.

   The properties page appears.

4. Select the Linked to Agile check box, and click Save.

   The Agile and Agile Task Type Mapping options become available in the Properties menu.

5. Click Properties, and from General, click Agile.

   The Agile properties page appears.

6. Complete the following fields:

   Agile Product Name

   Defines the name of the new CA Clarity™ Agile product you want to create.

   Agile Release Name

   Defines the name of the new CA Clarity™ Agile release you want to create.

   Product Prefix

   Defines a unique prefix to add to the product name for the user stories and tasks. You cannot change the prefix after the product is created.

   Limits: 6 characters

   Note: Leave the following fields blank: Agile Product ID and Agile Release ID.

7. Submit your changes.

   After the Agile Product Sync job runs, the following fields are automatically populated in CA Clarity™ PPM. The new product and release is created in CA Clarity™ Agile:

   Agile Product ID

   Displays the Agile product ID. This value is automatically populated from CA Clarity™ Agile.

   Source: The Product ID field on the Product Detail page on CA Clarity™ Agile.

   Agile Release ID

   Displays the Agile release ID. This value is automatically populated from CA Clarity™ Agile.

   Source: The Release ID field on the Release Detail page on CA Clarity™ Agile.

Link to an Existing Product and Release

You can link an existing CA Clarity™ Agile product and release to a CA Clarity™ PPM project by specifying the product ID and release ID. You can link to a product release or a master release. Link to a master release to see all the user stories and tasks that are assigned to the master release in CA Clarity™ PPM.

Follow these steps:

1. In CA Clarity™ PPM, open a project that you want to associate with Agile product.

   The project properties appear.

2. Select the Linked to Agile checkbox and click Save.
3. Click Properties, and from General, click Agile.

   The Agile properties page appears.

4. Complete the following fields:
   • If you are linking to a product release define the Agile Product ID and the Agile Release ID
   • If you are linking to an existing master release define the Agile Master Release ID. This value is used to link this project to an existing master release in CA Clarity™ Agile. If the link is established successfully, this field becomes display-only.

     Source: Master Release ID field on the Master Release Detail page in CA Clarity™ Agile.

   Note: Leave the following fields blank: Agile Product Name, Agile Release Name, and Product Prefix.

5. Submit your changes.

   After the Agile Product Sync job runs, the following fields are automatically populated in CA Clarity™ PPM:

   • Agile Product Name
   • Agile Release Name
   • Product Prefix

Create a Release in an Existing Product

Create a release in an existing CA Clarity™ Agile product by specifying the product ID and release name in the CA Clarity™ PPM project. Leave the release ID, product name, and product prefix values undefined.

Follow these steps:

1. In CA Clarity™ PPM, open the project and associate it with CA Clarity™ Agile by selecting the Linked to Agile checkbox and clicking Save.

   The project properties appear.

2. Click Properties, and from General, click Agile.

   The Agile properties page appears.

3. Complete the following fields:
   • Agile Product ID
   • Agile Release Name

   Note: Leave the following fields blank: Agile Release ID, Agile Product Name, and Product Prefix.

4. Submit your changes.

   After the Agile Product Sync job runs, the following fields are automatically populated in CA Clarity™ PPM:

   • Agile Release ID
   • Agile Product Name
   • Product Prefix

Map CA Clarity™ Agile Task Types to CA Clarity™ PPM Charge Codes

If you have assigned charge codes to your project tasks in CA Clarity™ PPM, you can map these charge codes to the CA Clarity™ Agile task types. Mapping the task types to charge codes allows you to assign appropriate charge codes to actuals on linked tasks. A project manager can map task types to charge codes and run the Populate Agile Task Types process, if they have the following global and instance access rights:

• Task Type and Charge Code Mapping - Create
• Task Type and Charge Code Mapping - Edit All
• Process - Start

Best practices:

• If you accidentally delete charge code mappings, run the Populate Agile Task Types process manually to retrieve the deleted mappings.

  See the CA Clarity™ PPM Administration Guide for more information.

• You can map a task type to only one charge code. If no task type is defined for a task in CA Clarity™ Agile, you can assign the Default charge code to it in CA Clarity™ PPM.

If you have a new task type in CA Clarity™ Agile, create a new charge code in CA Clarity™ PPM and map the new task type to the charge code.

Follow these steps:

1. In CA Clarity™ PPM, click Administration, and from Project Management, click Charge Codes.
2. Click New and complete the required fields.
3. Save your changes.

   New Charge code is created.

After you have created a charge code, you can map it to the CA Clarity™ Agile task type.

Follow these steps:

1. In CA Clarity™ PPM, open the linked project.

   The project properties appear.

2. Click Agile Task Type Mapping from Properties.

   The Agile Task Type Mapping page for the project appears.

3. Click New.

   The Create Agile Task Type and Charge Code Mapping page appears.

4. Complete the following fields and submit:

   Task Type

   Defines the CA Clarity™ Agile task type for a task.

   Charge Code

   Defines the CA Clarity™ PPM charge code for the same task.

5. Save your changes.

The CA Clarity™ PPM charge code is successfully mapped to the CA Clarity™ Agile task type.

Link CA Clarity™ PPM Tasks with CA Clarity™ Agile

You can link multiple tasks to a single requirement, and you can link multiple requirements to a single task.

Follow these steps:

1. In CA Clarity™ PPM, open the linked project.

   The project properties appear.

2. Click the Tasks tab and click Gantt.
3. Locate the task and click the icon in the Mapped Requirements column.

   The Mapped Task: Properties page appears with the Agile Requirement and Task Mapping List option selected in the menu.

4. Click New.

   The Create Agile Requirement and Task Mapping page appears.

5. Click the Browse icon and select a CA Clarity™ Agile requirement to map to the task.
6. Click Save and Return.

   The Mapped Task: Properties page appears with the requirement listed.

   Note: After the requirement is added to the task, populate the requirement list with the CA Clarity™ Agile requirement information. If the list is empty, refresh the page.

7. Choose one of the following options:
   • Click New to map another requirement to the task.
   • Click Return to return to the Work Breakdown Structure.

   CA Clarity™ Agile is updated with the information about linked tasks and requirements the next time the Agile Requirement and Task Mapping Sync job runs.

   Note: The sync job does not synchronize the requirement version number and the version status from CA Clarity™ Agile to CA Clarity™ PPM.

Update Roles in CA Clarity™ Agile from CA Clarity™ PPM

You can download roles and role hierarchies from CA Clarity™ PPM to CA Clarity™ Agile. When you download roles, all roles in CA Clarity™ PPM are available in CA Clarity™ Agile.

To update roles in CA Clarity™ Agile from CA Clarity™ PPM roles, run the Agile Role Sync job.

Review the Project Integration Status

Review the integration status from the Agile properties page after linking a CA Clarity™ PPM project to CA Clarity™ Agile.

Follow these steps:

1. In CA Clarity™ PPM, open the project, and from the Properties, click Agile.

   The Agile properties page for the project appears.

2. Review the information in the following fields:

   Sync Status

   Displays the status of the Agile Product Sync job as successful, pending, or failed.

   Sync Detail Information

   Displays the details of the job status such as date and time when it was last run. If the job failed, displays details of the errors encountered.

A successful integration means that data is transferring between CA Clarity™ Agile and CA Clarity™ PPM. If the integration is not successful, it can mean one of the following issues:

• The Salesforce.com or CA Clarity™ Agile credentials are incorrect on the admin setup page.
• The Salesforce.com network is down.
• The CA Clarity™ Agile product or release IDs are entered incorrectly.
• The CA Clarity™ Agile product that you are trying to create exists.
• The CA Clarity™ Agile release is already linked to another CA Clarity™ PPM project.

If any information is entered incorrectly, try integrating again by reentering the correct values and running the Agile Product Sync job.