T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
TPSAP Namespace Reference

Namespaces

 BOM
 
 CALL_TRANSACTION
 
 CLASS
 
 CSAI_BOM
 
 DIR
 
 ECM
 
 EQUI
 
 FUNCLOC
 
 MAIL
 
 MISCELLANEOUS
 
 MM
 
 ORDERBOM
 
 PRODORDER
 
 PROJECT
 
 PURCHASE
 
 REFSETOFOPERATIONS
 
 ROUTING
 
 S4
 
 SALESORDER
 
 TESISPLM
 
 USER
 
 VENDOR
 
 WORKCENTER
 
 ZPTC
 

Functions

 callRFC_FUNCTION_DOCU_GET FunctionName ?Language?
 Calls the RFC_FUNCTION_DOCU_GET ABAP via JCo. More...
 
 callRFC_FUNCTION_SEARCH FUNCNAME ?GROUPNAME? ?LANGUAGE?
 This function calls the RFC_FUNCTION_SEARCH function module. More...
 
 callRFC_GET_STRUCTURE_DEFINITION TableName ?UCLength?
 This function calls the RFC_GET_STRUCTURE_DEFINITION function module. More...
 
 callRFC_PING args
 This function calls the RFC_PING function module. More...
 
 doCommitOrRollBackBasedOnStatus TransferStatusList
 Based on the T4S transfer status we run a COMMIT and WAIT of the SAP transfer or we do a ROLLBACK of the transaction. More...
 
 doCommitOrRollBackBasedOnStatusDict TransferStatusDict
 Based on the SAP transfer/update status dict we run a COMMIT and WAIT of the SAP transfer or we do a ROLLBACK of the transaction. More...
 
 getDecimalSignOnly args
 Retrieves the decimal sign from the user profile of the active SAP system connection. More...
 
 getDecimalSigns args
 Retrieves the decimal sign and the thousands separator from the user profile of the active SAP system connection. More...
 
 getEmtpyScreenMsg args
 This function returns the last error message displayed in the SAPgui screen. More...
 
 getExternDateString ?Year? ?Month? ?Day? args
 Retrieves the external date format of the active SAP system connection. More...
 
 getInternDateString ?ExternalDateString? args
 Retrieves the internal date format of the active SAP system connection. More...
 
 getLoginLanguage args
 Retrieves the language of the active SAP system connection. More...
 
 getLoginLanguageISO args
 Retrieves the ISO language of the active SAP system connection. More...
 
 getReleaseInfo args
 Retrieves SAP system release information for the active SAP system connection. More...
 
 getSAPUser args
 Retrieves the user name of the active SAP system connection. More...
 
 getSessionLogChannel args
 Function tries to get the Session Logfile name of the current transaction. If no session logfile name is available, the default LogChannel is used. More...
 
 getSystemInfo args
 Retrieves SAP system information using the ABAP RFC_GET_SAP_SYSTEM_PARAMETERS. More...
 
 getSystemInfoWithReleaseVersion args
 Retrieves SAP system information including release version using the ABAP SCSI_GET_SYSTEM_INFO. More...
 
 performSapCall SAPInDataDictForNW
 Calls a SAP function. More...
 
 readF4BapiHelp ObjectType ObjectName Method Param Field args
 Retieves all valid help values (F4) for a parameter or field of a structured BAPI parameter. More...
 
 readFunctionInterface SAPFunctionName args
 Retrieves detailed information about an ABAP function using the ABAP BDL_FUNCTION_INTERFACE_GET. More...
 
 readRfcFunctionInterface SAPFunctionName args
 Retrieves detailed information about an ABAP function using the ABAP RFC_GET_FUNCTION_INTERFACE. More...
 
 readRfcFunctionInterfaceParameters FunctionName ?Language? args
 Retrieves detailed information about an ABAP function using the ABAP RFC_GET_FUNCTION_INTERFACE_P. More...
 
 RfcGetAttributes args
 Calls the SAP lib function RfcGetAttributes. More...
 
 transformQuantity2TclFloat Number ?DecimalSign?
 Transforms the external SAP representation of a floating point value into the tcl reprenstation of a float (e.g. 1.000,500 -> 1000.500). More...
 

Variables

 ConnectorList
 
 RfcAttributes
 
 SystemDateFormat
 
 SystemInfo
 

Function Documentation

◆ callRFC_FUNCTION_DOCU_GET()

TPSAP::callRFC_FUNCTION_DOCU_GET   FunctionName ?Language?  

Calls the RFC_FUNCTION_DOCU_GET ABAP via JCo.

Returns
dict structure with the following element:
  • Status OK|ERROR|JCO_ERROR
  • JCoStatus OK or JCO exception error
  • ErrorMessage last error message
  • NoOfMessages 0 or n
  • LogMessageMessage(1 .. n)
  • LogMessageSeverity(1 .. n)

◆ callRFC_FUNCTION_SEARCH()

TPSAP::callRFC_FUNCTION_SEARCH   FUNCNAME ?GROUPNAME? ?LANGUAGE?  

This function calls the RFC_FUNCTION_SEARCH function module.

Parameters
FUNCNAMEfunction name pattern
GROUPNAMEgroup name pattern
LANGUAGElanguage (one digit language code); default is E for English
Returns
OK or ERROR

References getSessionLogChannel().

◆ callRFC_GET_STRUCTURE_DEFINITION()

TPSAP::callRFC_GET_STRUCTURE_DEFINITION   TableName ?UCLength?  

This function calls the RFC_GET_STRUCTURE_DEFINITION function module.

Parameters
TableNameSAP ABAP table name
UCLengthUnicode Character Length
Returns
OK or ERROR

References getSessionLogChannel().

◆ callRFC_PING()

TPSAP::callRFC_PING   args  

This function calls the RFC_PING function module.

Parameters
none
Returns
OK or ERROR

References getSessionLogChannel().

◆ doCommitOrRollBackBasedOnStatus()

TPSAP::doCommitOrRollBackBasedOnStatus   TransferStatusList  

◆ doCommitOrRollBackBasedOnStatusDict()

TPSAP::doCommitOrRollBackBasedOnStatusDict   TransferStatusDict  

Based on the SAP transfer/update status dict we run a COMMIT and WAIT of the SAP transfer or we do a ROLLBACK of the transaction.

Parameters
TransferStatusDictStatus dict of the previous SAP update call
  • Status OK|ERROR|JCO_ERROR
  • JCoStatus OK|ERROR
  • ErrorMessage last error message
  • NoOfMessages number of messages
  • LogMessageMessage(1 .. n)
Returns
TransferStatusDict Updated Status dict that contains the error that occurs during the commit call.
  • Status OK|ERROR|JCO_ERROR
  • JCoStatus OK|ERROR
  • ErrorMessage last error message
  • NoOfMessages number of messages
  • LogMessageMessage(1 .. n)

References getSessionLogChannel().

Referenced by TPSAP::BOM::changeBillOfMaterial2(), TPSAP::BOM::createBillOfMaterial2(), TPSAP::BOM::BAPI::createBillOfMaterial2(), TPSAP::BOM::BAPI::maintainBillOfMaterial2(), TPSAP::MM::reserveMaterialNumber2(), and TPSAP::MM::updateMaterialMaster2().

◆ getDecimalSignOnly()

TPSAP::getDecimalSignOnly   args  

Retrieves the decimal sign from the user profile of the active SAP system connection.

Returns
decimal sign

References getSessionLogChannel(), getSystemInfo(), and tpwrite().

◆ getDecimalSigns()

TPSAP::getDecimalSigns   args  

Retrieves the decimal sign and the thousands separator from the user profile of the active SAP system connection.

Returns
List of the decimal separator AND the thousands separator defined in the profile of the connected user The following values are returned:
  • [list {,} {.}] - decimal separator ',' thousands separator '.' (value example "1.234.567,89")
  • [list {,} { }] - decimal separator ',' thousands separator ' ' (value example "1 234 567,89")
  • [list {.} {,}] - decimal separator '.' thousands separator ',' (value example "1,234,567.89")

References getSessionLogChannel(), getSystemInfo(), and tpwrite().

Referenced by TPSAP::BOM::readBillOfMaterial(), and transformQuantity2TclFloat().

◆ getEmtpyScreenMsg()

TPSAP::getEmtpyScreenMsg   args  

This function returns the last error message displayed in the SAPgui screen.

Parameters
none
Returns
Hex message string

References getSessionLogChannel(), and tpco_scanHEX16().

◆ getExternDateString()

TPSAP::getExternDateString   ?Year? ?Month? ?Day? args  

Retrieves the external date format of the active SAP system connection.

Returns
SAP system external date format for active connection

References getSessionLogChannel(), getSystemInfo(), and tpwrite().

◆ getInternDateString()

TPSAP::getInternDateString   ?ExternalDateString? args  

Retrieves the internal date format of the active SAP system connection.

Returns
SAP system internal date format for active connection

References getSessionLogChannel(), getSystemInfo(), and tpwrite().

◆ getLoginLanguage()

TPSAP::getLoginLanguage   args  

◆ getLoginLanguageISO()

TPSAP::getLoginLanguageISO   args  

Retrieves the ISO language of the active SAP system connection.

Returns
SAP system ISO language

References getSessionLogChannel(), RfcGetAttributes(), and tpwrite().

Referenced by TPSAP::CLASS::getDetailedObjectClassification(), and TPSAP::CLASS::getObjectClassification().

◆ getReleaseInfo()

TPSAP::getReleaseInfo   args  

Retrieves SAP system release information for the active SAP system connection.

Returns
SAP system release information SAP_SYSTEM_RELEASE

References getSessionLogChannel(), getSystemInfo(), and tpwrite().

Referenced by T4S::MM::CUSTOM::ITEM::IMPORT::getMaterialMasterInfo(), TPSAP::MM::setMaterialMaster_by_Reference(), and T4S::CONNECTION2SAP::testSAPLogin().

◆ getSAPUser()

TPSAP::getSAPUser   args  

Retrieves the user name of the active SAP system connection.

Returns
SAP system user name for active connection

References getSessionLogChannel(), getSystemInfo(), and tpwrite().

◆ getSessionLogChannel()

TPSAP::getSessionLogChannel   args  

Function tries to get the Session Logfile name of the current transaction. If no session logfile name is available, the default LogChannel is used.

References T4X::CORE::getSessionLogChannel().

Referenced by TPSAP::BOM::addSAPBomSubPosition(), TPSAP::MISCELLANEOUS::BapiUserGetDetail(), TPSAP::PURCHASE::ORDER::callBAPI_PO_GETITEMS(), TPSAP::PRODORDER::callBAPI_PRODORD_GET_LIST(), callRFC_FUNCTION_SEARCH(), callRFC_GET_STRUCTURE_DEFINITION(), callRFC_PING(), TPSAP::BOM::changeBillOfMaterial(), TPSAP::BOM::changeBillOfMaterial2(), TPSAP::ECM::ChangeMasterAssignObject2AltDate(), TPSAP::ECM::ChangeMasterChangeAltDate(), TPSAP::ECM::ChangeMasterCreateAltDate(), TPSAP::ECM::ChangeMasterDeleteAltDate(), TPSAP::VENDOR::changePurchaseInfoRecord(), TPSAP::VENDOR::changeVendor(), TPSAP::CLASS::charactGetDataType(), TPSAP::CLASS::charactGetDetail(), TPSAP::MM::checkConfigProfilExists(), TPSAP::MM::checkMaterialMasterAvailability(), TPSAP::MM::checkMaterialMasterExistence(), TPSAP::DIR::checkOutView(), TPSAP::ROUTING::checkRoutingExistence(), TPSAP::CLASS::classGetDetail(), TPSAP::CLASS::clearObjectClassificationCurrency(), TPSAP::CLASS::clearObjectClassificationNumericValues(), TPSAP::CLASS::clearObjectClassificationStringValues(), TPSAP::TESISPLM::UOM::convertISO2SAP2(), TPSAP::TESISPLM::UOM::convertSAP2ISO2(), TPSAP::DIR::copyObjectLinks(), TPSAP::CSAI_BOM::createBillOfMaterial(), TPSAP::BOM::createBillOfMaterial(), TPSAP::BOM::BAPI::createBillOfMaterial(), TPSAP::BOM::createBillOfMaterial2(), TPSAP::BOM::BAPI::createBillOfMaterial2(), TPSAP::ECM::createChangeMaster_WithProfile(), TPSAP::VENDOR::createPurchaseInfoRecord(), TPSAP::VENDOR::createVendor(), TPSAP::ORDERBOM::deleteBillOfMaterial(), TPSAP::CSAI_BOM::deleteBillOfMaterial(), TPSAP::BOM::BAPI::deleteBillOfMaterial(), TPSAP::ORDERBOM::deletePositionStructure(), TPSAP::BOM::deletePositionStructure(), doCommitOrRollBackBasedOnStatus(), doCommitOrRollBackBasedOnStatusDict(), TPSAP::MISCELLANEOUS::Enqueue_Read(), TPSAP::EQUI::Equi_getDetail(), TPSAP::EQUI::Equi_getList(), TPSAP::TESISPLM::BADI::executeT4SBadi(), TPSAP::DIR::ExistenceCheck(), TPSAP::FUNCLOC::FuncLoc_getDetail(), TPSAP::FUNCLOC::FuncLoc_getList(), TPSAP::DIR::getActiveVersion(), TPSAP::DIR::getActualVersion(), TPSAP::MM::getAllMaterialMasterInfos(), TPSAP::MM::getAllMaterialMasterInfosReadSingle(), TPSAP::ECM::getChangeMaster4Object(), TPSAP::ECM::getChangeMasterAltDatesList(), TPSAP::ECM::getChangeMasterEffectivity(), TPSAP::ECM::getChangeMasterInfo(), TPSAP::ECM::getChangeMasterLongText(), TPSAP::ECM::getChangeMasterObjectTypeDefinition(), TPSAP::ECM::getChangeMasterObjMgRecList(), TPSAP::ECM::getChangeMasterProfileData(), TPSAP::ECM::getChangeMasterValueAssign(), TPSAP::CLASS::getClassCharacteristics(), TPSAP::DIR::getDataCarrierInfo(), getDecimalSignOnly(), getDecimalSigns(), TPSAP::VENDOR::getDetail(), TPSAP::SALESORDER::getDetail(), TPSAP::CLASS::getDetailedObjectClassification(), TPSAP::DIR::getDocumentInfoRecordInfo(), TPSAP::DIR::getDocumentInfoRecordList(), TPSAP::DIR::getDocumentState(), TPSAP::DIR::getDocumentTypeInfo(), getEmtpyScreenMsg(), TPSAP::ECM::getExternalChangeNumber(), TPSAP::DIR::getExternalDocumentNumber(), TPSAP::MM::getExternalMaterialNumber(), TPSAP::VENDOR::getExternalNumber(), TPSAP::FUNCLOC::getExternalNumber(), TPSAP::EQUI::getExternalNumber(), TPSAP::PRODORDER::getExternalNumber(), TPSAP::SALESORDER::getExternalOrderNumber(), TPSAP::PROJECT::getExternalPSPNR(), getExternDateString(), TPSAP::ROUTING::getHighestGroup(), TPSAP::VENDOR::getInfoRecordInfo(), TPSAP::VENDOR::getInfoRecordInfo2(), TPSAP::ECM::getInternalChangeNumber(), TPSAP::DIR::getInternalDocumentNumber(), TPSAP::MM::getInternalMaterialNumber(), TPSAP::VENDOR::getInternalNumber(), TPSAP::FUNCLOC::getInternalNumber(), TPSAP::EQUI::getInternalNumber(), TPSAP::PRODORDER::getInternalNumber(), TPSAP::SALESORDER::getInternalOrderNumber(), TPSAP::PROJECT::getInternalPSPNR(), getInternDateString(), TPSAP::DIR::getLatestVersion(), getLoginLanguage(), getLoginLanguageISO(), TPSAP::MM::getMaterialList(), TPSAP::MM::getMaterialMasterInfo(), TPSAP::MM::getMaterialMasterInfoRfc(), TPSAP::MM::getMaterialMasterLongText(), TPSAP::CLASS::getObjectClassification(), TPSAP::ECM::getObjectManagementTypesList(), TPSAP::MM::getPlantsOfMaterial(), getReleaseInfo(), getSAPUser(), TPSAP::SALESORDER::getStatus(), TPSAP::DIR::getStatusList(), TPSAP::CLASS::getSuperClassAllocs(), getSystemInfo(), getSystemInfoWithReleaseVersion(), TPSAP::MM::getTaxIndicator4MaterialMaster(), TPSAP::VENDOR::getVendorInfo(), TPSAP::MM::getViewList4Plant(), TPSAP::BOM::BAPI::init_CT_EX_S_PATH_UPD4BOM_PARAMETER(), TPSAP::CLASS::initClassificationStructureChange(), TPSAP::CLASS::initClassificationStructureCreate(), TPSAP::EQUI::initEquiStructure(), TPSAP::FUNCLOC::initFuncLocStructure(), TPSAP::ORDERBOM::initLongTextStructure(), TPSAP::CLASS::initObjectClassificationStructure(), TPSAP::ORDERBOM::initPositionDependencyDescrStructure(), TPSAP::ORDERBOM::initPositionDependencyDocStructure(), TPSAP::ORDERBOM::initPositionDependencyOrderStructure(), TPSAP::ORDERBOM::initPositionDependencySourceStructure(), TPSAP::ORDERBOM::initPositionDependencyStructure(), TPSAP::ORDERBOM::initPositionStructure(), TPSAP::ROUTING::initRoutingDataStructure(), TPSAP::ORDERBOM::initSAPBomHeaderStructure(), TPSAP::BOM::BAPI::initSAPBomHeaderStructure(), TPSAP::ECM::initSAPChangeMasterStructure(), TPSAP::DIR::initSAPDocumentDescription(), TPSAP::DIR::initSAPDocumentOriginalStructure(), TPSAP::DIR::initSAPDocumentStructure(), TPSAP::DIR::initSAPDocumentStructureStructure(), TPSAP::ORDERBOM::initSubPositionStructure(), TPSAP::MM::linkMaterialMaster2DIR(), TPSAP::CSAI_BOM::maintainBillOfMaterial(), TPSAP::BOM::BAPI::maintainBillOfMaterial(), TPSAP::BOM::BAPI::maintainBillOfMaterial2(), TPSAP::TESISPLM::MM_ATTACHMENTS::maintainURLs(), TPSAP::CLASS::mergeObjectClassification(), TPSAP::VENDOR::readAMPL(), TPSAP::ORDERBOM::readBillOfMaterial(), TPSAP::CSAI_BOM::readBillOfMaterial(), TPSAP::BOM::readBillOfMaterial(), TPSAP::BOM::BAPI::readBillOfMaterial(), TPSAP::BOM::readBillOfMaterial2(), TPSAP::BOM::BAPI::readBillOfMaterial2(), TPSAP::BOM::BAPI::readBillOfMaterialWithAssemblyFlag(), readF4BapiHelp(), readFunctionInterface(), TPSAP::TESISPLM::MISC::readPlants(), TPSAP::PRODORDER::readProductionOrder(), TPSAP::PRODORDER::readProductionOrder2(), readRfcFunctionInterface(), TPSAP::MM::reserveMaterialNumber(), TPSAP::MM::reserveMaterialNumber2(), TPSAP::ECM::RevisionLevelSelect(), TPSAP::ECM::RevisionLevelTableExport(), RfcGetAttributes(), TPSAP::MISCELLANEOUS::RfcReadLongText(), TPSAP::MISCELLANEOUS::RfcReadTable(), TPSAP::ROUTING::RoutingGetDetail(), TPSAP::ROUTING::RoutingGetMapl(), TPSAP::ROUTING::RoutingSequenceGetAll(), TPSAP::CLASS::selectChangeMasterClassification(), TPSAP::CLASS::selectClassificationDefinition(), TPSAP::CLASS::selectDocumentClassification(), TPSAP::CLASS::selectDocumentObjectLinkClassification(), TPSAP::CLASS::selectGenericObjectLinkClassification(), TPSAP::CLASS::selectMaterialMasterClassification(), TPSAP::CLASS::selectPlanClassification(), TPSAP::MAIL::SendMail(), TPSAP::MAIL::SendMailWithBOAtt(), TPSAP::CLASS::setClassification_by_Reference(), TPSAP::MM::setClassificationData_by_Reference(), TPSAP::MM::setCrossPlantConfigurableMaterial(), TPSAP::BOM::setDependencyDescription(), TPSAP::DIR::setDocumentState(), TPSAP::MM::setKonfMatFlag(), TPSAP::MM::setMaterialMaster_by_Reference(), TPSAP::MM::setMaterialMasterLongText(), TPSAP::MM::setMaterialMasterNoteLongText(), TPSAP::MM::setMaterialMasterSalesLongText(), TPSAP::ECM::setObjectTypeStructure(), TPSAP::PRODORDER::setProdOrderUserStatus(), TPSAP::ECM::setRevisionLevel(), TPSAP::ORDERBOM::setSAPBomLPositionStructure(), TPSAP::ORDERBOM::setSAPBomRPositionStructure(), TPSAP::BOM::setSAPBomSubPositionStructure(), TPSAP::ORDERBOM::setSAPBomTextPositionStructure(), TPSAP::DIR::setSAPDocumentDescription(), TPSAP::DIR::setSAPDocumentStructureStructure(), TPSAP::BOM::setSelectionCondition(), TPSAP::MM::setTaxIndicator4MaterialMaster(), TPSAP::ORDERBOM::storeLongText2Structure(), TPSAP::ECM::storeLongText4Description(), TPSAP::CLASS::storeObjectClassificationCurrency(), TPSAP::CLASS::storeObjectClassificationNumericValue(), TPSAP::CLASS::storeObjectClassificationStringValue(), TPSAP::VENDOR::updateAMPL(), TPSAP::MM::updateMaterialMaster(), TPSAP::MM::updateMaterialMaster2(), TPSAP::ECM::updateObjectManagementRecord(), TPSAP::ECM::updateObjectManagementRecord2(), TPSAP::ZPTC::ZPTC_Delete(), TPSAP::ZPTC::ZPTC_Dyn_Delete(), TPSAP::ZPTC::ZPTC_Dyn_Search(), TPSAP::ZPTC::ZPTC_Get_Detail(), TPSAP::ZPTC::ZPTC_Insert(), and TPSAP::ZPTC::ZPTC_Update().

◆ getSystemInfo()

TPSAP::getSystemInfo   args  

Retrieves SAP system information using the ABAP RFC_GET_SAP_SYSTEM_PARAMETERS.

Parameters
none
Returns
SAP system information like language, decimal sign, ... in the namespace param SystemInfo

References getSessionLogChannel().

Referenced by getDecimalSignOnly(), getDecimalSigns(), getExternDateString(), getInternDateString(), getReleaseInfo(), and getSAPUser().

◆ getSystemInfoWithReleaseVersion()

TPSAP::getSystemInfoWithReleaseVersion   args  

Retrieves SAP system information including release version using the ABAP SCSI_GET_SYSTEM_INFO.

Parameters
none
Returns
SAPOutDataDict and global TCL array ::sap_result_array_SCSI_GET_SYSTEM_INFO with SAP system release information from table CVERS

References T4X::CORE::getSessionLogChannel(), getSessionLogChannel(), tpco_scanHEX16(), and tpwrite().

Referenced by TPSAP::S4::checkIfTargetSystemIsS4HANA(), and T4S::CONNECTION2SAP::validateAccess2SCSI_GET_SYSTEM_INFO().

◆ performSapCall()

TPSAP::performSapCall   SAPInDataDictForNW  

Calls a SAP function.

The SAP function to call is specified by the input data. The call can occur using different connectors.

Currently, the following connectors are supported:

  • NW: Netweaver connector
  • JCO: Java connector
  • WS: Web service connector (reserved for future usage)

Connector settings can be configured as follows: a) ::TPSAP::setSapConnector [dict create Type "...some connector..." SapSystem $SapSystem] b) ::TPSAP::setSapConnector [dict create Type "...some connector..." SapSystem $SapSystem SapFunction $SapFunction]

Case a) specifies:

  • a connector for all accesses to a particular SAP system

Case b) specifies:

  • a connector for all accesses to a particular SAP system calling a particular SAP function

So, settings of type b) can overwrite settings of type a).

Parameters
SAPInDataDictForNW- a SAP input data dict using the Netweaver pipe format; the dict specifies, among others, the SAP function to call currently the following dict keys are supported: SAPFunction the SAP function to call SAPInDataArray the name of a TCL array used for the input data of the function call the array has to be written before the function is called this is an optional field defaulting to "::SAPInData" SAPOutDataArray the name of a TCL array used for the output data of the function call the array can be read after the function is called this is an optional field defaulting to "::SAPOutData" Pattern the prefix of keys of the array specified by "SAPInDataArray" UseSAPGui if a SAP GUI has to be used during the function call possible values: true|false this is an optional field defaulting to "false" UseSAPCallback if a SAP callback function has to be used during the function call possible values: true|false this is an optional field defaulting to "false" Commit if the "commit functionality" has to be activated during the function call possible values: true|false this is an optional field defaulting to "false" CaloInit if the "caloinit functionality" has to be activated during the function call possible values: true|false this is an optional field defaulting to "false" VerifyDataKeys if the keys of the TCL array used for the input data have to be verified or not possible values: true|false in case of verification a "strict mode" is used:
  • in this case if keys are specified that do not exist and the Netweaver API "complains" about that, the function call is aborted with an error in case of non-verification a "tolerant mode" is used:
  • in this case if keys are specified that do not exist and the Netweaver API "complains" about that, the function call is not aborted and the corresponding parameter is skipped this is an optional field defaulting to "false" VerifyDataValues if the values of the TCL array used for the input data have to be verified or not possible values: true|false in case of verification a "strict mode" is used:
  • in this case if values are specified and the Netweaver API "complains" about them while trying to convert them, the function call is aborted with an error in case of non-verification a "tolerant mode" is used:
  • in this case if values are specified and the Netweaver API "complains" about them while trying to convert them, the function call is not aborted and the corresponding parameter is skipped this is an optional field defaulting to "false" VerifyErrors if the TCL array used for the output data has to be verified whether errors occurred or not possible values: true|false this is a compatibility mode which tries to reproduce the error validation functionality of the JCo pipe this is an optional field defaulting to "true" CloseConnection if the connection to the SAP system has to be closed after the function call possible values: true|false this is an optional field defaulting to "false"
Returns
Resulting dict with at least the following keys: Status OK|ERROR|JCO_ERROR JCoStatus OK|ERROR ErrorMessage last error message NoOfMessages number of messages LogMessageMessage(1 .. n)

References T4X::CORE::getLogLineMessageType4rc(), T4X::CORE::getSessionLogChannel(), T4X::CORE::getTransactionLogChannel(), tpco_calcHMAC(), tpco_shmget(), and tpwrite().

Referenced by TPSAP::ECM::call_TESISPLM_ECM_GET_ECM4OBJECT(), TPSAP::ECM::call_TESISPLM_ECM_OBJMGREC_READ(), TPSAP::ECM::call_TESISPLM_ECM_OBJTYPE_DEF_READ(), TPSAP::ECM::call_TESISPLM_ECM_PROFILE_READ(), TPSAP::MM::call_TESISPLM_MM_GET_CONFIGURATION(), TPSAP::MM::call_TESISPLM_T4S_READ_PROD_VERS(), TPSAP::VENDOR::GEN::callBAPI_INFORECORD_GETLIST(), TPSAP::PURCHASE::ORDER::callBAPI_PO_GETITEMS(), TPSAP::PRODORDER::callBAPI_PRODORD_GET_LIST(), TPSAP::CLASS::getSuperClassAllocs(), and TPSAP::WORKCENTER::getWorkcenterHierarchyInfo().

◆ readF4BapiHelp()

TPSAP::readF4BapiHelp   ObjectType ObjectName Method Param Field args  

Retieves all valid help values (F4) for a parameter or field of a structured BAPI parameter.

Example: You want to determine the valid help values for the National field (country code). The field is in the BAPI Employee.GetList in the PersonalData parameter.

If you call the method with the following parameters:

ObjectType '' ObjectName 'Employee' Method 'GetList' Param 'PersonalData' Field 'National'

Parameters
ObjectTypeObject type
ObjectNameObject Name
MethodMethod name of object type
ParamName of parameter in method
FieldField name in the parameter for F4 values
Returns
OK and global TCL array ::F4ResultDat or ERROR

References getSessionLogChannel().

◆ readFunctionInterface()

TPSAP::readFunctionInterface   SAPFunctionName args  

Retrieves detailed information about an ABAP function using the ABAP BDL_FUNCTION_INTERFACE_GET.

Parameters
SAPFunctionName
Returns
OK and global TCL array ::FunctionResultDat or ERROR

References getSessionLogChannel().

◆ readRfcFunctionInterface()

TPSAP::readRfcFunctionInterface   SAPFunctionName args  

Retrieves detailed information about an ABAP function using the ABAP RFC_GET_FUNCTION_INTERFACE.

Parameters
SAPFunctionName
Returns
OK and global TCL array ::FunctionResultDat or ERROR

References getSessionLogChannel().

◆ readRfcFunctionInterfaceParameters()

TPSAP::readRfcFunctionInterfaceParameters   FunctionName ?Language? args  

Retrieves detailed information about an ABAP function using the ABAP RFC_GET_FUNCTION_INTERFACE_P.

Parameters
FunctionName
Language
Returns
OK and global TCL array ::ParameterResultDat or ERROR

References tpwrite().

◆ RfcGetAttributes()

TPSAP::RfcGetAttributes   args  

Calls the SAP lib function RfcGetAttributes.

Generates array TPSAP::RfcAttributes with following content:

  • ::TPSAP::RfcAttributes(CLIENT);#Client ("Mandant")
  • ::TPSAP::RfcAttributes(CODEPAGE);#Own code page
  • ::TPSAP::RfcAttributes(CPIC_CONV_ID);#CPI-C Conversation ID
  • ::TPSAP::RfcAttributes(DEST);#RFC destination
  • ::TPSAP::RfcAttributes(HOST OWN_HOST);#Own host name
  • ::TPSAP::RfcAttributes(ISO_LANGUAGE);#2-byte ISO-Language
  • ::TPSAP::RfcAttributes(KERNEL_REL);#Partner kernel release
  • ::TPSAP::RfcAttributes(LANGUAGE);# 1-byte Language string
  • ::TPSAP::RfcAttributes(PCS);#Number of bytes per character in the backend's current codepage. Note this is different from the semantics of the PCS parameter.
  • ::TPSAP::RfcAttributes(PARTNER_CODEPAGE);#Partner code page
  • ::TPSAP::RfcAttributes(PARTNER_HOST);#Partner host name
  • ::TPSAP::RfcAttributes(PARTNER_REL);#Partner system release
  • ::TPSAP::RfcAttributes(REAL_PARTNER_CODEPAGE);#Partner system code page
  • ::TPSAP::RfcAttributes(PARTNER_TYPE);#2/3/E/R: R/2,R/3,Ext,Reg.Ext
  • ::TPSAP::RfcAttributes(PROGNAME);#Name of the calling APAB program (report, module pool)
  • ::TPSAP::RfcAttributes(OWN_REL);#
  • ::TPSAP::RfcAttributes(RESERVED);#Reserved for later use
  • ::TPSAP::RfcAttributes(RFC_ROLE);#C/S: RFC Client / RFC Server
  • ::TPSAP::RfcAttributes(SYSID);# R/3 system ID
  • ::TPSAP::RfcAttributes(SYSTNR);#R/3 system number
  • ::TPSAP::RfcAttributes(TRACE);#Trace level (0-3)
  • ::TPSAP::RfcAttributes(OWN_TYPE);#2/3/E/R: R/2,R/3,Ext,Reg.Ext
  • ::TPSAP::RfcAttributes(USER);#User
Parameters
none
Returns
OK or ERROR

References getSessionLogChannel().

Referenced by TPSAP::DIR::getDataCarrierInfo(), TPSAP::DIR::getDocumentTypeInfo(), getLoginLanguage(), getLoginLanguageISO(), T4S::DIR::CUSTOM::MAPPING::SAP_DocumentInfoRecord2TC_Object(), and T4S::CONNECTION2SAP::validatePasswordState4User().

◆ transformQuantity2TclFloat()

TPSAP::transformQuantity2TclFloat   Number ?DecimalSign?  

Transforms the external SAP representation of a floating point value into the tcl reprenstation of a float (e.g. 1.000,500 -> 1000.500).

Parameters
NumberSAP external Number format
DecimalSignlist that contains the information of the number format in the SAP profile
Returns
float value of a given SAP formated float value

Sample code sequence

set DECIMALSIGN [::TPSAP::getDecimalSigns]
set Quantity [string trim $::BOMResultDat(STPO_API02:COMP_QTY:1)]
set ImportInfo(BOMLINE:bl_quantity:1) [::TPSAP::transformQuantity2TclFloat $Quantity $DECIMALSIGN]

References getDecimalSigns().

Variable Documentation

◆ ConnectorList

ConnectorList
static

◆ RfcAttributes

RfcAttributes
static

◆ SystemDateFormat

SystemDateFormat
static

◆ SystemInfo

SystemInfo
static