Variable sys_ux_macroponentConst

Type Declaration

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

• ReadonlyallowClientScripts: false

• ReadonlyallowNewFields: false

• ReadonlyallowUiActions: false

• ReadonlyallowWebServiceAccess: true

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

• Readonlydisplay: "name"

• Readonlyextends: "sys_metadata"

• Readonlylabel: "UX Macroponent Definition"

• Readonlyname: "sys_ux_macroponent"

• Readonlyschema: {
      associated_types: Typed<
          string
          | string[]
          | Record<"sys_ux_macroponent_type">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              label: "Associated types";
              maxLength: 1024;
              referenceTable: "sys_ux_macroponent_type";
          },
      >;
      bundles: Typed<
          string,
          {
              label: [
                  {
                      hint: "JSON Array, describing all the bundles being used in this macroponent";
                      label: "Bundles";
                      plural: "Bundles";
                  },
              ];
              maxLength: 8000;
          },
      >;
      category: Typed<
          StringWithSuggestions<
              | "component"
              | "page"
              | "client_state_data_broker"
              | "chrome"
              | "controller"
              | "modal"
              | "popover"
              | "viewport"
              | "ui_controller"
              | "primitives"
              | "sub_page"
              | "bundle"
              | "modeless_dialog"
              | "modeless_dialog_bundle",
          >,
          {
              choices: {
                  bundle: { label: "Bundle"; sequence: 1100 };
                  chrome: { label: "App Shell UI"; sequence: 400 };
                  client_state_data_broker: { label: "Data Broker Proxy"; sequence: 300 };
                  component: { label: "Component"; sequence: 100 };
                  controller: { label: "Controller"; sequence: 600 };
                  modal: { label: "Modal"; sequence: 600 };
                  modeless_dialog: { label: "Modeless Dialog"; sequence: 1200 };
                  modeless_dialog_bundle: {
                      label: "Modeless Dialog Bundle";
                      sequence: 1300;
                  };
                  page: { label: "Page"; sequence: 200 };
                  popover: { label: "Popover"; sequence: 650 };
                  primitives: { label: "Primitive"; sequence: 900 };
                  sub_page: { label: "Sub Page"; sequence: 1000 };
                  ui_controller: { label: "UI Controller"; sequence: 800 };
                  viewport: { label: "Viewport"; sequence: 700 };
              };
              default: "component";
              dropdown: "suggestion";
              label: [
                  {
                      hint: "Macroponent Category";
                      label: "Category";
                      plural: "Categories";
                  },
              ];
              maxLength: 40;
          },
      >;
      component_dependencies: Typed<
          string
          | string[]
          | Record<"sys_ux_lib_component">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              label: [
                  {
                      hint: "Components used by this Macroponent";
                      label: "Component dependencies";
                      plural: "Component dependencies";
                  },
              ];
              maxLength: 1024;
              referenceTable: "sys_ux_lib_component";
          },
      >;
      composition: Typed<
          string,
          {
              label: [
                  {
                      hint: "JSON Array, describing all the static elements of the Macroponent UI";
                      label: "Composition";
                      plural: "Compositions";
                  },
              ];
              maxLength: 8000;
          },
      >;
      da_relay_models: Typed<
          string
          | string[]
          | Record<"sys_declarative_action_model_definition">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              label: [
                  {
                      hint: "This Macroponent will relay DA Client Actions from the specified Models, as its own Dispatched Events";
                      label: "Action relay models";
                      plural: "Action relay models";
                  },
              ];
              maxLength: 1024;
              referenceTable: "sys_declarative_action_model_definition";
          },
      >;
      data: Typed<
          string,
          {
              label: [
                  {
                      hint: "JSON Object, describing each data item for this Macroponent";
                      label: "Data";
                      plural: "Data";
                  },
              ];
              maxLength: 8000;
          },
      >;
      description: Typed<
          string,
          {
              attributes: {
                  serializer: "com.glide.script.TranslatedTextXMLSerializer";
              };
              label: [
                  {
                      hint: "A description of the macroponent";
                      label: "Description";
                      plural: "Descriptions";
                  },
              ];
              maxLength: 4000;
          },
      >;
      disable_auto_reflow: Typed<
          boolean,
          { default: false; label: "Disable Auto Reflow"; maxLength: 40 },
      >;
      dispatched_events: Typed<
          string
          | string[]
          | Record<"sys_ux_event">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              label: [
                  {
                      hint: "Events dispatched by the macroponent";
                      label: "Dispatched Events";
                      plural: "Dispatched Events";
                  },
              ];
              maxLength: 4001;
              referenceTable: "sys_ux_event";
          },
      >;
      ext_controller_dep: Typed<
          string,
          {
              label: [
                  {
                      hint: "JSON Array, describing all the External Controller Dependencies";
                      label: "External Controller Dependencies";
                      plural: "External Controller Dependencies";
                  },
              ];
              maxLength: 8000;
          },
      >;
      extends: Typed<
          | string
          | Record<"sys_ux_macroponent">
          | ExplicitKey<"sys_ux_macroponent">
          | TableBrand<"sys_ux_macroponent">,
          {
              attributes: { encode_utf8: false };
              label: "Extends";
              maxLength: 32;
              referenceTable: "sys_ux_macroponent";
          },
      >;
      extension_point: Typed<
          | string
          | Record<"sys_ux_extension_point">
          | ExplicitKey<"sys_ux_extension_point">
          | TableBrand<"sys_ux_extension_point">,
          {
              attributes: { encode_utf8: false };
              label: "Extension Point";
              maxLength: 32;
              referenceTable: "sys_ux_extension_point";
          },
      >;
      form_factors: Typed<
          string,
          {
              default: "{}";
              label: [
                  {
                      hint: "Macroponent level custom form factors";
                      label: "Form Factors";
                      plural: "Form Factors";
                  },
              ];
              maxLength: 8000;
          },
      >;
      handled_events: Typed<
          string
          | string[]
          | Record<"sys_ux_event">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              label: [
                  {
                      hint: "Events handled by the root element";
                      label: "Handled Events";
                      plural: "Handled Events";
                  },
              ];
              maxLength: 4001;
              referenceTable: "sys_ux_event";
          },
      >;
      interactions: Typed<
          string,
          {
              label: [
                  {
                      hint: "JSON Array, describing interactive and automated behavior for this Macroponent";
                      label: "Interactions";
                      plural: "Interactions";
                  },
              ];
              maxLength: 8000;
          },
      >;
      interfaces: Typed<
          string
          | string[]
          | Record<"sys_ux_interface">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              label: [
                  {
                      hint: "Interfaces implemented by this macroponent";
                      label: "Interfaces";
                      plural: "Interfaces";
                  },
              ];
              maxLength: 1024;
              referenceTable: "sys_ux_interface";
          },
      >;
      internal_event_mappings: Typed<
          string,
          { label: "Internal Event Mappings"; maxLength: 8000 },
      >;
      keyboard_shortcuts: Typed<
          string,
          {
              default: "{}";
              label: [
                  {
                      hint: "JSON Object where the keys are keyboard shortcut sys ID's and the values are an arrary of event objects.";
                      label: "Keyboard Shortcuts";
                      plural: "Keyboard Shortcuts";
                  },
              ];
              maxLength: 8000;
          },
      >;
      layout: Typed<
          string,
          {
              label: [
                  {
                      hint: "JSON Object, describing layout for this Macroponent";
                      label: "Layout model";
                      plural: "Layout models";
                  },
              ];
              maxLength: 8000;
          },
      >;
      macroponent_dependencies: Typed<
          string
          | string[]
          | Record<"sys_ux_macroponent">[],
          {
              attributes: { no_sort: true; slushbucket_ref_no_expand: true };
              label: [
                  {
                      hint: "Macroponents used by this Macroponent";
                      label: "Macroponent dependencies";
                      plural: "Macroponent dependencies";
                  },
              ];
              maxLength: 1024;
              referenceTable: "sys_ux_macroponent";
          },
      >;
      name: Typed<
          string,
          {
              attributes: { edge_encryption_enabled: true };
              label: "Name";
              mandatory: true;
              maxLength: 255;
          },
      >;
      output_prop_mapping: Typed<
          string,
          {
              label: [
                  {
                      hint: "Maps internal binding values to external API";
                      label: "Output Prop Mapping";
                      plural: "Output Prop Mappings";
                  },
              ];
              maxLength: 8000;
          },
      >;
      props: Typed<
          string,
          {
              label: [
                  {
                      hint: "JSON Object, describing the API for this Macroponent as properties that can be set and read externally";
                      label: "Properties";
                      plural: "Properties";
                  },
              ];
              maxLength: 8000;
          },
      >;
      required_sys_props: Typed<
          string,
          {
              attributes: { edge_encryption_enabled: true };
              label: [
                  {
                      hint: "String, specifying the system properties used in this macroponent. Separate multiple properties with commas (no quotes needed).";
                      label: "Required System Properties";
                      plural: "Required System Properties";
                  },
              ];
              maxLength: 8000;
          },
      >;
      required_translations: Typed<
          string
          | number,
          {
              columnType: "json_translations";
              label: [
                  {
                      hint: "JSON Array, holding the translations required by this Macroponent";
                      label: "Required translations";
                      plural: "Required translations";
                  },
              ];
              maxLength: 8000;
              readOnly: true;
              readOnlyOption: "strict_read_only";
          },
      >;
      root_component: Typed<
          | string
          | Record<"sys_ux_lib_component">
          | ExplicitKey<"sys_ux_lib_component">
          | TableBrand<"sys_ux_lib_component">,
          {
              attributes: { encode_utf8: false };
              cascadeRule: "delete";
              label: "Root element definition";
              maxLength: 32;
              referenceTable: "sys_ux_lib_component";
          },
      >;
      root_component_config: Typed<
          string,
          {
              attributes: { edge_encryption_enabled: true };
              label: [
                  {
                      hint: "JSON Object, specifying the configuration of the root element for this Macropoent";
                      label: "Root element configuration";
                      plural: "Root element configurations";
                  },
              ];
              maxLength: 8000;
          },
      >;
      root_component_definition: Typed<
          string,
          {
              attributes: { edge_encryption_enabled: true };
              label: [
                  {
                      hint: "JSON Object, specifying the implementation details of the root element for this Macropoent";
                      label: "Root element metadata";
                      plural: "Root element metadatas";
                  },
              ];
              maxLength: 8000;
          },
      >;
      schema_version: Typed<
          string,
          {
              attributes: { edge_encryption_enabled: true };
              default: "javascript:gs.getProperty('com.glide.uxf.schema.version', '1.0.0')";
              label: [
                  {
                      hint: "Schema version used by this Macroponent";
                      label: "Schema version";
                      plural: "Schema versions";
                  },
              ];
              mandatory: true;
              maxLength: 40;
              readOnly: true;
              readOnlyOption: "strict_read_only";
          },
      >;
      state_persistence_config: Typed<
          string,
          {
              label: [
                  {
                      hint: "JSON Object, specifying the configuration of the state persistence";
                      label: "State Persistence Config";
                      plural: "State Persistence Configs";
                  },
              ];
              maxLength: 8000;
          },
      >;
      state_properties: Typed<
          string,
          {
              label: [
                  {
                      hint: "JSON Array, holding any state the client has set for this Macroponent";
                      label: "State";
                      plural: "States";
                  },
              ];
              maxLength: 8000;
          },
      >;
      style_config: Typed<
          string,
          {
              default: "{}";
              label: [
                  {
                      hint: "Macroponent level style block";
                      label: "Style";
                      plural: "Styles";
                  },
              ];
              maxLength: 8000;
          },
      >;
      sys_id: Typed<
          string,
          {
              label: [{ label: "Sys ID"; plural: "Sys IDs" }];
              maxLength: 32;
              primary: true;
          },
      >;
  }

• ReadonlytextIndex: true