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

    Type Alias AssessmentFields<T>

    Fields shared by every asmt_metric_type definition, regardless of AssessmentConfig.evaluationMethod, excluding table (and $id/metadata). Exported so other plugins built on the same underlying entity — including ones where table isn't user-configurable, like RiskAssessment (always change_request) — can build their own config type on top of it.

    type AssessmentFields<T extends TableName = TableName> = {
        active?: boolean;
        allowPublic?: boolean;
        allowRetake?: boolean;
        anonymizeResponses?: boolean;
        assessmentDuration?: Duration;
        assessmentManager?: string | Record<"sys_user">;
        businessRule?: string;
        categories?: CategoryConfig[];
        chatSurvey?: boolean;
        condition?: string;
        defaultMatrixFilter?: string;
        deleteBusinessRule?: string;
        description?: string;
        displayAllFilters?: boolean;
        endNote?: string;
        enforceCondition?: boolean;
        filterCondition?: string;
        filterField?: keyof FullSchema<T> | string & {};
        hideSurveyIntroductionNotes?: boolean;
        introduction?: string;
        liveFeed?: boolean;
        name: string;
        notifyIfOverdue?: boolean;
        oneClickSurvey?: boolean;
        owners?: (string | Record<"sys_user">)[];
        portalPagination?: PortalPagination;
        returnUrl?: string;
        roles?: (string | Role)[];
        sampleMetric?: string | Record<"asmt_metric">;
        scaleFactor?: number;
        scheduleJob?: string;
        schedulePeriod?: SchedulePeriod;
        scheduleType?: ScheduleType;
        scoringType?: ScoringType;
        sendNotifications?: boolean;
        signature?: string | Record<"asmt_signature">;
        sourceTable?: TableName;
        state?: PublishState;
        userField?: keyof FullSchema<T> | string & {};
        userFieldBusinessRule?: string;
    }

    Type Parameters

    Index

    Properties

    active? allowPublic? allowRetake? anonymizeResponses? assessmentDuration? assessmentManager? businessRule? categories? chatSurvey? condition? defaultMatrixFilter? deleteBusinessRule? description? displayAllFilters? endNote? enforceCondition? filterCondition? filterField? hideSurveyIntroductionNotes? introduction? liveFeed? name notifyIfOverdue? oneClickSurvey? owners? portalPagination? returnUrl? roles? sampleMetric? scaleFactor? scheduleJob? schedulePeriod? scheduleType? scoringType? sendNotifications? signature? sourceTable? state? userField? userFieldBusinessRule?

    Properties

    active?: boolean

    Whether the assessment is active and can be issued. DB: active. Default true.

    allowPublic?: boolean

    Allow the assessment to be taken by public (unauthenticated) users. DB: allow_public. Read-only on the platform — populate only if your build plugin sets it explicitly. Default false.

    allowRetake?: boolean

    Allow assessors to retake the assessment. DB: allow_retake. Default false.

    anonymizeResponses?: boolean

    Anonymize responses. DB: anonymize. Default false.

    assessmentDuration?: Duration

    How long an assessment instance stays open. DB: duration (glide_duration). Default Duration({ days: 14 }) ('1970-01-15 00:00:00').

    assessmentManager?: string | Record<"sys_user">

    User to notify on overdue instances. DB: overdue_notify_user (reference sys_user).

    businessRule?: string

    Auto-generated business rule that triggers when the metric type is created. Do not set manually.

    categories?: CategoryConfig[]

    The categories (sections) of the assessment.

    chatSurvey?: boolean

    Expose the survey through chat / Virtual Agent. DB: chat_survey. Default false.

    condition?: string

    Encoded query selecting which records get assessed. DB: condition (conditions, max 1000).

    defaultMatrixFilter?: string

    Default filter (encoded query). DB: default_filter.

    deleteBusinessRule?: string

    Auto-generated business rule that triggers when the metric type is deleted. Do not set manually.

    description?: string

    Rich-text description of the assessment. DB: description (translated_text, max 1000).

    displayAllFilters?: boolean

    Show all filters on the assessment. DB: display_all_filters. Default false.

    endNote?: string

    Closing note HTML shown after submit. DB: end_note (translated_html, max 8000).

    enforceCondition?: boolean

    Enforce the condition strictly. DB: enforce_condition. Default false.

    filterCondition?: string

    Filter condition (encoded query). DB: filter_condition (conditions, max 1000).

    filterField?: keyof FullSchema<T> | string & {}

    Field on table that identifies the filter-menu choices on decision matrices and scorecards; selecting a value scopes the comparison pool (e.g. 'assignment_group' on incident compares within a group — it segments, not ranks). Conceptually keyof table. DB: display_field (field_name).

    hideSurveyIntroductionNotes?: boolean

    Suppress the introduction note. DB: not_show_intro_note. Default false.

    introduction?: string

    Introduction HTML shown before the survey begins. DB: introduction (translated_html, max 8000).

    liveFeed?: boolean

    Publish events to the live feed. DB: live_feed. Default false.

    name: string

    Display name of the assessment/survey. DB: name (translated_text, max 255). Mandatory.

    notifyIfOverdue?: boolean

    Notify when an assessment instance is overdue. DB: notify_if_overdue. Default false.

    oneClickSurvey?: boolean

    Enable one-click survey links. DB: one_click_survey. Default false.

    owners?: (string | Record<"sys_user">)[]

    Survey owners. DB: survey_owners (glide_list -> sys_user, max 1024).

    portalPagination?: PortalPagination

    Service Portal pagination mode. DB: portal_pagination. Default 'category'.

    returnUrl?: string

    Public URL for anonymous or one-click surveys. DB: url (max 500).

    roles?: (string | Role)[]

    Roles required to take the assessment. DB: roles (user_roles, max 200).

    sampleMetric?: string | Record<"asmt_metric">

    Sample metric used for previews. DB: sample_metric (reference asmt_metric).

    scaleFactor?: number

    Score scale factor — an integer that determines the score range. Typical values are 1 (raw), 10 (tens), or 100 (percentage). DB: scale_factor (integer). Required when evaluationMethod is 'assessment' (the default); optional when 'survey'.

    scheduleJob?: string

    Auto-generated recurring job that regenerates assessment instances when scheduleType is 'scheduled'. DB: job (reference sys_trigger). Do not set manually.

    schedulePeriod?: SchedulePeriod

    Recurrence period, used with scheduleType: 'scheduled'. DB: schedule_period. Default 'noLimit'.

    scheduleType?: ScheduleType

    Trigger model for generating assessment instances. DB: schedule_type. Default 'onDemand'.

    scoringType?: ScoringType

    Strategy used to score responses. DB: scoring_type. Default 'percentage'.

    sendNotifications?: boolean

    Notify the assessed user when an instance is created. DB: notify_user. Default true.

    signature?: string | Record<"asmt_signature">

    Signature definition to require on completion. DB: signature (reference asmt_signature).

    sourceTable?: TableName

    Alternate source table used to generate the list of assessable records. When set, candidate records are pulled from this table instead of table, but the assessment itself still targets table. Both fields can co-exist. DB: source_table (table_name).

    state?: PublishState

    Publish lifecycle state. DB: publish_state. Default 'draft'.

    userField?: keyof FullSchema<T> | string & {}

    Column name on table (or sourceTable) that identifies the user being assessed. Conceptually keyof table. DB: user_field (field_name).

    userFieldBusinessRule?: string

    Auto-generated business rule that updates assessable record category ownership when the assessment is updated. DB: user_field_business_rule (reference sys_script). Do not set manually.

    Settings

    Member Visibility

    On This Page

    Properties