Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EDCK] Add new object type for EDCK #629

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions file-formats/edck/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# EDCK File Format

File | Cardinality | Definition | Schema | Example
:--- | :--- | :--- | :--- | :---
`<name>.edck.json` | 1 | [`zif_aff_edck_v1.intf.abap`](./type/zif_aff_edck_v1.intf.abap) | [`edck-v1.json`](./edck-v1.json)
127 changes: 127 additions & 0 deletions file-formats/edck/edck-v1.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
{
"$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/edck/edck-v1.json",
"title": "Consistency Check ID",
"description": "Check ID (EDCK) v1",
"type": "object",
"properties": {
"formatVersion": {
"title": "ABAP File Format Version",
"description": "The ABAP file format version",
"type": "string",
"const": "1"
},
"header": {
"title": "Header",
"description": "Header",
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Description of the ABAP object",
"type": "string",
"maxLength": 60
},
"originalLanguage": {
"title": "Original Language",
"description": "Original language of the ABAP object",
"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"
]
},
"attributes": {
"title": "Check ID Definition",
"description": "Attributes of a Consistency Check",
"type": "object",
"properties": {
"checkcategory": {
"title": "Check Category",
"description": "Consistency Check Category",
"type": "string",
"enum": [
"exist",
"status",
"edochk",
"conmis"
],
"enumTitles": [
"Existence Check",
"Status Check",
"Edocument Existence Check",
"Content Mismatch"
],
"enumDescriptions": [
"Existence Check",
"Status Check",
"Edocument Existence Check",
"Content Mismatch"
]
},
"checkidclassification": {
"title": "Check Classification",
"description": "Consistency Check ID Classification",
"type": "string",
"enum": [
"core",
"additional"
],
"enumTitles": [
"Core delivered checks",
"Additionally (Extended) implemented checks"
],
"enumDescriptions": [
"Core delivered checks",
"Additionally (Extended) implemented checks"
]
},
"checkclass": {
"title": "Additional Check Class",
"description": "Consistency Check Class",
"type": "string",
"maxLength": 30
},
"resultderivationindicator": {
"title": "Result Derivation Indicator",
"description": "Result Process Derived by BAdI",
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"checkcategory",
"checkidclassification"
]
}
},
"additionalProperties": false,
"required": [
"formatVersion",
"header",
"attributes"
]
}
74 changes: 74 additions & 0 deletions file-formats/edck/type/zif_aff_edck_v1.intf.abap
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
INTERFACE zif_aff_edck_v1
PUBLIC.

TYPES ty_check_classification TYPE c LENGTH 1.
TYPES ty_check_category TYPE c LENGTH 6.

TYPES:
BEGIN OF ty_attributes,
"! <p class="shorttext">Check Category</p>
"! Consistency Check Category

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Consistency Check Category
"! Consistency check category

"! $values {@link zif_aff_edck_v1.data:co_check_category}
"! $default {@link if_aff_edck_v1.data:co_check_category.exist}
"! $required
checkcategory TYPE ty_check_category,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
checkcategory TYPE ty_check_category,
check_category TYPE ty_check_category,

"! <p class="shorttext">Check Classification</p>
"! Consistency Check ID Classification

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Consistency Check ID Classification
"! Consistency check ID classification

"! $values {@link zif_aff_edck_v1.data:co_check_classification}
"! $default {@link if_aff_edck_v1.data:co_check_classification.core}
"! $required
checkidclassification TYPE ty_check_classification,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
checkidclassification TYPE ty_check_classification,
check_id_classification TYPE ty_check_classification,

"! <p class="shorttext">Additional Check Class</p>
"! Consistency Check Class

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Consistency Check Class
"! Consistency check class

checkclass TYPE zif_aff_types_v1=>ty_object_name_30,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
checkclass TYPE zif_aff_types_v1=>ty_object_name_30,
check_class TYPE zif_aff_types_v1=>ty_object_name_30,

"! <p class="shorttext">Result Derivation Indicator</p>
"! Result Process Derived by BAdI

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Result Process Derived by BAdI
"! Result process derived by BAdI

resultderivationindicator TYPE abap_bool,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
resultderivationindicator TYPE abap_bool,
result_derivation_indicator TYPE abap_bool,

END OF ty_attributes.

TYPES:
"! <p class="shorttext">Consistency Check ID</p>
"! Check ID (EDCK) v1

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Check ID (EDCK) v1
"! Consistency check ID (EDCK) v1

BEGIN OF ty_main,
"! $required
format_version TYPE zif_aff_types_v1=>ty_format_version,
"! <p class="shorttext">Header</p>
"! Header
"! $required
header TYPE zif_aff_types_v1=>ty_header_60_cloud,
"! <p class="shorttext">Check ID Definition</p>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the title here mention attributes as well?

"! Attributes of a Consistency Check
"! $required
attributes TYPE ty_attributes,
END OF ty_main.

CONSTANTS:
"! <p class="shorttext">Check Classification</p>
"! Check Classification

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Check Classification
"! Check classification

BEGIN OF co_check_classification,
"! <p class="shorttext">Core delivered checks</p>
"! Core delivered checks
core TYPE ty_check_classification VALUE 'C',
"! <p class="shorttext">Additionally (Extended) implemented checks</p>
"! Additionally (Extended) implemented checks

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would extended checks sound better?

additional TYPE ty_check_classification VALUE 'A',
END OF co_check_classification.

CONSTANTS:
"! <p class="shorttext">Check Category</p>
"! Check Category

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Check Category
"! Check category

BEGIN OF co_check_category,
"! <p class="shorttext">Existence Check</p>
"! Existence Check

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Existence Check
"! Existence check

exist TYPE ty_check_category VALUE 'EXIST',
"! <p class="shorttext">Status Check</p>
"! Status Check

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Status Check
"! Status check

status TYPE ty_check_category VALUE 'STATUS',
"! <p class="shorttext">Edocument Existence Check</p>
"! Edocument Existence Check

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Edocument Existence Check
"! Edocument existence check

edochk TYPE ty_check_category VALUE 'EDOCHK',

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
edochk TYPE ty_check_category VALUE 'EDOCHK',
edocument_check TYPE ty_check_category VALUE 'EDOCHK',

"! <p class="shorttext"> Content Mismatch</p>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! <p class="shorttext"> Content Mismatch</p>
"! <p class="shorttext">Content Mismatch Check</p>

"! Content Mismatch

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"! Content Mismatch
"! Content mismatch check

conmis TYPE ty_check_category VALUE 'CONMIS',

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
conmis TYPE ty_check_category VALUE 'CONMIS',
content_mismatch_check TYPE ty_check_category VALUE 'CONMIS',

END OF co_check_category.
ENDINTERFACE.
7 changes: 7 additions & 0 deletions file-formats/edck/type/zif_aff_edck_v1.intf.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"formatVersion": "1",
"header": {
"description": "AFF type for EDCK",
"originalLanguage": "en"
}
}
Loading