selection-screen

selection-screen

Select-options with saved variants for your abap2UI5 apps - generated from a table name or your data. You pass a database table name or an internal table; selection-screen builds one select-option per field, lets the user enter ranges in a popup, and saves and loads the whole selection as a variant. Your app gets the filter back and turns it into a SQL WHERE clause or filters an internal table with it. For developers of abap2UI5 apps that read data on user-defined criteria.

Part of abap2UI5-addons - addons and apps for abap2UI5, installed with abapGit.

Why

In SAP GUI a report gets its selection screen and variants for free with SELECT-OPTIONS. In a UI5 app each filter field, its range dialog and the variant handling would have to be built by hand.

selection-screen does that generically: it reads the fields via RTTI, renders the select-options either inline in your page or as a filter popup, and keeps variants in its own table z2ui5_t_13 - per app, optionally per user, with a default variant.

Good for:

• Data browsers and reports on abap2UI5 that select from a database table.
• Filtering an internal table the user already sees, with ranges instead of a search field.

Installation

Requirements

• ABAP Cloud (S/4 Public Cloud, BTP ABAP Environment), S/4 Private Cloud or On-Premise, or SAP NetWeaver AS ABAP 7.50 or higher
• abap2UI5

Steps - with abapGit, in this order:

1. abap2UI5
2. this repository (branch main) - classes and the table z2ui5_t_13 for the variants; nothing else to set up

Start - run a sample like any abap2UI5 app, e.g. ?app_start=z2ui5_cl_sel_sample_01 for select-options over table T100. All samples are listed under Samples.

Usage

Select-options for every field of a database table, inline in your page (condensed from z2ui5_cl_sel_sample_01):

" DATA mo_multiselect TYPE REF TO z2ui5_cl_sel_multisel.

METHOD z2ui5_if_app~main.

  IF client->check_on_init( ).
    mo_multiselect = z2ui5_cl_sel_multisel=>factory_by_name( val       = `T100`
                                                             s_variant = VALUE #( handle01 = `ZMY_APP` ) ).
    view_display( ).    " calls mo_multiselect->set_output( client = client view = lo_panel )
    RETURN.
  ENDIF.

  " range popups, Clear, Load and Save variant are handled here
  IF mo_multiselect->main( client ).
    RETURN.
  ENDIF.

  IF client->check_on_event( `GO` ).
    DATA(lv_where) = z2ui5_cl_util=>filter_get_sql_where( mo_multiselect->ms_result-t_filter ).
    SELECT FROM t100 FIELDS * WHERE (lv_where) INTO TABLE @mt_t100 UP TO 100 ROWS.
    client->view_model_update( ).
  ENDIF.

ENDMETHOD.

The select-options are bound to the view, so ms_result-t_filter - field names included - comes back from the browser. Before the names go into a dynamic WHERE, keep only those that are fields of your table, as z2ui5_cl_sel_sample_01 does: a forged name could otherwise carry a condition or a subquery on another table.

As a filter popup over an internal table (condensed from z2ui5_cl_sel_sample_02):

" on init
mo_variant = z2ui5_cl_sel_multisel_pop=>factory_by_data( data        = mt_table
                                                         var_handle1 = `ZMY_APP` ).
" on the Filter button
client->nav_app_call( mo_variant ).

" back in your app
IF client->check_on_navigated( ).
  DATA(lo_filter) = CAST z2ui5_cl_sel_multisel_pop( client->get_app_prev( ) ).
  IF lo_filter->result( )-check_confirmed = abap_true.
    z2ui5_cl_util=>filter_itab( EXPORTING filter = lo_filter->result( )-t_filter
                                CHANGING  val    = mt_table ).
  ENDIF.
ENDIF.

Features

• Ranges, Filters, Selection-Screens
• Persist Variants

What is there

For a full report-style selection screen with PARAMETERS, SELECT-OPTIONS and event blocks, see abap2UI5-addons/abap-cloud-gui.

Samples

Demo

Selection-Screen

Filter Popup

Development

npm ci
npm run check           # all gates below, as in CI
npm run lint            # abaplint, Standard ABAP (v750)
npm run check:cloud     # abaplint, ABAP Cloud
npm run check:abap2ui5  # abap2UI5-linter over apps and views
npm run rename          # namespace rename check

Contributing

Issues and pull requests are welcome - whether you're fixing bugs, adding new functionality, or improving documentation. Read CONTRIBUTING.md first.

License

MIT - see LICENSE.