Managing multiple items in a folder

In OCLI, you can manage all or specific items in a particular folder with a single command. You can either modify or extract scheduling and security item definitions defined in the folder.

Overview

You can modify or extract all scheduling and security item definitions for which you have required permissions (see Access required to run Orchestration CLI commands) with a single command. When switching environments you can utilize the extract command with this option, combined with the add command, to effortlessly move a large number of items. Use the extract command with this option to consolidate multiple items in a specific folder into a single file. Then use the add command to import those item definitions from the file into the new environment. This ensures a smooth transition by transferring numerous items between environments. You can manage the item definitions in a folder and its sub folders.
Note: The scheduling item folder defined in the root folder and the FULL_CONTROL security role cannot be modified or extracted.

Syntax and command line options

Configure the syntax to manage the items that are defined in different folders. You can try out a few combinations to manage the items in different ways. All the security definitions are defined in the root folder and you can manage it distinctly. You can use any of the following combinations to manage the item definitions.
Managing all scheduling items in a folder and its sub folders
Run the command as follows to modify/extract all items, except the security items (acl and srol) in a folder,
ocli model mod all <folder_name>[/@]

ocli model extract file_name from all=<folder_name>[/@]
<folder_name>[@]
Specify the name of the folder that contains the items that you want to modify or extract. If you want to manage the items in the sub folders, use /@ after the folder name. Wildcard characters are permitted.
Managing all security items in the root folder
All security items are defined in the root folder; therefore, no need to specify the folder name in the command. To modify all security item definitions that are defined by a specific name, run the command as follows:
ocli model [mod|extract] security /<item_name>
<item_name>
All security items with the specified name is selected. Wildcard characters are permitted.
Managing specific scheduling items in a folder and its sub folders

You can manage multiple items of your choice with a single command. Specify those items that you want to modify or extract with the command and only those items are updated. You can specify any combination, except security items.

For example, if you want to update only the tasks and workflows in a particular folder, run the command as follows:
ocli model mod jd, js <folder_name>[/@]
Add /@, only if you want to modify the items in the sub folders also.
Note: If you specify security items with any other combination of items that are not in the root folder, then the security item definitions are not displayed or extracted.
Managing specific scheduling and security items in the root folder and its sub folders
All the security definitions are stored in the root folder. This makes it possible for simultaneous updates with scheduling items in the root folder with a single command. For example, run the command as follows to update all the task and acl item definitions in the root folder starting with the word B,
ocli model mod js, acl /B@[/@]

Add /@, only if you want to modify the items in the sub folders also.

You can manage the security definitions with other scheduling items using a single command, only when all items are defined in the root folder and its sub folders.

Important: You must use the withAgent option to extract workstation definitions when used in combination with all or any other item. If not, item definitions are extracted without the workstation definitions.

Examples

  1. Run the command as follows to modify all items in the zinc folder:
    ocli model mod all zinc
  2. Run the command as follows to extract the task and folder definitions from the ring folder:
    ocli model extract jd, fol ring
  3. Run the command as follows to modify the task definitions from the ring folder and its sub folders:
    ocli model mod jd ring/@
  4. Run the command as follows to extract workstation definitions and variable table definitions from the root folder:
    ocli model ext file.txt from vt, wks /@ withAgent
  5. Run the command as follows to extract all item definitions to the itemsFol_1.txt file from the fol_1 folder:
    ocli model extract itemsFol_1.txt from all=/fol_1/