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

    Variable sc_categoryConst

    sc_category: {
        allowWebServiceAccess: true;
        attributes: {
            kagami_csindex_enabled: true;
            synch_attachments: true;
            text_index_translations: true;
            update_synch: true;
        };
        display: "title";
        extends: "sys_metadata";
        extensible: true;
        label: "Category";
        name: "sc_category";
        schema: {
            active: Typed<boolean, { default: true; label: "Active" }>;
            description: Typed<
                string,
                {
                    attributes: {
                        serializer: "com.glide.script.TranslatedTextXMLSerializer";
                    };
                    label: "Description";
                    maxLength: 4000;
                    textIndex: true;
                },
            >;
            entitlement_script: Typed<
                string
                | number,
                {
                    columnType: "script_plain";
                    label: "Entitlement script";
                    maxLength: 4000;
                },
            >;
            header_icon: Typed<
                string
                | number,
                {
                    attributes: { pdf_cell_type: "image" };
                    columnType: "user_image";
                    label: [
                        {
                            hint: "Icon to use on category headers";
                            label: "Header icon";
                            language: "en";
                            plural: "Header icons";
                        },
                    ];
                },
            >;
            homepage_image: Typed<
                string
                | number,
                {
                    attributes: { pdf_cell_type: "image" };
                    columnType: "user_image";
                    label: "Homepage image";
                },
            >;
            homepage_renderer: Typed<
                | string
                | Record<"sc_homepage_renderer">
                | ExplicitKey<"sc_homepage_renderer">
                | TableBrand<"sc_homepage_renderer">,
                {
                    attributes: { encode_utf8: false };
                    default: "47ebe8aa3742300054b6a3549dbe5dfa";
                    label: [
                        {
                            hint: "The homepage renderer for this category";
                            label: "Homepage renderer";
                            language: "en";
                            plural: "Homepage renderers";
                        },
                    ];
                    mandatory: false;
                    referenceTable: "sc_homepage_renderer";
                },
            >;
            icon: Typed<
                string
                | number,
                {
                    attributes: { pdf_cell_type: "image" };
                    columnType: "user_image";
                    label: [
                        {
                            hint: "Icon to use to signify this category";
                            label: "Icon";
                            language: "en";
                            plural: "Icons";
                        },
                    ];
                },
            >;
            image: Typed<
                string,
                { attributes: { pdf_cell_type: "basic_image" }; label: "Image" },
            >;
            location: Typed<
                | string
                | Record<"cmn_location">
                | ExplicitKey<"cmn_location">
                | TableBrand<"cmn_location">,
                {
                    attributes: { encode_utf8: false; tree_picker: true };
                    label: "Location";
                    referenceTable: "cmn_location";
                },
            >;
            mobile_hide_description: Typed<
                boolean,
                {
                    default: false;
                    label: [
                        {
                            hint: "Hide the description of the category being browsed in the classic mobile UI";
                            label: "Hide description (classic mobile browsing)";
                            language: "en";
                            plural: "Hide description (classic mobile browsing)";
                        },
                    ];
                },
            >;
            mobile_picture: Typed<
                string
                | number,
                {
                    attributes: { pdf_cell_type: "image" };
                    columnType: "user_image";
                    label: [
                        {
                            hint: "The picture to use when displayed as a card in the classic mobile UI";
                            label: "Classic Mobile image";
                            language: "en";
                            plural: "Classic Mobile images";
                        },
                    ];
                },
            >;
            mobile_subcategory_render_type: Typed<
                "list"
                | "card",
                {
                    choices: {
                        card: { label: "Card"; sequence: 1 };
                        list: { label: "List"; sequence: 0 };
                    };
                    default: "list";
                    dropdown: "dropdown_without_none";
                    label: [
                        {
                            hint: "Choose the way in which subcategories will be rendered in listings for the classic mobile UI";
                            label: "Classic Mobile Subcategory Render Type";
                            language: "en";
                            plural: "Classic Mobile Subcategory Render Types";
                        },
                    ];
                },
            >;
            module: Typed<
                | string
                | Record<"sys_app_module">
                | ExplicitKey<"sys_app_module">
                | TableBrand<"sys_app_module">,
                {
                    attributes: { encode_utf8: false };
                    label: [
                        {
                            hint: "Override normal category behavior and make this category a link to a URI specified by the referenced module";
                            label: "Module link";
                            language: "en";
                            plural: "Module links";
                        },
                    ];
                    referenceTable: "sys_app_module";
                },
            >;
            order: Typed<
                number,
                {
                    default: "0";
                    label: [
                        {
                            hint: "Order this category will use when displayed on lists";
                            label: "Order";
                            language: "en";
                            plural: "Orders";
                        },
                    ];
                },
            >;
            parent: Typed<
                | string
                | Record<"sc_category">
                | ExplicitKey<"sc_category">
                | TableBrand<"sc_category">,
                {
                    attributes: {
                        ref_ac_columns: "sc_catalog";
                        ref_auto_completer: "AJAXTableCompleter";
                    };
                    label: "Parent";
                    referenceQual: "javascript: new Category().getReferenceQual(current);";
                    referenceTable: "sc_category";
                },
            >;
            roles: Typed<
                (string | Role)[],
                {
                    array: true;
                    attributes: { record_watcher_blacklist: true };
                    label: [
                        {
                            hint: "Who can view this catalog category";
                            label: "Roles";
                            language: "en";
                            plural: "Roles";
                        },
                    ];
                },
            >;
            sc_catalog: Typed<
                | string
                | Record<"sc_catalog">
                | ExplicitKey<"sc_catalog">
                | TableBrand<"sc_catalog">,
                {
                    default: "javascript: new Category().getDefaultCatalogValue();";
                    label: "Catalog";
                    referenceQual: "javascript: new SNCCatalogUtil().getReferenceQual('');";
                    referenceTable: "sc_catalog";
                },
            >;
            sys_id: Typed<
                string
                | number,
                { columnType: "GUID"; label: "Sys ID"; maxLength: 32; primary: true },
            >;
            title: Typed<
                string,
                {
                    attributes: {
                        serializer: "com.glide.script.TranslatedTextXMLSerializer";
                    };
                    label: "Title";
                    mandatory: true;
                    maxLength: 100;
                    textIndex: true;
                },
            >;
        };
        textIndex: true;
    } = ...

    Type Declaration

    • ReadonlyallowWebServiceAccess: true
    • Readonlyattributes: {
          kagami_csindex_enabled: true;
          synch_attachments: true;
          text_index_translations: true;
          update_synch: true;
      }
    • Readonlydisplay: "title"
    • Readonlyextends: "sys_metadata"
    • Readonlyextensible: true
    • Readonlylabel: "Category"
    • Readonlyname: "sc_category"
    • Readonlyschema: {
          active: Typed<boolean, { default: true; label: "Active" }>;
          description: Typed<
              string,
              {
                  attributes: {
                      serializer: "com.glide.script.TranslatedTextXMLSerializer";
                  };
                  label: "Description";
                  maxLength: 4000;
                  textIndex: true;
              },
          >;
          entitlement_script: Typed<
              string
              | number,
              {
                  columnType: "script_plain";
                  label: "Entitlement script";
                  maxLength: 4000;
              },
          >;
          header_icon: Typed<
              string
              | number,
              {
                  attributes: { pdf_cell_type: "image" };
                  columnType: "user_image";
                  label: [
                      {
                          hint: "Icon to use on category headers";
                          label: "Header icon";
                          language: "en";
                          plural: "Header icons";
                      },
                  ];
              },
          >;
          homepage_image: Typed<
              string
              | number,
              {
                  attributes: { pdf_cell_type: "image" };
                  columnType: "user_image";
                  label: "Homepage image";
              },
          >;
          homepage_renderer: Typed<
              | string
              | Record<"sc_homepage_renderer">
              | ExplicitKey<"sc_homepage_renderer">
              | TableBrand<"sc_homepage_renderer">,
              {
                  attributes: { encode_utf8: false };
                  default: "47ebe8aa3742300054b6a3549dbe5dfa";
                  label: [
                      {
                          hint: "The homepage renderer for this category";
                          label: "Homepage renderer";
                          language: "en";
                          plural: "Homepage renderers";
                      },
                  ];
                  mandatory: false;
                  referenceTable: "sc_homepage_renderer";
              },
          >;
          icon: Typed<
              string
              | number,
              {
                  attributes: { pdf_cell_type: "image" };
                  columnType: "user_image";
                  label: [
                      {
                          hint: "Icon to use to signify this category";
                          label: "Icon";
                          language: "en";
                          plural: "Icons";
                      },
                  ];
              },
          >;
          image: Typed<
              string,
              { attributes: { pdf_cell_type: "basic_image" }; label: "Image" },
          >;
          location: Typed<
              | string
              | Record<"cmn_location">
              | ExplicitKey<"cmn_location">
              | TableBrand<"cmn_location">,
              {
                  attributes: { encode_utf8: false; tree_picker: true };
                  label: "Location";
                  referenceTable: "cmn_location";
              },
          >;
          mobile_hide_description: Typed<
              boolean,
              {
                  default: false;
                  label: [
                      {
                          hint: "Hide the description of the category being browsed in the classic mobile UI";
                          label: "Hide description (classic mobile browsing)";
                          language: "en";
                          plural: "Hide description (classic mobile browsing)";
                      },
                  ];
              },
          >;
          mobile_picture: Typed<
              string
              | number,
              {
                  attributes: { pdf_cell_type: "image" };
                  columnType: "user_image";
                  label: [
                      {
                          hint: "The picture to use when displayed as a card in the classic mobile UI";
                          label: "Classic Mobile image";
                          language: "en";
                          plural: "Classic Mobile images";
                      },
                  ];
              },
          >;
          mobile_subcategory_render_type: Typed<
              "list"
              | "card",
              {
                  choices: {
                      card: { label: "Card"; sequence: 1 };
                      list: { label: "List"; sequence: 0 };
                  };
                  default: "list";
                  dropdown: "dropdown_without_none";
                  label: [
                      {
                          hint: "Choose the way in which subcategories will be rendered in listings for the classic mobile UI";
                          label: "Classic Mobile Subcategory Render Type";
                          language: "en";
                          plural: "Classic Mobile Subcategory Render Types";
                      },
                  ];
              },
          >;
          module: Typed<
              | string
              | Record<"sys_app_module">
              | ExplicitKey<"sys_app_module">
              | TableBrand<"sys_app_module">,
              {
                  attributes: { encode_utf8: false };
                  label: [
                      {
                          hint: "Override normal category behavior and make this category a link to a URI specified by the referenced module";
                          label: "Module link";
                          language: "en";
                          plural: "Module links";
                      },
                  ];
                  referenceTable: "sys_app_module";
              },
          >;
          order: Typed<
              number,
              {
                  default: "0";
                  label: [
                      {
                          hint: "Order this category will use when displayed on lists";
                          label: "Order";
                          language: "en";
                          plural: "Orders";
                      },
                  ];
              },
          >;
          parent: Typed<
              | string
              | Record<"sc_category">
              | ExplicitKey<"sc_category">
              | TableBrand<"sc_category">,
              {
                  attributes: {
                      ref_ac_columns: "sc_catalog";
                      ref_auto_completer: "AJAXTableCompleter";
                  };
                  label: "Parent";
                  referenceQual: "javascript: new Category().getReferenceQual(current);";
                  referenceTable: "sc_category";
              },
          >;
          roles: Typed<
              (string | Role)[],
              {
                  array: true;
                  attributes: { record_watcher_blacklist: true };
                  label: [
                      {
                          hint: "Who can view this catalog category";
                          label: "Roles";
                          language: "en";
                          plural: "Roles";
                      },
                  ];
              },
          >;
          sc_catalog: Typed<
              | string
              | Record<"sc_catalog">
              | ExplicitKey<"sc_catalog">
              | TableBrand<"sc_catalog">,
              {
                  default: "javascript: new Category().getDefaultCatalogValue();";
                  label: "Catalog";
                  referenceQual: "javascript: new SNCCatalogUtil().getReferenceQual('');";
                  referenceTable: "sc_catalog";
              },
          >;
          sys_id: Typed<
              string
              | number,
              { columnType: "GUID"; label: "Sys ID"; maxLength: 32; primary: true },
          >;
          title: Typed<
              string,
              {
                  attributes: {
                      serializer: "com.glide.script.TranslatedTextXMLSerializer";
                  };
                  label: "Title";
                  mandatory: true;
                  maxLength: 100;
                  textIndex: true;
              },
          >;
      }
    • ReadonlytextIndex: true