# Class R.E.EnvelopeInstance(CatalogPathAware, Folder):

Part of Reportek.EnvelopeInstance View In Hierarchy

Known subclasses: Reportek.Envelope.Envelope

The Envelope class subclasses from EnvelopeInstance which implements the workflow operations Each envelope follows a certain workflow process established at creation time.

Line # | Kind | Name | Docs
--- | --- | --- | ---
63 | Method | __init__ | constructor
99 | Method | getWorkflowTabs | Returns the tuple:
116 | Method | getOpenFlowEngine | Returns the Collection object, parent of the process
121 | Method | getActivity | Returns the activity of a workitem
129 | Method | getApplicationUrl | Return application definition URL relative to instance and workitem
139 | Method | getEnvironment | Returns the engine, the workitem object, the current process and activity
148 | Method | getInstanceProcessId | Returns the process id from its path
152 | Method | getProcess | Returns the process as an object
160 | Method | addWorkitem | Undocumented
168 | Method | getJoiningWorkitem | Undocumented
179 | Method | setStatus | Undocumented
209 | Method | is_active_for_me | returns >0 if there is an active workitem for that person
222 | Method | getActiveWorkitems | returns all active workitems
227 | Method | getListOfWorkitems | Returns all workitems given a list of statuses
239 | Method | setPriority | Undocumented
243 | Method | isActiveOrRunning | Undocumented
247 | Method | suspendInstance | suspend a specified instance
263 | Method | resumeInstance | resume a specified instance
279 | Method | terminateInstance | terminate a specified instance
294 | Method | startInstance | Starts the flowing of the process instance inside the process definition
310 | Method | linkWorkitems | Undocumented
319 | Method | assignWorkitem | Assign the specified workitem of the specified instance to the specified actor (string)
335 | Method | unassignWorkitem | Unassign the specified workitem
351 | Method | activateWorkitem | declares the activation of the specified workitem of the given instance
374 | Method | inactivateWorkitem | declares the inactivation of the specified workitem of the given instance
389 | Method | suspendWorkitem | declares the suspension of the specified workitem of the given instance
409 | Method | resumeWorkitem | declares the resumption of the specified workitem of the given instance
427 | Method | completeWorkitem | declares the completion of the specified workitem of the given instance
461 | Method | isEnd | Undocumented
467 | Method | getNextTransitions | Returns the list of transition that the given workitem (of the specified instance)
498 | Method | getDestinations | Undocumented
519 | Method | forwardWorkitem | instructs openflow to forward the specified workitem
562 | Method | getPreviousActor | Returns the actor that completed the previous workitem
571 | Method | changeWorkitem | use this API to modify anything of a fallout workitem
613 | Method | falloutWorkitem | drops the workitem in exceptional handling
627 | Method | sendWorkitemsToException | Undocumented
635 | Method | fallinWorkitem | the exceptional specified workitem (of the specified instance) will be put back in the activity
660 | Method | endFallinWorkitem | Ends the exceptional state of the given workitem
673 | Method | getWorkitemsActiveForMe | Returns the list of active workitems
685 | Method | manageDummyActivity | Undocumented
693 | Method | startAutomaticApplication | Undocumented
708 | Method | callAutoPush | Undocumented
724 | Method | manageWorkitemCreation | Undocumented
743 | Method | startSubflow | Undocumented
757 | Method | getSubflowWorkitem | TODO!
767 | Method | completeSubflow | Undocumented

def __init__(self, process, priority=0):
overridden in Reportek.Envelope.Envelope
constructor

def getWorkflowTabs(self, REQUEST):
Returns the tuple: (tabs available for the current user with respect to the active workitems, the selected tab)

def getOpenFlowEngine(self):
Returns the Collection object, parent of the process

def getActivity(self, workitem_id):
Returns the activity of a workitem

def getApplicationUrl(self, workitem_id):
Return application definition URL relative to instance and workitem

def getEnvironment(self, workitem_id):
Returns the engine, the workitem object, the current process and activity

def getInstanceProcessId(self):
Returns the process id from its path

def getProcess(self):
Returns the process as an object

def addWorkitem(self, activity_id, blocked, push_roles=, pull_roles=):
Undocumented
def getJoiningWorkitem(self, activity_id):
Undocumented
def setStatus(self, status, comment='', actor=''):
Undocumented
def is_active_for_me(self, REQUEST=None):
returns >0 if there is an active workitem for that person

def getActiveWorkitems(self):
returns all active workitems

def getListOfWorkitems(self, status=None):
Returns all workitems given a list of statuses If the status is not provided, all workitems are returned

def setPriority(self, value):
Undocumented
def isActiveOrRunning(self):
Undocumented
def suspendInstance(self, REQUEST=None):
suspend a specified instance

def resumeInstance(self, REQUEST=None):
resume a specified instance

def terminateInstance(self, REQUEST=None):
terminate a specified instance

def startInstance(self, REQUEST=None):
Starts the flowing of the process instance inside the process definition

def linkWorkitems(self, workitem_from_id, workitem_to_id_list):
Undocumented
def assignWorkitem(self, workitem_id, actor, REQUEST=None):
Assign the specified workitem of the specified instance to the specified actor (string)

def unassignWorkitem(self, workitem_id, REQUEST=None):
Unassign the specified workitem

def activateWorkitem(self, workitem_id, actor=None, REQUEST=None):
declares the activation of the specified workitem of the given instance

def inactivateWorkitem(self, workitem_id, REQUEST=None):
declares the inactivation of the specified workitem of the given instance

def suspendWorkitem(self, workitem_id, REQUEST=None):
declares the suspension of the specified workitem of the given instance

def resumeWorkitem(self, workitem_id, REQUEST=None):
declares the resumption of the specified workitem of the given instance

def completeWorkitem(self, workitem_id, actor=None, REQUEST=None):
declares the completion of the specified workitem of the given instance

def isEnd(self, activity_id):
Undocumented
def getNextTransitions(self, workitem_id):
Returns the list of transition that the given workitem (of the specified instance) will be routed on

def getDestinations(self, workitem_id, path=None):
Undocumented
def forwardWorkitem(self, workitem_id, path=None, REQUEST=None):
instructs openflow to forward the specified workitem

def getPreviousActor(self, workitem_id):
Returns the actor that completed the previous workitem

def changeWorkitem(self, workitem_id, push_roles=None, pull_roles=None, event_log=None, activity_id=None, blocked=None, priority=None, workitems_from=None, workitems_to=None, status=None, actor=None, graph_level=None, REQUEST=None):
use this API to modify anything of a fallout workitem usable only if workitem status is 'fallout'

def falloutWorkitem(self, workitem_id, REQUEST=None):
drops the workitem in exceptional handling

def sendWorkitemsToException(self, process_id, activity_id):
Undocumented
def fallinWorkitem(self, workitem_id, activity_id, coming_from=None, REQUEST=None):
the exceptional specified workitem (of the specified instance) will be put back in the activity specified by process_path and activity_id; workitem will still be in exceptional state: use endFallinWorkitem API to specify the end of the exceptional state

def endFallinWorkitem(self, workitem_id, REQUEST=None):
Ends the exceptional state of the given workitem

def getWorkitemsActiveForMe(self, REQUEST):
Returns the list of active workitems where an user is the current actor of

def manageDummyActivity(self, workitem_id):
Undocumented
def startAutomaticApplication(self, workitem_id, REQUEST=None):
Undocumented
def callAutoPush(self, workitem_id, REQUEST=None):
Undocumented
def manageWorkitemCreation(self, workitem_id):
Undocumented
def startSubflow(self, workitem_id, REQUEST=None):
Undocumented
def getSubflowWorkitem(self, workitem_id):
TODO!

def completeSubflow(self, workitem_id):
Undocumented