abap2UI5-addons/open-source-libs

open-source-libs

Every open-source ABAP library with a UI - abap2UI5 sample apps that put eleven community libraries to work in the browser. Each package in src/ is one abap2UI5 app for one library: statistics, Excel, JSON, OpenAPI, diffs, PDF and Word documents, test data, validation. For ABAP developers who want to see and try a library on their own system before they use it - written in nothing but ABAP, with the library installed as a dependency, never copied.

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

Why

The ABAP open-source community has built many good libraries. Most of them come with a README and unit tests, but without a screen. This repository adds one: every package in src/ is an abap2UI5 app that puts one library to work in the browser, on your own system, written in nothing but ABAP. The libraries stay where they are — each sample uses its library as a dependency, it never copies it.

Good for:

• ABAP developers evaluating a library - see what it does before writing a line against it.
• Library authors who want to show their library at work.
• abap2UI5 developers looking for complete apps to learn from.

Installation

Requirements

• Standard ABAP: S/4 Private Cloud or On-Premise, or SAP NetWeaver AS ABAP 7.50 or higher. Not on ABAP Cloud yet: most of the libraries use APIs that are not released for ABAP Cloud (tbox-stats, for example, uses NAME_FELD and IF_FSBP_CONST_RANGE).
• SAPUI5 1.71 or higher
• abap2UI5
• The library of each sample you want to run - see Samples. Each package needs abap2UI5 and its own library, nothing else.

Steps - with abapGit, in this order:

1. abap2UI5
2. the library of each sample you want to run (see Samples)
3. this repository (branch main)

Library notes:

• abap_fm_json brings the authorization object Z_JSON; users need it for the function modules they call
• JSON2ABAPType's type generator is a local class of its report ZJSON2ABAPTYPE – install the whole repository
• abap-data-validator: install the Standard ABAP release (branch master), not the ABAP Cloud one
• zcl_docx: install the whole package, its XSLT transformations are part of the library

Start - every sample is an abap2UI5 app; start its class from the Samples table, e.g. ?app_start=z2ui5_cl_osl_abap2xlsx. The tbox-stats sample (src/01) needs SAPUI5 instead of OpenUI5, see below.

SAPUI5 for the charts (src/01)

All samples run on OpenUI5, except tbox-stats (src/01): its charts are sap.viz controls, which ship with SAPUI5 only. abap2UI5 bootstraps OpenUI5 by default, so switch the bootstrap to SAPUI5 in your abap2UI5 user exit — the SAPUI5 of your system or the one of the SAPUI5 CDN. If your installation already has an exit class, add the one line to it:

CLASS zcl_my_abap2ui5_exit DEFINITION PUBLIC FINAL CREATE PUBLIC.
  PUBLIC SECTION.
    INTERFACES z2ui5_if_ui5_exit.
ENDCLASS.

CLASS zcl_my_abap2ui5_exit IMPLEMENTATION.

  METHOD z2ui5_if_ui5_exit~set_config_http_get.
    " or the SAPUI5 of the system: /sap/public/bc/ui5_ui5/resources/sap-ui-core.js
    cs_config-src = `https://ui5.sap.com/resources/sap-ui-core.js`.
  ENDMETHOD.

  METHOD z2ui5_if_ui5_exit~set_config_http_post.
  ENDMETHOD.

ENDCLASS.

Then start the app class, e.g. z2ui5_cl_osl_tbox_stats, like any other abap2UI5 app.

Usage

Start the app of a sample (column App) with ?app_start=<App> and work with the library in the browser - what each app does is described below.

Samples

tbox-stats – Statistics with ABAP (src/01)

The app generates a stand-in for the flight bookings table SBOOK — 4,000 bookings with price, booking class, carrier and luggage weight, drawn with tbox-stats' own random generators — and puts tbox-stats to work on it:

• Explore a column – mean, standard deviation, skewness, kurtosis, the Jarque–Bera normality test, outliers and a correlation; a histogram with its normal fit and the empirical CDF against the normal CDF; for all bookings or one booking class
• Group by booking class or carrier – count, share, mean, median, standard deviation, coefficient of variation, IQR and skewness per group
• Distribution lab – draw samples from the normal, uniform, Poisson, binomial, geometric and Bernoulli generators, change their parameters and compare the result with the theory

Every number is computed in ABAP by ztbox_cl_stats; the frontend only draws the bound tables.

abap2xlsx – Excel Workbench (src/02)

• Export – 50 generated flight bookings; every option is one abap2xlsx call: bind_table with a table style and a totals row (or a plain range with an autofilter), freeze_panes, a data bar and a cell-is rule on the amount, a dropdown validation and a summary sheet with a bar chart. zcl_excel_writer_2007 writes the file, the browser downloads it
• The code – a panel shows the exact abap2xlsx calls the chosen options produce
• Import – upload an .xlsx (or read back the exported one); zcl_excel_reader_2007 loads it, pick a sheet, see its cells, and watch zcl_excel_common=>excel_string_to_date turn the serial numbers of the detected date column into dates

abap_fm_json – Function Modules as JSON (src/03)

The app calls function modules the way the library's ICF handler does, without the HTTP round trip — every step is one of zcl_json_handler's public methods:

• Interface – pick a function module and see its parameters as build_params( ) reads them
• JSON input – edit the request, start from an example or a template the library serializes from the interface, choose the deserializer
• Call and result – the result, with any exception raised, as JSON, XML, YAML or Perl, with the handler's upcase, camelcase and show_import_params options

Only a hard-coded whitelist of harmless standard function modules is offered (STFC_CONNECTION, STFC_STRUCTURE, RFC_SYSTEM_INFO, DATE_GET_WEEK), and every call first passes the library's own authority check on Z_JSON.

abap-openapi – OpenAPI to ABAP (src/04)

• Paste or upload an OpenAPI 3 JSON document (a small petstore is prefilled) and run the library's generator (zcl_oapi_generator=>generate_v2)
• The generated interface, HTTP client, ICF handler and ICF implementation in read-only code editors, each downloadable
• The operations as the library's parser reads them – method, path, operationId, ABAP method name, parameters, request body, responses

ABAP Diff3 – Diff, Patch and Three-Way Merge (src/05)

• Diff – two texts compared line by line with diff_comm( ), side by side, every row marked unchanged, changed, deleted or inserted, with the LCS length and the hunks in diff(1) notation
• Three-way merge – base, mine and theirs merged with diff3_merge( ); clean changes are taken over, each conflict is resolved with take mine, take theirs or both, and the library's own conflict markers are shown in all three styles
• Patch – the diff as a diff(1)-style patch, inverted or stripped, applied with patch( ) and checked against the expected text

JSON2ABAPType – ABAP Types from JSON (src/06)

• Paste JSON and press Generate – zui2_json=>generate( ) builds the data, the library's type generator turns it into ABAP TYPES, shown in a code editor
• The library's naming modes, an editable JSON-name to ABAP-component mapping and the optional pretty printer
• A table of the structure the generator detected – structures, table types and components

abap-fm-logger – Function Module Logs in the Browser (src/07)

• A browser version of the log report ZAFL_VIEWER: search the logged calls by function module, date, status, message and the custom fields
• Each call opens with its import, export, changing and tables parameters as indented JSON
• An overview per function module – calls, share, errors, average runtime, last call
• Optional reprocessing through zcl_afl_utilities=>re_process: off by default, with a confirmation and the library's own authority check

zcl_pdf – PDF without Forms (src/08)

• A letter or invoice typed into a form becomes a PDF written in ABAP by one stand-alone class – no Adobe Document Server, SmartForm or spool
• Shown in a sap.m.PDFViewer and downloadable, regenerated on every option change
• Every library feature as an option: fonts and styles, font size, largest subject that fits, body shrunk into its box, text box alignment, rectangles, page formats, orientation, extra pages and page breaks – plus the measurements behind the layout

zcl_docx – Word Documents from ABAP (src/09)

• A delivery note or invoice form that zcl_docx3=>get_document fills into a Word template: fields, an address structure, a repeated table row, repeated paragraphs, checkboxes and read-only protection
• No template object needed – the app builds the template in ABAP; download it, change it in Word and upload it again, or upload your own
• A tag check against the template, and a text preview of the generated document

abapFaker – Test Data Generator (src/10)

• Choose a locale, the number of rows and which of the library's 37 generators to include – each with its call, a live example and a button to try it
• The generated records as a table whose columns follow the selection, and a CSV download

abap-data-validator – Validating Internal Tables (src/11)

• An editable table of demo contacts – e-mail, date, time, URL, phone, IMEI, GUID, number, JSON – some of them invalid on purpose
• A rules table: per column required, one of the library's type checks, a custom regex or a reference data element
• Validate runs zcl_adata_validator->validate( ) over the table – every invalid cell turns red with the library's message

Security

Most samples read nothing from your system – they generate their data or work on what you type or upload. Three touch the system, each limited on purpose:

• abap_fm_json (src/03) calls function modules – only a hard-coded whitelist of harmless ones, after the library's Z_JSON authority check
• abap-fm-logger (src/07) reads the log table ZAFL_LOG, which holds whatever the logged function modules received and returned; reprocessing is off by default and runs the function module again
• abap-data-validator (src/11) leaves out the library's HTML check, which would send the cell content to validator.w3.org

The samples carry no authorization check of their own; restrict who may start them before using them beyond a development system.

Your Library Here

Do you know an open-source ABAP library that deserves a UI? Open an issue, or add a sample yourself: one package per library, the library as a dependency — CONTRIBUTING.md has the steps.

Development

npm ci
npm run check   # abaplint Standard, abap2UI5-linter, rename check

npm run check runs the same steps as CI. The manual build-rename workflow pushes a namespace-renamed copy to a branch rename_<name> for a parallel installation.

Contributing

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

License

MIT - see LICENSE. The libraries keep their own licenses:

• abap-tbox-stats by Marco Marrone, MIT License
• abap2xlsx by the abap2xlsx contributors, Apache License 2.0
• abap_fm_json by César Martín, Apache License 2.0
• abap-openapi by the abap-openapi contributors, MIT License
• ABAP Diff3 by apm.to Inc. (Marc Bernard), MIT License – a port of node-diff3
• JSON2ABAPType by Łukasz Pęgiel, Apache License 2.0
• abap-fm-logger by hhelibeb, Apache License 2.0
• zcl_pdf by Bjørn Espen Raadim, MIT License
• zcl_docx by Anton Sikidin, MIT License
• abapFaker by Uwe Fetzer and contributors, MIT License
• abap-data-validator by hhelibeb, MIT License