The AddRecipient client API allows you to add a user or users in a role to a workflow step that is in progress and attaches a new workflow for the recipient that progresses in parallel to the original step.
|
Argument |
Description |
|---|---|
|
Parameter 1 |
Append Workflow Template Name |
|
Parameter 1 description |
Name of the appended workflow template |
|
Parameter 1 type |
String |
|
Parameter 1 default |
AppendedWorkflow |
|
Parameter 2 |
Roles to display |
|
Parameter 2 description |
Comma separated role names that will be displayed in the Add Recipient dialog box. Use ALLROLES to display all the roles in the system. If no role is specified, the roles of the logged-on user in the configuration of the object in the workflow are displayed. |
|
Parameter 2 type |
String |
|
Parameter 2 default |
None |
|
Parameter 3 |
Show roles |
|
Parameter 3 description |
If set to TRUE, the software displays the roles along with the users in the Add Recipient dialog box. If set to FALSE, the software displays only the users of that role in the configuration of the workflow item. |
|
Parameter 3 type |
Boolean |
|
Parameter 3 default |
True |
|
Parameter 4 |
Workflow Step Definition Name |
|
Parameter 4 description |
Specify the workflow step definition to identify the steps in ready to start state with the same step definition in the current workflow. |
|
Parameter 4 type |
String |
|
Parameter 4 default |
None |
|
Parameter 5 |
Relationship To Object (Optional) |
|
Parameter 5 description |
Specify the relationship definition name to append the recipient to the workflow item. |
|
Parameter 5 type |
String |
|
Parameter 5 default |
None |
The following methods use the AddRecipient client API:
-
AddRecipient adds a user or users in a role to a workflow step that is in progress and attaches a new workflow for the recipient that progresses in parallel to the original step. This method contains the condition IsNotFirstStep, which checks to make sure that the step is not the first step in the workflow.
-
AddRecipientToUser
-
AddRecipientWithSpecificRoles
-
SCLBAddReviewer adds a user or users in a role as a reviewer to a document that is in the QA review workflow. This method opens the Add reviewer dialog box which lists the users, except the users who have an active review plan, based on the configured security rule. These users are identified based on the workflow step definition specified in parameter 4.
The following methods add a user or users in a role as a reviewer or a responder to the current workflow. These methods open a dialog box listing the users based on the configured security rule and the parameter 3 value.
-
SCLBAddInternalReviewer
-
SCLBAddOutTQResponder
-
SCLBAddIncTQResponder