HCL Workload Automation, Version 9.4

display

Displays the details of one or more object definitions of the same type stored in the database. The entire definition of the object is displayed.

Authorization

To display scheduling objects, you must have display access to the object being displayed. If you want to use the full keyword you must have also the display access to the jobs contained in the job stream definition. If you do not have the required access, composer is unable to find the objects.

To display security objects, you must have permission for the display action on the object type file with attribute name=security.

Syntax

{display | di}
{[calendars | calendar | cal=calname] |
[eventrule | erule | er=eventrulename] |
[parms | parm | vb=variablename.]variablename] |  
[vartable | vt=tablename] |
[prompts | prom=promptname] |
[resources | resource | res=[workstationame#]resourcename] |
[runcyclegroup | rcg=runcyclegroupname] |
[cpu={workstationame | workstationclassname | domainame}]
[wat=workloadapplicationtemplatename]  
[workstation | ws=workstationame] |
[workstationclass | wscl=workstationclassname] |
[domain | dom=domainame] |
[jobs | jobdefinition | jd=[workstationame#]jobname] |
[sched | jobstream | js= [workstationame#]jstreamname
   [valid from date|valid to date |valid in date date]
   [;full]
] |
[users | user=[workstationame#]username] |
[accesscontrollist | acl for securitydomainname] |
[securitydomain | sdom=securitydomainname] |
[securityrole | srol=securityrolename]
}
[;offline]

Arguments

calendars | calendar | cal
If no argument follows, displays all calendar definitions.

If argument calname follows, displays the calname calendar. Wildcard characters are permitted.

eventrule | erule | er

If argument eventrulename follows, displays the eventrulename event rule. Wildcard characters are permitted.

parms | parm | vb
If no argument follows, displays all global variable definitions found in the default variable table.
If argument tablename.variablename follows, displays the variablename variable of the specified table. If tablename variable table is omitted, composer looks for the variable definition in the default variable table. Wildcard characters can be used on both tablename variable table and variablename variable. For example:
display parms=@.@
Displays all variables on all tables.
display parms=@
Displays all variables on the default table.
display parms=@.acct@
Displays all the variables whose name starts with acct on all the existing tables.
vartable | vt
If no argument follows, displays all variable table definitions.

If argument tablename variable table follows, displays the tablename variable table. Wildcard characters are permitted.

prompts | prom
If no argument follows, displays all prompt definitions.

If argument promptname follows, displays the promptname prompt. Wildcard characters are permitted.

resources | resource | res
If no argument follows, displays all resource definitions.

If argument workstationame#resourcename follows, displays the resourcename resource of the workstationame workstation on which the resource is defined. If workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted for both workstationame and resourcename.

runcyclegroup | rcg
If no argument follows, displays all run cycle group definitions.

If argument runcyclegroupname follows, displays the runcyclegroupname run cycle group. Wildcard characters are permitted.

cpu
Displays workstations, workstation classes, or domains.
workstation
The name of the workstation. Wildcard characters are permitted.
workstationclass
The name of the workstation class. Wildcard characters are permitted.
domain
The name of the domain. Wildcard characters are permitted.
wat
If no argument follows, displays all workload application template definitions.

If argument workloadapplicationtemplate follows, displays the specified workload application template. Wildcard characters are permitted.

workstation | ws
If no argument follows, displays all workstation definitions.

If argument workstationname follows, displays the workstationname workstation. Wildcard characters are permitted.

domain | dom
If no argument follows, displays all domain definitions.

If argument domainname follows, displays the domainname domain. Wildcard characters are permitted.

workstationclass | wscl
If no argument follows, displays all workstation class definitions.

If argument workstationclassname follows, displays the workstationclassname workstation class. Wildcard characters are permitted.

jobs | jobdefinition | jd
If no argument follows, displays all job definitions.

If argument workstationame#jobname follows, displays the jobname job of the workstationame workstation on which the job runs. If workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted for both workstationame and jobname.

sched | jobstream | js
If no argument follows, displays all job stream definitions.
If argument workstationame#jstreamname follows, displays the jstreamname job stream of the workstationame workstation on which the job stream is defined. If workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted for both workstationame and jstreamname.
valid from
date Restricts the selection to job streams that have a valid from date equal to the indicated value. The format is mm⁄dd⁄yyyy.
valid to
date Restricts the selection to job streams that have a valid to date equal to the indicated value. The format is mm⁄dd⁄yyyy.
valid in
date date The time frame during which the job stream can run. The format is mm⁄dd⁄yyyy - mm⁄dd⁄yyyy. One of the two dates can be represented by @.
full
Displays also all job definitions contained in the job stream.
users | user
If no argument follows, displays all user definitions.

If argument workstationame#username follows, displays the username user of the workstationame workstation on which the user is defined. If workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted for both workstationame and username.

accesscontrollist | acl
If no securitydomainname argument follows, displays access control list definitions for all the security domains.

If argument securitydomainname follows, displays the access control list definitions for the securitydomainname security domain. Wildcard characters are permitted for securitydomainname .

securitydomain | sdom
If no securitydomainname argument follows, displays all the security domains definitions.

If argument securitydomainname follows, displays the securitydomainname security domain definition. Wildcard characters are permitted for securitydomainname .

securityrole | srol
If no securityrolename argument follows, displays all the security roles definitions.

If argument securityrolename follows, displays the securityrolename security role definition. Wildcard characters are permitted for securityrolename .

;offline
Sends the output of the command to the composer output device. For information about this device, see Offline output.

Results

The display command returns you the following information about the object to be displayed:
  • a summary row containing information about the selected object
  • the selected object definition
Depending on the value set in the MAESTROCOLUMNS local variable the summary row shows different sets of information about the selected object.
Table 1 shows an example of the output produced based on the value set for the MAESTROCOLUMNS variable.
Table 1. Output formats for displaying scheduling objects
Object Type Output format if MAESTROCOLUMNS<120 Output format if MAESTROCOLUMNS ≥ 120
Calendar "CalendarName : UpdatedOn : UpdatedBy : LockedBy" "CalendarName : UpdatedBy : UpdatedOn : LockedBy : LockedOn"
Domain "DomainName : ParentDomain : Master : UpdatedOn : LockedBy" "DomainName : ParentDomain : Master : UpdatedBy : UpdatedOn : LockedBy : LockedOn"
Event rule "EventRuleName : Type : Draft : Status : UpdatedOn : LockedBy" "EventRuleName : Type : Draft : Status : UpdatedOn : LockedBy : LockedOn"
Job "Workstation : JobDefinitionName : UpdatedOn : LockedBy" "Workstation : JobDefinitionName : TaskType : UpdatedBy : LockedBy : LockedOn"
Job Stream "Workstation : JobstreamName : Validfrom : UpdatedOn : LockedBy" "Workstation : JobstreamName : Draft : ValidFrom : ValidTo : UpdatedBy : UpdatedOn : LockedBy : LockedOn"
Parameter "VariableTableName : VariableName : UpdatedOn : LockedBy" "VariableTableName : VariableName : UpdatedBy : UpdatedOn : LockedBy : LockedOn"
Prompt "PromptName : UpdatedOn : LockedBy " "PromptName : UpdatedBy : UpdatedOn : LockedBy : LockedOn"
Resource "Workstation : ResourceName : Quantity : UpdatedOn : LockedBy " "Workstation : ResourceName : Quantity : UpdatedBy : UpdatedOn : LockedBy : LockedOn"
Variable Table "VariableTableName : Default : UpdatedOn : LockedBy " "VariableTableName : Default : UpdatedBy : UpdatedOn : LockedBy : LockedOn"
User "Workstation : UserName : UpdatedOn : LockedBy" "UserName : Workstation : UpdatedBy : UpdatedOn : LockedBy : LockedOn"
Workstation "WorkstationName : Type : Domain : Ignored : UpdatedOn : LockedBy" "WorkstationName : Type : Domain : OsType : Ignored : UpdatedBy : UpdatedOn : LockedBy : LockedOn"
Workstation Class "WorkstationClassName : Ignored : UpdatedOn : LockedBy" "WorkstationClassName : Ignored : UpdatedBy : UpdatedOn : LockedBy : LockedOn"

See Offline output for more information on how to set MAESTROCOLUMNS.

Examples

To display all calendars, run the following command:
display calendars=@
this is a sample output:
 Calendar Name     Updated On  Locked By
 ----------------  ----------  ---------------------
 HOLIDAYS          12/31/2005  tws83
 HOLIDAYS
   01/01/2006 02/15/2006 05/31/2006
 
 
 Calendar Name     Updated On  Locked By
 ----------------  ----------  ---------------------
 MONTHEND          01/01/2006  -
 
 MONTHEND
   "Month end dates 1st half 2006"
   01/31/2006 02/28/2006 03/31/2006 04/30/2006 05/31/2006 06/30/2006
 
 Calendar Name     Updated On  Locked By
 ----------------  ----------  ---------------------
 PAYDAYS           01/02/2006  -
 
 PAYDAYS
   01/15/2006 02/15/2006 03/15/2006 04/15/2006 05/14/2006 06/15/2006
To print the output of the display command on all job streams that are launched on workstation site2, run the following command:
di sched=site2#@;offline

See also

From the Dynamic Workload Console you can perform the same tasks as described in:

the Dynamic Workload Console User's Guide.