display

You can use the command option to view the entire information about the item definitions of the same type.

Overview

You can configure the command line syntax with different parameters to view specific results. In this way, you can view the information about one or the entire item definitions of the same type available in the database. The details for each item are displayed as described in the table.
Table 1. Output format for displaying items
Items Details
access control list
  • Name
  • Updated On
  • Locked By
  • Access control list definition
aiagent
  • Name
  • Updated On
  • Locked By
  • Access control list definition
calendar
  • Calendar name
  • Updated On
  • Locked By
  • Calendar definition
event source
  • Event source name
  • Updated On
  • Locked By
  • Desired status
  • Event source definition
folder
  • Name
  • Updated On
  • Locked By
  • Folder definition
parms
  • Variable Table Name
  • Variable Name
  • Updated On
  • Locked By
resource
  • Workstation
  • Resource Name
  • Quantity
  • Updated On
  • Locked By
  • Resource definition
security role
  • Name
  • Updated On
  • Locked By
  • Security role definition
task definition
  • Workstation
  • Task Definition Name
  • Updated On
  • Locked By
  • Task definition
user
  • Username
  • Workstation
  • Updated On
  • Locked By
  • User definition
vartable
  • Variable Table Name
  • Default
  • Updated On
  • Locked By
workflow
  • Workstation
  • Workflow Name
  • Valid From
  • Updated On
  • Locked By
  • Workflow definition
workstation
  • Workstation Name
  • Type
  • Ignored
  • Updated On
  • Locked By
  • Workstation definition

Syntax and command line options

You must provide at least one scheduling or security item with the command to perform the action. 
ocli model display | di Scheduling or Security item Name of the Scheduling or Security item | wildcard characters
For the list of scheduling or security parameters that you can use and the format that needs to be followed, see the tables below.
Scheduling and Security items
Table 2. Scheduling items
Scheduling items Description
calendars | calendar | cal [folder/]calname You can specify the name of the calendar and optionally, the folder in which the calendar is defined. Otherwise, use wildcard characters to display details of all calendar definitions from the database.
eso | eventsource | so [folder/]eventsourcename You can specify the name of the event source and optionally, the folder in which the event source is defined. Otherwise use wildcard characters to display all the event source definitions.
folder | fol foldername You can specify the name of the folder. Otherwise use wildcard characters to display all the folder definitions.
jobs | jobdefinition | jd [[folder/]workstationame#][folder/]jobname If you provide a specific jobname only that particular task definition is displayed. You can provide [folder/]workstationame#] and the folder in which the task is defined to make the selection more specific. Otherwise use wildcard characters to display all the task definitions.
jobstream | js | sched [[folder/]workstationame#][folder/]jstreamname[valid from date|valid to date |valid in date][;full] If you provide a specific jstreamname only that particular workflow definition is displayed. You can provide [folder/]workstationame#] and the folder in which the workflow is defined to make the selection more specific. Otherwise use wildcard characters to display all the workflow definitions. You can also add the options below to provide more details of the workflow.

valid from date: You can specify a date which will restrict the selection of workflows, that have a valid from date equal to the value specified. The format is mm/dd/yyyy.

valid to date: You can specify a date which will restrict the selection of workflows, that have a valid to date equal to the value specified. The format is mm/dd/yyyy.

valid in date: Specify the time frame at which the task is run. You can specify one of the dates as @. The format is mm/dd/yyyy-mm/dd/yyyy.

full: If you add the option, all the task definitions in the workflow are displayed.
parms | parm | variable | vb [[folder/]tablename.]variablename You must provide the [[folder/]tablename.]variablename to view a specific variable within a specific table. If you specify the variablename only, the variable definition in the default variable is displayed. If you do not provide the [[folder/]tablename.]variablename, all the global variable definitions in the default variable table are displayed. Wildcard characters are permitted on both [folder/]tablename and variablename.
resource | res [[/workstationfolder/workstationname#/foldername/resourcename] | [workstationname#/foldername/resourcename] | [/foldername/resourcename] | resourcename] Enter the resource key to delete a specific definition or use wildcard characters to list 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.
user | credential | cred [[folder/]workstationame#]username] If you provide a specific username only that particular user definition is displayed and if not, all the user definitions are displayed. You can provide [folder/]workstationame#] and the folder in which the user is defined to make the selection more specific. Otherwise use wildcard characters to display the details of all the user definitions.
vartable | vt [folder/]tablename You can specify the name of the variable table and optionally, you can provide the folder in which the variable table is defined. Otherwise use wildcard characters to display the details of all the variable table definitions.
workstation | ws | cpu {[folder/]workstationame} You can specify the name of the workstation and optionally, you can provide the folder in which the items are located. Otherwise use wildcard characters to delete the details of all the workstation definitions.
Table 3. Security items
Security items Description
accesscontrollist | acl foldername|F+foldername|A+ADMIN If you specify the foldername|F+foldername|A+ADMIN, the access control list definition for a particular folder is displayed and if not, the access control list definitions for all the folders are displayed. Wildcard characters are permitted.

foldername|F+foldername: You can specify the option if you want to filter out the lists that are associated with a folder. The security roles are valid, only for the items available in the folder.

A+ADMIN: You can specify this option, if you want to filter out the lists that allows specific permissions on API keys (that are not defined in folders) and on agent registration action.
securityrole | srol securityrolename If you specify the securityrolename, the security role definition for that particular security role is displayed and if not, the security role definitions for all the security roles are displayed. Wildcard characters are permitted.
Table 4. Items
Item Description
aiagent aiagent_name Specify the name of the AI agent and optionally, the folder in which the agent is defined. If you do not provide any value, then all the AI agent definitions in the database are displayed.
Note:

When you run the display command, the template also displays the unique ID assigned to each item. If you want to view the template without these IDs, you can use the noid parameter along with the command.

For example, 
ocli model -format json display jd @#@ noid

Example

  1. Run the following command to display all calendars:
    ocli model display calendars=@
    The sample output is as follows:
     Calendar Name     Updated On  Locked By
 ----------------  ----------  ---------------------
 HOLIDAYS          12/31/2018  was18
 HOLIDAYS
   01/01/2020 02/15/2020 05/31/2020


 Calendar Name     Updated On  Locked By
 ----------------  ----------  ---------------------
 MONTHEND          01/01/2020  -

 MONTHEND
   "Month end dates 1st half 2020"
   01/31/2020 02/28/2020 03/31/2020 04/30/2020 05/31/2020 06/30/2020

 Calendar Name     Updated On  Locked By
 ----------------  ----------  ---------------------
 PAYDAYS           01/02/2020  -

 PAYDAYS
   01/15/2020 02/15/2020 03/15/2020 04/15/2020 05/14/2020 06/15/2020