Getting started with HCL Universal Orchestrator: Day one set up

Access the user interface

Log in to the UI to begin managing your environment. The user interface is the central hub where you can design, orchestrate, and monitor your scheduling environment. The welcome page provides access to the main functional areas. Click Design to open the Graphical Designer, or click Monitor to open the Orchestration Monitor.

Define a folder

You should create folders to organize your scheduling items according to your business needs, such as by department or project. A single folder can contain multiple items, but each item belongs to only one folder.

1. Click Design to access the My workspaces page.
2. Click New workspace or open an existing workspace to access the Graphical Designer.
3. From the palette, select the Assets tab.
4. Click Add new and select Folder from the drop-down menu.
5. Specify a name for the folder, for example /orders, and if necessary, select a parent folder to create a hierarchy and click Add.

Define a workstation

A workstation is the computer or partition where your tasks and workflows actually run. While workstations are automatically created when you install an agent, you can also manually define them to manage pools or cloud task launchers.

1. Click Design to access the My workspaces page.
2. Click New workspace or open an existing workspace to access the Graphical Designer.
3. From the palette, select the Assets tab.
4. Click Add new and select Workstation from the drop-down menu.
5. Select the workstation type, such as pool, if you want to group multiple workstations together to balance the workload.
6. Enter the general information, including the name and the operating system of the machine and click Add.

Define a calendar

You must create calendars to define the specific days on which your workflows should or should not run. This is essential for handling holidays and non-working days in your schedule.

1. Click Design to access the My workspaces page.
2. Click New workspace or open an existing workspace to access the Graphical Designer.
3. In the Assets tab, click add new and select Calendar.
4. Enter a name for the calendar, such as holidays or maintenance_window.
5. Select the specific dates that apply to this calendar and add the definition.

Define credentials

You can define credentials to store user identifications and passwords securely. These credentials are used by task definitions to authenticate on operating systems or APIs when running your automation.

1. Click Design to access the My workspaces page.
2. Click New workspace or open an existing workspace to access the Graphical Designer.
3. In the Assets tab, click add new and select Credentials.
4. Enter a username and the corresponding password or secret.
5. Once added, you can reference these credentials in your task templates without revealing the sensitive password data.

Define a simple task template

You can create task templates to define reusable units of work. For your first item, you can create a simple RESTful API task that runs on the Cloud Task Launcher workstation, enabling you to test external connectivity without needing a local agent.

1. Click Design to access the My workspaces page.
2. Click New workspace or open an existing workspace to access the Graphical Designer.
3. In the Assets tab, click Add new and select Task template.
4. In the search bar, type REST, select the RESTful task type.
5. In the General information section, enter a Name, select a Folder, and select the Cloud workstation.
6. In the Action section, enter a valid Service URL and select the request Method (for example, GET).
7. Click Add to save the definition to the database.