Used to launch tasks such as workflows or reports. The task to be launched must be defined by a TaskDefinition or TaskTemplate object in Waveset. Launching the task results in the creation of a TaskInstance object.
This view contains one top-level attribute named task. All other top-level attributes are arbitrary and are passed as inputs to the task.
This top-level attribute defines how the task is to be launched.
Table 3–39 Process View Attributes
Attribute |
Editable? |
Data Type |
Required? |
---|---|---|---|
process |
Read/Write |
String |
Yes |
taskName |
Read/Write |
String |
Yes |
organization |
Read/Write |
String |
Yes |
taskDisplay |
Read/Write |
String |
No |
description |
Read/Write |
String |
No |
execMode |
Read/Write |
String |
No |
result |
Read/Write |
WavesetResult |
No |
owner |
Read/Write |
String |
No |
Names the process to launch. This can be the name of a TaskDefinition or TaskTemplate object in Waveset. It can also be an abstract process name mapped through the process settings in the System Configuration object. This attribute is required.
Specifies the name given to the TaskInstance object that is created to hold the runtime state of the task. If this attribute is not set, a random name is generated.
Names the organization in which to place the TaskInstance. If this attribute is not set, the TaskInstance is placed in Top.
Specifies a display name for the TaskInstance.
Specifies a descriptive string for the TaskInstance. This string is displayed in the Manage Tasks table in the product interface.
Specifies execution mode. This is typically not specified, in which case the execution mode is determined by the TaskDefinition. Setting this attribute overrides the value in the TaskDefinition.
Allowed execMode values are:
Table 3–40 execMode Attribute Values (Process View)
Value |
Description |
---|---|
sync |
Specifies synchronous or foreground execution |
async |
Specifies asynchronous or background execution |
asyncImmediate |
Specifies asynchronous with immediate thread launch |
Use the asyncImmediate execution mode only for special system tasks that must pass non-serializable values into the task through the view. The task thread is started immediately. The default behavior is to save the TaskInstance temporarily in the repository and have the Scheduler resume it later.
Specifies the initial result for the TaskInstance. You can use this setting to pass information into the task that you eventually want displayed with the task results when the task completes.
Specifies the user name that is considered to be the owner of the task. If not set, the currently logged-in user is designated as the owner.
The following options are recognized by the createView and checkinView methods.
Specifies that the task is being launched from the Waveset User Interface. This allows users with no formal privileges to launch specially designated end-user tasks.
Names the process to launch. This name is recognized by the createView method and becomes the value of the process attribute in the view.
When set to true, suppresses a default message that is added to the task result when an asynchronous task is launched. The default English text is, The task is being executed in the background.
The following named result items can be found in the WavesetResult object that is returned by the checkinView method.
Table 3–41 Checkin View Results
Result |
Description |
---|---|
taskId |
Identifies the repository ID of the TaskInstance |
taskState |
Identifies the current state of the TaskInstance. It will be one of: ready, executing, suspended or finished |
extendedResults |
When set to true, indicates that the TaskInstance will have extended results. |