High Level Flow Diagrams

Login and Navigation

Game Selector

Data Replay

The sports tab runs horizontally across the dashboard and displays one tab for each sport that is enabled. The tabs are dynamic and configured through the MySql database Sports table.

The order the sports tabs are displayed in is defined by their id value in the Sports table.

There is no limit on the number of sports tabs that can be created. If the tabs reach the horizontal limit of the application then they will stack in to multiple rows. Realistically there should never be so many sports enabled at any one time to cause the tabs to be stacked.

Clicking on any unselected tab will:

1. Update the Leagues Tabs to show only the leagues associated with the selected sport.

2. Change the calendar display to show only events for the selected sport and league.

By default, when a new sports tab is selected the league will default to the first one in the list.

Captions

Actions

The dashboard is the main screen and is opened from the Home Page as soon as the user is logged in.

The components of the dashboard are:

The home page will be the first page to load and from where the user will be able to login or create an account.

Inputs

Actions

Validation

Assets

Captions

Inputs

Actions

Validation

The dashboard header is shown at the top of the screen and is non-scrollable. That is to say that if the application is run on a small display such that the user has to scroll up and down to see all of the dashboard, the header is always 'pinned' at the top of the screen.

Captions

Actions

Assets

The Game Selector is opened by clicking on the day cell of any calendar. The Game Selector is the engine behind all of the game incidents that are created and then posted to BOS.

The Game Selector is both used for creating new games/matches and then moving each game through the following standard incident workflow of create -> in_progress -> result -> finished.

The selector can also be used to Cancel or Delete games.

Header

The game selector header displays the following information:

Captions

Actions

Add Game

To add new game use the input fields at the bottom of the screen and then click on the ADD button.

Captions

Inputs

Actions

Validation

Each new game will have its status set to Not Started

Start Game

To start a game click on the Start button next to the game. The game status will then change to In Progress

Actions

Finish Game

To finish a game enter the score for both home and away teams and click on the Finish button next to the game. The game status will then change to Finished

Inputs

Actions

Cancel Game

Any game can be cancelled as long as it's either Not Started or In Progress.

To cancel a game click on the Cancel text next to the game.

A confirmation message will be shown.

Click on Yes to cancel the game (game status will then change to Canceled) or No to to return without canceling.

A canceled incident will be sent to BOS.

Delete Game

A game can only be deleted if it hasn't been started (has a status of Not Started).

To delete a game click on the Delete text next to the game.

A confirmation message will be shown.

Click on Yes to delete the game (game will be removed) or No to to return without deleting.

If a game is deleted than a canceled incident must also be sent to BOS so that BOS can tag the game in the same way as a canceled game.

Selector Grid

The selector grid is where all games are recorded as they get entered and moved through the workflow.

The selector grid is made up as follows:

The calendar component is the main 'engine' of the application. It's here that the user will navigate through, enter and select new games.

The calendar will dynamically create a month plan for each month selected using the forward (>) and backward (<) selectors. There will be no upper or lower limits for the first release.

Every time the calendar changes from December -> January or January <- December the year will change accordingly.

The numbers of days will be adjusted for each month and take into account leap years.

Weekdays will be displayed as Sunday -> Saturday.

The current day should be a different colour and larger than the other days.

Moving the cursor over any day cell will highlight it.

League Crest

If a day has at least one game scheduled then the crest for the league associated with the current calendar will be shown in that day cell.

Game Counter

If a day has at least one game scheduled then a badge for the total number of games will be shown in that day cell.

Captions

Actions

The account menu is accessed by clicking on the user icon at the far right of the header.

The account menu has two features.

Change Password

Click on the Change Password menu item to open the Change Password screen

Log Out

Click on the Log Out menu item to log out of the application and return to the Home Page.

The replay screen is displayed by clicking on the REPLAY button on the Dashboard header.

The purpose of the Replay feature is to give the user a manual way to send, or re-send, game create incidents to all of the BOS endpoints if for any reason they weren't correctly sent before.

Normally this feature shouldn't need to be used very often as a create incident is automatically sent every time a game is created. But there could be occasions when the application correctly records a game as being created but the information isn't recorded by the BOS nodes. If that happened then running a Replay will 'flush' all the games between the start and end dates and send create incidents to the BOS nodes a second time.

Sports and leagues can be selected individually using check-boxes, or all sports and leagues can be selected or de-selected using the Select All checkbox/toggle.

The range of data to be replayed will be set from the Start and End fields.

Captions

Inputs

Actions

Validation

The notifications panel is displayed on the right side of the dashboard and is where all notifications (reminders) will be posted for all games about to start or finish.

The notifications will be refreshed at a configurable millisecond interval set in the notifications->delay property in config-dataproxy.json. The default will be 3,000 (3 seconds).

Each notification will take the form of a 'note' which will have the following information:

Colours

The colour of the notes is very important and must be visibly obvious. The colour of the note is set by the following criteria:

Green

• Any game that is in the range 30 - 15 minutes to it's scheduled start time.

• Any game that is in the range 30 - 15 minutes from it's predicted end time.

Amber

• Any game that is in the range 1 - 14 minutes to it's scheduled start time.

• Any game that is in the range 1 - 14 minutes from it's predicted end time.

Red

• Any game that should have started according to its scheduled start time.

• Any game that is in the range 30 - 15 minutes to it's predicted end time.

Start and End Times

The notifications rely on the start and end times of each game. The start time is taken as the time entered for any game when it was created, this is the only value that can be used.

The end time is more complicated because for many sports it's very hard to predict when a game ends because of time-outs, extra-time etc. For example, a game of soccer is much more predictable because the clock doesn't stop during play. So a game is likely to be two halves of 45 minutes, 15 minutes of half-time and perhaps 5 minutes of extra time, so 45+45+15+5 = 110 minutes.

However, a game of football, even thought it's four quarters of 15 minutes, has time-outs and regular clock stops, so the time the game will finish is a very broad average.

The duration of any sport is set in the duration column of the sport table. The default values are based on the accepted average durations for these sports.

Note Attributes

Removing Notes

Each note is tied to a game and as such will be automatically removed from the notification panel as soon as the status of the game is updated. For example, if a note states that game x "SHOULD HAVE STARTED", then as soon as the game is started from the game selector, the note will be removed.

To keep things tidy notes can be set to be be automatically removed after a set interval (in hours). This means that if games haven't been started, instead of the warning note appearing even after [x] days when there would be no point updating the status of the game, it will be removed.

The number of hours after which a notes should be removed is set in the notifications->end property in config-dataproxy.json. The default value is 240 (10 days).

Hyperlinking

Each note is 'clickable', and when any note is clicked on it will automatically open the game selector for the selected date / league / sport combination. The game in the selector, that corresponds to the game on the selected note, will be highlighted for easy identification. For more information see:

The leagues tab runs vertically down the left side of the dashboard and displays one tab for each league that is configured for the selected sport. The tabs are dynamic and configured through the MySql database Leagues table.

The order the leagues tabs are displayed in is defined by their id value in the Leagues table.

There is no limit on the number of sports tabs that can be created. If the tabs reach the vertical limit of the application then they will stack in to multiple columns. Realistically there should never be so many leagues enabled at any one time to cause the tabs to be stacked.

Clicking on any unselected tab will change the calendar display to show only events for the selected sport and league.

Captions

Actions

The Change Password screen is opened by clicking on the Change Password menu item in the account menu.

Captions

Inputs

Actions

Validation