T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
T4X::TEST::WORKFLOW Namespace Reference

Functions

 createBatchJob4Workflow JobName JobDescription TriggerComment ProcessName ObjectTagList ?JobFilter? args
 Creates an batch job to run an work flow task. More...
 
 executeTcWorkflowJob JobName JobDescription TriggerComment ProcessName ObjectTagList ?RunMode? args
 This testscript is used to test automaticaly a T4X workflow template, this is done by the following steps: 1) Creation of a new Teamcenter process with the new created object as a target 2) Triggering the complete action of the workflow. More...
 
 runTemplateTest SapObjectType item_id item_rev_id object_name JobName JobDescription TriggerComment ProcessName args
 This testscript is used to test automaticaly a T4X workflow template, this is done by the following steps: 1) Creation of a new Teamcenter Object/ItemRevision 2) Creation of a new Teamcenter process with the new created object as a target 3) Triggering the complete action of the workflow 4) Verification of the results (not yet implemented) More...
 

Variables

 BatchjobDefaults
 

Function Documentation

◆ createBatchJob4Workflow()

T4X::TEST::WORKFLOW::createBatchJob4Workflow   JobName JobDescription TriggerComment ProcessName ObjectTagList ?JobFilter? args  

Creates an batch job to run an work flow task.

Parameters
JobName- name of the work flow to be created
JobDescription- description of the work flow to be created
TriggerComment- comment for the triggering the work flow
ProcessName- work flow template name
ObjectTagList- Tags of objects which are set as the work flow targets
JobFilter- (optional) default set to TEST
Returns
Status - OK / ERROR

References API::Core::Batch::connectTo(), API::Core::Batch::createJob(), API::Core::Batch::createObject(), API::Core::Batch::disconnect(), T4X::CORE::getSessionLogChannel(), API::Core::Batch::setObjectAttribute(), and tpwrite().

◆ executeTcWorkflowJob()

T4X::TEST::WORKFLOW::executeTcWorkflowJob   JobName JobDescription TriggerComment ProcessName ObjectTagList ?RunMode? args  

This testscript is used to test automaticaly a T4X workflow template, this is done by the following steps: 1) Creation of a new Teamcenter process with the new created object as a target 2) Triggering the complete action of the workflow.

Parameters
JobName- name of the work flow to be created
JobDescription- desription of the work flow to be created
TriggerComment- comment for the triggering the work flow
ProcessName- work flow template name
ObjectTagList- Tags of objects which are set as the workflow targets
RunMode- (optional) default set to BatchJob
Returns
Status - OK / UNKNOWN

References ITK::connect2TcDB(), ITK::EPM_ask_root_task(), ITK::EPM_ask_task_state_string(), ITK::EPM_create_process(), ITK::EPM_trigger_action(), T4X::CORE::getSessionLogChannel(), T4X::CORE::initStatusInfo(), T4X::CORE::resetLastErrorMessage(), ITK::setDefaultLogChannel(), tpco_formatHEX16(), tpwrite(), and T4X::CORE::writeVersionInfo2LogChannel().

◆ runTemplateTest()

T4X::TEST::WORKFLOW::runTemplateTest   SapObjectType item_id item_rev_id object_name JobName JobDescription TriggerComment ProcessName args  

This testscript is used to test automaticaly a T4X workflow template, this is done by the following steps: 1) Creation of a new Teamcenter Object/ItemRevision 2) Creation of a new Teamcenter process with the new created object as a target 3) Triggering the complete action of the workflow 4) Verification of the results (not yet implemented)

Parameters
SapObjectType- DIR / MM / BOM / EQUIBOM / ORDERBOM / ECM / FUNCLOC / EQUI
item_id- id of the new item to be created and used as workflow target
item_rev_id- revision of the new item revision to be created and used as workflow target
object_name- name of the new item to be created and used as workflow target
JobName- name of the work flow to be created
JobDescription- desription of the work flow to be created
TriggerComment- comment for the triggering the work flow
ProcessName- work flow template name
Returns
none

References ITK::connect2TcDB(), T4X::CUSTOM::MAPPING::TOOLBOX::createTC_Object(), ITK::EPM_add_attachment4JobTag(), ITK::EPM_ask_root_task(), ITK::EPM_ask_task_state_string(), ITK::EPM_create_process(), ITK::EPM_trigger_action(), ITK::getObjectMetaData(), ITK::getPreference(), and tpco_formatHEX16().

Variable Documentation

◆ BatchjobDefaults

BatchjobDefaults
static