Defining observer jobs using the Observer Configuration UI

Before observers can load data, you must first define and then run observer jobs. You configure jobs using the Observer Configuration UI, which you access through DASH.

Note: Using the Observer Configuration UI is the recommended method to configure and run observer jobs, but you can also do so manually using scripts, as described here in the Defining observer jobs manually topics.
SSL requirements: To acquire SSL certificates and build SSL truststores, use the relevant instructions in the following section: Configuring observer job security
To access the observer dashboard:
  1. Using a compatible browser, open DASH using the DASH URL. For example: 
    https://<DASH HOST>:<DASH PORT>/ibm/console/
  2. Login using your user credentials.
  3. Click Administration > Topology configuration.
  4. From the Topology configuration page, click Configure on the Observer jobs tile to display the Observer jobs page.
    All existing jobs are listed in a table by name, observer name, job status or job type columns, which are sortable.
    For each job its state is indicated. Hover over the state to see a tooltip with more information.
    From here, you can perform the following actions:
    Create a new job
    Click the blue Add a new job + button. The Add a new job panel displays all observers installed on your system.
    Click the tile of the observer to open its job configuration window.
    The Observer job configuration UI lists each job parameter that you have to configure. Define the job as described in the individual observer topics.
    View or edit an existing job.
    Click View & edit on the existing job's overflow menu to open its job configuration window.
    New in Version 1.1.16:
    Set the optional Generate debug support file parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated Support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. The file is saved to the following locations:
    On-prem
    $ASM_HOME/logs/<obs>-observer/
    On OCP
    /var/log/itsm/<obs>-observer
    Delete a job
    Click Delete on the existing job's overflow menu.
    Note: When deleting a running job, it will not complete its current run. Any previously loaded data will remain. You cannot delete a job that is in the 'Finishing' state.
    View job history
    Click View History on the existing job's overflow menu to open the Observer job history window listing the last ten jobs, when they were run, their observation count, duration and status.
    You can refine the list using the All, Complete, or Incomplete tabs.
    History is available for Load jobs only.
    Run a job
    Click Run in the Operation column to run on-demand (load) jobs.
    Toggle jobs on / off
    Click On (or Off) in the Operation column to run or stop listening jobs.
    Search for existing jobs
    If you have a large number of jobs configured, you can use Search to find it.
    Scheduled jobs
    If a schedule has been defined, you can hover over the Schedule icon to view additional details. The Schedule icon is either a clock icon if scheduled to run at set intervals, or an hourglass icon if it is scheduled to run only once at a future time.
    If a schedule has been set for a Load job, you can cancel the schedule using Remove Schedule, which will revert the job to a default, on-demand Load job.
Tip:
If an observer has been stopped or removed, you will be unable to run existing jobs, or add new jobs for that observer. Stopped or removed observers and jobs that are listed in the Observer Configuration UI will be disabled (grayed out) or removed in progressive (housekeeping) steps. If you are reinstalling or reactivating an observer, the jobs and the observer will again become available.
  1. Up to 5 minutes after removal, observers and jobs still appear as normal until the housekeeping process runs, but cannot be used.
  2. Up to 60 minutes after removal, the observer is still listed, but jobs are grayed out and marked offline until the next housekeeping process runs. You can delete existing jobs, but cannot view, add or edit jobs.
  3. After 60 minutes the removed observer is no longer listed, but jobs remain, though they are grayed out and marked offline. You can delete existing jobs, but cannot view, add or edit jobs.
  4. If at any time you reinstall or reactivate the observer, it reappears in the UI, and existing (previously active) jobs are no longer grayed out. You can delete, view or edit existing jobs, or add new jobs.