Migration Guide

This guide walks you through upgrading from UPV Webservices to the new UDiTH Portal. A potential way is also to setup a fresh instance.

Breaking changes

⚠️ Important: Review these changes before proceeding with your migration.

URL Structure

• Model URLs have changed - BBV includes basic compatibility, but update to new URLs as soon as possible
• Portal default path changed from /UpvWebservices to /Portal (Linux uses / by default)
  • This is configurable and can be customized during installation

Model Management

• Import requirement: All models must go through the new import procedure for BBV and Streaming compatibility
• Read-only imports: Imported models cannot be modified after import
  • If you need frequent file updates, wait for future releases with individual file update support
• New format required: Models must be packaged as ZIP files with specific structure requirements

Permissions & Database

• Unified permissions: No separate permissions between BBV and Streaming (will change in future versions)
• Database requirements: Tag Register functionality requires SQL Server (SQL Express storage limits may be insufficient)

Model Format Requirements

When preparing models for import:

• Create ZIP archives from your model folders
• Ensure correct structure: The Data folder must be at the top level of the ZIP file
• Validate structure before importing to avoid errors

MSSQL

• When using the new Tag Register functionality an SQL Express Server will no longer be enough due to limited storage in Express

Installer

• Installer will no longer validate prerequisites. Ensure prerequisites are meet

Backups

Ensure backups of database and models are created before performing any migrations

Migration

1. Verify model accessibility on Portal server
2. Document all secrets and save sharedsettings.json
3. Create comprehensive backups of database and models
4. Uninstall Webserver and restart the server
5. Stop and uninstall Renderserver
6. Install Portal with new installation path, entering secrets during setup
7. Restart IIS and verify Portal accessibility
8. Install new UDiTH Renderserver and Configure against new Portal instance
   • Note: Models no longer need to be on the Renderserver
9. Copy model folders to the new installation’s Models directory
10. Use Migration Tab in Portal web interface:
    • Navigate to Central Model Repository → Migration Tab
    • Convert models to new format and copy to import folder
11. Import models via Modelimport section. Create new models and assign model ids and version ids
12. Configure permissions for newly imported models
13. Import future models directly in new format via import folder