![]() |
T4S4
19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
getTransLogFile SessionLogChannel TransactionLogId args | |
Downloads a given transaction log file. More... | |
printInterfaceTableInfo4ObjectType TransactionId StructureId TranslogIndex blnIncreaseTranslogIndex LogIndex blnIncreaselogIndex arrayNameRef ObjectType | |
works like printInterfaceTableInfo, but here the first table element must be given. The function searches and sorts elements and prints them More... | |
setNextStructId StructId | |
This function overwrites the NextStructId as workaround for the import batch job, so that the indexes can be aligned if needed. More... | |
setSecurityContext4TransactionLog TransactionLogChannel SecurityContext | |
This function defines the security context for the specified transaction log channel. More... | |
startTransactionLog TransferType HexObjectTag ObjectIdString ObjectName ObjectTypeName SearchString ?IndexDict? args | |
This function creates based on the given parameters a new transaction log file that is valid for the current batch job transfer and returns the relative transaction log filename. More... | |
stopTransactionLog AppLogTransactionId TransferStatus args | |
This function write the final messages to the transaction log file. More... | |
writeArrayLog AppLogTransactionId TransferObject ArrayName Status args | |
This function writes based on the given arguments Status and TransferObject a corresponding message and all the data of the given array in the transaction log file. More... | |
writeBomLineMappingStatusLog AppLogTransactionId PositionInfo Status args | |
This function is called after the custom position mapping function with the status of the position mapping and some details about the position itself to write a corresponding message in the transaction log file. If the status is ERROR or UNKNOWN the content of ::errorInfo (in the case of a Tcl error) is written to the transaction log file as well. More... | |
writeCustomMappingLog AppLogTransactionId Status Messages ?SecurityContext? | |
Writes a messages to the transaction log file, in the section of the mapping result. More... | |
writeCustomMappingStatusLog AppLogTransactionId Status args | |
This function writes based on the given argument Status of the mapping function a corresponding message in the transaction log file. If the status is ERROR or UNKNOWN the content of ::errorInfo (in the case of a Tcl error) or stored messages in the StatusInfo array is written to the transaction log file as well. More... | |
writeCustomReverseMappingLog AppLogTransactionId Status Messages ?SecurityContext? | |
Writes a messages to the transaction log file, in the section of the reverse mapping result. More... | |
writeCustomReverseMappingStatusLog AppLogTransactionId Status args | |
This function writes based on the given argument Status of the reverse mapping function a corresponding message in the transaction log file. If the status is ERROR or UNKNOWN the content of ::errorInfo (in the case of a Tcl error) or stored messages in the StatusInfo array is written to the transaction log file as well. More... | |
writeImportStatusInfoLog AppLogTransactionId TransferObject FunctionName Status InfoText args | |
This function writes based on the given arguments Status and TransferObject a corresponding message and the info text of the InfoText (which can be a list of messages) in the transaction log file. More... | |
writeMultiStatusDictLog AppLogTransactionId TransferObject MultiInfo StatusDict | |
This function writes based on the given arguments Status and TransferObject a corresponding message in the transaction log file. If the status is ERROR, UPDATED_WITH_ERROR or UNKNOWN the content of the ErrorMessage or the StatusInfo array will be used to write more detailed informations about the error into the transaction log file. More... | |
writeMultiStatusLog AppLogTransactionId TransferObject MultiInfo Status ?ErrorMessages? args | |
This function writes based on the given arguments Status and TransferObject a corresponding message in the transaction log file. If the status is ERROR, UPDATED_WITH_ERROR or UNKNOWN the content of the ErrorMessage or the StatusInfo array will be used to write more detailed informations about the error into the transaction log file. More... | |
writePlainInfoLog AppLogTransactionId TransferObject Status InfoText args | |
This function writes based on the given arguments Status and TransferObject a corresponding message and the info text of the InfoText (which can be a list of messages) in the transaction log file. More... | |
writeStatusDictLog AppLogTransactionId TransferObject StatusDict | |
This function writes based on the given StatusDict entries and the TransferObject a corresponding set of message in the transaction log file. More... | |
writeStatusIntoMessageDetails TransactionLogChannel StructId HeaderMessage ?LineIndex? | |
The StatusInfo array message content will be used to write more detailed information about the transfer status into the transaction log file. More... | |
writeStatusLog AppLogTransactionId TransferObject Status ?ErrorMessages? args | |
This function writes based on the given arguments Status and TransferObject a corresponding message in the transaction log file. If the status is ERROR, UPDATED_WITH_ERROR or UNKNOWN the content of the ErrorMessage or the StatusInfo array will be used to write more detailed informations about the error into the transaction log file. More... | |
writeTcSysLogFileEntry AppLogTransactionId TcSysLogFileName | |
This function writes the used TcSysLogFileName to the transaction log file. More... | |
writeVersionInfo2TransactionLog AppLogTransactionId args | |
This function will writes the T4X version info to the transaction log file. More... | |
Variables | |
LogMode | |
The namespace variable can be used to configure the system in a way that the transaction log files contains a different type of details. Currently suppored are the following mode values: More... | |
T4X::TRANSLOG::getTransLogFile | SessionLogChannel TransactionLogId args | ||
Downloads a given transaction log file.
T4X::TRANSLOG::printInterfaceTableInfo4ObjectType | TransactionId StructureId TranslogIndex blnIncreaseTranslogIndex LogIndex blnIncreaselogIndex arrayNameRef ObjectType | ||
works like printInterfaceTableInfo, but here the first table element must be given. The function searches and sorts elements and prints them
TransactionId | the transaction ID |
StructureId | list name / object name (e.g. Article, Document) |
TranslogIndex | index |
blnIncreaseTranslogIndex | increase trx log index? |
LogIndex | initial index |
blnIncreaselogIndex | increase log index? |
ArrayName | Name of the mapping result array |
ObjectType | type of object, used as search pattering within the mapping result array |
T4X::TRANSLOG::setNextStructId | StructId | ||
This function overwrites the NextStructId as workaround for the import batch job, so that the indexes can be aligned if needed.
StructId |
T4X::TRANSLOG::setSecurityContext4TransactionLog | TransactionLogChannel SecurityContext | ||
This function defines the security context for the specified transaction log channel.
TransactionLogChannel | Relative log channel name of the transaction log If the value is TEST_MAPPING, the security context is not set for the console. |
SecurityContext | Optional parameter that defines the security context of the transaction log message (default is no security context)
|
log channel is already assigned to the security context STRICTLYCONFIDENTIAL.
T4X::TRANSLOG::startTransactionLog | TransferType HexObjectTag ObjectIdString ObjectName ObjectTypeName SearchString ?IndexDict? args | ||
This function creates based on the given parameters a new transaction log file that is valid for the current batch job transfer and returns the relative transaction log filename.
TransferType | defines the transfer type of the transaction, the information is used as part of the transaction log file name |
HexObjectTag | String representation of the Teamcenter object tag |
ObjectIdString | Teamcenter object id string |
ObjectName | object_name of the Teamcenter object |
ObjectTypeName | object_type name of the selected Teamcenter object |
SearchString | used for the indexing of the transaction log files (deprecated parameter, will be ignored) |
IndexDict | used for the indexing of the transaction log files input has to be provided as a Tcl dict |
T4X::TRANSLOG::stopTransactionLog | AppLogTransactionId TransferStatus args | ||
This function write the final messages to the transaction log file.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
TransferStatus | |
args | not used |
T4X::TRANSLOG::writeArrayLog | AppLogTransactionId TransferObject ArrayName Status args | ||
This function writes based on the given arguments Status and TransferObject a corresponding message and all the data of the given array in the transaction log file.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
TransferObject | Defines the target object token, valid tokens are: DIR, MM, BOM, ECM, FUNCLOC, EQUI, EQUIBOM, ORDERBOM, REVLEVEL, CLASS, INSP, OBJMGR, CONPROF, KZKFG, ROUTING, INSPPLAN, AMPL, VENDOR, BUSINESS_PARTNER, BUSINESS_PARTNER_ADDRESS, BUSINESS_PARTNER_ROLE, CUSTOM, OBJECT, T4O_ITEM, T4O_ECO, T4O_ECO_IMPLEMENT, T4O_BOM_VARIANT_RULES, T4O_BOM_IMPORT_MODEL, T4O_BOM, T4O_ROUTING, T4O_ITEM_REV, T4O_ITEM_ASSIGN, T4O_ITEM_CATEGORY_ASSIGN, T4O_ITEM_DESCR_ELEM_ASSIGN, T4O_ITEM_DOC_ATTACHMENT, T4O_ECO_DOC_ATTACHMENT, T4O_BOM_DOC_ATTACHMENT, T4O_RTG_DOC_ATTACHMENT, IMPORT, ARRAYPRINT, VARIANT_CLASS, CONSTRAINT_NET, CONSTRAINT, CONSTRAINT_TABLE, CONSTRAINT_TABLE_ENTRY, CLASS_ASSIGN |
ArrayName | array with the infos to be wrote into the log file |
Status | |
args | reserved for future use |
T4X::TRANSLOG::writeBomLineMappingStatusLog | AppLogTransactionId PositionInfo Status args | ||
This function is called after the custom position mapping function with the status of the position mapping and some details about the position itself to write a corresponding message in the transaction log file. If the status is ERROR or UNKNOWN the content of ::errorInfo (in the case of a Tcl error) is written to the transaction log file as well.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
PositionInfo | defines the position information like item_id for the current processed BOM line. |
Status | return status of the custom position mapping function |
args | reserved for future use |
T4X::TRANSLOG::writeCustomMappingLog | AppLogTransactionId Status Messages ?SecurityContext? | ||
Writes a messages to the transaction log file, in the section of the mapping result.
AppLogTransactionId | transaction log channel name |
Status | ERROR|WARNING|INFO|OK defines the colour of the log line |
Messages | |
SecurityContext | Optional paramenter that defines the security context of the transaction log message (default is no security context)
|
T4X::TRANSLOG::writeCustomMappingStatusLog | AppLogTransactionId Status args | ||
This function writes based on the given argument Status of the mapping function a corresponding message in the transaction log file. If the status is ERROR or UNKNOWN the content of ::errorInfo (in the case of a Tcl error) or stored messages in the StatusInfo array is written to the transaction log file as well.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
Status | |
args | reserved for future use |
T4X::TRANSLOG::writeCustomReverseMappingLog | AppLogTransactionId Status Messages ?SecurityContext? | ||
Writes a messages to the transaction log file, in the section of the reverse mapping result.
AppLogTransactionId | transaction log channel name |
Status | ERROR|WARNING|INFO|OK defines the colour of the log line |
Messages | |
SecurityContext | Optional paramenter that defines the security context of the transaction log message (default is no security context)
|
T4X::TRANSLOG::writeCustomReverseMappingStatusLog | AppLogTransactionId Status args | ||
This function writes based on the given argument Status of the reverse mapping function a corresponding message in the transaction log file. If the status is ERROR or UNKNOWN the content of ::errorInfo (in the case of a Tcl error) or stored messages in the StatusInfo array is written to the transaction log file as well.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
Status | |
args | reserved for future use |
T4X::TRANSLOG::writeImportStatusInfoLog | AppLogTransactionId TransferObject FunctionName Status InfoText args | ||
This function writes based on the given arguments Status and TransferObject a corresponding message and the info text of the InfoText (which can be a list of messages) in the transaction log file.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
TransferObject | Defines the target object token, valid tokens are: DIR, MM, BOM, ECM, FUNCLOC, EQUI, EQUIBOM, ORDERBOM, REVLEVEL, CLASS, INSP, OBJMGR, CONPROF, KZKFG, ROUTING, INSPPLAN, AMPL, VENDOR, BUSINESS_PARTNER, BUSINESS_PARTNER_ADDRESS, BUSINESS_PARTNER_ROLE, CUSTOM, OBJECT, T4O_ITEM, T4O_ECO, T4O_ECO_IMPLEMENT, T4O_BOM_VARIANT_RULES, T4O_BOM_IMPORT_MODEL, T4O_BOM, T4O_ROUTING, T4O_ITEM_REV, T4O_ITEM_ASSIGN, T4O_ITEM_CATEGORY_ASSIGN, T4O_ITEM_DESCR_ELEM_ASSIGN, T4O_ITEM_DOC_ATTACHMENT, T4O_ECO_DOC_ATTACHMENT, T4O_BOM_DOC_ATTACHMENT, T4O_RTG_DOC_ATTACHMENT, IMPORT, ARRAYPRINT, VARIANT_CLASS, CONSTRAINT_NET, CONSTRAINT, CONSTRAINT_TABLE, CONSTRAINT_TABLE_ENTRY, CLASS_ASSIGN |
FunctionName | Function name that should be used within the log message. |
Status | Will be used to define the message type, currently OK and SKIPPED will be marked as okay all other status values will be marked shown as error. |
InfoText | List of messages |
args | reserved for future use |
T4X::TRANSLOG::writeMultiStatusDictLog | AppLogTransactionId TransferObject MultiInfo StatusDict | ||
This function writes based on the given arguments Status and TransferObject a corresponding message in the transaction log file. If the status is ERROR, UPDATED_WITH_ERROR or UNKNOWN the content of the ErrorMessage or the StatusInfo array will be used to write more detailed informations about the error into the transaction log file.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
TransferObject | Defines the target object token, valid tokens are: DIR, MM, BOM, ECM, FUNCLOC, EQUI, EQUIBOM, ORDERBOM, REVLEVEL, CLASS, INSP, OBJMGR, CONPROF, KZKFG, ROUTING, INSPPLAN, AMPL, VENDOR, BUSINESS_PARTNER, BUSINESS_PARTNER_ADDRESS, BUSINESS_PARTNER_ROLE, CUSTOM, OBJECT, T4O_ITEM, T4O_ECO, T4O_ECO_IMPLEMENT, T4O_BOM_VARIANT_RULES, T4O_BOM_IMPORT_MODEL, T4O_BOM, T4O_ROUTING, T4O_ITEM_REV, T4O_ITEM_ASSIGN, T4O_ITEM_CATEGORY_ASSIGN, T4O_ITEM_DESCR_ELEM_ASSIGN, T4O_ITEM_DOC_ATTACHMENT, T4O_ECO_DOC_ATTACHMENT, T4O_BOM_DOC_ATTACHMENT, T4O_RTG_DOC_ATTACHMENT, IMPORT, ARRAYPRINT, VARIANT_CLASS, CONSTRAINT_NET, CONSTRAINT, CONSTRAINT_TABLE, CONSTRAINT_TABLE_ENTRY, CLASS_ASSIGN |
MultiInfo | Index of the multi transfer loop |
StatusDict | has the following dict entries:
|
T4X::TRANSLOG::writeMultiStatusLog | AppLogTransactionId TransferObject MultiInfo Status ?ErrorMessages? args | ||
This function writes based on the given arguments Status and TransferObject a corresponding message in the transaction log file. If the status is ERROR, UPDATED_WITH_ERROR or UNKNOWN the content of the ErrorMessage or the StatusInfo array will be used to write more detailed informations about the error into the transaction log file.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
TransferObject | Defines the target object token, valid tokens are: DIR, MM, BOM, ECM, FUNCLOC, EQUI, EQUIBOM, ORDERBOM, REVLEVEL, CLASS, INSP, OBJMGR, CONPROF, KZKFG, ROUTING, INSPPLAN, AMPL, VENDOR, BUSINESS_PARTNER, BUSINESS_PARTNER_ADDRESS, BUSINESS_PARTNER_ROLE, CUSTOM, OBJECT, T4O_ITEM, T4O_ECO, T4O_ECO_IMPLEMENT, T4O_BOM_VARIANT_RULES, T4O_BOM_IMPORT_MODEL, T4O_BOM, T4O_ROUTING, T4O_ITEM_REV, T4O_ITEM_ASSIGN, T4O_ITEM_CATEGORY_ASSIGN, T4O_ITEM_DESCR_ELEM_ASSIGN, T4O_ITEM_DOC_ATTACHMENT, T4O_ECO_DOC_ATTACHMENT, T4O_BOM_DOC_ATTACHMENT, T4O_RTG_DOC_ATTACHMENT, IMPORT, ARRAYPRINT, VARIANT_CLASS, CONSTRAINT_NET, CONSTRAINT, CONSTRAINT_TABLE, CONSTRAINT_TABLE_ENTRY, CLASS_ASSIGN |
MultiInfo | Index of the multi transfer loop |
Status | |
ErrorMessages | optional list of error messages |
args | reserved for future use |
T4X::TRANSLOG::writePlainInfoLog | AppLogTransactionId TransferObject Status InfoText args | ||
This function writes based on the given arguments Status and TransferObject a corresponding message and the info text of the InfoText (which can be a list of messages) in the transaction log file.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
TransferObject | Defines the target object token, valid tokens are: DIR, MM, BOM, ECM, FUNCLOC, EQUI, EQUIBOM, ORDERBOM, REVLEVEL, CLASS, INSP, OBJMGR, CONPROF, KZKFG, ROUTING, INSPPLAN, AMPL, VENDOR, BUSINESS_PARTNER, BUSINESS_PARTNER_ADDRESS, BUSINESS_PARTNER_ROLE, CUSTOM, OBJECT, T4O_ITEM, T4O_ECO, T4O_ECO_IMPLEMENT, T4O_BOM_VARIANT_RULES, T4O_BOM_IMPORT_MODEL, T4O_BOM, T4O_ROUTING, T4O_ITEM_REV, T4O_ITEM_ASSIGN, T4O_ITEM_CATEGORY_ASSIGN, T4O_ITEM_DESCR_ELEM_ASSIGN, T4O_ITEM_DOC_ATTACHMENT, T4O_ECO_DOC_ATTACHMENT, T4O_BOM_DOC_ATTACHMENT, T4O_RTG_DOC_ATTACHMENT, IMPORT, ARRAYPRINT, VARIANT_CLASS, CONSTRAINT_NET, CONSTRAINT, CONSTRAINT_TABLE, CONSTRAINT_TABLE_ENTRY, CLASS_ASSIGN |
InfoText | hexed single message or a list of messages |
Status | |
args | reserved for future use |
T4X::TRANSLOG::writeStatusDictLog | AppLogTransactionId TransferObject StatusDict | ||
This function writes based on the given StatusDict entries and the TransferObject a corresponding set of message in the transaction log file.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
TransferObject | Defines the target object token, valid tokens are: DIR, MM, BOM, ECM, FUNCLOC, EQUI, EQUIBOM, ORDERBOM, REVLEVEL, CLASS, INSP, OBJMGR, CONPROF, KZKFG, ROUTING, INSPPLAN, AMPL, VENDOR, BUSINESS_PARTNER, BUSINESS_PARTNER_ADDRESS, BUSINESS_PARTNER_ROLE, CUSTOM, OBJECT, T4O_ITEM, T4O_ECO, T4O_ECO_IMPLEMENT, T4O_BOM_VARIANT_RULES, T4O_BOM_IMPORT_MODEL, T4O_BOM, T4O_ROUTING, T4O_ITEM_REV, T4O_ITEM_ASSIGN, T4O_ITEM_CATEGORY_ASSIGN, T4O_ITEM_DESCR_ELEM_ASSIGN, T4O_ITEM_DOC_ATTACHMENT, T4O_ECO_DOC_ATTACHMENT, T4O_BOM_DOC_ATTACHMENT, T4O_RTG_DOC_ATTACHMENT, IMPORT, ARRAYPRINT, VARIANT_CLASS, CONSTRAINT_NET, CONSTRAINT, CONSTRAINT_TABLE, CONSTRAINT_TABLE_ENTRY, CLASS_ASSIGN |
StatusDict | has the following dict entries:
|
args | reserved for future use |
T4X::TRANSLOG::writeStatusIntoMessageDetails | TransactionLogChannel StructId HeaderMessage ?LineIndex? | ||
The StatusInfo array message content will be used to write more detailed information about the transfer status into the transaction log file.
TransactionLogChannel | Relative file name of the transaction log file |
StructId | |
HeaderMessage | message string that is used as chapter header message before the details are written to the log channel |
LineIndex | Defines the starting line index ins the transaction log section (default 1) |
T4X::TRANSLOG::writeStatusLog | AppLogTransactionId TransferObject Status ?ErrorMessages? args | ||
This function writes based on the given arguments Status and TransferObject a corresponding message in the transaction log file. If the status is ERROR, UPDATED_WITH_ERROR or UNKNOWN the content of the ErrorMessage or the StatusInfo array will be used to write more detailed informations about the error into the transaction log file.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
TransferObject | Defines the target object token, valid tokens are: DIR, MM, BOM, ECM, FUNCLOC, EQUI, EQUIBOM, ORDERBOM, REVLEVEL, CLASS, INSP, OBJMGR, CONPROF, KZKFG, ROUTING, INSPPLAN, AMPL, VENDOR, BUSINESS_PARTNER, BUSINESS_PARTNER_ADDRESS, BUSINESS_PARTNER_ROLE, CUSTOM, OBJECT, T4O_ITEM, T4O_ECO, T4O_ECO_IMPLEMENT, T4O_BOM_VARIANT_RULES, T4O_BOM_IMPORT_MODEL, T4O_BOM, T4O_ROUTING, T4O_ITEM_REV, T4O_ITEM_ASSIGN, T4O_ITEM_CATEGORY_ASSIGN, T4O_ITEM_DESCR_ELEM_ASSIGN, T4O_ITEM_DOC_ATTACHMENT, T4O_ECO_DOC_ATTACHMENT, T4O_BOM_DOC_ATTACHMENT, T4O_RTG_DOC_ATTACHMENT, IMPORT, ARRAYPRINT, VARIANT_CLASS, CONSTRAINT_NET, CONSTRAINT, CONSTRAINT_TABLE, CONSTRAINT_TABLE_ENTRY, CLASS_ASSIGN |
Status | |
ErrorMessages | optional list of error messages |
args | reserved for future use |
T4X::TRANSLOG::writeTcSysLogFileEntry | AppLogTransactionId TcSysLogFileName | ||
This function writes the used TcSysLogFileName to the transaction log file.
AppLogTransactionId | Relative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console |
TcSysLogFileName |
T4X::TRANSLOG::writeVersionInfo2TransactionLog | AppLogTransactionId args | ||
This function will writes the T4X version info to the transaction log file.
AppLogTransactionId | Relative filename of the transaction log file |
|
static |
The namespace variable can be used to configure the system in a way that the transaction log files contains a different type of details. Currently suppored are the following mode values: