Note:
This operation was deprecated in LiveCycle
ES2. It is recommended that you change processes that you upgrade
to use the
Assign Task operation
operation of the User 2.0 service.
The operation is used in the design of human-centric processes.
It creates a task and assigns it to a user or group. The property
group permits you to configure the behavior of the task at run time,
as well as the Workspace features that people can use with the task
when they open it in Workspace or when they use email to complete
a task. You can also configure the email templates used for email
notifications that are sent to the user.
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
Initial User Selection properties
Property to specify the user or group to assign the task
to.
Select Initial User
The user or user group to assign the task
to.
-
Allow Out Of Office Designation:
-
A
boolean
value that specifies
whether to allow the task to be routed to another user when the
assigned user is out of the office. The default is
True
.
-
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 ES2.5 environment. Use the Browse button
that displays the Select User dialog box (see
About Select User
), 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:
-
Assign To Group Queue: Assigns the task to the
group’s shared To Do list.
-
Assign to Random User In Group: Assigns the task to any user
who belongs to the specified group profile.
Use the Browse
button to display the Select Group dialog box (see
About Select Group
), which is used to choose the group profile to
which to assign the task.
-
XPath Expression:
-
A
string
value that represents
an XPath expression that evaluates to one of the following values:
-
A
string
value that represents
a user or group GUID, canonical name, login identification, email address,
or common name.
-
A
User
value. (See
User
.)
-
A
Group
value. (See
Group
.)
Note:
You should use common name or email addresses
only if you are certain that they are unique.
You can obtain
User and Group values using the User Lookup service. (See
User Lookup
.)
Task Instructions properties
A property that describes what the user must do to complete
the task.
Task Instructions
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 Mappings properties
Properties 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.
Input Form Variable
A
Form
,
xfaForm
, or
Document Form
value that
stores the form information to use for retrieving, merging data
with, and pre-populating a form.
Form Must Be Saved
A
boolean
value that represents whether
the specified form must be filled and saved to complete the task.
A value of
True
requires that the form be opened
before submission within Workspace. A value of
False
permits the
user who is assigned the task to submit a form without opening it
and also permits the user who saves a form to complete a task using
the process card or list view. The default is
False
.
Task Id
(Optional) The location to store the identifier of
the task created for the operation. The data type is
long
.
Completed User Id
(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) properties
Property that is used to add and configure ACLs for users.
Task ACLs
(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.
You
can click Add to use the Select User dialog box to choose the user
profile that represents who to assign the task to. You can also
highlight entries from the User List and click Delete to remove
users from the ACL. Lastly, you can click ellipsis button
to
open XPath Builder to create the XPath expression to assign what
a user has permission to do with a task. The user that you specify
using an XPath expression can be identified in the same manner as assigning
a user using an XPath expression.
You can permit each user
to do these tasks:
-
Claim:
-
Claim a task. When users have this permission, they can claim
a task from another user’s queue.
-
Add Attachments:
-
Add attachments to the task. In addition, the user can set
read, modify, and delete rights on each new attachment.
-
Forward:
-
Delegate the task to another user.
-
Add Notes:
-
Add notes to the task. In addition, the user can set read,
modify, and delete rights on each new note.
-
Share:
-
Share the task. When a task is shared, the original permissions
are enforced, and the user with whom the task is shared can claim
the task as their own.
-
Consult:
-
Consult the task. When a task is consulted, it is similar
to forwarding the task; however, the consulting user cannot complete
the task. The consulting user can only render the form, submit data
on the form, save the form data, add attachments and notes, or return
the form to the user who consulted the task. The user who consulted
the task can complete the task after it is returned from the consulting user.
-
Add ACL For Shared Queue:
-
Add permissions for other users who have shared queue access
to the assigned user’s queue.
Delegation and Consultation properties
Properties to restrict with whom a user can forward or
consult.
Forward and 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 To And Share With Only
Members Of This Group:
-
Select this option to limit the forwarding or sharing of the
task to a specific user group.
Click Browse to select the
group. (See
About Select Group
.)
-
Consult Only To Members Of This Group:
-
Select this option to limit who can be sent the task for
consultation to the members of a user group.
Click Browse
to select the group. (See
About Select Group
.)
Attachments and Notes properties
Properties 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.
Options
(Optional)
Specifies whether attachments and notes can be added by users in
Workspace and how notes and attachments are handled for the operation.
-
Show Attachment Window For This Task:
-
Allows Workspace 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
.
Output Attachments
(Optional) The location to store the notes
and attachments. The data type is a
list
and a sub-type of
document
.
For information
about retrieving values from a list, see
Accessing data in data collections
.
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, such as
/process_data/listVar[1]
.
Routes and Priority properties
Property to provide routes as options for the user to submit
or complete a task and to specify the priority for the assigned
task.
Routes and Priority
(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 route names 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:
-
Displays route names as task submission options in Workspace.
When route names are prefixed with an underscore (_), the route
does not appear as a task submission option in Workspace. Avoid
hiding routes that are selected for deadlines by prefixing the route
name with an underscore; instead, select Omit Deadline Route From
Task Submit Options from the Deadline property group.
Note:
Names of routes that go to exceptions do not display
as buttons in Workspace.
-
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 is
Normal
.
Reminders properties
Properties to configure reminders to be sent to users.
Reminder
(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.
Use Business Calendar
(Optional) Changes the first reminder
to use business days instead of calendar days.
In the Days,
Hours, and Minutes boxes directly below the Use Business Calendar
check box, specify the duration from when the task is first assigned
to the user and the reminder is sent to the user. 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. Repeat reminders are
calculated from when the first reminder is sent.
-
Use Business Calendar:
-
(Optional) Changes repeat reminders to use business days
instead of calendar days. When this option is selected, the Hours
and Minutes boxes are unavailable, and the business calendar associated
with the selected user is used. If the selected user does not have
a business calendar configured, the default business calendar is used.
In
the Days, Hours, and Minutes boxes directly below the Use Business Calendar
check box, specify the duration from when the task is first assigned
to the user and the reminder is sent to the user.If the Days, Hours,
and Minutes boxes all have a value of
0
, the reminder
will not be sent.
Change Task Instructions On Reminder
Type the template for the
instructions in the box. Click the ellipsis button to incorporate
process data using XPath expressions. For information about templates,
see
Specifying template expressions
.
Escalation properties
Properties 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.
Escalate Task
(Optional) A
boolean
value to enable reassignment
of a task after a specified time frame. A value of
True
means
to escalate the task. The default value of
False
means
not to escalate the task once a time period has passed.
Schedule Escalation
(Optional) A
Task Date
value that specifies
the time frame before the task is reassigned to another user.
-
Use Business Calendar:
-
(Optional) Changes the scheduled escalation to occur in the
specified business days instead of calendar days. When this option
is selected, the Hours and Minutes boxes are unavailable, and the
business calendar associated with the selected user is used. If
the selected user does not have a business calendar configured,
the default business calendar is used.
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.
Select Escalation 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.
-
Allow Out Of Office Designation:
-
A
boolean
value that permits
the task to be reassigned when the selected escalation user is out
of the office. A value of
True
means to allow out
of office designation. A value of
False
does not
allow for out of office designation.
-
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 ES2.5 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:
-
Assign To Group Queue
:
Assigns the task to the group’s shared To Do list.
-
Assign to Random User In Group
: Assigns the task to
any user who belongs to the specified group profile.
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.
Deadline properties
Property that configures a deadline for the task.
Deadline
(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.
-
Use Business Calendar:
-
(Optional) When selected, the deadline date is calculated
based on the business calendar that is associated with the user
who is assigned the task.
Note:
If you use a business
calendar, you can use only days to specify when the deadline occurs.
-
Days:
-
The number of days from the time the task is created until
the deadline occurs.
-
Hours:
-
The number of hours, in addition to the days specified, until
the deadline occurs.
-
Minutes:
-
The number of minutes, in addition to the days specified,
until the deadline occurs.
-
Change Task Instructions On Deadline:
-
Select to specify new task instructions change when the deadline occurs.
Enter the new instructions in the box below the Change Instructions
On Deadline option.
-
Follow A Specific Route On Deadline:
-
Select this option to determine the next operation to execute
by specifying the route to follow when the deadline occurs.
-
Select Route:
-
The route to follow when Follow A Specific Route is selected.
If no routes originate from the Assign Task operation, There Are
No OutBound Routes appears in the list.
-
Omit Deadline Route From Task Submit Options:
-
Select to exclude the deadline route from the list of submit
options that appear for the task. (See
Routes and Priority properties
.)
For more information about deadlines,
see
Setting deadlines for tasks
.
Custom Email Templates properties
Property that configures the text in emails when a task
is assigned, a reminder occurs, or a deadline occurs.
Custom Email Templates
You can modify the email templates that
occur on a task:
-
Task Assignment:
-
A task is first assigned to a user.
-
Reminder:
-
A reminder is sent for the task.
-
Deadline:
-
The time to complete a task has passed.
For each selected
email template, you can select one of these options:
-
Use Server Default:
-
Use the email template configured on the server.
-
Do Not Send Email:
-
Do not send an email notification.
-
Customize:
-
Modify the email template for this task. You can click Edit
Email Template to use the Email Template Editor dialog box to modify
the email template for the specified action. (See
About Email Template Editor
.)
Exceptions
This 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.
|
|
|