ALV Easy Tutorial
ALV Easy Tutorial
ALV Easy Tutorial
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
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.
Sap standard tables types taken from the type pools are:
SLIS_LAYOUT_ALV,
SLIS_T_FIELDCAT_ALV
SLIS_T_LISTHEADER,
SLIS_T_EVENT,
SLIS_SELFIELD.
Internal tables to be used in the program declared based on the above table types
DATA: I_LAYOUT TYPE SLIS_LAYOUT_ALV,
I_FIELDTAB TYPE SLIS_T_FIELDCAT_ALV,
I_HEADING TYPE SLIS_T_LISTHEADER,
I_EVENTS TYPE SLIS_T_EVENT.
Example: -
REPORT YSUBALV.
*----------Declaration of variables-----------------*
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.
*EJECT
DATA : begin of i_doc occurs 0 .
INCLUDE STRUCTURE MSEG.
DATA : end of i_doc.
Sample code:
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.
*&---------------------------------------------------------------------*
*& Form SUB_VARIANT_INIT
*&---------------------------------------------------------------------*
* Display default variant
*----------------------------------------------------------------------*
form SUB_VARIANT_INIT.
I_VARIANT1-REPORT = SY-REPID.
*&---------------------------------------------------------------------*
*& 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.
* 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
A field catalog is prepared using the internal table (I_FIELDCAT) of type SLIS_T_FIELDCAT_ALV. Field catalog containing
descriptions of the list output fields (usually a subset of the internal output table fields).
A field catalog is required for every ALV list output to add desired functionality (i.e. Key, Hotspot, Specific headings, Justify,
Col. position etc) to certain fields of the output. If not mentioned specifically, then the defaults are taken. The possible values
and defaults are listed below.
The field catalog for the output table is built-up in the caller's coding. The build-up can
be completely or partially automated by calling the
REUSE_ALV_FIELDCATALOG_MERGE module.
The minimal field catalog is documented below. This can be done in a routine using a local variable. The user can use the
other optional parameters to assign output attributes to different fields in the output, which differ from the default.
A field catalog need not be built-up and passed explicitly only under the following conditions:
1. The internal table to be output has the same structure as a Data Dictionary structure which is referred to in the internal
table declaration using LIKE or INCLUDE STRUCTURE. In this case the attributes of the different fields is taken directly
from the table and the attributes (key fields, length, texts etc) need to state explicitly.
2. all fields in this structure are to be output
3. The structure name is passed to ALV in the parameter I_STRUCTURE_NAME of the function module
REUSE_ALV_LIST_DISPLAY.
All the values entered in the catalog are specific to the particular field whose name is entered in the fieldname FIELDNAME
of the fieldcat structure. The name of the table is also entered in the corr. Fieldname TABNAME of the structure.
- Row_pos (row position): Only relevant if the list output is to be multi-line (two or three lines) by default. So, this
attribute can be used maintain certain level of alignment in the output.
Value set: 0, 1 - 3
- Col_pos (column position): This parameter is relevant when the fields in the output are to be different from the
sequence of the fields in the internal table used for display. The parameter specifies the relative column position of the
field in the list output. The column order can be changed interactively by the user. If this parameter is initial for all field
catalog entries, columns appear in the internal table field sequence.
Value set: 0, 1 - 60
- Fieldname (field name): This is the name of the internal table field for which the parameters are passed in the
catalog.
Value set: internal output table field name (required parameter)
- 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.
- 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 unscrollable 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, in case 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 (hideable 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.
- 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.
- 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.
* First field to appear in ALV list
X_FIELDCAT-COL_POS = 1.
* Name of the internal table field
X_FIELDCAT-FIELDNAME = 'SYM'.
* Name of the internal table
X_FIELDCAT-TABNAME = 'I_TAB'.
* Heading for the field
X_FIELDCAT-SELTEXT_M = 'Stat'.
* The field is going to contain a symbol
x_fieldcat-symbol = 'X'.
* Append the specifications to the internal table for field catalog.
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.
* The field is centre(C for centre, R and L for left and
* right) justified
x_fieldcat-just = 'C'.
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.
* The field will be colored differently(Cxyz)
x_fieldcat-emphasize = 'C511'.
* Initially the field will be hidden
x_fieldcat-no_out = 'X'.
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.
* Summation is allowed for this field
x_fieldcat-do_sum = 'X'.
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-qfieldname = '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.
The next step is to build an event table, which are used for firing both user commands and the system dependent events i.e.
top of page, end of page etc.
A list of possible events is populated into an event table (I_EVENTS) when this table is passed from the function module
REUSE_ALV_EVENT_NAMES_GET. The return table from this function module contains all the possible events.
The function module contains following import and export parameters.
This table is of TYPE SLIS_T_EVENT and returns to the program the name of all the possible events.
The table structure contains the fields:
I_EVENTS-NAME: Name of the Callback event.
I_EVENTS-FORM: Name of the form routine that should be called in the calling program at the event.
This event table (I_EVENTS) is now checked with the desired constants. If the desired constant is found, then the
corresponding field for the FORM NAME is populated with the name of the routine containing the corresponding event.
Sample code:
FORMNAME_TOP_OF_PAGE TYPE SLIS_FORMNAME VALUE 'TOP_OF_PAGE',
FORMNAME_END_OF_PAGE TYPE SLIS_FORMNAME VALUE 'END_OF_PAGE', FORMNAME_USER_COMMAND
TYPE SLIS_FORMNAME VALUE 'USER_COMMAND'.
A layout is build for the report output list description USING the internal table declared above (I_LAYOUT).
Output list description structure.
The parameters are described under the following heads:
- Display options
- Exceptions
- Totals
- Interaction
- Detail screen
- Display variants (only for hierarchical-sequential lists)
- Color
- Other
The layout table is of type slis_layout_alv_spec and has the following fields:
Display options
1. Colwidth_optimize (1) TYPE c: This parameter optimizes the length of the different columns in the output. The width of
the different col. now depends on the max. Length of the data in the column.
Value set: SPACE, 'X'
'X' = optimizes the column width so that all contents are displayed completely.
3*. No_hotspot*(1) TYPE c : The headings of the report output are not output as hotspot.
Value set: SPACE, 'X'.
'X' = column headers are not output as hotspot
5. No_vline (1) TYPE c: The report output contains columns only separated by space and no lines. It is not relevant for:
hierarchical-sequential lists and multiple-line lists.
Value set: SPACE, 'X'.
'X' = columns separated by SPACE
6. No_min_linesize(1) TYPE c : The report line size is equal to the width of the list. It is not relevant for block lists.
Value set: SPACE, 'X'.
'X' = line size depends on list width
' ' = Line size is set to 80 or MIN_LINESIZE (if > 0) .
7. Min_linesize LIKE sy-linsz: The report output contains a minimum possible length of line. If initial min_linesize is set to 80
by default, then this parameter is used to customize it. The prerequisite for this is that the parameter no_min_linesize should
be ' '.
Value set: 0, 10 - 250
If the list is wider, the format uses the list width (maximum 250 or MAX_LINESIZE (if > 0)).
8. Max_linesize LIKE sy-linsz: The default max. Linesize is 250. To change this default value, this parameter can
interactively-define the maximum list width setting.
Value set: 0, 80 - 1020
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.
Interaction
25. Box_fieldname TYPE slis_fieldname: Fieldname for checkbox in the report output. If the list has checkboxes at the start
of records (for selecting several records), this parameter contains the internal output table field name indicated by the
checkbox selection column. The field is a checkbox at the start of list records without a list header.
Value set: SPACE, internal output table field name
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.
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.
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
33. Key_hotspot(1) TYPE c : The key fields are displayed as hotspot. The columns defined in the field catalog as key fields
(FIELDCAT-KEY = 'X') are output as hotspots, i.e. clicking on a key column (highlighted in color in the list) calls the function
under F2.
Value set: SPACE, 'X'.
35. Group_buttons (1) TYPE c : group-buttons for COL1 - COL5 . Group output fields via FIELDCAT-SP_GROUP in the
field list, and pass the group name to the list module in the interface parameter IT_SPECIAL_GROUPS.
Value set: SPACE, 'X'.
39. No_scrolling(1) TYPE c : Does not allow scrolling of the list to the right.
Value set: SPACE, 'X'.
Detailed screen
40. Detail_popup(1) TYPE c : show detail in popup.
Value set: SPACE, 'X'
' ' = List record detail display in full-screen mode, with top-of-page.
'X' = list record detail display in popup (without top-of-page).
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'.
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.
The parameters to be passed in the IS_SEL_HIDE table are:
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-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.
- t_entries-table: DDIC table names of t_entries-field.
- t_entries-stext: Field name in info popup.
- If t_entries-field and t_entries-table have been entered, this text is taken from DDIC.
- t_entries-valuf: Selection condition 'from' value (external format)
- t_entries-valut: Selection condition 'to' value (external format)
- t_entries-sign0: (I)nclusive (E)xclusive
- t_entries-option: All values of the select options Option field allowed.
The Table IT_SORT is populated with the sort criteria for the different fields.
The caller specifies the sorting and/or subtotaling of the basic list in the internal table IT_SORT.
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
*" VALUE(I_PROGRAM_NAME) LIKE SY-REPID OPTIONAL
*" VALUE(I_INTERNAL_TABNAME) TYPE SLIS_TABNAME OPTIONAL
*" VALUE(I_STRUCTURE_NAME) LIKE DD02L-TABNAME OPTIONAL
*" VALUE(I_CLIENT_NEVER_DISPLAY) TYPE SLIS_CHAR_1 default 'X'
*" VALUE(I_INCLNAME) LIKE TRDIR-NAME OPTIONAL
*" CHANGING
*" VALUE(CT_FIELDCAT) TYPE SLIS_T_FIELDCAT_ALV
*" EXCEPTIONS
*" INCONSISTENT_INTERFACE
*" PROGRAM_ERROR
*"---------------------------------------------------------------------
Import parameters
I_PROGRAM_NAME: Program in which the internal output table is declared and populated
I_INTERNAL_TABNAME: Internal output table name
I_STRUCTURE_NAME: Structure name (structure, table, and view)
I_CLIENT_NEVER_DISPL: Hide client fields default 'X'
I_INCLNAME: Data declarations include name
CHANGING parameter
CT_FIELDCAT: Field catalog with field descriptions
The variant based on a program-internal table should only be used for rapid prototyping since the following restrictions
apply:
1. Performance is affected since the code of the table definition must always be read and interpreted at
runtime.
2. Dictionary reference are only considered if the keywords LIKE or INCLUDE STRUCTURE (not TYPE) are used.
The other function module is used to display the internal output table with the contents
FUNCTION reuse_alv_list_display.
*"----------------------------------------------------------------------
*"*"Lokale Schnittstelle:
*" IMPORTING
*" VALUE(I_INTERFACE_CHECK) DEFAULT SPACE
*" VALUE(I_CALLBACK_PROGRAM) LIKE SY-REPID DEFAULT SPACE
*" VALUE(I_CALLBACK_PF_STATUS_SET) TYPE SLIS_FORMNAME
*" DEFAULT SPACE
*" VALUE(I_CALLBACK_USER_COMMAND) TYPE SLIS_FORMNAME
*" DEFAULT SPACE
*" VALUE(I_STRUCTURE_NAME) LIKE DD02L-TABNAME OPTIONAL
*" VALUE(IS_LAYOUT) TYPE SLIS_LAYOUT_ALV OPTIONAL
*" VALUE(IT_FIELDCAT) TYPE SLIS_T_FIELDCAT_ALV OPTIONAL
*" VALUE(IT_EXCLUDING) TYPE SLIS_T_EXTAB OPTIONAL
*" VALUE(IT_SPECIAL_GROUPS) TYPE SLIS_T_SP_GROUP_ALV
*" OPTIONAL
*" VALUE(IT_SORT) TYPE SLIS_T_SORTINFO_ALV OPTIONAL
*" VALUE(IT_FILTER) TYPE SLIS_T_FILTER_ALV OPTIONAL
*" VALUE(IS_SEL_HIDE) TYPE SLIS_SEL_HIDE_ALV OPTIONAL
*" VALUE(I_DEFAULT) DEFAULT 'X'
" VALUE(I_SAVE) DEFAULT SPACE
" VALUE(IS_VARIANT) LIKE DISVARIANT
" STRUCTURE DISVARIANT DEFAULT SPACE
" VALUE(IT_EVENTS) TYPE SLIS_T_EVENT OPTIONAL
" VALUE(IT_EVENT_EXIT) TYPE SLIS_T_EVENT_EXIT OPTIONAL
" VALUE(IS_PRINT) TYPE SLIS_PRINT_ALV OPTIONAL
" VALUE(IS_REPREP_ID) TYPE SLIS_REPREP_ID OPTIONAL
" VALUE(I_SCREEN_START_COLUMN) DEFAULT 0
" VALUE(I_SCREEN_START_LINE) DEFAULT 0
" VALUE(I_SCREEN_END_COLUMN) DEFAULT 0
" VALUE(I_SCREEN_END_LINE) DEFAULT 0
" EXPORTING
" VALUE(E_EXIT_CAUSED_BY_CALLER)
" VALUE(ES_EXIT_CAUSED_BY_USER) TYPE SLIS_EXIT_BY_USER
" TABLES
" T_OUTTAB
" EXCEPTIONS
" PROGRAM_ERROR
Import parameters
I_INTERFACE_CHECK: Interface consistency check log output.
I_CALLBACK_PROGRAM: Name of the calling program
I_CALLBACK_PF_STATUS_SET: Set EXIT routine to status.
I_CALLBACK_USER_COMMAND: EXIT routine for command handling
I_STRUCTURE_NAME: Internal output table structure name
IS_LAYOUT: List layout specifications
IT_FIELDCAT: Field catalog with field descriptions
IT_EXCLUDING: Table of inactive function codes
IT_SPECIAL_GROUPS: Grouping fields for column selection
IT_SORT: Sort criteria for first list display
IT_FILTER: Filter criteria for first list output
IS_SEL_HIDE : Selection information modification
I_DEFAULT: Initial variant active/inactive logic
I_SAVE: Variants can be saved
IS_VARIANT : Variant information
IT_EVENTS: Table of events to perform
IT_EVENT_EXIT : Standard fcode exit requests table
IS_PRINT: Print information
IS_REPREP_ID: Initialization keys for Re/Re interface
I_SCREEN_START_COLUMN: Coordinates for list in dialog box
I_SCREEN_START_LINE: Coordinates for list in dialog box
I_SCREEN_END_COLUMN: Coordinates for list in dialog box
I_SCREEN_END_LINE: Coordinates for list in dialog box
IT_EVENT_EXIT: Standard fcode exit requests table
IS_PRINT: Print information
IS_REPREP_ID: Initialization keys for Re/Re interface
I_SCREEN_START_COLUMN: Coordinates for list in dialog box
I_SCREEN_START_LINE: Coordinates for list in dialog box
I_SCREEN_END_COLUMN: Coordinates for list in dialog box
I_SCREEN_END_LINE: Coordinates for list in dialog box
Export parameters
E_EXIT_CAUSED_BY_CALLER: Delete list in CALLBACK_USER_COMMAND
ES_EXIT_CAUSED_BY_USER: How the user left the list Tables
T_OUTTAB: Table with data to be displayed ---mandatory
Process:
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
Program from which the function module is called and that contains the exit routines. The program should always be a
report, function group, module pool or form routine pool (it should not be an include).
Caution: Never pass SY-REPID directly at the interface. If field SY-REPID contains the desired program name, you must
absolutely assign this name to an auxiliary variable and pass this variable to the interface.
I_CALLBACK_PF_STATUS_SET: Set EXIT runtime to status
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:
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 '&'.
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
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.
The EXIT routine is called whenever a function unknown to the ALV is triggered or if the routine call before/after the
execution of a standard function code has been defined by interface parameter
IT_EVENT_EXIT.
The function code and the current cursor position are then passed on to the calling program through the EXIT routine.
If the user has selected multiple rows by selecting checkboxes, the output table field designated as the checkbox
contains the current state of the checkbox in the list.
I_CALLBACK_TOP_OF_PAGE
Description
If the caller specifies an EXIT routine, this routine must have the following form:
FORM top_of_page.
If module REUSE_ALV_COMMENTARY_WRITE cannot be used, you must use two parameters instead. In
I_CALLBACK_TOP_OF_PAGE you pass the form routine that is responsible for normal formatting in batch mode or in the
print preview mode. The form routine that is responsible for online
formatting, is passed in parameter I_CALLBACK_HTML_TOP_OF_PAGE. If one of these parameters is not filled, top-of-
page is not output in the respective mode.
I_CALLBACK_HTML_TOP_OF_PAGE
Description
If function module REUSE_ALV_COMMENTARY_WRITE is not used in the form for CALLBACK_TOP_OF_PAGE, the
form routine must be passed in parameter
I_CALLBACK_HTML_TOP_OF_PAGE for the online mode. The form should then
have the following format:
In the form, you can, for example, use methods of class CL_DD_DOCUMENT
to display text in HTML format.
I_CALLBACK_HTML_END_OF_LIST
Description
In this parameter, you can pass a form for the online handling of end-of-list. The form must have the followiong format:
I_STRUCTURE_NAME
Description
If the internal output table is defined through an ABAP Dictionary structure (INCLUDE STRUCTURE struct or LIKE
struct), you can automatically set up the field catalog by passing the structure name.
The field catalog is then internally set up for this structure as follows:
o All fields are on the list (NO_OUT = SPACE) except fields of data type CLNT.
o The key fields of the Dictionary structure are adopted in the field catalog as key fields.
o References to unit fields stored in the Dictionary are adopted provided that the reference fields are contained in the
structure.
o If you additionally pass a field catalog as parameter, the structure information is merged with this field catalog.
For more information on how to set up the field catalog automatically, see the documentation on function
module REUSE_ALV_FIELDCATALOG_MERGE.
I_GRID_TITLE
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:
IS_LAYOUT
List layout specifications
Description
Display options
Exceptions
Totals
Interaction
Detail screen
Color
Other
Display options
colwidth_optimize
zebra
no_vline
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 .
lights_tabname
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
Value range: SPACE, data element name
The documentation defined for this data element is displayed when the F1 help for an exception column is called.
lights_condense
Value range: SPACE, 'X'
'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
no_totalline
- no_subchoice
Value range: SPACE, 'X'
'X' = Characteristics at whose control level subtotals should be calculated are communicated by the calling
program. The user should not be allowed to change this pre-defined setting
interactively.
no_subtotals
totals_only
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
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
Value range: SPACE, table name of the internal output table
f2code
Case 1:
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
communicate this function code to the ALV using parameter F2CODE.
confirmation_prompt
key_hotspot
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
detail_titlebar
Color
info_fieldname
coltab_fieldname
Default
In many cases, the default layout settings can be kept so that you
frequently do not need to pass this structure with modified flags.
IT_FIELDCAT
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.
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:
The structure of the internal table to be output corresponds to a structure stored in the Data Dictionary and is referenced
with LIKE or INCLUDE STRUCTURE in the declaration of the internal table.
I_STRUCTURE_NAME.
See also the documentation on IMPORTNG parameter I_STRUCTURE_NAME.
Positioning
The parameter determines the relative column position of the field in the list output. The column sequence can
interactively be changed by the user. If this parameter is set to its initial value for each field catalog entry, the columns are
arranged in the order of the fields in the field catalog.
Identification
- 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.
- For non-initial value fields with initial unit, the unit SPACE
is considered as a unit when unit-specific totals are
calculated.
- x: Color number
- y: Intensified
- z: Inverse
- 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 ().
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
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.
- 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.
- 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).
- 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
Other
Default
- fieldname
- ref_tabname
Note:
All fields not explicitly mentioned here are either not relevant in this
context or are not released!
All other information is retrieved by the ALV from the Data Dictionary.
If you do not specify the relative column position (COL_POS), the fields
are output in the list in the order in which they were added to the
field catalog.
Priority rule:
Specifications made in the field catalog take priority over
specifications in the Data Dictionary.
For internal table fields without reference to the Data Dictionary
- fieldname
- outputlen
- seltext_s
- seltext_l
Note:
IT_EXCLUDING
Description
In this case, you must enter the function codes of these standard
functions into the table.
IT_SORT
Description
Using internal table IT_SORT, the caller determines the sort order
and/or the subtotalling of the basic list.
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
subtot
'X' = Subtotals for control level changes
o expa
Prequisite:
IT_SORT-SUBTOT = 'X', that is, the sort criterion is also the
subtotals criterion.
IT_FILTER
Description
Using this parameter, you can pass on filter criteria resulting from
explicitly loading a display variant in advance, for example, to list
output.
Description
The remaining fields are used internally and are irrelevant to the
caller.
I_DEFAULT
Description
Value Range
Default : SPACE
I_SAVE
Variants can be saved
Description
Value Range
Default : SPACE .
IS_VARIANT
Variant information
Description
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 acess path using fields REPORT (required field), HANDLE (optional
field) and/or LOG_GROUP (optional field).
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.
To call a list with a variant, you must specify the above fields.
Default
I_SCREEN_START_COLUMN
I_SCREEN_START_LINE
Only required if the list is to be output in a dialog box. I_SCREEN_END_COLUMN
I_SCREEN_END_LINE
Example Code
WS_REPNAME = SY-REPID.
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
*---------------------------------------------------------------------*
* Selection
SELECT * FROM SFLIGHT INTO TABLE I_SFLIGHT.
REPORT Y_DEMO_ALV_1.
*
* Data to be displayed
DATA: I_SFLIGHT TYPE TABLE OF SFLIGHT.
*---------------------------------------------------------------------*
* Selection
SELECT * FROM SFLIGHT INTO TABLE I_SFLIGHT.
REPORT y_demo_alv_3.
TYPE-POOLS: slis.
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
REPORT YSUBALV.
*----------Declaration of variables-----------------*
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.
*EJECT
DATA : begin of i_doc occurs 0 .
INCLUDE STRUCTURE MSEG.
DATA : end of i_doc.
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.
START-OF-SELECTION.
* Prepare field catalog for the main report. State the name of
* the field , name of internal table , various formatting options etc
PERFORM SUB_PREPARE_FIELDCATALOG.
* Fetches records from database into table i_tab to be passed as export
* parameter t_outtab in function module : REUSE_ALV_GRID_DISPLAY
PERFORM SUB_SELECT_RECORD.
* Populate stat and icon columns of internal table i_tab with specific
* columns and symbols based on some logic for quantity and value fields.
PERFORM SUB_MODIFY_RECORDS.
* Defines the overall layout of the report
PERFORM SUB_DETERMINE_ALV_LAYOUT.
* Defines the sort sequence of the report
PERFORM SUB_DETERMINE_SORT_SEQUENCE.
* Defines the event table
PERFORM SUB_EVENTTAB_BUILD USING I_EVENTS.
* Things to be written at the top of the page
PERFORM SUB_COMMENT_BUILD USING i_list_top_of_page.
* Display the ALV list
PERFORM SUB_SHOW_ALV_LIST.
* struct_layout-hotspot_fieldname = 'X'.
AT LINE-SELECTION.
PERFORM SUB_HOTSPOT.
*&---------------------------------------------------------------------*
*& Form SUB_VARIANT_INIT
*&---------------------------------------------------------------------*
* Display default variant
*----------------------------------------------------------------------*
form SUB_VARIANT_INIT.
I_VARIANT1-REPORT = SY-REPID.
*&---------------------------------------------------------------------*
*& 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_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.
* First field to appear in ALV list
X_FIELDCAT-COL_POS = 1.
* Name of the internal table field
X_FIELDCAT-FIELDNAME = 'SYM'.
* Name of the internal table
X_FIELDCAT-TABNAME = 'I_TAB'.
* Heading for the field
X_FIELDCAT-SELTEXT_M = 'Stat'.
* The field is going to contain a symbol
x_fieldcat-symbol = 'X'.
* Append the specifications to the internal table for field catalog.
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.
* The field is centre(C for centre, R and L for left and
* right) justified
x_fieldcat-just = 'C'.
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.
* The field will be colored differently(Cxyz)
x_fieldcat-emphasize = 'C511'.
* Initially the field will be hidden
x_fieldcat-no_out = 'X'.
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.
* Summation is allowed for this field
x_fieldcat-do_sum = 'X'.
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-qfieldname = '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
*&---------------------------------------------------------------------*
*& Form SUB_SELECT_RECORD
*&---------------------------------------------------------------------*
* Fetches records from database into table i_tab to be passed as export
* parameter t_outtab in function module : REUSE_ALV_GRID_DISPLAY
*----------------------------------------------------------------------*
form SUB_SELECT_RECORD.
SELECT mblnr A~matnr A~maktg charg
werks lgort menge meins dmbtr ebeln
FROM makt as a join mseg as b
on ( a~matnr = b~matnr )
INTO TABLE I_TAB
where b~bwart = '101' .
loop at i_tab.
if i_tab-dmbtr gt 10000.
* Field icn of internal table is going to contain icon . For this column
*icon_allowed is set in the field catalog table. For various icons,see
* type pool <ICON>
i_tab-icn = ''.
modify i_tab transporting icn.
endif.
if i_tab-menge gt 50.
* Field icn of internal table is going to contain symbol . For this
* column symbol_allowed is set in the field catalog table. For various
* icons,see type pool <SYMBOL>
i_tab-sym = 'N'.
modify i_tab transporting sym.
endif.
IF I_TAB-WERKS NE 'SDC1'.
* This field will contain lights , traffic signals : red.yellow,green
* That this field will be used as a light will be specified in the
* column of structure STRUCT_LAYOUT.
I_TAB-EXCPT = '1'.
MODIFY I_TAB TRANSPORTING EXCPT.
endif.
endloop.
*&---------------------------------------------------------------------*
*& Form SUB_DETERMINE_ALV_LAYOUT *
*&---------------------------------------------------------------------*
*& Defines the overall structure of the report layout *
*----------------------------------------------------------------------*
form SUB_DETERMINE_ALV_LAYOUT.
* Field EXCPT will show the light signal
STRUCT_LAYOUT-LIGHTS_FIELDNAME = 'EXCPT'.
* Field BOS of the internal table will act as pushbutton and will appear
* at the left of the grid display. User will press that to select a
* record
struct_layout-box_fieldname = 'BOX'.
STRUCT_layout-totals_text = 'Totqty '.
STRUCT_LAYOUT-ZEBRA = 'X'.
struct_layout-confirmation_prompt = 'X'.
struct_layout-detail_titlebar = 'Details of Storing'.
struct_layout-no_sumchoice = 'X'.
struct_layout-totals_only = 'X'.
endform. " SUB_DETERMINE_ALV_LAYOUT
*&---------------------------------------------------------------------*
*& Form SUB_DETERMINE_SORT_SEQUENCE
*&---------------------------------------------------------------------*
* Defines the sort sequence of the report
*----------------------------------------------------------------------*
form SUB_DETERMINE_SORT_SEQUENCE.
X_sort-spos = 1. " Sort order
X_sort-fieldname = 'MATNR'.
X_sort-tabname = 'I_TAB'.
X_sort-up = 'X'.
X_sort-subtot = 'X'. " Sub total allowed
*&---------------------------------------------------------------------*
*& 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.
*----------------------------------------------------------------------*
* 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.
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
*&---------------------------------------------------------------------*
* text
*----------------------------------------------------------------------*
* --> p1 text
* <-- p2 text
*----------------------------------------------------------------------*
form SUB_SELECT_DOCUMENT.
data : v_lines type i .
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.
***Header
CLEAR ls_line.
ls_line-typ = 'H'.
* LS_LINE-KEY: not used for this type
ls_line-info = 'Heading list'.
APPEND ls_line TO I_top_of_page.
***Selection
CLEAR ls_line.
ls_line-typ = 'S'.
ls_line-key = 'Key 1'.
ls_line-info = 'Material '.
APPEND ls_line TO i_top_of_page.
ls_line-key = 'Key 2'.
ls_line-info = 'Document no'.
APPEND ls_line TO I_top_of_page.
***Action
CLEAR ls_line.
*---------------------------------------------------------------------*
* 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.