T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
EPM ITK functions

All ITK functions of group EPM supported by T4x. More...

Functions

 EPM_add_attachment4JobTag JobTag AttachmentType TcObjectTag
 This function calls the ITK pipe server function EPM_add_attachment4JobTag to add a Teamcenter object tag to a given job tag. More...
 
 EPM_ask_assigned_tasks
 This function calls the ITK pipe server function EPM_ask_assigned_tasks to retrieve the content of the users in-box. More...
 
 EPM_ask_name TaskTag
 This function calls the ITK pipe server function EPM_ask_name to get the object name of a given task tag. More...
 
 EPM_ask_parent_processes SubProcessTag
 This function calls the ITK pipe server function EPM_ask_parent_processes to get parent processes tags. More...
 
 EPM_ask_procedure_name TaskTag
 This function calls the ITK pipe server function EPM_ask_procedure_name to get the procedure name of a given task tag. More...
 
 EPM_ask_process_template TaskTag
 This function calls the ITK pipe server function EPM_ask_process_template to get the process template of a given task tag. More...
 
 EPM_ask_root_task JobTag
 This function calls the ITK pipe server function EPM_ask_root_task to retrieve the root task of a given job tag. More...
 
 EPM_ask_sub_processes ParentProcessTag
 This function calls the ITK pipe server function EPM_ask_sub_processes to get sub processes tags. More...
 
 EPM_ask_task_state_string TaskTag
 This function calls the ITK pipe server function EPM_ask_task_state_string to get the state name of a given task tag. More...
 
 EPM_create_process JobName JobDescription ProcessTemplateName TcObjectTag1 AttachmentType1 ...
 This function calls the ITK pipe server function EPM_create_process to create a new Teamcenter work-flow job. More...
 
 EPM_create_process_deferred_start Name Description TemplateTag AttachementType1 AttachementTag1 ...
 This function calls the ITK pipe server function EPM_create_process_deferred_start to create a new process with the name, description, process template tag, and attachments the newly created process will NOT start. The attachment specification is optional and could be done in an extra step via the ITK::EPM_add_attachment4JobTag call. More...
 
 EPM_demote_task TaskTag Comment
 This function calls the ITK pipe server function EPM_demote_task to trigger the demote action for the given task. More...
 
 EPM_find_process_template ProcessTemplateName
 This function calls the ITK pipe server function EPM_find_process_template to get sub process template tag. More...
 
 EPM_get_person_email_addr HexUserName
 This function calls the ITK pipe server function EPM_get_person_email_addr to get the email address of a given user name. More...
 
 EPM_get_type_tasks TaskTag HexTaskType
 This function calls the ITK pipe server function EPM_get_type_tasks to get the object name of a given task tag. More...
 
 EPM_get_user_email_addr HexUserTag
 This function calls the ITK pipe server function EPM_get_user_email_addr to get the email address of a given userTag. More...
 
 EPM_is_valid_performer TaskTag
 This function calls the ITK pipe server function EPM_is_valid_performer to get the information that the current user is the valid performer of the given task tag. More...
 
 EPM_promote_task TaskTag Comment
 This function calls the ITK pipe server function EPM_promote_task to trigger the promote action for the given task. More...
 
 EPM_remove_task_hold TaskTag
 This function calls the ITK pipe server function EPM_remove_task_hold to remove the hold on the DoTask. More...
 
 EPM_set_decision TaskTag Decision DecisionComment AutoComplete
 This function calls the ITK pipe server function EPM_set_decision to set the decision of a perform sign-off or review task. More...
 
 EPM_trigger_action JobTag Action Comment
 This function calls the ITK pipe server function EPM_trigger_action to trigger a given work-flow job in the users in-box. More...
 

Detailed Description

All ITK functions of group EPM supported by T4x.

This group specifies all ITK functions of group EPM for which wrappers have been defined in T4x

Function Documentation

◆ EPM_add_attachment4JobTag()

ITK::EPM_add_attachment4JobTag   JobTag AttachmentType TcObjectTag  

This function calls the ITK pipe server function EPM_add_attachment4JobTag to add a Teamcenter object tag to a given job tag.

Parameters
JobTagTcl representation of the Teamcenter job tag
AttachmentTypeEPM_reference_attachment, EPM_target_attachment or EPM_signoff_attachment
TcObjectTagTcl representation of the Teamcenter object tag (e.g. ItemRevision tag)
Returns
ITK_ok (=0) or list of ITK status and error message

Referenced by T4X::TEST::WORKFLOW::runTemplateTest().

◆ EPM_ask_assigned_tasks()

ITK::EPM_ask_assigned_tasks

This function calls the ITK pipe server function EPM_ask_assigned_tasks to retrieve the content of the users in-box.

Returns
ITK_ok (=0) and list of assigned tasks or list of ITK status and error message

◆ EPM_ask_name()

ITK::EPM_ask_name   TaskTag  

This function calls the ITK pipe server function EPM_ask_name to get the object name of a given task tag.

Parameters
TaskTagTcl representation of the Teamcenter task tag
Returns
ITK_ok (=0) and procedure name or list of ITK status and error message

◆ EPM_ask_parent_processes()

ITK::EPM_ask_parent_processes   SubProcessTag  

This function calls the ITK pipe server function EPM_ask_parent_processes to get parent processes tags.

Parameters
SubProcessTagTcl representation of the Teamcenter sub process tag
Returns
ITK_ok (=0) and list of parents processes tags or list of ITK status and error message

◆ EPM_ask_procedure_name()

ITK::EPM_ask_procedure_name   TaskTag  

This function calls the ITK pipe server function EPM_ask_procedure_name to get the procedure name of a given task tag.

Parameters
TaskTagTcl representation of the Teamcenter task tag
Returns
ITK_ok (=0) and procedure name or list of ITK status and error message

◆ EPM_ask_process_template()

ITK::EPM_ask_process_template   TaskTag  

This function calls the ITK pipe server function EPM_ask_process_template to get the process template of a given task tag.

Parameters
TaskTagTcl representation of the Teamcenter task tag
Returns
ITK_ok (=0) and process template tag or list of ITK status and error message

◆ EPM_ask_root_task()

ITK::EPM_ask_root_task   JobTag  

This function calls the ITK pipe server function EPM_ask_root_task to retrieve the root task of a given job tag.

Parameters
JobTag,Tclrepresentation of the Teamcenter job tag
Returns
List of ITK_ok (=0) and tag of the root task or list of ITK status and error message

Referenced by T4X::TEST::WORKFLOW::executeTcWorkflowJob(), and T4X::TEST::WORKFLOW::runTemplateTest().

◆ EPM_ask_sub_processes()

ITK::EPM_ask_sub_processes   ParentProcessTag  

This function calls the ITK pipe server function EPM_ask_sub_processes to get sub processes tags.

Parameters
ParentProcessTagTcl representation of the Teamcenter parent process tag
Returns
ITK_ok (=0) and list of sub processes tags or list of ITK status and error message

◆ EPM_ask_task_state_string()

ITK::EPM_ask_task_state_string   TaskTag  

This function calls the ITK pipe server function EPM_ask_task_state_string to get the state name of a given task tag.

Parameters
TaskTag,Tclrepresentation of the Teamcenter task tag
Returns
ITK_ok (=0) and state name or list of ITK status and error message

Referenced by T4X::TEST::WORKFLOW::executeTcWorkflowJob(), findStartedSuccessorTask(), and T4X::TEST::WORKFLOW::runTemplateTest().

◆ EPM_create_process()

ITK::EPM_create_process   JobName JobDescription ProcessTemplateName TcObjectTag1 AttachmentType1 ...  

This function calls the ITK pipe server function EPM_create_process to create a new Teamcenter work-flow job.

Parameters
JobName
JobDescription
ProcessTemplateName
TcObjectTag1Tcl representation of the Teamcenter object tag (e.g. ItemRevision tag)
AttachmentType1EPM_reference_attachment, EPM_target_attachment or EPM_signoff_attachment
...
TcObjectTagXTcl representation of the Teamcenter object tag (e.g. ItemRevision tag)
AttachmentTypeXEPM_reference_attachment, EPM_target_attachment or EPM_signoff_attachment
Returns
List of ITK_ok (=0) and tag of the job or list of ITK status and list of error messages

Referenced by T4X::TEST::WORKFLOW::executeTcWorkflowJob(), and T4X::TEST::WORKFLOW::runTemplateTest().

◆ EPM_create_process_deferred_start()

ITK::EPM_create_process_deferred_start   Name Description TemplateTag AttachementType1 AttachementTag1 ...  

This function calls the ITK pipe server function EPM_create_process_deferred_start to create a new process with the name, description, process template tag, and attachments the newly created process will NOT start. The attachment specification is optional and could be done in an extra step via the ITK::EPM_add_attachment4JobTag call.

This functional is only available available with Tc 10.x onwards.

Parameters
Name
Description
TemplateTagTcl representation of the Teamcenter template tag
AttachementType1- string - target/reference/signoff/release_status/comment/instruction/interprocess_task/schedule_task
AttachementTag1- Tcl representation of the Teamcenter attachment tag (type and tag HAVE to come pair wise)
...
AttachementTypeX- string - target/reference/signoff/release_status/comment/instruction/interprocess_task/schedule_task
AttachementTagX- Tcl representation of the Teamcenter attachment tag (type and tag HAVE to come pair wise)
Returns
ITK_ok (=0) and new processes tag or list of ITK status and error message

Sample code sequence

1 set ItkStatus [::ITK::EPM_find_process_template $TemplateName]
2 if {[::ITK::isITK_ok $ItkStatus] && [llength $ItkStatus] == 2} {
3  set TemplateTag [lindex $ItkStatus 1]
4  set ItkStatus [::ITK::EPM_create_process_deferred_start $JobName "test" $TemplateTag $AttachmentType $ObjectTag]
5  if {[::ITK::isITK_ok $ItkStatus] && [llength $ItkStatus] == 2} {
6  set ProcessTag [lindex $ItkStatus 1]
7  set ItkStatus [::ITK::EPM_ask_root_task $ProcessTag]
8  if {[::ITK::isITK_ok $ItkStatus] && [llength $ItkStatus] == 2} {
9  set RootTask [lindex $ItkStatus 1]
10  set ItkStatus [::ITK::EPM_trigger_action $RootTask "COMPLETE" "description"]
11  if {[::ITK::isITK_ok $ItkStatus]} {
12  puts "XXXX"
13  puts "XXXX EPM_trigger_action ITK_ok"
14  puts "XXXX"
15  set TaskStateStatus [::ITK::EPM_ask_task_state_string $RootTask]
16  } else {
17  #
18  # EPM_trigger_action is not ITK_ok
19  #
20  }
21  } else {
22  #
23  # EPM_ask_root_task is not ITK_ok
24  #
25  }
26  } else {
27  #
28  # EPM_create_process_deferred_start is not ITK_ok
29  #
30  }
31 } else {
32  #
33  # EPM_find_process_template is not ITK_ok
34  #
35 }

◆ EPM_demote_task()

ITK::EPM_demote_task   TaskTag Comment  

This function calls the ITK pipe server function EPM_demote_task to trigger the demote action for the given task.

Parameters
TaskTagTcl representation of the Teamcenter task tag
Comment
Returns
ITK_ok (=0) or list of ITK status and error message

◆ EPM_find_process_template()

ITK::EPM_find_process_template   ProcessTemplateName  

This function calls the ITK pipe server function EPM_find_process_template to get sub process template tag.

Parameters
ProcessTemplateName
Returns
List of ITK_ok (=0) and tag of the found process template or list of ITK status and error message

Sample code sequence

1 set ItkStatus [::ITK::EPM_find_process_template "MyTemplateProcess"]
2 if {[::ITK::isITK_ok $ItkStatus]} {
3  set ProcessTemplateTag [lindex $ItkStatus 1]
4  if {[string length $ProcessTemplateTag] > 0} {
5  # ProcessTemplateTag found
6  } else {
7  # No matiching ProcessTemplate for the specified name found
8  }
9 }

◆ EPM_get_person_email_addr()

ITK::EPM_get_person_email_addr   HexUserName  

This function calls the ITK pipe server function EPM_get_person_email_addr to get the email address of a given user name.

Parameters
HexUserName
Returns
ITK_ok (=0) and emailAddr or list of ITK status and error message

◆ EPM_get_type_tasks()

ITK::EPM_get_type_tasks   TaskTag HexTaskType  

This function calls the ITK pipe server function EPM_get_type_tasks to get the object name of a given task tag.

Parameters
TaskTagTcl representation of the Teamcenter task tag
HexTaskType- DoTask / ReviewTask / AcknowledgeTask ...
Returns
ITK_ok (=0) and procedure name or list of ITK status and error message

◆ EPM_get_user_email_addr()

ITK::EPM_get_user_email_addr   HexUserTag  

This function calls the ITK pipe server function EPM_get_user_email_addr to get the email address of a given userTag.

Parameters
HexUserTag
Returns
ITK_ok (=0) and emailAddr or list of ITK status and error message

◆ EPM_is_valid_performer()

ITK::EPM_is_valid_performer   TaskTag  

This function calls the ITK pipe server function EPM_is_valid_performer to get the information that the current user is the valid performer of the given task tag.

Parameters
TaskTag,Tclrepresentation of the Teamcenter task tag
Returns
ITK_ok (=0) and valid performer flag or list of ITK status and error message

◆ EPM_promote_task()

ITK::EPM_promote_task   TaskTag Comment  

This function calls the ITK pipe server function EPM_promote_task to trigger the promote action for the given task.

Parameters
TaskTagTcl representation of the Teamcenter task tag
Comment
Returns
ITK_ok (=0) or list of ITK status and error message

◆ EPM_remove_task_hold()

ITK::EPM_remove_task_hold   TaskTag  

This function calls the ITK pipe server function EPM_remove_task_hold to remove the hold on the DoTask.

Parameters
TaskTagTcl representation of the Teamcenter DoTask tag
Returns
ITK_ok (=0) or list of ITK status and error message

Sample code sequence

1 set ItkStatus [::ITK::EPM_remove_task_hold $TaskTag]
2 if {[::ITK::isITK_ok $ItkStatus]} {
3  set TriggerStatus [::ITK::EPM_trigger_action $TaskTag COMPLETE TriggerComment]
4  if {[::ITK::isITK_ok $TriggerStatus]} {
5  puts "XXXX"
6  puts "XXXX EPM_trigger_action ITK_ok"
7  puts "XXXX"
8  } else {
9  #
10  # EPM_trigger_action is not ITK_ok
11  #
12  }
13 } else {
14  #
15  # EPM_remove_task_hold is not ITK_ok
16  #
17 }

◆ EPM_set_decision()

ITK::EPM_set_decision   TaskTag Decision DecisionComment AutoComplete  

This function calls the ITK pipe server function EPM_set_decision to set the decision of a perform sign-off or review task.

Parameters
TaskTagTcl representation of the perform sign-off or review task tag
DecisionNO_DECISION|APPROVE_DECISION|REJECT_DECISION
DecisionComment
AutoComplete,flagdecides if a complete action is triggered to automatically complete the task after decision is set.
Returns
ITK_ok (=0) or list of ITK status and error message

◆ EPM_trigger_action()

ITK::EPM_trigger_action   JobTag Action Comment  

This function calls the ITK pipe server function EPM_trigger_action to trigger a given work-flow job in the users in-box.

Parameters
JobTagTcl representation of the Teamcenter task tag
Actionvalid values are: ASSIGN, START, PERFORM, COMPLETE, SUSPEND, RESUME, SKIP, ABORT, REFUSE, UNDO, REJECT,or HALT.
Comment
Returns
ITK_ok (=0) or list of ITK status and error message

Referenced by T4X::TEST::WORKFLOW::executeTcWorkflowJob(), and T4X::TEST::WORKFLOW::runTemplateTest().