Upgrade to Release 5¶
The final version of Release 4 of MFSQL Connector is 4.11.36.80. All further bug fixes and enhancements are available only in Release 5.
Release 5 is required for the Context Menu functionality with the M-Files New Desktop, and for all installations on Windows Server 2022 and later.
Release 5 installs the Context Menu UIX for the New Desktop (UIX v2). This UIX does not display MFSQL Connector buttons in the Classic (old) desktop. However, there is a workaround that can be used during a transition period to allow users to continue using the Classic desktop alongside Release 5 functionality.
Classic desktop workaround (UIX v1)¶
There are different scenarios to consider for upgrading
M-Files version older than 25.1.xxxx. Do not upgrade to Release 5. Continue to use Release 4 up to version 4.11.36.80. Note that Release 4 will not receive further enhancements or bug fixes.
M-Files version 25.1.xxxx or newer, and the company is not using Context Menu functionality. Upgrade to Release 5. Note that the Context Menu buttons will no longer be visible in the Classic desktop. This does not affect Connector functionality except for Context Menu-related operations.
M-Files version 25.1.xxxx or newer, and the company uses Context Menu functionality but users are not on the New Desktop. Upgrade to Release 5 and manually install the UIX v1 package for the Classic desktop. See Installing the Context Menu for installation and configuration.
M-Files version 25.1.xxxx or newer, and the company uses Context Menu functionality and all MFSQL Connector users are on the New Desktop. Upgrade to Release 5 with no further manual adjustments.
To continue using the Classic desktop after upgrading to Release 5, install the UIX v1 package manually and configure the Context Menu as described in Installing the Context Menu.
Special considerations for installing or upgrading to Release 5¶
Release 5 makes MFSQL Connector compatible with the latest M-Files application architecture, including the New Desktop. The Release 5 UIX targets the New Desktop; MFSQL Connector buttons will not appear in the Classic desktop unless UIX v1 is installed manually. Release 5 also adopts .NET Framework 4.8 and therefore enables running MFSQL Connector on Windows Server 2022 and later.
Upgrading to Release 5 will change the VAF, UIX, assemblies, SQL procedures, and Web API of the MFSQL Connector. The upgrade should therefore be run on the SQL Server, M-Files Server, and Web Server (where applicable).
The Release 5 installation package uses a 64‑bit ODBC connection to connect to SQL Server. The package will not install on older Windows servers that do not support 64‑bit SQL connection protocols.
Release 5 resets the Context Menu functionality to improve throughput, ease of use, and logging when calling SQL operations via the M-Files user interface. This lays the foundation for further enhancements when using SQL via M-Files for advanced integrations and applications.
The logging enables tracking the operation in the MFSQL ProcessBatch tables: from triggering the event in M-Files, through the M-Files task management handoff, to executing the SQL operation defined in MFSQL Connector tables and procedures.
The types of events in M-Files Desktop are consolidated into three distinct types of operations:
Executing a SQL procedure within the context of the selected M-Files object when the user selects the operation from a menu item
Executing a SQL procedure to perform any operation not specifically related to an object when the user selects the operation from a menu item
Executing a SQL procedure triggered by a workflow state change or any M-Files event handler
For installation and configuration details, see Installing the Context Menu and the Release 5 notes in Release 5 functionality.
This functionality can be used in on-premises or cloud M-Files installations.