Applies to: StorageGuard 9.2.9 and later
Overview
Custom Check Fields let administrators and risk owners capture organization specific metadata on checks and risks—directly in StorageGuard. You can define fields (e.g. “SLA (days)”, “Compliance Tag”, “Severity Override Reason”) and have them appear:
- In Findings on the Risks page
- In reports showcasing Checks and Findings
Each field has a name, value type, and default value. Defaults can be refined at the check level (affecting all findings generated by that check) and further overridden at the individual risk (finding) level.
Key Concepts
Custom Field: A user-defined attribute assigned to checks and visible on their findings.
Default Value: The system-wide initial value configured at the field definition level.
Check-Level Override: A default value tailored to a specific check (applies to all its findings unless overridden at risk level).
Risk-Level Value: The value on a specific finding (risk) that can override both the global default and the check-level value.
Value Types Supported:
- Text
- Number
- Boolean
- Date
- Enum (predefined list of selectable values)
Using Custom Check Fields
Add a Custom Field
Use this to define your custom check fields:
- Navigate to the Baseline Configuration tab, select Settings, and then Custom fields from the left panel.
- Click the (+) Add field button.
- In the Add Custom Field dialog, enter:
- Name – the label that will appear on risks and in reports
- Type – select one of Text, Number, Boolean, Date, Enum
- Default value – the initial value applied to all checks
- Click OK to save the field.
The new custom field is now available on checks, risks, and finding reports.
Edit a Custom Field
Use this to edit one or more of your custom check fields:
- Navigate to the Baseline Configuration tab, select Settings, and then Custom fields from the left panel.
- Select the custom field from the list.
- Click Edit field.
- Update the field name, type, or default value as needed.
- Click OK to save changes.
NOTE: Changes to the default value do not override values already set on checks or risks.
Delete a Custom Field
Use this to delete a custom field that is unused or no longer required:
- Navigate to the Baseline Configuration tab, select Settings, and then Custom fields from the left panel.
- Select the custom field from the list.
- Click Delete field.
- Confirm the deletion.
Note that deleting a field removes it from all checks, risks, and reports.
Change the Default Field Value for One or More Checks
Use this when a specific check should have a different default value than the global field default:
- Navigate to the Baseline Configuration tab, select Checks, and then Knowledge Base from the left panel.
- Select one or more checks.
- Right click the selected check(s) to open the context menu.
- Select Edit custom fields.
- In the dialog:
- Change the default value for one or more custom fields.
- To revert a value to the global default, click (R) Reset to default.
- Click OK to apply the changes.
The updated values become the default for all findings generated by the selected checks.
Change a Custom Field Value for a Single Risk
Use this to override the value for a specific finding:
- Navigate to the Baseline Configuration tab and select Risks from the left panel.
- Double click the risk to open its details.
- In the Attributes pane, locate the custom field.
- Change the field value.
This value applies only to the selected risk.
Change a Custom Field Value for Multiple Risks
Use this to update many findings at once:
- Navigate to the Baseline Configuration tab and select Risks from the left panel.
- Select one or more risks.
- Right click the selected risks to open the context menu.
- Select Edit custom field.
- Enter the new value.
- Click OK.
The selected value is applied to all chosen risks.
Permissions & Access
The permission to view or modify custom fields is controlled through user roles. It is aligned and controlled through the permission defined for managing checks under Baseline Configuration.
Example Use Cases
- SLA (Days): Defines the required remediation timeframe (e.g., critical issues resolved within 7 days).
- Score: Represents an internally calculated risk score or priority used to rank findings.
- Depends On: Identifies other findings that must be addressed before this finding can be addressed.
Best Practices
Naming Conventions: Use consistent prefixes or patterns (e.g., Ops: Owner, GRC: Control ID) to keep long lists organized.
Enum Discipline: Define clear, mutually exclusive values. Avoid overlapping terms (e.g., “Prod” vs “Production”) to prevent reporting fragmentation.
Troubleshooting & FAQs
Q1. What takes precedence—global default, check default, or risk value?
A: Precedence: Risk value → Check-level default → Global default.
Q2. How do I reset a check-level value back to the global default?
A: Use (R) Reset to default in Edit custom fields under checks → knowledge-base.
Comments
0 comments
Please sign in to leave a comment.