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

    Variable kb_knowledge_baseConst

    kb_knowledge_base: {
        actions: ["read", "update", "create"];
        allowClientScripts: true;
        allowNewFields: true;
        allowUiActions: true;
        allowWebServiceAccess: true;
        display: "title";
        label: "Knowledge Base";
        name: "kb_knowledge_base";
        schema: {
            active: Typed<boolean, { default: true; label: "Active" }>;
            application: Typed<
                | string
                | ExplicitKey<"sys_scope">
                | TableBrand<"sys_scope">
                | Record<"sys_scope">,
                {
                    attributes: { encode_utf8: false; readonly_clickthrough: true };
                    cascadeRule: "none";
                    default: "javascript:(function() {if (gs.isCurrentApplicationInGlobalScope()) return gs.getCurrentApplicationScope(); else return gs.getCurrentApplicationId();})()";
                    label: [
                        {
                            hint: "Application scope for this knowledge base";
                            label: "Application";
                            language: "en";
                            plural: "Applications";
                        },
                    ];
                    mandatory: true;
                    referenceTable: "sys_scope";
                },
            >;
            approval_description: Typed<
                string,
                {
                    attributes: {
                        serializer: "com.glide.script.TranslatedTextXMLSerializer";
                    };
                    label: [
                        {
                            hint: "A short description of who will approve content in this knowledge base";
                            label: "Approval description";
                            language: "en";
                            plural: "Approval descriptions";
                        },
                    ];
                    maxLength: 4000;
                },
            >;
            article_validity: Typed<
                number,
                {
                    label: [
                        {
                            hint: "Number of days the article is valid for.";
                            label: "Article Validity";
                            language: "en";
                            plural: "Article Validities";
                        },
                    ];
                    maxLength: 32;
                },
            >;
            card_color: Typed<
                string
                | number,
                {
                    columnType: "color";
                    label: [
                        {
                            hint: "Color that represents this Knowledge Base";
                            label: "Card color";
                            language: "en";
                            plural: "Card colors";
                        },
                    ];
                },
            >;
            checklist: Typed<
                | string
                | Record<"kb_quality_checklist">
                | ExplicitKey<"kb_quality_checklist">
                | TableBrand<"kb_quality_checklist">,
                {
                    attributes: { encode_utf8: false };
                    label: "Checklist";
                    referenceTable: "kb_quality_checklist";
                },
            >;
            data_policy: Typed<
                | string
                | Record<"sys_data_policy2">
                | ExplicitKey<"sys_data_policy2">
                | TableBrand<"sys_data_policy2">,
                {
                    attributes: { encode_utf8: false };
                    label: "Data policy";
                    referenceTable: "sys_data_policy2";
                },
            >;
            description: Typed<
                string,
                {
                    attributes: {
                        serializer: "com.glide.script.TranslatedTextXMLSerializer";
                    };
                    label: "Description";
                    maxLength: 4000;
                },
            >;
            disable_category_editing: Typed<
                boolean,
                {
                    default: false;
                    label: [
                        {
                            label: "Disable category editing";
                            language: "en";
                            plural: "Disable category editing";
                        },
                    ];
                },
            >;
            disable_commenting: Typed<
                boolean,
                {
                    default: false;
                    label: [
                        {
                            hint: "Disables writing comments to an article for all articles belonging to this knowledge base";
                            label: "Disable commenting";
                            language: "en";
                            plural: "Disable commenting";
                        },
                    ];
                },
            >;
            disable_mark_as_helpful: Typed<
                boolean,
                {
                    default: false;
                    label: [
                        {
                            hint: "Removes mark as helpful option for all articles belonging to this knowledge base";
                            label: "Disable mark as helpful";
                            language: "en";
                            plural: "Disable mark as helpfuls";
                        },
                    ];
                },
            >;
            disable_rating: Typed<
                boolean,
                {
                    default: false;
                    label: [
                        {
                            hint: "Removes star rating option for all articles belonging to this knowledge base";
                            label: "Disable rating";
                            language: "en";
                            plural: "Disable ratings";
                        },
                    ];
                },
            >;
            disable_suggesting: Typed<
                boolean,
                {
                    default: false;
                    label: [
                        {
                            hint: "Removes 'Flag Article' button from the article view for all articles belonging to this knowledge base";
                            label: "Disable suggesting";
                            language: "en";
                            plural: "Disable suggesting";
                        },
                    ];
                },
            >;
            enable_socialqa: Typed<
                boolean,
                {
                    default: false;
                    label: [
                        {
                            hint: "Enable social questions and answers for the knowledge base";
                            label: "Enable social questions and answers";
                            language: "en";
                            plural: "Enable social questions and answers";
                        },
                    ];
                },
            >;
            icon: Typed<
                string
                | number,
                {
                    attributes: { pdf_cell_type: "image" };
                    columnType: "user_image";
                    label: [
                        {
                            hint: "Icon that represents this Knowledge Base";
                            label: "Icon";
                            language: "en";
                            plural: "Icons";
                        },
                    ];
                },
            >;
            kb_managers: Typed<
                string
                | string[]
                | Record<"sys_user">[],
                {
                    attributes: {
                        no_email: true;
                        no_sort: true;
                        slushbucket_ref_no_expand: true;
                    };
                    label: "Managers";
                    referenceTable: "sys_user";
                },
            >;
            kb_publish_flow: Typed<
                | string
                | Record<"sys_hub_flow">
                | ExplicitKey<"sys_hub_flow">
                | TableBrand<"sys_hub_flow">,
                {
                    attributes: { encode_utf8: false };
                    label: "Publish flow";
                    referenceQual: "javascript: new KBFlow().getKnowledgeFlows()";
                    referenceTable: "sys_hub_flow";
                },
            >;
            kb_retire_flow: Typed<
                | string
                | Record<"sys_hub_flow">
                | ExplicitKey<"sys_hub_flow">
                | TableBrand<"sys_hub_flow">,
                {
                    attributes: { encode_utf8: false };
                    label: "Retire flow";
                    referenceQual: "javascript: new KBFlow().getKnowledgeFlows()";
                    referenceTable: "sys_hub_flow";
                },
            >;
            kb_version: Typed<
                string
                | number,
                {
                    default: "3";
                    dropdown: "dropdown_without_none";
                    label: [
                        {
                            hint: "Knowledge release version";
                            label: "Release version";
                            language: "en";
                            plural: "Release versions";
                        },
                    ];
                    readOnly: true;
                },
            >;
            mandatory_fields: Typed<
                string
                | unknown[],
                {
                    label: "Mandatory fields";
                    maxLength: 1000;
                    script: "getKBMandatoryFields()";
                },
            >;
            order: Typed<
                number,
                {
                    label: [
                        {
                            hint: "Order of importance for pinned articles query";
                            label: "Order";
                            language: "en";
                            plural: "Orders";
                        },
                    ];
                },
            >;
            owner: Typed<
                | string
                | Record<"sys_user">
                | ExplicitKey<"sys_user">
                | TableBrand<"sys_user">,
                {
                    attributes: { encode_utf8: false };
                    label: "Owner";
                    mandatory: true;
                    referenceTable: "sys_user";
                },
            >;
            question_annotation: Typed<
                string
                | number,
                {
                    attributes: {
                        encode_utf8: false;
                        serializer: "com.glide.script.TranslatedTextXMLSerializer";
                    };
                    columnType: "translated_html";
                    label: [
                        {
                            hint: "Annotation to question";
                            label: "Question annotation";
                            language: "en";
                            plural: "Question annotations";
                        },
                    ];
                    maxLength: 65000;
                },
            >;
            retire_workflow: Typed<
                | string
                | Record<"wf_workflow">
                | ExplicitKey<"wf_workflow">
                | TableBrand<"wf_workflow">,
                {
                    active: false;
                    attributes: { encode_utf8: false };
                    label: "Retire workflow";
                    referenceQual: "javascript:'sys_idIN'+(new KBWorkflow().getWorkflowIds().join());";
                    referenceTable: "wf_workflow";
                },
            >;
            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 record 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<
                keyof Tables,
                {
                    attributes: { base_start: true };
                    default: "kb_knowledge";
                    label: "Table";
                    readOnly: true;
                    tableReference: true;
                },
            >;
            template: Typed<
                string
                | TemplateValueElement<keyof Tables>,
                { dependent: "table"; label: "Set default knowledge field values" },
            >;
            title: Typed<
                string,
                {
                    attributes: {
                        serializer: "com.glide.script.TranslatedTextXMLSerializer";
                    };
                    label: [
                        {
                            hint: "The title of the knowledge base. This must be unique.";
                            label: "Title";
                            language: "en";
                            plural: "Titles";
                        },
                    ];
                    mandatory: true;
                    maxLength: 100;
                    textIndex: true;
                    unique: true;
                },
            >;
            workflow: Typed<
                | string
                | Record<"wf_workflow">
                | ExplicitKey<"wf_workflow">
                | TableBrand<"wf_workflow">,
                {
                    active: false;
                    attributes: { encode_utf8: false };
                    label: "Publish workflow";
                    referenceQual: "javascript:'sys_idIN'+(new KBWorkflow().getWorkflowIds().join());";
                    referenceTable: "wf_workflow";
                },
            >;
        };
    } = ...

    Type Declaration

    • Readonlyactions: ["read", "update", "create"]
    • ReadonlyallowClientScripts: true
    • ReadonlyallowNewFields: true
    • ReadonlyallowUiActions: true
    • ReadonlyallowWebServiceAccess: true
    • Readonlydisplay: "title"
    • Readonlylabel: "Knowledge Base"
    • Readonlyname: "kb_knowledge_base"
    • Readonlyschema: {
          active: Typed<boolean, { default: true; label: "Active" }>;
          application: Typed<
              | string
              | ExplicitKey<"sys_scope">
              | TableBrand<"sys_scope">
              | Record<"sys_scope">,
              {
                  attributes: { encode_utf8: false; readonly_clickthrough: true };
                  cascadeRule: "none";
                  default: "javascript:(function() {if (gs.isCurrentApplicationInGlobalScope()) return gs.getCurrentApplicationScope(); else return gs.getCurrentApplicationId();})()";
                  label: [
                      {
                          hint: "Application scope for this knowledge base";
                          label: "Application";
                          language: "en";
                          plural: "Applications";
                      },
                  ];
                  mandatory: true;
                  referenceTable: "sys_scope";
              },
          >;
          approval_description: Typed<
              string,
              {
                  attributes: {
                      serializer: "com.glide.script.TranslatedTextXMLSerializer";
                  };
                  label: [
                      {
                          hint: "A short description of who will approve content in this knowledge base";
                          label: "Approval description";
                          language: "en";
                          plural: "Approval descriptions";
                      },
                  ];
                  maxLength: 4000;
              },
          >;
          article_validity: Typed<
              number,
              {
                  label: [
                      {
                          hint: "Number of days the article is valid for.";
                          label: "Article Validity";
                          language: "en";
                          plural: "Article Validities";
                      },
                  ];
                  maxLength: 32;
              },
          >;
          card_color: Typed<
              string
              | number,
              {
                  columnType: "color";
                  label: [
                      {
                          hint: "Color that represents this Knowledge Base";
                          label: "Card color";
                          language: "en";
                          plural: "Card colors";
                      },
                  ];
              },
          >;
          checklist: Typed<
              | string
              | Record<"kb_quality_checklist">
              | ExplicitKey<"kb_quality_checklist">
              | TableBrand<"kb_quality_checklist">,
              {
                  attributes: { encode_utf8: false };
                  label: "Checklist";
                  referenceTable: "kb_quality_checklist";
              },
          >;
          data_policy: Typed<
              | string
              | Record<"sys_data_policy2">
              | ExplicitKey<"sys_data_policy2">
              | TableBrand<"sys_data_policy2">,
              {
                  attributes: { encode_utf8: false };
                  label: "Data policy";
                  referenceTable: "sys_data_policy2";
              },
          >;
          description: Typed<
              string,
              {
                  attributes: {
                      serializer: "com.glide.script.TranslatedTextXMLSerializer";
                  };
                  label: "Description";
                  maxLength: 4000;
              },
          >;
          disable_category_editing: Typed<
              boolean,
              {
                  default: false;
                  label: [
                      {
                          label: "Disable category editing";
                          language: "en";
                          plural: "Disable category editing";
                      },
                  ];
              },
          >;
          disable_commenting: Typed<
              boolean,
              {
                  default: false;
                  label: [
                      {
                          hint: "Disables writing comments to an article for all articles belonging to this knowledge base";
                          label: "Disable commenting";
                          language: "en";
                          plural: "Disable commenting";
                      },
                  ];
              },
          >;
          disable_mark_as_helpful: Typed<
              boolean,
              {
                  default: false;
                  label: [
                      {
                          hint: "Removes mark as helpful option for all articles belonging to this knowledge base";
                          label: "Disable mark as helpful";
                          language: "en";
                          plural: "Disable mark as helpfuls";
                      },
                  ];
              },
          >;
          disable_rating: Typed<
              boolean,
              {
                  default: false;
                  label: [
                      {
                          hint: "Removes star rating option for all articles belonging to this knowledge base";
                          label: "Disable rating";
                          language: "en";
                          plural: "Disable ratings";
                      },
                  ];
              },
          >;
          disable_suggesting: Typed<
              boolean,
              {
                  default: false;
                  label: [
                      {
                          hint: "Removes 'Flag Article' button from the article view for all articles belonging to this knowledge base";
                          label: "Disable suggesting";
                          language: "en";
                          plural: "Disable suggesting";
                      },
                  ];
              },
          >;
          enable_socialqa: Typed<
              boolean,
              {
                  default: false;
                  label: [
                      {
                          hint: "Enable social questions and answers for the knowledge base";
                          label: "Enable social questions and answers";
                          language: "en";
                          plural: "Enable social questions and answers";
                      },
                  ];
              },
          >;
          icon: Typed<
              string
              | number,
              {
                  attributes: { pdf_cell_type: "image" };
                  columnType: "user_image";
                  label: [
                      {
                          hint: "Icon that represents this Knowledge Base";
                          label: "Icon";
                          language: "en";
                          plural: "Icons";
                      },
                  ];
              },
          >;
          kb_managers: Typed<
              string
              | string[]
              | Record<"sys_user">[],
              {
                  attributes: {
                      no_email: true;
                      no_sort: true;
                      slushbucket_ref_no_expand: true;
                  };
                  label: "Managers";
                  referenceTable: "sys_user";
              },
          >;
          kb_publish_flow: Typed<
              | string
              | Record<"sys_hub_flow">
              | ExplicitKey<"sys_hub_flow">
              | TableBrand<"sys_hub_flow">,
              {
                  attributes: { encode_utf8: false };
                  label: "Publish flow";
                  referenceQual: "javascript: new KBFlow().getKnowledgeFlows()";
                  referenceTable: "sys_hub_flow";
              },
          >;
          kb_retire_flow: Typed<
              | string
              | Record<"sys_hub_flow">
              | ExplicitKey<"sys_hub_flow">
              | TableBrand<"sys_hub_flow">,
              {
                  attributes: { encode_utf8: false };
                  label: "Retire flow";
                  referenceQual: "javascript: new KBFlow().getKnowledgeFlows()";
                  referenceTable: "sys_hub_flow";
              },
          >;
          kb_version: Typed<
              string
              | number,
              {
                  default: "3";
                  dropdown: "dropdown_without_none";
                  label: [
                      {
                          hint: "Knowledge release version";
                          label: "Release version";
                          language: "en";
                          plural: "Release versions";
                      },
                  ];
                  readOnly: true;
              },
          >;
          mandatory_fields: Typed<
              string
              | unknown[],
              {
                  label: "Mandatory fields";
                  maxLength: 1000;
                  script: "getKBMandatoryFields()";
              },
          >;
          order: Typed<
              number,
              {
                  label: [
                      {
                          hint: "Order of importance for pinned articles query";
                          label: "Order";
                          language: "en";
                          plural: "Orders";
                      },
                  ];
              },
          >;
          owner: Typed<
              | string
              | Record<"sys_user">
              | ExplicitKey<"sys_user">
              | TableBrand<"sys_user">,
              {
                  attributes: { encode_utf8: false };
                  label: "Owner";
                  mandatory: true;
                  referenceTable: "sys_user";
              },
          >;
          question_annotation: Typed<
              string
              | number,
              {
                  attributes: {
                      encode_utf8: false;
                      serializer: "com.glide.script.TranslatedTextXMLSerializer";
                  };
                  columnType: "translated_html";
                  label: [
                      {
                          hint: "Annotation to question";
                          label: "Question annotation";
                          language: "en";
                          plural: "Question annotations";
                      },
                  ];
                  maxLength: 65000;
              },
          >;
          retire_workflow: Typed<
              | string
              | Record<"wf_workflow">
              | ExplicitKey<"wf_workflow">
              | TableBrand<"wf_workflow">,
              {
                  active: false;
                  attributes: { encode_utf8: false };
                  label: "Retire workflow";
                  referenceQual: "javascript:'sys_idIN'+(new KBWorkflow().getWorkflowIds().join());";
                  referenceTable: "wf_workflow";
              },
          >;
          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 record 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<
              keyof Tables,
              {
                  attributes: { base_start: true };
                  default: "kb_knowledge";
                  label: "Table";
                  readOnly: true;
                  tableReference: true;
              },
          >;
          template: Typed<
              string
              | TemplateValueElement<keyof Tables>,
              { dependent: "table"; label: "Set default knowledge field values" },
          >;
          title: Typed<
              string,
              {
                  attributes: {
                      serializer: "com.glide.script.TranslatedTextXMLSerializer";
                  };
                  label: [
                      {
                          hint: "The title of the knowledge base. This must be unique.";
                          label: "Title";
                          language: "en";
                          plural: "Titles";
                      },
                  ];
                  mandatory: true;
                  maxLength: 100;
                  textIndex: true;
                  unique: true;
              },
          >;
          workflow: Typed<
              | string
              | Record<"wf_workflow">
              | ExplicitKey<"wf_workflow">
              | TableBrand<"wf_workflow">,
              {
                  active: false;
                  attributes: { encode_utf8: false };
                  label: "Publish workflow";
                  referenceQual: "javascript:'sys_idIN'+(new KBWorkflow().getWorkflowIds().join());";
                  referenceTable: "wf_workflow";
              },
          >;
      }