CA Agile Vision and CA Product Vision. Integration Guide

Transcription

1 CA Agile Vision and CA Product Vision Integration Guide Spring 2012

2 This documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the Documentation ) is for your informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA. Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy. The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice. The manufacturer of this Documentation is CA. Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections , , and (c)(1) - (2) and DFARS Section (b)(3), as applicable, or their successors. Copyright 2012 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

3 CA Agile Vision Support CA Agile Vision Team Edition Support CA Agile Vision Enterprise Edition Support The following types of support are available for CA Agile Vision customers: For your convenience, CA Technologies provides a self-supported CA User Community Online Forum where you can access information about CA Agile Vision, ask questions, and share experiences with other users. or phone support is unavailable. There is no guarantee that issues reported through the community forum will be monitored by CA Support. If you have comments or questions about documentation, you can submit questions or feedback on the CA User Community Online Forum. For your convenience, CA Technologies provides one site where you can access the information you need for your Home Office, Small Business, and Enterprise products. At you can access the following: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads CA Support policies and guidelines Other helpful resources appropriate for your product Provide Feedback If you have comments or questions about documentation, you can send a message to techpubs@ca.com. If you would like to provide feedback about documentation, complete our short customer survey, which is also available on the CA Support website, found at Full technical assistance is available for CA Agile Vision Enterprise Edition customers. For more information, contact CA Customer Support.

4

5 Contents Chapter 1: Overview 7 About Third-Party Integrations... 7 CA Clarity PPM Integration... 8 Integration Prerequisites... 8 Synchronization Jobs... 9 CA Software Change Manager Integration with CA Agile Vision and CA Product Vision... 9 Chapter 2: CA Clarity PPM and Agile Vision Integration 11 Integration Overview How to Integrate CA Clarity PPM with CA Agile Vision and CA Product Vision Install and Configure CA Vision Add-in on CA Clarity PPM Change the URL for Accessing CA Agile Vision or CA Product Vision Sandbox Environment from CA Clarity PPM Configure the CA Vision Add-in on CA Clarity PPM Configure CA Clarity PPM How to Set up Data Transfers from CA Clarity PPM Link to an Existing CA Vision Product and Release Create a Release in an Existing CA Vision Product Create a New Project and Release from CA Clarity PPM Map CA Agile Vision Task Types to CA Clarity PPM Charge Codes How to Link CA Clarity PPM Tasks with CA Product Vision Requirements Update Roles in CA Product Vision from CA Clarity PPM Review the Agile Vision Project Integration Status Jobs Management CA Agile Vision and CA Product Vision Sync Jobs CA Vision Product Sync Job CA Agile Vision Timesheet Sync Job CA Product Vision Requirement and Task Mapping Sync Job CA Product Vision Role Sync Job Chapter 3: JIRA and CA Agile Vision Integration 29 How to Integrate JIRA with CA Agile Vision Install Agile Vision Plug-in on JIRA Change the URL for Accessing CA Agile Vision or CA Product Vision Sandbox Environment from JIRA Configure the Agile Vision Settings for JIRA Configure CA Agile Vision Issue Sync Service Schedule Contents 5

6 Run CA Agile Vision Issue Sync Service Immediately Configure the CA Agile Vision Listener Map JIRA Projects to CA Agile Vision Products Map JIRA Attributes to CA Agile Vision Attributes Map JIRA Attribute Values to CA Agile Vision Attribute Values Issue Synchronization between JIRA and CA Agile Vision Set Issue Import Criteria for CA Agile Vision Synchronize an Issue from JIRA to CA Agile Vision Synchronize an Issue from CA Agile Vision to JIRA Disable JIRA Integration with CA Agile Vision Chapter 4: Quality Center and CA Agile Vision Integration 41 How to Integrate Quality Center with CA Agile Vision Prerequisites for Setting up the Quality Center Plugin Install Quality Center Plugin Package Configure Quality Center Plugin for CA Agile Vision Change Quality Center and CA Agile Vision Passwords Change the URL for Accessing CA Agile Vision Sandbox Environment from Quality Center Configure Plug-in to Run as Scheduled Windows Task Sample Configuration File for Quality Center Plugin Synchronize Quality Center Test Cases into CA Agile Vision Appendix A: CA Clarity PPM Field Mapping for CA Agile Vision and CA Product Vision 49 Project Mapping Resource Mapping Resource Updates Resource Deletion Resource Mapping Task Mapping Task Updates Task Deletions Field and Value Mapping Task Worklog Mapping Impediment Mapping Integration Guide

7 Chapter 1: Overview This section contains the following topics: About Third-Party Integrations (see page 7) CA Clarity PPM Integration (see page 8) CA Software Change Manager Integration with CA Agile Vision and CA Product Vision (see page 9) About Third-Party Integrations You can configure CA Agile Vision and CA Product Vision to integrate with with the following CA products: CA Clarity PPM: You can create and manage requirements in an agile environment while adhering to the traditional project governing process. CA Software Change Manager: You can view details about CA Software Change Manager packages and package history information. Also, you can integrate CA Agile Vision with the following third-party add-in products. JIRA. Manage user stories and issues from a single location. Track issues in the backlog and report on issues for each user story. HP Quality Center (Quality Center). Track product quality directly from each user story. Best Practice: For each add-in, complete the following tasks to prevent invalid sessions: Create separate system administrator or super user accounts per add-in. Run the sync jobs for each add-in at different times. If you are unable to create a separate system administrator account per add-in, run the sync jobs at different times. Do not overlap them. Chapter 1: Overview 7

8 CA Clarity PPM Integration CA Clarity PPM Integration You can integrate CA Agile Vision and CA Product Vision with CA Clarity PPM projects. CA Agile Vision Enterprise Edition and CA Product Vision licenses are required. Using this integration, product owners can create and manage requirements in an agile environment while adhering to the traditional project governing process. The integration includes the following capabilities: Create and manage CA Agile Vision products and users from CA Clarity PPM. Associate CA Product Vision requirements with CA Clarity PPM tasks Build the CA Clarity PPM work breakdown structure (WBS) from Agile sprints, user stories, and tasks. Auto-populate CA Clarity PPM timesheets using CA Agile Vision task worklogs. Download roles from CA Clarity PPM for use in CA Product Vision. Synchronization jobs can run in the background at predefined intervals to transfer information between CA Agile Vision, CA Product Visions and CA Clarity PPM. Integration Prerequisites You need the following licenses to integrate CA Clarity PPM with CA Agile Vision, CA Product Vision, or both CA Agile Vision and CA Product Vision: Integrate CA Clarity PPM with... CA Vision add-in that is installed on CA Clarity PPM v or v CA Agile Vision X X CA Agile Vision Enterprise Edition license CA Product Vision X X CA Product Vision license CA Agile Vision and CA Product Vision X X X 8 Integration Guide

9 CA Software Change Manager Integration with CA Agile Vision and CA Product Vision Synchronization Jobs The following synchronization jobs are available in CA Clarity PPM that run in the background at predefined intervals to transfer information between CA Clarity PPM, CA Agile Vision, and CA Product Vision. CA Vision Project Sync job. This job synchronizes project and resource information from CA Clarity PPM to both CA Agile Vision and CA Product Vision. Also, this job uses sprints, user stories, and tasks from CA Agile Vision to create the project work breakdown structure in CA Clarity PPM. CA Agile Vision Timesheet Sync job. This job uses task worklogs in CA Agile Vision to populate the timesheets for corresponding resources in CA Clarity PPM. CA Product Vision Requirement and Task Mapping Sync job. This job synchronizes CA Product Vision requirement and CA Clarity PPM task information for relevant releases. CA Product Vision Role Sync job. This job downloads roles from CA Clarity PPM to CA Product Vision. CA Software Change Manager Integration with CA Agile Vision and CA Product Vision You can integrate CA Agile Vision and CA Product Vision with CA Software Change Manager Version or higher to view information about packages associated with user stories, issues, and requirements. To set up the integration, the system administrator completes following steps: The system administrator configures CA Software Change Manager to work with CA Agile Vision and CA Product Vision. To learn about how to configure CA Software Change Manager, see the CA Software Change Manager Administration Guide, available on CA Support. The system administrator enables CA Software Change Manager from the Global Configuration page, found on the CA Vision Administration menu. To learn more about enabling CA Software Change Manager, see the CA Agile Vision and CA Product Vision Administration Guide. Chapter 1: Overview 9

10

11 Chapter 2: CA Clarity PPM and Agile Vision Integration This section contains the following topics: Integration Overview (see page 11) How to Integrate CA Clarity PPM with CA Agile Vision and CA Product Vision (see page 12) How to Set up Data Transfers from CA Clarity PPM (see page 17) Review the Agile Vision Project Integration Status (see page 25) Jobs Management (see page 26) Integration Overview When CA Vision is used in this document, it means the CA Vision family of products (CA Agile Vision or CA Product Vision). Terminology in CA Clarity PPM and in CA Agile Vision and CA Product Vision varies slightly for the same object. A project in CA Clarity PPM is known as a release in CA Agile Vision and CA Product Vision. Before you can share information, associate a CA Clarity PPM project with CA Vision. Once you establish the association, the CA Vision subpage in CA Clarity PPM becomes available for you to specify CA Agile Vision or CA Product Vision product and release details. If you delete an associated CA Clarity PPM project, you cannot link another project to the same CA Agile Vision or CA Product Vision release. You can link a new CA Clarity PPM project to another release and can move the details (user stories, tasks, or requirements) to the newly linked release. When the integration is complete, jobs that run in CA Clarity PPM update and synchronize information in CA Clarity PPM, CA Agile Vision, and CA Product Vision. The jobs that run depend on the information that is being updated. You can set the jobs to run periodically, or you can run them manually from CA Clarity PPM, as needed. For more information about jobs for this integration, see Jobs Management (see page 26). For a complete list of the fields that are updated between CA Clarity PPM,CA Agile Vision and CA Product Vision, see CA Clarity PPM Field Mapping for CA Agile Vision and CA Product Vision (see page 49). Chapter 2: CA Clarity PPM and Agile Vision Integration 11

12 How to Integrate CA Clarity PPM with CA Agile Vision and CA Product Vision How to Integrate CA Clarity PPM with CA Agile Vision and CA Product Vision The following steps show the high-level process for integrating CA Clarity PPM with CA Agile Vision and CA Agile Vision. The steps are the same whether you are integrating CA Clarity PPM with CA Agile Vision, CA Product Vision, or both. Administrator: 1. Downloads and extracts the Agile Vision add-in. (see page 12) See CA Agile Vision Implementation Guide for more information about how to download and extract the add-ins. 2. Stops the CA Clarity PPM application (app) and background (bg) services. (see page 12) See the CA Clarity PPM Installation Guide for more information. 3. Installs the CA Vision add-in (see page 12) 4. Configures the CA Vision add-in and restarts the Clarity app and bg services. (see page 14) See the CA Clarity PPM Installation Guide for more information. 5. Applies the Add-in. See the CA Clarity PPM Installation Guide for more information. 6. Configures CA Clarity PPM (see page 15). Project Manager: 1. Sets up data transfers. (see page 17) 2. Reviews the integration status in CA Clarity PPM (see page 25). Install and Configure CA Vision Add-in on CA Clarity PPM Download and Extract the Add-In To install the CA Vision Add-in, download and extract the add-in file, stop CA Clarity PPM services, and install the add-in. Go to support.ca.com and download the.iso image to your computer or an accessible network location. 1. Download and unzip the GEN E.zip file available from support.ca.com. 2. Download the wsc_java15.jar file from the following URL: 12 Integration Guide

13 How to Integrate CA Clarity PPM with CA Agile Vision and CA Product Vision 3. Copy the wsc_java15.jar file to the <Clarity installation directory>/lib directory on the CA Clarity application server where you are planning to complete the installation process. 4. Copy the avee jar file to the <Clarity installation directory>/lib directory on the CA Clarity application server. The.jar file includes the following files: The.jar file ix installation script. install.bat The Windows installation script. install.xml The Ant installation script includes the following files: install.sh package tools The UNIX installation script. The directory of updated files. The directory of supporting files. Stop CA Clarity PPM Services Install the Add-in 1. Log in to Clarity System Administration (NSA). 2. Stop the CA Clarity PPM application (app) and background (bg) services. Install the add-in to update to objects, reports, and the 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 install in a test environment before installing this add-in into your production environment. Once you have installed the add-in, you cannot uninstall it. 1. Open a command prompt window in the directory where you extracted the.jar files, and issue the following command: install Chapter 2: CA Clarity PPM and Agile Vision Integration 13

14 How to Integrate CA Clarity PPM with CA Agile Vision and CA Product Vision 2. Press Enter. 3. Follow the on-screen directions to complete the add-in installation. Change the URL for Accessing CA Agile Vision or CA Product Vision Sandbox Environment from CA Clarity PPM After installing the CA Vision 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 Agile Vision or CA Product Vision 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 Vision Sandbox environment. Perform this step only if you have configured a sandbox environment. See the Salesforce.com Help & Training for more information. 1. Open the Vision Admin Settings in the CA Clarity PPM Administration Tool. 2. Enter the URL for Sandbox environment in the CA Vision Environment URL field. 3. Click Save. Important! If you are upgrading from the previous version AND using sandbox server URL, update the sandbox URL from the Vision Admin Settings page. Configure the CA Vision Add-in on CA Clarity PPM After installing and optionally changing the URL for a sandbox environment, configure the CA Vision add-in in CA Clarity PPM. 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 and access the Administration Tool. 4. Select Objects from the CA Clarity Studio menu. 5. Filter using the Project object name. The objects list appears. 6. Click the Project object to open it. 14 Integration Guide

15 How to Integrate CA Clarity PPM with CA Agile Vision and CA Product Vision 7. Click Views in the content menu. Click the Layout: Edit link for the Project Properties view. The property layout appears. 8. Expand the CA Vision project properties and then expand the Integration Status section. 9. Click the Properties and Layout icon for the Integration Status section. The section properties appear. 10. Click Submit. The property layout appears. 11. Click Back. The object definition view appears. 12. Click Publish to publish the view. A confirmation prompt appears. 13. Click Yes. Configure CA Clarity PPM The following procedure describes how to set up CA Clarity PPM to link to CA Agile Vision or CA Product Vision. 1. Log in to the CA Clarity PPM and access the Administration Tool. 2. Select CA Vision Setup from the General Settings menu. The admin settings page appears. 3. Complete the following fields in the CA Vision Login Info section: User Name Defines the user name for logging in to CA Agile Vision with system administrator privileges. Password Defines the password for logging in to Agile Vision with system administrator privileges. Chapter 2: CA Clarity PPM and Agile Vision Integration 15

16 How to Integrate CA Clarity PPM with CA Agile Vision and CA Product Vision 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. CA Vision Environment URL Specifies the URL that CA Clarity PPM uses to access the CA Agile Vision or CA Product Vision production or sandbox environment. CA Vision URL Specifies the URL that CA Clarity PPM uses to access the requirements list in CA Product Vision. 4. Complete the following fields in the Proxy Server Info section: Host Name Port Defines the proxy server host name. Defines the proxy server port. User Name Defines the proxy server user name. Password 5. Click Save. Defines the proxy server password. 16 Integration Guide

17 How to Set up Data Transfers from CA Clarity PPM How to Set up Data Transfers from CA Clarity PPM To set up data transfers, specify the CA Agile Vision or CA Product Vision product details in a CA Clarity PPM project that you have associated. The following tasks show how to set up data transfers: Create a product or release from CA Clarity PPM (see page 21). Link to an existing CA Agile Vision or CA Product Vision product and release from CA Clarity PPM (see page 18). Create a release in an existing product from CA Clarity PPM (see page 19). Map CA Agile Vision task types to CA Clarity PPM charge codes (see page 22). Link CA Clarity PPM tasks with CA Product Vision requirements (see page 23). Update Roles in CA Product Vision from CA Clarity PPM (see page 24) The following rules apply for linking projects between CA Clarity PPM and CA Agile Vision or CA Product Vision: 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 to avoid having it be overwritten from CA Clarity PPM. If you leave all the fields blank, the synchronization job fails and nothing is created or linked in CA Agile Vision. Best Practice: To link a CA Clarity PPM project to CA Agile Vision or CA Product Vision, 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. Chapter 2: CA Clarity PPM and Agile Vision Integration 17

18 How to Set up Data Transfers from CA Clarity PPM Link to an Existing CA Vision Product and Release Link to an existing CA Vision release by specifying the product ID and release ID in a CA Clarity PPM project. 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. 1. In CA Clarity PPM, open a project that you want to associate with a CA Vision product. The project properties appear. 2. Select the Linked to CA Vision check box and click Save. 3. Click CA Vision from the content menu. The CA Vision properties page appears. 4. Complete the following fields: CA Vision Master Release ID Defines the release ID for an existing master release. This value is used to link this project to an existing master release in CA Agile Vision or CA Product Vision. If the link is established successfully, this field becomes display-only. Source: Master Release ID field on the Master Release Detail page in CA Agile Vision or CA Product Vision. Note: Leave this field blank, if you are linking to a product release instead of a master release. CA Vision Product ID Defines the product ID of an existing product in CA Agile Vision or CA Product Vision. This value is used to link a CA Clarity PPM project to an existing product. If the link is established successfully, this field becomes display-only. Source: Product ID field on the Product Detail page in CA Agile Vision or CA Product Vision. CA Vision Release ID Defines the release ID for an existing release in CA Agile Vision or CA Product Vision. This value is used to link a CA Clarity PPM project to an existing release. If the link is established successfully, this field becomes display-only. Source: Release ID field on the Release Detail page in CA Agile Vision or CA Product Vision. Note: Leave the following fields blank: CA Vision Product Name, CA Vision Release Name, and Product Prefix. 18 Integration Guide

19 How to Set up Data Transfers from CA Clarity PPM 5. Submit your changes. After the CA Vision Product Sync job runs, the following fields are automatically populated in CA Clarity PPM: CA Vision Product Name Displays the product name. This value is automatically populated from CA Agile Vision or CA Product Vision. Source: Product Name field on the Product Detail page in CA Agile Vision or CA Product Vision. CA Vision Release Name Displays the Agile Vision release name. This value is automatically populated from CA Agile Vision. Source: Release Name field on the Release Detail page in CA Agile Vision. Product Prefix Displays the unique prefix to the user stories and tasks in the Agile Vision product. Source: Product Prefix field on the Product Detail page in Agile Vision. Create a Release in an Existing CA Vision Product Create a release in an existing CA Agile Vision or CA Product Vision 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. 1. In CA Clarity PPM, open the project and associate it with CA Vision by selecting the Linked to CA Vision check box and clicking Save. The project properties appear. 2. Click CA Vision from the content menu. The CA Vision properties page appears. 3. Complete the following fields: CA Vision Product ID Defines the product ID of an existing product in CA Agile Vision or CA Product Vision. This value is used to link a CA Clarity PPM project to an existing product. If the link is established successfully, this field becomes display-only. Source: Product ID field on the Product Detail page in CA Agile Vision or CA Product Vision. Chapter 2: CA Clarity PPM and Agile Vision Integration 19

20 How to Set up Data Transfers from CA Clarity PPM CA Vision Release Name Defines the name of the new CA Agile Vision release you want to create. Note: Leave the following fields blank: CA Vision Release ID, CA Vision Product Name, and Product Prefix. 4. Submit your changes. After the CA Vision Product Sync job runs, the following fields are automatically populated in CA Clarity PPM: CA Vision Release ID Displays the CA Agile Vision or CA Product Vision release ID. This value is automatically populated from CA Agile Vision or CA Product Vision. Source: Release ID field on the Release Detail page on CA Agile Vision or CA Product Vision. CA Vision Product Name Displays the product name. This value is automatically populated from CA Agile Vision or CA Product Vision. Source: Product Name field on the Product Detail page in CA Agile Vision or CA Product Vision. Product Prefix Displays the unique prefix assigned to the product in CA Agile Vision or CA Product Vision. Source: Product Prefix field on the Product Detail page in CA Agile Vision or CA Product Vision. 20 Integration Guide

21 How to Set up Data Transfers from CA Clarity PPM Create a New Project and Release from CA Clarity PPM Create a project in CA Clarity PPM and a release in CA Agile Vision or CA Product Vision by specifying the product name and release name in the CA Clarity PPM project. 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 Link to CA Vision check box and click Save. Two CA Vision options become available in the content menu. 5. Click CA Vision from the content menu. The CA Vision properties page appears. 6. Complete the following fields: CA Vision Product Name Defines the name of the new CA Vision product you want to create. CA Vision Release Name Defines the name of the new CA Vision 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: CA Vision Product ID and CA Vision Release ID. 7. Submit your changes. After the CA Vision Project Sync job runs, the following fields are automatically populated in CA Clarity PPM and the new product and release is created in CA Agile Vision and/or CA Product Vision: CA Vision Product ID Displays the CA Vision product ID. This value is automatically populated from CA Agile Vision or CA Product Vision. Source: Product ID field on the Product Detail page on CA Agile Vision or CA Product Vision. Chapter 2: CA Clarity PPM and Agile Vision Integration 21

22 How to Set up Data Transfers from CA Clarity PPM CA Vision Release ID Displays the CA Vision release ID. This value is automatically populated from CA Agile Vision or CA Product Vision. Source: Release ID field on the Release Detail page on CA Agile Vision or CA Product Vision. Map CA Agile Vision 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 Agile Vision task types. Mapping the task types to charge codes allows you to assign appropriate charge codes to actuals on linked tasks. The project manager must have the following global and instance access rights to map task types to charge codes and run the Populate CA Agile Vision Task Types process: 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 CA Agile Vision 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 Agile Vision, you can assign the Default charge code to it in CA Clarity PPM. 1. In CA Clarity PPM, open the linked project. The project properties appear. 2. Click CA Vision Task Type Mapping from the content menu. The CA Vision task type and charge code mapping page appears. 3. Click New. The create mapping page appears. 4. Complete the following fields and submit: Task Type Defines the CA Agile Vision task type for a task. Charge Code Defines the CA Clarity PPM charge code for the same task. 22 Integration Guide

23 How to Set up Data Transfers from CA Clarity PPM How to Link CA Clarity PPM Tasks with CA Product Vision Requirements Verify Prerequisites CA Product Vision requirements map with CA Clarity PPM tasks. To link tasks with requirements, complete the following steps: 1. Verify Prerequisites (see page 23) 2. Verify CA Clarity PPM Access Rights (see page 23) 3. Link CA Clarity PPM Tasks with CA Product Vision Requirements (see page 23). The CA Product Vision requirements that you want to link must be available to CA Clarity PPM for selection. Verify that the CA Vision Product Sync job has run since any requirements were added. Verify CA Clarity PPM Access Rights Verify that you have the following CA Clarity PPM access rights: Mapped Task - Create Mapped Task - Edit All CA Product Vision Requirement - Create CA Product Vision Requirement - Edit All Requirement and Task Mapping - Create Requirement and Task Mapping - Edit All Link CA Clarity PPM Tasks with CA Product Vision Requirements You can link CA Clarity PPM tasks with requirements from CA Product Vision. You can link multiple tasks to a single requirement, and you can link multiple requirements to a single task. 1. In CA Clarity PPM, open the linked project. The project properties appear. 2. Click the Tasks tab and go to the Work Breakdown Structure sub-tab. 3. Locate the task and click the icon in the Mapped Requirements column. Chapter 2: CA Clarity PPM and Agile Vision Integration 23

24 How to Set up Data Transfers from CA Clarity PPM The Mapped Task: Properties page appears with the Requirement and Task Mapping List option selected in the content menu. 4. Click New. The Create Requirement and Task Mapping page appears. 5. Click the Browse icon and select a CA Product Vision requirement to map to the task. 6. Click Save. 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 Product Vision 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 the Task WBS icon for the requirement to return to the Work Breakdown Structure. CA Product Vision is updated with the information about linked tasks and requirements the next time the CA Product Vision Requirement and Task Mapping Sync job runs. Note: The sync job does not sync the requirement version number and the version status from CA Product Vision to CA Clarity PPM. Update Roles in CA Product Vision from CA Clarity PPM You can download roles and role hierarchies from CA Clarity PPM to CA Product Vision. When you download roles, all roles in CA Clarity PPM are available in CA Product Vision. To update roles in CA Product Vision from CA Clarity PPM roles, run the CA Product Vision Role Sync job. 24 Integration Guide

25 Review the Agile Vision Project Integration Status Review the Agile Vision Project Integration Status Review the integration status from the CA Agile Vision properties page after linking a CA Clarity PPM project to CA Agile Vision. A successful integration means that data is transferring between CA Agile Vision and CA Clarity PPM. If the integration is not successful, it can mean one of the following issues: The Salesforce.com or CA Agile Vision credentials are incorrect on the CA Agile Vision admin setup page. The Salesforce.com network is down. The CA Agile Vision product or release IDs are entered incorrectly. The CA Agile Vision product that you are trying to create exists. The CA Agile Vision 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 CA Agile Vision Product Sync job. 1. In CA Clarity PPM, open the project and click CA Vision from the content menu. The CA Vision properties page appears. 2. Review the information in the following fields: Sync Status Displays the status of the CA Vision Project 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. Chapter 2: CA Clarity PPM and Agile Vision Integration 25

26 Jobs Management Jobs Management CA Agile Vision and CA Product Vision Sync Jobs When you install the CA Clarity Agile Enterprise add-in, the following jobs become available and active in CA Clarity PPM: CA Agile Vision Project Sync CA Agile Vision Timesheet Sync CA Product Vision Requirement and Task Mapping Sync CA Product Vision Role Sync By default, these jobs are scheduled to run automatically at predefined intervals (everyday at 9:00 AM). You can modify the default schedules of these jobs to suit the needs of your organization. You can also run the jobs immediately to move data over from CA Agile Vision to CA Clarity PPM. See the CA Clarity PPM Administration Guide for information about how to schedule and run jobs from CA Clarity PPM. The CA Agile Vision Sync jobs cannot run concurrently with the following CA Clarity PPM jobs: Post Timesheets Time Slicing Update Earned Value Totals Update Earned Value History CA Vision Product Sync Job The CA Vision Product Sync job synchronizes the following items: Projects and resources from CA Clarity PPM to CA Agile Vision. Tasks from CA Agile Vision to CA Clarity PPM. 26 Integration Guide

27 Jobs Management Product Sync Details Resource Sync Details Task Sync Details In CA Clarity PPM, the job populates the following fields on the CA Vision subpage: CA Vision Product Name CA Vision Release Name In CA Agile Vision, the job replaces the release start date and release date with the CA Clarity PPM project start and end dates. Note: The Product Sync job reports a Failed status even if one of the many projects fail. The Failed status notifies the administrator that there is at least one project that needs attention. This status does not necessarily mean that all projects have failed. Refer to the sync job log page in CA Clarity PPM to determine which projects need attention and why. In CA Agile Vision, the job creates a user, unless the resource is an existing Salesforce.com user. The following fields are populated from CA Clarity PPM: First Name Last Name User name In CA Clarity PPM, the job populates the following kinds of tasks in the task WBS of a project that uses CA Agile Vision sprints, user stories, and tasks: Summary tasks Detail tasks Unscheduled tasks Chapter 2: CA Clarity PPM and Agile Vision Integration 27

28 Jobs Management CA Agile Vision Timesheet Sync Job The CA Agile Vision Timesheet Sync job populates the following items in CA Clarity PPM from CA Agile Vision task work logs: Actual hours on tasks Hours that are worked and ETC for a resource for a given date in timesheets. Each time the Timesheet Sync job runs, this job overwrites any changes to timesheets made in CA Clarity PPM provided the timesheet is still open. Best Practice: Make all your updates in CA Agile Vision and the changes are updated in the CA Clarity PPM timesheet the next time the Timesheet Sync job runs. You do not need to update the CA Agile Vision tasks in the CA Clarity PPM timesheet. CA Product Vision Requirement and Task Mapping Sync Job This job synchronizes the relationships between CA Clarity PPM project tasks and CA Product Vision requirements. The data flows from CA Clarity PPM to CA Product Vision and also from CA Product Vision to CA Clarity PPM. CA Product Vision Role Sync Job This job downloads all roles defined in CA Clarity PPM to CA Product Vision. The Role Sync Job contains the following parameter: Overwrite CA Product Vision Roles Specifies whether the roles already in CA Product Vision can be overwritten when the job runs. Select the check box to overwrite current roles. 28 Integration Guide

29 Chapter 3: JIRA and CA Agile Vision Integration This section contains the following topics: How to Integrate JIRA with CA Agile Vision (see page 29) Issue Synchronization between JIRA and CA Agile Vision (see page 38) How to Integrate JIRA with CA Agile Vision You must have JIRA, Version 4.1.2, installed and running before integrating CA Agile Vision with JIRA. To integrate JIRA with CA Agile Vision, complete the following steps: 1. On the JIRA server, install the CA Agile Vision (see page 30)Plug-in. 2. Configure JIRA for the CA Agile Vision setup (see page 31). 3. Enable CA Agile Vision to integrate with JIRA. See the CA Agile Vision Online Help for more information. 4. Complete the following additional steps: Configure the CA Agile Vision Issue Sync Service (see page 32)Schedule. Configure the CA Agile Vision listener (see page 34). Map the JIRA project to the CA Agile Vision (see page 35)project. Map JIRA attributes to CA Agile Vision attributes (see page 36). Map JIRA attribute values to CA Agile Vision attribute values (see page 37). Chapter 3: JIRA and CA Agile Vision Integration 29

30 How to Integrate JIRA with CA Agile Vision Install Agile Vision Plug-in on JIRA If the ca-agile-jira-integration-1.1.jar file exists in the <JIRA installation directory>/atlassian-jira/web-inf/lib directory, remove this file before starting the JIRA server. 1. Download and unzip the GEN E.zip file available from support.ca.com. 2. Download the wsc_java15.jar file from the following URL: 3. Copy the wsc_java15.jar file to the <JIRA installation directory>/atlassian-jira/web-inf/lib directory on the JIRA server. 4. Copy the plug-in ca-agile-jira-integration-1.3.jar to the <JIRA installation directory>/atlassian-jira/web-inf/lib directory. 5. Restart JIRA. Change the URL for Accessing CA Agile Vision or CA Product Vision Sandbox Environment from JIRA After you install the CA Vision add-in, you can edit the URL that JIRA uses to access Salesforce.com. The default URL points to the regular environment. You can create a Sandbox environment for CA Agile Vision or CA Product Vision 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 Vision Sandbox environment. Perform this task only if you have created a Sandbox environment. See the Salesforce.com Help & Training for more information. 1. Stop JIRA. 2. Create a temporary directory (for example, C:\jira_temp). 3. Copy the ca-agile-jira-integration-1.3.jar file from the lib directory under the JIRA installation directory to the temporary directory. 4. Unpack the ca-agile-jira-integration-1.3.jar file as follows: jar -xvf ca-agile-jira-integration-1.3.jar 30 Integration Guide

31 How to Integrate JIRA with CA Agile Vision 5. Edit the jiraintegration.properties file by changing the default URL from the following URL: avee.endpoint= To the following URL: avee.endpoint= 6. Save the properties file. 7. Recreate the jar file as follows: jar -cvf ca-agile-jira-integration-1.3.jar 8. Copy the ca-agile-jira-integration-1.3.jar file to the lib directory under the JIRA installation directory. 9. Delete the temporary directory (c:\jira_temp). 10. Restart JIRA. Configure the Agile Vision Settings for JIRA Configure the CA Agile Vision organization details for the JIRA plug-in so they connect to each other. Test your connection to CA Agile Vision after saving your configuration settings. A message appears indicating either a successful connection to the CA Agile Vision organization or an error. A connection error can occur for the following reasons: Incorrect CA Agile Vision credentials Network issues 1. Log in to JIRA as an administrator. 2. Click Administration. The administration page appears. 3. Click Configuration from the Plug-ins, Other menu. The configuration page appears. 4. Complete the following CA Agile Vision organization details: User Name Defines the user name for logging in to CA Agile Vision with system administrator privileges. Password Defines the password for logging in to CA Agile Vision with system administrator privileges. Chapter 3: JIRA and CA Agile Vision Integration 31

32 How to Integrate JIRA with CA Agile Vision Security Token Defines the security token that is used for server identification in case the login fails or if the JIRA 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. Proxy Server Host Name Defines the proxy server hostname. Proxy Server Port Defines the proxy server port. Proxy Server User Name Defines the proxy server username. Proxy Server Password 5. Click Save. Defines the proxy server password. Configure CA Agile Vision Issue Sync Service Schedule As a JIRA administrator, configure the CA Agile Vision Issue Sync Service to run at fixed intervals and to synchronize issues between CA Agile Vision and JIRA. You can also use the Run Sync Job Immediately option. Refer to the atlassian-jira.log file located in the JIRA_HOME directory to view job run progress. Note: Once you configure the Issue Sync Service schedule, the sync job runs immediately and the Run Sync Job Immediately option is temporarily disabled. Once the job completes, this option is enabled again. 1. Click Administration in JIRA. 2. The administration page appears. 3. Click Services from the System menu. The services list page appears. 4. In the Add Service section, complete the following fields: Name Defines the issue synchronization service name. Value: CA Agile Vision Issue Sync Service 32 Integration Guide

33 How to Integrate JIRA with CA Agile Vision Class Delay Defines the issue synchronization service class. Value: com.ca.agile.integration.jira.job.agilevisionissuesyncservice Defines the delay between the synchronization service running time in minutes. The recommended interval is 360 minutes. Default: 1 minute (the service runs every minute) 5. Click Add Service. Run CA Agile Vision Issue Sync Service Immediately As a JIRA administrator, you can run the CA Agile Vision Issue Sync Service any time to view updated issues from CA Agile Vision. If there is another job instance running simultaneously, the request is skipped and a message appears in the atlassian-jira.log file located in the JIRA_HOME directory. The Issue Sync Service page displays the job status (Running, Completed), the request type, and the job start time. You can refresh the job status at any time. If the job fails, an error message displays with recommended actions. An error usually occurs when connection to CA Agile Vision cannot be established or if the sync job is already running. 1. Click Administration in JIRA. The administration page appears. 2. Click Sync Status from the CA Agile Vision menu. The CA Agile Vision Issue Sync Status page appears. 3. Click Run Sync Job Immediately. 4. Go to the log file to view job progress. Chapter 3: JIRA and CA Agile Vision Integration 33

34 How to Integrate JIRA with CA Agile Vision Configure the CA Agile Vision Listener Configure the CA Agile Vision listener to verify that if an issue is deleted either in JIRA or CA Agile Vision, it is also deleted from the other application when the sync job runs. You can delete the listener any time to stop all updates from JIRA to CA Agile Vision. 1. Click Administration in JIRA. The administration page appears. 2. Click Listeners from the System menu. The listeners list page appears. In the Add Listener section, complete the following fields: Name Class 3. Click Add. Defines the name for the CA Agile Vision listener. Value: CA Agile Vision Issue Listener Defines the class for the listener. Value: com.ca.agile.integration.jira.listener.agilevisionissuelistener 34 Integration Guide

35 How to Integrate JIRA with CA Agile Vision Map JIRA Projects to CA Agile Vision Products Map your JIRA projects to CA Agile Vision products to connect and track issues. You can also remove these mappings if desired at any point. When you delete a project in JIRA, the following actions occur: The JIRA project is unlinked from the CA Agile Vision product. Issues that were imported from JIRA to CA Agile Vision remain, but are no longer synchronized. You can still view these issues and link to them from user stories. The issues are removed from JIRA. 1. Click Administration in JIRA. The administration page appears. 2. Click Project Mapping from the CA Agile Vision menu. The CA Agile Vision JIRA project mapping page appears. 3. Complete the following fields in the Add Project Mapping section: CA Agile Vision Product Defines the CA Agile Vision product that you want to map to the JIRA project. JIRA Project Defines the JIRA project that you want to map to the CA Agile Vision product. 4. Click Add Mapping to add the mapping to the list. Chapter 3: JIRA and CA Agile Vision Integration 35

36 How to Integrate JIRA with CA Agile Vision Map JIRA Attributes to CA Agile Vision Attributes Map your JIRA attributes to CA Agile Vision attributes to connect JIRA issues and CA Agile Vision issues. You can edit or remove these mappings if desired at any point. You can map the following attribute types: Text (for example, Title) Unlimited text (for example, Description) Number (for example, Points) Single-select (for example, Priority) Multi-select (for example, Theme) You can also map any custom JIRA fields to CA Agile Vision attributes. 1. Click Administration in JIRA. The administration page appears. 2. Click Project Mapping from the CA Agile Vision menu. The CA Agile Vision JIRA project mapping page appears listing the mapped projects. 3. In the Operations column of the mapping table, click Attribute Mapping next to the CA Agile Vision product and JIRA project for which you want to map attributes. The CA Agile Vision JIRA project attribute mapping page appears displaying the attributes that are mapped by default. 4. Click Edit to map the remaining attributes. The project attribute mapping page refreshes listing the CA Agile Vision attributes and JIRA fields. 5. For each CA Agile Vision attribute, select a matching JIRA field from the drop-down and click Save. The following table shows the attributes that are mapped by default. CA Agile Vision Attributes Title Status Priority Expected Result Workaround Available JIRA Issue Fields Summary Status Priority None None 36 Integration Guide