Status Page

From MidasWiki
Jump to: navigation, search


Links


Purpose

The purpose of the mhttpd status page is to allow the user to control and monitor the experiment.

  • NOTE* Since Fall 2017 the look of the MIDAS status page has changed significantly, with the navigation buttons moving from the top to the left side. But the functionality of the status page is basically unchanged. The pictures on this document are from the pre-2017 status page.

Access the status page

If the MIDAS web server mhttpd is running, the experiment can be accessed from the web (see usage). An example of the status page is shown in Figure 1. By default, anyone can access the experiment via the web. Web access restrictions to the experiment can be set by the user (see Security).

Status Page Refresh

It is important to note that the refresh of the Status Page is not "event driven" but is controlled by a timer whose rate is adjustable through the Config Page. This means the information at any given time may reflect the experiment state of up to n seconds in the past, where n is the timer setting of the refresh parameter.

Features of the status page

Figure 1: Example of status page
Click image to enlarge

The status page is divided into several parts

  • Menu Buttons
    • Run Control buttons
    • Page Switch Buttons
    • Optional (user-defined) buttons
  • Run Status information
    • Optional display of status items
    • Last system message
  • Equipment Information and Event rates
  • Data Logging Information
  • Active client list

Menu Buttons

The top row of Menu buttons on the main status page Figure 1 include the run control buttons (Start/Stop/Pause/Resume depending on the run state) and the page switch buttons (e.g. ODB, Messages, Elog, Alarms, Programs, History, Sequencer, MSCB, Chat, Help). Clicking on a page switch button will replace the Status page with the requested page. The pages may contain a Status button to return to the Status page (see select visible menu buttons, or the browser "Back" button can be used.

For the Config button see page refresh.

Select visible menu buttons

Not all the available buttons may be visible on the status and other pages. Keys in the /Experiment ODB tree control which menu buttons are visible. The user may customize these by hiding unneeded buttons. The Menu Buttons key lists the buttons to appear on the page. By default, the Status button is not visible on subpages, but can be made so by adding "Status" to this key.

Sometimes it is desirable to stop users from starting/stopping or pausing/resuming runs, and this can easily be done by hiding the appropriate buttons. The Start/Stop buttons and Pause/Resume buttons may be suppressed using the Start-Stop Buttons and Pause-Resume Buttons keys respectively.

Note that the MSCB button will only be visible if MSCB support has been built into Midas.

Optional Buttons

On the Status page (Figure 1), below the Menu Buttons, there may be up to three rows of optional user-added buttons. These may include

In Figure 1, test is a script-button, ppg-cycle is a custom-button, the other buttons on the line are all alias-buttons.

Alarm Banner

Figure 2: Example of status page with alarm banner

The alarms (see Alarm System) are configured using the Alarms Page. If an alarm is triggered, a banner appears on the status page as shown in Figure 2.

The alarm may be reset with the Reset button on the banner (or on the Alarms Page). However, unless the alarm condition is resolved, the alarm will be triggered again at an interval given by Check interval, causing the alarm banner to reappear. To see which alarm(s) have triggered, check the Alarms Page.

The alarm message and colour of the banner are configured in the ODB /Alarms/<alarm-name> and /Alarms/<class-name> subtrees respectively.

Run Status Information

The a space Run Status space a information on the status page (Figure 1) displays important information, such as the run status, alarm system status and data directory. The run may also be started/stopped using the button provided. The colour or information changes depending whether the run is active or not (e.g. run elapsed time or run stop time). By default, the experiment name is also shown here. The user may choose to display other useful information in this area (see Status items.

The last item in this area is a one-line display of the last Midas message. More messages can be viewed on the Message page by clicking Message.

Equipment Information

Click a thumbnail to enlarge

The a space Equipment space a area on the status page (Figure 1) shows the status (by colour) of any defined Equipments (unless hidden). If Hidden equipments are present, they may also be displayed by clicking on the "+" link above the equipment names. This area also displays the number of events sent, the event rate and the data rate. These values are found in the Statistics subtree for each Equipment.


The names of the equipments are links to the /Equipment/<equipment-name>/Variables subtree. If the Equipment sends data to the ODB (see Log History and RO_ODB flag), clicking on this link will display the contents of the /Equipment/<equipment-name>/Variables subtree with the name of each variable if the <Names> subtree has been set up (Figure 3). Slow Control Equipments (Figure 4) are often accessed in this way, unless they use the MIDAS Slow Control Bus, in which case they are viewed using the MSCB Page.



Logging Channels

The a space Logging Channels space {{Spacer|blank=ab} section on the status page (Figure 1) contains a display of the status of open logging channels, number of events logged, disk usage etc.

Clients

The a space Clients space b area on the status page (Figure 1) displays the names of the clients that are currently running.