HCL Workload Automation, Version 9.4

unlock

Releases access locks on scheduling objects defined in the database. By default to unlock an object, the object must have been locked using the same user and session.

Authorization

You must have the unlock access to unlock scheduling objects locked by other users.

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

Syntax

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

Arguments

calendars | calendar | cal

If no argument follows, unlocks all calendar definitions.

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

eventrule | erule | er

If no argument follows, unlocks all event rule definitions.

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

parms|parm|vb

If no argument follows, unlocks the default variable table.

If argument tablename.variablename follows, unlocks the entire table containing the variablename variable. If tablename is omitted, unlocks the default variable table. Wildcard characters can be used on both tablename and variablename. For example:

unlock parms=@.@

Unlocks all tables.

unlock parms=@

Unlocks the default table.

unlock parms=@.acct@

Unlocks all the tables containing the variables whose name starts with acct.

unlock parms=acct@

Unlocks the default table.

Remember: The action on a single variable unlocks the variable table that contains it.

vartable | vt

If no argument follows, unlocks all variable table definitions.

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

prompts | prom

If no argument follows, unlocks all prompt definitions.

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

resources | resource | res

If no argument follows, unlocks all resource definitions.

If argument workstationame#resourcename follows, unlocks 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, unlocks all run cycle group definitions.

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

cpu

Unlocks 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.

workstation | ws

If no argument follows, unlocks all workstation definitions.

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

domain | dom

If no argument follows, unlocks all domain definitions.

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

workstationclass | wscl

If no argument follows, unlocks all workstation class definitions.

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

jobs | jobdefinition | jd

If no argument follows, unlocks all job definitions.

If argument workstationame#jobname follows, unlocks 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, unlocks all job stream definitions.

If argument workstationame#jstreamname follows, unlocks 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 @.

users | user

If no argument follows, unlocks all user definitions.

If argument workstationame#username follows, unlocks 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, unlocks the access control list definitions for all the security domains.

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

securitydomain | sdom

If no securitydomainname argument follows, unlocks all the security domain definitions.

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

securityrole | srol

If no securityrolename argument follows, unlocks all the security roles definitions.

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

forced

If specified, allows the user who locked the object to unlock it regardless of the session.

If this option is used by the superuser, then the unlock command can operate regardless to the user and the session used to lock the object.

Comments

If a user, other than the superuser, tries to unlock an object that is locked by another user, an error message is returned.

Examples

To unlock job definition JOBDEF1, run the following command:

unlock jd=@#JOBDEF1

To unlock event rule definition ERJS21, run the following command:

unlock erule=ERJS21