Chapter 5 User Interface

The User Interface (UI) consists of several main regions:

Navigation Menu
Top Menu Bar
User Links Bar
View Area

The visibility of some elements of the User Interface, such as menu items and other features, depend on a user’s roles and privileges (see the User Management System documentation). The User Interface also has response design elements, which means the layout will appear differently based on screen-size and screen type (mobile vs. desktop).

Image of the CWD Data Warehouse user interface.

5.1 Navigation Menu

The Navigation Menu is the primary means by which the user can find their way through the Warehouse. The overall structure of the Warehouse is reflected in the Navigation Menu, allowing users to interact with and manage their Data, Models, and Visualizations. The Navigation Menu consists of several sections including Explore, Data, Models, Administrative, and Documentation.

The Navigation Menu can be shown or hidden by clicking the menu icon (circle with three horizontal lines, otherwise known as a “hamburger” button, located to the left on the top menu bar).

5.1.1 Navigation Menu Sections

5.1.1.1 Explore

Overview At the top of the Explore section is the Overview link. The Overview provides a series of tables summarizing a Provider’s Data Collections and use of the Warehouse. It includes the following tables:

Provider details
User - Counts by role
Sample - Counts by Season year
Sample - Counts by Geolocation precision category
Processors - Counts by type
Cervid facilities - Counts by type
Demography - Counts by metric
Agency expense - Counts by Season year
Annual Surveillance - Counts by Season year
Test alignment - Counts by status
Model execution - Counts by model type
Visualizations - Counts by type
Audit log - Counts by Collection and event type
General - Counts by Collection
Sample - Counts by Season year and Sub-administrative area
Test results - Counts by Sub-administrative area, Season year, and Result
Cervid facility - Counts by Sub-administrative area and Current status
Processor - Counts by Sub-administrative area, Business type, and Current status
Demography - Presence by Season year and Metric
General - Overall summary

Visualizations The Visualizations section provides links to Visualizations accessible to the user. The names and order of Visualizations are set by a Provider Administrator.

Note that Provider Administrators control the visibility of Visualizations to Provider Users. A lock symbol will be present next to Visualizations that only Provider Administrators can see. The name, order, and lock state of visualizations can be set within the setup of each Visualization.

5.1.1.2 Data

The Data section lists each Data Collection available to the Provider in the Warehouse. Data Collections include Sample, Cervid facility, Processor, Demography, Agency expense, and Annual surveillance. See Introducing Data Collections for more information about each Data Collection.

Each Data section link provides a list view of items in the given Data Collection. Selecting an item in the list will open a dialog with all the details of that Data Collection item (such as a sample record or a cervid facility record). The user can edit a Data Collection item through this interface if they have the necessary privileges.

5.1.1.3 Models

The Models section contains links to run new models and access previously run models.

Run a new model - a page containing descriptions of Models in the Warehouse with links for running each model.
Previously executed models - a list of all previously executed models. Selection of a listed item allows the user to view and edit parameters for the model execution.

5.1.1.4 Administrative

The Administrative section is visible only to Provider Administrators and System Administrators and contains functionality that only Provider Administrators and System Administrators can use. It includes the following links:

Visualization – a view for managing previously created visualizations and for creating new visualizations
Test alignment – a view of the Test Alignment Data Collection, which includes imported test data to be associated with Samples
Audit log – a list of all activities that are tracked in the Warehouse, such as the creation, updating, or deletion of Data Collection records
Import log – a list of all Sample Collection bulk data import processes executed

5.1.1.5 Documentation

The Documentation section provides detailed technical documentation about the Warehouse, including a link to the CWD Data Warehouse User Manual (this document) and documentation of the API.

5.2 Top Menu Bar

The Top Menu Bar provides text indicating the current page or view which the User is seeing in the View Area. The Top Menu Bar also includes links relevant to the current View.

5.2.1 Top Menu Links

The Top Menu Links, shown as a series of circular icons, provide functions specific to the current View.

5.2.1.1 Show more columns

The Show more columns checkbox will modify the current list view to show additional fields that may be useful. The additional fields shown vary by Data Collection.

5.2.1.2 Filter controls

The filter button (a magnifying glass) shows the filters available for the current list. A Show more button may be present at the bottom of the filter control list. Note that all “free text” or “text string” searches use the “contains” criteria and are case-sensitive. For example, if searching within the Sample Data Collection for a record with a Sample ID of “TE31053”, the record will appear using the search phrase is “E31”, because that string is contained within the Sample ID string. However, the record will not appear in the list if “e31” is entered.

5.2.1.3 Reset filters

If a filter is applied to the list, an additional Top Menu link icon (a circle of two arrows) is shown to that removes all filters.

5.2.1.4 Download

The Download link (an arrow pointing down) exports and downloads a “flat” comma-separated value (CSV) file of the Data Collection displayed. This function is available only for Sample, Cervid facility, Processor, and Demography Data Collections. Any filters applied to the view will also be applied to the download. See the Data Download section for more information.

5.2.1.5 Create

The Create link (a plus sign) brings up a dialog with a blank form for a new Collection item (e.g., a new Sample) that can be used to create new data. The Create link is available only to users with appropriate permissions.

5.3 The User Links Bar

The User Links are shown at the top of the Navigation Menu and are dependent on a user’s roles and permissions. Two links shown to all users are:

Logout logs user out of the CWD Data Warehouse
User profile links to the current user’s profile, allowing them to update their personal details and password

Provider Administrators will see two additional links:

Provider administration links to configuration options for Data Collections and underlying data processes (e.g., adding custom properties to the Sample Collection or defining Agency Programs for the Processor Collection) (see the Data Collections documentation topics for details)
Users link to an interface for creating, updating, and managing users (see the User Management documentation)

5.4 View Area

The View Area refers to the main body of the page and shows the selected menu item or content. See the relevant documentation sections for more information.