T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
Rule Handler Definition

Functions

 CLM4T-validate-EALogon
 Examination of the EA login. More...
 
 T4EA-validate-EALogon
 Examination of the EA login. More...
 
 T4O-validate-BillOfMaterial
 Check information for an Oracle EBS bill of materials transfer. More...
 
 T4O-validate-ChangeOrder
 Validate ChangeOrder. More...
 
 T4O-validate-EBSLogon
 Examination of the Oracle EBS login. More...
 
 T4O-validate-GenericObject
 Check information for an Oracle EBS generic object transfer. More...
 
 T4O-validate-Item
 Check information for an Oracle EBS item transfer. More...
 
 T4S-check-T4SFolderExists
 Check for T4S folder. More...
 
 T4S-validate-BillOfMaterial
 Validate information for bill of materials transfer. More...
 
 T4S-validate-BusinessPartner
 Validate information for business partner transfer. More...
 
 T4S-validate-ChangeNumber
 Validate ChangeNumber. More...
 
 T4S-validate-DocumentInfoRecord
 Validate information for document info record transfer. More...
 
 T4S-validate-DocumentStructure4BomView
 Validate information for document structure transfer. More...
 
 T4S-validate-EquiBillOfMaterial
 Validate information for equipment bill of materials transfer. More...
 
 T4S-validate-EquipmentMaster
 Validate information for equipment master transfer. More...
 
 T4S-validate-FunctionalLocation
 Validate information for functional location master transfer. More...
 
 T4S-validate-FunctionalLocationBillOfMaterial
 Validate information for functional location bill of materials transfer. More...
 
 T4S-validate-GenericObject
 Validate information for generic object transfer. More...
 
 T4S-validate-MaterialMaster
 Validate information for material master transfer. More...
 
 T4S-validate-OrderBillOfMaterial
 Validate information for order bill of materials transfer. More...
 
 T4S-validate-PIR
 Validate information for purchase info record transfer. More...
 
 T4S-validate-SAPLogon
 Examination of the SAP login. More...
 
 T4S-validate-Schedule
 Validate information for schedule transfer. More...
 
 T4S-validate-Vendor
 Validate information for vendor transfer. More...
 
 T4S-validate-WBS-BillOfMaterial
 Validate information for work breakdown structure bill of materials transfer. More...
 
 T4X-attach-LogfileDataset
 Creates a log file for the workflow. More...
 
 T4X-validate-GenericObject4TargetType
 Check whether all the necessary information for generic object transfer is defined. More...
 

Detailed Description

Function Documentation

◆ CLM4T-validate-EALogon()

CLM4T-validate-EALogon

Examination of the EA login.

This handler validates the EA login to SIMATIC IT.
The handler should be used if possible in the "Complete" action of the SIT logon task.

Parameters
-use_EA_systemIf set, CLM4T will use the EA system stated as the value of this argument.

◆ T4EA-validate-EALogon()

T4EA-validate-EALogon

Examination of the EA login.

This handler validates the EA login.
The handler should be used if possible in the "Complete" action of the EA logon task.

Parameters
-use_EA_systemIf set, T4EA will use the EA system stated as the value of this argument.

◆ T4O-validate-BillOfMaterial()

T4O-validate-BillOfMaterial

Check information for an Oracle EBS bill of materials transfer.

This rule handler checks whether all the necessary information for an Oracle EBS bill of materials transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler. Only the actions "Perform" and "Complete" (equivalent to the argument -Check=MANDATORYFIELDS) return valid values. All other actions return "EPM_undecided".
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4O-validate-ChangeOrder()

T4O-validate-ChangeOrder

Validate ChangeOrder.

This rule handler checks if a change number was given and may additionally check if an ECO with this Name exists in Oracle EBS.
The rule handler may be placed in the "Start" action of the Root Task. Then it will not be executed for every target, but only once in the Wokflow job. It also has the advantage that T4O may change the Workflow Job Name; later Teamcenter will not allow that.
If the argument "-check_EPM_Targets=True" is set, it does not check the Job Name as ECO Name, but you can set it freely in the mapping and differently for every target of this Workflow job. If this is not set, the handler will only read the Workflow Job Name and use this as ECO Name, no matter of the number of targets. But nevertheless, the mapping needs to point to this information: set ::EBSDat(ChangeOrder:P_ECO_REC:ECO_NAME) [tpco_formatHEX16 $::TcData(Workflow:JobName)]

Parameters
-check_EPM_TargetsIf set to TRUE, the handler reads data from each Workflow job target data additionally.
-- - - - -
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4O-validate-EBSLogon()

T4O-validate-EBSLogon

Examination of the Oracle EBS login.

This handler validates the Oracle EBS login.
The handler should be used if possible in the "Complete" action of the EBS logon task.

Parameters
-use_EBS_systemIf set, T4O will use the Oracle EBS system stated as the value of this argument.

◆ T4O-validate-GenericObject()

T4O-validate-GenericObject

Check information for an Oracle EBS generic object transfer.

This rule handler checks whether all the necessary information for an Oracle EBS generic object transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler. Only the actions "Perform" and "Complete" (equivalent to the argument -Check=MANDATORYFIELDS) return valid values. All other actions return "EPM_undecided".
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4O-validate-Item()

T4O-validate-Item

Check information for an Oracle EBS item transfer.

This rule handler checks whether all the necessary information for an Oracle EBS item transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler. Only the actions "Perform" (equivalent to the argument -Check= MANDATORYFIELDS) and "Complete" (equivalent to the argument -Check=ITEMNUMBER) return valid values. All other actions return "EPM_undecided".
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-check-T4SFolderExists()

T4S-check-T4SFolderExists

Check for T4S folder.

This handler checks whether the T4S folder (in order to manage workflow targets) exists.
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-BillOfMaterial()

T4S-validate-BillOfMaterial

Validate information for bill of materials transfer.

This handler checks whether all the necessary information for a bill of materials transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler. Only the actions “Perform” and "Complete“ (equivalent to the argument "-check=MANDATORYFIELDS" ) return valid values. All other actions return "EPM_undecided". The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-BusinessPartner()

T4S-validate-BusinessPartner

Validate information for business partner transfer.

This handler checks whether all the necessary information for a business partner transaction is defined.
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-ChangeNumber()

T4S-validate-ChangeNumber

Validate ChangeNumber.

This handler checks if a change number was given and may additionally check if an ECM with this ID exists in SAP.
The rule handler may be placed in the "Start" action of the Root Task. Then it will not be executed for every target, but only once in the Wokflow job. It also has the advantage that T4S may change the Workflow Job Name; later Teamcenter will not allow that.

Parameters
-check_EPM_TargetsIf set to TRUE, the handler reads data from each Workflow job target data additionally.
-- - - - -
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-DocumentInfoRecord()

T4S-validate-DocumentInfoRecord

Validate information for document info record transfer.

This handler checks whether all the necessary information is defined for the creation of a document info record or if the reverse mapping of the SAP document key was successful, respectively.
The handler can be used in any task, preferably in action "Complete".

Parameters
-use_related_objectsIf set to TRUE, the handler adds related object information as simulated BOM lines to the TcData buffer. This can be used to create SAP document structures based on relations.
-- - - - -
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-DocumentStructure4BomView()

T4S-validate-DocumentStructure4BomView

Validate information for document structure transfer.

This handler checks whether all the necessary information for a document structure transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler. Only the actions “Perform” and "Complete“ (equivalent to the argument "-check=MANDATORYFIELDS" ) return valid values. All other actions return "EPM_undecided". The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-EquiBillOfMaterial()

T4S-validate-EquiBillOfMaterial

Validate information for equipment bill of materials transfer.

This handler checks whether all the necessary information for an equipment bill of materials transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler. Only the actions “Perform” and "Complete“ (equivalent to the argument "-check=MANDATORYFIELDS" ) return valid values. All other actions return "EPM_undecided". The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-EquipmentMaster()

T4S-validate-EquipmentMaster

Validate information for equipment master transfer.

This handler checks whether all the necessary information for a equipment master transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler.
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-FunctionalLocation()

T4S-validate-FunctionalLocation

Validate information for functional location master transfer.

This handler checks whether all the necessary information for a functional location master transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler.
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-FunctionalLocationBillOfMaterial()

T4S-validate-FunctionalLocationBillOfMaterial

Validate information for functional location bill of materials transfer.

This handler checks whether all the necessary information for an functional location bill of materials transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler. Only the actions “Perform” and "Complete“ (equivalent to the argument "-check=MANDATORYFIELDS" ) return valid values. All other actions return "EPM_undecided". The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-GenericObject()

T4S-validate-GenericObject

Validate information for generic object transfer.

This handler checks whether all the necessary information for a generic object transaction is defined.
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-MaterialMaster()

T4S-validate-MaterialMaster

Validate information for material master transfer.

This handler checks whether all the necessary information for a material master transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler. Only the actions “Perform” (equivalent to the argument "-check=MANDATORYFIELDS") and "Complete“ (equivalent to the argument "-check=MATERIALNUMBER" ) return valid values. All other actions return "EPM_undecided". The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-OrderBillOfMaterial()

T4S-validate-OrderBillOfMaterial

Validate information for order bill of materials transfer.

This handler checks whether all the necessary information for an order bill of materials transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler. Only the actions “Perform” and "Complete“ (equivalent to the argument "-check=MANDATORYFIELDS" ) return valid values. All other actions return "EPM_undecided". The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-PIR()

T4S-validate-PIR

Validate information for purchase info record transfer.

This handler checks whether all the necessary information for a purchase info record transaction is defined.
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-SAPLogon()

T4S-validate-SAPLogon

Examination of the SAP login.

This handler validates the SAP login.
The handler should be used if possible in the "Complete" action of the SAP logon task.

Parameters
-use_SAP_clientIf set, T4S will use the SAP client stated as the value of this argument.
-use_SAP_systemIf set, T4S will use the SAP system stated as the value of this argument.

◆ T4S-validate-Schedule()

T4S-validate-Schedule

Validate information for schedule transfer.

This handler checks whether all the necessary information for a schedule transaction is defined.
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-Vendor()

T4S-validate-Vendor

Validate information for vendor transfer.

This handler checks whether all the necessary information for a vendor transaction is defined.
The handler can be used in any task, preferably in action "Complete".

Parameters
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4S-validate-WBS-BillOfMaterial()

T4S-validate-WBS-BillOfMaterial

Validate information for work breakdown structure bill of materials transfer.

This handler checks whether all the necessary information for a work breakdown structure bill of materials transaction is defined. If no arguments are transferred, the action is used as a parameter for the function of the rule handler.
The handler can be used in any task, preferably in action "Complete".

Parameters
-use_VariantRuleTransferIf set to TRUE, the VariantRule information is considered during BOM transfer.
-- - - - -
-bom_rev_ruleThis parameter specifies the TC BOM revision rule name. If set, the stated revision rule overrides the BOM revision rule setting <ProductKey>_BillOfMaterialMapping4 in the Teamcenter preferences. If you use a BOM rule handler as well, it needs the same argument.
-bomview_prio_listThis parameter specifies <list of BOM view types>. Value is a comma-separated list of BOM view types; if set, T4x reads this list and checks if one of the stated BOM view types is present in the target according to the preference <ProductKey>_BillOfMaterialTypeList. Then it uses the Teamcenter BOM object according to the first matching type only and ignores all the others given to this handler. If none of the stated types is present, no BOM is transferred although the target list may contain several BOM views. The value for this argument is a comma separated list without additional blanks. T4x just removes the commas and uses the strings as they are as type names, e.g. "-bomview_prio_list=view,MBOM,BOM3"
-closure_ruleThis parameter specifies the closure rule applied to the structure.
-hide_GDELinesIf set to TRUE, T4x will hide GDE BOM positions.
-hide_incremental_changes_bomlinesIf set to TRUE, T4x will hide incremental changes.
-hide_substitutesIf set to TRUE, T4x will hide substitutes.
-hide_suppressed_bomlinesIf set to TRUE, T4x will hide suppressed BOM positions.
-hide_unconfigured_bomlinesIf set to TRUE, T4x will hide unconfigured variants.
-hide_variants_bomlinesIf set to TRUE, T4x will hide variants.
-no_transfer_of_empty_bomIf set to TRUE, an empty Teamcenter BOM (it does not contain any position) will be ignored; else T4x will try and create an empty BOM in the foreign system, i.e. the BOM header with all its data but no BOM position. Caution: this is only used for BOMs that are stored empty in Teamcenter; if a BOM gets empty during the mapping because all its positions are skipped, this setting will not skip the BOM transfer; that has to be handled in the BOM mapping separately
-scan_max_bom_levelThis parameter defines the maximum number of structure levels that are read by T4x. The default value is 1.
Only relevant if multi-level BOM transfer is configured.
-skip_bomlines_by_conditionIf set to TRUE, T4x will skip BOM positions based on a defined set of BMIDE conditions.
The validated conditions are defined in a site preference with the following naming convention:
<ProductKey>_<TargetTypeName>SkipCondition4<BOMLineType>
-skip_bomlines_by_condition_prefixThis parameter overwrites the default preference name used by parameter -skip_bomlines_by_condition.
-skip_unconfigured_bomlinesIf set to TRUE, T4x will skip unconfigured BOM positions.
-unpack_all_bomlinesIf set to TRUE, T4x will provide all BOM positions unpacked and allow the packing in the mapping according to any logic defined there
-unpack_bomlines_by_conditionIf set to TRUE, T4x will provide all BOM positions unpacked based on a defined set of BMIDE conditions.
The validated conditions are defined in a site preference with the following naming convention:
<ProductKey>_<TargetTypeName>UnpackCondition4<BOMLineType>
-use_attached_rev_ruleIf set to TRUE, this BOM handler will use the Teamcenter BOM revision rule which was attached to the workflow target by the additional T4x handler T4X-attach-RevisionRule. Additionally this functionality needs the following preference set: <ProductKey>_BillOfMaterialType_RevisionRuleAttachmentPath=<Relation>:RevisionRule The name part BillOfMaterial depends on the Teamcenter BOM type for which that configuration should be valid, so instead of the default name BillOfMaterial that name part may be for example OrderBillOfMaterial or EquiBillOfMaterial The <Relation> stands for the path that is used to find the RevisionRule, e.g. IMAN_reference or if the revision rule is attached to the workflow itself then EPM_target_attachment
-- - - - -
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.

◆ T4X-attach-LogfileDataset()

T4X-attach-LogfileDataset

Creates a log file for the workflow.

This rule handler creates an additional workflow log file that will be linked to the workflow as an attachment. In case of an error, the error message defined with storeMessage2 will be shown there. Additionally, for writing into this file no matter if an error occurred, use the function storeMessage2DatasetLogfile instead, e.g. T4X::CORE::storeMessage2DatasetLogfile "MAPPING" "Test message".
The rule handler should be used if possible in the "Start" action of the Root Task so that all subsequent handlers can use the log file.
During a Workflow Job run, the log file is created in the "Attachments" of this Workflow Job (check in "Workflow Viewer").

Note
If this handler is used, the log information that is written into this file will not be written to the session log file any more.
Parameters
-aclThis parameter defines the Access Control List (acl) name that is attached to the log file dataset, so that it is possible to update the dataset by different users.

◆ T4X-validate-GenericObject4TargetType()

T4X-validate-GenericObject4TargetType

Check whether all the necessary information for generic object transfer is defined.

No mandatory arguments, all handler arguments are optional.

Parameters
-BomHeaderTypeListRequired for BOM transfers. The parameter specifies the variable part of the preference names that is used to identify which structure needs to be transferred.
-ChangeTypeThe parameter defines the preference prefix (<ProductKey><ChangeType>TypeList) to identify if the target should be search with a Teamcenter Change object and its folders (e.g. Solution Item, Problem Item, ...).
-ChangeTypeNameThe parameter defines the preference prefix (<ProductKey><ChangeTypeName>TypeList) to identify if the target should be search with a Teamcenter Change object and its folders (e.g. Solution Item, Problem Item, ...).
-ProductKeyThe parameter specifies the T4x product, e.g. T4S.
-TargetTypeNameThe parameter specifies the preference prefix for the preference names (e.g. <ProductKey>_<TargetTypeName>TypeList) that is used to identify which structure needs to be transferred.
-use_EA_systemIf set, T4X will use the EA system stated as the value of this argument.
-use_EBS_systemIf set, T4O will use the Oracle EBS system stated as the value of this argument.
-use_SAP_clientIf set, T4S will use the SAP client stated as the value of this argument.
-use_SAP_systemIf set, T4S will use the SAP system stated as the value of this argument.
-useView4TransferRequired for BOM transfers. If set to TRUE, a BOM transfer is enabled based on BOM view information.
-- - - - -
-AddObject4MappingThis parameter allows T4x reading additional Teamcenter data during the transaction.
Syntax: -AddObject4Mapping=<EPM_attachment_type>:<ObjectType>[:<RelationType>:<ObjectType>][:PropertyName]
For <EPM_attachment_type> use value EPM_target_attachment, EPM_reference_attachment, EPM_signoff_attachment or EPM_release_status_attachment.

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
to read attribute values of a TC object in the mapping that have not been configured (i.e. set in the corresponding Mapping4 preference).

Specify e.g. -AddObject4Mapping=EPM_target_attachment:ChangeNoticeRevision
or -AddObject4Mapping=EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties
to read attribute values of a TC object e.g. added via action handler EPM_attach_related_objects to workflow task or manually in the "New Process Dialog".

In case of several needed objects the syntax is -AddObject4Mapping=usePreference:<PreferenceName>.
The preference <PreferenceName> contains the definition for all needed objects,
e.g. -AddObject4Mapping=usePreference:T4X_AddObject4MappingPref with
T4X_AddObject4MappingPref =
EPM_target_attachment:ItemRevision:CMHasSolutionItem:ChangeNoticeRevision
EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info:#__getAllProperties__#:Properties

In mapping use function ::T4X::TC::MAPPING::RootTaskFieldMapping to read the object attribute value,
e.g. set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ItemRevision:CMHasImpactedItem:ChangeNoticeRevision" "object_desc"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_target_attachment:ChangeNoticeRevision" "object_name"]
or set AttrValue [::T4X::TC::MAPPING::RootTaskFieldMapping "RootTask:EPM_reference_attachment:ItemRevision:IMAN_reference:T4S Status Info" "T4S_Free1"]

Specify -AddObject4Mapping=root_task:EPMTask to read workflow task attributes in the mapping.
In mapping get the task attribute from the TcData buffer, e.g. set GovClassification [T4X::TC::MAPPING::RootTaskFieldMapping RootTask:root_task:EPMTask gov_classification]
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-checkThis parameter is used in the combination with the -user_rule=Default argument to trigger target object specific build in rules.
-modeThis parameter is used in the combination with the -user_rule=Default and the -check argument to trigger target object specific build in rules.
-user_ruleName of the rule to check if the mapping was executed (default value is "Default"). If set to Default, a target object specific check is executed for the mandatory input fields. Otherwise a corresponding mapping function (callCustomerRuleHandler) is called to calculate the rule handler decision.