General Screen Usage

Most screens in the system typically contain several elements:

• Header, containing:
  • Menu.
  • Filter.
  • Button bar.
  • Home button.
  • Log Off button.
• Main results area.
• Detail panel.
• Footer.

Typically there are also several pop-up windows that are shown in certain circumstances.

You can go back to the home screen at any time using the Home button on the header.

You can log out of the system using the Log Out button on the header.

The button bar on the header typically includes one or all of the following buttons:

• Query - See Queries below.
• Refresh - See Results Tables below.
• Settings - This displays a pop-up Preferences window. Here, you can choose any roles that have been assigned to you (which can change the function of some screens) or choose the look and feel of the system with the Theme drop-down list.
• Widget - See Widgets below.
• Export to Excel - See Results Tables below.
• Export to CSV - See Results Tables below.
• Add to Favourites - See Menu below.
• Column Selector - See Results Tables below.

The footer shows the version of the system - you can use this when reporting any problems.

Widgets

Warning: In Progress.

Menu

The menu is accessibly by clicking the Menu button in the top left of the screen. This will display the menu. You can close the menu by clicking off the menu, or clicking the Close button.

The menu shows all the screens that you as a user of the system have been configured to use.

The screens are categorised, so you can click on a category and see the screens (or sub-categories) that belong to that category. If you click again, the category will close.

You can search for a specific screen using the search box provided at the top of the screen.

You can open a screen in a new tab in your browser (if your browser supports tabs) by clicking the Call-Out button next to the screen.

If you have identified screens as a favourite by using the Favourite button in the header, the menu will list these screens under a Favourite category in the menu.

Queries

Most screens allow searching of the data by defining the criteria of the search - a query.

You can click the Query button in the header to show the query pop-up. Note: In some screens, this is a pop-out panel on the left of the screen.

Depending on the screen, the filters will be displayed. In most cases, this is a list of all the data items you can find by. In some screens, you can choose the individual criteria one by one from a list.

When you have entered your query criteria, you can run the query using the Submit button.

You can clear the criteria entered by clicking the Clear button. This will display the Results Table, as seen below.

The pop-up can be closed with the Close button.

Results Tables

When queries are run (typically when the screen is first opened), the screen displays the results in a table. The screen will generally display the total records found in the footer.

You can sort the results table by clicking on a column header. If you click again, the sort will be reversed. You can sort on multiple columns by holding the control key when clicking - the screen will sort the data in the order that you click.

You can filter the data shown by entering into the filter columns provided by the screen. The screen provides a general filter on the header, and specific column filters under each column header. The filter is immediate - as you type, the results will be filtered. If you enter text in multiple columns, the screen will filter the data by all the entered filters.

You can change the order of columns by dragging the column header to a new position in the results table.

You can change the displayed columns in the results table using the Column Selector button in the button bar.

You can move from the first to last record (and vice versa) quickly using the First and Last buttons on the footer.

You can see the details of the record in the results table by clicking the row - typically, the screen will display the details in a pop-out panel from the right of the screen. See Details Panel below.

You can refresh the data shown in the results table by clicking the Refresh button in the button bar in the header. The screen will re-run the query and re-display the results.

Details Panel

The screen will display the Details panel from the right of the screen whenever you select a record from the results table.

You can also choose to display the panel by dragging the panel open using the handle on the right of the screen.

You can close the Details panel by dragging it closed or clicking the arrow on the top of the panel separator.

By default, the screen displays the Details panel as part of the main display window. When it displays, it reduces the amount of screen available for the results table, and the screen may display a scroll-bar in the results table so you can still see all data. You can change this by clicking the Pin icon in the separator bar. This changes the detail panel so that it floats over the results table - in this mode, you will need to hide the panel to see the full results table.

The options available on the details panel typically differ from screen to screen - see your specific screen documentation for details. However, you will normally find some or all of the following:

• New - create a new record.
• Save - save a new record or changes to an existing record.
• Delete - delete an existing record.
• Help - help on this screen.
• Undo - undo change made since last save.
• Clear - clear all fields.
• Toggle - toggle display of all accordion headers.

Typically, the details panel displays a lot of data organised into sections - by default, all sections are displayed and you can scroll up or down to see all the details. You can collapse or show these sections by clicking in the header. You can collapse or show all sections by clicking the Toggle button on the detail panel tool bar.

You can scroll up and down the Details panel to see all the data. Moving down the list of results will also display a floating Back to Top button in the bottom right of the panel.

When the screen supports it, you can use this panel to enter new records or amend existing records.

You can clear entered data or reset data to its original form.

You can save changes if allowed by using the Save button. Note: When you save changes, generally any filters you have applied to the results table will be undone.

Notifications

Whenever you take actions in a screen, you will be notified of the success or failure of your actions through a notification message. These appear at the top of the screen.

Informational messages are coloured green and will disappear after a few seconds.

Error messages are red and will stay on the screen until you clear them.

Regardless of the type of pop-up message, you can clear them from the screen by clicking the Close button on the right-hand side of the message.