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.

Sign up for GitHub

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

[EDOI] Add new object types EDOI #681

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

[EDOI] Add new object types EDOI #681

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a8ec8b7
Add files for EDOI & EDOT
i506210 Jan 27, 2025
499d83a
React to abaplint
i506210 Jan 27, 2025
e1e96b2
React to abaplint
i506210 Jan 27, 2025
ecdefa0
Merge branch 'main' into feature/edoi
i506210 Jan 27, 2025
3a2e9b9
React to comments from Michael Schneider
i506210 Jan 28, 2025
6b8c5b2
reaction to comments
i506210 Feb 4, 2025
a158a2a
Merge branch 'main' into feature/edoi
i506210 Feb 13, 2025
2759148
corrections
i506210 Feb 19, 2025
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/edoi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# EDOI File Format

File | Cardinality | Definition | Schema | Example
:--- | :--- | :--- | :--- | :---
`<name>.edoi.json` | 1 | [`zif_aff_edoi_v1.intf.abap`](./type/zif_aff_edoi_v1.intf.abap) | [`edoi-v1.json`](./edoi-v1.json)
207 changes: 207 additions & 0 deletions file-formats/edoi/edoi-v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
{
"$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/edoi/edoi-v1.json",
"title": "eDocument Interface",
"description": "eDocument Interface",
"type": "object",
"properties": {
"formatVersion": {
"title": "Format Version",
"description": "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",
"keyUser",
"cloudDevelopment"
],
"enumTitles": [
"Standard",
"ABAP for Key Users",
"ABAP Cloud Development"
],
"enumDescriptions": [
"Standard",
"ABAP for key user extensibility",
"ABAP cloud development"
],
"default": "standard"
}
},
"additionalProperties": false,
"required": [
"description",
"originalLanguage"
]
},
"generalInformation": {
"title": "eDocument Interface",
"description": "eDocument Interface",
"type": "object",
"properties": {
"edocumentInterfaceId": {
"title": "eDocument Interface",
"description": "eDocument Interface",
"type": "string",
"maxLength": 30
},
"interfaceDescription": {
"title": "eDocument Interface Description",
"description": "Interface Description.",
"type": "string",
"maxLength": 100
},
"interfaceDirection": {
"title": "eDocument Interface Direction",
"description": "Interface Direction.",
"type": "string",
"enum": [
"outbound",
"inbound"
],
"enumTitles": [
"Outbound",
"Inbound"
],
"enumDescriptions": [
"Outbound",
"Inbound"
],
"default": "outbound"
},
"edocumentInterfaceVersion": {
"title": "Interface Version",
"description": "Interface Version",
"type": "array",
"uniqueItems": true,
"items": {
"title": "Interface Version",
"description": "eDocument Interface Version",
"type": "object",
"properties": {
"intVersion": {
"title": "Interface Version",
"description": "Interface Version",
"type": "string",
"maxLength": 4
},
"intVersionDesc": {
"title": "Interface Version Description",
"description": "Interface Version Description",
"type": "string",
"maxLength": 30
},
"activeFrom": {
"title": "Active From",
"description": "Active from",
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"intVersion",
"intVersionDesc",
"activeFrom"
]
}
},
"edocSpecAdditionalTable": {
"title": "Attribute Determination for Communication with Cloud Edition",
"description": "DRC Integration Attribute Determination",
"type": "array",
"uniqueItems": true,
"items": {
"title": "Attribute Determination for Communication with Cloud Edition",
"description": "DRC Integration Attribute Determination",
"type": "object",
"properties": {
"processType": {
"title": "Process Type",
"description": "DRC Process Type",
"type": "string",
"maxLength": 50
},
"processVersion": {
"title": "Process Version",
"description": "DRC Process Version",
"type": "string",
"maxLength": 20
},
"processSubtype": {
"title": "Process Subtype",
"description": "DRC Process Subtype",
"type": "string",
"maxLength": 50
},
"drcAction": {
"title": "Action",
"description": "DRC Process Action",
"type": "string",
"maxLength": 30
},
"respInterfaceId": {
"title": "Response Interface",
"description": "eDoc Response Interface",
"type": "string",
"maxLength": 30
},
"respIntVersion": {
"title": "Response Interface Version",
"description": "Response Interface Version",
"type": "string",
"maxLength": 4
}
},
"additionalProperties": false,
"required": [
"processType",
"processVersion",
"processSubtype",
"drcAction",
"respInterfaceId",
"respIntVersion"
]
}
}
},
"additionalProperties": false,
"required": [
"edocumentInterfaceId",
"interfaceDescription",
"interfaceDirection",
"edocumentInterfaceVersion",
"edocSpecAdditionalTable"
]
}
},
"additionalProperties": false,
"required": [
"formatVersion",
"header",
"generalInformation"
]
}
120 changes: 120 additions & 0 deletions file-formats/edoi/type/zif_aff_edoi_v1.intf.abap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
INTERFACE zif_aff_edoi_v1 PUBLIC.

"! <p class="shorttext">Interface direction</p>
"! Interface direction
"! $required
"! $values {@link zif_aff_edoi_v1.data:co_edoc_int_direction}
"! $default {@link zif_aff_edoi_v1.data:co_edoc_int_direction.outbound}
TYPES ty_int_direction TYPE c LENGTH 1.
TYPES:
"! <p class="shorttext">Interface Version</p>
"! eDocument Interface Version
BEGIN OF ty_edoc_interface_version,
"! <p class="shorttext">Interface Version</p>
"! Interface Version
"! $required
int_version TYPE c LENGTH 4,
"! <p class="shorttext">Interface Version Description</p>
"! Interface Version Description
"! $required
int_version_desc TYPE c LENGTH 30,
"! <p class="shorttext">Active From</p>
"! Active from
"! $required
active_from TYPE sy-datum,

END OF ty_edoc_interface_version.
"! <p class="shorttext">Interface Versions</p>
"! eDocument Interface Versions
TYPES ty_edoc_interface_versions TYPE SORTED TABLE OF ty_edoc_interface_version WITH UNIQUE KEY int_version.
TYPES:
"! <p class="shorttext">Attribute Determination for Communication with Cloud Edition</p>
"! DRC Integration Attribute Determination
BEGIN OF ty_edoc_int_drc_attr,
Copy link

Choose a reason for hiding this comment

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

Suggested change
BEGIN OF ty_edoc_int_drc_attr,
BEGIN OF ty_determination_attribute,

"! <p class="shorttext">Process Type</p>
"! DRC Process Type
"! $required
process_type TYPE c LENGTH 50,
"! <p class="shorttext">Process Version</p>
"! DRC Process Version
"! $required
process_version TYPE c LENGTH 20,
"! <p class="shorttext">Process Subtype</p>
"! DRC Process Subtype
"! $required
process_subtype TYPE c LENGTH 50,
"! <p class="shorttext">Action</p>
"! DRC Process Action
"! $required
drc_action TYPE c LENGTH 30,
"! <p class="shorttext">Response Interface</p>
"! eDoc Response Interface
"! $required
resp_interface_id TYPE c LENGTH 30,
"! <p class="shorttext">Response Interface Version</p>
"! Response Interface Version
"! $required
resp_int_version TYPE c LENGTH 4,

END OF ty_edoc_int_drc_attr.
"! <p class="shorttext">Interface Versions</p>
"! eDocument Interface Versions
TYPES ty_edoc_int_drc_attributes TYPE SORTED TABLE OF ty_edoc_int_drc_attr WITH UNIQUE KEY process_type.
Copy link

Choose a reason for hiding this comment

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

Suggested change
TYPES ty_edoc_int_drc_attributes TYPE SORTED TABLE OF ty_edoc_int_drc_attr WITH UNIQUE KEY process_type.
TYPES ty_determination_attribute TYPE SORTED TABLE OF ty_edoc_int_drc_attr WITH UNIQUE KEY process_type.

I would say that having edoc and interface in the name of the variable is unnecessary as the whole object type is about the edoc interface. What do you think?

When you will be using the AFF, it will be something like this, the easier the name, the better
edoi_model-edoc_spec_additional_table[index]

TYPES:
"! <p class="shorttext">General Information</p>
"! eDocument Interface
BEGIN OF ty_edoc_interface,
"! <p class="shorttext">eDocument Interface</p>
"! eDocument Interface
"! $required
edocument_interface_id TYPE c LENGTH 30,
"! <p class="shorttext">eDocument Interface Description</p>
"! Interface Description.
"! $required
interface_description TYPE c LENGTH 100,
Copy link
Member

Choose a reason for hiding this comment

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

Is this edocument_interface_id and interface_description the name and description of this EDOI object?

To prevent redundant data, the name is saved in the file name, and the description is saved in ty_main->header (where you currently have selected a header with description length 60, but there is also a version for length 80 or length 100 available).

Copy link
Author

Choose a reason for hiding this comment

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

May be I might have added 'header' by referring the sample interface. I don't know the purpose of 'header' section. If its not necessary, i will remove it.
Could you please explain the statement "the name is saved in the file name,", As I didn't find the field 'file name'.

Copy link
Contributor

Choose a reason for hiding this comment

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

May be I might have added 'header' by referring the sample interface. I don't know the purpose of 'header' section. If its not necessary, i will remove it.

We expect formatVersionand header as mandatory fields. See https://github.com/SAP/abap-file-formats/blob/main/docs/json.md#writing-json-schema-with-abap-types

Therefore, please do not remove it ;)

Could you please explain the statement "the name is saved in the file name,", As I didn't find the field 'file name'.

If you check the file names in AFF, the object name is stored there. There is no need to add it to the file content. This would be redundant data.

Copy link
Author

Choose a reason for hiding this comment

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

corrected, removed object name and description from general information


"! <p class="shorttext">eDocument Interface Direction</p>
"! Interface Direction.
"! $required
interface_direction TYPE ty_int_direction,

"! <p class="shorttext">Interface Version</p>
"! Interface Version
"! $required
edocument_interface_version TYPE ty_edoc_interface_versions,
"! <p class="shorttext">Attribute Determination for Communication with Cloud Edition</p>
"! DRC Integration Attribute Determination
"! $required
edoc_spec_additional_table TYPE ty_edoc_int_drc_attributes,
END OF ty_edoc_interface.
TYPES:
"! <p class="shorttext">eDocument Interface</p>
"! eDocument Interface
BEGIN OF ty_main,
"! <p class="shorttext">Format Version</p>
"! Format version
"! $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,
"! <p class="shorttext">eDocument Interface</p>
"! eDocument Interface
"! $required
general_information TYPE ty_edoc_interface,

END OF ty_main.

CONSTANTS:
"! <p class="shorttext">Interface Direction</p>
"! Interface Direction
BEGIN OF co_edoc_int_direction,
"! <p class="shorttext">Outbound</p>
"! Outbound
outbound TYPE ty_int_direction VALUE 'O',
"! <p class="shorttext">Inbound</p>
"! Inbound
inbound TYPE ty_int_direction VALUE 'I',
END OF co_edoc_int_direction.
ENDINTERFACE.
7 changes: 7 additions & 0 deletions file-formats/edoi/type/zif_aff_edoi_v1.intf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"formatVersion": "1",
"header": {
"description": "Create eDocument Types",
Copy link

Choose a reason for hiding this comment

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

does the I in EDOI stand for Interface? Then maybe the description could be: AFF for eDocument Interface (EDOI)

"originalLanguage": "en"
}
}
Loading