show resource

You can run the showresource command to view information about resources.

Overview

Resources are a type of dependency that you can add to a task or workflow to create more complex and customized configurations. You can use the showresource command to display details about these resources such as, type and properties of resources, quantity, associated workstations and so on. You can view the information about resources in multiple formats. If you do not add any specific option in the command, the information is displayed in standard format. You can use the following attributes to view the results in three formats:

showid
keys
deps

You can further filter the deps format by using the following options:

keys
logon
info

Syntax and command line options

You can run the command as follows:

ocli plan showresource | sr [[/workstationfolder/workstationname#/foldername/resourcename] | [workstationname#/foldername/resourcename] | [/foldername/resourcename] | resourcename]

ocli plan showresource | sr [[/workstationfolder/workstationname#/foldername/resourcename] | [workstationname#/foldername/resourcename] | [/foldername/resourcename] | resourcename] ; showid

ocli plan showresource | sr [[/workstationfolder/workstationname#/foldername/resourcename] | [workstationname#/foldername/resourcename] | [/foldername/resourcename] | resourcename] ; keys

ocli plan showresource | sr [[/workstationfolder/workstationname#/foldername/resourcename] | [workstationname#/foldername/resourcename] | [/foldername/resourcename] | resourcename] ; deps [keys | info | logon]

The detail required with each parameter is as follows:

Resourcename

Enter the resource key to display a specific definition or use wildcard characters to display all the resource definitions at the same time. If the resource is defined in the root folder, specify only the name of the resource. Otherwise add the resource key that contains the workstation name and folder name as follows:

[[/workstationfolder/workstationname#/foldername/resourcename] | [workstationname#/foldername/resourcename] | [/foldername/resourcename] | resourcename]

Customizable display formats

Standard format
If you do not specify any option with the command, the details are displayed in the standard format. The following details are displayed:

Workstation

The workstation associated with the resource.

Resource

The name of the resource.

Total

The total quantity of the resource in units.

Available

The number of units available in the resource for allocation to tasks or workflows.

Quantity

The number of units allotted to a particular task or workflow.

Shared

If the resource is shared between multiple tasks or workflows, then Y is displayed or else N.

Used by

All the workflows utilizing the resource units are displayed.
Example:
```
ocli plan sr @#@

Workstation      Resource         Total  Available   Qty   Shared Used By
/WS_AGT_0        RES1             25     25          No holders of this resource
/WS_AGT_0        RES2             25     25          No holders of this resource
/WS_AGT_0        RES3             25     25          No holders of this resource
```
showid
When you add this option, the result shows all the fields that are displayed for standard format with one difference. The Used by field shows a unique identifier that identifies the task or workflow. In plan, the tasks or workflows are not only identified by the name but also the folder in which it is defined. The name of the task or workflow and the location of the folder where it is defined is linked to a unique identifier.
Example:
```
ocli plan sr RES9090646687 showid

Workstation      Resource         Total  Available   Qty   Shared Used By
/WS_AGT_0        RES9090646687    20     17          3     Y      24709d66-0717-48d6-9302-507b3725bffd
```

keys

Only the unique ID associated with each resource is displayed.

Example:

ocli plan sr RES9090646687 keys


b31fe964-bba7-4520-89d5-0cde3377fb00.JRESPLAN01085954927

deps
The result shows details of the tasks and workflows dependent on the selected resource. The following details are displayed:

Workstation

The workstation associated with the resource.

Job stream

The ID of the workflow associated with the resource.

SchedTime

The date and time on which the task is scheduled to run.

Job

The ID of the task associated with the resource.

State

The current state of the workflow associated with the resource.

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.
Return code
The return code of the task.
Example:
ocli plan sr @#@ deps (Est) (Est) Workstation Job Stream SchedTime Job State Pr Start Elapse ReturnCode Dependencies /WS_AGT_0#/RES1085954927 represents a dependency for: WS_AGT_0 #JSRESPLAN01085954…0900 01/24 **************************************** SUCC 10 09:00 00:00 0
You can furhter filter the results with the following options:
- deps;keys
  
  Only the unique ID of the task or workflow dependant on the selected resource is displayed.
  Example:
  ocli plan sr @#@ deps keys b31fe964-bba7-4520-89d5-0cde3377fb00.JRESPLAN01085954927
- deps;logon
  
  If you add this option, in addition to the Workstation, Job stream, SchedTime, Job, State fields, the result also shows the following fields:
  
  Job#
  
  The unique number of the task associated with the agent.
  
  Logon
  
  Details of the user.
  Note: You can view the following information for the Windows operating system.
  
  username
  
  domain\username
  
  username@internet_domain
  
  Example:
  ocli plan sr @#@ deps logon Workstation Job Stream SchedTime Job State Job# Logon ReturnCode /WS_AGT_0#/RES1085954927 represents a dependency for: WS_AGT_0 #JSRESPLAN0108595…0900 01/24 JRESPLAN01085954927 SUCC #J755150wauser 0
- deps;info
  
  If you add this option, in addition to the Workstation, Job stream, SchedTime, Job fields, the result also shows the following fields:
  
  Job file
  
  The name of the script or the executable file of the task.
  Note: File names that are too long might wrap, resulting in incorrect paging. You can use the more option to have a clear view of the results that are displayed.
  
  opt
  
  The recovery option specified for the task, if any.
  
  Job
  
  The task alias, if the task is submitted with an alias.
  Example:
  ocli plan sr @#@ deps info -------- Restart --------- Workstation Job Stream SchedTime Job JobFile Opt Job Prompt /WS_AGT_0#/RES1085954927 represents a dependency for: WS_AGT_0 #JSRESPLAN010859540900 01/24 JRESPLAN01085954927 --- executable: script: ls credential: userName: wauser password: "${password:wauser}"