T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
TPSAP::FUNCLOC Namespace Reference

Functions

 changeFuncLoc_DeletionFlagActivate FuncLocNumber args
 Activates the deletion flag of a given functional location. Important: This procedure has a dependency to the SAP transport package "TESISPLM_T4S_CALL_TRANSACTION" and does not work without it. More...
 
 changeFuncLoc_DeletionFlagDeactivate FuncLocNumber args
 Deactivates the deletion flag of a given functional location. Important: This procedure has a dependency to the SAP transport package "TESISPLM_T4S_CALL_TRANSACTION" and does not work without it. More...
 
 changeFuncLoc_UserStatus FuncLocNumber UserStatus UserStatusLanguageISO ?UserStatusKey? args
 Changes the user status of a given functional location. The status can be provided as either a "status text" + "status language (ISO)" or by just specifying the internal status key.
Important: This procedure has a dependency to the SAP transport package "TESISPLM_T4S_FUNCLOC" and does not work without it. More...
 
 FuncLoc_getDetail args
 Retrieves detailed SAP functional location information. More...
 
 FuncLoc_getList args
 Matchcode search for functional locations in SAP. More...
 
 getExternalNumber InternalNumber
 Retrieves the SAP external functional location id for a given SAP internal functional location id. More...
 
 getInternalNumber ExternalNumber
 Retrieves the SAP internal functional location id for a given SAP external functional location id. More...
 
 initFuncLocStructure args
 Resets part the corresponding global TCL ::SAPDat array within the section FUNCLOC. More...
 

Detailed Description

            This functiion required CALL TRANSACTION to be installed
            properly on the SAP system.
            All parameters are passed into the function using the
            global TCL array ::SAPDat. The array pattern is
            ::SAPDat(FuncLocLink:<SAP FIELD STRUCTURE>:<SAP FIELD NAME>)
            Example for FuncLoc FROM:
            ::SAPDat(FuncLocLink:VINET:TPVON)
            Example for FuncLoc TO:
            ::SAPDat(FuncLocLink:VINET:TPNACH)

Function Documentation

◆ changeFuncLoc_DeletionFlagActivate()

TPSAP::FUNCLOC::changeFuncLoc_DeletionFlagActivate   FuncLocNumber args  

Activates the deletion flag of a given functional location. Important: This procedure has a dependency to the SAP transport package "TESISPLM_T4S_CALL_TRANSACTION" and does not work without it.

Parameters
FuncLocNumber
Returns
OK or ERROR with message in hex format as TCL list

◆ changeFuncLoc_DeletionFlagDeactivate()

TPSAP::FUNCLOC::changeFuncLoc_DeletionFlagDeactivate   FuncLocNumber args  

Deactivates the deletion flag of a given functional location. Important: This procedure has a dependency to the SAP transport package "TESISPLM_T4S_CALL_TRANSACTION" and does not work without it.

Parameters
FuncLocNumber
Returns
OK or ERROR with message in hex format as TCL list

◆ changeFuncLoc_UserStatus()

TPSAP::FUNCLOC::changeFuncLoc_UserStatus   FuncLocNumber UserStatus UserStatusLanguageISO ?UserStatusKey? args  

Changes the user status of a given functional location. The status can be provided as either a "status text" + "status language (ISO)" or by just specifying the internal status key.
Important: This procedure has a dependency to the SAP transport package "TESISPLM_T4S_FUNCLOC" and does not work without it.

Parameters
FuncLocNumber
UserStatus
UserStatusLanguageISO
UserStatusKeyOptional (default empty) - If provided, this key will be used instead of UserStatus + UserStatusLanguageISO
Returns
OK or ERROR with message as TCL list and global Array ::FuncLocResult

◆ FuncLoc_getDetail()

TPSAP::FUNCLOC::FuncLoc_getDetail   args  

Retrieves detailed SAP functional location information.

Parameters
argsnone
Returns
OK and global TCL array ::FuncLocResult or ERROR

◆ FuncLoc_getList()

TPSAP::FUNCLOC::FuncLoc_getList   args  

Matchcode search for functional locations in SAP.

Parameters
argsnone
Returns
OK and global TCL array ::FuncLocResult or ERROR

◆ getExternalNumber()

TPSAP::FUNCLOC::getExternalNumber   InternalNumber  

Retrieves the SAP external functional location id for a given SAP internal functional location id.

Parameters
InternalNumberSAP internal functional location id
Returns
External number

◆ getInternalNumber()

TPSAP::FUNCLOC::getInternalNumber   ExternalNumber  

Retrieves the SAP internal functional location id for a given SAP external functional location id.

Parameters
ExternalNumberSAP external functional location id
Returns
Internal number

◆ initFuncLocStructure()

TPSAP::FUNCLOC::initFuncLocStructure   args  

Resets part the corresponding global TCL ::SAPDat array within the section FUNCLOC.

Parameters
argsnone
Returns