How to Create Custom Finding Fields
We've already learned how to use Finding Fields Templates and adjust the details of findings in a project. Now, let's take it a step further and learn how to create our own custom finding fields.
To do this, we'll first create a Finding Fields Template and then link it to our project. Here's a step-by-step guide:
1. Navigate to Finding Fields and either edit an existing template or create a new one. For this example, we'll create a new template.
2. Let's stay on the Vulnerability type and click New Field in the Recommendations category.
You have several options for the type of custom field you can create. You can add up to five Text, five Multitext, five Dropdown, and five Multiselect fields per template. As an example, we have chosen Multiselect and added three options.
3. Once the field is saved, it's not visible by default. You can edit, make visible, or delete any custom field. Note that for system fields, you can only adjust visibility. A field that is not visible will not be displayed in the finding details.
4. Now, select a project and ensure it uses the Finding Field Template you just created.
5. Create a new finding of the Vulnerability type or edit an existing one and check the Recommendations section. You will now see and be able to fill in your custom field along with the others. Be sure to save your changes.
Feel free to add new custom fields and adjust their names, types, and visibility to personalize your finding templates.
Finding Custom Fields API, Import/Export
As you saw when creating the custom fields, there is a field called Code. By default, this is created from the custom field's name, with spaces replaced by hyphens. For example, a field named "This is a custom field" would automatically generate the code "this-is-a-custom-field."
You can, of course, rename this code if you'd like. This property is crucial as it's used for the following:
- As the column name when exporting findings to Excel and CSV files:
- As a node for the custom field when exporting findings to XML and via the API:
- To match data when importing an Excel, CSV, or XML file with findings.