Two different recipient classes (SPFWorkflowStepRecipient and SPFMatrixRowRecipient) are used to link the different types of recipients (roles and users) to workflow steps and distribution matrices.
An abstract relationship (SPFRecipientParticipant) links recipients (roles and users) to the workflow step recipient object (SPFWorkflowStepRecipient) which is linked to the actual workflow step. Additional properties and relationships are configured on the step recipient object on ISPFWorkflowStepRecipient. The intermediate step recipient object is modeled in preference to a single relationship with a link interface to share the model and functionality with the matrix model. Simply substitute Matrix Row Recipient for Workflow Step Recipient and matrix row for workflow step and the model is almost identical.
Details of the properties and functionality exposed by these interfaces are given in the sections that follow.
ISPFRecipient interface
ISPFRecipient is realized by SPFWorkflowStepRecipient class and SPFMatrixRowRecipient class. It is used to gather the roles and users as recipients.
It has the format in which the recipient (paper users) will receive the information (for example, A4, A3) and has a link to the reason for receipt.
The following properties are found on this interface.
|
Name |
Description |
Set on |
|---|---|---|
|
Format |
Format in which the recipient will receive the information |
Recipient form |
SPFRecipientParticipant relationship definition
SPFRecipientParticipant links the participant to the recipient. It is an abstract relationship that specializes the SPFRecipientUser and SPFRecipientRole.
This relationship is expanded to get users and roles in one expansion.
SPFRecipientUser relationship definition
SPFRecipientUser links the recipient object to a user and is a specialization of SPFRecipientParticipant. This relationship is configured on the Manage Recipients form.
SPFRecipientRole relationship definition
SPFRecipientRole links the recipient to the role. This relationship is configured on the Manage Recipients form.
ISPFReasonForReceipt interface
ISPFReasonForReceipt is the primary interface of SPFReasonForReceipt class. Reasons might be: review (information only) review and comment (information and action). The reason for receipt objects are configurable by the administrator.
The following properties are found on this interface.
|
Name |
Description |
Set on |
|---|---|---|
|
SPFRFRInfoInd |
Reason for receipt indicator (if set user gets information step and not action step) |
Recipient form |
SPFRecipientRFR relationship definition
SPFRecipientRFR links the reason for receipt to the recipient.
ISPFParticipant interface
ISPFParticipant is realized by all the recipient classes, SPFRole, SPFAbstractUser, SPFUser, SPFEmailUser, and SPFPaperUser.
ISPFRole interface
See Roles, domains, and access groups.
ISPFUser interface
See Users.
ISPFPaperUser interface
See Users.
ISPFEmailUser interface
See Users.
ISPFLoginUser interface
See Users.
ISPFWorkflowStepRecipient interface
ISPFWorkflowStepRecipient is the primary interface of the SPFWorkflowStepRecipient class.
The following properties are found on this interface.
|
Name |
Description |
Set on |
|---|---|---|
|
SPFWFSRActionInBox |
Does not put a step in the user’s inbox, but still sends an email (for the recipient's information only) |
Recipient form |
|
SPFExpandedFromRoleInd |
Expanded from a role indicator to show that the recipient was extracted off a role |
Set by code |
ISPFWorkflowStep interface
ISPFWorkStep is the primary interface of the SPFWorkflowStep class. See also Workflow templates. ISPFWorkStep is implied by ISPFObjectWorkflowStep and ISPFWorkflowTemplateStep.
SPFWorkflowStepStepRecipient relationship definition
SPFWorkflowStepStepRecipient links the recipients to the workflow step.
SPFOriginalWFStepStepRecipient relationship definition
SPFOriginalWFStepStepRecipient links the original recipient to the original workflow step. It is used in reports to determine how a user became a recipient.
It is used when revising the workflow. This is in case someone has left or joined a role. The expansion will be done again.
SPFWorkflowStepRecipientOriginalMatrix relationship definition
SPFWorkflowStepRecipientOriginalMatrix links the original matrix to the step using the WorkflowStepRecipient object.
ISPFDistributionMatrix interface
This interface is instantiated on all distribution matrix classes. The method MaintainMatrixRecips (Assign Recipients) is available from this interface.
WorkflowSteps
It is used to expand from the workflow to the steps, displaying them in step order. This is exposed on the RHM of a workflow.
WFStepRecipientUser
It is used internally to get the users for a step.