Using Orchestration Query Language

You can use the essential Orchestration Query Language (OQL) keywords and syntax to effectively write queries.

You can monitor the HCL Universal Orchestrator plan environment by using the OQL, which applies to REST API V2 and the Orchestration Monitor of the UI.

Write queries for items in your database and retrieve required results easily and quickly by using the OQL syntax.

An OQL query begins with an expression, which is composed of different conditions, known as queryTerms. A queryTerm is the minimum condition of a OQL construction, for example jobStreamName = test1.

QueryTerms include three main elements: a field, a comparison_operator, and a value. The fields and the values of the query are case-insensitive.

The field must begin with a letter. After the first letter, the field can contain the following characters:

  • 0 - 9
  • a - z
  • A - Z
  • _
  • -
  • .
You can express the value in one of the following ways:
  • Integers, both positive and negative.
  • Strings in single quotation marks (').
  • Duration, based on ISO 8601 standard. Duration is expressed in P[n]Y[n]M[n]DT[n]H[n]M[n]S format, where [n] replaces the value of each time and date element. For example, to express a duration of 4 hours and 20 seconds, the format to use is PT4H20S.
  • Instant, based on ISO 8601 standard. Instant is expressed in YYYY-MM-DDThh:mm:ss.milliseconds format. For example, to express the instant for December 1st, 2025 at 11 PM, the format to use is 2025-12-01T23:00:00.000Z.
  • Identifier (ID) based on Universally Unique Identifier (UUID) standard.

OQL syntax keywords and comparison operators

The following table details OQL keywords and comparison operators, both of which are essential for constructing effective queries.

Table 1. OQL syntax keywords
Keywords Description
AND Returns the results that satisfy all the conditions separated by AND. It is case insensitive.
OR Returns the results that satisfy at least one of the conditions separated by OR. It is case insensitive.
( Opens a priority expression.
) Closes a priority expression.
[ Opens a list.
] Closes a list.
= Returns all the elements equal to the specified element. Numbers, strings, or one of these keywords can follow the keyword: true, false, or null.
!= Returns all the elements different from the specified keyword. Numbers, strings, or one of these keywords can follow the keyword: true, false, or null.
<= Returns all the elements that are less than or equal to the specified keyword. Only numbers or strings can follow.
>= Returns all the elements that are greater than or equal to the specified keyword. Only numbers or strings can follow.
< Returns all the elements that are less than the specified keyword. Only numbers or strings can follow.
> Returns all the elements that are greater than the specified keyword. Only numbers or strings can follow.
IN Returns items that the specified list includes.
NOT IN Returns items that the specified list does not include.
LIKE Returns elements that match the specified pattern. The accepted characters are as follows:
  • @: matches all characters.
  • ?: matches a single character in a specific position.
NOT LIKE Returns elements that do not match the specified pattern. The accepted characters are as follows:
  • @: matches all characters.
  • ?: matches a single character in a specific position.
ORDER BY Orders the query results according to the specified fields. You can use the keyword at the end of the construction. By default, the field is sorted in ascending order. The accepted values are as follows:
  • ASC: Sorts the results in ascending order.
  • DESC: Sorts the results in descending order.
, Separates values inside a list.
. Specifies a subfield of an item.
true Represents the Boolean value true.
false Represents the Boolean value false.
null Represents the null value.

OQL syntax fields for workstations

The table below provides a comprehensive list and description of OQL fields that apply to workstations.
Note: OQL fields are case-sensitive; therefore, adherence to the exact capitalization and spelling is mandatory. OQL fields are case-sensitive; therefore, adherence to the exact capitalization and spelling is mandatory.
Table 2. OQL syntax fields for workstations
Field name Description
activeStates The statuses of the workstation.. Supported values are:
ONLINE|MONMAN|LINKED|START|RUNNING
Example:
activeStates IN ['ONLINE']
fence The minimum required priority value set for the tasks for them to be able to run on the workstation.
Example:
fence > '8'
folder The name of the folder where the workstation is saved.
Example:
folder LIKE '/@A/'
folderId The identifier of the folder of the workstation.
Example:
folderId = 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
id The identifier of the workstation.
Example:
id LIKE '@854d8d0d3639'
limit The number of tasks that can run simultaneously on a workstation.
Example:
limit > 7
name The name of the workstation.
Example:
name = 'wksrome'
nodeName The system hostname or IP address.
Example:
nodename LIKE '@_AGT_@'
os The operating system of the machine associated to the workstation. Supported values are:
WINDOWS|UNIX|LINUX|ZOS|AIX|HPUX|SOLARIS|AS400|WEB|OTHER
Example:
os NOT IN ['WINDOWS']
timeZone The time zone set on the workstation.
Example:
timeZone = 'America/New_York'
tcpPort The agent TCP port for unencrypted communication.
Example:
tcpPort != 1234
type The type of workstation. Supported values are: 
AGENT|CLOUD|POOL
Example:
type IN ['AGENT']
version The version of the workstation.
Example:
version = '2.1.1.0'

OQL syntax fields for workflows

The table below provides a comprehensive list and description of OQL fields that apply to workflows.
Note: OQL fields are case-sensitive; therefore, adherence to the exact capitalization and spelling is mandatory.
Table 3. OQL syntax fields for workflows
Field name Description
aliasJobStreamName The alias name of the workflow.
Example:
aliasJobStreamName LIKE '@rome'
commonStatus The external status of the workflow in plan. The supported values are: 
WAITING|WAITING_FOR_TRIGGER|READY|RUNNING|SUCCESSFUL|ERROR|CANCELED|HELD|UNDECIDED|BLOCKED|SUPPRESS
Example:
commonStatus IN ['ERROR','BLOCKED']
dependencies.dependencyStatus The status of the workflow dependency. Supported values are: 
SATISFIED|UNSATISFIED|UNDECIDED|UNBOUND
Example:
dependencies.dependencyStatus = 'SATISFIED'
dependencies.jobId The identifier of the task instance on which the workflow depends.
Example:
dependencies.jobId != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
dependencies.jobName The name of the task on which the workflow depends.
Example:
dependencies.jobName LIKE '@task1'
dependencies.jobStreamFolder

For dependencies on tasks, the name of the folder of the workflow to which the task belongs.

For dependencies on workflows, the name of the folder of the dependent workflow.

Example:
dependencies.jobStreamFolder LIKE '/@root/'
dependencies.jobStreamId

For dependencies on tasks, the id of the workflow to which the task belongs.

For dependencies on workflows, the id of the dependent workflow.

Example:
dependencies.jobStreamId NOT LIKE 'ca15f24a@'
dependencies.jobStreamName

For dependencies on tasks, the name of the workflow to which the task belongs.

For dependencies on workflows, the name of the dependent workflow.

Example:
dependencies.jobStreamName LIKE '@wf_exec'
dependencies.jobStreamSchedTime

For dependencies on tasks, the scheduled time of the workflow to which the task belongs.

For dependencies on workflows, the scheduled time of the dependent workflow.

Example:
dependencies.jobStreamSchedTime >= '2025-03-01T00:00:00.000Z'
dependencies.jobStreamWorkstation

For dependencies on tasks, the name of the workstation of the workflow to which the task belongs.

For dependencies on workflows, the name of the workstation of the dependent workflow.

Example:
dependencies.jobStreamWorkstation LIKE '@wks_rome@'
dependencies.members.dependencyStatus The status of the member within the join dependency. Supported values are:
SATISFIED|UNSATISFIED|UNDECIDED|UNBOUND
Example:
dependencies.members.dependencyStatus != 'UNDECIDED'
dependencies.members.jobId The identifier of the task instance of the member within the join dependency.
Example:
dependencies.members.jobId = 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
dependencies.members.jobName The name of the task of the member within the join dependency.
Example:
dependencies.members.jobName LIKE 'task@'
dependencies.members.jobStreamId

For join members that depend on tasks, the id of the workflow to which the task belongs.

For join members that depend on workflows, the id of the dependent workflow.

Example:
dependencies.members.jobStreamId = 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
dependencies.members.jobStreamName

For join members that depend on tasks, the name of the workflow to which the task belongs.

For join members that depend on workflows, the name of the dependent workflow.

Example:
dependencies.members.jobStreamName NOT LIKE '@workflow_145632@'
folder The name of the folder within which the workflow is saved.

Example:

folder = '/WF_FOLDER'
folderId The identifier of the folder within which the workflow is saved.
Example:
folderId NOT LIKE 'ca@'
id The identifier of the workflow.
Example:
id LIKE 'ca?5f24a-0e6b-3f1b-9251-854d8d0d3639'
jobs.dependencies.dependencyStatus The status of the dependency of a task in a workflow. Supported values are: 
SATISFIED|UNSATISFIED|UNDECIDED|UNBOUND
Example:
jobs.dependencies.dependencyStatus != 'SATISFIED'
jobs.dependencies.jobId The identifier of the task instance on which a task in the workflow depends.
Example:
jobs.dependencies.jobId != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
jobs.dependencies.jobName The name of the task instance on which a task in the workflow depends.
Example:
jobs.dependencies.jobName NOT LIKE 'task@'
jobs.dependencies.jobStreamFolder

For task dependencies on tasks, the name of the folder of the workflow to which the task belongs.

For task dependencies on workflows, the name of the folder of the dependent workflow.

Example:
jobs.dependencies.jobStreamFolder LIKE '/@root/'
jobs.dependencies.jobStreamId

For task dependencies on tasks, the id of the workflow to which the task belongs.

For task dependencies on workflows, the id of the dependent workflow.

Example:
jobs.dependencies.jobStreamId NOT LIKE '@ca@'
jobs.dependencies.jobStreamName

For task dependencies on tasks, the name of the workflow to which the task belongs.

For task dependencies on workflows, the name of the dependent workflow.

Example:
jobs.dependencies.jobStreamName LIKE '@task128932'
jobs.dependencies.jobStreamSchedTime

For task dependencies on tasks, the scheduled time of the workflow to which the task belongs.

For task dependencies on workflows, the scheduled time of the dependent workflow.

Example:
jobs.dependencies.jobStreamSchedTime = '2025-03-01T00:00:00.000Z'
jobs.dependencies.jobStreamWorkstation

For task dependencies on tasks, the name of the workstation of the workflow to which the task belongs.

For task dependencies on workflows, the name of the workstation of the dependent workflow.

Example:
jobs.dependencies.jobStreamWorkstation LIKE '@wks'
jobs.dependencies.members.dependencyStatus The status of the join member of a task in a workflow. Supported values are: 
SATISFIED|UNSATISFIED|UNDECIDED|UNBOUND
Example:
jobs.dependencies.members.dependencyStatus = 'SATISFIED'
jobs.dependencies.members.jobId The identifier of the task instance of the member within the task join dependency.
Example:
jobs.dependencies.members.jobId = 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
jobs.dependencies.members.jobName The name of the task of the member within the task join dependency.
Example:
jobs.dependencies.members.jobName NOT LIKE 'task?_@'
jobs.dependencies.members.jobStreamId

For task join members that depend on tasks, the id of the workflow to which the task belongs.

For task join members that depend on workflows, the id of the dependent workflow.

Example:
jobs.dependencies.members.jobStreamId NOT LIKE 'ca@'
jobs.dependencies.members.jobStreamName

For task join members that depend on tasks, the name of the workflow to which the task belongs.

For task join members that depend on workflows, the name of the dependent workflow.

Example:
jobs.dependencies.members.jobStreamName = 'wkflow_1'
jobs.jobDefinition.name The name of the task definition referenced by a task within the workflow.
Example:
jobs.jobDefinition.name LIKE '@exec_@'
jobs.jobDefinitionRefId The identifier of the task definition referenced by a task within the workflow.
Example:
jobs.jobDefinitionRefId != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
jobs.jobDefinition.recoveryJob The key of the recovery task of a task definition referenced by a task within the workflow.
Example:
jobs.jobDefinition.recoveryJob LIKE '@key434563@'
jobs.jobDefinition.recoveryJobId The identifier of the recovery task of a task definition referenced by a task within the workflow.
Example:
jobs.jobDefinition.recoveryJobId NOT LIKE 'th@'
jobs.jobDefinition.recoveryOption The recovery option of a task definition referenced by a task within the workflow. Supported values are STOP or CONTINUE.
Example:
jobs.jobDefinition.recoveryOption = 'STOP'
jobs.jobDefinition.recoveryRepeatAffinity The recovery repeat affinity option set on a task definition referenced by a task within the workflow. Supported values are true or false.
Example:
jobs.jobDefinition.recoveryRepeatAffinity = true
jobs.jobDefinition.recoveryRepeatInterval The recovery repeat interval of a task definition referenced by a task within the workflow.
Example:
jobs.jobDefinition.recoveryRepeatInterval > 'PT4H6S'
jobs.jobDefinition.recoveryRepeatOccurrences The recovery repeat occurrences of a task definition referenced by a task within the workflow.
Example:
jobs.jobDefinition.recoveryRepeatOccurrences > 5
jobs.jobDefinition.taskType The task type of the task definition referenced by a task within the workflow.
Example:
jobs.jobDefinition.taskType = 'executable'
jobs.jobDefinition.userLogins The user names that are used to run the task definition referenced by a task within the workflow.
Example:
jobs.jobDefinition.userLogins LIKE '@operator@'
jobs.jobDefinition.workstation The workstation of the task definition referenced by a task within the workflow.
Example:
jobs.jobDefinition.workstation = '/WSFOLDER/WS'
jobs.jobOptions.requiresConfirmation The task is flagged as "Requires confirmation". Supported values are true or false.
Example:
jobs.jobOptions.requiresConfirmation = true
jobs.jobruns.actualWorkstation The workstation where the task run within the workflow actually runs.
Example:
jobs.jobruns.actualWorkstation NOT LIKE '@wks@'
jobs.jobruns.commonStatus The external status of the task run within the workflow. The supported values are: 
WAITING|WAITING_FOR_TRIGGER|READY|RUNNING|SUCCESSFUL|ERROR|CANCELED|HELD|UNDECIDED|BLOCKED|SUPPRESS
Example:
jobs.jobruns.commonStatus IN ['WAITING', 'BLOCKED']
jobs.jobruns.compositeStatus.status The internal status of the task run within the workflow. Supported values are: 
HOLD|READY|FENCE|INTRO|FAIL|EXEC|WAIT|SUPPR|END|SUCC|SUCCP|ABEND|CANCL|CANCLP|ABENP|PEND|SUSP|STUCK|EXTRN
Example:
jobs.jobruns.compositeStatus.status NOT IN ['SUPPR']
jobs.jobruns.compositeStatus.substatus The substatus of the internal status of the task run within the workflow. Supported values are: 
HOLD_WAITING_FOR_PREDECESSOR|HOLD_UNEXPECTED_PREDECESSOR_CONDITION|HOLD_WAITING_FOR_TIME|HOLD_WAITING_FOR_PROMPT|HOLD_WAITING_FOR_FILE|HOLD_WAITING_FOR_INPUT|HOLD_PRIORITY_ZERO|READY_WAITING_FOR_RESOURCES|READY_SUPPRESSED|SUPPR_UNSATISFIED_DEPENDENCY|SUPPR_WORKSTATION_IGNORED|READY_SUBMITTED|READY_WAITING_FOR_LIMIT|READY_WAITING_FOR_AGENT|READY_WAITING_FOR_USER_INTERVENTION|SUCC_DO_NOT_RUN|SUCC_COMPLETED
Example:
jobs.jobruns.compositeStatus.substatus NOT IN ['HOLD_WAITING_FOR_TIME']
jobs.jobruns.confirmed The task run within the workflow has been confirmed. Supported values are true or false.
Example:
jobs.jobruns.confirmed = false
jobs.jobruns.id The identifier of the task run within the workflow.
Example:
jobs.jobruns.id LIKE '@kdhj134@'
jobs.jobruns.jobId The identifier of the task instance referenced by the task run within the workflow.
Example:
jobs.jobruns.jobId NOT LIKE 'ca_i3984284@'
jobs.jobruns.jobNumber The task number that identifies a task run within the workflow.
Example:
jobs.jobruns.jobNumber != '3834822'
jobs.jobruns.name The name of the task run within the workflow.
Example:
jobs.jobruns.name LIKE 'taskexec@'
jobs.jobruns.returnCode The return code of the task run within the workflow.
Example:
jobs.jobruns.returnCode != '1234'
jobs.jobruns.step The alias name of the task run within the workflow.
Example:
jobs.jobruns.step LIKE 'tas?@'
jobs.jobruns.submittedTime The time at which the task run within the workflow has been submitted.
Example:
jobs.jobruns.submittedTime = '2025-10-07T00:00:00.000Z'
jobs.jobruns.timeInfo.actualEndTime The time at which the task run ended.
Example:
jobs.jobruns.timeInfo.actualEndTime = '2025-10-10T03:20:00.000Z'
jobs.jobruns.timeInfo.actualStartTime The time at which the task run started.
Example:
jobs.jobruns.timeInfo.actualStartTime < '2025-10-10T03:20:00.000Z'
jobs.jobStreamId The identifier of the workflow.
Example:
jobs.jobStreamId LIKE '@-854d8d0d3639'
jobs.jobStreamName The name of the workflow.
Example:
jobs.jobStreamName LIKE '@WF@'
jobs.lastRunCommonStatus The external status of the last run of the task. Supported values are: 
WAITING|WAITING_FOR_TRIGGER|READY|RUNNING|SUCCESSFUL|ERROR|CANCELED|HELD|UNDECIDED|BLOCKED|SUPPRESS
Example:
jobs.lastRunCommonStatus IN ['READY']
jobs.lastRunCompositeStatus.status The internal status of the last run of the task. Supported values are: 
HOLD|READY|FENCE|INTRO|FAIL|EXEC|WAIT|SUPPR|END|SUCC|SUCCP|ABEND|CANCL|CANCLP|ABENP|PEND|SUSP|STUCK|EXTRN
Example:
jobs.lastRunCompositeStatus.status NOT IN ['FENCE', 'WAIT', 'ABEND']
jobs.lastRunCompositeStatus.substatus The substatus of the internal status of the last run of the task. Supported values are: 
HOLD_WAITING_FOR_PREDECESSOR|HOLD_UNEXPECTED_PREDECESSOR_CONDITION|HOLD_WAITING_FOR_TIME|HOLD_WAITING_FOR_PROMPT|HOLD_WAITING_FOR_FILE|HOLD_WAITING_FOR_INPUT|HOLD_PRIORITY_ZERO|READY_WAITING_FOR_RESOURCES|READY_SUPPRESSED|SUPPR_UNSATISFIED_DEPENDENCY|SUPPR_WORKSTATION_IGNORED|READY_SUBMITTED|READY_WAITING_FOR_LIMIT|READY_WAITING_FOR_AGENT|READY_WAITING_FOR_USER_INTERVENTION|SUCC_DO_NOT_RUN|SUCC_COMPLETED
Example:
jobs.lastRunCompositeStatus.substatus IN ['HOLD_UNEXPECTED_PREDECESSOR_CONDITION']
jobs.skipLateAction The action to take in case of late repeat of a task within the workflow. Supported values are:
overlap|immediate|none
Example:
jobs.skipLateAction = 'overlap'
jobs.timeRestrictions.deadlineTime The time within which a task within the workflow should complete.
Example:
jobs.timeRestrictions.deadlineTime = '2025-10-10T03:20:00.000Z'
jobs.timeRestrictions.lateAction The action to take on a task within the workflow when the deadline is expired. Supported values are continue or kill.
Example:
jobs.timeRestrictions.lateAction = 'continue'
jobs.timeRestrictions.lateStartAction The action to take on a task within the workflow when the latestStartTime is expired. Supported values are:
doNotRun|continue|cancel
Example:
jobs.timeRestrictions.lateStartAction != 'doNotRun'
jobs.timeRestrictions.latestStartTime The latest time a task within the workflow can start.
Example:
jobs.timeRestrictions.latestStartTime != '2025-10-10T03:20:00.000Z'
jobs.timeRestrictions.maxDuration The maximum duration set for a task within the workflow.
Example:
jobs.timeRestrictions.maxDuration > 'PT9H21M'
jobs.timeRestrictions.minDuration The minimum duration set for a task within the workflow.
Example:
jobs.timeRestrictions.minDuration < 'PT9H21M'
jobs.timeRestrictions.startTime The start time set for a task within the workflow.
Example:
jobs.timeRestrictions.startTime != '2025-10-10T03:20:00.000Z'
jobStreamModelId The identifier of the workflow definition.
Example:
jobStreamModelId LIKE '@idwkflw'
limit The limit value set for the workflow.
Example:
name LIKE '@WF@' AND (limit > 1 AND limit <= 3)
name The name of the workflow.
Example:
name != '@WF@'
originalJobStreamName The name of the workflow before any change was performed.
Example
originalJobStreamName NOT LIKE 'task@'
pendingEvents.eventPlugin The event plug-in type of a pending event within the workflow.
Example:
pendingEvents.eventPlugin = 'Webhook'
pendingEvents.eventSource The key of the event source of a pending event within the workflow.
Example:
pendingEvents.eventSource = '/FOLDER/ESO_NAME'
pendingEvents.eventSourceId The identifier of the event source of a pending event within the workflow.
Example:
pendingEvents.eventSourceId != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
pendingEvents.eventType The type of a pending event within the workflow.
Example:
pendingEvents.eventType = 'Generic'
pendingEvents.name The name of a pending event within the workflow.
Example:
pendingEvents.name LIKE 'event1@'
pendingEvents.scope The scope that describes the purpose of a pending event within the workflow.
Example:
pendingEvents.scope = 'triggering'
priority The priority value set for the workflow.
Example:
priority = 101
schedTime The scheduled time of the workflow.
Example:
schedTime >= '2025-03-01T00:00:00.000Z'
scheduledDate

The scheduled date of the workflow.

Example:
scheduledDate = '2025-03-01T00:00:00.000Z'
timeInfo.actualEndTime The time at which the workflow actually ended.
Example:
timeInfo.actualEndTime < '2025-03-02T10:35:22.000Z'
timeInfo.actualStartTime The time at which the workflow actually started.
Example:
timeInfo.actualStartTime < '2025-02-27T11:15:00.000Z'
timeRestrictions.deadlineTime The time within which the workflow should complete.
Example:
timeRestrictions.deadlineTime > '2025-03-01T00:00:00.000Z'
timeRestrictions.lateAction The action to take when the deadline is expired. Supported values are continue or kill.
Example:
timeRestrictions.lateAction = 'kill'
timeRestrictions.lateStartAction The action to take when the latestStartTime is expired. Supported values are:
doNotRun|continue|cancel
Example:
timeRestrictions.lateStartAction =  'continue'
timeRestrictions.latestStartTime The latest time a workflow can start.
Example:
timeRestrictions.latestStartTime = '2025-03-01T00:00:00.000Z'
timeRestrictions.startTime The start time set for a workflow.
Example:
timeRestrictions.startTime != '2025-10-07T00:00:00.000Z'
timeZone The time zone set on the workstation where a workflow runs.
Example:
timeZone = 'America/New_York'
triggeredBy The cause of the submission of the workflow, that explains how the workflow instance has entered the plan. Supported values are:
scheduling|event group|manual submit|service|nesting
Example:
triggeredBy = 'scheduling'
triggeringEvents.eventPlugin The event plug-in type of an event that has triggered the submission of the workflow.
Example:
triggeringEvents.eventPlugin = 'AWS'
triggeringEvents.eventSource The key of the event source of an event that has triggered the submission of the workflow.
Example:
triggeringEvents.eventSource LIKE 'evsource@'
triggeringEvents.eventType The type of an event that has triggered the submission of the workflow.
Example:
triggeringEvents.eventType = 'AWS SQS'
triggeringEvents.id The identifier of an event that has triggered the submission of the workflow.
Example:
triggeringEvents.id = 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
triggeringEvents.name The name of an event that has triggered the submission of the workflow.
Example:
triggeringEvents.name = 'event1'
triggeringEvents.receivedTime The time in which a triggering event has been received.
Example:
triggeringEvents.receivedTime != '2025-10-07T00:00:00.000Z'
triggeringEvents.scope The scope that describes the purpose of an event that has caused the submission of the workflow.
Example:
triggeringEvents.scope = 'triggering'
triggerName The name of an event that has triggered the submission of the workflow.
Example:
triggerName LIKE '@trigger'
workstation The workstation where the workflow runs.
Example:
workstation = '/WSFOLDER/WS'
workstationId The identifier of the workstation on which the workflow runs.
Example:
workstationId LIKE 'ca?15f@'

OQL syntax fields for tasks

The table below provides a comprehensive list and description of OQL fields that apply to tasks.
Note: OQL fields are case-sensitive; therefore, adherence to the exact capitalization and spelling is mandatory.
Table 4. OQL syntax fields for tasks
Field name Description
dependencies.dependencyStatus The status of the task dependency. Supported values are: 
SATISFIED|UNSATISFIED|UNDECIDED|UNBOUND
Example:
dependencies.dependencyStatus = 'SATISFIED'
dependencies.jobId The identifier of the task instance on which the task depends.
Example:
dependencies.jobId = 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
dependencies.jobName The name of the task on which the task depends.
Example:
dependencies.jobName NOT LIKE 'taskexec@'
dependencies.jobStreamFolder

For dependencies on tasks, the name of the folder of the workflow to which the task belongs.

For dependencies on workflows, the name of the folder of the dependent workflow.

Example:
dependencies.jobStreamFolder != '/root'
dependencies.jobStreamId

For dependencies on tasks, the identifier of the workflow to which the task belongs.

For dependencies on workflows, the identifier of the dependent workflow.

Example:
dependencies.jobStreamId LIKE '@be12h543b@'
dependencies.jobStreamName

For dependencies on tasks, the name of the workflow to which the task belongs.

For dependencies on workflows, the name of the dependent workflow.

Example:
dependencies.jobStreamName != 'wf1'
dependencies.jobStreamSchedTime

For dependencies on tasks, the scheduled time of the workflow to which the task belongs.

For dependencies on workflows, the scheduled time of the dependent workflow.

Example:
dependencies.jobStreamSchedTime <= '2025-03-01T00:00:00.000Z'
dependencies.jobStreamWorkstation

For dependencies on tasks, the name of the workstation of the workflow to which the task belongs.

For dependencies on workflows, the name of the workstation of the dependent workflow.

Example:
dependencies.jobStreamWorkstation != 'AGT943832'
dependencies.members.dependencyStatus The status of the member within the join dependency. Supported values are:
SATISFIED|UNSATISFIED|UNDECIDED|UNBOUND
Example:
dependencies.members.dependencyStatus IN ['UNBOUND']
dependencies.members.jobId The identifier of the task instance of the member within the join dependency.
Example:
dependencies.members.jobId != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
dependencies.members.jobName The name of the task of the member within the join dependency.
Example:
dependencies.members.jobName LIKE '@ga_rome@'
dependencies.members.jobStreamId

For join members that depend on tasks, the identifier of the workflow to which the task belongs.

For join members that depend on workflows, the identifier of the dependent workflow.

Example:
dependencies.members.jobStreamId NOT LIKE '@-854d8d0d363?9'
dependencies.members.jobStreamName

For join members that depend on tasks, the name of the workflow to which the task belongs.

For join members that depend on workflows, the name of the dependent workflow.

Example:
dependencies.members.jobStreamName = 'workflow9'
folder The name of the folder within which the task is saved.

Example:

folder ='/TASKFOLDER'
folderId The identifier of the folder within which the task is saved.
Example:
folderId NOT LIKE 'ca15f@'
id The identifier of the task.
Example:
id != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
jobDefinition.name The name of the task definition.
Example:
jobDefinition.name = 'europe2304'
jobDefinition.recoveryJob The name of the recovery task.
Example:
jobDefinition.recoveryJob != 'recovery_00'
jobDefinition.recoveryJobId The identifier of the recovery task.
Example:
jobDefinition.recoveryJobId LIKE '@ca15f24@'
jobDefinition.recoveryOption The recovery options set for the task definition. Supported values are:
STOP|CONTINUE|CONTINUE_PROMPT|RERUN|RERUN_PROMPT
Example:
jobDefinition.recoveryOption IN ['RERUN']
jobDefinition.recoveryRepeatAffinity The recovery repeat affinity option set on the task definition. Supported values are true or false.
Example:
jobDefinition.recoveryRepeatAffinity = true
jobDefinition.recoveryRepeatOccurrences The recovery repeat occurrences of the task definition.
Example:
jobDefinition.recoveryRepeatOccurrences > 8
jobDefinition.taskType The task type of the task definition.
Example:
jobDefinition.taskType = 'executable'
jobDefinition.userLogins The user names that are used to run the task definition referenced by a task.
Example:
jobDefinition.userLogins LIKE 'uno_user@'
jobDefinition.workstation The workstation of the task definition.
Example:
jobDefinition.workstation != 'AGT9'
jobDefinitionRefId The identifier of the task definition.
Example:
jobDefinitionRefId NOT LIKE '@ab8292@'
jobOptions.requiresConfirmation The task is flagged as "Requires confirmation". Supported values are true or false.
Example:
jobOptions.requiresConfirmation = false
jobruns.actualWorkstation The workstation where the task run actually runs.
Example:
jobruns.actualWorkstation NOT LIKE '@wks@'
jobruns.commonStatus The external status of the task run. Supported values are: 
WAITING|WAITING_FOR_TRIGGER|READY|RUNNING|SUCCESSFUL|ERROR|CANCELED|HELD|UNDECIDED|BLOCKED|SUPPRESS
Example:
jobruns.commonStatus NOT IN ['READY', 'RUNNING']
jobruns.compositeStatus.status The internal status of the task run. Supported values are: 
HOLD|READY|FENCE|INTRO|FAIL|EXEC|WAIT|SUPPR|END|SUCC|SUCCP|ABEND|CANCL|CANCLP|ABENP|PEND|SUSP|STUCK|EXTRN
Example:
jobruns.compositeStatus.status IN ['WAIT', 'ABEND']
jobruns.compositeStatus.substatus The substatus of the internal status of the task run. Supported values are: 
HOLD_WAITING_FOR_PREDECESSOR|HOLD_UNEXPECTED_PREDECESSOR_CONDITION|HOLD_WAITING_FOR_TIME|HOLD_WAITING_FOR_PROMPT|HOLD_WAITING_FOR_FILE|HOLD_WAITING_FOR_INPUT|HOLD_PRIORITY_ZERO|READY_WAITING_FOR_RESOURCES|READY_SUPPRESSED|SUPPR_UNSATISFIED_DEPENDENCY|SUPPR_WORKSTATION_IGNORED|READY_SUBMITTED|READY_WAITING_FOR_LIMIT|READY_WAITING_FOR_AGENT|READY_WAITING_FOR_USER_INTERVENTION|SUCC_DO_NOT_RUN|SUCC_COMPLETED
Example:
jobruns.compositeStatus.substatus IN ['HOLD_WAITING_FOR_PREDECESSOR']
jobruns.confirmed The task run has been confirmed. Supported values are true or false.
Example:
jobruns.confirmed = true
jobruns.id The identifier of the task run.
Example:
jobruns.id = 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
jobruns.jobId The identifier of the task instance referenced by the task run.
Example:
jobruns.jobId != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
jobruns.jobNumber The task number that identifies the task run.
Example:
jobruns.jobNumber != 43748503
jobruns.name The name of the task run.
Example:
jobruns.name NOT LIKE 'task9@'
jobruns.returnCode The return code of the task run.
Example:
jobruns.returnCode > 0
jobruns.step The alias name of the task run.
Example:
jobruns.step = 'taskdef232'
jobruns.submittedTime The time at which the task run has been submitted.
Example:
jobruns.submittedTime > '2025-03-01T00:00:00.000Z'
jobruns.timeInfo.actualEndTime The time at which the task run ended.
Example:
jobruns.timeInfo.actualEndTime < '2025-03-01T00:00:00.000Z'
jobruns.timeInfo.actualStartTime The time at which the task run started.
Example:
jobruns.timeInfo.actualStartTime = '2025-03-01T00:00:00.000Z'
jobStreamId The identifier of the workflow.
Example:
jobStreamId = 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
jobStreamName The name of the workflow.
Example:
jobStreamName NOT LIKE 'wkflow1@'
lastRunCommonStatus The external status of the last run of the task. Supported values are: 
WAITING|WAITING_FOR_TRIGGER|READY|RUNNING|SUCCESSFUL|ERROR|CANCELED|HELD|UNDECIDED|BLOCKED|SUPPRESS
Example:
lastRunCommonStatus IN ['WAITING_FOR_TRIGGER', 'HELD']
lastRunCompositeStatus.status The internal status of the last run of the task. Supported values are: 
HOLD|READY|FENCE|INTRO|FAIL|EXEC|WAIT|SUPPR|END|SUCC|SUCCP|ABEND|CANCL|CANCLP|ABENP|PEND|SUSP|STUCK|EXTRN
Example:
lastRunCompositeStatus.status IN ['READY']
lastRunCompositeStatus.substatus The substatus of the internal status of the last run of the task. Supported values are: 
HOLD_WAITING_FOR_PREDECESSOR|HOLD_UNEXPECTED_PREDECESSOR_CONDITION|HOLD_WAITING_FOR_TIME|HOLD_WAITING_FOR_PROMPT|HOLD_WAITING_FOR_FILE|HOLD_WAITING_FOR_INPUT|HOLD_PRIORITY_ZERO|READY_WAITING_FOR_RESOURCES|READY_SUPPRESSED|SUPPR_UNSATISFIED_DEPENDENCY|SUPPR_WORKSTATION_IGNORED|READY_SUBMITTED|READY_WAITING_FOR_LIMIT|READY_WAITING_FOR_AGENT|READY_WAITING_FOR_USER_INTERVENTION|SUCC_DO_NOT_RUN|SUCC_COMPLETED
Example:
lastRunCompositeStatus.substatus NOT IN ['HOLD_UNEXPECTED_PREDECESSOR_CONDITION']
name The name of the task.
Example:
name |= 'taskUnO'
priority The priority value set for the task.
Example:
priority > 0
schedTime The scheduled time of the task.
Example:
schedTime = '2025-03-01T00:00:00.000Z'
skipLateAction The action to take in case of late repeat. Supported values are:
overlap|immediate|none
Example:
skipLateAction IN ['overlap']
timeRestrictions.deadlineTime The time within which the task should complete.
Example:
timeRestrictions.deadlineTime != 2025-09-01T00:00:00.000Z'
timeRestrictions.lateAction The action to take on the task when the deadline is expired. Supported values are continue or kill.
Example:
timeRestrictions.lateAction = 'kill'
timeRestrictions.lateStartAction The action to take when the latestStartTime is expired. Supported values are:
doNotRun|continue|cancel
Example:
timeRestrictions.lateStartAction NOT IN ['continue']
timeRestrictions.latestStartTime The latest time a task can start.
Example:
timeRestrictions.latestStartTime > '2025-09-01T00:00:00.000Z'
timeRestrictions.maxDuration The maximum duration set for the task.
Example:
timeRestrictions.maxDuration != 'P3D'
timeRestrictions.minDuration The minimum duration set for the task.
Example:
timeRestrictions.minDuration > 'P3D'
timeRestrictions.startTime The start time set for the task.
Example:
timeRestrictions.startTime < '2025-09-01T00:00:00.000Z'
timeZone The time zone set on the workstation where the task runs.
Example:
timeZone = 'America/New_York'
workstation The workstation where the task runs.
Example:
workstation = '/WSFOLDER/WS'
workstationId The ID of the workstation on which the task runs.
Example:
workstationId != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'

OQL syntax fields for resources

The table below provides a comprehensive list and description of OQL fields that apply to resources.
Note: OQL fields are case-sensitive; therefore, adherence to the exact capitalization and spelling is mandatory.
Table 5. OQL syntax fields for resources
Field name Description
folder The folder of the resource.
Example:
folder != '/rome'
folderId The identifier of the folder of the resource.
Example:
folderId != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
id The id of the resource.
Example:
id NOT LIKE '@ca15f2@'
name The name of the resource.
Example:
name LIKE '@res@'
workstation The workstation of the resource.
Example:
workstation = '/WSFOLDER/WS'
workstationId The identifier of the workstation of the resource.
Example:
workstationId != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'

OQL syntax fields for event sources

The table below provides a comprehensive list and description of OQL fields that apply to event sources.
Note: OQL fields are case-sensitive; therefore, adherence to the exact capitalization and spelling is mandatory.
Table 6. OQL syntax fields for event sources
Field name Description
actualStatus The actual status of the event source. Supported values are:
CONNECTED|DISCONNECTED|LISTENING|ERROR
Example:
actualStatus IN ['CONNECTED', 'LISTENING']
eventPlugin The type of the event plug-in of the event source.
Example:
eventPlugin = 'Webhook'
folder The folder of the event source.
Example:
folder NOT LIKE '/root'
folderId The identifier of the folder of the event source.
Example:
folderId != 'ca15f24a-0e6b-3f1b-9251-854d8d0d3639'
id The id of the event source.
Example:
id NOT LIKE '@ca15f24a-@'
name The name of the event source.
Example:
name NOT LIKE 'storage@'
status The desired status of the event source. Supported values are:
CONNECTED|DISCONNECTED|LISTENING|ERROR
Example:
status IN ['DISCONNECTED']
type The event source type related to an event plug-in.
Example:
eventPlugin = 'Webhook' AND type = 'Generic'

Examples

This section shows various examples of OQL queries.
Workstation
  1. The following example shows a query that retrieves all the workstations in plan that either are linked or their workstation type is cloud:
    activeStates IN  ['LINKED'] OR type IN ['CLOUD']
  2. The example below shows a query that retrieves all the workstations that have all the following characteristics:
    • They have a name that contains the sequence of letters AGT
    • They are either agent or cloud type workstations
    • They are in LINKED state
    • They are contained in a folder whose name ends with letter A

      The results of the query must be ordered by name, sorted in descending order:

    name LIKE '@AGT@' AND type IN ['AGENT','CLOUD'] AND activeStates IN ['LINKED'] AND folder LIKE '/@A' ORDER BY name DESC
Workflow
  1. The example below shows a query that retrieves either:
    • Workflows whose name does not contain the word JS within and whose limit is greater than 1 and less or equal to 3

      Or

    • Workflows whose name contains the letter A and that has a priority greater than 9 and less or equal to 100
    (name NOT LIKE '@JS@' AND (limit > 1 AND limit <= 3)) OR (name LIKE '@A@' AND (priority > 9 AND priority <= 100))
  2. The following example shows a query that retrieves either:
    • Workflows that are in WAITING and READY status and that have a schedule time between March, 1st 2025 at 12 AM and April, 10th 2025 at 11:59 PM

      Or

    • Workflows that are in ERROR and BLOCKED status and that have a schedule time between January, 1st 2025 at 12 AM and April, 25th 2025 at 11:59 PM
    (commonStatus IN ['WAITING','READY'] AND (schedTime >= '2025-03-01T00:00:00.000Z' AND schedTime <= '2025-04-10T23:59:59.000Z')) OR (commonStatus IN ['ERROR','BLOCKED'] AND (schedTime >= '2025-01-01T00:00:00.000Z' AND schedTime <= '2025-04-25T23:59:59.000Z'))
  3. The following example shows a query that performs a basic search. Using regular plan filters, the query would correspond to /WSFOLDER/WS#/JSFOLDER/JSNAME:
    name = 'JSNAME' AND workstation = '/WSFOLDER/WS' AND folder ='/JSFOLDER'
  4. The below query retrieves all workflow whose status is either SUCC, ABEND, or STUCK, and whose start time is prior to 2025/04/27 11:15:00:000 UTC:
    compositeStatus.status IN ['SUCC','ABEND','STUCK'] AND timeInfo.actualStartTime < '2025-04-27T11:15:00.000Z'
  5. The following example shows a query that retrieves all the workflows that either:
    • Have priority value set to 101 and are in RUNNING status

      Or

    • Are on folder and on a workstation whose name starts with /WS
    (priority = 101 AND commonStatus = 'RUNNING') OR (workstation LIKE '/WS@' AND folder = '/')
Task
  1. The following example shows a query that retrieves all tasks that:
    • Have a name that starts with the letter A
    • Are part of the workflow named TASKS
    Moreover, the query retrieves tasks that either run on the workstation named /WORKSTATION, or that belong to workflow scheduled on /WORKSTATION:
    name LIKE 'A@'  AND (workstation = '/WORKSTATION' OR jobStreamWorkstation = '/WORKSTATION')  AND jobStreamName = 'TASKS'
  2. The following query retrieves all tasks that either are not in FAIL, ABEND, and HOLD, or have been cancelled:
    jobruns.compositeStatus.status NOT IN ['FAIL','ABEND','HOLD'] OR jobruns.compositeStatus.canceled = true
  3. The below query retrieves all tasks that are on a workstation with a name similar to WKS_rome, excluding those that have completed with either SUCCESSFUL or ERROR status:
    workstation LIKE '@WKS_rome@' AND jobruns.commonStatus NOT IN ['SUCCESSFUL','ERROR']
Resources
  1. The following example shows a query that retrieves all the resources that:
    • Have a name that contains the letters RES
    • Are saved in a folder named /FOLDER1
    • Are on a workstation different from AGT_ROME
    The results are sorted by name in descending order:
    (name LIKE '@RES@'  AND folder = '/FOLDER1' AND workstation != 'AGT_ROME')  ORDER BY name DESC
Event sources
  1. The following example shows a query that retrieves all the event sources that are actually connected and:
    • Have a name that starts with 'S' and are of Webhook Generic type

      OR

    • Have a name that starts with 'G' and are of AWS SQS type:
    actualStatus IN ['CONNECTED'] AND (name LIKE 'S@' AND eventPlugin = 'Webhook' AND type = 'Generic') OR (name LIKE 'G@' AND eventPlugin = 'AWS' AND type = 'AWS SQS')