Upgrade an Existing Installation to MineMarket 5.5

Use this activity to upgrade an existing installation to MineMarket 5.5.

Important: If using MineMarket with IMS Integration Hub, Datamine recommends upgrading to IMS Integration Hub 2.10 at the same time as upgrading to MineMarket 5.5 or later because .NET Framework 4.8 is required for both products.

This activity presumes that an earlier version of MineMarket is currently installed on the system.

Before the upgrade:

  1. Back up the files in the MineMarket installation folder.

    Important: You must do these backups. The backup files and database are required to restore the MineMarket version in the case of problems with the upgrade. Backups of original configuration files are essential for reference purposes; for example, for customised system integration.

  2. Back up the MineMarket database.
  3. Back up the MineMarket Data Mart database, if it exists.
  4. Ensure that the system requirements for MineMarket 5.5 are met.
  5. Obtain a new MineMarket licence file from your Datamine representative if required.

    Important: From MineMarket 4.11 onwards, a new licence file is not required for minor version upgrades. That is, a licence file for 4.11 will work for 4.12, 4.13, and so on. A new licence file is required for major version upgrades (to 5.0+), or if changing the network domain or machine name where the MineMarket Server is installed.

  6. Generate or locate the required database update script by performing one of the following steps:
    1. Use the Database Upgrade Wizard to Create an Upgrade Script for a MineMarket Database.
    2. Obtain a script from your Datamine representative.
  7. Determine which customised files (MineMarket report DLLs, MineMarket add-ins and IMS Integration Hub adaptors) need to be recompiled.

    Important: Previous versions of MineMarket used a 4-byte unique identifier for each object in the MineMarket database. MineMarket 5.5.0+ uses an 8-byte primary key value. You must recompile any add-in that has a relationship to a MineMarket base object, so that the add-in can use the new primary key data type. Any add-in that stores database objects that use BTKey as their primary key require a database upgrade script. The storage type for Int extension objects has been changed to 8 bytes, which allows you to use extension object fields as references. If your custom add-ins make use of these fields, you may need to change the value that you store to an 8-byte value. Contact your Datamine representative for assistance with recompiling files and generating upgrade scripts.

  8. If using MineMarket with IMS Integration Hub 2.7 or earlier, prepare to upgrade IMS Integration Hub to 2.10 or later.

    Important: Datamine recommends upgrading to IMS Integration Hub 2.10 at the same time as upgrading to MineMarket 5.5 or later because .NET Framework 4.8 is required for both products. See the IMS Integration Hub Installation Guide for more information about upgrading IMS Integration Hub.

Prepare the system for the upgrade:

  1. Stop the MineMarket Services.
  2. Use the appropriate MineMarket setup wizard to uninstall MineMarket and all of its components.
  3. Uninstall IMS KeyGenerator if it was installed because (since MineMarket 4.9.0) keys are generated within MineMarket.
  4. Complete any outstanding installation prerequisites. In particular, ensure that .NET Framework 2 and 4.8 are installed on the Application Server and all Application Clients.

Upgrade:

  1. Upgrade the MineMarket database:
    1. If MineMarket is hosted on a SQL server, perform one of the following steps:
      1. Use the Database Upgrade Wizard to Upgrade a MineMarket Database.
      2. Run the provided or generated update script in a SQL Server database scripting environment.
    2. If MineMarket is hosted on an Oracle server, run the provided update script in an Oracle database scripting environment.

    Important: Note the following information about scripts:

    • Ensure that only an update script is run on an existing database; never a full setup script. Running a full setup script will delete all existing data.
    • It is highly recommended that only the update scripts provided by Datamine are used. Running an incorrect update script may result in significant data loss or corruption.
    • If incremental update scripts are provided, they must be run one by one and in sequence in the database scripting environment.
    • For SQL, ensure that single-byte scripts are only run on single-byte databases, and double-byte scripts are only run on double-byte databases. Since MineMarket 5.2.0, all SQL databases are converted to support double-byte characters. Fields with the varchar character data type will use nvarchar, and fields with the text character data type will use nvarchar(max).
    • For Oracle, warnings of the type "Failed: Warning: execution completed with a warning" can be ignored. These warnings may be seen on temporary tables if using Oracle SQL Developer. Oracle SQL Plus is recommended for running upgrade scripts.
  2. Use the MineMarket setup wizard to install the MineMarket Server and MineMarket Clients. See the following activities for full instructions:
  3. Copy the licence file to the MineMarket Server installation folder.
  4. Recompile any customised MineMarket report DLLs, MineMarket add-ins and IMS Integration Hub adaptors so that they run with .NET Framework 4.8 and the MineMarket 5.5 BulkTrak.Component.dll.

    Important: Database changes may also affect existing reports. Check the database update script for changes to tables referenced in the reports.

  5. Copy any recompiled files to the MineMarket Server installation folder.
  6. Configure the MineMarket Service, the MineMarket Search Service, the MineMarket Marketing Service, the MineMarket Information Services and the MineMarket Clients. See the Configure... information in this Installation Guide for each service and client.
  7. Customise any required files. In particular, consider any required changes to:
    • Configuration files
    • InvoiceDataSet.xsd—Used to generate invoices.

      Important: See the Summary of Changes... information in this Installation Guide for each configuration file. Do not simply copy previous configuration files! (Some configuration files do not have Summary of Changes... page in this Installation Guide. For such files, customisations are unlikely and you should use the new version of the files.) Contact your Datamine representative for assistance with customising files.

  8. As required, start the services. See Start the MineMarket Services.

    Note: MineMarket upgrades the Data Mart database table structure automatically when MineMarket is upgraded and the MineMarket Data Mart Service is started.

  9. Configure the MMServerName to enable emailing. (See activity steps in the MineMarket System Administration Guide or the MineMarket Help.)

    The stored MMServerName is used to validate that any emails (for warehouse notifications, scheduled billboards, scheduled reports and alerts) can only be sent from the intended installation. The MMServerName is the combination of the domain name and the machine name where the MineMarket Server is installed, and is stored as an encrypted value.

    Important: If this upgrade is from a version before MineMarket 5.1.12+, MineMarket 5.4.2+ or MineMarket 5.5.0+, the MMServerName must be stored to enable emailing. If the MineMarket Server installation is subsequently moved (such as for testing or production) to a different domain and/or machine name, the old MMServerName must be cleared and the new MMServerName stored to enable emailing.