# Legacy System Tools - MCP ABAP ADT Server Generated from code in `src/handlers/**` (not from docs). Tools available on legacy SAP systems (BASIS < 7.50) connected via RFC. Legacy systems support a subset of tools — primarily Class, Interface, View, Program, Function Group/Module, Package (read/update/delete), Include, Unit Test, and common utilities. - Total tools: 168 - Read-Only: 25 - High-Level: 71 - Low-Level: 72 ## Navigation - [Read-Only Group](#read-only-group) - [Class](#read-only-class) - [ReadClass](#readclass-read-only-class) - [Enhancement](#read-only-enhancement) - [GetBadiImplementations](#getbadiimplementations-read-only-enhancement) - [Function Group](#read-only-function-group) - [ReadFunctionGroup](#readfunctiongroup-read-only-function-group) - [Function Module](#read-only-function-module) - [ReadFunctionModule](#readfunctionmodule-read-only-function-module) - [Gui Status](#read-only-gui-status) - [GetGuiStatusList](#getguistatuslist-read-only-gui-status) - [ReadGuiStatus](#readguistatus-read-only-gui-status) - [Include](#read-only-include) - [GetInclude](#getinclude-read-only-include) - [GetIncludesList](#getincludeslist-read-only-include) - [Interface](#read-only-interface) - [ReadInterface](#readinterface-read-only-interface) - [Package](#read-only-package) - [GetPackageContents](#getpackagecontents-read-only-package) - [ReadPackage](#readpackage-read-only-package) - [Program](#read-only-program) - [GetProgFullCode](#getprogfullcode-read-only-program) - [ReadProgram](#readprogram-read-only-program) - [Screen](#read-only-screen) - [GetScreensList](#getscreenslist-read-only-screen) - [ReadScreen](#readscreen-read-only-screen) - [System](#read-only-system) - [GetInactiveObjects](#getinactiveobjects-read-only-system) - [GetJobUsage](#getjobusage-read-only-system) - [GetSmartFormContent](#getsmartformcontent-read-only-system) - [GetSmartFormLayout](#getsmartformlayout-read-only-system) - [GetTcodeUsage](#gettcodeusage-read-only-system) - [GetUsageSnippets](#getusagesnippets-read-only-system) - [GetWhereUsed](#getwhereused-read-only-system) - [ReloadProfile](#reloadprofile-read-only-system) - [RenderSmartForm](#rendersmartform-read-only-system) - [View](#read-only-view) - [ReadView](#readview-read-only-view) - [High-Level Group](#high-level-group) - [Class](#high-level-class) - [CreateClass](#createclass-high-level-class) - [DeleteClass](#deleteclass-high-level-class) - [DeleteLocalDefinitions](#deletelocaldefinitions-high-level-class) - [DeleteLocalMacros](#deletelocalmacros-high-level-class) - [DeleteLocalTestClass](#deletelocaltestclass-high-level-class) - [DeleteLocalTypes](#deletelocaltypes-high-level-class) - [GetClass](#getclass-high-level-class) - [GetLocalDefinitions](#getlocaldefinitions-high-level-class) - [GetLocalMacros](#getlocalmacros-high-level-class) - [GetLocalTestClass](#getlocaltestclass-high-level-class) - [GetLocalTypes](#getlocaltypes-high-level-class) - [UpdateClass](#updateclass-high-level-class) - [UpdateLocalDefinitions](#updatelocaldefinitions-high-level-class) - [UpdateLocalMacros](#updatelocalmacros-high-level-class) - [UpdateLocalTestClass](#updatelocaltestclass-high-level-class) - [UpdateLocalTypes](#updatelocaltypes-high-level-class) - [Common](#high-level-common) - [ActivateObjects](#activateobjects-high-level-common) - [Function](#high-level-function) - [CreateFunctionGroup](#createfunctiongroup-high-level-function) - [CreateFunctionModule](#createfunctionmodule-high-level-function) - [UpdateFunctionGroup](#updatefunctiongroup-high-level-function) - [UpdateFunctionModule](#updatefunctionmodule-high-level-function) - [Function Group](#high-level-function-group) - [DeleteFunctionGroup](#deletefunctiongroup-high-level-function-group) - [GetFunctionGroup](#getfunctiongroup-high-level-function-group) - [Function Module](#high-level-function-module) - [DeleteFunctionModule](#deletefunctionmodule-high-level-function-module) - [GetFunctionModule](#getfunctionmodule-high-level-function-module) - [Gui Status](#high-level-gui-status) - [CreateGuiStatus](#createguistatus-high-level-gui-status) - [DeleteGuiStatus](#deleteguistatus-high-level-gui-status) - [GetGuiStatus](#getguistatus-high-level-gui-status) - [PatchGuiStatus](#patchguistatus-high-level-gui-status) - [UpdateGuiStatus](#updateguistatus-high-level-gui-status) - [Include](#high-level-include) - [CreateInclude](#createinclude-high-level-include) - [DeleteInclude](#deleteinclude-high-level-include) - [UpdateInclude](#updateinclude-high-level-include) - [Interface](#high-level-interface) - [CreateInterface](#createinterface-high-level-interface) - [DeleteInterface](#deleteinterface-high-level-interface) - [GetInterface](#getinterface-high-level-interface) - [UpdateInterface](#updateinterface-high-level-interface) - [Package](#high-level-package) - [GetPackage](#getpackage-high-level-package) - [Program](#high-level-program) - [CreateProgram](#createprogram-high-level-program) - [DeleteProgram](#deleteprogram-high-level-program) - [GetProgram](#getprogram-high-level-program) - [UpdateProgram](#updateprogram-high-level-program) - [Screen](#high-level-screen) - [CreateScreen](#createscreen-high-level-screen) - [DeleteScreen](#deletescreen-high-level-screen) - [GetScreen](#getscreen-high-level-screen) - [UpdateScreen](#updatescreen-high-level-screen) - [Smartform](#high-level-smartform) - [CreateSmartForm](#createsmartform-high-level-smartform) - [DeleteSmartForm](#deletesmartform-high-level-smartform) - [Text Element](#high-level-text-element) - [CreateTextElement](#createtextelement-high-level-text-element) - [DeleteTextElement](#deletetextelement-high-level-text-element) - [GetTextElement](#gettextelement-high-level-text-element) - [ReadTextElementsBulk](#readtextelementsbulk-high-level-text-element) - [UpdateTextElement](#updatetextelement-high-level-text-element) - [WriteTextElementsBulk](#writetextelementsbulk-high-level-text-element) - [Unit Test](#high-level-unit-test) - [CreateCdsUnitTest](#createcdsunittest-high-level-unit-test) - [CreateUnitTest](#createunittest-high-level-unit-test) - [DeleteCdsUnitTest](#deletecdsunittest-high-level-unit-test) - [DeleteUnitTest](#deleteunittest-high-level-unit-test) - [GetCdsUnitTest](#getcdsunittest-high-level-unit-test) - [GetCdsUnitTestResult](#getcdsunittestresult-high-level-unit-test) - [GetCdsUnitTestStatus](#getcdsunitteststatus-high-level-unit-test) - [GetUnitTest](#getunittest-high-level-unit-test) - [GetUnitTestResult](#getunittestresult-high-level-unit-test) - [GetUnitTestStatus](#getunitteststatus-high-level-unit-test) - [RunUnitTest](#rununittest-high-level-unit-test) - [UpdateCdsUnitTest](#updatecdsunittest-high-level-unit-test) - [UpdateUnitTest](#updateunittest-high-level-unit-test) - [View](#high-level-view) - [CreateView](#createview-high-level-view) - [DeleteView](#deleteview-high-level-view) - [GetView](#getview-high-level-view) - [UpdateView](#updateview-high-level-view) - [Low-Level Group](#low-level-group) - [Class](#low-level-class) - [ActivateClassLow](#activateclasslow-low-level-class) - [ActivateClassTestClassesLow](#activateclasstestclasseslow-low-level-class) - [CheckClassLow](#checkclasslow-low-level-class) - [CreateClassLow](#createclasslow-low-level-class) - [DeleteClassLow](#deleteclasslow-low-level-class) - [GetClassUnitTestResultLow](#getclassunittestresultlow-low-level-class) - [GetClassUnitTestStatusLow](#getclassunitteststatuslow-low-level-class) - [LockClassLow](#lockclasslow-low-level-class) - [LockClassTestClassesLow](#lockclasstestclasseslow-low-level-class) - [RunClassUnitTestsLow](#runclassunittestslow-low-level-class) - [UnlockClassLow](#unlockclasslow-low-level-class) - [UnlockClassTestClassesLow](#unlockclasstestclasseslow-low-level-class) - [UpdateClassLow](#updateclasslow-low-level-class) - [UpdateClassTestClassesLow](#updateclasstestclasseslow-low-level-class) - [ValidateClassLow](#validateclasslow-low-level-class) - [Common](#low-level-common) - [ActivateObjectLow](#activateobjectlow-low-level-common) - [Function](#low-level-function) - [ActivateFunctionGroupLow](#activatefunctiongrouplow-low-level-function) - [ActivateFunctionModuleLow](#activatefunctionmodulelow-low-level-function) - [CheckFunctionGroupLow](#checkfunctiongrouplow-low-level-function) - [CheckFunctionModuleLow](#checkfunctionmodulelow-low-level-function) - [CreateFunctionGroupLow](#createfunctiongrouplow-low-level-function) - [CreateFunctionModuleLow](#createfunctionmodulelow-low-level-function) - [DeleteFunctionGroupLow](#deletefunctiongrouplow-low-level-function) - [DeleteFunctionModuleLow](#deletefunctionmodulelow-low-level-function) - [LockFunctionGroupLow](#lockfunctiongrouplow-low-level-function) - [LockFunctionModuleLow](#lockfunctionmodulelow-low-level-function) - [UnlockFunctionGroupLow](#unlockfunctiongrouplow-low-level-function) - [UnlockFunctionModuleLow](#unlockfunctionmodulelow-low-level-function) - [UpdateFunctionModuleLow](#updatefunctionmodulelow-low-level-function) - [ValidateFunctionGroupLow](#validatefunctiongrouplow-low-level-function) - [ValidateFunctionModuleLow](#validatefunctionmodulelow-low-level-function) - [Gui Status](#low-level-gui-status) - [ActivateGuiStatusLow](#activateguistatuslow-low-level-gui-status) - [CreateGuiStatusLow](#createguistatuslow-low-level-gui-status) - [DeleteGuiStatusLow](#deleteguistatuslow-low-level-gui-status) - [LockGuiStatusLow](#lockguistatuslow-low-level-gui-status) - [UnlockGuiStatusLow](#unlockguistatuslow-low-level-gui-status) - [UpdateGuiStatusLow](#updateguistatuslow-low-level-gui-status) - [Interface](#low-level-interface) - [ActivateInterfaceLow](#activateinterfacelow-low-level-interface) - [CheckInterfaceLow](#checkinterfacelow-low-level-interface) - [CreateInterfaceLow](#createinterfacelow-low-level-interface) - [DeleteInterfaceLow](#deleteinterfacelow-low-level-interface) - [LockInterfaceLow](#lockinterfacelow-low-level-interface) - [UnlockInterfaceLow](#unlockinterfacelow-low-level-interface) - [UpdateInterfaceLow](#updateinterfacelow-low-level-interface) - [ValidateInterfaceLow](#validateinterfacelow-low-level-interface) - [Package](#low-level-package) - [CheckPackageLow](#checkpackagelow-low-level-package) - [DeletePackageLow](#deletepackagelow-low-level-package) - [LockPackageLow](#lockpackagelow-low-level-package) - [UnlockPackageLow](#unlockpackagelow-low-level-package) - [UpdatePackageLow](#updatepackagelow-low-level-package) - [Program](#low-level-program) - [ActivateProgramLow](#activateprogramlow-low-level-program) - [CheckProgramLow](#checkprogramlow-low-level-program) - [CreateProgramLow](#createprogramlow-low-level-program) - [DeleteProgramLow](#deleteprogramlow-low-level-program) - [LockProgramLow](#lockprogramlow-low-level-program) - [UnlockProgramLow](#unlockprogramlow-low-level-program) - [UpdateProgramLow](#updateprogramlow-low-level-program) - [ValidateProgramLow](#validateprogramlow-low-level-program) - [Screen](#low-level-screen) - [ActivateScreenLow](#activatescreenlow-low-level-screen) - [CreateScreenLow](#createscreenlow-low-level-screen) - [DeleteScreenLow](#deletescreenlow-low-level-screen) - [LockScreenLow](#lockscreenlow-low-level-screen) - [UnlockScreenLow](#unlockscreenlow-low-level-screen) - [UpdateScreenLow](#updatescreenlow-low-level-screen) - [View](#low-level-view) - [ActivateViewLow](#activateviewlow-low-level-view) - [CheckViewLow](#checkviewlow-low-level-view) - [CreateViewLow](#createviewlow-low-level-view) - [DeleteViewLow](#deleteviewlow-low-level-view) - [LockViewLow](#lockviewlow-low-level-view) - [UnlockViewLow](#unlockviewlow-low-level-view) - [UpdateViewLow](#updateviewlow-low-level-view) - [ValidateViewLow](#validateviewlow-low-level-view) --- ## Read-Only Group ### Read-Only / Class #### ReadClass (Read-Only / Class) **Description:** [read-only] Read ABAP class source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/class/readonly/handleReadClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Enhancement #### GetBadiImplementations (Read-Only / Enhancement) **Description:** [read-only] Find implementations of a (classic) BAdI definition. Use during symptom analysis when a standard SAP BAdI is implicated — answers 'which Z class extends this standard BAdI?'. Example flow: PO BAPI error → ME_PROCESS_PO_CUST → list Z impls → read the impl class source via GetClass to find the bug. Currently ECC-only (routes through the ZMCP_ADT_DDIC_BADI bridge FM). Classic BAdI only; kernel BAdI returns kind='unknown'. **Source:** `src/handlers/enhancement/readonly/handleGetBadiImplementations.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `active_only` (boolean, optional (default: true)) - Restrict to active implementations only. Default: true. - `badi_definition` (string, required) - BAdI definition name (e.g., ME_PROCESS_PO_CUST). Will be uppercased. - `customer_only` (boolean, optional (default: true)) - Restrict to Z*/Y* implementations. Default: true. Set false to include SAP-shipped implementations. - `include_methods` (boolean, optional (default: true)) - Include the list of redefined method names per implementation (from SXC_EXIT). Default: true. --- ### Read-Only / Function Group #### ReadFunctionGroup (Read-Only / Function Group) **Description:** [read-only] Read ABAP function group source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/function_group/readonly/handleReadFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - Function group name (e.g., Z_MY_FG). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Function Module #### ReadFunctionModule (Read-Only / Function Module) **Description:** [read-only] Read ABAP function module source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/function_module/readonly/handleReadFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - Function group name containing the function module (e.g., Z_MY_FG). - `function_module_name` (string, required) - Function module name (e.g., Z_MY_FM). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Gui Status #### GetGuiStatusList (Read-Only / Gui Status) **Description:** [read-only] List all GUI statuses belonging to an ABAP program. **Source:** `src/handlers/gui_status/readonly/handleGetGuiStatusList.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Program name (e.g., SAPMV45A). --- #### ReadGuiStatus (Read-Only / Gui Status) **Description:** [read-only] Read ABAP GUI Status definition (statuses, function codes, menus, toolbars, titles) for a program. **Source:** `src/handlers/gui_status/readonly/handleReadGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Parent program name (e.g., SAPMV45A). --- ### Read-Only / Include #### GetInclude (Read-Only / Include) **Description:** [read-only] Retrieve source code of a specific ABAP include file. **Source:** `src/handlers/include/readonly/handleGetInclude.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - None --- #### GetIncludesList (Read-Only / Include) **Description:** [read-only] Recursively discover and list ALL include files within an ABAP program or include. **Source:** `src/handlers/include/readonly/handleGetIncludesList.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `detailed` (boolean, optional (default: false)) - If true, returns structured JSON with metadata and raw XML. - `object_name` (string, required) - Name of the ABAP program or include - `object_type` (string, required) - ADT object type (e.g. PROG/P, PROG/I, FUGR, CLAS/OC) - `timeout` (number, optional) - Timeout in ms for each ADT request. --- ### Read-Only / Interface #### ReadInterface (Read-Only / Interface) **Description:** [read-only] Read ABAP interface source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/interface/readonly/handleReadInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., ZIF_MY_INTERFACE). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Package #### GetPackageContents (Read-Only / Package) **Description:** [read-only] Retrieve objects inside an ABAP package as a flat list. Supports recursive traversal of subpackages. **Source:** `src/handlers/package/readonly/handleGetPackageContents.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - None --- #### ReadPackage (Read-Only / Package) **Description:** [read-only] Read ABAP package definition and metadata (super-package, responsible, description, etc.). **Source:** `src/handlers/package/readonly/handleReadPackage.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `package_name` (string, required) - Package name (e.g., Z_MY_PACKAGE). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Program #### GetProgFullCode (Read-Only / Program) **Description:** [read-only] Returns the full code for a program or function group, including all includes, in tree traversal order. Use output="file" to get paths + outlines instead of the code. **Source:** `src/handlers/program/readonly/handleGetProgFullCode.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `name` (string, required) - Technical name of the program or function group (e.g., '/CBY/MM_INVENTORY') - `output` (string, optional (default: inline)) - - `type` (string, required) - 'PROG/P' for program or 'FUGR' for function group --- #### ReadProgram (Read-Only / Program) **Description:** [read-only] Read ABAP program source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/program/readonly/handleReadProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Screen #### GetScreensList (Read-Only / Screen) **Description:** [read-only] List all screens (dynpros) belonging to an ABAP program. **Source:** `src/handlers/screen/readonly/handleGetScreensList.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Program name (e.g., SAPMV45A). --- #### ReadScreen (Read-Only / Screen) **Description:** [read-only] Read ABAP Screen (Dynpro) flow logic source code, fields, and metadata. **Source:** `src/handlers/screen/readonly/handleReadScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Parent program name (e.g., SAPMV45A). - `screen_number` (string, required) - Screen number (e.g., 0100). --- ### Read-Only / System #### GetInactiveObjects (Read-Only / System) **Description:** [read-only] Get a list of inactive ABAP objects — modified but not yet activated, pending activation. Shows classes, tables, CDS views, and other objects awaiting activation. **Source:** `src/handlers/system/readonly/handleGetInactiveObjects.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - None --- #### GetJobUsage (Read-Only / System) **Description:** [read-only] Check whether programs are used as background job steps (SM37 jobs, TBTCO/TBTCP): true when the program is a step of a job that is scheduled now (released/ready/active, incl. periodic) or that finished/was cancelled in the last N months. SE38/SA38 dialog runs do not count. `oldest` = start date of the oldest finished job still kept; job reorganization deletes older ones, so when `complete` is false a false means "no job since ". No user names are returned. ECC-only (ZMCP_WL_JOB_USAGE bridge FM). **Source:** `src/handlers/system/readonly/handleGetJobUsage.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `months` (number, optional (default: 12)) - Months back including the current one (1-36). Default: 12. - `programs` (array, required) - ABAP program names to check (e.g. ["ZMY_REPORT"]). --- #### GetSmartFormContent (Read-Only / System) **Description:** [read-only] Read what a SmartForm prints, for a preview: per page and window (position in mm) the content tree — text nodes with their lines (paragraph format + text with inline tags and &symbols&), include texts, tables / templates / loops with line types and cells, graphics, addresses, conditions; code nodes appear only as markers (no program lines). Also fetches the SmartStyles as CSS, the SE78 graphics with a fixed key as BMP files (with printed size) and the include texts with a fixed key. Graphics / texts whose key holds a &symbol& are listed under dynamicReferences. Active version, texts in the logon language. Files go under the MCP output directory (smartforms/
/), including .content.json with the full result; summary=true answers with an overview (windows, data declarations, &symbols&, files) instead of the content tree. Needs the ZMCP_SSF_CONTENT FM and the SSF_CONTENT dispatcher action. **Source:** `src/handlers/system/readonly/handleGetSmartFormContent.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `device` (string, optional) - Output device whose printer fonts the preview should assume. Default: a device whose type has fonts for most of the families of the form. - `form_name` (string, required) - SmartForm name (e.g. "ZMY_FORM"). - `include_graphics` (boolean, optional) - Fetch SE78 graphics with a fixed key as BMP files. Default true. - `include_styles` (boolean, optional) - Fetch the SmartStyles (form default + text node styles) as CSS. Default true. - `include_texts` (boolean, optional) - Fetch include texts (SO10) with a fixed key. Default true. - `summary` (boolean, optional) - Answer with an overview (windows, data declarations, &symbols&, graphics, files) instead of the full content tree; the full result is always written to files.content. Default false. - `text_language` (string, optional) - Language for include texts whose key has no language: 1-char SAP key (e.g. "3") or 2-letter ISO code (e.g. "KO"). Default: the form language. - `values` (object, optional) - Sample values for &symbols& in graphic keys (e.g. {"IM_SIGN": "ZSIGN"}): graphics named by a variable are then fetched too. --- #### GetSmartFormLayout (Read-Only / System) **Description:** [read-only] Read the page and window layout of a SmartForm (active version; a never-activated form is read from its saved version, then `active` is false): per page the format, orientation, next page, CPI / LPI and style, and per window its type (MAIN / SECONDARY / ...), position and size as stored (value + unit) and converted to millimetres. Layout only: no texts, code or form interface. Needs the ZMCP_SSF_LAYOUT FM and the SSF_LAYOUT dispatcher action. **Source:** `src/handlers/system/readonly/handleGetSmartFormLayout.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `form_name` (string, required) - SmartForm name (e.g. "ZMY_FORM"). - `language` (string, optional) - Form language: 1-char SAP key (e.g. "E", "3") or 2-letter ISO code (e.g. "EN", "KO"). Default: the master language of the form. --- #### GetTcodeUsage (Read-Only / System) **Description:** [read-only] Check whether transactions were used in the last N months, from the ST03N workload monthly aggregates. Returns one boolean per transaction plus `coverage` = months that actually hold workload data; when coverage < months, false means "not used in the last months". No user names are returned. ECC-only (ZMCP_WL_TCODE_USAGE bridge FM). **Source:** `src/handlers/system/readonly/handleGetTcodeUsage.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `destination` (string, optional) - SM59 RFC destination (on the connected system) of the system to measure, e.g. the QA or PRD system. Omitted → SAP_USAGE_RFCDEST from the profile sap.env, else the connected system. "" or "LOCAL" → the connected system. - `months` (number, optional (default: 12)) - Months back including the current one (1-36). Default: 12. - `tcodes` (array, required) - Transaction codes to check (e.g. ["VA01","ZMY_TCODE"]). --- #### GetUsageSnippets (Read-Only / System) **Description:** [read-only] Line-level where-used hits: for each referencing object, the source lines that use the searched object, with uri ".../source/main#start=,", line, column and the source line. Pass object_identifiers from GetWhereUsed references[].object_identifier, or object_name + object_type to run the where-used search first (customer_only / package filters apply to that search). Works on ECC 7.40 and S/4HANA. **Source:** `src/handlers/system/readonly/handleGetUsageSnippets.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `customer_only` (boolean, optional (default: false)) - With object_name: only customer referencing objects (Z / Y name, or package Z* / Y* / $*). Default: false. - `include_context` (boolean, optional (default: false)) - Include the multi-line context SAP returns per hit (description). Default: false. - `max_objects` (number, optional) - Cap on referencing objects whose snippets are fetched. Default: ${DEFAULT_MAX_OBJECTS}. truncated=true when more were available. - `object_identifiers` (array, optional) - object_identifier values from GetWhereUsed references[]. Takes precedence over object_name / object_type. - `object_name` (string, optional) - Object to search (used when object_identifiers is not given). - `object_type` (string, optional) - Object type for object_name: ${SUPPORTED_WHERE_USED_TYPES} - `package` (string, optional) - With object_name: package filter on the referencing objects (exact, or prefix with trailing *). - `timeout_ms` (number, optional) - Optional request timeout in ms per SAP request (the where-used search and each snippet batch). --- #### GetWhereUsed (Read-Only / System) **Description:** [read-only] Find where-used references (cross-references, usages, dependencies) for ABAP objects — classes, interfaces, tables, data elements, programs, function modules, etc. Returns list of all referencing objects with their types and packages. On ECC a function module may be given by plain name (no GROUP|FM needed). Widely used SAP standard tables (e.g. VBAK) can take about 60 s and return thousands of references — use customer_only / package / max_results to shrink the answer (filtering happens after the SAP search, so it does not shorten the search time). Pass references[].object_identifier to GetUsageSnippets for line-level hits. **Source:** `src/handlers/system/readonly/handleGetWhereUsed.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `customer_only` (boolean, optional (default: false)) - Optional. Keep only customer objects: name starting with Z / Y, or package Z* / Y* / $*. Objects in /namespace/ (SAP industry solutions, partners, generated /1.../) are dropped; for a registered customer namespace use package: "/ACME/*" instead. Default: false. - `enable_all_types` (boolean, optional (default: false)) - If true, searches in all available object types (Eclipse 'select all' behavior). Default: false (uses SAP default scope). Ignored on ECC (no scope resource). - `max_results` (number, optional) - Optional cap on references[] after filtering. Omit or 0 = no cap. truncated=true when more were found. - `object_name` (string, required) - Name of the ABAP object - `object_type` (string, required) - Type of the ABAP object: ${SUPPORTED_WHERE_USED_TYPES} - `package` (string, optional) - Optional package filter on references[].package_name: exact name, or prefix with a trailing * (e.g. ZSD*). - `timeout_ms` (number, optional) - Optional request timeout in ms for the SAP search. Default: SAP_TIMEOUT_LONG (120 s) on ECC, SAP_TIMEOUT_DEFAULT (45 s) otherwise. --- #### ReloadProfile (Read-Only / System) **Description:** [system] Reload the active SAP profile from .sc4sap/active-profile.txt and reset the cached connection. Called by the sc4sap plugin after switching profiles. Returns the newly active alias, host, tier, and readonly status. **Source:** `src/handlers/system/readonly/handleReloadProfile.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - None --- #### RenderSmartForm (Read-Only / System) **Description:** [runs the form, no output] The output of a SmartForm as SAP prints it, for given interface values: calls the generated function module with GETOTF (no dialog, no print, no spool) and writes the OTF (text: positions, fonts, strings) and the PDF under the MCP output directory (smartforms//.sap.otf.txt / .sap.pdf). The form's own program lines run as in a real print and may read the database — pass invented sample values only. Needs the ZMCP_SSF_RENDER FM and the SSF_RENDER dispatcher action. **Source:** `src/handlers/system/readonly/handleRenderSmartForm.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `device` (string, optional) - Output device whose device type sets fonts and character widths (e.g. the printer the form goes to). Default: the user default device, else a SAPWIN / PDF device. - `families` (array, optional) - Font families the form uses (from GetSmartFormContent styles). Without `device`, a device whose type has printer fonts for most of them is used, so the output shows the fonts the form was made for. - `form_name` (string, required) - SmartForm name (e.g. "ZMY_FORM"). - `language` (string, optional) - Output language: 1-char SAP key or 2-letter ISO code. Default: logon language. - `values` (object, optional) - Interface parameter → value, in internal format: structures as objects with the ABAP component names, TABLES parameters / table types as arrays, dates "2026-10-16", times "14:00:00", amounts and quantities as numbers. Parameters left out are passed initial. - `values_file` (string, optional) - Path of a JSON file with the same object as `values` (for large interfaces). Ignored when `values` is given. --- ### Read-Only / View #### ReadView (Read-Only / View) **Description:** [read-only] Read ABAP view (CDS view) source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/view/readonly/handleReadView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". - `view_name` (string, required) - View name (e.g., Z_MY_VIEW). --- ## High-Level Group ### High-Level / Class #### CreateClass (High-Level / Class) **Description:** Create a new ABAP class in SAP system. Creates the class object in initial state. Use UpdateClass to set source code afterwards. **Source:** `src/handlers/class/high/handleCreateClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `abstract` (boolean, optional) - Mark class as abstract. Default: false - `class_name` (string, required) - Class name (e.g., ZCL_TEST_CLASS_001). - `create_protected` (boolean, optional) - Protected constructor. Default: false - `description` (string, optional) - Class description (defaults to class_name). - `final` (boolean, optional) - Mark class as final. Default: false - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP). - `superclass` (string, optional) - Optional superclass name. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteClass (High-Level / Class) **Description:** Delete an ABAP class from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/class/high/handleDeleteClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### DeleteLocalDefinitions (High-Level / Class) **Description:** Delete local definitions from an ABAP class by clearing the definitions include. Manages lock, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleDeleteLocalDefinitions.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate_on_delete` (boolean, optional (default: false)) - Activate parent class after deleting. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request number. --- #### DeleteLocalMacros (High-Level / Class) **Description:** Delete local macros from an ABAP class by clearing the macros include. Manages lock, update, unlock, and optional activation. Note: Macros are supported in older ABAP versions but not in newer ones. **Source:** `src/handlers/class/high/handleDeleteLocalMacros.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate_on_delete` (boolean, optional (default: false)) - Activate parent class after deleting. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request number. --- #### DeleteLocalTestClass (High-Level / Class) **Description:** Delete a local test class from an ABAP class by clearing the testclasses include. Manages lock, update, unlock, and optional activation of parent class. **Source:** `src/handlers/class/high/handleDeleteLocalTestClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate_on_delete` (boolean, optional (default: false)) - Activate parent class after deleting test class. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request number (required for transportable objects). --- #### DeleteLocalTypes (High-Level / Class) **Description:** Delete local types from an ABAP class by clearing the implementations include. Manages lock, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleDeleteLocalTypes.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate_on_delete` (boolean, optional (default: false)) - Activate parent class after deleting. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request number. --- #### GetClass (High-Level / Class) **Description:** Retrieve ABAP class source code. Supports reading active or inactive version. **Source:** `src/handlers/class/high/handleGetClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `output` (string, optional (default: inline)) - - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### GetLocalDefinitions (High-Level / Class) **Description:** Retrieve local definitions source code from a class (definitions include). Supports reading active or inactive version. **Source:** `src/handlers/class/high/handleGetLocalDefinitions.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### GetLocalMacros (High-Level / Class) **Description:** Retrieve local macros source code from a class (macros include). Supports reading active or inactive version. Note: Macros are supported in older ABAP versions but not in newer ones. **Source:** `src/handlers/class/high/handleGetLocalMacros.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### GetLocalTestClass (High-Level / Class) **Description:** Retrieve local test class source code from a class. Supports reading active or inactive version. **Source:** `src/handlers/class/high/handleGetLocalTestClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### GetLocalTypes (High-Level / Class) **Description:** Retrieve local types source code from a class (implementations include). Supports reading active or inactive version. **Source:** `src/handlers/class/high/handleGetLocalTypes.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### UpdateClass (High-Level / Class) **Description:** Update source code of an existing ABAP class. Locks, checks, updates, unlocks, and optionally activates. **Source:** `src/handlers/class/high/handleUpdateClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate after update. Default: false. - `class_name` (string, required) - Class name (e.g., ZCL_TEST_CLASS_001). - `source_code` (string, required) - Complete ABAP class source code. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### UpdateLocalDefinitions (High-Level / Class) **Description:** Update local definitions in an ABAP class (definitions include). Manages lock, check, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleUpdateLocalDefinitions.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate_on_update` (boolean, optional (default: false)) - Activate parent class after updating. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `definitions_code` (string, required) - Updated source code for local definitions. - `transport_request` (string, optional) - Transport request number. --- #### UpdateLocalMacros (High-Level / Class) **Description:** Update local macros in an ABAP class (macros include). Manages lock, check, update, unlock, and optional activation. Note: Macros are supported in older ABAP versions but not in newer ones. **Source:** `src/handlers/class/high/handleUpdateLocalMacros.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate_on_update` (boolean, optional (default: false)) - Activate parent class after updating. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `macros_code` (string, required) - Updated source code for local macros. - `transport_request` (string, optional) - Transport request number. --- #### UpdateLocalTestClass (High-Level / Class) **Description:** Update a local test class in an ABAP class. Manages lock, check, update, unlock, and optional activation of parent class. **Source:** `src/handlers/class/high/handleUpdateLocalTestClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate_on_update` (boolean, optional (default: false)) - Activate parent class after updating test class. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `test_class_code` (string, required) - Updated source code for the local test class. - `transport_request` (string, optional) - Transport request number (required for transportable objects). --- #### UpdateLocalTypes (High-Level / Class) **Description:** Update local types in an ABAP class (implementations include). Manages lock, check, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleUpdateLocalTypes.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate_on_update` (boolean, optional (default: false)) - Activate parent class after updating. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `local_types_code` (string, required) - Updated source code for local types. - `transport_request` (string, optional) - Transport request number. --- ### High-Level / Common #### ActivateObjects (High-Level / Common) **Description:** [high-level] Activate a set of ABAP objects in a single call. Uses the ADT mass-activation endpoint (/sap/bc/adt/activation/runs) so cyclic references between siblings (e.g. main program + multiple cross-referencing includes) resolve in one compilation scope. Returns per-object status, errors, warnings. Falls back to /sap/bc/adt/activation on legacy systems. **Source:** `src/handlers/common/high/handleActivateObjects.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `objects` (array, required) - Objects to activate in one batch. Supply either explicit uri, or name+type (and parent_name for FUGR/FF, FUGR/I). - `preaudit` (boolean, optional) - Request pre-audit before activation. Default true. - `run_timeout_ms` (number, optional) - Max time to wait for the activation run to finish (runs endpoint only). Default 120000. --- ### High-Level / Function #### CreateFunctionGroup (High-Level / Function) **Description:** Create a new ABAP function group in SAP system. Function groups serve as containers for function modules. Uses stateful session for proper lock management. **Source:** `src/handlers/function/high/handleCreateFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate function group after creation. Default: true. Set to false for batch operations. - `description` (string, optional) - Function group description. If not provided, function_group_name will be used. - `function_group_name` (string, required) - Function group name (e.g., ZTEST_FG_001). Must follow SAP naming conventions (start with Z or Y, max 26 chars). - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP for local objects) - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### CreateFunctionModule (High-Level / Function) **Description:** Create a new ABAP function module within an existing function group. Creates the function module in initial state. Use UpdateFunctionModule to set source code afterwards. **Source:** `src/handlers/function/high/handleCreateFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, optional) - Optional description for the function module - `function_group_name` (string, required) - Parent function group name (e.g., ZTEST_FG_001) - `function_module_name` (string, required) - Function module name (e.g., Z_TEST_FUNCTION_001). Must follow SAP naming conventions (start with Z or Y, max 30 chars). - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### UpdateFunctionGroup (High-Level / Function) **Description:** Update metadata (description) of an existing ABAP function group. Function groups are containers for function modules and don't have source code to update directly. Uses stateful session with proper lock/unlock mechanism. **Source:** `src/handlers/function/high/handleUpdateFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, required) - New description for the function group. - `function_group_name` (string, required) - Function group name (e.g., ZTEST_FG_001). Must exist in the system. - `transport_request` (string, optional) - Transport request. Optional if the object is local or already in one. --- #### UpdateFunctionModule (High-Level / Function) **Description:** Update source code of an existing ABAP function module. Locks the function module, uploads new source code, and unlocks. Optionally activates after update. Use this to modify existing function modules without re-creating metadata. **Source:** `src/handlers/function/high/handleUpdateFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate function module after source update. Default: false. Set to true to activate immediately. - `function_group_name` (string, required) - Function group name containing the function module (e.g., ZOK_FG_MCP01). - `function_module_name` (string, required) - Function module name (e.g., Z_TEST_FM_MCP01). Function module must already exist. - `source_code` (string, required) - Complete ABAP function module source code. Must include FUNCTION statement with parameters and ENDFUNCTION. Example: FUNCTION Z_TEST_FM IMPORTING VALUE(iv_input) TYPE string EXPORTING VALUE(ev_output) TYPE string. ev_output = iv_input. ENDFUNCTION. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable function modules. For local objects ($TMP package) this can be omitted — the handler defaults to "local". --- ### High-Level / Function Group #### DeleteFunctionGroup (High-Level / Function Group) **Description:** Delete an ABAP function group from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/function_group/high/handleDeleteFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_FUNCTIONGROUP). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetFunctionGroup (High-Level / Function Group) **Description:** Retrieve ABAP function group definition. Supports reading active or inactive version. **Source:** `src/handlers/function_group/high/handleGetFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_FUNCTIONGROUP). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- ### High-Level / Function Module #### DeleteFunctionModule (High-Level / Function Module) **Description:** Delete an ABAP function module from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/function_module/high/handleDeleteFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name containing the function module (e.g., Z_MY_FUNCTIONGROUP). - `function_module_name` (string, required) - FunctionModule name (e.g., Z_MY_FUNCTIONMODULE). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetFunctionModule (High-Level / Function Module) **Description:** Retrieve ABAP function module definition. Supports reading active or inactive version. **Source:** `src/handlers/function_module/high/handleGetFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name containing the function module (e.g., Z_MY_FUNCTIONGROUP). - `function_module_name` (string, required) - FunctionModule name (e.g., Z_MY_FUNCTIONMODULE). - `output` (string, optional (default: inline)) - - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- ### High-Level / Gui Status #### CreateGuiStatus (High-Level / Gui Status) **Description:** Create a new ABAP GUI Status on an existing program. Optionally activates after creation. **Source:** `src/handlers/gui_status/high/handleCreateGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate after creation. Default: false. - `description` (string, optional) - GUI Status description. - `program_name` (string, required) - Parent program name (e.g., Z_MY_PROGRAM). - `status_name` (string, required) - GUI Status name to create (e.g., MAIN_STATUS). - `status_type` (string, optional) - Status type: "N" (normal screen/list status, stored as MODAL D), "P" (dialog box/popup, MODAL P), "C" (context menu, MODAL C). Default: "N". - `transport_request` (string, optional) - Transport request number. --- #### DeleteGuiStatus (High-Level / Gui Status) **Description:** Delete an ABAP GUI Status from a program. Handles lock/unlock automatically. **Source:** `src/handlers/gui_status/high/handleDeleteGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Parent program name. - `status_name` (string, required) - GUI Status name to delete. - `transport_request` (string, optional) - Transport request number. --- #### GetGuiStatus (High-Level / Gui Status) **Description:** Get ABAP GUI Status definition including statuses, function codes, menus, toolbars, and titles. A large program interface is big: pass status_name and/or function_codes to narrow every table, and format="compact" for one line per function (code, text, icon, function key, toolbar). **Source:** `src/handlers/gui_status/high/handleGetGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `format` (string, optional) - full (default) = CUA tables; compact = { statuses: [{ code, type, functions: [{ code, text, icon?, fkey?, toolbar? }] }] }. - `function_codes` (array, optional) - Optional: function codes to keep (e.g. ["SAVE", "CRPO"]). Narrows FUN / SET / PFK / BUT to them. - `program_name` (string, required) - Parent program name (e.g., SAPMV45A). - `status_name` (string, optional) - Optional: one GUI Status name. Narrows every table to that status (its SET functions, FUN texts, PFK keys, BUT toolbar, ACT / MEN / MTX menus); TIT / DOC / BIV are left out. If omitted, returns all statuses. --- #### PatchGuiStatus (High-Level / Gui Status) **Description:** Row-level merge into an existing ABAP GUI Status definition. Fetches current CUA → merges the caller-supplied changes (by natural key) → writes merged result back. Rows / fields you omit are preserved. Safer default for targeted edits; use UpdateGuiStatus only when you truly want to replace the whole CUA. Merge keys per table: STA=CODE, FUN=CODE, PFK=CODE+PFNO, BUT=PFK_CODE+CODE+NO, TIT=CODE, MEN=CODE+NO, MTX=CODE, ACT=CODE+NO, SET=STATUS+FUNCTION, DOC=OBJ_TYPE+OBJ_CODE, BIV=CODE+POS. **Source:** `src/handlers/gui_status/high/handlePatchGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate after patch. Default: false. - `changes` (string, required) - Partial CUA data to merge into the current definition. Same shape as cua_data (ADM / STA / FUN / MEN / MTX / ACT / BUT / PFK / SET / DOC / TIT / BIV). Accepts JSON string or object. Rows matched by natural key are field-merged (changes win). New rows are appended. Omitted tables are left untouched. - `program_name` (string, required) - Parent program name. - `skip_validation` (boolean, optional) - Skip client-side validation of the merged result. Default: false. - `transport_request` (string, optional) - Transport request number. --- #### UpdateGuiStatus (High-Level / Gui Status) **Description:** ⚠️ FULL REPLACE — overwrites the entire GUI Status definition (all 12 CUA tables) for the program. Any row or field you omit is DROPPED. Always Read (ReadGuiStatus) → modify → Update, or use PatchGuiStatus for row-level merges. cua_data must include complete STA / FUN / PFK / BUT / TIT rows with all required fields (CODE, PFNO, FUNCODE, ...). Handles lock/unlock automatically. **Source:** `src/handlers/gui_status/high/handleUpdateGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate after update. Default: false. - `cua_data` (string, required) - Complete CUA data — accepts either a JSON string or a structured object with ADM / STA / FUN / MEN / MTX / ACT / BUT / PFK / SET / DOC / TIT / BIV. Required row fields: STA.CODE, FUN.CODE, PFK.{CODE,PFNO,FUNCODE}, BUT.{PFK_CODE,CODE,NO,PFNO}, TIT.CODE. Missing rows are dropped — this is full-replace semantics. - `program_name` (string, required) - Parent program name. - `skip_validation` (boolean, optional) - Skip client-side schema validation. Default: false. Only set true if you know the CUA payload is intentionally partial and SAP will accept it. - `transport_request` (string, optional) - Transport request number. --- ### High-Level / Include #### CreateInclude (High-Level / Include) **Description:** Create a new ABAP Include program (Type I, PROG/I) in SAP system. Creates the include object and registers it under the main program in D010INC. By default also auto-inserts an `INCLUDE .` statement into the main program source so the include is actually used. Use UpdateInclude to set source code afterwards. Unlike CreateProgram with program_type=include (which creates PROG/P), this creates a proper PROG/I include. For mass-activation scenarios (many cross-referencing includes) pass source_code inline, set activate_main_program=false and skip_program_tree_check=true, then call ActivateObjects once with the full set. **Source:** `src/handlers/include/high/handleCreateInclude.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate_main_program` (boolean, optional) - When inserting INCLUDE statement into the main program, also activate the main program afterwards. Default: true (existing behavior). Set false when batching many includes so that activation is deferred to a single ActivateObjects call. - `description` (string, optional) - Include description (max 60 chars). If not provided, include_name will be used. - `include_name` (string, required) - Include program name (e.g., ZPAEK_TEST_INC01). Must follow SAP naming conventions (start with Z or Y). - `insert_into_main` (boolean, optional) - Auto-insert `INCLUDE .` statement into the main program source. Default: true. Set false to skip main-program modification. - `main_program` (string, required) - Name of the main/master program that will contain this include (e.g., ZPAEK_TEST003). Required for proper include registration and activation. - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP for local objects). - `skip_program_tree_check` (boolean, optional) - Skip the post-create program-tree syntax check. Default: false (existing behavior). Set true when batching many cross-referencing includes — an intermediate include in a cycle will necessarily fail the tree check while its siblings are still missing. - `source_code` (string, optional) - Optional include body. When provided, the handler also locks, writes the source, and unlocks the new include in a single call. Never activates — caller must run a separate activation (ActivateObjects for batch scenarios). - `transport_request` (string, optional) - Transport request number (e.g., S4HK904224). Required for transportable packages. Optional for local ($TMP) objects. --- #### DeleteInclude (High-Level / Include) **Description:** Delete an existing ABAP Include program (Type I) from the SAP system via ADT API. If the include is referenced by a main program, provide main_program so the handler can first remove the `INCLUDE .` line from the main program source before deleting. **Source:** `src/handlers/include/high/handleDeleteInclude.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `include_name` (string, required) - Include program name to delete. - `main_program` (string, optional) - Optional. Name of the main program referencing this include. If provided, the `INCLUDE .` line is removed from the main program source first (so the include is no longer referenced and delete succeeds). - `remove_from_main` (boolean, optional) - Auto-remove `INCLUDE .` line from main program source. Default: true when main_program is provided. Set false to skip the main-program modification. - `transport_request` (string, optional) - Transport request number. Required for transportable packages. Optional for local ($TMP) objects. Also used for updating the main program if main_program is provided. --- #### UpdateInclude (High-Level / Include) **Description:** Update source code of an existing ABAP Include program (Type I). Locks the include, uploads new source code, and unlocks. Optionally activates after update. Use this instead of UpdateProgram for Type I include programs. **Source:** `src/handlers/include/high/handleUpdateInclude.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate include after source update. Default: false. Set to true to activate immediately. - `include_name` (string, required) - Include program name. Must already exist as Type I include in SAP. - `main_program` (string, optional) - Name of the parent/master program that contains this include. When provided, a program-wide syntax check is run after the source is uploaded to catch ABAP errors in the new include code. Highly recommended. - `source_code` (string, required) - Complete ABAP include source code. Do NOT include a REPORT statement — include programs start directly with code or comments. - `transport_request` (string, optional) - Transport request number. Required for transportable packages. --- ### High-Level / Interface #### CreateInterface (High-Level / Interface) **Description:** Create a new ABAP interface in SAP system. Creates the interface object in initial state. Use UpdateInterface to set source code afterwards. **Source:** `src/handlers/interface/high/handleCreateInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, optional) - Interface description. If not provided, interface_name will be used. - `interface_name` (string, required) - Interface name (e.g., ZIF_TEST_INTERFACE_001). Must follow SAP naming conventions (start with Z or Y). - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP for local objects) - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteInterface (High-Level / Interface) **Description:** Delete an ABAP interface from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/interface/high/handleDeleteInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., Z_MY_INTERFACE). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetInterface (High-Level / Interface) **Description:** Retrieve ABAP interface definition. Supports reading active or inactive version. **Source:** `src/handlers/interface/high/handleGetInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., Z_MY_INTERFACE). - `output` (string, optional (default: inline)) - - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### UpdateInterface (High-Level / Interface) **Description:** Update source code of an existing ABAP interface. Uses stateful session with proper lock/unlock mechanism. Lock handle and transport number are passed in URL parameters. **Source:** `src/handlers/interface/high/handleUpdateInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate interface after update. Default: true. - `interface_name` (string, required) - Interface name (e.g., ZIF_MY_INTERFACE). Must exist in the system. - `source_code` (string, required) - Complete ABAP interface source code with INTERFACE...ENDINTERFACE section. - `transport_request` (string, optional) - Transport request. Optional if the object is local or already in one. --- ### High-Level / Package #### GetPackage (High-Level / Package) **Description:** Retrieve ABAP package metadata (description, super-package, etc.). Supports reading active or inactive version. **Source:** `src/handlers/package/high/handleGetPackage.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `package_name` (string, required) - Package name (e.g., Z_MY_PACKAGE). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- ### High-Level / Program #### CreateProgram (High-Level / Program) **Description:** Create a new ABAP program (report) in SAP system. Creates the program object in initial state. Use UpdateProgram to set source code afterwards. **Source:** `src/handlers/program/high/handleCreateProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `application` (string, optional) - Application area (e.g., 'S' for System, 'M' for Materials Management). Default: '*' - `description` (string, optional) - Program description. If not provided, program_name will be used. - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP for local objects) - `program_name` (string, required) - Program name (e.g., Z_TEST_PROGRAM_001). Must follow SAP naming conventions (start with Z or Y). - `program_type` (string, optional) - Program type: 'executable' (Report), 'include', 'module_pool', 'function_group', 'class_pool', 'interface_pool'. Default: 'executable' - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteProgram (High-Level / Program) **Description:** Delete an ABAP program from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/program/high/handleDeleteProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetProgram (High-Level / Program) **Description:** Retrieve ABAP program definition. Supports reading active or inactive version. **Source:** `src/handlers/program/high/handleGetProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `output` (string, optional (default: inline)) - - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### UpdateProgram (High-Level / Program) **Description:** Update source code of an existing ABAP program. Locks the program, checks new code, uploads new source code, and unlocks. Optionally activates after update. Use this to modify existing programs without re-creating metadata. **Source:** `src/handlers/program/high/handleUpdateProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate program after source update. Default: false. Set to true to activate immediately, or use ActivateObject for batch activation. - `program_name` (string, required) - Program name (e.g., Z_TEST_PROGRAM_001). Program must already exist. - `source_code` (string, required) - Complete ABAP program source code. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- ### High-Level / Screen #### CreateScreen (High-Level / Screen) **Description:** Create a new ABAP Screen (Dynpro) on an existing program. Optionally activates. **Source:** `src/handlers/screen/high/handleCreateScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate after creation. Default: false. - `description` (string, optional) - Screen description. - `dynpro_data` (string, optional) - Full screen definition as JSON. If omitted, creates minimal screen. - `program_name` (string, required) - Parent program name. - `screen_number` (string, required) - Screen number to create (e.g., 0100). - `transport_request` (string, optional) - Transport request number. --- #### DeleteScreen (High-Level / Screen) **Description:** Delete an ABAP Screen (Dynpro) from a program. Handles lock/unlock automatically. **Source:** `src/handlers/screen/high/handleDeleteScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Parent program name. - `screen_number` (string, required) - Screen number to delete. - `transport_request` (string, optional) - Transport request number. --- #### GetScreen (High-Level / Screen) **Description:** Get ABAP Screen (Dynpro) definition including metadata, fields, and flow logic source code. **Source:** `src/handlers/screen/high/handleGetScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Parent program name (e.g., SAPMV45A). - `screen_number` (string, required) - Screen number (e.g., 0100). --- #### UpdateScreen (High-Level / Screen) **Description:** Update an ABAP Screen (Dynpro) definition. Provide full screen data as JSON. Handles lock/unlock automatically. **Source:** `src/handlers/screen/high/handleUpdateScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate after update. Default: false. - `dynpro_data` (string, required) - Complete screen definition as JSON (from GetScreen/ReadScreen). - `program_name` (string, required) - Parent program name. - `screen_number` (string, required) - Screen number (e.g., 0100). - `transport_request` (string, optional) - Transport request number. --- ### High-Level / Smartform #### CreateSmartForm (High-Level / Smartform) **Description:** [writes] Create (or, with overwrite, replace) a Z/Y SmartForm from Form Builder XML — the format of SMARTFORMS > Utilities > Download. The form is checked and stored active (function module generated) when the check finds no error; otherwise it is stored inactive and the check errors are returned. SmartStyles and SE78 graphics the XML names must already exist. Needs the ZMCP_SSF_UPLOAD FM and the SSF_UPLOAD_XML dispatcher action. **Source:** `src/handlers/smartform/high/handleCreateSmartForm.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Check and store active. Default true; false stores the form inactive without a check. - `form_name` (string, required) - Target SmartForm name, Z* or Y* (e.g. "ZMY_FORM"). - `overwrite` (boolean, optional) - Replace the form when it exists. Default false (an existing form is refused). - `package_name` (string, optional) - Package. Default $TMP; any other package needs transport_request. - `transport_request` (string, optional) - Transport request the form is recorded in. - `xml_file` (string, required) - Path of the Form Builder XML file (UTF-8). --- #### DeleteSmartForm (High-Level / Smartform) **Description:** [writes, destructive] Delete a Z/Y SmartForm of a local package ($TMP, $…) with its generated function module. Without confirm: true only reports what would be deleted (dry run). Transportable forms are refused. Needs the ZMCP_SSF_DELETE FM and the SSF_DELETE_FORM dispatcher action. **Source:** `src/handlers/smartform/high/handleDeleteSmartForm.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `confirm` (boolean, optional) - true = really delete. Default false (dry run). - `form_name` (string, required) - SmartForm name, Z* or Y*. --- ### High-Level / Text Element #### CreateTextElement (High-Level / Text Element) **Description:** Add a text element (text symbol, selection text, program title, or list heading) to an ABAP program. Optionally activates after write. **Source:** `src/handlers/text_element/high/handleCreateTextElement.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate the parent program after write. Default: false. - `key` (string, optional) - Row key. For "I" use 3-char code (e.g., "001"). For "S" use the parameter/select-option name. For "R" the key is ignored (single row). - `language` (string, optional) - Language key (1-char). Defaults to SAP logon language. - `program_name` (string, required) - Parent program name (e.g., Z_MY_PROGRAM). - `text` (string, required) - Text content (max ${MAX_ENTRY_LEN} characters). - `text_type` (string, required) - "I"=text symbol (TEXT-xxx), "S"=selection text, "R"=program title, "H"=list heading. - `transport_request` (string, optional) - Transport request number. --- #### DeleteTextElement (High-Level / Text Element) **Description:** Delete a text element from an ABAP program text pool. key="*" wipes all rows of the given text_type; text_type="*" wipes the whole pool. **Source:** `src/handlers/text_element/high/handleDeleteTextElement.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate the parent program after write. Default: false. - `key` (string, optional) - Row key, or "*" to delete every row of the given text_type. - `language` (string, optional) - Language key. Defaults to SAP logon language. - `program_name` (string, required) - Parent program name. - `text_type` (string, required) - "I"|"S"|"R"|"H", or "*" to wipe every row in the language. - `transport_request` (string, optional) - Transport request number. --- #### GetTextElement (High-Level / Text Element) **Description:** Read ABAP program text pool (text symbols, selection texts, title, headings). Optionally filter by text_type / key. **Source:** `src/handlers/text_element/high/handleGetTextElement.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `key` (string, optional) - Optional: filter by row key (e.g., "001" for text symbol TEXT-001, or a parameter name for selection text). - `language` (string, optional) - Language key (1-char, e.g., "E", "D", "K"). Defaults to the SAP logon language. - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `text_type` (string, optional) - Filter by ID: "I"=text symbol, "S"=selection text, "R"=program title, "H"=list heading. --- #### ReadTextElementsBulk (High-Level / Text Element) **Description:** Read every text element (R/I/S/H) of a program in ONE call via the TPOOL RFC. Partitions rows by type and returns structured arrays. Use this instead of calling GetTextElement per row. **Source:** `src/handlers/text_element/high/handleReadTextElementsBulk.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `language` (string, optional) - 1-char language. Defaults to SAP logon language. - `program_name` (string, required) - Program name. --- #### UpdateTextElement (High-Level / Text Element) **Description:** Update an existing text element in an ABAP program text pool. Handles lock/unlock automatically. **Source:** `src/handlers/text_element/high/handleUpdateTextElement.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate the parent program after write. Default: false. - `key` (string, optional) - Row key. Required except for "R" (single program title). - `language` (string, optional) - Language key. Defaults to SAP logon language. - `program_name` (string, required) - Parent program name. - `text` (string, required) - New text content (max ${MAX_ENTRY_LEN} characters). - `text_type` (string, required) - "I"|"S"|"R"|"H" — see GetTextElement. - `transport_request` (string, optional) - Transport request number. --- #### WriteTextElementsBulk (High-Level / Text Element) **Description:** Register many ABAP text elements (R/I/S/H) in ONE tool call via a single TPOOL RFC write. Use instead of calling CreateTextElement N times. With activate=false (default) the pool is staged INACTIVE — the parent program's next activation promotes every entry atomically, which is the correct flow for "register 40 now, activate program later". With activate=true the pool is written ACTIVE immediately. Set replace_existing=false to merge into the current pool instead of replacing it. **Source:** `src/handlers/text_element/high/handleWriteTextElementsBulk.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `activate` (boolean, optional) - false (default) — stage as INACTIVE (program activation promotes). true — write ACTIVE immediately. - `language` (string, optional) - 1-char language key (e.g. "K" for Korean). Defaults to SAP logon language. - `program_name` (string, required) - Parent program name. - `replace_existing` (boolean, optional) - If true (default), the TPOOL is replaced with the provided entries only. If false, existing rows are preserved and provided rows merge by (type, key). - `text_elements` (array, required) - Array of entries. Each: { type: "R"|"I"|"S"|"H", key?: string, text: string }. R ignores key (single-row program title — key defaults to program name). I requires a 3-char key. S requires a parameter / select-option name (max 8 chars). H requires one of "listHeader" or "columnHeader_N". - `transport_request` (string, optional) - Transport request number (informational). --- ### High-Level / Unit Test #### CreateCdsUnitTest (High-Level / Unit Test) **Description:** Create a CDS unit test class with CDS validation. Creates the test class in initial state. **Source:** `src/handlers/unit_test/high/handleCreateCdsUnitTest.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `cds_view_name` (string, required) - CDS view name to validate for unit test doubles. - `class_name` (string, required) - Global test class name (e.g., ZCL_CDS_TEST). - `description` (string, optional) - Optional description for the global test class. - `package_name` (string, required) - Package name (e.g., ZOK_TEST_PKG_01, $TMP). - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### CreateUnitTest (High-Level / Unit Test) **Description:** Start an ABAP Unit test run for provided class test definitions. Returns run_id for status/result queries. **Source:** `src/handlers/unit_test/high/handleCreateUnitTest.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `context` (string, optional) - Optional context string shown in SAP tools. - `duration` (object, optional) - - `risk_level` (object, optional) - - `scope` (object, optional) - - `tests` (array, required) - List of container/test class pairs to execute. - `title` (string, optional) - Optional title for the ABAP Unit run. --- #### DeleteCdsUnitTest (High-Level / Unit Test) **Description:** Delete a CDS unit test class (global class). **Source:** `src/handlers/unit_test/high/handleDeleteCdsUnitTest.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Global test class name (e.g., ZCL_CDS_TEST). - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteUnitTest (High-Level / Unit Test) **Description:** Delete an ABAP Unit test run. Note: ADT does not support deleting unit test runs and will return an error. **Source:** `src/handlers/unit_test/high/handleDeleteUnitTest.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `run_id` (string, required) - Run identifier returned by CreateUnitTest/RunUnitTest. --- #### GetCdsUnitTest (High-Level / Unit Test) **Description:** Retrieve CDS unit test run status and result for a previously started run_id. **Source:** `src/handlers/unit_test/high/handleGetCdsUnitTest.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `run_id` (string, required) - Run identifier returned by unit test run. --- #### GetCdsUnitTestResult (High-Level / Unit Test) **Description:** Retrieve CDS unit test run result for a run_id. **Source:** `src/handlers/unit_test/high/handleGetCdsUnitTestResult.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `format` (string, optional) - Result format: abapunit or junit. - `run_id` (string, required) - Run identifier returned by unit test run. - `with_navigation_uris` (boolean, optional (default: false)) - Include navigation URIs in result if supported. --- #### GetCdsUnitTestStatus (High-Level / Unit Test) **Description:** Retrieve CDS unit test run status for a run_id. **Source:** `src/handlers/unit_test/high/handleGetCdsUnitTestStatus.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `run_id` (string, required) - Run identifier returned by unit test run. - `with_long_polling` (boolean, optional (default: true)) - Enable long polling while waiting for status. --- #### GetUnitTest (High-Level / Unit Test) **Description:** Retrieve ABAP Unit test run status and result for a previously started run_id. **Source:** `src/handlers/unit_test/high/handleGetUnitTest.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `run_id` (string, required) - Run identifier returned by RunUnitTest. --- #### GetUnitTestResult (High-Level / Unit Test) **Description:** Retrieve ABAP Unit test run result for a run_id. **Source:** `src/handlers/unit_test/high/handleGetUnitTestResult.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `format` (string, optional) - Result format: abapunit or junit. - `run_id` (string, required) - Run identifier returned by unit test run. - `with_navigation_uris` (boolean, optional (default: false)) - Include navigation URIs in result if supported. --- #### GetUnitTestStatus (High-Level / Unit Test) **Description:** Retrieve ABAP Unit test run status for a run_id. **Source:** `src/handlers/unit_test/high/handleGetUnitTestStatus.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `run_id` (string, required) - Run identifier returned by unit test run. - `with_long_polling` (boolean, optional (default: true)) - Enable long polling while waiting for status. --- #### RunUnitTest (High-Level / Unit Test) **Description:** Start an ABAP Unit test run for provided test definitions. Returns run_id for status/result queries. **Source:** `src/handlers/unit_test/high/handleRunUnitTest.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `context` (string, optional) - Optional context string shown in SAP tools. - `duration` (object, optional) - - `risk_level` (object, optional) - - `scope` (object, optional) - - `tests` (array, required) - List of container/test class pairs to execute. - `title` (string, optional) - Optional title for the ABAP Unit run. --- #### UpdateCdsUnitTest (High-Level / Unit Test) **Description:** Update a CDS unit test class local test class source code. **Source:** `src/handlers/unit_test/high/handleUpdateCdsUnitTest.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Global test class name (e.g., ZCL_CDS_TEST). - `test_class_source` (string, required) - Updated local test class ABAP source code. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### UpdateUnitTest (High-Level / Unit Test) **Description:** Update an ABAP Unit test run. Note: ADT does not support updating unit test runs and will return an error. **Source:** `src/handlers/unit_test/high/handleUpdateUnitTest.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `run_id` (string, required) - Run identifier returned by CreateUnitTest/RunUnitTest. --- ### High-Level / View #### CreateView (High-Level / View) **Description:** Create CDS View or Classic View in SAP. Creates the view object in initial state. Use UpdateView to set DDL source code afterwards. **Source:** `src/handlers/view/high/handleCreateView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, optional) - Optional description (defaults to view_name). - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP for local objects) - `transport_request` (string, optional) - Transport request. Required for transportable packages. - `view_name` (string, required) - View name (e.g., ZOK_R_TEST_0002, Z_I_MY_VIEW). --- #### DeleteView (High-Level / View) **Description:** Delete an ABAP view from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/view/high/handleDeleteView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). - `view_name` (string, required) - View name (e.g., Z_MY_VIEW). --- #### GetView (High-Level / View) **Description:** Retrieve ABAP view definition. Supports reading active or inactive version. **Source:** `src/handlers/view/high/handleGetView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). - `view_name` (string, required) - View name (e.g., Z_MY_VIEW). --- #### UpdateView (High-Level / View) **Description:** Update DDL source code of an existing CDS View or Classic View. Locks the view, checks new code, uploads new DDL source, unlocks, and optionally activates. **Source:** `src/handlers/view/high/handleUpdateView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `activate` (boolean, optional) - Activate after update. Default: false. - `ddl_source` (string, required) - Complete DDL source code. - `transport_request` (string, optional) - Transport request. Required for transportable packages. - `view_name` (string, required) - View name (e.g., ZOK_R_TEST_0002). --- ## Low-Level Group ### Low-Level / Class #### ActivateClassLow (Low-Level / Class) **Description:** [low-level] Activate an ABAP class. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/class/low/handleActivateClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### ActivateClassTestClassesLow (Low-Level / Class) **Description:** [low-level] Activate ABAP Unit test classes include for an existing class. Should be executed after updating and unlocking test classes. **Source:** `src/handlers/class/low/handleActivateClassTestClasses.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `test_class_name` (string, optional) - Optional ABAP Unit test class name (e.g., LTCL_MY_CLASS). Defaults to auto-detected value. --- #### CheckClassLow (Low-Level / Class) **Description:** [low-level] Perform syntax check on an ABAP class. Can check existing class (active/inactive) or hypothetical source code. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/class/low/handleCheckClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS) - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `source_code` (string, optional) - Optional: source code to validate. If provided, validates hypothetical code without creating object. Must include complete CLASS DEFINITION and IMPLEMENTATION sections. - `version` (string, optional) - Version to check: 'active' (last activated) or 'inactive' (current unsaved). Default: active --- #### CreateClassLow (Low-Level / Class) **Description:** [low-level] Create a new ABAP class. - use CreateClass (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/class/low/handleCreateClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `abstract` (boolean, optional (default: false).)) - Mark class as abstract (optional, default: false). - `class_name` (string, required) - Class name (e.g., ZCL_TEST_CLASS_001). Must follow SAP naming conventions. - `create_protected` (boolean, optional (default: false).)) - Create protected section (optional, default: false). - `description` (string, required) - Class description. - `final` (boolean, optional (default: false).)) - Mark class as final (optional, default: false). - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `skip_check` (boolean, optional) - Skip post-create syntax check. Default: false. When false, runs a syntax check on the newly created class shell and surfaces any errors with line numbers. - `superclass` (string, optional) - Superclass name (optional). - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteClassLow (Low-Level / Class) **Description:** [low-level] Delete an ABAP class from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/class/low/handleDeleteClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetClassUnitTestResultLow (Low-Level / Class) **Description:** [low-level] Retrieve ABAP Unit run result (ABAPUnit or JUnit XML) for a completed run_id. **Source:** `src/handlers/class/low/handleGetClassUnitTestResult.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `format` (string, optional) - Preferred response format. Defaults to 'abapunit'. - `run_id` (string, required) - Run identifier returned by RunClassUnitTestsLow. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `with_navigation_uris` (boolean, optional) - Optional flag to request navigation URIs in SAP response (default true). --- #### GetClassUnitTestStatusLow (Low-Level / Class) **Description:** [low-level] Retrieve ABAP Unit run status XML for a previously started run_id. **Source:** `src/handlers/class/low/handleGetClassUnitTestStatus.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `run_id` (string, required) - Run identifier returned by RunClassUnitTestsLow. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `with_long_polling` (boolean, optional) - Optional flag to enable SAP long-polling (default true). --- #### LockClassLow (Low-Level / Class) **Description:** [low-level] Lock an ABAP class for modification. Uses session from HandlerContext. Returns lock handle that must be used in subsequent update/unlock operations. **Source:** `src/handlers/class/low/handleLockClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). --- #### LockClassTestClassesLow (Low-Level / Class) **Description:** [low-level] Lock ABAP Unit test classes include (CLAS/OC testclasses) for the specified class. Returns a test_classes_lock_handle for subsequent update/unlock operations using the same session. **Source:** `src/handlers/class/low/handleLockClassTestClasses.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### RunClassUnitTestsLow (Low-Level / Class) **Description:** [low-level] Start an ABAP Unit test run for provided class test definitions. Returns run_id extracted from SAP response headers. **Source:** `src/handlers/class/low/handleRunClassUnitTests.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `context` (string, optional) - Optional context string shown in SAP tools. - `duration` (object, optional) - - `risk_level` (object, optional) - - `scope` (object, optional) - - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `tests` (array, required) - List of container/test class pairs to execute. - `title` (string, optional) - Optional title for the ABAP Unit run. --- #### UnlockClassLow (Low-Level / Class) **Description:** [low-level] Unlock an ABAP class after modification. Uses session from HandlerContext. Must use the same lock_handle from LockClass operation. **Source:** `src/handlers/class/low/handleUnlockClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `lock_handle` (string, required) - Lock handle from LockClass operation. --- #### UnlockClassTestClassesLow (Low-Level / Class) **Description:** [low-level] Unlock ABAP Unit test classes include for a class using the test_classes_lock_handle obtained from LockClassTestClassesLow. **Source:** `src/handlers/class/low/handleUnlockClassTestClasses.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `lock_handle` (string, required) - Lock handle returned by LockClassTestClassesLow. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UpdateClassLow (Low-Level / Class) **Description:** [low-level] Update source code of an existing ABAP class. Uses session from HandlerContext. Requires lock handle from LockClass operation. - use UpdateClass (high-level) for full workflow with lock/unlock/activate. **Source:** `src/handlers/class/low/handleUpdateClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_TEST_CLASS_001). Class must already exist. - `lock_handle` (string, required) - Lock handle from LockClass operation. Required for update operation. - `skip_check` (boolean, optional) - Skip pre-write syntax check on source_code. Default: false. When false, runs a syntax check on the proposed code BEFORE uploading it and surfaces any errors with line numbers — the broken source never lands on SAP. - `source_code` (string, required) - Complete ABAP class source code including CLASS DEFINITION and IMPLEMENTATION sections. --- #### UpdateClassTestClassesLow (Low-Level / Class) **Description:** [low-level] Upload ABAP Unit test include source code for an existing class. Requires test_classes_lock_handle from LockClassTestClassesLow. **Source:** `src/handlers/class/low/handleUpdateClassTestClasses.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `lock_handle` (string, required) - Test classes lock handle from LockClassTestClassesLow. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `skip_check` (boolean, optional) - Skip post-write syntax check. Default: false. When false, runs a syntax check on the parent class after updating the test-classes include and surfaces any errors with line numbers. - `test_class_source` (string, required) - Complete ABAP Unit test class source code. --- #### ValidateClassLow (Low-Level / Class) **Description:** [low-level] Validate an ABAP class name before creation. Checks if the name is valid, available, and validates package, description, and superclass if provided. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/class/low/handleValidateClass.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `class_name` (string, required) - Class name to validate (e.g., ZCL_MY_CLASS) - `description` (string, required) - Description for validation (required). - `package_name` (string, required) - Package name for validation (required). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `superclass` (string, optional) - Optional superclass name for validation (e.g., CL_OBJECT) --- ### Low-Level / Common #### ActivateObjectLow (Low-Level / Common) **Description:** [low-level] Activate one or multiple ABAP repository objects. Works with any object type; URI is auto-generated from name and type. **Source:** `src/handlers/common/low/handleActivateObject.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `objects` (array, required) - Array of objects to activate. Each object must have 'name' and 'type'. URI is optional. - `preaudit` (boolean, optional) - Request pre-audit before activation. Default: true --- ### Low-Level / Function #### ActivateFunctionGroupLow (Low-Level / Function) **Description:** [low-level] Activate an ABAP function group. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/function/low/handleActivateFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - Function group name (e.g., Z_FG_TEST). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### ActivateFunctionModuleLow (Low-Level / Function) **Description:** [low-level] Activate an ABAP function module. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/function/low/handleActivateFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - Function group name (e.g., Z_FG_TEST). - `function_module_name` (string, required) - Function module name (e.g., Z_FM_TEST). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### CheckFunctionGroupLow (Low-Level / Function) **Description:** [low-level] Perform syntax check on an ABAP function group. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/function/low/handleCheckFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_PROGRAM). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### CheckFunctionModuleLow (Low-Level / Function) **Description:** [low-level] Perform syntax check on an ABAP function module. Returns syntax errors, warnings, and messages. Requires function group name. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/function/low/handleCheckFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - Function group name (e.g., Z_FUGR_TEST_0001) - `function_module_name` (string, required) - Function module name (e.g., Z_TEST_FM) - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `version` (string, optional) - Version to check: 'active' (last activated) or 'inactive' (current unsaved). Default: active --- #### CreateFunctionGroupLow (Low-Level / Function) **Description:** [low-level] Create a new ABAP function group. - use CreateFunctionGroup (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/function/low/handleCreateFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, required) - Function group description. - `function_group_name` (string, required) - Function group name (e.g., ZFG_MY_GROUP). Must follow SAP naming conventions. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### CreateFunctionModuleLow (Low-Level / Function) **Description:** [low-level] Create a new ABAP function module. - use CreateFunctionModule (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/function/low/handleCreateFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, required) - Function module description. - `function_group_name` (string, required) - Function group name (e.g., ZFG_MY_GROUP). - `function_module_name` (string, required) - Function module name (e.g., Z_MY_FUNCTION). - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteFunctionGroupLow (Low-Level / Function) **Description:** [low-level] Delete an ABAP function group from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/function/low/handleDeleteFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_PROGRAM). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### DeleteFunctionModuleLow (Low-Level / Function) **Description:** [low-level] Delete an ABAP function module from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/function/low/handleDeleteFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - Function group name (e.g., ZFG_MY_GROUP). - `function_module_name` (string, required) - Function module name (e.g., Z_MY_FUNCTION). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### LockFunctionGroupLow (Low-Level / Function) **Description:** [low-level] Lock an ABAP function group for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/function/low/handleLockFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_PROGRAM). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### LockFunctionModuleLow (Low-Level / Function) **Description:** [low-level] Lock an ABAP function module for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/function/low/handleLockFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - Function group name (e.g., ZFG_MY_GROUP). - `function_module_name` (string, required) - Function module name (e.g., Z_MY_FUNCTION). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UnlockFunctionGroupLow (Low-Level / Function) **Description:** [low-level] Unlock an ABAP function group after modification. Must use the same session_id and lock_handle from LockFunctionGroup operation. **Source:** `src/handlers/function/low/handleUnlockFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_PROGRAM). - `lock_handle` (string, required) - Lock handle from LockFunctionGroup operation. - `session_id` (string, required) - Session ID from LockFunctionGroup operation. Must be the same as used in LockFunctionGroup. - `session_state` (object, optional) - Session state from LockFunctionGroup (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UnlockFunctionModuleLow (Low-Level / Function) **Description:** [low-level] Unlock an ABAP function module after modification. Must use the same session_id and lock_handle from LockFunctionModule operation. **Source:** `src/handlers/function/low/handleUnlockFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - Function group name (e.g., ZFG_MY_GROUP). - `function_module_name` (string, required) - Function module name (e.g., Z_MY_FUNCTION). - `lock_handle` (string, required) - Lock handle from LockFunctionModule operation. - `session_id` (string, required) - Session ID from LockFunctionModule operation. Must be the same as used in LockFunctionModule. - `session_state` (object, optional) - Session state from LockFunctionModule (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UpdateFunctionModuleLow (Low-Level / Function) **Description:** [low-level] Update source code of an existing ABAP function module. Requires lock handle from LockObject and function group name. - use UpdateFunctionModule (high-level) for full workflow with lock/unlock/activate. **Source:** `src/handlers/function/low/handleUpdateFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `function_group_name` (string, required) - Function group name containing the function module (e.g., Z_TEST_FG). - `function_module_name` (string, required) - Function module name (e.g., Z_TEST_FM). Function module must already exist. - `lock_handle` (string, required) - Lock handle from LockFunctionModule. Required for update operation. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `skip_check` (boolean, optional) - Skip post-write syntax check. Default: false. When false, runs a syntax check on the staged inactive version after update and surfaces any errors with line numbers. - `source_code` (string, required) - Complete ABAP function module source code. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects locked in a request. --- #### ValidateFunctionGroupLow (Low-Level / Function) **Description:** [low-level] Validate an ABAP function group name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/function/low/handleValidateFunctionGroup.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, optional) - Optional description for validation - `function_group_name` (string, required) - FunctionGroup name to validate (e.g., Z_MY_PROGRAM). - `package_name` (string, optional) - Package name for validation (optional but recommended). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### ValidateFunctionModuleLow (Low-Level / Function) **Description:** [low-level] Validate an ABAP function module name before creation. Checks if the name is valid and available. Requires function group name. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/function/low/handleValidateFunctionModule.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, optional) - Optional description for validation - `function_group_name` (string, required) - Function group name (e.g., Z_FUGR_TEST_0001) - `function_module_name` (string, required) - Function module name to validate (e.g., Z_TEST_FM) - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- ### Low-Level / Gui Status #### ActivateGuiStatusLow (Low-Level / Gui Status) **Description:** [low-level] Activate an ABAP program to make GUI Status changes active. **Source:** `src/handlers/gui_status/low/handleActivateGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Parent program name. - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. --- #### CreateGuiStatusLow (Low-Level / Gui Status) **Description:** [low-level] Create a new ABAP GUI Status on an existing program. **Source:** `src/handlers/gui_status/low/handleCreateGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `description` (string, optional) - GUI Status description. - `program_name` (string, required) - Parent program name (e.g., Z_MY_PROGRAM). - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. - `status_name` (string, required) - GUI Status name to create (e.g., MAIN_STATUS). - `status_type` (string, optional) - Status type: "N" (normal screen/list status, stored as MODAL D), "P" (dialog box/popup, MODAL P), "C" (context menu, MODAL C). Default: "N". - `transport_request` (string, optional) - Transport request number. --- #### DeleteGuiStatusLow (Low-Level / Gui Status) **Description:** [low-level] Delete an ABAP GUI Status from a program. **Source:** `src/handlers/gui_status/low/handleDeleteGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockGuiStatusLow. - `program_name` (string, required) - Parent program name. - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. - `status_name` (string, required) - GUI Status name to delete. Use "*" to delete all. - `transport_request` (string, optional) - Transport request number. --- #### LockGuiStatusLow (Low-Level / Gui Status) **Description:** [low-level] Lock a program for GUI Status modification. Returns lock handle for subsequent update/unlock operations. **Source:** `src/handlers/gui_status/low/handleLockGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Parent program name (e.g., SAPMV45A). - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. - `status_name` (string, optional) - GUI Status name (for reference only). --- #### UnlockGuiStatusLow (Low-Level / Gui Status) **Description:** [low-level] Unlock a program after GUI Status modification. Requires lock handle from LockGuiStatusLow. **Source:** `src/handlers/gui_status/low/handleUnlockGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockGuiStatusLow. - `program_name` (string, required) - Parent program name. - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. --- #### UpdateGuiStatusLow (Low-Level / Gui Status) **Description:** [low-level] Update an ABAP GUI Status definition. Provide full CUA data (from ReadGuiStatus) with modifications. **Source:** `src/handlers/gui_status/low/handleUpdateGuiStatus.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `cua_data` (string, required) - Complete CUA data as JSON string (from ReadGuiStatus/GetGuiStatus). Modify and pass back. - `lock_handle` (string, required) - Lock handle from LockGuiStatusLow. - `program_name` (string, required) - Parent program name. - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. - `transport_request` (string, optional) - Transport request number. --- ### Low-Level / Interface #### ActivateInterfaceLow (Low-Level / Interface) **Description:** [low-level] Activate an ABAP interface. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/interface/low/handleActivateInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., ZIF_MY_INTERFACE). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### CheckInterfaceLow (Low-Level / Interface) **Description:** [low-level] Perform syntax check on an ABAP interface. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/interface/low/handleCheckInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., Z_MY_PROGRAM). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### CreateInterfaceLow (Low-Level / Interface) **Description:** [low-level] Create a new ABAP interface. - use CreateInterface (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/interface/low/handleCreateInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, required) - Interface description. - `interface_name` (string, required) - Interface name (e.g., ZIF_TEST_INTERFACE). Must follow SAP naming conventions. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteInterfaceLow (Low-Level / Interface) **Description:** [low-level] Delete an ABAP interface from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/interface/low/handleDeleteInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., Z_MY_PROGRAM). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### LockInterfaceLow (Low-Level / Interface) **Description:** [low-level] Lock an ABAP interface for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/interface/low/handleLockInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., ZIF_MY_INTERFACE). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UnlockInterfaceLow (Low-Level / Interface) **Description:** [low-level] Unlock an ABAP interface after modification. Must use the same session_id and lock_handle from LockInterface operation. **Source:** `src/handlers/interface/low/handleUnlockInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., Z_MY_PROGRAM). - `lock_handle` (string, required) - Lock handle from LockInterface operation. - `session_id` (string, required) - Session ID from LockInterface operation. Must be the same as used in LockInterface. - `session_state` (object, optional) - Session state from LockInterface (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UpdateInterfaceLow (Low-Level / Interface) **Description:** [low-level] Update source code of an existing ABAP interface. Requires lock handle from LockObject. - use UpdateInterface (high-level) for full workflow with lock/unlock/activate. **Source:** `src/handlers/interface/low/handleUpdateInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., ZIF_TEST_INTERFACE). Interface must already exist. - `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `source_code` (string, required) - Complete ABAP interface source code. --- #### ValidateInterfaceLow (Low-Level / Interface) **Description:** [low-level] Validate an ABAP interface name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/interface/low/handleValidateInterface.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, required) - Interface description. Required for validation. - `interface_name` (string, required) - Interface name to validate (e.g., Z_MY_PROGRAM). - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- ### Low-Level / Package #### CheckPackageLow (Low-Level / Package) **Description:** [low-level] Perform syntax check on an ABAP package. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/package/low/handleCheckPackage.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `package_name` (string, required) - Package name (e.g., ZOK_TEST_0002). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `super_package` (string, required) - Super package (parent package) name (e.g., ZOK_PACKAGE). Required. --- #### DeletePackageLow (Low-Level / Package) **Description:** [low-level] Delete an ABAP package from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/package/low/handleDeletePackage.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `connection_config` (object, optional) - Optional SAP connection config to create a fresh connection for deletion. Useful when the existing connection config is unavailable. - `force_new_connection` (boolean, optional) - Force creation of a new connection (bypass cache). Useful when package was locked/unlocked and needs to be deleted in a fresh session. Default: false. - `package_name` (string, required) - Package name (e.g., Z_MY_PROGRAM). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### LockPackageLow (Low-Level / Package) **Description:** [low-level] Lock an ABAP package for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. Requires super_package. **Source:** `src/handlers/package/low/handleLockPackage.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `package_name` (string, required) - Package name (e.g., ZOK_TEST_0002). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `super_package` (string, required) - Super package (parent package) name (e.g., ZOK_PACKAGE). Required. --- #### UnlockPackageLow (Low-Level / Package) **Description:** [low-level] Unlock an ABAP package after modification. Requires lock handle from LockObject and superPackage. - must use the same session_id and lock_handle from LockObject. **Source:** `src/handlers/package/low/handleUnlockPackage.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockObject operation - `package_name` (string, required) - Package name (e.g., ZOK_TEST_0002). Package must already exist. - `session_id` (string, required) - Session ID from LockObject operation. Must be the same as used in LockObject. - `session_state` (object, optional) - Session state from LockObject (cookies, csrf_token, cookie_store). Required if session_id is provided. - `super_package` (string, required) - Super package (parent package) name. Required for package operations. --- #### UpdatePackageLow (Low-Level / Package) **Description:** [low-level] Update description of an existing ABAP package. Requires lock handle from LockObject and superPackage. - use UpdatePackageSource for full workflow with lock/unlock. **Source:** `src/handlers/package/low/handleUpdatePackage.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation. - `package_name` (string, required) - Package name (e.g., ZOK_TEST_0002). Package must already exist. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `super_package` (string, required) - Super package (parent package) name. Required for package operations. - `updated_description` (string, required) - New description for the package. --- ### Low-Level / Program #### ActivateProgramLow (Low-Level / Program) **Description:** [low-level] Activate an ABAP program. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/program/low/handleActivateProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### CheckProgramLow (Low-Level / Program) **Description:** [low-level] Perform syntax check on an ABAP program. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/program/low/handleCheckProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### CreateProgramLow (Low-Level / Program) **Description:** [low-level] Create a new ABAP program. - use CreateProgram (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/program/low/handleCreateProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `application` (string, optional (default: *').)) - Application area (optional, default: '*'). - `description` (string, required) - Program description. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). - `program_name` (string, required) - Program name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions. - `program_type` (string, optional) - Program type: 'executable', 'include', 'module_pool', 'function_group', 'class_pool', 'interface_pool' (optional). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `skip_check` (boolean, optional) - Skip the post-create syntax check on the newly created program shell. Default: false. Set to true when chaining multiple low-level calls where the caller will run CheckProgramLow explicitly later. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteProgramLow (Low-Level / Program) **Description:** [low-level] Delete an ABAP program from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/program/low/handleDeleteProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### LockProgramLow (Low-Level / Program) **Description:** [low-level] Lock an ABAP program for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/program/low/handleLockProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UnlockProgramLow (Low-Level / Program) **Description:** [low-level] Unlock an ABAP program after modification. Must use the same session_id and lock_handle from LockProgram operation. **Source:** `src/handlers/program/low/handleUnlockProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockProgram operation. - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `session_id` (string, required) - Session ID from LockProgram operation. Must be the same as used in LockProgram. - `session_state` (object, optional) - Session state from LockProgram (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UpdateProgramLow (Low-Level / Program) **Description:** [low-level] Update source code of an existing ABAP program. Requires lock handle from LockObject. - use UpdateProgram (high-level) for full workflow with lock/unlock/activate. **Source:** `src/handlers/program/low/handleUpdateProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation. - `program_name` (string, required) - Program name (e.g., Z_TEST_PROGRAM). Program must already exist. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `skip_check` (boolean, optional) - Skip the pre-write syntax check of the new source. Default: false. Set to true when chaining multiple low-level calls where the caller will run CheckProgramLow explicitly before this update. - `source_code` (string, required) - Complete ABAP program source code. --- #### ValidateProgramLow (Low-Level / Program) **Description:** [low-level] Validate an ABAP program name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/program/low/handleValidateProgram.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `description` (string, required) - Program description. Required for validation. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation. - `program_name` (string, required) - Program name to validate (e.g., Z_MY_PROGRAM). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. --- ### Low-Level / Screen #### ActivateScreenLow (Low-Level / Screen) **Description:** [low-level] Activate an ABAP program to make Screen changes active. **Source:** `src/handlers/screen/low/handleActivateScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Parent program name. - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. --- #### CreateScreenLow (Low-Level / Screen) **Description:** [low-level] Create a new ABAP Screen (Dynpro) on an existing program. **Source:** `src/handlers/screen/low/handleCreateScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `description` (string, optional) - Screen description. - `dynpro_data` (string, optional) - Full screen definition as JSON (header, containers, fields_to_containers, flow_logic). If omitted, creates a minimal empty screen. - `program_name` (string, required) - Parent program name. - `screen_number` (string, required) - Screen number to create (e.g., 0100). - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. - `skip_check` (boolean, optional) - Skip post-write syntax check. Default: false. When false, runs a program-tree syntax check on the parent program after DYNPRO_INSERT and surfaces any flow-logic errors with line numbers. --- #### DeleteScreenLow (Low-Level / Screen) **Description:** [low-level] Delete an ABAP Screen (Dynpro) from a program. **Source:** `src/handlers/screen/low/handleDeleteScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockScreenLow. - `program_name` (string, required) - Parent program name. - `screen_number` (string, required) - Screen number (e.g., 0100). - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. --- #### LockScreenLow (Low-Level / Screen) **Description:** [low-level] Lock a program for Screen modification. Returns lock handle for subsequent operations. **Source:** `src/handlers/screen/low/handleLockScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `program_name` (string, required) - Parent program name. - `screen_number` (string, optional) - Screen number (for reference). - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. --- #### UnlockScreenLow (Low-Level / Screen) **Description:** [low-level] Unlock a program after Screen modification. **Source:** `src/handlers/screen/low/handleUnlockScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockScreenLow. - `program_name` (string, required) - Parent program name. - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. --- #### UpdateScreenLow (Low-Level / Screen) **Description:** [low-level] Update an ABAP Screen (Dynpro) definition. Provide full screen data as JSON. **Source:** `src/handlers/screen/low/handleUpdateScreen.ts` **Available in:** `onprem`, `legacy` **Parameters:** - `dynpro_data` (string, required) - Complete screen definition as JSON (header, containers, fields_to_containers, flow_logic). - `lock_handle` (string, required) - Lock handle from LockScreenLow. - `program_name` (string, required) - Parent program name. - `screen_number` (string, required) - Screen number (e.g., 0100). - `session_id` (string, optional) - Session ID from GetSession. - `session_state` (object, optional) - Session state from GetSession. - `skip_check` (boolean, optional) - Skip post-write syntax check. Default: false. When false, runs a program-tree syntax check on the parent program after DYNPRO_INSERT and surfaces any flow-logic errors with line numbers. --- ### Low-Level / View #### ActivateViewLow (Low-Level / View) **Description:** [low-level] Activate an ABAP view (CDS view). Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/view/low/handleActivateView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `view_name` (string, required) - View name (e.g., ZVW_MY_VIEW). --- #### CheckViewLow (Low-Level / View) **Description:** [low-level] Perform syntax check on an ABAP view. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. If ddl_source is provided, validates new/unsaved code (will be base64 encoded in request). **Source:** `src/handlers/view/low/handleCheckView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `ddl_source` (string, optional) - Optional DDL source code to validate (for checking new/unsaved code). If provided, code will be base64 encoded and sent in check request body. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `version` (string, optional) - Version to check: 'active' (last activated) or 'inactive' (current unsaved). Default: inactive - `view_name` (string, required) - View name (e.g., Z_MY_PROGRAM). --- #### CreateViewLow (Low-Level / View) **Description:** [low-level] Create a new ABAP view. - use CreateView (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/view/low/handleCreateView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `application` (string, optional (default: *').)) - Application area (optional, default: '*'). - `description` (string, required) - View description. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `skip_check` (boolean, optional) - Skip post-create syntax check. Default: false. When false, runs a syntax check on the freshly created view shell and surfaces any errors with line numbers. - `transport_request` (string, optional) - Transport request. Required for transportable packages. - `view_name` (string, required) - View name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions. - `view_type` (string, optional) - View type: 'executable', 'include', 'module_pool', 'function_group', 'class_pool', 'interface_pool' (optional). --- #### DeleteViewLow (Low-Level / View) **Description:** [low-level] Delete an ABAP view from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/view/low/handleDeleteView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). - `view_name` (string, required) - View name (e.g., Z_MY_PROGRAM). --- #### LockViewLow (Low-Level / View) **Description:** [low-level] Lock an ABAP view for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/view/low/handleLockView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `view_name` (string, required) - View name (e.g., Z_MY_PROGRAM). --- #### UnlockViewLow (Low-Level / View) **Description:** [low-level] Unlock an ABAP view after modification. Must use the same session_id and lock_handle from LockView operation. **Source:** `src/handlers/view/low/handleUnlockView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockView operation. - `session_id` (string, required) - Session ID from LockView operation. Must be the same as used in LockView. - `session_state` (object, optional) - Session state from LockView (cookies, csrf_token, cookie_store). Required if session_id is provided. - `view_name` (string, required) - View name (e.g., Z_MY_PROGRAM). --- #### UpdateViewLow (Low-Level / View) **Description:** [low-level] Update DDL source code of an existing CDS View or Classic View. Requires lock handle from LockObject. - use UpdateView (high-level) for full workflow with lock/unlock/activate. **Source:** `src/handlers/view/low/handleUpdateView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `ddl_source` (string, required) - Complete DDL source code. CDS: include @AbapCatalog.sqlViewName and other annotations. Classic: plain 'define view' statement. - `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `skip_check` (boolean, optional) - Skip pre-write syntax check on ddl_source. Default: false. When false, runs a syntax check on the proposed code BEFORE uploading it and surfaces any errors with line numbers — the broken source never lands on SAP. - `view_name` (string, required) - View name (e.g., ZOK_R_TEST_0002). View must already exist. --- #### ValidateViewLow (Low-Level / View) **Description:** [low-level] Validate an ABAP view name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/view/low/handleValidateView.ts` **Available in:** `onprem`, `cloud`, `legacy` **Parameters:** - `description` (string, required) - View description. Required for validation. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation. - `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created. - `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided. - `view_name` (string, required) - View name to validate (e.g., Z_MY_PROGRAM). --- *Last updated: 2026-10-28*