HCL Workload Automation, Version 9.4

Composer commands

This section describes the operations you can perform in the database using the composer command line interface program with syntax: 
composer [connection_parameters] [-defaultws twscpu]
        ["command[&[command]][...]"]
where connection_parameters, if they are not supplied in the localopts or useropts files, are the following: 
[-file filename]|
[-host hostname]
[-port port_name]
[-protocol protocol_name]
[-proxy proxy_name]
[-proxyport proxy_port_number]
[-password user_password]
[-timeout seconds]
[-username user_name]
See Setting up options for using the user interfaces for more details.

These operations can only be run from any composer client command line installed.

In Table 1 displaying the list of commands that can be used against the scheduling object, filename indicates an existing file when used in the syntax for the add and replace commands, it indicates a not existing file when used in the syntax for the create/extract command.

Table 1. Composer commands
Command Syntax User Authorization
add

{add | a} filename [;unlock]

 add or modify
authenticate

{authenticate | au} [username=username password=password]

  
continue

{continue | co}

 
create extract

{create | cr | extract | ext} filename from
{[calendars | calendar | cal=calname] |
[eventrule | erule | er=eventrulename] |
[parms | parm | vb=[tablename.]variablename] |
[vartable | vt=tablename] |
[prompts | prom=promptname] |
[resources | resource | res=[workstationame#]resourcename] |
[runcyclegroup | rcg=runcyclegroupname] |
[cpu={workstationame | workstationclassname | domainame}] |
[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  [;password]] |
[accesscontrollist | acl for securitydomainname] |
[securitydomain | sdom=securitydomainname] |
[securityrole | srol=securityrolename]}
[;lock]

 display
delete

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

 delete
display

{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]

 display
edit

{edit | ed} filename

  
exit

{exit | e}

 
list print

{list | l}
{[calendars | calendar | cal=calname] |
[eventrule | erule | er=eventrulename] |
[parms | parm | vb=[tablename.]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] |
[users | user=[workstationame#]username] |
[accesscontrollist | acl for securitydomainname] |
[securitydomain | sdom=securitydomainname] |
[securityrole | srol=securityrolename]}
[;offline]

 display
lock

{lock | lo}
{[calendars | calendar | cal=calname] |
[eventrule | erule | er=eventrulename] |
[parms | parm | vb=[tablename.]variablename] |  
[vartable | vt=tablename] |
[prompts | prom=promptname] |
[resources | resource | res=[workstationame#]resourcename] |
[runcyclegroup | rcg=runcyclegroupname] |
[cpu={workstationame | workstationclassname | domainame}]  
[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]] |
[users | user=[workstationame#]username] |
[accesscontrollist | acl for securitydomainname] |
[securitydomain | sdom=securitydomainname] |
[securityrole | srol=securityrolename]}

 modify
modify

{modify | m}
{[calendars | calendar | cal=calname] |
[eventrule | erule | er=eventrulename] |
[parms | parm | vb=[tablename.]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]}

 modify or add
new

new
[calendar |
domain |
eventrule |
job |
jobstream |
parameter |
prompt |
resource |
runcyclegroup |
user |
vartable |
wat |
workstation |
workstationclass |
accesscontrollist |
securitydomain |
securityrole]

 add or modify
rename

{rename | rn}

{calendars|calendar|cal |

parms|parm|vb |

vartable|vt |

prompts|prom |

resorces|resource|res |

runcyclegroup|rcg |

workstation|ws |

workstationclass|wscl |

domain|dom |

jobs|jobdefinition|jd |

jobsched|jb |

eventrule|erule|er

sched|jobstream|js |

users|user }

old_object_identifier  new_object_identifier

 add and delete
replace

{replace | rep} filename [;unlock]

 modify or add
unlock

{unlock | u}
{[calendars | calendar | cal=calname] |
[eventrule | erule | er=eventrulename] |
[parms | parm | vb=[tablename.]variablename] |
[vartable | vt=tablename] |
[prompts | prom=promptname] |
[resources | resource | res=[workstationame#]resourcename] |
[runcyclegroup | rcg=runcyclegroupname] |
[cpu={workstationame | workstationclassname | domainame}]
[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]] |
[users | user=[workstationame#]username] |
[accesscontrollist | acl for securitydomainname] |
[securitydomain | sdom=securitydomainname] |
[securityrole | srol=securityrolename]}
[;forced]

 modify and unlock
validate

{validate | val} filename [;syntax]