---
title: "v2.3.3 User Guide"
canonical: "https://servicedesk.maxgeo.com/space/DS/1253966050/v2.3.3%20User%20Guide"
format: markdown
---
TABLE OF CONTENTS
> Macro (toc)
# > Macro (anchor)
Introduction
> Macro (anchor)
DataShed5 is a browser-based application that allows users to view and visualise data stored within the Maxwell Data Schema. Users can view data stored in various database objects, apply advanced filtering rules, and then download the results in various formats. DataShed5 also provides access to various summary and detail reports and allows data to be displayed on an interactive map.
The DataShed5 interface has been designed to be as intuitive as possible, and most users should need none, or very little, instruction in order to use the basic functions. However, more advanced functions or features may not be as obvious.
The ‘Quick Start’ section of this document describes a few fundamentals that will enable user to quickly get started and discover for themselves the basics of using DataShed5. The rest of the manual describes in detail how to use all of the functions available within the application.
# > Macro (anchor)
System Requirements
DataShed5 imposes very few requirements on the user device that will be used to access it. Fundamentally, DataShed5 only requires a modern web browser. The current supported browsers and minimum supported versions are:
- Mozilla Firefox v47.0.1
- Google Chrome v51
- Microsoft Edge 44.18362.449.0
Maxwell GeoServices recommends that users keep their browsers upgraded to the latest version. Other browsers not listed here might also be used to access DataShed5 but compatibility is not guaranteed.
DataShed5 allows users to download data and reports in multiple formats. The end-user device must have appropriate software installed in order to open those files. In particular, applications may be required to open Microsoft Excel spreadsheets, Microsoft Access databases, and Portable Document Format (PDF) files.
It is highly recommended that the user install the latest Service Packs, application updates and security updates to ensure the best compatibility and security.
# > Macro (anchor)
Quick Start Guide
You can get started quickly with DataShed5 by following these steps:
- Register as a DataShed5 User
- Open your web browser, navigate to the DataShed5 URL.
- Click the ‘Register Here’ link and enter your details.
- Wait for an administrator to approve your request.
- Log in to DataShed5 with your email address and password.
- Click ‘DataSet Manager’ and select one or more datasets. Click ‘Activate’ to activate the selection. You can modify your active dataset selection at any time.
- The data in the database can now be viewed and downloaded.
- Data: Click ‘View Data’, click on the arrow next to one of the modules in the ‘Module Select’ list, click on one of the tables. Click on a column name to sort by that name, drag a column name upwards to group data by that column. Enter data at the top of a column to filter for that value.
- Maps: Click ‘View Map’ and choose one of the maps. Zoom/pan the map, click on map points for info about that point, etc.
- Dashboards: Click ‘Dashboard’, then select one of the available dashboard options. Enter appropriate parameters to see data in the dashboard charts.
- Reports: Click ‘Reports’, select a report to run. Enter appropriate parameters and click ‘Submit’ to run the report. Use the ‘>’ and ‘<’ buttons to go to the next/previous page, etc.
- Download: Click ‘Download Data’, select the type of data that you want to download (Table – single table, Layout – pre-defined layout, Scheme – multiple layouts) and the file format (if appropriate), and the data source. A ‘Download’ button will appear, click this to begin the data extract/download.
- Create Filters
- Create a filter by clicking ‘Cascade Filters’, then click the ‘+’ button next to one of the categories. Choose a column name, a criteria and a value, then click ‘Add Criteria’ to add the filter rule to the filter. Multiple rules can be added for more complex filtering. Click the ‘Activate Filter’ button to immediately activate the filter.
- Active filters are shown with green text. Click the
filter symbol to change the filter status from inactive to active.
- If viewing a map, click the
button to create a map filter. Select one or more points by dragging the mouse to draw a rectangle, items within the rectangle are included in the map filter. Click the
button to clear the map filter.
- Active filters will limit items displayed when viewing data, or points visible on the map.
- Click ‘Hello username’ ‘Log Off’ to log off of DataShed5 when you are finished.
Most buttons and links have tooltips – moving the mouse over the top of a button or link and leaving it there for a few seconds will often show a small pop-up containing text that briefly describes the action that the button or link will perform.
# > Macro (anchor)
Login Screen
After navigating to the DataShed5 main page, the DataShed5 login screen will be displayed. Enter an email address and password to login to DataShed5. New users can click ‘Register Here’ to request a login and access to a database, and existing users can click ‘Forgot your password’
After entering a valid email address and password, most users will be presented with the DataShed5 main screen, giving access to the database for which they are registered.
If the user has been granted access to multiple databases, after logging in they will be presented with a list of databases and asked to select which one they wish to access. The user must choose a database from the list and click ‘Connect’.
Users may only access a single database during a DataShed5 session, in order to access data from other databases the user must log off and log on again.
## > Macro (anchor)
Forgotten Passwords
Users that forget their password can request assistance by clicking the ‘Forgot your password?’ link on the login page.
Users can enter their email address and click ‘Submit’, the DataShed5 system will then send an email to that address that includes a link that will allow the user to reset the password. This link must be activated within 20 minutes of the request. If the link is never clicked, the password will remain unchanged. This prevents passwords from being changed by someone other than the correct user. Reset password link requires no email to be entered and only password details.
## > Macro (anchor)
New User Registration
Users without a DataShed5 account can click the ‘Register Here’ link on the login page, they will be directed to the ‘Create a new account’ page as shown below. Here the user can enter their email address, DataShed user name, enter the authorisation person details and enter a password. The authorisation person will be sent an authorisation letter from the DataShed5 Administrator. The authorization letter has to be completed and signed by the authorisation person and sent to the DataShed5 administrator before approval and access to the DataShed5 system can be granted.
For most users, the DataShed5 username is the part of the email address before the ‘@’, but this is not a requirement. If unsure, contact the DataShed5 administrator.
After clicking ‘Register’, the DataShed5 administrator will be notified that the user has submitted a registration request. The DataShed5 administrator will approval access upon receiving the signed authorisation letter, and grant access to appropriate portions of the database, before the user can begin to use DataShed5.
Once the administrator has performed the necessary approval steps, the user will be sent an email notifying them that their access has been approved. The user may then log in to DataShed5 and view the information.
Activity option is available when Assay Management module is assigned to the user.
# > Macro (anchor)
Main Screen
The main screen is displayed after user login, displaying the function menu on the left side of the screen, and the user startup option in the right. In the example shown above, the startup option of “Data View” is shown, but users can choose to start with a map or a dashboard. Selecting the **Hello user **menu option** **at the top left and selecting the **User Settings **option** **allows you to change your startup view.
At the top of the menu, the ‘DataShed5’ logo is shown, this may be replaced with your own company logo. Clicking this logo will return the user to their chosen startup screen.
On the right-side near the logo is a left-pointing arrow. Selecting this arrow shrinks the left-side menu to a minimalist display, with just the representational icons shown. This view allows more of the display area to be used to show maps/data/etc. Clicking the right-pointing arrow will restore the original menu display format.
In the normal view, menu items that have a ‘>’ displayed will display a sub-menu when the item is clicked. Clicking the item again will hide the sub-menu. This behavior also occurs in the condensed view, but the ‘>’ is not shown.
# > Macro (anchor)
User Menu
Just below the DataShed5 logo (or your company logo) is the **User Menu**. The User Menu allows the user to change their default settings, change their password, or log off, among other things.
The User Menu is labelled ‘Hello username’, where ‘username’ is the DataShed username of the currently logged-in user (the username is pixelated in the image below).
Clicking the User Menu item will display the user menu options. Clicking one of those options will activate the requested function.
## > Macro (anchor)
User Settings
The **User Settings** option will show the settings for the current user, including the Default View, Display Last viewed Table, Email Active, and the Browser Language. Of these options, only the Default View and the Display Last Viewed Table can be directly changed by the user in this window. The ‘Email Active’ option can be changed by a DataShed5 administrator, contact your administrator if you need this option changed. The Browser Language is set in the browser settings, not in the DataShed5 user settings.
The Default View is the view with which the user is presented after they log in to DataShed5 (or click the logo at the top of the menu). The available options are ‘Dashboard’, ‘Data View, and ‘Map’. When ‘Dashboard’ or ‘Map’ are selected, the user is presented with a list of dashboards or maps that are available to the current user, and the user may choose which one these will be presented to them when they log in to DataShed5.If any changes are made to the default view selection, click ‘Save’ to save the changes and close the window. On saving User Setting, the confirmation message updated to “User settings saved successfully.” Click ‘Close’ to close the window without saving the update. Pressing the ‘Escape’ key or clicking the ‘X’ in the top-right corner will also close the window without saving.
## > Macro (anchor)
User Guide
## The User Guide option will open a PDF copy of the DataShed5 User Guide in a PDF viewer window. The blue View User Guide PDF option in the top left corner of the window will open a full size PDF viewer window. The options to print and download the guide are available.
## Disable All Filters
DataShed5 allows users to create a number of filters, based on a combination of simple or complex criteria, spatial point selection, and DataSet selection. When viewing data directly, users can filter the data further with ad-hoc filtering within the data view.
The Disable All Filters will turn off all filtering criteria (except the DataSet selection) and make all data visible in the data view.
## > Macro (anchor)
Change Password
The Change Password option allows the user to modify their DataShed5 password. The user must correctly enter their current password, and the new password (twice). Click ‘Save’ to save the password changes and close the Change Password window, or click ‘Close’ (or press the Escape key) to close the window without updating the password.
User passwords must contain at least one upper case letter, one lower case letter, and one numeric digit. When you click ‘Save’, DataShed5 will show an error message if the current password is incorrect, if the updated password does not meet the password requirements, or if the new password and the confirmation do not match.
## > Macro (anchor)
About
The About option shows a window with some version and licensing information about the current installation of DataShed5. You may be asked for some of this information if you need to contact maxgeo to request support for DataShed5.
No changes can be made within this window. Press the escape key, or click the ‘X’ at the top-right, to close the window.
## > Macro (anchor)
Log Off
This option will log out the current user from DataShed5. The browser session will no longer be able to access any DataShed5 data until the user logs in again.
# > Macro (anchor)
DataSet Manager
DataShed5 allows users to view/visualize data in a DataShed / Maxwell Data Schema database. Within such a database, data is typically divided into a number of datasets, and data is assigned as a member of one of these datasets. The DataSet Manager allows the user to select one or more of the datasets that have been assigned to them as ‘active’ in the DataShed5 session.
To activate one or more datasets, click the ‘DataSet Manager’. The DataSet Manager window appears, with a list of datasets that are available to the current user. These datasets may be structured in simple list, or they could be organised in a hierarchy of Projects, each of which contains datasets and/or other Projects.
Datasets that are set to not current will be displayed at the bottom of the list and be italic dimmed font. In the example below we can see the *MXACS* dataset is not active.
Select/de-select datasets by clicking the check boxes on the left side of the list. Click ‘Activate DataSets’ to activate the selected datasets. Any currently open items (maps, tables, reports) must be refreshed to incorporate data from the new dataset selection.
A selection name can be entered in ‘Save Selection As:’ and clicking ‘Save’ will save this selection as a named set. Previously saved named sets are shown at the top of the DataSet Manager where it says ‘Saved DataSets’, clicking the down-arrow could be necessary to show the complete list. Buttons next to each listed selection allow the saved sets to be loaded, or to delete the saved selection. Deleting the set does not delete the actual datasets, only the saved group.
Clicking ‘Close’ will close the window with no changes to the currently active datasets.
DataShed5 will remember the active dataset selection across login sessions. Each time after logging into DataShed5, it will automatically activate the same group of datasets that was in use at the end of the previous session.
# > Macro (anchor)
Cascade Filters
## > Macro (anchor)
Cascade Filter Concepts
DataShed5 allows users to create Cascade Filters to limit the data returned in DataShed5 by excluding any data that does not fit the criteria defined in the filter. Filters can be saved with a user-defined filter name, and activated and deactivated as required. The filter builder has ‘basic’ and ‘advanced’ modes, allowing for very complex filters to be defined.
Activating a filter will affect the data displayed by DataShed5 in the Map displays, tables and views in ‘View Data’, downloads, and reports. Filters work in conjunction with the currently active DataSet Selection, as defined in the DataSet Manager.
Shared filters can be create by a user that is assigned the SysAdmin Security level. Shared filters can be activated and deactivated by all users. Shared Filters can only be edited and deleted by the SysAdmin.
When displaying a table or view in the View Data, a cascade filter will be applied to the table/view only if the table/view name begins with the defined cascade filter table prefix( For example, if the table is tblDHAlteration, the Downhole cascade filter has “tblDH” as a table prefix ) and the table/view includes the defined cascade filter primary key fields ( For example, if a table has been defined as a DownHole cascade filter, Dataset and Hole_Id fields have to exist in table).
If the table/view includes the defined cascade filter primary key fields. For example, if a table has been defined as a DownHole cascade filter, Dataset and Hole_Id fields have to exist in table.
## > Macro (anchor)
Create Filters
Selecting the Cascade Filters menu shows a selection of filter categories, from which new filters can be added. Clicking the ‘[+]’ button next to a filter category opens the filter editor, which allows the definition of the criteria for the filter.
The example below is based on the ‘DownHole’ category, filters based on other categories will have different column names available for filtering, but the method of building filters is the same.
To add a filter criteria, first select a column name, then choose a comparison method and select or enter a criteria value. In the example, the column ‘Max_Depth’ has been selected, the comparison method ‘greater than or equal to’, and the value is 100. When this filter is applied, it will limit the selection to only those holes that have a Max_Depth value of 100m or more.
Other comparison methods are available, including ‘equals’, ‘not equals’, ‘between’, ‘is null’, and more. Some of these require two criteria values instead of one (e.g. ‘between’) and some require none (e.g. ‘is null’). Entry fields for criteria values will appear as required. For some comparison methods, a list of currently available values is presented for selection.
After selecting the filter column, comparison method and relevant criteria values, click the ‘Add Criteria’ button to add the filter criteria to the filter definition. A description of the filter criteria appears in the ‘Basic SQL’ window.
When displaying library table lists in the dropdown, the items can be distinguish between an in-active and active status. In-active items will be sorted to the bottom of the list and displayed using italic light grey font style.
Additional criteria can be added to the filter definition by repeating the process of selecting a column, choosing a comparison operator and entering the values as required, then clicking the ‘Add Criteria OR’ or ‘Add Criteria AND’ button. This adds the additional criteria to the filter with an ‘AND’ or an ‘OR’ operator. Choosing ‘AND’ means that both criteria must be satisfied for records to be included in the result, choosing ‘OR’ means the data matching either criteria will be included in the result.
Criteria can be removed by clicking the ‘X’ at the right side of criteria entry.
The image below shows a filter with multiple criteria conditions added to the filter definition.
Beware that adding multiple conditions with a combination of AND and OR may not behave the way that you expect. The AND connections will be processed before the OR connections.
Consider a filter with the following conditions:
[Max_Depth] IS GREATER THAN OR EQUAL TO 100
AND [Hole_Type] EQUALS ‘DD’
OR [Hole_Type] EQUALS ‘DD_W’
The AND operation has a higher priority than OR, so is done first. This means that the filter will find type ‘DD’ holes that have a depth over 100m, and it will also include ‘DD_W’ holes *regardless of the depth*. The ‘AND’ will link the hole type ‘DD’ to the 100m+ holes, and this combined criteria is OR’d with the remaining criteria.
To have the filter find holes that are over 100m deep for both hole types ‘DD’ and ‘DD_W’, you need to use the Advanced Filtering function to edit the filter manually.
## > Macro (anchor)
Basic / Advanced Filtering
The ‘Basic SQL’ and ‘Advanced SQL’ buttons at the top right of the window will switch the criteria view between a simplified description of the criteria, and the ‘raw’ SQL text that will be applied to the database. Users with good understanding of SQL query syntax can edit the filter text directly in the Advanced View.
Using the example given above, creating a filter to find holes that are over 100m deep for both hole types ‘DD’ and ‘DD_W’, the filter will be created with the criteria described above. After hitting the ‘Advanced SQL’ button the criteria is re-written in the compact form below:
The filter can be modified to provide the correct behavior by adding brackets – add a ‘(’ after the word ‘AND’, and a ‘)’ at the end of the statement. The brackets force the two hole type criteria to be grouped together before the depth restriction is added to the filter.
(tblDHColl.[Max_Depth] >= ‘100’) AND **(** (tblDHColl.[Hole_Type] = ‘DD’) OR tblDHColl.[Hole_Type] = ‘DD_W’) **)**
Note that editing the filter criteria in the Advanced SQL view will mean that the filter criteria can no longer be modified using the Basic method.
## > Macro (anchor)
Shared Filters
A filter can be created as a ‘Shared Filter’ by a user that has “Sys Admin” or “User Plus” security level. The option to create a Shared Filter will be available to these users as below.
Selecting the ‘Shared Filter’ check box and activating the filter will be available to all users. Users that have a security level of “User” have the ability to activate and deactivate shared filters. A shared filter will be created with a name starting with the # character.
## > Macro (anchor)
Activating / Deactivating Filters
All filters defined for the current user are shown in the Cascade Filters menu. Each filter is listed underneath the table for which it was originally created, showing the name of the filter or ‘unnamed filter’ or ‘map filter’ as appropriate.
Filters are shown with green text when active. Clicking the enable/Disable filter icon will activate the filter, or de-activate the filter. Note that activating a filter will also de-activate any other currently active filters.
## > Macro (anchor)
Editing / Deleting Filters
The filter list will display with edit and delete options along side each filter. A user can edit a filter by selecing the Edit option.
A user can delete a filter by selecting the delete option. A confirmation prompt will display to confirm the deletion of the filter.
**Find and Replace**
## > Macro (anchor)
Copy Filters
The filter list will display with copy option on each filter to copy existing filter, with the exception of Unnamed filters.
## > Macro (anchor)
Map Filters
Map filters can be created when any map is open (see ‘View Map’ section). Map filters are created by clicking the ‘Select multiple points by rectangle’
button on the map, then using the mouse click/drag to select a region. All active objects within the selected region are included in the new map filter. Note that object types that have been de-selected in the map layers selector are NOT included in the map filter.
The new filter is shown in the cascade filters list as ‘Map Filter’ and is marked as active. Note that disabling the map filter will remove it. The ‘Remove active map filter’ button
will also disable/remove the map filter.
The ‘Display selected points’ button
shows a pop-up box containing a list of the points that have been selected by the currently active map filter. The separate pages of the list can be viewed using the page buttons at the bottom of the window. Search for items containing a particular group of characters by using the ‘Search’ window. Clicking the ‘Delete’ link next to a particular point will remove that point from the Map Filter selection, is does NOT remove the point from the database. Map Filter List popup can be moved, so user can still see map points underneath.
Just like other Cascade Filters, active Map Filters will filter the data that is returned from ‘View Data’ and ‘Download Data’ activities.
# > Macro (anchor)
View Data
The ‘View Data’ option presents a list of the modules (tables/views) that are available to the current user. These modules are collected into module groups, which can be expanded and collapsed by clicking on the
and
arrowheads next to the module name. If any filters have been saved for a particular module, those filters will be listed underneath the module name (see example below: Module ‘DH Collars’ has saved filter ‘Hole Type DD’)
Clicking the module name will open the table/view and show the content of the object. The content of the table will be filtered based on the current active dataset selection, activated through the DataSet Manager. The content is also filtered according to any currently active Cascade Filters that relate to the current object type.
In the image above, the ‘DH Collars’ module has been selected, and there are no currently active cascade filters. The first page of data is displayed, along with a scrollbar at the bottom of the page (not currently visible) allowing the user to see additional columns not currently on screen. At the bottom of the page are the first / previous / next / last page buttons, the current page and number of pages, and the total number of items.
Clicking the ‘Hole Type DD’ filter will show the data in the same table, but first activates the named Cascade Filter. In this example, that filter includes only holes with the value ‘DD’ in the ‘Hole_Type’ column. This filter will now remain active for other ‘DownHole’ modules, until it is disabled. The DH Collars heading below will display a * symbol when a cascade filter has been applied to a table as below.
| | |
| --- | --- |
| Assay Incoming Data table will display default shared filters for “Missing Library Values”, “No Sample match” and “Other Errors”. | |
| 
Decimal fields will in the table will be displayed with all decimal places and no trailing zeros. An “&” character is supported in a user module name or table display name | |
|  | |
| | |
| | |
## > Macro (anchor)
Grouping
Under the space for the object name and filter definitions is the ‘grouping’ space. (See ‘2’ above). One or more column headings from the column list (‘3’) can be selected, by right mouse click, into the grouping space. Data is then collapsed into groups with one group for each unique value for the grouping column. If additional columns are grouped, the data is further collapsed into sub-groups within each higher level group, with a sub-group for each value of that column present in the parent group. This pattern repeats for further grouping levels. Groups/sub-groups can be individually expanded/collapsed to view the data within the groups.
In the example above, data has been grouped by Data Set, and also Hole Type. This is done by right mouse clicking on the ‘Dataset’ column header, selecting the ‘Group by This Column’ from the list. Then right mouse click on the ‘Hole Type’ column header and select ‘Group by This Column’. The data is then grouped into blocks, with holes in the ‘MXDD’ dataset grouped together (see ‘1’ above), holes in ‘MXRC’ together (see ‘4’), and holes in ‘MXRG’ together. Within each of these groups, data for each Hole Type value is further grouped and collapsed.
The ‘MXDD’ group has been expanded, and within that group, the ‘DD’ Hole_Type value has also been expanded (see ‘2’ above). DataShed5 now shows the 9 rows in the ‘MXDD’ dataset that have the ‘DD’ hole type. The holes with the ‘RCD’ hole type in this dataset are still collapsed (see ‘3’ above)
By default, when grouping data the values in the grouped column are shown in ascending order. (See the ‘up’ arrows next to the column names in the Grouping area). Clicking the column heading will reverse the sorting order, and change the arrow direction, for that column.
Clicking the ‘Refresh’ button, or selecting the module from the module list, will refresh the data with no column grouping.
## > Macro (anchor)
Sorting / Filtering from the grid
In the main data display area, clicking a column heading will sort the data according to values in that column, clicking the heading again alternates the sort order between ascending and descending order. This sorts the data according to the values in that column only. A small arrowhead pointing up/down indicates that the data is sorted by that column. If there are data groupings active, the column values are sorted within each sub-grouping. Columns can be re-ordered by clicking/dragging a column heading along the heading list to a new location.
Below each column heading is a space for searching/filtering the data, within any already active filters. To search for data with particular values, enter the value underneath the column heading, and click ‘Return’ to activate. Alternately, click the ‘funnel’ (filter) icon next to that space to change the matching condition as required. Conditions can be entered for multiple columns if required, only data that fits ALL of the entered conditions is displayed.
**Grid Toolbar Actions **
At the top of the grid a toolbar is available with the following actions:
**Download**
Download the data in the current displayed module to the browser, in either Excel or CSV format. Any active cascade filters, as well as additional display/filtering/sorting rules applied in the module (see below) are applied in this download.
**Refresh**
Refresh the data in the current module. The refresh button will retrieve the data from the database and update the grid.
**Sort**
Provide a ‘Sort Data’ dialog to sort data according to one or more columns. The ‘Sort’ button is the only way to include multiple columns in the sorting definition and allows a user to save a sort order for the grid. Sorting a varbinary field (i.e. Image), is not supported in the data grids.
**Display**
Provides a ‘Display’ dialog allowing the user to select columns to show in the current grid and the order of the columns. Selecting the ‘Display’ option will show a dialog allowing the user to select any Available Columns on the left to display in the grid. It automatically select the primary key fields when selecting display columns.
The columns can be ordered in the grid by selecting the
and dragging the column to the required position.
Selecting the ‘Clear All’ option will clear all the users’ selections, order, and reset the grid to the display all columns in the default order.
Selecting ‘Save’ will save the users display setting and refresh the grid.
**Filter**
The filter option allows a user to create, edit, delete, activate and deactivate filters for the displayed grid.
Selecting the ‘New Filter…’ option from the Filter menu will display the Filter dialog as below.
Selecting the ‘Activate Filter’ will save the filter, close the dialog and refresh the grid with the active filter. The Filter option will display the activate filter name in the toolbar.
You can also create filters, disable a filter for a table by right-clicking on the table name in the module list, and selecting ‘Add Filter’ or ‘Disable Filter’ options.
A Hole List filter can be created using the criteria Hole_ID is one of, a list of holes where the list of holes can be copy and pasted from an excel spreadsheets.
**Audit Trail**
The Modified date, Load date details are updated with server datetime on insert and update.
## > Macro (anchor)
Find and Replace
The Find and Replace option is available in View Data. Select a column on the grid to
find and replace data within that column.
Find and replace data within the currently display page or all data for the table as shown below.
A user confirmation prompt displays, detailing the total number of occurrences and allowing the user to confirm to replace the data.
## > Macro (anchor)
Imago Access
Where relevant, Views and Tables can be configured by the DataShed5 Admininstrator to enable access to your Imago account. This will provide access to view images stored in Imago for the selected DataShed5 record from View Data.
The image above shows a view which has been enabled for Imago access for the logged in User. By selecting the relevant record and clicking on the link
at the left of the grid row, login access to Imago will be provided.
After signing in to your Imago account, the relevant images for the selected record’s HoleID and optionally DataSet, Depth and Project will be displayed.
# > Macro (anchor)
View Map
Several map views are available under the ‘View Map’ menu option. An example of the maps available is shown below, the list of maps available in your own installation can vary slightly as DataShed5 administrators can add new maps to this list, or modify or remove the default maps.
Clicking a particular map from the list will show the map, and will mark points on the map corresponding to all of the objects for that map type. If there are any active cascade filters, the objects shown on the map will only include objects that fit the filter criteria. (An exception to this is Map Filters, which still show all points, but highlight the filtered points in red).
The map can be zoomed in/out using the zoom in/out buttons on the toolbar at the top-left of the map window.
Zoom in/out of the map by using the map scroll wheel, pinch/expand on a touch-screen device, and possibly other key/mouse/touchpad combinations depending on your device configuration. Holding the shift key and selecting a rectangle with the mouse will cause the map to zoom in on the selected area.
Pan around the map by clicking and dragging the mouse or touchpad, or a finger-drag on a touch-screen device.
Note that map images will only be available if there is an active internet connection, DataShed5 actively retrieves the map images directly from online map service provider Mapbox as the map is manipulated.
Clicking on a particular point will show more details for that point, the actual details depends on the data type for the map being displayed (see below). Note that points can only be shown on a map if their latitude/longitude data has been correctly added – if necessary your data administrator can use the DataShed Grid Transformation function to calculate lat/long details from other grid data.
Some maps may also include tenement boundaries, drawn as blue lines. If your map includes the tenement layers, clicking the map inside a boundary will show information about the tenement. Other custom map layers could be added for your particular DataShed5 installation, these may show additional lines/objects on the map, and may or may not provide additional information when clicking on objects that are drawn as part of those layers.
Additional buttons on the map allow the user to create a ‘Map Filter’ by selecting a rectangle on the map. All points inside the rectangle are selected as part of the filter. More information about this is in the ‘Filters’ section of this document.
At the top right corner is a map series selection list. When a map is opened the list will include all available series for this map. Various objects displayed on the map are separated into different series according to a particular value, which depends on the map type. Objects may be separated by hole type, sample type, intercept ranges, etc.
Unchecking the box for a particular series will hide all objects with that same value, or of the same type. This can serve to make the map less cluttered by hiding particular objects and allowing the user to focus on other object types. Selecting the check box to turn it on will make those objects visible again.
The map refresh button
is used to redraw the current map. This button is useful if you enable/disable a cascade filter, or edit an active filter, whilst a map is already displayed. The refresh button will cause the map to be redrawn with new points excluded/included after the changes in filtering conditions.
Polygon selection icon allow to create active map filters. It’s allowed multiple selections. Cross sign icon can remove all created polygon points on active map.
Rectangle icons shows two types of Tenements details which are Monitored Tenements and My Tenements. Each of the sections includes type of expiry options, it’s allowed to filter out tenement based on the expiry day.
Tenement monitoring information based on ‘tblSYSTenementMonitoring’ in MDS, client or administrator need to define lists of tenements, for monitored tenement, add ‘MonitorTen’ in DataSet column. For own tenement keep DataSet as it is.
Equal icon shows the Map Styles, includes LightMode, HeatMap, TerrainMode, Layer Opacity and Types of Layers. All styles default as in ‘off’ mode. Except from ‘HeatMap’, all other functions work as default. ‘HeatMap’ function is disabled as default, configuration required in DS5Admin to enable ‘HeatMap’ function. For the ‘Layer Opacity’ option, required to select any one of layers and opacity allowed to manage opacity level. Default as disable until select one of the layers.
The Tenement Search function allows users to search for all or part of a Tenement ID and then the map will move to focus the map window on the selected tenement. To use this function, type all or part of the required tenement ID into the search box then click on the required tenement in the drop down box. Note, the window may not focus on the centre of the required tenement due to the irregular shapes of tenement outlines.
# > Macro (anchor)
Reports
DataShed5 provides a number of reports, available in a number of report groups. Reports collect and collate information from various places in the database, and summarise and display that data – possibly with charts and graphs, or even just a list of some of the raw data.
Administrators can customise which users have access to which report groups, so the reports available to a particular user may not match those available to others.
When a report is selected, DataShed5 will load the report and display a parameter/preview screen (highlighted in red above). The number and type of parameters and acceptable values will vary according to the particular report that has been selected. Enter appropriate values in each of the parameter fields, then click the ‘SUBMIT’ button to run the report.
Along the top of the report, and also to the right side, is a number of buttons that facilitate navigation and viewing of the report. Hovering the mouse over the top of any of these buttons will show a pop-up tooltip indicating what the button does. Each button is described below.
The first group (section ‘1’ above) includes buttons that move to the first, previous, next, and last page of the report. The ‘1 of 357’ in the middle of that section in this example indicates that the current page being viewed is page, and that there are 357 pages in total. Clicking this pull-down box allows the user to select a particular page and jump directly to that page.
The buttons in section ‘2’ allow the user to toggle the ‘multi-page’ view mode. The example image above shows only a single page of the report, toggling the multi-page view shows multiple pages and allows scrolling up/down the pages. Next to that is the zoom out (-) and in (+) buttons, and a list that allows selecting a zoom percentage or a whole-page / page-width zoom setting.
Section ‘3’ contains the buttons that allow the user to print the report, and allows the user to select any locally accessible printer as the target. Another button allows the report to be downloaded to the local computer as a PDF, XLSX, DOCX, or CSV format file. The magnifying glass button in this section allows the user to search for a particular text string in the report.
At the right side of the report screen (section ‘4’ above) are several more buttons. Selecting the ‘Funnel’
icon allows the modification of one or more of the report parameters, before re-executing the report with the updated parameter values. The ‘Settings’ icon
allows the user to modify the export options, these options will modify the behavior of the ‘Export’ (Download) button in the Section 3 buttons. The ‘Search’
icon is that same as the similar icon in section 3, allowing the user to search for particular text within the report. Finally, the ‘Document Map’
icon shows logical separation points of data within the report (eg. where data for each drillhole begins) and allows the user to jump to the page of the report where that section begins.
The ‘>’ button at the very top of section 4 will collapse that part of the window, allowing more screen space to view the actual report content. The icons for each option are still visible, clicking any of the icons (or the ‘<’ button) will restore that part of the report viewer again.
# > Macro (anchor)
Power BI Reports
DataShed5 provides users access to Power BI Reports embedded from Power BI cloud portal in Datashed5.
# > Macro (anchor)
Dashboards
DataShed5 provides users with dashboards, which are collections of various data summaries that are shown together. Dashboards typically contain information rendered as charts, gauges, indicators, and other visual objects. The DataShed5 dashboards provide this visual information and allows the user to enter/edit various parameters, and then re-display the data according to the new parameter values.
*QAQC Dashboard – Standards Tab*
The image above is an example image from the QAQC dashboard. The parameters along the top of the screen allow the user to select which assay batches will be included in the calculations. The parameters to the left side of the chart allow the user to choose which standard, assay method and element will be charted, and also allows a ‘zoom’ to a particular part of the chart if required.
When a standard control chart is plotted by library values, DataShed5 will first look for a specific expected value from the combination of standard, generic method and element and if that is not found it will search for an expected value for the standard and element where preferred = 0.
The image above shows that it allows multiple standards to be displayed in the standards control chart.
*QAQC Dashboard – Repeats Tab*
The repeats tab provides a different chart, again there are multiple parameters that change the behaviour or display of the chart.
DataShed5 provides an Excel download option for the standards and repeats chart that will download the results data for the currently displayed chart.
DataShed5 allows a batch status filter to be applied to the standards and repeats chart data.
*Drilling Dashboard*
The Drilling Dashboard shows drilling information in various charts and graphs, and also a consumable/chargeable item list shown at the bottom of the page. The parameters at the top of the page allow the user to select the hole, rig, shift, and date range to be charted.
After parameters are selected, click the ‘Apply’ button to draw the charts. The dashboard shows total costs and metres drilled per shift and the total cost per metre for each day over the selected period. The pie-chart at the bottom right shows the distribution of costs for the period.
# > Macro (anchor)
Download Data
The Download Data menu option allows the user to extract and download data from the database. Users can choose from the download types ‘Table’, ‘Layout’, and ‘Scheme’, the option selected then defines the other selections available.
Data can be downloaded in the following formats:
- Microsoft Access
- Microsoft Excel
- Comma Separated Values (CSV)
- Micromine
- Fixed Width text
Note that not all of these options are available for all download selections. Some formats may be incompatible with or inappropriate for the selected item or items to be downloaded. Only formats supported for the current download selection will be shown in the ‘File Format’ selector.
A **Setting** option is available, that will allow downloading quoted and non-quoted files for a comma-delimited format.
If the ‘**Table’** download option is selected, the user can then select the desired file format for the download, and then select the table (or view) from which data will be extracted. When the ‘Download’ button is pressed the content of that table or view will then be downloaded to the user’s computer. The ‘Download’ button is hidden until a valid option has been selected in all of the required fields. On option for ‘All Columns’ will display for Download Type Table. When unselected the data downloaded will contain the columns selected and the columns order by the user in the Display option for the grid. When selected all columns for the table will download.
The ‘**Layout’** download option presents the same file format options as the ‘Table’ selection, with the addition of a Micromine and fixed Width file format. The user selects the data source as before, which is a table or view in the database. DataShed5 then shows a list of the layouts available for the selected data source. (Layouts are created in DataShed4, and define a subset of fields, their ordering and format, to be extracted from a table or view). With Layout you also get option to Validate.
If Validate option is selected, application will validate the selected layout and if there is no error or warning you can see Validate status as “**Validation Pass**” or else **Details**. Details link to display details of the error or warnings. And file will be downloaded.
If you don’t select Validate option status will show “No Validation Checked”.
Once a layout is selected for the source, the ‘download’ button is available to begin the extract/download of the data.
The ‘**Scheme’** download option shows a list of pre-defined download schemes that are available. Schemes are created in DataShed, and typically consist of a collection of Layouts for various tables. Schemes can be selected for extraction in either Access or Excel format.
If the “**Validate”** option is selected, application will validate the selected scheme and if there is no error or warning you can see Validate status as “**Validation Pass**” or else **Details**. Details link to display details of the error or warnings. And file will be downloaded.
If you don’t select Validate option status will show “No Validation Checked”.
After a scheme has been selected, the ‘Download’ link becomes available to begin the download.
On selecting Download, a download table will display as above showing the status of the download. Once the download is complete, the Status will display ‘Downloaded’ when successful or Error when an error occurs. If an error occurs, the user will be able to select the Error link to display details of the error.
Downloads can be queued allowing for multiple downloads to be selected. Each download will be displayed in the table that has been requested and a status will display. A ‘Cancel’ option will be available for the download that is currently in progress. Selecting the cancel option will cancel the current download and progress to the next download if one has been queued. Selecting the ‘Remove’ button will remove the download from the display list.
**Validation Check Rules:**
- Check export layout data source exists in MDS.
- Check exported fields are mapped to the correct datatype.
- Check export layout fields exist in MDS data source.
- Check export fields configured with a SQL output type, checks for valid SQL.
- Check predefined export fields have correct format.
- When downloading a scheme, check if the user has access privileges to each layout in the scheme. A warning will display if the user has no access privileges to a layout in a scheme and will not download data.
There is “Copy Validation to Notepad” option, by clicking this button all the validation check results will be copied to notepad on client side.
When downloading a date field for a layout or scheme the format of an export layout date field configuration, where Data Type = C-Character, will export a date format consistent with the current browser language settings and Data Type =D- Date, will export a date with format dd-MMM-yyyy HH:mm:ss.
Regardless of which download format is selected, only data that belongs in the currently active DataSet Selection AND also conforms to any active Cascade Filters will be extracted.
# > Macro (anchor)
Intercept Calculator
DataShed5 provides a method to run an Intercept Calculator package directly from the browser. The user selects an appropriate IC package from the list, and can then use the ‘Validate’ and ‘Calculate’ buttons to validate the package, then perform the intercept calculation.
The intercept calculator is used to populate the table tblDHIntercepts, which is then used as a source for the ‘Drill Hole Intercepts’ map. Intercept Calculator package records the Loaded By and Load Date from currently logged in user and server datetime.
At the right side of the screen are a number of check boxes – selecting the first one causes DataShed5 to show the intercept data after the calculation is complete. The remaining boxes will limit the data returned to that calculated by the currently selected package only, and/or the current user only. Unchecking those check boxes will hide data that was not calculated by the currently select package, or that was calculated by another user.
# > Macro (anchor)
Assay Manager
DataShed5 provides an Activity option to users only if Assay Management module is assigned to them in DataShed5Admin.
Upon clicking on Activity option, it enables user to see Assay Manager Sub menu as below.
The Assay Manager module will provide the ability for a user to query assay batches loaded, process, analyse, approve and report on assay batches.
On clicking Assay Manager sub menu, Assay Manager page will appear with the assay manager filters, a multiview option and the Admin menu button.
Admin menu button is available for the users with SysAdmin security level only.
## > Macro (anchor)
Assay Manager Filters
Assay Manager Filtering will appear allowing the users to select filters to apply on assays based on the following options. Currently always displaying ‘Assay’.
Schemes filter: It is single select drop down list with list of imported schemes. Assays is the default scheme set in the import post processing schemes.
Date Range filter: It is single select drop down list as below allows to user to select date periods. Last week is selected by default. This filter allows user to filter assays based on the load date from Assay Batch table.
Date From & Date To: This filter allows user to filter assays based on the load date from Assay Batch table.
BatchStatus: It is a multiple select drop down list with list of items from AssayBatchStatus. AllBatchStatus is selected by default.
Users: It is a multiple select drop down with list of items including loaded by users from Assay Batch for the selected scheme and selected Batch Status. All Users are selected by default.
Labs: It is a multiple select drop down with list of lab codes from Assay Batch for the selected Scheme, Date Range, users, BatchStatus. All Labs are selected by default.
Batches: It is a multiple select drop down with list of batch numbers available for selected Scheme, Date Range, users, BatchStatus. All Batches are selected by default.
After selecting the filters, click on Apply button to see the list of components for the selected schemes, DateRange, BatchStatus, Users, labs and batches as below.
## > Macro (anchor)
Assay Manager Components
The Assay Manager module consists of the standard components i.e., Batch List, Unmerged Assay Results, Assay batch header, Assay batch Details, Unmerged Assay results, QC Results and Batch approval.
### > Macro (anchor)
Batch List
The Batch List will display filtered data from the Assay Batch table. The Batch List has a Batch status field, the batch status is assigned to a batch on importing to the system. The following details the batch status values that can be assigned.
- Accepted: when all QC Rules pass the batch will be set to ACCEPTED.
- Rejected: when all QCRules fail the batch will be set to REJECTED.
- Queried: when one or more rules but not all rules fail, the batch will be set to REJECTED.
- QC not applied: when no QC Policy is assigned to a batch, the batch will be set to QC_NA.
- Unmerged: If a batch has unmerged data, the batch will be set to UNMERGED.
This Batch Filter List has a **Process Batch **and **Delete** option available in the first column for a SysAdmin only.
Process Batch: When SysAdmin clicks on
(**Process Batch**) a confirmation prompt will appear enabling user to confirm to start the process for that batch number. When clicked on Yes, the process batch will run the incoming data driver, retry merge procedures to process any records existing in the unmerged Assay Results then runs the QC Checker procedure if the batch status is not Unmerged and then runs the re-ranking procedure if the batch status is Accepted.
The list of processes running is shown as below with the checkbox associated to it. Once the process is completed the status of each is updated as below in green colour if succeeded else the error message will be shown in red colour. When running the stored procedures user has the ability to cancel the process anytime.
On completion of running the stored procedures, when clicked on close button the Filter data grid and all component data grids displayed will be refreshed.
Delete Batch:** Delete** option gives SysAdmin a confirmation prompt to delete the data from Admin Batch Delete procedure.
### > Macro (anchor)
Unmerged Assay Results:
The Unmerged Assay Results option allows users to display the assay data that is quarantined due to data validation issues. This option also provides details to the SysAdmin for the reasons for quarantining the data and once the user has rectified the errors the user can Process Batch to merge the data to the assay tables.
Column filter is available for the Exception Type column to the user to filter data based on unique exception Type.
### > Macro (anchor)
Assay Batch Header
This component will display grid data of from Assay Batch table filtered by Assay Manager labcodes and batch numbers.
### > Macro (anchor)
Assay Batch Detail
This component will display grid data of from Assay Batch Detail filtered by Assay Manager labcodes and batch numbers.
### > Macro (anchor)
QC Results
The QC Results component will display the QC results details associated with the selected batches. The QC Results will display a non-editable data grid with QC Results and QC Result details, allowing the user to drill into a QC result to display the QC result details associated.
An example of data that will display in the QC Results, QC Result details for each QC type (Blank, Standard, Repeat, Screen Test) is given below.
#### QC Type: Blank
A blank rule will display details similar to the following in the QC Result section
This blank rule has been configured for “Blanks are within expected min and max value”
**QC Status: **will equal Pass/Fail/NoData**.** “QC Rule Pass %” determines if the blank rule will pass or fail.
- **Pass: ** “Results Pass%” > “QC Rule Pass%”. The “QC Rule Pass%” is set by the user in the QC Rule, Pass% field. The “Result Pass%” is calculated when processing the rule. The “Result Pass %” = Total number of blank samples for the batch that failed the rule / total number of blanks samples for the batch.
- **NoData: **There are no blank sample existing for the batch.
A user can drill into the QC result to display all the blank sample results with a QC status Pass/Fail status, as shown in below screenshot.
A blank sample will be assigned a status of Pass/Fail with the following conditions
**FAIL**: if no reference values exists, i.e. Expected Min and Expected Max values.
The Expected Min and Expected Max values are selected from the *QC Reference Value *Library Table where
- If a record exists for the combination of standard, generic method and element where the Expected Min and Expected Max values exist, these values will be used for the comparison above.
- If no record exists for the above combination, a search for the standard and element where preferred = 0 and Expected Min and Expected Max values exist, the values will be used.
**FAIL**: if reference values exist AND the blank sysResult is outside of the ExpectedMin and ExpectedMax
**PASS**: if reference values exist AND the blank sysResult is between the ExpectedMin and ExpectedMax. For example, the sysResult value 0.02 is within the Expected Min value 0.01 and Expected Max value 100, so the status is passed.
#### QC Type: Standards
A standard rule will display details similar to the following in the QC Result section. This record will be highlighted red when it has a failed QC Status.
This standard rule has been configured for “Standards within 2STD of expected value”
**QC Status: **will equal Pass/Fail/NoData**. ** The “QC Rule Pass %” determines if the standard rule will pass or fail.
- **Pass: ** “Results Pass%” > “QC Rule Pass%”. The “QC Rule Pass%” is set by the user in the QC Rule, Pass% field. The “Result Pass%” is calculated when processing the rule. The “Result Pass %” = Total number of standard samples for the batch that failed the rule / total number of standard samples for the batch.
- **NoData: **There are no standard samples existing for the batch.
A user can drill into the QC result to display all the standard sample results with a QC status Pass/Fail status, as shown in below screenshot.
A standard sample will be assigned a status of Pass/Fail with the following conditions
**Fail:** if no reference values exists, i.e. Expected Value and Expected StdDev values.
The Expected Value and Expected StdDev values are selected from the *QC Reference Value *Library Table where
- If a record exists for the combination of standard, generic method and element and where the Expected Value and Expected StdDev values exist, these values will be used for the comparison above.
- If no record exists for the above combination, a search for the standard and element where preferred = 0 and Expected Value and Expected StdDev values exist, thee values will be used.
- For example sysResult value 2.16 is not in between LowerLimitStDev -1.9 and UpperLimitStDev 2.1. So, the status is failed.
- **Pass**: Standard Sample Result is between LowerLimitStDev and UpperLimitStDev.
- **Fail**: Standard Sample Result is **not between** LowerLimitStDev and UpperLimitStDev.
#### QCType: Repeats
A repeat rule will display details similar to the following in the QC Result section
This repeats rule has been configured for “Lab Repeat 1 within 10% difference of original value”
**QC Status: **will equal Pass/Fail/NoData**. ** The “QC Rule Pass %” determines if the repeat rule will pass or fail.
- **Pass: ** “Results Pass%” > “QC Rule Pass%”. The “QC Rule Pass%” is set by the user in the QC Rule, Pass% field. The “Result Pass%” is calculated when processing the rule. The “Result Pass %” = Total number of Lab Repeat1 samples for the batch that failed the rule / total number of Lab Repeat 1 samples for the batch.
- **NoData: **There are no LabRepeat1 samples existing for the batch.
A user can drill into the QC result to display all the repeat sample results with a QC status Pass/Fail status, as shown in below screenshot.
A repeat sample will be assigned a status of Pass/Fail with the following conditions
- **Pass**: (repeat result – original Result)/ original Result < 10% ((i.e. “% difference From original Value”) AND Repeat Result < (10% * original Result Limit lower)
- **Fail**: (repeat result – original Result)/ original Result >= 10% ((i.e. “% difference From original Value”) AND Repeat Result > (10% * original Result Limit lower)
#### QCType: Screen
A screen test rule will display details similar to the following in the QC Result section
This screen test rule has been configured for “Screen Test check for p75pum”
**QC Status: **will equal Pass/Fail/NoData**. ** The “QC Rule Pass %” determines if the screen test rule will pass or fail.
- **Pass: ** “Results Pass%” > “QC Rule Pass%”. The “QC Rule Pass%” is set by the user in the QC Rule, Pass% field. The “Result Pass%” is calculated when processing the rule. The “Result Pass %” = Total number of results for element: p75um for the batch that failed the rule / total number of results for element: p75um for the batch.
- **NoData: **There are no results for element: p75um samples existing for the batch.
A user can drill into the QC result to display all the results for element: p75um sample results with a QC status Pass/Fail status, as shown in below screenshot.
A screen test sample will be assigned a status of Pass/Fail with the following conditions
- **Pass**: when the sysResult is outside of the Lower and Upper limit. The Lower and Upper limits are set by the user in the QC rule.
- **Fail**: when the sysResult is inside the Lower and Upper limit.
### > Macro (anchor)
Batch Approval
The Batch Approval component will allow a SysAdmin and User Plus the ability to accept/reject batches and automatically email a notification with batch summary details and QC Results.
On selecting the **Approve** button, a pop window will appear allowing user to change the batch status and send the email to the email address configured and Save. User is allowed to select only accepted or rejected.
When approving a batch and changing the status to rejected or accepted a notification will displayed if reranking will run. For example if the Batch status is changed from Accepted to rejected the reranking will run on saving.
Emails are configured for the approval from QC Emails in QC Rules Configuration. Once email is configured in QC Emails it will appear in Batch Approval grid. So, when saving the batch status and emails are configured, email is sent to with Batch Summary and QC Results. If there is any issue with the email not being sent message will be shown to the user as below.
## > Macro (anchor)
Admin Menu
The admin menu allows the administrator to configure QC rules, maintain assay management library table codes and details and setup assay configurations required for importing assay data.
### > Macro (anchor)
Library Tables Maintenance
Library Tables submenu displays a list of library tables as below and allows the SysAdmin the ability to add, edit, delete and copy assay library table codes.
1. Element Groups: This grid displays the list of element groups from
2. Elements: This grid displays the list of elements.
3. Method priorities: This grid displays data from Method priorities. The Method priorities will automatically sort the order of the priority on save. After saving it will run the re-rank procedure as below.
1. Generic Methods: This grid displays the list of generic methods.
2. Labs: This grid displays the list of labs with their information from Assay Labs table.
3. Lab Method: This grid displays the list of lab methods from Assay Lab Method table.
4. Lab Element Alias: This grid displays the list of alias names for the labs from Assay Lab Alias table
5. Units: This grid displays the list of units from Units table.
6. Conversion Factor: This grid displays the list of conversion factors from conversion factors.
7. Import Substitutions: This grid displays data from import substitutions table.
8. Import File Type: This grid displays the list of files imported into the system from import file type table.
9. Incoming Data Mask: This grid displays data from incoming data mask table.
10. QC Category: This grid displays data from QC Category table.
11. QC Reference: This grid displays data from QC Reference table.
12. QC Reference Type: This grid displays data from QC Reference Type table.
13. QC Reference Values: This grid displays data from QC Reference Value table
### > Macro (anchor)
Configuring QC Rules
QC Rules in Assay Manager can only be configured by Sys Admin only. SysAdmin will have the ability to assign and maintain QC rules to one or more layouts. Below are the list of options available in the QC Rules Configuration.
#### QC Rule Standards
Allows the user to maintain QC Rules for standard samples. Clicking on the Add option in QC Rule Standards grid will enable user to add new QC Rule Standard.
A popup window as above will appear upon clicking on edit option. QC Rule Standards will allow user to enter below fields
- Code: a user defined name for the rule, is a unique name.
- Description: a user defined description of the QX Rule standard and will be displayed in the email notifications.
- QCType: is the qc type, always STD.
- StandardTypes: is a list of types from the Reference Type library table, will not display reference types containing Blank or BLK.
- Element: is a list of elements from the Ass Element Library table, one Element can be selected.
- Pass%: is a percentage that determines if the rule will pass or fail. For example, this rule will fail if 75% or more of the standard samples for the batch are not within 2std deviations.
- Exclude BDL:** **true/false. If true, standard samples that have a Below detection limit (tblAssay.sysAssayStatus=BDL) will be excluded from the rule.
- Exclude UP: true/false. If true, standard samples that require updating (eg I/S, X, NS) (tblAssay.sysAssayStatus=UP) will not be included in the rule.,
- Exclude OR: true/false. If true, standard samples that are Over Range (tblAssay.sysAssayStatus=OR) will be excluded from the rule.
- Reference Values: is a dropdown selection with UseExpectedValue/UseHighLow.
- UseExpectedValue: the standard sample rule will be computed using the QC Reference values: Expected Value and Expected StdDev. For example, a sample will fail if the sysResult is not within 2std deviations of the expected value.
- UseHighLow: the standard sample rule will be computed using the QC Reference values: Expected Min and Expected Max. For example, a sample will fail if the sysResult is not within Expected Min and Expected max.
- Std Deviation: is a dropdown selection with 1/2/3, this option is required if you are using ReferenceValues= UseExpectedValues.
#### QC Rule Blanks
Allows the user to maintain QC Rules for blank samples. A popup window as below will appear upon clicking on edit new option. QC Rule Blanks will allow user to enter below fields.
- QCType: is the QC type, always BLANK.
- StandardTypes: is a list of the types from the Reference Type library table and will only display Reference Types containing Blank or BLK
- Element: is a list of elements from the Ass Element Library table, one Element can be selected.
- Pass%: is a percentage that determines if the rule will pass or fail. For example, this rule will fail if 75% or more of the blank samples for the batch are not within the expected min and expected Max for the batch.
- Exclude BDL:** **true/false. If true, blank samples that have a Below detection limit (tblAssay.sysAssayStatus=BDL) will not be included in the rule.
- Exclude UP: true/false. If true, blank samples that require updating (eg I/S, X, NS) (tblAssay.sysAssayStatus=UP) will not be included in the rule.,
- Exclude OR: true/false. If true, blank samples that are Over Range (tblAssay.sysAssayStatus=OR) will not be included in the rule.
- Reference Values: is a dropdown selection with UseExpectedValue/UseHighLow.
- UseExpectedValue: the blank sample rule will be computed using the QC Reference values: Expected Value and Expected StdDev. For example, a sample will fail if the sysResult is not within 2std deviations of the expected value.
- UseHighLow: the blank sample rule will be computed using the QC Reference values: Expected Min and Expected Max. For example, a sample will fail if the sysResult is not within Expected Min and Expected max.
- Std Deviation: is a dropdown selection with 1/2/3, this option is required if you are using ReferenceValues= UseExpectedValues.
#### QC Rule Repeat
Allows the user to maintain QC Rules for repeat samples. A popup window as below will appear upon clicking on edit new option. QC Rule Repeats will allow user to enter below fields.
- QCType: is the qc type, always REPEAT.
- RepeatType: a list of values from the QC Category Library Table, one repeat type can be selected.
- Element: is a list of elements from the Ass Element Library table, one Element can be selected.
- Pass%: is a percentage that determines if the rule will pass or fail. For example, this rule will fail if 75% or more of Lab repeat1 samples for the batch if
- the difference percentage of the repeat result from the original result is less than 10% (i.e. “% difference From original Value”) AND
- the repeat result is less than 10% of the detection limit (i.e. “Value * Detection Limit (lower limit)”)
- %Difference from original value: is a percentage that will determine if the repeat result fails or passes. Therefore, if the difference percentage is less than 10% from the original value the repeat sample will pass.
- Exclude BDL:** **true/false. If true, repeat samples that have a Below detection limit (tblAssay.sysAssayStatus=BDL) will be excluded from the rule.
- Exclude UP: true/false. If true, repeat samples that require updating (eg I/S, X, NS) (tblAssay.sysAssayStatus=UP) will not be included in the rule.
- Exclude OR: true/false. If true, repeat samples that are Over Range (tblAssay.sysAssayStatus=OR) will be excluded from the rule.
- Value * Detection Limit (lower limit): is a percentage that will determine if the repeat result fails or passes.
#### QC Rule Screen Test
Allows the user to maintain QC Rules for screen tests.** **A popup window as below will appear upon clicking on edit option. QC Rule Standards will allow user to enter below fields.
- QC Type: the QC type, always equal Screen.
- Element: is a list of elements from the Ass Element Library table, one Element can be selected.
- Lower Limit Value: defines the minimum value required for the rule to pass/fail.
- Upper Limit Value: defines the maximum value required for the rule to pass/fail
- Exclude UP: true/false. If true, screen samples that require updating (eg I/S, X, NS) (tblAssay.sysAssayStatus=UP) will not be included in the rule.
- Pass%: is a percentage that determines if the rule will pass or fail.
#### QC Policy
Allows SysAdmin to create new policy with a unique policy name.
#### QC Policy Rule
Allows SysAdmin to assign existing QC Rules to an existing QC Policy.
#### QC Policy Layout
Allows SysAdmin to assign one QCPolicy to one or more layouts. The QC Policy has to be active for the policy to be applied to a batch on importing a batch or processing a Batch. The Batch List will display the *Active QC Policy* for the Import layout.
** **
#### QC Emails
A QC Email can be configured for the Batch Approval notifications here. One or more emails can be added. When approving a batch, the user emails configured in the QC emails will be emailed.
### > Macro (anchor)
Assay Configuration
Assay Configuration allows Sys Admin to setup Import Post Processing Scheme, Assay Structure, RH Norm, LH Norm and Below Detection Treatment.
#### Import Post Processing Scheme
An Import Post-Processing Scheme is a logical listing of tables that the incoming assays will be merged to. The Default Post Processing scheme is configured in the standard MDS. Additional Import Post Processing schemes may need to be configured if multiple normalised assay tables are utilised.
A popup window as above will appear on clicking on create new import post processing scheme option. Creating new import post processing scheme will allow user to enter below fields.
- Name: Type in a suitable name.
- Assay Structures: Is the list of tables default standard assay merge tables.
- Description: Field allows to enter the description of the Assay Structures merge table.
- Unmerged Assay Results Table: Is the list of tables.
For example: tblSYSAssIncomingData (Most of the users are defined the name with Incoming Data at the end of the naming).
- Data Driver Store Procedure: Is default as ‘usp_ProcessInComingDataDriver’.
- Merge Stored Procedure: Is default as ‘usp_DataAssayMergingProcess’.
- ReRanking Stored Procedure: Is default as ‘usp_DataAssayRankingProcess’.
#### Assay Structure
Configures the normalised assay table (tblAssay).
A popup window as above will appear on clicking on create new Assay Structure. Creating new Assay Structure will allow user to enter below fields.
- Assay Table: Select the name of the normalised Assay Results table in the dropdown list (tblAssay).
- Name: Type in a suitable name. It is Maxgeo’s nomenclature to start all structures with AM (Assay Management) followed by the abbreviated structure type and table name. (AM_ASS_Assay).
- Sample Register: Select the name of the Sample Register in the dropdown list (tblSampleRegister).
#### RH Norm: Right Hand Normalisation
Links the flat assay table (tblAssayFlat) to the normalised assay table
These structures are all preconfigured as part of the Maxgeo Data Model.
A popup window as above will appear on clicking on create new RH Norm Structure. Creating new RH Norm Structure will allow user to enter below fields.
- Assay Table: Select the name of the normalised Assay Results table in the dropdown list (tblAssay).
- Name: Type in a suitable name. It is Maxgeo’s nomenclature to start all structures with AM (Assay Management) followed by the abbreviated structure type and table name. (AM_RH_Assay).
- Assay Flat Table: Select the name of the Assay Flat table in the dropdown list (Naming is followed by abbreviated table name and Flat word).
RH Attributes: allows a sysadmin the ability to configure elements for the tblAssay Flat table. The element field is assumed to be existing in the tblAssay flat table before configuring in the RH attributes.
Attributes of assay table section details will appear on clicking on detail RH Norm Structure. Lists of attributes assay table will show as above. A popup window as below, will appear on clicking on create new Attributes for selected RH Norm Structure.
Creating new Attributes will allow user to enter below fields.
- Element: Select the name of the Element in the dropdown list (tblSYSAssElement).
- Attribute Name: Type in a suitable name.
- Mode: User can select three modes such as Dynamic, Preferred Value Calculation and Static.
- Field Name: Select the field name from the dropdown list of selected Assay table.
- Field Type: Select suitable field type according to selected field name.
- Field Length: Type suitable field length for selected field type (Double, Integer, Long, Single, Text).
The Attributes tab configures how the assay results are to be ranked.
There are 3 ways to rank the assay values
- Preferred Value Calculations: Populates a field in the flat assay table based the generic methods priority for the element group the result’s element has been assigned to. This means the field defined will always be populated if there is a result for this element. This field MUST be added to the table tblAssayFlat in SQL Management Studio.
- Static: Populates a field in the flat assay table based on criteria defined in the database. This may is not always populated in the flat assay table. This field MUST be added to the table tblAssayFlat in SQL Management Studio.
- Dynamic: Can create a virtual field based on criteria specified, if the attribute is selected. Will attach the virtual field to the select LH sample table. In DataShed.
**Add Definition Type for Element**
Clicking on arrow and it will show sub details of Element definition type. A popup window will appear on clicking on create new Definition for selected Element. Creating new Definition will allow user to enter below fields.
- Definition Type: lists of the type will be depends on Element’s mode. If element defined as Preferred Value Calculation, definition dropdown will populate only Conversion. For Dynamic and Static mode, Conversion and Field type will populate in dropdown.
- Field Type: lists of field type populate as selected definition type. (For example: Select Conversion definition type, conversion value will populate in dropdown.)
- Value: Input only required for Field Definition Type. Keep it blank for Conversion Definition Type.
#### LH Norm: Left Hand Normalisation
Configures the sample metadata tables (tblDHSamp, tblDHSampQC etc.) and links this to the assay table.
A popup window as above will appear on clicking on create new Attributes for selected RH Norm Structure. Creating new Attributes will allow user to enter below fields.
- Sample Table: Select the name of the table in the dropdown list which is register in DataShed configuration.
- Name: Name will be automatically assign with ‘AM_LH’ and selected Sample Table name.
- RH Table: Select the name of the assay structure table in dropdown list.
- Related Sample QC: Select the sample QC table that stores the QC sample relating to the sample table specified.
- Is Standard Table: Check if table type is Standard Table type.
- Depth From: If Depth_From field does not exists in the LH Sample Table Name, dropdown function will disable. The Depth_From will display a list of fields that exist for the LH table name specified. Only save the details if a user has selected a different field name than Depth_From.
- Parent Table: display a list of registered tables, user can only select Parent Table when Sample Table has no Dataset column. This field is used for the production sample table currently, when a Dataset is not the Parent key you need to specify the parent table here. For example when selecting tblProdSamp as LHNormalisation a Parent Table has to be specified as tblProdLocation.
Assign LH Attributes
To Assign Attributes to LH table, check the element available in RH table lists and click on Assign button.
#### Check Config
Select the ‘Check Config’ button to check the configuration of the assay table that has just been configured. Following actions are performed
LH Norm
- Check that the attributes are defined in the corresponding LH table
- Check the Field name clash with Assay table.
- Check relationships exist for attributes and are defined.
RH Norm
- Check that the attributes are defined in the corresponding RH table
- Check for static table existence and that all parameters are filled in (non-fatal) (Only check if there are static/prefer attributes)
- Check the relationship between RH and Static
- Check for static and dynamic attributes, check that the restriction fields exist and that the restrictions placed on these fields are consistent with the field data types
- Check for prefer attributes, check that the element exists in the element in library (and that it is defined with single quotes in the attribute definition.)
- Check that the conversion factor specified is a non-zero numeric.
The message returned will indicate if the configuration has all the required fields populated correctly.
#### Below Detection Treatment
The detection limit can be set to either –1 times the lower detection limit or to half the lower detection limit. The sysresult will be calculated as 0.5*LLD or -1*LLD.
BDL substitutions ensure that the lower limit is populated and that the substitution for the import layout has been populated correctly. The sysAssayStatus will be populated with BDL if the substitutions table has been populated correctly. For example, a “<” before the results indicates that it is Below Detection Level for that method and “BDL” is inserted in the sysAssayStatus field.
## > Macro (anchor)
Security Levels: User, UserPlus, and SysAdmin
The following details all the functions that will be available to a user that has a security Level assigned to them of User, User Plus and Sys Admin.
**User**: will be given access to view data in the Assay manager.
**User Plus:** will be given access to the following in Assay Manager.
- Process Batch: allows user to run the stored procedures required for assay management data: Incoming Data driver, merging , Qc Checker, and Reranking.
- Can view and edit Unmerged Assay Results, Assay Batch Header, Assay Batch Detail grids.
- Cannot delete data from Unmerged Assay Results, Assay Batch Header, Assay Batch Detail grids.
- Approve Batches: Accept or reject batches.
**SysAdmin:** will be given access to the following in the Assay Manager.
- Maintain Assay Schemes and Normalisations database structures required for the importing of assay data to a specified assay files, i.e. standard assay, assay water, pXRF Assay data.
- Maintain assay management configuration data for Library Tables, Qc Configuration and Assay Structures, LH Nominations, RH normalisations and Post Processing schemes.
- Process Batches: running the Process Batch option will run the stored procedures required for assay management importing of data: Incoming Data driver, merging, Qc Checker and Re-ranking.
- Approve batches by Accepting or rejecting batches.
- Delete batches.
## > Macro (anchor)
Grid Modifications
Assay Manager allows user with security Level Sys Admin will allows to create, edit, copy and delete the records.
Clicking the ‘[+]’ button next to Assay Manager tables opens the popup, which allows the SysAdmin to create new record.
**Copy: **A SysAdmin can copy a records by selecting the copy option. A popup window will appear helping the user with the fields copied to create new record.
**Delete:** A SysAdmin can delete a record by selecting the delete option. A confirmation prompt will display to confirm the deletion of the record.
**Edit: **A SysAdmin can edit a record by selecing the Edit option.
**Save: **Once the record is saved in the grid user will be notified with a message showing the save successful along with the title of grid as below.
User will be prompted an error message if the record already exists in the database with the same unique key as below.
### > Macro (anchor)
Searching & Filtering
Assay Manager allows users to search and filter the columns in the grid. User can search values in the filter row column as shown below. It will filter the grid with the searched value.
Users can reset the filter by clicking on reset option as shown below.
The foreign key columns will have dropdown in the filter allowing the users to filter amongst the list. By default All is selected. Users can clear the filter by clicking on the cross icon. The Users can navigate through the grid record by selecting the paging options at bottom of grids.
Users can sort the grid ascending or descending by clicking on the column heading as shown below. In order to refresh the grid user can close and open on the title.
**Refresh**
In order to refresh the grid manually user have to click on grid title to close the grid and open again to get the refreshed data in the grid.
## > Macro (anchor)
Download Batch List
Download Batch List button is available for the user once clicked on Apply after selecting the filters. It will download the filtered data from the Batch List in the excel format.
## > Macro (anchor)
Process Batches
Process batches button is available for the users once clicked on Apply after selecting the filters. When clicked on process batches button it will open a popup with list of procedures enabling the user to know which procedures will run for the batches available in the Batch List grid. The procedures will after the other. When running the stored procedures display a status, and allow the process to be cancelled by the user. The process batches will run the incoming data driver and retry merge procedures to process any records existing in the unmerged Assay Results, runs the QC Checker procedure if the batch status is not Unmerged and runs the re-ranking procedure if the batch status is Accepted. The status will be updated as below
Processing incoming data driver
Processing retry merge
Processing QC Rules
Processing Re-Rank
Completed
On close it will refresh all the components.
If there is any error while running the procedures it will display the error message in red colour and will continue running the other procedures as below.
