---
title: "MDS Upgrader v1.5.4 Installation & User Guide"
canonical: "https://servicedesk.maxgeo.com/space/MDS/2330984450/MDS%20Upgrader%20v1.5.4%20Installation%20%26%20User%20Guide"
format: markdown
---
**MDS Upgrader **
> Macro (toc)
# > Macro (anchor)
Introduction
The MDS Upgrader is an application designed to upgrade the Maxwell Database Schema between versions 4.6.0 to 5.0.0. The MDS Upgrader will upgrade and validate the database objects (Tables, Views, PK, FK, etc) to ensure compliance with the standard Maxwell Database Schema. Custom Tables, Fields, etc. will not be check. All available hotfixes, if any, will be checked and downloaded from our FTP site at runtime and installed, if internet connection is available. If reserved base object definition has been customized, these customization might be overwritten during the upgrade process. Customization on non-reserved based object (such as views) will be preserved during the upgrade and review of these objects are required to manually apply any enhancements done on them.
For database schema prior to 4.6.1 SP1, the Upgrader will first try to upgrade the schema to 4.6.1 SP1. And once 4.6.1 SP1 upgrade is completed, it will continue to upgrade the schema to 5.0.0.
After upgraded your schema to 5.0.0, you can run the MDS Upgrader program again on your schema at any time to install any new hotfixes that’s available to 5.0.0.
The MDS Upgrader application include an option to upgrade Data Shed Admin database. It also has option to install the Grid Transformation components that requires by MDS 5.0.0+.
> ⚠️ **DB Modification**
> ⚠️
> ⚠️ Before any change is made to a user database (or system), maxgeo recommends competent staff should follow all standard database change management practices and never make untested changes to a production database.
> ⚠️ Change, test and document all modifications on a test copy of your database to ensure results are as expected before implementing them on your live database. Always ensure a full backup is available in case rollback is required and follow all company change management procedures and practices.
# > Macro (anchor)
Installation
This section details the steps to install the MDS Upgrader.
1. double click on the setup.exe
2. Click on the **Run** button if following window pop up
1. Click on the **Next** button to continue
1. Accept the license agreement, then click on the **Next** button to continue
1. Enter customer information as needed, then click on the **Next** button to continue
1. Select setup type, then click on the **Next** button to continue
1. Click on the **Install** button to start installation
1.
2. Click on the **Yes** button to continue
1. Click on the **Finish** button to conclude the installation
# > Macro (anchor)
Run MDS Upgrader
Once installed, you will be able to start the program from Start 🡪 All programs 🡪 MDS Upgrader
# > Macro (anchor)
Run Upgrader Type - MDS
By selecting the MDS option the Maxwell Database Schema can be upgraded.
As shown on the above screenshot, the Upgrader will run the upgrade process in sections as listed on the left hand side of the application interface. When click on the Next button, if will move to the next section if the current section has been process successfully without error. Any error encountered needs to be fixed before the Upgrade can move to the next stage. Please refer to the Troubleshooting section later in this documentation for helps with troubleshooting some common errors one might encounter.
To see brief descriptions of all changes the Upgrader will implement, click on the **ReadMe** button to see the schema change list for all versions, segmented by versions.
### > Macro (anchor)
Database Connection:
You configure the database that will be upgraded in this section (see screenshot above). Specify the Database Server, the credentials used to connect to that database server, and the Database Name for the database to be upgraded.
Please note the following important requirements:
1. Please ensure a VALID database backup exists PRIOR to run the Upgrader.
2. Please ensure the Server Authentication setting on the target database server is set to SQL Server and Windows Authentication mode. Otherwise, the upgrade will fail to connect.
3. Please ensure no other people or process is accessing the target database during the upgrade to prevent any potential issues.
### > Macro (anchor)
Pre Validation Checks:
This section runs any, if any, required pre validation checks. If any checks failed, please follow the prompt or error message to address them.
Depends on your current schema version, you might see the title of “MDS Upgrader 4.6.1 SP1” if you are currently on 4.6.1 and prior. Or you will see the “MDS Upgrader 4.6.2” if you are currently on 4.6.1 SP1 or later.
### > Macro (anchor)
Data Defaults:
When Upgrader modify an existing column to be NOT NULL, and if there is data already existing in that table with NULL value in it, a default value will be required for the change be able to be made. The Data Defaults section let you configure those default values to be used to update existing records. The Upgrader might suggest some default values as shown in the screenshot below. Supply or modify the values with your preference and click on the Save button before go to next section.
### > Macro (anchor)
Library Tables:
This section implements all the changes on library tables.
### > Macro (anchor)
System Tables:
This section implements System Table changes.
### > Macro (anchor)
General Tables:
This section implements all user table changes.
### > Macro (anchor)
Stored Procedures:
This section implements Stored Procedure and Function changes.
### > Macro (anchor)
Views:
This section implements View changes.
### > Macro (anchor)
General Objects:
This section implements other general changes.
### > Macro (anchor)
Post Validation Checks:
This section implements any required post validation checks and update the schema dictionaries.
Please read carefully the output in this section. It may contain recommendations for actions required to modify custom objects or other manual actions that can’t be performed by the Upgrader.
### > Macro (anchor)
Hot Fixes:
This section implements any available hot fixes. It requires an Internet connection to download any available hot fix scripts from Maxwell GeoServices Download site. If Internet connection is not available at run time, no hot fix will be checked or implemented.
When there more than one version upgrade required, the Upgrader will go back to start the next version upgrade. When no more version upgrade required, it will move on to Final DB Checks step.
### > Macro (anchor)
Final DB Checks:
This section validates the current schema structure and reports back any schema structure issue it found comparing with the MDS base model schema dictionary. There are two type of issues might be reported here.
Type 1: Reserved base objects have been modified/deleted. Reserved objects are columns, constraints etc. that’s mandatory required in the schema as other Maxwell products might depends on them to work properly. For any issues reported under this category, it’s strongly advised to rectify them as suggested by the report to be aligned with the base model.
Type 2: None-Reserved base objects have been modified/deleted. None-Reserved base objects, often are views, are objects that allow to be modified. For any of these objects reported, please compare the base object definition as reported against current definition in you schema and manually apply any enhancements done, if any, on the base model onto your schema as appropriate.
# > Macro (anchor)
Run Upgrader Type – DataShed Admin
By selecting the DataShed Admin option the Maxwell DataShed Admin Database Schema can be upgraded.
### > Macro (anchor)
User/Login:
Create users, login, roles if not already exists and grant required permissions
### > Macro (anchor)
Tables:
This section implements all user table changes.
### > Macro (anchor)
Stored Procedures:
This section implements Stored Procedure and Function changes.
### > Macro (anchor)
Permissions:
### > Macro (anchor)
Data:
### > Macro (anchor)
Others:
### > Macro (anchor)
Final DB Checks:
Update DataShed Admin database version
# > Macro (anchor)
Run Upgrader Type - Grid Transformation
By selecting the Grid Transformation option, the required components for grid transformation in MDS 5.0.0 and above will be installed.
Please refer to the “MDS5 Upgrader Grid Transformations Installation Guide” document for details.
# > Macro (anchor)
Upgrader Type - MDS - Troubleshooting
Following are some of the common errors you might experience during the upgrade process.
1. **Data issue might prevent new constraint to be created. For example, if existing data violate the new foreign key constraint, the new FK will not be able to be created. Please fix the data involved in the FK first and then continue with the upgrade.**
Example error message:
- Alter table tblSYSAssLabMethod
ERROR: The ALTER TABLE statement conflicted with the FOREIGN KEY constraint "FK_tblAssay_tblSYSAssLabMethod_OrigMethod_LabCode_GenericMethod". The conflict occurred in database "Test_Database_v4.6.1", table "dbo.tblSYSAssLabMethod".
Example solution:
In tblAssay, some of the combo of OrigMethod/LabCode/GenericMethod data does not exist in tblSYSAssLabMethod (LabMethod/LabCode/GenericMethod). This is often duo to the GenericMethod in tblSYSAssLabMethod is incorrectly recorded. Depends on your data, It might be the GenericMethod data in tblAssay is not correct or both. Fix the incorrect data you find.
1. **When receive error about can’t modify a column because certain FK(s) are referencing it, those FKs will be custom FKs and need to be dropped first and recreate them back after upgrade complete. (Note, additional column change to the custom columns might be required to reflect changes to the base column, such as column length change.)**
Example error message:
- Alter table tblDHColl
ERROR: The object 'FK_tblDHColl_tblDHColl1' is dependent on column 'Hole_ID'.
ERROR: The object 'FK_tblDHColl_tblDHColl' is dependent on column 'Hole_ID'.
ERROR: The object 'FK_tblDHColl_tblDHColl1' is dependent on column 'Hole_ID'.
ERROR: The object 'FK_tblDHColl_tblDHColl' is dependent on column 'Hole_ID'.
ERROR: ALTER TABLE ALTER COLUMN Hole_ID failed because one or more objects access this column.
Example solution:
Drop the FKs mentioned in the error message above and then continue with the upgrade. Recreate these FKs (if still needed) after the upgrade completed.
1. **When receive error about enable update cascade will cause cycles or multiple cascade paths, there will be a custom FK on the target table that already has cascade on. Try to remove cascade on any custom FKs on the target table so the upgrade can continue. Once upgrade completed, may try to put cascade on back on those custom FKs (note, if cascade cannot be set on custom FK, just leave it)**
Example error message:
- Replace tblLIBStructPlaneIntensity with tblLIBIntensity
ERROR: Introducing FOREIGN KEY constraint 'FK_tblDHStructure_tblLIBIntensity_Plane_Intensity' on table 'tblDHStructure' may cause cycles or multiple cascade paths. Specify ON DELETE NO ACTION or ON UPDATE NO ACTION, or modify other FOREIGN KEY constraints.
ERROR: Could not create constraint. See previous errors.
Example solution:
Remove cascade setting on all custom FKs on table tblDHStructure and then continue upgrade. Try to reinstate cascade setting on these custom FKS where can once upgrade complete.
# > Macro (anchor)
> Macro (anchor)
> Macro (anchor)
> Macro (anchor)
Licence Agreement
The use of MDS Upgrader is subject to a licence agreement with Maxwell GeoServices. The software may only be used or copied in accordance with the terms and conditions of that agreement.
# > Macro (anchor)
> Macro (anchor)
> Macro (anchor)
> Macro (anchor)
Disclaimer
Maxwell GeoServices will not accept any liability arising from the use of MDS Upgrader software or any other software product mentioned in this manual, nor for any technical or editorial errors or omissions in this manual.
# > Macro (anchor)
> Macro (anchor)
> Macro (anchor)
> Macro (anchor)
Copyright
Maxwell GeoServices is the owner of the MDS Upgrader software, and all icons within the software, together with all soft and hardcopy documentation. This manual contains information protected by copyright. No part of this manual may be photocopied or reproduced in any form without the prior written consent of Maxwell GeoServices.
© Copyright 2002-2024 by Maxwell GeoServices.
# > Macro (anchor)
Support
For MDS Upgrader Support, please refer to the Maxwell GeoServices website:
[http://www.maxwellgeoservices.com/maxwellsupport.html](http://www.maxwellgeoservices.com/maxwellsupport.html)
Please find attached pdf here: