[SITO] File format for situation objects - New (#380)

* Initial object upload * Resolve abaplint issue * Resolve abaplint issue 2 * Resolve abaplint issue 3 * Resolve abaplint issue 4 * Update json.md test change * SITO: Adapt entity names, ID, descriptions * Revert docu changes * Descriptions, order, etc. * Singular vs Plural * DDIC, SORTED, NAV+CB Co-authored-by: Michael Schneider <[email protected]> Co-authored-by: Tobias Münch <[email protected]> Co-authored-by: Katharina Wurz <[email protected]>
SAP · Aug 25, 2022 · 843a9d4 · 843a9d4
1 parent f0bb765
commit 843a9d4
Show file tree

Hide file tree

Showing 5 changed files with 1,747 additions and 0 deletions.
diff --git a/file-formats/sito/README.md b/file-formats/sito/README.md
@@ -0,0 +1,5 @@
+# SITO File Format
+
+File | Cardinality | Definition | Schema | Example
+:--- | :---  | :--- | :--- | :---
+`<name>.sito.json` | 1 | [`zif_aff_sito_v1.intf.abap`](./type/zif_aff_sito_v1.intf.abap) | [`sito-v1.json`](./sito-v1.json) | [`zmo_sito_test.sito.json`](./examples/zmo_sito_test.sito.json)
diff --git a/file-formats/sito/examples/zmo_sito_test.sito.json b/file-formats/sito/examples/zmo_sito_test.sito.json
@@ -0,0 +1,256 @@
+{
+  "formatVersion": "1",
+  "header": {
+    "description": "Flight (Demo Object)",
+    "originalLanguage": "en"
+  },
+  "situationObject": {
+    "reusable": false,
+    "scope": "SAP",
+    "sapObjectType": "BusinessSituationDemoFlight",
+    "extensible": false,
+    "text": {
+      "name": "Flight (Demo Object)",
+      "description": "The flight object is used in the demo scenario Flight Profitability (SITDEMO_FLIGHT_PROFITABILITY)."
+    },
+    "structures": [
+      {
+        "id": "SITDEMO_CDS_FLIGHT",
+        "name": "I_SITN2DEMOFLIGHT",
+        "type": "CDS",
+        "reusable": false,
+        "scope": "SAP",
+        "sapObjectNodeType": "BusinessSituationDemoFlight",
+        "text": {
+          "description": "CDS view of flight (demo object)"
+        },
+        "semanticKeys": [
+          {
+            "field": "SITNDEMOCARRIERID",
+            "fieldOrder": "01"
+          },
+          {
+            "field": "SITNDEMOCONNECTIONID",
+            "fieldOrder": "02"
+          },
+          {
+            "field": "SITNDEMOFLIGHTDATE",
+            "fieldOrder": "03"
+          }
+        ],
+        "valueHelpMappings": [
+          {
+            "fieldName": "SITNDEMOCARRIERID",
+            "appType": "allApps",
+            "type": "service",
+            "scope": "SAP"
+          },
+          {
+            "fieldName": "SITNDEMOPLANETYPE",
+            "appType": "allApps",
+            "type": "service",
+            "scope": "SAP"
+          },
+          {
+            "fieldName": "SITNDEMOCARRIERREGION",
+            "appType": "allApps",
+            "type": "service",
+            "scope": "SAP"
+          },
+          {
+            "fieldName": "SITNDEMOCONNECTIONID",
+            "appType": "allApps",
+            "type": "service",
+            "scope": "SAP"
+          }
+        ],
+        "services": [
+          {
+            "id": "SITDEMO_VH",
+            "fieldName": "SITNDEMOCARRIERID",
+            "type": "allApps",
+            "entitySet": "C_Sitn2DemoFlightVH",
+            "property": "SitnDemoCarrierID"
+          },
+          {
+            "id": "SITDEMO_VH",
+            "fieldName": "SITNDEMOPLANETYPE",
+            "type": "allApps",
+            "entitySet": "C_Sitn2DemoFlightVH",
+            "property": "SitnDemoPlaneType"
+          },
+          {
+            "id": "SITDEMO_VH",
+            "fieldName": "SITNDEMOCARRIERREGION",
+            "type": "allApps",
+            "entitySet": "C_Sitn2DemoFlightVH",
+            "property": "SitnDemoRegionCode"
+          },
+          {
+            "id": "SITDEMO_VH",
+            "fieldName": "SITNDEMOCONNECTIONID",
+            "type": "allApps",
+            "entitySet": "C_Sitn2DemoFlightVH",
+            "property": "SitnDemoConnectionID"
+          }
+        ]
+      }
+    ],
+    "endUserActions": [
+      {
+        "id": "SITDEMO_ACT_CANCEL_FLIGHT",
+        "type": "callbackAction",
+        "reusable": false,
+        "scope": "SAP",
+        "text": {
+          "name": "Cancel Flight",
+          "description": "Set flight status to unscheduled"
+        },
+        "callback": {
+          "id": "SITDEMO_CB_CANCEL_FLIGHT"
+        }
+      },
+      {
+        "id": "SITDEMO_ACT_CHANGE_PLANE",
+        "type": "callbackAction",
+        "reusable": false,
+        "scope": "SAP",
+        "text": {
+          "name": "Change Plane",
+          "description": "Assign another plane to the flight"
+        },
+        "callback": {
+          "id": "SITDEMO_CB_CHANGE_PLANE"
+        }
+      },
+      {
+        "id": "SITDEMO_ACT_MANAGE_AIRLINE",
+        "type": "navigationAction",
+        "reusable": false,
+        "scope": "SAP",
+        "text": {
+          "name": "Display Airline",
+          "description": "Show contact details"
+        },
+        "navigation": {
+          "id": "SITDEMO_NAV_MANAGE_AIRLINE"
+        }
+      },
+      {
+        "id": "SITDEMO_ACT_MANAGE_FLIGHT",
+        "type": "navigationAction",
+        "reusable": false,
+        "scope": "SAP",
+        "text": {
+          "name": "Manage Flight",
+          "description": "Maintain bookings and flight details"
+        },
+        "navigation": {
+          "id": "SITDEMO_NAV_MANAGE_FLIGHT"
+        }
+      }
+    ],
+    "navigations": [
+      {
+        "id": "SITDEMO_NAV_MANAGE_FLIGHT",
+        "reusable": false,
+        "scope": "SAP",
+        "semanticObject": "SituationDemoFlight",
+        "semanticObjectAction": "maintain",
+        "parameters": [
+          {
+            "name": "SitnDemoCarrierID"
+          },
+          {
+            "name": "SitnDemoConnectionID"
+          },
+          {
+            "name": "SitnDemoFlightDate"
+          }
+        ]
+      },
+      {
+        "id": "SITDEMO_NAV_MANAGE_AIRLINE",
+        "reusable": false,
+        "scope": "SAP",
+        "semanticObject": "SituationDemoFlight",
+        "semanticObjectAction": "maintain",
+        "parameters": [
+          {
+            "name": "SitnDemoCarrierID"
+          }
+        ]
+      }
+    ],
+    "callbacks": [
+      {
+        "id": "SITDEMO_CB_CHANGE_PLANE",
+        "reusable": false,
+        "scope": "SAP",
+        "className": "CL_SIT2_DEMO_CB_CHANGE_PLANE",
+        "parameters": [
+          {
+            "name": "CARRID"
+          },
+          {
+            "name": "PLANETYPE"
+          },
+          {
+            "name": "CONNID"
+          },
+          {
+            "name": "FLDATE"
+          }
+        ]
+      },
+      {
+        "id": "SITDEMO_CB_CANCEL_FLIGHT",
+        "reusable": false,
+        "scope": "SAP",
+        "className": "CL_SIT2_DEMO_CB_CANCEL_FLIGHT",
+        "parameters": [
+          {
+            "name": "CARRID"
+          },
+          {
+            "name": "CONNID"
+          },
+          {
+            "name": "FLDATE"
+          }
+        ]
+      }
+    ],
+    "valueHelpServices": [
+      {
+        "id": "SITDEMO_VH",
+        "reusable": false,
+        "scope": "SAP",
+        "protocolVersion": "V2",
+        "pathType": "standard",
+        "customPath": "",
+        "binding": "C_SITN2DEMOFLIGHTVH_CDS",
+        "definition": "",
+        "version": "0001",
+        "valueHelpServiceProviders": [
+          {
+            "entitySet": "C_Sitn2DemoFlightVH",
+            "property": "SitnDemoCarrierID"
+          },
+          {
+            "entitySet": "C_Sitn2DemoFlightVH",
+            "property": "SitnDemoConnectionID"
+          },
+          {
+            "entitySet": "C_Sitn2DemoFlightVH",
+            "property": "SitnDemoPlaneType"
+          },
+          {
+            "entitySet": "C_Sitn2DemoFlightVH",
+            "property": "SitnDemoRegionCode"
+          }
+        ]
+      }
+    ]
+  }
+}