Configure Jira mapping

  • Public preview

Use the Mapping view to define how an XBOW finding becomes a Jira work item.

Note: The app loads options on this page from your Jira site. If the expected project or issue type is not listed, confirm that you installed the app on the correct Jira site, and that the app can access the project.

Map a finding to a work item

  1. Choose a Jira project key.
  2. Choose an issue type.
  3. Click Check Fields to validate XBOW’s data against the requirements for creating that issue type in your project. See Check required fields.
    • If the validation is successful, the “Check Fields” area shows green and “Required Jira fields” reports a “Ready” label.
    • If any problems are reported, you must resolve them and click Check Fields to retry validation.
  4. Set or update the remaining fields as needed. See XBOW data placement.
  5. Click Save Mapping.
  6. If you enabled Bidirectional mode, use the “Status Writeback” area to define how Jira data is sent back to XBOW, then click Save Writeback. See Status writeback to XBOW.

After you finish mapping findings to work items, any new findings reported in XBOW will automatically trigger new work items in Jira.

Check required fields

The app asks Jira which fields you must cover to create the selected work item, then reports each one:

StatusMeaning
CoveredXBOW already sends this field.
Jira defaultJira has a default value for this field, so the app does not need to send one.

When every required field is covered, the panel shows “Ready” and you can save the mapping.

The app sends the following fields itself:

  • Project
  • Issue type
  • Summary
  • Description
  • Labels
  • Priority, when you configure priority mapping and Jira accepts priority for that work item

The app can also cover required fields of these types:

  • Text
  • Textarea
  • Number
  • Date
  • Single select
  • Multi select
  • Components
  • Versions
  • Fix versions

A required field of an unsupported type blocks saving only when Jira has no default value for it. To unblock the mapping, add a Jira default, make the field optional, remove the requirement, or choose a different project or issue type.

“Field output preview” shows the project, issue type, summary, description, and any outstanding required fields for the current mapping, so you can check it before you save.

Labels

Labels are optional. Use them to make XBOW-created work items easier to find and filter in Jira. Enter them as a comma-separated list. The app suggests a default label of xbow.

The app also appends a severity label, such as xbow-severity-high, and this is on by default. The setting is not in this section. To turn it off, find “Severity label” beside the priority mapping and clear the Append xbow-severity-* checkbox.

XBOW data placement

The Mapping view shows the default layout of XBOW finding data in a Jira issue. You can use the available variables to define an alternative layout.

Available variables:

VariableDescription
{{id}}XBOW finding ID.
{{name}}Finding name.
{{summary}}Short finding summary.
{{severity}}XBOW severity.
{{evidence}}Evidence text.
{{impact}}Impact text.
{{mitigations}}Mitigation text.
{{recipe}}Reproduction or validation steps.
{{state}}Current finding state in XBOW.

Unknown variables are left in place so typos are visible.

Issue title

The summary template controls the title of the Jira issue.

Default:

[XBOW] {{name}}

Issue description

The description template controls the main Jira description.

Default:

{{summary}}

Finding detail placement

The default options keep the issue description short and add Evidence, Impact, Mitigations, and Recipe as separate comments. Use this area to change where each section appears.

OptionResult
Separate commentAdds the section as its own Jira comment.
DescriptionAdds the section to the Jira description.
Do not includeLeaves the section out of Jira.

Priorities

By default, the integration leaves Jira priorities blank for your own processes to set. You can map some or all XBOW finding severities to a Jira priority.

If you leave a severity unmapped, the app creates the work item without setting a priority.

Status writeback to XBOW

Status writeback applies only in bidirectional mode. In unidirectional mode the section is read-only and shows “Bidirectional off”.

Map each Jira status to one of these XBOW workflow states:

  • not-started
  • in-progress
  • completed

The app suggests a mapping for the default Jira statuses, so review the suggestions before you change them.

Use Default XBOW workflow state to set the state the app applies when it first creates a Jira issue and no Jira status is mapped yet.

Test custom Jira workflows before relying on bidirectional writeback.

Was this helpful?