[DTEL] first draft by larshp · Pull Request #727 · SAP/abap-file-formats

larshp · 2026-01-14T12:37:41Z

#556

moving some of the types to new re-useable interface

schneidermic0 · 2026-02-13T08:14:49Z

@larshp Since DOMA has been merged, now. Shall we proceed with this in the same way as with DOMA?

If so, I can try to update this proposal, too. But give me some time.

larshp · 2026-02-13T09:04:33Z

yes, we can go ahead with this one

Copilot

Pull request overview

Adds an initial ABAP File Format (AFF) definition for DDIC Data Elements (DTEL) and introduces a shared DDIC-types interface to reuse common type definitions across DDIC object formats.

Changes:

Introduce zif_aff_ddic_types_v1 to centralize reusable DDIC primitive types (data type enum, length, decimals).
Add the DTEL AFF type interface, JSON schema (dtel-v1.json), README, and an example DTEL file.
Refactor DOMA to reuse the new shared DDIC types instead of duplicating them.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
file-formats/zif_aff_ddic_types_v1.intf.json	Metadata for the new shared DDIC types interface.
file-formats/zif_aff_ddic_types_v1.intf.abap	Centralizes DDIC type enum + length/decimals constraints for reuse.
file-formats/dtel/type/zif_aff_dtel_v1.intf.json	Metadata for the DTEL AFF type interface.
file-formats/dtel/type/zif_aff_dtel_v1.intf.abap	Defines DTEL structure (domain/type refs, labels, search help, etc.).
file-formats/dtel/examples/zdtel_v1.dtel.json	Example DTEL JSON instance.
file-formats/dtel/dtel-v1.json	Generated JSON schema for DTEL files.
file-formats/dtel/README.md	DTEL format documentation entry point.
file-formats/doma/type/zif_aff_doma_v1.intf.abap	Switches DOMA to reference centralized DDIC types.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

albertmink · 2026-03-06T08:18:52Z

@@ -0,0 +1,175 @@
+"! <p class="shorttext synchronized" lang="en">Common DDIC types reusable in AFF</p>
+"! Types which can be reused for ABAP Dictionary object types (DOMA, DTEL, etc.)
+INTERFACE zif_aff_ddic_types_v1 PUBLIC.


[internal] there should be a IF_AFF_DDIC_TYPES_V1 in the SAP BASIS shipment

I have created ZIF_AFF_DDIC_TYPES_V1 for now. I was wondering whether we should move them to a dedicated folder. But this can be done later, too.

schneidermic0 · 2026-03-10T17:23:28Z

+      "! <p class="shorttext">Domain Name</p>
+      "! Reference domain name
+      domain_name               TYPE zif_aff_types_v1=>ty_object_name_30,
+
+      "! <p class="shorttext">Predefined Type</p>
+      "! Predefined ABAP type
+      predefined_type           TYPE ty_predefined_type,
+
+      "! <p class="shorttext">Reference Type</p>
+      "! Reference to an ABAP type
+      reference_type            TYPE zif_aff_types_v1=>ty_object_name_30,
+
+      "! <p class="shorttext">Reference Predefined Type</p>
+      "! Reference to a predefined ABAP type
+      reference_predefined_type TYPE zif_aff_types_v1=>ty_object_name_30,


Currently, we have multiple options to define the data type here. No field is required.
Best solution (for the schema) would be oneOf, but this is not supported.

I was also wondering whether we show it similar to the editor in ADT with a category (as enum) and a data type or a predefined data type:

yea, well, cannot really express "oneOf" in ABAP types

I'd say its up to presentation and/or additional checks

but I guess we can also do a new annotation, which is just relevant for the JSON schema

we can always implement that later? and not wait until its done?

I would love to have s.th. like oneOf. Unfortunately, this would have some implications we cannot address so fast.

github-actions · 2026-04-13T16:38:20Z

ABAP Doc Checks

Run ABAP Doc title/description casing check

New commits with ABAP changes were pushed. Check the box to run again.

larshp · 2026-04-17T09:58:10Z

@schneidermic0 any thoughts?

schneidermic0 · 2026-04-17T10:11:20Z

The team is working on a proposal for data elements currently. They wanted to reach out here soon anyhow. Can we wait for some time?

larshp · 2026-04-17T10:53:27Z

The team is working on a proposal for data elements currently. They wanted to reach out here soon anyhow. Can we wait for some time?

So my efforts is expected ti be discarded?

GuilhermeSaraiva96 · 2026-04-17T15:29:35Z

The team is working on a proposal for data elements currently. They wanted to reach out here soon anyhow. Can we wait for some time?

So my efforts is expected ti be discarded?

Hi Lars,

We have been working on a solution to automate the AFF generation, which works specially well on objects that already exist in ADT, mainly due to the XSD structure for ADT editors. The AFF Generation AI Tool has access to this AFF repo, to past comments from our reviews, to our ADT codebase and to our ABAP systems.

To keep it transparent, I am posting here the fully generated AFF, without any manual input from us. We already reviewed the structure with the colleagues responsible for the DTEL editor and we are very pleased with it, it would need a final review from the object type experts and a review regarding title, naming and descriptions (these come down to personal taste). One thing I noticed is that it contains the length variables (medium_length, short_length), which is missing in your AFF and I also prefer the solution of ty_type_definition vs your ty_data_type_information. To not let any of your work go to waste and since this is your PR, you can tell us if we should adapt yours to include some of the improvements from this generated AFF, or if we should directly iterate from this one :)

Note: Use the raw text from my comment to see the ABAP type

INTERFACE zif_aff_dtel_v1 PUBLIC.

"! <p class="shorttext">Type Kind</p>                                       
"! Kind of type assignment for the data element                             
"! $values {@link zif_aff_dtel_v1.data:co_type_kind}                        
TYPES ty_type_kind TYPE c LENGTH 30.                                        
                                                                            
CONSTANTS:                                                                  
  BEGIN OF co_type_kind,                                                    
    "! <p class="shorttext">Domain</p>                                      
    "! Data element is based on a domain                                    
    domain                      TYPE ty_type_kind VALUE 'domain',           
    "! <p class="shorttext">Predefined ABAP Type</p>                        
    "! Data element uses a predefined ABAP built-in type                    
    predefined_abap_type        TYPE ty_type_kind VALUE

'predefinedAbapType',
"!

Reference to Predefined ABAP Type

"! Data element is a reference to a predefined ABAP type
ref_to_predefined_abap_type TYPE ty_type_kind VALUE
'refToPredefinedAbapType',
"!

Reference to Dictionary Type

"! Data element is a reference to a Dictionary type
ref_to_dictionary_type TYPE ty_type_kind VALUE
'refToDictionaryType',
"!

Reference to Class/Interface Type

"! Data element is a reference to a class or interface type
ref_to_clif_type TYPE ty_type_kind VALUE 'refToClifType',
END OF co_type_kind.

"! <p class="shorttext">Documentation Status</p>                            
"! Documentation status of the data element                                 
"! $values {@link zif_aff_dtel_v1.data:co_documentation_status}             
TYPES ty_documentation_status TYPE c LENGTH 25.                             
                                                                            
CONSTANTS:                                                                  
  BEGIN OF co_documentation_status,                                         
    "! <p class="shorttext">Required</p>                                    
    "! Documentation is required                                            
    required                TYPE ty_documentation_status VALUE 'required',  
    "! <p class="shorttext">Not Used in Screens</p>                         
    "! Data element is not used in screens; no documentation needed         
    not_used_in_screens     TYPE ty_documentation_status VALUE

'notUsedInScreens',
"!

Explained by Short Text

"! Short text is sufficient as documentation
explained_by_short_text TYPE ty_documentation_status VALUE
'explainedByShortText',
"!

Postponed

"! Documentation is postponed
postponed TYPE ty_documentation_status VALUE 'postponed',
END OF co_documentation_status.

TYPES:                                                                      
  "! <p class="shorttext">Type Definition</p>                               
  "! Type definition of the data element                                    
  BEGIN OF ty_type_definition,
    "! <p class="shorttext">Type Kind</p>                                   
    "! Kind of type assignment                                              
    "! $required                                                            
    type_kind  TYPE ty_type_kind,                                           
    "! <p class="shorttext">Type Name</p>                                   
    "! Name of the domain or type this data element is based on             
    type_name  TYPE zif_aff_types_v1=>ty_object_name_30,                    
    "! <p class="shorttext">Data Type</p>
    "! Built-in ABAP data type (only for type kind predefined ABAP type)    
    data_type  TYPE zif_aff_ddic_types_v1=>ty_data_type,                    
    "! <p class="shorttext">Length</p>                                      
    "! Length of the data type (only for type kind predefined ABAP type)    
    length     TYPE i,                                                      
    "! <p class="shorttext">Decimals</p>                                    
    "! Number of decimal places (only for type kind predefined ABAP type)   
    decimals   TYPE i,                                                      
  END OF ty_type_definition.                                                
                                                                            
TYPES:                                                                      
  "! <p class="shorttext">Field Labels</p>                                  
  "! Screen and list field labels for the data element                      
  BEGIN OF ty_field_labels,                                                 
    "! <p class="shorttext">Short Label</p>                                 
    "! Short field label (max 10 characters)                                
    short_label    TYPE c LENGTH 10,                                        
    "! <p class="shorttext">Short Label Length</p>                          
    "! Output length for the short field label                              
    short_length   TYPE zif_aff_ddic_types_v1=>ty_label_length,             
    "! <p class="shorttext">Medium Label</p>                                
    "! Medium field label (max 20 characters)                               
    medium_label   TYPE c LENGTH 20,                                        
    "! <p class="shorttext">Medium Label Length</p>                         
    "! Output length for the medium field label                             
    medium_length  TYPE zif_aff_ddic_types_v1=>ty_label_length,             
    "! <p class="shorttext">Long Label</p>                                  
    "! Long field label (max 40 characters)                                 
    long_label     TYPE c LENGTH 40,                                        
    "! <p class="shorttext">Long Label Length</p>                           
    "! Output length for the long field label                               
    long_length    TYPE zif_aff_ddic_types_v1=>ty_label_length,             
    "! <p class="shorttext">Heading</p>                                     
    "! Column heading for list outputs (max 55 characters)                  
    heading        TYPE c LENGTH 55,                                        
    "! <p class="shorttext">Heading Length</p>                              
    "! Output length for the column heading                                 
    heading_length TYPE zif_aff_ddic_types_v1=>ty_label_length,             
  END OF ty_field_labels.                                                   
                                                                            
TYPES:                                                                      
  "! <p class="shorttext">Search Help</p>                                   
  "! Search help assignment for value input help                            
  BEGIN OF ty_search_help,                                                  
    "! <p class="shorttext">Search Help Name</p>                            
    "! Name of the assigned search help                                     
    name      TYPE zif_aff_types_v1=>ty_object_name_30,                     
    "! <p class="shorttext">Search Help Parameter</p>                       
    "! Parameter of the search help used for this data element              
    parameter TYPE c LENGTH 30,                                             
  END OF ty_search_help.                                                    
                                                                            
TYPES:                                                                      
  "! <p class="shorttext">Further Characteristics</p>                       
  "! Further characteristics of the data element                            
  BEGIN OF ty_further_characteristics,                                      
    "! <p class="shorttext">Set/Get Parameter ID</p>                        
    "! Parameter ID for SET/GET parameter (SPA/GPA memory)                  
    set_get_parameter_id      TYPE c LENGTH 20,                             
    "! <p class="shorttext">Default Component Name</p>                      
    "! Default field name when the data element is used as a component      
    default_component_name    TYPE zif_aff_types_v1=>ty_object_name_30,     
    "! <p class="shorttext">Change Document</p>                             
    "! Field should be recorded in change documents                         
    "! $showAlways                                                          
    change_document           TYPE abap_bool,                               
    "! <p class="shorttext">No Input History</p>                            
    "! Deactivates input history for fields based on this data element      
    "! $showAlways                                                          
    no_input_history          TYPE abap_bool,                               
    "! <p class="shorttext">Left-to-Right Direction</p>                     
    "! Forces left-to-right text direction for bidirectional text           
    "! $showAlways                                                          
    left_to_right_direction   TYPE abap_bool,                            # here I would personally leave it as a enumeration, like you did   
    "! <p class="shorttext">Deactivate BiDi Filtering</p>                   
    "! Deactivates bidirectional text filtering                             
    "! $showAlways                                                          
    deactivate_bidi_filtering TYPE abap_bool,                               
    "! <p class="shorttext">Documentation Status</p>                        
    "! Status of the documentation for this data element                    
    "! $required                                                            
    documentation_status      TYPE ty_documentation_status,                 
  END OF ty_further_characteristics.                                        
                                                                            
TYPES:                                                                      
  "! <p class="shorttext">Data Element</p>                                  
  "! Data element properties                                                
  BEGIN OF ty_main,                                                         
    "! $required                                                            
    format_version          TYPE zif_aff_types_v1=>ty_format_version,       
    "! <p class="shorttext">Header</p>                                      
    "! Administrative data of the data element                              
    "! $required                                                            
    header                  TYPE zif_aff_types_v1=>ty_header_60,            
    "! <p class="shorttext">Type Definition</p>                             
    "! Type definition of the data element                                  
    "! $required                                                            
    type_definition         TYPE ty_type_definition,                        
    "! <p class="shorttext">Field Labels</p>
    "! Screen and list field labels
    "! $showAlways                                                          
    field_labels            TYPE ty_field_labels,                           
    "! <p class="shorttext">Search Help</p>                                 
    "! Search help assignment                                               
    search_help             TYPE ty_search_help,                            
    "! <p class="shorttext">Further Characteristics</p>                     
    "! Further characteristics of the data element                          
    further_characteristics TYPE ty_further_characteristics,                
  END OF ty_main.

ENDINTERFACE.

larshp · 2026-04-22T14:37:37Z

@GuilhermeSaraiva96 format the above message, or open a separate PR so we can see it?

does this also mean you'll be opening PRs for other object types? like TTYP ?

DTEL scaffolding

3bc8d34

larshp mentioned this pull request Jan 14, 2026

Could you please define format for DTEL (Data Element)? #556

Open

larshp added 2 commits January 14, 2026 13:46

scaffolding

a7c3da6

scaffolding

6481a2e

Merge branch 'main' into hvam/dtelv1

43df30b

schneidermic0 and others added 4 commits February 27, 2026 14:15

Merge branch 'main' into hvam/dtelv1

392916d

adjust

25af0e9

update example

7bc9166

update schema

ee6975f

larshp requested a review from Copilot March 5, 2026 12:07

Copilot started reviewing on behalf of larshp March 5, 2026 12:08 View session

larshp marked this pull request as ready for review March 5, 2026 12:08

Copilot AI reviewed Mar 5, 2026

View reviewed changes

larshp and others added 10 commits March 5, 2026 13:14

Update file-formats/dtel/type/zif_aff_dtel_v1.intf.json

3d5e293

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update file-formats/dtel/README.md

ef2be0a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update file-formats/dtel/type/zif_aff_dtel_v1.intf.abap

6b4d1af

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update file-formats/dtel/dtel-v1.json

8e3a62a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update file-formats/zif_aff_ddic_types_v1.intf.abap

a3380dd

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

update schema

9f5f933

fix typo in DOMA schema

14fbacf

Update zif_aff_doma_v1.intf.abap

b662f7c

Remove empty line in zif_aff_doma_v1 interface

7df2510

Merge branch 'main' into hvam/dtelv1

ebb822c

albertmink reviewed Mar 6, 2026

View reviewed changes

schneidermic0 added 3 commits March 10, 2026 18:09

Update the structure for DTEL

06dcaae

Fixing abaplint

687aff6

Merge branch 'main' into hvam/dtelv1

3310059

schneidermic0 reviewed Mar 10, 2026

View reviewed changes

larshp added 5 commits March 29, 2026 17:28

Merge branch 'main' into hvam/dtelv1

e3afbb0

Merge branch 'main' into hvam/dtelv1

e48f3f1

Merge branch 'main' into hvam/dtelv1

d3b9e7a

Merge branch 'main' into hvam/dtelv1

68fe03f

Merge branch 'main' into hvam/dtelv1

8dfb82c

larshp requested a review from schneidermic0 April 13, 2026 16:38

schneidermic0 self-assigned this Apr 14, 2026

Merge branch 'main' into hvam/dtelv1

37303b4

GuilhermeSaraiva96 self-assigned this Apr 20, 2026

larshp added 4 commits April 22, 2026 16:38

Merge branch 'main' into hvam/dtelv1

061183b

Update zif_aff_doma_v1.intf.abap

240dd50

Refactor types in zif_aff_doma_v1 interface

1a30133

Merge branch 'main' into hvam/dtelv1

b76aa03

larshp mentioned this pull request Apr 29, 2026

[TTYP] Add ABAP file format for table types #775

Open

Conversation

larshp commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

schneidermic0 commented Feb 13, 2026

Uh oh!

larshp commented Feb 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

albertmink Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

schneidermic0 Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

schneidermic0 Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

larshp Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

larshp Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

schneidermic0 Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ABAP Doc Checks

Uh oh!

larshp commented Apr 17, 2026

Uh oh!

schneidermic0 commented Apr 17, 2026

Uh oh!

larshp commented Apr 17, 2026

Uh oh!

GuilhermeSaraiva96 commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

larshp commented Apr 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

larshp commented Jan 14, 2026 •

edited

Loading

schneidermic0 Mar 10, 2026 •

edited

Loading

larshp Apr 9, 2026 •

edited

Loading

github-actions Bot commented Apr 13, 2026 •

edited

Loading

GuilhermeSaraiva96 commented Apr 17, 2026 •

edited

Loading