-
Notifications
You must be signed in to change notification settings - Fork 69
[EDOT] Add new object EDOT #682
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
base: main
Are you sure you want to change the base?
Conversation
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.
Thanks for your pull request. This pull request still contains both, EDOI and EDOT (with the .DS_Store
). Please remove all the unwanted files here.
Please note, that for the title and description, we use title case and sentence case respectively. I've not marked every occurrence but if you could please adjust that.
"! <p class="shorttext">Interface Version</p> "<- title (title case)
"! Interface version "<- description (sentence case)
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 have also added some comments and questions
file-formats/edot/README.md
Outdated
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.
I corrected and pushed the latest changes, can you please check |
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.
Thank you for submitting the AFF and changes. Most of my comments are minors and just a personal touch, up to you if you want to implement them :)
However, I always like to mention that AFF is a readable representation of an ABAP Object Type, and the more coherent the field names are, the better!
|
||
TYPES: | ||
"! <p class="shorttext">SRAL Configuration Type</p> | ||
"! SRAL configuration type |
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.
what does SRAL stand for? Apologies if I might have missed it
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.
Hello GuilhermeSaraiva,
Its about Read access logging setup. For more information
https://help.sap.com/doc/863abf53d25ab64ce10000000a174cb4/700_SFIN3E%20006/en-US/b10184538ca0e647e10000000a441470.html
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.
What do you think is most common Term for the end user? RAL, SRAL or Read Access Logging? We want to avoid that internal terminology is present in AFF. Could you please confirm it with your UA?
TYPES: | ||
"! <p class="shorttext">General Information</p> | ||
"! General information | ||
BEGIN OF ty_edoc_information, |
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.
BEGIN OF ty_edoc_information, | |
BEGIN OF ty_general_information, |
general_information TYPE ty_edoc_information, | ||
"! <p class="shorttext">Additional Selection Fields</p> | ||
"! Additional selection fields of validation report | ||
sral_configuration TYPE ty_sral_configurations, |
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.
The field name is called sral_configuration, but the title is: Additional Selection Fields. These are not coherent, which would be best for the end user to understand what kind of field this is?
|
||
TYPES: | ||
"! <p class="shorttext">SRAL Configuration Type</p> | ||
"! SRAL configuration type |
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.
What do you think is most common Term for the end user? RAL, SRAL or Read Access Logging? We want to avoid that internal terminology is present in AFF. Could you please confirm it with your UA?
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.
Thanks, looks good!
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.
Thanks for the update. See my questions and comments
file-formats/edot/README.md
Outdated
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.
Before merging, we should als create an issue for the missing example
"! <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, |
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.
Would you align the field names and the title's please?
Furthermore, is any field of general_information
a $required
field?
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.
unfortunately only name & description are manditory which are not part of gerneral information anymore.
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.
corrected the field names and labels
"! <p class="shorttext">File Structure Type</p> | ||
"! File structure type | ||
"! $required | ||
file_structure TYPE c LENGTH 30, |
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.
Should description and field name be aligned?
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.
corrected
"! <p class="shorttext">File Type</p> | ||
"! File type | ||
"! $required | ||
file_type TYPE c LENGTH 10, |
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.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
"tableName": "EDOFRINV", | ||
"isArchivePreprocessNeeded": false, | ||
"isCreatedInContingencyMode": false |
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.
Boolean values with value false
aren't serialized by default.
"tableName": "EDOFRINV", | |
"isArchivePreprocessNeeded": false, | |
"isCreatedInContingencyMode": false | |
"tableName": "EDOFRINV" |
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 didn't understand the comments, do I need to make any change here
"fileDescription": "eDocument France: Invoice Request", | ||
"isCloudRelevant": false |
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.
Boolean values with value false
aren't serialized by default.
"fileDescription": "eDocument France: Invoice Request", | |
"isCloudRelevant": false | |
"fileDescription": "eDocument France: Invoice Request" |
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.
same - I didn't understand the comments, do I need to make any change here
"readAccessLogConfigurations": [ | ||
{ | ||
"fileType": "REQUEST", | ||
"fileStructure": "EDO_FR_INV_INVOICE_TYPE", | ||
"fileDescription": "eDocument France: Invoice Request", |
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.
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.
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.
Please see my comment
I am getting JSON schema error without providing detailed errors. In addition, always EOL, EOF error is appearing, not sure how to resolve |
No description provided.