![]() |
T4S4
18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
tpco_getListOfValues | |
This function returns all occurring values for a certain key (without duplicates) as well as the number of absolute occurrences for each found value. More... | |
tpco_getLogIndex | |
This function returns the key attribute list of a specified log channel, matching the given patterns for key and value. More... | |
tpco_removeLogIndex | |
This function removes an attribute entry from the specified log channel. More... | |
tpco_searchGlobLogIndex | |
This function simply searches globally for all terms defined in searchlist within the whole log index. It returns a list of matching log index entries. More... | |
tpco_searchLogIndex | |
This function can search for several specific keys and values at once. It returns a list of matching log index entries, which can be used to get the corresponding log files. If the key is defined as “*” and the value is defined as “*”, all entries are returned. More... | |
tpco_setLogIndex | |
This function adds an attribute entry (key and value) to the index of the specified log channel. More... | |
tpco_udpAllocAttachmentTab | |
This function creates a X-Y storage table. More... | |
tpco_udpExportAttachmentTab | |
This function exports the X-Y storage table. More... | |
tpco_udpFreeAttachmentTab | |
This function frees (destroys) the X-Y storage table. More... | |
tpco_udpGetAttachmentTab | |
This function reads an entry from the X-Y storage table. More... | |
tpco_udpReadAttachment | |
This function reads a logfile attachment. More... | |
tpco_udpSetAttachmentTab | |
This function writes an entry in the X-Y storage table. More... | |
tpco_udpWriteAttachment | |
This function writes a logfile attachment. More... | |
tpco_udpWriteRemoteAttachment2 | |
This function writes a remote logfile attachment. More... | |
tpco_getListOfValues |
This function returns all occurring values for a certain key (without duplicates) as well as the number of absolute occurrences for each found value.
key | Attribute key for which all existing values and number of occurrences should be returned. |
rrange | The result range of the corresponding searchresult (default [list 0 9]) |
rsortd | sort direction of the result list. The sortkey is absolute number of occurrences. |
loglist | previous result of any search to be searched, if the loglist is not provided, all index entries will be searched. |
<occurrences>
<occurrences> ..}
tpco_getLogIndex |
This function returns the key attribute list of a specified log channel, matching the given patterns for key and value.
logchannel | string of the log channel |
keypattern | pattern to match the key of the attribute as string |
valuepattern | pattern to match the value of the attribute |
tpco_removeLogIndex |
This function removes an attribute entry from the specified log channel.
logchannel | string of the log channel |
key | the name for the key |
tpco_searchGlobLogIndex |
This function simply searches globally for all terms defined in searchlist within the whole log index. It returns a list of matching log index entries.
searchlist | List of search terms as strings |
rrange | The result range of the corresponding searchresult (default [list 0 9]) |
rsort | sort key and direction for the searchresult. (default CTIME decreasing) |
link | the logical link between the search patterns (default OR) |
case | defines whether this search should be case-sensitive or not true: to search case-sensitive false: to ignore any case (DEFAULT) |
keylov | Attribute key for which all existing values and number of occurrences should be returned. |
klovrange | The result range of the corresponding result for keylov (default [list 0 9]) |
tpco_searchLogIndex |
This function can search for several specific keys and values at once. It returns a list of matching log index entries, which can be used to get the corresponding log files. If the key is defined as “*” and the value is defined as “*”, all entries are returned.
pattern | tcl dictionary containing any number of key-value-pairs, where each value con-sists of a list, where the first entry represents the submitted data type and the second value contains the searched value pattern. e.g. [ <key1> {<type1> <valuepattern1>} <key2> {<type2> <valuepattern2>} …] key pattern to match the key of an attribute as string type data type of the valuepattern (STR - string, STRLIST – a list of strings, UINTRNAGE – a range of interger values e.g. [list 4711 9192]) valuepattern: pattern to be searched for in the according key, needs to match the re-quirements of the previously defined data type. |
rrange | The result range of the corresponding searchresult (default [list 0 9]) |
rsort | sort key and direction for the searchresult. (default CTIME decreasing) |
link | the logical link between the search patterns (default OR) |
case | defines whether this search should be case-sensitive or no true: to search case-sensitive false: to ignore any case (DEFAULT) |
keylov | Attribute key for which all existing values and number of occurrences should be returned. |
klovrange | The result range of the corresponding result for keylov (default [list 0 9]) |
tpco_setLogIndex |
This function adds an attribute entry (key and value) to the index of the specified log channel.
logchannel | string of the log channel |
key | the name for the key |
value | value for the previously defined key to be set |
mode | overwrite: The data will be overwritten (default setting) exclusive: if this entry has been defined before nothing will happen, else it will be exclusively set once to the index append: the data will be appended, regardless if the entry does already exist or not |
Referenced by T4X::TRANSLOG::startTransactionLog(), T4X::TRANSLOG::stopTransactionLog(), and T4X::BATCHJOB::TOOLBOX::writeTcUser2LogIndex().
tpco_udpAllocAttachmentTab |
This function creates a X-Y storage table.
tpco_udpExportAttachmentTab |
This function exports the X-Y storage table.
attahd | table ID |
tpco_udpFreeAttachmentTab |
This function frees (destroys) the X-Y storage table.
attahd | table ID |
tpco_udpGetAttachmentTab |
This function reads an entry from the X-Y storage table.
attahd | table ID |
line | line number |
row | row number |
tpco_udpReadAttachment |
This function reads a logfile attachment.
tpco_udpReadAttachment
works only in the BGS enviroment. For external usage, use the ::LOGSRV::readAttachment
function.
id | the attachment ID |
tpco_udpSetAttachmentTab |
This function writes an entry in the X-Y storage table.
attahd | table ID |
line | line number |
row | row number |
value | content of X-Y |
tpco_udpWriteAttachment |
This function writes a logfile attachment.
tpco_udpWriteAttachment
works only in the BGS enviroment. For external usage, use the tpco_udpWriteRemoteAttachment2
function. The download URL for the attachment is :: http(s)://<bgs-server>:<port>/dcx/attach?<attachment-id>.
name | name of the attachment |
mtype | MIME type of the attachment |
data | content of the attachment |
TPHAP::setAttaLink
. tpco_udpWriteRemoteAttachment2 |
This function writes a remote logfile attachment.
The download URL for the attachment is :: http(s)://<bgs-server>:<port>/dcx/attach?<attachment-id>.
host | BGS hostname |
port | BGS port |
mtype | MIME type of the attachment |
name | name of the attachment |
data | content of the attachment |
TPHAP::setAttaLink
.Referenced by T4X::CORE::writeLogLineWithAttachment2BGS().