Class Reference
EnsLib.SAP.Utils
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [EnsLib] >  [SAP] >  [Utils]
Private  Storage

class EnsLib.SAP.Utils extends %RegisteredObject

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 15 13


Summary

Properties
JavaGatewayAddress JavaGatewayPort SAPClient SAPGWHost
SAPGWServ SAPGroup SAPHost SAPLanguage
SAPMSHost SAPPassword SAPR3Name SAPSystemNumber
SAPTransactionAutoCommit SAPType SAPUser

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
Connect CreateClasses GetBAPIList GetRFCList
PingSAP


Parameters

• parameter DOMAIN = "EnsSAP";
Domain for $$$Text()

Properties

• property JavaGatewayAddress as %String(TRUNCATE=1);
Dervied from JavaGateway
• property JavaGatewayPort as %String(TRUNCATE=1);
Dervied from JavaGateway
• property SAPClient as %String(TRUNCATE=1);
SAP Client e.g 000
• property SAPGWHost as %String(MAXLEN="");
MM 20130917 Used for loadbalanced Type "B" connect. Gateway Host (jco.client.gwhost).
• property SAPGWServ as %String(MAXLEN="");
MM 20130917 Used for loadbalanced Type "B" connect. Gateway Service (jco.client.gwserv).
• property SAPGroup as %String(MAXLEN="");
MM 20130917 Used for loadbalanced Type "B" connect. SAP Group (jco.client.group).
• property SAPHost as %String(TRUNCATE=1);
IP Address of the SAP Host
• property SAPLanguage as %String(TRUNCATE=1);
Derived from Credentials
• property SAPMSHost as %String(MAXLEN="");
MM 20130917 Used for loadbalanced Type "B" connect. Message Server Host (jco.client.mshost).
• property SAPPassword as %String(TRUNCATE=1);
Derived from Credentials
• property SAPR3Name as %String(MAXLEN="");
MM 20130917 Used for loadbalanced Type "B" connect. SAP Group (jco.client.r3name).
• property SAPSystemNumber as %String(TRUNCATE=1);
SAP System Number 00
• property SAPTransactionAutoCommit as %Boolean [ InitialExpression = 0 ];
Should perform Auto Commit
• property SAPType as %String(VALUELIST=",A,B") [ InitialExpression = "A",Required ];
MM 20130917 SAP Type for connect: "A" means direct application server connect, "B" means load balanced connect
• property SAPUser as %String(TRUNCATE=1);
Name of InterSystems IRIS Credentials to use for the connection

Methods

• method Connect(Output pGateway As EnsLib.JavaGateway.JavaGateway, Output pJCoDestination As %ObjectHandle, Output pJCoRespository As %ObjectHandle) as %Status
Connect to SAP, returns an instance of the JavaGateway, SAP Destination and SAP Respository
• method CreateClasses(pSAPName As %String, pPackage As %String) as %Status
This method creates the classes which represent the structure of the specified SAP call. Classes ISCuRequest and ISCuResponse and supporting structural classes are generated within the named package. To avoid conflict with external names, the names of InterSystems specific structures are prefixed with the 'ISCu' prefix. In addition the SAP names containing underscores will be converted to equivalent ObjectScript compatible names with an alternate character replacing the underscore
• method GetBAPIList(Output pList As %ListOfDataTypes, pFilterString As %String = "") as %Status
Retrieve a list of Know BPIs from the SAP repository Note: This method relies on pre-knowlege of the structure of the SWO_QUERY_API_METHODS function which should not vary between SAP JCO versions.
• method GetRFCList(Output pList As %ListOfDataTypes, pFilterString As %String = "") as %Status
Retrieve a list of Known RFCs from the SAP repository Note: This method relies on pre-knowlege of the structure of the SWO_QUERY_API_METHODS function which should not vary between SAP JCO versions.
• method PingSAP(Output pOK As %Boolean) as %Status
Connect to SAP and perform a dynamic invocation of the STFC_CONNECTION function to test connectivity. Note: This method relies on pre-knowlege of the structure of the STFC_CONNECTION function which should not vary between SAP JCO versions.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.