Real-time prevention monitoring for Scan Engine
Summarize
Summary of Real-time prevention monitoring for Scan Engine
Real-time prevention monitoring is a feature of the Scan Engine that actively checks records as they are created or modified, providing immediate feedback on potential violations in scripts and other fields. This functionality operates in any instance where the Scan Engine is installed and enabled, delivering on-screen alerts and detailed guidance to help users resolve issues promptly, ensuring compliance and governance.
Show less
Key Features
- Immediate detection: Identifies violations instantly during record edits.
- On-screen alerts: Displays findings with color-coded severity levels (blue for Review and Suggest, red for Recommend and Act).
- Guided resolution: Provides line numbers, impact levels, resolution steps, and links to supporting documentation.
- Governance support: Integrates exception workflows allowing users to submit reasons when findings are not valid.
- Configurable enforcement: Enforcement of findings can be enabled or disabled, and visibility of alerts can be restricted to specific user groups via Scan Engine properties.
Finding Severity Levels and Impact on Users
Findings are categorized into four levels:
- Act (Red): Blocks saving of records until issues are fixed; no exception allowed unless admin overrides or disables the definition.
- Recommend (Red): Blocks saving unless users resolve the issue or provide an exception reason.
- Suggest (Blue): Prompts users to consider better solutions; can be hidden to reduce noise.
- Review (Blue): Provides informational messages without preventing saves.
Finding Information and Resolution
When a finding occurs, a detailed information window appears, showing:
- Severity level and description
- Line number where the issue was found
- Steps to resolve the issue
- Requirement to submit an exception reason for Recommend findings
- Links to supporting documentation for further guidance
- Impact rating of the finding on the instance (scale of 1 to 10)
Users can resolve findings by fixing the code or submitting an exception reason (for Recommend level) to continue saving records.
Configuration and Management
Real-time enforcement and messaging visibility are controlled through the Scan Engine properties page. Administrators can enable or disable enforcement, restrict alert visibility to certain user groups, and configure other behaviors to suit organizational policies and workflows.
Real-time prevention monitoring is a Scan Engine feature that actively monitors records as they are created or modified, displaying finding messages in real time when saving records in any instance where the Scan Engine is installed and activated.
Real-time prevention monitoring provides the following capabilities:
- Immediate detection: Identifies potential violations in scripts, includes, and other fields at the moment of edit.
- On-screen alerts: Displays findings in real time with severity levels.
- Guided resolution: Provides details such as line numbers, impact levels, and steps to resolve found issues.
- Governance: Supports exception workflows and links to supporting documentation for compliance.
Finding levels
Findings identified by real-time monitoring are assigned one of four levels. Review and Suggest level findings are shown in blue. Recommend and Act level findings are shown in red.
| Level | Color | Description |
|---|---|---|
| Act | Red |
|
| Recommend | Red |
|
| Suggest | Blue |
|
| Review | Blue | Displays an informational message without blocking saves or creating finding records. |
Finding information window
When a finding is detected, an information window displays. The fields shown depend on the severity of the finding.
| Field | Description |
|---|---|
| Finding level | The severity level of the finding and a brief description. |
| Details | Generally, the line number the finding occurred on. |
| Steps to resolve issue | Suggested steps the developer can follow to resolve the finding. |
| Exception reason required | For Recommend level findings, reminds developers they can submit an exception if they believe the issue is not a valid finding. |
| Supporting documentation |
|
| Impact |
|
Resolving a finding
Using the information provided in the finding window, you can do one of the following:
- Correct the issue. If the issue is corrected, the Scan Engine will not return a new finding notice.
- For Recommend level findings, submit an exception reason, then select Update. See Submit exceptions for Scan Engine findings.
Configuration
Real-time messaging enforcement can be disabled on the Scan Engine properties page. When enforcement is disabled, users see the messaging but are not required to make corrections for Act and Recommend findings.
Visibility of real-time messaging can also be configured to limit which users receive finding notifications. You can restrict messaging to a specific group if necessary.
For more information, refer to Configure Scan Engine properties.