Real-time prevention monitoring for Scan Engine

  • Release version: Australia
  • Updated April 13, 2026
  • 2 minutes to read
  • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    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 full answer 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.
    Note:
    Real-time prevention monitoring must be enabled on the Scan Engine properties page for this feature to function. For more information, refer to Configure real-time scanning properties.

    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
    • Prevents users from saving the record until they fix the code to meet the definition's requirements.
    • No exception reason option is available.
    • An override requires admin-level rights or disabling of the definition.
    Recommend Red
    Suggest Blue
    • Prompts users to check for a better solution if one is available.
    • Select whether to Exclude suggestion finding, which when enabled hides Suggestion level findings messages from displaying onLoad of a form, so the blocking messages display for the object when real-time validation is enabled.
    Review Blue Displays an informational message without blocking saves or creating finding records.
    Note:
    Depending on the level of the definition, users may be required to fix a finding before saving a record.

    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
    • If the definition contains a Supporting documentation link, it appears here as a hyperlink that opens in a new browser tab.
    • This can link to documentation, knowledge base articles, FAQs, and more.
    Impact
    • Lists the finding's impact level and Impact to instance for the associated definition.
    • The impact to instance is a number between 1 and 10, where 10 is the most impactful.

    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.