--- title: "v2.3.4 Administrators Guide" canonical: "https://servicedesk.maxgeo.com/space/DS/1253867693/v2.3.4%20Administrators%20Guide" format: markdown --- TABLE OF CONTENTS > Macro (toc) # > Macro (anchor) Introduction The DataShed5 system allows users to view, visualise and download data from one or more DataShed databases. It is a browser-based application in two parts: the main DataShed5 application and the DataShed5Admin administration utility. The DataShed5Admin utility provides the ability to edit the DataShed5 configuration details that are stored in the DataShed5Admin SQL Server database. DataShed5 uses these details to enable authorised users to access supported MDS (DataShed) databases. This document describes the concepts encapsulated within the DataShed5Admin database, and the recommended procedures to set up and maintain the DataShed5Admin database for use with one or more MDS (DataShed) databases ![image](media://53b48ba6-8fe6-442e-9ad8-af3c16b6fb3a) # > Macro (anchor) Installation and Initial Setup > Macro (anchor) The installation and setup of DataShed5Admin is covered in detail in the DataShed5 Installation Guide. A summary is included here, for full details consult the Installation Guide. ## > Macro (anchor) Installation For most installations, the DataShed5Admin database is usually created by restoring a copy of the ‘blank’ or template database from the database backup supplied with the installation materials. If necessary, a new database can be created from SQL Scripts. The database can be restored with any name, however where possible it should be named ‘DataShedAdmin’. In installations with multiple concurrent versions or installations of DataShed5 in use, it is possible to install them all on a single SQL Server instance, as long as a unique name is used for each DataShed5Admin database. Care must be taken with each DataShed5 installation to ensure that it refers to the correct DataShed5Admin database for the installation. ## > Macro (anchor) DataShed5Admin Initial Setup After the DataShed5Admin database has been restored, there are some initial steps that must be taken to set it up before DataShed5 can be used. The following steps are required for initial setup: - Run DataShed5Admin and login using the following credentials: - Email WebShedAdmin@maxgeo.com - Password WebShed123 - Select **Applications** menu - Select DataShed5, click Edit - enter the DataShed5 URL or IP address - Select DataShed5Admin, click Edit - enter the DataShed5Admin URL or IP address - Select LogChiefLite, click Edit - enter the LogChiefLite URL or IP address ![image](media://b1b91908-65a4-4b70-916c-1c88f7fd3b22) - Select **Companies** menu, then click +Company and add a company record - Ensure the Company is marked as Active - Ensure the Company Id is set with the correct Id - Company Form Logo – (dimensions: 180 x 50 pixels). To include your company logo on forms within the DataShed5 application, select Browse and upload the appropriate image file - Company Report Logo – (dimensions: 190 x 50 pixels). To include your company logo on reports generated from DataShed5, select Browse and upload the appropriate image file - Select **Edit** **SMTP**: select setting option at top right hand side - Click the ‘Edit SMTP’ button next to the Administrator name at the top-right - Enter the SMTP details in the pop-up screen and click ‘Save’. Check with your email administrator for the correct values to enter in this screen ![image](media://adc16af1-f715-407b-81d1-0fa0b22b531f) If your email server does not require authentication, leave the user name and password fields blank. - Select **Users** menu to configure a new DataShed5 Administrator - Click +User, add details for the new administrator, and click ‘Save’ - Click +UserRole and add following user-role records for the new user - SuperUser role: to all for the Datashed5 administrator, a SuperUser can perform - Administrator role: to allow login to the DataShed5Admin application - WSA_EmailNotification role for the application DataShed5Admin (this role enables emails to be sent to this user when people register to use DataShed5) - Select **Database** menu to licence and activate an MDS database - Select +Database and add a record for the MDS database and Save. - From the Database List, select the Licence action to licence your MDs database.Licence the database by entering the Licence Key provided by Maxwell. The database must be licenced and flagged as Valid in order for access to be enabled. - Configure database - Select Databases menu and select **Database_Template** details - Select Map tab and copy the map to new database. - Select Map View tab and copy each required Map View to new database - Select Report Groups tab, copy required Report Groups and Reports to new database - Select Dashboard Groups tab and copy required Dashboard Groups and dashboards to new database - Add Administrator user membership to database - Select Memberships menu - Select +Membership and add record for administrator user and database. - Select Membership Details and ensure Projects/Datasets, Modules, User Groups, Reports and Dashboards have been assigned to User. - Select Security level tab and select the security level required. - Using SQL Server Management Studio, review the following map view definitions in the MDS database. These views are initially set up for commodity gold, this can be changed to other elements if required by altering these view definitions appropriately. - tblVWWSDHIntercepts - tblVWWSDHMaxAu_Current - tblVWWSPTMaxAssays_Current - tblVWWSXRFResults - *For ****Maxwell Hosted Client databases only*** the following is also required. Please ignore for on-premise installations. - Select **Companies** menu, select each Company and select **Edit** Action ensure the following are entered: - Full Company Name - Company Address - Company Phone Number - Contact Person - Contract Person Title - Contact Person Email - Company Name Jira – this *must* match the JIRA name. - Company Id – this must match the Timesheet Company Id. - Select **Databases** menu, for each hosted Client Database, select **Edit** Action and then select the **Memberships** tab. For each database ensure that one maxgeo member has been assigned the Membership Type of ‘**DBA**’. This person will receive generated hosted client monthly reports. - All other Users should be assigned the **Membership** **Type** of ‘**NR’** ![image](media://06e17fd7-4861-4565-8625-5b5e336930ba) # > Macro (anchor) DataShed5 Admin Concepts Both DataShed5Admin and DataShed5 require that several components are defined prior to using the system. The details of each of the Applications must be updated to match the specific implementation. There must be at least one Company defined, and at least one Database licensed for that Company. Report and Dashboard groups must be copied to the new database. Users must be created and assigned roles that define their access privilege level. Finally, users are granted membership to a database and allocated access to components that they can access within DataShed5. ## > Macro (anchor) Data Pages Data is presented on most pages as a list of objects of a particular type. For example, click the ‘Users’ item on the left-side of the page to see a list of Users. ![image](media://429bddf0-df2d-4be6-aeb9-4a771e617013) The ‘Display Row Size’ allows the user to change the number of rows displayed on each page. The size can be set to 5, 10, 25, 50, or 100 rows, the default is 10 rows. Changing the option will immediately refresh the page with the newly selected number of rows. The data in these pages are ordered by the values in the first column. The user can select to change the order by clicking on a column heading that is coloured blue (see ‘User Name’, Email’, ‘Company’ columns in the example above) to order by that column instead. Clicking again on the same column will reverse the order. The user can quickly find data matching a particular pattern by entering a few characters in the ‘Search By …’ box and clicking the ‘Search’ button (or hit the ‘Enter’ key). Only records that contain these characters will be displayed. Note that the search function will search only within the first column of data. Clearing the search box and clicking the search button will refresh the list with no filtering. At the bottom of the page is a row of page numbers, these allow the user to jump to a particular page by clicking the page number. There may also be buttons for First Page ![image](media://b07cc339-00d7-489b-b5cb-76056bae0f90) , Previous Page ![image](media://e98b93ca-5d03-4bbc-bff2-a4127a71d4bf) , Next Page ![image](media://259bde08-0adc-4fb9-a9a0-08f15032f33d) , and Last Page ![image](media://f9709731-9fa8-4d80-b07a-ead71ac7dbd1) , these buttons may be hidden if they are not required. In the example above, the ‘Next Page’ button is shown; the ‘First Page’ button is hidden because the ‘1’ is visible, the ‘Previous Page’ is hidden because the view is currently on page 1, and the ‘Last Page’ button is hidden because the last page number (2) is already visible. ## > Macro (anchor) Manipulating Data After logging in to DataShedAdmin, a number of different data items are listed on the left side of the screen. Selecting one of these items displays a list of items for that data type. At the top of the screen is a green ‘+Object’ (e.g. +User, +Company, etc.) button, clicking that button allows the operator to create a new entry for the current object type. Below that is a list of entries for the current object type. At the right side of each list entry is a ‘Details’ button, and often an ‘Edit’ and a ‘Delete’ button. The ‘Details’ ![image](media://c1e4efa8-d102-4f67-aac3-271c9a7619d1) button shows additional information about the selected object, whilst ‘Edit’ ![image](media://ed9fe2fa-8c1d-47a2-bbf2-3f7f7274fbeb) allows that some of the information for the select object to be modified. The ‘Delete’ ![image](media://c3cf76e4-304d-4066-9976-86a8dfe79685) button will remove the object, as long as there are no other dependent objects. Some objects also have a ‘Copy’ ![image](media://bc24c363-5bf8-439a-a8be-d828a19aacbc) button, allowing the object configuration to be copied to another object in the same database, or potentially in a different database. If the user clicks the ‘Edit’ button, another page is displayed that allows some or all of the object attributes to be modified. The user must click ‘Save’ to save the changes, clicking ‘Back to List’ will cancel the modifications and return the previous list. # > Macro (anchor) DataShed 5 Administration Basics ## > Macro (anchor) Overview The DataShed5Admin application shows a list of menu item options at the left side of the page. These items are Users, User Roles, Memberships, Databases, Companies, and Outage. Clicking on one of these items allows the user to modify objects of the selected type. After the initial application installation, the ‘Companies’ and ‘Databases’ tabs will be used to create a company record and configure a database for DataShed5. Following this, DataShed5 administration mostly consists of adding and updating users and user memberships and configuring user membership details and access to data within databases. ## > Macro (anchor) Users Users are individuals who will log in to the DataShed5 (or DataShedAdmin) system to perform tasks. In some installations, users connect indirectly using the DataShed5 Service to log in and synchronise data from LogChief. Each User is identified by an email address, that email address is associated with a user name (typically their Windows username) and a password. The password is not directly stored in the database, only a hash of the password is stored. User records can be created in this section, they can also be created by users self-registering on the DataShed5 login page. Users cannot access DataShed 5 until they have been assigned membership to a database. DataShed5 administrators are responsible for all aspects of user management, including adding or authorising new users, managing user memberships and access, and deleting users who no longer require access to the system. ## > Macro (anchor) UserRoles UserRoles is a list of roles that have been assigned to users – it shows an entry for each role that has been assigned to each user. Adding or removing role assignments can be done here, or from the Details list for a user under the Users section. The current roles include Administrator: allows a user access to login to the DataShed5Admin application WSA_EmailNotification: a user with this role will be sent notifications emails for new user registrations, and errors that may occur from the MXAutodownloader scheduling application. WSServiceConsumer: a user with this role will have access to use the MXSync tool to synchronise data to an MDS database they have been granted membership to. SuperUser: a user with this role assigned will also see entries for ‘Reports’, ‘Dashboards’, ‘Applications’, and ‘Roles’. ## > Macro (anchor) Membership The Membership entries allow users to access a database, users can only see databases for which they have been granted membership. Membership details allows the Administrator to further specify which components within that database that the user can see. Memberships can be copied from one user to another, which includes access to Modules, Datasets, Dashboards, and Reports. Most members will be given a Membership Type of ‘NR’. For maxgeo Hosted Client database administrators should be assigned a Membership Type of ‘DBA’ to ensure they receive emails for their assigned databases. See the ‘[Configure User Memberships](#Configure_User_Memberships)’ and ‘[Configure Membership Detail](#Configure_Membership_Detail)’ sections for more information. ## > Macro (anchor) Databases Each database that DataShed5 will access must be defined in the DataShed5Admin database. Each database is given a name and is linked to a previously defined Company. DataShed5Admin is also given the name or address of the SQL Server Instance, which includes both the host server name and an Instance Name (if required). Finally, the name of the database on that SQL Server instance is selected. After creating the database entry, the database must be licensed before it can be used by DataShed5. Clicking on the ‘licence’ link in the databases list opens a form that shows the database name, company name, SQL Server details, along with a Machine GUID or URL and an MDS_DBid. The URL and MDS_DBid are used by Maxwell GeoServices to generate a license file. This license file can then be attached to this form and uploaded in order to license the database. Clicking the ‘licence’ ![image](media://617236ed-384f-402b-ad6a-d6faf67424c4) link on an already-licensed database shows a license key, and a license expiry date, and allows upload of a new license file for the current database. ### Template Database A database called ‘Database_Template’ is supplied with DataShedAdmin. This object does not correspond to a physical database, it is present to provide a source for reports, dashboards, and other objects that can be copied from this template to user-defined databases. See the ‘Configure MDS Database’ section for more information about copying objects from the Template. ## > Macro (anchor) Companies DataShed5 can be installed at a client site that will access only databases that are owned by that company. In this case only a single company record is required. DataShed5 could also be installed in a hosting situation, where multiple database for several companies share the same DataShed5 installation. In this scenario each Company must be defined to DataShed5Admin. Company details include the company name, description, and two logo files to appear on screen and on printed reports. ## > Macro (anchor) Outage DataShed5 is designed to be a live, online system providing web-based access to information on a 24/7 basis. However, there are times when the system must be taken offline in order to allow for system maintenance or upgrades. The ‘Outage’ page allows Administrators to add one or more records describing planned downtime, including the date and time of the start and end of the outage, the database affected, and a message to show users. Any time that users login during the period of ‘x’ days prior to the outage (x is defined by the Administrator) they will be given a notification to inform or remind them of the upcoming system outage. ## > Macro (anchor) Online Users DataShed5 admin is capable of listing users those are currently logged in and using current license. This is menu item available for Super user role. It lists details like user name, email, application name and duration of login. Super user has ability to remotely logoff user by clicking on provided button on screen, except super user himself. ![image](media://b9a4df64-6fe2-4543-a078-ad2643c88638) ## > Macro (anchor) Reports All DataShed5 reports are listed in the Reports section. Each report is given a name, a description, and a sort order. Additionally, a ‘Default Date Selection’ entry is recorded for each report, which enables reports to have their date parameters default to Year-To-Date, Month-To-Date, Last-Week, etc. When the report is run the dates are pre-populated according to the default. The Report names and descriptions are defined here, but the report parameters, content, and layout are not. Those are defined within a DataShed5 code library stored on the Web Server. The name stored in the reports list is used to reference a report of the same name in the report code library. If Reports are of type Power BI, then we need to check Is Power BI Report checkbox and add Power BI Report Link as below. ![image](media://ce89f049-a37e-4a8d-a2fd-182523f3a40f) ## > Macro (anchor) Dashboards All dashboards are defined in this section, with a Dashboard name and description. A number can also be entered in the sort order column to define the order that dashboard names appear in the menu. Dashboard names are defined here, but the dashboard content and layout are not. The dashboard content, parameters, layout, etc. are defined within the DataShed5 code stored on the Web Server. ## > Macro (anchor) Applications The applications DataShed5, DataShedAdmin, WSService, and LogChiefLite are defined in the applications group. These are pre-defined in the DataShed5Admin database, but must be updated to configure the URL entries to point to the correct URL for the application. These URLS are used as part of the licencing details, and also as links within the DataShed5 application. ## > Macro (anchor) Roles Roles are pre-defined in the DataShed5Admin database, these are application-based roles that define behaviours in DataShed5. These roles are NOT used to determine which users will have access to particular data or modules within a particular database – User Groups are used for this purpose. In general, the supplied base roles should be sufficient, additional roles should not be required. ## > Macro (anchor) Two-factor Authentication(2FA) Two Factor Authentication, or 2FA, is an extra layer of protection used to ensure the security of online accounts beyond just a username and password. DataShed5 has ability to send verification code to user’s email account which user needs to enter in application which makes sure that only authenticated user is logged in. ![image](media://5e479b5a-e23f-40c4-807a-b686a225e388) ![image](media://d4d2ae61-1181-4a4b-93e6-c4014d5c3998) # > Macro (anchor) Adding MDS Databases After the DataShed5Admin database has been restored and configured, one or more MDS databases can be added for DataShed5 users to access. MDS database versions 4.6.5 and above are supported. The MDS database must be configured for use with DataShed5, there are a number of SQL scripts that will create database objects and assign privileges as required for access by DataShed5. More information about this process can be found in the Installation Guide. To add a new database to the DataShed5 system, perform the following steps: 1. Log in to DataShedAdmin 2. Click ‘**Companies**’ 3. Ensure that the correct company entry is present. 1. If it is not present, click ‘+Company’ ![image](media://f908a6c4-fb55-45c0-b51a-71234d5ecea9) 1. Enter the new company information. 2. Upload the company logos if available, these can be added or updated later if required. Ensure the form logo dimensions are 220 x 50 pixels, and report logo dimensions are 200 x 35 pixels. 3. For *maxgeo hosted client databases*, ensure the required company contact and JIRA details are entered ![image](media://4ed17fe9-0723-4d0d-84b4-ae6fc764def6) Click ‘Save’ to save the new company information. 1. Click ‘**Databases**’, click ‘+Database’ to add a new database 1. Enter a name for the new database ![image](media://ecca8cb0-98f9-41c3-8fa5-f8cedfd00792) 1. Select the correct company from the list 2. Choose ‘DataShed5’ from the Application list 3. Check the ‘Valid’ checkbox 4. Enter the SQL Server name or IP address (followed by \INSTANCE if required) 5. DataShed5 will immediately connect to the SQL instance and populate the SQL Database list. Select the correct SQL database name from the list. 6. Click ‘Save’ to save the database information 1. The Database entry is now present, but the database must be licensed before it can be used. 1. On the database list screen, click the Licence button to view the licence screen ![image](media://a0012f03-26df-4b37-b038-3403e1c78103) Enter the **Licence Key** provided by maxgeo. ![image](media://850e6a07-83cf-42fe-8731-e884706a3fd5) 1. Click ‘Check Licence Key’ to verify that the Licence Key entered is valid. 2. Click ‘Save’. The Licence Key will be activated and saved with the database. If the MDS_DBid or URL does not match, or the Expiry Date associated with the license has elapsed, DataShed5Admin will show an error message. If no error message is returned, the database is now licenced. 3. Clicking on the ‘Licence’ button on an already licenced database will show the licence information for the database, including number of licenced users and the licence expiry date. You can update the licence information by entering a new, un-activated Licence Key, or by clicking the ‘Request Licence’ button. Please see the **Request a Licence** section for more information (this section explains the process for the LogChief Lite application, but it is exactly the same for DataShed 5). ![image](media://1b4ead2a-4dc9-4292-a351-c43db9a9308d) # > Macro (anchor) MDS Database Configuration After a new MDS database has been added to DataShed5 and successfully licensed, there is some more administration required before the database can be used. Maps, reports and dashboards must be added to the database, and made available to various user roles within the database. Users must also be granted access (‘membership’) to the database. ## > Macro (anchor) Configure Maps / Report Groups / Dashboards 1. Copy Map to Database 1. Select ‘Databases’ from menu ![image](media://af1cd9f2-b013-4338-aa50-2c049d645c78) 1. Find ‘Database_Template’, click ‘Details’ button 2. Select ‘Map’ tab. ![image](media://4d0c3d1c-fd24-421e-ac14-3d0b3abd789e) Click the ‘Copy’ ![image](media://05f856cb-8709-4d23-be72-d3a741ff1ed8) button to copy one of the Map entries to the new database. Note that a map layer must be present to view any map, even if the map layer does not contain the location of the data stored in the database. ![image](media://9ee108be-833e-4fd2-aa51-dcf5302bae99) Select the target database from the pull-down list, make any necessary changes to the map definition (usually none) and click ‘Save’. The Map, and an associated Map Set, will be copied to the target database. 1. Copy Map Views to Database 1. Select Database_Template details (see 1a, 1b above) 2. Select the ‘Map Views’ tab 3. Click the ‘Copy’ button next to a Map View ![image](media://18c4538a-f966-479e-9663-b2b7be3bf2ad) Select the target database from the ‘Copy To Database’ drop-down list ![image](media://4d14b1e5-ff71-4be6-b624-f4a98c5db259) 1. Make any other required modifications to the Map View. Maps generally require no changes at all, however sometimes there are changes to labels required (e.g. change ‘Au’ to another element in example above), and some maps require additional value/symbol/colour entries to be added for the relevant map type. 2. Click ‘Save’ to save the Map View definition in the target database 3. Repeat for other required Map Views. 1. Copy Report Groups 1. Select Database_Template details (see 1a, 1b above) 2. Select the ‘Report Groups’ tab ![image](media://8e0c8223-79d8-426e-a06a-2d304c0b3e51) 1. Click the ‘Copy’ button next to a report group 2. Select the target database (see ‘1’ below) ![image](media://06729731-6084-44cb-8809-4e31c3a6cc53) 1. Check the check box (see ‘2’ in above figure) next to the DataShed user groups that should have access to this report group. Note that the available groups may be different for each database. 2. Click ‘Copy Report Group’ (see ‘3’ in above figure) to copy the report group to the target database and enable it for the selected user groups. 3. Repeat for other required report groups. 1. Copy Dashboard Groups 1. Select Database_Template details (see 1a, 1b above) 2. Select the ‘Dashboard Groups’ tab 3. Click the ‘Copy’ button next to a dashboard group ![image](media://130c8662-a22f-4734-9395-93ed0154f58c) Select the target database (see ‘1’ below) ![image](media://b26e43d2-dcf3-44a2-be3b-3cc60f0c7e26) 1. Check the check box (see ‘2’ in above figure) next to the DataShed user groups that should have access to this dashboard group. Note that the available groups may be different for each database. 2. Click ‘Copy Dashboard Group’ (see ‘3’ in above figure) to copy the dashboard group to the target database and enable it for the selected user groups. 3. Repeat for other required dashboard groups. # > Macro (anchor) Database Application Licences With the addition of the new Log Chief Lite application, the licensing process has been extended to enable Log Chief Lite, and future applications, to be licensed on a per database, per application basis. ## > Macro (anchor) Configure Application Licence 1. To configure an Application Licence for the Database 1. Select ‘Databases’ from the menu ![image](media://5411b97e-7015-42ee-9f7f-fa8577b45f60) 1. Click the ‘Application Licences’ button to view the Database Applications Licence screen. 2. Click ‘+App Licence’ to view the Add Application Licence screen. ![image](media://5f382ad4-b36f-4525-a3b2-a95d969d121d) Select your Application (LogChiefLite) from the Applications drop-down menu. If you have NOT been provided with a Licence Key from maxgeo, please refer to the **Request a Licence** section on the next page. If you have, enter the provided **Licence Key**. ![image](media://b22f5559-0d4b-4d3f-a777-4b8d15228e70) 1. Click ‘Check Licence Key’ to verify that the Licence Key entered is valid. 2. Click ‘Save’. The Licence Key will be activated and saved with the Application, and it will now be licenced. 3. Clicking on the ‘Licence’ button on an already licenced database will show the licence information for the database, including number of licenced users and the licence expiry date. You can update the licence information by entering a new, un-activated Licence Key, or by clicking the ‘Request Licence’ button. Please see the **Request a Licence** section for more information. ## > Macro (anchor) Request a Licence 1. To request a new Application Licence, or update an existing Licence for the Database: 1. Click the ‘Request Licence’ button. This will direct your browser to the maxgeo licensing portal. ![image](media://ca557b6c-5ebf-4702-82fc-7e5de160e5b9) 1. Complete the Licence request by entering the required No. of Users, and any optional Customer Reference text. Click Submit Request. 2. If this is the first time you have made a Licence Request for an unlicensed or expired application, you will receive a short-term licence key (which expires in 7 days) for you to use immediately. ![image](media://caad0ede-cb80-4557-a894-4f02a311199b) Click ‘Go Back’ to be redirected to Datashed5. For *maxgeo hosted client databases*, the licence will be applied automatically to your database. For *on-premise installations*, enter the new provided **Licence Key** and click Save. ![image](media://f32cfb9e-5206-48ec-916d-c6cdfc50a25a) 1. If you are updating the Licence Request, or you are making a request for an active Licence (for example, requesting more users), you will be redirected to DataShed5 automatically with no changes being made. 2. Clicking the ‘Edit’ button will show the licence information for the application, including number of licenced users and the licence expiry date. You can update the licence information by entering a new, un-activated Licence Key, or by clicking the ‘Request Licence’ button and repeating the process outlined above. ![image](media://a63f7dd8-0b46-4f6a-83c5-db30a8784020) 1. You may receive the following error codes after clicking the ‘Request Licence’ button. These must be corrected before you can successfully request a licence : 1. 1003 – The Company Licence ID is invalid. 2. 1004 – The MDS DB ID is invalid. 3. 1005 – The Application name is invalid. ## > Macro (anchor) Manage Application Licence Users 1. Application Licences differ from the DataShed5 licence in that users must be explicitly added to the licence itself. To add users to an Application Licence 1. From the Database Applications Licence screen, click the ‘User List’ button to view the Database Application User Licence screen. 2. Click ‘+User’ to view the Add Application Licence screen. ![image](media://152adb6f-d6c6-4629-b844-340edc7f2ca5) Select a User from the Users drop-down menu (for a user to appear in this list, they must have database membership, and the required application role). Click ‘Save’ to add this user to the Licence. ![image](media://c99ca9b6-522d-466c-92d5-15829ab26df6) Repeat this process to add more users to the application Licence. When the No. Of Users allowed for the Licence has been reached, the ‘+User’ button will be disabled. To enable this button, you must remove at least one user from the Licence. To do so, click the ‘Delete’ button. This user will be removed from the Licence, and the ‘+User’ button will be re-enabled. ![image](media://ada5f679-b7ad-427f-8f65-1e4f428817d0) # > Macro (anchor) Manage Database Details Once an MDS database has been added to DataShed5 and has been correctly configured, there can be some ongoing maintenance and management tasks required from time to time. Such tasks include adding new projects and datasets, defining new or modifying existing user groups, adding subscriptions, and managing user memberships. Database details are accessed by going to the ‘Databases’ list, and clicking the ‘Details’ button at the right-side of the database entry. ### Projects The Projects tab shows all of the Projects and DataSets defined in the current database. The left side of the windows shows a list of defined regions and countries, and to the right of that list is a list of projects and datasets. Clicking a region/country will show only those projects/datasets that have been linked to that region/country. If a region or country is selected, a ‘Show All’ button will appear, clicking this button will cause the entire list of projects and datasets to be displayed. ![image](media://d69a2f78-977d-44a3-9e44-34a6260cf5f4) Click on a project or dataset to show the details for the selected item. You may be able to modify some of this information, some details (e.g. DataSet Code) cannot be updated after other data is added to the database linked to this information. The mouse pointer will change to a ‘block’ ![image](media://640ac76c-3ed1-48d7-9dc7-3f2eefadf464) icon in fields that cannot be modified. Click ‘Save’ to save changes. ![image](media://f676b53f-ea6d-454a-ba42-3574f2182fe7) *View/Edit details for ‘Australasia’ project* Click the ‘Assign’ button (projects only) to grant access to the new project to one or more users. Check the check boxes next to the users to be granted access. The ‘+Project or DataSet’ button allows a new project or dataset to be added to the database. Select the category (project / dataset) for the new record, choose a region and country (for projects only), parent project (if applicable), and enter a name, code and description for the new item. Click ‘Save’ to save the new item. ![image](media://d538f9a2-7093-4de3-be6c-f71f523209d5) *Add new Project or DataSet* ### User Group A ‘User Group’ is an object that can be assigned access to Modules, Reporting Groups, and Dashboard Groups. Any users that are assigned as members of the user group will automatically gain access to any resources that have been granted to the group. The ‘User Group’ tab lets the administrator view, edit and create User Groups in the selected database. A list of existing user groups is shown, clicking on a group will show a list of modules assigned to the user group (‘User Modules’) and also show a list of all available modules. Modules can be turned on or off for the selected group by checking / unchecking the relevant check box. ![image](media://e70d022c-eddc-4b69-b3f0-1fd2b180326d) *View/Edit ‘System Administrators’ User Group* When changes are made to modules available to a user group, any users that have been assigned as members of that group will immediately gain or lose access to those modules, unless they have been granted access through multiple group memberships, or directly granted access to those modules. ### Module A ‘Module’ is a logical collection of tables, usually modules are related to tasks or job roles but can also be a grouping of related tables, or an arbitrary collection. The ‘Module’ tab shows a list of all modules defined in the database. Clicking a module shows the tables that have been linked to that module, and allows tables to be removed from the list as well as a table or view can be configured as a read-only mode. ![image](media://71e61659-5dab-4b83-9fc6-15098f0915a0) *View/Edit ‘Activity Log Management’ Module* ### Table Data in tables and views in the MDS database are only visible to users in DataShed5 (and DataShed) after they have been ‘registered’ in the system and also added to a module to which the user has been granted access. The ‘Table’ tab allows the administrator to register or unregister database tables and views in the MDS database. Registration of tables is necessary to assist DataShed5/DataShed with identifying the nature of the information in the table. Tables are registered with an object class that identifies the data as collar data, downhole data, point data, assay data, or library data. ![image](media://b8eca583-fe8f-4eec-8e17-5981f31aae93) The ‘+Table’ button allows a new table definition to be added. Enter a table name and display name, choose the object class from the list, then select the Table/View object from the list. ![image](media://3d1b15a3-8907-479f-947d-a4cdafe10fc4) ![image](media://a49a79ee-976e-4ffb-bf49-8ef9b222bd0a) #### Imago access A link to your Imago images can be provided from DataShed5 when it is enabled here. To enable this feature, the table or view must contain at a minimum a column for the HoleID, and optionally any of the following columns: DataSet, Depth, Project. Check the “Imago Access?” checkbox, and select the mapped columns for HoleID and any of the other three optional columns. **Note***: you will need a valid Imago licence and login to use this feature in DataShed5.* Once a table has been added it will appear in the list of Unregistered tables. Unregistered tables can have their registration properties edited, copied, or deleted. The status of a table can be updated from unregistered to registered by selecting the table (check the check box) and then clicking the ‘Register’ button. Tables and views that have already been registered can be unregistered by selecting them from the list of registered tables, then clicking the ‘UnRegister’ button. Unregistering a table will unlink it from any modules to which it has been linked. Registered table definitions can be duplicated by clicking the Copy’ ![image](media://b031e6c9-7de4-44f6-9987-2d578b10f543) button next to an existing registered object, and entering a new table name, and optionally a new display name. Only *registered* tables and views that have been assigned to a user will be visible in DataShed5 ### Map / Map Sets The ‘Map’ and ‘Map Sets’ tabs will show the maps and map sets that have been linked to the current database. Although the details for these items can be edited here, or the map removed, there is usually no reason to do so. Maps and Map Sets cannot be created from these screens, they are copied from pre-defined objects stored in the Database_Template database. Map Sets cannot be directly deleted, deleting a map will also delete any associated map set. ### Map Views Map Views correspond to the items available in the ‘View Map’ menu in DataShed5. Map views define a database table or view to use as a source of data, that data is used to display points on the map. ![image](media://5ce94aaf-42de-42ea-8b44-c318da271fbc) Each map view definition describes which columns in the source table/view to use for point co-ordinates (latitude/longitude), the column to be used for the value to be plotted (‘series’), and several values that the ‘series’ column might contain and an associated symbol and colour to be displayed on the map for that value. The base map views are usually copied from the Database_Template database when the MDS database is first configured, however they may need modification for various reasons. Examples include modification to display elements other than gold, intercept value ranges, and defining the common hole types drilled for this company. ### Map Views / Heatmap Configuration Map Views Heatmap items available in the ‘View Map’ menu in DataShed5. Heatmap configuration available on CreateMapTable or EditMapTable. Heatmap functions works based on ‘tblVWWSPTMaxAssays_Current’ in MDS and user can create or modification with their requirement. In this configuration, allowed to define element column as below. After selected Heatmap column need to specify value limit for specific selected element with colour. ![image](media://d912a691-707b-4675-9122-36fb4ab21805) ### Report Groups / Dashboard Groups The Report Groups and Dashboard Groups tabs allow the administrator to view, add, edit and remove Report Groups and Dashboard Groups, as well as define the reports or dashboards that belong to the group, and the User Groups that may have access to the group. ![image](media://c47a2e69-b64c-435e-a2ad-e536c57b9c03) Editing a group allows the administrator to change the contents of the group and modify the group name. Deleting a group removes access to the items in that group from a particular user group. Note that the user group may still have access to some or all of the items through other report/dashboard groups, some users may have access through other user groups. ![image](media://f51e8674-c291-4335-99dc-6c16634a4c32) These tabs provide a means to define who has access to which reports, the reports and dashboards themselves are not defined here. ### Download Subscription From the download subscription tab the administrator can add, edit and remove subscriptions. Subscriptions are requests for reports or data exports that are processed at regular intervals (usually daily) by an external subscription engine. The ‘+Subscription’ button allows creation of a new subscription definition. Select the source type (Report, Layout, Scheme, or Table) and then the source. The available sources will depend on the selected source type. User can filter source type by dropdown search function. Next, select a file type for the subscription – again, the available file types will depend on the source type. ![image](media://a1996289-410d-4a56-befc-1dc8a2ede663) Enter a subscription name, select the start/end date and frequency of the new subscription, and select a subscription type. The available subscription types are ‘Email’ and ‘File’. Selecting ‘email’ will deliver the subscription output to the selected recipients as an email attachment. Selecting ‘file’ will store the file in the selected file path, the selected path is relative to the server that runs the subscription requests (commonly the web server). Usually the path would be a location that is visible to (shared with) the relevant users. ![image](media://83e0da44-d9d9-42dd-9fb1-86ff2688daf7) Some subscriptions may require parameters. Subscriptions that run reports will need the same parameters supplied for the report that you would normally supply if you were running the report interactively. Subscriptions that generate data can have filtering criteria supplied as a subscription parameter. From the subscription page, click the ‘Add/Edit Parameters’ button (same ![image](media://c23cf6d3-2dbc-46e5-bd8c-d14582231786) icon as ‘Details’ on some other pages). This shows a page that lists all of the parameters for the current subscription, and allows the administrator to add, edit or remove parameters as required. ![image](media://601c1ddf-7ea2-4b3a-929a-079f818a28ee) When adding parameters for a report subscription, the ‘Subscription parameter’ page will show a list of parameters that are available for the report in the ‘Parameter Criteria’ field. The parameter type is one of ‘DatePeriod’, ‘SQL’, or ‘Value’. ‘DatePeriod’ parameters allow selection of a date range such as ‘Year to Date’, ‘Last Month’, ‘Last Week’, etc. ‘DataSet’ parameters allow one or more ‘DataSets’ (separated by comma), this functionality is dependent on the multi select function in report. E.g. Assay summary report. The ‘SQL’ parameter type expects part of a SQL statement, and ‘Value’ expects a single value. ![image](media://a7a6bc53-8d8a-49b7-8e93-f72af7dbd9c5) *Add Subscription parameter – Report Subscription* When adding parameters for a data subscription, the ‘Subscription parameter’ page will show a screen similar to that used to create cascade filters in DataShed 5. The Administrator can select a column, a comparison operator and operand values and add the criteria to the filter. Additional criteria can be added to the filter if required. ![image](media://cba6eb03-26e4-420d-8ac4-24130fa275b3) *Add Subscription parameter – Data Subscription* ### Subscription Monitor The Subscription Monitor allows the administrator to examine the execution status of each of the Download Subscriptions defined for the database. ![image](media://31649eaf-3980-4791-a146-4899a75beae2) The subscription monitor is a display-only screen, monitor entries cannot be edited or deleted. ### Memberships The memberships tab shows a list of users that have membership to the current database. The Membership Type of ‘DBA’ is only used for maxgeo Hosted Client Database Administrators to ensure they receive externally generated reports for their assigned databases. All other members have a Membership Type of ‘NR’. Users that have membership are allowed to access data in this database. From this tab the administrator can add or remove memberships and change the membership details for users. See the ‘Configure User Memberships’ and ‘Configure Membership Detail’ sections for more information. ### Planned Outage From time to time a DataShed5 system may become unavailable to users. Occasionally this is unplanned, but most occasions will be planned ahead of time. The ‘Planned Outage’ tab allows the administrator to enter the details of the planned outage, and DataShed5 users will be automatically notified of the impending outage when they log on to the specified database, by a notification message similar to the following: ![image](media://5b8c61d3-7bbc-4b9b-b8ee-fa0713893750) The ‘Planned Outage’ item in the database details is identical to the ‘Outage’ top-level item, however it will only warn users logging in to the current database, whereas entering the outage details at the top level will warn users logging in to all databases on this DataShed5 installation. Click ‘+Planned Outage’ to add a new outage notification entry and complete the outage details. ![image](media://0daead10-234f-4597-950a-b2b6f5b75064) Note that adding an outage entry does not stop or start the system, nor does it prevent users from logging in to the database. It only provides a method of notifying DataShed5 users. Administrators must still stop and start the system through the regular means. ![image](media://d3fa0708-0e9d-41c5-8356-9fa5c139621a) The planned outage notification details can be removed by clicking the Delete ![image](media://5e5bd0d7-f81d-4f11-9a6b-1126b32ade55) button. When the system is returned to an online state, the outage can be marked as completed by clicking the ‘Outage Complete’ ![image](media://4d8c6b0a-580e-4edc-937e-e18a27e386ae) button. This can be done before the previously saved end-time. After being marked as complete, the outage details will remain in the list, and cannot be deleted. ### Email Tasks The email tasks tab is used by maxgeo for data loading processes for hosted client databases only. # > Macro (anchor) User Memberships and Membership Details Users can be created by the Administrator using the ‘Users’ item, new users can also register themselves from the DataShed5 login screen. Users will not have access to any information in DataShed5 until they have been granted membership to a database, and also have their membership details configured to allow membership of a User Group and access to Projects Users will display in red in the User List until their configuration has been completed. The user password can be reset from the User List using the Reset Password icon. ![image](media://b2de626a-4af3-4f48-bcfd-1ce9e862ac30) ## > Macro (anchor) > Macro (anchor) Configure User Memberships There are several ways to configure user access to a particular database. In each case, the user must already exist. Users can be created directly by an Administrator from the ‘Users’ item of DataShedAdmin, users can also register themselves from the DataShed5 login page. ### Method 1 – Add Membership User memberships can be added to a database from two locations. The first is by clicking on ‘Memberships’, then selecting ‘+Membership’. The second is by selecting the details button for a database on the Databases list, then selecting the ‘Memberships’ tab in the database details and clicking the ‘+Membership’ button. Both methods present the ‘Create Membership’ window. From the ‘Create Membership’ window, perform the following: ![image](media://60db2b57-8648-471a-b092-fe5ae38af251) 1. Select the user name from the drop-down list 2. Select the target database from the Database drop-down list. If you have come to the ‘Create Membership’ window from the Database Details window, the database will be pre-populated. 3. Check the ‘Approved’ checkbox. 4. Enter a Comment if required 5. Select the Membership Type 1. select ‘Other’, or 2. for a user who is a maxgeo hosted client assigned administrator, select ‘Maxgeo Database Administrator’ 6. Click the ‘Save’ button ### Method 2 – Copy Membership User memberships can be copied from one user to another user that does not already have membership of the database and that has the same UserRoles assigned. In the Create Membership Screen repeat steps 1- 5 above then select ‘Copy Membership’ & a List of Current Membership users are the same user roles with the new membership user for this Database will be made available to copy their membership details over to the new membership user. ![image](media://eb1e86ef-5ce6-4bd8-b96f-fc93d8b8ba47) 1. repeat steps 1- 5 from Add Membership above 2. select ‘Copy Membership’ & select a user from the List of Current Membership users 3. Click the ‘Save’ button **NB:** Using the ‘Copy’ method will create a new membership and copy the following details from the specified ‘Copy Membership’ user - user access, - user groups, - modules, - security level, - project/dataset. **NB:** In some installations, users may already be configured in the MDS database using the DataShed4 Configuration Manager. In this situation, the user configuration can NOT be copied from another user, because the configuration already exists. For these users, DataShed5 finds and associates the existing DataShed user configuration for this user. A message prompt below displays this confirmation. ![image](media://ceda725a-5290-4870-8c1f-67fe854c6f09) ## > Macro (anchor) > Macro (anchor) Configure Membership Detail User Access to the MDS database can be configured any time after the user has been granted membership to the database. User Access includes defining which Projects/Datasets the user can see and changing the user Security Level. It also includes adding the user to one or more User Groups within the database, which then allows access to data modules, report groups and dashboard groups associated with those user groups. The User Membership Detail configuration is similar to the user project assignments and group membership configuration that is traditionally performed by the DataShed4 Configuration Manager, this function can now be completed using the DataShed5Admin interface. User Membership details can be accessed by: - Users Select User Detail User Memberships list Select Details - Memberships Select Details - Databases Select Database Detail Memberships tab Select Details ![image](media://c766a877-6dda-4be0-bf63-67fb11dca775) The Membership Detail screen shows the user name / database combination that is being modified. There are tabs available to show and possibly modify the assigned DataSets, Modules, Dashboards, Reports, User Access, and Security. Selecting each tab shows the related information for this user membership. ### DataSets The DataSets tab shows a list of projects and datasets for which access has been granted for the user being examined. The Administrator can click ‘Edit User’s Projects’ to show a list of projects with check boxes, selecting or de-selecting the check box for a project will turn on/off access to that project (and its associated datasets) for this user. ![image](media://39f4fa74-e9d3-4675-8219-1515284a2e80) After modifications have been made, click ‘Save’ to save the selection, or ‘Cancel’ to revert to the selection prior to modification. ### Modules The ‘Modules’ tab allows the Administrator to assign membership of one or more user groups to users, and also modify access to modules. Granting membership to a user group will also grant access to a number of modules that have been assigned to the group, the administrator can override these defaults and remove access to modules or add additional modules. ![image](media://dbf70169-4af8-4e03-a031-f02ea34e145a) From the ‘Modules’ tab, the current group membership and module access is shown. Click the ‘Edit User’s Groups’ button to view and modify the user’s group memberships – click to turn the check boxes on or off to enable or disable membership of each groups. Click ‘Save’ to save the selection, or ‘Cancel’ to revert to the original settings. After modifying the user’s group membership, the user will be automatically granted access to any modules that are associated with the assigned user groups. Click the ‘Edit User’s Modules’ button to grant access to additional modules, or to remove access from an already assigned module. Click ‘Save’ to save the changes, or ‘Cancel’ to revert to prior settings. ### Dashboards / Reports Dashboards and Reports are assigned to User Group within a database, not to individual users. These assignments can be updated from the appropriate tabs in the Database Details screen. Selecting the Dashboards and Reports tabs will show the Dashboards and Reports that are available to the user, based on the user’s membership of User Groups within the current database. ![image](media://dc41db3c-5c50-4a6f-8b39-7820ea934591) ### User Access The User Access tab allows configuration of access to the Contract data. The available sites are displayed, grouped by Region. Access can be granted by region, which gives access to all sites within the region, or to specific sites within one or more regions. For users that have been assigned the WSServiceConsumer role, the selected User Access values will determine the Contract data that is synchronised to these users by LogChief. ![image](media://b25f7a0a-2eca-40fe-bcd1-39a618f5f571) To edit the User Access settings, click ‘Edit User Access’, check or uncheck the required sites/regions, and click the ‘Save’ button to save the configuration or ‘Cancel’ to revert to the previous settings. ### Security This tab shows the security level that the user has been granted in the current database. The available levels are Sys Admin, User Plus, and User. Different security levels can be granted to the same user in different databases. ![image](media://7d6ea41c-2448-408b-aec5-583b3c3bcac8) Click the ‘Edit’ button to enable Available Security Levels box, select the desired security level, then click the ‘Save’ button. Click ‘Cancel’ to revert to the original security level setting. # > Macro (anchor) Database Maintenance The DataShed5Admin database will remain quite small, regardless of the size or number of MDS databases registered to the installation. As part of good database management practice, it is recommended that standard maintenance tasks are carried out regularly on the WSA database. This includes regular backup, index rebuilds, space monitoring, etc. NB: If the DataShed5Admin database must be restored from backup, the service broker must be re-enabled for the database, using the following SQL command: alter database DataShed5Admin set enable_broker;