sap-rfc-wrapper-class

name: sap-rfc-wrapper-class description: | Generates an RFC wrapper function module for a non-RFC-callable ABAP class method. Reads the class method's parameter interface from SEOPARAM/SEOEXCEP via RFC_READ_TABLE, generates a deployable ABAP function module that internally calls the class method, and deploys it via /sap-se37. The generated FM name follows the pattern Z_CLSWRP__ (truncated to 30 chars). Prerequisites: SAP profile saved via /sap-login (RFC password required). SAP NCo 3.1 (32-bit, .NET 4.0) in GAC. Active SAP GUI session (use /sap-login first) for the /sap-se37 deploy sub-step. argument-hint: " [function-group] [package] [transport]"

SAP RFC Wrapper — Class Method Skill

You generate and deploy an RFC wrapper function module that internally calls an ABAP class method. This lets you invoke non-RFC-callable class methods via the RFC protocol (e.g. using SAP NCo 3.1).

Task: $ARGUMENTS

Shared Resources

Step 0 — Resolve Work Directory

Resolve work_dir via the env-aware helper — do NOT take work_dir from a direct settings.json read (that ignores the SAPDEV_AI_WORK_DIR env var and userconfig.json). Use the WORK_DIR= value printed by:

powershell -NoProfile -ExecutionPolicy Bypass -Command ". '<SAP_DEV_CORE_SHARED_DIR>\scripts\sap_settings_lib.ps1'; . '<SAP_DEV_CORE_SHARED_DIR>\scripts\sap_connection_lib.ps1'; Write-Output ('WORK_DIR=' + (Get-SapWorkDir))"

The settings note below still applies to the OTHER keys.

Settings reads/writes follow <SAP_DEV_CORE_SHARED_DIR>/rules/settings_lookup.md — merge per-key on the .value field (env var → settings.local.json → userconfig.json → settings.json); non-per-connection writes go to userconfig.json. Resolve cross-plugin paths: 3 levels up from <SKILL_DIR>, then into sap-dev-core\settings.json and (if present) sap-dev-core\settings.local.json.

Set {WORK_TEMP} = {work_dir}\temp

cmd /c if not exist "{WORK_TEMP}" mkdir "{WORK_TEMP}"

Step 0.5 — Start Logging

Start a structured log run. State file: {WORK_TEMP}\sap_rfc_wrapper_class_run.json. Best-effort.

powershell -ExecutionPolicy Bypass -File "<SAP_DEV_CORE_SHARED_DIR>\scripts\sap_log_helper.ps1" -Action start -StateFile "{WORK_TEMP}\sap_rfc_wrapper_class_run.json" -Skill sap-rfc-wrapper-class -ParamsJson "{\"class\":\"<CLASS>\",\"method\":\"<METHOD>\"}"

Step 1 — Collect Parameters

From arguments ($ARGUMENTS):

Compute generated FM name:

• Pattern: Z_CLSWRP_<CLASS>_<METHOD>
• Truncate the combined name to exactly 30 characters
• Convert to UPPERCASE
• Example: CL_MATERIAL_BASIC + GET_DESCRIPTION → Z_CLSWRP_CL_MATERIAL_BGET_D (30 chars)

Read SAP connection settings from the merged sap-dev-core settings (per <SAP_DEV_CORE_SHARED_DIR>/rules/settings_lookup.md — settings.local.json overrides settings.json per-key):

Step 2 — Read Class Method Interface

The reader script queries the OO repository transparent tables (NOT the SEOPARAM / SEOEXCEP structures — those are line types only and cannot be read via RFC_READ_TABLE):

Limitation — source-based classes: Newer classes created with the inline ABAP class editor may have empty SEOSUBCODF rows because the parameter list is parsed from source on-the-fly. The reader script will emit a NOTE in that case. Workaround: deploy a small RFC-enabled helper FM that uses RTTI (cl_abap_classdescr=>describe_by_name) to introspect at runtime.

Fill sap_rfc_read_class_method.ps1 from the template and run it.

Write {WORK_TEMP}\sap_rfc_read_cls_run.ps1:

$ps = Get-Content '<SKILL_DIR>\references\sap_rfc_read_class_method.ps1' -Raw -Encoding UTF8
$ps = $ps -replace '%%SAP_SERVER%%',   ''
$ps = $ps -replace '%%SAP_SYSNR%%',    ''
$ps = $ps -replace '%%SAP_CLIENT%%',   ''
$ps = $ps -replace '%%SAP_USER%%',     ''
$ps = $ps -replace '%%SAP_PASSWORD%%', ''
$ps = $ps -replace '%%SAP_LANGUAGE%%', ''
$ps = $ps -replace '%%RFC_LIB_PS1%%',  '<SAP_DEV_CORE_SHARED_DIR>\scripts\sap_rfc_lib.ps1'
$ps = $ps -replace '%%CLASS_NAME%%',   'THE_CLASS_NAME'
$ps = $ps -replace '%%METHOD_NAME%%',  'THE_METHOD_NAME'
[System.IO.File]::WriteAllText('{WORK_TEMP}\sap_rfc_read_cls_run.ps1', $ps, [System.Text.Encoding]::UTF8)
Write-Host 'Done'

Run:

C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe -ExecutionPolicy Bypass -File "{WORK_TEMP}\sap_rfc_read_cls_run.ps1"

Parse output — each parameter appears as:

PARDECLTYPE|SCONAME|TYPNAME|KEYFLAG|PASSTYPE

• PARDECLTYPE: 0=Importing 1=Exporting 2=Changing 3=Returning
• SCONAME: parameter name
• TYPNAME: DDIC type name (use as both the FM parameter type AND the asXML type)
• KEYFLAG: blank=mandatory X=optional
• PASSTYPE: 0=by value 1=by reference 2=by reference with default

Method-type indicator (also emitted by the read script):

MTDTYPE|<n>

where <n> is from SEOCOMPO.MTDTYPE: 0=instance method, 1=static method, 2=event handler. The wrapper generator MUST emit <CLASS>=><METHOD>(...) syntax for static methods (no CREATE OBJECT) and lo_obj-><METHOD>(...) for instance methods (preceded by CREATE OBJECT lo_obj).

Exceptions appear as: EXCEPT|<EXCEPTION_NAME>

REJECT class-reference returns: if any parameter has TYPNAME starting with REF TO or the SEOPARAM TYPTYPE column equals 1 (class ref) or 2 (interface ref), STOP and report to the user:

"Method <CLASS>=><METHOD> returns/uses an object reference (<param> TYPE REF TO <X>). Object references cannot be marshaled via RFC + asXML serialization. Pick a method whose parameters are all scalar/structured DDIC types, or write a custom wrapper that extracts only the relevant scalar attributes from the returned object."

If ERROR:, show full output and stop.

Present the interface to the user:

Class: <CLASS_NAME> — Method: <METHOD_NAME>
============================================
Direction   Parameter       Type                 Optional
----------  --------------  -------------------  --------
Importing   IM_MATNR        MATNR                mandatory
Exporting   EX_MAKTX        MAKTX                optional

Step 3 — Generate Wrapper FM ABAP Source

Generate the wrapper function module ABAP source code.

FM source template

The generated source must be a complete function include. Use this structure:

FUNCTION <GENERATED_FM_NAME>.
*"----------------------------------------------------------------------
*"*"Local Interface:
*"  IMPORTING
*"     VALUE(<im_param>) TYPE  <TYPNAME>
*"  EXPORTING
*"     VALUE(<ex_param>) TYPE  <TYPNAME>
*"  CHANGING
*"     VALUE(<ch_param>) TYPE  <TYPNAME>
*"  EXCEPTIONS
*"      CALL_FAILED
*"----------------------------------------------------------------------
  DATA: lo_obj    TYPE REF TO <CLASS_NAME>,
        lx_root   TYPE REF TO cx_root.

  TRY.
      CREATE OBJECT lo_obj.
      lo_obj-><METHOD_NAME>(
        EXPORTING   " <-- method's IMPORTING params
          <im_param> = <im_param>
        IMPORTING   " <-- method's EXPORTING params
          <ex_param> = <ex_param>
        CHANGING
          <ch_param> = <ch_param>
        RECEIVING   " <-- method's RETURNING param (if any)
          <ret_param> = <ret_param>
      ).
    CATCH cx_root INTO lx_root.
      RAISE CALL_FAILED.
  ENDTRY.

ENDFUNCTION.

Static method variant (MTDTYPE = 1)

For static methods, omit CREATE OBJECT and call via =>:

  DATA: lx_root TYPE REF TO cx_root.

  TRY.
      <CLASS_NAME>=><METHOD_NAME>(
        EXPORTING <im_param> = <im_param>
        IMPORTING <ex_param> = <ex_param>
      ).
    CATCH cx_root INTO lx_root.
      RAISE CALL_FAILED.
  ENDTRY.

Mapping rules

Parameter pass mode in Local Interface

• PASSTYPE=0 (by value): use VALUE(<param>) TYPE <TYPNAME> in the comment block
• PASSTYPE=1 or 2 (by reference): use REFERENCE(<param>) TYPE <TYPNAME>

Local Interface comment format

The Local Interface block must be exact — SE37 uses it to regenerate the FM interface:

*"*"Local Interface:
*"  IMPORTING
*"     VALUE(IV_MATNR) TYPE  MATNR
*"  EXPORTING
*"     VALUE(EV_MAKTX) TYPE  MAKTX
*"  EXCEPTIONS
*"      CALL_FAILED

• Indent with 5 spaces after *", 4 more for each parameter
• Each type reference has exactly 2 spaces before TYPE and 2 spaces after TYPE

Write the generated source

Write {WORK_TEMP}\<GENERATED_FM_NAME>.abap.

Step 4 — Deploy via sap-se37

Run:

/sap-se37 <GENERATED_FM_NAME> {WORK_TEMP}\<GENERATED_FM_NAME>.abap

Pass:

• Function group: the function group from Step 1 (or sap_dev_function_group)
• Short text: RFC wrapper for <CLASS_NAME>-><METHOD_NAME> (max 70 chars)
• Package: from Step 1 (or sap_dev_package)
• Transport: from Step 1 (or sap_dev_transport_request)

If sap-se37 reports success, the wrapper FM is live.

Step 5 — Summary

Report:

RFC Wrapper Generated and Deployed
===================================
Class    : <CLASS_NAME>
Method   : <METHOD_NAME>
FM Name  : <GENERATED_FM_NAME>
Group    : <FUNCTION_GROUP>
Package  : <PACKAGE>

To call this FM via /sap-rfc-wrapper-fm:
  /sap-rfc-wrapper-fm <GENERATED_FM_NAME> [param=value ...]

Step 6 — Clean Up

cmd /c del {WORK_TEMP}\sap_rfc_read_cls_run.ps1

The generated .abap file is kept (it is the source of record for the FM).

Final — Log End

Log the run-end record. Best-effort.

On success:

powershell -ExecutionPolicy Bypass -File "<SAP_DEV_CORE_SHARED_DIR>\scripts\sap_log_helper.ps1" -Action end -StateFile "{WORK_TEMP}\sap_rfc_wrapper_class_run.json" -Status SUCCESS -ExitCode 0

On failure:

powershell -ExecutionPolicy Bypass -File "<SAP_DEV_CORE_SHARED_DIR>\scripts\sap_log_helper.ps1" -Action end -StateFile "{WORK_TEMP}\sap_rfc_wrapper_class_run.json" -Status FAILED -ExitCode 1 -ErrorClass <CLASS> -ErrorMsg "<short>"

Suggested <CLASS>: RFC_WRAPPER_FAILED, SE37_FAILED, RFC_LOGON_FAILED.

Troubleshooting