Creating Issue schemas

With the help of schemas you can customize issue fields.

Note: the Reports will be generated according to the issue schema that is set as default in the project;

To create Issue schema:

1. Go to Project > Issues > Schemas;

2. Click +Schema;

3. Select schema template to copy it (optional) — use this option to copy schema fields from other schemas;

4. Enter Issue title display (optional) — by default Title is displayed. You can enter any value for this field;
5. Status field is a default field for all issues, you can change displayed name for this field;
6. In the column Add content click + to add fields to the schema:

7. When you add all needed fields, click Preview to view the schema;
8. Click Create to save new schema;
9. Click Create issue to create issue right after you save your issue schema.

Issue schema fields

Templates — predefined issue fields that are used for issue templates. Fields from this section can be added to the schema only once. You cannot edit IDs of these fields, however you can edit technical names:

• Score — total risk of the vulnerability calculated upon Probability and Criticality of the Issue:

  • Criticality — the risk level of the vulnerability (Low, Medium, High);
  • Probability — the possibility of exploiting a vulnerability (Low, Medium, High);

• Affected assets — IP addresses or Hostnames of the systems with Issues;

• HTTP request — example of site requests and responses (the field is collapsible by default);
• Weakness type — type of the vulnerability (f.e. CWE-79);

Custom fields — fields from this section can be added to the schema an unlimited number of times. You can edit IDs and technical names of all fields:

• String — field for text values;
• Integer — field for positive or negative integer numbers (f.e. 1, 2, 3, ... n);
• Float — field for positive or negative integer numbers with a decimal point (f.e. 0.1, 0.2, 0.3, ... n);

• Markdown — text in Markdown format. To the Markdown fields you can attach images in the formats .jpg, .png, .jpeg, .gif and file size is up to 100 MB (contact system administrator to change this parameter). To apply autofill of the markdown fields from the Issue templates, you must specify the following IDs for these fields in your Schema:

  • generalDescription — corresponds to the field General description
  • recommendations — corresponds to the field Recommendations
  • riskDescription — corresponds to the field Risk description
  • stepsToReproduce — corresponds to the field Steps to Reproduce
  • technicalDescription — corresponds to the field Technical description

  

• Checkbox — single checkbox selector;

• Checkboxes — multiple checkbox selector;

• Select — field for selecting one or several options:

  • multiple choice — select several options at once;
  • single choice — select only one option;
  • add placeholder — add hint to the empty option field (when registering an issue, grey text of the hint will be displayed in select fields)

  

• Radio buttons — radio button selector;

• Date — field for indicating date;
• Date & time — field for indicating date and time.

During the creation of issue schema, you can configure parameters of all fields:

• Change order of the fields — select the field with the mouse, drag and drop it to another position;
• Make required — to make field mandatory, click * next to the selected field;
• Collapse empty fields - click next to the selected field.

Import and export issue schemas

To import Issue schema:

1. Go to Project > Issues > Schemas;
2. Click > Import;

3. Click Browse to upload issue schema or drop it to the field in a.json format;

4. Click Import. New issue schema appears in the list.

To export Issue schema:

1. Go to Project > Issues > Schemas;
2. Click > Export;
3. Select one or several issue schemas and click Export:

4. The issue schema will be downloaded as file in a .json format.

Note: if you export several issue schemas, they will be saved to one .json file.

Default Issue schema

Default issue schema contains the following fields:

• Title — name of the detected Issue;
• Status — issue status,

• Score — total risk of the vulnerability calculated upon Probability and Criticality of the Issue:

  • Criticality — the risk level of the vulnerability (Low, Medium, High);
  • Probability — the possibility of exploiting a vulnerability (Low, Medium, High);

• Affected Assets — IP address or Hostname of the system with Issue (optional);

• General description — common description of the Issue;
• Risks — description of the vulnerability risk;
• Technical description — technical description of the issue;
• HTTP request — example of the site requests and responses;
• Recommendations — recommendations for issue remediation;
• Steps to reproduce — actions to reproduce the Issue.

Technical description of predefined schema fields

See also

• Getting started: Creating Project and Project Group
• Manage Project data
• Compare Project Data
• Add Custom Report Templates