showfile

The showfile command lists text files marked as dependencies for jobs or job streams. The associated jobs or job streams complete only after the orchestrator verifies and confirms the existence of these files.

Syntax and command line options

The showfile command checks for the existence of specific files. Use attributes to filter results or view data in various formats, including the job stream and job information associated with the file.

To run the command, provide a file name with wildcard characters or use the wildcard characters alone. The command requires at least one wildcard character to run. It then lists all files in the database, regardless of their current status.
ocli plan [showfile | sf] [[folder/workstation#][file_name]] [state] [keys]
or
ocli plan [showfile | sf] [[folder/workstation#][file_name]] [state] [deps:[info|key|logon]]
You can filter the results by adding the following attributes with the command:
  • [folder/]workstation
    Specify the name of the workstation where the file resides. Include the folder path to make the results more specific. You can also use wildcard characters to view details of similar files or multiple files within the same folder or workstation.
  • file_name
    Specify the name of the file. You can also use wildcard characters to view details of similar files or multiple files within the database.
  • state
    Specify the status of the file. You can also add any of the following:
    • Not Checked
      The existence of the file is not yet checked.
    • Checked
      The existence of the file is checked but not yet confirmed.
    • Exists
      The existence of the file is confirmed.
    • Not Exists
      The non-existence of the file is confirmed.
Add any one of the following attributes to the command to view the results in specific formats.
  1. standard format
    If you do not add any attributes to the command, the results are displayed in the standard format. This format shows the status and name of each file in the database.
  2. keys
    Lists the unique ID for each file.
  3. deps
    Lists the files alongside their dependent job streams or jobs. The command returns the following details:
    • deps
      • 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 sequence and its position in that sequence.
        • rerun step
          The job was rerun using 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.
    You can further customize these results using the keys, info, or logon options.
    • deps;keys
      Lists the unique ID of 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 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 sequence and its position in that sequence.
        • rerun step
          The job was rerun using 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.
      • 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.
    • 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.

Examples

  1. Run the command as follows to view all the files in the database:
    ocli plan showfile "@"
    The command produces an output in standard format:
    Status	                File Name
FILE_STATUS_NOT_EXISTS	/WA_AGT#/folder/test/new/testin1/unit(-w %p)
FILE_STATUS_NOT_EXISTS	/TEST/TESTWRKSTATION#/folder/test/new/testin2/unit(-f %p)
FILE_STATUS_NOT_EXISTS	/TEST/TESTWRKSTATION#/folder/test/new/testing/unit/one/two(-r %p)
FILE_STATUS_NOT_EXISTS	/TEST/EU-HWS-LNX12#/folder/test/new/testing/unit/one/two/three/four(-e %p)
  2. Run the command as follows to view the results in keys format:
    ocli plan showfile "@" keys
    The command produces an output similar to the following:
    68626f15-6481-30ed-8072-a5d0e353c537

c8cb285f-6b78-33e1-bc40-9b99f80bd8af

e5375660-2a67-3612-be1c-f11c08c81113

7a62d51d-12e5-3bc1-8ef4-fe75fdb809c4
  3. Run the command as follows to view the results in deps format:
    ocli plan showfile "@" deps
    The command produces an output similar to the following:
                                                                                                  (Est) (Est)
Workstation         Job Stream  SchedTime       Job                               State  Pr   Start  Elapse  ReturnCode  Dependencies

/TEST/EU-HWS-LNX12#/folder/test/new(-r %p) represents a dependency for:

  WA_AGT             #FILEJS    1534 03/02       ******************************** HOLD   10
ew(-r %p)
  4. Run the command as follows to view the results in deps logon format:
    ocli plan showfile "@" deps logon
    The command produces an output similar to the following:
      Workstation  Job Stream      SchedTime  Job                              State  Job#  Logon  ReturnCode

/WA_AGT#/folder/test/new/testin1/unit(-w %p) represents a dependency for:

WA_AGT         #TESTINGNEWJS1  1900 02/27 ******************************** HOLD

/TEST/TESTWRKSTATION#/folder/test/new/testin2/unit(-f %p) represents a dependency for:

/TEST/
TESTWRKSTATION #NEWONEJ1       1901 02/27 ******************************** HOLD

/TEST/TESTWRKSTATION#/folder/test/new/testing/unit/one/two(-r %p) represents a dependency for:

WA_AGT         #NEWTEST32       1914 02/27 ******************************** HOLD

/TEST/EU-HWS-LNX12#/folder/test/new/testing/unit/one/two/three/four(-e %p) represents a dependency for:

/TEST/
EU-HWS-LNX12   #NEW22           1916 02/27 ******************************** HOLD
  5. Run the command as follows to view the results in deps info format:
    ocli plan showfile "@" deps info
    The command produces an output similar to the following:
      Workstation      Job Stream       SchedTime  Job                                   JobFile  Opt  Job  Prompt
   Dependencies

/WA_AGT#/folder/test/new/testin1/unit(-w %p) represents a dependency for:

  WA_AGT           #TESTINGNEWJS1   1900 02/27

     /WA_AGT#/folder/test/new/testin1/unit(-w %p)

/TEST/TESTWRKSTATION#/folder/test/new/testin2/unit(-f %p) represents a dependency for:

  /TEST/
  TESTWRKSTATION   #NEWONEJ1        1901 02/27

      /TEST/TESTWRKSTATION#/folder/test/new/testin2/unit(-f %p)

/TEST/TESTWRKSTATION#/folder/test/new/testing/unit/one/two(-r %p) represents a dependency for:

  WA_AGT            #NEWTEST32      1914 02/27

     /TEST/TESTWRKSTATION#/folder/test/new/testing/unit/one/two(-r %p)

/TEST/EU-HWS-LNX12#/folder/test/new/testing/unit/one/two/three/four(-e %p) represents a dependency for:

  /TEST/
  EU-HWS-LNX12      #NEW22           1916 02/27

     /TEST/EU-HWS-LNX12#/folder/test/new/testing/unit/one/two/three/four(-e %p)
  6. Run the command as follows to view the results in deps keys format:
    ocli plan showfile "@" deps keys
    The command produces an output similar to the following:
    17b81c03-87ee-3030-a161-4af4dafaea2a.JOB1

17b81c03-87ee-3030-a161-4af4dafaea2a.JOB1