@servicenow/sdk - v4.13.3
    Preparing search index...
    interface sys_app_module {
        active: Typed<
            boolean,
            { default: true; label: "Active"; maxLength: 40 },
        >;
        application: Typed<
            | string
            | TableBrand<"sys_app_application">
            | Record<"sys_app_application">
            | ExplicitKey<"sys_app_application">,
            {
                label: [
                    {
                        hint: "The navigation menu where this module should reside";
                        label: "Application menu";
                        plural: "Application menu";
                    },
                ];
                maxLength: 32;
                referenceTable: "sys_app_application";
            },
        >;
        assessment: Typed<
            | string
            | ExplicitKey<"asmt_metric_type">
            | TableBrand<"asmt_metric_type">
            | Record<"asmt_metric_type">,
            {
                attributes: { encode_utf8: false };
                label: "Assessment";
                maxLength: 32;
                referenceTable: "asmt_metric_type";
            },
        >;
        device_type: Typed<
            "browser"
            | "any"
            | "mobile",
            {
                choices: {
                    any: { label: "Any" };
                    browser: { label: "Browser" };
                    mobile: { label: "Mobile" };
                };
                dropdown: "dropdown_with_none";
                label: [
                    {
                        hint: "Devices on which this module is available. Uses the application menu setting if not specified.";
                        label: "Device type";
                        plural: "Device types";
                    },
                ];
                maxLength: 40;
            },
        >;
        filter: Typed<
            string,
            { dependent: "name"; label: "Filter"; maxLength: 3500 },
        >;
        hint: Typed<
            string,
            { attributes: { no_truncate: true }; label: "Hint"; maxLength: 255 },
        >;
        homepage: Typed<
            | string
            | ExplicitKey<"sys_portal_page">
            | TableBrand<"sys_portal_page">
            | Record<"sys_portal_page">,
            {
                label: "Homepage";
                maxLength: 32;
                referenceQual: "view!=";
                referenceTable: "sys_portal_page";
                useReferenceQualifier: "simple";
            },
        >;
        image: Typed<string, { label: "Image (UI11)"; maxLength: 100 }>;
        link_type: Typed<
            | "LIST"
            | "ASSESSMENT"
            | "CONTENT_PAGE"
            | "DETAIL"
            | "DIRECT"
            | "DOC_LINK"
            | "FILTER"
            | "HOMEPAGE"
            | "HTML"
            | "MAP"
            | "NEW"
            | "REPORT"
            | "SCRIPT"
            | "SEARCH"
            | "SEPARATOR"
            | "SURVEY"
            | "TIMELINE",
            {
                choices: {
                    ASSESSMENT: { label: "Assessment" };
                    CONTENT_PAGE: { label: "Content Page" };
                    DETAIL: { label: "Single Record" };
                    DIRECT: { label: "URL (from Arguments:)" };
                    DOC_LINK: { label: "Documentation Link" };
                    FILTER: { label: "List Filter" };
                    HOMEPAGE: { inactive: true; label: "Homepage" };
                    HTML: { label: "HTML (from Arguments:)" };
                    LIST: { label: "List of Records" };
                    MAP: { label: "Map Page" };
                    NEW: { label: "New Record" };
                    REPORT: { label: "Run a Report" };
                    SCRIPT: { label: "Script (from Arguments:)" };
                    SEARCH: { label: "Search Screen" };
                    SEPARATOR: { label: "Separator" };
                    SURVEY: { label: "Survey" };
                    TIMELINE: { label: "Timeline Page" };
                };
                default: "LIST";
                dropdown: "dropdown_with_none";
                label: "Link type";
                maxLength: 40;
            },
        >;
        map_page: Typed<
            | string
            | ExplicitKey<"cmn_map_page">
            | TableBrand<"cmn_map_page">
            | Record<"cmn_map_page">,
            { label: "Map page"; maxLength: 32; referenceTable: "cmn_map_page" },
        >;
        mobile_title: Typed<
            string,
            {
                label: [
                    {
                        hint: "Display name on mobile devices";
                        label: "Mobile title";
                        plural: "Mobile titles";
                    },
                ];
                maxLength: 80;
            },
        >;
        mobile_view_name: Typed<
            string,
            {
                default: "Mobile";
                label: [
                    {
                        hint: "View used for mobile devices";
                        label: "Mobile view name";
                        plural: "Mobile view names";
                    },
                ];
                maxLength: 40;
            },
        >;
        name: Typed<
            keyof Tables,
            {
                attributes: { allow_public: true };
                label: "Table";
                maxLength: 80;
                tableReference: true;
            },
        >;
        order: Typed<number, { label: "Order"; maxLength: 15 }>;
        override_menu_roles: Typed<
            boolean,
            {
                default: false;
                label: [
                    {
                        hint: "Show this module when the user has the specified roles. Otherwise the user must have the roles specified by both the application menu and the module.";
                        label: "Override application menu roles";
                        plural: "Override application menu roles";
                    },
                ];
                maxLength: 40;
            },
        >;
        query: Typed<string, { label: "Arguments"; maxLength: 3500 }>;
        report: Typed<
            | string
            | Record<"sys_report">
            | ExplicitKey<"sys_report">
            | TableBrand<"sys_report">,
            {
                dependent: "name,table";
                label: "Report";
                maxLength: 32;
                referenceTable: "sys_report";
            },
        >;
        require_confirmation: Typed<
            boolean,
            {
                default: true;
                label: [
                    {
                        hint: "When selected, Script (from Arguments:) will require the user to click a button to confirm execution.";
                        label: "Require confirmation";
                        plural: "Require confirmations";
                    },
                ];
                maxLength: 40;
            },
        >;
        roles: Typed<
            (string | Role)[],
            {
                array: true;
                attributes: { no_truncate: true };
                label: "Roles";
                maxLength: 100;
            },
        >;
        route: Typed<
            | string
            | ExplicitKey<"sys_ux_app_route">
            | TableBrand<"sys_ux_app_route">
            | Record<"sys_ux_app_route">,
            {
                attributes: { encode_utf8: false };
                label: "Route";
                maxLength: 32;
                referenceTable: "sys_ux_app_route";
            },
        >;
        screen: Typed<
            | string
            | ExplicitKey<"sys_ux_screen">
            | TableBrand<"sys_ux_screen">
            | Record<"sys_ux_screen">,
            {
                attributes: { encode_utf8: false };
                label: "Screen";
                maxLength: 32;
                referenceTable: "sys_ux_screen";
            },
        >;
        sys_domain: Typed<
            string & {}
            | "global"
            | Record<"domain">,
            {
                default: "global";
                label: [
                    {
                        hint: "Domain to which the script belongs";
                        label: "Domain";
                        plural: "Domains";
                    },
                ];
                maxLength: 32;
            },
        >;
        sys_domain_path: Typed<
            string,
            {
                attributes: { case_sensitive: true };
                default: "/";
                label: "Domain Path";
                maxLength: 255;
            },
        >;
        sys_id: Typed<string, { label: "Sys ID"; maxLength: 32; primary: true }>;
        sys_overrides: Typed<
            | string
            | Record<"sys_app_module">
            | ExplicitKey<"sys_app_module">
            | TableBrand<"sys_app_module">,
            {
                label: [
                    {
                        hint: "Module being overridden by the current record";
                        label: "Overrides";
                        plural: "Overrides";
                    },
                ];
                maxLength: 32;
                referenceTable: "sys_app_module";
            },
        >;
        timeline_page: Typed<
            | string
            | ExplicitKey<"cmn_timeline_page">
            | TableBrand<"cmn_timeline_page">
            | Record<"cmn_timeline_page">,
            {
                attributes: { encode_utf8: false };
                label: "Timeline page";
                maxLength: 32;
                referenceTable: "cmn_timeline_page";
            },
        >;
        title: Typed<
            string,
            {
                label: [
                    {
                        hint: "Display name of the module";
                        label: "Title";
                        plural: "Titles";
                    },
                ];
                maxLength: 80;
            },
        >;
        uncancelable: Typed<
            boolean,
            {
                default: false;
                label: [
                    {
                        hint: "If this module is clicked, then another module is clicked, Setting this to true will prevent this module from being canceled.";
                        label: "Uncancelable by Other Modules";
                        plural: "Uncancelable by Other Modules";
                    },
                ];
                maxLength: 40;
            },
        >;
        ux_list: Typed<
            | string
            | ExplicitKey<"sys_ux_list">
            | TableBrand<"sys_ux_list">
            | Record<"sys_ux_list">,
            {
                attributes: { encode_utf8: false };
                label: "UX List";
                maxLength: 32;
                referenceTable: "sys_ux_list";
            },
        >;
        view_name: Typed<
            string,
            {
                default: "javascript:var viewDefault='';if(current.device_type=='mobile') viewDefault='Mobile';else if(!current.application.nil() && current.application.device_type=='mobile' && current.device_type.nil()) viewDefault='Mobile';viewDefault";
                label: "View name";
                maxLength: 40;
            },
        >;
        window_name: Typed<string, { label: "Window name"; maxLength: 40 }>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    active: Typed<boolean, { default: true; label: "Active"; maxLength: 40 }>
    application: Typed<
        | string
        | TableBrand<"sys_app_application">
        | Record<"sys_app_application">
        | ExplicitKey<"sys_app_application">,
        {
            label: [
                {
                    hint: "The navigation menu where this module should reside";
                    label: "Application menu";
                    plural: "Application menu";
                },
            ];
            maxLength: 32;
            referenceTable: "sys_app_application";
        },
    >
    assessment: Typed<
        | string
        | ExplicitKey<"asmt_metric_type">
        | TableBrand<"asmt_metric_type">
        | Record<"asmt_metric_type">,
        {
            attributes: { encode_utf8: false };
            label: "Assessment";
            maxLength: 32;
            referenceTable: "asmt_metric_type";
        },
    >
    device_type: Typed<
        "browser"
        | "any"
        | "mobile",
        {
            choices: {
                any: { label: "Any" };
                browser: { label: "Browser" };
                mobile: { label: "Mobile" };
            };
            dropdown: "dropdown_with_none";
            label: [
                {
                    hint: "Devices on which this module is available. Uses the application menu setting if not specified.";
                    label: "Device type";
                    plural: "Device types";
                },
            ];
            maxLength: 40;
        },
    >
    filter: Typed<string, { dependent: "name"; label: "Filter"; maxLength: 3500 }>
    hint: Typed<
        string,
        { attributes: { no_truncate: true }; label: "Hint"; maxLength: 255 },
    >
    homepage: Typed<
        | string
        | ExplicitKey<"sys_portal_page">
        | TableBrand<"sys_portal_page">
        | Record<"sys_portal_page">,
        {
            label: "Homepage";
            maxLength: 32;
            referenceQual: "view!=";
            referenceTable: "sys_portal_page";
            useReferenceQualifier: "simple";
        },
    >
    image: Typed<string, { label: "Image (UI11)"; maxLength: 100 }>
    link_type: Typed<
        | "LIST"
        | "ASSESSMENT"
        | "CONTENT_PAGE"
        | "DETAIL"
        | "DIRECT"
        | "DOC_LINK"
        | "FILTER"
        | "HOMEPAGE"
        | "HTML"
        | "MAP"
        | "NEW"
        | "REPORT"
        | "SCRIPT"
        | "SEARCH"
        | "SEPARATOR"
        | "SURVEY"
        | "TIMELINE",
        {
            choices: {
                ASSESSMENT: { label: "Assessment" };
                CONTENT_PAGE: { label: "Content Page" };
                DETAIL: { label: "Single Record" };
                DIRECT: { label: "URL (from Arguments:)" };
                DOC_LINK: { label: "Documentation Link" };
                FILTER: { label: "List Filter" };
                HOMEPAGE: { inactive: true; label: "Homepage" };
                HTML: { label: "HTML (from Arguments:)" };
                LIST: { label: "List of Records" };
                MAP: { label: "Map Page" };
                NEW: { label: "New Record" };
                REPORT: { label: "Run a Report" };
                SCRIPT: { label: "Script (from Arguments:)" };
                SEARCH: { label: "Search Screen" };
                SEPARATOR: { label: "Separator" };
                SURVEY: { label: "Survey" };
                TIMELINE: { label: "Timeline Page" };
            };
            default: "LIST";
            dropdown: "dropdown_with_none";
            label: "Link type";
            maxLength: 40;
        },
    >
    map_page: Typed<
        | string
        | ExplicitKey<"cmn_map_page">
        | TableBrand<"cmn_map_page">
        | Record<"cmn_map_page">,
        { label: "Map page"; maxLength: 32; referenceTable: "cmn_map_page" },
    >
    mobile_title: Typed<
        string,
        {
            label: [
                {
                    hint: "Display name on mobile devices";
                    label: "Mobile title";
                    plural: "Mobile titles";
                },
            ];
            maxLength: 80;
        },
    >
    mobile_view_name: Typed<
        string,
        {
            default: "Mobile";
            label: [
                {
                    hint: "View used for mobile devices";
                    label: "Mobile view name";
                    plural: "Mobile view names";
                },
            ];
            maxLength: 40;
        },
    >
    name: Typed<
        keyof Tables,
        {
            attributes: { allow_public: true };
            label: "Table";
            maxLength: 80;
            tableReference: true;
        },
    >
    order: Typed<number, { label: "Order"; maxLength: 15 }>
    override_menu_roles: Typed<
        boolean,
        {
            default: false;
            label: [
                {
                    hint: "Show this module when the user has the specified roles. Otherwise the user must have the roles specified by both the application menu and the module.";
                    label: "Override application menu roles";
                    plural: "Override application menu roles";
                },
            ];
            maxLength: 40;
        },
    >
    query: Typed<string, { label: "Arguments"; maxLength: 3500 }>
    report: Typed<
        | string
        | Record<"sys_report">
        | ExplicitKey<"sys_report">
        | TableBrand<"sys_report">,
        {
            dependent: "name,table";
            label: "Report";
            maxLength: 32;
            referenceTable: "sys_report";
        },
    >
    require_confirmation: Typed<
        boolean,
        {
            default: true;
            label: [
                {
                    hint: "When selected, Script (from Arguments:) will require the user to click a button to confirm execution.";
                    label: "Require confirmation";
                    plural: "Require confirmations";
                },
            ];
            maxLength: 40;
        },
    >
    roles: Typed<
        (string | Role)[],
        {
            array: true;
            attributes: { no_truncate: true };
            label: "Roles";
            maxLength: 100;
        },
    >
    route: Typed<
        | string
        | ExplicitKey<"sys_ux_app_route">
        | TableBrand<"sys_ux_app_route">
        | Record<"sys_ux_app_route">,
        {
            attributes: { encode_utf8: false };
            label: "Route";
            maxLength: 32;
            referenceTable: "sys_ux_app_route";
        },
    >
    screen: Typed<
        | string
        | ExplicitKey<"sys_ux_screen">
        | TableBrand<"sys_ux_screen">
        | Record<"sys_ux_screen">,
        {
            attributes: { encode_utf8: false };
            label: "Screen";
            maxLength: 32;
            referenceTable: "sys_ux_screen";
        },
    >
    sys_domain: Typed<
        string & {}
        | "global"
        | Record<"domain">,
        {
            default: "global";
            label: [
                {
                    hint: "Domain to which the script belongs";
                    label: "Domain";
                    plural: "Domains";
                },
            ];
            maxLength: 32;
        },
    >
    sys_domain_path: Typed<
        string,
        {
            attributes: { case_sensitive: true };
            default: "/";
            label: "Domain Path";
            maxLength: 255;
        },
    >
    sys_id: Typed<string, { label: "Sys ID"; maxLength: 32; primary: true }>
    sys_overrides: Typed<
        | string
        | Record<"sys_app_module">
        | ExplicitKey<"sys_app_module">
        | TableBrand<"sys_app_module">,
        {
            label: [
                {
                    hint: "Module being overridden by the current record";
                    label: "Overrides";
                    plural: "Overrides";
                },
            ];
            maxLength: 32;
            referenceTable: "sys_app_module";
        },
    >
    timeline_page: Typed<
        | string
        | ExplicitKey<"cmn_timeline_page">
        | TableBrand<"cmn_timeline_page">
        | Record<"cmn_timeline_page">,
        {
            attributes: { encode_utf8: false };
            label: "Timeline page";
            maxLength: 32;
            referenceTable: "cmn_timeline_page";
        },
    >
    title: Typed<
        string,
        {
            label: [
                {
                    hint: "Display name of the module";
                    label: "Title";
                    plural: "Titles";
                },
            ];
            maxLength: 80;
        },
    >
    uncancelable: Typed<
        boolean,
        {
            default: false;
            label: [
                {
                    hint: "If this module is clicked, then another module is clicked, Setting this to true will prevent this module from being canceled.";
                    label: "Uncancelable by Other Modules";
                    plural: "Uncancelable by Other Modules";
                },
            ];
            maxLength: 40;
        },
    >
    ux_list: Typed<
        | string
        | ExplicitKey<"sys_ux_list">
        | TableBrand<"sys_ux_list">
        | Record<"sys_ux_list">,
        {
            attributes: { encode_utf8: false };
            label: "UX List";
            maxLength: 32;
            referenceTable: "sys_ux_list";
        },
    >
    view_name: Typed<
        string,
        {
            default: "javascript:var viewDefault='';if(current.device_type=='mobile') viewDefault='Mobile';else if(!current.application.nil() && current.application.device_type=='mobile' && current.device_type.nil()) viewDefault='Mobile';viewDefault";
            label: "View name";
            maxLength: 40;
        },
    >
    window_name: Typed<string, { label: "Window name"; maxLength: 40 }>