![]() |
T4S4
19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
convertTimeString2Secs TimeString | |
This function converts a given time string into the number of seconds of the day. More... | |
getLogLineMessageType4rc rc_func ?strDefaultMessageType? args | |
Calculates the corresponding message type (for tpwrite log lines) based on the input return code. More... | |
getSessionLogChannel args | |
Returns the Session log-file name of the current transfer session. If no session log-file name is available, the default LogChannel is used. More... | |
getTransactionLogChannel args | |
Returns the Log-channel information defined for the active transaction. More... | |
initStatusInfo args | |
Initializes the global StatusInfo buffer array. More... | |
matchStringWithRegExp compareExpr matchString args | |
resetLastErrorMessage args | |
Initializes the global ErrorMessage buffer array. More... | |
sendMail2BGS2 addr from smtp port message org subject xmailer ttype prio args | |
This function will send a mail via the BGSs and a smtp. More... | |
sendMailWithErrorList FromMailAddr MailAddr Subject ErrorMessage ?Prio? | |
Send an email via the BGS server to a specified receiver including all stored error messages. More... | |
setTransactionLogChannel TransactionLogChannel | |
Stores the name of the Transaction log-file into the internal buffer. More... | |
storeMessage2 MessageSource Message ?Kind? ?Format? | |
writes an entry to the internal error message buffer so so that the information can be displayed to the Teamcenter user More... | |
storeMessage2DatasetLogfile MessageSource Message ?Kind? ?Format? | |
writes an entry to the internal message buffer so that the information can written to the log-file dataset More... | |
storeUserMessage Severity MessageId ?S1? ?S2? ?S3? ?S4? ?S5? | |
writes an user error entry to the internal error message buffer so that the information can be displayed to the Teamcenter user More... | |
tp_split strInput strSplit ?blnTrim? | |
Just like the TCL split, but with the possibility to use more than one character as split parameter. More... | |
writeLogLineWithAttachment2BGS strLogChannel strLogLine strLinkName strAttachmentData ?strAttachmentMType? ?strMessageType? ?strAttachmentName? ?strHost? ?strPort? args | |
Creates an attachment on the log server (BGS) and adds the link to it to the specified log line. More... | |
writeVersionInfo2LogChannel LogChannel args | |
Writes the version info to a given log channel. More... | |
T4X::CORE::convertTimeString2Secs | TimeString | ||
This function converts a given time string into the number of seconds of the day.
TimeString | in one of the following formats
|
T4X::CORE::getLogLineMessageType4rc | rc_func ?strDefaultMessageType? args | ||
Calculates the corresponding message type (for tpwrite log lines) based on the input return code.
rc_func | - return code for which the message type should be calculated |
strDefaultMessageType | - OPTIONAL - default: INTERN; Can be used to set DEBUG or any other message type as default |
T4X::CORE::getSessionLogChannel | args | ||
Returns the Session log-file name of the current transfer session. If no session log-file name is available, the default LogChannel is used.
none |
T4X::CORE::getTransactionLogChannel | args | ||
Returns the Log-channel information defined for the active transaction.
none |
T4X::CORE::initStatusInfo | args | ||
Initializes the global StatusInfo buffer array.
none |
T4X::CORE::matchStringWithRegExp | compareExpr matchString args | ||
T4X::CORE::resetLastErrorMessage | args | ||
Initializes the global ErrorMessage buffer array.
none |
T4X::CORE::sendMail2BGS2 | addr from smtp port message org subject xmailer ttype prio args | ||
This function will send a mail via the BGSs and a smtp.
addr | receiver mail address |
from | sender mail address |
smtp | <DNS|IP|HOST> address of the SMTP server |
port | smpt server port (not yet supported, for future usage) |
message | email message text |
org | mail header organisation |
subject | subject of the email |
xmailer | mail header xheader |
ttype | HTML | PLAIN |
prio | Mail priority indicaor "" (default) | high | low |
args | list of file attachments (please make sure that the files are copied to the BGS before the mail is send) |
Sample code sequence
T4X::CORE::sendMailWithErrorList | FromMailAddr MailAddr Subject ErrorMessage ?Prio? | ||
Send an email via the BGS server to a specified receiver including all stored error messages.
FromMailAddr | sender mail address(e.g. i.am@) sour ce.co m |
MailAddr | receiver mail address(e.g. i.am@) xyz. com |
Subject | subject string of the email |
ErrorMessage | prefix string for the message body |
Prio | mail priority indicator "" (default) | high | low |
Sample code sequence
T4X::CORE::setTransactionLogChannel | TransactionLogChannel | ||
Stores the name of the Transaction log-file into the internal buffer.
TransactionLogChannel | transaction log channel name |
T4X::CORE::storeMessage2 | MessageSource Message ?Kind? ?Format? | ||
writes an entry to the internal error message buffer so so that the information can be displayed to the Teamcenter user
MessageSource | defines the origin system or module of the message |
Message | messages string default format is hex encoded |
Kind | ERROR | INFO | WARNING |
Format | HEX|NOHEX defines if the message string is hex encoded or not default is NOHEX |
T4X::CORE::storeMessage2DatasetLogfile | MessageSource Message ?Kind? ?Format? | ||
writes an entry to the internal message buffer so that the information can written to the log-file dataset
MessageSource | defines the origin system or module of the message |
Message | messages string default format is hex encoded |
Kind | ERROR | INFO | WARNING |
Format | HEX|NOHEX defines if the message string is hex encoded or not default is NOHEX |
T4X::CORE::storeUserMessage | Severity MessageId ?S1? ?S2? ?S3? ?S4? ?S5? | ||
writes an user error entry to the internal error message buffer so that the information can be displayed to the Teamcenter user
Severity | - ERROR | INFO | WARNING - by unknown will be set to ERROR |
MessageId | - for UserError use the range 919000-919999 |
S1 | Character string being substituted into the internationalized message associated with this ifail code |
S2 | Character string being substituted into the internationalized message associated with this ifail code |
S3 | Character string being substituted into the internationalized message associated with this ifail code |
S4 | Character string being substituted into the internationalized message associated with this ifail code |
S5 | Character string being substituted into the internationalized message associated with this ifail code |
T4X::CORE::tp_split | strInput strSplit ?blnTrim? | ||
Just like the TCL split, but with the possibility to use more than one character as split parameter.
strInput | - input string which should be split |
strSplit | - split string (more than one character possible) |
blnTrim | - OPTIONAL (FALSE) - If TRUE, the returned values will be trimmed |
T4X::CORE::writeLogLineWithAttachment2BGS | strLogChannel strLogLine strLinkName strAttachmentData ?strAttachmentMType? ?strMessageType? ?strAttachmentName? ?strHost? ?strPort? args | ||
Creates an attachment on the log server (BGS) and adds the link to it to the specified log line.
strLogChannel | Defines the log channel in the log server |
strLogLine | Message in the log channel where the attachment will be added as a link |
strLinkName | The name of the link |
strAttachmentData | The content/payload of the attachment |
strAttachmentMType | Mime type of the attachment (Optional - Default text/xml) |
strMessageType | Message type (like INTERN, DEBUG, WARNING, ERROR) (Optional - Default INTERN) |
strAttachmentName | The name of the attachment (Optional - Default Attachment_timestamp + valid file extension for text/plain (.txt) and text/xml (.xml)) |
strHost | this argument is ignored |
strPort | this argument is ignored |
T4X::CORE::writeVersionInfo2LogChannel | LogChannel args | ||
Writes the version info to a given log channel.
LogChannel | logchannel used for the version string output |
args | none |