T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
T4X::TRANSLOG Namespace Reference

Functions

 getMessage TransferObject
 This function returns a predefined message for the TransferObject. More...
 
 getNextStructId args
 
 getStructId TransferObject
 This function returns a predefined structure for the TransferObject. More...
 
 getTransLogFile SessionLogChannel TransactionLogId args
 Downloads a given transaction log file. 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...
 
 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 args
 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 args
 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...
 
 writeMultiClassTransferMappingLog AppLogTransactionId StructureId ClassInfo PlantInfo args
 
 writeMultiInspectionControlTransferMappingLog AppLogTransactionId StructureId InspectionControlInfo PlantInfo args
 
 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...
 
 writeMultiTransferMappingLog AppLogTransactionId StructureId MultiInfo args
 
 writeMultiTransferStartLog AppLogTransactionId TransferObject MultiInfo args
 
 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

 LastCustomMappingLine
 
 LastCustomReverseMappingLine
 
 LastStructId
 
 Msg
 
 Msg
 
 StructId
 
 StructId
 
 WaitTime4TransLogFile
 

Function Documentation

◆ getMessage()

T4X::TRANSLOG::getMessage   TransferObject  

This function returns a predefined message for the TransferObject.

Parameters
TransferObjectDefines 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_ITEM_MPN, T4O_ITEM_APC, 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
Returns
always OK

Referenced by writeArrayLog(), writeImportStatusInfoLog(), writePlainInfoLog(), writeStatusDictLog(), and writeStatusLog().

◆ getNextStructId()

◆ getStructId()

T4X::TRANSLOG::getStructId   TransferObject  

This function returns a predefined structure for the TransferObject.

Parameters
TransferObjectDefines 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_ITEM_MPN, T4O_ITEM_APC, 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
Returns
always OK

Referenced by writeMultiStatusDictLog(), writeMultiStatusLog(), writeMultiTransferStartLog(), writeStatusDictLog(), and writeStatusLog().

◆ getTransLogFile()

T4X::TRANSLOG::getTransLogFile   SessionLogChannel TransactionLogId args  

Downloads a given transaction log file.

Returns
List of FileName and ShortFileName of the log file for the import to Tc

References SYSBase::getTmpDir(), and tpwrite().

◆ setNextStructId()

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.

Parameters
StructId
Returns
always OK

Referenced by stopTransactionLog().

◆ startTransactionLog()

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.

Parameters
TransferTypedefines the transfer type of the transaction, the information is used as part of the transaction log file name
HexObjectTagString representation of the Teamcenter object tag
ObjectIdStringTeamcenter object id string
ObjectNameobject_name of the Teamcenter object
ObjectTypeNameobject_type name of the selected Teamcenter object
SearchStringused for the indexing of the transaction log files (deprecated parameter, will be ingnored)
IndexDictused for the indexing of the transaction log files input has to be provided as a Tcl dict
Returns
Transactionlog fileId defines the relative filename of the transaction log file

References tpco_formatHEX16(), tpco_getdefaultlogchannel(), tpco_getHostName(), tpco_setLogIndex(), tpco_usectime(), tpco_usectime2int(), tpwrite(), and writeVersionInfo2TransactionLog().

Referenced by T4X::BATCHJOB::EXPORT::executeExportJob(), and T4X::BATCHJOB::IMPORT::executeImportJob().

◆ stopTransactionLog()

T4X::TRANSLOG::stopTransactionLog   AppLogTransactionId TransferStatus args  

This function write the final messages to the transaction log file.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
TransferStatus
argsnot used
Returns
none

References getNextStructId(), setNextStructId(), tpco_setLogIndex(), and tpwrite().

Referenced by T4X::BATCHJOB::EXPORT::executeExportJob(), and T4X::BATCHJOB::IMPORT::executeImportJob().

◆ writeArrayLog()

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.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
TransferObjectDefines 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
argsreserved for future use
Returns
always OK

References getMessage(), getNextStructId(), and tpwrite().

◆ writeBomLineMappingStatusLog()

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.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
PositionInfodefines the position information like item_id for the current processed BOM line.
Statusreturn status of the custom position mapping function
argsreserved for future use
Returns
NONE

References T4X::CORE::storeMessage2(), and tpwrite().

◆ writeCustomMappingLog()

T4X::TRANSLOG::writeCustomMappingLog   AppLogTransactionId Status Messages args  

Writes a messages to the transaction log file, in the section of the mapping result.

Parameters
AppLogTransactionIdtransaction log channel name
StatusERROR|WARNING|INFO|OK defines the colour of the log line
Messages
Returns
none

References tpwrite().

◆ writeCustomMappingStatusLog()

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.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
Status
argsreserved for future use
Returns
always OK

References T4X::CORE::storeMessage2(), and tpwrite().

◆ writeCustomReverseMappingLog()

T4X::TRANSLOG::writeCustomReverseMappingLog   AppLogTransactionId Status Messages args  

Writes a messages to the transaction log file, in the section of the reverse mapping result.

Parameters
AppLogTransactionIdtransaction log channel name
StatusERROR|WARNING|INFO|OK defines the colour of the log line
Messages
Returns
none

References tpwrite().

◆ writeCustomReverseMappingStatusLog()

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.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
Status
argsreserved for future use
Returns
always OK

References getNextStructId(), T4X::CORE::storeMessage2(), and tpwrite().

◆ writeImportStatusInfoLog()

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.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
TransferObjectDefines 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
FunctionNameFunction name that should be used within the log message.
StatusWill 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.
InfoTextList of messages
argsreserved for future use
Returns
always OK

References getMessage(), getNextStructId(), and tpwrite().

Referenced by T4X::BATCHJOB::IMPORT::writeTransactionLog().

◆ writeMultiClassTransferMappingLog()

T4X::TRANSLOG::writeMultiClassTransferMappingLog   AppLogTransactionId StructureId ClassInfo PlantInfo args  
Returns

References tpwrite().

◆ writeMultiInspectionControlTransferMappingLog()

T4X::TRANSLOG::writeMultiInspectionControlTransferMappingLog   AppLogTransactionId StructureId InspectionControlInfo PlantInfo args  
Returns

References tpwrite().

◆ writeMultiStatusDictLog()

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.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
TransferObjectDefines 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
MultiInfoIndex of the multi transfer loop
StatusDicthas the following dict entries:
  • Status
  • NoOfMessages
  • LogMessageMessage(n)
  • LogMessageSeverity(n)
Returns
always OK

References getStructId(), and tpwrite().

◆ writeMultiStatusLog()

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.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
TransferObjectDefines 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
MultiInfoIndex of the multi transfer loop
Status
ErrorMessagesoptional list of error messages
argsreserved for future use
Returns
always OK

References getStructId(), tpco_formatHEX16(), and tpwrite().

◆ writeMultiTransferMappingLog()

T4X::TRANSLOG::writeMultiTransferMappingLog   AppLogTransactionId StructureId MultiInfo args  
Returns

References tpwrite().

◆ writeMultiTransferStartLog()

T4X::TRANSLOG::writeMultiTransferStartLog   AppLogTransactionId TransferObject MultiInfo args  
Returns

References getStructId(), and tpwrite().

◆ writePlainInfoLog()

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.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
TransferObjectDefines 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
argsreserved for future use
Returns
always OK

References getMessage(), getNextStructId(), tpco_formatHEX16(), and tpwrite().

◆ writeStatusDictLog()

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.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
TransferObjectDefines 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
StatusDicthas the following dict entries:
  • Status
  • NoOfMessages
  • LogMessageMessage(n)
  • LogMessageSeverity(n)
argsreserved for future use
Returns
always OK

References getMessage(), getStructId(), tpwrite(), and writeStatusIntoMessageDetails().

◆ writeStatusIntoMessageDetails()

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.

Parameters
TransactionLogChannelRelative file name of the transaction log file
StructId
HeaderMessagemessage string that is used as chapter header message before the details are written to the log channel
LineIndexDefines the starting line index ins the transaction log section (default 1)
Returns
none

References tpwrite().

Referenced by writeStatusDictLog(), and writeStatusLog().

◆ writeStatusLog()

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.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
TransferObjectDefines 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
ErrorMessagesoptional list of error messages
argsreserved for future use
Returns
always OK

References getMessage(), getStructId(), tpco_formatHEX16(), tpwrite(), and writeStatusIntoMessageDetails().

◆ writeTcSysLogFileEntry()

T4X::TRANSLOG::writeTcSysLogFileEntry   AppLogTransactionId TcSysLogFileName  

This function writes the used TcSysLogFileName to the transaction log file.

Parameters
AppLogTransactionIdRelative file name of the transaction log file If the value is TEST_MAPPING, the output is written to the console
TcSysLogFileName
Returns
none

References tpwrite().

Referenced by T4X::BATCHJOB::EXPORT::executeExportJob(), and T4X::BATCHJOB::IMPORT::executeImportJob().

◆ writeVersionInfo2TransactionLog()

T4X::TRANSLOG::writeVersionInfo2TransactionLog   AppLogTransactionId args  

This function will writes the T4X version info to the transaction log file.

Parameters
AppLogTransactionIdRelative filename of the transaction log file
Returns
always OK

References tpco_shmget(), and tpwrite().

Referenced by startTransactionLog().

Variable Documentation

◆ LastCustomMappingLine

LastCustomMappingLine
static

◆ LastCustomReverseMappingLine

LastCustomReverseMappingLine
static

◆ LastStructId

LastStructId
static

◆ Msg [1/2]

Msg
static

◆ Msg [2/2]

Msg
static

◆ StructId [1/2]

StructId
static

◆ StructId [2/2]

StructId
static

◆ WaitTime4TransLogFile

WaitTime4TransLogFile
static