Author: fareedas
Date: 15/04/2008
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)
Step 1: DATA DECLARATION
Example:
Step 2: Selecting the variants(Optional)
Step 3: (Defining Output Characteristics)
Step 4: (Build up events table)
Step 5: (Report Output list description)
Step 6: (Pass Selection-screen Information)
Step 7: (Deciding Sort Criteria)
Step 8: (Final Step)
Step 9: (Display Internal Output Table)
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.
Step 1: DATA DECLARATION
Sap standard type pools: SLIS, KKBLO.
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.
TYPES: KKBLO_SELFIELD TYPE SLIS_SELFIELD.
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.
* 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.
Step 2: Selecting the variants (Optional)
SELECTING THE VARIANTS FOR INITIAL LIST DISPLAY (DEFAULT VARIANT)
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
Step3 (Defining Output Characteristics)
DEFININING OUTPUT CHARACTERISTICS: PREPARING DISPLAY FIELDS CATALOG
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.
The different possible attributes are:
- 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
Link to currency unit
- 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
Step 4(Build up events table)
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.
IMPORTING PARAMETERS: I_LIST_TYPE
This parameter has possible values from 0-4.
The parameter I_LIST_TYPE is of TYPE SLIS_LIST_TYPE and is DEFAULT 0 .
EXPORTING PARAMETERS: I_EVENTS table. 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.
Only events with a form routine name are processed.
The I_EVENTS table returns with the following possible constants:
1. Slis_ev_item_data_expand TYPE slis_formname VALUE 'ITEM_DATA_EXPAND'.
Only relevant for hierarchical-sequential lists using the layout parameter IS_LAYOUT-EXPAND_FIELDNAME of the structure IS_LAYOUT. Exit for passing item entries (ITEM table) for a header record that was expanded interactively by the user.2. Slis_ev_reprep_sel_modify TYPE slis_formname VALUE 'REPREP_SEL_MODIFY'.
RS_SELFIELD-TABINDEX contains the header table index for which the item entries are to be put in the global item output table (T_OUTTAB_SLAVE). The Callback is only called if ALV has no items for a header that is to be expanded.
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.
RS_SELFIELD is initial in this case. 3. Slis_ev_caller_exit_at_start TYPE slis_formname VALUE 'CALLER_EXIT'.
Is called at the beginning of the function module to make special settings. It is not usually used. 4. Slis_ev_user_command TYPE slis_formname VALUE 'USER_COMMAND'.
As this is a frequently-used Callback event, the form routine can also be passed directly in the interface by passing the user command in the IMPORTING parameter I_CALLBACK_USER_COMMAND.
5. Slis_ev_top_of_page TYPE slis_formname VALUE 'TOP_OF_PAGE'.
Equivalent to the list processing TOP-OF-PAGE event.
6. Slis_ev_top_of_coverpage TYPE slis_formname VALUE 'TOP_OF_COVERPAGE'.
The selection information and list status are output together (if they exist) on a separate page by default
7. Slis_ev_end_of_coverpage TYPE slis_formname VALUE 'END_OF_COVERPAGE'.
Analogously to TOP_OF_COVERPAGE the user can add other information
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
R_INDEX LIKE SY-TABIX
R_INDEX_ITEM LIKE SY-TABIX
R_INDEX_SUM LIKE SY-TABIX.12. Slis_ev_top_of_list TYPE slis_formname VALUE 'TOP_OF_LIST'.
Information output at the start of the list* *
13. Slis_ev_end_of_page TYPE slis_formname VALUE 'END_OF_PAGE'.
Information output at the end of a page. This is only called for printing.14. Slis_ev_end_of_list TYPE slis_formname VALUE 'END_OF_LIST'.
Information output at the end of the list
15. Slis_ev_after_line_output TYPE slis_formname VALUE 'AFTER_LINE_OUTPUT'.
Output information after each output line. Should only be used in justified cases because it costs a lot of performance.
16. Slis_ev_before_line_output TYPE slis_formname VALUE 'BEFORE_LINE_OUTPUT'.
Output information before each output line. Should only be used in justified cases because it costs a lot of performance.
17. Slis_ev_subtotal_text TYPE slis_formname VALUE 'SUBTOTAL_TEXT'.
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'.
DATA: L_I_EVENT TYPE SLIS_ALV_EVENT.
CALL FUNCTION 'REUSE_ALV_EVENTS_GET'
EXPORTING
I_LIST_TYPE = 0
IMPORTING
ET_EVENTS = I_EVENTS.
READ TABLE I_EVENTS WITH KEY NAME = SLIS_EV_TOP_OF_PAGE INTO L_I_EVENT.
IF SY-SUBRC = 0.
MOVE FORMNAME_TOP_OF_PAGE TO L_I_EVENT-FORM.
APPEND L_I_EVENT TO I_EVENTS.
ENDIF.
READ TABLE I_EVENTS WITH KEY NAME = SLIS_EV_END_OF_PAGE INTO L_I_EVENT.
IF SY-SUBRC = 0.
MOVE FORMNAME_END_OF_PAGE TO L_I_EVENT-FORM.
APPEND L_I_EVENT TO I_EVENTS.
ENDIF.
CLEAR L_I_EVENT.
READ TABLE I_EVENTS WITH KEY NAME = SLIS_EV_USER_COMMAND INTO L_I_EVENT.
IF SY-SUBRC = 0.
MOVE FORMNAME_USER_COMMAND TO L_I_EVENT-FORM.
APPEND L_I_EVENT TO I_EVENTS.
ENDIF.
This will prepare the events table for the report.
The report will contain three forms for the above events:
1. FORM TOP_OF_PAGE: This form will contain the top of page event for the report i.e. header etc
Using the function module 'REUSE_ALV_COMMENTARY_WRITE', the internal table containing the headings for top of page event can be passed to the list output. Also, any logo specific to the report can be passed to the function module.
2. FORM END_OF_PAGE: This form will contain the end of page event for the report i.e. footer etc
3. FORM USER_COMMAND: This form will contain the desired user command i.e. pick/line selection
Step 5(Report Output list description)
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.
2. No_colhead (1) TYPE c: This parameter suppresses the column headings
Value set: SPACE, 'X'.
'X' = column headers are not output
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
4*. Zebra*(1) TYPE c : The report is output in the striped pattern.
Value set: SPACE, 'X'.
'X' = striped pattern (e.g. for wide lists)
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
9. Window_titlebar LIKE rsmpe-tittext: To set the titlebar on the report output.
10. No_uline_hs(1) TYPE c.
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.
18. No_subtotals(1) TYPE c : No subtotals possible
Value set: SPACE, 'X'
'X' = no subtotals.
19*. Numc_sum*(1) TYPE c : Totals only possible for NUMC-Fields.
20. No_unit_splitting TYPE c: No separate total lines by inh.units
21.totals_before_items TYPE c: Display totals before the items
22. Totals_only(1) TYPE c : Show only totals
Value set: SPACE, 'X'
'X' = only total records are output.
23. Totals_text(60) TYPE c : Text for 1st col. in totals
Value set: SPACE, string (max.60)
' ' = The first column in the total record contains an appropriate number of '*'s to indicate the total by default. If the first column is wide enough, the string 'Total' is output after the asterisks.
'String' = The string passed is output after the total indicated by '*', if the column is wide enough.
24. Subtotals_text(60) TYPE c : Texts for subtotals
Value set: SPACE, string (max.60)
' ' = In the first column of subtotal records, the subtotal is indicated by an appropriate number of '*' by default. If the first column is not a subtotal criterion, the string 'Total' is output after the asterisks, if the column is wide enough.
'String' = the string passed is output after the subtotal indicated by '*', if the column is wide enough and the first column is not a subtotal criterion. If it is a subtotal criterion, its value is repeated after the total, if the column is wide enough.
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.
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
32. Confirmation_prompt: confirm. Prompt when leaving
Value set: SPACE, 'X'
'X' = if one of the functions 'Back (F03)', 'Exit (F15)' or 'Cancel (F12)' occurs, a confirmation prompt appears.
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'.
34. Reprep(1) TYPE c : report report interface active.
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'.
36. No_keyfix(1) TYPE c : Used to make the key fields scrollable.
Value set: SPACE, 'X'.
' ' = The key columns defined in the field catalog by FIELDCAT-KEY = 'X' are fixed in the list output. These columns do not scroll horizontally. The item table key columns are fixed in hierarchical-sequential lists. The header table key fields are not considered here.
'X' = key columns not fixed
37. Get_selinfos(1) TYPE c : To read selection screen.
Value set: SPACE, 'X'.
If the calling program is a report with an ABAP/4 selection screen, setting this parameter makes ALV read the selection screen again. If the selections are read successfully, a pushbutton, via which the user can call a popup which lists the report selections in a simple form, becomes active on the results list output by ALV.
38. group_change_edit(1) TYPE c : Settings by user for new group
Value set: SPACE, 'X'
'X' = the user can enter a format option for each sort criterion in the sort/subtotal popup, for the list format when this value changes (e.g. new page or underline).
39. No_scrolling(1) TYPE c : Does not allow scrolling of the list to the right.
Value set: SPACE, 'X'.
40. Expand_all(1) TYPE c : Expand all positions
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).
41. Detail_initial_lines(1) TYPE c : show also initial lines
Value set: SPACE, 'X'
' ' = Only fields whose contents are not initial are output in the detail view.
'X' = initial field contents are also output in detail.
41. detail_titlebar(30) type c : Titlebar for detail screen
Value set: SPACE, string (max.30)
' ' = ' Detail: Display' is output as the title of the detail window.
'String' = the string passed is output as the title of the detail window.
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.
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: 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.
- 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.
Step 7(Deciding Sort Criteria)
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.
This internal table has the following fields:
- spos : Sort sequence
- fieldname : Internal output table field name
- tabname : Only relevant for hierarchical-sequential lists. Name of the internal output table.
- up : 'X' = sort in ascending order
- down : 'X' = sort in descending order
- subtot : 'X' = subtotal at group value change
- group : '* ' = new page at group value change ,'UL' = underline at group value change
Step 8(Final Step)
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.
Step 8(Display Internal Output Table)
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
Documentation on function module: REUSE_ALV_GRID_DISPLAY
The function module outputs an internal table with whatever structure in the form of a formatted single- or multi-line list. Process:
Ø Passing an internal table with the set of information to be output
Ø Passing a structure with general layout specifications for list layout
Ø Passing a field catalog in the form of an internal table
The field catalog describes the fields to be output in the list.
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
I_CALLBACK_PROGRAM: Name of the calling program
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:
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:
o tabname : Name of the internal output table
o tabindex : Index of the internal output table
o fieldname: Field name
o endsum : Cursor is located on the totals line
o sumindex : If >0, the cursor is located on a subtotals line
o value : Value of the field on the list
o refresh : (Exporting) List should be set up again
o col_stable: (Exporting) Keep column position when list is set up again
o row_stable: (Exporting) Keep row position when list is set up again
o exit : (Exporting) Exit list (and ALV)
o before_action: Call before standard action exec
Date: 15/04/2008
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)
Step 1: DATA DECLARATION
Example:
Step 2: Selecting the variants(Optional)
Step 3: (Defining Output Characteristics)
Step 4: (Build up events table)
Step 5: (Report Output list description)
Step 6: (Pass Selection-screen Information)
Step 7: (Deciding Sort Criteria)
Step 8: (Final Step)
Step 9: (Display Internal Output Table)
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.
Step 1: DATA DECLARATION
Sap standard type pools: SLIS, KKBLO.
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.
TYPES: KKBLO_SELFIELD TYPE SLIS_SELFIELD.
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.
* 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.
Step 2: Selecting the variants (Optional)
SELECTING THE VARIANTS FOR INITIAL LIST DISPLAY (DEFAULT VARIANT)
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
Step3 (Defining Output Characteristics)
DEFININING OUTPUT CHARACTERISTICS: PREPARING DISPLAY FIELDS CATALOG
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.
The different possible attributes are:
- 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
Link to currency unit
- 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
Step 4(Build up events table)
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.
IMPORTING PARAMETERS: I_LIST_TYPE
This parameter has possible values from 0-4.
The parameter I_LIST_TYPE is of TYPE SLIS_LIST_TYPE and is DEFAULT 0 .
EXPORTING PARAMETERS: I_EVENTS table. 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.
Only events with a form routine name are processed.
The I_EVENTS table returns with the following possible constants:
1. Slis_ev_item_data_expand TYPE slis_formname VALUE 'ITEM_DATA_EXPAND'.
Only relevant for hierarchical-sequential lists using the layout parameter IS_LAYOUT-EXPAND_FIELDNAME of the structure IS_LAYOUT. Exit for passing item entries (ITEM table) for a header record that was expanded interactively by the user.2. Slis_ev_reprep_sel_modify TYPE slis_formname VALUE 'REPREP_SEL_MODIFY'.
RS_SELFIELD-TABINDEX contains the header table index for which the item entries are to be put in the global item output table (T_OUTTAB_SLAVE). The Callback is only called if ALV has no items for a header that is to be expanded.
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.
RS_SELFIELD is initial in this case. 3. Slis_ev_caller_exit_at_start TYPE slis_formname VALUE 'CALLER_EXIT'.
Is called at the beginning of the function module to make special settings. It is not usually used. 4. Slis_ev_user_command TYPE slis_formname VALUE 'USER_COMMAND'.
As this is a frequently-used Callback event, the form routine can also be passed directly in the interface by passing the user command in the IMPORTING parameter I_CALLBACK_USER_COMMAND.
5. Slis_ev_top_of_page TYPE slis_formname VALUE 'TOP_OF_PAGE'.
Equivalent to the list processing TOP-OF-PAGE event.
6. Slis_ev_top_of_coverpage TYPE slis_formname VALUE 'TOP_OF_COVERPAGE'.
The selection information and list status are output together (if they exist) on a separate page by default
7. Slis_ev_end_of_coverpage TYPE slis_formname VALUE 'END_OF_COVERPAGE'.
Analogously to TOP_OF_COVERPAGE the user can add other information
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
R_INDEX LIKE SY-TABIX
R_INDEX_ITEM LIKE SY-TABIX
R_INDEX_SUM LIKE SY-TABIX.12. Slis_ev_top_of_list TYPE slis_formname VALUE 'TOP_OF_LIST'.
Information output at the start of the list* *
13. Slis_ev_end_of_page TYPE slis_formname VALUE 'END_OF_PAGE'.
Information output at the end of a page. This is only called for printing.14. Slis_ev_end_of_list TYPE slis_formname VALUE 'END_OF_LIST'.
Information output at the end of the list
15. Slis_ev_after_line_output TYPE slis_formname VALUE 'AFTER_LINE_OUTPUT'.
Output information after each output line. Should only be used in justified cases because it costs a lot of performance.
16. Slis_ev_before_line_output TYPE slis_formname VALUE 'BEFORE_LINE_OUTPUT'.
Output information before each output line. Should only be used in justified cases because it costs a lot of performance.
17. Slis_ev_subtotal_text TYPE slis_formname VALUE 'SUBTOTAL_TEXT'.
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'.
DATA: L_I_EVENT TYPE SLIS_ALV_EVENT.
CALL FUNCTION 'REUSE_ALV_EVENTS_GET'
EXPORTING
I_LIST_TYPE = 0
IMPORTING
ET_EVENTS = I_EVENTS.
READ TABLE I_EVENTS WITH KEY NAME = SLIS_EV_TOP_OF_PAGE INTO L_I_EVENT.
IF SY-SUBRC = 0.
MOVE FORMNAME_TOP_OF_PAGE TO L_I_EVENT-FORM.
APPEND L_I_EVENT TO I_EVENTS.
ENDIF.
READ TABLE I_EVENTS WITH KEY NAME = SLIS_EV_END_OF_PAGE INTO L_I_EVENT.
IF SY-SUBRC = 0.
MOVE FORMNAME_END_OF_PAGE TO L_I_EVENT-FORM.
APPEND L_I_EVENT TO I_EVENTS.
ENDIF.
CLEAR L_I_EVENT.
READ TABLE I_EVENTS WITH KEY NAME = SLIS_EV_USER_COMMAND INTO L_I_EVENT.
IF SY-SUBRC = 0.
MOVE FORMNAME_USER_COMMAND TO L_I_EVENT-FORM.
APPEND L_I_EVENT TO I_EVENTS.
ENDIF.
This will prepare the events table for the report.
The report will contain three forms for the above events:
1. FORM TOP_OF_PAGE: This form will contain the top of page event for the report i.e. header etc
Using the function module 'REUSE_ALV_COMMENTARY_WRITE', the internal table containing the headings for top of page event can be passed to the list output. Also, any logo specific to the report can be passed to the function module.
2. FORM END_OF_PAGE: This form will contain the end of page event for the report i.e. footer etc
3. FORM USER_COMMAND: This form will contain the desired user command i.e. pick/line selection
Step 5(Report Output list description)
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.
2. No_colhead (1) TYPE c: This parameter suppresses the column headings
Value set: SPACE, 'X'.
'X' = column headers are not output
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
4*. Zebra*(1) TYPE c : The report is output in the striped pattern.
Value set: SPACE, 'X'.
'X' = striped pattern (e.g. for wide lists)
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
9. Window_titlebar LIKE rsmpe-tittext: To set the titlebar on the report output.
10. No_uline_hs(1) TYPE c.
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.
18. No_subtotals(1) TYPE c : No subtotals possible
Value set: SPACE, 'X'
'X' = no subtotals.
19*. Numc_sum*(1) TYPE c : Totals only possible for NUMC-Fields.
20. No_unit_splitting TYPE c: No separate total lines by inh.units
21.totals_before_items TYPE c: Display totals before the items
22. Totals_only(1) TYPE c : Show only totals
Value set: SPACE, 'X'
'X' = only total records are output.
23. Totals_text(60) TYPE c : Text for 1st col. in totals
Value set: SPACE, string (max.60)
' ' = The first column in the total record contains an appropriate number of '*'s to indicate the total by default. If the first column is wide enough, the string 'Total' is output after the asterisks.
'String' = The string passed is output after the total indicated by '*', if the column is wide enough.
24. Subtotals_text(60) TYPE c : Texts for subtotals
Value set: SPACE, string (max.60)
' ' = In the first column of subtotal records, the subtotal is indicated by an appropriate number of '*' by default. If the first column is not a subtotal criterion, the string 'Total' is output after the asterisks, if the column is wide enough.
'String' = the string passed is output after the subtotal indicated by '*', if the column is wide enough and the first column is not a subtotal criterion. If it is a subtotal criterion, its value is repeated after the total, if the column is wide enough.
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.
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
32. Confirmation_prompt: confirm. Prompt when leaving
Value set: SPACE, 'X'
'X' = if one of the functions 'Back (F03)', 'Exit (F15)' or 'Cancel (F12)' occurs, a confirmation prompt appears.
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'.
34. Reprep(1) TYPE c : report report interface active.
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'.
36. No_keyfix(1) TYPE c : Used to make the key fields scrollable.
Value set: SPACE, 'X'.
' ' = The key columns defined in the field catalog by FIELDCAT-KEY = 'X' are fixed in the list output. These columns do not scroll horizontally. The item table key columns are fixed in hierarchical-sequential lists. The header table key fields are not considered here.
'X' = key columns not fixed
37. Get_selinfos(1) TYPE c : To read selection screen.
Value set: SPACE, 'X'.
If the calling program is a report with an ABAP/4 selection screen, setting this parameter makes ALV read the selection screen again. If the selections are read successfully, a pushbutton, via which the user can call a popup which lists the report selections in a simple form, becomes active on the results list output by ALV.
38. group_change_edit(1) TYPE c : Settings by user for new group
Value set: SPACE, 'X'
'X' = the user can enter a format option for each sort criterion in the sort/subtotal popup, for the list format when this value changes (e.g. new page or underline).
39. No_scrolling(1) TYPE c : Does not allow scrolling of the list to the right.
Value set: SPACE, 'X'.
40. Expand_all(1) TYPE c : Expand all positions
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).
41. Detail_initial_lines(1) TYPE c : show also initial lines
Value set: SPACE, 'X'
' ' = Only fields whose contents are not initial are output in the detail view.
'X' = initial field contents are also output in detail.
41. detail_titlebar(30) type c : Titlebar for detail screen
Value set: SPACE, string (max.30)
' ' = ' Detail: Display' is output as the title of the detail window.
'String' = the string passed is output as the title of the detail window.
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.
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: 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.
- 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.
Step 7(Deciding Sort Criteria)
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.
This internal table has the following fields:
- spos : Sort sequence
- fieldname : Internal output table field name
- tabname : Only relevant for hierarchical-sequential lists. Name of the internal output table.
- up : 'X' = sort in ascending order
- down : 'X' = sort in descending order
- subtot : 'X' = subtotal at group value change
- group : '* ' = new page at group value change ,'UL' = underline at group value change
Step 8(Final Step)
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.
Step 8(Display Internal Output Table)
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
Documentation on function module: REUSE_ALV_GRID_DISPLAY
The function module outputs an internal table with whatever structure in the form of a formatted single- or multi-line list. Process:
Ø Passing an internal table with the set of information to be output
Ø Passing a structure with general layout specifications for list layout
Ø Passing a field catalog in the form of an internal table
The field catalog describes the fields to be output in the list.
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
I_CALLBACK_PROGRAM: Name of the calling program
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:
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:
o tabname : Name of the internal output table
o tabindex : Index of the internal output table
o fieldname: Field name
o endsum : Cursor is located on the totals line
o sumindex : If >0, the cursor is located on a subtotals line
o value : Value of the field on the list
o refresh : (Exporting) List should be set up again
o col_stable: (Exporting) Keep column position when list is set up again
o row_stable: (Exporting) Keep row position when list is set up again
o exit : (Exporting) Exit list (and ALV)
o before_action: Call before standard action exec
扫一扫
679
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
