Skip to main content
Version: 3.4.0 (Latest Stable)

ExMeX Framework Upgrade Guide

Overview​

This guide outlines the steps to upgrade the ExMeX Framework to a new version. Follow the instructions carefully to ensure a smooth upgrade process.

Important Notes​

  • The -ConnectionName parameter should match the name of the .json file you created in Step 3 (e.g., myConnection.json).
  • Always back up your configuration and database before proceeding with the upgrade to avoid any potential data loss.

Step-by-Step Upgrade Instructions​

  1. Download the Update Package

    First, download the latest version of the ExMeX Framework from the official download link:

    Download the latest version

  2. Extract the Package

    Once the file is downloaded, extract it into the root directory of your ExMeX Framework installation.

  3. Configure the SQL Server Connection

    • Navigate to the extracted files and copy the default SQL Server connection configuration file etc/config/SqlServerConnection.orig.json.
    • Rename this file to etc/config/myConnection.json or any other name that suits your setup.

  4. Update the Connection Configuration

    Open the newly created etc/config/myConnection.json file and update the connection details to match your SQL Server configuration. Ensure the following parameters are correctly set:

    • Server Name and Port
    • Database Name
    • Authentication Details

    This configuration will allow the update script to connect to your SQL Server instance.

  5. Run the Update Script in PowerShell

    Open PowerShell (pwsh) and navigate to the root folder of the ExMeX Framework. From this directory, execute the following command to initiate the upgrade:

    ./UpdateExmexFramework.ps1 -ConnectionName myConnection -ReleaseVersion 3.2.0 -Database myExMeXDatabase
    • -ConnectionName myConnection refers to the name of the connection profile you created in Step 3 (myConnection.json).
    • -ReleaseVersion 3.2.0 specifies the new version you're upgrading to.
      • 3 is the MAJOR version
      • 2 is the MINOR version
      • 0 is the PATCH version
    • -Database myExMeXDatabase is the name of your ExMeX Framework database.

  6. Additional Help

    If you need more information or assistance with the upgrade script, you can access the help options by running the following command:

    ./UpdateExmexFramework.ps1 -Help

By following these steps, you will successfully upgrade your ExMeX Framework to the latest version!