![]() |
T4S4
18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
|
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... | |
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
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.
JobTag | Tcl representation of the Teamcenter job tag |
AttachmentType | EPM_reference_attachment, EPM_target_attachment or EPM_signoff_attachment |
TcObjectTag | Tcl representation of the Teamcenter object tag (e.g. ItemRevision tag) |
Referenced by T4X::TEST::WORKFLOW::runTemplateTest().
ITK::EPM_ask_assigned_tasks |
ITK::EPM_ask_name | TaskTag | ||
ITK::EPM_ask_parent_processes | SubProcessTag | ||
ITK::EPM_ask_procedure_name | TaskTag | ||
ITK::EPM_ask_process_template | TaskTag | ||
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.
JobTag,Tcl | representation of the Teamcenter job tag |
Referenced by T4X::TEST::WORKFLOW::executeTcWorkflowJob(), and T4X::TEST::WORKFLOW::runTemplateTest().
ITK::EPM_ask_sub_processes | ParentProcessTag | ||
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.
TaskTag,Tcl | representation of the Teamcenter task tag |
Referenced by T4X::TEST::WORKFLOW::executeTcWorkflowJob(), findStartedSuccessorTask(), and T4X::TEST::WORKFLOW::runTemplateTest().
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.
JobName | |
JobDescription | |
ProcessTemplateName | |
TcObjectTag1 | Tcl representation of the Teamcenter object tag (e.g. ItemRevision tag) |
AttachmentType1 | EPM_reference_attachment, EPM_target_attachment or EPM_signoff_attachment |
... | |
TcObjectTagX | Tcl representation of the Teamcenter object tag (e.g. ItemRevision tag) |
AttachmentTypeX | EPM_reference_attachment, EPM_target_attachment or EPM_signoff_attachment |
Referenced by T4X::TEST::WORKFLOW::executeTcWorkflowJob(), and T4X::TEST::WORKFLOW::runTemplateTest().
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.
Name | |
Description | |
TemplateTag | Tcl 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) |
Sample code sequence
ITK::EPM_demote_task | TaskTag Comment | ||
ITK::EPM_find_process_template | ProcessTemplateName | ||
ITK::EPM_get_person_email_addr | HexUserName | ||
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.
TaskTag | Tcl representation of the Teamcenter task tag |
HexTaskType | - DoTask / ReviewTask / AcknowledgeTask ... |
ITK::EPM_get_user_email_addr | HexUserTag | ||
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.
TaskTag,Tcl | representation of the Teamcenter task tag |
ITK::EPM_promote_task | TaskTag Comment | ||
ITK::EPM_remove_task_hold | TaskTag | ||
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.
TaskTag | Tcl representation of the perform sign-off or review task tag |
Decision | NO_DECISION|APPROVE_DECISION|REJECT_DECISION |
DecisionComment | |
AutoComplete,flag | decides if a complete action is triggered to automatically complete the task after decision is set. |
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.
JobTag | Tcl representation of the Teamcenter task tag |
Action | valid values are: ASSIGN, START, PERFORM, COMPLETE, SUSPEND, RESUME, SKIP, ABORT, REFUSE, UNDO, REJECT,or HALT. |
Comment |
Referenced by T4X::TEST::WORKFLOW::executeTcWorkflowJob(), and T4X::TEST::WORKFLOW::runTemplateTest().