Instances pane
The Instances pane is shared with other tabbed options including Instance Details, Generic Queue Instances, Log Viewer, and the Alerts pane. A high-level description of each tabbed option is provided in this section. But, if you would like to access more details, click on the desired link below.
The Instances Pane is located at the bottom of the UI by default, under the Main view. The Instances pane is the only one initially open and visible, by default. That is why it is typically referred to as the Instances pane, although is it shared by the other tabbed options stated above. The other options tabbed in this pane are accessed via the Open/Close Panes button in the lower right-hand corner of the UI. The Instances pane displays all the instances for the selected Job, Plan or Queue object. There are also filters you can set, based on the date/time the instances ran, and/or the state of the instances (eg. failed, succeeded, aborted, etc.).
The Instance Details Pane is accessed via the Open/Close Panes UI option. By default, it is tabbed alongside any other open options that are accessed via this pane, since the pane is shared. The Instance Details are displayed for the currently selected instance. The details are organized into 3 separate tabs. One tab displays the selected instance’s Job log file (which can be viewed real time, when auto-refreshed is enabled), another tab displays a graphical time line of the instance's audits, and the last tab displays variable resolution (the variable names and values).
The Log Viewer Pane is accessed via the Open/Close Panes UI option. By default, it is tabbed alongside any other open options that are accessed via this pane, since the pane is shared. The Log Viewer option contains informational, success and error messages concerning your use of ActiveBatch as you perform actions in the UI. A button to the far right of the window allows you to clear the log. Examples of the type of activity logged include manual triggers, deleting objects, disabling objects, adding objects to Favorites, emptying the recycling bin, moving an object, etc. Please note that some UI actions, as they are relate to objects, are also recorded in the individual object's audit trail (see the Analytics property sheet for audit information).
The Generic Queue Instances Pane is accessed via the Open/Close Panes UI option. By default, it is tabbed alongside any other open options that are accessed via this pane, since the pane is shared. Its purpose is to display all Jobs that are active on the Execution Queues that are members of the Generic Queue
. This view is updated when you select a Generic Queue in the Object Navigation Pane, Browse View or Definitions view. After selecting a Generic Queue, you will see, in a list format, the names of the Execution Queues associated with the Generic Queue, and the Jobs currently running on each Execution Queue (if any). The Jobs you will see in this view can be associated to the Generic Queue you selected, and/or they can be associated with an Execution Queue that happens to be a member of the selected Generic Queue. Either way, no matter how the Job ended up running on an Execution Queue in the list, they will be displayed when they are active. As the instances complete, they are automatically removed from this view.
The Alerts Pane is accessed via the Open/Close Panes UI option. By default, it is tabbed alongside any other open options that are accessed via this pane, since the pane is shared. The Alerts pane displays two categories of records:
-
The first category is any alert condition you configure, for example, a Job failed, or a Queue went offline, can be written to the Alerts pane - using the "ActiveBatch Alert" notification type. An operator can monitor the Alerts pane, take ownership of an alert, and add any helpful comments.
-
The second category of records that are added to the Alerts pane are Jobs or Plans that have been triggered, but they are being held back from running, by design, until an operator responds to the waiting Job. This feature is typically used when a Job requires some kind of manual intervention before it can execute. The properties to configure this option can be found on a Job or Plan's Constraints property sheet - see Constraints > General > Add > Variable > Active Variable > User Input.
Almost all views and panes support dynamic real-time display. For example, the Daily Activity view tabbed in the Main view and the Instances view tabbed in the Instances pane are updated real time. This is a desired feature when you want to watch your Plans and Jobs as they execute and complete. You do have the option to disable auto updates. To do this, launch the Connection Manager (press F4) and check Disable Auto Updates. When you connect to a Job Scheduler with Auto Updates disabled, the Job Scheduler object at the top of the Object Navigation pane will have a red lightening bolt icon to the left of the computer icon. If you mouse over the icon, a tooltip will pop up stating "Auto Updates Disabled". Finally, the views described here support color-coded instances to denote their state (e.g. executing, waiting, failed, completely successfully, etc.).
Many of the windows and panes feature a small “pin” icon. This pin allows you to indicate whether you want the window to always be displayed or to display the window only when you hover your mouse cursor over the tab name for the pinned pane. Many of the panes also allow to you to move them to another location (float, dock, etc.), detaching it from the Main window.