LiveCycle Workbench ES Help | |||
| Creating Processes > Service reference > User > Assign Task | |||
The operation is used in the design of human-centric processes, which creates a task and assigns it to a user. The property groups allow you to configure the behavior of the task at run time, as well as the Workspace ES features that people can use with the task when they open it in Workspace ES or when they use email to complete a task.
For information about the General and Route Evaluation property groups, see Common operation properties.
Initial User SelectionProperty to specify the user to assign the task to.
The following options are used to configure the user to assign the task to.
Assign To Specific User: A string value that represents the user profile to whom to assign the task. The user profile must exist in the LiveCycle ES environment. Use the Browse button that displays the Select User dialog box (see About the Select User dialog box), which is used to choose the user profile to which to assign the task.
Assign To Process Creator: A string value that represents the profile of the user who initiated the process.
Assign To Group: A string value that represents the group profile to which to assign the task. Users belonging to the group profile can be assigned a task in one of the following ways:
Use the Browse button to display the Select Group dialog box (see About the Select Group dialog box), which is used to choose the group profile to which to assign the task.
XPath Expression: A string value which assigns the task. The XPath expression must evaluate to an existing user profile. The value representing the user profile must be stored in the process data, such as in a process variable or in form data.
Task InstructionsA property that describes what the user must do to complete the task.
A string value that represents the instructions for the task.
If you provide a literal value, you type the instructions for the task.
Form Data MappingsProperties that identify the input form data that is used for the operation, whether a form must be saved to complete the task, the location to store output form data, and the task identifier and user profile information of the person completing the task.
A Form, xfaForm, or Document Form value that stores the form information to use for retrieving, merging data with, and pre-populating a form.
A boolean value representing whether the specified form must be filled in and saved to complete the task. A value of true will require that the form be filled in and saved to complete the task. The default is false.
The location to store the form information. The data type is a Form, xfaForm, or Document Form.
(Optional) The location to store the identifier of the task created for the operation. The data type is long.
(Optional) The location to store the GUID (Global Unique Identifier) representing the user who completed the task. The data type is string.
Task Access Control List (ACL)Property that is used to add and configure ACLs for users.
(Optional) Identifies the actions that users who are assigned the task are permitted to do. ACL (Access Control List) properties can be configured for all users who might be assigned the task. A default ACL is available if no specific ACL is configured for a user. The default ACL allows users permissions to add attachments, to add notes, and to forward the current assigned task.
Click the Browse button to use the Select User dialog box to choose the user profile representing to whom to assign the task.
The following are actions that you can permit each user to do:
Claim: Claim ownership of a task from a group queue.
Modify Permissions: Modify the permissions of a task.
Add Attachments: Add file attachments to tasks.
Modify Deadline: Change the properties of deadlines for a task.
Forward: Assign the task to another user to complete.
Add Notes: Add notes to the task.
Share: Share ownership of the task.
Consult: Allow another user to fill in a form but not complete the task.
Add ACL For Shared Queue: Adds permissions to other users who have access to the user's queue of tasks.
Delegation and Consultation Properties to restrict with whom a user can forward or consult.
(Optional) A Task Delegate and Consult value that imposes limitations on who the assigned user can forward or consult their task with. The restricted users are specified by group.
If you provide a literal value, you can modify the following fields that appear:
Forward Only To Members Of This Group: Specifies that the user is limited to forwarding their task to only the specified group of users. If the value is set to false, the user can forward it to any other user.
Use the Browse button located below the Forward Only To Members Of This Group check box to display the Select Group dialog box (see About the Select Group dialog box), which is used to choose the group profile to which to assign the task.
Consult Only To Members Of This Group: Specifies that the user can only consult their task with a specific group of users. If the value is set to false, the user can consult with any other user.
Use the Browse button located below the Consult Only To Members Of This Group check box to display the Select Group dialog box (see About the Select Group dialog box), which is used to choose the group profile to which to assign the task.
Attachments and NotesProperties that specify the manner in which attachments and notes are handled for the operation and where the notes and attachments from the task are stored after execution.
(Optional) Specifies whether attachments and notes can be added by users in Workspace ES and how notes and attachments are handled for the operation.
Show Attachment Window For This Task: Allows Workspace ES users to add attachments to tasks.
Select one of the following options to specify whether attachments are included in the task when it is sent to the user:
Do Not Initialize This Action With Any Notes Or Attachments: Specifies that no attachments are included with the task.
Copy All Notes and Attachments From Previous Task: Specifies that notes and attachments from the previous Assign Task operation are included in the current task.
Copy All Notes and Attachments From A List Of Documents: Specifies that notes and attachments are provided by a list value. The list variable is selected from the Input List. The list value stores a collection of notes and attachments. The list stores a sub-type of document.
(Optional) Specifies the location to store the notes and attachments. The data type is a list and a sub-type of document.
Note: New items will be appended to the end of the list if there are existing items in the list variable. To replace a list, you must specify the index of the first item in the list. For example, /process_data/listVar[1].
Routes and Priority Property to provide routes as options for the user to submit or complete a task and to specify the priority for the assigned task.
(Optional) A Task Routes and Priority value that specifies that users are presented with a list of options based on the routes in the process diagram for the operation. Based on the list of options, users can choose to submit or complete a task. You display the name routes as options. You can also specify a priority for the task.
If you provide a literal value, you can modify the following fields that appear:
Initialize Task With Route Names: Display route names as task submission options. Default route names are displayed if no routes names are provided in the process diagram.
User Must Select A Route To Complete The Task: Specifies that it is mandatory that the user select a route to complete the task.
Select Priority For This Task: Specifies a priority of Highest, High, Normal, Low, or Lowest. The default value is Normal.
RemindersProperties to configure reminders to be sent to users.
(Optional) A Task Reminder value that specifies the time when the first reminder is sent, the duration between a reminder and subsequent reminders, and whether to change task instructions when the reminder is sent.
If you provide a literal value, you can modify the following fields that appear:
Enable First Reminder
Sends a reminder to the task owner. In the Days, Hours, and Minutes boxes directly below the Enable First Reminder check box, specify the duration from when the task is first assigned to the user and the reminder is sent to the user. The duration is specified using the Days, Hours, and Minutes boxes. If the Days, Hours, and Minutes boxes all have a value of 0, the reminder will not be sent.
Enable Repeat Reminder
Sends reminders at regular intervals after the first reminder is sent to the task owner. In the Days, Hours, and Minutes boxes directly below the Enable Repeat Reminder check box, specify the duration from when the task is first assigned to the user and the reminder is sent to the user. The duration is specified using the Days, Hours, and Minutes boxes. If the Days, Hours, and Minutes boxes all have a value of 0, the reminder will not be sent.
Change Task Instructions On Reminder
Changes the task instructions that are displayed to the user when the reminder is sent.
Reminder Instruction
The task instructions to use when a reminder is sent to the user.
EscalationProperties that reassign the task to another user, specify the time frame between when the task is assigned to the first user and when it is reassigned to another user, and specify who to reassign the task to.
(Optional) A boolean value to enable reassignment of a task after a specified time frame.
(Optional) A Task Date value that specifies the time frame before the task is reassigned to another user.
If you provide a literal value, you can modify the Days, Hours, and Minutes boxes that appear directly below the Schedule Escalation property. If the Days, Hours, and Minutes boxes all have a value of 0, the task will not be reassigned to another user.
(Optional) Select one of the following options to specify who to reassign the task to when the time frame specified in Schedule Escalation property is reached.
Assign To Specific User: A string value that represents the GUID (Global Unique Identifier) of the user profile to whom the task will be reassigned. The user profile must exist in the LiveCycle ES environment. Click the Browse button to display the Select User dialog box.
Assign To Process Creator: A string value that represents the GUID of the user profile who initiated the process.
Assign To Group: A string value that represents the GUID of the group profile to which to assign the task. Users belonging to the group profile can be assigned a task in one of the following ways:
Click the Browse button to display the Select Group dialog box.
XPath Expression: A string value which assigns the task. The XPath expression must evaluate to an existing user profile. The value representing the user profile must be stored in the process data, such as in a process variable or in form data.
DeadlineProperty that configures a deadline for the task.
(Optional) A Task Deadline value that specifies that a deadline is set for the task, the time frame for the deadline, whether to replace the task instructions with new instructions when the deadline has passed, and whether to proceed to another step in the process if the deadline has passed.
If you provide a literal value, you can enable the deadline using the following check boxes.
Enable Deadline: Enables deadlines on the task. After this check box is selected, configure the time frame for the deadline in the Days, Hours, and Minutes boxes directly below the Enable Deadline check box. If the Days, Hours, and Minutes boxes all have a value of 0, then no deadline is imposed on the task.
Change Task Instructions On Deadline: The task instructions change once the deadline has passed. The new instructions can be entered in the Deadline Instructions box below the Change Instructions On Deadline check box.
Follow A Specific Route: Proceed to another step in the process by following the specified route once the deadline has passed. The next step is selected in the Select Route list below the Follow A Specific Route check box.
ExceptionsThis operation can throw an InvalidPrincipal exception when the user, group, or domain no longer exists. This applies when you are specifying an initial user, an escalation user, or a group with whom to delegate or consult.
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/wb_help/00000987.html
