Variable sys_declarative_action_assignmentConst

Type Declaration

• ReadonlyallowWebServiceAccess: true

• Readonlyattributes: { no_text_index: true; update_synch: true }

• Readonlydisplay: "action_name"

• Readonlyextends: "sys_metadata"

• Readonlylabel: "Action Assignment"

• Readonlyname: "sys_declarative_action_assignment"

• Readonlyschema: {
      action: Typed<
          | string
          | Record<"sys_declarative_action_definition">
          | ExplicitKey<"sys_declarative_action_definition">
          | TableBrand<"sys_declarative_action_definition">,
          {
              attributes: { encode_utf8: false };
              label: "Action";
              referenceTable: "sys_declarative_action_definition";
          },
      >;
      action_attributes: Typed<
          string
          | number,
          {
              attributes: { key_readonly: true; no_actions: true };
              columnType: "simple_name_values";
              label: "Component Attributes";
              maxLength: 4000;
          },
      >;
      action_name: Typed<string, { label: "Action name" }>;
      action_payload: Typed<
          string,
          { label: "Action Payload"; maxLength: 65535 },
      >;
      action_type: Typed<
          string
          | number,
          {
              default: "type";
              dropdown: "dropdown_without_none";
              label: "Decorator applies to";
          },
      >;
      active: Typed<
          boolean,
          {
              default: true;
              label: [
                  {
                      hint: "Disabling this will make the system fallback to the parent table's assignment if applicable";
                      label: "Active";
                      language: "en";
                      plural: "Active";
                  },
              ];
          },
      >;
      animate_icon: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "If true, the icon will be animated. Not all components and icons support animation.";
                      label: "Animate icon";
                      language: "en";
                      plural: "Animate icons";
                  },
              ];
          },
      >;
      button_position: Typed<
          string
          | number,
          {
              default: "right";
              dropdown: "dropdown_without_none";
              label: [
                  {
                      hint: "Use Button Position to place the action button on the left or right side of the activity";
                      label: "Button Position";
                      language: "en";
                      plural: "Button Positions";
                  },
              ];
          },
      >;
      button_type: Typed<
          string
          | number,
          {
              default: "primary";
              dropdown: "dropdown_without_none";
              label: [
                  {
                      hint: "Use Button Type to apply visual weights to the action button";
                      label: "Button type";
                      language: "en";
                      plural: "Button types";
                  },
              ];
          },
      >;
      client_action: Typed<
          | string
          | Record<"sys_declarative_action_payload_definition">
          | ExplicitKey<"sys_declarative_action_payload_definition">
          | TableBrand<"sys_declarative_action_payload_definition">,
          {
              attributes: { encode_utf8: false };
              cascadeRule: "delete";
              label: "Specify client action";
              mandatory: true;
              referenceQual: "javascript: 'applicable_to=' + current.model";
              referenceTable: "sys_declarative_action_payload_definition";
          },
      >;
      client_conditions: Typed<
          string
          | number,
          {
              attributes: { key_readonly: true; no_actions: true };
              columnType: "simple_name_values";
              label: [
                  {
                      hint: "Conditions required to render action. The model must meet all the values set.";
                      label: "Client Conditions";
                      language: "en";
                      plural: "Client Conditions";
                  },
              ];
              maxLength: 4000;
          },
      >;
      client_conditions_on_fields: Typed<
          string
          | string[]
          | Record<"sys_declarative_action_model_field">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              dependent: "model";
              label: "Client Conditions on Fields";
              maxLength: 1024;
              referenceTable: "sys_declarative_action_model_field";
          },
      >;
      client_script: Typed<
          string
          | number,
          {
              columnType: "script_plain";
              default: "function onClick() { }";
              label: "Client Script";
              maxLength: 8000;
          },
      >;
      confirmation_message: Typed<
          string,
          {
              attributes: {
                  serializer: "com.glide.script.TranslatedTextXMLSerializer";
              };
              label: [
                  {
                      hint: "Message to display when prompting user for confirmation";
                      label: "Confirmation Message";
                      language: "en";
                      plural: "Confirmation Messages";
                  },
              ];
              maxLength: 4000;
          },
      >;
      confirmation_required: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Ask for confirmation before running the server scripts";
                      label: "Confirmation Required";
                      language: "en";
                      plural: "Confirmation Required";
                  },
              ];
          },
      >;
      create_access: Typed<
          boolean,
          {
              label: [
                  {
                      hint: "Action is only applicable when the user has a create access";
                      label: "Requires create access";
                      language: "en";
                      plural: "Requires create access";
                  },
              ];
          },
      >;
      declarative_action_render_mode: Typed<
          | string
          | Record<"sys_declarative_action_render_mode">
          | ExplicitKey<"sys_declarative_action_render_mode">
          | TableBrand<"sys_declarative_action_render_mode">,
          {
              attributes: {
                  encode_utf8: false;
                  ref_auto_completer: "AJAXReferenceChoice";
              };
              dropdown: "dropdown_without_none";
              label: "Render Mode";
              referenceQual: "javascript:'applicable_toLIKE'+current.model";
              referenceTable: "sys_declarative_action_render_mode";
          },
      >;
      declarative_action_type: Typed<
          string
          | number,
          {
              default: "server_script";
              dropdown: "dropdown_without_none";
              label: "Implemented as";
          },
      >;
      delete_access: Typed<
          boolean,
          {
              label: [
                  {
                      hint: "Action is only applicable when the user has a delete access";
                      label: "Requires delete access";
                      language: "en";
                      plural: "Requires delete access";
                  },
              ];
          },
      >;
      dependency: Typed<string, { label: "Dependency"; maxLength: 255 }>;
      description: Typed<string, { label: "Description"; maxLength: 4000 }>;
      design_icon: Typed<
          | string
          | Record<"st_sys_design_system_icon">
          | ExplicitKey<"st_sys_design_system_icon">
          | TableBrand<"st_sys_design_system_icon">,
          {
              attributes: { encode_utf8: false };
              label: "Icon";
              referenceTable: "st_sys_design_system_icon";
          },
      >;
      dynamic_record_condition: Typed<
          string,
          {
              attributes: { use_variables: false };
              dependent: "table";
              label: [
                  {
                      hint: "Evaluated when the selected list items change";
                      label: "Dynamic Record Conditions";
                      language: "en";
                      plural: "Dynamic Record Conditions";
                  },
              ];
          },
      >;
      dynamic_script_condition: Typed<
          string
          | number,
          {
              columnType: "condition_string";
              label: [
                  {
                      hint: "Evaluated when the selected list items change";
                      label: "Dynamic Script Condition";
                      language: "en";
                      plural: "Dynamic Script Conditions";
                  },
              ];
              maxLength: 254;
          },
      >;
      enable_dynamic_evaluation: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "To enable this feature set Experience Restricted and Record Selection Required as true. When enabled, users are unable to perform an action until all of the selected list items meet the defined conditions";
                      label: "Enable Dynamic Evaluation";
                      language: "en";
                      plural: "Enable Dynamic Evaluations";
                  },
              ];
          },
      >;
      enable_for_all_experiences: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Make this action visible in all Configurable Experiences";
                      label: "Enable for all Configurable Experiences";
                      language: "en";
                      plural: "Enable for all Configurable Experiences";
                  },
              ];
          },
      >;
      enabled: Typed<
          boolean,
          {
              default: true;
              label: [
                  {
                      hint: "Disabling this will prevent this action from rendering. The system will not fallback to the parent";
                      label: "Enabled";
                      language: "en";
                      plural: "Enabled";
                  },
              ];
          },
      >;
      experience_restricted: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Make this action restricted to experiences as specified in action configuration";
                      label: "Experience Restricted";
                      language: "en";
                      plural: "Experience Restricted";
                  },
              ];
          },
      >;
      field_name: Typed<
          string,
          {
              attributes: { allow_null: true; allow_references: true };
              dependent: "table";
              label: "Field Name";
          },
      >;
      field_type: Typed<
          string
          | number,
          {
              default: "glide_date";
              dropdown: "dropdown_without_none";
              label: "Field type";
          },
      >;
      form_fields_required: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Use form fields required to disable the action when required fields are empty.";
                      label: "Form Fields Required";
                      language: "en";
                      plural: "Form Fields Required";
                  },
              ];
          },
      >;
      form_position: Typed<
          string,
          { dropdown: "dropdown_without_none"; label: "Form position" },
      >;
      group: Typed<
          | string
          | Record<"sys_declarative_action_group">
          | ExplicitKey<"sys_declarative_action_group">
          | TableBrand<"sys_declarative_action_group">,
          {
              attributes: { encode_utf8: false };
              label: "Group";
              referenceTable: "sys_declarative_action_group";
          },
      >;
      group_by: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Whether or not the action is grouped in any group";
                      label: "Group By";
                      language: "en";
                      plural: "Group Bys";
                  },
              ];
          },
      >;
      icon: Typed<string, { label: "Icon" }>;
      label: Typed<
          string,
          {
              attributes: {
                  serializer: "com.glide.script.TranslatedTextXMLSerializer";
              };
              label: "Action label";
              mandatory: true;
          },
      >;
      model: Typed<
          | string
          | Record<"sys_declarative_action_model_definition">
          | ExplicitKey<"sys_declarative_action_model_definition">
          | TableBrand<"sys_declarative_action_model_definition">,
          {
              attributes: { encode_utf8: false };
              cascadeRule: "delete";
              label: "Action Model";
              mandatory: true;
              referenceQual: "javascript:'sys_idIN' + current.action.applicable_to";
              referenceTable: "sys_declarative_action_model_definition";
          },
      >;
      model_conditions: Typed<
          string,
          {
              dependent: "model.model_field_table";
              label: [
                  {
                      hint: "Apply conditions to dynamically display the action";
                      label: "Client Conditions";
                      language: "en";
                      plural: "Client Conditions";
                  },
              ];
              maxLength: 8000;
          },
      >;
      model_field_required: Typed<
          string
          | string[]
          | Record<"sys_declarative_action_model_field">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              dependent: "model";
              label: [
                  {
                      hint: "Selected fields will be resolved to current payload value and pass to action component as props";
                      label: "Model Fields required";
                      language: "en";
                      plural: "Model Fields required";
                  },
              ];
              maxLength: 1024;
              referenceTable: "sys_declarative_action_model_field";
          },
      >;
      order: Typed<
          string
          | number,
          { columnType: "order_index"; default: "0"; label: "Order" },
      >;
      payload_map: Typed<
          string
          | TemplateValueElement<keyof Tables>,
          {
              dependent: "client_action.payload_field_table";
              label: [
                  {
                      hint: "Set values to the listed properties";
                      label: "Payload Map";
                      language: "en";
                      plural: "Payload Maps";
                  },
              ];
              maxLength: 8000;
          },
      >;
      read_access: Typed<
          boolean,
          {
              label: [
                  {
                      hint: "Action is only applicable when the user has a read access";
                      label: "Requires read access";
                      language: "en";
                      plural: "Requires read access";
                  },
              ];
          },
      >;
      record_conditions: Typed<
          string,
          {
              dependent: "table";
              label: [
                  {
                      hint: "Query condition used to enable policy run";
                      label: "Record Conditions";
                      language: "en";
                      plural: "Record Conditions";
                  },
              ];
              maxLength: 1000;
          },
      >;
      record_selection_required: Typed<
          boolean,
          {
              label: [
                  {
                      hint: "By enabling this at least one list item must be selected in order perform the action";
                      label: "Record Selection Required";
                      language: "en";
                      plural: "Record Selection Required";
                  },
              ];
          },
      >;
      required_roles: Typed<
          string
          | string[]
          | Record<"sys_user_role">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              label: [
                  {
                      hint: "Recommend do not use. This field uses role sys IDs to determine access. If \"Required user role names\" field is populated, this field does not take effect.";
                      label: "Required Roles";
                      language: "en";
                      plural: "Required Roles";
                  },
              ];
              maxLength: 1024;
              referenceTable: "sys_user_role";
          },
      >;
      required_translations: Typed<
          string
          | number,
          {
              columnType: "json_translations";
              label: [
                  {
                      hint: "JSON Array, holding the translations required by this declarative action assignment";
                      label: "Required translations";
                      language: "en";
                      plural: "Required translations";
                  },
              ];
              maxLength: 8000;
          },
      >;
      required_user_role_names: Typed<
          (string | Role)[],
          {
              attributes: { record_watcher_blacklist: true };
              label: "Required user role names";
          },
      >;
      requires_value: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Action is only applicable when field has value";
                      label: "Requires Value";
                      language: "en";
                      plural: "Requires Values";
                  },
              ];
          },
      >;
      script_condition: Typed<
          string
          | number,
          {
              columnType: "condition_string";
              label: "Script Condition";
              maxLength: 254;
          },
      >;
      scripted_client_condition: Typed<
          string
          | number,
          {
              columnType: "condition_string";
              label: [
                  {
                      hint: "Define scripted condition to dynamically display the action";
                      label: "Scripted Client Condition";
                      language: "en";
                      plural: "Scripted Client Conditions";
                  },
              ];
              maxLength: 254;
          },
      >;
      server_script: Typed<
          string
          | ScriptModule<Function>,
          { dependent: "table"; label: "Server Script" },
      >;
      specificity: Typed<
          number,
          {
              label: "Specificity";
              readOnly: true;
              readOnlyOption: "instance_configured";
          },
      >;
      sys_domain: Typed<
          Record<"domain">
          | "global",
          {
              default: "global";
              label: [
                  {
                      hint: "Domain to which the action belongs";
                      label: "Domain";
                      language: "en";
                      plural: "Domains";
                  },
              ];
              readOnly: true;
              readOnlyOption: "instance_configured";
          },
      >;
      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_overrides: Typed<
          | string
          | Record<"sys_declarative_action_assignment">
          | ExplicitKey<"sys_declarative_action_assignment">
          | TableBrand<"sys_declarative_action_assignment">,
          {
              attributes: { encode_utf8: false };
              label: [
                  {
                      hint: "Script being overridden by the current record";
                      label: "Overrides";
                      language: "en";
                      plural: "Overrides";
                  },
              ];
              referenceTable: "sys_declarative_action_assignment";
          },
      >;
      table: Typed<
          keyof Tables,
          {
              attributes: { base_start: true };
              default: "global";
              label: "Table";
              mandatory: true;
          },
      >;
      tooltip: Typed<
          string,
          {
              attributes: {
                  serializer: "com.glide.script.TranslatedTextXMLSerializer";
              };
              label: "Tooltip";
              maxLength: 255;
          },
      >;
      ui_component: Typed<
          | string
          | Record<"sys_ux_lib_component">
          | ExplicitKey<"sys_ux_lib_component">
          | TableBrand<"sys_ux_lib_component">,
          {
              attributes: { encode_utf8: false };
              label: [
                  {
                      hint: "Select seismic component to render";
                      label: "Specify UI component";
                      language: "en";
                      plural: "Specify UI components";
                  },
              ];
              referenceQual: "deprecated=false^ORdeprecatedISEMPTY";
              referenceTable: "sys_ux_lib_component";
          },
      >;
      view: Typed<
          | string
          | Record<"sys_ui_view">
          | ExplicitKey<"sys_ui_view">
          | TableBrand<"sys_ui_view">,
          {
              attributes: { encode_utf8: false };
              label: "View";
              referenceTable: "sys_ui_view";
          },
      >;
      workspace: Typed<
          | string
          | Record<"sys_aw_master_config">
          | ExplicitKey<"sys_aw_master_config">
          | TableBrand<"sys_aw_master_config">,
          {
              attributes: { encode_utf8: false };
              label: [
                  {
                      help: "Restrict action to a legacy Agent Workspace experience.";
                      hint: "Restrict action to a legacy Agent Workspace experience.";
                      label: "Workspace";
                      language: "en";
                      plural: "Workspaces";
                  },
              ];
              referenceQual: "javascript:(current.action && current.action.workspace) ? 'sys_id=' + current.action.workspace : ''";
              referenceTable: "sys_aw_master_config";
          },
      >;
      write_access: Typed<
          boolean,
          {
              label: [
                  {
                      hint: "Action is only applicable when the user has a write access";
                      label: "Requires write access";
                      language: "en";
                      plural: "Requires write access";
                  },
              ];
          },
      >;
  }

• ReadonlytextIndex: true