T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
T4S::DIR::CONFIG Namespace Reference

Functions

 setDocumentInfoRecordKeyDefaults ObjectTypeName ?DOCUMENTTYPE? ?DOCUMENTPART? ?DOCUMENTVERSION?
 With this function it is possible to define the default document key for a given Teamcenter object type (like a Dataset or ItemRevision). More...
 
 setDocumentInfoRecordOriginalsConfig ObjectTypeName NamedFileReference FileType FileExtension DatacarrierName DatacarrierPath KProName
 This function is used to define the all needed information to specify an original files transfer to SAP based on a given Teamcenter object type and the relation or named reference to the file. More...
 
 writeDocumentInfoRecordKeyDefaults ?LogChannel?
 This function write the content of the default document keys configuration to a specified log channel or to the default log channel. This document keys configuration is used by the T4S::DIR::MAPPING::checkSAPDocumentKey function. More...
 
 writeDocumentInfoRecordOriginalsConfig ?LogChannel?
 This function write the content of the Original File configuration to a specified log channel or to the default log channel. More...
 

Function Documentation

◆ setDocumentInfoRecordKeyDefaults()

T4S::DIR::CONFIG::setDocumentInfoRecordKeyDefaults   ObjectTypeName ?DOCUMENTTYPE? ?DOCUMENTPART? ?DOCUMENTVERSION?  

With this function it is possible to define the default document key for a given Teamcenter object type (like a Dataset or ItemRevision).

Parameters
ObjectTypeNameTeamcenter object type name (like MSWord or ItemRevision)
DOCUMENTTYPESAP document info record type
DOCUMENTPARTSAP document info record part
DOCUMENTVERSIONSAP document info record version
Returns
None

References tpco_shmget(), and tpco_shmset().

◆ setDocumentInfoRecordOriginalsConfig()

T4S::DIR::CONFIG::setDocumentInfoRecordOriginalsConfig   ObjectTypeName NamedFileReference FileType FileExtension DatacarrierName DatacarrierPath KProName  

This function is used to define the all needed information to specify an original files transfer to SAP based on a given Teamcenter object type and the relation or named reference to the file.

Parameters
ObjectTypeNameTeamcenter object type name (like MSWord or ItemRevision)
NamedFileReferencedefines the relation to the named file reference of the ImanFile
FileTypedefines the SAP workspace application (like JT or WRD,…)
FileExtensiondefines the filename extension of the SAP original (like jt, doc or docx)
DatacarrierNamedefines SAP data carrier name for the SAP storage
DatacarrierPathdefines the path that is used to handover the original file to SAP
KProNameName of the SAP Knowledge Provider used to store the original file
Returns
None

References tpco_shmget(), and tpco_shmset().

◆ writeDocumentInfoRecordKeyDefaults()

T4S::DIR::CONFIG::writeDocumentInfoRecordKeyDefaults   ?LogChannel?  

This function write the content of the default document keys configuration to a specified log channel or to the default log channel. This document keys configuration is used by the T4S::DIR::MAPPING::checkSAPDocumentKey function.

Parameters
LogChannelOptional parameter that defines in which log-channel the debug output of the function should be stored. If not specified the information is stored into the session log file.
Returns
OK

References T4X::CORE::getSessionLogChannel().

◆ writeDocumentInfoRecordOriginalsConfig()

T4S::DIR::CONFIG::writeDocumentInfoRecordOriginalsConfig   ?LogChannel?  

This function write the content of the Original File configuration to a specified log channel or to the default log channel.

Parameters
LogChannelOptional parameter that defines in which log-channel the debug output of the function should be stored. If not specified the information is stored into the session log file.
Returns
OK

References T4X::CORE::getSessionLogChannel().