The instantiated workflow is created when an object is attached to a template by copying the template workflow. The ISPFWorkflowTemplate interface is dropped and the ISPFObjectWorkflow interface is added. Similarly, the ISPFObjectWorkflowStep interface is added to the instantiated steps. The template is copied to the instantiated workflow. The instantiated workflow maintains a link back to show which template was used.
Details of the properties and functionality exposed by these interfaces are given in the sections that follow.
ISPFWorkflow interface
See previous section.
ISPFWorkflowStep interface
See previous section.
ISPFObjectWorkflow interface
ISPFObjectWorkflow is realized by the workflow class and is instantiated on object workflows. It has the relationship back to the workflow template.
The following properties to define the workflow step are found on this interface:
|
Name |
Description |
Set on |
|---|---|---|
|
SPFWorkflowStatus |
The success or failure status of current step |
Step completion |
|
SPFWorkflowRev |
Workflow revision |
Incremented as step accepted or rejected into another workflow. |
|
SPFWorkflowOnHoldInd |
When set will not allow the workflow to progress any further and the steps will not be visible in the user’s inbox |
Right hand mouse click on the current step. |
|
SPFWorkflowTerminationProcessClass |
Process class to run when terminating this workflow; Allows for post step customization |
SPFWorkflowWorkflowTemplate relationship definition
SPFWorkflowWorkflowTemplate relates a workflow to its template.
By default, when a workflow template is terminated or deleted, any instances of the
workflow are allowed to finish. If you want the instances to also be terminated or
deleted, change the Delete21 property on the SPFWorkflowWorkflowTemplate relationship definition to True. One way to do this is to create and execute a load file.
SPFWorkflowSubmitter relationship definition
SPFWorkflowSubmitter links the submitter to the workflow.
ISPFObjectWorkflowStep interface
ISPFObjectWorkflowStep is attached to instantiated workflow steps and contains the properties to show the progress of an object in a workflow in the client window.
The following properties are found on this interface.
|
Name |
Description |
Set on |
|---|---|---|
|
SPFStepStatus |
Step status |
Code |
|
SPFStepClaimedInd |
Step claimed indicator (used with group assignments) |
When user claims in inbox. |
|
SPFStepStartDate |
Step start date |
Set when step starts. |
|
SPFStepTargetDate |
Step target date |
Internally calculated from step start date plus duration. |
|
SPFStepPlannedDate |
Step planned date |
Set when workflow started but over writable by the user (shortcut menu method). Can be set on instantiated workflows to change the step forecast but this does NOT change the target date. |
|
SPFStepCompletedDate |
Step completed date |
Set when step is completed. |
|
SPFStepComments |
Step comment |
Available when user completes step. |
|
SPFStepMsgFromPreviousStep |
Step message from previous step |
Available when user completes step. |
|
SPFStepOverdueDate |
Overdue date |
Calculated when doing expiration checks. |
The SPFStepStatus are (in order):
|
1 |
Not ready |
|
|
2 |
Ready to start |
|
|
3 |
Signed off |
Alternative value that happens after 'ready to start' |
|
4 |
Rejected |
Alternative value that happens after 'ready to start' |
|
5 |
Termination |
Alternative value that happens after 'ready to start' |
Functionality configured on ISPFObjectWorkflowStep
The following methods are available on this interface:
|
Method name |
Display name |
Comment |
|---|---|---|
|
StepUpdateDates |
Update Step Duration |
|
|
StepUpdateDesc |
Update Step Description |
|
|
StepUpdateRecip |
Update Step Recipients |
|
|
StepResponseManagement |
Response Management |
Part of the transmittals model |
SPFWrkflwStepsCompletedBy relationship definition
SPFWrkflwStepsCompletedBy links the user to the instantiated workflow steps that they have completed.
ISPFWorkflowItem interface
ISPFWorkflowItem is realized by any class of object that can be put in a workflow. That is, it denotes that the object can be put on a workflow. If a class realizes this interface, it will inherit all the workflow functionality from methods configured on this interface.
The following properties are found on this interface.
|
Name |
Description |
Set on |
|---|---|---|
|
SPFActiveWorkflowCount |
The number of active workflows |
Code* |
|
SPFActiveWorkflowStatus |
The active workflow status |
Code |
* This property is for future use and is not currently supported. Currently, it can only have a value of 0 or 1.
Functionality configured on ISPFWorkflowItem
The following methods are available on this interface. The table includes the internal and display names for each method.
Some methods are conditional, based on the status of the workflow.
|
Method name |
Display name |
Comment |
|---|---|---|
|
AttWFlow |
Attach and Edit Workflow |
|
|
AttWFlowNoEdit |
Attach Workflow |
|
|
DeleteWorkflow |
Delete Workflow |
|
|
HoldWorkflow |
Put Workflow on Hold |
|
|
ObjectViewWorkflow |
View Workflow |
|
|
ObjectWorkflowDetail |
Workflow Details |
|
|
ObjectWorkflowEdit |
Update workflow |
|
|
OffHold |
Take Workflow Off Hold |
|
|
OverdueStepsReport |
Workflow Overdue Steps Report |
|
|
RejectWorkflow |
Reject Workflow |
|
|
ShowInboxForObject |
Show Inbox for Object |
|
|
TerminateWorkflow |
Terminate Workflow |
|
|
WFItemResponseManagement |
Response Management |
Part of the transmittal model |
|
WorkflowDetailReport |
Workflow Details Report |
|
|
WorkflowHistory |
Workflow History |
SPFItemWorkflow relationship definition
When an item is put on a workflow, SPFItemWorkflow links the instantiated workflow to the items progressing down the workflow.