Associating the Project with an Application Life Cycle System to Create Work Items
Code Insight integrates with application lifecycle management (ALM) systems, enabling Code Insight users to create and manage external work items associated with inventory directly from Code Insight. With this integration, inventory requiring further review and remediation can be tracked externally as part of the user’s existing issue-tracking system.
For example, a Code Insight scan might uncover security vulnerabilities or copyleft licenses requiring further review by the Security and Legal teams. With an ALM integration, these reviews and any resulting remedial work can be quickly converted into work items in the ALM system directly from Code Insight. Users can also track the state of these work items—and open the items—from Code Insight.
Currently, Code Insight supports integration with only Jira as an ALM system. This chapter focuses the Project Administrator’s task of configuring a Code Insight project for Jira integration so that the project’s users can create and track issues on the Jira system from Code Insight.
The following topics provide the background and process for configuring projects to integrate with Jira:
About the Jira Connector and Instances
Integration with the Jira system is enabled through the Jira connector available with Code Insight. This connector supports pre-populated data (in the form of one or more instances) used to connect Code Insight with the Jira system and create Jira issues in that system. The Jira connector also controls the frequency of data synchronization between Code Insight and the server, enabling users to view the current state of these external Jira issues from within Code Insight. The Code Insight System Administrator has the responsibility of defining one or more of Jira ALM instances in Code Insight.
Once Jira ALM instances are available, the Code Insight Project Administrator associates a Code Insight project with a specific Jira ALM instance so that project users can create track external Jira issues from Code Insight.
Associating a Code Insight Project with a Jira ALM instance
Use the following instructions to associate a Code Insight project with a Jira ALM instance.
To associate a Code Insight project with a Jira ALM instance, do the following:
|
2.
|
From the Manage Project menu, select Edit Project. The Edit Project window opens. |
|
3.
|
Select the ALM Settings tab. |
|
4.
|
From the ALM Instance dropdown list, select the Jira ALM instance to associate to this project. |
The current settings for the Jira ALM instance are displayed.
If no instances (or no appropriate instances) are available in the dropdown list, contact the System Administrator about the configuration of a Jira ALM instance that meets your needs.
|
5.
|
Complete the fields on the ALM Settings tab as needed. Refer to Fields Defining an External Jira Issue for field descriptions and important information about the fields. Consider the following: |
|
•
|
The Default Project Key field is the only field (other than the ALM Instance field) that requires a value when associating the project with the instance. If a default value is provided, ensure that it is correct. |
|
•
|
The remaining fields are optional when associating the project with the instance. A value that you enter for any of these remaining fields serves as a default for that field when a project user actually defines an external Jira issue for project inventory. Keep in mind that, although the default value for a field might be the one most commonly used (or that you desire to be used) for external issues, the user creating the issue can override the default as needed. |
|
•
|
If you enter a default value, ensure that it is valid. Validation of these field values takes place during the creation of a Jira issue. At that time, if information entered for these fields is invalid (for example, the Default Assignee value does not exist in the Jira system), the information will still be saved, but the user will not be able to create the issue on Jira system. |
|
6.
|
When you have completed the settings, click Save to associate the Jira ALM instance to the project. |
Disassociating an Jira ALM instance from a Project
The Project Administrator can disassociate an Jira ALM instance from a project at any time. If the association is removed, any existing Jira issues for the Code Insight project will remain in Jira, but the Create Work Item option on the Task Details dialog is disabled.
To disassociate an ALM instance from a project, do the following:
|
2.
|
From the Manage Project menu, select Edit Project. The Edit Project window opens. |
|
3.
|
Select the ALM Settings tab. |
|
4.
|
In the ALM Instance dropdown list, change the selection to None. |