Versions Compared

Old Version 6

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version 7

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

<ul> <li>


  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CTI
criteria - CTI
criteria

n/a

Specific task instance with this task instance name that you want to cancel.

Valid values:

Html bobswift
Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - CTI
id - CTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CTI
name - CTI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - CTI
workflowInstanceName - CTI
workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CAD
criteria - CAD
criteria

n/a

Specific task instance with this task instance name for which
you want to clear all dependencies.

Valid values:

html-bobswift

<ul> <li>


  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - CAD
id - CAD
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CAD
name - CAD
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - CAD
workflowInstanceName - CAD
workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CED
criteria - CED
criteria

n/a

Specific task instance with this task instance name for which you want to clear exclusive dependencies.

Valid values:

html-bobswift

<ul> <li>


  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - CED
id - CED
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CED
name - CED
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - CED
workflowInstanceName - CED
workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CPD
criteria - CPD
criteria

n/a

Specific task instance with this task instance name for which you want to clear predecessor dependencies.

Valid values:

html-bobswift

<ul> <li>


  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - CPD
id - CPD
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CPD
name - CPD
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
predecessorName - CPD
predecessorName - CPD
predecessorName

n/a

Name of the predecessor task instance for which you want to clear dependency.

* = Clears dependencies from all predecessor task instances.

Y


Anchor
workflowInstanceName - CPD
workflowInstanceName - CPD
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CTD
criteria - CTD
criteria

n/a

Specific task instance with this task instance name for which you want to clear time dependency.

Valid values:

html-bobswift

<ul> <li>


  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - CTD
id - CTD
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CTD
name - CTD
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - CTD
workflowInstanceName - CTD
workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CVR
criteria - CVR
criteria

n/a

Specific task instance with this task instance name for which you want to clear virtual resource dependencies.

Valid values:

html-bobswift

<ul> <li>


  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - CVR
id - CVR
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CVR
name - CVR
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
resourceName - CVR
resourceName - CVR
resourceName

n/a

Name of the virtual resource for which you want to clear dependency.

* = Clears dependencies from all virtual resources.

Y


Anchor
workflowInstanceName - CVR
workflowInstanceName - CVR
workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - DTI
criteria - DTI
criteria

n/a

Specific task instance with this task instance name which you want to delete.

Valid values:

html-bobswift

<ul> <li>


  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Instance (3).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_instance).


N


Anchor
id - DTI
id - DTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - DTI
name - DTI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
recursive - DTI
recursive - DTI
recursive

n/a

For Workflow task instances only; Specification for whether or not to delete all children task instances of the task instance.

Boolean; Valid values: true/false. Default is false.

N


...

<ul> <li> As String = Oldest Active Instance, As Value = 1 <li> As String = Newest Active Instance, As Value = 2 <li> As String = Oldest Instance, As Value = 3 <li> As String = Newest Instance, As Value = 4 </ul>
  • As String = Oldest Active Instance, As Value = 1
  • As String = Newest Active Instance, As Value = 2
  • As String = Oldest Instance, As Value = 3
  • As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).
 


Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - FF
criteria - FF
criteria

n/a

Specific task instance with this task instance name that you want to force finish.

Valid values:

Html bobswift
Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
halt - FF
halt - FF
halt

n/a

Prevents successor task instances of the specified task instance in a Workflow from being run.

Boolean. Valid values: true/false. Default is false.

N


Anchor
id - FF
id - FF
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - FF
name - FF
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - FF
workflowInstanceName - FF
workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - FFC
criteria - FFC
criteria

n/a

Specific task instance with this task instance name that you want to force finish/cancel.

Valid values:

html-bobswift

<ul> <li>


  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
halt - FFC
halt - FFC
halt

n/a

Prevents successor task instances of the specified task instance in a Workflow from being run.

Boolean. Valid values: true/false. Default is false.

N


Anchor
id - FFC
id - FFC
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - FFC
name - FFC
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - FFC
workflowInstanceName - FFC
workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - HTI
criteria - HTI
criteria

n/a

Specific task instance with this task instance name that you want to hold.

Valid values:

html-bobswift

<ul> <li>


  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - HTI
id - HTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - HTI
name - HTI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - HTI
workflowInstanceName - HTI
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - ISCC
criteria - ISCC
criteria

n/a

Specific task instance with this task instance name that you want to issue a Set Completed command for.

Valid values:

html-bobswift

<ul> <li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - ISCC
id - ISCC
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - ISCC
name - ISCC
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - ISCC
workflowInstanceName - ISCC
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - ISSC
criteria - ISSC
criteria

n/a

Specific task instance with this task instance name that you want to issue a Set Started command for.

Valid values:

html-bobswift

<ul> <li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - ISSC
id - ISSC
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - ISSC
name - ISSC
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - ISSC
workflowInstanceName - ISSC
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
agentName - LTI
agentName - LTI
agentName

Agent

Name of the agent that this task instances is assigned to run on.


N


Anchor
businessServices - LTI
businessServices - LTI
businessServices

Member of Business Services

Business Services that this task instance belongs to.

Comma-separated list.

N


Anchor
customField1 - LTI
customField1 - LTI
customField1

Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.)

User-defined task field 1.

Wildcards are supported.

N


Anchor
customField2 - LTI
customField2 - LTI
customField2

Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.)

User-defined task field 2.

Wildcards are supported.

N


Anchor
executionUser - LTI
executionUser - LTI
executionUser

Execution User

Execution User of a task instance that determines the security context under which the task instance runs.

System-supplied.

N


Anchor
instanceNumber - LTI
instanceNumber - LTI
instanceNumber

Instance Number

Sequentially assigned number, maintained per task, representing the creation order of the instance.

Integer value.

N


Anchor
late - LTI
late - LTI
late

Started Late / Finished Late

Indication of whether or not to list all task instances that started late or finished late.

Valid values: true/false.

N


Anchor
lateEarly - LTI
lateEarly - LTI
lateEarly

Started Late / Finished Late / Finished Early

Indication of whether or not to list all task instances that started late, finished late, or finished early.

Valid values: true/false.

N


Anchor
name - LTI
name - LTI
name

Instance name

Name or partial name of one or more task instances.

Wildcards are supported.

Y
(unless sysId
is specified)

sysId

Anchor
status - LTI
status - LTI
status

Status

List of comma-separated task instance status codes and/or names (not case sensitive).

Specifying one or more statuses automatically excludes task instances in all other statuses.
 
To list task instances for all statuses, enter <status></status> in the request.
 
To list task instances for all statuses except one or more specific statuses, enter the status code or name for each status to be excluded with a preceding exclamation mark ( ! ). For example, !200.

N


Anchor
statusDescription - LTI
statusDescription - LTI
statusDescription

Status Description

Description (if any) of the current status of the Task Instance.

Wildcards are supported.

N


Anchor
sysId - LTI
sysId - LTI
sysId

n/a

sys_id used within the Controller to identify a task instance.


Y
(unless name
is specified)

name

Anchor
taskId - LTI
taskId - LTI
taskId

n/a

sys_id of the task definition that this Task Instance was created from.


N

taskName

Anchor
taskName - LTI
taskName - LTI
taskName

n/a

Name of the task definition that this Task Instance was created from.


N

taskId

Anchor
triggerId - LTI
triggerId - LTI
triggerId

n/a

sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger).


N

triggerName

Anchor
triggerName - LTI
triggerName - LTI
triggerName

n/a

Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.)


N

triggerId

Anchor
type - LTI
type - LTI
type

n/a

Task type of this task instance.

Valid values: One of the following (not case sensitive): application_control, email, email_monitor, agent_file_monitor, ftp, remote_file_monitor, indesca / universal_command / ucmd, manual, sap, sql, stored_procedure, system_monitor, task_monitor, timer, universal, unix, variable_monitor, web_service, windows, workflow, zos.
 
To list task instances for all task types, enter <type></type> in the request.

N


Anchor
updateTime - LTI
updateTime - LTI
updatedTime

n/a

If updatedTimeType = Offset; -offset period.

Valid values:

html-bobswift

<ul> <li>

  • mn
  • (minutes)
<li>
  • h
  • (hours)
<li>
  • d
  • (days)
</ul>

Default is d.
 
Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days).
 
If updatedTimeType is Since; date/time value
( yyyy-MM-dd [HH:mm:ss] )
 


Note
titleNote

The time is relative to the Time Zone specified for the User.


Y
(if updatedTimeType
is Offset, Since,
or Older Than.)


Anchor
updatedTimeType - LTI
updatedTimeType - LTI
updatedTimeType

n/a

Type of updateTime.

Valid values:

  • As String = Today, As Value = 1
  • As String = Offset, As Value = 2
  • As String = Since, As Value = 3
  • As String = Older Than, As Value = 4

N


Anchor
workflowDefinitionId - LTI
workflowDefinitionId - LTI
workflowDefinitionId

n/a

sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).


N

workflowDefinitionName

Anchor
workflowDefinitionName - LTI
workflowDefinitionName - LTI
workflowDefinitionName

n/a

Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).


N

workflowDefinitionId

Anchor
workflowInstanceCriteria - LTI
workflowInstanceCriteria - LTI
workflowInstanceCriteria

n/a

Specification for how workflowinstancename finds the matching workflow.

Valid values:

html-bobswift

<ul> <li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
workflowInstanceId - LTI
workflowInstanceId - LTI
workflowInstanceId

n/a

sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed.


N

workflowInstanceName

Anchor
workflowInstanceName - LTI
workflowInstanceName - LTI
workflowInstanceName

Workflow

Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed.


N

workflowInstanceId

...

<ul><li>
  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).


UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - LIST
criteria - LIST
criteria

n/a

Used if taskinstancename is specified; Specific task instance with this taskinstancename.

String; URI parameter. Valid values:

Html bobswift

N


Anchor
taskinstanceid - LIST
taskinstanceid - LIST
taskinstanceid

UUID

UUID of the task instance for which you want to list variables.

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor
taskinstancename - LIST
taskinstancename - LIST
taskinstancename

Instance Name

Name of the task instance for which you want to list variables.

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor
workflowInstanceName - LIST
workflowInstanceName - LIST
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - RTI
criteria - RTI
criteria

n/a

Specific task instance with this task instance name which
you want to release from hold.

Valid values:

html-bobswift

<ul> <li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Iinstance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - RTI
id - RTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - RTI
name - RTI
name

Instance Name

Name of the task instance


Y
(unless id
is specified)

id

Anchor
recursive - RTI
recursive - RTI
recursive

n/a

For Workflow task instances only; Specification for whether or not to release from hold all children task instances of the task instance.

Boolean; Valid values: true/false. Default is false.

N


Anchor
workflowInstanceName - RTI
workflowInstanceName - RTI
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - RER
criteria - RER
criteria

n/a

Specific task instance with this task instance name that you want to rerun.

Valid values:

html-bobswift

<ul> <li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - RER
id - RER
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - RER
name - RER
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
recursive - RER
recursive - RER
recursive

n/a

Indication of whether or not tasks within sub-workflows will qualify for rerun.

Valid values: true/false. Default is false.

N


Anchor
taskStatus - RER
taskStatus - RER
taskStatus

Status

If matched task instance is workflow type; List of comma-separated status codes or case-insensitive status names. All tasks within the matching workflow with a matching status will be queued for rerun.

Valid statuses:

  • Start_Failure (120)
  • Cancelled (130)
  • Failed (140)
  • Finished (190)
  • Success (200)

Y


Anchor
workflowInstanceName - RER
workflowInstanceName - RER
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - RET
criteria - RET
criteria

n/a

Used if taskinstancename is specified; Specific task instance with this taskinstancename.

String; URI parameter. Valid values:

html-bobswift

<ul><li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
numlines - RET
numlines - RET
numlines

Number of Lines

Number of lines to retrieve.

Integer

N


Anchor
outputtype - RET
outputtype - RET
outputtype

Output Type

Type of task instance output to retrieve.

String; URI parameter. Valid values:

html-bobswift

<ul><li>

  • As
  • String
  • =
  • OUTERR,
  • As
  • Value
  • =
  • 0
<li>
  • As
  • String
  • =
  • STDOUT,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • STDERR,
  • As
  • Value
  • =
  • 2
</ul

Default is OUTERR (0).

Y
(except for z/OS
task instances:
output defaults to
z/OS joblog)


Anchor
scantext - RET
scantext - RET
scantext

Scan Text

Scan the data for the text specified and retrieve only that.

String; URI parameter.

N


Anchor
startline - RET
startline - RET
startline

Start Line

Retrieve data beginning at the line indicated.

Integer; URI parameter. Default is 1.

N


Anchor
taskinstanceid - RET
taskinstanceid - RET
taskinstanceid

UUID

UUID of the task instance for which you want to retrieve output.

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor
taskinstancename - RET
taskinstancename - RET
taskinstancename

Instance Name

Name of the task instance for which you want to retrieve output.

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor
workflowInstanceName - RET
workflowInstanceName - RET
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - SOM
criteria - SOM
criteria

n/a

Specific task instance with this task instance name which
you want to release from hold.

Valid values:

html-bobswift

<ul> <li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>


  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>


  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>


  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
delayDuration - SOM
delayDuration - SOM
delayDuration

Delay Duration

If waitType is duration; Number of days, hours, minutes, and seconds to delay after starting the task.

Format: DD:HH:MM:SS

Y
(if delayType
is duration)


Anchor
delaySeconds - SOM
delaySeconds - SOM
delaySeconds

Delay Duration In Seconds

If delayType is seconds; Number of seconds to delay after starting the task.

Format: SS

Y
(if delayType
is seconds)


Anchor
delayType - SOM
delayType - SOM
delayType

Delay On Start

Amount of time to delay the start of a task once it is eligible to start.

Valid values:

  • As String = none, As Value = 0
  • As String = duration, As Value = 2
  • As String = seconds, As Value = 3

Y
(unless waitType
is specified.)


Anchor
id - SOM
id - SOM
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - SOM
name - SOM
name

Instance Name

Name of the task instance


Y
(unless id
is specified)

id

Anchor
waitDayConstraint- SOM
waitDayConstraint- SOM
waitDayConstraint

Wait Day Constraint

If waitTime is time or relative time; Specification for whether or not to advance the wait time to another day.

Valid values:

  • As String = none, As Value = 0
    • If waitType is time; Advance to the next day if calculated wait time is before the current time.
    • If waitType is relative time; Advance to the next day if calculated wait time is before the Trigger/Launch Time.
  • As String = same day/same_day, As Value = 1 (Do not advance day.)
  • As String = next day/next_day, As Value = 2 (Advance to the next day.)
  • As String = next business day/next_business_day, As Value = 3 (Advance to the next business day.)
  • As String = sunday, As Value = 4 (If today is not Sunday, advance to next Sunday.)
  • As String = monday, As Value = 5 (If today is not Monday, advance to next Monday.)
  • As String = tuesday, As Value = 6 (If today is not Tuesday, advance to next Tuesday.)
  • As String = wednesday, As Value = 7 (If today is not Wednesday, advance to next Wednesday.)
  • As String = thursday, As Value = 8 (If today is not Thursday, advance to next Thursday.)
  • As String = friday, As Value = 9 (If today is not Friday, advance to next Friday.)
  • As String = saturday, As Value = 10 (If today is not Saturday, advance to next Saturday.)

N


Anchor
waitDuration - SOM
waitDuration - SOM
waitDuration

Wait Duration

If waitType is duration; Number of days, hours, minutes, and seconds to wait before starting the task.

Format: DD:HH:MM:SS

Y
(if {{waitType
is duration)


Anchor
waitTime - SOM
waitTime - SOM
waitSeconds

Wait Duration In Seconds

If waitType is seconds; Number of seconds to wait before starting the task.

Format: SS

Y
(if waitType
is seconds)


Anchor
waitTime - SOM
waitTime - SOM
waitTime

Wait Time

If waitType is time or relative time; Number of hours and minutes to wait before starting the task.

Format: HH:MM

Y
(if waitType
is time or
relative time)


Anchor
waitType - SOM
waitType - SOM
waitType

Wait To Start

Amount of time to wait before starting a task after it has been launched.

Valid values:

  • As String = none, As Value = 0
  • As String = time, As Value = 1
  • As String = duration, As Value = 2
  • As String = seconds, As Value = 3
  • As String = relative time, As Value = 4

Y
(unless delayType
is specified.)


Anchor
workflowInstanceName - SOM
workflowInstanceName - SOM
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - SP
criteria - SP
criteria

n/a

Specific task instance with this task instance name that you want to set a priority for.

Valid values:

html-bobswift

<ul> <li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>


  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>


  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>


  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - SP
id - SP
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - SP
name - SP
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
priorityType - SP
priorityType - SP
priorityType

n/a

Sets the priority for this task instance.

Valid values: low, medium, high; Case-insensitive.

Y


Anchor
workflowInstanceName - SP
workflowInstanceName - SP
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - STI
criteria - STI
criteria

n/a

Specific task instance with this task instance name that you want to skip.

Valid values:

html-bobswift

<ul> <li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>


  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>


  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>


  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - STI
id - STI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - STI
name - STI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - STI
workflowInstanceName - STI
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

<ul> <li>
  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>


  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>


  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>


  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - STIP
criteria - STIP
criteria

n/a

Specific task instance with this task instance name whose path you want to skip.

Valid values:

Html bobswift
Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - STIP
id - STIP
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - STIP
name - STIP
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - STIP
workflowInstanceName - STIP
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - UTI
criteria - UTI
criteria

n/a

Specific task instance with this task instance name that you want to unskip.

Valid values:

html-bobswift

<ul> <li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>


  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>


  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>


  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is Oldest Active Instance (1).
 


Note
titleNote

Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).


N


Anchor
id - UTI
id - UTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - UTI
name - UTI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - UTI
workflowInstanceName - UTI
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...


UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - LIST
criteria - LIST
criteria

n/a

Used if taskinstancename is specified; Specific task instance with this taskinstancename.

String; URI parameter. Valid values:

html-bobswift

<ul><li>

  • As
  • String
  • =
  • Oldest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 1
<li>


  • As
  • String
  • =
  • Newest
  • Active
  • Instance,
  • As
  • Value
  • =
  • 2
<li>


  • As
  • String
  • =
  • Oldest
  • Instance,
  • As
  • Value
  • =
  • 3
<li>


  • As
  • String
  • =
  • Newest
  • Instance,
  • As
  • Value
  • =
  • 4
</ul>


Default is Oldest Active Instance (1).

N


Anchor
taskinstanceid - LIST
taskinstanceid - LIST
taskinstanceid

UUID

UUID of the task instance for which you want to update the Operational Memo.

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor
taskinstancename - LIST
taskinstancename - LIST
taskinstancename

Instance Name

Name of the task instance for which you want to update the Operational Memo.

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor
workflowInstanceName - LIST
workflowInstanceName - LIST
workflowinstancename

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


...