Skip to main content

Use of Code Insight Variables in Text

The Default Summary Text and Default Description Text fields support Code Insight variables that automatically pass information about the current 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:

VariableDescription
$PROJECT_NAMEName of the Code Insight project containing the issue
$INVENTORY_ITEM_NAMEName of the inventory item containing the issue
$COMPONENT_NAMEName of the component associated with the inventory item
$VERSION_NAMEVersion of the component associated with the inventory item
$LICENSE_NAMEName of the selected license for the inventory item
$NUMBER_VULNERABILITIESTotal number of security vulnerabilities associated with the inventory item
$NUMBER_FILESTotal number of files associated with the inventory item
$INVENTORY_URLLink 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.