BC435 - Module Pool
BC435 - Module Pool
Introduction
This is a discussion on ALV reporting-a step by step operation manual about creating an
ALV report of medium complexity. This documentation will not make you an expert in
ALV. But, definitely, it will come handy at the time of need. It refers an example report
YSUBALV, as a reference and will represent relevant blocks of the code at different areas
of discussion.
Contents
ALV (ABAP LIST VIEWER)
Example:
Sample code.
Description:Sap provides a set of ALV (ABAP LIST VIEWER) function modules, which
can be put into use to embellish the output of a report. This set of ALV functions is used to
enhance the readability and functionality of any report output. Cases arise in sap when the
output of a report contains columns extending more than 255 characters in length. In such
cases, this set of ALV functions can help choose selected columns and arrange the different
columns from a report output and also save different variants for report display. This is a
very efficient tool for dynamically sorting and arranging the columns from a report output.
The report output can contain up to 90 columns in the display with the wide array of
display options.
The commonly used ALV functions used for this purpose are;
1. REUSE_ALV_VARIANT_DEFAULT_GET
2. REUSE_ALV_VARIANT_F4
3. REUSE_ALV_VARIANT_EXISTENCE
4. REUSE_ALV_EVENTS_GET
5. REUSE_ALV_COMMENTARY_WRITE
6. REUSE_ALV_FIELDCATALOG_MERGE
7. REUSE_ALV_LIST_DISPLAY
8. REUSE_ALV_GRID_DISPLAY
9. REUSE_ALV_POPUP_TO_SELECT
The different steps used for getting the above function modules into use are described
below.
Example: -
REPORT YSUBALV.
*---------------------------*
TYPE-POOLS: SLIS.
* To pass name of the report in function module for ALV
Data: V_REPID LIKE SY-REPID.
* To pass the overall structure of the ALV report
Data: STRUCT_LAYOUT TYPE SLIS_LAYOUT_ALV.
Data: STRUCT_LAYOUT1 TYPE SLIS_LAYOUT_ALV.
* Internal table to capture various events in ALV
Data: I_EVENTS TYPE SLIS_T_EVENT.
* Table for catalog of the fields to be displayed
Data: I_FIELDCAT TYPE SLIS_T_FIELDCAT_ALV.
Data: X_FIELDCAT TYPE SLIS_FIELDCAT_ALV.
Data: I_FIELDCAT1 TYPE SLIS_T_FIELDCAT_ALV.
Data: X_FIELDCAT1 TYPE SLIS_FIELDCAT_ALV.
* Internal table to mention the sort sequence
Data: IT_SORT TYPE SLIS_T_SORTINFO_ALV.
Data: X_SORT TYPE SLIS_SORTINFO_ALV.
* Internal table to display top of page
Data: i_list_top_of_page type slis_t_listheader.
* Structure to display variants
Data: i_variant like disvariant,
I_variant1 like disvariant.
* Internal table to pass data
DATA: BEGIN OF I_TAB OCCURS 0,
Mblnr like mseg-mblnr ,
Matnr like mseg-matnr,
Maktg like makt-maktg,
Charg like mseg-charg,
Werks like mseg-werks,
Lgort like mseg-lgort,
menge like mseg-menge ,
meins like mseg-meins ,
dmbtr like mseg-dmbtr,
ebeln like mseg-ebeln,
icn(4) type c ,
sym(4) type c ,
excpt(2) type c ,
box(1),
END OF I_TAB.
*EJECT
Data: begin of i_doc occurs 0.
INCLUDE STRUCTURE MSEG.
Data: end of i_doc.
The variants in the list display can be both user-specific and general. The user can
programmatically set the initial (default) variant for list display. The default variant can be
found using the function module 'REUSE_ALV_VARIANT_DEFAULT_GET'.
Sample code:
CALL FUNCTION 'REUSE_ALV_VARIANT_DEFAULT_GET'
EXPORTING
i_save = variant save condition (A=all, U = user-specific)
CHANGING
cs_variant = internal table containing the program name (and the default variant---
optional)
EXCEPTIONS
not_found = 2.
The user can also choose from the list of existing variants using the function module
'REUSE_ALV_VARIANT_F4'. Example:
Initialization.
v_repid = sy-repid.
* Display default variant
PERFORM SUB_VARIANT_INIT.
AT SELECTION-SCREEN ON P_VAR.
* Once the user has entered variant, check about its existence
PERFORM SUB_CHECK_PVAR.
AT SELECTION-SCREEN ON VALUE-REQUEST FOR P_VAR.
* Display a list of various variants of the report when the User presses F4 key in the variant
field
PERFORM SUB_VARIANT_F4.
*&---------------------------------------------------------------------*
*& Form SUB_VARIANT_INIT
*&---------------------------------------------------------------------*
* Display default variant
*&---------------------------------------------------------------------*
Form SUB_VARIANT_INIT.
I_VARIANT1-REPORT = SY-REPID.
* Search default variant for the report
CALL FUNCTION 'REUSE_ALV_VARIANT_DEFAULT_GET'
EXPORTING
i_save = 'A'
CHANGING
cs_variant = i_variant1
EXCEPTIONS
not_found = 2.
* If default variant is found, use it as default.
* Else, use the variant LAYOUT1.
IF sy-subrc = 0.
p_var = i_variant1-variant.
ELSE.
p_var = 'LAYOUT1'.
ENDIF.
endform. "SUB_VARIANT_INIT
*&---------------------------------------------------------------------------------*
*& Form SUB_CHECK_PVAR
*&---------------------------------------------------------------------------------*
* Once the user has entered variant, check about its existence
*&---------------------------------------------------------------------------------*
FORM SUB_CHECK_PVAR.
* If the name of the variable is not blank, check about its existence
if not p_var is initial.
clear i_variant.
i_variant-report = sy-repid.
i_variant-variant = p_var.
CALL FUNCTION 'REUSE_ALV_VARIANT_EXISTENCE'
EXPORTING
I_SAVE = 'A'
CHANGING
CS_VARIANT = I_VARIANT.
* If no such variant found, flash error message
If sy-subrc ne 0 .
Message e398(00) with 'No such variant exists'.
Else.
* If variant exists, use the variant name to populate structure
* I_VARIANT1 which will be used for export parameter: IS_VARIANT
* in the function module : REUSE_ALV_GRID_DISPLAY
Clear i_variant1.
Move p_var to i_variant1-variant.
Move sy-repid to i_variant1-report.
endif.
Else.
Clear i_variant.
endif.
ENDFORM. "SUB_CHECK_PVAR
*&---------------------------------------------------------------------------------*
*& Form SUB_VARIANT_F4
*&---------------------------------------------------------------------------------*
* Display a list of various variants of the report when the User presses F4 key in the variant
field
*&---------------------------------------------------------------------------------*
Form SUB_VARIANT_F4.
i_variant-report = sy-repid.
* Utilizing the name of the report, this function module will search for a list of
* variants and will fetch the selected one into the parameter field for variants
CALL FUNCTION 'REUSE_ALV_VARIANT_F4'
EXPORTING
IS_VARIANT = I_VARIANT
I_SAVE = 'A'
I_DISPLAY_VIA_GRID = 'X'
IMPORTING
ES_VARIANT = I_VARIANT1
EXCEPTIONS
NOT_FOUND =1
PROGRAM_ERROR =2
OTHERS = 3.
IF SY-SUBRC = 0.
P_VAR = I_VARIANT1-VARIANT.
ENDIF.
endform. "SUB_VARIANT_F4
- Tabname (internal output table): Name of the internal output table that contains the
field FIELDCAT-FIELDNAME above.
Value set: SPACE, internal output table name.
- Ref_fieldname (reference field name): Name of the Data Dictionary field referred
to. This parameter is only used when the internal output table field described by the current
field catalog entry has a reference to the Data Dictionary (not a program field), and the field
name in the internal output table is different from the name of the field in the Data
Dictionary. If the field names are identical, naming the Data Dictionary structure or table in
the FIELDCAT-REF_TABNAME parameter is sufficient.
Value set: SPACE, Data Dictionary field name.
- Ref_tabname (reference table/structure field name): Structure or table name of the
referred Data Dictionary field. This parameter is only used when the internal output table
field described by the current field catalog entry has a Data Dictionary reference (not a
program field).
Value set: SPACE, name of a Data Dictionary structure or table
- Cfieldname (currency unit field name): This is used for currency fields that have a
reference to any unit field. This is only relevant for amount columns with associated unit.
This parameter contains the Name of the internal output table field containing the currency
unit associated with the amount field FIELDCAT-FIELDNAME. The field in FIELDCAT-
CFIELDNAME must have its own field catalog entry.
Value set: SPACE, output table field name.
- Ctabname (internal currency unit field output table): Name of the internal output
table containing the FIELDCAT-CFIELDNAME field.
Value set: SPACE, output table field name.
Link to measurement unit
- Qfieldname (measurement unit field name): Only relevant for quantity columns
with unit link. Name of the internal output table field containing the measurement unit
associated with the quantity field FIELDCAT-FIELDNAME. The field in FIELDCAT-
QFIELDNAME must have its own field catalog entry.
Value set: SPACE, output table field name.
- Qtabname (internal measurement unit field output table): Name of the internal
output table containing the FIELDCAT-QFIELDNAME field.
Value set: SPACE, output table field name.
- Outputlen (column width): This parameter is used if the desired output length for a
field is desired to be different from the internal output table field. For fields with a Data
Dictionary link this parameter can be left initial. For fields without a Data Dictionary link
(program field) the parameter must be given the value of the desired field list output length
(column width).
Initial = column width is the output length of the referred Data Dictionary field (domain).
N = column width is n characters.
Value set: 0 (initial), n.
- Key (key column): By default, the system makes some fields in the output as key
fields, provided the fields are key fields in their referencing table. Using this parameter,
fields other than key fields of the referencing table can be made key field. This parameter is
most important if the output needs to contain some field, which are not scrollable or cannot
be hidden.
If the internal output table contains fields that are key fields from different tables, then all
those fields in the report output becomes un-scrollable and cannot be hidden. So, the fields
in the output internal table should not be referenced from tables in which they are key
fields. Instead, they should be referenced to the tables in which they are not key fields,
incase they are not desired as key field in the output.
'X' = key field (key field output in color) and Key fields cannot be interactively hidden.
Parameter FIELDCAT-NO_OUT must be left initial.
Value set: SPACE, 'X'.
- Key_sel (hide-able key column): This parameter is only relevant for the fields
which are made key fields using FIELDCAT-KEY = 'X'. Using this parameter the Key field
can be hidden interactively.
The key column sequence cannot be changed interactively by the user. The output is
controlled by the FIELDCAT-NO_OUT parameter analogously to non-key fields.
Value set: SPACE, 'X'.
- No_out (field in field list): This parameter is used to remove certain fields from the
output during initial display. The user can however interactively choose the field for output
from the field list in the display variant.
'X' = field is not displayed in the current list.
Value set: SPACE, 'X'.
- Tech (technical field): This parameter is used to make certain field display only in
the field catalog. The fields with this parameter set cannot be output in the list nor can they
be displayed interactively from the catalog.
'X' = technical field.
Value set: SPACE, 'X'.
- Emphasize (highlight columns in color): As name suggests, this field parameter is
used to highlight certain field with chosen colors.
Value set: SPACE, 'X' or 'Cxyz' (x:'1'-'9'; y,z: '0'=off ,'1'=on).
'X' = column is colored with the default column highlight color.
'Cxyz' = column is colored with a coded color:
- C: Color (coding must begin with C)
- X: color number
- Y: bold
- Z: inverse
- Hotspot (column as hotspot): This parameter is used to make certain field appear as
hotspot i.e. a hand is displayed if the cursor is positioned on the field value. Single click on
such fields cause the PICK OR F2 events to happen.
Value set: SPACE, 'X'.
'X' = column cells are output as hotspots.
- Fix_column (fix column): This parameter is used to fix certain columns in the
output. All columns to be fixed must have this flag, starting from the left. If a column
without this flag is output, only the columns to the left of this column are fixed. The user
can change the column fixing interactively.
Value set: SPACE, 'X'.
'X' = column fixed (does not scroll horizontally).
- Do_sum (sum over column): the user can also call this function interactively.
Value set: SPACE, 'X'.
'X' = a sum is calculated over this internal output table field.
- No_sum (sums forbidden): No sum can be calculated over this field, although the
data type of the field would allow summing.
Value set: SPACE, 'X'.
- Icon: The parameter displays certain column contents as icons. The internal output
table column contents must be valid icon strings.
Value set: SPACE, 'X'.
'X' = column contents to be output as an icon.
- Symbol: The internal output table column must be a valid symbol character.
Value set: SPACE, 'X'
'X' = column contents are to be output as a symbol.
- Just (justification): This parameter is used for alignment of the contents of the
output table. This is only relevant for CHAR or NUMC fields in the output internal table.
The justification of the column header always follows the justification of the columns.
Independent justification of the column header is not possible.
Value set: SPACE, 'R', 'L', and 'C'.
' ' = Default justification for this data type
'R' = right-justified output
'L' = left-justified output
'C' = centered output.
- Lzero (leading zeros): By default ALV outputs NUMC fields right-justified without
leading zeros. Using this parameter only the NUMC fields can be displayed with leading
zeroes.
Value set: SPACE, 'X'.
'X' = output with leading zeros.
- No_sign (no +/- sign): This parameter is used to suppress the signs of the output
fields. It is only relevant for the value fields.
Value set: SPACE, 'X'.
'X' = value output without +/ sign.
- No_zero (suppress zeros): Only relevant for value fields.
Value set: SPACE, 'X'.
'X' = suppress zeros.
- Edit_mask (field formatting): To apply the report output formatting options same
as in the WRITE statement in report writing.
Value set: SPACE, template.
The following parameters are used for customizing the texts in the heading of the output of
the columns. The texts are taken from the Data Dictionary for fields with a Data Dictionary
reference. If this is not desired, the text parameters can also be specified. The Data
Dictionary texts are then ignored.
If the user changes the column width interactively, the column header text with the
appropriate length is always used.
The interactive function 'Optimize column width' takes account of both the field contents
and the column headers: if all field contents are shorter than the shortest column header, the
column width depends on the column header.
The 'long field label' is also used in display variant definition,
Sort, etc. Popup.
- seltext_l (long field label)
- seltext_m (medium field label)
- seltext_s (short field label)
- reptext_ddic (header) Analogous to the Data element main header
- Ddictxt (specify text): You can specify with values 'L', 'M', and 'S', the keyword that
should always be used as column header. If the column width changes, no attempt is made
in this case to find an appropriate header for the new output width.
Value set: SPACE, 'L', 'M', and 'S'.
Sample code:
*&---------------------------------------------------------------------*
*& Form SUB_PREPARE_FIELDCATALOG
*&---------------------------------------------------------------------*
* Prepare field catalog for the main report. State the name of the field, name of internal
table, various formatting options etc
*----------------------------------------------------------------------*
Form SUB_PREPARE_FIELDCATALOG.
X_FIELDCAT-COL_POS = 1. * First field to appear in ALV list
X_FIELDCAT-FIELDNAME = 'SYM'. * Name of the internal table field
X_FIELDCAT-TABNAME = 'I_TAB'. * Name of the internal table
X_FIELDCAT-SELTEXT_M = 'Stat'. * Heading for the field
X_FIELDCAT-SYMBOL = 'X'. * The field is going to contain a symbol
* Append the specifications to the internal table for field catalog.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 2. * Second field to appear in ALV
list
X_FIELDCAT-FIELDNAME = 'MATNR'. * Name of the field in the internal
table
X_FIELDCAT-TABNAME = 'I_TAB'. * Name of the internal table
X_FIELDCAT-SELTEXT_M = 'MatItem'. * Heading for the column
* It is going to be the key field.The color for this field is going to be different
X_FIELDCAT-KEY = 'X'.
X_FIELDCAT-KEY_SEL = 'X'.
* Single click on the field will trigger double click event. Also, a hand will appear when the
cursor navigates to the field
X_FIELDCAT-HOTSPOT = 'X'.
X_FIELDCAT-FIX_COLUMN = 'X'. * The column and those left to it
will not scroll
X_FIELDCAT-REF_TABNAME = 'MSEG'. * F1 help will come as it is
referenced to DDIC table
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 3.
X_FIELDCAT-FIELDNAME = 'MAKTG'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = 'Description'.
* X_FIELDCAT-OUTPUTLEN = 50.
X_FIELDCAT-HOTSPOT = space.
X_FIELDCAT-JUST = 'C'. * The field is centre(C for centre, R and L
for left and right) justified
X_FIELDCAT-KEY = 'X'.
X_FIELDCAT-FIX_COLUMN = 'X'.
*X_fieldcat-no_out = 'X'.
X_FIELDCAT-FIX_COLUMN = 'X'.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 4.
X_FIELDCAT-FIELDNAME = 'CHARG'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = 'Batch'.
* X_FIELDCAT-OUTPUTLEN = 10.
X_FIELDCAT-HOTSPOT = space.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 5.
X_FIELDCAT-FIELDNAME = 'EBELN'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = 'Purchase Order'.
* X_FIELDCAT-OUTPUTLEN = 14.
X_FIELDCAT-EMPHASIZE = 'C511'. * The field will be colored
differently (Cxyz)
X_FIELDCAT-NO_OUT = 'X'. * Initially the field will be hidden
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 6.
X_FIELDCAT-FIELDNAME = 'MBLNR'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = 'Document no'.
* X_FIELDCAT-OUTPUTLEN = 14.
X_FIELDCAT_EMPHASIZE = 'C711'.
X_FIELDCAT-NO_OUT = 'X'.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 7.
X_FIELDCAT-FIELDNAME = 'WERKS'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = 'Plant'.
* X_FIELDCAT-OUTPUTLEN = 5.
X_FIELDCAT-EMPHASIZE = 'C310'.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 8.
X_FIELDCAT-FIELDNAME = 'LGORT'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = 'St.Loc'.
* X_FIELDCAT-OUTPUTLEN = 7.
* X_FIELDCAT-NO_OUT = 'X'.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 9.
X_FIELDCAT-FIELDNAME = 'MENGE'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = 'Quantity'.
X_FIELDCAT-OUTPUTLEN = 12.
X_FIELDCAT-DO_SUM = 'X'. * Summation is allowed for this
field
X_FIELDCAT-REF_TABNAME = 'MSEG'.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 10.
X_FIELDCAT-FIELDNAME = 'ICN'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = ''.
X_FIELDCAT-OUTPUTLEN = 2.
X_FIELDCAT-ICON = 'X'.
* X_FIELDCAT-NO_OUT = 'X'.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 11.
X_FIELDCAT-FIELDNAME = 'MEINS'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = 'Unit'.
X_FIELDCAT-OUTPUTLEN = 5.
X_FIELDCAT-FIELDNAME = 'MEINS'.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 12.
X_FIELDCAT-FIELDNAME = 'DMBTR'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = 'Local curr'.
X_FIELDCAT-OUTPUTLEN = 12.
X_FIELDCAT-INTTYPE = 'P'.
X_FIELDCAT-JUST = 'R'.
X_FIELDCAT-DO_SUM = 'X'.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
X_FIELDCAT-COL_POS = 13.
X_FIELDCAT-FIELDNAME = 'EXCPT'.
X_FIELDCAT-TABNAME = 'I_TAB'.
X_FIELDCAT-SELTEXT_M = ''.
X_FIELDCAT-OUTPUTLEN = 3.
APPEND X_FIELDCAT TO I_FIELDCAT.
CLEAR X_FIELDCAT.
ENDFORM. "SUB_PREPARE_FIELDCATALOG
RFLG_ALL is passed with 'X' if the user shows all items. The application must ensure
that entries are not repeated in the item table.
to the information output by ALV (selection information, list status) at this event.8.
Slis_ev_foreign_top_of_page TYPE slis_formname VALUE
'FOREIGN_TOP_OF_PAGE'.
The Top-of-page event is always processed in ALV and is only passed to the caller via the
Callback mechanism. This is still the case if the caller, e.g. by a user action, processes a
branch list which was not formatted by ALV (e.g. a popup with additional information
about the list record selected and displayed by ALV).
In this case, top-of-page cannot be formatted by ALV analogously to the basic list, it must
be handled completely by the caller. The event top-of-page still occurs in ALV. When ALV
notices a top-of-page which was not caused by an ALV output, the form routine in
FOREIGN_TOP_OF_PAGE is called. 9. Slis_ev_foreign_end_of_page TYPE
slis_formname VALUE 'FOREIGN_END_OF_PAGE'.
The event end-of-page is always processed in ALV and only passed to the caller via
callback. This is still the case, e.g. when the caller processes a details list which was not
formatted by ALV (e.g. a popup with further information about selected list records which
were displayed by ALV).In this case, end-of-page cannot be formatted by ALV analogously
to the basic list, it must be handled completely by the caller. The event end-of-page still
occurs in ALV. When ALV notices an end-of-page that was not caused by an ALV output,
the form routine in FOREIGN_END_OF_PAGE is called.
10. Slis_ev_pf_status_set TYPE slis_formname VALUE 'PF_STATUS_SET'.
If a user list status is to be set, it must be done in the form routine assigned to this event.
The ALV function codes, which must not be active, are in the Parameter RT_EXTAB. This
table must be passed with the SET PF-STATUS command (with inactive user function
codes as well, if necessary).
The STANDARD status of the function group SALV should be used as a template for a
user-specific status. As this is a frequently used Callback event, its form routine can also be
passed directly in the interface in the IMPORTING parameter
I_CALLBACK_PF_STATUS_SET.11. Slis_ev_list_modify TYPE slis_formname
VALUE 'LIST_MODIFY'.
LIST_MODIFY USING R_TABNAME TYPE SLIS_TABNAME
Exceptions
11. Lights_fieldname TYPE slis_fieldname: Internal output table field containing the
codes of exceptions to be output.
Output table field code: '1' = red traffic light
'2' = yellow traffic light
'3' = green traffic light Fieldname for exception
Value set: SPACE, internal output table field name.
12. Lights_tabname TYPE slis_tabname: Name of the internal output table that contains
the field in the parameter LIGHTS_FIELDNAME. If LIGHTS_FIELDNAME is not empty,
this field must also be filled for hierarchical-sequential lists. Only relevant for hierarchical-
sequential lists.
Value set: SPACE, internal output table name.
13. Lights_rollname LIKE dfies-rollname: The documentation of this data element is
displayed when you call F1 help for an exception column.
Value set: SPACE, data element name.
14. Lights_condense (1) TYPE c : If a list record is output with 'red traffic light', each
Subtotal that includes this record is also output with 'red traffic light'.
Value set: SPACE, 'X'
'X' = the 'maximum' exception of the items in the subtotal is output at subtotal level.
Sums
15*. No_sumchoice* (1) TYPE c: This parameter allows the choice for summing up Only
by field catalog.
Value set: SPACE, 'X'
'X' = fields which are to be summed, passed by the calling program (FIELDCAT-DO_SUM
= 'X'). The user should not be able to change this value interactively.
16. No_totalline(1) TYPE c : Removes the option of having totals after sub-totals.
Value set: SPACE, 'X'
'X' = no total record is to be output. Subtotals can still be calculated and output. The fields
in the subtotals are flagged DO_SUM = 'X' in the field list.
17. No_subchoice(1) TYPE c : Does not allow the user to interactively change the field
chosen for subtotals.
Value set: SPACE, 'X'
'X' = value whose change triggers subtotals, provided by the calling program. The user
should not be able to change this value interactively.
26. Box_tabname TYPE slis_tabname: Name of the internal output table that contains the
field in the parameter BOX_FIELDNAME. If BOX_FIELDNAME is not empty, this field
must also be filled for hierarchical-sequential lists.
Value set: SPACE, internal output table name.
27. Box_rollname LIKE dd03p-rollname: rollname for checkbox
28. Expand_fieldname TYPE slis_fieldname: fieldname flag 'expand'. The user can show
or hide the items by clicking on the folder symbol (hotspot). If the items for a header entry
are only to be read by the calling program and passed to ALV when a header has been
expanded interactively, this can be controlled via the CALLBACK event
'ITEM_DATA_EXPAND'.
29. Hotspot_fieldname TYPE slis_fieldname: Used to make the fieldname flag hotspot.
30. No_input(1) TYPE c : The fields are only display fields.
Value set: SPACE, 'X'
'X' = all ready-for-input fields in a list are displayed as not ready-for-input. (Record
selection checkboxes and fields which can be made ready-for-input via the field list
parameter FIELDCAT-INPUT = 'X')
31. F2code LIKE sy-ucomm: To assign an ALV standard function code to double-click
(F2), assign the function code to this parameter. Ex.: to assign the ALV standard function
'Detail' ('&ETA') to F2.
=> LAYOUT-F2CODE = '&ETA'.
Value set: SPACE, function code
Display variants
42. Header_text (20) TYPE c: Text for header button. Only relevant for hierarchical-
sequential lists. You can toggle between display field and field list views via pushbuttons in
the display variant definition popup for hierarchical-sequential lists. The views refer to the
hierarchy level of the fields. This is technically a toggle between the header table and item
table fields.
Value set: SPACE, CHAR (20)
' ' = The header table field pushbutton text is 'Header' by default.
CHAR (20) = header table field pushbutton text.
43.item_text(20) TYPE c : Text for item button. Only relevant for hierarchical-sequential
lists. You can toggle the view between the display fields and the field list via pushbuttons in
the display variant definition popup for hierarchical-sequential lists. The views refer to the
hierarchy level of the fields. This is technically a toggle between the header table and item
table fields.
Value set: SPACE, CHAR (20)
' ' = The pushbutton text for the item table fields is 'Item' by default.
CHAR (20) = item table field pushbutton text.
44.default_ item(1) TYPE c : Items as default. Only relevant for hierarchical-sequential
lists.
Value set: SPACE, 'X'
' ' = The header table fields are displayed by default in the display variant definition popup.
The user can switch to the item table fields interactively.
'X' = the item table fields are displayed by default in the display variant Definition Popup.
The user can switch to the header table fields interactively.
Colour
45. Info_fieldname TYPE slis_fieldname: infofield for listoutput. A whole list record can
be colored individually using a color code in a column of the internal output table for the
record. Assign the name of the field containing the color code to this parameter.
Value set: SPACE, internal output table field name
The internal output table field must be of type CHAR(3).
The code must have the following syntax: 'Cxy':
C = color (all codes must start with 'C')
X = color number ('1'-'9')
Y = bold ('0' = off, '1' = on)
46. Coltab_fieldname TYPE slis_fieldname: Cells can be colored individually using a
color code which is contained in a column of the internal output table for the record
containing the cell. Assign the name of the field to this parameter.
Others
47. List_append(1) TYPE c : no call screen. It is only useful to output block-lists without
specifying the above modules if the number of list blocks exceeds, or may exceed, the
maximum number specified in the block module documentation. These operations are not
possible for user-defined block lists.
Example code :
I_LAYOUT-f2code = ws_fcode.
I_LAYOUT-zebra = 'X'.
I_LAYOUT-colwidth_optimize = 'X'.
I_LAYOUT-no_keyfix = 'X'.
I_LAYOUT-get_selinfos = 'X'.
I_LAYOUT-no_hotspot = 'X'.
I_LAYOUT-no_input = 'X'.
I_LAYOUT-hotspot_fieldname = FIELDNAME.
I_LAYOUT-no_input = 'X'.
I_LAYOUT-no_vline = `X'.
I_LAYOUT-no_colhead = ' '.
I_LAYOUT-lights_condense = ` `.
I_LAYOUT-totals_text = ` `.
I_LAYOUT-subtotals_text = ` `.
I_LAYOUT-totals_only = ` `.
I_LAYOUT-key_hotspot = 'X'.
I_LAYOUT-detail_popup = 'X'.
I_LAYOUT-group_change_edit = 'X'.
I_LAYOUT-GROUP_BUTTONS = 'X'.
Step 6(Pass Selection-screen Information)
This step is required to get the selection screen information in the report output.
The prerequisite for this is to set the parameter LAYOUT-GET_SELINFOS of the
IMPORTING structure.
o mode: 'R' = only the entries passed in the internal table IS_SEL_HIDE-
T_ENTRIES
Are output in the pop up. Selection info, which the list tool read in the selection screen
(when called by a report with a selection screen), is replaced by the values passed.
'S' = the selection info which the list tool read in the selection screen of the calling report
are modified by the entries in the table IS_SEL_HIDE-T_ENTRIES.
v t_entries: Selection info table
v t_entries-mode: 'A' = output the selection info for the current table record in the info
popup.
§ 'D' = do not output select option or SELNAME parameter selection info in the
popup.
v t_entries-selname: (only used in t_entries-mode = 'D') : Name of the select option or
parameter. The following table fields are only used in t_entries-mode = 'A'. They contain
the selection information to be added.
- t_entries-field: DDIC field name of the field for which selection information is to be
output.
- If t_entries-field and t_entries-table have been entered, this text is taken from DDIC.
The final step in the output of the report is the use of two ALV functions modules.1.
REUSE_ALV_FIELDCATALOG_MERGE
2. REUSE_ALV_LIST_DISPLAY
The first function module is used to pass the field catalog to the report output and merge it
with the internal output table.
FUNCTION reuse_alv_fieldcatalog_merge.
*"---------------------------------------------------------------------
*"*"Lokale Schnittstelle:
*" IMPORTING
*" CHANGING
*" EXCEPTIONS
*" INCONSISTENT_INTERFACE
*" PROGRAM_ERROR
*"---------------------------------------------------------------------
Import parameters
The other function module is used to display the internal output table with the contents
FUNCTION reuse_alv_list_display.
*"----------------------------------------------------------------------
*"*"Lokale Schnittstelle:
" IMPORTING
" EXPORTING
*" VALUE(E_EXIT_CAUSED_BY_CALLER)
" TABLES
*" T_OUTTAB
" EXCEPTIONS
Notes
v All interactions performed on the list refer directly to the internal output table. Sorting
the list, for example, also involves a resorting of the internal output table passed (since it
was passed by reference).
v An important factor determining the usability of the tool or of various generic
functions (totals, subtotals) is the expected amount of data to be displayed.
Parameters :
- I_INTERFACE_CHECK
- I_BYPASSING_BUFFER
- I_BUFFER_ACTIVE
- I_CALLBACK_PROGRAM
- I_CALLBACK_PF_STATUS_SET
- I_CALLBACK_USER_COMMAND
- I_CALLBACK_TOP_OF_PAGE
- I_CALLBACK_HTML_TOP_OF_PAGE
- I_CALLBACK_HTML_END_OF_LIST
- I_STRUCTURE_NAME
- I_BACKGROUND_ID
- I_GRID_TITLE
- I_GRID_SETTINGS
- IS_LAYOUT
- IT_FIELDCAT
- IT_EXCLUDING
- IT_SPECIAL_GROUPS
- IT_SORT
- IT_FILTER
- IS_SEL_HIDE
- I_DEFAULT
- I_SAVE
- IS_VARIANT
- IT_EVENTS
- IT_EVENT_EXIT
- IS_PRINT
- IS_REPREP_ID
- I_SCREEN_START_COLUMN
- I_SCREEN_START_LINE
- I_SCREEN_END_COLUMN
- I_SCREEN_END_LINE
- IT_ALV_GRAPHICS
- IT_ADD_FIELDCAT
- IT_HYPERLINK
- E_EXIT_CAUSED_BY_CALLER
- ES_EXIT_CAUSED_BY_USER
Passing an EXIT routine indicates to the ALV that the caller wants to set a self-defined
user status. As a result, the default status of the ALV is not set. The interface of the form
routine specified must be defined as follows:
FORM set_pf_status USING rt_extab TYPE slis_t_extab Table RT_EXTAB contains the
function codes that would be hidden on the standard user interface.
If the caller wants to use a self-defined user interface (for example, in order to provide
additional list functions or use existing functions), we recommend that you copy standard
status STANDARD from function group SALV and modify it accordingly. ALV standard
function codes always start with '&'.
See also the documentation on parameter I_CALLBACK_USER_COMMAND.
If a self-defined user interface is used that includes function codes of the standard user
interface, the function codes of the excluding table passed should be taken into account.
This means that the user status should generally be set as follows:
SET PF-STATUS user status EXCLUDING rt_extab.
Application functions can be added to excluding table rt_extab if they are to be disabled.
The routine is called whenever the standard user interface would be set with SET PF-
STATUS.
Default
If no EXIT routine is specified, the ALV sets a status that corresponds to status
STANDARD of function group SALV.
I_CALLBACK_USER_COMMAND: EXIT routine for command handling
Description
Passing an EXIT routine indicates to the ALV that the application wants to respond to
certain function codes.
Generally, these are function codes that are unknown to the ALV (that is, are not standard
ALV functions) and that were defined and set by a user status.
See also the documentation on parameter I_CALLBACK_PF_STATUS_SET.
The interface of the form routine specified must be defined as follows:
FORM user_command USING r_ucomm LIKE sy-ucomm rs_selfield TYPE
slis_selfield.
Parameter R_UCOMM contains the function code triggered.
Structure RS_SELFIELD contains the following information:
I_CALLBACK_HTML_TOP_OF_PAGE
Control title
Description : Specifies the title of the control. This text is displayed above the
grid. I_GRID_SETTINGS
Grid settings
Description
If Top-of-Page or End-of-List are output online, these areas are displayed in a splitter
above or below the list. Using I_GRID_SETTINGS you can reduce the default size to 0%.
To do this, you use two fields:
COLL_TOP_P: Sets Top-of-Page to 0%
COLL_END_L: Sets End-of-List to 0% IS_LAYOUT
categories:
Display options
Exceptions
Totals
Interaction
Detail screen
Color
Other
Note the section on pre-defined settings. Display options
colwidth_optimize Value range: SPACE, 'X'
X' = Optimizes the column width to ensure that the content is displayed
completely.
Exceptions
lights_fieldname
Value range: SPACE, field name of the internal output table field of the internal output
table that contains the coding of the exceptions to be output .
Coding in the field of the output table:
Value range: SPACE, table name of the internal output table Table name of the internal
output table that contains the specified field in parameter
LIGHTS_FIELDNAME. lights_rollname
The documentation defined for this data element is displayed when the F1 help for an
exception column is called. lights_condense
'X' = The system outputs the 'maximum' exception of the items included in the total at
subtotal level.
Example: If a list row is output with a 'red traffic light', each subtotal included in this list
row is also displayed with a 'red traffic light'. Totals
no_sumchoice
'X' = Value fields for which totals are calculated are communicated by the calling
program (FIELDCAT-DO_SUM = 'X'). The user should not be allowed to change this pre-
defined setting interactively.
no_totalline
'X' = No overall totals line should be displayed. If required, subtotals can nevertheless
be calculated and displayed. The fields which are used for calculating subtotals are to be
marked with
no_subtotals
totals_only
Prerequisite: IMPORTING parameter IT_SORT is filled accordingly with the sort criteria
and the subtotals indicator.
- totals_text
that the column width of the first output column is large enough. If the column width
is not sufficient, only the asterisks are displayed.
'string' = After the totals level indicated visually by means of '*', the system displays
the string passed provided that the column width is sufficient.
subtotals_text
Value range: SPACE, string (not more than 60) ' ' = In the first column, the standard
system indicates the totals level by displaying an adequate number of '*' for the subtotals
line. After the asterisks, the system displays the string *total* provided that the column
width of the first output column is large enough and the characteristic of the first column is
not a subtotal criterion. If the column width is not sufficient, only the asterisks are
displayed.
'string' = After the totals level indicated visually by means of '*', the system displays the
string passed provided that the column width is sufficient and the characteristic of the first
column is not a subtotal criterion.
If the characteristic is a subtotal criterion, the system repeats the characteristic value for
which subtotals were calculated after the totals level provided that the column width is
sufficient.
numc_sum
' ' = In the standard system, it is not possible to calculate totals for NUMC fields.
'X' = It is generally possible to calculate totals for NUMC fields. If this indicator is set, you
can use parameter FIELDCAT-NO_SUM to control for each NUMC column whether totals
can be calculated or not. Interaction
- box_fieldname
Value range: SPACE, field name of the internal output table. If the list should have
checkboxes at the beginning of each list row (to allow the user to select multiple rows at
once), you must fill this parameter with the field name of the internal output table that
represents the selection column for selecting rows with the help of checkboxes. The field is
always displayed as a checkbox at the beginning of each list row without a list heading.
box_tabname
If you want to assign a standard ALV function code to a double-click (F2), you must
assign this function code to this parameter.
('&ETA') to F2.
You leave the standard ALV function code for F2 '&IC1' in the copied interface of the
application. However, you want to have a function executed with F2 that is not assigned to
F2 in the interface
(standard ALV function or application function). You must communicate this function
code to the ALV using parameter F2CODE. Case 2:
You remove the standard ALV function code for F2 '&IC1' from the interface of the
application and use another function code instead (standard ALV function or application
function). You must
confirmation_prompt
key_hotspot
The columns defined as key fields in the field catalog (FIELDCAT-KEY = 'X') are output
as a hotspot. This means that single-clicking a key field (highlighted in color in the list)
triggers the function assigned to F2.
reprep
The list module acts as a potential sender in the report/report interface (interface
initialization, if required).
The calling report/module pool entered in I_CALLBACK_PROGRAM is declared to the
report/report interface as the sender report with type RT=Report. If the sender report is
assigned to receiver reports in table TRSTI, function code BEBx is set to active. ( x =
function code class) Example:
If sender RKTFGS15 has a receiver assignment for Report Writer report group 7KOI
with function code class '3' (SAP setting), this receiver report group is called through the
report/report interface
at function code 'BEB3'. The selections passed to the report/report interface are the
report selections and the key information of the selected row.
For more information on the report/report interface, see the documentation on function
group 'RSTI'.Detail screen
detail_initial_lines
' ' = In the detail view, the system displays only fields whose content is not set to
initial.
'X' = Initial field contents are also displayed on the detail screen.
detail_titlebar
' ' = The system displays 'Detail: Display' as the title of the detail screen.
'string' = The system displays the string passed as the title of the detail screen.
Color
info_fieldname
this parameter.
The field of the internal output table must be of type CHAR(3).
Note: The color of the key column is not affected. If you also want
to color the key column at row or cell level, you can use complex
coltab_fieldname
You can color cells individually by using a color code that is set for the row of the cells in a
column of the internal output table. You must assign the field name of the field with the
color code to this parameter.
The field of the internal output table must be of type SLIS_T_SPECIALCOL_ALV.
Principle: The field for the color code is filled in the row in which the cells to be colored
are located. The field then contains an internal table of the above structure that includes the
field names of the cells to be colored with the color code. The cell coordinates are therefore
derived from the row position in which the color code is written and the column
information contained in the color table. The row structure of the internal color table of
type SLIS_T_SPECIALCOL_ALV is as follows:
Farbtabelle-NAME = Field name of cell to be colored
Field catalog containing the field descriptions of the fields to be considered for the list
output (usually, this is a subset of the fields in the internal output table).
Basically, you need a field catalog for each list output that uses the ALV.
The field catalog associated with the output table is generated in the code of the caller.
You can generate the field catalog automatically or semi-automatically by calling function
module
REUSE_ALV_FIELDCATALOG_MERGE.
See also the documentation on function module :
REUSE_ALV_FIELDCATALOG_MERGE.
The minimum values required for the field catalog are documented in the 'Default' section.
The caller can optionally use all other parameters to assign non-standard output attributes
to a field.
It is only in the following cases that you are not required to generate the field catalog and
pass it explicitly:
Field name of the field in the internal output table that is described by this field
catalog entry.
Reference to the Data Dictionary ref_fieldname (field name of the reference field)
Value range: SPACE, name of a field in the Data Dictionary Name of the referenced
field in the Data Dictionary.
This parameter is only required if the field in the internal output table that is described
by the current entry in the field catalog has a reference to the Data Dictionary (that is, is not
a program field) and if the field name in the internal output table is not identical to the field
name of the field in the Data Dictionary. If both field names are identical, it is sufficient to
specify the Data Dictionary structure or table in parameter FIELDCAT-REF_TABNAME.
- ref_tabname (field name of the reference table/structure)
Value range: SPACE, name of a structure or table in the Data Dictionary Structure or table
name of the referenced field in the Data Dictionary.
This parameter is only required if the field in the internal output table that is described by
the current entry in the field catalog has a reference to the Data Dictionary (that is, is not a
program field).
Reference to fields with currency units/units of measure
Each amount or quantity field of the internal output table whose decimal places are to be
displayed with the proper unit in the list output, must comply with the following
conventions:
- The field is of data type QUAN or CURR (internal type P).
(Physically, the field must actually belong to this data type.
Overriding the physical data type with parameter FIELDCAT-DATATYPE has no
effect.)
- There is one field in the internal output table that contains the relevant unit.
- There is also an entry for the unit field in the field catalog.
(If the unit should not be displayed as a column in the list and the user should not
be able to show the unit interactively, for example, because the unit is always unique and
therefore explicitly output by the caller in the list header, then you can assign parameter
FIELDCAT-TECH = 'X' to the field catalog entry for the unit field.
If a value field has a reference to a unit, this has the following effects when the list is
output:
- The decimal places are displayed with the proper unit.
- An initial value field with reference to a non-initial unit is displayed as '0'
(provided that FIELDCAT-NO_ZERO is initial). If unit-specific totals are calculated for
this value field, the unit is considered in the analysis of whether homogeneous units exist.
- An initial value field with reference to an initial unit is displayed as SPACE. If
unit-specific totals are calculated for this value field, the unit SPACE has no effect on the
homogeneity of the unit if the value field is initial.
- For non-initial value fields with initial unit, the unit SPACE is considered as a unit
when unit-specific totals are calculated.
Reference to the currency unit
- cfieldname (field name of the currency unit field)
Value range: SPACE, name of a field of the output table Only relevant to amount
columns with unit reference. Field name of the field in the internal output table that
contains the currency unit for the amount field FIELDCAT-FIELDNAME.
There must be a separate field catalog entry for the field specified in FIELDCAT-
CFIELDNAME.
Reference to the unit of measure
- qfieldname (field name of the unit of measure field)
Value range: SPACE, name of a field of the output table
Only relevant to quantity columns with unit reference.
Field name of the field in the internal output table that contains the unit of measure for the
amount field FIELDCAT-FIELDNAME.
There must be a separate field catalog entry for the field specified in FIELDCAT-
QFIELDNAME.
Output options for a column
- outputlen (column width)
Value range: 0 (initial), n
For fields with reference to the Data Dictionary you can leave this parameter set to initial.
For fields without reference to the Data Dictionary (program fields) you must set the
parameter to the desired field output length on the list (column width).
initial = The column width is derived from the output length of the referenced field
(domain) in the Data Dictionary.
n = The column width is n characters.
- key (key column)
Value range: SPACE, 'X'
'X' = Key field (colored output for key fields)
Key fields cannot be hidden interactively by the user.
Parameter FIELDCAT-NO_OUT must be left set to initial.
For exceptions, see the documentation on parameter FIELDCAT-KEY_SEL.
- key_sel (key column that can be hidden)
Value range: SPACE, 'X'
Only relevant if FIELDCAT-KEY = 'X'
Key field that can be hidden interactively by the user.
The user cannot interactively change the sequence of the key columns.
As with non-key fields, output control is performed using parameter FIELDCAT-
NO_OUT.
- no_out (field in the available fields list)
Value range: SPACE, 'X'
'X' = Field is not displayed on the current list.
The field is available to the user in the field list and can be interactively selected as a
display field.
At row level, the user can use the detail function to display the content of these fields.
See also the documentation on the 'Detail screen' section of parameter IS_LAYOUT.
- tech (technical field)
Value range: SPACE, 'X'
'X' = Technical field
The field cannot be output on the list and cannot be shown interactively by the user.
The field may only be used in the field catalog (not in IT_SORT, ...).
- emphasize (highlight column in color)
Value range: SPACE, 'X' or 'Cxyz' (x:'1'-'9'; y,z: '0'=off '1'=on)
'X' = The column is highlighted in the default color for color highlighting.
'Cxyz' = The column is highlighted in the coded color:
- C: Color (coding must start with C)
- x: Color number
- y: Intensified
- z: Inverse
- hotspot (column as hotspot)
Value range: SPACE, 'X'
'X' = The cells of the column are output as a hotspot.
- do_sum (calculate totals for column)
Value range: SPACE, 'X'
'X' = Totals are calculated for this field of the internal output table.
This function can also be used interactively by the user.
- no_sum (totals calculation not allowed)
Value range: SPACE, 'X'
'X' = No totals may be calculated for this field although the data type of the field
allows totalling.
Formatting column contents
- icon (icon)
Value range: SPACE, 'X'
'X' = The column contents are displayed as an icon.
The column contents of the internal output table must consist of valid icon strings (
(xx)).
The caller should consider the problem of printing icons.
- symbol (symbol)
Value range: SPACE, 'X'
'X' = The column contents are output as a symbol.
The column contents of the internal output table must consist of valid symbol
characters.
The caller should consider the problem of printing symbols.
Although symbols can generally be printed, they are not always shown correctly depending
on the printer configuration.
- just (justification)
Value range: SPACE, 'R', 'L', 'C'
Only relevant to fields of data type CHAR or NUMC
' ' = Default justification according to data type
'R' = Right-justified output
'L' = Left-justified output
'C' = Centered output
The justification of the column header depends on the justification of the column
contents. You cannot justify the column header independently of the column contents.
- lzero (leading zeros)
Value range: SPACE, 'X'
Only relevant to fields of data type NUMC
By default, NUMC fields are output in the ALV right-justified without leading zeros.
'X' = Output with leading zeros
- no_sign (no +/- sign)
Value range: SPACE, 'X'
Only relevant to value fields
'X' = Value output without +/- signs.
- no_zero (suppress zeros)
Value range: SPACE, 'X'
Only relevant to value fields
'X' = Supress zeros
- edit_mask (field formatting)
Value range: SPACE, mask
mask = See documentation on the WRITE formatting option
USING EDIT MASK mask
Using mask = '== conv' you can force an output conversion conv.
Texts
The following parameters for texts are always required for program fields without
reference to the Data Dictionary.
For fields with reference to the Data Dictionary, the texts are retrieved from the Data
Dictionary. If you do not want this, you can fill the text parameters also for fields with
reference to the Data Dictionary. If you do this, the corresponding texts from the Data
Dictionary will be ignored.
If the user changes the column width interactively, the text with the appropriate
length is always used as the column header.
If the user optimizes the column width interactively, both the field contents and the
column headings are considered for the list output:
If all field contents are shorter than the shortest column heading, the column width is
set based on the column heading.
The long field label is also used in the dialog boxes for defining the display variant,
the sort order, and so on.
- seltext_l (long field label)
- seltext_m (medium field label)
- seltext_s (short field label)
- reptext_ddic (heading)
Same as the 'heading' for data element maintenance.
When the list is output, the system does not necessarily retrieve the text stored here, but
uses the text that fits best.
- ddictxt (determine text)
Value range: SPACE, 'L', 'M', 'S', 'R'
Using possible values 'L', 'M', 'S', 'R' you can predefine the keyword that should
always be retrieved as the column header. If the column width is changed, the system tries
to find a heading that fits the new output width.
Parameter for program fields without reference to the Data Dictionary
See also the parameter in the 'Texts' section.
- datatype (data type)
Value range: SPACE, data type from the Data Dictionary (CHAR, NUMC,...)
Only relevant to fields without reference to the Data Dictionary. Data type of program
field
- ddic_outputlen (external output length)
Value range: 0 (initial), n
Only relevant to fields without reference to the Data Dictionary whose output should
nevertheless be modified using a conversion exit.
Prerequisites:
- FIELDCAT-EDIT_MASK = '==conv'
See also the documentation on parameter FIELDCAT-EDIT_MASK
- FIELDCAT-INTLEN = n
See documentation on parameter FIELDCAT-INTLEN
n = Field output length of the external display
The column width FIELDCAT-OUTPUTLEN must not be equivalent to the output
length of the external display (FIELDCAT-DDIC_OUTPUTLEN).
o intlen (internal output length)
Value range: 0 (initial), n
Only relevant to fields without reference to the Data Dictionary whose output should
nevertheless be modified using a conversion exit.
Prerequisites:
- FIELDCAT-EDIT_MASK = '==conv'
See also the documentation on parameter FIELDCAT-EDIT_MASK
- FIELDCAT-DDIC_OUTPUTLEN = n
See also the documentation on parameter FIELDCAT-DDIC_OUTPUTLEN
n = Field output length of the internal display
o rollname (data element)
Value range: SPACE, name of a data element from the Data Dictionary
You can use this parameter to provide an F1 help for a program field without reference
to the Data Dictionary or to provide an F1 help other than that of the Data Dictionary for a
field with reference to the Data Dictionary.
When the F1 help is called for this field, the documentation for the data element
assigned is displayed.
If, for fields with reference to the Data Dictionary,
FIELDCAT-ROLLNAME is initial, the documentation for the data element of the
referenced field in the Data Dictionary is displayed.
Other
o sp_group (field group key)
Value range: SPACE, CHAR(1)
Key for grouping fields
You assign the key to the group description using parameter
IT_SPECIAL_GROUPS (see also the documentation on parameter
IT_SPECIAL_GROUPS).
If you define such an assignment in the field catalog using
IT_SPECIAL_GROUPS, the fields in the field list of the display variant dialog box are
grouped accordingly.
o reprep (selection criterion of the report/report interface)
Value range: SPACE, 'X'
Prerequisites:
- The report/report interface exists in the system.
(function group RSTI, table TRSTI)
- Parameter LAYOUT-REPREP = 'X'
(See also the documentation on parameter
LAYOUT-REPREP of IMPORTING parameter IS_LAYOUT)
'X' = If the report/report interface is called, the value of this field is passed as a
selection criterion in the selected branch line of the interface.
Default
o For internal table fields with reference to a field defined in the
For internal table fields without reference to the Data Dictionary (program fields), it
is normally sufficient to make the following specifications: - fieldname
- outputlen
- datatype (without data type, character is the default)
- seltext_s
- seltext_l
Note:
If you assign a data element to parameter ROLLNAME, you can, for example,
implement an F1 help for program fields.
IT_EXCLUDING
Table of inactive function codes
Description
Optional IMPORTING parameter IT_EXCLUDING is an internal table. You must
only fill this table if the caller uses the standard interface of the list tool but does not
need certain interface functions and therefore wants to disable them.
In this case, you must enter the function codes of these standard functions into the
table.
IT_SORT
Sort criteria for first list display
Description
Using internal table IT_SORT, the caller determines the sort order and/or the
subtotalling of the basic list.
The following fields of this internal table must be filled:
o spos : Sort order
o fieldname : Field name in the internal output table
o up : 'X' = Sorted in ascending order
o down : 'X' = Sorted in descending order
o subtot : 'X' = Subtotals for control level changes
o comp (INTERNAL USE ONLY)
o expa
Perquisites:
IT_SORT-SUBTOT = 'X', that is, the sort criterion is also the subtotals
criterion.
If no complete breakdown but only a breakdown to totals level n that can be further
expanded by the user should be displayed when the list is output for the first time,
you must set the indicator for the totals level criterion of level n.
IT_FILTER
Filter criteria for first list output
Description
Table with filter criteria
Using this parameter, you can pass on filter criteria resulting from explicitly
loading a display variant in advance, for example, to list output.
This table should never be set up 'manually'.
IS_SEL_HIDE
Selection information modification
Description
This parameter is currently not supported!
Only relevant if layout parameter LAYOUT-GET_SELINFOS of IMPORTING
structure IS_LAYOUT is set.
Complex type for modifying information displayed on the selection dialog box:
o mode: 'R' = Only entries passed in internal table IS_SEL_HIDE-
T_ENTRIES are output on the dialog box. Selection information obtained by the list tool
by reading the selection screen again (only if the report is called with selection screen) are
replaced by the entries passed.
'S' = The selection information obtained by the list tool by reading the
selection screen of the calling report again, are modified by the entries of table
IS_SEL_HIDE-T_ENTRIES.
o t_entries: Table with selection information
o t_entries-mode: 'A' = Display selection information of the current table row on the
information dialog box.
'D' = Do not display selection information of the Select option or of
parameter SELNAME on the dialog box.
o t_entries-selname: (required only if t_entries-mode = 'D') name of Select option or
parameter
The following table fields are only required if t_entries-mode = 'A'.
They contain the selection information to be added.
o t_entries-field: DDIC field name of the field for which selection information is to be
displayed
o t_entries-table: DDIC table name of t_entries-field.
o t_entries-stext: Field description on the information dialog box.
If t_entries-field and t_entries-table were filled, this text is taken from the DDIC.
o t_entries-valuf: Selection condition from-value (external format)
o t_entries-valut: Selection condition to-value (external format)
o t_entries-sign0: (I)nclusive (E)xclusive
o t_entries-optio: All values of the option field of the Select option are allowed.
The remaining fields are used internally and are irrelevant to the caller.
I_DEFAULT
Initial variant active/inactive logic
Description
Initial variant maintenance active/inactive. .
Prerequisite: Parameter IS_VARIANT is filled accordingly.
See also the documentation on the IMPORTING parameter IS_VARIANT.
Value Range
SPACE = Definition of initial variants not allowed
'X' = Definition of initial variants allowed
Default : SPACE
I_SAVE
Variants can be saved
Description
Controls the save mode
Prerequisite:
Parameter IS_VARIANT is filled accordingly.
See also the documentation on IMPORTING parameter IS_VARIANT.
Value Range
o ' ' = Display variants cannot be saved
Defined display variants (such as delivered display variants) can be selected for
presentation regardless of this indicator. However, changes cannot be saved.
o 'X' = Standard save mode
Display variants can be saved as standard display variants.
Saving display variants as user-specific is not possible.
o 'U' = User-specific save mode
Display variants can only be saved as user-specific.
o 'A' = Standard and user-specific save mode
Display variants can be saved both as user-specific and as standard variants. Users
make their choice on the dialog box for saving the display variant.
Default : SPACE .
IS_VARIANT
Variant information
Description
This structure is only relevant if display variants are to be saved and/or read.
Variant information including the name of the list variant that is used to output the list.
To allow display variants to be read within the ALV, you must specify the access path
using fields REPORT (required field), HANDLE (optional field) and/or LOG_GROUP
(optional field).
If you also want to allow display variants to be saved, you must additionally fill
parameter I_SAVE accordingly.
See also the documentation on IMPORTING parameter I_SAVE.
A variant is uniquely described through:
o The program to which the variant is assigned (REPORT)
o The handle (HANDLE), if, for example, multiple lists with different structures and
data are called in a program (I_CALLBACK_PROGRAM).
The handle is a CHAR(4) field that must be uniquely defined and describes the
assignment of the call to the current structure of the internal output table.
Example:
Depending on the user interaction, several types of lists can be output in program x.
The user should be able to define display variants for each type of list.
You provide this function to the user by assigning a HANDLE to each list. If variants for
the program and the handle are saved, the handle must not be modified any more.
o The logical group, if, for example, the same list is created with different settings
through various transactions (LOG_GROUP).
The logical group is a CHAR(4) that must be uniquely defined and specifies the
assignment.
Example:
Program x is called through transactions T1 and T2. Depending on the transaction code, the
fields available to the user through the field catalog differ in their assignment to different
logical groups.
If variants for the program and the logical group are saved, the logical group must not be
modified any more.
o The user name, if user-specific variants are saved (USERNAME).
You do not have to fill this parameter manually since the variant name is unique.
o The variant name (VARIANT).
You only have to fill this parameter if this structure is to be used to read a concrete
variant and the list is to be output with this variant.
Value Range
To call a list with a variant, you must specify the above fields.
Default
If the structure is initial, but saving is active (I_SAVE is not initial), then IS_VARIANT-
REPORT = I_CALLBACK_PROGRAM is set.
For a possible entries help for variants, function module REUSE_ALV_VARIANT_F4 is
available.
Example Code
WS_REPNAME = SY-REPID.
CALL FUNCTION 'REUSE_ALV_FIELDCATALOG_MERGE'
EXPORTING
I_PROGRAM_NAME = WS_REPNAME
I_INTERNAL_TABNAME = Internal output table field name
I_INCLNAME = WS_REPNAME
CHANGING
CT_FIELDCAT = I_FIELDTAB.
IF SY-SUBRC <> 0.
WRITE: 'SY-SUBRC: ', SY-SUBRC, 'REUSE_ALV_FIELDCATALOG_MERGE'.
ENDIF.
CALL FUNCTION 'REUSE_ALV_LIST_DISPLAY'
EXPORTING
I_CALLBACK_PROGRAM = WS_REPNAME
I_STRUCTURE_NAME = Internal output table field name
IS_LAYOUT = I_LAYOUT
IT_FIELDCAT = I_FIELDTAB
I_DEFAULT = 'A'
I_SAVE = 'A'
IS_VARIANT = 'X'
IT_EVENTS = I_EVENTS[]
IT_SORT = I_SORT
IS_SEL_HIDE = I_SELINFO
TABLES
T_OUTTAB = Internal output table field name.
IF SY-SUBRC <> 0.
WRITE: 'SY-SUBRC: ', SY-SUBRC, 'REUSE_ALV_LIST_DISPLAY'.
ENDIF
Using other function module 'REUSE_ALV_GRID_DISPLAY' can help us get list output
in the form of a grid and also attach logos to the report output.
Sample code
1 Simple list output:
REPORT Y_DEMO_ALV NO STANDARD PAGE HEADING.
* Data to be displayed
DATA: I_SFLIGHT TYPE TABLE OF SFLIGHT.
*---------------------------------------------------------------------*
* Selection
SELECT * FROM SFLIGHT INTO TABLE I_SFLIGHT.
* Call ABAP List Viewer (ALV)
CALL FUNCTION 'REUSE_ALV_LIST_DISPLAY'
EXPORTING
I_STRUCTURE_NAME = 'SFLIGHT'
TABLES
T_OUTTAB = I_SFLIGHT.
2.Simple grid output:
REPORT Y_DEMO_ALV_1.
*
* Data to be displayed
DATA: I_SFLIGHT TYPE TABLE OF SFLIGHT.
*---------------------------------------------------------------------*
* Selection
SELECT * FROM SFLIGHT INTO TABLE I_SFLIGHT.
* Call ABAP List Viewer (ALV)
CALL FUNCTION 'REUSE_ALV_GRID_DISPLAY'
EXPORTING
I_STRUCTURE_NAME = 'SFLIGHT'
TABLES
T_OUTTAB = I_SFLIGHT.
3. Demo for 'REUSE_ALV_POPUP_TO_SELECT'
REPORT y_demo_alv_3.
TYPE-POOLS: slis.
DATA: BEGIN OF i_outtab OCCURS 0.
INCLUDE STRUCTURE sflight.
DATA: w_chk TYPE c. "For multiple selection
DATA: END OF i_outtab.
* I_OUTTAB TYPE SFLIGHT OCCURS 0,
DATA: i_private TYPE slis_data_caller_exit,
i_selfield TYPE slis_selfield,
W_exit(1) TYPE c.
PARAMETERS: p_title TYPE sy-title.
START-OF-SELECTION.
SELECT * FROM sflight INTO TABLE i_outtab.
CALL FUNCTION 'REUSE_ALV_POPUP_TO_SELECT'
EXPORTING
i_title = p_title
i_selection = 'X'
i_zebra = 'X'
* I_SCREEN_START_COLUMN =0
* I_SCREEN_START_LINE =0
* I_SCREEN_END_COLUMN =0
* I_SCREEN_END_LINE =0
i_checkbox_fieldname = 'W_CHK'
* I_LINEMARK_FIELDNAME =
* I_SCROLL_TO_SEL_LINE = 'X'
i_tabname = 'I_OUTTAB'
i_structure_name = 'SFLIGHT'
* IT_FIELDCAT =
* IT_EXCLUDING =
* I_CALLBACK_PROGRAM =
* I_CALLBACK_USER_COMMAND =
* IS_PRIVATE = I_PRIVATE
IMPORTING
es_selfield = i_selfield
e_exit = w_exit
TABLES
t_outtab = i_outtab
EXCEPTIONS
program_error =1
OTHERS = 2.
IF sy-subrc <> 0.
* MESSAGE i000(0k) WITH sy-subrc.
ENDIF.
*****the internal table is modified with a cross sign for marking the rows selected
LOOP AT i_outtab WHERE w_chk = 'X'.
WRITE: / i_outtab-carrid, i_outtab-price.
ENDLOOP.
*&---------------------------------------------------------------------*
*& Form SUB_SHOW_ALV_LIST
*&---------------------------------------------------------------------*
* Shows ALV list in grid form
*----------------------------------------------------------------------*
form SUB_SHOW_ALV_LIST.
CALL FUNCTION 'REUSE_ALV_GRID_DISPLAY'
EXPORTING
I_CALLBACK_PROGRAM = V_REPID "* Name of the program
I_GRID_TITLE = 'Details of Storing' "* title
I_callback_pf_status_set = 'PF_STATUS_SET' "* calls subroutine :
PF_STATUS_SET
i_callback_user_command = 'USER_COMMAND' "* Calls subroutine :
user_command
IS_LAYOUT = STRUCT_LAYOUT "* Overall structure of
the report
IT_FIELDCAT = I_FIELDCAT "* Passes the field catg
internal table
IT_SORT = IT_SORT "* Passes the sort
sequence internal table
I_DEFAULT = 'X'
I_SAVE = 'A'
IS_VARIANT = i_variant1
* fetches different events into internal table i_events
it_events = i_events[]
TABLES
* Passes data table for ALV display
T_OUTTAB = I_TAB
EXCEPTIONS
PROGRAM_ERROR =1
OTHERS = 2.
IF SY-SUBRC <> 0.
* MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO
* WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.
ENDIF.
endform. " SUB_SHOW_ALV_LIST
*&---------------------------------------------------------------------*
*& Form set_status
*&---------------------------------------------------------------------*
* Form used to set the Custom pf-status of the List Display
*----------------------------------------------------------------------*
* rt_extab :
*----------------------------------------------------------------------*
FORM pf_status_set USING i_rt_extab TYPE slis_t_extab.
data : x_extab type slis_extab.
x_extab-fcode = '&LFO'.
append x_extab to i_rt_extab.
* Pf-status STANDARD of program SAPLSALV is copied to ZSTANDARD of the
* current program and the pushbutton for Information (okcode=&LFO) is
* excluded
SET PF-STATUS 'ZSTANDARD' excluding i_rt_extab .
ENDFORM.
*&---------------------------------------------------------------------*
*& Form user_command
*&---------------------------------------------------------------------*
* Form used to handle USER_COMMAND events
*----------------------------------------------------------------------*
* rf_ucomm: Function Code
* rs : Internal Table containing the selection information.
*----------------------------------------------------------------------*
FORM user_command USING rf_ucomm LIKE sy-ucomm
rs TYPE slis_selfield.
data : v_mblnr like mseg-mblnr.
case rf_ucomm.
* A custom pushbutton for record deletion is set in the GUI status. When a record is
selected , the field BOC for that *record becomes 'X'.
* The records are traced and deleted and the fields are refreshed( rs of type slis_selfield is
refreshed)
when '&DEL'. "Print button clicked.
delete i_tab where box = 'X'.
rs-refresh = 'X'.
* When the user selects a row and presses the Select pushbutton ( user defined ) from the
application toolbar, the details * of the document will be shown in another ALV list
when '&SEL'.
PERFORM SUB_SELECT_DOCUMENT.
* set parameter id 'MBN' field i_tab-mblnr.
* call transaction 'MB03'.
* Ok code for double click is &IC1 for ALV report
when '&IC1'.
perform sub_hotspot.
endcase.
ENDFORM.
*&---------------------------------------------------------------------*
*& Form SUB_HOTSPOT
*&---------------------------------------------------------------------*
* text
*----------------------------------------------------------------------*
* --> p1 text
* <-- p2 text
*----------------------------------------------------------------------*
form SUB_HOTSPOT.
message i398(00) with 'Hello'.
endform. " SUB_HOTSPOT
*&---------------------------------------------------------------------*
*& Form SUB_VARIANT_F4
*&---------------------------------------------------------------------*
* Display a list of various variants of the report when the user presses F4 key in the variant
field
*------------------------------------------------------------------------*
form SUB_VARIANT_F4.
i_variant-report = sy-repid.
* Utilising the name of the report , this function module will search for a list of variants and
will fetch the selected one * into the parameter field for variants
CALL FUNCTION 'REUSE_ALV_VARIANT_F4'
EXPORTING
IS_VARIANT = I_VARIANT
I_SAVE = 'A'
I_DISPLAY_VIA_GRID = 'X'
IMPORTING
ES_VARIANT = I_VARIANT1
EXCEPTIONS
NOT_FOUND =1
PROGRAM_ERROR =2
OTHERS = 3.
IF SY-SUBRC = 0.
P_VAR = I_VARIANT1-VARIANT.
ENDIF.
ENDFORM. " SUB_VARIANT_F4
*&---------------------------------------------------------------------*
*& Form SUB_SELECT_DOCUMENT
*&---------------------------------------------------------------------*
form SUB_SELECT_DOCUMENT.
data : v_lines type i .
read table i_tab with key box = 'X'.
Select * from mseg INTO TABLE I_DOC WHERE MBLNR = I_TAB-MBLNR.
IF SY-SUBRC EQ 0 .
CALL FUNCTION 'REUSE_ALV_FIELDCATALOG_MERGE'
EXPORTING
I_PROGRAM_NAME = V_REPID
I_INTERNAL_TABNAME = 'I_DOC'
I_STRUCTURE_NAME = 'MSEG'
CHANGING
CT_FIELDCAT = I_FIELDCAT1
EXCEPTIONS
INCONSISTENT_INTERFACE =1
PROGRAM_ERROR =2
OTHERS = 3.
IF SY-SUBRC <> 0.
MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO
WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.
ENDIF.
clear struct_layout1.
STRUCT_layout1-colwidth_optimize = 'X'.
refresh it_sort.
clear it_sort.
*&---------------------------------------------------------------------*
*& Form SUB_EVENTTAB_BUILD
*&---------------------------------------------------------------------*
* Defines the event table
*&---------------------------------------------------------------------*
FORM sub_eventtab_build USING l_events TYPE slis_t_event.
DATA: ls_event TYPE slis_alv_event.
* Get the different events of the ALV
CALL FUNCTION 'REUSE_ALV_EVENTS_GET'
EXPORTING
i_list_type = 0
IMPORTING
et_events = l_events.
* Search the top of page events
READ TABLE l_events WITH KEY name = slis_ev_top_of_page INTO ls_event.
IF sy-subrc = 0.
MOVE 'TOP_OF_PAGE' TO ls_event-form.
APPEND ls_event TO l_events.
ENDIF.
endform. " SUB_EVENTTAB_BUILD
*&---------------------------------------------------------------------*
* FORM TOP_OF_PAGE *
*&---------------------------------------------------------------------*
* When TOP-OF-PAGE will be fired , this event will be called and it
* will use the contents of i_list_top_of_page for output in the header
*&---------------------------------------------------------------------*
FORM top_of_page.
CALL FUNCTION 'REUSE_ALV_COMMENTARY_WRITE'
EXPORTING
i_logo = 'ENJOYSAP_LOGO'
it_list_commentary = i_list_top_of_page.
ENDFORM.