@servicenow/sdk - v4.13.3
    Preparing search index...

    Interface ScriptOnlyCheck

    Executes a standalone script-based check with no table binding (scan_script_only_check).

    interface ScriptOnlyCheck {
        $id: string | number | ExplicitKey<string>;
        $meta?: {
            installMethod?: "first install" | "demo" | "once";
            useEsLatest?: boolean;
        };
        $override?: Record<string, string | number | boolean>;
        active?: boolean;
        category: ScanCategory;
        description?: string;
        documentationUrl?: string;
        findingType?: keyof Tables;
        name: string;
        priority: ScanPriority;
        protectionPolicy?: "read" | "protected";
        resolutionDetails?: string;
        runCondition?: string;
        scoreMax?: number;
        scoreMin?: number;
        scoreScale?: number;
        script?: string;
        shortDescription: string;
    }
    Index

    Properties

    $id $meta? $override? active? category description? documentationUrl? findingType? name priority protectionPolicy? resolutionDetails? runCondition? scoreMax? scoreMin? scoreScale? script? shortDescription

    Properties

    $id: string | number | ExplicitKey<string>
    $meta?: {
        installMethod?: "first install" | "demo" | "once";
        useEsLatest?: boolean;
    }

    Type Declaration

    • OptionalinstallMethod?: "first install" | "demo" | "once"

      Map a record to an output folder that loads only in specific circumstances. 'first install' -> 'unload' (only loaded when plugin is first registered), 'demo' -> 'unload.demo' (only loaded when demo data is loaded), 'once' -> 'apply_once' (scripts that are only applied once)

    • OptionaluseEsLatest?: boolean

      Controls whether this record's server-side script field(s) run with the latest supported ECMAScript version rather than the application's default. Omit to leave the sys_app/now.config default in place. This setting applies to all fields defined for this entity

    $override?: Record<string, string | number | boolean>

    Set properties not directly supported by this API.

    active?: boolean

    Controls whether this check runs during scans. Defaults to true

    category: ScanCategory

    Classifies what aspect of the instance this check evaluates

    description?: string

    Full explanation of what this check evaluates and why

    documentationUrl?: string

    Link to external documentation for this check

    findingType?: keyof Tables

    Table where findings are stored. Defaults to scan_finding

    name: string

    Unique name identifying this check

    priority: ScanPriority

    Severity level: 1=Critical, 2=High, 3=Moderate, 4=Low

    protectionPolicy?: "read" | "protected"

    Controls edit/view access for other developers after the application is installed.

    • read: Others can see the script logic but not change it.
    • protected: Others cannot change this record.
    • Omit to allow other developers to customize this record.
    resolutionDetails?: string

    Guidance on how to remediate findings from this check

    runCondition?: string

    Encoded query condition that must be met before this check runs

    scoreMax?: number

    Maximum number of findings for scoring calculation

    scoreMin?: number

    Minimum number of findings before scoring applies

    scoreScale?: number

    Multiplier applied to the finding count for scoring

    script?: string

    Server-side script executed when the check runs

    shortDescription: string

    Brief summary displayed in scan results

    Settings

    Member Visibility

    On This Page

    Properties