smbc-v1.json

{
  "$comment": "This file is autogenerated, do not edit manually, see https://github.com/SAP/abap-file-formats for more information.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/SAP/abap-file-formats/blob/main/file-formats/smbc/smbc-v1.json",
  "title": "Business Configuration Maintenance Object Type",
  "type": "object",
  "properties": {
    "formatVersion": {
      "title": "ABAP File Format Version",
      "description": "The ABAP file format version",
      "type": "string",
      "const": "1"
    },
    "header": {
      "title": "Header for SMBC Objects",
      "type": "object",
      "properties": {
        "description": {
          "title": "Description",
          "description": "Description of the Business Configuration shown in the Maintain Business Configurations app. Can be translated with the Maintain Translations app",
          "type": "string",
          "maxLength": 50
        },
        "originalLanguage": {
          "title": "Original Language",
          "description": "Original language of the development object. Attributes Name and Description must be maintained in this language",
          "type": "string",
          "minLength": 2
        },
        "abapLanguageVersion": {
          "title": "ABAP Language Version",
          "description": "ABAP language version",
          "type": "string",
          "enum": [
            "standard",
            "cloudDevelopment"
          ],
          "enumTitles": [
            "Standard",
            "ABAP Cloud Development"
          ],
          "enumDescriptions": [
            "Standard",
            "ABAP cloud development"
          ],
          "default": "standard"
        }
      },
      "additionalProperties": false,
      "required": [
        "description",
        "originalLanguage"
      ]
    },
    "serviceConfiguration": {
      "title": "Service Configuration",
      "type": "object",
      "properties": {
        "serviceBinding": {
          "title": "Service Binding",
          "description": "Service Binding used for business configuration maintenance",
          "type": "string",
          "maxLength": 40
        },
        "serviceName": {
          "title": "Service Name",
          "type": "string",
          "maxLength": 40
        },
        "serviceVersion": {
          "title": "Service Version",
          "description": "The major version number of the service to be used (as defined in the Service Binding)",
          "type": "string",
          "maxLength": 4,
          "pattern": "^[0-9]+$"
        },
        "rootEntitySet": {
          "title": "Root Entity Set",
          "description": "Root Entity Set exposed by the Service Definition",
          "type": "string",
          "maxLength": 30
        },
        "name": {
          "title": "Name",
          "description": "Name of the Business Configuration",
          "type": "string",
          "maxLength": 50
        },
        "configurationGroup": {
          "title": "Configuration Group",
          "type": "string",
          "maxLength": 30
        },
        "skipRootEntity": {
          "title": "Skip Root Entity List Report",
          "description": "If true, the UI automatically navigates to the Object Page of the root entity",
          "type": "boolean"
        }
      },
      "additionalProperties": false,
      "required": [
        "serviceBinding",
        "serviceName",
        "serviceVersion",
        "rootEntitySet",
        "name"
      ]
    },
    "appConfiguration": {
      "title": "Confguration of List Report and Object Pages",
      "type": "object",
      "properties": {
        "listReport": {
          "title": "List Report Configuration",
          "type": "object",
          "properties": {
            "initialLoad": {
              "title": "Initial Load",
              "description": "Defines whether data in the List Report is automatically loaded on first app start.",
              "type": "string",
              "enum": [
                "enabled",
                "disabled",
                "auto"
              ],
              "enumTitles": [
                "Enabled",
                "Disabled",
                "Automatic"
              ],
              "enumDescriptions": [
                "Data is always loaded when opening the app",
                "Data is never loaded when opening the app without an app state",
                "Data is only loaded, if initial/preset filters are available"
              ],
              "default": "enabled"
            },
            "variantManagement": {
              "title": "Variant Management",
              "type": "string",
              "enum": [
                "page",
                "none"
              ],
              "enumTitles": [
                "Page",
                "None"
              ],
              "default": "page"
            }
          },
          "additionalProperties": false
        },
        "objectPages": {
          "title": "Object Page Configurations",
          "type": "array",
          "uniqueItems": true,
          "items": {
            "title": "Object Page Settings",
            "type": "object",
            "properties": {
              "entitySet": {
                "title": "Entity Set",
                "type": "string"
              },
              "sectionLayout": {
                "title": "Section Layout",
                "description": "Toggle between onepage concept and tabs.",
                "type": "string",
                "enum": [
                  "page",
                  "tabs"
                ],
                "enumTitles": [
                  "Page",
                  "Tabs"
                ],
                "default": "page"
              },
              "variantManagement": {
                "title": "Variant Management",
                "type": "string",
                "enum": [
                  "control",
                  "none"
                ],
                "enumTitles": [
                  "Control",
                  "None"
                ],
                "default": "none"
              },
              "editableHeaderContent": {
                "title": "Editable Header Content",
                "description": "If true, the header content is changeable in edit mode",
                "type": "boolean"
              }
            },
            "additionalProperties": false
          }
        },
        "tableSettings": {
          "title": "Table Settings",
          "type": "array",
          "uniqueItems": true,
          "items": {
            "title": "Table Settings",
            "type": "object",
            "properties": {
              "entitySet": {
                "title": "Entity Set",
                "type": "string"
              },
              "tableType": {
                "title": "Table Type",
                "type": "string",
                "enum": [
                  "responsiveTable",
                  "gridTable"
                ],
                "enumTitles": [
                  "Responsive Table",
                  "Grid Table"
                ],
                "default": "responsiveTable"
              },
              "selectionMode": {
                "title": "Selection Mode",
                "type": "string",
                "enum": [
                  "auto",
                  "multi",
                  "single",
                  "none"
                ],
                "enumTitles": [
                  "Automatic",
                  "Select Multiple Entries",
                  "Select Single Entry",
                  "None"
                ],
                "default": "auto"
              },
              "rowCountMode": {
                "title": "Row Count Mode",
                "description": "Defines how the table handles the visible rows in the table",
                "type": "string",
                "enum": [
                  "fixed",
                  "auto"
                ],
                "enumTitles": [
                  "Fixed",
                  "Automatic"
                ],
                "enumDescriptions": [
                  "The table always has as many rows as defined in the visibleRowCount property",
                  "The visibleRowCount property is changed by the table automatically"
                ],
                "default": "fixed"
              },
              "rowCount": {
                "title": "Row Count",
                "description": "Number of visible rows of the table",
                "type": "integer",
                "minimum": 1,
                "maximum": 1000,
                "default": 5
              },
              "creationModeName": {
                "title": "Table Creation Mode",
                "type": "string",
                "enum": [
                  "newPage",
                  "inline",
                  "creationRow",
                  "inlineCreationRows"
                ],
                "enumTitles": [
                  "New Page",
                  "Inline",
                  "Creation Row",
                  "Empty Row"
                ],
                "enumDescriptions": [
                  "Item is created in subpage",
                  "By clicking on 'Create' a new line is created but automatic navigation to subpage is not performed.",
                  "By clicking on 'Add row' a new line is created but automatic navigation to subpage is not performed.",
                  "In create or edit mode, one new empty row is added to the table."
                ],
                "default": "newPage"
              },
              "createAtEnd": {
                "title": "Create at End",
                "description": "If true, a new row is added to the end of the table instead of the beginning of the table",
                "type": "boolean"
              },
              "hideFilter": {
                "title": "Hide Filter",
                "description": "If true, the user cannot filter data of the table",
                "type": "boolean"
              },
              "hideSort": {
                "title": "Hide Sort",
                "description": "If true, the user cannot sort the table",
                "type": "boolean"
              },
              "hideColumn": {
                "title": "Hide Column",
                "description": "If true, the user cannot add and remove columns to the table",
                "type": "boolean"
              },
              "condensedTableLayout": {
                "title": "Condensed Table Layout",
                "description": "If true, display rows in a condensed way. Only applicaple to Table Type 'GridTable'.",
                "type": "boolean"
              },
              "disablePaste": {
                "title": "Disable Paste",
                "description": "If true, disable the possibility to add several items by copying and pasting data from an excel file",
                "type": "boolean"
              },
              "enableFullScreen": {
                "title": "Enable Full Screen",
                "description": "If true, a button on the table toolbar allows the user to open the table in fullscreen dialog",
                "type": "boolean"
              },
              "enableMassEdit": {
                "title": "Enable Mass Edit",
                "description": "Mass editing allows users to simultaneously change multiple objects that share the same editable properties",
                "type": "boolean"
              }
            },
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "required": [
    "formatVersion",
    "header",
    "serviceConfiguration"
  ]
}