modify

You can use the command option to update the existing scheduling or security items in the database.

Overview

The command option performs similar to new command, when you want to modify an item that is not available in the database. When you run the command, the selected item definition is copied and opened in a temporary file. You can then edit the file and replace the existing item.

Note: When you modify an existing item definition, the ID’s associated with the definitions are not displayed for editing as it is unique for each item. Therefore the noid option does not have an impact when used with the modify command.

Syntax and command line options

You must provide at least one scheduling or security item with the command to perform the action.

ocli model modify|m Scheduling or Security item

Important: If you modify an item by changing its key, a new item is created without modifying the existing one. You can use the rename command to modify the item.

Restriction: When modifying a task or workflow or user definition, do not add a number sign (#) before the name of the item to save it to the default workstation. Any characters following the number sign is taken as free text and an error is displayed. You must only specify the name of the item to save it to the default workstation.

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 display all the calendar definitions in a file for editing.
`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 display all the event source definitions in a file for editing.
`folder \| fol foldername`	You can specify the name of the folder. Otherwise use wildcard characters to display all the folder definitions in a file for editing.
`jobs \| jobdefinition \| jd [[folder/]workstationame#][folder/]jobname`	If you provide a specific `jobname` only that particular task definition is displayed for editing. Otherwise use wildcard characters to modify all task definitions for editing. 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 displayed for editing. You can provide `[folder/]workstationame#]` and the folder in which the workflow is defined to make the selection more specific. Otherwise use wildcard characters to display all workflow definitions for editing. 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 modify a specific definition or use wildcard characters to modify 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`	You must provide the `[[folder/]tablename.]variablename` to update a specific variable within a specific table. If you specify the `variablename` only, the variable definition in the default variable is displayed. If you do not provide the `[[folder/]tablename.]variablename`, all the global variable definitions in the default variable table are displayed for editing. Wildcard characters are permitted on both `[folder/]tablename` and `variablename`.
`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 modify all the user definitions at the same time.
`vartable \| vt [folder/]tablename`	You can specify the name of the variable table and optionally, you can specify the folder in which the variable table is defined. Otherwise use wildcard characters to copy all the variable table definitions into a temporary file for editing.
`workstation \| ws \| cpu [folder/]workstationame]`	You can specify the name of the workstation that you want to update. Optionally, you can provide the folder in which the items are located. Otherwise use wildcard characters to modify 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 displayed for editing. Otherwise use wildcard characters to modify 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 displayed for editing. Otherwise use wildcard characters to modify 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 displayed for editing. If you do not provide any value, the definitions for all the AI agents in the database are displayed.

Note: You can also modify all scheduling and security item definitions for which you have required permissions (see Access required to run Orchestration CLI commands) with a single command. For more information, see Managing multiple items in a folder.

Examples

Run the following command to edit all the calendar definitions:
```
ocli model modify cal @
```
Run the following command to modify the workflow FINAL located at folder TEAMS that is launched on workstation WS1:
```
ocli model modify sched WS1#TEAMS/FINAL
```