Installation and configuration

This guide details the installation and configuration steps for AutoUpgradeTool to perform your Process Studio version upgrades.

Detailed prerequisites

Before starting, verify that you have all the necessary elements.

Rights and permissions

Windows administrator rights

AutoUpgradeTool requires administrator rights to function correctly.

At startup, if you don't have administrator privileges, a dialog box will offer you:

• Yes: Restarts the tool in administrator mode
• No: Continues without privileges (some actions will fail)
• Cancel: Interrupts execution

::: warning Important Without administrator rights, the following operations will fail:

• Starting/stopping Windows services
• Starting/stopping IIS pools
• Modifying system files

Recommendation: Always run the tool as administrator. :::

Database access rights

You must have the following rights on APS databases:

• Read/write on the directory database
• Read/write on all application databases
• Ability to execute SQL scripts

Access to Bastille server

• Network access to Bastille server (internal Avanteam server)
• Read rights on the S:\3-PRODUIT\ReleaseUpgrades\ share

Required system components

Component	Minimum version	How to verify
Windows Server	2016	winver
.NET Runtime	8.0	dotnet --list-runtimes
IIS	10.0	IIS Manager
SQL Server Client	2016	SQL Server Management Studio

::: tip .NET Runtime If .NET 8.0 is not installed, the tool will offer to download it automatically on first launch. :::

Network access

Make sure that the workstation from which you run AutoUpgradeTool has:

• Network access to database servers (SQL Server or Oracle)
• Read/write access to Process Studio installation directories
• Access to Windows services of the APS instance
• Access to Bastille server: \\bastille\3-PRODUIT\ReleaseUpgrades\

AutoUpgradeTool installation

Step 1: Access to Bastille server

1. Open Windows Explorer

2. Access Bastille server:

   \\bastille\3-PRODUIT\ReleaseUpgrades\AutoUpgradeTool\

   Or using S: drive if mapped:

   S:\3-PRODUIT\ReleaseUpgrades\AutoUpgradeTool\

Step 2: Download

1. Copy the file to your local workstation:

   Copy from: S:\3-PRODUIT\ReleaseUpgrades\AutoUpgradeTool
   To: C:\Avanteam\AutoUpgradeTool\

2. Or work directly from the server (if stable connection)

Step 3: Installation verification

1. Right-click on AutoUpgradeTool.exe
2. Select "Run as administrator"
3. The tool should launch and display the version upgrade wizard

::: tip Shortcut with admin rights To facilitate future launches, create a shortcut to AutoUpgradeTool.exe and configure it to always run as administrator:

• Right-click on shortcut > Properties
• Shortcut tab > Advanced
• Check "Run as administrator" :::

Obtaining version upgrade patches

Patches are .7z archives containing all files necessary for the version upgrade.

Access to patches on Bastille

S:\3-PRODUIT\ReleaseUpgrades\Patches\
├── 2019\                    # Version 19 patches
│   ├── aps.upgrade.v19.24.v19.25.7z
│   └── ...
├── 2021\                    # Version 21 patches
│   ├── aps.upgrade.v21.24.v21.25.7z
│   └── ...
├── 2023\                    # Version 23 patches
│   ├── aps.upgrade.v23.14.v23.15.7z
│   ├── aps.upgrade.v23.17.v23.18.7z
│   └── ...
└── 2026\                    # Version 26 patches
    ├── aps.upgrade.v26.0.v26.1.7z
    └── ...

Patch structure

A version upgrade patch has the following nomenclature:

aps.upgrade.v[SOURCE_VERSION].v[TARGET_VERSION].7z

Examples:

• aps.upgrade.v23.14.v23.15.7z: minor upgrade 23.14 → 23.15
• aps.upgrade.v21.25.v23.0.7z: major upgrade 21.25 → 23.0
• aps.upgrade.v19.25.v21.0.7z: major upgrade 19.25 → 21.0

Patch contents

aps.upgrade.v23.14.v23.15.7z
├── scripts/                    # Version upgrade scripts
│   ├── db/                     # SQL scripts
│   │   ├── directory/          # Directory database scripts
│   │   └── application/        # Application database scripts
│   └── files.fix               # File update rules
├── binaries/                   # New APS binaries
│   ├── PStudio.Net.Web/
│   └── PStudio.Services/
└── workflow.yml                # Version upgrade workflow (optional)

Copying necessary patches

For your version upgrade, copy the necessary patches from Bastille:

Local patch organization

Organize your patches locally for quick access:

C:\Avanteam\Patches\
├── v21.x\
│   └── aps.upgrade.v21.24.v21.25.7z
├── v23.x\
│   ├── aps.upgrade.v23.14.v23.15.7z
│   ├── aps.upgrade.v23.15.v23.16.7z
│   └── aps.upgrade.v23.17.v23.18.7z
└── v26.x\
    └── aps.upgrade.v26.0.v26.1.7z

::: info Which patches to download?

• For a minor upgrade: The direct patch (ex: v23.14 → v23.15)
• For a progressive upgrade: All intermediate patches if available
• For a major upgrade: The major transition patch (ex: v21.25 → v23.0)

Consult the Bastille directory to see all available patches. :::

Target environment configuration

Before launching AutoUpgradeTool, prepare your Process Studio environment.

Complete backup (CRITICAL)

Mandatory backup

ALWAYS perform a complete backup before any version upgrade, especially for major upgrades.

Elements to backup:

Databases

-- SQL Server backup example
BACKUP DATABASE [APS_Directory]
TO DISK = 'C:\Backups\APS_Directory_YYYYMMDD.bak'
WITH COMPRESSION;

BACKUP DATABASE [APS_App_MyApp]
TO DISK = 'C:\Backups\APS_App_MyApp_YYYYMMDD.bak'
WITH COMPRESSION;

Process Studio directories

xcopy "C:\Program Files\Avanteam\" "D:\Backups\APS_Backup_YYYYMMDD\" /E /I /H /Y

IIS configuration

Export-IISConfiguration -Path "C:\Backups\IIS_Config_YYYYMMDD"

Stopping user connections

Before the version upgrade:

1. Inform users of upcoming unavailability
2. Disconnect all active sessions on Process Studio
3. Disable scheduled tasks in the Scheduler

Disk space verification

Make sure you have sufficient disk space:

• System: at least 5 GB free
• Database: 20% free space on the volume

Get-PSDrive C | Select-Object Used,Free

Working directory preparation

AutoUpgradeTool will automatically create log and working directories.

Automatically created structure

C:\Program Files\Avanteam\APP\
└── .autoupgrade\                       # Hidden directory
    ├── logs\                           # Version upgrade logs
    │   └── upgrade_2024-12-30_14-30-00.log
    └── readme\                         # Manual actions
        └── readme_2024-12-30_14-30-00.html

Logs and README

After each execution, two important files are generated:

1. Log file: detailed trace of all operations

   .autoupgrade/logs/upgrade_YYYY-MM-DD_HH-MM-SS.log

2. HTML README: list of manual actions to perform post-version upgrade

   .autoupgrade/readme/readme_YYYY-MM-DD_HH-MM-SS.html

::: tip Consulting files An "Open logs" button in the interface provides direct access to these files during and after the version upgrade. :::

Advanced configuration (optional)

Custom workflow

If your patch contains a workflow.yml file, AutoUpgradeTool will use this custom workflow instead of the default workflow.

Custom workflow example:

version: 1.0
scopes:
  instance:
    steps:
      - name: Stop Remoting service
        uses: StopWindowsService
        with:
          service-name: "PStudio.Services.Remoting"
      
      - name: Update directory database
        uses: ExecuteSqlScripts
        with:
          scope: directory
          path: "db/directory/*.sql"
  
  app:
    steps:
      - name: Stop IIS pool
        uses: StopAppPool
        with:
          app-pool-name: "{profile}"
      
      - name: Update files
        uses: ApplyFilesFix
        with:
          files-fix-path: "files.fix"

Environment variables

You can define environment variables to customize behavior:

Variable	Description	Default value
AUTOUPGRADE_LOG_LEVEL	Log level (Trace, Debug, Info, Warn, Error)	Info
AUTOUPGRADE_TEMP_DIR	Temporary directory	.autoupgrade

Preparation checklist

Before proceeding to usage, ensure all points are validated:

• AutoUpgradeTool downloaded from Bastille and extracted
• Windows administrator rights available
• Database access rights validated
• Bastille server access verified
• .NET 8.0 Runtime installed
• Version upgrade patches copied from Bastille
• Complete backup performed (DB + files)
• Users disconnected from Process Studio
• Sufficient disk space verified
• Scheduler scheduled tasks disabled

Next steps

Your environment is now ready! Proceed to the usage guide to perform your first version upgrade:

➡️ Step-by-step usage guide

Additional resources

• 📖 Introduction to AutoUpgradeTool
• 🛠️ Use cases and best practices
• ❓ Troubleshooting and FAQ
• 📁 Bastille server: S:\3-PRODUIT\ReleaseUpgrades\

Related articles

• AutoUpgradeTool
• ImportDocs
• Getting started guide