@servicenow/sdk - v4.4.1
    Preparing search index...
    interface wf_context {
        active: Typed<
            boolean,
            {
                default: true;
                label: [
                    {
                        hint: "Active means have not reached a terminal state";
                        label: "Active";
                        language: "en";
                        plural: "Active";
                    },
                ];
            },
        >;
        activity_count: Typed<
            number,
            {
                default: "0";
                label: [
                    {
                        hint: "Loop detection and prevention";
                        label: "Activity count";
                        language: "en";
                        plural: "Activity counts";
                    },
                ];
            },
        >;
        activity_index: Typed<
            number,
            {
                default: "0";
                label: [
                    {
                        hint: "Index assigned to activities as they are transitioned to in the process of workflow execution";
                        label: "Activity index";
                        language: "en";
                        plural: "Activity indexes";
                    },
                ];
            },
        >;
        after_business_rules: Typed<
            boolean,
            {
                default: false;
                label: [
                    {
                        hint: "Defer running of the workflow until all before and after business rules have completed";
                        label: "Run after bus. rules run";
                        language: "en";
                        plural: "Run after bus. rules runs";
                    },
                ];
            },
        >;
        auto_start: Typed<boolean, { label: "Auto start" }>;
        column_renderer: Typed<
            | string
            | Record<"column_renderer">
            | ExplicitKey<"column_renderer">
            | TableBrand<"column_renderer">,
            {
                attributes: { encode_utf8: false };
                dropdown: "dropdown_without_none";
                label: [
                    {
                        hint: "Type of display for stages";
                        label: "Stage rendering";
                        language: "en";
                        plural: "Stage renderings";
                    },
                ];
                referenceTable: "column_renderer";
            },
        >;
        cumulated_avg_ert: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Cumulated average estimated run time";
                        label: "Cumulative to ERT";
                        language: "en";
                        plural: "Cumulative to ERTs";
                    },
                ];
            },
        >;
        due: Typed<
            `${number}-${number}-${number} ${number}:${number}:${number}`,
            {
                label: [
                    {
                        hint: "Estimated Completion Date";
                        label: "Due";
                        language: "en";
                        plural: "Dues";
                    },
                ];
            },
        >;
        ended: Typed<
            `${number}-${number}-${number} ${number}:${number}:${number}`,
            {
                label: [
                    {
                        hint: "Absolute time the workflow completed";
                        label: "Ended";
                        language: "en";
                        plural: "Ended";
                    },
                ];
            },
        >;
        ert_long_running_actions: Typed<
            string
            | number,
            {
                attributes: { no_sort: true; slushbucket_ref_no_expand: true };
                columnType: "glide_action_list";
                default: "51782761ac1464174baaeb9af4b9ae76,803b3c728f320100ec9a6441f0f923ef,b69c7e18eb532100ec9a82810206fea4";
                label: "Available actions";
                maxLength: 1024;
            },
        >;
        ert_outlier_workflow_actions: Typed<
            string
            | number,
            {
                attributes: { no_sort: true; slushbucket_ref_no_expand: true };
                columnType: "glide_action_list";
                default: "b69c7e18eb532100ec9a82810206fea4";
                label: "Available actions";
                maxLength: 1024;
            },
        >;
        id: Typed<
            string
            | Record<keyof Tables>,
            {
                dependent: "table";
                label: [
                    {
                        hint: "The record the workflow instance is being executed on";
                        label: "Related record";
                        language: "en";
                        plural: "Related records";
                    },
                ];
                readOnly: true;
            },
        >;
        name: Typed<
            string,
            {
                label: [
                    {
                        hint: "Copied from workflow to make messages readable";
                        label: "Name";
                        language: "en";
                        plural: "Names";
                    },
                ];
                maxLength: 100;
                readOnly: true;
            },
        >;
        parent: Typed<
            | string
            | Record<"wf_context">
            | ExplicitKey<"wf_context">
            | TableBrand<"wf_context">,
            {
                attributes: { encode_utf8: false };
                label: [
                    {
                        label: "Parent Workflow";
                        language: "en";
                        plural: "Parent Workflows";
                    },
                ];
                readOnly: true;
                referenceTable: "wf_context";
            },
        >;
        parent_activity: Typed<
            | string
            | Record<"wf_executing">
            | ExplicitKey<"wf_executing">
            | TableBrand<"wf_executing">,
            {
                attributes: { encode_utf8: false };
                label: "Parent activity";
                readOnly: true;
                referenceTable: "wf_executing";
            },
        >;
        requires_ert: Typed<
            boolean,
            {
                default: false;
                label: [
                    {
                        hint: "Requires an estimated run time";
                        label: "Requires ERT";
                        language: "en";
                        plural: "Requires ERTs";
                    },
                ];
            },
        >;
        result: Typed<
            string,
            {
                label: [
                    {
                        hint: "May be (manually) set by workflow activity to indicate overall result";
                        label: "Result";
                        language: "en";
                        plural: "Results";
                    },
                ];
            },
        >;
        return_value: Typed<
            string,
            {
                label: [
                    {
                        hint: "Has a return value to the parent workflow";
                        label: "Return value";
                        language: "en";
                        plural: "Return values";
                    },
                ];
                readOnly: true;
            },
        >;
        running_duration: Typed<
            string
            | Duration,
            {
                label: [
                    {
                        hint: "Duration for which context was running";
                        label: "Running duration";
                        language: "en";
                        plural: "Running durations";
                    },
                ];
                maxLength: 40;
            },
        >;
        schedule: Typed<
            | string
            | Record<"cmn_schedule">
            | ExplicitKey<"cmn_schedule">
            | TableBrand<"cmn_schedule">,
            {
                attributes: { encode_utf8: false };
                label: [
                    {
                        hint: "Schedule";
                        label: "Schedule";
                        language: "en";
                        plural: "Schedules";
                    },
                ];
                referenceTable: "cmn_schedule";
            },
        >;
        scratchpad: Typed<
            string,
            {
                label: [
                    {
                        hint: "A json object containing all shared data between activities";
                        label: "Scratchpad";
                        language: "en";
                        plural: "Scratchpads";
                    },
                ];
                maxLength: 8000;
                readOnly: true;
            },
        >;
        stage: Typed<
            | string
            | Record<"wf_stage">
            | ExplicitKey<"wf_stage">
            | TableBrand<"wf_stage">,
            {
                attributes: { encode_utf8: false };
                cascadeRule: "clear";
                label: [
                    {
                        hint: "Current Workflow Stage";
                        label: "Stage";
                        language: "en";
                        plural: "Stages";
                    },
                ];
                referenceQual: "javascript:'workflow_version=' + current.workflow_version;";
                referenceTable: "wf_stage";
            },
        >;
        stage_state: Typed<
            string,
            {
                label: [
                    { label: "Stage states"; language: "en"; plural: "Stage stages" },
                ];
                maxLength: 8000;
                readOnly: true;
            },
        >;
        started: Typed<
            `${number}-${number}-${number} ${number}:${number}:${number}`,
            {
                label: [
                    {
                        hint: "Absolute time the workflow began";
                        label: "Started";
                        language: "en";
                        plural: "Started";
                    },
                ];
            },
        >;
        started_by: Typed<
            | string
            | Record<"sys_user">
            | ExplicitKey<"sys_user">
            | TableBrand<"sys_user">,
            {
                attributes: { encode_utf8: false };
                cascadeRule: "none";
                label: [
                    {
                        hint: "User that initiated this instance of workflow execution(if any)";
                        label: "Started by";
                        language: "en";
                        plural: "Started by";
                    },
                ];
                referenceTable: "sys_user";
            },
        >;
        state: Typed<
            string,
            {
                default: "executing";
                dropdown: "dropdown_without_none";
                label: [
                    {
                        hint: "Workflow execution state";
                        label: "State";
                        language: "en";
                        plural: "States";
                    },
                ];
            },
        >;
        sys_created_by: Typed<
            string,
            { label: [{ label: "Created by"; language: "en"; plural: "Created by" }] },
        >;
        sys_created_on: Typed<
            `${number}-${number}-${number} ${number}:${number}:${number}`,
            { label: [{ label: "Created"; language: "en"; plural: "Created" }] },
        >;
        sys_domain: Typed<
            Record<"domain">
            | "global",
            {
                default: "global";
                label: [
                    {
                        hint: "Domain to which the workflow belongs";
                        label: "Domain";
                        language: "en";
                        plural: "Domains";
                    },
                ];
            },
        >;
        sys_domain_path: Typed<
            string,
            {
                attributes: { case_sensitive: true };
                default: "/";
                label: "Domain Path";
            },
        >;
        sys_id: Typed<
            string,
            {
                label: [{ label: "Sys ID"; language: "en"; plural: "Sys IDs" }];
                primary: true;
            },
        >;
        sys_mod_count: Typed<
            number,
            { label: [{ label: "Updates"; language: "en"; plural: "Updates" }] },
        >;
        sys_updated_by: Typed<
            string,
            { label: [{ label: "Updated by"; language: "en"; plural: "Updated by" }] },
        >;
        sys_updated_on: Typed<
            `${number}-${number}-${number} ${number}:${number}:${number}`,
            { label: [{ label: "Updated"; language: "en"; plural: "Updated" }] },
        >;
        table: Typed<
            string
            | number,
            {
                columnType: "short_table_name";
                label: [
                    {
                        hint: "Table the related record belongs to";
                        label: "Table";
                        language: "en";
                        plural: "Tables";
                    },
                ];
                readOnly: true;
                tableReference: true;
            },
        >;
        timezone: Typed<
            string,
            {
                dropdown: "dropdown_with_none";
                dynamicValueDefinitions: {
                    field: "time_zone";
                    table: "sys_user";
                    type: "choices_from_other_table";
                };
                label: [
                    {
                        hint: "Timezone override";
                        label: "Timezone";
                        language: "en";
                        plural: "Timezones";
                    },
                ];
            },
        >;
        without_current_wf_actions: Typed<
            string
            | number,
            {
                attributes: { no_sort: true; slushbucket_ref_no_expand: true };
                columnType: "glide_action_list";
                default: "51782761ac1464174baaeb9af4b9ae76,b69c7e18eb532100ec9a82810206fea4";
                label: "Available actions";
                maxLength: 1024;
            },
        >;
        workflow: Typed<
            | string
            | Record<"wf_workflow">
            | ExplicitKey<"wf_workflow">
            | TableBrand<"wf_workflow">,
            {
                attributes: { encode_utf8: false };
                label: "Workflow";
                referenceTable: "wf_workflow";
            },
        >;
        workflow_version: Typed<
            | string
            | Record<"wf_workflow_version">
            | ExplicitKey<"wf_workflow_version">
            | TableBrand<"wf_workflow_version">,
            {
                attributes: { encode_utf8: false };
                label: [
                    {
                        hint: "Parent workflow version";
                        label: "Workflow version";
                        language: "en";
                        plural: "Workflow versions";
                    },
                ];
                readOnly: true;
                referenceTable: "wf_workflow_version";
            },
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    active: Typed<
        boolean,
        {
            default: true;
            label: [
                {
                    hint: "Active means have not reached a terminal state";
                    label: "Active";
                    language: "en";
                    plural: "Active";
                },
            ];
        },
    >
    activity_count: Typed<
        number,
        {
            default: "0";
            label: [
                {
                    hint: "Loop detection and prevention";
                    label: "Activity count";
                    language: "en";
                    plural: "Activity counts";
                },
            ];
        },
    >
    activity_index: Typed<
        number,
        {
            default: "0";
            label: [
                {
                    hint: "Index assigned to activities as they are transitioned to in the process of workflow execution";
                    label: "Activity index";
                    language: "en";
                    plural: "Activity indexes";
                },
            ];
        },
    >
    after_business_rules: Typed<
        boolean,
        {
            default: false;
            label: [
                {
                    hint: "Defer running of the workflow until all before and after business rules have completed";
                    label: "Run after bus. rules run";
                    language: "en";
                    plural: "Run after bus. rules runs";
                },
            ];
        },
    >
    auto_start: Typed<boolean, { label: "Auto start" }>
    column_renderer: Typed<
        | string
        | Record<"column_renderer">
        | ExplicitKey<"column_renderer">
        | TableBrand<"column_renderer">,
        {
            attributes: { encode_utf8: false };
            dropdown: "dropdown_without_none";
            label: [
                {
                    hint: "Type of display for stages";
                    label: "Stage rendering";
                    language: "en";
                    plural: "Stage renderings";
                },
            ];
            referenceTable: "column_renderer";
        },
    >
    cumulated_avg_ert: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Cumulated average estimated run time";
                    label: "Cumulative to ERT";
                    language: "en";
                    plural: "Cumulative to ERTs";
                },
            ];
        },
    >
    due: Typed<
        `${number}-${number}-${number} ${number}:${number}:${number}`,
        {
            label: [
                {
                    hint: "Estimated Completion Date";
                    label: "Due";
                    language: "en";
                    plural: "Dues";
                },
            ];
        },
    >
    ended: Typed<
        `${number}-${number}-${number} ${number}:${number}:${number}`,
        {
            label: [
                {
                    hint: "Absolute time the workflow completed";
                    label: "Ended";
                    language: "en";
                    plural: "Ended";
                },
            ];
        },
    >
    ert_long_running_actions: Typed<
        string
        | number,
        {
            attributes: { no_sort: true; slushbucket_ref_no_expand: true };
            columnType: "glide_action_list";
            default: "51782761ac1464174baaeb9af4b9ae76,803b3c728f320100ec9a6441f0f923ef,b69c7e18eb532100ec9a82810206fea4";
            label: "Available actions";
            maxLength: 1024;
        },
    >
    ert_outlier_workflow_actions: Typed<
        string
        | number,
        {
            attributes: { no_sort: true; slushbucket_ref_no_expand: true };
            columnType: "glide_action_list";
            default: "b69c7e18eb532100ec9a82810206fea4";
            label: "Available actions";
            maxLength: 1024;
        },
    >
    id: Typed<
        string
        | Record<keyof Tables>,
        {
            dependent: "table";
            label: [
                {
                    hint: "The record the workflow instance is being executed on";
                    label: "Related record";
                    language: "en";
                    plural: "Related records";
                },
            ];
            readOnly: true;
        },
    >
    name: Typed<
        string,
        {
            label: [
                {
                    hint: "Copied from workflow to make messages readable";
                    label: "Name";
                    language: "en";
                    plural: "Names";
                },
            ];
            maxLength: 100;
            readOnly: true;
        },
    >
    parent: Typed<
        | string
        | Record<"wf_context">
        | ExplicitKey<"wf_context">
        | TableBrand<"wf_context">,
        {
            attributes: { encode_utf8: false };
            label: [
                {
                    label: "Parent Workflow";
                    language: "en";
                    plural: "Parent Workflows";
                },
            ];
            readOnly: true;
            referenceTable: "wf_context";
        },
    >
    parent_activity: Typed<
        | string
        | Record<"wf_executing">
        | ExplicitKey<"wf_executing">
        | TableBrand<"wf_executing">,
        {
            attributes: { encode_utf8: false };
            label: "Parent activity";
            readOnly: true;
            referenceTable: "wf_executing";
        },
    >
    requires_ert: Typed<
        boolean,
        {
            default: false;
            label: [
                {
                    hint: "Requires an estimated run time";
                    label: "Requires ERT";
                    language: "en";
                    plural: "Requires ERTs";
                },
            ];
        },
    >
    result: Typed<
        string,
        {
            label: [
                {
                    hint: "May be (manually) set by workflow activity to indicate overall result";
                    label: "Result";
                    language: "en";
                    plural: "Results";
                },
            ];
        },
    >
    return_value: Typed<
        string,
        {
            label: [
                {
                    hint: "Has a return value to the parent workflow";
                    label: "Return value";
                    language: "en";
                    plural: "Return values";
                },
            ];
            readOnly: true;
        },
    >
    running_duration: Typed<
        string
        | Duration,
        {
            label: [
                {
                    hint: "Duration for which context was running";
                    label: "Running duration";
                    language: "en";
                    plural: "Running durations";
                },
            ];
            maxLength: 40;
        },
    >
    schedule: Typed<
        | string
        | Record<"cmn_schedule">
        | ExplicitKey<"cmn_schedule">
        | TableBrand<"cmn_schedule">,
        {
            attributes: { encode_utf8: false };
            label: [
                {
                    hint: "Schedule";
                    label: "Schedule";
                    language: "en";
                    plural: "Schedules";
                },
            ];
            referenceTable: "cmn_schedule";
        },
    >
    scratchpad: Typed<
        string,
        {
            label: [
                {
                    hint: "A json object containing all shared data between activities";
                    label: "Scratchpad";
                    language: "en";
                    plural: "Scratchpads";
                },
            ];
            maxLength: 8000;
            readOnly: true;
        },
    >
    stage: Typed<
        | string
        | Record<"wf_stage">
        | ExplicitKey<"wf_stage">
        | TableBrand<"wf_stage">,
        {
            attributes: { encode_utf8: false };
            cascadeRule: "clear";
            label: [
                {
                    hint: "Current Workflow Stage";
                    label: "Stage";
                    language: "en";
                    plural: "Stages";
                },
            ];
            referenceQual: "javascript:'workflow_version=' + current.workflow_version;";
            referenceTable: "wf_stage";
        },
    >
    stage_state: Typed<
        string,
        {
            label: [
                { label: "Stage states"; language: "en"; plural: "Stage stages" },
            ];
            maxLength: 8000;
            readOnly: true;
        },
    >
    started: Typed<
        `${number}-${number}-${number} ${number}:${number}:${number}`,
        {
            label: [
                {
                    hint: "Absolute time the workflow began";
                    label: "Started";
                    language: "en";
                    plural: "Started";
                },
            ];
        },
    >
    started_by: Typed<
        | string
        | Record<"sys_user">
        | ExplicitKey<"sys_user">
        | TableBrand<"sys_user">,
        {
            attributes: { encode_utf8: false };
            cascadeRule: "none";
            label: [
                {
                    hint: "User that initiated this instance of workflow execution(if any)";
                    label: "Started by";
                    language: "en";
                    plural: "Started by";
                },
            ];
            referenceTable: "sys_user";
        },
    >
    state: Typed<
        string,
        {
            default: "executing";
            dropdown: "dropdown_without_none";
            label: [
                {
                    hint: "Workflow execution state";
                    label: "State";
                    language: "en";
                    plural: "States";
                },
            ];
        },
    >
    sys_created_by: Typed<
        string,
        { label: [{ label: "Created by"; language: "en"; plural: "Created by" }] },
    >
    sys_created_on: Typed<
        `${number}-${number}-${number} ${number}:${number}:${number}`,
        { label: [{ label: "Created"; language: "en"; plural: "Created" }] },
    >
    sys_domain: Typed<
        Record<"domain">
        | "global",
        {
            default: "global";
            label: [
                {
                    hint: "Domain to which the workflow belongs";
                    label: "Domain";
                    language: "en";
                    plural: "Domains";
                },
            ];
        },
    >
    sys_domain_path: Typed<
        string,
        {
            attributes: { case_sensitive: true };
            default: "/";
            label: "Domain Path";
        },
    >
    sys_id: Typed<
        string,
        {
            label: [{ label: "Sys ID"; language: "en"; plural: "Sys IDs" }];
            primary: true;
        },
    >
    sys_mod_count: Typed<
        number,
        { label: [{ label: "Updates"; language: "en"; plural: "Updates" }] },
    >
    sys_updated_by: Typed<
        string,
        { label: [{ label: "Updated by"; language: "en"; plural: "Updated by" }] },
    >
    sys_updated_on: Typed<
        `${number}-${number}-${number} ${number}:${number}:${number}`,
        { label: [{ label: "Updated"; language: "en"; plural: "Updated" }] },
    >
    table: Typed<
        string
        | number,
        {
            columnType: "short_table_name";
            label: [
                {
                    hint: "Table the related record belongs to";
                    label: "Table";
                    language: "en";
                    plural: "Tables";
                },
            ];
            readOnly: true;
            tableReference: true;
        },
    >
    timezone: Typed<
        string,
        {
            dropdown: "dropdown_with_none";
            dynamicValueDefinitions: {
                field: "time_zone";
                table: "sys_user";
                type: "choices_from_other_table";
            };
            label: [
                {
                    hint: "Timezone override";
                    label: "Timezone";
                    language: "en";
                    plural: "Timezones";
                },
            ];
        },
    >
    without_current_wf_actions: Typed<
        string
        | number,
        {
            attributes: { no_sort: true; slushbucket_ref_no_expand: true };
            columnType: "glide_action_list";
            default: "51782761ac1464174baaeb9af4b9ae76,b69c7e18eb532100ec9a82810206fea4";
            label: "Available actions";
            maxLength: 1024;
        },
    >
    workflow: Typed<
        | string
        | Record<"wf_workflow">
        | ExplicitKey<"wf_workflow">
        | TableBrand<"wf_workflow">,
        {
            attributes: { encode_utf8: false };
            label: "Workflow";
            referenceTable: "wf_workflow";
        },
    >
    workflow_version: Typed<
        | string
        | Record<"wf_workflow_version">
        | ExplicitKey<"wf_workflow_version">
        | TableBrand<"wf_workflow_version">,
        {
            attributes: { encode_utf8: false };
            label: [
                {
                    hint: "Parent workflow version";
                    label: "Workflow version";
                    language: "en";
                    plural: "Workflow versions";
                },
            ];
            readOnly: true;
            referenceTable: "wf_workflow_version";
        },
    >