Filters and wildcards

In HCL Workload Automation composer you can use wildcards and filters when issuing some specific commands to filter scheduling objects defined in the database. The wildcards you can use from composer are:

@
Replaces one or more alphanumeric characters.
?
Replaces one alphanumeric character.
To search for occurrences with names that contain either @ or ?, make sure you use the backslash character \ before @ or ? to escape them so that they are not interpreted as wildcards. Similarly, the backslash character must be prefixed by another backslash character to be interpreted as an occurrence to be found. The following examples clarify these rules, which also apply when specifying search strings using the filter keyword.
S@E
Search for all strings starting with S and ending with E, whatever is their length.
S?E
Search for all strings starting with S and ending with E, and whose length is three characters.
S\@E
Search for an exact match with string S@E.
S\?E
Search for an exact match with string S?E.
S\\E
Search for an exact match with string S\E.
When searching for scheduling objects in folders, the position of wildcards in the string indicates the object being searched. The following examples clarify these rules:
/@/@#/@/@
Search for all objects in all folders for all workstations defined in all folders. The first statement ("/@/" in the example) indicates the folder, the second statement ("@#", in the example) indicates the workstation name, the third statement ("/@/", in the example) indicates the folder, the fourth statement ("@", in the example) indicates the scheduling object.
[folder/]workstationname#/[folder/]jobstreamname
Search for all job streams with the specified name on the specified workstation. For both job streams and workstations, you can specify the folder where the object is stored, if any.
The commands you can issue from composer and that support filtering are:
  • display
  • create
  • delete
  • list
  • lock
  • modify
  • print
  • unlock
  • update
The syntax used to filter objects when issuing one of these commands is the following:

command_name type_of_object=selection; [option;] [filter filter_keyword=selection [...]]

Scheduling objects filtering criteria shows the scheduling objects you can filter when issuing the commands listed above, and for each object, which fields can be filtered (in italic) or which key (in bold) is used to filter its fields.

For all objects which can be defined in a folder, such as jobs, job streams, workstations, and so on, you can optionally specify the folder where the object is defined. If no folder is specified, the root folder is used by default.

Table 1. Scheduling objects filtering criteria
Scheduling object Filter keywords or fields that can be filtered Description Example
workstation [folder/]workstationname Applies the command to the workstations whose name satisfies the criteria. list ws=p@
domain Applies the command to the workstations which belong to a domain. mod ws=@; filter domain=dom1
vartable Applies the command to the workstations which refer the specified variable table. mod ws=@; filter vartable=table2
domain domainname Applies the command to the domains whose name satisfies the criteria. display dom=dom?
parent Applies the command to the domains whose parent domain satisfies the criteria. list dom=@; filter parent=rome
prompt promptname Applies the command to the global prompts whose name satisfies the criteria. lock prompt=p@
user [folder/]workstationname# username Applies the command to the users whose identifier satisfies the criteria. list users=cpu1#operator?
resource [folder/]workstationname# resourcename Applies the command to the resources whose identifier satisfies the criteria. print res=cpu?#operator?
variable variablename Applies the command to the parameters whose name satisfies the criteria. delete vb=mytable.myparm@
folder folder Applies the command to the folders whose name satisfies the criteria. list folder myfolder
job definition [folder/]workstationname#folder/jobname Applies the command to the job definitions whose name satisfies the criteria. mod jd=mycpu#/myfolder/myjob@
RecoveryJob Applies the command to the jobs whose definition contains the specified recovery job definition. list jobdefinition=@; filter RecoveryJob=CPUA#/job01
job stream [folder/]workstationname#folder/jobstreamname Applies the command to the job stream definitions whose name satisfies the criteria.

mod js=mycpu#testfolder/myjs@
mod js=mycpu#/myfolder/myjs@

Calendar Applies the command to the job streams that contain the calendar specified in the filter. list js=@#@; filter Calendar=cal1
Jobdefinition Applies the command to the job streams that contain the job definition specified in the filter. list js=@#@; filter jobdefinition=CPUA#job01
Resource Applies the command to the job streams that refer to the resource specified in the filter. list js=@#@; filter Resource=cpu1#disk1
Prompt Applies the command to the job streams that refer to the prompt specified in the filter. list js=@#@; filter Prompt=myprompt
Vartable Applies the command to the job streams that refer to the variable table specified in the filter. The variable table can be specified either in the run cycle or in the job stream section. list js=@#@; filter Vartable=table1
Rcvartable Applies the command to the run cycles in the job streams that refer to the variable table specified in the filter. list js=@#@; filter Rcvartable=table1
Jsvartable Applies the command to the job streams that refer to the variable table specified in the filter regardless of what is specified in the run cycle. list js=@#@; filter Jsvartable=table1
draft Displays only job streams in draft status list js=@#@; filter draft=table1
active Displays only job streams in active status list js=@#@; filter active=table1
event rule eventrulename Applies the command to the event rules that include an action on a specific job or job stream. list er=@; filter js=accrecjs5
vartable vartablename Applies the command to the variable tables whose name satisfies the criteria. list vartable=A@
isdefault Applies the command to the default variable table. list vartable=A@; filter isdefault
You can combine more than one filter for the same object type as shown in the following example:
list js=@#@; filter Calendar=cal1 jobdefinition=CPUA#myfolder/mysubfolder/job01
The output of the command is a list of job streams using calendar cal1 and containing a job with job definition CPUA#job01stored in the path myfolder/mysubfolder.