Function Assessment

Assessment<T extends keyof Tables>(
config: AssessmentConfig<T>,
): AssessmentConfig<T>

Creates a ServiceNow assessment/survey definition (asmt_metric_type) together with its categories (asmt_metric_category) and questions/metrics (asmt_metric) as a single nested entity. The metric_type and category foreign keys are wired automatically from the nesting structure.

Type Parameters

T extends keyof Tables

Parameters

config: AssessmentConfig<T>
The assessment configuration object

Returns AssessmentConfig<T>

See

https://docs.servicenow.com/csh?topicname=assessments-landing-page.html&version=latest

Example

Assessment({
    $id: Now.ID['nps-survey'],
    name: 'Customer NPS',
    table: 'customer_account',
    categories: [
        {
            $id: Now.ID['nps-cat'],
            name: 'Net Promoter Score',
            metrics: [
                {
                    $id: Now.ID['nps-q'],
                    name: 'How likely are you to recommend us?',
                    question: 'How likely are you to recommend us?',
                    dataType: 'numericScale',
                    scored: false,
                },
            ],
        },
    ],
})