Variable sys_ui_actionConst

Type Declaration

• Readonlyactions: { create: false; delete: false; read: true; update: false }

• ReadonlyallowClientScripts: false

• ReadonlyallowNewFields: false

• ReadonlyallowUiActions: false

• ReadonlyallowWebServiceAccess: true

• Readonlyattributes: {
      "all_tables.text_index_translations": true;
      no_table_trace: true;
      update_synch: true;
  }

• Readonlyaudit: true

• Readonlyextends: "sys_metadata"

• Readonlylabel: [
      {
          help: "Controls to create a custom button or link on lists or forms to perform a particular action";
          label: "UI Action";
      },
  ]

• Readonlyname: "sys_ui_action"

• Readonlyschema: {
      action_name: Typed<string, { label: "Action name"; maxLength: 40 }>;
      active: Typed<boolean, { default: true; maxLength: 40 }>;
      client: Typed<boolean, { default: false; maxLength: 40 }>;
      client_script_v2: Typed<
          string
          | ScriptModule<Function>,
          {
              attributes: { client_script: true };
              dependent: "table";
              label: "Workspace Client Script";
              maxLength: 8000;
              script: "true";
          },
      >;
      comments: Typed<string, { maxLength: 4000 }>;
      condition: Typed<
          string
          | number,
          { columnType: "condition_string"; maxLength: 254 },
      >;
      form_action: Typed<boolean, { label: "Form action"; maxLength: 40 }>;
      form_button: Typed<
          boolean,
          { default: false; label: "Form button"; maxLength: 40 },
      >;
      form_button_icon: Typed<
          string,
          {
              label: [
                  {
                      hint: "For the list of available icons, go to /styles/retina_icons/retina_icons.html";
                      label: "Form button icon";
                  },
              ];
              maxLength: 40;
          },
      >;
      form_button_v2: Typed<
          boolean,
          { default: false; label: "Workspace Form Button"; maxLength: 40 },
      >;
      form_context_menu: Typed<
          boolean,
          { default: false; label: "Form context menu"; maxLength: 40 },
      >;
      form_link: Typed<
          boolean,
          { default: false; label: "Form link"; maxLength: 40 },
      >;
      form_menu_button_v2: Typed<
          boolean,
          { default: false; label: "Workspace Form Menu"; maxLength: 40 },
      >;
      form_style: Typed<
          "primary"
          | "primary-ai"
          | "secondary-ai"
          | "destructive"
          | "unstyled",
          {
              choices: {
                  destructive: { label: "Destructive"; sequence: 2 };
                  primary: { label: "Primary"; sequence: 1 };
                  "primary-ai": { label: "AI primary"; sequence: 4 };
                  "secondary-ai": { label: "AI secondary"; sequence: 5 };
                  unstyled: { label: "Unstyled"; sequence: 3 };
              };
              dropdown: "dropdown_with_none";
              label: [
                  {
                      hint: "It is recommended that you configure only one primary button. Configuring two can cause confusion for end users.";
                      label: "Form style";
                  },
              ];
              maxLength: 40;
          },
      >;
      format_for_configurable_workspace: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Select if this ui action will be used in a configurable workspace.";
                      label: "Format for Configurable Workspace";
                  },
              ];
              maxLength: 40;
          },
      >;
      hint: Typed<
          string,
          {
              label: [
                  { hint: "Text that appears when hovering over the UI Action" },
              ];
              maxLength: 254;
          },
      >;
      isolate_script: Typed<
          boolean,
          { default: false; label: "Isolate script"; maxLength: 40 },
      >;
      keyboard_shortcut: Typed<string, {}>;
      list_action: Typed<boolean, { label: "List action"; maxLength: 40 }>;
      list_banner_button: Typed<
          boolean,
          { default: false; label: "List banner button"; maxLength: 40 },
      >;
      list_button: Typed<
          boolean,
          { default: false; label: "List bottom button"; maxLength: 40 },
      >;
      list_button_icon: Typed<
          string,
          {
              label: [
                  {
                      hint: "For the list of available icons, go to /styles/retina_icons/retina_icons.html";
                      label: "List button icon";
                  },
              ];
              maxLength: 40;
          },
      >;
      list_choice: Typed<
          boolean,
          { default: false; label: "List choice"; maxLength: 40 },
      >;
      list_context_menu: Typed<
          boolean,
          { default: false; label: "List context menu"; maxLength: 40 },
      >;
      list_link: Typed<
          boolean,
          { default: false; label: "List link"; maxLength: 40 },
      >;
      list_save_with_form_button: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "This button will be available for lists that are set to 'Save with the form'.";
                      label: "Save with form button";
                  },
              ];
              maxLength: 40;
          },
      >;
      list_style: Typed<
          "primary"
          | "primary-ai"
          | "secondary-ai"
          | "destructive"
          | "unstyled",
          {
              choices: {
                  destructive: { label: "Destructive"; sequence: 2 };
                  primary: { label: "Primary"; sequence: 1 };
                  "primary-ai": { label: "AI primary"; sequence: 4 };
                  "secondary-ai": { label: "AI secondary"; sequence: 5 };
                  unstyled: { label: "Unstyled"; sequence: 3 };
              };
              dropdown: "dropdown_with_none";
              label: [
                  {
                      hint: "It is recommended that you configure only one primary button. Configuring two can cause confusion for end users.";
                      label: "List style";
                  },
              ];
              maxLength: 40;
          },
      >;
      messages: Typed<
          string,
          {
              label: [
                  {
                      hint: "Text strings (one per line) available to the Client Script as localized messages using getMessage('[message]')";
                  },
              ];
              maxLength: 4000;
          },
      >;
      name: Typed<string, { maxLength: 40 }>;
      onclick: Typed<string, { maxLength: 254 }>;
      order: Typed<number, { default: 100; maxLength: 40 }>;
      script: Typed<
          string
          | ScriptModule<Function>,
          { dependent: "table"; maxLength: 8000 },
      >;
      show_form_icon_only: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "When true, the button will display only the icon, ignoring the 'Name' field. Remember to add a separate tooltip to the UI action itself to describe its function to users.";
                      label: "Show form icon only";
                  },
              ];
              maxLength: 40;
          },
      >;
      show_insert: Typed<
          boolean,
          { default: true; label: "Show insert"; maxLength: 40 },
      >;
      show_list_icon_only: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "When true, the button will display only the icon, ignoring the 'Name' field. Remember to add a separate tooltip to the UI action itself to describe its function to users.";
                      label: "Show list icon only";
                  },
              ];
              maxLength: 40;
          },
      >;
      show_multiple_update: Typed<
          boolean,
          { default: false; label: "Show multiple update"; maxLength: 40 },
      >;
      show_query: Typed<
          boolean,
          { default: false; label: "Show query"; maxLength: 40 },
      >;
      show_update: Typed<
          boolean,
          { default: true; label: "Show update"; maxLength: 40 },
      >;
      sys_domain: Typed<
          string & {}
          | Record<"domain">
          | "global",
          {
              default: "global";
              label: [{ hint: "Domain to which the action belongs"; label: "Domain" }];
              maxLength: 32;
          },
      >;
      sys_domain_path: Typed<
          string,
          {
              attributes: { case_sensitive: true };
              default: "/";
              label: "Domain Path";
              maxLength: 255;
          },
      >;
      sys_id: Typed<string, { maxLength: 32; primary: true }>;
      sys_overrides: Typed<
          | string
          | Record<"sys_ui_action">
          | ExplicitKey<"sys_ui_action">
          | TableBrand<"sys_ui_action">,
          {
              label: [
                  {
                      hint: "Action being overridden by the current record";
                      label: "Overrides";
                  },
              ];
              maxLength: 32;
              referenceTable: "sys_ui_action";
          },
      >;
      table: Typed<keyof Tables, { maxLength: 80 }>;
      ui11_compatible: Typed<
          boolean,
          {
              default: true;
              label: [{ label: "List v2 Compatible"; plural: "List v2 Compatible" }];
              maxLength: 40;
          },
      >;
      ui16_compatible: Typed<
          boolean,
          {
              default: "javascript:gs.getProperty('glide.ui.list_v3.enable', 'false')";
              label: [{ label: "List v3 Compatible"; plural: "List v3 Compatible" }];
              maxLength: 40;
          },
      >;
  }

• ReadonlytextIndex: true