Listing object definitions in the database

About this task

The following sections describe how you list the object definitions available in the database.

Listing workload objects

About this task

To list all the workload definitions except for event rules, open the Workload Designer as follows:
  1. From the navigation toolbar, click >Workload Definitions>Manage Workload Definitions.
  2. In the displayed panel, specify the engine connection you want to use. Only the categories of objects supported by the engine you selected are available.
You can open multiple occurrences of the Workload Designer, but only the following scenarios are supported:
  • Same user connected to multiple engines
  • Multiple users connected to the same engine.

Procedure

From the Workload Designer you can use the Working List view to list objects:
Perform the following steps:
  1. Specify the object name in Search field and select the object you want to view or modify. A toolbar is displayed with the icons of the objects you can search for. You can also click on Advanced to specify advanced search criteria.
  2. From the displayed list, select one or multiple objects and click one of the following action buttons:
    Create like icon Create like
    To create a new object with the same properties of the selected object.
    Edit icon Edit
    To modify the properties of the selected objects. When an object is open in edit mode the edit icon The edit icon is displayed on the right of the object.
    Unlock icon Unlock
    To unlock the selected objects for further actions. When an object is unlocked, it is displayed in read-only mode.
    Delete icon Delete
    To delete the selected objects from the database.
    Create new icon Create New menu
    To create a new object.
    Close selected Close selected
    To close the currently open object.

All the selected objects are listed in the Working List view. When you select an object from this list, its properties are displayed in the right pane, where you can view or edit them, if you have the required authorization defined in the HCL Workload Automation security file.

By hovering with the cursor over the icons located on the toolbar, you can see all the actions you can perform on the selected objects.

Listing jobs and job streams

About this task

To view a list of jobs and job streams available in the database, perform the following steps:

Procedure

  1. In the navigation bar at the top of the page, click Administration > Workload Design > Manage Workload Definitions
  2. In the displayed panel, specify your engine connection and the filtering criteria for your query. With distributed engine connections, from the Object type drop-down menu, select the object you want to list.
  3. In the Columns section, select the column you want to display in the list of results.
  4. Click Display to launch the query.

Listing event rules

About this task

To view a list of event rules available in the database, perform the following steps:

Procedure

  1. From the navigation toolbar, click Administration > Workload Definitions > Manage Event Rules. Or In the navigation bar, click Monitoring and Reporting > All Configured Tasks > New.
  2. In the Select Task Type section, select Event Monitoring Task > List Event Rule Definitions and click Next.
  3. In the Enter Task Information panel, specify the task name and select the engine connection where you want to run the task. You can run this type of query only for HCL Workload Automation and IBM® Z® Workload Scheduler Actions. You can click Lookup to select jobs, job streams, and workstations defined in the database on either the master domain manager or on a node installed as a backup master domain manager, but not necessarily belonging to the master domain. You can also specify whether to share the task with others, to allow them to see and run the task, but not to modify it.
  4. Click Next to proceed with task creation or click Finish to complete the creation using the default values and exit without proceeding to the following steps. If you are editing an existing task, properties are organized in tabs.
  5. In the Filter Criteria panel, specify some broad filtering criteria to limit the results retrieved by your query. Here you start refining the scope of your query by also considering the amount of information you want to retrieve. You can search for event rule definitions based on their status, validity intervals, or types of events and associated actions.
  6. In the Columns Definition panel, select the information you want to display in the table containing the query results. According to the columns you choose here, the corresponding information is displayed in the task results table. For example, for each of the event rule definitions resulting from your query, you might want to see the status, type, or timeframe during which it is valid. You can then drill down into this information displayed in the table and navigate it. In the Columns Definition panel, not only can you select the columns for this task results, but you can also specify the columns for secondary queries on event rule instances. The information to be retrieved with these secondary queries is specified in this panel.
  7. In the All Configured Tasks panel, you can see the main details about the task that you have just created. You can also choose to run the task immediately. The task is now in the list of your tasks where you can open and modify it. You can find it in the task lists displayed by clicking the following options: All Configured Tasks or Administration > Workload Definitions > Manage Event Rules.
  8. After running the task, a table is displayed showing a list of event rule definitions, on which you can take several actions, such as setting them as complete or as draft depending whether you want to make them available for deployment.

Listing workstations

About this task

To view a list of workstations available in the database, perform the following steps:

Procedure

  1. From the portfolio, click Administration > Workload Environment Design > List Workstations.
  2. In the displayed panel, specify your engine connection and the filtering criteria for your query.
  3. In the Columns section, select the column you want to display in the list of results.
  4. Click Display to launch the query.