Definitions

The Definitions View allows you to obtain counts for each object by container (Job Scheduler root, Folder and Plan). By default, all objects including containers are displayed. This view will show you where the greatest number of objects are, by type, and then show you the object itself.

 

The image below depicts a partial image of the Definitions View. There are additional object type columns not visible, and there is also a rightmost Total column (also not displayed in the image below).

 

You can access the Definitions view via the Views pane. By default, the view is stored the Developers folder. When accessed there, the Definitions view displays all the objects, system-wide. Therefore, it is a root-level view of the definitions. That is what the image below is displaying. The root is the very first record in the table, and it is represented by the forward slash "/".

 

 

As you expand each plan or folder, you can see how many of each object type is stored at that level. In the image below, the expanded Objects folder consists of 5 objects, and the total per object type is listed (and outlined in red) in the appropriate object column.

 

 

The total column associated with the above Objects folder would appear as shown below.

 

 

Notice the total column at the top of the above image, where it displays 85.  This means the Scheduler system has 85 objects created, system-wide.

 

You can also access the Definitions view for any folder or plan by right-clicking on it in the Navigation pane, then selecting View > Definitions. When this action is done for the above Objects folder, the Definitions view only returns data for that folder, as depicted in the image below. For this example, you see all the columns associated with this view.

 

 

Next, you can select the sorting sequence for a particular object by clicking on its column. This useful feature allows you to rearrange the levels (folders and/or plans) based on high-to-low (or low-to-high) for each particular object. For example, if you wanted to see from high-to-low how many Jobs are stored, level-wise, this view provides that information.

 

The buttons on the Definition view toolbar consist of the Refresh, Export View and Non-Container Objects dropdown.

 

The Refresh button refreshes the view since this view is not dynamically refreshed.

 

The Export View button allows you to create a CSV or HTML file of the various object totals. Using the CSV file, you can import the data into a spreadsheet where you can graph and/or report on the totals for each object for the entire system and/or on a level basis.

 

The Non-Container Objects dropdown functions as a filter - to show or hide non-container objects. Before we describe the filter, let's clarify a few things. First, non-container objects are all the user-defined ActiveBatch object types excluding folders and plans. Non-container objects include Jobs, Queues, User Accounts, Schedules, Alerts, etc. Next, container objects are the Scheduler root, folders and plans. They cannot be hidden. That said, the "Non-Container Objects" dropdown allows you to limit the non-container objects you see in the view.

 

By default, when you first access the view, all containers appear at the top of the list in alphabetical order, followed by each object class category in alphabetical order. Without selecting any other column heading, the only two options in the Non-Container Objects dropdown is Show All (the default) or Hide All. Show All means that all non-container objects types, as you expand the various containers, will be visible. If you select Hide All, you will only be left with the containers in the view. That is, all non-container objects will be hidden. If you expand any of the containers, you won't see anything (only other folders/plans, if any are nested). The object totals will remain the same since Show All and Hide All applies to object visibility and not the counts.

 

Next, if you click on a column heading for any of the non-container object types, the sort order changes from the Name column, to the column you selected. You can toggle the sort order from descending to ascending and vice versa when clicking on the same column heading. In addition, you will see one more option in the Non-Container Objects dropdown, in addition to Show All and Hide All - and it will be the default option and therefore the currently set filter. The additional option is "Based on Sorted Column". What this means is whatever non-container object column you clicked on, you will only see that object type as you expand the various containers. All other non-container object types will be hidden. The other filter options, Show All or Hide All, will display all non-container object types - or hide them.

 

As a Based on Sorted Column example, if you click on the Execution Queues column heading, only Execution Queue objects will be displayed (in whatever containers they are stored in) - in alphabetical order. The other non-container types are not displayed. This filter option lets you focus on the non-container object type you wish to locate and/or see counts for. The object totals remain the same, since this option (like Show All and Hide All) applies to object visibility and not the counts.