You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/programs/custom-fields.md
+48-26Lines changed: 48 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -6,52 +6,60 @@ id: "programs/custom-fields"
6
6
7
7
Program administrators can configure custom fields to add data to their reports. This enables your program members to add additional information to your reports to help you better manage and analyze your internal data by the categories that you define to be important, such as by business unit or by root cause analysis.
8
8
9
-
> This feature is only available to Enterprise programs.
9
+
Administrators can also create hacker facing custom fields to require specific information from hackers regarding the vulnerability and how they found it. This can help speed up the remediation process as it’ll minimize the back-and-forth between the hacker and the program in getting necessary information.
10
10
11
-
### Create a Custom Field
11
+
> This feature is only available to Enterprise programs. Hacker facing custom fields are currently in beta.
12
+
13
+
### Create a custom field
12
14
13
15
> **Note:** You must be an administrator of the program in order to add a custom field.
14
16
15
17
To create a custom field:
16
18
1. Go to **Program > Customization > Custom Fields**.
17
-
2. Click **New Custom Field**.
19
+
2. Click **Add Custom Field**.
18
20
3. Enter the **Field Title** on the **Create Custom Field** page.
19
-
4.Select the **Field Type**. You can choose from:
21
+
4.Choose the type of field you’d like for the Select type. You can choose from:
20
22
21
23
Option | Details
22
24
------ | --------
23
-
Text | This option enables you to create an editable text field.<br><br>
25
+
Text | This option enables you to create an editable text field.
24
26
List | This option enables you to create a drop-down list that you can select from when editing your custom field.<br><br>Enter your option items in the **Configuration List** field separated by a comma.<br><br>
27
+
Checkbox | This option enables you to create a clickable checkbox option so that hackers or program members can select if the vulnerability meets the criteria the field is labeled with.<br><br>
28
+
Date/Time | This option enables you to create a clickable calendar and time field so that hackers or program members can input the correct date and time of their findings. <br><br>
25
29
26
-
5.Click **Save**.
30
+
5.Select the **Visibility** type you’d like for the custom field. You can choose from:
27
31
28
-
All of your reports will now have a Custom Fields section. You can edit the section to add the Custom Field label you created.
32
+
Option | Details
33
+
------ | --------
34
+
Internal | Only the internal members of your program will be able to see the custom field.
35
+
Hacker facing | The field will appear on the report for the hacker to complete.
29
36
30
-
37
+
6.*(Optional. Only displays for hacker facing custom fields.)* Select the checkbox to indicate that you’d like to mark the field as required on the report.
38
+
7.*(Optional. Only displays for hacker facing custom fields.)* Enter the helper text you’d like to use to help guide hackers in filling out the custom field.
39
+
8.*(Optional)* Enter a regular expression in the Validation via regular expression field. This is make sure that all inputs for the field are valid. [Learn more about using regular expressions to validate the input](https://www.regular-expressions.info/).
40
+
9.*(Optional)* Enter the error message that you would like to display when the validation fails.
41
+
10. Click **Save**.
31
42
32
-
The custom field will also be added into your inbox filter so that you can filter your reports by the custom field you created. The image below shows the filter 2 custom fields that were created: Squad and Root Cause Analysis. To filter on **Text** types for reports that don't have the custom field set, click in the custom field input box and press the **Return** key without entering a value. For **List** types, click on the custom field and select the Empty option.
43
+
All of your reports will now have a Custom Fields section on the right-hand side that will show both your created internal and hacker facing custom fields. Hackers can add the details corresponding to each hacker facing custom field, and your internal program members can add information for the internal custom fields.
To fill in a value for a Custom Field to your report:
38
-
1. Go the report you want to add a custom field to.
39
-
2. Click **Edit** in the Custom Fields section.
40
-
41
-
49
+
1. Go the report you want to add custom field details to.
50
+
2. Click the pencil icon to edit the custom fields section.
51
+
3. Enter the information you want to add for each custom field.
52
+
4. Click **Save**.
42
53
43
-
3. Enter the information you want to add to the field for each field label.
44
-
4. Click **Save and add fields**.
54
+
The information you input will now be tied to your field labels.
45
55
46
-
The information you input will now be tied to your field labels. To edit the information, click **Edit**.
56
+
When you export your reports as a CSV file, the custom field and the information associated with it will also be included in the export. Each custom field will be exported with an associated key. The key for each field is comprised of: `<team_id>_<custom_field_attribute_label>`.
47
57
48
-
49
-
50
-
When you export your reports as a CSV file, the custom field and the information associated with it will also be included in the export. Each custom fields will be exported with an associated key. The key for each field is comprised of: `<team_id>_<custom_field_attribute_label>`.
58
+
The image below shows an example of an exported report with the custom field labels of `squad`, `source`, and `rca` in the header of each column.
51
59
52
60
53
61
54
-
### Edit a Custom Field
62
+
### Edit a custom field
55
63
You can edit your custom fields to change the name of the field label.
@@ -65,15 +73,29 @@ To edit the title of a custom field:
65
73
66
74
When you edit a custom field, the key associated with the field will also change.
67
75
68
-
### Archive Custom Fields
69
-
You can archive custom fields that you no longer want to use. We don’t enable you to permanently delete custom fields to prevent data loss.
76
+
### Archive custom fields
77
+
You can archive custom fields that you no longer want to use. We don’t enable you to permanently delete custom fields as a precaution to prevent data loss.
1. Go to **Program > Customization > Custom Fields**.
75
-
2. Click **Archive**.
83
+
2. Click **Archive** next to the custom field you want to archive.
76
84
77
85
The archived field can no longer be added to new reports. Current and past reports with the archived field will remain on the report and won’t disappear. You can, however, edit the field within the report.
78
86
79
-
You can unarchive an archived custom field by clicking **Unarchive**.
87
+
You can unarchive an archived custom field by clicking **Unarchive** next to the archived custom field.
88
+
89
+
### Filter reports by custom field
90
+
You can filter your inbox reports by the custom fields you created as each custom field you create will be added into your inbox filter.
91
+
92
+
To filter your inbox by custom fields:
93
+
1. Go to your inbox.
94
+
2. Click **Show filters**.
95
+
3. Scroll down to the **Custom fields** filters.
96
+
4. Select the custom fields you want to filter by.
97
+
98
+
To filter by **Text types** for reports that don't have the custom field set, click in the custom field input box and press the **Return** key on your keyboard without entering a value.
99
+
100
+
To filter by **List types** for reports that don't have the custom field set, click on the custom field and select the *Empty* option.
101
+
0 commit comments