Home
Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
Orchestration CLI commands
You can use the various command options in Orchestration CLI to achieve specific results. The command options are not case sensitive and you can use either uppercase or lowercase letters.
Model commands
You can use the model commands to create or modify the item definitions for folders, jobs, job streams, and other scheduling or security items.
add
You can use the add command to add scheduling items to the database.

Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
- Orchestration CLI commands
  You can use the various command options in Orchestration CLI to achieve specific results. The command options are not case sensitive and you can use either uppercase or lowercase letters.
  - Access required to run Orchestration CLI commands
    You must have specific permissions to run each command in Orchestration CLI. The level of access to run the command is customizable and you can use Dynamic Workload Console (DWC) or Orchestration CLI to manage the roles.
  - Model commands
    You can use the model commands to create or modify the item definitions for folders, jobs, job streams, and other scheduling or security items.
    - add
      You can use the add command to add scheduling items to the database.
    - delete
      You can use the delete command to remove the scheduling or security items from the database.
    - display
      You can use the display command to view the entire information about the item definitions of the same type.
    - extract
      You can use the extract command to create a text file by copying the item definitions from the database.
    - list
      You can use the list command to view the list of items of the same type.
    - listfolder
      You can use the listfolder command to view the list of folders available in the database.
    - lock
      You can use the lock command to lock access to a scheduling item definition.
    - mkfolder
      You can use the mkfolder command to create new folders.
    - modify
      You can use the modify command to update the existing scheduling or security items in the database.
    - new
      You can use the new command to create a new scheduling or security item definition.
    - rename
      You can use the rename command to rename a scheduling or security item in the database.
    - renamefolder
      You can use the renamefoldercommand to rename folder definitions.
    - replace
      You can use the replace command to replace the existing scheduling or security item definitions in the database.
    - rmfolder
      You can use the rmfolder command to delete folders in the database.
    - unlock
      You can use the unlock command to unlock a scheduling or security item that are locked.
  - Plan commands
    You can use the plan commands to submit and run the job or job streams.
  - help
    You can use the help command to view the online help or details about the commands that Orchestration CLI supports.
  - version
    You can use the version command to view the version of Orchestration CLI that is installed in your system. You can use the command either with a plan or a model.
  - Special characters as wildcards and delimiters
    When you want to use filters to select scheduling items in the database, you can use a list of selected special characters as wildcards and delimiters.
  - Orchestration CLI return codes
    Orchestration CLI return codes
- Job stream definition
  This topic introduces the job stream definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Job definition
  This topic introduces the job definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Calendar definition
  This topic introduces the calendar definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Folder definition
  This topic introduces the folder definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Credentials definition
  This topic introduces credentials definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Variable table definition
  This topic introduces the variable table definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Workstation definition
  This topic introduces the workstation definition, that can be done from the Orchestration CLI and from the Dynamic Workload Console.
- Managing matching criteria
  In this topic you can find a description of matching criteria.
- Managing time zones
  In this topic you can find information about managing time zones.
- Policy-driven plan
  The new HCL Universal Orchestrator policy-driven adaptive plan makes your workload more autonomous, dynamic and scalable.
- Data exchange and transformation
  This topic explains how you can streamline your workflows using data exchange and transformation.

add

You can use the add command to add scheduling items to the database.

Overview

You can add new items and items similar to existing ones. If an item already exists, you are asked whether to replace the item or not. You must specify the file location before the file name, if the file is not located where you run the command. You can use the unlock option, if the item is locked by any other user. The add command checks for loop dependencies in a job stream. There is a loop dependency in a job stream, if JOB1 follows JOB2 and JOB2 follows JOB1.

You must have add access to add an item to the database. If the item already exists and locked by any other user, then you must have modify and unlock access to the item.

Syntax and command line options

You must provide at least one scheduling or security item with the command to perform the action. You need to use the ;unlock parameter, if the item already exists and it is locked by the same user and session. You can enter the command as follows:

ocli model add|a filename [;unlock]

filename: You must specify the name of the file that contains the item definition.

;unlock

You must add the parameter, if the item you want to edit is locked by the same user and session.

Examples

Run the following command to add jobs from jobspend:
```
ocli model add jobspend
```
Run the following command to add job streams from skedon:
```
ocli model add skedon
```