# Available Tools Reference - MCP ABAP ADT Server Generated from code in `src/handlers/**` (not from docs). ## Summary - Total tools: 335 - Read-only tools: 67 - High-level tools: 134 - Low-level tools: 134 - Compact tools: 22 (included in High-level group) ## Handler Sets - `readonly` -> [Read-Only Group](#read-only-group) - `high` -> [High-Level Group](#high-level-group) - `low` -> [Low-Level Group](#low-level-group) - `compact` -> [High-Level / Compact](#high-level-compact) ## Navigation - [Compact Set](#high-level-compact) - [Read-Only Group](#read-only-group) - [Behavior Definition](#read-only-behavior-definition) - [ReadBehaviorDefinition](#readbehaviordefinition-read-only-behavior-definition) - [Behavior Implementation](#read-only-behavior-implementation) - [ReadBehaviorImplementation](#readbehaviorimplementation-read-only-behavior-implementation) - [Class](#read-only-class) - [ReadClass](#readclass-read-only-class) - [Data Element](#read-only-data-element) - [ReadDataElement](#readdataelement-read-only-data-element) - [Domain](#read-only-domain) - [ReadDomain](#readdomain-read-only-domain) - [Enhancement](#read-only-enhancement) - [GetBadiImplementations](#getbadiimplementations-read-only-enhancement) - [GetEnhancementImpl](#getenhancementimpl-read-only-enhancement) - [GetEnhancements](#getenhancements-read-only-enhancement) - [GetEnhancementSpot](#getenhancementspot-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) - [Metadata Extension](#read-only-metadata-extension) - [ReadMetadataExtension](#readmetadataextension-read-only-metadata-extension) - [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) - [Search](#read-only-search) - [GetObjectsByType](#getobjectsbytype-read-only-search) - [GetObjectsList](#getobjectslist-read-only-search) - [SearchObject](#searchobject-read-only-search) - [Service Binding](#read-only-service-binding) - [ReadServiceBinding](#readservicebinding-read-only-service-binding) - [Service Definition](#read-only-service-definition) - [ReadServiceDefinition](#readservicedefinition-read-only-service-definition) - [Structure](#read-only-structure) - [ReadStructure](#readstructure-read-only-structure) - [System](#read-only-system) - [DescribeByList](#describebylist-read-only-system) - [GetAbapAST](#getabapast-read-only-system) - [GetAbapSemanticAnalysis](#getabapsemanticanalysis-read-only-system) - [GetAbapSystemSymbols](#getabapsystemsymbols-read-only-system) - [GetAdtTypes](#getadttypes-read-only-system) - [GetInactiveObjects](#getinactiveobjects-read-only-system) - [GetJobUsage](#getjobusage-read-only-system) - [GetObjectInfo](#getobjectinfo-read-only-system) - [GetObjectNodeFromCache](#getobjectnodefromcache-read-only-system) - [GetObjectStructure](#getobjectstructure-read-only-system) - [GetSession](#getsession-read-only-system) - [GetSmartFormContent](#getsmartformcontent-read-only-system) - [GetSmartFormLayout](#getsmartformlayout-read-only-system) - [GetSqlQuery](#getsqlquery-read-only-system) - [GetTcodeUsage](#gettcodeusage-read-only-system) - [GetTransaction](#gettransaction-read-only-system) - [GetTypeInfo](#gettypeinfo-read-only-system) - [GetUsageSnippets](#getusagesnippets-read-only-system) - [GetWhereUsed](#getwhereused-read-only-system) - [ReloadProfile](#reloadprofile-read-only-system) - [RenderSmartForm](#rendersmartform-read-only-system) - [RuntimeAnalyzeDump](#runtimeanalyzedump-read-only-system) - [RuntimeAnalyzeProfilerTrace](#runtimeanalyzeprofilertrace-read-only-system) - [RuntimeCreateProfilerTraceParameters](#runtimecreateprofilertraceparameters-read-only-system) - [RuntimeGetDumpById](#runtimegetdumpbyid-read-only-system) - [RuntimeGetGatewayErrorLog](#runtimegetgatewayerrorlog-read-only-system) - [RuntimeGetProfilerTraceData](#runtimegetprofilertracedata-read-only-system) - [RuntimeListDumps](#runtimelistdumps-read-only-system) - [RuntimeListFeeds](#runtimelistfeeds-read-only-system) - [RuntimeListProfilerTraceFiles](#runtimelistprofilertracefiles-read-only-system) - [RuntimeListSystemMessages](#runtimelistsystemmessages-read-only-system) - [RuntimeRunClassWithProfiling](#runtimerunclasswithprofiling-read-only-system) - [RuntimeRunProgramWithProfiling](#runtimerunprogramwithprofiling-read-only-system) - [Table](#read-only-table) - [GetTableContents](#gettablecontents-read-only-table) - [ReadTable](#readtable-read-only-table) - [Transport](#read-only-transport) - [GetTransport](#gettransport-read-only-transport) - [ListTransports](#listtransports-read-only-transport) - [View](#read-only-view) - [ReadView](#readview-read-only-view) - [High-Level Group](#high-level-group) - [Behavior Definition](#high-level-behavior-definition) - [CreateBehaviorDefinition](#createbehaviordefinition-high-level-behavior-definition) - [DeleteBehaviorDefinition](#deletebehaviordefinition-high-level-behavior-definition) - [GetBehaviorDefinition](#getbehaviordefinition-high-level-behavior-definition) - [UpdateBehaviorDefinition](#updatebehaviordefinition-high-level-behavior-definition) - [Behavior Implementation](#high-level-behavior-implementation) - [CreateBehaviorImplementation](#createbehaviorimplementation-high-level-behavior-implementation) - [DeleteBehaviorImplementation](#deletebehaviorimplementation-high-level-behavior-implementation) - [GetBehaviorImplementation](#getbehaviorimplementation-high-level-behavior-implementation) - [UpdateBehaviorImplementation](#updatebehaviorimplementation-high-level-behavior-implementation) - [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) - [Compact](#high-level-compact) - [HandlerActivate](#handleractivate-high-level-compact) - [HandlerCdsUnitTestResult](#handlercdsunittestresult-high-level-compact) - [HandlerCdsUnitTestStatus](#handlercdsunitteststatus-high-level-compact) - [HandlerCheckRun](#handlercheckrun-high-level-compact) - [HandlerCreate](#handlercreate-high-level-compact) - [HandlerDelete](#handlerdelete-high-level-compact) - [HandlerDumpList](#handlerdumplist-high-level-compact) - [HandlerDumpView](#handlerdumpview-high-level-compact) - [HandlerGet](#handlerget-high-level-compact) - [HandlerLock](#handlerlock-high-level-compact) - [HandlerProfileList](#handlerprofilelist-high-level-compact) - [HandlerProfileRun](#handlerprofilerun-high-level-compact) - [HandlerProfileView](#handlerprofileview-high-level-compact) - [HandlerServiceBindingListTypes](#handlerservicebindinglisttypes-high-level-compact) - [HandlerServiceBindingValidate](#handlerservicebindingvalidate-high-level-compact) - [HandlerTransportCreate](#handlertransportcreate-high-level-compact) - [HandlerUnitTestResult](#handlerunittestresult-high-level-compact) - [HandlerUnitTestRun](#handlerunittestrun-high-level-compact) - [HandlerUnitTestStatus](#handlerunitteststatus-high-level-compact) - [HandlerUnlock](#handlerunlock-high-level-compact) - [HandlerUpdate](#handlerupdate-high-level-compact) - [HandlerValidate](#handlervalidate-high-level-compact) - [Data Element](#high-level-data-element) - [CreateDataElement](#createdataelement-high-level-data-element) - [DeleteDataElement](#deletedataelement-high-level-data-element) - [GetDataElement](#getdataelement-high-level-data-element) - [UpdateDataElement](#updatedataelement-high-level-data-element) - [Ddlx](#high-level-ddlx) - [CreateMetadataExtension](#createmetadataextension-high-level-ddlx) - [UpdateMetadataExtension](#updatemetadataextension-high-level-ddlx) - [Domain](#high-level-domain) - [CreateDomain](#createdomain-high-level-domain) - [DeleteDomain](#deletedomain-high-level-domain) - [GetDomain](#getdomain-high-level-domain) - [UpdateDomain](#updatedomain-high-level-domain) - [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) - [Metadata Extension](#high-level-metadata-extension) - [DeleteMetadataExtension](#deletemetadataextension-high-level-metadata-extension) - [GetMetadataExtension](#getmetadataextension-high-level-metadata-extension) - [Package](#high-level-package) - [CreatePackage](#createpackage-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) - [Service Binding](#high-level-service-binding) - [CreateServiceBinding](#createservicebinding-high-level-service-binding) - [DeleteServiceBinding](#deleteservicebinding-high-level-service-binding) - [GetServiceBinding](#getservicebinding-high-level-service-binding) - [ListServiceBindingTypes](#listservicebindingtypes-high-level-service-binding) - [UpdateServiceBinding](#updateservicebinding-high-level-service-binding) - [ValidateServiceBinding](#validateservicebinding-high-level-service-binding) - [Service Definition](#high-level-service-definition) - [CreateServiceDefinition](#createservicedefinition-high-level-service-definition) - [DeleteServiceDefinition](#deleteservicedefinition-high-level-service-definition) - [GetServiceDefinition](#getservicedefinition-high-level-service-definition) - [UpdateServiceDefinition](#updateservicedefinition-high-level-service-definition) - [Smartform](#high-level-smartform) - [CreateSmartForm](#createsmartform-high-level-smartform) - [DeleteSmartForm](#deletesmartform-high-level-smartform) - [Structure](#high-level-structure) - [CreateStructure](#createstructure-high-level-structure) - [DeleteStructure](#deletestructure-high-level-structure) - [GetStructure](#getstructure-high-level-structure) - [UpdateStructure](#updatestructure-high-level-structure) - [System](#high-level-system) - [GetPackageTree](#getpackagetree-high-level-system) - [Table](#high-level-table) - [CreateTable](#createtable-high-level-table) - [DeleteTable](#deletetable-high-level-table) - [GetTable](#gettable-high-level-table) - [UpdateTable](#updatetable-high-level-table) - [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) - [Transport](#high-level-transport) - [CreateTransport](#createtransport-high-level-transport) - [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) - [Behavior Definition](#low-level-behavior-definition) - [ActivateBehaviorDefinitionLow](#activatebehaviordefinitionlow-low-level-behavior-definition) - [CheckBdefLow](#checkbdeflow-low-level-behavior-definition) - [CreateBehaviorDefinitionLow](#createbehaviordefinitionlow-low-level-behavior-definition) - [DeleteBehaviorDefinitionLow](#deletebehaviordefinitionlow-low-level-behavior-definition) - [LockBehaviorDefinitionLow](#lockbehaviordefinitionlow-low-level-behavior-definition) - [UnlockBehaviorDefinitionLow](#unlockbehaviordefinitionlow-low-level-behavior-definition) - [UpdateBehaviorDefinitionLow](#updatebehaviordefinitionlow-low-level-behavior-definition) - [ValidateBehaviorDefinitionLow](#validatebehaviordefinitionlow-low-level-behavior-definition) - [Behavior Implementation](#low-level-behavior-implementation) - [CreateBehaviorImplementationLow](#createbehaviorimplementationlow-low-level-behavior-implementation) - [LockBehaviorImplementationLow](#lockbehaviorimplementationlow-low-level-behavior-implementation) - [ValidateBehaviorImplementationLow](#validatebehaviorimplementationlow-low-level-behavior-implementation) - [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) - [CheckObjectLow](#checkobjectlow-low-level-common) - [DeleteObjectLow](#deleteobjectlow-low-level-common) - [LockObjectLow](#lockobjectlow-low-level-common) - [UnlockObjectLow](#unlockobjectlow-low-level-common) - [ValidateObjectLow](#validateobjectlow-low-level-common) - [Data Element](#low-level-data-element) - [ActivateDataElementLow](#activatedataelementlow-low-level-data-element) - [CheckDataElementLow](#checkdataelementlow-low-level-data-element) - [CreateDataElementLow](#createdataelementlow-low-level-data-element) - [DeleteDataElementLow](#deletedataelementlow-low-level-data-element) - [LockDataElementLow](#lockdataelementlow-low-level-data-element) - [UnlockDataElementLow](#unlockdataelementlow-low-level-data-element) - [UpdateDataElementLow](#updatedataelementlow-low-level-data-element) - [ValidateDataElementLow](#validatedataelementlow-low-level-data-element) - [Ddlx](#low-level-ddlx) - [ActivateMetadataExtensionLow](#activatemetadataextensionlow-low-level-ddlx) - [CheckMetadataExtensionLow](#checkmetadataextensionlow-low-level-ddlx) - [CreateMetadataExtensionLow](#createmetadataextensionlow-low-level-ddlx) - [DeleteMetadataExtensionLow](#deletemetadataextensionlow-low-level-ddlx) - [LockMetadataExtensionLow](#lockmetadataextensionlow-low-level-ddlx) - [UnlockMetadataExtensionLow](#unlockmetadataextensionlow-low-level-ddlx) - [UpdateMetadataExtensionLow](#updatemetadataextensionlow-low-level-ddlx) - [ValidateMetadataExtensionLow](#validatemetadataextensionlow-low-level-ddlx) - [Domain](#low-level-domain) - [ActivateDomainLow](#activatedomainlow-low-level-domain) - [CheckDomainLow](#checkdomainlow-low-level-domain) - [CreateDomainLow](#createdomainlow-low-level-domain) - [DeleteDomainLow](#deletedomainlow-low-level-domain) - [LockDomainLow](#lockdomainlow-low-level-domain) - [UnlockDomainLow](#unlockdomainlow-low-level-domain) - [UpdateDomainLow](#updatedomainlow-low-level-domain) - [ValidateDomainLow](#validatedomainlow-low-level-domain) - [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) - [CreatePackageLow](#createpackagelow-low-level-package) - [DeletePackageLow](#deletepackagelow-low-level-package) - [LockPackageLow](#lockpackagelow-low-level-package) - [UnlockPackageLow](#unlockpackagelow-low-level-package) - [UpdatePackageLow](#updatepackagelow-low-level-package) - [ValidatePackageLow](#validatepackagelow-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) - [Structure](#low-level-structure) - [ActivateStructureLow](#activatestructurelow-low-level-structure) - [CheckStructureLow](#checkstructurelow-low-level-structure) - [CreateStructureLow](#createstructurelow-low-level-structure) - [DeleteStructureLow](#deletestructurelow-low-level-structure) - [LockStructureLow](#lockstructurelow-low-level-structure) - [UnlockStructureLow](#unlockstructurelow-low-level-structure) - [UpdateStructureLow](#updatestructurelow-low-level-structure) - [ValidateStructureLow](#validatestructurelow-low-level-structure) - [System](#low-level-system) - [GetNodeStructureLow](#getnodestructurelow-low-level-system) - [GetObjectStructureLow](#getobjectstructurelow-low-level-system) - [GetVirtualFoldersLow](#getvirtualfolderslow-low-level-system) - [Table](#low-level-table) - [ActivateTableLow](#activatetablelow-low-level-table) - [CheckTableLow](#checktablelow-low-level-table) - [CreateTableLow](#createtablelow-low-level-table) - [DeleteTableLow](#deletetablelow-low-level-table) - [LockTableLow](#locktablelow-low-level-table) - [UnlockTableLow](#unlocktablelow-low-level-table) - [UpdateTableLow](#updatetablelow-low-level-table) - [ValidateTableLow](#validatetablelow-low-level-table) - [Transport](#low-level-transport) - [CreateTransportLow](#createtransportlow-low-level-transport) - [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 / Behavior Definition #### ReadBehaviorDefinition (Read-Only / Behavior Definition) **Description:** [read-only] Read ABAP behavior definition source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/behavior_definition/readonly/handleReadBehaviorDefinition.ts` **Parameters:** - `behavior_definition_name` (string, required) - Behavior definition name (e.g., Z_MY_BDEF). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Behavior Implementation #### ReadBehaviorImplementation (Read-Only / Behavior Implementation) **Description:** [read-only] Read ABAP behavior implementation source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/behavior_implementation/readonly/handleReadBehaviorImplementation.ts` **Parameters:** - `behavior_implementation_name` (string, required) - Behavior implementation name (e.g., ZBP_MY_CLASS). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### 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` **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 / Data Element #### ReadDataElement (Read-Only / Data Element) **Description:** [read-only] Read ABAP data element definition and metadata (package, responsible, description, etc.). **Source:** `src/handlers/data_element/readonly/handleReadDataElement.ts` **Parameters:** - `data_element_name` (string, required) - Data element name (e.g., Z_MY_DATA_ELEMENT). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Domain #### ReadDomain (Read-Only / Domain) **Description:** [read-only] Read ABAP domain definition and metadata (package, responsible, description, etc.). **Source:** `src/handlers/domain/readonly/handleReadDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain name (e.g., Z_MY_DOMAIN). - `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` **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. --- #### GetEnhancementImpl (Read-Only / Enhancement) **Description:** [read-only] Retrieve source code of a specific enhancement implementation by its name and enhancement spot. **Source:** `src/handlers/enhancement/readonly/handleGetEnhancementImpl.ts` **Parameters:** - `enhancement_name` (string, required) - Name of the enhancement implementation - `enhancement_spot` (string, required) - Name of the enhancement spot --- #### GetEnhancements (Read-Only / Enhancement) **Description:** [read-only] Retrieve a list of enhancements for a given ABAP object. **Source:** `src/handlers/enhancement/readonly/handleGetEnhancements.ts` **Parameters:** - `object_name` (string, required) - Name of the ABAP object - `object_type` (string, required) - Type of the ABAP object --- #### GetEnhancementSpot (Read-Only / Enhancement) **Description:** [read-only] Retrieve metadata and list of implementations for a specific enhancement spot. **Source:** `src/handlers/enhancement/readonly/handleGetEnhancementSpot.ts` **Parameters:** - `enhancement_spot` (string, required) - Name of the enhancement spot --- ### 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` **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` **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` **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` **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` **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` **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` **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 / Metadata Extension #### ReadMetadataExtension (Read-Only / Metadata Extension) **Description:** [read-only] Read ABAP metadata extension (DDLX) source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/metadata_extension/readonly/handleReadMetadataExtension.ts` **Parameters:** - `metadata_extension_name` (string, required) - Metadata extension name (e.g., Z_MY_DDLX). - `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` **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` **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` **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` **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` **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` **Parameters:** - `program_name` (string, required) - Parent program name (e.g., SAPMV45A). - `screen_number` (string, required) - Screen number (e.g., 0100). --- ### Read-Only / Search #### GetObjectsByType (Read-Only / Search) **Description:** [read-only] Retrieves all ABAP objects of a specific type (classes, tables, programs, interfaces, etc.) under a given parent node. Useful for listing all objects of one type within a package or composite object. **Source:** `src/handlers/search/readonly/handleGetObjectsByType.ts` **Parameters:** - `format` (string, optional) - Output format: 'raw' or 'parsed' - `node_id` (string, required) - [read-only] Node ID - `parent_name` (string, required) - Parent object name - `parent_tech_name` (string, required) - Parent technical name - `parent_type` (string, required) - Parent object type - `with_short_descriptions` (boolean, optional) - Include short descriptions --- #### GetObjectsList (Read-Only / Search) **Description:** [read-only] Recursively retrieves all child ABAP repository objects for a given parent — programs (PROG), function groups (FUGR), classes (CLAS), packages (DEVC), and other composite objects — including nested includes and subcomponents. **Source:** `src/handlers/search/readonly/handleGetObjectsList.ts` **Parameters:** - `parent_name` (string, required) - Parent object name - `parent_tech_name` (string, required) - Parent technical name - `parent_type` (string, required) - Parent object type (e.g. PROG/P, FUGR) - `with_short_descriptions` (boolean, optional (default: true))) - Include short descriptions (default: true) --- #### SearchObject (Read-Only / Search) **Description:** [read-only] Find, search, locate, or check if an ABAP repository object exists by name or wildcard pattern (e.g. 'ZOK*'). Use this tool to answer questions like 'is there a program named...', 'find all objects starting with...', 'does this class exist?', 'list objects matching...'. Supports all repository object types — optionally filter by type (PROG, CLAS, INTF, DEVC, TABL, DDLS, DTEL, FUGR, SRVD, SRVB, BDEF, DDLX, etc.). **Source:** `src/handlers/search/readonly/handleSearchObject.ts` **Parameters:** - `include_raw_xml` (boolean, optional (default: false)) - Also return the raw ADT XML (the parsed results already carry every field). Default false. - `maxResults` (number, optional (default: DEFAULT_MAX_RESULTS)) - Maximum number of results to return (default ${DEFAULT_MAX_RESULTS}). The response has truncated=true when this limit was hit. - `object_name` (string, required) - Object name or mask (e.g. 'MARA*') - `object_type` (string, optional) - Optional ABAP object type (e.g. 'TABL', 'CLAS/OC') --- ### Read-Only / Service Binding #### ReadServiceBinding (Read-Only / Service Binding) **Description:** [read-only] Read ABAP service binding source/payload and metadata (package, responsible, description, etc.). **Source:** `src/handlers/service_binding/readonly/handleReadServiceBinding.ts` **Parameters:** - `service_binding_name` (string, required) - Service binding name (e.g., ZUI_MY_BINDING). --- ### Read-Only / Service Definition #### ReadServiceDefinition (Read-Only / Service Definition) **Description:** [read-only] Read ABAP service definition source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/service_definition/readonly/handleReadServiceDefinition.ts` **Parameters:** - `service_definition_name` (string, required) - Service definition name (e.g., Z_MY_SRVD). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Structure #### ReadStructure (Read-Only / Structure) **Description:** [read-only] Read ABAP structure definition and metadata (package, responsible, description, etc.). **Source:** `src/handlers/structure/readonly/handleReadStructure.ts` **Parameters:** - `structure_name` (string, required) - Structure name (e.g., Z_MY_STRUCTURE). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / System #### DescribeByList (Read-Only / System) **Description:** [read-only] Batch description for a list of ABAP objects. Input: objects: Array<{ name: string, type?: string }>. Each object may be of type: PROG/P, FUGR, PROG/I, CLAS/OC, FUGR/FC, INTF/OI, TABLE, STRUCTURE, etc. **Source:** `src/handlers/system/readonly/handleDescribeByList.ts` **Parameters:** - `objects` (array, required) - Object name (required, must be valid ABAP object name or mask) --- #### GetAbapAST (Read-Only / System) **Description:** [read-only] Parse ABAP code and return AST (Abstract Syntax Tree) in JSON format. **Source:** `src/handlers/system/readonly/handleGetAbapAST.ts` **Parameters:** - `code` (string, required) - ABAP source code to parse - `filePath` (string, optional) - Optional file path to write the result to --- #### GetAbapSemanticAnalysis (Read-Only / System) **Description:** [read-only] Perform semantic analysis on ABAP code and return symbols, types, scopes, and dependencies. **Source:** `src/handlers/system/readonly/handleGetAbapSemanticAnalysis.ts` **Parameters:** - `code` (string, required) - ABAP source code to analyze - `filePath` (string, optional) - Optional file path to write the result to --- #### GetAbapSystemSymbols (Read-Only / System) **Description:** [read-only] Resolve ABAP symbols from semantic analysis with SAP system information including types, scopes, descriptions, and packages. **Source:** `src/handlers/system/readonly/handleGetAbapSystemSymbols.ts` **Parameters:** - `code` (string, required) - ABAP source code to analyze and resolve symbols for - `filePath` (string, optional) - Optional file path to write the result to --- #### GetAdtTypes (Read-Only / System) **Description:** [read-only] Retrieve all valid ADT object types (CLAS, TABL, PROG, DEVC, FUGR, INTF, DDLS, DTEL, DOMA, SRVD, SRVB, BDEF, DDLX, etc.) or validate a specific type name. **Source:** `src/handlers/system/readonly/handleGetAllTypes.ts` **Parameters:** - `validate_type` (string, optional) - Type name to validate (optional) --- #### 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` **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` **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"]). --- #### GetObjectInfo (Read-Only / System) **Description:** [read-only] Return ABAP object tree structure for packages (DEVC), classes (CLAS), programs (PROG), function groups (FUGR), and other objects. Shows root, group nodes, and terminal leaves up to maxDepth. Enrich each node with description and package via SearchObject if enrich=true. **Source:** `src/handlers/system/readonly/handleGetObjectInfo.ts` **Parameters:** - `enrich` (boolean, optional (default: true)) - Whether to add description and package via SearchObject (default true) - `maxDepth` (integer, optional (default: 1)) - Maximum tree depth (default depends on type) - `parent_name` (string, required) - Parent object name - `parent_type` (string, required) - Parent object type (e.g. DEVC/K, CLAS/OC, PROG/P) --- #### GetObjectNodeFromCache (Read-Only / System) **Description:** [read-only] Returns a node from the in-memory objects list cache by OBJECT_TYPE, OBJECT_NAME, TECH_NAME, and expands OBJECT_URI if present. **Source:** `src/handlers/system/readonly/handleGetObjectNodeFromCache.ts` **Parameters:** - `object_name` (string, required) - [read-only] Object name - `object_type` (string, required) - [read-only] Object type - `tech_name` (string, required) - [read-only] Technical name --- #### GetObjectStructure (Read-Only / System) **Description:** [read-only] Retrieve ADT object structure as a compact JSON tree. **Source:** `src/handlers/system/readonly/handleGetObjectStructure.ts` **Parameters:** - `objectname` (string, required) - ADT object name (e.g. /CBY/ACQ_DDL) - `objecttype` (string, required) - ADT object type (e.g. DDLS/DF) --- #### GetSession (Read-Only / System) **Description:** [read-only] Get a new session ID and current session state (cookies, CSRF token) for reuse across multiple ADT operations. Use this to maintain the same session and lock handle across multiple requests. **Source:** `src/handlers/system/readonly/handleGetSession.ts` **Parameters:** - `force_new` (boolean, optional) - Force creation of a new session even if one exists. Default: false --- #### 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` **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` **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. --- #### GetSqlQuery (Read-Only / System) **Description:** [read-only] Execute ABAP SQL SELECT queries on database tables and CDS views via SAP ADT Data Preview API. Use for ad-hoc data retrieval, row counts, and filtered queries. **Source:** `src/handlers/system/readonly/handleGetSqlQuery.ts` **Parameters:** - `acknowledge_risk` (boolean, optional (default: false)) - Set to true ONLY after the user has explicitly authorized row extraction from an 'ask'-tier protected table. The approval is logged to stderr for audit. Has no effect on 'deny'-tier tables. - `row_number` (number, optional (default: 100)) - Maximum number of rows to return - `sql_query` (string, required) - SQL query to execute --- #### 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` **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"]). --- #### GetTransaction (Read-Only / System) **Description:** [read-only] Retrieve ABAP transaction (t-code) details from TSTC / TSTCP — program, screen, and kind (program, parameter transaction with its target t-code and parameters such as an SM30 view, variant transaction). Pass transaction_names for many t-codes in one call. **Source:** `src/handlers/system/readonly/handleGetTransaction.ts` **Parameters:** - `transaction_name` (string, optional) - Name of the ABAP transaction - `transaction_names` (array, optional) - Several transactions in one call (e.g. ["VA01","ZMY_TCODE"]). --- #### GetTypeInfo (Read-Only / System) **Description:** [read-only] Retrieve ABAP type information for domains (DOMA), data elements (DTEL), table types, and structures. Returns field definitions, value ranges, fixed values, and DDIC metadata. **Source:** `src/handlers/system/readonly/handleGetTypeInfo.ts` **Parameters:** - `include_structure_fallback` (boolean, optional (default: true)) - When true (default), tries DDIC structure lookup only if type lookup returns 404/empty. - `type_name` (string, required) - Name of the ABAP type --- #### 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` **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` **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` **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` **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. --- #### RuntimeAnalyzeDump (Read-Only / System) **Description:** [runtime] Read runtime dump by ID and return key facts (runtime error, exception, program, termination object/line, user, date, chapter index). Set include_payload=false for facts only. Pass chapters=["developer"] to get the ST22 long text reduced to the developer chapters (~10 KB instead of ~50 KB). **Source:** `src/handlers/system/readonly/handleRuntimeAnalyzeDump.ts` **Parameters:** - `chapters` (array, optional) - Formatted long text only (implies view="formatted"): keep just these chapters, without box borders or padding. "developer" = Short Text, What happened?, Error analysis, Chain of Exception Objects, Information on where terminated, Source Code Extract, Active Calls/Events, User and Transaction. Other entries match chapter titles by prefix. - `dump_id` (string, required) - Runtime dump ID. - `include_payload` (boolean, optional (default: true)) - Include full parsed payload in response. - `view` (string, optional (default: default)) - Dump view mode to analyze: default payload, summary section, or formatted long text. --- #### RuntimeAnalyzeProfilerTrace (Read-Only / System) **Description:** [runtime] Read profiler trace view and return compact analysis summary (totals + top entries). **Source:** `src/handlers/system/readonly/handleRuntimeAnalyzeProfilerTrace.ts` **Parameters:** - `top` (number, optional) - Number of top rows for summary. Default: 10. - `trace_id_or_uri` (string, required) - Profiler trace ID or full trace URI. - `view` (string, optional (default: hitlist)) - - `with_system_events` (boolean, optional) - Include system events. --- #### RuntimeCreateProfilerTraceParameters (Read-Only / System) **Description:** [runtime] Create ABAP profiler trace parameters and return profilerId (URI) for profiled execution. **Source:** `src/handlers/system/readonly/handleRuntimeCreateProfilerTraceParameters.ts` **Parameters:** - `aggregate` (boolean, optional) - - `all_db_events` (boolean, optional) - - `all_dynpro_events` (boolean, optional) - - `all_internal_table_events` (boolean, optional) - - `all_misc_abap_statements` (boolean, optional) - - `all_procedural_units` (boolean, optional) - - `all_system_kernel_events` (boolean, optional) - - `amdp_trace` (boolean, optional) - - `description` (string, required) - Human-readable trace description. - `explicit_on_off` (boolean, optional) - - `max_size_for_trace_file` (number, optional) - - `max_time_for_tracing` (number, optional) - - `sql_trace` (boolean, optional) - - `with_rfc_tracing` (boolean, optional) - --- #### RuntimeGetDumpById (Read-Only / System) **Description:** [runtime] Read a specific ABAP runtime dump by dump ID. Default view (~7 KB): dump metadata, termination link (object + line) and chapter index. Use response_mode="summary" for key facts only (runtime error, exception, program, termination object/line, user, date). For the ST22 long text pass chapters=["developer"] (or chapter titles) to get only those chapters, compacted (~10 KB instead of ~50 KB). **Source:** `src/handlers/system/readonly/handleRuntimeGetDumpById.ts` **Parameters:** - `chapters` (array, optional) - Formatted long text only (implies view="formatted"): keep just these chapters, without box borders or padding. "developer" = Short Text, What happened?, Error analysis, Chain of Exception Objects, Information on where terminated, Source Code Extract, Active Calls/Events, User and Transaction. Other entries match chapter titles by prefix, e.g. "Selected Variables". - `dump_id` (string, required) - Runtime dump ID (for example: 694AB694097211F1929806D06D234D38). - `response_mode` (string, optional (default: payload)) - Controls what is returned: "payload" (default, legacy) — full parsed dump data only, "summary" — compact key facts only (title, exception, program, line, user, date...), "both" — summary + full payload. - `view` (string, optional (default: default)) - Dump view mode: default payload, summary section, or formatted long text. --- #### RuntimeGetGatewayErrorLog (Read-Only / System) **Description:** [runtime] List SAP Gateway error log (/IWFND/ERROR_LOG) or get error detail. Returns structured entries with type, shortText, transactionId, dateTime, username. With error_url returns full detail including serviceInfo, errorContext, sourceCode, callStack. **Source:** `src/handlers/system/readonly/handleRuntimeGetGatewayErrorLog.ts` **Parameters:** - `error_url` (string, optional) - Feed URL of a specific error entry (from a previous list response link field). When provided, returns detailed error info instead of listing. - `from` (string, optional) - Start of time range in YYYYMMDDHHMMSS format. - `max_results` (number, optional) - Maximum number of errors to return. - `to` (string, optional) - End of time range in YYYYMMDDHHMMSS format. - `user` (string, optional) - Filter errors by SAP username. --- #### RuntimeGetProfilerTraceData (Read-Only / System) **Description:** [runtime] Read profiler trace data by trace id/uri: hitlist, statements, or db accesses. Returns parsed JSON payload. **Source:** `src/handlers/system/readonly/handleRuntimeGetProfilerTraceData.ts` **Parameters:** - `auto_drill_down_threshold` (number, optional) - Auto drill-down threshold (for statements view). - `id` (number, optional) - Statement node ID (for statements view). - `trace_id_or_uri` (string, required) - Profiler trace ID or full ADT trace URI. - `view` (string, required) - Trace view to retrieve. - `with_details` (boolean, optional) - Include statement details (for statements view). - `with_system_events` (boolean, optional) - Include system events. --- #### RuntimeListDumps (Read-Only / System) **Description:** [runtime] List ABAP runtime dumps with optional user filter and paging. Returns parsed JSON payload. Each entry's HTML summary (~13 KB per dump) is omitted unless include_summary=true — use RuntimeGetDumpById / RuntimeAnalyzeDump for one dump's details. **Source:** `src/handlers/system/readonly/handleRuntimeListDumps.ts` **Parameters:** - `include_summary` (boolean, optional) - Keep each entry's HTML summary (atom:summary). Default false — it is ~96% of the payload and duplicates what RuntimeGetDumpById returns. - `inlinecount` (string, optional) - Include total count metadata. - `orderby` (string, optional) - ADT order by expression. - `skip` (number, optional) - Number of records to skip. - `top` (number, optional) - Maximum number of records to return. - `user` (string, optional) - Optional username filter. If omitted, dumps for all users are returned. --- #### RuntimeListFeeds (Read-Only / System) **Description:** [runtime] List available ADT runtime feeds or read a specific feed type. Feed types: dumps, system_messages, gateway_errors. Without feed_type returns available feed descriptors. **Source:** `src/handlers/system/readonly/handleRuntimeListFeeds.ts` **Parameters:** - `feed_type` (string, optional (default: descriptors)) - Feed to read. "descriptors" lists available feeds, "variants" lists feed variants, others read that specific feed. Default: descriptors. - `from` (string, optional) - Start of time range in YYYYMMDDHHMMSS format. - `max_results` (number, optional) - Maximum number of entries to return. - `to` (string, optional) - End of time range in YYYYMMDDHHMMSS format. - `user` (string, optional) - Filter feed entries by SAP username. --- #### RuntimeListProfilerTraceFiles (Read-Only / System) **Description:** [runtime] List ABAP profiler trace files available in ADT runtime. Returns parsed JSON payload. **Source:** `src/handlers/system/readonly/handleRuntimeListProfilerTraceFiles.ts` **Parameters:** - None --- #### RuntimeListSystemMessages (Read-Only / System) **Description:** [runtime] List SM02 system messages. Returns structured entries with id, title, text, severity, validity period, and author. **Source:** `src/handlers/system/readonly/handleRuntimeListSystemMessages.ts` **Parameters:** - `from` (string, optional) - Start of time range in YYYYMMDDHHMMSS format. - `max_results` (number, optional) - Maximum number of messages to return. - `to` (string, optional) - End of time range in YYYYMMDDHHMMSS format. - `user` (string, optional) - Filter by author username. --- #### RuntimeRunClassWithProfiling (Read-Only / System) **Description:** [runtime] Execute ABAP class with profiler enabled and return created profilerId + traceId. **Source:** `src/handlers/system/readonly/handleRuntimeRunClassWithProfiling.ts` **Parameters:** - `aggregate` (boolean, optional) - - `all_db_events` (boolean, optional) - - `all_dynpro_events` (boolean, optional) - - `all_internal_table_events` (boolean, optional) - - `all_misc_abap_statements` (boolean, optional) - - `all_procedural_units` (boolean, optional) - - `all_system_kernel_events` (boolean, optional) - - `amdp_trace` (boolean, optional) - - `class_name` (string, required) - ABAP class name to execute. - `description` (string, optional) - Profiler trace description. - `explicit_on_off` (boolean, optional) - - `max_size_for_trace_file` (number, optional) - - `max_time_for_tracing` (number, optional) - - `sql_trace` (boolean, optional) - - `with_rfc_tracing` (boolean, optional) - --- #### RuntimeRunProgramWithProfiling (Read-Only / System) **Description:** [runtime] Execute ABAP program with profiler enabled and return created profilerId + traceId. **Source:** `src/handlers/system/readonly/handleRuntimeRunProgramWithProfiling.ts` **Parameters:** - `aggregate` (boolean, optional) - - `all_db_events` (boolean, optional) - - `all_dynpro_events` (boolean, optional) - - `all_internal_table_events` (boolean, optional) - - `all_misc_abap_statements` (boolean, optional) - - `all_procedural_units` (boolean, optional) - - `all_system_kernel_events` (boolean, optional) - - `amdp_trace` (boolean, optional) - - `description` (string, optional) - Profiler trace description. - `explicit_on_off` (boolean, optional) - - `max_size_for_trace_file` (number, optional) - - `max_time_for_tracing` (number, optional) - - `program_name` (string, required) - ABAP program name to execute. - `sql_trace` (boolean, optional) - - `with_rfc_tracing` (boolean, optional) - --- ### Read-Only / Table #### GetTableContents (Read-Only / Table) **Description:** [read-only] Retrieve contents (data preview) of an ABAP database table or CDS view, like SE16. Compact by default: column names only, empty cell values left out of each row, 20 rows. Use fields to keep only some columns and include_metadata for column types/descriptions. **Source:** `src/handlers/table/readonly/handleGetTableContents.ts` **Parameters:** - None --- #### ReadTable (Read-Only / Table) **Description:** [read-only] Read ABAP table definition and metadata (package, responsible, description, etc.). **Source:** `src/handlers/table/readonly/handleReadTable.ts` **Parameters:** - `table_name` (string, required) - Table name (e.g., Z_MY_TABLE). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Transport #### GetTransport (Read-Only / Transport) **Description:** [read-only] Retrieve ABAP transport request information including metadata, included objects, and status from SAP system. **Source:** `src/handlers/transport/readonly/handleGetTransport.ts` **Parameters:** - `include_objects` (boolean, optional (default: true))) - Include list of objects in transport (default: true) - `include_tasks` (boolean, optional (default: true))) - Include list of tasks in transport (default: true) - `owner` (string, optional) - SAP user who owns the transport. On ECC the session-user-scoped path endpoint silently filters out other users' TRs — pass `owner` to retry via the list endpoint. On S/4 usually unnecessary, but provide it if the path read is rejected by authorization. - `transport_number` (string, required) - Transport request number (e.g., E19K905635, DEVK905123) --- #### ListTransports (Read-Only / Transport) **Description:** [read-only] List transport requests for the current or specified user. Returns modifiable and/or released workbench and customizing requests. **Source:** `src/handlers/transport/readonly/handleListTransports.ts` **Parameters:** - `modifiable_only` (boolean, optional) - Only return modifiable (not yet released) transports. Default: true. - `user` (string, optional) - SAP user name. If not provided, returns transports for the current user. --- ### 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` **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 / Behavior Definition #### CreateBehaviorDefinition (High-Level / Behavior Definition) **Description:** Create a new ABAP Behavior Definition (BDEF) in SAP system. Defines RAP business object behavior: CRUD operations, validations, determinations, actions, and draft handling. **Source:** `src/handlers/behavior_definition/high/handleCreateBehaviorDefinition.ts` **Parameters:** - `activate` (boolean, optional) - Activate after creation. Default: true - `description` (string, optional) - Description - `implementation_type` (string, required) - Implementation type: 'Managed', 'Unmanaged', 'Abstract', 'Projection' - `name` (string, required) - Behavior Definition name (usually same as Root Entity name) - `package_name` (string, required) - Package name - `root_entity` (string, required) - Root Entity name (CDS View name) - `transport_request` (string, optional) - Transport request number --- #### DeleteBehaviorDefinition (High-Level / Behavior Definition) **Description:** Delete an ABAP behavior definition from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/behavior_definition/high/handleDeleteBehaviorDefinition.ts` **Parameters:** - `behavior_definition_name` (string, required) - BehaviorDefinition name (e.g., Z_MY_BEHAVIORDEFINITION). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetBehaviorDefinition (High-Level / Behavior Definition) **Description:** Retrieve ABAP behavior definition definition. Supports reading active or inactive version. **Source:** `src/handlers/behavior_definition/high/handleGetBehaviorDefinition.ts` **Parameters:** - `behavior_definition_name` (string, required) - BehaviorDefinition name (e.g., Z_MY_BEHAVIORDEFINITION). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### UpdateBehaviorDefinition (High-Level / Behavior Definition) **Description:** Update source code of an ABAP Behavior Definition (BDEF). Modifies RAP business object behavior: CRUD operations, validations, determinations, actions, and draft handling. **Source:** `src/handlers/behavior_definition/high/handleUpdateBehaviorDefinition.ts` **Parameters:** - `activate` (boolean, optional) - Activate after update. Default: true - `lock_handle` (string, optional) - Lock handle from LockObject. If not provided, will attempt to lock internally (not recommended for stateful flows). - `name` (string, required) - Behavior Definition name - `source_code` (string, required) - New source code - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- ### High-Level / Behavior Implementation #### CreateBehaviorImplementation (High-Level / Behavior Implementation) **Description:** Create a new ABAP behavior implementation class for a behavior definition. Creates the object in initial state. Use UpdateBehaviorImplementation to set implementation code afterwards. **Source:** `src/handlers/behavior_implementation/high/handleCreateBehaviorImplementation.ts` **Parameters:** - `behavior_definition` (string, required) - Behavior Definition name (e.g., ZI_MY_ENTITY). The behavior definition must exist. - `class_name` (string, required) - Behavior Implementation class name (e.g., ZBP_MY_ENTITY). Must follow SAP naming conventions (typically starts with ZBP_ for behavior implementations). - `description` (string, optional) - Class description. If not provided, class_name will be used. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteBehaviorImplementation (High-Level / Behavior Implementation) **Description:** Delete an ABAP behavior implementation from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/behavior_implementation/high/handleDeleteBehaviorImplementation.ts` **Parameters:** - `behavior_implementation_name` (string, required) - BehaviorImplementation name (e.g., Z_MY_BEHAVIORIMPLEMENTATION). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetBehaviorImplementation (High-Level / Behavior Implementation) **Description:** Retrieve ABAP behavior implementation definition. Supports reading active or inactive version. **Source:** `src/handlers/behavior_implementation/high/handleGetBehaviorImplementation.ts` **Parameters:** - `behavior_implementation_name` (string, required) - BehaviorImplementation name (e.g., Z_MY_BEHAVIORIMPLEMENTATION). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### UpdateBehaviorImplementation (High-Level / Behavior Implementation) **Description:** Update source code of an existing ABAP behavior implementation class. Updates both main source (with FOR BEHAVIOR OF clause) and implementations include. Uses stateful session with proper lock/unlock mechanism. **Source:** `src/handlers/behavior_implementation/high/handleUpdateBehaviorImplementation.ts` **Parameters:** - `activate` (boolean, optional) - Activate behavior implementation after update. Default: true. - `behavior_definition` (string, required) - Behavior Definition name (e.g., ZI_MY_ENTITY). Must match the behavior definition used when creating the class. - `class_name` (string, required) - Behavior Implementation class name (e.g., ZBP_MY_ENTITY). Must exist in the system. - `implementation_code` (string, required) - Implementation code for the implementations include. Contains the actual behavior implementation methods. - `transport_request` (string, optional) - Transport request. Optional if the object is local or already in one. --- ### 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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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 / Compact #### HandlerActivate (High-Level / Compact) **Description:** Activate operation. Single mode(object_name*, object_adt_type*). Batch mode(objects[].name*, objects[].type*). **Source:** `src/handlers/compact/high/handleHandlerActivate.ts` **Parameters:** - `object_adt_type` (string, optional) - ADT object type code (e.g. CLAS/OC, PROG/P). Required for single-object activation form. - `object_name` (string, optional) - Object name for single-object activation form. - `object_type` (any, optional) - - `objects` (array, optional) - Explicit objects list for batch activation. - `preaudit` (boolean, optional) - Run pre-audit checks before activation. --- #### HandlerCdsUnitTestResult (High-Level / Compact) **Description:** CDS unit test result. object_type: not used. Required: run_id*. Optional: with_navigation_uris, format(abapunit|junit). Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerCdsUnitTestResult.ts` **Parameters:** - `aggregate` (boolean, optional) - Aggregate profiling data. - `all_db_events` (boolean, optional) - Trace all DB events. - `all_dynpro_events` (boolean, optional) - Trace dynpro events. - `all_internal_table_events` (boolean, optional) - Trace internal table events. - `all_misc_abap_statements` (boolean, optional) - Trace miscellaneous ABAP statements. - `all_procedural_units` (boolean, optional) - Trace all procedural units. - `all_system_kernel_events` (boolean, optional) - Trace system kernel events. - `amdp_trace` (boolean, optional) - Enable AMDP tracing. - `class_name` (string, optional) - Class name for profiling. - `description` (string, optional) - Profiler run description. - `explicit_on_off` (boolean, optional) - Use explicit on/off trace sections. - `max_size_for_trace_file` (number, optional) - Maximum trace file size. - `max_time_for_tracing` (number, optional) - Maximum tracing time. - `program_name` (string, optional) - Program name for profiling. - `sql_trace` (boolean, optional) - Enable SQL trace. - `target_type` (string, required) - Profile execution target kind. - `with_rfc_tracing` (boolean, optional) - Enable RFC tracing. --- #### HandlerCdsUnitTestStatus (High-Level / Compact) **Description:** CDS unit test status. object_type: not used. Required: run_id*. Optional: with_long_polling. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerCdsUnitTestStatus.ts` **Parameters:** - `aggregate` (boolean, optional) - Aggregate profiling data. - `all_db_events` (boolean, optional) - Trace all DB events. - `all_dynpro_events` (boolean, optional) - Trace dynpro events. - `all_internal_table_events` (boolean, optional) - Trace internal table events. - `all_misc_abap_statements` (boolean, optional) - Trace miscellaneous ABAP statements. - `all_procedural_units` (boolean, optional) - Trace all procedural units. - `all_system_kernel_events` (boolean, optional) - Trace system kernel events. - `amdp_trace` (boolean, optional) - Enable AMDP tracing. - `class_name` (string, optional) - Class name for profiling. - `description` (string, optional) - Profiler run description. - `explicit_on_off` (boolean, optional) - Use explicit on/off trace sections. - `max_size_for_trace_file` (number, optional) - Maximum trace file size. - `max_time_for_tracing` (number, optional) - Maximum tracing time. - `program_name` (string, optional) - Program name for profiling. - `sql_trace` (boolean, optional) - Enable SQL trace. - `target_type` (string, required) - Profile execution target kind. - `with_rfc_tracing` (boolean, optional) - Enable RFC tracing. --- #### HandlerCheckRun (High-Level / Compact) **Description:** CheckRun operation (syntax, no activation). object_type required: CLASS(object_name*), PROGRAM(object_name*), INTERFACE(object_name*), FUNCTION_GROUP(object_name*), FUNCTION_MODULE(object_name*), TABLE(object_name*), STRUCTURE(object_name*), VIEW(object_name*), DOMAIN(object_name*), DATA_ELEMENT(object_name*), PACKAGE(object_name*), BEHAVIOR_DEFINITION(object_name*), BEHAVIOR_IMPLEMENTATION(object_name*), METADATA_EXTENSION(object_name*). **Source:** `src/handlers/compact/high/handleHandlerCheckRun.ts` **Parameters:** - `session_id` (string, optional) - Optional ADT session id for stateful check flow. - `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful check flow. - `version` (string, optional (default: active)) - Version to syntax-check. --- #### HandlerCreate (High-Level / Compact) **Description:** Create operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*). **Source:** `src/handlers/compact/high/handleHandlerCreate.ts` **Parameters:** - `activate` (boolean, optional) - Activate object after create. - `application` (string, optional) - Domain application area. - `class_name` (string, optional) - ABAP class name. - `conversion_exit` (string, optional) - Conversion exit name. - `datatype` (string, optional) - ABAP data type. - `decimals` (number, optional) - Decimal places. - `description` (string, optional) - Human-readable object description. - `domain_name` (string, optional) - ABAP domain name. - `fixed_values` (array, optional) - Domain fixed values list. - `function_group_name` (string, optional) - ABAP function group name. - `function_module_name` (string, optional) - ABAP function module name. - `length` (number, optional) - Length for typed artifacts. - `lowercase` (boolean, optional) - Allow lowercase values (domain setting). - `object_type` (any, required) - - `package_name` (string, optional) - ABAP package name. - `program_name` (string, optional) - ABAP program name. - `program_type` (string, optional) - ABAP program type. - `sign_exists` (boolean, optional) - Allow signed values (domain setting). - `transport_request` (string, optional) - Transport request id (if required by system). - `value_table` (string, optional) - Foreign key value table. --- #### HandlerDelete (High-Level / Compact) **Description:** Delete operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*). **Source:** `src/handlers/compact/high/handleHandlerDelete.ts` **Parameters:** - `class_name` (string, optional) - ABAP class name. - `domain_name` (string, optional) - ABAP domain name. - `function_group_name` (string, optional) - ABAP function group name. - `function_module_name` (string, optional) - ABAP function module name. - `object_type` (any, required) - - `program_name` (string, optional) - ABAP program name. - `transport_request` (string, optional) - Transport request id (if required by system). --- #### HandlerDumpList (High-Level / Compact) **Description:** Runtime dump list. object_type: not used. Required: none. Optional: user, inlinecount, top, skip, orderby. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerDumpList.ts` **Parameters:** - `include_summary` (boolean, optional) - Keep each dump's HTML summary (large). Default false; use HandlerDumpView for one dump. - `inlinecount` (string, optional) - Include total count in response. - `orderby` (string, optional) - Sort expression. - `skip` (number, optional) - Offset for pagination. - `top` (number, optional) - Limit number of returned dumps. - `user` (string, optional) - Filter dumps by user. --- #### HandlerDumpView (High-Level / Compact) **Description:** Runtime dump view. object_type: not used. Required: dump_id*. Optional: view(default|summary|formatted). Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerDumpView.ts` **Parameters:** - `dump_id` (string, required) - Runtime dump id. - `view` (string, optional (default: default)) - Dump rendering mode. --- #### HandlerGet (High-Level / Compact) **Description:** Read operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*). **Source:** `src/handlers/compact/high/handleHandlerGet.ts` **Parameters:** - `behavior_definition_name` (string, optional) - Behavior definition name. - `behavior_implementation_name` (string, optional) - Behavior implementation name. - `class_name` (string, optional) - Class name. - `data_element_name` (string, optional) - Data element name. - `domain_name` (string, optional) - Domain name. - `function_group_name` (string, optional) - Function group name. - `function_module_name` (string, optional) - Function module name. - `interface_name` (string, optional) - Interface name. - `metadata_extension_name` (string, optional) - Metadata extension name. - `object_type` (any, required) - - `package_name` (string, optional) - Package name. - `program_name` (string, optional) - Program name. - `response_format` (string, optional) - Response format for SERVICE_BINDING reads. - `run_id` (string, optional) - Unit test run id. - `service_binding_name` (string, optional) - Service binding name. - `service_definition_name` (string, optional) - Service definition name. - `structure_name` (string, optional) - Structure name. - `table_name` (string, optional) - Table name. - `version` (any, optional) - - `view_name` (string, optional) - View name. --- #### HandlerLock (High-Level / Compact) **Description:** Lock operation. object_type required: CLASS(object_name*), PROGRAM(object_name*), INTERFACE(object_name*), FUNCTION_GROUP(object_name*), FUNCTION_MODULE(object_name*), TABLE(object_name*), STRUCTURE(object_name*), VIEW(object_name*), DOMAIN(object_name*), DATA_ELEMENT(object_name*), PACKAGE(object_name*), BEHAVIOR_DEFINITION(object_name*), BEHAVIOR_IMPLEMENTATION(object_name*), METADATA_EXTENSION(object_name*). **Source:** `src/handlers/compact/high/handleHandlerLock.ts` **Parameters:** - `session_id` (string, optional) - Optional ADT session id for stateful lock flow. - `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful lock flow. - `super_package` (string, optional) - Super package context when relevant. --- #### HandlerProfileList (High-Level / Compact) **Description:** Runtime profiling list. object_type: not used. Required: none. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerProfileList.ts` **Parameters:** - See schema reference `compactProfileListSchema` in source file --- #### HandlerProfileRun (High-Level / Compact) **Description:** Runtime profiling run. object_type: not used. Required: target_type*(CLASS|PROGRAM) + class_name* for CLASS or program_name* for PROGRAM. Optional profiling flags and description. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerProfileRun.ts` **Parameters:** - `aggregate` (boolean, optional) - Aggregate profiling data. - `all_db_events` (boolean, optional) - Trace all DB events. - `all_dynpro_events` (boolean, optional) - Trace dynpro events. - `all_internal_table_events` (boolean, optional) - Trace internal table events. - `all_misc_abap_statements` (boolean, optional) - Trace miscellaneous ABAP statements. - `all_procedural_units` (boolean, optional) - Trace all procedural units. - `all_system_kernel_events` (boolean, optional) - Trace system kernel events. - `amdp_trace` (boolean, optional) - Enable AMDP tracing. - `class_name` (string, optional) - Class name for profiling. - `description` (string, optional) - Profiler run description. - `explicit_on_off` (boolean, optional) - Use explicit on/off trace sections. - `max_size_for_trace_file` (number, optional) - Maximum trace file size. - `max_time_for_tracing` (number, optional) - Maximum tracing time. - `program_name` (string, optional) - Program name for profiling. - `sql_trace` (boolean, optional) - Enable SQL trace. - `target_type` (string, required) - Profile execution target kind. - `with_rfc_tracing` (boolean, optional) - Enable RFC tracing. --- #### HandlerProfileView (High-Level / Compact) **Description:** Runtime profiling view. object_type: not used. Required: trace_id_or_uri*, view*(hitlist|statements|db_accesses). Optional: with_system_events, id, with_details, auto_drill_down_threshold. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerProfileView.ts` **Parameters:** - `auto_drill_down_threshold` (number, optional) - Auto drill-down threshold. - `id` (number, optional) - Optional statement/access id. - `trace_id_or_uri` (string, required) - Profiler trace id or URI. - `view` (string, required) - Profiler trace view kind. - `with_details` (boolean, optional) - Include detailed payload. - `with_system_events` (boolean, optional) - Include system events in analysis. --- #### HandlerServiceBindingListTypes (High-Level / Compact) **Description:** Service binding types list. object_type: not used. Required: none. Optional: response_format(xml|json|plain). Response: XML/JSON/plain by response_format. **Source:** `src/handlers/compact/high/handleHandlerServiceBindingListTypes.ts` **Parameters:** - `response_format` (string, optional (default: xml)) - Response format for protocol types list. --- #### HandlerServiceBindingValidate (High-Level / Compact) **Description:** Service binding validate before create. object_type: not used. Required: service_binding_name*, service_definition_name*. Optional: service_binding_version, package_name, description. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerServiceBindingValidate.ts` **Parameters:** - `description` (string, optional) - Binding description. - `package_name` (string, optional) - Target package name. - `service_binding_name` (string, required) - Service binding name to validate. - `service_binding_version` (string, optional) - Service binding version. - `service_definition_name` (string, required) - Service definition name to pair with binding. --- #### HandlerTransportCreate (High-Level / Compact) **Description:** Transport create. object_type: not used. Required: description*. Optional: transport_type(workbench|customizing), target_system, owner. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerTransportCreate.ts` **Parameters:** - `description` (string, required) - Transport description. - `owner` (string, optional) - Transport owner user. - `target_system` (string, optional) - Target system id. - `transport_type` (string, optional (default: workbench)) - Transport type. --- #### HandlerUnitTestResult (High-Level / Compact) **Description:** ABAP Unit result. object_type: not used. Required: run_id*. Optional: with_navigation_uris, format(abapunit|junit). Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerUnitTestResult.ts` **Parameters:** - `format` (string, optional) - Result format. - `run_id` (string, required) - Unit test run id. - `with_navigation_uris` (boolean, optional (default: false)) - Include ADT navigation URIs in the result payload. --- #### HandlerUnitTestRun (High-Level / Compact) **Description:** ABAP Unit run. object_type: not used. Required: tests[]{container_class*, test_class*}. Optional: title, context, scope, risk_level, duration. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerUnitTestRun.ts` **Parameters:** - `context` (string, optional) - Run context label. - `duration` (object, optional) - Allowed duration classes. - `risk_level` (object, optional) - Allowed risk levels. - `scope` (object, optional) - ABAP Unit scope flags. - `tests` (array, required) - List of test classes to run. - `title` (string, optional) - Run title shown in ABAP Unit logs. --- #### HandlerUnitTestStatus (High-Level / Compact) **Description:** ABAP Unit status. object_type: not used. Required: run_id*. Optional: with_long_polling. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerUnitTestStatus.ts` **Parameters:** - `run_id` (string, required) - Unit test run id. - `with_long_polling` (boolean, optional (default: true)) - Use long polling while waiting for completion. --- #### HandlerUnlock (High-Level / Compact) **Description:** Unlock operation. object_type required: CLASS(object_name*, lock_handle*, session_id*), PROGRAM(object_name*, lock_handle*, session_id*), INTERFACE(object_name*, lock_handle*, session_id*), FUNCTION_GROUP(object_name*, lock_handle*, session_id*), FUNCTION_MODULE(object_name*, lock_handle*, session_id*), TABLE(object_name*, lock_handle*, session_id*), STRUCTURE(object_name*, lock_handle*, session_id*), VIEW(object_name*, lock_handle*, session_id*), DOMAIN(object_name*, lock_handle*, session_id*), DATA_ELEMENT(object_name*, lock_handle*, session_id*), PACKAGE(object_name*, lock_handle*, session_id*), BEHAVIOR_DEFINITION(object_name*, lock_handle*, session_id*), BEHAVIOR_IMPLEMENTATION(object_name*, lock_handle*, session_id*), METADATA_EXTENSION(object_name*, lock_handle*, session_id*). **Source:** `src/handlers/compact/high/handleHandlerUnlock.ts` **Parameters:** - `lock_handle` (string, required) - Lock handle returned by lock. - `session_id` (string, required) - ADT session id used during lock. - `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful unlock flow. --- #### HandlerUpdate (High-Level / Compact) **Description:** Update operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*). **Source:** `src/handlers/compact/high/handleHandlerUpdate.ts` **Parameters:** - `activate` (boolean, optional) - Activate object after update. - `class_name` (string, optional) - ABAP class name. - `conversion_exit` (string, optional) - Conversion exit name. - `datatype` (string, optional) - ABAP data type. - `decimals` (number, optional) - Decimal places. - `description` (string, optional) - Human-readable object description. - `domain_name` (string, optional) - ABAP domain name. - `fixed_values` (array, optional) - Domain fixed values list. - `function_group_name` (string, optional) - ABAP function group name. - `function_module_name` (string, optional) - ABAP function module name. - `length` (number, optional) - Length for typed artifacts. - `lowercase` (boolean, optional) - Allow lowercase values (domain setting). - `object_type` (any, required) - - `package_name` (string, optional) - ABAP package name. - `program_name` (string, optional) - ABAP program name. - `sign_exists` (boolean, optional) - Allow signed values (domain setting). - `source_code` (string, optional) - ABAP source code payload. - `transport_request` (string, optional) - Transport request id (if required by system). - `value_table` (string, optional) - Foreign key value table. --- #### HandlerValidate (High-Level / Compact) **Description:** Validate before create only. object_type required: CLASS(object_name*), PROGRAM(object_name*), INTERFACE(object_name*), FUNCTION_GROUP(object_name*), FUNCTION_MODULE(object_name*), TABLE(object_name*), STRUCTURE(object_name*), VIEW(object_name*), DOMAIN(object_name*), DATA_ELEMENT(object_name*), PACKAGE(object_name*), BEHAVIOR_DEFINITION(object_name*), BEHAVIOR_IMPLEMENTATION(object_name*), METADATA_EXTENSION(object_name*), SERVICE_BINDING(object_name*=service_binding_name*, service_definition_name*). **Source:** `src/handlers/compact/high/handleHandlerValidate.ts` **Parameters:** - `behavior_definition` (string, optional) - Optional behavior definition name, used when validating behavior implementation. - `description` (string, optional) - Optional object description used during validation. - `implementation_type` (string, optional) - Optional implementation type, used for behavior implementation validation. - `object_name` (string, required) - Required object name. For SERVICE_BINDING this is the service binding name. - `object_type` (string, required) - Object type to validate before create. Supported: CLASS, PROGRAM, INTERFACE, FUNCTION_GROUP, FUNCTION_MODULE, TABLE, STRUCTURE, VIEW, DOMAIN, DATA_ELEMENT, PACKAGE, BEHAVIOR_DEFINITION, BEHAVIOR_IMPLEMENTATION, METADATA_EXTENSION, SERVICE_BINDING. - `package_name` (string, optional) - Optional package context for validation (especially for create scenarios). - `root_entity` (string, optional) - Optional CDS root entity name, used for behavior-related validation. - `service_binding_version` (string, optional) - Optional service binding version for SERVICE_BINDING. - `service_definition_name` (string, optional) - Required when object_type=SERVICE_BINDING. Service definition paired with the binding. - `session_id` (string, optional) - Optional ADT session id for stateful validation flow. - `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful validation flow. --- ### High-Level / Data Element #### CreateDataElement (High-Level / Data Element) **Description:** Create a new ABAP data element in SAP system with all required steps: create, activate, and verify. **Source:** `src/handlers/data_element/high/handleCreateDataElement.ts` **Parameters:** - `data_element_name` (string, required) - Data element name (e.g., ZZ_E_TEST_001). Must follow SAP naming conventions. - `data_type` (string, optional (default: CHAR)) - Data type (e.g., CHAR, NUMC) or domain name when type_kind is 'domain'. - `decimals` (number, optional (default: 0)) - Decimal places. Usually inherited from domain. - `description` (string, optional) - Data element description. If not provided, data_element_name will be used. - `heading_label` (string, optional) - Heading field label (max 55 chars). Applied during update step after creation. - `length` (number, optional (default: 100)) - Data type length. Usually inherited from domain. - `long_label` (string, optional) - Long field label (max 40 chars). Applied during update step after creation. - `medium_label` (string, optional) - Medium field label (max 20 chars). Applied during update step after creation. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `search_help` (string, optional) - Search help name. Applied during update step after creation. - `search_help_parameter` (string, optional) - Search help parameter. Applied during update step after creation. - `set_get_parameter` (string, optional) - Set/Get parameter ID. Applied during update step after creation. - `short_label` (string, optional) - Short field label (max 10 chars). Applied during update step after creation. - `transport_request` (string, optional) - Transport request. Required for transportable packages. - `type_kind` (string, optional (default: domain)) - Type kind: 'domain' (default), 'predefinedAbapType', 'refToPredefinedAbapType', 'refToDictionaryType', 'refToClifType'. If not specified, defaults to 'domain'. - `type_name` (string, optional) - Type name: domain name (when type_kind is 'domain'), data element name (when type_kind is 'refToDictionaryType'), or class name (when type_kind is 'refToClifType') --- #### DeleteDataElement (High-Level / Data Element) **Description:** Delete an ABAP data element from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/data_element/high/handleDeleteDataElement.ts` **Parameters:** - `data_element_name` (string, required) - Data element name (e.g., Z_MY_DATA_ELEMENT). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetDataElement (High-Level / Data Element) **Description:** Retrieve ABAP data element definition. Supports reading active or inactive version. **Source:** `src/handlers/data_element/high/handleGetDataElement.ts` **Parameters:** - `data_element_name` (string, required) - Data element name (e.g., Z_MY_DATA_ELEMENT). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### UpdateDataElement (High-Level / Data Element) **Description:** Update an existing ABAP data element in SAP system. Workflow: 1. Gets domain info (if type_kind is 'domain') to extract dataType/length/decimals 2. Acquires lock on the data element 3. Updates data element with provided parameters (complete replacement) 4. Unlocks data element 5. Optionally activates data element (default: true) 6. Returns updated data element details Supported type_kind values: - domain: Based on ABAP domain (requires type_name = domain name) - predefinedAbapType: Direct ABAP type (requires data_type, length, decimals) - refToPredefinedAbapType: Reference to ABAP type (requires data_type, length, decimals) - refToDictionaryType: Reference to another data element (requires type_name = data element name) - refToClifType: Reference to class (requires type_name = class name) Note: All provided parameters completely replace existing values. Field labels are truncated to max lengths (10/20/40/55). **Source:** `src/handlers/data_element/high/handleUpdateDataElement.ts` **Parameters:** - `activate` (boolean, optional (default: true))) - Activate data element after update (default: true) - `data_element_name` (string, required) - Data element name to update (e.g., ZZ_TEST_DTEL_01) - `data_type` (string, optional) - Data type (CHAR, NUMC, etc.) - for predefinedAbapType or refToPredefinedAbapType - `decimals` (number, optional) - Decimals - for predefinedAbapType or refToPredefinedAbapType - `description` (string, optional) - New data element description - `field_label_heading` (string, optional) - Heading field label (max 55 chars) - `field_label_long` (string, optional) - Long field label (max 40 chars) - `field_label_medium` (string, optional) - Medium field label (max 20 chars) - `field_label_short` (string, optional) - Short field label (max 10 chars) - `length` (number, optional) - Length - for predefinedAbapType or refToPredefinedAbapType - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `search_help` (string, optional) - Search help name - `search_help_parameter` (string, optional) - Search help parameter - `set_get_parameter` (string, optional) - Set/Get parameter ID - `transport_request` (string, optional) - Transport request. Required for transportable packages. - `type_kind` (string, optional (default: domain)) - Type kind: domain, predefinedAbapType, refToPredefinedAbapType, refToDictionaryType, refToClifType - `type_name` (string, optional) - Type name: domain name, data element name, or class name (depending on type_kind) --- ### High-Level / Ddlx #### CreateMetadataExtension (High-Level / Ddlx) **Description:** Create a new ABAP Metadata Extension (DDLX) in SAP system. Defines Fiori UI annotations, field labels, search help, and list/object page layout for CDS views. **Source:** `src/handlers/ddlx/high/handleCreateMetadataExtension.ts` **Parameters:** - `activate` (boolean, optional) - Activate after creation. Default: true - `description` (string, optional) - Description - `name` (string, required) - Metadata Extension name - `package_name` (string, required) - Package name - `transport_request` (string, optional) - Transport request number --- #### UpdateMetadataExtension (High-Level / Ddlx) **Description:** Update source code of an ABAP Metadata Extension (DDLX). Modifies Fiori UI annotations, field labels, search help, and list/object page layout for CDS views. **Source:** `src/handlers/ddlx/high/handleUpdateMetadataExtension.ts` **Parameters:** - `activate` (boolean, optional) - Activate after update. Default: true - `lock_handle` (string, optional) - Lock handle from LockObject. If not provided, will attempt to lock internally. - `name` (string, required) - Metadata Extension name - `source_code` (string, required) - New source code - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- ### High-Level / Domain #### CreateDomain (High-Level / Domain) **Description:** Create a new ABAP domain in SAP system with all required steps: lock, create, check, unlock, activate, and verify. **Source:** `src/handlers/domain/high/handleCreateDomain.ts` **Parameters:** - `activate` (boolean, optional (default: true))) - (optional) Activate domain after creation (default: true) - `conversion_exit` (string, optional) - (optional) Conversion exit routine name (without CONVERSION_EXIT_ prefix) - `datatype` (string, optional (default: CHAR)) - (optional) Data type: CHAR, NUMC, DATS, TIMS, DEC, INT1, INT2, INT4, INT8, CURR, QUAN, etc. - `decimals` (number, optional (default: 0)) - (optional) Decimal places (for DEC, CURR, QUAN types) - `description` (string, optional) - (optional) Domain description. If not provided, domain_name will be used. - `domain_name` (string, required) - Domain name (e.g., ZZ_TEST_0001). Must follow SAP naming conventions. - `fixed_values` (array, optional) - (optional) Array of fixed values for domain value range - `length` (number, optional (default: 100)) - (optional) Field length (max depends on datatype) - `lowercase` (boolean, optional (default: false)) - (optional) Allow lowercase input - `package_name` (string, optional) - (optional) Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `sign_exists` (boolean, optional (default: false)) - (optional) Field has sign (+/-) - `transport_request` (string, optional) - (optional) Transport request. Required for transportable packages. - `value_table` (string, optional) - (optional) Value table name for foreign key relationship --- #### DeleteDomain (High-Level / Domain) **Description:** Delete an ABAP domain from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/domain/high/handleDeleteDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain name (e.g., Z_MY_DOMAIN). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetDomain (High-Level / Domain) **Description:** Retrieve ABAP domain definition. Supports reading active or inactive version. **Source:** `src/handlers/domain/high/handleGetDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain name (e.g., Z_MY_DOMAIN). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### UpdateDomain (High-Level / Domain) **Description:** Update an existing ABAP domain in SAP system. Workflow: 1. Acquires lock on the domain 2. Updates domain with provided parameters (complete replacement) 3. Performs syntax check 4. Unlocks domain 5. Optionally activates domain (default: true) 6. Returns updated domain details Note: All provided parameters completely replace existing values. Use GetDomain first to see current values if needed. **Source:** `src/handlers/domain/high/handleUpdateDomain.ts` **Parameters:** - `activate` (boolean, optional (default: true))) - Activate domain after update (default: true) - `conversion_exit` (string, optional) - Conversion exit routine name (without CONVERSION_EXIT_ prefix) - `datatype` (string, optional) - Data type: CHAR, NUMC, DATS, TIMS, DEC, INT1, INT2, INT4, INT8, CURR, QUAN, etc. - `decimals` (number, optional) - Decimal places (for DEC, CURR, QUAN types) - `description` (string, optional) - New domain description (optional) - `domain_name` (string, required) - Domain name to update (e.g., ZZ_TEST_0001) - `fixed_values` (array, optional) - Array of fixed values for domain value range - `length` (number, optional) - Field length (max depends on datatype) - `lowercase` (boolean, optional) - Allow lowercase input - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `sign_exists` (boolean, optional) - Field has sign (+/-) - `transport_request` (string, optional) - Transport request. Required for transportable packages. - `value_table` (string, optional) - Value table name for foreign key relationship --- ### 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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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 / Metadata Extension #### DeleteMetadataExtension (High-Level / Metadata Extension) **Description:** Delete an ABAP metadata extension from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/metadata_extension/high/handleDeleteMetadataExtension.ts` **Parameters:** - `metadata_extension_name` (string, required) - MetadataExtension name (e.g., Z_MY_METADATAEXTENSION). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetMetadataExtension (High-Level / Metadata Extension) **Description:** Retrieve ABAP metadata extension definition. Supports reading active or inactive version. **Source:** `src/handlers/metadata_extension/high/handleGetMetadataExtension.ts` **Parameters:** - `metadata_extension_name` (string, required) - MetadataExtension name (e.g., Z_MY_METADATAEXTENSION). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- ### High-Level / Package #### CreatePackage (High-Level / Package) **Description:** Create a new ABAP package in SAP system. Packages are containers for development objects and are essential for organizing code. **Source:** `src/handlers/package/high/handleCreatePackage.ts` **Parameters:** - None --- #### 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` **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` **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` **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` **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` **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` **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` **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` **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` **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 / Service Binding #### CreateServiceBinding (High-Level / Service Binding) **Description:** Create ABAP service binding via ADT Business Services endpoint. XML is generated from high-level parameters. **Source:** `src/handlers/service_binding/high/handleCreateServiceBinding.ts` **Parameters:** - `activate` (boolean, optional (default: true)) - Activate service binding after create. Default: true. - `binding_type` (string, optional (default: ODataV4)) - OData binding type. - `description` (string, optional) - Optional description. Defaults to service_binding_name when omitted. - `package_name` (string, required) - ABAP package name. - `response_format` (string, optional (default: xml)) - - `service_binding_name` (string, required) - Service binding name. - `service_binding_version` (string, optional) - Service binding ADT version. Default inferred from type. - `service_definition_name` (string, required) - Referenced service definition name. - `service_name` (string, optional) - Published service name. Default: service_binding_name if omitted. - `service_version` (string, optional) - Published service version. Default: 0001. - `transport_request` (string, optional) - Optional transport request for transport checks. --- #### DeleteServiceBinding (High-Level / Service Binding) **Description:** Delete ABAP service binding via ADT Business Services endpoint. **Source:** `src/handlers/service_binding/high/handleDeleteServiceBinding.ts` **Parameters:** - `response_format` (string, optional (default: xml)) - - `service_binding_name` (string, required) - Service binding name to delete. - `transport_request` (string, optional) - Optional transport request for deletion transport flow. --- #### GetServiceBinding (High-Level / Service Binding) **Description:** Retrieve ABAP service binding source/metadata by name via ADT Business Services endpoint. **Source:** `src/handlers/service_binding/high/handleGetServiceBinding.ts` **Parameters:** - `response_format` (string, optional (default: xml)) - Preferred response format. "json" requests JSON from endpoint, "xml" parses XML payload, "plain" returns raw text. - `service_binding_name` (string, required) - Service binding name (for example: ZUI_MY_BINDING). Case-insensitive. --- #### ListServiceBindingTypes (High-Level / Service Binding) **Description:** List available service binding types (for example ODataV2/ODataV4) from ADT Business Services endpoint. **Source:** `src/handlers/service_binding/high/handleListServiceBindingTypes.ts` **Parameters:** - `response_format` (string, optional (default: xml)) - --- #### UpdateServiceBinding (High-Level / Service Binding) **Description:** Update publication state for ABAP service binding via AdtServiceBinding workflow. **Source:** `src/handlers/service_binding/high/handleUpdateServiceBinding.ts` **Parameters:** - `desired_publication_state` (string, required) - Target publication state. - `response_format` (string, optional (default: xml)) - - `service_binding_name` (string, required) - Service binding name to update. - `service_name` (string, required) - Published service name. - `service_type` (string, required (default: ODataV4)) - OData service type for publish/unpublish action routing. - `service_version` (string, optional) - Published service version. Optional. --- #### ValidateServiceBinding (High-Level / Service Binding) **Description:** Validate service binding parameters (name, service definition, package, version) via ADT validation endpoint. **Source:** `src/handlers/service_binding/high/handleValidateServiceBinding.ts` **Parameters:** - `description` (string, optional) - Optional description used during validation. - `package_name` (string, optional) - ABAP package for the binding. - `service_binding_name` (string, required) - Service binding name to validate. - `service_binding_version` (string, optional) - Service binding version (for example: 1.0). - `service_definition_name` (string, required) - Service definition linked to binding. --- ### High-Level / Service Definition #### CreateServiceDefinition (High-Level / Service Definition) **Description:** Create a new ABAP service definition for OData services. Service definitions define the structure and behavior of OData services. Uses stateful session for proper lock management. **Source:** `src/handlers/service_definition/high/handleCreateServiceDefinition.ts` **Parameters:** - `activate` (boolean, optional) - Activate service definition after creation. Default: true. - `description` (string, optional) - Service definition description. If not provided, service_definition_name will be used. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `service_definition_name` (string, required) - Service definition name (e.g., ZSD_MY_SERVICE). Must follow SAP naming conventions (start with Z or Y). - `source_code` (string, optional) - Service definition source code (optional). If not provided, a minimal template will be created. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteServiceDefinition (High-Level / Service Definition) **Description:** Delete an ABAP service definition from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/service_definition/high/handleDeleteServiceDefinition.ts` **Parameters:** - `service_definition_name` (string, required) - ServiceDefinition name (e.g., Z_MY_SERVICEDEFINITION). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetServiceDefinition (High-Level / Service Definition) **Description:** Retrieve ABAP service definition definition. Supports reading active or inactive version. **Source:** `src/handlers/service_definition/high/handleGetServiceDefinition.ts` **Parameters:** - `service_definition_name` (string, required) - ServiceDefinition name (e.g., Z_MY_SERVICEDEFINITION). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### UpdateServiceDefinition (High-Level / Service Definition) **Description:** Update source code of an existing ABAP service definition. Uses stateful session with proper lock/unlock mechanism. **Source:** `src/handlers/service_definition/high/handleUpdateServiceDefinition.ts` **Parameters:** - `activate` (boolean, optional) - Activate service definition after update. Default: true. - `service_definition_name` (string, required) - Service definition name (e.g., ZSD_MY_SERVICE). Must exist in the system. - `source_code` (string, required) - Complete service definition source code. - `transport_request` (string, optional) - Transport request. Optional if the object is local or already in one. --- ### 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` **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` **Parameters:** - `confirm` (boolean, optional) - true = really delete. Default false (dry run). - `form_name` (string, required) - SmartForm name, Z* or Y*. --- ### High-Level / Structure #### CreateStructure (High-Level / Structure) **Description:** Create a new ABAP structure in SAP system with fields and type references. Includes create, activate, and verify steps. **Source:** `src/handlers/structure/high/handleCreateStructure.ts` **Parameters:** - `activate` (boolean, optional) - Activate structure after creation. Default: true. Set to false for batch operations (activate multiple objects later). - `description` (string, optional) - Structure description. If not provided, structure_name will be used. - `fields` (array, required (default: 0)) - Array of structure fields - `includes` (array, optional) - Include other structures in this structure - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `structure_name` (string, required) - Structure name (e.g., ZZ_S_TEST_001). Must follow SAP naming conventions. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteStructure (High-Level / Structure) **Description:** Delete an ABAP structure from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/structure/high/handleDeleteStructure.ts` **Parameters:** - `structure_name` (string, required) - Structure name (e.g., Z_MY_STRUCTURE). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetStructure (High-Level / Structure) **Description:** Retrieve ABAP structure definition. Supports reading active or inactive version. **Source:** `src/handlers/structure/high/handleGetStructure.ts` **Parameters:** - `structure_name` (string, required) - Structure name (e.g., Z_MY_STRUCTURE). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### UpdateStructure (High-Level / Structure) **Description:** Update DDL source code of an existing ABAP structure. Locks the structure, uploads new DDL source, and unlocks. Optionally activates after update. Use this to modify existing structures without re-creating metadata. **Source:** `src/handlers/structure/high/handleUpdateStructure.ts` **Parameters:** - `activate` (boolean, optional) - Activate structure after source update. Default: true. - `ddl_code` (string, required) - Complete DDL source code for structure. Example: '@EndUserText.label : \'My Structure\' @AbapCatalog.tableCategory : #TRANSPARENT define structure zz_s_test_001 { client : abap.clnt not null; id : abap.char(10); name : abap.char(255); }' - `structure_name` (string, required) - Structure name (e.g., ZZ_S_TEST_001). Structure must already exist. - `transport_request` (string, optional) - Transport request. Optional if the object is local or already in one. --- ### High-Level / System #### GetPackageTree (High-Level / System) **Description:** [high-level] Retrieve complete package tree structure including subpackages and objects. Returns hierarchical tree with object names, types, and descriptions. **Source:** `src/handlers/system/high/handleGetPackageTree.ts` **Parameters:** - `debug` (boolean, optional (default: false)) - Include diagnostic metadata in response (counts, types, hierarchy info). Default: false - `include_descriptions` (boolean, optional (default: true)) - Include object descriptions in response. Default: true - `include_subpackages` (boolean, optional (default: true)) - Include subpackages recursively in the tree. If false, subpackages are shown as first-level objects but not recursively expanded. Default: true - `max_depth` (integer, optional (default: 5)) - Maximum depth for recursive package traversal. Default: 5 - `package_name` (string, required) - Package name (e.g., "ZMY_PACKAGE") --- ### High-Level / Table #### CreateTable (High-Level / Table) **Description:** Create a new ABAP table via the ADT API. Creates the table object in initial state. Use UpdateTable to set DDL code afterwards. **Source:** `src/handlers/table/high/handleCreateTable.ts` **Parameters:** - `description` (string, optional) - Table description for validation and creation. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `table_name` (string, required) - Table name (e.g., ZZ_TEST_TABLE_001). Must follow SAP naming conventions. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteTable (High-Level / Table) **Description:** Delete an ABAP table from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/table/high/handleDeleteTable.ts` **Parameters:** - `table_name` (string, required) - Table name (e.g., Z_MY_TABLE). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### GetTable (High-Level / Table) **Description:** Retrieve ABAP table definition. Supports reading active or inactive version. **Source:** `src/handlers/table/high/handleGetTable.ts` **Parameters:** - `table_name` (string, required) - Table name (e.g., Z_MY_TABLE). - `version` (string, optional (default: active)) - "active" (default) or "inactive" (saved, not yet activated). --- #### UpdateTable (High-Level / Table) **Description:** Update DDL source code of an existing ABAP table. Locks the table, uploads new DDL source, and unlocks. Optionally activates after update. Use this to modify existing tables without re-creating metadata. **Source:** `src/handlers/table/high/handleUpdateTable.ts` **Parameters:** - `activate` (boolean, optional) - Activate table after source update. Default: true. - `ddl_code` (string, required) - Complete DDL source code for a TRANSPARENT TABLE. IMPORTANT — use the MANDT data element for the client key ('key mandt : mandt not null'), NOT 'abap.clnt' (that's CDS-view syntax). Standard SAP tables (MARA, T001, VBAK, …) all use MANDT. The annotation block CreateTable seeded must be preserved verbatim: #NOT_EXTENSIBLE enhancement category, #TRANSPARENT tableCategory, #A deliveryClass, #RESTRICTED dataMaintenance. Example: '@EndUserText.label : \'My Table\' @AbapCatalog.enhancement.category : #NOT_EXTENSIBLE @AbapCatalog.tableCategory : #TRANSPARENT @AbapCatalog.deliveryClass : #A @AbapCatalog.dataMaintenance : #RESTRICTED define table ztst_table { key mandt : mandt not null; key id : abap.char(10); name : abap.char(255); }' - `table_name` (string, required) - Table name (e.g., ZZ_TEST_TABLE_001). Table must already exist. - `transport_request` (string, optional) - Transport request. Optional if the object is local or already in one. --- ### 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` **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` **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` **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` **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` **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` **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 / Transport #### CreateTransport (High-Level / Transport) **Description:** Create a new ABAP transport request in SAP system for development objects. **Source:** `src/handlers/transport/high/handleCreateTransport.ts` **Parameters:** - `description` (string, required) - Transport request description (mandatory) - `owner` (string, optional) - Transport owner (optional, defaults to current user) - `target_system` (string, optional) - Target system for transport (optional, e.g., 'PRD', 'QAS'). If not provided or empty, uses 'LOCAL' - `transport_type` (string, optional (default: workbench)) - Transport type: 'workbench' (cross-client) or 'customizing' (client-specific) --- ### 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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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 / Behavior Definition #### ActivateBehaviorDefinitionLow (Low-Level / Behavior Definition) **Description:** [low-level] Activate an ABAP behavior definition. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/behavior_definition/low/handleActivateBehaviorDefinition.ts` **Parameters:** - `name` (string, required) - Behavior definition name (root entity, e.g., ZI_MY_ENTITY). - `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. --- #### CheckBdefLow (Low-Level / Behavior Definition) **Description:** [low-level] Perform syntax check on an ABAP behavior definition. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/behavior_definition/low/handleCheckBehaviorDefinition.ts` **Parameters:** - `name` (string, required) - BehaviorDefinition 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. --- #### CreateBehaviorDefinitionLow (Low-Level / Behavior Definition) **Description:** [low-level] Create a new ABAP Behavior Definition. - use CreateBehaviorDefinition (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/behavior_definition/low/handleCreateBehaviorDefinition.ts` **Parameters:** - `description` (string, required) - Behavior Definition description. - `implementation_type` (string, required) - Implementation type: 'Managed', 'Unmanaged', 'Abstract', or 'Projection'. - `name` (string, required) - Behavior Definition name (e.g., ZI_MY_BDEF). - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). - `root_entity` (string, required) - Root entity name (e.g., ZI_MY_ENTITY). - `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 number (e.g., E19K905635). Required. --- #### DeleteBehaviorDefinitionLow (Low-Level / Behavior Definition) **Description:** [low-level] Delete an ABAP behavior definition from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/behavior_definition/low/handleDeleteBehaviorDefinition.ts` **Parameters:** - `name` (string, required) - BehaviorDefinition name (e.g., ZI_MY_BDEF). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### LockBehaviorDefinitionLow (Low-Level / Behavior Definition) **Description:** [low-level] Lock an ABAP behavior definition for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/behavior_definition/low/handleLockBehaviorDefinition.ts` **Parameters:** - `name` (string, required) - BehaviorDefinition name (e.g., ZI_MY_BDEF). - `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. --- #### UnlockBehaviorDefinitionLow (Low-Level / Behavior Definition) **Description:** [low-level] Unlock an ABAP behavior definition after modification. Must use the same session_id and lock_handle from LockBehaviorDefinition operation. **Source:** `src/handlers/behavior_definition/low/handleUnlockBehaviorDefinition.ts` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockBehaviorDefinition operation. - `name` (string, required) - BehaviorDefinition name (e.g., ZI_MY_BDEF). - `session_id` (string, required) - Session ID from LockBehaviorDefinition operation. Must be the same as used in LockBehaviorDefinition. - `session_state` (object, optional) - Session state from LockBehaviorDefinition (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UpdateBehaviorDefinitionLow (Low-Level / Behavior Definition) **Description:** [low-level] Update source code of an existing ABAP behavior definition. Requires lock handle from LockObject. - use UpdateBehaviorDefinition (high-level) for full workflow with lock/unlock/activate. **Source:** `src/handlers/behavior_definition/low/handleUpdateBehaviorDefinition.ts` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation. - `name` (string, required) - Behavior definition name (e.g., ZOK_C_TEST_0001). Behavior definition 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 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 behavior definition source code. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### ValidateBehaviorDefinitionLow (Low-Level / Behavior Definition) **Description:** [low-level] Validate an ABAP behavior definition 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/behavior_definition/low/handleValidateBehaviorDefinition.ts` **Parameters:** - `description` (string, required) - BehaviorDefinition description. Required for validation. - `implementation_type` (string, required) - Implementation type: 'Managed', 'Unmanaged', 'Abstract', or 'Projection'. - `name` (string, required) - BehaviorDefinition name to validate (e.g., ZI_MY_BDEF). - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation. - `root_entity` (string, required) - Root entity name (e.g., ZI_MY_ENTITY). 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 / Behavior Implementation #### CreateBehaviorImplementationLow (Low-Level / Behavior Implementation) **Description:** [low-level] Create a new ABAP behavior implementation class with full workflow (create, lock, update main source, update implementations, unlock, activate). - use CreateBehaviorImplementation (high-level) for additional validation. **Source:** `src/handlers/behavior_implementation/low/handleCreateBehaviorImplementation.ts` **Parameters:** - `behavior_definition` (string, required) - Behavior Definition name (e.g., ZI_MY_ENTITY). Required. - `class_name` (string, required) - Behavior Implementation class name (e.g., ZBP_MY_ENTITY). Must follow SAP naming conventions. - `description` (string, required) - Class description. - `implementation_code` (string, optional) - Implementation code for the implementations include (optional). - `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. --- #### LockBehaviorImplementationLow (Low-Level / Behavior Implementation) **Description:** [low-level] Lock an ABAP behavior implementation class for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/behavior_implementation/low/handleLockBehaviorImplementation.ts` **Parameters:** - `class_name` (string, required) - Behavior Implementation class name (e.g., ZBP_MY_ENTITY). - `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. --- #### ValidateBehaviorImplementationLow (Low-Level / Behavior Implementation) **Description:** [low-level] Validate an ABAP behavior implementation class 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/behavior_implementation/low/handleValidateBehaviorImplementation.ts` **Parameters:** - `behavior_definition` (string, required) - Behavior Definition name (e.g., ZI_MY_ENTITY). Required for validation. - `class_name` (string, required) - Behavior Implementation class name to validate (e.g., ZBP_MY_ENTITY). - `description` (string, required) - Class 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. --- ### 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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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 --- #### CheckObjectLow (Low-Level / Common) **Description:** [low-level] Perform syntax check on an ABAP object without activation. Returns syntax errors, warnings, and messages. **Source:** `src/handlers/common/low/handleCheckObject.ts` **Parameters:** - `object_name` (string, required) - Object name (e.g., ZCL_MY_CLASS, Z_MY_PROGRAM) - `object_type` (string, required) - Object type - `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' or 'inactive' (default active) --- #### DeleteObjectLow (Low-Level / Common) **Description:** [low-level] Delete an ABAP object via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/common/low/handleDeleteObject.ts` **Parameters:** - `function_group_name` (string, optional) - Required only for function_module type - `object_name` (string, required) - Object name (e.g., ZCL_MY_CLASS) - `object_type` (string, required) - Object type (class/program/interface/function_group/function_module/table/structure/view/domain/data_element/behavior_definition/metadata_extension) - `transport_request` (string, optional) - Transport request number --- #### LockObjectLow (Low-Level / Common) **Description:** [low-level] Lock an ABAP object for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/common/low/handleLockObject.ts` **Parameters:** - `object_name` (string, required) - Object name (e.g., ZCL_MY_CLASS, Z_MY_PROGRAM, ZIF_MY_INTERFACE). For function modules, use format GROUP|FM_NAME - `object_type` (string, required) - Object type - `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, optional) - Super package (required for package locking) --- #### UnlockObjectLow (Low-Level / Common) **Description:** [low-level] Unlock an ABAP object after modification. Must use the same session_id and lock_handle from the LockObject operation. **Source:** `src/handlers/common/low/handleUnlockObject.ts` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockObject operation - `object_name` (string, required) - Object name (e.g., ZCL_MY_CLASS, Z_MY_PROGRAM, ZIF_MY_INTERFACE). For function modules, use format GROUP|FM_NAME - `object_type` (string, required) - Object type - `session_id` (string, required) - Session ID from LockObject operation. Must be the same session. - `session_state` (object, optional) - Session state from LockObject (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### ValidateObjectLow (Low-Level / Common) **Description:** [low-level] Validate an ABAP object 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/common/low/handleValidateObject.ts` **Parameters:** - `behavior_definition` (string, optional) - Optional behavior definition name (required for behavior_implementation validation) - `description` (string, optional) - Optional description for validation - `implementation_type` (string, optional) - Implementation type: 'Managed', 'Unmanaged', or 'External' (required for behavior_definition validation) - `object_name` (string, required) - Object name to validate (e.g., ZCL_MY_CLASS, Z_MY_PROGRAM, ZIF_MY_INTERFACE) - `object_type` (string, required) - Object type: 'class', 'program', 'interface', 'function_group', 'table', 'structure', 'view', 'domain', 'data_element', 'package', 'behavior_definition', 'behavior_implementation', 'metadata_extension' - `package_name` (string, optional) - Optional package name for validation - `root_entity` (string, optional) - Root entity name (required for behavior_definition 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 / Data Element #### ActivateDataElementLow (Low-Level / Data Element) **Description:** [low-level] Activate an ABAP data element. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/data_element/low/handleActivateDataElement.ts` **Parameters:** - `data_element_name` (string, required) - Data element name (e.g., ZDT_MY_ELEMENT). - `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. --- #### CheckDataElementLow (Low-Level / Data Element) **Description:** [low-level] Perform syntax check on an ABAP data element. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/data_element/low/handleCheckDataElement.ts` **Parameters:** - `data_element_name` (string, required) - DataElement 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. --- #### CreateDataElementLow (Low-Level / Data Element) **Description:** [low-level] Create a new ABAP data element. - use CreateDataElement (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/data_element/low/handleCreateDataElement.ts` **Parameters:** - `data_element_name` (string, required) - DataElement name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions. - `data_type` (string, optional) - Data type (e.g., CHAR, NUMC) or domain name when type_kind is 'E' or 'domain'. - `decimals` (number, optional) - Decimal places (for predefinedAbapType or refToPredefinedAbapType) - `description` (string, required) - DataElement description. - `length` (number, optional) - Data type length (for predefinedAbapType or refToPredefinedAbapType) - `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. - `type_kind` (string, optional) - Type kind: 'E' for domain-based, 'P' for predefined type, etc. - `type_name` (string, optional) - Type name: domain name (when type_kind is 'domain'), data element name (when type_kind is 'refToDictionaryType'), or class name (when type_kind is 'refToClifType') --- #### DeleteDataElementLow (Low-Level / Data Element) **Description:** [low-level] Delete an ABAP data element from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/data_element/low/handleDeleteDataElement.ts` **Parameters:** - `data_element_name` (string, required) - DataElement name (e.g., Z_MY_PROGRAM). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### LockDataElementLow (Low-Level / Data Element) **Description:** [low-level] Lock an ABAP data element for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/data_element/low/handleLockDataElement.ts` **Parameters:** - `data_element_name` (string, required) - DataElement 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. --- #### UnlockDataElementLow (Low-Level / Data Element) **Description:** [low-level] Unlock an ABAP data element after modification. Must use the same session_id and lock_handle from LockDataElement operation. **Source:** `src/handlers/data_element/low/handleUnlockDataElement.ts` **Parameters:** - `data_element_name` (string, required) - DataElement name (e.g., Z_MY_PROGRAM). - `lock_handle` (string, required) - Lock handle from LockDataElement operation. - `session_id` (string, required) - Session ID from LockDataElement operation. Must be the same as used in LockDataElement. - `session_state` (object, optional) - Session state from LockDataElement (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UpdateDataElementLow (Low-Level / Data Element) **Description:** [low-level] Update properties of an existing ABAP data element. Requires lock handle from LockObject. - use UpdateDataElement (high-level) for full workflow with lock/unlock/activate. **Source:** `src/handlers/data_element/low/handleUpdateDataElement.ts` **Parameters:** - `data_element_name` (string, required) - Data element name (e.g., ZOK_E_TEST_0001). Data element must already exist. - `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation. - `properties` (object, required) - Data element properties object. Can include: description, type_name, type_kind, data_type, field_label_short, field_label_medium, field_label_long, etc. - `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. --- #### ValidateDataElementLow (Low-Level / Data Element) **Description:** [low-level] Validate an ABAP data element 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/data_element/low/handleValidateDataElement.ts` **Parameters:** - `data_element_name` (string, required) - DataElement name to validate (e.g., Z_MY_PROGRAM). - `description` (string, required) - DataElement 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. --- ### Low-Level / Ddlx #### ActivateMetadataExtensionLow (Low-Level / Ddlx) **Description:** [low-level] Activate an ABAP metadata extension. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/ddlx/low/handleActivateMetadataExtension.ts` **Parameters:** - `name` (string, required) - Metadata extension name (e.g., ZC_MY_EXTENSION). - `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. --- #### CheckMetadataExtensionLow (Low-Level / Ddlx) **Description:** [low-level] Perform syntax check on an ABAP metadata extension. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/ddlx/low/handleCheckMetadataExtension.ts` **Parameters:** - `name` (string, required) - MetadataExtension name (e.g., ZI_MY_DDLX). - `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. --- #### CreateMetadataExtensionLow (Low-Level / Ddlx) **Description:** [low-level] Create a new ABAP Metadata Extension. - use CreateMetadataExtension (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/ddlx/low/handleCreateMetadataExtension.ts` **Parameters:** - `description` (string, required) - Metadata Extension description. - `master_language` (string, optional) - Master language (optional, e.g., 'EN'). - `name` (string, required) - Metadata Extension name (e.g., ZI_MY_DDLX). - `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. NOTE: SAP's /checkruns reporter is weak for DDLX — may return empty results for some error classes. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Optional for local objects. --- #### DeleteMetadataExtensionLow (Low-Level / Ddlx) **Description:** [low-level] Delete an ABAP metadata extension from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/ddlx/low/handleDeleteMetadataExtension.ts` **Parameters:** - `name` (string, required) - MetadataExtension name (e.g., ZI_MY_DDLX). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### LockMetadataExtensionLow (Low-Level / Ddlx) **Description:** [low-level] Lock an ABAP metadata extension for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/ddlx/low/handleLockMetadataExtension.ts` **Parameters:** - `name` (string, required) - MetadataExtension name (e.g., ZI_MY_DDLX). - `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. --- #### UnlockMetadataExtensionLow (Low-Level / Ddlx) **Description:** [low-level] Unlock an ABAP metadata extension after modification. Must use the same session_id and lock_handle from LockMetadataExtension operation. **Source:** `src/handlers/ddlx/low/handleUnlockMetadataExtension.ts` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockMetadataExtension operation. - `name` (string, required) - MetadataExtension name (e.g., ZI_MY_DDLX). - `session_id` (string, required) - Session ID from LockMetadataExtension operation. Must be the same as used in LockMetadataExtension. - `session_state` (object, optional) - Session state from LockMetadataExtension (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UpdateMetadataExtensionLow (Low-Level / Ddlx) **Description:** [low-level] Update source code of an existing ABAP metadata extension. Requires lock handle from LockObject. - use UpdateMetadataExtension (high-level) for full workflow with lock/unlock/activate. **Source:** `src/handlers/ddlx/low/handleUpdateMetadataExtension.ts` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation. - `name` (string, required) - Metadata extension name (e.g., ZOK_C_TEST_0001). Metadata extension 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 post-write syntax check. Default: false. NOTE: SAP's /checkruns reporter is weak for DDLX — may return empty results for some error classes. - `source_code` (string, required) - Complete metadata extension source code. --- #### ValidateMetadataExtensionLow (Low-Level / Ddlx) **Description:** [low-level] Validate an ABAP metadata extension 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/ddlx/low/handleValidateMetadataExtension.ts` **Parameters:** - `description` (string, required) - MetadataExtension description. - `name` (string, required) - MetadataExtension name to validate (e.g., ZI_MY_DDLX). - `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. --- ### Low-Level / Domain #### ActivateDomainLow (Low-Level / Domain) **Description:** [low-level] Activate an ABAP domain. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/domain/low/handleActivateDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain name (e.g., ZDM_MY_DOMAIN). - `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. --- #### CheckDomainLow (Low-Level / Domain) **Description:** [low-level] Perform syntax check on an ABAP domain. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/domain/low/handleCheckDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain 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. --- #### CreateDomainLow (Low-Level / Domain) **Description:** [low-level] Create a new ABAP domain. - use CreateDomain (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/domain/low/handleCreateDomain.ts` **Parameters:** - `description` (string, required) - Domain description. - `domain_name` (string, required) - Domain name (e.g., Z_TEST_PROGRAM). 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. --- #### DeleteDomainLow (Low-Level / Domain) **Description:** [low-level] Delete an ABAP domain from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/domain/low/handleDeleteDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain name (e.g., Z_MY_PROGRAM). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### LockDomainLow (Low-Level / Domain) **Description:** [low-level] Lock an ABAP domain for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/domain/low/handleLockDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain 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. --- #### UnlockDomainLow (Low-Level / Domain) **Description:** [low-level] Unlock an ABAP domain after modification. Must use the same session_id and lock_handle from LockDomain operation. **Source:** `src/handlers/domain/low/handleUnlockDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain name (e.g., Z_MY_PROGRAM). - `lock_handle` (string, required) - Lock handle from LockDomain operation. - `session_id` (string, required) - Session ID from LockDomain operation. Must be the same as used in LockDomain. - `session_state` (object, optional) - Session state from LockDomain (cookies, csrf_token, cookie_store). Required if session_id is provided. --- #### UpdateDomainLow (Low-Level / Domain) **Description:** [low-level] Update properties of an existing ABAP domain. Requires lock handle from LockObject. - use UpdateDomain (high-level) for full workflow with lock/unlock/activate. **Source:** `src/handlers/domain/low/handleUpdateDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain name (e.g., ZOK_D_TEST_0001). Domain must already exist. - `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation. - `properties` (object, required) - Domain properties object. Can include: description, datatype, length, decimals, conversion_exit, lowercase, sign_exists, value_table, fixed_values, etc. - `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. --- #### ValidateDomainLow (Low-Level / Domain) **Description:** [low-level] Validate an ABAP domain 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/domain/low/handleValidateDomain.ts` **Parameters:** - `description` (string, required) - Domain description (required for validation). - `domain_name` (string, required) - Domain name to validate (e.g., Z_MY_PROGRAM). - `package_name` (string, required) - Package name (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 / 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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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. --- #### CreatePackageLow (Low-Level / Package) **Description:** [low-level] Create a new ABAP package. - use CreatePackage (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/package/low/handleCreatePackage.ts` **Parameters:** - `application_component` (string, optional) - Application component (e.g., BC-ABA). - `description` (string, required) - Package description. - `package_name` (string, required) - Package name (e.g., ZOK_TEST_0002). Must follow SAP naming conventions. - `package_type` (string, optional) - Package type (development/structure). Defaults to development. - `record_changes` (boolean, optional) - Enable change recording for the package. Required for transportable packages (non-$TMP). Default: false. - `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. - `software_component` (string, optional) - Software component (e.g., HOME, ZLOCAL). If not provided, SAP will set a default (typically ZLOCAL for local packages). - `super_package` (string, required) - Super package (parent package) name (e.g., ZOK_PACKAGE). Required. - `transport_layer` (string, optional) - Transport layer (e.g., ZDEV). Required for transportable packages. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### 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` **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` **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` **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` **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. --- #### ValidatePackageLow (Low-Level / Package) **Description:** [low-level] Validate an ABAP package 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/package/low/handleValidatePackage.ts` **Parameters:** - `package_name` (string, required) - Package 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. - `super_package` (string, required) - Parent (super) package name. The new package will be created under this 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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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 / Structure #### ActivateStructureLow (Low-Level / Structure) **Description:** [low-level] Activate an ABAP structure. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/structure/low/handleActivateStructure.ts` **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. - `structure_name` (string, required) - Structure name (e.g., ZST_MY_STRUCTURE). --- #### CheckStructureLow (Low-Level / Structure) **Description:** [low-level] Perform syntax check on an ABAP structure. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. If ddl_code is provided, validates new/unsaved code (will be base64 encoded in request). **Source:** `src/handlers/structure/low/handleCheckStructure.ts` **Parameters:** - `ddl_code` (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. - `structure_name` (string, required) - Structure name (e.g., Z_MY_PROGRAM). - `version` (string, optional) - Version to check: 'active' (last activated) or 'inactive' (current unsaved). Default: inactive --- #### CreateStructureLow (Low-Level / Structure) **Description:** [low-level] Create a new ABAP structure. - use CreateStructure (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/structure/low/handleCreateStructure.ts` **Parameters:** - `application` (string, optional (default: *').)) - Application area (optional, default: '*'). - `description` (string, required) - Structure 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. - `structure_name` (string, required) - Structure name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions. - `structure_type` (string, optional) - Structure type: 'executable', 'include', 'module_pool', 'function_group', 'class_pool', 'interface_pool' (optional). - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteStructureLow (Low-Level / Structure) **Description:** [low-level] Delete an ABAP structure from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/structure/low/handleDeleteStructure.ts` **Parameters:** - `structure_name` (string, required) - Structure name (e.g., Z_MY_PROGRAM). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### LockStructureLow (Low-Level / Structure) **Description:** [low-level] Lock an ABAP structure for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/structure/low/handleLockStructure.ts` **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. - `structure_name` (string, required) - Structure name (e.g., Z_MY_PROGRAM). --- #### UnlockStructureLow (Low-Level / Structure) **Description:** [low-level] Unlock an ABAP structure after modification. Must use the same session_id and lock_handle from LockStructure operation. **Source:** `src/handlers/structure/low/handleUnlockStructure.ts` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockStructure operation. - `session_id` (string, required) - Session ID from LockStructure operation. Must be the same as used in LockStructure. - `session_state` (object, optional) - Session state from LockStructure (cookies, csrf_token, cookie_store). Required if session_id is provided. - `structure_name` (string, required) - Structure name (e.g., Z_MY_PROGRAM). --- #### UpdateStructureLow (Low-Level / Structure) **Description:** [low-level] Update DDL source code of an existing ABAP structure. Requires lock handle from LockObject. - use UpdateStructureSource for full workflow with lock/unlock. **Source:** `src/handlers/structure/low/handleUpdateStructure.ts` **Parameters:** - `ddl_code` (string, required) - Complete DDL source code for the structure definition. - `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. - `structure_name` (string, required) - Structure name (e.g., ZZ_S_TEST_001). Structure must already exist. --- #### ValidateStructureLow (Low-Level / Structure) **Description:** [low-level] Validate an ABAP structure 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/structure/low/handleValidateStructure.ts` **Parameters:** - `description` (string, required) - Structure 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. - `structure_name` (string, required) - Structure name to validate (e.g., Z_MY_PROGRAM). --- ### Low-Level / System #### GetNodeStructureLow (Low-Level / System) **Description:** [low-level] Fetch node structure from ADT repository. Used for object tree navigation and structure discovery. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/system/low/handleGetNodeStructure.ts` **Parameters:** - `node_id` (string, optional (default: 0000" for root). Use to fetch child nodes.)) - Optional node ID (default: "0000" for root). Use to fetch child nodes. - `parent_name` (string, required) - Parent object name - `parent_type` (string, required) - Parent object type (e.g., "CLAS/OC", "PROG/P", "DEVC/K") - `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_short_descriptions` (boolean, optional (default: true)) - Include short descriptions in response --- #### GetObjectStructureLow (Low-Level / System) **Description:** [low-level] Retrieve ADT object structure as compact JSON tree. Returns XML response with object structure tree. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/system/low/handleGetObjectStructure.ts` **Parameters:** - `object_name` (string, required) - Object name (e.g., "ZMY_CLASS", "ZMY_PROGRAM") - `object_type` (string, required) - Object type (e.g., "CLAS/OC", "PROG/P", "DEVC/K", "DDLS/DF") - `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. --- #### GetVirtualFoldersLow (Low-Level / System) **Description:** [low-level] Retrieve hierarchical virtual folder contents from ADT information system. Used for browsing ABAP objects by package, group, type, etc. **Source:** `src/handlers/system/low/handleGetVirtualFolders.ts` **Parameters:** - `facet_order` (array, optional (default: ['package)) - Order of facets in response (e.g., ["package", "group", "type"]). Default: ["package", "group", "type"] - `ignore_short_descriptions` (boolean, optional (default: false)) - Ignore short descriptions in response - `object_search_pattern` (string, optional (default: *)) - Object search pattern (e.g., "*", "Z*", "ZCL_*"). Default: "*" - `preselection` (array, optional) - Optional preselection filters (facet-value pairs for filtering) - `with_versions` (boolean, optional (default: false)) - Include version information in response --- ### Low-Level / Table #### ActivateTableLow (Low-Level / Table) **Description:** [low-level] Activate an ABAP table. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/table/low/handleActivateTable.ts` **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. - `table_name` (string, required) - Table name (e.g., ZTB_MY_TABLE). --- #### CheckTableLow (Low-Level / Table) **Description:** [low-level] Perform syntax check on an ABAP table. Returns syntax errors, warnings, and messages. Requires session_id for stateful operations. Can use session_id and session_state from GetSession to maintain the same session. If ddl_code is provided, validates new/unsaved code (will be base64 encoded in request). **Source:** `src/handlers/table/low/handleCheckTable.ts` **Parameters:** - `ddl_code` (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. - `reporter` (string, optional) - Check reporter: 'tableStatusCheck' or 'abapCheckRun'. Default: abapCheckRun - `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. - `table_name` (string, required) - Table name (e.g., Z_MY_TABLE) - `version` (string, optional) - Version to check: 'active' (last activated), 'inactive' (current unsaved), or 'new' (for new code validation). Default: new --- #### CreateTableLow (Low-Level / Table) **Description:** [low-level] Create a new ABAP table. - use CreateTable (high-level) for full workflow with validation, lock, update, check, unlock, and activate. **Source:** `src/handlers/table/low/handleCreateTable.ts` **Parameters:** - `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. - `table_name` (string, required) - Table name (e.g., ZT_TEST_001). Must follow SAP naming conventions. - `transport_request` (string, optional) - Transport request. Required for transportable packages. --- #### DeleteTableLow (Low-Level / Table) **Description:** [low-level] Delete an ABAP table from the SAP system via ADT deletion API. Transport request optional for $TMP objects. **Source:** `src/handlers/table/low/handleDeleteTable.ts` **Parameters:** - `table_name` (string, required) - Table name (e.g., Z_MY_PROGRAM). - `transport_request` (string, optional) - Transport request. Required unless the object is local ($TMP). --- #### LockTableLow (Low-Level / Table) **Description:** [low-level] Lock an ABAP table for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. **Source:** `src/handlers/table/low/handleLockTable.ts` **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. - `table_name` (string, required) - Table name (e.g., Z_MY_PROGRAM). --- #### UnlockTableLow (Low-Level / Table) **Description:** [low-level] Unlock an ABAP table after modification. Must use the same session_id and lock_handle from LockTable operation. **Source:** `src/handlers/table/low/handleUnlockTable.ts` **Parameters:** - `lock_handle` (string, required) - Lock handle from LockTable operation. - `session_id` (string, required) - Session ID from LockTable operation. Must be the same as used in LockTable. - `session_state` (object, optional) - Session state from LockTable (cookies, csrf_token, cookie_store). Required if session_id is provided. - `table_name` (string, required) - Table name (e.g., Z_MY_PROGRAM). --- #### UpdateTableLow (Low-Level / Table) **Description:** [low-level] Update DDL source code of an existing ABAP table. Requires lock handle from LockObject. - use CreateTable for full workflow with lock/unlock. **Source:** `src/handlers/table/low/handleUpdateTable.ts` **Parameters:** - `ddl_code` (string, required) - Complete DDL source code for the table definition. - `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. - `table_name` (string, required) - Table name (e.g., ZOK_T_TEST_0001). Table must already exist. - `transport_request` (string, optional) - Transport request. Optional if the object is local or already in one. --- #### ValidateTableLow (Low-Level / Table) **Description:** [low-level] Validate an ABAP table name before creation. Checks if the name is valid and available. Can use session_id and session_state from GetSession to maintain the same session. **Source:** `src/handlers/table/low/handleValidateTable.ts` **Parameters:** - `description` (string, required) - Table 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. - `table_name` (string, required) - Table name to validate (e.g., Z_MY_TABLE) --- ### Low-Level / Transport #### CreateTransportLow (Low-Level / Transport) **Description:** [low-level] Create a new ABAP transport request. **Source:** `src/handlers/transport/low/handleCreateTransport.ts` **Parameters:** - `description` (string, required) - Transport request description. - `transport_type` (string, optional (default: workbench').)) - Transport type: 'workbench' or 'customizing' (optional, default: 'workbench'). --- ### 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` **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` **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` **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` **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` **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` **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` **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` **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*