ABAP Cloud-ready framework for isolating ABAP exit points.
ABAP Cloud-ready framework for isolating ABAP exit points.
Open Source Contribution: This project is community-driven and Open Source! 🚀 If you spot a bug or have an idea for a cool enhancement, your contributions are more than welcome. Feel free to open an Issue or submit a Pull Request.
ABAP Point Gate is a configuration-driven framework designed to decouple custom enhancements from standard SAP objects, ensuring a clean and maintainable architecture. By leveraging Dependency Injection and Type-Safe Context management, it enables seamless unit testing and granular, hierarchical control over enhancement execution.
Define Points (hook locations in your code) and attach an ordered chain of Gate Handlers to each of them — activated, deactivated, sequenced, and parameterized through a Fiori app instead of code changes.
Consumer code ABAP Point Gate Configuration
───────────── ─────────────── ─────────────
build ZCL_APG_CONTEXT ──────▶ ZCL_APG_EXECUTION (facade)
│
▼
ZCL_APG_FACTORY ◀──────── ZAPG_POINT
│ evaluates activation ZAPG_GATE_HANDLE
│ (point level, then gate) (maintained via
▼ Fiori app)
ZCL_APG_INJECTOR
│ resolves instances
▼
ZIF_APG_HANDLER chain
executed in SEQNO order
ZCL_APG_CONTEXT with named data references and calls ZCL_APG_EXECUTION=>EXECUTE_GATE for a point ID.| Object | Role |
|---|---|
ZIF_APG_HANDLER | Contract for a gate handler (Strategy) |
ZIF_APG_ACTIVATION_TOGGLE | Contract for a custom activation decision |
ZIF_APG_CONTEXT / ZCL_APG_CONTEXT | Named data-reference container shared along the chain |
ZCL_APG_EXECUTION | Facade — the only class consumers call |
ZCL_APG_FACTORY | Resolves the active handlers of a point |
ZCL_APG_INJECTOR | DI registry — dynamic instantiation and test-double injection |
ZCX_APG_ERROR | T100 exception (message class ZAPG) |
ZR_APG_Point / ZR_APG_GateHandle + BDEF | RAP managed, draft-enabled configuration BO |
ZC_APG_*, ZUI_APG_POINT_V4 | Projection layer and OData V4 UI service |
I_JournalEntry.This project is licensed under the MIT License.
The repository was created by George Drakos.
ABAP Point Gate provides a standardized "gate" around ABAP exit points/enhancements, so custom logic stays isolated from the SAP core instead of being scattered across standard objects. This helps keep the system clean, maintainable, and upgrade-friendly, while offering a consistent way to implement enhancements that aligns with Clean Core / ABAP Cloud readiness practices and encourages quality through automated checks (e.g. abaplint) and unit testing.
ZCX_APG_ERROR instead of failing silently.PARAM_1 / PARAM_2) are maintained in the Fiori app and delivered to every handler, enabling parameterized handler variants without new classes.ZAPG with full diagnostics (failing class, context name, original exception in previous).ABAP Point Gate supports a sophisticated activation model (domain ZAPG_ACTIVE):
| Status | Meaning |
|---|---|
X | Globally Active |
- | Inactive |
| Unknown — treated as inactive |
C | Custom — a ZIF_APG_ACTIVATION_TOGGLE class decides at runtime |
The Fiori app (service binding ZUI_APG_POINT_V4_O4, OData V4) maintains points and their handler chains with draft handling and optimistic locking. The following rules are enforced on save:
ZIF_APG_HANDLER (messages 001/002/009).ZIF_APG_ACTIVATION_TOGGLE (001/002).Prepare the data environment before triggering a gate.
DATA(context) = NEW zcl_apg_context( ).
context->set_data( name = `SALES_ORDER`
value = REF #( sales_order ) ).
context->set_data( name = `POSTING_DATE`
value = NEW d( cl_abap_context_info=>get_system_date( ) ) ).
context->set_data( name = `RETRY_COUNT`
value = NEW i( 3 ) ).
Trigger the execution logic. The framework automatically identifies and runs all active handlers.
DATA messages TYPE zcl_apg_execution=>tt_messages.
TRY.
" The Point ID 'SAMPLE_SAVE_BEFORE' must be configured in table ZAPG_POINT
zcl_apg_execution=>execute_gate( EXPORTING point_id = 'SAMPLE_SAVE_BEFORE'
context = context
CHANGING messages = messages ).
CATCH zcx_apg_error INTO DATA(configuration_error).
" Configuration problems (unknown class, broken toggle) - surface them
" through the host's own error channel, e.g. reported/failed in RAP
INSERT VALUE #( type = 'E'
message = configuration_error->get_text( ) ) INTO TABLE messages.
ENDTRY.
Handler exceptions are converted into E messages by the framework; only configuration errors raise ZCX_APG_ERROR to the consumer.
Retrieve modified data or typed values without manual casting.
" A. Check for validation messages returned by handlers
IF line_exists( messages[ type = 'E' ] ).
" Handle errors (e.g. abort save, show log)
ENDIF.
" B. Retrieve potentially modified data
" If a handler modified the data, the updated reference is available again
DATA(changed_order) = context->get_data( `SALES_ORDER` ).
DATA(posting_date) = context->get_date( `POSTING_DATE` ).
DATA(retry_count) = context->get_integer( `RETRY_COUNT` ).
CLASS zcl_my_enrichment DEFINITION
PUBLIC
FINAL
CREATE PUBLIC.
PUBLIC SECTION.
INTERFACES zif_apg_handler.
ENDCLASS.
CLASS zcl_my_enrichment IMPLEMENTATION.
METHOD zif_apg_handler~execute.
" Named data references shared along the handler chain
DATA(order_ref) = context->get_data( `SALES_ORDER` ).
" Gate configuration parameters (PARAM_1 / PARAM_2 from the Fiori app)
IF parameters-param_1 = 'STRICT'.
" variant-specific behavior without a new handler class
ENDIF.
" Findings go into the shared message container
INSERT VALUE #( type = 'W'
message = 'Order enriched with defaults' ) INTO TABLE messages.
ENDMETHOD.
ENDCLASS.
CLASS zcl_weekday_toggle DEFINITION
PUBLIC
FINAL
CREATE PUBLIC.
PUBLIC SECTION.
INTERFACES zif_apg_activation_toggle.
ENDCLASS.
CLASS zcl_weekday_toggle IMPLEMENTATION.
METHOD zif_apg_activation_toggle~is_active.
" Cloud-released system date access - never SY-DATUM
DATA(today) = cl_abap_context_info=>get_system_date( ).
result = xsdbool( today+6(2) <> '01' ).
ENDMETHOD.
ENDCLASS.
Assign the class to a point or gate with activation status C in the Fiori app.
ZCL_APG_INJECTOR doubles as the test seam — no database needed:
" Inject the configuration for a point
zcl_apg_injector=>inject_configurations(
point_id = 'SAMPLE_SAVE_BEFORE'
configurations = VALUE #( ( point_id = 'SAMPLE_SAVE_BEFORE'
point_active = zcl_apg_factory=>activation_status-active
seqno = '001'
handler_class = 'ZCL_MY_ENRICHMENT'
gate_active = zcl_apg_factory=>activation_status-active ) ) ).
" Inject a test double for a class name
zcl_apg_injector=>inject_instance( classname = 'ZCL_MY_ENRICHMENT'
instance = my_test_double ).
" Always clean up in setup/teardown
zcl_apg_injector=>clear( ).
ABAP_CLOUD_DEVELOPMENT_DEFAULT with zero priority-1/2 findings.CL_OSQL_TEST_ENVIRONMENT, the toggle error path, and the RAP validation rule set.abaplint.json.ZAPG, 000-010) — no hardcoded texts.See CHANGELOG.md for the full history.
Full production-hardening rewrite: ABAP Cloud readiness, T100-based error handling, handler parameters, hardened RAP layer (validations, optimistic locking, domain-based value helps), and complete unit-test coverage. Contains breaking API changes — see the changelog.
Initial Release.
IF_BALI_LOG) for suppressed handler errors.get_boolean, structures, tables).