T4S4  19.1 C8540 A23673
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
stringstring that may or may not contain the letter X
Returns
true if the string contains the letter X; false otherwise

◆ 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

◆ 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
ObjectKeySAP Id
Returns
OK or NOT_FOUND

◆ 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
ObjectKeySAP Id
ParametersParameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
ObjectKeySAP Id
Returns
OK or NOT_FOUND

◆ 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
ObjectKeySAP Id
ParametersParameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
ObjectTypeNameTeamcenter object type
ObjectKeySAP Id
DocumentTypeSAP Document type
DocumentPartSAP Document part
DocumentVersionSAP Document version
Returns
OK or NOT_FOUND

◆ 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
ObjectTypeNameTeamcenter object type
ObjectKeySAP Id
DocumentTypeSAP Document type
DocumentPartSAP Document part
DocumentVersionSAP Document version
ParametersParameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
ObjectKeySAP Id
Returns
OK or NOT_FOUND

◆ 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
ObjectKeySAP Id
ParametersParameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
ObjectKeySAP Id
Returns
OK or NOT_FOUND

◆ 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
ObjectKeySAP Id
ParametersParameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
ObjectKeySAP Id
Returns
OK or NOT_FOUND

◆ 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
ObjectKeySAP Id
ParametersParameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
ObjectKeySAP Id
Returns
OK or NOT_FOUND

◆ 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
ObjectKeySAP Id
ParametersParameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
SessionIdTeamcenter session id
ItemTypeTeamcenter item type
ItemRevisionTypeTeamcenter item revision type
ObjectTypeTeamcenter object type
TCUserTeamcenter user who initiated the data view call
TCLanguageLanguage which will be used for the data view call
ContainerIdOptional parameter which defines the current display container
ParametersOptional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
SessionIdTeamcenter session id
ItemTypeTeamcenter item type
ItemRevisionTypeTeamcenter item revision type
ObjectTypeTeamcenter object type (target type
TCUserTeamcenter user who initiated the data view call
TCLanguageLanguage which will be used for the data view call
ContainerIdOptional parameter which defines the current display container
ParametersOptional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
SessionIdTeamcenter session id
ItemTypeTeamcenter item type
ItemRevisionTypeTeamcenter item revision type
ObjectTypeTeamcenter object type
TCUserTeamcenter user who initiated the data view call
TCLanguageLanguage which will be used for the data view call
ContainerIdOptional parameter which defines the current display container
ParametersOptional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
SessionIdTeamcenter session id
ObjectTypeNameTeamcenter object type
ObjectClassNameTeamcenter object class
ItemTypeTeamcenter item type
ItemRevisionTypeTeamcenter item revision type
ObjectTypeTeamcenter object type
TCUserTeamcenter user who initiated the data view call
TCLanguageLanguage which will be used for the data view call
ContainerIdOptional parameter which defines the current display container
ParametersOptional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
SessionIdTeamcenter session id
ItemTypeTeamcenter item type
ItemRevisionTypeTeamcenter item revision type
ObjectTypeTeamcenter object type
TCUserTeamcenter user who initiated the data view call
TCLanguageLanguage which will be used for the data view call
ContainerIdOptional parameter which defines the current display container
ParametersOptional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
SessionIdTeamcenter session id
ItemTypeTeamcenter item type
ItemRevisionTypeTeamcenter item revision type
ObjectTypeTeamcenter object type
TCUserTeamcenter user who initiated the data view call
TCLanguageLanguage which will be used for the data view call
ContainerIdOptional parameter which defines the current display container
ParametersOptional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
SessionIdTeamcenter session id
ItemTypeTeamcenter item type
ItemRevisionTypeTeamcenter item revision type
ObjectTypeTeamcenter object type
TCUserTeamcenter user who initiated the data view call
TCLanguageLanguage which will be used for the data view call
ContainerIdOptional parameter which defines the current display container
ParametersOptional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
SessionIdTeamcenter session id
QueryNameQuery name to be executed
ObjectKeySAP object key used for query
TCUserTeamcenter user who initiated the data view call
TCLanguageLanguage which will be used for the data view call
ContainerIdOptional parameter which defines the current display container
ParametersOptional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
SessionIdTeamcenter session id
ItemTypeTeamcenter item type
ItemRevisionTypeTeamcenter item revision type
ObjectTypeTeamcenter object type (target type
TCUserTeamcenter user who initiated the data view call
TCLanguageLanguage which will be used for the data view call
ContainerIdOptional parameter which defines the current display container
ParametersOptional parameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view

◆ 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
ObjectKeySAP Id
Returns
OK or NOT_FOUND

◆ 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
ObjectKeySAP Id
ParametersParameter which defines the used parameters for the data retrieval
Returns
XML-Payload used to render the data view