Variable kb_knowledgeConst

Type Declaration

• Readonlyactions: ["read", "update", "create"]

• ReadonlyallowClientScripts: true

• ReadonlyallowNewFields: true

• ReadonlyallowUiActions: true

• ReadonlyallowWebServiceAccess: true

• Readonlyattributes: {
      "all_tables.text_index_translations": true;
      attachment_index: true;
      document_viewer_audit: "all";
      global_search_config_handler: "KnowledgeArticle";
      text_index_attachment_displayed: true;
      text_index_enable_idf: true;
      text_index_filter_junk: false;
      use_document_viewer: true;
  }

• Readonlyaudit: true

• ReadonlyautoNumber: { number: 10000; prefix: "KB" }

• Readonlydisplay: "display_number"

• Readonlyextensible: true

• Readonlylabel: "Knowledge"

• Readonlyname: "kb_knowledge"

• Readonlyschema: {
      active: Typed<
          boolean,
          {
              attributes: { ignore_filter_on_new: true };
              default: true;
              label: [
                  {
                      hint: "Part of the active Knowledge Base";
                      label: "Active";
                      language: "en";
                      plural: "Active";
                  },
              ];
          },
      >;
      article_id: Typed<
          string,
          { label: "Article ID"; maxLength: 32; readOnly: true },
      >;
      article_type: Typed<
          string,
          {
              default: "text";
              dropdown: "dropdown_without_none";
              label: [
                  {
                      hint: "Type of article";
                      label: "Article type";
                      language: "en";
                      plural: "Article types";
                  },
              ];
          },
      >;
      author: Typed<
          | string
          | Record<"sys_user">
          | ExplicitKey<"sys_user">
          | TableBrand<"sys_user">,
          {
              attributes: { encode_utf8: false };
              default: "javascript:gs.getUserID()";
              label: [
                  {
                      hint: "Primary author of this article";
                      label: "Author";
                      language: "en";
                      plural: "Authors";
                  },
              ];
              referenceTable: "sys_user";
          },
      >;
      base_version: Typed<
          | string
          | Record<"kb_knowledge">
          | ExplicitKey<"kb_knowledge">
          | TableBrand<"kb_knowledge">,
          {
              attributes: { encode_utf8: false; readonly_clickthrough: true };
              label: "Base Version";
              readOnly: true;
              referenceTable: "kb_knowledge";
          },
      >;
      can_read_user_criteria: Typed<
          string
          | string[]
          | Record<"user_criteria">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              label: "Can Read";
              maxLength: 1024;
              referenceQual: "active=true^EQ";
              referenceTable: "user_criteria";
          },
      >;
      cannot_read_user_criteria: Typed<
          string
          | string[]
          | Record<"user_criteria">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              label: "Cannot Read";
              maxLength: 1024;
              referenceQual: "active=true^EQ";
              referenceTable: "user_criteria";
          },
      >;
      category: Typed<
          string,
          {
              dependent: "topic";
              dropdown: "dropdown_with_none";
              label: [
                  {
                      hint: "Lower level of article categorization - Topics can have multiple Categories";
                      label: "Category";
                      language: "en";
                      plural: "Categories";
                  },
              ];
          },
      >;
      cmdb_ci: Typed<
          | string
          | Record<"cmdb_ci">
          | ExplicitKey<"cmdb_ci">
          | TableBrand<"cmdb_ci">,
          {
              attributes: { encode_utf8: false };
              label: "Configuration item";
              referenceTable: "cmdb_ci";
          },
      >;
      description: Typed<
          string,
          {
              label: [
                  {
                      hint: "Purpose of the article, not displayed in the Knowledge Base. This field can be used for internal notes.";
                      label: "Description";
                      language: "en";
                      plural: "Descriptions";
                  },
              ];
              maxLength: 4000;
          },
      >;
      direct: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Clicking an article downloads its attachment instead of opening it in normal article view";
                      label: "Attachment link";
                      language: "en";
                      plural: "Attachment links";
                  },
              ];
          },
      >;
      disable_commenting: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Disables writing comments to an article";
                      label: "Disable commenting";
                      language: "en";
                      plural: "Disable commentings";
                  },
              ];
          },
      >;
      disable_suggesting: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Removes 'Flag Article' button from the article view";
                      label: "Disable suggesting";
                      language: "en";
                      plural: "Disable suggestings";
                  },
              ];
          },
      >;
      display_attachments: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Display all attachments when viewing article - only relevant when 'Attachment link' is unchecked";
                      label: "Display attachments";
                      language: "en";
                      plural: "Display attachments";
                  },
              ];
          },
      >;
      display_number: Typed<
          string,
          {
              dynamicValueDefinitions: {
                  calculatedValue: "(function calculatedFieldValue(current) {\n\n\t// Add your code here\n\tvar version = '';\n\tif(current.version && !current.version.nil())\n\t\tversion = ' v'+current.version.version;\n\t\n\treturn current.number+version; // return the calculated value\n\n})(current);";
                  type: "calculated_value";
              };
              label: "Display number";
          },
      >;
      editor_type: Typed<
          string
          | number,
          {
              default: "TinyMCE";
              dropdown: "dropdown_without_none";
              label: "Editor Type";
          },
      >;
      flagged: Typed<
          boolean,
          {
              label: [
                  {
                      hint: "Flagged by users as incorrect or incomplete, true if any Feedback record for this article is flagged";
                      label: "Flagged";
                      language: "en";
                      plural: "Flagged";
                  },
              ];
          },
      >;
      generated_with_now_assist: Typed<
          boolean,
          { default: false; label: "Generated With Now Assist"; readOnly: true },
      >;
      helpful_count: Typed<
          number,
          {
              default: "0";
              label: [
                  {
                      hint: "Number of times this article has been helpful";
                      label: "Helpful count";
                      language: "en";
                      plural: "Helpful counts";
                  },
              ];
              readOnly: true;
          },
      >;
      image: Typed<
          string,
          {
              attributes: { pdf_cell_type: "basic_image" };
              label: [
                  {
                      hint: "Displayed next to article short description in Knowledge Base (optional)";
                      label: "Image";
                      language: "en";
                      plural: "Images";
                  },
              ];
              maxLength: 100;
          },
      >;
      instrumentation_metadata: Typed<
          string,
          { label: "Instrumentation metadata"; maxLength: 8000; readOnly: true },
      >;
      kb_category: Typed<
          | string
          | Record<"kb_category">
          | ExplicitKey<"kb_category">
          | TableBrand<"kb_category">,
          {
              attributes: {
                  encode_utf8: false;
                  field_decorations: "kb_category_reference_lookup";
              };
              label: "Category";
              referenceQual: "javascript: new global.GlobalKnowledgeUtil().getRefQualCategoryIdsForKB(current.kb_knowledge_base)";
              referenceTable: "kb_category";
          },
      >;
      kb_knowledge_base: Typed<
          | string
          | Record<"kb_knowledge_base">
          | ExplicitKey<"kb_knowledge_base">
          | TableBrand<"kb_knowledge_base">,
          {
              attributes: { readonly_clickthrough: true };
              default: "javascript:getDefaultKB()";
              label: "Knowledge base";
              mandatory: true;
              referenceQual: "javascript: new KnowledgeRefQualifiers().getCanContributeKBs(current.sys_class_name);";
              referenceTable: "kb_knowledge_base";
          },
      >;
      latest: Typed<boolean, { default: true; label: "Latest"; readOnly: true }>;
      latest_aqi: Typed<
          | string
          | Record<"kb_article_checklist_summary">
          | ExplicitKey<"kb_article_checklist_summary">
          | TableBrand<"kb_article_checklist_summary">,
          {
              attributes: { encode_utf8: false; readonly_clickthrough: true };
              label: "Latest AQI";
              readOnly: true;
              referenceTable: "kb_article_checklist_summary";
          },
      >;
      meta: Typed<
          string,
          {
              attributes: { ts_weight: "10" };
              label: [
                  {
                      hint: "Additional text indexed for search purposes, not shown when viewing article";
                      label: "Meta";
                      language: "en";
                      plural: "Metas";
                  },
              ];
              maxLength: 4000;
          },
      >;
      meta_description: Typed<
          string,
          {
              attributes: { no_text_index: true };
              label: "Meta Description";
              maxLength: 1000;
          },
      >;
      number: Typed<
          string,
          {
              attributes: { ignore_filter_on_new: true; ts_weight: "50" };
              default: "javascript:getNextObjNumberPadded();";
              label: "Number";
              readOnly: true;
          },
      >;
      ownership_group: Typed<
          | string
          | Record<"sys_user_group">
          | ExplicitKey<"sys_user_group">
          | TableBrand<"sys_user_group">,
          {
              attributes: { encode_utf8: false };
              label: "Ownership Group";
              referenceQual: "typeLIKE458de4f067671300dbfdbb2d07415ad6^EQ";
              referenceTable: "sys_user_group";
          },
      >;
      published: Typed<
          `${number}-${number}-${number}`,
          {
              label: [
                  {
                      hint: "Date article was published";
                      label: "Published";
                      language: "en";
                      plural: "Published";
                  },
              ];
          },
      >;
      rating: Typed<
          number,
          {
              label: [
                  {
                      hint: "Average rating based on user feedback";
                      label: "Rating";
                      language: "en";
                      plural: "Ratings";
                  },
              ];
              maxLength: 15;
              readOnly: true;
          },
      >;
      replacement_article: Typed<
          | string
          | Record<"kb_knowledge">
          | ExplicitKey<"kb_knowledge">
          | TableBrand<"kb_knowledge">,
          {
              attributes: { encode_utf8: false };
              label: [
                  {
                      hint: "Replacement article to this article after retirement.";
                      label: "Replacement Article";
                      language: "en";
                      plural: "Replacement Articles";
                  },
              ];
              readOnly: true;
              referenceTable: "kb_knowledge";
          },
      >;
      retired: Typed<
          `${number}-${number}-${number}`,
          {
              label: [
                  {
                      hint: "Date of retirement";
                      label: "Retired";
                      language: "en";
                      plural: "Retired";
                  },
              ];
              readOnly: true;
          },
      >;
      revised_by: Typed<
          | string
          | Record<"sys_user">
          | ExplicitKey<"sys_user">
          | TableBrand<"sys_user">,
          {
              attributes: { encode_utf8: false };
              label: "Revised By";
              readOnly: true;
              referenceTable: "sys_user";
          },
      >;
      roles: Typed<
          (string | Role)[],
          {
              array: true;
              attributes: { record_watcher_blacklist: true };
              label: [
                  {
                      hint: "Roles allowed to view or search for article - if empty, all users can see";
                      label: "Roles";
                      language: "en";
                      plural: "Roles";
                  },
              ];
          },
      >;
      scheduled_publish_date: Typed<
          `${number}-${number}-${number} ${number}:${number}:${number}`,
          {
              label: [
                  {
                      hint: "If specified, article will be published on that date and time";
                      label: "Scheduled publish date";
                      language: "en";
                      plural: "Scheduled publish dates";
                  },
              ];
          },
      >;
      short_description: Typed<
          string,
          {
              attributes: { ts_weight: "10" };
              label: [
                  {
                      hint: "Title of the article";
                      label: "Short description";
                      language: "en";
                      plural: "Short descriptions";
                  },
              ];
              mandatory: true;
              maxLength: 100;
          },
      >;
      source: Typed<
          string
          | Record<"task">
          | ExplicitKey<"task">
          | TableBrand<"task">,
          {
              attributes: { encode_utf8: false; readonly_clickthrough: true };
              label: [
                  {
                      hint: "Task from which this article originated, if any";
                      label: "Source task";
                      language: "en";
                      plural: "Source tasks";
                  },
              ];
              referenceTable: "task";
          },
      >;
      summary: Typed<
          | string
          | Record<"kb_knowledge_summary">
          | ExplicitKey<"kb_knowledge_summary">
          | TableBrand<"kb_knowledge_summary">,
          {
              attributes: { encode_utf8: false; readonly_clickthrough: true };
              label: "Summary";
              readOnly: true;
              referenceTable: "kb_knowledge_summary";
          },
      >;
      sys_class_name: Typed<
          string,
          {
              default: "javascript:current.getTableName();";
              dropdown: "dropdown_without_none";
              label: "Class";
              maxLength: 80;
          },
      >;
      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 article 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" }] },
      >;
      sys_view_count: Typed<
          number,
          {
              default: "0";
              label: [
                  {
                      hint: "Number of times this article has been viewed";
                      label: "View count";
                      language: "en";
                      plural: "View counts";
                  },
              ];
              readOnly: true;
          },
      >;
      taxonomy_topic: Typed<
          string
          | Record<"topic">
          | ExplicitKey<"topic">
          | TableBrand<"topic">,
          {
              attributes: { encode_utf8: false };
              label: [
                  {
                      hint: "primary taxonomy topic for the item";
                      label: "Taxonomy topic";
                      language: "en";
                      plural: "Taxonomy topics";
                  },
              ];
              referenceTable: "topic";
          },
      >;
      text: Typed<
          string
          | number,
          {
              attributes: {
                  "editor.height": "300";
                  "editor.plugins": "table link image media codemirror lists advlist fullscreen charmap directionality emoticons insertdatetime nonbreaking pagebreak searchreplace wordcount anchor tableofcontents codesample visualblocks visualchars compat3x autolink align_listitems tinymcespellchecker accordion editimage a11ychecker readonlynoborder";
                  "editor.toolbar": "fontfamily fontsize | bold italic underline strikethrough forecolor backcolor pastetext removeformat | blocks searchreplace undo redo spellchecker | bullist numlist outdent indent alignleft aligncenter alignright | tableofcontents table link unlink a11ycheck anchor accordion insertdatetime | image media codesample | code fullscreen";
                  encode_utf8: false;
                  serializer: "com.glide.script.TranslatedTextXMLSerializer";
              };
              columnType: "translated_html";
              label: [
                  {
                      hint: "Body of the article";
                      label: "Article body";
                      language: "en";
                      plural: "Article body";
                  },
              ];
              maxLength: 65000;
          },
      >;
      topic: Typed<
          string,
          {
              default: "General";
              dropdown: "dropdown_without_none";
              label: [
                  {
                      hint: "Higher level of article categorization - Topics can have multiple Categories";
                      label: "Topic";
                      language: "en";
                      plural: "Topics";
                  },
              ];
          },
      >;
      use_count: Typed<
          number,
          {
              default: "0";
              label: [
                  {
                      hint: "Number of times article has been attached to a task";
                      label: "Use count";
                      language: "en";
                      plural: "Use counts";
                  },
              ];
              readOnly: true;
          },
      >;
      valid_to: Typed<
          `${number}-${number}-${number}`,
          {
              default: "javascript: current.kb_knowledge_base ? new global.KBCommon().getDefaultValidToDateFromCurrentDate(current.kb_knowledge_base) : '';";
              label: [
                  {
                      hint: "After this date, article will not appear in the Knowledge Base or be returned in search results";
                      label: "Valid to";
                      language: "en";
                      plural: "Valid to";
                  },
              ];
          },
      >;
      version: Typed<
          | string
          | Record<"kb_version">
          | ExplicitKey<"kb_version">
          | TableBrand<"kb_version">,
          {
              attributes: { encode_utf8: false };
              label: "Version";
              readOnly: true;
              referenceTable: "kb_version";
          },
      >;
      view_as_allowed: Typed<
          boolean,
          {
              default: true;
              label: [
                  {
                      hint: "Allow a permitted user to search and view this article as another user";
                      label: "View as allowed";
                      language: "en";
                      plural: "View as allowed";
                  },
              ];
          },
      >;
      wiki: Typed<
          string
          | number,
          {
              attributes: {
                  image_refs: true;
                  is_multi_text: true;
                  preview_first: true;
                  preview_selector: true;
              };
              columnType: "wiki_text";
              dependent: "short_description";
              label: [
                  {
                      label: "Wiki";
                      language: "en";
                      plural: "Wikis";
                      url: "http://docs.servicenow.com/?context=Wiki_Plugin";
                      urlTarget: "_blank";
                  },
              ];
              maxLength: 65000;
              textIndex: true;
          },
      >;
      workflow_state: Typed<
          string
          | number,
          {
              attributes: { ignore_filter_on_new: true };
              columnType: "workflow";
              default: "draft";
              dropdown: "dropdown_with_none";
              label: [
                  {
                      hint: "Knowledge base workflow state";
                      label: "Workflow";
                      language: "en";
                      plural: "Workflows";
                  },
              ];
              maxLength: 80;
          },
      >;
  }

• ReadonlytextIndex: true