T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
Action Handler Definition

Functions

 T4EA-SessionProxy
 Manage a proxy to forward the EA login data. More...
 
 T4EA-transfer-GenericBillOfMaterial4Relation
 Generic bill of materials transfer based on a TC relation based structure. More...
 
 T4EA-transfer-GenericObject
 Generic object transfer. More...
 
 T4EA-transfer-GenericObject4BomLine
 Generic object transfer for each position of a bill of material. More...
 
 T4O-define-PreferredEBSSystem
 Define the preferred Oracle EBS connection. More...
 
 T4O-SessionProxy
 Manage a proxy to forward the Oracle EBS login data. More...
 
 T4O-transfer-BillOfMaterial
 Bill of materials transfer to Oracle EBS. More...
 
 T4O-transfer-CC-BOM
 CC Bill of materials transfer. More...
 
 T4O-transfer-ChangeOrder
 Create an ECO in Oracle EBS. More...
 
 T4O-transfer-GenericObject
 Generic object transfer. More...
 
 T4O-transfer-Item
 Create an item in Oracle EBS. More...
 
 T4O-transfer-Item4BomLine
 Item transfer for each position of a bill of material. More...
 
 T4O-transfer-Routing
 Routing transfer. More...
 
 T4S-add-Form2CC
 Add form to CC object. More...
 
 T4S-create-Folder
 Create folder to manage workflow targets. More...
 
 T4S-define-PreferredSapSystem
 Define the preferred SAP connection. More...
 
 T4S-SessionProxy
 Manages a proxy to forward the SAP login data. More...
 
 T4S-transfer-BillOfMaterial
 Bill of materials transfer to SAP. More...
 
 T4S-transfer-BillOfMaterial4Relation
 Bill of materials transfer based on a TC relation based structure. More...
 
 T4S-transfer-BusinessPartner
 Create or change a business partner in SAP S/4HANA. More...
 
 T4S-transfer-CC-BOM
 CC Bill of materials transfer. More...
 
 T4S-transfer-ChangeNumber
 Create a change number in SAP. More...
 
 T4S-transfer-DocumentInfoRecord
 Create or change a document info record in SAP. More...
 
 T4S-transfer-DocumentStructure4BomView
 Document structure transfer to SAP. More...
 
 T4S-transfer-EquiBillOfMaterial
 Equipment bill of materials transfer to SAP. More...
 
 T4S-transfer-EquipmentMaster
 Create or change an equipment master record in SAP. More...
 
 T4S-transfer-FunctionalLocation
 Create or change a functional location master record in SAP. More...
 
 T4S-transfer-FunctionalLocationBillOfMaterial
 Functional location bill of materials transfer to SAP. More...
 
 T4S-transfer-GenericObject
 Generic object transfer. More...
 
 T4S-transfer-iPPE-Node4BomLine
 Bill of materials transfer to iPPE structure node in SAP. More...
 
 T4S-transfer-iPPE-Structure
 Bill of materials transfer to iPPE structure node in SAP. More...
 
 T4S-transfer-MaterialMaster
 Create or change a material master record in SAP. More...
 
 T4S-transfer-MaterialMaster4BomLine
 Create a material master record in SAP for every Bill of materials position. More...
 
 T4S-transfer-OrderBillOfMaterial
 Order bill of materials transfer to SAP. More...
 
 T4S-transfer-PIR
 Create or change a purchase info record in SAP. More...
 
 T4S-transfer-Routing
 Routing transfer. More...
 
 T4S-transfer-Schedule
 Create or change a schedule in SAP. More...
 
 T4S-transfer-VariantCharacteristic
 Create a characteristic in SAP. More...
 
 T4S-transfer-VariantClass
 Create a class of type 300 in SAP. More...
 
 T4S-transfer-VariantValueRestriction
 Restrict characteristic values for a SAP class. More...
 
 T4S-transfer-Vendor
 Create or change a vendor in SAP. More...
 
 T4S-transfer-WBS-BillOfMaterial
 Bill of materials transfer to work breakdown structure bom in SAP. More...
 
 T4X-attach-RevisionRule
 Attaches a dynamically created revision rule to an workflow job. More...
 
 T4X-copy-Attributes-to-Task
 Copy attributes to task object. More...
 
 T4X-create-AIObject4CC
 Create an Application Interface Object. More...
 
 T4X-create-T4X-BatchJob
 This handler creates a job in the T4x BGS environment. More...
 
 T4X-SessionProxy
 Manage a proxy to store and reset preferred connections during a workflow. More...
 
 T4X-transfer-GenericObject4TargetType
 Generic object transfer based on the specified arguments. More...
 

Detailed Description

The T4x handlers can be combined with all other handlers without any major modification.

Some handlers may be placed in the "Start" action of the Root Task. As Teamcenter will discard the entire workflow job if an error occurs in this action (which also means that T4x cannot store its log file Dataset), error tracking might be harder in this case so this is not recommended.

Function Documentation

◆ T4EA-SessionProxy()

T4EA-SessionProxy

Manage a proxy to forward the EA login data.

This handler manages a proxy to forward the EA login data between different TC users if they are involved in one workflow, i.e. only the first user will have to type his or her EA login data and every EA transaction in the same Workflow job will be done with the same EA user. Add "-Mode=SAVE" after the EA Logon Task. If another TC user gets the workflow (e.g. a reviewer), add "-Mode=READ" in his task to enable him sending data to EA with the same EA user as the TC user who started the workflow without the need to login separately. As then, this TC user automatically uses the same EA login outside of any Workflow, too, you should add "-Mode=FORGET" to avoid that. This can also be used to restore the previous preferred connection.
The handler can be used in any task, preferably in action "Complete".

Note
The EA logon data must be present and correct. This is best checked with the "T4EA-validate-EALogon" rule handler before the T4EA-SessionProxy called with the -Mode=SAVE argument.
Do not use this handler with "-Mode=FORGET" in a Workflow Task that is executed before the Workflow is shifted to another Teamcenter user (e.g. a generic T4x job user), because this would delete the current user’s EA login (for Workflow and interactive use as well).
Parameters
-ModePossible values are:
  • SAVE - saves the current EA login into a T4EA proxy.
  • READ - reads the EA login from a T4EA proxy.
  • FORGET - deletes the logon data from the T4EA proxy without deleting the T4EA Proxy itself.
  • DELETE - deletes a T4EA proxy. (*)
    (*) The difference is that after FORGET the login data are not used automatically again, but they may be reused with the argument -Mode=READ; after a DELETE, they cannot be restored.

◆ T4EA-transfer-GenericBillOfMaterial4Relation()

T4EA-transfer-GenericBillOfMaterial4Relation

Generic bill of materials transfer based on a TC relation based structure.

This handler creates or changes a Bill of materials based on a TC relation based structure (instead of using a TC bom view).

Parameters
-add_related_objectsIf set to TRUE, the handler adds related object information as simulated BOM lines to the TcData buffer during the BOMView based data extraction. This means it combines the BOMView based with the BOM4REL based data extraction.
-bom4rel_use_bomviewRequires -useBom4Realation4Transfer=TRUE. If parameter is set to TRUE, a BOM transfer based on BOM view information is done if BOM view exists.
-Bom4RelationTargetTypeNameThe parameter specifies the variable part of the preference names that is used to identify which structure needs to be transferred.
-BomHeaderTypeListThe parameter specifies the variable part of the preference names that is used to identify which structure needs to be transferred.
-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, T4EA will use the EA system stated as the value of this argument.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4EA-transfer-GenericObject()

T4EA-transfer-GenericObject

Generic object transfer.

For an element of object type ItemRevision a generic object transfer to an Enterprise Application is executed. A configured Teamcenter object is transferred via a Teamcenter workflow to a specified EA target object. In the Enterprise Application, the defined object is created or updated. The business logic for the creation or update of the EA object is defined and implemented by the customer in the mapping file. Supported Objects: ItemRevision based Objects (included attached Forms and datasets) Bom View Revisions. Define the generic object mapping for a specific type in your own mapping file in the namespace "::T4EA::GENOBJ::CUSTOM::MAPPING" (do not forget to source it in t4ea_mapping_config.sd) in the following functions:

  • TC_Object2EA_Object – for defining the data mapping from Teamcenter to the EA object
  • EA_Object2TC_Object – for defining the back mapping from the EA object to Teamcenter
  • performTransfer – for customer specific definition of the actual transfer to the Enterprise Application
  • getObjectInfo – for retrieving the object information from the EA object
Parameters
-add_related_objectsIf set to TRUE, the handler adds related object information as simulated BOM lines to the TcData buffer during the BOMView based data extraction. This means it combines the BOMView based with the BOM4REL based data extraction.
-bom4rel_use_bomviewRequires -useBom4Realation4Transfer=TRUE. If parameter is set to TRUE, a BOM transfer based on BOM view information is done if BOM view exists.
-Bom4RelationTargetTypeNameRequired for BOM transfers based on relation information. The parameter specifies the variable part of the preference names that is used to identify which structure needs to be transferred.
-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.
-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, ...).
-check_EPM_TargetsIf set to TRUE, the handler reads data from each Workflow job target data additionally.
-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, T4EA will use the EA system stated as the value of this argument.
-use_EPM_objects_as_targetsWith this parameter it is possible to decide if the root_task (job) or the current_task of a workflow in the inbox is used as transfer object. Possible values are: root_task (Default) and current_task.
In addition the preference <ProductKey>_<TargetTypeName>TypeList needs to contain the type EPMTask.
-useBom4Relation4TransferRequired for BOM transfers. If set to TRUE, a BOM transfer is enabled based on relation information.
-usePlmxml4TransferIf set to YES, all generic object handler calls are switched to an implementation that is using a PLMXML based implementation namespace. Default: NO.
-useView4TransferRequired for BOM transfers. If set to TRUE, a BOM transfer is enabled based on BOM view information.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4EA-transfer-GenericObject4BomLine()

T4EA-transfer-GenericObject4BomLine

Generic object transfer for each position of a bill of material.

This handler transfers from the currently selected Teamcenter BOM every position object as well as the BOM header object to an Enterprise Application. So if it is requested then this additional handler should be used before the handler T4EA-transfer-GenericObject configured for BOM transfer.

Parameters
-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, T4EA will use the EA system stated as the value of this argument.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4O-define-PreferredEBSSystem()

T4O-define-PreferredEBSSystem

Define the preferred Oracle EBS connection.

This handler defines the preferred Oracle EBS connection for all following transfer handlers.
The handler can be used in any task, preferably in action "Complete".

Note
The EBS logon data must be present and correct. This is best checked with the "T4O-validate-EBSLogon" rule handler.
Parameters
-use_EBS_systemIf set, T4O will use the Oracle EBS system stated as the value of this argument.

◆ T4O-SessionProxy()

T4O-SessionProxy

Manage a proxy to forward the Oracle EBS login data.

This handler manages a proxy to forward the Oracle EBS login data between different TC users if they are involved in one workflow, i.e. only the first user will have to type his or her Oracle EBS login data and every Oracle EBS transaction in the same Workflow job will be done with the same Oracle EBS user. Add "-Mode=SAVE" after the Oracle EBS Logon Task. If another TC user gets the workflow (e.g. a reviewer), add "-Mode=READ" in his task to enable him sending data to Oracle EBS with the same Oracle EBS user as the TC user who started the workflow without the need to login separately. As then, this TC user automatically uses the same Oracle EBS login outside of any Workflow, too, you should add "-Mode=FORGET" to avoid that. This can also be used to restore the previous preferred connection.
The handler can be used in any task, preferably in action "Complete".

Note
The EBS logon data must be present and correct. This is best checked with the "T4O-validate-EBSLogon" rule handler before the T4O_SessionProxy-AH called with the "-Mode=Save" argument.
Do not use this handler with "-Mode=Forget" in a Workflow Task that is executed before the Workflow is shifted to another Teamcenter user (e.g. a generic T4O job user), because this would delete the current user’s EBS login (for Workflow and interactive use as well).
Parameters
-ModePossible values are:
  • SAVE saves the current Oracle EBS login into a T4O proxy
  • READ reads the Oracle EBS login from a T4O proxy
  • FORGET deletes the logon data from the T4O proxy without deleting the T4O Proxy itself
  • DELETE deletes a T4O proxy (*)
    (*) The difference is that after FORGET the login data are not used automatically again, but they may be reused with the argument -Mode=READ; after a DELETE, they cannot be restored.

◆ T4O-transfer-BillOfMaterial()

T4O-transfer-BillOfMaterial

Bill of materials transfer to Oracle EBS.

This handler transfers for each configured BOM view type a defined bill of materials to Oracle EBS.
The handler can be used in any task, preferably in action "Complete".

Note
The EBS logon data must be present and correct. This is best checked with the "T4O-validate-EBSLogon" rule handler.
Parameters
-LOOP_COUNTEROptional for BOM Rule Imports. This parameter specifies how often T4O should try to get the rule import result.
-LOOP_DELAYOptional for BOM Rule Imports. This parameter specifies the time between the attempts to get the rule import result.
-RETRIEVE_IMPORT_RESULTOptional for BOM Rule Imports. If set to TRUE, polling for import result is enabled. As the BOM Rule Import will execute an EBS concurrent program which is asynchronous, T4O will try to get the import result every x minutes. We recommend to set this argument only for use in test environments.
-use_EBS_systemIf set, T4O will use the Oracle EBS system stated as the value of this argument.
-use_VariantRuleTransferIf set to TRUE, the VariantRule information is considered during BOM transfer.
-VARIANT_TRANSFERRequired for BOM Rule Imports. If set to TRUE, the BOM Rule Import to Oracle Configurator is enabled.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4O-transfer-CC-BOM()

T4O-transfer-CC-BOM

CC Bill of materials transfer.

Transfers MBOM Data extracted from the Application Interface Object found as target attachment of the current task to Oracle EBS.
The handler can be used in any task, preferably in action "Complete".

Note
Works only for objects of type Application Interface Object.
The EBS logon data must be present and correct. This is best checked with the "T4O-validate-EBSLogon" rule handler.
Parameters
-use_EBS_systemIf set, T4O will use the Oracle EBS system stated as the value of this argument.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4O-transfer-ChangeOrder()

T4O-transfer-ChangeOrder

Create an ECO in Oracle EBS.

This handler creates an ECO in Oracle EBS on the basis of the workflow job name.
The handler can be used in any task, preferably in action "Complete".

Note
The EBS logon data must be present and correct. This is best checked with the "T4O-validate-EBSLogon" rule handler.
Parameters
-check_EPM_TargetsIf set to TRUE, the handler reads data from each Workflow job target data additionally.
-UPDATE_EXISTINGIf set to FALSE, the ECO is created but not modified. The handler checks first if the ECO already exists and if it does, this handler aborts the transaction.
-use_EBS_systemIf set, T4O will use the Oracle EBS system stated as the value of this argument.
-use_EPM_objects_as_targetsWith this parameter it is possible to decide if the root_task (job) or the current_task of a workflow in the inbox is used as transfer object. Possible values are: root_task (Default) and current_task.
In addition the preference <ProductKey>_<TargetTypeName>TypeList needs to contain the type EPMTask.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4O-transfer-GenericObject()

T4O-transfer-GenericObject

Generic object transfer.

A configured Teamcenter object is transferred via a Teamcenter workflow to a specified EBS target object. In Oracle, the defined object is created or updated and depending on the business rules approved or rejected. The handler can be used in any task, preferably in action "Complete".
The business logic for the creation or update of the EBS object is defined and implemented by the customer in the corresponding mapping file.
Supported Objects: all Teamcenter POM object types and BOM Views in the case of a Structure based transfer. Note that for Generic Object handlers, the same concept of preferences for data extraction is used as for all out of the box object types. Also the data mapping for Generic Object handlers is done in the same way as for out of the box object types: Define the Generic Object mapping for a specific type in your own mapping file (don’t forget to source it in t4o_mapping_config.sd) in the following functions:

  • TC_Object2EBS_Object – for defining the data mapping from Teamcenter to Oracle EBS.
  • EBS_Object2TC_Object – for defining the back mapping from Oracle EBS to Teamcenter.
  • performTransfer – for customer specific definition of the actual transfer to EBS.
  • getObjectInfo – for retirieving the object information from EBS.
  • callCustomerRuleHandler – for defining the customer specific rule handler.
  • TC_Object2EBS_ObjectPosition – only needed for BOM views; for defining the BOM position mapping from Teamcenter to Oracle EBS

    Note
    The EBS logon data must be present and correct. This is best checked with the "T4O-validate-EBSLogon" rule handler.
    Parameters
    -add_related_objectsIf set to TRUE, the handler adds related object information as simulated BOM lines to the TcData buffer during the BOMView based data extraction. This means it combines the BOMView based with the BOM4REL based data extraction.
    -bom4rel_use_bomviewRequires -useBom4Realation4Transfer=TRUE. If parameter is set to TRUE, a BOM transfer based on BOM view information is done if BOM view exists.
    -Bom4RelationTargetTypeNameRequired for BOM transfers based on relation information. The parameter specifies the variable part of the preference names that is used to identify which structure needs to be transferred.
    -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.
    -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, ...).
    -check_EPM_TargetsIf set to TRUE, the handler reads data from each Workflow job target data additionally.
    -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_EBS_systemIf set, T4O will use the Oracle EBS system stated as the value of this argument.
    -use_EPM_objects_as_targetsWith this parameter it is possible to decide if the root_task (job) or the current_task of a workflow in the inbox is used as transfer object. Possible values are: root_task (Default) and current_task.
    In addition the preference <ProductKey>_<TargetTypeName>TypeList needs to contain the type EPMTask.
    -useBom4Relation4TransferRequired for BOM transfers. If set to TRUE, a BOM transfer is enabled based on relation information.
    -usePlmxml4TransferIf set to YES, all generic object handler calls are switched to an implementation that is using a PLMXML based implementation namespace. Default: NO.
    -useView4TransferRequired for BOM transfers. If set to TRUE, a BOM transfer is enabled based on BOM view information.
    -- - - - -
    -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 job attributes in the mapping.
    In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
    (Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
    -- - - - -
    -useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
    -- - - - -
    -collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
    -continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
    -on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
    -on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
    -on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
    -process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
    -target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
    -target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4O-transfer-Item()

T4O-transfer-Item

Create an item in Oracle EBS.

This handler creates or alters an item in Oracle EBS.
The handler can be used in any task, preferably in action "Complete".

Note
The EBS logon data must be present and correct. This is best checked with the "T4O-validate-EBSLogon" rule handler.
Parameters
-MODEL_BOMIf set to TRUE, the EBS item attribute "Bom Item Type" is set to "Model" instead of "Standard" (as by default).
-use_EBS_systemIf set, T4O will use the Oracle EBS system stated as the value of this argument.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4O-transfer-Item4BomLine()

T4O-transfer-Item4BomLine

Item transfer for each position of a bill of material.

This handler transfers from the currently selected Teamcenter BOM every position object as well as the BOM header object as Inventory item to Oracle EBS. This may be helpful because the EBS does not allow creating/updating a BOM if no items for the header and the components have been created yet. If required, this additional handler should be used before the standard T4O BOM handler T4O-transfer-BillOfMaterial.

Note
Same as the standard T4O BOM processing, this handler does not do anything with sub BOM levels but only with the objects in the current BOM level, i.e. the selected BOM header and its direct BOM positions.
Parameters
-use_EBS_systemIf set, T4O will use the Oracle EBS system stated as the value of this argument.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4O-transfer-Routing()

T4O-transfer-Routing

Routing transfer.

Transfers Routing Data extracted from the Application Interface Object found as target attachment of the current task to Oracle EBS. After the creation of the routing in Oracle EBS, group counter and group id information is written back into TC in the form attached to the CC Object contained in the Application Interface Object.
The handler can be used in any task, preferably in action "Complete".

Note
Works only for objects of type Application Interface Object. A form with at least to attributes ( for group counter and group id ) must be attached to the CC Object contained in the Application Interface Object.
The EBS logon data must be present and correct. This is best checked with the "T4O-validate-EBSLogon" rule handler.
Parameters
-use_EBS_systemIf set, T4O will use the Oracle EBS system stated as the value of this argument.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-add-Form2CC()

T4S-add-Form2CC

Add form to CC object.

This handler adds the form specified by handler argument FORM_TYPE to the CC object found as target attachment of current task. If handler argument ADD_AS_TARGET is also specified, the form will be added also as target attachment of the current task.
The handler can be used in any task, preferably in action "Complete".

Note
Works only for objects of type CC object.
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
Parameters
-ADD_AS_TARGETIf set to TRUE, the newly created form is added as a workflow target attachment. Otherwise the form is only attached to the CC.
-FORM_TYPEMandatory. The parameter specifies form type name of form to be added
-RESET_FORMIf set to TRUE, the content of the dorm is reset.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-create-Folder()

T4S-create-Folder

Create folder to manage workflow targets.

This handler creates a folder in order to manage workflow targets. The reason is that it adds all workflow targets into that new created workflow folder and deletes all that finished OK, so in case of an error the current target is not deleted from that folder so it can be checked easily which target had an error: those that are still in that folder.
The handler can be used in any task, preferably in action "Complete".

Parameters
-sap_object_typeThis parameter specifies the object types. Possible values are: MM, DIR, BOM, ECN (in different possible combinations, colon separated), or "all"
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-define-PreferredSapSystem()

T4S-define-PreferredSapSystem

Define the preferred SAP connection.

This handler defines the preferred SAP connection for all following transfer handlers, i.e. as long as no other SAP connection is given, this one will be used.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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-SessionProxy()

T4S-SessionProxy

Manages a proxy to forward the SAP login data.

This handler manages a proxy to forward the SAP login data between different TC users if they are involved in one workflow, i.e. only the first user will have to type his or her SAP login data and every SAP transaction in the same Workflow job will be done with the same SAP user. Add "-Mode=Save" after the SAP Logon Task. If another TC user gets the workflow (e.g. a reviewer), add "-Mode=READ" in his task to enable him sending data to SAP with the same SAP user as the TC user who started the workflow without the need to login separately. As then, this TC user automatically uses the same SAP login outside of any Workflow, too, you should add "-Mode=FORGET" to avoid that. This can also be used to restore the previous preferred connection.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler before the T4S-SessionProxy called with the -Mode=Save argument.
Do not use this handler with "-Mode=Forget" in a Workflow Task that is executed before the Workflow is shifted to another Teamcenter user (e.g. a generic T4S job user), because this would delete the current user’s SAP login (for Workflow and interactive use as well).
Parameters
-ModePossible values are:
  • SAVE saves the current ESAP login into a T4S proxy
  • READ reads the EA login from a T4EA proxy
  • FORGET deletes the logon data from the T4S proxy without deleting the T4S Proxy itself
  • DELETE deletes a T4S proxy (*)
    (*) The difference is that after FORGET the login data are not used automatically again, but they may be reused with the argument -Mode=READ; after a DELETE, they cannot be restored.

◆ T4S-transfer-BillOfMaterial()

T4S-transfer-BillOfMaterial

Bill of materials transfer to SAP.

This handler transfers for each configured BOM view type a defined bill of materials to SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-BillOfMaterial4Relation()

T4S-transfer-BillOfMaterial4Relation

Bill of materials transfer based on a TC relation based structure.

This handler creates or changes a SAP bill of materials based on a TC relation based structure (instead of using a TC bom view).
The handler can be used in any task, preferably in action "Complete".

Parameters
-add_related_objectsIf set to TRUE, the handler adds related object information as simulated BOM lines to the TcData buffer during the BOMView based data extraction. This means it combines the BOMView based with the BOM4REL based data extraction.
-bom4rel_use_bomviewRequires -useBom4Realation4Transfer=TRUE. If parameter is set to TRUE, a BOM transfer based on BOM view information is done if BOM view exists.
-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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-BusinessPartner()

T4S-transfer-BusinessPartner

Create or change a business partner in SAP S/4HANA.

This handler creates or changes a business partner in SAP S/4HANA system.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-CC-BOM()

T4S-transfer-CC-BOM

CC Bill of materials transfer.

Transfers MBOM Data extracted from the Application Interface Object found as target attachment of the current task to SAP.
The handler can be used in any task, preferably in action "Complete".

Note
Works only for objects of type Application Interface Object.
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-ChangeNumber()

T4S-transfer-ChangeNumber

Create a change number in SAP.

This handler creates a change number in SAP on the basis of the workflow job name.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
Parameters
-check_EPM_TargetsIf set to TRUE, the handler reads data from each Workflow job target data additionally.
-UPDATE_EXISTINGIf set to FALSE, the ECM is created but not modified. The handler checks first if the ECM already exists and if it does, this handler aborts the transaction.
-use_EPM_objects_as_targetsWith this parameter it is possible to decide if the root_task (job) or the current_task of a workflow in the inbox is used as transfer object. Possible values are: root_task (Default) and current_task.
In addition the preference <ProductKey>_<TargetTypeName>TypeList needs to contain the type EPMTask.
-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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-DocumentInfoRecord()

T4S-transfer-DocumentInfoRecord

Create or change a document info record in SAP.

This handler creates a new document info record in SAP for a given data set with all the metadata (including the original files).
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
Parameters
-documentstructurePossible values are:
  • YES - create/update the document structure of the DIR.
  • NO (default) - do not update the document structure of the DIR.
-metadataPossible values are:
  • YES (default) - create/update the metadata of the DIR.
  • NO - do not update the metadata of the DIR.
-modePossible values are:
  • CREATE - the DIR is only created, not updated (if the DIR already exists the workflow stops with an error).
  • UPDATE (default) - create the DIR or update it if it exists.
-objectlinksPossible values are:
  • YES (default) - create/update the object links of the DIR.
  • NO - do not update the object links of the DIR.
-ORIGINALSPossible values are:
  • YES (default) - create/update the original data (i.e. the files) of the DIR.
  • NO - do not update the original data (i.e. the files) of the DIR.
-process_target_datasetRestricted to T4S. If set to TRUE, T4S processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-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.
-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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-DocumentStructure4BomView()

T4S-transfer-DocumentStructure4BomView

Document structure transfer to SAP.

This handler transfers for each configured BOM view type a defined document structure to SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-EquiBillOfMaterial()

T4S-transfer-EquiBillOfMaterial

Equipment bill of materials transfer to SAP.

This handler transfers for each configured BOM view type a defined equipment bill of materials to SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-EquipmentMaster()

T4S-transfer-EquipmentMaster

Create or change an equipment master record in SAP.

This handler creates or changes an equipment master record in SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-FunctionalLocation()

T4S-transfer-FunctionalLocation

Create or change a functional location master record in SAP.

This handler creates or changes a functional location master record in SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-FunctionalLocationBillOfMaterial()

T4S-transfer-FunctionalLocationBillOfMaterial

Functional location bill of materials transfer to SAP.

This handler transfers for each configured BOM view type a defined functional location bill of materials to SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-GenericObject()

T4S-transfer-GenericObject

Generic object transfer.

A configured Teamcenter object is transferred via a Teamcenter workflow to a specified SAP target object. In SAP, the defined object is created or updated and depending on the business rules approved or rejected. The business logic for the creation or update of the SAP object is defined and implemented by the customer in the corresponding mapping file.
Supported Objects: all Teamcenter POM object types and BOM Views in the case of a Structure based transfer. Note that for Generic Object handlers, the same concept of preferences for data extraction is used as for all other out of the box object types.
Also the data mapping for Generic Object handlers is done in the same way as for out of the box object types: Define the Generic Object mapping for a specific type in your own mapping file (don not forget to source it in t4s_mapping_config.sd) in the following functions:

  • TC_Object2SAP_Object – for defining the data mapping from Teamcenter to SAP
  • TC_Object2SAP_ObjectPosition – for defining the data mapping from Teamcenter BOM Position to SAP. Only for BOM views.
  • SAP_Object2TC_Object – for defining the back mapping from SAP to Teamcenter
  • performSapTransfer – for customer specific definition of the actual transfer to SAP
  • getObjectInfo – for retirieving the object information from SAP
  • callCustomerRuleHandler – for defining a customer specific rule handler

    Note
    The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
    Parameters
    -add_related_objectsIf set to TRUE, the handler adds related object information as simulated BOM lines to the TcData buffer during the BOMView based data extraction. This means it combines the BOMView based with the BOM4REL based data extraction.
    -bom4rel_use_bomviewRequires -useBom4Realation4Transfer=TRUE. If parameter is set to TRUE, a BOM transfer based on BOM view information is done if BOM view exists.
    -Bom4RelationTargetTypeNameRequired for BOM transfers based on relation information. The parameter specifies the variable part of the preference names that is used to identify which structure needs to be transferred.
    -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.
    -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, ...).
    -check_EPM_TargetsIf set to TRUE, the handler reads data from each Workflow job target data additionally.
    -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_EPM_objects_as_targetsWith this parameter it is possible to decide if the root_task (job) or the current_task of a workflow in the inbox is used as transfer object. Possible values are: root_task (Default) and current_task.
    In addition the preference <ProductKey>_<TargetTypeName>TypeList needs to contain the type EPMTask.
    -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.
    -useBom4Relation4TransferRequired for BOM transfers. If set to TRUE, a BOM transfer is enabled based on relation information.
    -usePlmxml4TransferIf set to YES, all generic object handler calls are switched to an implementation that is using a PLMXML based implementation namespace. Default: NO.
    -useView4TransferRequired for BOM transfers. If set to TRUE, a BOM transfer is enabled based on BOM view information.
    -- - - - -
    -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 job attributes in the mapping.
    In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
    (Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
    -- - - - -
    -useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
    -- - - - -
    -collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
    -continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
    -on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
    -on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
    -on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
    -process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
    -target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
    -target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-iPPE-Node4BomLine()

T4S-transfer-iPPE-Node4BomLine

Bill of materials transfer to iPPE structure node in SAP.

This handler transfers all BOM lines to the corresponding iPPE structure node in SAP, so that the selection conditions and the assigned material can be updated in SAP.
The handler can be used in any task, preferably in action "Complete".

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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-iPPE-Structure()

T4S-transfer-iPPE-Structure

Bill of materials transfer to iPPE structure node in SAP.

This handler transfers all BOM lines to the corresponding iPPE structure node in SAP, so that the selection conditions and the assigned material can be updated in SAP.
The handler can be used in any task, preferably in action "Complete".

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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-MaterialMaster()

T4S-transfer-MaterialMaster

Create or change a material master record in SAP.

This handler creates or changes a material master record in SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-MaterialMaster4BomLine()

T4S-transfer-MaterialMaster4BomLine

Create a material master record in SAP for every Bill of materials position.

This handler transfers from the currently selected Teamcenter BOM every position object as well as the BOM header object as Material Master to SAP. This may be helpful because SAP does not allow creating/updating a BOM with a position that is not a SAP MM yet. So if it is requested then this additional handler should be used before the standard T4S BOM handler.

Note
Same as the standard T4S BOM processing, this handler does not do anything with sub BOM levels
but only with the objects in the current BOM level, i.e. the selected BOM header and its direct BOM positions.
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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-OrderBillOfMaterial()

T4S-transfer-OrderBillOfMaterial

Order bill of materials transfer to SAP.

This handler transfers for each configured BOM view type a defined order bill of materials to SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-PIR()

T4S-transfer-PIR

Create or change a purchase info record in SAP.

This handler creates or changes a purchase info record in SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-Routing()

T4S-transfer-Routing

Routing transfer.

Transfers Routing Data extracted from the Application Interface Object found as target attachment of the current task to SAP. After the creation of the routing in SAP, group counter and group id information is written back into TC in the form attached to the CC Object contained in the Application Interface Object.
The handler can be used in any task, preferably in action "Complete".

Note
Works only for objects of type Application Interface Object. A form with at least to attributes ( for group counter and group id ) must be attached to the CC Object contained in the Application Interface Object.
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
Parameters
-TargetThis parameter is used to select the specific target routing type in SAP. Possible values are:
  • Routing (default)
  • InspectionPlan
  • RefSetOfOperations
-use_ai_as_targetIf set to TRUE, the AI object based PLMXML transfer is enabled instead of the routing net change functionality. Currently only used in the context of the T4S routing transfer.
-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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-Schedule()

T4S-transfer-Schedule

Create or change a schedule in SAP.

This handler creates or changes a schedule in SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-VariantCharacteristic()

T4S-transfer-VariantCharacteristic

Create a characteristic in SAP.

This handler creates a characteristic in SAP based on an OptionFamily in context of Teamcenter Product Configurator.

Parameters
-revision_ruleThis parameter specifies the revision rule name that should be applied to the product configuratior context during the transfer.
-revision_rule_preferenceThis parameter specifies the name of a preference that configures the revision rule name that should be applied to the product configuratior context during the transfer. This approach allows a revision rule name change without changing the workflow template.
-revision_rule_relationThis parameter specifies the relation from the transfer target object to an attached revision rule that should be applied to the product configuratior context during the transfer.
-revision_rule_relation_preferenceThis parameter specifies the name of a preference that configures the relation from the transfer target object to an attached revision rule that should be applied to the product configuratior context during the transfer. This approach allows to change the relation to the revisions rule without changing the workflow template.
-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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-VariantClass()

T4S-transfer-VariantClass

Create a class of type 300 in SAP.

This handler creates a class of type 300 in SAP based on a Dictionary or a Configurator context in context of Teamcenter Product Configurator. The characteristics which correspond to Teamcenter OptionFamilies are linked to the class.

Parameters
-revision_ruleThis parameter specifies the revision rule name that should be applied to the product configuratior context during the transfer.
-revision_rule_preferenceThis parameter specifies the name of a preference that configures the revision rule name that should be applied to the product configuratior context during the transfer. This approach allows a revision rule name change without changing the workflow template.
-revision_rule_relationThis parameter specifies the relation from the transfer target object to an attached revision rule that should be applied to the product configuratior context during the transfer.
-revision_rule_relation_preferenceThis parameter specifies the name of a preference that configures the relation from the transfer target object to an attached revision rule that should be applied to the product configuratior context during the transfer. This approach allows to change the relation to the revisions rule without changing the workflow template.
-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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-VariantValueRestriction()

T4S-transfer-VariantValueRestriction

Restrict characteristic values for a SAP class.

This handler restricts characteristic values for a SAP class in context of Teamcenter Product Configurator. If in Teamcenter a Product Context Option contains less values than the Dictionary Option this will be represented in SAP by a Constraint of type restriction and a Variant Table which limits the available values.

Parameters
-revision_ruleThis parameter specifies the revision rule name that should be applied to the product configuratior context during the transfer.
-revision_rule_preferenceThis parameter specifies the name of a preference that configures the revision rule name that should be applied to the product configuratior context during the transfer. This approach allows a revision rule name change without changing the workflow template.
-revision_rule_relationThis parameter specifies the relation from the transfer target object to an attached revision rule that should be applied to the product configuratior context during the transfer.
-revision_rule_relation_preferenceThis parameter specifies the name of a preference that configures the relation from the transfer target object to an attached revision rule that should be applied to the product configuratior context during the transfer. This approach allows to change the relation to the revisions rule without changing the workflow template.
-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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-Vendor()

T4S-transfer-Vendor

Create or change a vendor in SAP.

This handler creates or changes a vendor in SAP.
The handler can be used in any task, preferably in action "Complete".

Note
The SAP logon data must be present and correct. This is best checked with the "T4S-validate-SAPLogon" rule handler.
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.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4S-transfer-WBS-BillOfMaterial()

T4S-transfer-WBS-BillOfMaterial

Bill of materials transfer to work breakdown structure bom in SAP.

This handler transfers for each configured BOM view type a defined work breakdown structure bill of materials to SAP.
The handler can be used in any task, preferably in action "Complete".

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.
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4X-attach-RevisionRule()

T4X-attach-RevisionRule

Attaches a dynamically created revision rule to an workflow job.

The handler can be used in any task, preferably in action "Start" of the perform-signoff task. It is also possible to use the handler in a DO-task as well. This handler creates a dynamic revision rule and attaches it to the current workflow job for telling another T4x handler later in the same workflow job how to find the desired data from Teamcenter. This allows T4x handling the Teamcenter BOM occurrence effectivity in a more flexible way than the standard fix defined revision rules
The "last_release_status" is a real Teamcenter release status and this value determines if T4x should use the date, the unit or the end_item of that Teamcenter status object. In contrast to that, the "EPM_release_status_attachment" is a temporary status object attached by T4x; the effectivity determination by the status date, unit or the end_item of that status object works the same. If no argument is specified the handler returns with an error message.

The handler can be used in any task, preferably in action "Complete". Example how to use this handler for a T4S BOM workflow in order to use the dynamic revision rule "MyRevRule": set three handlers in the "Complete" action of a T4S BOM workflow task with the handler arguments as stated here: That means a new revision rule is created based on the revision rule template "MyRevRule", it is attached to the workflow target and used by the T4S BOM handler. The third handler will remove the revision rule then If the argument "-input" has last_release_status set as the first part of the string, the data will be retrieved from the effectivity of the status set in the last_release_status attribute. If the first part of the argument "-input" value is EPM_release_status_attachment, the data will be retrieved from the effectivity of the status created in the workflow and attached as EPM_release_status_attachment. The second part of the "-input" value describes type of data which shall be read and used:

  • date stands for the effectivity date
  • unit stands for the effectivity unit
  • end_item stands for the effectivity end_item
2  -mode=add
3  -use_rev_rule=MyRevRule
4  -rev_rule_relation=IMAN_reference
5  -input=last_release_status:date
7  -use_attached_rev_rule=true
9  -mode=delete
10  -rev_rule_relation=IMAN_reference


Note
As for now for retrieving the data the first found effectivity and date will be used!
Parameters
-modePossible values are:
  • ADD (default) will attach the specified revision rule to current workflow target.
  • DELETE will remove the attached revision rule from the workflow target and delete it from the data base.
-rev_rule_relationThis parameter specifies the relation name or reference attribute that is used to attach the revision rule to the workflow job (required).
-use_dateIf set to TRUE, the date effectifty information is copied from the ReleaseStatus object found via the -use_status_relation argument to the temporary Revision Rule.
-use_end_itemIf set to TRUE, the end item effectifty information is copied from the ReleaseStatus object found via the -use_status_relation argument to the temporary Revision Rule.
-use_rev_ruleThis parameter specifies the revision rule template name that is required by the -mode=add argument.
-use_status_relationThis parameter specifies the relation to the Teamcenter ReleaseStatus object that is used as input for the temporary Revision Rule.
-use_unitIf set to TRUE, the unit effectifty information is copied from the ReleaseStatus object found via the -use_status_relation argument to the temporary Revision Rule.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4X-copy-Attributes-to-Task()

T4X-copy-Attributes-to-Task

Copy attributes to task object.

This handler copies the given literal value to the given attribute of the task object. In T4EA this handler is used to pass static values to the GUI, especially the EA connection identifier. The handler is not restricted to T4EA, however. The handler can be used in any action, preferably in action "Start".
Every argument name is interpreted as the internal name of an attribute of the EPM task object, this handler is attached to.
Example: the argument "-eax2TargetTypeName=Article" will cause the handler to write the value "Article" to the attribute named "eax2TargetTypeName" of the EPMTask. This attribute only exists on a specific derivation of EPMTask on the type EAX2LogonTask. With this functionality it is possible to configure a workflow to choose an EA connection that is compatible with the given TargetTypeName. The GUI will restrict the logon dialog to the corresponding connections.
Here is a type-independent example: "-object_name=My special task" will set the task name to "My special task" at runtime.

Parameters
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4X-create-AIObject4CC()

T4X-create-AIObject4CC

Create an Application Interface Object.

This handler creates an Application Interface Object of type specified in handler argument for the CC Object found as target attachment of the current task.
The handler can be used in any task, preferably in action "Complete".

Note
Works only for objects of type CC object.
Parameters
-AI_TYPEDefines the resulting Application Interface Object Type Name that should be created based on the profived target objects. Example:
-AI_TYPE=EBS2AI4Routing Mandatory: Application Interface Object Type Name
-ProductFlavorStores the string to the job attribute JobFilter which can be used to control which job agent may execute the job.
-TargetTypeNameStores the string to the job attribute JobFilter which can be used to control which job agent may execute the job.
-use_cc_nameIf set to TRUE, the name of the newly created AI object is based on the CC object that is used as an input for the AI object. We recommend setting this to true.
-use_export_transfer_modeName of the PLMXML export transfer mode. The parameter overwrites the defined default name of the PLMXML export transfer mode for the Application Interface Object Type. The PLMXML export transfer type is defined in Teamcenter internally in the PLMXML application.
-use_import_transfer_modeName of the PLMXML import transfer mode. The parameter overwrites the defined default name of the PLMXML import transfer mode for the Application Interface Object Type. The PLMXML import transfer type is defined in Teamcenter internally in the PLMXML application.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.

◆ T4X-create-T4X-BatchJob()

T4X-create-T4X-BatchJob

This handler creates a job in the T4x BGS environment.

No mandatory arguments, all handler arguments are optional.
The handler can be used in any task, preferably in action "Start" of the perform-signoff task. It is also possible to use the handler in a DO-task as well.

Parameters
-FilterStores the string to the job attribute JobFilter which can be used to control which job agent may execute the job.
-JobNamePrefixThis will manipulate the job name in the job queue. Use this to be able to differentiate by job name which workflow created the job.
Valid Keywords:
  • $SITE
  • $USERID
  • $USERNAME
  • $GROUP
  • $ROLE
-JobPrioInteger argument assigns a priority specifically to the workflow job different from the default value 50. A lower value signifies a higher priority. Jobs with high priority are executed first.
-JobTimeoutAssigns the timeout value in seconds for the job. If a job execution is not finished in the time frame the job will abort with status RUNTIME ERROR.
-tc_userSets the job attribute ITK_TC_USER_ID to a specific TC user to use for the ITK connection of the job. The following values are supported:
  • SelectedReviewer: Evaluate the user specified in workflow argument -reviewer of TC OOTB action handler EPM-fill-in-reviewers used in preceding Review Task.
  • ResponsibleParty (default): Evaluate the user specified in workflow argument -assignee of TC OOTB action handler EPM-auto-assign used in preceding Do Task.
-TimeWindowEndSets the job attribute Time Window End (Format [hh:mm:ss]) to define the time of last possible execution of the job per day. If not set default value is 00:00:00 meaning the job may be executed at any time.
-TimeWindowStartSets the job attribute Time Window Begin (Format [hh:mm:ss]) to define the time of first possible execution of the job per day. If not set default value is 00:00:00 meaning the job may be executed at any time.

◆ T4X-SessionProxy()

T4X-SessionProxy

Manage a proxy to store and reset preferred connections during a workflow.

This handler manages preferred connection settings while a workflow is executed. It stores the current settings when called with "-Mode=SAVE" and restores these settings when called with "-Mode=RESTORE". Option "-ProductKey=..." can specify a certain T4x product or type of connections for which the preferred connection is supposed to be (re-)stored. If it is not specified, preferred connections will be (re-)stored for all T4x products within the installation.
The handler can be used in any task, preferably in actions "Start" and "Complete".

Note
A change in preferred connection settings outside the workflow while this is still not completed may be changed again by the workflow's preferred connection RESET on workflow completion.
The EA logon data must be present and correct. This is best checked with the "T4X-validate-EALogon" rule handler before the T4X-SessionProxy is called with the -Mode=SAVE argument.
Parameters
-ModePossible values are:
  • SAVE - saves the current EA login into a product specific proxy.
  • RESTORE - restores the EA login from a product specific proxy.
-ProductKey(optional) The parameter can specify a T4x product, e.g. T4S. If a product is specified, the action is only performed for the specified product, resp. type of connection.

◆ T4X-transfer-GenericObject4TargetType()

T4X-transfer-GenericObject4TargetType

Generic object transfer based on the specified arguments.

No mandatory arguments, all handler arguments are optional.

Parameters
-add_related_objectsIf set to TRUE, the handler adds related object information as simulated BOM lines to the TcData buffer during the BOMView based data extraction. This means it combines the BOMView based with the BOM4REL based data extraction.
-bom4rel_use_bomviewRequires -useBom4Realation4Transfer=TRUE. If parameter is set to TRUE, a BOM transfer based on BOM view information is done if BOM view exists.
-Bom4RelationTargetTypeNameRequired for BOM transfers based on relation information. The parameter specifies the variable part of the preference names that is used to identify which structure needs to be transferred.
-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, ...).
-check_EPM_TargetsIf set to TRUE, the handler reads data from each Workflow job target data additionally.
-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_EPM_objects_as_targetsWith this parameter it is possible to decide if the root_task (job) or the current_task of a workflow in the inbox is used as transfer object. Possible values are: root_task (Default) and current_task.
In addition the preference <ProductKey>_<TargetTypeName>TypeList needs to contain the type EPMTask.
-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.
-useBom4Relation4TransferRequired for BOM transfers. If set to TRUE, a BOM transfer is enabled based on relation information.
-usePlmxml4TransferIf set to YES, all generic object handler calls are switched to an implementation that is using a PLMXML based implementation namespace. Default: NO.
-useView4TransferRequired for BOM transfers. If set to TRUE, a BOM transfer is enabled based on BOM view information.
-- - - - -
-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 job attributes in the mapping.
In mapping get the job attribute from the TcData buffer, e.g. set GovClassification $TcData(RootTask:root_task:EPMTask:gov_classification)
(Check preferences T4X_Property2IgnoreList4EPMTask and T4X_Property2ProcessList4EPMTask for the attribute and adapt them accordingly).
-- - - - -
-useSpecialModeIf set to REVERSEMAPPINGONLY, the handler skips the transfer after the mapping and calls directly the reverse mapping procedure.
-- - - - -
-collect_all_errorsIf set to TRUE, all attached workflow targets are processed without stop until all targets are processed. Then the whole set of errors can be handled together.
-continue_on_errorIf set to TRUE, the handler does not stop in case of an T4x error (i.e. Teamcenter error number range 212000 to 212999 which is reserved for T4X).
-on_error_set_task_resultIf set to TRUE, the parameter enables the update of the EPM Task result property in the error case.
-on_error_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was not successful. If not specified the value "Unable_to_complete" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-on_ok_use_task_resultThis parameter defines the string that is stored to the EPM Task result property if the transfer was successful. If not specified the value "Completed" is used. Prerequisite is that the argument -on_error_set_task_result=true.
-process_target_datasetRestricted to T4S. If set to TRUE, the handler processes a Dataset as a workflow target (by default it uses an Item Revision only). Note that only Dataset types are used which are in the preference T4S_DocumentInfoRecordTypeList and it only works correctly if that Dataset is stored in an Item type with the references defined in the DIR mapping preferences for that Dataset type.
-target_condition_preferenceWith this parameter T4x will use the conditions defined by the specified preference to validate the BMIDE condition against the selected target object.
-target_condition_preference_prefixThis prefix is extended by the object_type name to generate the final preference name to retrieve the condition name <Preference Prefix><TransferObjectTypeName>.