-
Notifications
You must be signed in to change notification settings - Fork 55
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
[SMTG] Add new object type SMTG #633
Open
OliverBeck01
wants to merge
12
commits into
SAP:main
Choose a base branch
from
OliverBeck01:feature/SMTG
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
23b6806
Add files for SMTG
OliverBeck01 da2d7d1
Delete file-formats/smtg
OliverBeck01 5c00ddf
Create type
OliverBeck01 3cba3b8
Delete SMTG directory
OliverBeck01 2685430
add smtg
OliverBeck01 feca225
Change table types in SMTG aff interface
OliverBeck01 5828755
Update SMTG Aff
OliverBeck01 26b5021
Change a few namings in AFF interface
OliverBeck01 0e0f1ee
Update AFF - Removing Template ID and Template ID
OliverBeck01 d19bf6e
Remove schema generation error
OliverBeck01 cd9f2e9
Move Subject into main interface and change config file
OliverBeck01 b6a1928
Add a "required" to the interface
OliverBeck01 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ | ||
# SMTG File Format | ||
|
||
File | Cardinality | Definition | Schema | Example | ||
:--- | :--- | :--- | :--- | :--- | ||
`<name>.smtg.json` | 1 | [`zif_aff_smtg_v1.intf.abap`](./type/zif_aff_smtg_v1.intf.abap) | [`smtg-v1.json`](./smtg-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,107 @@ | ||
{ | ||
"$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/smtg/smtg-v1.json", | ||
"title": "Email Template", | ||
"description": "Email 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": 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" | ||
] | ||
}, | ||
"generalInformation": { | ||
"title": "General Information", | ||
"description": "General information", | ||
"type": "object", | ||
"properties": { | ||
"longDescription": { | ||
"title": "Template Description", | ||
"description": "Long description to that email template", | ||
"type": "string", | ||
"maxLength": 255 | ||
}, | ||
"isPredelivered": { | ||
"title": "Predelivered", | ||
"description": "Indicator if the template is predelivered", | ||
"type": "boolean" | ||
}, | ||
"isPlaintextAutoGenerated": { | ||
"title": "Generate Plain Text from HTML", | ||
"description": "Indicator if the template text body is generated automatically from html body", | ||
"type": "boolean" | ||
}, | ||
"cdsView": { | ||
"title": "CDS View", | ||
"description": "The corresponding CDS view name for the template", | ||
"type": "string", | ||
"maxLength": 30 | ||
}, | ||
"emailSubject": { | ||
"title": "Subject", | ||
"description": "The subject of the email template", | ||
"type": "string", | ||
"maxLength": 255 | ||
} | ||
}, | ||
"additionalProperties": false, | ||
"required": [ | ||
"cdsView", | ||
"emailSubject" | ||
] | ||
} | ||
}, | ||
"additionalProperties": false, | ||
"required": [ | ||
"formatVersion", | ||
"header", | ||
"generalInformation" | ||
] | ||
} |
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,47 @@ | ||
INTERFACE zif_aff_smtg_v1 | ||
PUBLIC. | ||
|
||
TYPES: | ||
"! <p class="shorttext">General Information</p> | ||
"! Combines template header and administrative data. | ||
BEGIN OF ty_general_information, | ||
"! <p class="shorttext">Template Description</p> | ||
"! Long description to that email template | ||
long_description TYPE c LENGTH 255, | ||
"! <p class="shorttext">Predelivered</p> | ||
"! Indicator if the template is predelivered | ||
is_predelivered TYPE abap_bool, | ||
"! <p class="shorttext">Generate Plain Text from HTML</p> | ||
"! Indicator if the template text body is generated automatically from html body | ||
is_plaintext_auto_generated TYPE abap_bool, | ||
"! <p class="shorttext">CDS View</p> | ||
"! The corresponding CDS view name for the template | ||
"! $required | ||
cds_view TYPE zif_aff_types_v1=>ty_object_name_30, | ||
"! <p class="shorttext">Subject</p> | ||
"! The subject of the email template | ||
"! $required | ||
email_subject TYPE c LENGTH 255, | ||
END OF ty_general_information. | ||
" Corresponding content ist stored in a separate file and implemented as action | ||
|
||
|
||
TYPES: | ||
"! <p class="shorttext">Email Template</p> | ||
"! Email 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, | ||
"! <p class="shorttext">General Information</p> | ||
"! General information | ||
"! $required | ||
general_information TYPE ty_general_information, | ||
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": "test email template file format", | ||
"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.
We usually recommend having title and name of the component in sync. Is it possible to rename to
? The other discrepancies between title and name are fine for me.
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 updated the description name to "template_description"