Skip to content

Commit 59b44ef

Browse files
KUMARMUKULSAPschneidermic0wurzka
authored
[EDCK] Add new object type for EDCK (#629)
Co-authored-by: Michael Schneider <[email protected]> Co-authored-by: Katharina Wurz <[email protected]>
1 parent 8c921e8 commit 59b44ef

File tree

5 files changed

+222
-0
lines changed

5 files changed

+222
-0
lines changed

‎file-formats/edck/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# EDCK File Format
2+
3+
File | Cardinality | Definition | Schema | Example
4+
:--- | :--- | :--- | :--- | :---
5+
`<name>.edck.json` | 1 | [`zif_aff_edck_v1.intf.abap`](./type/zif_aff_edck_v1.intf.abap) | [`edck-v1.json`](./edck-v1.json) | [`z_aff_example_edck.edck.json`](./examples/z_aff_example_edck.edck.json)

‎file-formats/edck/edck-v1.json‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
{
2+
"$comment": "This file is autogenerated, do not edit manually, see https://github.com/SAP/abap-file-formats for more information.",
3+
"$schema": "https://json-schema.org/draft/2020-12/schema",
4+
"$id": "https://github.com/SAP/abap-file-formats/blob/main/file-formats/edck/edck-v1.json",
5+
"title": "Consistency Check ID",
6+
"description": "Consistency check ID",
7+
"type": "object",
8+
"properties": {
9+
"formatVersion": {
10+
"title": "ABAP File Format Version",
11+
"description": "The ABAP file format version",
12+
"type": "string",
13+
"const": "1"
14+
},
15+
"header": {
16+
"title": "Header",
17+
"description": "Header",
18+
"type": "object",
19+
"properties": {
20+
"description": {
21+
"title": "Description",
22+
"description": "Description of the ABAP object",
23+
"type": "string",
24+
"maxLength": 60
25+
},
26+
"originalLanguage": {
27+
"title": "Original Language",
28+
"description": "Original language of the ABAP object",
29+
"type": "string",
30+
"minLength": 2
31+
},
32+
"abapLanguageVersion": {
33+
"title": "ABAP Language Version",
34+
"description": "ABAP language version",
35+
"type": "string",
36+
"enum": [
37+
"standard",
38+
"cloudDevelopment"
39+
],
40+
"enumTitles": [
41+
"Standard",
42+
"ABAP Cloud Development"
43+
],
44+
"enumDescriptions": [
45+
"Standard",
46+
"ABAP cloud development"
47+
],
48+
"default": "standard"
49+
}
50+
},
51+
"additionalProperties": false,
52+
"required": [
53+
"description",
54+
"originalLanguage"
55+
]
56+
},
57+
"generalInformation": {
58+
"title": "General Information",
59+
"description": "General information of consistency check ID",
60+
"type": "object",
61+
"properties": {
62+
"checkCategory": {
63+
"title": "Check Category",
64+
"description": "Consistency check category",
65+
"type": "string",
66+
"enum": [
67+
"existenceCheck",
68+
"statusCheck",
69+
"edocumentExistenceCheck",
70+
"contentMismatchCheck"
71+
],
72+
"enumTitles": [
73+
"Existence Check",
74+
"Status Check",
75+
"Edocument Existence Check",
76+
"Content Mismatch Check"
77+
],
78+
"enumDescriptions": [
79+
"Existence check",
80+
"Status check",
81+
"Edocument existence check",
82+
"Content mismatch check"
83+
],
84+
"default": "existenceCheck"
85+
},
86+
"checkClassification": {
87+
"title": "Check Classification",
88+
"description": "Consistency check ID classification",
89+
"type": "string",
90+
"enum": [
91+
"coreDeliveredChecks",
92+
"additionalImplementedChecks"
93+
],
94+
"enumTitles": [
95+
"Core Delivered Checks",
96+
"Additionally (Extended) Implemented Checks"
97+
],
98+
"enumDescriptions": [
99+
"Core delivered checks",
100+
"Additionally (Extended) implemented checks"
101+
],
102+
"default": "coreDeliveredChecks"
103+
},
104+
"additionalCheckClass": {
105+
"title": "Additional Check Class",
106+
"description": "Consistency check class",
107+
"type": "string",
108+
"maxLength": 30
109+
},
110+
"resultProcessDerived": {
111+
"title": "Result Process Derived",
112+
"description": "Result process derived",
113+
"type": "boolean"
114+
}
115+
},
116+
"additionalProperties": false
117+
}
118+
},
119+
"additionalProperties": false,
120+
"required": [
121+
"formatVersion",
122+
"header",
123+
"generalInformation"
124+
]
125+
}

‎file-formats/edck/examples/z_aff_example_edck.edck.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"formatVersion": "1",
3+
"header": {
4+
"description": "Example Check ID",
5+
"originalLanguage": "en",
6+
"abapLanguageVersion": "cloudDevelopment"
7+
},
8+
"generalInformation": {
9+
"checkCategory": "existenceCheck",
10+
"checkClassification": "coreDeliveredChecks",
11+
"resultProcessDerived": false
12+
}
13+
}

‎file-formats/edck/type/zif_aff_edck_v1.intf.abap‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
INTERFACE zif_aff_edck_v1
2+
PUBLIC.
3+
4+
TYPES ty_check_classification TYPE c LENGTH 1.
5+
TYPES ty_check_category TYPE c LENGTH 6.
6+
7+
TYPES:
8+
BEGIN OF ty_attributes,
9+
"! <p class="shorttext">Check Category</p>
10+
"! Consistency check category
11+
"! $values {@link zif_aff_edck_v1.data:co_check_category}
12+
"! $default {@link zif_aff_edck_v1.data:co_check_category.existence_check}
13+
check_category TYPE ty_check_category,
14+
"! <p class="shorttext">Check Classification</p>
15+
"! Consistency check ID classification
16+
"! $values {@link zif_aff_edck_v1.data:co_check_classification}
17+
"! $default {@link zif_aff_edck_v1.data:co_check_classification.core_delivered_checks}
18+
check_classification TYPE ty_check_classification,
19+
"! <p class="shorttext">Additional Check Class</p>
20+
"! Consistency check class
21+
additional_check_class TYPE zif_aff_types_v1=>ty_object_name_30,
22+
"! <p class="shorttext">Result Process Derived</p>
23+
"! Result process derived
24+
result_process_derived TYPE abap_bool,
25+
END OF ty_attributes.
26+
27+
TYPES:
28+
"! <p class="shorttext">Consistency Check ID</p>
29+
"! Consistency check ID
30+
BEGIN OF ty_main,
31+
"! $required
32+
format_version TYPE zif_aff_types_v1=>ty_format_version,
33+
"! <p class="shorttext">Header</p>
34+
"! Header
35+
"! $required
36+
header TYPE zif_aff_types_v1=>ty_header_60_cloud,
37+
"! <p class="shorttext">General Information</p>
38+
"! General information of consistency check ID
39+
"! $required
40+
general_information TYPE ty_attributes,
41+
END OF ty_main.
42+
43+
CONSTANTS:
44+
"! <p class="shorttext">Check Classification</p>
45+
"! Check classification
46+
BEGIN OF co_check_classification,
47+
"! <p class="shorttext">Core Delivered Checks</p>
48+
"! Core delivered checks
49+
core_delivered_checks TYPE ty_check_classification VALUE 'C',
50+
"! <p class="shorttext">Additionally (Extended) Implemented Checks</p>
51+
"! Additionally (Extended) implemented checks
52+
additional_implemented_checks TYPE ty_check_classification VALUE 'A',
53+
END OF co_check_classification.
54+
55+
CONSTANTS:
56+
"! <p class="shorttext">Check Category</p>
57+
"! Check category
58+
BEGIN OF co_check_category,
59+
"! <p class="shorttext">Existence Check</p>
60+
"! Existence check
61+
existence_check TYPE ty_check_category VALUE 'EXIST',
62+
"! <p class="shorttext">Status Check</p>
63+
"! Status check
64+
status_check TYPE ty_check_category VALUE 'STATUS',
65+
"! <p class="shorttext">Edocument Existence Check</p>
66+
"! Edocument existence check
67+
edocument_existence_check TYPE ty_check_category VALUE 'EDOCHK',
68+
"! <p class="shorttext">Content Mismatch Check</p>
69+
"! Content mismatch check
70+
content_mismatch_check TYPE ty_check_category VALUE 'CONMIS',
71+
END OF co_check_category.
72+
ENDINTERFACE.

‎file-formats/edck/type/zif_aff_edck_v1.intf.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"formatVersion": "1",
3+
"header": {
4+
"description": "AFF type for EDCK",
5+
"originalLanguage": "en"
6+
}
7+
}

0 commit comments

Comments
 (0)