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 (optional);

4. Enter schema Title (optional);
5. In the column Add content click + to add fields to the schema:

• Templates - you can add only one field of each type to the schema (only template names can be changed);
  • Score -total risk of the vulnerability (you can rename risk values);
  • Affected assets - IP address or Hostname;
  • HTTP requests - site requests and responses (the field is collapsible by default);
  • Weakness type - type of the vulnerability;

• Custom fields (optional) - you can add several fields of each type to the schema (you can edit IDs and technical names of the fields):

  • String - field for text values;
  • Integer - field for numeric values;
  • Float - float values;

  • Markdown - text in Markdown format;

    Note: to apply autofill of the markdown fields from the Issue templates, you must specify the following technical names for the fields:

    • 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;

  • Checkboxes - several checkboxes;

  • 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 - field for entering radio buttons;

  • Date - contains only date;
  • Date & time - contains both date and time.

6. Additional options:
   • Change order of the fields - select the field with the mouse and drag it to another position;
   • Make fields required - to make field mandatory, click * next to the selected field;
   • Collapse empty fields - click next to the selected field;
7. Click Preview to view the schema;
8. Click Create to save issue schema;
9. Click Create issue to create issue by issue schema.

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

Predefined fields

See also

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