showsched

You can use the showsched command to display the information about workflows.

Overview

The information about to workflows is displayed in three formats: standard, keys, and deps. You can use the keys, info and logon options to further modify the results for deps display. You can use wildcards to filter workflows and the folders in which they are defined. For more information, see Special characters as wildcards and delimiters.

Syntax and command line options

The options that you can use with the command are as follows:
ocli plan showsched | ss jstreamselect [;keys] [;showid]
or
ocli plan showsched | ss jstreamselect [;deps [;keys | ;info | ;logon]][;showid][;events]

If you do not specify any options the results are displayed in standard format. The details that are required with each parameters are as follows:

jstreamselect

You can specify the workflow that contains the tasks which you want to view.

keys

If you use this option, the results are displayed with only the workflow ID per line.

deps
If you use the option, the results are displayed with workflows that are used in follows dependencies. You can use the keys, info, and logon options to further filter the results. The tasks and workflows are listed in the Standard format and standard showsched format respectively.
  • deps;keys

    If you use the keys parameter with deps option, the workflows that are used in the follows dependencies are displayed with only the workflow ID per line.

  • deps;info

    The tasks in the results are displayed in showjobs;info format and the workflows are displayed in the standard showsched format.

  • deps;logon

    The tasks in the results are displayed in showjobs;logon format and the workflows are displayed in the standard showsched format.

showid

When you add this option, the results will display a unique identifier that identifies the workflow. In plan, the workflows are not only identified by the name but also the folder in which it is defined. The name of the workflow and the location of the folder where it is defined is linked to a unique identifier.

events

If you add this option, the events that trigger the workflow are displayed with the following information:
  • EventSource
    The event source of the event.
  • EventType
    The type of event.
  • Plugin
    The plug-in that creates the event.
  • Received Time
    The date and time when the event that matches with one event condition of the workflow is received. If the event does not match any event condition, no values are displayed.
  • Scope
    Describes the event received that matches with one event condition of the workflow. If the event does not match any event condition, no values are displayed.
standard format
If you do not specify any options with the showsched command, the results are displayed in standard format. The format contains the following information:
  • Workstation

    The name of the workstation the workflow runs on.

  • Job stream

    The workflow name.

  • SchedTime

    The scheduled time and date of the workflow to start the run. The date is displayed in the mm/dd format.

  • State
    Specifies the current status of the workflow. The different states are as follows:
    • ABEND

      A malfunction has ended the workflow.

    • CANCELP

      The workflow cancellation is pending. The workflow is cancelled when all the dependencies are resolved.

    • EXEC

      The workflow is in progress.

    • HOLD

      The workflow is waiting for dependencies to resolve.

    • READY

      All dependencies of the workflow are resolved and the tasks are ready to start.

    • STUCK

      The workflow run is interrupted. The tasks in the workflow cannot start without the user intervention.

    • SUCC

      The workflow finished successfully.

    • SUPPR

      The workflow is suppressed because the related conditional dependencies are not resolved.

  • Pr

    The priority of the workflow.

  • (Est)Start

    The start time of the task or workflow. The (Est) element indicates the expected start time. If the start time is before or after 24 hours, the date instead of time is displayed, for example, mm/dd/yy or mm/dd.

  • (Est)Elapse
    The run time of the task or workflow. The (Est) element indicates the expected start time.
  • Jobs #

    The number of tasks in the workflow.

  • Jobs OK

    The number of tasks that have completed successfully.

  • Sch Lim

    The limit of workflow.

Notes:

dependencies

Dependencies associated with tasks are displayed and any combination of the following information can be listed.
  • The workflow or task name is displayed for the follows dependency. The name is followed by [P], if it is a pending predecessor.
  • For conditional dependencies the name of the predecessor task or workflow is followed by the output conditions in this format, IF <condition name>. The <condition name> can be the final status of the predecessor task, the workflow status or condition based on the predecessor task output. When you have multiple conditions, they are separated by the vertical bar (|).
  • For an until time, the time is preceded by an angle bracket (<).
  • Cancelled workflows are labelled with this message [Cancelled].
  • The workflows that are cancelled with the ;pend option are labeled [Cancel Pend].
  • For a deadline time, the time displayed is preceded by an angle bracket (<).
  • The workflows with the carryforward keyword are labelled [Carry].
  • The initial name and date of workflows are displayed in brackets that are carried forward form the previous production plan.
  • When the results are displayed for the showsched command, the time dependencies are shown in the start column as described below:
    • Only the time hh:mm, if the date on which the command is run matches with the date set on the workflow.
    • Only the date dd/mm, if the date on which the command is run does not matches with the date set on the workflow.

Examples

  1. Run the following command to display the status for the WF1 workflow defined on the WS_AGT_1 workstation in the root folder with the workflow identifier.
    ocli plan ss /WS_AGT_1#WF1 showid
    The sample output is given below:
                                                           (Est)  (Est)    Jobs  Sch
    Workstation      Job Stream        SchedTime  State Pr Start  Elapse   #  OK Lim
    WS_AGT_1        #WF1               0000 03/16 SUCC  10 09:18  00:00    1   1          {81b4f5e6-2853-4f2d-86c8-e6b1aca192d8}
    
  2. Run the following command to display the status of all workflows defined in all folders in the HOLD state on the workstation on which you are running Orchestration CLI:
    ocli plan ss /@/@+state=HOLD
    The sample output is given below:
                                                            (Est)  (Est)    Jobs  Sch
    Workstation      Job Stream        SchedTime  State Pr Start  Elapse   #  OK Lim
    WS_AGT_0        #WORKFLOW_151736…1316 03/15 HOLD  10(13:16)          1   0
    WS_AGT_0        #WORKFLOW_153149…1329 03/15 HOLD  10                 1   0          [Cancelled]
    WS_AGT_0        #WORKFLOW_153542…1333 03/15 HOLD  10                 1   0          [Cancelled]
    WS_AGT_0        #WORKFLOW_153542…1334 03/15 HOLD  10(13:34)          1   0          WS_AGT_0#WORKFLOW_PRED_153542026(0000 03/15/23).@
    WS_AGT_0        #WORKFLOW_153754…1335 03/15 HOLD  10                 1   0          [Cancelled]
    WS_AGT_0        #WORKFLOW_153932…1337 03/15 HOLD  10                 1   0          WS_AGT_0#WORKFLOW_PRED_153932096(0000 03/15/23).@
    WS_AGT_0        #WORKFLOW_154221…1340 03/15 HOLD  10                 1   0          WS_AGT_0#WORKFLOW_PRED_154221947(0000 03/15/23).@
    
  3. Run the following command to display the status of all workflows with the name beginning with WORKFLOW_PRED on the WS_AGT_0 workstation in the ;deps;info format:
    ocli plan ss WS_AGT_0#WORKFLOW_PRED@;deps;info
    The sample output is given below:
      -------- Restart ---------
      Workstation      Job Stream       SchedTime  Job                                    JobFile                  Opt  Job            Prompt
    
    WS_AGT_0#/WORKFLOW_PRED_152439416[(2300 03/14),(5fce9706-0042-40fd-af5f-258cae0b1aeb)] represents a dependency for:
    
      WS_AGT_0        #WORKFLOW_1524391322 03/15
                                                   TASK_DEFINITION_152439416                 netstat -an
    
    WS_AGT_0#/WORKFLOW_PRED_152732126[(2300 03/14),(ea6ab877-de10-4dce-8670-382d977e0bca)] represents a dependency for:
    
      WS_AGT_0        #WORKFLOW_1527321325 03/15
                                                   TASK_DEFINITION_152732126                 netstat -an
    
    WS_AGT_0#/WORKFLOW_PRED_153149897[(2300 03/14),(fe5060dd-bf4e-483a-b873-6856f621011d)] represents a dependency for:
    
      WS_AGT_0        #WORKFLOW_1531491329 03/15
                                                   TASK_DEFINITION_153149897                 netstat -an
    
  4. Run the following command to display the status of all workflows defined in all folder and on all workstations defined in all folders:
    ocli plan ss /@/@#/@/@
    The sample output is given below:
                                                           (Est)  (Est)    Jobs  Sch
    Workstation      Job Stream        SchedTime  State Pr Start  Elapse   #  OK Lim
    CLOUD           #TASK_PLUGIN_151126…1511 03/14 ABEND 10 03/14  00:00    1   0
    CLOUD           #TASK_PLUGIN_151153…1511 03/14 ABEND 10 03/14  00:00    1   0
    CLOUD           #TASK_PLUGIN_151208…1512 03/14 ABEND 10 03/14  00:00    1   0
    CLOUD           #TASK_PLUGIN_151219…1512 03/14 ABEND 10 03/14  00:00    1   0
    CLOUD           #TASK_PLUGIN_151230…1512 03/14 ABEND 10 03/14  00:00    1   0
    CLOUD           #TASK_PLUGIN_151246…1512 03/14 ABEND 10 03/14  00:00    1   0
    CLOUD           #TASK_PLUGIN_151257…1513 03/14 ABEND 10 03/14  00:00    1   0