Fields Defining an External Jira Issue
The following fields are used to define an external Jira issue in Code Insight. These fields correspond to the fields that define a Jira issue on the Jira server.
| Field | Description |
|---|---|
| Project Key | The key that identifies the Jira project on the Jira server with which the Jira issue you are creating is associated. This field is set by the Project Manager and is not editable. |
| Issue Type | Select the type of issue you are creating on the Jira server— Bug or Task. This field is required. |
| Priority | Select the priority level for the Jira issue: 1—Highest 2—High 3—Medium 4—Low 5—Lowest This field is required. |
| Assignee | Enter the email for the user on the Jira server to whom you are assigning the Jira issue. |
| Summary Text | Enter the text that will display as the summary for the issue on the Jira server. The field supports the use of Code Insight variables, as described in Using Code Insight Variables in Text. This field is required. |
| Description Text | Enter the text that will display as the description for the issue on the Jira server. This field supports the use of Code Insight variables, as described in Using Code Insight Variables in Text. |
Using Code Insight Variables in Text
The Summary Text and Description Text fields support Code Insight variables that automatically pass information about the Code Insight project and inventory item to the content in these fields.
Supported Variables
The following table lists the variables available for use in the text entered in the fields:
| Variable | Description |
|---|---|
| $PROJECT_NAME | Name of the Code Insight project containing the issue |
| $INVENTORY_ITEM_NAME | Name of the inventory item containing the issue |
| $COMPONENT_NAME | Name of the component associated with the inventory item |
| $VERSION_NAME | Version of the component associated with the inventory item |
| $LICENSE_NAME | Name of the selected license for the inventory item |
| $NUMBER_VULNERABILITIES | Total number of security vulnerabilities associated with the inventory item |
| $NUMBER_FILES | Total number of files associated with the inventory item |
| $INVENTORY_URL | Link to the inventory item |
When the Jira issue is created, the included variables are replaced by their respective values.
Example Use of Variables
The following is example text you might enter in the Default Summary Text field. The text includes some of the available variables:
The $INVENTORY_ITEM_NAME inventory item in the project $PROJECT_NAME contains $NUMBER_VULNERABILITIES vulnerabilities that require review. Go to $INVENTORY_URL to see the vulnerable inventory item.
If your Code Insight project name is MySampleProject and the name of the inventory item name for which you create a work item is Apache Commons BeanUtils, the work item and Jira issue will display the following summary:
The Apache Commons BeanUtils 1.7.0 (Apache 2.0) inventory item in the project MySampleProject contains 18 vulnerabilities that require review. Go to https://my.sample.server:8888/codeinsight to see the vulnerable inventory item.