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.

Sign up for GitHub

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

[UIST] Add new object type UIST #497

Merged
merged 27 commits into from
Mar 21, 2023
Merged

[UIST] Add new object type UIST #497

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
86a006e
[UIST] Add new object type UIST
ViktoriaFreidel Feb 27, 2023
995af5b
[UIST] Add new object type UIST
ViktoriaFreidel Feb 27, 2023
2d90847
Update file-formats/uist/type/zif_aff_uist_v1.intf.abap
ViktoriaFreidel Mar 1, 2023
9019fda
Update file-formats/uist/type/zif_aff_uist_v1.intf.abap
ViktoriaFreidel Mar 1, 2023
7ffbc3b
Add new object type UIST
ViktoriaFreidel Mar 9, 2023
35af4b6
Add new object type UIST
ViktoriaFreidel Mar 9, 2023
74d39a7
[UIST] Add new object type UIST
ViktoriaFreidel Mar 14, 2023
12ace5f
Merge branch 'main' into feature/uist
schneidermic0 Mar 14, 2023
47de50c
Add header 100 for cloud
wurzka Mar 14, 2023
466821a
Update /uist/type/zif_aff_uist_v1.intf.abap use cloud description
ViktoriaFreidel Mar 15, 2023
2ad56b8
Update zif_aff_uist_v1.intf.abap - use Name and not Id
ViktoriaFreidel Mar 15, 2023
c81d390
Update zif_aff_uist_v1.intf.abap - use Page Name not Id
ViktoriaFreidel Mar 15, 2023
2869329
Update zif_aff_uist_v1.intf.abap- remove pages description and title
ViktoriaFreidel Mar 15, 2023
4ae86d1
[UIST] Add new object type UIST and Update AFF Model
ViktoriaFreidel Mar 15, 2023
b628fe0
[UIST] Add new object type UIST and Update AFF Model
ViktoriaFreidel Mar 15, 2023
ed1b79c
[UIST] Add new object type UIST and Update AFF Model
ViktoriaFreidel Mar 15, 2023
d8e19ab
[UIST] Add new object type UIST and Update AFF Model
ViktoriaFreidel Mar 15, 2023
1144999
[UIST] Add new object type UIST
ViktoriaFreidel Mar 15, 2023
3c9d96e
Update file-formats/uist/type/zif_aff_uist_v1.intf.abap
ViktoriaFreidel Mar 16, 2023
6514fe2
Update file-formats/uist/examples/z_aff_example_uist.uist.json
ViktoriaFreidel Mar 16, 2023
6dc3e7a
Update file-formats/uist/type/zif_aff_uist_v1.intf.abap
ViktoriaFreidel Mar 16, 2023
c6975da
Update file-formats/uist/type/zif_aff_uist_v1.intf.abap
ViktoriaFreidel Mar 16, 2023
6290642
[UIST] Add new object type UIST
ViktoriaFreidel Mar 16, 2023
2b8e327
[UIST] Add new object type UIST
ViktoriaFreidel Mar 16, 2023
942cda4
[UIST] Add new object type UIST
ViktoriaFreidel Mar 16, 2023
bf29b35
remove `multipleOf`from schema
schneidermic0 Mar 16, 2023
33860fe
Merge branch 'main' into feature/uist
schneidermic0 Mar 21, 2023
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/uist/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# UIST File Format

File | Cardinality | Definition | Schema | Example
:--- | :--- | :--- | :--- | :---
`<name>.uist.json` | 1 | [`zif_aff_uist_v1.intf.abap`](./type/zif_aff_uist_v1.intf.abap) | [`uist-v1.json`](./uist-v1.json) | [`z_aff_example_uist.uist.json`](./examples/z_aff_example_uist.uist.json)
18 changes: 18 additions & 0 deletions file-formats/uist/examples/z_aff_example_uist.uist.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
ViktoriaFreidel marked this conversation as resolved.
Show resolved Hide resolved
"formatVersion": "1",
"header": {
"description": "Example of UIST Object for ABAP file formats",
"originalLanguage": "en"
},
"properties": {
"name": "Z_AFF_EXAMPLE_UIST",
"title": "Example of UIST Object for ABAP file formats",
"sortPriority": 1.001,
"baseSpaceTemplateName": "Z_TEST"
},
"pages": [
{
"name": "Z_PAGE"
}
]
}
60 changes: 60 additions & 0 deletions file-formats/uist/type/zif_aff_uist_v1.intf.abap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
INTERFACE zif_aff_uist_v1
PUBLIC.

TYPES:
"! <p class="shorttext">Properties</p>
"! Properties
BEGIN OF ty_properties,
"! <p class="shorttext">Name</p>
"! Space Template Name
"! $required
name TYPE c LENGTH 35,
schneidermic0 marked this conversation as resolved.
Show resolved Hide resolved
"! <p class="shorttext">Title</p>
"! Space Template Title
Copy link
Contributor

Choose a reason for hiding this comment

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

Same

Suggested change
"! Space Template Title
"! Space Template title

"! $required
title TYPE zif_aff_types_v1=>ty_description_100,
"! <p class="shorttext">Sort Priority</p>
"! Sort priority
"! $minimum: -999.999
"! $maximum: 999.999
sort_priority TYPE p LENGTH 7 DECIMALS 3,
"! <p class="shorttext">Base Space Template Name</p>
"! Base Space Template Name
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure about SAP Terms here, but I think at least 'name' should be lower case, no?

Suggested change
"! Base Space Template Name
"! Base Space Template name

Copy link
Contributor

Choose a reason for hiding this comment

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

maybe we could change it to "Name of the Base Space Template"? also not sure about the writing of "Base Space Template"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We change it to "Name of the base space template" - as description .
... Write the description in sentence case .... - from documentation.

base_space_template_name TYPE c LENGTH 35,
END OF ty_properties.

TYPES:
"! <p class="shorttext">SAP Fiori Page Template</p>
"! SAP Fiori Page Template
BEGIN OF ty_page,
"! <p class="shorttext">Name</p>
"! Page Template Name
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"! Page Template Name
"! Page Template name

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we change all description. Thanks

name TYPE c LENGTH 35,
END OF ty_page,

ty_pages TYPE TABLE OF ty_page WITH KEY name.
ViktoriaFreidel marked this conversation as resolved.
Show resolved Hide resolved

TYPES:
"! <p class="shorttext">Fiori Launchpad Space Template</p>
"! Fiori Launchpad Space Template
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_cloud,
schneidermic0 marked this conversation as resolved.
Show resolved Hide resolved

"! <p class="shorttext">Properties</p>
"! Properties
"! $required
properties TYPE ty_properties,
schneidermic0 marked this conversation as resolved.
Show resolved Hide resolved

"! <p class="shorttext">Page Templates</p>
"! Assigned SAP Fiori launchpad page templates
schneidermic0 marked this conversation as resolved.
Show resolved Hide resolved
pages TYPE ty_pages,
END OF ty_main.
ENDINTERFACE.
ViktoriaFreidel marked this conversation as resolved.
Show resolved Hide resolved
7 changes: 7 additions & 0 deletions file-formats/uist/type/zif_aff_uist_v1.intf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"formatVersion": "1",
"header": {
"description": "AFF Type for Object UIST",
"originalLanguage": "en"
}
}
133 changes: 133 additions & 0 deletions file-formats/uist/uist-v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
{
"$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/uist/uist-v1.json",
"title": "Fiori Launchpad Space Template",
"description": "Fiori Launchpad Space Template",
"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": 100
},
"originalLanguage": {
"title": "Original Language",
"description": "Original language of the ABAP object",
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[a-z]+$"
},
"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"
]
},
"id": {
"title": "ID",
"description": "Space Template ID",
"type": "string",
"maxLength": 35
},
"title": {
"title": "Title",
"description": "Space Template Title",
"type": "string",
"maxLength": 100
},
"description": {
"title": "Description",
"description": "Space Template Description",
"type": "string",
"maxLength": 100
},
"sortPriority": {
"title": "Sort Priority",
"description": "Sort priority",
"type": "number",
"minimum": -999.999,
"maximum": 999.999
},
"baseSpaceTemplateId": {
"title": "Base Space Template ID",
"description": "Base Space Template ID",
"type": "string",
"maxLength": 35
},
"pages": {
"title": "Page Templates",
"description": "Assigned SAP Fiori launchpad page templates",
"type": "array",
"items": {
"title": "SAP Fiori Page Template",
"description": "SAP Fiori Page Template",
"type": "object",
"properties": {
"pageTemplateId": {
"title": "Page Template ID",
"description": "Page Template ID",
"type": "string",
"maxLength": 35
},
"pageTemplateTitle": {
"title": "Title",
"description": "Title",
"type": "string",
"maxLength": 100
},
"pageTemplateDescription": {
"title": "Description",
"description": "Description",
"type": "string",
"maxLength": 100
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"required": [
"formatVersion",
"header",
"id",
"title",
"description"
]
}
11 changes: 11 additions & 0 deletions file-formats/zif_aff_types_v1.intf.abap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,17 @@ INTERFACE zif_aff_types_v1 PUBLIC.
abap_language_version TYPE ty_abap_language_version,
END OF ty_header_100.

TYPES:
"! <p class="shorttext">Header for Non-Source Code Objects (no key user)</p>
"! The header for an ABAP main object (without source code) with a description of 100 characters (no key user)
BEGIN OF ty_header_100_cloud,
"! $required
description TYPE ty_description_100,
"! $required
original_language TYPE ty_original_language,
abap_language_version TYPE ty_abap_language_version_cloud,
END OF ty_header_100_cloud.

schneidermic0 marked this conversation as resolved.
Show resolved Hide resolved
TYPES:
"! <p class="shorttext">Header for Subobjects</p>
"! The header for an ABAP subobject with a description of 60 characters
Expand Down