TaskContext values store the following values. The values
represent information about the task with which the TaskContext
value is associated.
actionInstanceId
A
string
value
that represents the unique identification of the run-time instance
of the service operation that generated the task.
assignedUser
A
User
value
that represents the user who is assigned the task.
assignedUserId
A
string
value
that represents the unique identification of the user who is assigned
the task.
classOfTask
A
string
value
that represents the type of task. The following values are valid:
-
Multi:
-
The Create Multiple Tasks operation generated the task.
-
Standard:
-
The Assign Task operation of the User 2.0 service created
the task.
-
Standard_LC8:
-
The Assign Task operation of the User 1.0 service created
the task. The task is the result of a legacy process that is running
in the LiveCycle ES2.5 environment.
createTime
A
dateTime
value
that represents the date and time when the task was created.
description
A
string
value
that represents the text from the Description property of the Assign
Task or Assign Multiple Tasks operation that generated the task.
formURL
A
string
that
represents the path of the application asset that is used with the task.
The values of the Presentation And Data properties of the Assign
Task or Assign Multiple Tasks operation that generated the task
determine the value of formURL:
-
When the Use An Application
Asset option is selected, this value is the path that is specified
for the Asset property.
-
When the Use A Document Variable option is selected, this
value is
null
.
inputDocument
A
document
value
that represents the document that is used as the presentation asset
for the task. The values of the Presentation And Data properties
of the Assign Task or Assign Multiple Tasks operation that generated
the task determine the value of inputDocument:
-
When
the Use A Document Variable option is selected, this value is the
value of the variable that is specified for the Variable property.
-
When the Use An Application Asset option is selected, this
value is
null
.
isDraft
A
boolean
value
that indicates whether the Workspace user who is assigned the task
has saved a draft copy of the task. The value is
true
if
the user has saved a draft copy. The value is
false
if
the user has not saved a draft copy.
isTaskActive
A
boolean
value
that indicates whether the task is active or not. A value of
true
indicates
the task is active. A value of
false
indicates
the task is completed.
processInstanceId
A
long
value
that represents the unique identification of the process instance
to which the task belongs.
processName
A
string
value
that represents the name of the process. This value is same as the
value of the Name property of the process.
routeList
A
string
value
that represents a comma-separated list of the names of User Actions
that are configured for the Assign Task or Assign Multiple Tasks operation.
For example, if the operation has two User Actions named action1
and action2, the value of routeList is
action1,action2
.
runtimeMap
A
map
of
string
values
that represent run-time information that is provided to Workspace.
The map contains the following useful keys:
-
acrobatVersion:
-
The version of Acrobat that that the user has installed.
-
acroClientType:
-
The client software that the user uses to open PDF documents, such
as Acrobat or Adobe Reader.
-
httpHeaders:
-
The HTTP headers that are included in the message that is
sent to Workspace on the LiveCycle server.
-
relativeTargetUrl:
-
The portion of the target URL after the IP address, for example
/workspace-server/submit
.
-
targetUrl:
-
The URL that the HTTP message is submitted to. For example
the value of targetURL when submitting to the LiveCycle server on
JBoss is
http://192.168.0.20:8080/workspace-server/submit
.
-
userAgent:
-
Information about the browser that is being used to open
the task.
selectedRoute
A
string
value
that represents the name of the User Action that the user selects to
complete the task. This value is
null
until the
task is completed.
serverReplyEmail
A
string
value
that represents the email address that is configured for the LiveCycle
server.
stepName
A
string
value
that represents the name of the operation on the process diagram
that generated the task. This value is the same as the value of
the Name property of the operation.
taskId
A
long
value
that represents the unique identification of the task.
taskInstructions
A
string
value
that represents the instructions that are provided with the task. This
value is the same as the value of the Task Instructions property
of the Assign Task or Assign Multiple Tasks operation that generated
the task.
taskStatus
A
short
value
that represents the status of the task. This read-only value and
can be one of the following numbers:
-
1:
-
The task has been created.
-
2:
-
The task has been created and saved. This status is assigned
when a user opens a task from the Start Process page of Workspace
and then saves a draft.
-
3:
-
The task is assigned to a user.
-
4:
-
The user has saved the task as a draft.
-
100:
-
The task has been completed.
-
101:
-
The task is completed because a deadline occurred.
-
102:
-
The task is completed because it was manually terminated
using LiveCycle Administration Console.
variationInputs
A
map
of
string
values
that represent the property-value pairs to use for configuring a
Guide variation. The map keys are the names of the variation input properties,
and the associated values are the property values. The values are configured
in the Presentation and Data properties of the Assign Task or Assign Multiple
Tasks operations. This value is
null
if no Guide
variation is used.
variationName
A
string
value
that represents the name of the Guide variation to use. This value is
null
if
no variation is selected in the Presentation and Data properties
of the Assign Task or Assign Multiple Tasks operations.
Use the runtimeMap data item to
pass data from Prepare Data processes to custom Render processes.
(See
