T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
T4S::DIR::MAPPING Namespace Reference

Functions

 checkSAPDocumentKey DatasetTypeName
 This convenient function checks if the document key is completely specified and fills out the missing key attribute with the predefined defaults.
The document key default configuration can be defined by the corresponding Teamcenter preference set starting with the prefix T4S_DocumentInfoRecordDefaultDocumentKey4<DataType> or by using the T4S::DIR::CONFIG::setDocumentInfoRecordKeyDefaults API. More...
 
 getDocumentInfoRecordOriginals ObjectTypeName
 This convenient function fills the needed API input fields that are needed to transfer original file to SAP Which means the ::SAPDat(Document:Files:*) and ::SAPDat(Document:FileNames:*) attributes are filled based on the configuration information for a given object type name. The configuration can be defined by the corresponding Teamcenter preference set starting with the prefix T4S_DocumentInfoRecordMappingNamedFileList4<DataType> and the related set of. More...
 

Function Documentation

◆ checkSAPDocumentKey()

T4S::DIR::MAPPING::checkSAPDocumentKey   DatasetTypeName  

This convenient function checks if the document key is completely specified and fills out the missing key attribute with the predefined defaults.
The document key default configuration can be defined by the corresponding Teamcenter preference set starting with the prefix T4S_DocumentInfoRecordDefaultDocumentKey4<DataType> or by using the T4S::DIR::CONFIG::setDocumentInfoRecordKeyDefaults API.

Parameters
ObjectTypeNameInternal Teamcenter object type name (e.g. ItemRevision, Text)
Returns
none

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

Referenced by T4S::PROP::CUSTOM::MAPPING::GetDIRData(), and T4S::DIR::CUSTOM::MAPPING::TC_Object2SAP_DocumentInfoRecord().

◆ getDocumentInfoRecordOriginals()

T4S::DIR::MAPPING::getDocumentInfoRecordOriginals   ObjectTypeName  

This convenient function fills the needed API input fields that are needed to transfer original file to SAP Which means the ::SAPDat(Document:Files:*) and ::SAPDat(Document:FileNames:*) attributes are filled based on the configuration information for a given object type name. The configuration can be defined by the corresponding Teamcenter preference set starting with the prefix T4S_DocumentInfoRecordMappingNamedFileList4<DataType> and the related set of.

  • T4S_DIR_WorkstationApplication4<NamedFileRealtionInfo>
  • T4S_DIR_FileExtension4<NamedFileRealtionInfo>
  • T4S_DIR_DataCarrierName4<NamedFileRealtionInfo>
  • T4S_DIR_DataCarrierPath4<NamedFileRealtionInfo>
  • T4S_DIR_KproName4<NamedFileRealtionInfo>
    or by using the ::T4S::DIR::setDocumentInfoRecordOriginalsConfig API
Parameters
ObjectTypeNameInternal Teamcenter object type name (e.g. ItemRevision, Text)
Returns
Number of found files that are transformed to the corresponding SAPDat structures.

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