showprompt

The command lists all prompts associated with jobs and job streams. Prompts are textual messages that are displayed to the user when a job or job stream runs. These jobs or job streams resume only after the user answers the prompts.

Syntax and command line options

You can filter results based on the prompt name, message number, or prompt status. The command also checks for the existence of specific prompts.

You can use attributes to view data in various formats, including the job stream and job information associated with the prompt. Use wildcard characters to broaden your search. The command requires at least one wildcard character to run. It then lists all prompts in the database, regardless of their current status.

ocli plan [showprompt | showprompts | sp] [[folder/]prompt_name] [msgnum] [state] [keys] [showid]

ocli plan [showprompt | showprompts | sp] [[folder/]prompt_name] [msgnum] [state] [deps;[keys | info | logon]]

You can filter the results by adding the following attributes with the command:

[folder/]prompt_name]

Specify the name of the workstation where the prompt is defined. Include the folder path to make the results more specific. You can also use wildcard characters to view details of similar prompts or multiple prompts within the database.
msgnum

Specify the unique number assigned to the prompt.
state
Specify the state of the prompt to be displayed. You can add any one of the following:
- NOT_ASKED
  
  The prompts are not yet issued.
- ASKED
  
  The prompts are issued and awaiting reply.
- ANSWERED_YES
  
  The prompts are issued and confirmed with a YES reply.
- ANSWERED_NO
  
  The prompts are issued and confirmed with a NO reply.

Add any one of the following attributes with the command to view the results in specific formats.

Standard format
If you do not add attributes to the command, the results are displayed in the standard format. This format shows the following details of the prompt:
- Prompt
  
  The name of the prompt.
- Status
  
  The current status of the prompt.
- Prompt Type
  
  The prompt type.
- Number
  
  The unique number assigned to the prompt.
- Message or Prompt
  
  Specifies the textual content within the prompt.
Keys

Lists the unique ID for each prompt.
deps
Lists the prompts alongside their dependent job streams or jobs. The following details are displayed:
- deps
  - Workstation
    
    The workstation on which the task or job stream runs.
  - Job Stream
    
    The name of the job stream.
  - SchedTime
    
    The date and time on which the task is scheduled to run. The date is displayed in mm/dd format.
  - Job
    
    The job name. The following notations may precede the job name.
    
    rerun as
    
    The job that was rerun either by the rerun command or as a part of automatic recovery.
    
    rerun rerun_number of rerun_total
    
    The job that was run as part of a rerun sequence and its position in that sequence.
    
    rerun step
    
    The job was rerun using the rerun;step command.
    
    every run
    
    The second and the subsequent runs of a job defined with the every attribute.
    
    recovery
    
    The job was run by a recovery job.
  - State
    
    Specifies the status of the job or job stream.
  - Pr
    
    The priority assigned to the job stream.
  - Start
    
    The estimated start time of the job or job stream.
  - Elapse
    
    The estimated run time of the job or job stream.
  - ReturnCode
    
    Specifies the return code of the job.
  - Dependencies
    
    Specifies the prompt associated with the job or job stream.
You can further customize these results using the keys, info, or logon options.
- deps;keys
  
  Lists the unique ID of the dependent job streams and jobs on each line.
- deps;info
  
  Lists the following details of the dependent jobs and job streams.
  
  workstation
  
  The workstation on which the job or job stream runs.
  
  Job stream
  
  The name of the jobstream.
  
  SchedTime
  
  The date and time on which the job is scheduled to run. The date is displayed in mm/dd format.
  
  Job
  
  The job name. The following notations may precede the job name.
  
  rerun as
  
  The job that was rerun either by the rerun command or as a part of automatic recovery.
  
  rerun rerun_number of rerun_total
  
  The job that was run as part of a rerun sequence and its position in that sequence.
  
  rerun step
  
  The job was rerun using the rerun;step command.
  
  every run
  
  The second and the subsequent runs of a job defined with the every attribute.
  
  recovery
  
  The task was run by a recovery job.
  
  JobFile
  
  Specifies the name of the script or the executable file of the job.
  
  Opt
  
  Specifies the available recovery options. The recovery options are RE for run, CO for continue, and ST for stop.
  
  Job
  
  Specifies the available recovery options.
  
  Prompt
  
  Specifies the number of the recovery prompt.
  
  Dependencies
  
  The prompt name is displayed. For predefined or global prompts, the name is preceded by the message number. For adhoc prompts only the number is displayed.
- deps;logon
  
  Lists the following details of the dependent jobs and job streams.
  
  workstation
  
  The workstation on which the job or job stream runs.
  
  Job stream
  
  The name of the job stream.
  
  SchedTime
  
  The date and time on which the job is scheduled to run. The date is displayed in mm/dd format.
  
  Job
  
  The job name. The following notations may precede the job name.
  
  rerun as
  
  The job that was rerun either by the rerun command or as a part of automatic recovery.
  
  rerun rerun_number of rerun_total
  
  The job that was run as part of a rerun and the position of job in the sequence.
  
  repeated as
  
  Specifies the subsequent run of every job.
  
  State
  
  Specifies the status of the job or job stream.
  
  Job#
  
  Specifies the job number.
  
  Logon
  
  Specifies the details of the user logged in.
  
  ReturnCode
  
  Specifies the return code of the job.
showid
Lists the following details of the prompts.
- Prompt ID
  
  The unique ID of the prompt.
- Prompt
  
  The name of the prompt.
- Status
  
  The current status of the prompt.
- Prompt Type
  
  The prompt type.
- Number
  
  The unique number assigned to the prompt.
- Message or Prompt
  
  Specifies the textual content within the prompt.

Examples

Run the command as follows to view all the prompts in the database:

ocli plan sp @

The command produces an output in standard format:

Prompt                           Status            Prompt Type           Number     Message or Prompt
1C/MASTERAGENTS#/JS2 [Tue Mar ...ASKED             Ad Hoc Prompt         1          Adhoc Prompt
/PRMT3                           ASKED             Predefined Prompt     2          ocli prompt
3C/MASTERAGENTS#/JS2 [Wed Mar ...NOT_ASKED         Ad Hoc Prompt         3          Adhoc Prompt
/PRMT1                           ASKED             Predefined Prompt     4          ready for job4? (y/n)

Run the command as follows to view the prompts in keys format:

ocli plan sp @ keys

The command produces an output similar to the following:

56aab039-30a9-36ef-9435-68d95580f76b

0c7cec83-19c8-336d-b453-28576d0e8755

38c49d4b-b1f0-3f8a-7854-e545a9b1d2a6

920fe5a8-fd20-320f-dfh1-c435969cf87a

da3b216c-17da-3fec-7458-c96badf86fc7

381d17e2-7ae2-38d4-7gt1-d20db6b1d344

587da0f7-e415-330d-1452-b9bc524341ba

Run the command as follows to view the prompts in deps format:

ocli plan sp @ deps

The command produces an output similar to the following:

  Workstation      Job Stream         SchedTime   Job                    State  Pr  Start  Elapse  ReturnCode  Dependencies

1(/PRMT1) represents a dependency for:

  MASTERAGENTS     #JOBS              0702 02/16  ***********************READY  10                             {02/16/26} 
                                                  JOB00                  HOLD   10                             #1(PRMT1)
                                                                                                               -1 /MASTERAGENTS#/RES1-                     
2(/PRMT2) represents a dependency for:

  MASTERAGENTS     #JOBS              0702 02/16  ***********************READY  10                             {02/16/26}
                                                  JOB01                  READY  10                         
                                                
7(/PRMT6) represents a dependency for:

  MASTERAGENTS     #JOBS              0702 02/16  ***********************READY  10                             {02/16/26}
                                                      JOB12      HOLD   10                                     #7(PRMT6)
                                                      JOB07      HOLD   10                                     #7(PRMT6)