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

Functions

 callCustomerRuleHandler TransactionId Action RuleName ItemType ItemRevisionType args
 Customer specific object RuleHandler function template. More...
 
 getObjectInfo TransactionId TargetTypeName ObjectKey args
 Customer specific Mapping function to retrieve the object information from SAP. More...
 
 performSapTransfer TransactionId TargetTypeName args
 Customer specific function to call SAP. More...
 
 SAP_Object2TC_Object TransactionId TargetTypeName Status ObjectKey args
 Customer specific object reverse mapping function template for TargetTypeName. More...
 
 TC_Object2SAP_Object TransactionId TargetTypeName ItemType ItemRevisionType args
 Customer specific object mapping function template for TargetTypeName. More...
 
 TC_Object2SAP_ObjectPosition TransactionId TargetTypeName TcPositionIndex ItemType ItemRevisionType args
 Customer specific object mapping function template for TargetTypeName. More...
 
 TC_Object2SAP_ObjectPostAction TransactionId TargetTypeName ItemType ItemRevisionType MappingStatus args
 This function is called AFTER the general mapping and can be used to perform additional steps after the header and position mapping. More...
 

Variables

 BomHeaderInfo
 
 BomPositionInfo
 

Function Documentation

◆ callCustomerRuleHandler()

T4S::GENBOM::CUSTOM::MAPPING::callCustomerRuleHandler   TransactionId Action RuleName ItemType ItemRevisionType args  

Customer specific object RuleHandler function template.

Parameters
TransactionIdunique ID for the transfer transaction
ActionWork flow action
RuleNamespecified rule name in the work flow arguments named "-user_rule". If the argument is not specified the value is "Default"
ItemType
ItemRevisionType
Returns
EPM_nogo or EPM_go

◆ getObjectInfo()

T4S::GENBOM::CUSTOM::MAPPING::getObjectInfo   TransactionId TargetTypeName ObjectKey args  

Customer specific Mapping function to retrieve the object information from SAP.

Parameters
TransactionIdunique ID for the transfer transaction
TargetTypeNamespecified transaction target type name
ObjectKey
Returns
list of status and object key

◆ performSapTransfer()

T4S::GENBOM::CUSTOM::MAPPING::performSapTransfer   TransactionId TargetTypeName args  

Customer specific function to call SAP.

Parameters
TransactionIdunique ID for the transfer transaction
TargetTypeNamespecified transaction target type name
Returns
StatusDict dict structure with the following element:
  • Status OK|ERROR
  • OBJECT_KEY object key of the resulting object in the external system
  • ErrorMessage last error message
  • NoOfMessages 0 or n (optional if more that one error messages needs to be returned)
  • LogMessageMessage(1 .. n) (optional if more that one error messages needs to be returned)
  • LogMessageSeverity(1 .. n) (optional if more that one error messages needs to be returned)

◆ SAP_Object2TC_Object()

T4S::GENBOM::CUSTOM::MAPPING::SAP_Object2TC_Object   TransactionId TargetTypeName Status ObjectKey args  

Customer specific object reverse mapping function template for TargetTypeName.

Parameters
TransactionIdunique ID for the transfer transaction
TargetTypeNamespecified transaction target type name
StatusTransfer 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
ObjectKey
argsnot used
Returns
MappingStatus 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_Object()

T4S::GENBOM::CUSTOM::MAPPING::TC_Object2SAP_Object   TransactionId TargetTypeName ItemType ItemRevisionType args  

Customer specific object mapping function template for TargetTypeName.

Parameters
TransactionIdunique ID for the transfer transaction
TargetTypeNamespecified transaction target type name
ItemType
ItemRevisionType
argsnot used
Returns
MappingStatus 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

◆ TC_Object2SAP_ObjectPosition()

T4S::GENBOM::CUSTOM::MAPPING::TC_Object2SAP_ObjectPosition   TransactionId TargetTypeName TcPositionIndex ItemType ItemRevisionType args  

Customer specific object mapping function template for TargetTypeName.

Parameters
TransactionIdunique ID for the transfer transaction
TargetTypeNamespecified transaction target type name
TcPositionIndexTc BOMLine index
ItemType
ItemRevisionType
argsnot used
Returns
MappingStatus used by the following transfer function. The following values are valid:
  • OK T4S will continue with the next transfer step
  • SKIPPED T4S will skip the transfer to SAP
  • ERROR T4S will stop transfer and raise an error

◆ TC_Object2SAP_ObjectPostAction()

T4S::GENBOM::CUSTOM::MAPPING::TC_Object2SAP_ObjectPostAction   TransactionId TargetTypeName ItemType ItemRevisionType MappingStatus args  

This function is called AFTER the general mapping and can be used to perform additional steps after the header and position mapping.

Parameters
TransactionIdUnique ID for the transfer transaction
PositionIndexTc BOMLine index
ItemType
ItemRevisionType
MappingStatus
argsNot used
Returns
OK

Variable Documentation

◆ BomHeaderInfo

BomHeaderInfo
static

◆ BomPositionInfo

BomPositionInfo
static