Skip to content

[SXTG] Add new object type SXTG #687

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/sxtg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# SXTG File Format

File | Cardinality | Definition | Schema | Example
:--- | :--- | :--- | :--- | :---
`<name>.sxtg.json` | 1 | [`zif_aff_sxtg_v1.intf.abap`](./type/zif_aff_sxtg_v1.intf.abap) | [`sxtg-v1.json`](./sxtg-v1.json) | [`sxtg_tsm_so.sxtg.json`](./examples/sxtg_tsm_so.sxtg.json)
17 changes: 17 additions & 0 deletions file-formats/sxtg/examples/sxtg_tsm_so.sxtg.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"formatVersion": "1",
"header": {
"description": "SXTG: Sales Order Header (Home)",
"originalLanguage": "en"
},
"generalInformation": {
"extensionInclude": "SXTG_S_TSM_SO_INCL_EEW",
"applicationDataStructure": "SXTG_S_TSM_SO_APPL_DATA",
"uiExtensionEntity": "D_SXTG_TSM_SO_UI_HEADER"
},
"transactionCodes": [
{
"transactionCode": "SXTG_TSM_SO"
}
]
Comment on lines +12 to +16
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor: In other object types we did not repeated the array name in the structure and changed it the field for the object name just to name. However, I would suggest to double check this in the UX review.

This suggestion shall show how it could look like. I would wait whether our UX colleagues suggest to change it:

Suggested change
"transactionCodes": [
{
"transactionCode": "SXTG_TSM_SO"
}
]
"transactionCodes": [
{
"name": "SXTG_TSM_SO"
}
]

}
95 changes: 95 additions & 0 deletions file-formats/sxtg/sxtg-v1.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
{
"$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/sxtg/sxtg-v1.json",
"title": "SAP GUI Extension Point",
"description": "SAP gui extension point for developer extensibility",
"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
}
},
"additionalProperties": false,
"required": [
"description",
"originalLanguage"
]
},
"generalInformation": {
"title": "General Information",
"description": "General information",
"type": "object",
"properties": {
"extensionInclude": {
"title": "Extension Include",
"description": "Extension include with persisted custom fields",
"type": "string",
"maxLength": 30
},
"applicationDataStructure": {
"title": "Application Data Structure",
"description": "Structure with application data",
"type": "string",
"maxLength": 30
},
"uiExtensionEntity": {
"title": "UI Extension Entity",
"description": "Abstract entity with ui definition",
"type": "string",
"maxLength": 30
}
},
"additionalProperties": false,
"required": [
"extensionInclude",
"applicationDataStructure",
"uiExtensionEntity"
]
},
"transactionCodes": {
"title": "Transaction Codes",
"description": "Transaction codes of extensible application",
"type": "array",
"items": {
"title": "Transaction Code",
"description": "Transaction code",
"type": "object",
"properties": {
"transactionCode": {
"title": "Transaction Code",
"description": "Transaction code",
"type": "string",
"maxLength": 20
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"required": [
"formatVersion",
"header"
]
}
59 changes: 59 additions & 0 deletions file-formats/sxtg/type/zif_aff_sxtg_v1.intf.abap
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
INTERFACE zif_aff_sxtg_v1
PUBLIC.

TYPES:
"! <p class="shorttext">Transaction Code</p>
"! Transaction code
BEGIN OF ty_transaction_code,
"! <p class="shorttext">Transaction Code</p>
"! Transaction code
transaction_code TYPE c LENGTH 20,
END OF ty_transaction_code.

"! <p class="shorttext">Transaction Codes</p>
"! Transaction codes
TYPES ty_transaction_codes TYPE STANDARD TABLE OF ty_transaction_code WITH KEY transaction_code.

TYPES:
"! <p class="shorttext">General Information</p>
"! General information
BEGIN OF ty_general_information,
"! <p class="shorttext">Extension Include</p>
"! Extension include with persisted custom fields
"! $required
extension_include TYPE zif_aff_types_v1=>ty_object_name_30,

"! <p class="shorttext">Application Data Structure</p>
"! Structure with application data
"! $required
application_data_structure TYPE zif_aff_types_v1=>ty_object_name_30,

"! <p class="shorttext">UI Extension Entity</p>
"! Abstract entity with ui definition
"! $required
ui_extension_entity TYPE zif_aff_types_v1=>ty_object_name_30,
END OF ty_general_information.

TYPES:
"! <p class="shorttext">SAP GUI Extension Point</p>
"! SAP gui extension point for developer extensibility
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"! SAP gui extension point for developer extensibility
"! SAP GUI extension point for developer extensibility

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_no_abap_lv,

"! <p class="shorttext">General Information</p>
"! General information
general_information TYPE ty_general_information,

"! <p class="shorttext">Transaction Codes</p>
"! Transaction codes of extensible application
transaction_codes TYPE ty_transaction_codes,
END OF ty_main.

ENDINTERFACE.
7 changes: 7 additions & 0 deletions file-formats/sxtg/type/zif_aff_sxtg_v1.intf.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"formatVersion": "1",
"header": {
"description": "SXTG: SAP GUI Extension Point AFF Type",
"originalLanguage": "en"
}
}
Loading