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

Functions

 callCustomerRuleHandler TransactionId SourceObjectInfo Action RuleName 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...
 
 getTcData ObjectTag args
 This function is called to extract the Tc data for a given tag, the resulting Tc data is stored in the TcData buffer. More...
 
 getTcOptionValues TransactionId SourceObjectInfo TargetTypeName strDataTypeTC
 Customer specific object mapping function template to get a list of all TC option values for a given option family. More...
 
 SAP_VariantValueRestriction2TC_Object TransactionId SourceObjectInfo TargetTypeName Status ObjectKey args
 Customer specific object reverse mapping function template for TargetTypeName. More...
 
 TC_Object2SAP_ConfigurationProfile TransactionId SourceObjectInfo TargetTypeName args
 Customer specific object mapping function template to maintain the configuration profile for a given material. More...
 
 TC_Object2SAP_VariantValueRestriction TransactionId SourceObjectInfo TargetTypeName args
 Customer specific object mapping function template for TargetTypeName. More...
 
 TC_Object2SAP_VariantValueRestriction_CreateAndAssignConstraint TransactionId SourceObjectInfo TargetTypeName Characteristic args
 Customer specific object mapping function template to create a constraint and to assign it to a constraint net. More...
 
 TC_Object2SAP_VariantValueRestriction_CreateAndAssignNet TransactionId SourceObjectInfo TargetTypeName args
 Customer specific object mapping function template to create a constraint net and to assign it to the configuration profile. More...
 
 TC_Object2SAP_VariantValueRestriction_CreateAndAssignTable TransactionId SourceObjectInfo TargetTypeName Characteristic args
 Customer specific object mapping function template to create a constraint table and to assign it to the constraint. More...
 
 TC_Object2SAP_VariantValueRestriction_CreateTableEntry TransactionId SourceObjectInfo TargetTypeName Characteristic lstTcOptionValues args
 Customer specific object mapping function template to create a constraint table entry. More...
 

Function Documentation

◆ callCustomerRuleHandler()

T4S::VARIANT_VALUE_RESTRICTION::CUSTOM::MAPPING::callCustomerRuleHandler   TransactionId SourceObjectInfo Action RuleName args  

Customer specific object 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
argsnot used
Returns
EPM_nogo or EPM_go

◆ getObjectInfo()

T4S::VARIANT_VALUE_RESTRICTION::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
argsnot used
Returns
ITK_ok (=0) or List of ITK status and error message.

◆ getTcData()

T4S::VARIANT_VALUE_RESTRICTION::CUSTOM::MAPPING::getTcData   ObjectTag args  

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

Parameters
ObjectTagof the Teamcenter object
argsnot used
Returns
ITK_ok (=0) or List of ITK status and error message.

◆ getTcOptionValues()

T4S::VARIANT_VALUE_RESTRICTION::CUSTOM::MAPPING::getTcOptionValues   TransactionId SourceObjectInfo TargetTypeName strDataTypeTC  

Customer specific object mapping function template to get a list of all TC option values for a given option family.

Parameters
TransactionIdUnique ID for the transfer transaction
SourceObjectInfosource object information dict structure
TargetTypeNameSpecified transaction target type name for generic TC object transfer
strDataTypeTC
Returns
TCL list of TC option values

◆ SAP_VariantValueRestriction2TC_Object()

T4S::VARIANT_VALUE_RESTRICTION::CUSTOM::MAPPING::SAP_VariantValueRestriction2TC_Object   TransactionId SourceObjectInfo TargetTypeName Status ObjectKey args  

Customer specific object reverse mapping function template for TargetTypeName.

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_ConfigurationProfile()

T4S::VARIANT_VALUE_RESTRICTION::CUSTOM::MAPPING::TC_Object2SAP_ConfigurationProfile   TransactionId SourceObjectInfo TargetTypeName args  

Customer specific object mapping function template to maintain the configuration profile for a given material.

Parameters
TransactionIdUnique ID for the transfer transaction
SourceObjectInfosource object information dict structure
TargetTypeNameSpecified transaction target type name for generic TC object transfer
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
  • ADDITIONALUPDATESONLY -> T4S will skip the main transfer but will excecute all additional transfers (if activated in the mapping)
  • ERROR T4S will stop transfer and raise an error

◆ TC_Object2SAP_VariantValueRestriction()

T4S::VARIANT_VALUE_RESTRICTION::CUSTOM::MAPPING::TC_Object2SAP_VariantValueRestriction   TransactionId SourceObjectInfo TargetTypeName args  

Customer specific object mapping function template for TargetTypeName.

Parameters
SessionIdunique session ID for the users Teamcenter session
TransactionIdunique ID for the transfer transaction
TargetTypeNamespecified transaction target type name for generic TC object transfer
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_VariantValueRestriction_CreateAndAssignConstraint()

T4S::VARIANT_VALUE_RESTRICTION::CUSTOM::MAPPING::TC_Object2SAP_VariantValueRestriction_CreateAndAssignConstraint   TransactionId SourceObjectInfo TargetTypeName Characteristic args  

Customer specific object mapping function template to create a constraint and to assign it to a constraint net.

Parameters
TransactionIdUnique ID for the transfer transaction
SourceObjectInfosource object information dict structure
TargetTypeNameSpecified transaction target type name for generic TC object transfer
CharacteristicThe SAP characteristic for which the constraint net will be maintained
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_VariantValueRestriction_CreateAndAssignNet()

T4S::VARIANT_VALUE_RESTRICTION::CUSTOM::MAPPING::TC_Object2SAP_VariantValueRestriction_CreateAndAssignNet   TransactionId SourceObjectInfo TargetTypeName args  

Customer specific object mapping function template to create a constraint net and to assign it to the configuration profile.

Parameters
TransactionIdUnique ID for the transfer transaction
SourceObjectInfosource object information dict structure
TargetTypeNameSpecified transaction target type name for generic TC object transfer
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_VariantValueRestriction_CreateAndAssignTable()

T4S::VARIANT_VALUE_RESTRICTION::CUSTOM::MAPPING::TC_Object2SAP_VariantValueRestriction_CreateAndAssignTable   TransactionId SourceObjectInfo TargetTypeName Characteristic args  

Customer specific object mapping function template to create a constraint table and to assign it to the constraint.

Parameters
TransactionIdUnique ID for the transfer transaction
SourceObjectInfosource object information dict structure
TargetTypeNameSpecified transaction target type name for generic TC object transfer
CharacteristicThe SAP characteristic for which the constraint net will be maintained
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_VariantValueRestriction_CreateTableEntry()

T4S::VARIANT_VALUE_RESTRICTION::CUSTOM::MAPPING::TC_Object2SAP_VariantValueRestriction_CreateTableEntry   TransactionId SourceObjectInfo TargetTypeName Characteristic lstTcOptionValues args  

Customer specific object mapping function template to create a constraint table entry.

Parameters
TransactionIdUnique ID for the transfer transaction
SourceObjectInfosource object information dict structure
TargetTypeNameSpecified transaction target type name for generic TC object transfer
CharacteristicThe SAP characteristic for which the constraint net will be maintained.
lstTcOptionValuesList of TC option values
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