@linkup-ai/abap-ai 2.0.0

package/dist/knowledge/abap/cloud-extensibility.md

@@ -0,0 +1,252 @@
+# ABAP Cloud Extensibility — extending standard RAP BOs, behavior extensions
+
+## Extension Types
+
+| Type | Who | What |
+|------|-----|------|
+| **Key User Extensibility** | Business user (no coding) | Custom fields, custom logic (BAdI), custom CDS views |
+| **Developer Extensibility** | ABAP developer | Behavior extensions, CDS view extensions, new RAP BOs |
+| **Side-by-Side Extensibility** | BTP developer | New app on BTP consuming S/4 APIs |
+
+## Behavior Extension — Add Logic to Standard BO
+
+```abap
+" Extend SAP standard behavior definition
+" File: ZBX_I_SALESORDER (Behavior Extension)
+
+extension using interface /sap/s4/api/salesorder/I_SalesOrder
+implementation in class ZBP_BX_I_SALESORDER unique;
+
+extend behavior for SalesOrder
+{
+  " Add validation
+  validation zz_validateCustomCredit on save
+    { create; update; field OverallSDProcessStatus; }
+
+  " Add determination
+  determination zz_setCustomField on modify
+    { create; field SalesOrganization; }
+
+  " Add side effects
+  side effects {
+    field SalesOrganization affects field ZZ_CustomRegion;
+  }
+}
+```
+
+### Handler Class for Behavior Extension
+
+```abap
+CLASS zbp_bx_i_salesorder DEFINITION PUBLIC ABSTRACT FINAL
+  FOR BEHAVIOR OF /sap/s4/api/salesorder/I_SalesOrder.
+ENDCLASS.
+
+CLASS zbp_bx_i_salesorder IMPLEMENTATION.
+ENDCLASS.
+
+" Local handler
+CLASS lhc_salesorder DEFINITION INHERITING FROM cl_abap_behavior_handler.
+  PRIVATE SECTION.
+    METHODS zz_validateCustomCredit FOR VALIDATE ON SAVE
+      IMPORTING keys FOR SalesOrder~zz_validateCustomCredit.
+
+    METHODS zz_setCustomField FOR DETERMINE ON MODIFY
+      IMPORTING keys FOR SalesOrder~zz_setCustomField.
+ENDCLASS.
+
+CLASS lhc_salesorder IMPLEMENTATION.
+  METHOD zz_validateCustomCredit.
+    READ ENTITIES OF /sap/s4/api/salesorder/I_SalesOrder IN LOCAL MODE
+      ENTITY SalesOrder
+      FIELDS ( SoldToParty TotalNetAmount TransactionCurrency )
+      WITH CORRESPONDING #( keys )
+      RESULT DATA(lt_orders).
+
+    LOOP AT lt_orders INTO DATA(ls_order).
+      " Custom credit check logic
+      IF ls_order-TotalNetAmount > 100000.
+        APPEND VALUE #(
+          %tky = ls_order-%tky
+          %msg = new_message_with_text(
+            severity = if_abap_behv_message=>severity-warning
+            text = |Order exceeds credit limit for { ls_order-SoldToParty }| )
+        ) TO reported-salesorder.
+      ENDIF.
+    ENDLOOP.
+  ENDMETHOD.
+
+  METHOD zz_setCustomField.
+    READ ENTITIES OF /sap/s4/api/salesorder/I_SalesOrder IN LOCAL MODE
+      ENTITY SalesOrder
+      FIELDS ( SalesOrganization )
+      WITH CORRESPONDING #( keys )
+      RESULT DATA(lt_orders).
+
+    MODIFY ENTITIES OF /sap/s4/api/salesorder/I_SalesOrder IN LOCAL MODE
+      ENTITY SalesOrder
+      UPDATE FIELDS ( ZZ_CustomRegion )
+      WITH VALUE #( FOR ls_order IN lt_orders
+        ( %tky = ls_order-%tky
+          ZZ_CustomRegion = SWITCH #( ls_order-SalesOrganization
+            WHEN '1000' THEN 'EMEA'
+            WHEN '2000' THEN 'AMER'
+            ELSE 'APAC' ) ) ).
+  ENDMETHOD.
+ENDCLASS.
+```
+
+## CDS View Extension — Add Fields to Standard View
+
+```abap
+" Extend standard CDS view with custom fields
+extend view entity I_SalesOrderTP with
+{
+  salesorder.zz_custom_region as ZZ_CustomRegion,
+  salesorder.zz_priority      as ZZ_Priority
+}
+```
+
+## Custom CDS View on Standard Tables
+
+```abap
+" Create read-only view consuming released CDS views
+@AccessControl.authorizationCheck: #CHECK
+@EndUserText.label: 'Custom Sales Analysis'
+define view entity ZI_SalesAnalysis
+  as select from I_SalesOrder as so
+  inner join I_SalesOrderItem as soi
+    on so.SalesOrder = soi.SalesOrder
+  association [0..1] to I_Customer as _Customer
+    on $projection.SoldToParty = _Customer.Customer
+{
+  key so.SalesOrder,
+  key soi.SalesOrderItem,
+      so.SoldToParty,
+      so.SalesOrganization,
+      soi.Material,
+      @Semantics.amount.currencyCode: 'TransactionCurrency'
+      soi.NetAmount,
+      so.TransactionCurrency,
+      so.CreationDate,
+
+      " Custom calculated field
+      case
+        when soi.NetAmount > 10000 then 'HIGH'
+        when soi.NetAmount > 1000  then 'MEDIUM'
+        else 'LOW'
+      end as ValueCategory,
+
+      _Customer
+}
+```
+
+## Custom RAP BO on Custom Table (with Standard BO Association)
+
+```abap
+" Custom table
+define table ztab_order_comment {
+  key client     : abap.clnt not null;
+  key comment_id : sysuuid_x16 not null;
+  sales_order    : vbeln;
+  comment_text   : abap.string;
+  created_by     : abp_creation_user;
+  created_at     : abp_creation_tstmpl;
+}
+
+" CDS with association to released view
+@AccessControl.authorizationCheck: #CHECK
+define root view entity ZI_OrderComment
+  as select from ztab_order_comment
+  association [0..1] to I_SalesOrder as _SalesOrder
+    on $projection.SalesOrder = _SalesOrder.SalesOrder
+{
+  key comment_id   as CommentID,
+      sales_order  as SalesOrder,
+      comment_text as CommentText,
+      @Semantics.user.createdBy: true
+      created_by   as CreatedBy,
+      @Semantics.systemDateTime.createdAt: true
+      created_at   as CreatedAt,
+      _SalesOrder
+}
+```
+
+## Key User Extensibility — Custom Fields
+
+```
+1. Fiori app "Custom Fields and Logic" (F1481)
+2. Select business context (e.g., Sales Order)
+3. Add field:
+   - Field name: ZZ_Priority
+   - Type: Code list / Text / Number / Date
+   - Label: Priority
+4. Publish → field available in standard UIs
+5. Optional: add custom logic via BAdI implementation
+```
+
+Custom fields created this way are automatically:
+- Added to the database table
+- Exposed in OData services
+- Available in CDS views (extension include)
+- Editable in Fiori Elements UIs
+
+## Key User BAdI Implementation
+
+```
+1. Fiori app "Custom Logic" (F1960)
+2. Select BAdI definition (e.g., BADI_SD_SLS_DOC_BEFORESAVE)
+3. Write ABAP Cloud logic:
+```
+
+```abap
+" Inside BAdI implementation (key user editor)
+IF salesorder-zz_priority IS INITIAL.
+  salesorder-zz_priority = 'MEDIUM'.
+ENDIF.
+
+IF salesorder-totalnetamount > 50000.
+  salesorder-zz_priority = 'HIGH'.
+ENDIF.
+```
+
+## Extension Naming Convention
+
+| Prefix | Use |
+|--------|-----|
+| `ZZ_` | Custom fields on standard objects (key user + developer) |
+| `Z` | Custom objects (tables, classes, CDS views) |
+| `ZBX_` | Behavior extensions |
+| `ZBP_BX_` | Behavior extension handler class |
+
+## Finding Extensible BOs
+
+```abap
+" In ADT: search for released behavior definitions
+" Filter: Release State = Released, Object Type = BDEF
+
+" Or query:
+SELECT * FROM I_CustABAPObjDirectoryEntry
+  WHERE ABAPObjectType = 'BDEF'
+    AND ReleaseState = 'RELEASED'
+  INTO TABLE @DATA(lt_extensible_bos).
+```
+
+## Rules
+- Behavior extensions: `extension using interface` — not `managed`/`unmanaged`
+- Prefix custom fields with `ZZ_` on standard objects
+- Use IN LOCAL MODE in extension handlers (same as regular RAP)
+- Only extend released BOs (check release state in ADT)
+- Custom validations/determinations in extensions use `zz_` prefix
+- Key user fields are automatically available in OData — no manual CDS extension needed
+- Side-by-side: new app on BTP calling S/4 APIs via communication scenario
+
+## Anti-Patterns
+| Anti-Pattern | Correct |
+|---|---|
+| Modifying standard SAP code | Use behavior extension or BAdI |
+| Custom field without `ZZ_` prefix | Always prefix with `ZZ_` on standard objects |
+| Extending unreleased BO | Only extend released BOs |
+| Direct DB access to standard tables | Use released CDS views (I_*) or EML |
+| `MODIFY ENTITIES` without IN LOCAL MODE in extension | Always use IN LOCAL MODE |
+| Key user logic with complex DB access | Keep key user logic simple — use developer extensibility for complex cases |
+| Behavior extension without `extension using interface` | Required keyword for extensions |

package/dist/knowledge/abap/cloud-released-apis.md

@@ -0,0 +1,261 @@
+# ABAP Cloud Released APIs — XCO, released classes, I_* CDS views
+
+## XCO Library (Cloud-Ready Utilities)
+
+### XCO String
+
+```abap
+" Split
+DATA(lt_parts) = xco_cp=>string( 'A,B,C' )->split( ',' )->value.
+" lt_parts = string_table: 'A', 'B', 'C'
+
+" Join
+DATA(lv_joined) = xco_cp=>strings( lt_parts )->join( ',' )->value.
+" lv_joined = 'A,B,C'
+
+" Case conversion
+DATA(lv_upper) = xco_cp=>string( 'hello' )->to_upper_case( )->value.
+DATA(lv_lower) = xco_cp=>string( 'HELLO' )->to_lower_case( )->value.
+
+" Camel case
+DATA(lv_camel) = xco_cp=>string( 'SALES_ORDER_ITEM' )->to_camel_case( )->value.
+" lv_camel = 'salesOrderItem'
+
+DATA(lv_pascal) = xco_cp=>string( 'sales_order' )->to_pascal_case( )->value.
+" lv_pascal = 'SalesOrder'
+
+" Snake case
+DATA(lv_snake) = xco_cp=>string( 'SalesOrderItem' )->to_snake_case( )->value.
+" lv_snake = 'sales_order_item'
+
+" Compose / decompose
+DATA(lv_composed) = xco_cp=>string( 'hello world' )->compose(
+  xco_cp_string=>composition->pascal_case )->value.
+" lv_composed = 'HelloWorld'
+
+" Substring
+DATA(lv_sub) = xco_cp=>string( 'ABCDEF' )->from( 3 )->to( 5 )->value.
+" lv_sub = 'CDE'
+
+" Trim
+DATA(lv_trim) = xco_cp=>string( '  hello  ' )->trim( )->value.
+
+" Contains
+DATA(lv_has) = xco_cp=>string( 'hello world' )->contains( 'world' ).
+" lv_has = abap_true
+
+" Prepend / append
+DATA(lv_pre) = xco_cp=>string( 'world' )->prepend( 'hello ' )->value.
+```
+
+### XCO UUID
+
+```abap
+" Generate UUID (X16 — 16 bytes hex)
+DATA(lv_uuid) = xco_cp=>uuid( )->value.
+" lv_uuid = '550E8400E29B41D4A716446655440000' (RAW16)
+
+" As string
+DATA(lv_uuid_str) = xco_cp=>uuid( )->as( xco_cp_uuid=>format->abap_32 )->value.
+```
+
+### XCO Date / Time
+
+```abap
+" Current date/time
+DATA(lv_date) = xco_cp=>sy->date( )->as( xco_cp_time=>date_format->iso_8601_basic )->value.
+" lv_date = '20260315'
+
+DATA(lv_time) = xco_cp=>sy->time( )->as( xco_cp_time=>time_format->iso_8601_basic )->value.
+" lv_time = '143022'
+
+" Date calculation
+DATA(lv_tomorrow) = xco_cp_time=>date( sy-datum )->add( iv_day = 1 )->value.
+DATA(lv_next_month) = xco_cp_time=>date( sy-datum )->add( iv_month = 1 )->value.
+DATA(lv_last_year) = xco_cp_time=>date( sy-datum )->add( iv_year = -1 )->value.
+
+" Difference
+DATA(lv_diff) = xco_cp_time=>date( lv_start )->difference( xco_cp_time=>date( lv_end ) ).
+DATA(lv_days) = lv_diff->in_days( ).
+```
+
+### XCO Random
+
+```abap
+" Random integer
+DATA(lv_rand) = xco_cp=>random->integer(
+  iv_min = 1 iv_max = 100 )->value.
+
+" Random string
+DATA(lv_rand_str) = xco_cp=>random->string(
+  iv_length = 10
+  iv_content = xco_cp_random_string=>content->alphanumeric )->value.
+
+" Random UUID
+DATA(lv_uuid2) = xco_cp=>uuid( )->value.
+```
+
+### XCO JSON
+
+```abap
+" Serialize structure/table to JSON
+DATA(lv_json) = xco_cp_json=>data->from_abap( ls_structure )->to_string( ).
+
+" Deserialize JSON to ABAP
+xco_cp_json=>data->from_string( lv_json )->write_to( REF #( ls_target ) ).
+
+" Pretty print
+DATA(lv_pretty) = xco_cp_json=>data->from_abap( ls_data )->to_string(
+  xco_cp_json=>format->pretty_print ).
+```
+
+## Released Classes (Common)
+
+### UUID Generation
+
+```abap
+" Preferred in Cloud (also works on-premise 7.55+)
+DATA(lv_uuid) = cl_system_uuid=>create_uuid_x16_static( ).
+" Returns RAW16
+
+" For SYSUUID_C32 format
+DATA(lv_uuid32) = cl_system_uuid=>create_uuid_c32_static( ).
+" Returns CHAR32
+```
+
+### Timestamp
+
+```abap
+" Current UTC timestamp
+GET TIME STAMP FIELD DATA(lv_ts).
+" lv_ts type TIMESTAMPL = 20260315143022.1234567
+
+" Using cl_abap_tstmp
+DATA(lv_diff_secs) = cl_abap_tstmp=>subtract(
+  tstmp1 = lv_ts_end  tstmp2 = lv_ts_start ).
+
+cl_abap_tstmp=>add(
+  EXPORTING tstmp = lv_ts_start  secs = 3600
+  IMPORTING r_tstmp = DATA(lv_plus_1h) ).
+```
+
+### Number Range
+
+```abap
+" Cloud-compatible number range
+TRY.
+    cl_numberrange_runtime=>number_get(
+      EXPORTING nr_range_nr = '01'
+                object      = 'ZORDER_NR'
+                quantity    = 1
+      IMPORTING number      = DATA(lv_number)
+                returncode  = DATA(lv_rc) ).
+  CATCH cx_number_ranges INTO DATA(lx).
+    " handle
+ENDTRY.
+```
+
+### Logging
+
+```abap
+" Application log (BAL) — released wrapper
+DATA(lo_log) = cl_bali_log=>create_with_header(
+  cl_bali_header_setter=>create(
+    iv_object    = 'ZORDER'
+    iv_subobject = 'PROCESS' ) ).
+
+lo_log->add_item( cl_bali_message_setter=>create(
+  iv_severity = if_bali_constants=>c_severity_error
+  iv_message_text = |Order { lv_id } failed: { lv_reason }| ) ).
+
+cl_bali_log_db=>get_instance( )->save_log( lo_log ).
+```
+
+### HTTP Client (Cloud)
+
+```abap
+" → see cloud-communication.md for full HTTP client reference
+```
+
+## Released CDS Views (I_* Catalog)
+
+### Common Released Views
+
+| View | Content |
+|------|---------|
+| `I_Currency` | Currency codes |
+| `I_CurrencyText` | Currency descriptions |
+| `I_Country` | Country codes |
+| `I_CountryText` | Country descriptions |
+| `I_Language` | Language codes |
+| `I_UnitOfMeasure` | Units of measure |
+| `I_UnitOfMeasureText` | UoM descriptions |
+| `I_CompanyCode` | Company codes |
+| `I_CompanyCodeText` | Company code descriptions |
+| `I_BusinessPartner` | Business partners |
+| `I_Customer` | Customers |
+| `I_Supplier` | Suppliers |
+| `I_Product` | Products (S/4) |
+| `I_PurchaseOrder` | Purchase orders |
+| `I_PurchaseOrderItem` | PO items |
+| `I_SalesOrder` | Sales orders |
+| `I_SalesOrderItem` | SO items |
+| `I_BillingDocument` | Billing docs |
+| `I_JournalEntry` | Accounting docs |
+| `I_GLAccountLineItem` | GL line items |
+| `I_CostCenter` | Cost centers |
+| `I_ProfitCenter` | Profit centers |
+| `I_Plant` | Plants |
+| `I_StorageLocation` | Storage locations |
+
+### Querying Released APIs
+
+```abap
+" Find all released CDS views for a domain
+SELECT * FROM I_CustABAPObjDirectoryEntry
+  WHERE ABAPObjectType = 'DDLS'
+    AND ReleaseState = 'RELEASED'
+    AND ABAPObjectCategory = 'R3TR'
+  INTO TABLE @DATA(lt_released_views)
+  UP TO 100 ROWS.
+
+" Find released classes
+SELECT * FROM I_CustABAPObjDirectoryEntry
+  WHERE ABAPObjectType = 'CLAS'
+    AND ReleaseState = 'RELEASED'
+  INTO TABLE @DATA(lt_released_classes)
+  UP TO 100 ROWS.
+```
+
+## Released Interfaces (Common)
+
+| Interface | Purpose |
+|-----------|---------|
+| `if_oo_adt_classrun` | Console output (replaces WRITE/REPORT) |
+| `if_rap_query_provider` | Custom query for unmanaged RAP |
+| `if_abap_behv_message` | RAP behavior messages |
+| `if_t100_message` | Message class integration for exceptions |
+| `if_bali_log` | Application logging |
+| `if_apj_dt_exec_object` | Application job execution |
+| `if_http_client` | HTTP client |
+
+## Rules
+- XCO is the primary utility library in Cloud — replaces many classic FMs
+- Always check release state in ADT before using a class/CDS view
+- I_* views are SAP-released read-only views — use in associations and value helps
+- `cl_system_uuid=>create_uuid_x16_static()` is the standard UUID generation
+- GET TIME STAMP works in Cloud — no replacement needed
+- `cl_bali_*` replaces classic `BAL_*` function modules for logging
+- XCO string methods are chainable: `xco_cp=>string( )->method1( )->method2( )->value`
+
+## Anti-Patterns
+| Anti-Pattern | Correct |
+|---|---|
+| `CALL FUNCTION 'GUID_CREATE'` | `cl_system_uuid=>create_uuid_x16_static( )` |
+| `CALL FUNCTION 'CONVERSION_EXIT_ALPHA_INPUT'` | `\|{ lv_val ALPHA = IN }\|` |
+| `CALL FUNCTION 'BAPI_*'` | Use released RAP APIs or I_* views |
+| `CL_SALV_TABLE` for output | `if_oo_adt_classrun~main` + `out->write()` |
+| `CL_HTTP_CLIENT=>create_by_url` | Communication scenario + `cl_http_destination_provider` |
+| `cl_gui_frontend_services` | Not available in Cloud — use cloud file APIs |
+| Direct DB access to SAP tables | Use released I_* CDS views |
+| `CALL FUNCTION 'BAL_LOG_CREATE'` | `cl_bali_log=>create_with_header( )` |