This manual describes the functionality of the Halogen Browser and how to use it to extract useful data from Halogen. This manual assumes that the user is familiar with basic windows concepts and terminology.

The Halogen Browser is a software tool which enables the user to view a graphical representation of the information held in the Halogen database. The information which is displayed is based on events, which correspond to individual NMCS equipment logs from Halogen. These events combine to form a "picture" of the network of roads for which the Highways Agency is responsible.

Retrieving Information

The information to be displayed is retrieved from the Halogen database by submitting queries from the Browser. It is possible to submit four types of query, two of which are based on historic information with the further two relating to current events:

Historic - Range

A range query allows the user to specify a start and end date/time, all events in this range are then retrieved. With range data, it is possible to scroll through the entire range of data, and also to have the Browser automatically "replay" the events in sequence.

Historic - Snapshot

A snapshot query retrieves the state of equipment on the network at a given point in time.

Current - Snapshot

The current snapshot query retrieves the current state of the network based on the criteria entered. Various user options allow selective retrieval and display of this information, so for example it is possible to display just the faults for a particular road section, selected area or control office.

Current - Auto Update

The Auto Update query is an extension of the Current - Snapshot query, which operates by constantly updating the display information to produce near real-time results whilst minimising network bandwidth.

· Information Display

The Browser displays a map, on which it is possible to view the following types of events:

· Sign Settings (Variable Message Signs)

· Signal Settings (Matrix signs)

· Control Office Logging System Status

· Equipment Faults

· Telephone Faults

Three zoom levels are used to show the events at different levels of detail. Scroll bars and arrow keys allow navigation around the map, and an additional "overview" map shows the position of the displayed information relative to the map.

1.2 Halogen

Halogen is the NMCS Central Logging Service. It provides centralized storage, retrieval and dissemination of current and historical log data generated by Highways Agency systems in Control Offices (CO) and Regional Control Centres (RCC) throughout England.

Halogen's primary functions are:

· Secure storage of NMCS logs

· Centralised log enquiry and reporting facilities

· Up to date information on Logging System Status

· Delivery of operational information statistic reports to the Highways Agency Managers and Maintaining Agencies.

Secure storage of NMCS Logs

Halogen accepts NMCS logs according to configurable rules (log templates) and provides secure storage of received logs in its database. Halogen acknowledges each log received. Logs are stored securely and in such a way that no single point of failure will lead to their loss. All logs sent to Halogen must contain standard 'header' information, must be encoded in a specified way, and must be sent according to a simple application-level protocol. These simple rules define a common interface for all NMCS (National Motorway Communication System systems) that log to Halogen.

Information currently gathered includes:

· Signals

· Telephones

· Signs

· Equipment Faults

· Control Office Logging System Statistics

Central log enquiry and reporting facility

Halogen organises the Log Data so as to provide the minimum restrictions on reporting. Halogen accepts users' requests to search and report on the data, and it returns matching logs and/or statistical information about the logs.

Halogen’s architecture is designed to provide maximum flexibility of reporting. It does not enforce rigid rules for acceptable access paths, nor is it necessary to decide in advance what statistics it must collate. Instead, Halogen stores logs in their simplest form and generates each report, including any statistics, from scratch every time a user requests it. In this way it is not oriented to any particular report, nor is it restricted in what it can report on and what it cannot. Remote user access to Halogen is provided via a number of Applications and a variety of mechanisms.

These include:

· Suite of Standard reports available through the Halogen website.

· Customised reports developed as required to meet a particular user’s needs. Users requiring a customised report should contact the Halogen Help Desk.

· Applications such as the Halogen Browser and the Halogen Web Reporting Application

· Users own development of log reports using standard report writing tools (e.g. Sybase Infomaker).

· Direct access to Halogen log data via open standards (e.g. ODBC, JDBC, xml)

Up to date information on Logging System Status

The Halogen web suite provides users with up to the minute details of Halogen operation and the status of its links to Logging Systems. Information is also provided on any invalid or unrecognised logs received by Halogen.

For up to date information on Halogen go to the Halogen web site at http://www.businesslink.gov.uk/halogen/ .

1.3 Legal Use of Halogen Data

Under no circumstances should users extract Halogen data, either via a reporting tool or directly, for use in court proceedings. If Halogen data is to be used in court please contact the Mott MacDonald Help desk for further assistance.

Halogen Technical Note 091 ‘Provision of log data in support of court proceedings’ provides more information on this topic and can be found on the Halogen website at http://www.businesslink.gov.uk/halogen/.

1.4 Terminology used in this Manual

The following terms are used in this document

· Dialogue box – Small Windows style window that contains information helpful to the user.

· Menus – Provide a quick and easy way to access functionality within the main application.

· Right-Click – Refers to using the right mouse button.

1.5 Mott MacDonald Help Desk

Mott MacDonald operates a Help Desk for Halogen. The Help Desk should be contacted if you wish to become a Halogen user or have any query regarding the Halogen system and its functions. The Help Desk provides users with general support on using Halogen to report on log data.

All Halogen faults should be reported via the Help Desk.

The Help Desk contact details are:

Telephone Number: 0141 222 4666

Fax Number: 0141 222 4667

Email Address: helpdesk.tts@mottmac.com

The project website http://www.businesslink.gov.uk/halogen/. provides more information on Halogen and its associated services.

2 How To Use The Halogen Browser To...

The Halogen Browser is a versatile program with the ability to supply the user with concise information regarding road equipment. The following sections describe how to get the most out of the program for most common scenarios.

2.1 How to use the Halogen Browser to identify the events associated with an accident

A Date Range query allows the user of the Halogen browser to identify the sequence of events before and after an accident:

To perform a Date Range query:

1. Logon to the Halogen Browser

2. Click on the Criteria tab.

3. Select the road section that the event occurred on. Do this by either drawing a bounding box over the required accident region on the map or by selecting the region from the drop down menus.

Make sure after you have drawn the bounding box, to select 'Geographic Area' in the Criteria window.

4. Select the type of events you wish to see. For accidents it is likely that the most relevant information is: Signal Setting, Message Sign Settings, and Device status.

5. Enter a suitable time range for the accident, i.e. a short time before the accident occurred extending to after the accident has been cleared.

6. Click on the 'Start' button to execute the query, with the option of cancelling the query handled by pressing 'Stop'.

Once the query has finished running, the playback toolbar will appear allowing the user to playback the events associated with the accident.

2.2 How to use the Halogen Browser to identify events associated with a specific journey

A Date Range query allows the user of the Halogen Browser to identify the status and setting of equipment at a point in time and the time sequence of events following.

To perform a Date Range query:

1. Logon to the Halogen Browser.

2. Select the Criteria tab.

3. Select the road the journey went through from the drop down menus, or draw a bounding box on the Map display to select the region of interest.

Make sure after you have drawn the bounding box, to select 'Geographic Area' in the Criteria window.

4. Select all the events of interest.

5. Enter a suitable time range for the journey, i.e. a short time before the journey started extending to after the journey was completed.

6. Click on the 'Start' button to execute the query, with the option of cancelling the query handled by pressing 'Stop'.

All the events are now ready to be played back using the playback toolbar on the map display to see the events that happened during the time range.

2.3 How to use the Halogen Browser to get the current state of signals and settings on the Highways Agency road network

A 'Current - Snapshot' query allows the user of the Halogen browser to see the current settings and faults for equipment within a desired region.

To run this type of query, the following actions need to be followed:

1. Logon to the Halogen Browser

2. Click on the Criteria tab.

3. On the Map display, draw a bounding box around the area on the network that you wish to query on. Or the user may select the region via the drop down menu.

Make sure after you have drawn the bounding box, to select 'Geographic Area' in the Criteria window.

4. Select the events of interest.

5. Click on 'Current - Snapshot' to retrieve the current state of signals and settings.

or,

Click on 'Current - Auto Update' to retrieve the current state of signals and settings determined by a value set in the Properties. This function enables the browser to constantly refresh its content thus producing a near real-time visualisation of events.

6. Click on the 'Start' button to execute the query, with the option of cancelling the query handled by pressing 'Stop'.

NB: If the choice of time period was 'Current - Auto Update', the browser presents the status of the updating on the status bar underneath the Map pane. The status bar logs the time of the most recent event received ('Latest Time') and also the time of last check for updated event information ('Update Time'). The 'Updated Time' will change periodically, but will only ever affect the Map if a new event has been received, in which case the 'Latest Time' will also change accordingly.

On execution of the query, the current status of the events can be viewed via the map.

2.4 How to use the Halogen browser to monitor the current level of faulty equipment on the Highways Agency road network

A 'Current - Snapshot' and 'Current - Auto Update' query allows the user of the Halogen browser to see the current settings and faults for equipment within a desired region.

To run this type of query, the following actions need to be followed:

1. Logon to the Halogen Browser

2. Click on the Criteria tab.

3. On the Map display, draw a bounding box around the area on the network that you wish to query on. Or the user may select the region via the drop down menu.

Make sure after you have drawn the bounding box, to select 'Geographic Area' in the Criteria window.

4. Select the faults of interest:

5. Select 'Current - Snapshot' to retrieve the current state of signals and settings. If the user wishes the current status to be updated as the status changes then select the 'Current - Auto Update'. When a new fault arrives into the system then this will be included into the query results.

or,

6. Click on the 'Start' button to execute the query, with the option of cancelling the query handled by pressing 'Stop'.

After the query has finished running, the current status of the faults will be available for viewing on the map.

2.5 How to use the Halogen browser to see equipment setting and fault events at a specific time in history

A 'Historic - Snapshot' query allows the user of the Halogen browser to see the settings and faults for equipment within a desired region at a specific point in time.

To run this type of query, the following actions need to be followed:

1. Logon to the Halogen Browser

2. Click on the Criteria tab.

3. On the Map display, draw a bounding box around the area on the network that you wish to query on. Or the user may select the area by selecting values from the drop down menus.

Make sure after you have drawn the bounding box, to select 'Geographic Area' in the Criteria window.

4. Select the events to be queried for:

5. Click on 'History - Snapshot' and then enter a date and time in the format: dd/mm/yyyy hh:mm, for example 05/04/2005 15:45

6. Click on the 'Start' button to execute the query, with the option of cancelling the query handled by pressing 'Stop'.

After the query has finished running, the status of the events at the specified time will be available for viewing on the map.

2.6 How to improve the relevance of fault events displayed in the Halogen Browser

There may be times when a query may display a large number of fault events. The volume of the these faults may obscure the detail of other events from the user. The time relevance of recent events can be improved by refining the 'Time Period value for recent logs'.

This is achieved by setting the 'Time Period value for recent logs' to a time that is considered relevant to the analysis. i.e. Display events which have occurred only within the last three 3 days, 6 hours or 1 hour.

To improve the relevance of fault events:

1. Select Preferences from the View menu.

2. Selecting the View Options, change the value of the 'Time Period value for recent logs'. This value may be set in days or hours, depending on the user.

3. After closing this dialogue down, the user may select the 'Show Only Recent Events' button from the toolbar. This will then 'hide' the events that the user does not wish to view.

2.7 How to use the Halogen Browser to monitor the state of logging system connections to Halogen

A 'Current - Snapshot' and 'Current - Auto Update' queries allows the user of the Halogen Browser to see the current state of all logging systems known to the system.

To perform a Current query:

1. Logon to the Halogen Browser.

2. Select the Criteria tab.

3. Begin by selecting 'Current - Snapshot' to retrieve the current state of signals, settings and Logging System Status. If the user wishes the current status to be updated as the status changes then select the 'Current - Auto Update'. When a new fault arrives into the system then this will be automatically included.

4. On the Map display, draw a bounding box on the map around the area on the network to be queried or the select the region via the drop down menu.

Make sure after you have drawn the bounding box, to select 'Geographic Area' in the Criteria window.

5. Select the events (Settings events) of interest ensuring that the 'Logging System Status' tick box is selected (enabled only when 'Current - Snapshot' or 'Current - Auto Update' time periods are selected)

6. Click on the 'Start' button to execute the query, with the option of cancelling the query handled by pressing 'Stop'.

After the query has finished running, the current status of the events and logging systems will be available for viewing on the Halogen Browser.

3 Installation

3.1 System Requirements

Hardware Requirements

Minimum hardware

· Pentium 4 1.5GHz PC or equivalent.

· 256MB RAM

· 20GB hard disk with 600MB available for the installation of the Halogen Browser, additional space (swap file, locally stored data) will be required during the operation of the program.

· Graphics card capable of displaying 1024x768 in 16-bit colour.

· Mouse.

· Keyboard.

· 17" screen capable of displaying 1024x768.

Recommended hardware:

· Pentium 4 2GHz PC or equivalent.

· 512MB RAM.

· 40GB Hard disk with 600MB available for the installation of the Halogen Browser, additional space (swap file, locally stored data) will be required during the operation of the program.

· Graphics card capable of displaying 1280x1024 in 16-bit colour.

· Mouse.

· Keyboard.

· 19” screen capable of displaying 1280x1024.

Software Requirements

Verified Operating system platforms:

· Windows XP Professional, Service Pack 3 with the latest security patches applied.

· Windows 7 Professional Service Pack 1 with the latest security patches applied

Other Windows versions will be supported on a best effort basis only.

Internet Explorer 7 or 8 is required to view the integrated help pages and integrated access to other web sites.

Network Requirements

All remote connections to Halogen are achieved via the Internet. An internet connection is therefore required to use the Halogen Browser.

3.2 Installing the Halogen Browser

To install the Halogen Browser;

1. Download the installation from the Halogen website at:
https://halogenonline.dft.gov.uk/halogenweb/jsp/Secure/downloads.jsp
Note that you will need a Halogen account to be able to access this page.

2. From the “Software” section, click the “Halogen Browser” link. This will ask you to save the installation program to a location of your choice on your computers local Hard Drive.

3. If a previous browser version is installed on the machine, this should be uninstalled before installing the new version

4. After the download has finished, double click on the installation program at the location where the file was saved. The installation will now start, simply follow the on-screen instructions.

The following describes the installation process.

The welcome screen is displayed. Click the “Next” button.

Select the folder where the Halogen Browser is to be installed. It is recommended that you keep the default install folder that is displayed. Click the “Next” button to continue.

If your Internet access is normally via the use of a corporate proxy server, then this information can be entered here. If you have a direct connection to the Internet leave the data blank. If you are unsure leave blank for now and contact your local IT representative. Click the “Next” button to continue.

Choose the location of the program shortcut on the start menu. It is recommended that you keep the default folder that is displayed. Click the “Install” button to proceed with the transfer of the program.

After the program has been transferred, the result screen is shown. Press the “Next” button to continue.

The installation is complete, select 'Finish'. The Halogen Browser is now ready.

4 Getting Started

This section describes how to get started using the Halogen Browser.

4.1 How to become a Halogen Browser User

Click here to go to the Downloads page from where you can obtain a copy of the Browser software.

From there you can download an executable which when run will install the Browser.

Then you will need to contact the Mott MacDonald Help desk to obtain a User Id and Password.

The Highways Agency must approve all Halogen users.

4.2 Starting the Halogen Browser

After Installation, the Halogen Browser application may be run by:

2. From the menu Start -> All Programs -> Mott MacDonald -> Halogen Browser -> Launch Halogen Browser

4.3 Halogen Browser - Window Basics

The Halogen Browser uses a standard menu driven Microsoft Windows^®style screen. All menus are accessible via point and click.

All Halogen Browser windows have standard Windows^® functionality. For example when a window is resized, all the window controls resize. When changes have been made, but not saved, an appropriate warning message is displayed if an attempt is made to close the window.

Other standard features, such as Tool tips and Help are available on the toolbar. To see Tool tips, position the mouse cursor over a toolbar icon for a brief period.

5 Using the Halogen Browser

This section describes how to use the Halogen Browser to the extent of its abilities and will go into some detail about the various functions.

5.1 Default Screen Layout

The main screen of the Halogen Browser application provides:

· Main menu

· Toolbar

· Status bar at the bottom

· Tabbed Windows

· Main map

The main menu provides access to a number of application functions and the choices in each menu will vary depending on which tab of the main window the user is currently viewing. The main menu is described in Section 5.3.

The tool bar provides shortcuts to various menu functions. For example, when using the Map based display, the toolbar will show icons for the zoom, pan and de-clutter tools. Tool bar functions are described in Section 5.5

The status bar is located the bottom of the Browser application screen. It will display a variety of status information, including the current username, a general information box for the display of error, help, or status messages and information regarding the 'Latest' and 'Update' times.

5.2 Changing the Screen Layout

The Browser is very versatile and the layout of the screen can be changed to suit the needs of the user.

· By double clicking on any one of the tabbed windows will cause the tabbed window to become the full size of the screen. Double clicking on it again will have the opposite affect and will reduce the tabbed window reduce down to its original size.

· Tabbed windows can be 'dragged and dropped' any where on the screen. By clicking and holding on the tab and dragging it over the screen will cause the tabbed window to be displayed wherever the user lets the mouse button go.

· Tabbed Windows can be closed by clicking on the on any of the tabs. The window can then be reopened by using the View Menu and selecting the window to reopen.

· If the user wishes to change back to the 'Default' layout then they have to select the icon on the top left hand side of the window.

Figure 1 Halogen Browser with different window layout.

Figure 1 Another Halogen Browser layout.

5.3 Main Menu Options

The main menu provides three permanently available menus: File, View, and Help.

File Menu

1. Load Event Data - This allows the user to Load Event Data that had been previously saved.

2. Save Event Data - This allows the user to Save Event Data onto the local hard drive of the computer.

3. Exit - This option closes the Halogen Browser.

To see more about the loading and saving options please refer to section 7.

View Menu

1. Show View - This allows the user to change the current view.

· Non-Located events - Shows events with no location information

· Legend - Shows the Legend View.

· Event Statistics - Shows the Events Statistics view

· Criteria - Shows the Criteria view

· Event Details - Shows the Event Details View.

· Logon - Shows the Logon View.

· Map View - Shows the Map View.

· Overview Map - Shows the Overview map View.

2. Roadside Faults Website - Shows the Roadside Fault website in the built in web browser.

3. Halogen Online Website - Shows the Halogen Website in the built in web browser.

4. Default Layout - This changes the layout of the screen back to the default layout.

5. Preferences - This brings up the Preferences dialogue. See section 8 for more details.

Help Menu

The Help menu provides an on-line help facility for the Halogen Browser. A user guide is available from the ‘Help’ menu of the viewer. This contains descriptions of the functionality available in the Browser. The help guide acts both as a tutorial and as the first point of reference for users in the event of any problems.

Version information is available from the ‘Help’ menu by choosing the ‘About’ option.

5.4 Tabbed Windows

The tabbed windows provides several different tabbed windows including: Map, Criteria, Event Details, Event Statistics, Non-Located, Legend, Overview Map, and Logon.

Logon

This screen allows the user to logon to the Halogen Browser to start executing queries and more.

To logon:

1. Enter user name and password.

2. Click 'Logon' button.

The status bar will show the progress of the log on. Once successfully logged on, the status bar will confirm the username that the browser has logged on as.

Criteria

This window allows the user to define the Query Criteria.

To see more on the Criteria Window please refer to section 6.

Event Statistics

This window shows the statistics of the events that are based around the current snapshot of the query performed.

Overview Map

The Overview Map element of the map-based display, main screen, provides users with a static top-level map view of the entire geographic region served by the underlying Halogen Browser data.

The Overview Map provides a summary of the map main map display. Automatically highlighting the region currently displayed on the main map it provides context to the user.

The functionality supported by the Overview Map includes:

· Highlighting the map region currently displayed by the Main Map element.

· Enabling users to quickly focus the Main Map element’s display on a specific area of the overall region served.

Moving the red bounding rectangle on the Overview Map will cause the Main Map to focus on the selected region, presenting a map displaying that region at the appropriate zoom level.

The Overview Map does not provide the functionality of the Main Map element, but rather, provides users with a simple means of quickly moving the focus of the Main Map element from one map area to another, without the need for multiple zoom and pan operations.

Event Details

This tabbed window provides details about the 'Current Event'.

The window contains two main sections:

1. Equipment Fault Detection: This contains details about the event and the device. The 'device info' part contains details about the device that is contained in the current event. The fault details specifies information about the current fault for the event.

2. Effective State: This section lists the uncleared faults. If the current event is a fault then the effective state will also display the last setting for the device if it exists.

Legend

This window gives details about the meanings of each type of icon that can be found on the map.

Icon	Meaning
	Time since last log was < 6hours ago
	Time since last log was between 6-12 hours ago
	Time since last log was between 12-24 hours ago
	Time since last log was > 24 hours ago
	Logging system is not connected and the last log is known
	Logging system is not connected and the last log is unknown
	Midas Device
	Midas Fault
	Telephone Device
	Telephone Fault
	Display Fault Events
	Display Logging System Status Events
	Show 'Off' events
	Show only recent events
	Display setting events
	Restore the layout to default
	Opens the Preferences window
	Load event data from a file
	Save event data to a file
	Signal setting
	Signal setting off
	Signal setting faulty
	Signal setting unknown
	VMS Device
	VMS Device Off
	Faulty VMS Device
	Other Device
	Other Device Fault

An example of what a the user may see on the screen, when zoom is at level 3, is shown below, the picture shows 3 signal settings and a VMS device settings.

Map

The Main Map provides users with a detailed view of a selected map region, presenting traffic and travel information in a graphical form, thereby facilitating its interrogation.

The Main Map presents dynamic icons representing the state of street furniture, car parks and active events superimposed on a map image which shows, geographical features, places of interest and road networks. Supporting facilities including zoom, pan and image declutter, the Main Map presents information at an appropriate level of detail for the currently chosen map scale.

Non-Located

To view information associated with any non-located events, the Non Located tab is available via the View menu (View->Show View->Non-Located events).

Devices listed in this window are indicative of devices that Halogen has no data of location. These items are not linked to the maintained source providing location information hence are deemed unlocated.

NB: If there are any anomalies to the position on screen of devices or located events, contact the Halogen help desk.

5.5 Toolbar

In addition to the main menu described in section 5.3, the map-based display makes available a toolbar that provides users with facilities for manipulating the main map, feature selection, view manipulation, and navigation controls. The Toolbar layout and typical icon use is illustrated below:

Toolbar buttons are only enabled when the corresponding function can be performed (for example, the Playback buttons are only available if the user has run a query that provides playback).

	Display Fault Events	This will cause the Equipment and Telephone Faults to be displayed on the map.
	Display Setting Events	This will cause Device Setting, Device Status, Message Sign setting, and Message Sign Status events to be displayed on the map.
	Display Logging System Status Events	This will cause Logging System Status events to be displayed on the map.
	Show 'Off' Events	This option is useful to 'de-clutter' the screen and will only display events that may be of interest. When the option is enabled, all events will be displayed. When disabled, events that have a setting that is considered to be 'OFF' will be hidden, but only if there are no active faults for the device.
	Show only Recent Events	This option is used to 'hide' events that may be older than what the user is currently looking for. The 'recent' time may be changed in the Preferences dialogue.
	Map Moves to Current Event	Selecting this option will enable the browser to locate the main map to the area where the most recent event matching the query criteria occurred.
No Icon (Appears under 'menu' on the toolbar)	Respect Status Events	This option is used to control whether or not status events will modify what is considered to be current setting of a device.
No Icon (Appears under 'menu' on the toolbar)	Show Faulty Settings	This option only has significance if a range query has been performed, and the user is using the playback facility. It allows the user to select whether or not the map will display a 'Faulty Setting' for a device. A Faulty Setting is defined as a setting event that occurs when the device still has uncleared faults active. For example, if the sequence of events on a device was 30 - Fault - 50, then the setting event for the '50' is considered a 'Faulty Setting Event'. If 'Show Fault Settings' is on, then as playback reaches the '50' event, the device icon will show 50. If the option is off, then the icon will display '30' and ignore the '50' setting.
	Zoom Out	This option will zoom the map out to the next zoom level.
	Zoom In	This option will zoom the map into the next zoom level.
	Zoom Level (1,2,3)	These allow the user to zoom in/out of the map. Level 1 shows the farthest level of zoom and level 3 shows the closest level of zoom.
	Menu	Clicking on this button will reveal more menu options.
	Minimize	This button will minimize the window.
	Maximize	This button maximizes the window to be the full size of the screen. this can also be done by double clicking on the window tab.
	Restore	This button is only enabled when the Maximize button or the Minimize button has been pressed. It restores the window back to its original size.

5.6 Status Bar

The status bar is located the bottom of the Browser application screen. It will display a variety of status information, including the current username, a timer, a general information box for the display of error, or help.

Once logged successfully, the status bar will show the current user name.

5.7 Tool Tips

All features that support selection also support tool-tips. Thus, the only features that do not support tool-tips are Map Features such as railways, waterways and built-up areas.

When a user’s mouse hovers over a selectable feature within the Main Map, a tool-tip is displayed stating the specific type of the feature in question.

6 Creating Queries

This section describes how to create and run different types of queries

6.1 The Criteria Tab

The Criteria Tab is used when the user wishes to run queries against the data.

Types of Search

This section of the Criteria tab, defines the area that the user wishes to obtain data for.

· Geographic Area - This search criteria only becomes available when a region on the map has been selected. To use this type of search, go to the map window, hold down the mouse button and drag the pointer of the region to obtain data for.

· CO - This search criteria allows the user to select from the drop down list what CO area or RCC to search in.

· Road Section - This search criteria allows the user to select the section of road that they wish to obtain the data for, either by Junction numbers or Marker Post numbers.

Note: The geographic area search will only return events where the equipment has a location. This is not true for CO and Road Section searches, which return events for equipment which is currently unlocated.

Types of Events

This section of the Criteria tab, defines the event type that the user wishes to obtain data for.

· Signal Settings - Include events from the device setting logs.

· Msg Sign Settings - Include events from message sign setting logs.

· Signal Status - Include events for signal status logs, only if device and message sign setting logs are included above.

· Msg Sign Status - Include events for message sign status logs

· Equipment Faults - Include events for Equipment fault logs.

· Telephone Faults - Include events for Telephone fault logs.

· Logging System Status - Include events for Logging System Status information. This option will only be available if the Query Type is 'Current - Snapshot' or 'Current - Auto Update'. There is no historical information for logging system status. The Logging System Status will be retrieved for all CO's and not just the one that was selected in the Search box.

Types of Time Period queries

There are three types of queries available:

· Historic - Snapshot : This query involves querying for events based on a specific moment in history

· Historic - Range: This indicates that you wish to query a set of events that were 'current' at a given historical date and time. The historical date and time should be supplied by the user.

· Current - Snapshot : A query to retrieve all events at the particular moment in time that the query is executed.

· Current - Auto Update: A variation on the 'Current - Snapshot' query, where the current events will be updated periodically in order to present a real-time view of events currently happening on the road network. Such events will also be updated at the refresh interval, determined via the View Options of the Preferences section of the browser.

6.2 Running a Query

Once all the criteria data (search type, event types, and time period) have all been entered click on the 'Start' button at the bottom of the of the Criteria window.

N.B. Before running a query the user must be logged on, if not then the following window will be displayed:

If the user has logged on successfully and now goes to run the query, then when the 'Start' button is pressed the status bar will show the progress of the query.

If an error has occurred, the user will be aware of this as an error box like the one above will appear detailing the problem. For example, the date entered into the query does not meet the required format:

6.3 Using playback

The playback functions will only be significant if a 'Range' query has been performed, otherwise the playback tools will not be available. Text will be displayed on the status bar (see below) showing the replay date and time. This value will update whenever the range is played, stepped, or moved to start/end. It will always reflect the current position of the playback cursor.

The available controls perform various functions as described below:

· Position at start of range - This button will position the playback cursor at the start of the range.

· Position at end of range - This button will position the playback cursor at the end of the range.

· Play (in forward/reverse direction) - When the animation is stopped, the user has the option to begin animation either in a forward/reverse direction. If one of the Play buttons is pressed, animation will be performed. While animation will continue until an extremity of the range is encountered, or until the 'Stop' button is pressed.

· Step (to the next/previous event) - The user may use these buttons to move the playback cursor to the next/previous event in the range data. The map will change to reflect the changing events. The Replay time will update to reflect the time of the 'current event'. The event details will be updated to reflect the details of the 'current event'.

· Step (to the next/previous) Device - The user may use these buttons to move the playback cursor to the next/previous event in the date range for the selected device. The map will change to reflect the changing events. The Replay time will update to reflect the time of the 'current event'. The Event Details will be updated to reflect the details of the 'current event'.

· Step (forwards/backwards) by one timeslot interval - The user may use these buttons to move the playback cursor to a time, which is one 'time slot' before/after the current cursor time. The 'time slot' amount is the value of the 'Real-time increment specified in the 'Play Options'. The new 'Latest time' displayed on the status bar will be changed by the increment value each time, as the browser steps through each timeslot interval. The Map will be updated to reflect the details of the newest 'current event'.

7 Loading and Saving Data

This section describes how to load and save data from the browser.

7.1 How to Save

If the user wishes to save the current events along with their current status, then:

1. Select 'File' -> 'Save Event Data' or click on the icon at the top right hand corner of the Halogen browser window.

2. A dialog will appear:

3. Select the location to save and name the file.

4. Click 'Save'.

7.2 How to Load

To load previously saved data about events:

1. Click 'File' -> 'Load Event Data' or click on the icon at the top right hand corner of the Halogen browser window.

2. A dialog will appear:

3. Select the location where the file was previously saved and click 'open'.

4. The data will now be available to look at from the Browser.

8 Preferences

This section describes how to change the preferences for the Halogen Browser.

It is recommended that the connection URL's are left unchanged. Changing these values may cause the Browser to become unstable.

If desired, the Halogen browser can retrieve any available maps which are more up-to-date than the one currently used. The browser will execute this function if the 'Check for map updates' tick box is enabled, however this can be a time-consuming process if done regularly, so it is recommended to only enable this function periodically and use the local version of the map under normal circumstances.

If you make a mistake in any of the preference settings, simply click 'Restore Defaults' and all the original settings will be restored.

NB: The preferences window is also available by clicking on the icon on the top right hand side of the Halogen Browser window.

8.1 Play Options

Changing the Play options will affect how events are played back in the Halogen Browser.

· Play Events/Play at Realtime Increment - Only one of these options may be selected. The option selected will identify how playback facility will behave when the 'Play Forward' or 'Play Reverse' button is pressed.

If 'Play Events' is selected, the animation will occur at a given rate of event change, e.g. 2 events per second. This means that playback will occur at this rate, regardless of the actual times when the events occurred.

If 'Play at Realtime Increment' is selected, the animation will occur at a given rate of realtime change, e.g. 2 minutes per second. This means that playback will occur at a rate relative to real time, regardless of how many events occurred within the time period.

· Tick Period - The value is tightly related to the above option. It specifies how often the playback facility will update the data on-screen, and is used to determine the effective rates of playback.

· Realtime Increment - This value is tightly related to the above two options. It is only significant if the 'Play at realtime increment' option is selected. It specifies what time interval to move, for every tick of the animation.

This value also has another use, it is used to control how much to advance the playback cursor when using the 'Step Time Slot' facility when a range query has been performed.

Examples

· To play at a rate of change equal to 2 events per 1 second of animation time.

Select the 'Play Events' option

Set the 'Tick Period' to 500mS

· To play at a rate of realtime change equivalent to 2 minutes of realtime per 1 second of animation time,

Select the 'Play at Realtime Increment' option

Set the 'Tick Period' to 1000mS

Set the 'Realtime Increment' to 2 minutes.

8.2 View Options

Changing the View Options will change how the browser will refresh.

To move the map to the current event during playback then ensure that the 'Move Map to Current Event' is ticked.

The 'Periodic refresh interval' defines how often the browser will be automatically refreshed from the server.

The 'Time Period value for recent logs' option will filter out older logs, based on the value entered, this can either be expressed days or hours depending on the 'Units' selected.