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

[RVBC] Add new object type RVBC #677

Merged
merged 30 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
10ed6d6
Add files of RVBC
RuixingYangSAP Dec 5, 2024
7bac5cc
correct field names
RuixingYangSAP Dec 5, 2024
1e7e897
Update file-formats/rvbc/type/zif_aff_rvbc_v1.intf.abap
RuixingYangSAP Dec 5, 2024
e49a66c
align fields via abap cleaner
RuixingYangSAP Dec 5, 2024
d12ee82
remove dependent external type
RuixingYangSAP Dec 5, 2024
c017b01
correct type ty_extensibility_mode
RuixingYangSAP Dec 5, 2024
63ecbea
correct other external types
RuixingYangSAP Dec 5, 2024
65964ca
fix external type spras
RuixingYangSAP Dec 5, 2024
767aebe
replace spras with ty_main_language
RuixingYangSAP Dec 5, 2024
f32df77
adapt AFF according to the review suggetions
RuixingYangSAP Dec 9, 2024
88c73bf
change predefined_ina1_service description
RuixingYangSAP Dec 10, 2024
72421e2
add id field; remove unnecessary annotation $required for several fields
RuixingYangSAP Dec 11, 2024
7479de0
change the header description in the json file
RuixingYangSAP Dec 11, 2024
1c50d01
change type ty_source, ty_status, ty_consistency_status from code typ…
RuixingYangSAP Dec 11, 2024
8c336c3
correct the types from text type back to code type; add necessary con…
RuixingYangSAP Dec 12, 2024
8d36369
delete unnecessary type ty_booklet_id
RuixingYangSAP Dec 12, 2024
59e7138
remove ID and type field of INA service and related types
RuixingYangSAP Dec 19, 2024
b72409d
change back INA related fields to structure on root level
RuixingYangSAP Dec 19, 2024
14c014e
add example
RuixingYangSAP Dec 19, 2024
403ebaf
change CRLF to LF in example json file
RuixingYangSAP Dec 19, 2024
0fcad28
add ending LF to example json
RuixingYangSAP Dec 19, 2024
ab42949
delete unnecessary abaplanguageversion field
RuixingYangSAP Dec 19, 2024
d70b348
rename field ina1_service_name; add the Link to the example file in r…
RuixingYangSAP Jan 8, 2025
dbfd042
update json schema and the example
RuixingYangSAP Jan 8, 2025
fb57a9f
remove consistencyStatus
RuixingYangSAP Jan 20, 2025
635df89
merge 2 ina services into 1; rename title of field application
RuixingYangSAP Jan 29, 2025
5ac1505
move position of field application
RuixingYangSAP Jan 29, 2025
f74d1d5
remove trailing space in example json file
RuixingYangSAP Jan 29, 2025
bdc17e5
rename titles and fields in INAservice section
RuixingYangSAP Jan 31, 2025
460991b
Merge branch 'main' into feature/rvbc
schneidermic0 Jan 31, 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/rvbc/README.md
RuixingYangSAP marked this conversation as resolved.
Show resolved Hide resolved
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) | [`z_aff_example_rvbc.rvbc.json`]
17 changes: 17 additions & 0 deletions file-formats/rvbc/examples/z_aff_example_rvbc.rvbc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"formatVersion": "1",
"header": {
"description": "Example RVBC for ABAP File Formats",
"originalLanguage": "en"
},
"bookletDefinition": {
"source": "predefined",
"status": "draft",
RuixingYangSAP marked this conversation as resolved.
Show resolved Hide resolved
"application": "test.app.adt.editor",
"extensibilityMode": "supportedPredefinedQueries"
},
"ina1Services": {
"predefined": "UI_INA_TST_FLIGHT_SERVBIND",
"custom": "YY1_TEST_INA1"
}
}
157 changes: 157 additions & 0 deletions file-formats/rvbc/rvbc-v1.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
{
"$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": {
"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"
},
"application": {
"title": "Fiori Application",
"description": "Fiori application",
"type": "string",
"maxLength": 70
},
"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
},
"ina1Services": {
"title": "InA Services",
"description": "InA services",
"type": "object",
"properties": {
"predefined": {
"title": "Predefined InA Service",
"description": "Predefined InA service",
"type": "string",
"maxLength": 40
},
"custom": {
"title": "Custom InA Service",
"description": "Custom InA service",
"type": "string",
"maxLength": 40
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"formatVersion",
"header"
]
}
100 changes: 100 additions & 0 deletions file-formats/rvbc/type/zif_aff_rvbc_v1.intf.abap
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
"! 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.
schneidermic0 marked this conversation as resolved.
Show resolved Hide resolved

"! $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.

schneidermic0 marked this conversation as resolved.
Show resolved Hide resolved
"! $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.

TYPES:
"! <p class="shorttext">Review Booklet Definition</p>
"! Review booklet definition
BEGIN OF ty_booklet_definition,
"! <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">Fiori Application</p>
"! Fiori application
application TYPE ty_app_id,
"! <p class="shorttext">Extensibility Mode</p>
"! Extensibility mode
extensibility_mode TYPE ty_extensibility_mode,
END OF ty_booklet_definition.

TYPES:
"! <p class="shorttext">InA Services</p>
"! InA Services
BEGIN OF ty_ina1_services,
"! <p class="shorttext">Predefined InA Service</p>
"! Predefined InA service
predefined TYPE ty_ina1_service_name,
"! <p class="shorttext">Custom InA Service</p>
"! Custom InA service
custom TYPE ty_ina1_service_name,
END OF ty_ina1_services.

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">InA Services</p>
"! InA services
ina1_services TYPE ty_ina1_services,
END OF ty_main.

ENDINTERFACE.
7 changes: 7 additions & 0 deletions file-formats/rvbc/type/zif_aff_rvbc_v1.intf.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"formatVersion": "1",
"header": {
"description": "AFF type for RVBC ( Review Booklet )",
"originalLanguage": "en"
}
}
Loading