Upgrade to Release 5

Release 5 is required for using MFSQL Connector with the M-Files New Desktop and for installations on Windows Server 2022 or later. It introduces a new Context Menu implementation (UIX v2), optimizes ODBC and Web API operations, and consolidates menu actions into three execution types.

Important

The final Release 4 version is 4.11.36.80. Release 4 will not receive further fixes or enhancements. All future updates are in Release 5.

Note

UIX = User Interface eXtensions; VAF = Vault Application Framework.

The operations for the Context Menu have been consolidated into three main operations:

  • Execute a SQL procedure for an object

  • Execute a SQL procedure for non-object-specific operations

  • Execute a SQL procedure triggered by a workflow state change or any M-Files event handler

The processing of these transactions using ODBC and the Web API has been optimized for performance and reliability.

Warning

Release 5 does not display MFSQL Connector buttons in the Classic desktop. Use the UIX v1 workaround during the transition period if users remain on the Classic desktop.

Classic desktop workaround (UIX v1)

If users must remain on the Classic desktop after upgrading, install the UIX v1 package manually and configure the Context Menu as described in Installing the Context Menu.

Who should upgrade?

Upgrade decision matrix

M-Files version

Context Menu usage

Action

Older than 25.1.x

Any

Stay on Release 4 (4.11.36.80). No further enhancements or fixes.

25.1.x or newer

Not using Context Menu

Upgrade to Release 5.

25.1.x or newer

Uses Context Menu; users on New Desktop

Upgrade to Release 5 (UIX v2 included).

25.1.x or newer

Uses Context Menu; users on Classic desktop

Upgrade to Release 5 and install UIX v1 for Classic. See Installing the Context Menu.

Compatibility and prerequisites

  • Windows Server: 2022 or later. Installer uses a 64‑bit ODBC connection.

  • M-Files: Targets the New Desktop (UIX v2). Classic desktop requires the UIX v1 workaround.

  • .NET: Requires .NET Framework 4.8.

Upgrade scope

Upgrading to Release 5 updates the VAF, UIX, assemblies, SQL procedures, and Web API. Run the upgrade on:

  • SQL Server

  • M-Files Server

  • Web Server (if applicable)

Operational improvements

Release 5 improves throughput, ease of use, and logging when invoking SQL operations via M-Files. Logging traces each operation across M-Files, task handoff, and MFSQL ProcessBatch execution for full visibility.

For installation and configuration details, see Installing the Context Menu and the Release 5 notes in Release 5 functionality (retired).

This functionality works with both on-premises and cloud M-Files installations.