ITK Function Reference

(V10000.1.0.60_20160308.00)
Modules | Macros | Typedefs | Enumerations
Enterprise Process Modeling

Modules

 Cascade Release
 
 EPM Access Control
 
 EPM Errors
 
 EPM Task Template
 
 EPM Toolkit
 
 Release Management
 
 Signoff
 
 Alias List
 
 Process Management
 

Macros

#define EPM_abort_action   9
 
#define EPM_add_attachment_action   101
 
#define EPM_approve_action   104
 
#define EPM_assign_action   1
 
#define EPM_assign_approver_action   109
 
#define EPM_claim_action   203
 
#define EPM_comment2_size_c   4000
 
#define EPM_complete_action   4
 
#define EPM_complete_on_complete_action   EPM_complete_action
 
#define EPM_demote_action   107
 
#define EPM_fail_action   10
 
#define EPM_notify_action   110
 
#define EPM_perform_action   100
 
#define EPM_perform_signoffs_task   "perform-signoffs"
 
#define EPM_promote_action   106
 
#define EPM_refuse_action   108
 
#define EPM_reject_action   105
 
#define EPM_remove_attachment_action   102
 
#define EPM_restart_on_complete_action   200
 
#define EPM_restart_on_fail_action   201
 
#define EPM_resume_action   7
 
#define EPM_select_signoff_team_task   "select-signoff-team"
 
#define EPM_skip_action   5
 
#define EPM_start_action   2
 
#define EPM_start_on_complete_action   EPM_start_action
 
#define EPM_start_on_fail_action   EPM_fail_action
 
#define EPM_start_on_start_action   202
 
#define EPM_suspend_action   6
 
#define EPM_undo_action   8
 
#define EPM_user_action   1000
 
#define EPM_user_size_c   163
 

Typedefs

typedef int EPM_action_t
 
typedef enum EPM_signoff_decision_e EPM_signoff_decision_t
 
typedef enum EPM_state_e EPM_state_t
 

Enumerations

enum  EPM_signoff_decision_e { EPM_no_decision = 0, EPM_approve_decision = 'Y', EPM_reject_decision = 'N' }
 
enum  EPM_state_e {
  EPM_unassigned = (1 << 0), EPM_pending = (1 << 1), EPM_started = (1 << 2), EPM_completed = (1 << 3),
  EPM_skipped = (1 << 4), EPM_aborted = (1 << 5), EPM_failed = (1 << 6), EPM_suspended = (1 << 7)
}
 

Detailed Description

The Enterprise Process Management (EPM) functions provide you with the capability to write action and rule handler code. You must include the header file epm.h in your source code.

Warning
EPM functions have been specially developed for custom EPM applications and procedures. Using these functions with other workflow applications (e.g., CR, CM), procedures, and tasks can result in unpredictable behavior and could cause loss of data.

Macro Definition Documentation

#define EPM_abort_action   9

Abort action

Definition at line 85 of file epm.h.

#define EPM_add_attachment_action   101

Add attachment to a task

Definition at line 89 of file epm.h.

#define EPM_approve_action   104

Approve action

Definition at line 91 of file epm.h.

#define EPM_assign_action   1

Actions on the taskAssign action

Definition at line 78 of file epm.h.

#define EPM_assign_approver_action   109

Assign approver to a task

Definition at line 96 of file epm.h.

#define EPM_claim_action   203

Claim action

Definition at line 105 of file epm.h.

#define EPM_comment2_size_c   4000

Length of the comments

Definition at line 57 of file epm.h.

#define EPM_complete_action   4

Complete action

Definition at line 80 of file epm.h.

#define EPM_complete_on_complete_action   EPM_complete_action

Complete action

Definition at line 100 of file epm.h.

#define EPM_demote_action   107

Demote action

Definition at line 94 of file epm.h.

#define EPM_fail_action   10

Fail action

Definition at line 86 of file epm.h.

#define EPM_notify_action   110

Notify action

Definition at line 97 of file epm.h.

#define EPM_perform_action   100

Perform action

Definition at line 88 of file epm.h.

#define EPM_perform_signoffs_task   "perform-signoffs"

Perform signoffs task

Definition at line 41 of file epm.h.

#define EPM_promote_action   106

Promote action

Definition at line 93 of file epm.h.

#define EPM_refuse_action   108

Refuse action

Definition at line 95 of file epm.h.

#define EPM_reject_action   105

Reject action

Definition at line 92 of file epm.h.

#define EPM_remove_attachment_action   102

Remove attachment of a task

Definition at line 90 of file epm.h.

#define EPM_restart_on_complete_action   200

Restart on complete action

Definition at line 102 of file epm.h.

#define EPM_restart_on_fail_action   201

Restart on fail action

Definition at line 103 of file epm.h.

#define EPM_resume_action   7

Resume action

Definition at line 83 of file epm.h.

#define EPM_select_signoff_team_task   "select-signoff-team"

Select signoff team task

Definition at line 40 of file epm.h.

#define EPM_skip_action   5

Skip action

Definition at line 81 of file epm.h.

#define EPM_start_action   2

Start action

Definition at line 79 of file epm.h.

#define EPM_start_on_complete_action   EPM_start_action

Start action

Definition at line 99 of file epm.h.

#define EPM_start_on_fail_action   EPM_fail_action

Fail action

Definition at line 101 of file epm.h.

#define EPM_start_on_start_action   202

Start on start action

Definition at line 104 of file epm.h.

#define EPM_suspend_action   6

Suspend action

Definition at line 82 of file epm.h.

#define EPM_undo_action   8

Undo action

Definition at line 84 of file epm.h.

#define EPM_user_action   1000

Actions from 1000-32000 are user defined

Definition at line 109 of file epm.h.

#define EPM_user_size_c   163
Set the size for person name (userid).


In the database, the person name contains up to 128 characters, the user name/id up to 32 characters,and 3 more characters for '(', ')' and ' '.
The total is 128 + 32 + 3 = 163 characters, which are set for the user size.

Definition at line 46 of file epm.h.

Typedef Documentation

typedef int EPM_action_t

Definition at line 111 of file epm.h.

Decisions that can be set by the reviewers while performing the signoff

typedef enum EPM_state_e EPM_state_t

States of the tasks

Enumeration Type Documentation

Decisions that can be set by the reviewers while performing the signoff

Enumerator
EPM_no_decision 

No decision

EPM_approve_decision 

Approve decision

EPM_reject_decision 

Reject decision

Definition at line 51 of file epm.h.

States of the tasks

Enumerator
EPM_unassigned 

Unassigned task state

EPM_pending 

Pending task state

EPM_started 

Started task state

EPM_completed 

Completed task state

EPM_skipped 

Skipped task state

EPM_aborted 

Aborted task state

EPM_failed 

Failed task state

EPM_suspended 

Suspended task state

Definition at line 62 of file epm.h.