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=[folder/]calname] |
[eventrule | erule | er=[folder/]eventrulename] |
[folder|fol=foldername |]
[parms | parm | vb=variablename.]variablename] |
[vartable | vt=[folder/]tablename] |
[prompts | prom=[folder/]promptname] |
[resources | resource | res=[[folder/]workstationame#][folder/]resourcename] |
[runcyclegroup | rcg=[folder/]runcyclegroupname] |
[cpu={[folder/]workstationame | [folder/]workstationclassname | domainame}]
[wat=[folder/]workloadapplicationtemplatename]
[workstation | ws=[folder/]workstationame] |
[workstationclass | wscl=[folder/]workstationclassname] |
[domain | dom=domainame] |
[jobs | jobdefinition | jd=[[folder/]workstationame#][folder/]jobname] |
[sched | jobstream | js= [[folder/]workstationame#][folder/]jstreamname
[valid from date|valid to date |valid in date date]
[;full]] |
[users | user=[[folder/]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 [folder/]calname follows, displays the [folder/]calname calendar. Wildcard characters are permitted.
- eventrule | erule | er
-
If argument [folder/]eventrulename follows, displays the [folder/]eventrulename event rule. Wildcard characters are permitted.
- folder | fol
- If no argument follows, displays all folder definitions.
If argument foldername follows, displays the foldername folders. Wildcard characters are permitted.
- parms | parm | vb
- If no argument follows, displays all global variable definitions found in the default variable table.
- vartable | vt
- If no argument follows, displays all variable table definitions.
If argument [folder/]tablename variable table follows, displays the [folder/]tablename variable table. Wildcard characters are permitted.
- prompts | prom
- If no argument follows, displays all prompt definitions.
If argument [folder/]promptname follows, displays the [folder/]promptname prompt. Wildcard characters are permitted.
- resources | resource | res
- If no argument follows, displays all resource definitions.
If argument [folder/]workstationame#[folder/]resourcename follows, displays the [folder/]resourcename resource of the [folder/]workstationame workstation on which the resource is defined. If [folder/]workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted.
- runcyclegroup | rcg
- If no argument follows, displays all run cycle group definitions.
If argument [folder/]runcyclegroupname follows, displays the [folder/]runcyclegroupname run cycle group. Wildcard characters are permitted.
- cpu
- Displays workstations, workstation classes, or domains.
- [folder/]workstation
- The name of the workstation. Wildcard characters are permitted.
- [folder/]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 [folder/]workloadapplicationtemplate follows, displays the specified workload application template. Wildcard characters are permitted.
- workstation | ws
- If no argument follows, displays all workstation definitions.
If argument [folder/]workstationname follows, displays the specified 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 [folder/]workstationclassname follows, displays the specified workstation class. Wildcard characters are permitted.
- jobs | jobdefinition | jd
- If no argument follows, displays all job definitions.
If argument workstationame#/folder/jobname follows, displays the folder where the jobname is stored, and the workstationame workstation workstationame on which the job runs. If folder is omitted, the default folder ("/") is used.
You can use the com.hcl.ws.showRootFolder property in the TWSConfig.properties file to manage how jobs located in the root folder are displayed. The job name can either be displayed indicating the root folder (/MYJOB1
), or without indicating it (MYJOB1
). By default, this property is set to NO which specifies to display the job without indicating the root folder. Set the property to YES to display job names preceded by root ("/") . The TWSConfig.properties file is located in the path:- On Windows operating systems
- TWA_home\usr\servers\engineServer\resources\properties
- On UNIX operating systems
- TWA_DATA_DIR/usr/servers/engineServer/resources/properties
If [folder/]workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted.
- sched | jobstream | js
- If no argument follows, displays all job stream definitions in the current folder.
If argument workstationame#/folder/jstreamname follows, displays the folder where the job stream definition jstreamname is stored and the workstation workstationame on which the job stream is defined. If folder is omitted, the default folder ("/") is used.
You can use the com.hcl.ws.showRootFolder property in the TWSConfig.properties file to manage how job streams located in the root folder are displayed. The job stream name can either be displayed indicating the root folder (/MYJOBSTREAM1
), or without indicating it (MYJOBSTREAM1
). By default, this property is set to NO which specifies to display the job stream name without indicating the root folder. Set the property to YES to display job stream names preceded by root ("/"). The TWSConfig.properties file is located in the path:- On Windows operating systems
- TWA_home\usr\servers\engineServer\resources\properties
- On UNIX operating systems
- TWA_DATA_DIR/usr/servers/engineServer/resources/properties
If [folder/]workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted.- 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 [folder/]workstationame#username follows, displays the username user of the [folder/]workstationame workstation on which the user is defined. If [folder/]workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted.
- 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
- a summary row containing information about the selected object
- the selected object definition
Object Type | Output format if MAESTROCOLUMNS<120 | Output format if MAESTROCOLUMNS ≥ 120 |
---|---|---|
Calendar | "CalendarName : UpdatedOn : 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" |
Folder | "Name : UpdateOn : LockedBy" | "Name : UpdateOn : LockedBy" |
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
display calendars=@
this is a sample output:
Calendar Name Updated On Locked By
---------------- ---------- ---------------------
HOLIDAYS 12/31/2018 tws83
HOLIDAYS
01/01/2019 02/15/2019 05/31/2019
Calendar Name Updated On Locked By
---------------- ---------- ---------------------
MONTHEND 01/01/2019 -
MONTHEND
"Month end dates 1st half 2019"
01/31/2019 02/28/2019 03/31/2019 04/30/2019 05/31/2019 06/30/2019
Calendar Name Updated On Locked By
---------------- ---------- ---------------------
PAYDAYS 01/02/2019 -
PAYDAYS
01/15/2019 02/15/2019 03/15/2019 04/15/2019 05/14/2019 06/15/2019
site2
, stored in folder
myfolder run the following command:
di sched=myfolder/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.
- To display workstations, see
- To display event rules, see
- To display access control lists, security domains, and security roles, see
- To display all other objects, see