T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
T4S::DIR::CUSTOM::MAPPING Namespace Reference

Mapping namespace for T4S document info record transfer. More...

Functions

 SAP_DocumentInfoRecord2TC_Object TransactionId Status DocumentNumber DocumentType DocumentPart DocumentVersion args
 Customer specific reverse mapping function for the T4S document info record transfer. More...
 
 TC_Object2SAP_DocumentInfoRecord TransactionId ObjectTypeName ObjectClassName ItemType ItemRevisionType args
 Customer specific mapping function to define the document info record to be transferred to SAP. More...
 

Detailed Description

Mapping namespace for T4S document info record transfer.

The namespace contains the custom specific part of a T4S document info record transfer:

  • Procedure TC_Object2SAP_DocumentInfoRecord maps Teamcenter attributes to SAP attributes (so called mapping).
  • Procedure SAP_DocumentInfoRecord2TC_Object maps SAP attributes back to Teamcenter attributes (so called reverse mapping).
Note
For the data exchange between Teamcenter and T4S the internal TCL dictionary ::TcData is used. It contains specific attributes of the Teamcenter object to be transferred and additional information about the current transaction. For the data exchange between T4S and SAP the internal TCL array ::SAPDat is used.
Teamcenter attributes can be read from ::TcData with function T4X::TC::MAPPING::FieldMapping.
Teamcenter attributes can be written to ::TcData with function T4X::TC::MAPPING::storeReverseMappingAttribute.
SAP attributes can be read from ::SAPDat using function T4S::TC::MAPPING::SAPFieldMapping.
SAP attributes can be written to ::SAPDat with set ::SAPDat(<key>) value.
Precondition
For the material master transfer the following preferences are used:
  • T4S_DocumentInfoRecordTypeList : list of allowed Teamcenter object types
  • T4S_DocumentInfoRecordMapping4<ObjectType> : list of Teamcenter data types to read attributes from
  • T4S_DocumentInfoRecordMapping2<ObjectType> : list of Teamcenter data types to write back during reverse mapping
  • T4S_DocumentInfoRecordFieldMapping2<DataType> : list of Teamcenter attributes to write back during reverse mapping (optional)
  • T4S_DocumentInfoRecordDefaultDocumentKey4<DataType> : defines document type, part and version for Teamcenter data type
  • T4S_DocumentInfoRecordMappingNamedFileList4<DataType> : list of Teamcenter data types to read files from

Function Documentation

◆ SAP_DocumentInfoRecord2TC_Object()

T4S::DIR::CUSTOM::MAPPING::SAP_DocumentInfoRecord2TC_Object   TransactionId Status DocumentNumber DocumentType DocumentPart DocumentVersion args  

Customer specific reverse mapping function for the T4S document info record transfer.

The procedure maps the following SAP attributes back to Teamcenter attributes:
SAP Document number -> SAP_DirNo
SAP Document type -> SAP_DirType
SAP Document part -> SAP_DirPart
SAP Document version -> SAP_DirVersion
T4S transfer status -> SentDIRToSAP

Parameters
TransactionIdUnique ID for the transfer transaction
StatusSAP transfer status. The following values are valid:
SKIPPED -> the transfer was skipped
ERROR -> the transfer was stopped by an error
UNKNOWN -> the transfer was stopped by an unknown error
UPDATED_WITH_ERROR -> the transfer was stopped by an minor error in one of the additional transfer steps
CREATED, CHANGED, UPDATED -> and some other values are used for a successful transfer
DocumentNumberSAP Id of document info record
DocumentTypeSAP Type of document info record
DocumentPartSAP Part of document info record
DocumentVersionSAP Version of document info record
argsNot used
Returns
Return code used by the following Tc object update function. The following values are valid:
OK -> T4S will update the Tc object based on the reverse mapping preferences and the reverse mapping buffer
SKIPPED -> T4S will skip the TcData object
ERROR -> T4S will stop transfer and raise an error

◆ TC_Object2SAP_DocumentInfoRecord()

T4S::DIR::CUSTOM::MAPPING::TC_Object2SAP_DocumentInfoRecord   TransactionId ObjectTypeName ObjectClassName ItemType ItemRevisionType args  

Customer specific mapping function to define the document info record to be transferred to SAP.

The procedure maps the following Teamcenter attributes to SAP attributes:
object_name -> SAP Description
SAP_DirNo -> SAP Id
SAP_DirType -> SAP Document type
SAP_DirPart -> SAP Document part
SAP_DirVersion -> SAP Document version
No original files are transferred but object links are created in SAP.

Parameters
TransactionIdUnique ID for the transfer transaction
ObjectTypeNameTeamcenter object type
ObjectClassNameTeamcenter object class
ItemTypeTeamcenter item type
ItemRevisionTypeTeamcenter item revision type
argsNot used
Returns
Return code used by the following transfer function. The following values are valid:
OK -> T4S will continue with the next transfer step
REVERSEMAPPINGONLY -> T4S will skip the transfer to SAP and will just do the reverse mapping
SKIPPED -> T4S will skip the transfer to SAP
ERROR -> T4S will stop transfer and raise an error