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

Functions

 callCustomerRuleHandler TransactionId SourceObjectInfo Action RuleName args
 Customer specific WBS BOM RuleHandler function template. More...
 
 ctrlAfterMultiTransferLoop TransactionId TransferIndex TransferStatus args
 Customer specific mapping function to control the MultiTransferLoop. This function is called after every transfer within such a loop. It can be used to perform any action in between two transfers or to cancel the loop by modified the returned status. More...
 
 ctrlAfterMultiTransferLoop_ContinueOnError TransactionId TransferIndex TransferStatus args
 Customer specific mapping function to control, if the MultiTransferLoop should continue even if there was an error in the previous transfer during the loop. More...
 
 ctrlBeforeMultiTransferLoop TransactionId TransferIndex args
 Customer specific mapping function to control the MultiTransferLoop. This function is called before every transfer within such a loop. It can be used to perform any action in between two transfers. More...
 
 getObjectInfo TransactionId TargetTypeName ObjectKey args
 Customer specific Mapping function to retrieve the object information from SAP. More...
 
 getTcData ObjectTag args
 This function is called to extract the WBS BOM data for a given BOM view tag, the resulting Tc data is stored in the TcData buffer. More...
 
 SAP_WBS_BillOfMaterial2TC_Object TransactionId SourceObjectInfo TargetTypeName Status ObjectKey args
 Customer specific WBS BOM reverse mapping function template. More...
 
 TC_Object2SAP_WBS_BillOfMaterial TransactionId SourceObjectInfo TargetTypeName args
 Customer specific WBS BOM header mapping function template. More...
 
 TC_Object2SAP_WBS_BillOfMaterialPosition TransactionId PositionIndex SourceObjectInfo TargetTypeName args
 Customer specific WBS BOM position mapping function template. More...
 
 TC_Object2SAP_WBS_BillOfMaterialPostAction TransactionId SourceObjectInfo TargetTypeName 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::WBS_BOM::CUSTOM::MAPPING::callCustomerRuleHandler   TransactionId SourceObjectInfo Action RuleName args  

Customer specific WBS BOM RuleHandler function template.

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

◆ ctrlAfterMultiTransferLoop()

T4S::WBS_BOM::CUSTOM::MAPPING::ctrlAfterMultiTransferLoop   TransactionId TransferIndex TransferStatus args  

Customer specific mapping function to control the MultiTransferLoop. This function is called after every transfer within such a loop. It can be used to perform any action in between two transfers or to cancel the loop by modified the returned status.

Parameters
TransactionIdUnique ID for the transfer transaction
TransferIndexThe MultiTransferLoop index
TransferStatusThe status of the previously performed transfer
argsNot used
Returns
Status of the transfer

◆ ctrlAfterMultiTransferLoop_ContinueOnError()

T4S::WBS_BOM::CUSTOM::MAPPING::ctrlAfterMultiTransferLoop_ContinueOnError   TransactionId TransferIndex TransferStatus args  

Customer specific mapping function to control, if the MultiTransferLoop should continue even if there was an error in the previous transfer during the loop.

Parameters
TransactionIdUnique ID for the transfer transaction
TransferIndexThe MultiTransferLoop index
TransferStatusThe status of the previously performed transfer
argsNot used
Returns
TRUE -> Loop will continue in case of an ERROR; FALSE -> Loop will stop in case of an ERROR (default)

◆ ctrlBeforeMultiTransferLoop()

T4S::WBS_BOM::CUSTOM::MAPPING::ctrlBeforeMultiTransferLoop   TransactionId TransferIndex args  

Customer specific mapping function to control the MultiTransferLoop. This function is called before every transfer within such a loop. It can be used to perform any action in between two transfers.

Parameters
TransactionIdUnique ID for the transfer transaction
TransferIndexThe MultiTransferLoop index
argsNot used
Returns
Status to control the loop (OK (=continue), SKIPPED (=skip this transfer) or ERROR (=stop loop))

◆ getObjectInfo()

T4S::WBS_BOM::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 for generic TC object transfer
ObjectKeySAP object id information
Returns

◆ getTcData()

T4S::WBS_BOM::CUSTOM::MAPPING::getTcData   ObjectTag args  

This function is called to extract the WBS BOM data for a given BOM view tag, the resulting Tc data is stored in the TcData buffer.

Parameters
ObjectTagof the BOM view that represents the WBS BOM in Tc.
argsnot used
Returns
ITK_ok (=0) or List of ITK status and error message.

◆ SAP_WBS_BillOfMaterial2TC_Object()

T4S::WBS_BOM::CUSTOM::MAPPING::SAP_WBS_BillOfMaterial2TC_Object   TransactionId SourceObjectInfo TargetTypeName Status ObjectKey args  

Customer specific WBS BOM reverse mapping function template.

Parameters
TransactionIdunique ID for the transfer transaction
SourceObjectInfosource object information dict structure
TargetTypeNamespecified transaction target type name for generic TC object transfer
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
ObjectKeySAP object id information
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_WBS_BillOfMaterial()

T4S::WBS_BOM::CUSTOM::MAPPING::TC_Object2SAP_WBS_BillOfMaterial   TransactionId SourceObjectInfo TargetTypeName args  

Customer specific WBS BOM header mapping function template.

Parameters
TransactionIdunique ID for the transfer transaction
SourceObjectInfosource object information dict structure
TargetTypeNamespecified transaction target type name
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_WBS_BillOfMaterialPosition()

T4S::WBS_BOM::CUSTOM::MAPPING::TC_Object2SAP_WBS_BillOfMaterialPosition   TransactionId PositionIndex SourceObjectInfo TargetTypeName args  

Customer specific WBS BOM position mapping function template.

Parameters
TransactionIdunique ID for the transfer transaction
PositionIndexTc BOMLine index
SourceObjectInfosource object information dict structure
TargetTypeNamespecified transaction target type name
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_WBS_BillOfMaterialPostAction()

T4S::WBS_BOM::CUSTOM::MAPPING::TC_Object2SAP_WBS_BillOfMaterialPostAction   TransactionId SourceObjectInfo TargetTypeName 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