Skip to main content
Version: v2.6

Deployment Notes 2.6

Introduction​

Artifacts can be downloaded from the download page.

Here's an upgrade checklist to assist: Hopp.2.6.Upgrade.xlsx

A note about local customization

We are always doing our utmost to ensure the quality of the Hopp Migration Platform.

To the extent that our customers have custom implementations using external extension APIs or write queries against the internal databases of the Hopp platform, we do expect our customers to perform rigorous testing of their own implementations.

Internal Database Objects

Our internal staging and migration databases are designed to support our data processing workflows and are not intended to function as stable, external APIs.

While we aim to maintain consistency across releases, we do not guarantee backward compatibility or structural stability of these databases.

Clients who choose to access these databases directly are responsible for validating that their integrations continue to function as expected after any updates or releases.

Extension APIs

Our API for extensions is provided to enable advanced integrations and custom functionality. However, this API may evolve over time, and changes may occur between releases.

We advise all customers using the Extension API to validate their custom extensions and integrations against each new version of the platform. Proper testing will help identify and resolve any issues arising from API modifications.

The following sections outline the deployment actions for this release.

Database Migration​

Important

Please back up all databases before running refactor scripts

Redeploy Portal​

  1. Download the appropriate zip file from the download page depending on your installation
    1. If you are using the Portal including all modules (Item Manager and Planning), download portalwithmodules.zip
    2. Otherwise, download portal.zip and - if relevant ' ext-itemmgr.zip or ext-planning.zip
  2. Redeploy the Portal web application.
    1. Preserve and re-establish the appsettings.json file
    2. If you are hosting the Portal in an IIS sub-folder, you should also preserve and re-establish the <base> tag in the wwwroot/index.html file

If you are selectively deploying Item Manager or Planning modules, you need to copy the contents of the Server and Client folders from the zip file to their respective locations under in the Extensions folder under the Portal application folder

Upload new runtime to the Portal​

  1. Download the runtime.zip from the download page
  2. Upload new runtime.zip to the Portal (Configuration → Operations → Runtime → Upload)
  3. Set the new runtime version active

Execution Servers​

Reinstall Hopp Agent Service​

Reinstall the Hopp Agent Service:

note

Make sure you have the application credentials (UserId/Password) ready for the Hopp Service account

  1. Download the Hopp.Director.Agent.msi installer from the download page
  2. Stop the Hopp Agent Service before uninstall
    1. Open the Services Control Panel Add On - search for 'services' in the Windows Start Menu
    2. Locate and stop the Hopp Agent Service
  3. Preserve the MigFx.Agent.dll.config file in the installation folder (normally C:\Program Files\HoppTech\migFx\Agent)
  4. Run the Hopp Agent Service installer
  5. Re-establish the MigFx.Agent.dll.config file
  6. Re-enter the application credentials as logon for the Hopp Agent Service
  7. Start the Hopp Agent Service

Reinstall the DataServices extensions​

Reinstall any DataServices extensions (if installed):

  • Hopp.DataServices.SqlServer
  • Hopp.DataServices.DB2
  • Hopp.DataServices.Oracle

Workstations​

Reinstall Hopp Studio​

  1. Download the Hopp Studio installer (Hopp.Studio.exe) from the download page
  2. Install the new version of Hopp Studio.

Reinstall the DataServices extensions​

Reinstall any DataServices extensions (if installed):

  • Hopp.DataServices.SqlServer
  • Hopp.DataServices.DB2
  • Hopp.DataServices.Oracle

Reinstall Visual Studio Extension​

note

Before uninstalling the current Visual Studio extension, please open the Visual Studio options dialog and note down the current options for the Portal connection.

The new ability to deploy directly from within Hopp Studio has changed how the Portal connection options are stored - Hopp Studio and Visual Studio are now sharing the same Portal configuration options.

For this reason, it is required to re-enter the Portal information into the Visual Studio options after reinstall of the Visual Studio extension.

  1. Make sure you have at least Visual Studio 2022 version 17.4 installed
  2. Open Visual Studio and in Extensions → Manage Extensions, mark the installed Hopp Migration extension for un-install
  3. Close Visual Studio. The Microsoft Visual Studio extension installer will launch to uninstall the previous version. Follow the guidance in the installer
  4. Install the new Hopp Visual Studio extension (double-click VsExtension.2022.vsix)
  5. Follow the guidance in the installer
  6. When installed, open Visual Studio
  7. In Tools → Options → Hopp, re-enter the Portal configuration options

Update Engine Generator​

  • If using Nuget

    • Update the Hopp.Generator tool dotnet tool update hopp.tools.enginegenerator --global

  • If using local libraries

    • Reinstall MigFx.EngineGenerator from download page

Update Visual Studio Library References​

note

This only needs to be done by the administrator and committed to version control

  • In all custom library projects implementing Hopp extensions

    • Update any Hopp.* NuGet package references to 2.6.*

  • If using Nuget

    • Update Hopp.SourceEngine package reference to 2.6.* in all *.SourceEngineGenerated.csproj files <PackageReference Include="Hopp.SourceEngine" Version="2.6.\*"/>
    • Update Hopp.TargetEngine package reference to 2.6.* in all *.TargetEngine.csproj files <PackageReference Include="Hopp.TargetEngine" Version="2.6.\*"/>

  • If using local libraries

    • Reinstall MigFx.Libraries from download page

Powershell Automation​

Re-install the PowerShell Automation module on relevant workstations and servers.

note

This is optional and only if the Powershell Automation scripts are used