[EDOT] Add new object EDOT #682
+282
−0
There are no files selected for viewing
wurzka marked this conversation as resolved.
Show resolved
Hide resolved
i506210 marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # EDOT File Format | ||
|
|
||
| File | Cardinality | Definition | Schema | Example | ||
| :--- | :--- | :--- | :--- | :--- | ||
| `<name>.edot.json` | 1 | [`zif_aff_edot_v1.intf.abap`](./type/zif_aff_edot_v1.intf.abap) | [`edot-v1.json`](./edot-v1.json) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| { | ||
| "$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/edot/edot-v1.json", | ||
| "title": "eDocument Type", | ||
| "description": "eDocument type", | ||
| "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": "eDocument type description", | ||
| "type": "string", | ||
| "maxLength": 30 | ||
| }, | ||
| "originalLanguage": { | ||
| "title": "Original Language", | ||
| "description": "Original language of the eDocument type", | ||
| "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" | ||
| ] | ||
| }, | ||
| "generalInformation": { | ||
| "title": "General Information", | ||
| "description": "General information", | ||
| "type": "object", | ||
| "properties": { | ||
| "tableName": { | ||
| "title": "eDocument Table Name", | ||
| "description": "eDocument table name", | ||
| "type": "string", | ||
| "maxLength": 30 | ||
| }, | ||
| "isArchivePreprocessNeeded": { | ||
| "title": "Preprocess Before Archiving", | ||
| "description": "Preprocess before archiving", | ||
| "type": "boolean" | ||
| }, | ||
| "isCreatedInContingencyMode": { | ||
| "title": "Created in Contingency Mode", | ||
| "description": "Created in contingency mode", | ||
| "type": "boolean" | ||
| }, | ||
| "contingencyEdocType": { | ||
| "title": "Contingency eDocument Type", | ||
| "description": "Contingency eDocument type", | ||
| "type": "string", | ||
| "maxLength": 10 | ||
| } | ||
| }, | ||
| "additionalProperties": false | ||
| }, | ||
| "readAccessLoggingSettings": { | ||
| "title": "Read Access Logging Settings", | ||
| "description": "Read access logging settings", | ||
| "type": "array", | ||
| "uniqueItems": true, | ||
| "items": { | ||
| "title": "Read Access Loggging Settings", | ||
| "description": "Read access logging settings", | ||
| "type": "object", | ||
| "properties": { | ||
| "fileType": { | ||
| "title": "File Type", | ||
| "description": "File type", | ||
| "type": "string", | ||
| "maxLength": 10 | ||
| }, | ||
| "fileStructure": { | ||
| "title": "File Structure Type", | ||
| "description": "File structure type", | ||
| "type": "string", | ||
| "maxLength": 30 | ||
| }, | ||
| "fileDescription": { | ||
| "title": "File Description", | ||
| "description": "File description", | ||
| "type": "string", | ||
| "maxLength": 60 | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "fileType", | ||
| "fileStructure" | ||
| ] | ||
| } | ||
| }, | ||
| "edocSpecAdditionalTables": { | ||
| "title": "eDocument Type Specific Additional Tables", | ||
| "description": "eDocument type specific additional tables", | ||
| "type": "array", | ||
| "uniqueItems": true, | ||
| "items": { | ||
| "title": "eDocument Type Specific Additional Tables", | ||
| "description": "eDocument type specific additional tables", | ||
| "type": "object", | ||
| "properties": { | ||
| "sequenceNumber": { | ||
| "title": "Sequence Number", | ||
| "description": "Sequence number", | ||
| "type": "integer", | ||
| "minimum": 1, | ||
| "maximum": 9999 | ||
| }, | ||
| "tableName": { | ||
| "title": "Table Name", | ||
| "description": "Table name", | ||
| "type": "string", | ||
| "maxLength": 30 | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "sequenceNumber", | ||
| "tableName" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "formatVersion", | ||
| "header", | ||
| "generalInformation" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,26 @@ | ||||||||||
| { | ||||||||||
| "formatVersion": "1", | ||||||||||
| "header": { | ||||||||||
| "description": "Example EDOT for file formats", | ||||||||||
| "originalLanguage": "en" | ||||||||||
| }, | ||||||||||
| "generalInformation": { | ||||||||||
| "tableName": "EDOFRINV", | ||||||||||
| "isArchivePreprocessNeeded": false, | ||||||||||
| "isCreatedInContingencyMode": false | ||||||||||
|
||||||||||
| "tableName": "EDOFRINV", | |
| "isArchivePreprocessNeeded": false, | |
| "isCreatedInContingencyMode": false | |
| "tableName": "EDOFRINV" |
There was a problem hiding this comment.
I didn't understand the comments, do I need to make any change here
Outdated
There was a problem hiding this comment.
This is just an idea. I am not sure whether this makes sense:
Almost all fields start with "file". I am not sure, but I was wondering whether it make sense to add "files" to the name of the array.
Outdated
There was a problem hiding this comment.
Boolean values with value false aren't serialized by default.
Suggested change
| "fileDescription": "eDocument France: Invoice Request", | |
| "isCloudRelevant": false | |
| "fileDescription": "eDocument France: Invoice Request" |
There was a problem hiding this comment.
same - I didn't understand the comments, do I need to make any change here
i506210 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
i506210 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| "! <p class="shorttext synchronized">AFF for eDocument Type (EDOT)</p> | ||
| "! eDocument types that can be used in eInvoice process | ||
| INTERFACE zif_aff_edot_v1 | ||
| PUBLIC. | ||
|
|
||
| TYPES: | ||
| "! <p class="shorttext">Read Access Loggging Settings</p> | ||
| "! Read access logging settings | ||
| BEGIN OF ty_read_access_logging_setting, | ||
| "! <p class="shorttext">File Type</p> | ||
| "! File type | ||
| "! $required | ||
| file_type TYPE c LENGTH 10, | ||
|
Comment on lines
+10
to
+13
There was a problem hiding this comment. Are file types defined by a hard set of values? If so, we could use an enumeration here. There was a problem hiding this comment. Its not hard set of values but coming from check table, we need to have value help instead fixed domain, I think it will be covered during development |
||
| "! <p class="shorttext">File Structure Type</p> | ||
| "! File structure type | ||
| "! $required | ||
| file_structure TYPE c LENGTH 30, | ||
|
||
| "! <p class="shorttext">File Description</p> | ||
| "! File description | ||
| file_description TYPE c LENGTH 60, | ||
| END OF ty_read_access_logging_setting. | ||
| "! <p class="shorttext">Read Access Logging Settings</p> | ||
| "! Read access logging settings | ||
| TYPES ty_read_acc_logging_settings TYPE SORTED TABLE OF ty_read_access_logging_setting WITH UNIQUE KEY file_type. | ||
| TYPES: | ||
| "! <p class="shorttext">eDocument Type Specific Additional Tables</p> | ||
| "! eDocument type specific additional tables | ||
| BEGIN OF ty_additional_table, | ||
GuilhermeSaraiva96 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "! <p class="shorttext">Sequence Number</p> | ||
| "! Sequence number | ||
| "! $required | ||
| "! $minimum 1 | ||
| "! $maximum 9999 | ||
| sequence_number TYPE i, | ||
| "! <p class="shorttext">Table Name</p> | ||
| "! Table name | ||
| "! $required | ||
| table_name TYPE zif_aff_types_v1=>ty_object_name_30, | ||
| END OF ty_additional_table. | ||
| "! <p class="shorttext">Read Access Logging Settings</p> | ||
| "! Read access logging settings | ||
| TYPES ty_additional_tables TYPE SORTED TABLE OF ty_additional_table WITH UNIQUE KEY sequence_number. | ||
| TYPES: | ||
| "! <p class="shorttext">General Information</p> | ||
| "! General information | ||
| BEGIN OF ty_general_information, | ||
| "! <p class="shorttext">eDocument Table Name</p> | ||
| "! eDocument table name | ||
| table_name TYPE zif_aff_types_v1=>ty_object_name_30, | ||
| "! <p class="shorttext">Preprocess Before Archiving</p> | ||
| "! Preprocess before archiving | ||
| is_archive_preprocess_needed TYPE abap_bool, | ||
| "! <p class="shorttext">Created in Contingency Mode</p> | ||
| "! Created in contingency mode | ||
| is_created_in_contingency_mode TYPE abap_bool, | ||
|
||
| "! <p class="shorttext">Contingency eDocument Type</p> | ||
| "! Contingency eDocument type | ||
| contingency_edoc_type TYPE c LENGTH 10, | ||
i506210 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| END OF ty_general_information. | ||
| TYPES: | ||
| "! <p class="shorttext">Header for EDOT object</p> | ||
| "! The header for an ABAP main object (without source code) with a description of 30 characters (no key user) | ||
| BEGIN OF ty_header_30_cloud, | ||
| "! <p class="shorttext">Description</p> | ||
| "! eDocument type description | ||
| "! $required | ||
| description TYPE c LENGTH 30, | ||
| "! <p class="shorttext">Original Language</p> | ||
| "! Original language of the eDocument type | ||
| "! $required | ||
| original_language TYPE sy-langu, | ||
| "! <p class="shorttext">ABAP Language Version</p> | ||
| "! ABAP language version | ||
| "! $values {@link zif_aff_types_v1.data:co_abap_language_version_cloud} | ||
| "! $default {@link zif_aff_types_v1.data:co_abap_language_version_cloud.standard} | ||
| abap_language_version TYPE zif_aff_types_v1=>ty_abap_language_version_cloud, | ||
| END OF ty_header_30_cloud. | ||
| TYPES: | ||
| "! <p class="shorttext">eDocument Type</p> | ||
| "! eDocument type | ||
| 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 ty_header_30_cloud, | ||
| "! <p class="shorttext">General Information</p> | ||
| "! General information | ||
| "! $required | ||
| general_information TYPE ty_general_information, | ||
| "! <p class="shorttext">Read Access Logging Settings</p> | ||
| "! Read access logging settings | ||
| read_access_logging_settings TYPE ty_read_acc_logging_settings, | ||
| "! <p class="shorttext">eDocument Type Specific Additional Tables</p> | ||
| "! eDocument type specific additional tables | ||
| edoc_spec_additional_tables TYPE ty_additional_tables, | ||
i506210 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| END OF ty_main. | ||
| ENDINTERFACE. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "formatVersion": "1", | ||
| "header": { | ||
| "description": "AFF for eDocument Type (EDOT)", | ||
| "originalLanguage": "en" | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Example is missing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think having an example would also help me for the review
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Somehow I am unable to generate example, I created class and Transformation but its not clear to me in the report what object to be mentioned as input.