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

Mapping namespace for SAP data view to show attributes from SAP in the Teamcenter GUI. More...

Functions

 asBoolean string
 Interpret the letter X as true. More...
 
 defineStyle
 Customer specific auxiliary function to define the GUI style. More...
 
 GetBOMData ObjectKey
 Customer specific auxiliary function to read the bill of material information from SAP. More...
 
 GetBOMDataView ObjectKey Parameters
 Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Bill of Material. More...
 
 GetBUSINESSPARTNERData ObjectKey
 Customer specific auxiliary function to read the Business Partner information from SAP. More...
 
 GetBUSINESSPARTNERDataView ObjectKey Parameters
 Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Business Partner. More...
 
 GetDIRData ObjectTypeName ObjectKey DocumentType DocumentPart DocumentVersion
 Customer specific auxiliary function to read the document info record information from SAP. More...
 
 GetDIRDataView ObjectTypeName ObjectKey DocumentType DocumentPart DocumentVersion Parameters
 Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Document Info Record. More...
 
 GetECMData ObjectKey
 Customer specific auxiliary function to read the engineering change master information from SAP. More...
 
 GetECMDataView ObjectKey Parameters
 Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Engineering Change Master. More...
 
 GetEQUIData ObjectKey
 Customer specific auxiliary function to read the equipment master information from SAP. More...
 
 GetEQUIDataView ObjectKey Parameters
 Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Equipment Master. More...
 
 GetFUNCLOCData ObjectKey
 Customer specific auxiliary function to read the functional location information from SAP. More...
 
 GetFUNCLOCDataView ObjectKey Parameters
 Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Functional Location. More...
 
 GetMMData ObjectKey
 Customer specific auxiliary function to read the material master information from SAP. More...
 
 GetMMDataView ObjectKey Parameters
 Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Material Master. More...
 
 GetSAPData_BillOfMaterial SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters
 Customer specific mapping function to create the XML payload for the SAP data view for SAP Bill of Material. More...
 
 GetSAPData_BusinessPartner SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters
 Customer specific mapping function to create the XML payload for the SAP data view for SAP BusinessPartner. More...
 
 GetSAPData_ChangeMaster SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters
 Customer specific mapping function to create the XML payload for the SAP data view for SAP Engineering Change Master. More...
 
 GetSAPData_DocumentInfoRecord SessionId ObjectTypeName ObjectClassName ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters
 Customer specific mapping function to create the XML payload for the SAP data view for SAP Material Master. More...
 
 GetSAPData_EquipmentMaster SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters
 Customer specific mapping function to create the XML payload for the SAP data view for SAP Equipment Master. More...
 
 GetSAPData_FunctionalLocation SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters
 Customer specific mapping function to create the XML payload for the SAP data view for SAP Functional Location. More...
 
 GetSAPData_MaterialMaster SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters
 Customer specific mapping function to create the XML payload for the SAP data view for SAP Material Master. More...
 
 GetSAPData_QueryResultObject SessionId QueryName ObjectKey TCUser TCLanguage ContainerId Parameters
 Customer specific mapping function to create the XML payload for the SAP data view for an external query object. More...
 
 GetSAPData_Vendor SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters
 Customer specific mapping function to create the XML payload for the SAP data view for SAP Vendor. More...
 
 GetVENDORData ObjectKey
 Customer specific auxiliary function to read the vendor information from SAP. More...
 
 GetVENDORDataView ObjectKey Parameters
 Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Vendor. More...
 

Detailed Description

Mapping namespace for SAP data view to show attributes from SAP in the Teamcenter GUI.

The namespace contains the custom specific part of the SAP data view.
Procedures with fixed name GetSAPData_<TargetType> are defined for the following target types:

  • MaterialMaster
  • BillOfMaterial
  • DocumentInfoRecord
  • ChangeMaster
  • EquipmentMaster
  • FunctionalLocation
  • Vendor
  • BusinessPartner

Function Documentation

◆ asBoolean()

T4S::PROP::CUSTOM::MAPPING::asBoolean   string  

Interpret the letter X as true.

Parameters
string- string that may or may not contain the letter X
Returns
true if the string contains the letter X; false otherwise

Referenced by GetMMDataView().

◆ defineStyle()

T4S::PROP::CUSTOM::MAPPING::defineStyle

Customer specific auxiliary function to define the GUI style.

The procedure is called by GetSAPData_<TargetType>. It defines some global variables used for GUI style.

Returns
No return code required

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

Referenced by GetBOMDataView(), GetBUSINESSPARTNERDataView(), GetDIRDataView(), GetECMDataView(), GetEQUIDataView(), GetFUNCLOCDataView(), GetMMDataView(), and GetVENDORDataView().

◆ GetBOMData()

T4S::PROP::CUSTOM::MAPPING::GetBOMData   ObjectKey  

Customer specific auxiliary function to read the bill of material information from SAP.

The procedure is called by GetSAPData_BillOfMaterial.

Parameters
ObjectKey- SAP Id
Returns
OK or NOT_FOUND

References T4X::CORE::getSessionLogChannel(), TPSAP::BOM::BAPI::initSAPBomHeaderStructure(), TPSAP::BOM::BAPI::readBillOfMaterial2(), and tpwrite().

Referenced by GetSAPData_BillOfMaterial().

◆ GetBOMDataView()

T4S::PROP::CUSTOM::MAPPING::GetBOMDataView   ObjectKey Parameters  

Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Bill of Material.

The procedure is called by GetSAPData_BillOfMaterial.

Parameters
ObjectKey- SAP Id
Parameters- Parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

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

Referenced by GetSAPData_BillOfMaterial().

◆ GetBUSINESSPARTNERData()

T4S::PROP::CUSTOM::MAPPING::GetBUSINESSPARTNERData   ObjectKey  

Customer specific auxiliary function to read the Business Partner information from SAP.

The procedure is called by GetSAPData_BusinessPartner.

Parameters
ObjectKey- SAP Id
Returns
OK or NOT_FOUND

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

Referenced by GetSAPData_BusinessPartner().

◆ GetBUSINESSPARTNERDataView()

T4S::PROP::CUSTOM::MAPPING::GetBUSINESSPARTNERDataView   ObjectKey Parameters  

Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Business Partner.

The procedure is called by GetSAPData_BusinessPartner.

Parameters
ObjectKey- SAP Id
Parameters- Parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

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

Referenced by GetSAPData_BusinessPartner().

◆ GetDIRData()

T4S::PROP::CUSTOM::MAPPING::GetDIRData   ObjectTypeName ObjectKey DocumentType DocumentPart DocumentVersion  

Customer specific auxiliary function to read the document info record information from SAP.

The procedure is called by GetSAPData_DocumentInfoRecord.

Parameters
ObjectTypeName- Teamcenter object type
ObjectKey- SAP Id
DocumentType- SAP Document type
DocumentPart- SAP Document part
DocumentVersion- SAP Document version
Returns
OK or NOT_FOUND

References T4S::DIR::MAPPING::checkSAPDocumentKey(), TPSAP::DIR::getDocumentInfoRecordInfo(), T4X::CORE::getSessionLogChannel(), TPSAP::DIR::initSAPDocumentStructure(), and tpwrite().

Referenced by GetSAPData_DocumentInfoRecord().

◆ GetDIRDataView()

T4S::PROP::CUSTOM::MAPPING::GetDIRDataView   ObjectTypeName ObjectKey DocumentType DocumentPart DocumentVersion Parameters  

Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Document Info Record.

The procedure is called by GetSAPData_DocumentInfoRecord.

Parameters
ObjectTypeName- Teamcenter object type
ObjectKey- SAP Id
DocumentType- SAP Document type
DocumentPart- SAP Document part
DocumentVersion- SAP Document version
Parameters- Parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References defineStyle(), T4X::CORE::getSessionLogChannel(), T4S::TC::MAPPING::SAPFieldMapping(), and tpwrite().

Referenced by GetSAPData_DocumentInfoRecord().

◆ GetECMData()

T4S::PROP::CUSTOM::MAPPING::GetECMData   ObjectKey  

Customer specific auxiliary function to read the engineering change master information from SAP.

The procedure is called by GetSAPData_ChangeMaster.

Parameters
ObjectKey- SAP Id
Returns
OK or NOT_FOUND

References TPSAP::ECM::getChangeMasterInfo(), T4X::CORE::getSessionLogChannel(), and tpwrite().

Referenced by GetSAPData_ChangeMaster().

◆ GetECMDataView()

T4S::PROP::CUSTOM::MAPPING::GetECMDataView   ObjectKey Parameters  

Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Engineering Change Master.

The procedure is called by GetSAPData_ChangeMaster.

Parameters
ObjectKey- SAP Id
Parameters- Parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References defineStyle(), T4X::CORE::getSessionLogChannel(), T4S::TC::MAPPING::SAPFieldMapping(), and tpwrite().

Referenced by GetSAPData_ChangeMaster().

◆ GetEQUIData()

T4S::PROP::CUSTOM::MAPPING::GetEQUIData   ObjectKey  

Customer specific auxiliary function to read the equipment master information from SAP.

The procedure is called by GetSAPData_EquipmentMaster.

Parameters
ObjectKey- SAP Id
Returns
OK or NOT_FOUND

References TPSAP::EQUI::Equi_getDetail(), T4X::CORE::getSessionLogChannel(), and tpwrite().

Referenced by GetSAPData_EquipmentMaster().

◆ GetEQUIDataView()

T4S::PROP::CUSTOM::MAPPING::GetEQUIDataView   ObjectKey Parameters  

Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Equipment Master.

The procedure is called by GetSAPData_EquipmentMaster.

Parameters
ObjectKey- SAP Id
Parameters- Parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

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

Referenced by GetSAPData_EquipmentMaster().

◆ GetFUNCLOCData()

T4S::PROP::CUSTOM::MAPPING::GetFUNCLOCData   ObjectKey  

Customer specific auxiliary function to read the functional location information from SAP.

The procedure is called by GetSAPData_FunctionalLocation.

Parameters
ObjectKey- SAP Id
Returns
OK or NOT_FOUND

References TPSAP::FUNCLOC::FuncLoc_getDetail(), T4X::CORE::getSessionLogChannel(), and tpwrite().

Referenced by GetSAPData_FunctionalLocation().

◆ GetFUNCLOCDataView()

T4S::PROP::CUSTOM::MAPPING::GetFUNCLOCDataView   ObjectKey Parameters  

Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Functional Location.

The procedure is called by GetSAPData_FunctionalLocation.

Parameters
ObjectKey- SAP Id
Parameters- Parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

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

Referenced by GetSAPData_FunctionalLocation().

◆ GetMMData()

T4S::PROP::CUSTOM::MAPPING::GetMMData   ObjectKey  

Customer specific auxiliary function to read the material master information from SAP.

The procedure is called by GetSAPData_MaterialMaster.

Parameters
ObjectKey- SAP Id
Returns
OK or NOT_FOUND

References TPSAP::MM::getAllMaterialMasterInfos(), T4X::CORE::getSessionLogChannel(), and tpwrite().

Referenced by GetSAPData_MaterialMaster(), and GetSAPData_QueryResultObject().

◆ GetMMDataView()

T4S::PROP::CUSTOM::MAPPING::GetMMDataView   ObjectKey Parameters  

Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Material Master.

The procedure is called by GetSAPData_MaterialMaster.

Parameters
ObjectKey- SAP Id
Parameters- Parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References asBoolean(), defineStyle(), T4X::CORE::getSessionLogChannel(), T4S::TC::MAPPING::SAPFieldMapping(), and tpwrite().

Referenced by GetSAPData_MaterialMaster(), and GetSAPData_QueryResultObject().

◆ GetSAPData_BillOfMaterial()

T4S::PROP::CUSTOM::MAPPING::GetSAPData_BillOfMaterial   SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters  

Customer specific mapping function to create the XML payload for the SAP data view for SAP Bill of Material.

Parameters
SessionId- Teamcenter session id
ItemType- Teamcenter item type
ItemRevisionType- Teamcenter item revision type
ObjectType- Teamcenter object type
TCUser- Teamcenter user who initiated the data view call
TCLanguage- Language which will be used for the data view call
ContainerId- Optional parameter which defines the current display container
Parameters- Optional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References GetBOMData(), GetBOMDataView(), T4X::CORE::getSessionLogChannel(), T4X::TC::MAPPING::IndexedFieldMapping(), and tpwrite().

◆ GetSAPData_BusinessPartner()

T4S::PROP::CUSTOM::MAPPING::GetSAPData_BusinessPartner   SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters  

Customer specific mapping function to create the XML payload for the SAP data view for SAP BusinessPartner.

Parameters
SessionId- Teamcenter session id
ItemType- Teamcenter item type
ItemRevisionType- Teamcenter item revision type
ObjectType- Teamcenter object type (target type
TCUser- Teamcenter user who initiated the data view call
TCLanguage- Language which will be used for the data view call
ContainerId- Optional parameter which defines the current display container
Parameters- Optional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References T4X::TC::MAPPING::FieldMapping(), GetBUSINESSPARTNERData(), GetBUSINESSPARTNERDataView(), T4X::CORE::getSessionLogChannel(), tpco_formatHEX16(), and tpwrite().

◆ GetSAPData_ChangeMaster()

T4S::PROP::CUSTOM::MAPPING::GetSAPData_ChangeMaster   SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters  

Customer specific mapping function to create the XML payload for the SAP data view for SAP Engineering Change Master.

Parameters
SessionId- Teamcenter session id
ItemType- Teamcenter item type
ItemRevisionType- Teamcenter item revision type
ObjectType- Teamcenter object type
TCUser- Teamcenter user who initiated the data view call
TCLanguage- Language which will be used for the data view call
ContainerId- Optional parameter which defines the current display container
Parameters- Optional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References T4X::TC::MAPPING::FieldMapping(), GetECMData(), GetECMDataView(), T4X::CORE::getSessionLogChannel(), and tpwrite().

◆ GetSAPData_DocumentInfoRecord()

T4S::PROP::CUSTOM::MAPPING::GetSAPData_DocumentInfoRecord   SessionId ObjectTypeName ObjectClassName ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters  

Customer specific mapping function to create the XML payload for the SAP data view for SAP Material Master.

Parameters
SessionId- Teamcenter session id
ObjectTypeName- Teamcenter object type
ObjectClassName- Teamcenter object class
ItemType- Teamcenter item type
ItemRevisionType- Teamcenter item revision type
ObjectType- Teamcenter object type
TCUser- Teamcenter user who initiated the data view call
TCLanguage- Language which will be used for the data view call
ContainerId- Optional parameter which defines the current display container
Parameters- Optional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References T4X::TC::MAPPING::FieldMapping(), GetDIRData(), GetDIRDataView(), T4X::CORE::getSessionLogChannel(), and tpwrite().

◆ GetSAPData_EquipmentMaster()

T4S::PROP::CUSTOM::MAPPING::GetSAPData_EquipmentMaster   SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters  

Customer specific mapping function to create the XML payload for the SAP data view for SAP Equipment Master.

Parameters
SessionId- Teamcenter session id
ItemType- Teamcenter item type
ItemRevisionType- Teamcenter item revision type
ObjectType- Teamcenter object type
TCUser- Teamcenter user who initiated the data view call
TCLanguage- Language which will be used for the data view call
ContainerId- Optional parameter which defines the current display container
Parameters- Optional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References T4X::TC::MAPPING::FieldMapping(), GetEQUIData(), GetEQUIDataView(), T4X::CORE::getSessionLogChannel(), tpco_formatHEX16(), and tpwrite().

◆ GetSAPData_FunctionalLocation()

T4S::PROP::CUSTOM::MAPPING::GetSAPData_FunctionalLocation   SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters  

Customer specific mapping function to create the XML payload for the SAP data view for SAP Functional Location.

Parameters
SessionId- Teamcenter session id
ItemType- Teamcenter item type
ItemRevisionType- Teamcenter item revision type
ObjectType- Teamcenter object type
TCUser- Teamcenter user who initiated the data view call
TCLanguage- Language which will be used for the data view call
ContainerId- Optional parameter which defines the current display container
Parameters- Optional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References T4X::TC::MAPPING::FieldMapping(), GetFUNCLOCData(), GetFUNCLOCDataView(), T4X::CORE::getSessionLogChannel(), tpco_formatHEX16(), and tpwrite().

◆ GetSAPData_MaterialMaster()

T4S::PROP::CUSTOM::MAPPING::GetSAPData_MaterialMaster   SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters  

Customer specific mapping function to create the XML payload for the SAP data view for SAP Material Master.

Parameters
SessionId- Teamcenter session id
ItemType- Teamcenter item type
ItemRevisionType- Teamcenter item revision type
ObjectType- Teamcenter object type
TCUser- Teamcenter user who initiated the data view call
TCLanguage- Language which will be used for the data view call
ContainerId- Optional parameter which defines the current display container
Parameters- Optional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References T4X::TC::MAPPING::FieldMapping(), GetMMData(), GetMMDataView(), T4X::CORE::getSessionLogChannel(), T4S::TC::MAPPING::SAPFieldMapping(), and tpwrite().

◆ GetSAPData_QueryResultObject()

T4S::PROP::CUSTOM::MAPPING::GetSAPData_QueryResultObject   SessionId QueryName ObjectKey TCUser TCLanguage ContainerId Parameters  

Customer specific mapping function to create the XML payload for the SAP data view for an external query object.

Parameters
SessionId- Teamcenter session id
QueryName- Query name to be executed
ObjectKey- SAP object key used for query
TCUser- Teamcenter user who initiated the data view call
TCLanguage- Language which will be used for the data view call
ContainerId- Optional parameter which defines the current display container
Parameters- Optional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

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

◆ GetSAPData_Vendor()

T4S::PROP::CUSTOM::MAPPING::GetSAPData_Vendor   SessionId ItemType ItemRevisionType ObjectType TCUser TCLanguage ContainerId Parameters  

Customer specific mapping function to create the XML payload for the SAP data view for SAP Vendor.

Parameters
SessionId- Teamcenter session id
ItemType- Teamcenter item type
ItemRevisionType- Teamcenter item revision type
ObjectType- Teamcenter object type (target type
TCUser- Teamcenter user who initiated the data view call
TCLanguage- Language which will be used for the data view call
ContainerId- Optional parameter which defines the current display container
Parameters- Optional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

References T4X::TC::MAPPING::FieldMapping(), T4X::CORE::getSessionLogChannel(), GetVENDORData(), GetVENDORDataView(), tpco_formatHEX16(), and tpwrite().

◆ GetVENDORData()

T4S::PROP::CUSTOM::MAPPING::GetVENDORData   ObjectKey  

Customer specific auxiliary function to read the vendor information from SAP.

The procedure is called by GetSAPData_Vendor.

Parameters
ObjectKey- SAP Id
Returns
OK or NOT_FOUND

References TPSAP::VENDOR::getDetail(), T4X::CORE::getSessionLogChannel(), and tpwrite().

Referenced by GetSAPData_Vendor().

◆ GetVENDORDataView()

T4S::PROP::CUSTOM::MAPPING::GetVENDORDataView   ObjectKey Parameters  

Customer specific auxiliary function to build the XML payload for the SAP data view for SAP Vendor.

The procedure is called by GetSAPData_Vendor.

Parameters
ObjectKey- SAP Id
Parameters- Parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

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

Referenced by GetSAPData_Vendor().