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

Functions

 getLogLineMessageType4rc rc_func ?strDefaultMessageType? args
 Calculates the correspondig message type (for tpwrite log lines) based on the input return code. More...
 
 getSessionLogChannel args
 Returns the session logchannel of the current transfer session. If no session logchannel is available, the default logchannel is used. More...
 
 hex2String strString2DeHex ?blnUseBinaryFormat? args
 Converts a given hexed string into a normal string. More...
 
 setSecurityContext4SessionLogChannel SecurityContext
 This function defines the security context for the active session log channel. More...
 
 setSessionLogChannel args
 Defines the session logchannel based on the Teamcenter session information. More...
 
 sortIndexedInterfaceTable tab
 This function sort the result of an array names for an index array (e.g: BOM lines). More...
 
 string2Hex strString2Hex ?blnUseBinaryScan? args
 Converts a given string into HEX format. More...
 

Detailed Description

Function Documentation

◆ getLogLineMessageType4rc()

PL4X::CORE::getLogLineMessageType4rc   rc_func ?strDefaultMessageType? args  

Calculates the correspondig message type (for tpwrite log lines) based on the input return code.

Parameters
rc_funcreturn code for which the message type should be calculated
strDefaultMessageType(optional, default is INTERN) can be used to set DEBUG or any other message type as default
Returns
INTERN or ERROR based on the given rc_func

◆ getSessionLogChannel()

PL4X::CORE::getSessionLogChannel   args  

Returns the session logchannel of the current transfer session. If no session logchannel is available, the default logchannel is used.

Parameters
none
Returns
logchannel of the session

◆ hex2String()

PL4X::CORE::hex2String   strString2DeHex ?blnUseBinaryFormat? args  

Converts a given hexed string into a normal string.

Parameters
strString2DeHexhexed string to be converted
blnUseBinaryFormat(optional, default is FALSE) if TRUE, TCL binary format will be used instead of tpco_scanHEX16
Returns
Normal string

◆ setSecurityContext4SessionLogChannel()

PL4X::CORE::setSecurityContext4SessionLogChannel   SecurityContext  

This function defines the security context for the active session log channel.

Parameters
SecurityContextnew security context of the session log channel
  • UNRESTRICTED
  • RESTRICTED
  • CONFIDENTIAL
  • STRICTLYCONFIDENTIAL
It is only possible to increase the security context, that means setting the SecurityContext to UNRESTRICTED has no effect, if the session log channel is already assigned to the security context STRICTLYCONFIDENTIAL.
Returns
nothing

◆ setSessionLogChannel()

PL4X::CORE::setSessionLogChannel   args  

Defines the session logchannel based on the Teamcenter session information.

Parameters
none
Returns
nothing

◆ sortIndexedInterfaceTable()

PL4X::CORE::sortIndexedInterfaceTable   tab  

This function sort the result of an array names for an index array (e.g: BOM lines).

Parameters
tablist of array name strings to sort with the following syntax: Name:XXX:YYY:1 Name:XXX:YYY:2 ...
Returns
sorted list

◆ string2Hex()

PL4X::CORE::string2Hex   strString2Hex ?blnUseBinaryScan? args  

Converts a given string into HEX format.

Parameters
strString2HexString to be converted
blnUseBinaryScan(optional, default is FALSE) if TRUE, TCL binary scan will be used instead of tpco_scanHEX16
Returns
HEX string