@sap/ux-specification 1.90.5 → 1.90.9

package/dist/schemas/v4/ObjectPageConfig.json

@@ -9,7 +9,8 @@
     },
     "variantManagement": {
       "$ref": "#/definitions/VariantManagementTypeObjectPage",
-      "description": "variantManagement defines how the variant management of page personalizations is controlled.\n- None - No variant management by default.\n- Control - Individual personalizations for each control."
+      "description": "variantManagement defines how the variant management of page personalizations is controlled.\n- None - No variant management by default.\n- Control - Individual personalizations for each control.",
+      "artifactType": "Manifest"
     },
     "sections": {
       "anyOf": [
@@ -34,19 +35,174 @@
       "properties": {
         "editableHeaderContent": {
           "description": "Set editableHeaderContent to true to make the header fields editable.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         },
         "showRelatedApps": {
           "description": "Set showRelatedApps to true to show the navigation button for related apps.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         },
         "visible": {
           "description": "Set visible to true to make the header visible.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         },
         "anchorBarVisible": {
           "description": "Set visible to true to make the anchor bar visible.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "sections": {
+          "$ref": "#/definitions/HeaderSections"
+        }
+      },
+      "additionalProperties": false
+    },
+    "HeaderSections": {
+      "description": "Header Sections",
+      "isViewNode": true,
+      "type": "object",
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "$ref": "#/definitions/ObjectPageHeaderSectionForm"
+          },
+          {
+            "$ref": "#/definitions/ObjectPageHeaderSectionChart"
+          },
+          {
+            "$ref": "#/definitions/ObjectPageHeaderSectionDataPoint"
+          },
+          {
+            "$ref": "#/definitions/ObjectPageHeaderSectionContact"
+          },
+          {
+            "$ref": "#/definitions/ObjectPageHeaderSectionAddress"
+          }
+        ]
+      }
+    },
+    "ObjectPageHeaderSectionForm": {
+      "type": "object",
+      "properties": {
+        "form": {
+          "description": "Form",
+          "isViewNode": true,
+          "type": "object",
+          "properties": {},
+          "additionalProperties": true
+        },
+        "stashed": {
+          "description": "Header facets marked as stashed are initially not visible on the UI. Key users can add these header facets via key user adaptation.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "flexSettings": {
+          "$ref": "#/definitions/FlexSettings",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "FlexSettings": {
+      "type": "object",
+      "properties": {
+        "designtime": {
+          "description": "You can restrict the adaptability of header facets via the setting 'flexSettings'/'designtime'. 'not-adaptable-visibility' means that 'remove' and 'add' are not possible, but 'move' is enabled.",
+          "type": "string",
+          "enum": [
+            "not-adaptable-visibility"
+          ],
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ObjectPageHeaderSectionChart": {
+      "type": "object",
+      "properties": {
+        "chart": {
+          "description": "Chart",
+          "isViewNode": true,
+          "type": "object",
+          "properties": {},
+          "additionalProperties": true
+        },
+        "stashed": {
+          "description": "Header facets marked as stashed are initially not visible on the UI. Key users can add these header facets via key user adaptation.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "flexSettings": {
+          "$ref": "#/definitions/FlexSettings",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ObjectPageHeaderSectionDataPoint": {
+      "type": "object",
+      "properties": {
+        "dataPoint": {
+          "description": "Data Point",
+          "isViewNode": true,
+          "type": "object",
+          "properties": {},
+          "additionalProperties": true
+        },
+        "stashed": {
+          "description": "Header facets marked as stashed are initially not visible on the UI. Key users can add these header facets via key user adaptation.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "flexSettings": {
+          "$ref": "#/definitions/FlexSettings",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ObjectPageHeaderSectionContact": {
+      "type": "object",
+      "properties": {
+        "contact": {
+          "description": "Contact",
+          "isViewNode": true,
+          "type": "object",
+          "properties": {},
+          "additionalProperties": true
+        },
+        "stashed": {
+          "description": "Header facets marked as stashed are initially not visible on the UI. Key users can add these header facets via key user adaptation.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "flexSettings": {
+          "$ref": "#/definitions/FlexSettings",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ObjectPageHeaderSectionAddress": {
+      "type": "object",
+      "properties": {
+        "address": {
+          "description": "Address",
+          "isViewNode": true,
+          "type": "object",
+          "properties": {},
+          "additionalProperties": true
+        },
+        "stashed": {
+          "description": "Header facets marked as stashed are initially not visible on the UI. Key users can add these header facets via key user adaptation.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "flexSettings": {
+          "$ref": "#/definitions/FlexSettings",
+          "artifactType": "Manifest"
         }
       },
       "additionalProperties": false
@@ -58,7 +214,8 @@
       "properties": {
         "sectionLayout": {
           "$ref": "#/definitions/SectionLayoutType",
-          "description": "sectionLayout defines the layout of the sections. The default is \"Page\" (all sections in one page), possible values are \"Page\" and \"Tabs\" (every section in its own tab)."
+          "description": "sectionLayout defines the layout of the sections. The default is \"Page\" (all sections in one page), possible values are \"Page\" and \"Tabs\" (every section in its own tab).",
+          "artifactType": "Manifest"
         }
       },
       "additionalProperties": false
@@ -86,6 +243,15 @@
           },
           {
             "$ref": "#/definitions/ObjectPageSectionForm"
+          },
+          {
+            "$ref": "#/definitions/ObjectPageSectionDataPoint"
+          },
+          {
+            "$ref": "#/definitions/ObjectPageSectionContact"
+          },
+          {
+            "$ref": "#/definitions/ObjectPageSectionAddress"
           }
         ]
       }
@@ -108,71 +274,123 @@
       "properties": {
         "enableFullScreen": {
           "description": "By setting enableFullScreen to true you can enable the full screen mode for this table; this will display a new button on the table toolbar allowing the user to open the table in a fullscreen dialog.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         },
         "enablePaste": {
           "description": "In the Object Page tables, it is possible to add several items at a time by copying and pasting data from an excel file, if this property is set to true.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         },
-        "type": {
-          "$ref": "#/definitions/TableTypeV4",
-          "description": "Use type to define the table type. Note: Grid tables, analytical tables, and tree tables cannot be rendered on smartphones. Instead, responsive tables always show on smartphones."
+        "toolBar": {
+          "$ref": "#/definitions/ObjectPageToolBar",
+          "description": "Tool Bar"
         },
         "creationMode": {
-          "$ref": "#/definitions/TableCreationMode",
-          "description": "Defines the page behavior when a new record is created."
+          "$ref": "#/definitions/TableCreationModeOP",
+          "description": "Defines the page behavior when a new record is created.",
+          "artifactType": "Manifest"
         },
         "personalization": {
-          "$ref": "#/definitions/PersonalizationType",
-          "description": "Defines the personalization mode, currently only effective if variant management on page is either set to Page or Control.\nBy default all table settings are enabled. You can change this for the different parts of the table by setting the properties \"Column\", \"Sort\" and \"Filter\" accordingly.\nOmitting a property is treated as false, this allows apps to avoid getting new features like grouping in upcoming releases."
+          "$ref": "#/definitions/PersonalizationTypeOP",
+          "description": "Defines the personalization mode, currently only effective if variant management on page is either set to Page or Control.\nBy default all table settings are enabled. You can change this for the different parts of the table by setting the properties \"Column\", \"Sort\" and \"Filter\" accordingly.\nOmitting a property is treated as false, this allows apps to avoid getting new features like grouping in upcoming releases.",
+          "artifactType": "Manifest"
+        },
+        "quickVariantSelection": {
+          "$ref": "#/definitions/QuickVariantSelectionV4OP",
+          "description": "With quickVariantSelection you can switch on the multiple view feature (single table mode). It links to SelectionVariant (filters) or SelectionPresentationVariant (filters and sorters) you must have added to your annotations beforehand.",
+          "artifactType": "Manifest"
+        },
+        "columns": {
+          "$ref": "#/definitions/GenericColumns"
+        },
+        "type": {
+          "$ref": "#/definitions/TableTypeV4",
+          "description": "Use type to define the table type. Note: Grid tables, analytical tables, and tree tables cannot be rendered on smartphones. Instead, responsive tables always show on smartphones.",
+          "artifactType": "Manifest"
         },
         "selectionMode": {
           "$ref": "#/definitions/SelectionMode",
-          "description": "Applications can influence whether the table rows are selectable or not, and whether it allows for single selection or multiple selection. It can take the following values:\n- \"Auto\": This is the default value. In this mode, Fiori Elements first checks if there are any custom actions or IBN buttons in the table toolbar that require a context. If no such buttons are found, then no table selection is allowed in display mode. In edit mode too a selection is not allowed unless there is a Delete button in the table toolbar in which case multiple row selection will be allowed.\n- \"Multi\": This will allow end users to select multiple table records (in both display and edit mode)\n- \"Single\" This will allow end user to select only a single table record (in both display and edit mode)\n- \"None\": This will not allow the end user to select any table record in display mode. This will also be the case in edit mode unless the table has a delete button enabled, in which multiple selection is allowed in delete mode."
+          "description": "Applications can influence whether the table rows are selectable or not, and whether it allows for single selection or multiple selection. It can take the following values:\n- \"Auto\": This is the default value. In this mode, Fiori Elements first checks if there are any custom actions or IBN buttons in the table toolbar that require a context. If no such buttons are found, then no table selection is allowed in display mode. In edit mode too a selection is not allowed unless there is a Delete button in the table toolbar in which case multiple row selection will be allowed.\n- \"Multi\": This will allow end users to select multiple table records (in both display and edit mode)\n- \"Single\" This will allow end user to select only a single table record (in both display and edit mode)\n- \"None\": This will not allow the end user to select any table record in display mode. This will also be the case in edit mode unless the table has a delete button enabled, in which multiple selection is allowed in delete mode.",
+          "artifactType": "Manifest"
         },
         "selectAll": {
           "description": "The selectAll configuration overrides the selectionLimit and allows the user to select all the items. When set to true, the select all feature is enabled: a checkbox in the table header is displayed which selects all items when clicked.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         },
         "selectionLimit": {
           "description": "With the selectionLimit you can define how many items can be selected at a time,",
-          "type": "number"
+          "type": "number",
+          "artifactType": "Manifest"
         },
         "enableExport": {
           "description": "The exporting of the table to an Excel file is enabled in List Report tables by default. In Object Page, the export to Excel is available by default if the copy/paste feature is also available; otherwise it is disabled.\nTo disable the export in List Report or to enable it in Object Page, use the \"enableExport\" property and set it to false or true.",
-          "type": "boolean"
-        },
-        "quickVariantSelection": {
-          "$ref": "#/definitions/QuickVariantSelectionV4",
-          "description": "With quickVariantSelection you can switch on the multiple view feature (single table mode). It links to SelectionVariant (filters) or SelectionPresentationVariant (filters and sorters) you must have added to your annotations beforehand."
+          "type": "boolean",
+          "artifactType": "Manifest"
         },
         "condensedTableLayout": {
           "description": "You can set the content density to condensed for ui.table on the list report and object page applications.",
-          "type": "boolean"
-        },
-        "columns": {
-          "$ref": "#/definitions/GenericColumns"
+          "type": "boolean",
+          "artifactType": "Manifest"
         }
       },
       "additionalProperties": false
     },
-    "TableTypeV4": {
+    "ObjectPageToolBar": {
+      "description": "Toolbar",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "actions": {
+          "$ref": "#/definitions/ObjectPageToolBarActions"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "actions"
+      ]
+    },
+    "ObjectPageToolBarActions": {
+      "description": "Actions",
+      "isViewNode": true,
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/ObjectPageToolBarAction"
+      }
+    },
+    "ObjectPageToolBarAction": {
+      "description": "Action",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "enableOnSelect": {
+          "$ref": "#/definitions/SelectType",
+          "description": "Enables single selection for a bound action",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "SelectType": {
       "enum": [
-        "GridTable",
-        "ResponsiveTable"
+        "multi",
+        "single"
       ],
       "type": "string"
     },
-    "TableCreationMode": {
+    "TableCreationModeOP": {
       "type": "object",
       "properties": {
         "name": {
           "$ref": "#/definitions/TableCreationModeType",
-          "description": "The name property of TableCreationMode defines the creation mode; possible values are:\n- NewPage: The create action leads to a new page.\n- Inline: The create action leads to a new row at the table.\n- CreationRow: No create button will be rendered, an empty row is directly given.\nThe default is \"NewPage\"."
+          "description": "The name property of TableCreationMode defines the creation mode; possible values are:\n- NewPage: The create action leads to a new page.\n- Inline: The create action leads to a new row at the table.\n- CreationRow: No create button will be rendered, an empty row is directly given.\nThe default is \"NewPage\".",
+          "artifactType": "Manifest"
         },
         "createAtEnd": {
           "description": "In case of inline creation mode you can decide if the new row will be created at the end of the table, or direcly after the currently selected table. The default value is \"true\"",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         }
       },
       "additionalProperties": false
@@ -185,34 +403,28 @@
       ],
       "type": "string"
     },
-    "PersonalizationType": {
+    "PersonalizationTypeOP": {
       "type": "object",
       "properties": {
         "column": {
           "description": "Defines whether the user can add and remove columns to a given table.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         },
         "sort": {
           "description": "Defines whether the user can sort a given table.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         },
         "filter": {
           "description": "Defines whether the user can filter data of a given table.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         }
       },
       "additionalProperties": false
     },
-    "SelectionMode": {
-      "enum": [
-        "Auto",
-        "Multi",
-        "None",
-        "Single"
-      ],
-      "type": "string"
-    },
-    "QuickVariantSelectionV4": {
+    "QuickVariantSelectionV4OP": {
       "type": "object",
       "properties": {
         "paths": {
@@ -220,15 +432,18 @@
           "type": "array",
           "items": {
             "$ref": "#/definitions/AnnotationPathAsObject"
-          }
+          },
+          "artifactType": "Manifest"
         },
         "hideTableTitle": {
           "description": "You can hide the table and display only the titles of the tabs. To do so, add the hideTableTitle option and set it to true.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         },
         "showCounts": {
           "description": "You can show the counts of entries of each view. To do so, add the showCounts option and set it to true.",
-          "type": "boolean"
+          "type": "boolean",
+          "artifactType": "Manifest"
         }
       },
       "additionalProperties": false,
@@ -266,19 +481,8 @@
                 "description": "Defines where the column should be shown.\nDefault: it will be shown by default in the table.\nAdaptation: it will initially not shown in the table but be available via end user adaptation.\nHidden: the column is neither available in the table nor in adaptation."
               },
               "afterExecution": {
-                "description": "Settings that are only relevant for actions (associated with a UI.DataFieldForAction annotation)",
-                "type": "object",
-                "properties": {
-                  "navigateToInstance": {
-                    "description": "By default, a navigation is automatically triggered after an action execution. If applications want to disable the navigation, they can do so using the manifest setting “navigateToInstance”.",
-                    "type": "boolean"
-                  },
-                  "enableAutoScroll": {
-                    "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or change item after execution of an action",
-                    "type": "boolean"
-                  }
-                },
-                "additionalProperties": false
+                "$ref": "#/definitions/ActionAfterExecutionConfigurationOP",
+                "description": "Settings that are only relevant for actions (associated with a UI.DataFieldForAction annotation)"
               }
             },
             "additionalProperties": false
@@ -340,6 +544,22 @@
       ],
       "type": "string"
     },
+    "ActionAfterExecutionConfigurationOP": {
+      "type": "object",
+      "properties": {
+        "navigateToInstance": {
+          "description": "By default, a navigation is automatically triggered after an action execution. If applications want to disable the navigation, they can do so using the manifest setting “navigateToInstance”.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "enableAutoScroll": {
+          "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or change item after execution of an action",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
     "Placement": {
       "enum": [
         "After",
@@ -348,13 +568,74 @@
       ],
       "type": "string"
     },
+    "TableTypeV4": {
+      "enum": [
+        "AnalyticalTable",
+        "GridTable",
+        "ResponsiveTable"
+      ],
+      "type": "string"
+    },
+    "SelectionMode": {
+      "enum": [
+        "Auto",
+        "Multi",
+        "None",
+        "Single"
+      ],
+      "type": "string"
+    },
     "ObjectPageSectionForm": {
       "type": "object",
-      "additionalProperties": {
-        "type": "object",
-        "properties": {},
-        "additionalProperties": true
-      }
+      "properties": {
+        "form": {
+          "description": "Form",
+          "isViewNode": true,
+          "type": "object",
+          "properties": {},
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "ObjectPageSectionDataPoint": {
+      "type": "object",
+      "properties": {
+        "dataPoint": {
+          "description": "Data Point",
+          "isViewNode": true,
+          "type": "object",
+          "properties": {},
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "ObjectPageSectionContact": {
+      "type": "object",
+      "properties": {
+        "contact": {
+          "description": "Contact",
+          "isViewNode": true,
+          "type": "object",
+          "properties": {},
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "ObjectPageSectionAddress": {
+      "type": "object",
+      "properties": {
+        "address": {
+          "description": "Address",
+          "isViewNode": true,
+          "type": "object",
+          "properties": {},
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": false
     },
     "CustomSections": {
       "description": "Custom Sections",