abap2UI5-local

abap2UI5-local

All abap2UI5 artifacts are combined into a single HTTP handler implementation as local classes. This approach makes your app completely independent of the rest of the system or any other abap2UI5 installation. It is for developers who want to run an abap2UI5 app without installing the framework as a package, or next to an existing installation. This is a delivery repository: the installable branches standard, 702 and cloud are generated by workflows and are never edited by hand, and main holds the generation machinery plus input/, a generated copy of abap2UI5's src/. Changes to the framework go to abap2UI5, see CONTRIBUTING.md.

Branches

Branch	Content	Last generated
standard	Standard ABAP (if_http_extension)
702	Downport for old releases (NW 7.02+)
cloud	ABAP for Cloud (if_http_service_extension)

Installation

1. Create a new HTTP handler in your system.
2. Copy & paste the handler class from this repository.
3. Add your abap2UI5 app as a local class and start it via your new HTTP endpoint.
4. Alternatively, pull this repository using abapGit and start via /sap/bc/z2ui5_local?app_start=z2ui5_cl_my_local_app

Start via HTTP

The standard and 702 branches ship the ICF node z2ui5_local (service path /sap/bc/z2ui5_local, handler class Z2UI5_CL_ABAP2UI5_LOCAL). After pulling the repository, activate the node in transaction SICF (locate /sap/bc/z2ui5_local, right-click → Activate Service) and open your app in the browser:

https://<host>:<port>/sap/bc/z2ui5_local?sap-client=<client>&app_start=<your_app_class>

For example:

https://myhost:44300/sap/bc/z2ui5_local?app_start=z2ui5_cl_my_local_app

The cloud branch uses the HTTP service Z2UI5_SERVICE_HTTP instead (same handler class) — take the URL from its service binding in ADT and append ?app_start=<your_app_class>.

Approach

Persistence

To avoid any side effects with other abap2UI5 installations, this version uses a separate table for persistence (z2ui5_t_99, the framework's z2ui5_t_01 under another name). You can either pull this repository or manually create the table in your system. The DDL below is rendered from the table definition the repository ships (input/01/01/z2ui5_t_01.tabl.xml) and checked on every branch generation, so it always has the columns the class reads:

@EndUserText.label : 'abap2UI5-local'
@AbapCatalog.enhancement.category : #NOT_EXTENSIBLE
@AbapCatalog.tableCategory : #TRANSPARENT
@AbapCatalog.deliveryClass : #A
@AbapCatalog.dataMaintenance : #RESTRICTED
define table z2ui5_t_99 {
  key mandt         : abap.clnt not null;
  key id            : abap.char(32) not null;
  id_prev           : abap.char(32);
  id_prev_app       : abap.char(32);
  id_prev_app_stack : abap.char(32);
  uname             : abap.char(32);
  timestampl        : timestampl;
  data              : abap.string(0);
}

The user exit lookup is switched off in this build: the folded class carries z2ui5_if_ui5_exit as a local interface, which a global exit class of a regular installation cannot implement (see disable_exit_lookup in build_locals_imp.py).

Generation

This main branch is the template branch — it carries the merge tooling and a snapshot of the upstream sources, the installable artifact lives on the generated branches:

• input/ holds a copy of the current abap2UI5 sources. Upstream's trigger_local workflow refreshes it on every push to abap2UI5 main; the update_input workflow (monthly schedule as safety net, or Run workflow) does the same from this side. Both overwrite it with the latest upstream version, validates it with abaplint (abaplint.jsonc points at /input) and pushes the refresh to main.
• Each artifact branch has its own workflow (generate_standard, generate_702, generate_cloud) which runs after every input refresh (and on every push to main). It merges the sources from input/ into the single locals include z2ui5_cl_abap2ui5_local.clas.locals_imp.abap via .github/scripts/build_locals_imp.py (runs abapmerge, re-adds the local zif_app/zcx_error additions, renames the persistence table to z2ui5_t_99 and orders all definitions so the result compiles as one include), renders the branch README from its template in .github/readme/ (replacing the {{VERSION}} placeholder with the current abap2UI5 version), validates everything with abaplint and force-pushes the branch content as exactly one commit on top of the current main — so every branch always shows 1 commit ahead of main and never behind. To change a branch README, edit its template on main — edits made directly on a generated branch are overwritten on the next run.

Run it locally:

python3 .github/scripts/build_locals_imp.py input /tmp/locals_imp.abap

Credits

• Merged files created with abapmerge (fetched from npm by build_locals_imp.py)
• 702 branch created with abaplint

Compatibility

This repository works in both ABAP for Cloud and Standard ABAP. For old releases use the branch 702.

Issues

For bug reports or feature requests, please open an issue in the abap2UI5 repository.