Workstation class definition

A workstation class is a group of workstations for which common jobs and job streams can be written. You can include multiple workstation class definitions in the same text file, along with workstation definitions and domain definitions.

When defining workstation classes, ensure that the workstations in the class support the job types you plan to run on them. The following rules apply:
  • Job types with advanced options run only on dynamic agents, pools, and dynamic pools.
  • Shadow jobs run only on remote engines.

When creating a scheduling object, you can define it in a folder. If no folder path is specified, then the object definition is created in the current folder. By default, the current folder is the root (\) folder, but you can customize it to a different folder path. You can also use the composer rename command to move and rename objects in batch mode that use a naming convention to a different folder using part of the object name to assign a name to the object.

Note: When defining a workstation class containing fault-tolerant agents at versions earlier than 9.3 Fix Pack 1, the following problems might be encountered: scheduled objects on the fault-tolerant agents are not correctly managed, the statuses of jobs and job streams are not reported consistently, and the number and statuses of unsatisfied dependencies related to conditional dependencies are reported incorrectly.

Each workstation class definition has the following format and arguments:


cpuclass [folder/]workstationclass
   [description "description"]
   members [[folder/]workstation | @] [...]
[cpuname ...]
[cpuclass ...]
[domain ...]


cpuclass [folder/]workstationclass
Specifies the name of the folder within which the workstation class is defined, if any, and the name of the workstation class. The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores. It can contain up to 16 characters.
Note: You cannot use the same names for workstations and workstation classes.
description ”description
Provides a description of the workstation class. The description can contain up to 120 alphanumeric characters. The text must be enclosed within double quotes.
Specifies that HCL Workload Automation must ignore all workstations included in this workstation class when generating the production plan.
members [folder/]workstation
Specifies a list of workstation names, preceded by the folder name within which the workstation class is defined, if any, separated by spaces, that are members of the class. The @ wildcard character means that the workstation class includes all workstations.

With the introduction of folders in which to define workstation classes, a change has taken place with respect to the use of wildcards in specifying workstation classes. While in the previous releases, wildcards applied to all workstation classes matching the specified requirements, starting from version 9.5, Fix Pack 2, wildcards apply to all workstation classes matching the specified requirements and stored in the same folder as the specified workstation class and all its subfolders.

To create or modify workstation classes, add the USE access method to CPU objects that are, or will be, members of a workstation class.


The following example defines a workstation class named backup:
cpuclass backup
The following example defines a workstation class named allcpus that contains every workstation:
cpuclass allcpus

See also

For more information about how to perform the same task from the Dynamic Workload Console, see:

Designing your Workload.