[RVBC] Add new object type RVBC #677
There are no files selected for viewing
This file contains 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 @@ | ||
| # RVBC File Format | ||
|
|
||
| File | Cardinality | Definition | Schema | Example | ||
| :--- | :--- | :--- | :--- | :--- | ||
| `<name>.rvbc.json` | 1 | [`zif_aff_rvbc_v1.intf.abap`](./type/zif_aff_rvbc_v1.intf.abap) | [`rvbc-v1.json`](./rvbc-v1.json) | ||
This file contains 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,20 @@ | ||
| { | ||
| "formatVersion": "1", | ||
| "header": { | ||
| "description": "Example RVBC for ABAP File Formats", | ||
| "originalLanguage": "en" | ||
| }, | ||
| "bookletDefinition": { | ||
| "application": "test.app.adt.editor", | ||
| "source": "predefined", | ||
| "status": "draft", | ||
|
There was a problem hiding this comment. As mentioned in our call, I am wondering whether the draft is the same as active/inactive handling in ABAP |
||
| "consistencyStatus": "consistent", | ||
|
There was a problem hiding this comment. similar question here: |
||
| "extensibilityMode": "supportedPredefinedQueries" | ||
| }, | ||
| "predefinedIna1Service": { | ||
| "ina1Service": "UI_INA_TST_FLIGHT_SERVBIND" | ||
| }, | ||
| "customIna1Service": { | ||
| "ina1Service": "YY1_TEST_INA1" | ||
| } | ||
| } | ||
This file contains 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,196 @@ | ||
| { | ||
| "$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/rvbc/rvbc-v1.json", | ||
| "title": "Object Type RVBC", | ||
| "description": "Object type RVBC", | ||
| "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" | ||
| ] | ||
| }, | ||
| "bookletDefinition": { | ||
| "title": "Booklet Definition", | ||
| "description": "Booklet definition", | ||
| "type": "object", | ||
| "properties": { | ||
| "application": { | ||
| "title": "Application ID", | ||
| "description": "Application ID", | ||
| "type": "string", | ||
| "maxLength": 70 | ||
| }, | ||
| "source": { | ||
| "title": "Source", | ||
| "description": "Source", | ||
| "type": "string", | ||
| "enum": [ | ||
| "predefined", | ||
| "custom" | ||
| ], | ||
| "enumTitles": [ | ||
| "Predefined", | ||
| "Custom" | ||
| ], | ||
| "enumDescriptions": [ | ||
| "Predefined", | ||
| "Custom" | ||
| ], | ||
| "default": "predefined" | ||
| }, | ||
| "status": { | ||
| "title": "Status", | ||
| "description": "Status", | ||
| "type": "string", | ||
| "enum": [ | ||
| "draft", | ||
| "final" | ||
| ], | ||
| "enumTitles": [ | ||
| "Draft", | ||
| "Final" | ||
| ], | ||
| "enumDescriptions": [ | ||
| "Draft", | ||
| "Final" | ||
| ], | ||
| "default": "draft" | ||
| }, | ||
| "consistencyStatus": { | ||
| "title": "Consistency Status", | ||
| "description": "Consistency status", | ||
| "type": "string", | ||
| "enum": [ | ||
| "checkRequired", | ||
| "consistent", | ||
| "error" | ||
| ], | ||
| "enumTitles": [ | ||
| "Consistency Check Is Required", | ||
| "Consistent", | ||
| "Error" | ||
| ], | ||
| "enumDescriptions": [ | ||
| "Consistency check is required", | ||
| "Consistent", | ||
| "Error" | ||
| ], | ||
| "default": "checkRequired" | ||
| }, | ||
| "extensibilityMode": { | ||
| "title": "Extensibility Mode", | ||
| "description": "Extensibility mode", | ||
| "type": "string", | ||
| "enum": [ | ||
| "fullySupported", | ||
| "supportedPredefinedQueries", | ||
| "notSupported" | ||
| ], | ||
| "enumTitles": [ | ||
| "Fully Supported Including Custom Analytical Queries", | ||
| "Supported Only for Predefined Analytical Queries", | ||
| "Not Supported" | ||
| ], | ||
| "enumDescriptions": [ | ||
| "Fully supported including custom analytical queries", | ||
| "Supported only for predefined analytical queries", | ||
| "Not supported" | ||
| ], | ||
| "default": "notSupported" | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "application", | ||
| "extensibilityMode" | ||
| ] | ||
| }, | ||
| "predefinedIna1Service": { | ||
| "title": "Predefined InA Service", | ||
| "description": "Predefined InA service", | ||
| "type": "object", | ||
| "properties": { | ||
| "ina1Service": { | ||
| "title": "Service Name", | ||
| "description": "Service name", | ||
| "type": "string", | ||
| "maxLength": 40 | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "ina1Service" | ||
| ] | ||
| }, | ||
| "customIna1Service": { | ||
| "title": "Custom InA Service", | ||
| "description": "Custom InA service", | ||
| "type": "object", | ||
| "properties": { | ||
| "ina1Service": { | ||
| "title": "Service Name", | ||
| "description": "Service name", | ||
| "type": "string", | ||
| "maxLength": 40 | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "ina1Service" | ||
| ] | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "formatVersion", | ||
| "header" | ||
| ] | ||
| } |
This file contains 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,122 @@ | ||
| "! AFF type for the object RVBC ( Review Booklets ) | ||
| INTERFACE zif_aff_rvbc_v1 | ||
| PUBLIC. | ||
|
|
||
| TYPES ty_app_id TYPE c LENGTH 70. | ||
| TYPES ty_ina1_service_name TYPE c LENGTH 40. | ||
|
There was a problem hiding this comment. I am not sure. Is the service name really 40 characters long. Most objects only support 30 characters. |
||
|
|
||
| "! $values { @link zif_aff_rvbc_v1.data:co_extensibility_mode } | ||
| "! $default { @link zif_aff_rvbc_v1.data:co_extensibility_mode.not_supported } | ||
| TYPES ty_extensibility_mode TYPE n LENGTH 2. | ||
| CONSTANTS: | ||
| BEGIN OF co_extensibility_mode, | ||
| "! <p class="shorttext">Fully Supported Including Custom Analytical Queries</p> | ||
| "! Fully supported including custom analytical queries | ||
| fully_supported TYPE ty_extensibility_mode VALUE 0, | ||
| "! <p class="shorttext">Supported Only for Predefined Analytical Queries</p> | ||
| "! Supported only for predefined analytical queries | ||
| supported_predefined_queries TYPE ty_extensibility_mode VALUE 1, | ||
| "! <p class="shorttext">Not Supported</p> | ||
| "! Not supported | ||
| not_supported TYPE ty_extensibility_mode VALUE 2, | ||
| END OF co_extensibility_mode. | ||
|
|
||
| "! $values { @link zif_aff_rvbc_v1.data:co_source } | ||
| "! $default { @link zif_aff_rvbc_v1.data:co_source.predefined } | ||
| TYPES ty_source TYPE n LENGTH 1. | ||
| CONSTANTS: | ||
| BEGIN OF co_source, | ||
| "! <p class="shorttext">Predefined</p> | ||
| "! Predefined | ||
| predefined TYPE ty_source VALUE 1, | ||
| "! <p class="shorttext">Custom</p> | ||
| "! Custom | ||
| custom TYPE ty_source VALUE 2, | ||
| END OF co_source. | ||
|
|
||
|
Comment on lines
+24
to
+36
There was a problem hiding this comment. I guess the type and the constant is obsolete, now, isn't it? |
||
| "! $values { @link zif_aff_rvbc_v1.data:co_status } | ||
| "! $default { @link zif_aff_rvbc_v1.data:co_status.draft } | ||
| TYPES ty_status TYPE n LENGTH 1. | ||
| CONSTANTS: | ||
| BEGIN OF co_status, | ||
| "! <p class="shorttext">Draft</p> | ||
| "! Draft | ||
| draft TYPE ty_status VALUE 1, | ||
| "! <p class="shorttext">Final</p> | ||
| "! Final | ||
| final TYPE ty_status VALUE 2, | ||
| END OF co_status. | ||
|
|
||
| "! $values { @link zif_aff_rvbc_v1.data:co_consistency_status } | ||
| "! $default { @link zif_aff_rvbc_v1.data:co_consistency_status.check_required } | ||
| TYPES ty_consistency_status TYPE n LENGTH 1. | ||
| CONSTANTS: | ||
| BEGIN OF co_consistency_status, | ||
| "! <p class="shorttext">Consistency Check Is Required</p> | ||
| "! Consistency check is required | ||
| check_required TYPE ty_consistency_status VALUE 0, | ||
| "! <p class="shorttext">Consistent</p> | ||
| "! Consistent | ||
| consistent TYPE ty_consistency_status VALUE 1, | ||
| "! <p class="shorttext">Error</p> | ||
| "! Error | ||
| error TYPE ty_consistency_status VALUE 2, | ||
| END OF co_consistency_status. | ||
|
|
||
| TYPES: | ||
| "! <p class="shorttext">Review Booklet Definition</p> | ||
| "! Review booklet definition | ||
| BEGIN OF ty_booklet_definition, | ||
| "! <p class="shorttext">Application ID</p> | ||
| "! Application ID | ||
| "! $required | ||
| application TYPE ty_app_id, | ||
| "! <p class="shorttext">Source</p> | ||
| "! Source | ||
| source TYPE ty_source, | ||
| "! <p class="shorttext">Status</p> | ||
| "! Status | ||
| status TYPE ty_status, | ||
RuixingYangSAP marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "! <p class="shorttext">Consistency Status</p> | ||
| "! Consistency status | ||
| consistency_status TYPE ty_consistency_status, | ||
RuixingYangSAP marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "! <p class="shorttext">Extensibility Mode</p> | ||
| "! Extensibility mode | ||
| "! $required | ||
| extensibility_mode TYPE ty_extensibility_mode, | ||
RuixingYangSAP marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| END OF ty_booklet_definition. | ||
|
|
||
| TYPES: | ||
| "! <p class="shorttext">InA Service</p> | ||
| "! InA Service | ||
| BEGIN OF ty_ina1_service, | ||
schneidermic0 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "! <p class="shorttext">Service Name</p> | ||
| "! Service name | ||
| "! $required | ||
| ina1_service TYPE ty_ina1_service_name, | ||
|
Comment on lines
+93
to
+96
There was a problem hiding this comment. Usually, we try to keep the name of the tile and the field name identical. So either "Service Name" or "INA1 Service". |
||
| END OF ty_ina1_service. | ||
|
|
||
| TYPES: | ||
| "! <p class="shorttext">Object Type RVBC</p> | ||
| "! Object type RVBC | ||
| 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">Booklet Definition</p> | ||
| "! Booklet definition | ||
| booklet_definition TYPE ty_booklet_definition, | ||
| "! <p class="shorttext">Predefined InA Service</p> | ||
| "! Predefined InA service | ||
| predefined_ina1_service TYPE ty_ina1_service, | ||
| "! <p class="shorttext">Custom InA Service</p> | ||
| "! Custom InA service | ||
| custom_ina1_service TYPE ty_ina1_service, | ||
| END OF ty_main. | ||
|
|
||
| ENDINTERFACE. | ||
This file contains 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 type for RVBC ( Review Booklets )", | ||
| "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.
Link to the example file is missing