Skip to main content
Version: Next

Introduction to AutoUpgradeTool

Overview​

AutoUpgradeTool is an automation tool for upgrading Avanteam Process Studio (APS) to .NET version. It helps simplify and secure the APS instance update process by automatically detecting your configuration and applying the necessary patches.

Who is this tool for?​

AutoUpgradeTool is designed for:

  • Client IT teams who want to perform upgrades independently
  • Avanteam project teams involved in version upgrades
  • Avanteam partners performing upgrades at their clients' sites
  • Process Studio designers and users with administrative rights

Key Features​

Automatic Detection​

  • ✅ Detection of installed Process Studio instance
  • ✅ Identification of current version
  • ✅ Detection of applications and their configurations
  • ✅ Identification of databases (directory and applications)
  • ✅ Location of services (Remoting, Scheduler)

Upgrade Automation​

  • ✅ Automatic shutdown of Windows services
  • ✅ IIS pool shutdown
  • ✅ Patch application in appropriate order
  • ✅ Database updates
  • ✅ Update of instance and application files
  • ✅ Service restart

Traceability and Security​

  • ✅ Detailed logs of all operations
  • ✅ Generated README file with manual actions to perform
  • ✅ Error handling with cancellation capability
  • ✅ Prerequisites validation before execution

Supported APS Versions​

AutoUpgradeTool supports version upgrades for:

  • Versions 19.x (19.0 to 19.25)
  • Versions 21.x (21.0 to 21.25)
  • Versions 23.x (23.0 to 23.18+)
  • Versions 26.x (26.0 to 26.x)
  • Major version upgrades (e.g.: 21.14 → 23.0)
  • Minor version upgrades (e.g.: 23.14 → 23.15)
Major Version Upgrades

Major version upgrades (changing the first or second digit, for example 21.x → 23.x or 23.x → 26.x) are critical operations that require special attention and prior backups. Consult the article Use Cases and Best Practices for more details.

Technical Architecture​

AutoUpgradeTool consists of two main components:

AutoUpgradeTool.exe (Graphical Interface)​

Windows Forms application with a step-by-step wizard that guides the user through the version upgrade steps.

AutoUpgradeLib.dll (Library)​

.NET 8.0 library containing all business logic:

  • Process Studio instance detection
  • Patch and workflow management
  • Database interactions (SQL Server, Oracle)
  • Windows services and IIS management
  • Logging system

System Requirements​

Before using AutoUpgradeTool, ensure your environment has:

Operating System​

  • Windows Server 2016 or higher
  • Windows 10/11 (for development environments)

Administrative Rights​

  • Windows administrator rights required for:
    • Stopping/starting Windows services
    • Modifying IIS application pools
    • Accessing installation directories

Required Components​

  • .NET 8.0 Runtime (automatically installed if missing)
  • IIS (Internet Information Services)
  • SQL Server or Oracle Client (depending on your APS configuration)

Network and Database Access​

  • Read/write access to APS databases (directory and applications)
  • Write access to Process Studio installation directories
  • Access to Bastille server (Avanteam internal network)

How to Get the Tool?​

Bastille Server Access​

The tool and upgrade patches are available on the Bastille server (Avanteam internal server):

S:\3-PRODUIT\ReleaseUpgrades\
├── AutoUpgradeTool\          # Version upgrade tool
├── Patches\                  # Version upgrade patches
│   ├── 2019\
│   ├── 2021\
│   ├── 2023\
│   └── 2026\

Tool Download​

  1. Access the Bastille server:

    \\bastille\S$\3-PRODUIT\ReleaseUpgrades\AutoUpgradeTool\

  2. Download the latest available version

    Example: AutoUpgradeTool-v2.4.zip

Archive Contents​

The archive contains:

  • AutoUpgradeTool.exe: the main application
  • AutoUpgradeLib.dll: the upgrade library
  • Required .NET dependencies
  • Configuration files

Upgrade Patches​

::: info Where to Find Patches? APS upgrade patches are .7z files available on the Bastille server in the S:\3-PRODUIT\ReleaseUpgrades\Patches\ directory.

Example nomenclature:

  • aps.upgrade.v23.14.v23.15.7z: patch from version 23.14 to 23.15
  • aps.upgrade.v21.25.v23.0.7z: patch from version 21.25 to 23.0 (major upgrade) :::

Patch Structure by Version​

S:\3-PRODUIT\ReleaseUpgrades\Patches\
├── 2019\
│   ├── aps.upgrade.v19.24.v19.25.7z
│   └── ... 
├── 2021\
│   ├── aps.upgrade.v21.0.v21.1.7z
│   ├── aps.upgrade.v21.24.v21.25.7z
│   └── ...
├── 2023\
│   ├── aps.upgrade.v23.0.v23.1.7z
│   ├── aps.upgrade.v23.14.v23.15.7z
│   └── ...
└── 2026\
    ├── aps.upgrade.v26.0.v26.1.7z
    └── ...

Operation Diagram​

graph TD
    A[Launch AutoUpgradeTool] --> B{Admin rights?}
    B -->|No| C[Request relaunch as admin]
    B -->|Yes| D[Detect APS instance]
    D --> E[Verify configuration]
    E --> F[Select target version]
    F --> G[Validate prerequisites]
    G --> H[Apply patch]
    H --> I[Stop services]
    I --> J[Update files]
    J --> K[Update database]
    K --> L[Restart services]
    L --> M[Generate logs and README]
    M --> N[Upgrade completed]

Next Steps​

Go to the next article to learn how to install and configure AutoUpgradeTool:

➡️ Installation and Configuration

Additional Resources​