Table Of Contents

Previous topic

Reef Landing Pages

Next topic

Event Management Dashboard

Reef Client Overview

After logging into the The Reef Client you will be presented with one of the available Dashboards. There are several User Interface (UI) features common to many dashboards that are described here.

_images/reef_client.png

The Reef Client

Application Control Bar

The Application Control Bar is a placeholder for various controls and menu items that each Reef Dashboard makes available. The control bar’s content may vary between dashboards. Most controls provide feedback when hovering the mouse over them, for example, indicating the control is an link that can be used to invoke some sort of action (e.g. logout) or providing some additional information in the form of a tool tip.

_images/appctrlbar.png

Application Control Bar

In the example above the content includes (from left to right):

  • Abilisoft logo and title, these are always displayed.
  • Message Pane. The Message Pane has various purposes, from indicating the client’s connection status with the Reef Server to displaying pertinent operation modes instigated by the user. The Message Pane is described in more detail later in this section.
  • Current logged in user.
  • Clock.
  • Logout link.

Logo Behaviour

In the top left-hand corner of Reef Client click on the Abilisoft logo and an About Box containing version information will be displayed. The about box also contains two links above the OK button, one to e-mail Abilisoft Support and one to navigate to Abilisoft’s web site. Use the OK button to dismiss the about box.

_images/about.png

About Box

Message Pane Behaviour

The Message Pane is multi-functional control that will present itself in various ways. Dashboard specific Message Pane behaviour will be described in the relevant sections however general Message Pane behaviour is described here.

Connection Status

The connection status is reflected in the Broadcast Icon displayed in the Message Pane. Normally the broadcast icon should represent either an idle communication status as shown below or an Active Communication Status, meaning the client is in the process of communicating with the server.

_images/msgpanecommidle.png

Broadcast Icon

_images/msgpanecommactive.png

Active Communication Status

If at any time the Reef Client fails to contact the server the broadcast icon becomes red indicating a Retry Communication Status.

_images/msgpaneretry.png

Retry Communication Status

If, during any communication with the server, a connection is established but the server encounters an error a Server Error Status is displayed.

_images/msgpaneerr.png

Server Error Status

Connection Status Dialogue

If the communications failure is transient then normal operations should ensue. You can examine details about any communications or server errors by clicking on the broadcast icon. This will display the Server Connection Status Dialogue.

_images/faultdlg_svr_ok.png

Server Connection Status Dialogue

The dialogue will be displayed as above when there are no recorded connection or issues. Click the Done button to dismiss the dialogue. The connection status dialogue displays details of connection and server faults that have occurred in the current session. All faults encountered will persist in the Connection Status Dialogue list until the client is closed. Alternatively you can use the Clear All or Clear Selected buttons to remove old faults. Note that the fault entries are just a record of faults detected and have no impact on determining the current connection status. If there have been communication or server errors in the current session the you might see Connection Status Issues.

_images/faultdlg_svr_fail.png

Connection Status Issues

The example in Connection Status Issues shows the kind of messages you will see if the server cannot be found. If the Reef server can be found but is raising errors then Server Error Issues will be seen in the dialogue.

_images/faultdlg_svr_err.png

Server Error Issues

The client will continue to operate as best it can and is tolerant of transient connection failures. However, if the communication failures persist for contiguous attempts longer than a pre-defined period then you will be notified with a Server Connection Failure Dialogue. Click OK to dismiss the dialogue.

_images/serverconnfail.png

Server Connection Failure Dialogue

The time between the first communication failure and when this dialogue is displayed is configurable, talk to your Administrator if you would like it changed. After a permanent communications failure the Reef Client will continue to try to reconnect. After the Server Connection Failure Dialogue is displayed the broadcast icon will be replaced with the Connection Failure Message.

_images/connfailmsg.png

Connection Failure Message

Clicking this message will display the Server Connection Status Dialogue. As attempts to re-establish communications with the Reef Server continue the Connection Retry Message will be intermittently displayed.

_images/connretrymsg.png

Connection Retry Message

When communications do finally resume the Broadcast Icon will revert to normal behaviour toggle between idle and an Active Communication Status.

Dockers

Some dashboards utilise a Docker control. This is a window component that contains a number of other controls used to interact with the Reef Client. A Docker is normally hidden in order to make the most of the screen real-estate available to the Reef Client. The Docker control has various states: Hidden, Revealed, Pinned, or Ripped.

All Dockers have a Title Bar that describes the Docker and sometimes contains additional, contextual information.

_images/dock_title.png

Title Bar

Hidden

A Docking Window Hint Bar indicates the presence of a Docker for a given screen in the Reef Client. Hovering the mouse cursor over this bar will cause the Docker to be Revealed.

_images/dock_hint.png

Docking Window Hint Bar

Revealed

A Docker will remain revealed for as long as it has mouse cursor focus. This means you can quickly hover over a Docker, click a button or examine some values then move the mouse away, the Docker will automatically retract when it loses mouse focus.

_images/events_dock_revealed.png

Docking Window

Pinned

You can Pin a Docking Window if you want it to remain open after it loses mouse focus. Simply reveal the Docker and click the pin located on the top right of the Docker window. The docker will remain revealed until you either unpin the Docker (allowing it to retract when it loses mouse focus), or rip the docker.

_images/dock_pin.png

Pin a Docking Window

Ripped

When a Docker is in the Revealed or Pinned states it is possible to drag (rip) it to another location within the browser window that the Reef Client is displayed in. Once ripped it will remain in view even if it loses mouse focus. To rip a Docker, left-click on the Docker Title Bar and drag the docker to the desired location.

When in the ripped state the Docker’s pin control (used to pin the Docker when initially revealed) changes into a Close Control. Click this to put the Docker back into the Hidden state.

_images/dock_close.png

Close Control

Note that when in the Ripped state a Docker can only be dragged to coordinates within the current browser window, not outside.

Dashboards

In general the Reef Client is organised into various dashboards. These are logical collections of functionality, typically presented as a set of tabbed views. The remainder of this guide describes the Reef Client Dashboards.