unlock

You can use the command option to unlock a scheduling or security item that are locked.

Overview

You can unlock an item which is locked by you. You must have the unlock access to the scheduling or security items.

Syntax and command line options

You must provide at least one scheduling or security item with the command to perform the action. You can create the command as described below.
ocli model unlock|un Scheduling or Security item [;forced]
For the list of scheduling or security parameters that you can use and the format that needs to be followed, see the tables below.
Table 1. Scheduling items
Scheduling items Description
calendars | calendar | cal [folder/]calname You can specify the name of the calendar and optionally, the folder in which the calendar is defined. Otherwise use wildcard characters to unlock all the calendar definitions.
folder | fol foldername You must specify the name of the folder that you want to unlock. Otherwise use wildcard characters to unlock all the folder definitions.
eso | eventsource | so [folder/]eventsourcename You can specify the name of the event source and optionally, the folder in which the event source is defined. Otherwise use wildcard characters to unlock all the event source definitions.
jobs | jobdefinition | jd [[folder/]workstationame#][folder/]jobname If you provide a specific jobname only that particular task definition is locked, or else use wildcard characters to unlock all the task definitions. You can provide [folder/]workstationame#] and the folder in which the task is defined to make the selection more specific.
sched | jobstream | js [[folder/]workstationame#][folder/]jstreamname[valid from date|valid to date|valid in date][;full]] If you provide a specific jstreamname only that particular workflow definition is unlocked. Otherwise use wildcard characters to unlock all the workflow definitions. You can provide [folder/]workstationame#] and the folder in which the workflow is defined to make the selection more specific. You can also add the options below to provide more details of the workflow.

valid from date: You can specify a date which will restrict the selection of workflows, that have a valid from date equal to the value specified. The format is mm/dd/yyyy.

valid to date: You can specify a date which will restrict the selection of workflows, that have a valid to date equal to the value specified. The format is mm/dd/yyyy.

valid in date: Specify the time frame at which the task is run. You can specify one of the dates as @. The format is mm/dd/yyyy-mm/dd/yyyy.

full: If you add the option, all the task definitions in the workflow are displayed for editing.

resource | res [[/workstationfolder/workstationname#/foldername/resourcename] | [workstationname#/foldername/resourcename] | [/foldername/resourcename] | resourcename] Enter the resource key to unlock a specific definition or use wildcard characters to unlock all the resource definitions at the same time. If the resource is defined in the root folder, specify only the name of the resource. Otherwise add the resource key that contains the workstation name and folder name.
parms | parm | variable | vb [[folder/]tablename.]variablename If you specify the variablename only, all the variable definitions in that table are unlocked. Otherwise use wildcard characters to unlock all the global variable definitions.
user | credential | cred [[folder/]workstationame#]username [;password] You can provide [folder/]workstationame#] and the folder in which the user is defined, to make the selection more specific. Otherwise use wildcard characters to unlock all the user definitions.
vartable | vt [folder/]tablename You can specify the name of the variable table and optionally, you can provide the folder in which the variable table is defined. Otherwise use wildcard characters to unlock all the variable table definitions.
workstation | ws | cpu [folder/]workstationame] You can specify the name of the workstation that you want to unlock. Optionally, you can provide the folder in which the items are located. Otherwise use wildcard characters to unlock all the workstation definitions.
Table 2. Security items
Security items Description
accesscontrollist | acl foldername|F+foldername|A+ADMIN If you specify the foldername|F+foldername|A+ADMIN, the access control list definition for that particular folder is unlocked. Otherwise use wildcard characters to unlock all the access control list definitions.

foldername|F+foldername: You can specify the option if you want to filter out the lists that are associated with a folder. The security roles are valid, only for the items available in the folder.

A+ADMIN: You can specify this option, if you want to filter out the lists that allows specific permissions on API keys (that are not defined in folders) and on agent registration action.

securityrole | srol securityrolename If you specify the securityrolename, the security role definition for that particular security role is unlocked. Otherwise use wildcard characters to unlock all the security role definitions.
Table 3. Item
aiagent aiagent_name If you specify the aiagent_name, the definition for that particular AI agent is unlocked. If you do not provide any value, all locked AI agent definitions are unlocked.
forced

You can use this option to unlock item definitions that are locked by your user id, regardless of the session.

Examples

  1. Run the following command to unlock the task definition way2:
    ocli model unlock jd=@#way2
  2. Run the following command to unlock the folder delhi:
    ocli model unlock folder /delhi