Version Control — Release 5

Purpose

This page tracks Release 5 versions and changes. It mirrors the Release 4 approach (published versions summary, release numbering notes, and a chronological change log), but reflects the Release 5 architecture (UIX v2, optimized ODBC/Web API, decision to consolidate operations).

Scope and principles

  • Keep the log consumer-focused: what changed, why it matters, and any operator action required.

  • Group changes by package (SQL scripts, Assemblies, Vault application, Web API) when helpful.

  • Prefer short bullet points with links to detailed object docs (procedures, tables, functions).

  • Use absolute docnames for cross-references, e.g. spMFUpdateMFilesToMFSQL.

Published

Component

Version

Date

SQL scripts

5.13.37.81

2025-08-15

Assemblies

5.37

2025-08-15

Vault application

5.13.24

2025-08-20

UIX package

5.13.24

2025-08-20

Web API

TBD

TBD

Release numbering

Release 5 retains the four-part numbering from Release 4:

  • 1st digit: major release (5.x.x.x)

  • 2nd digit: M-Files application changes

  • 3rd digit: Assembly changes

  • 4th digit: SQL changes (monotonic across packages)

Installed releases

  • Latest release installed: SELECT * FROM dbo.MFDeploymentDetail

  • Latest release per object: SELECT * FROM setup.MFSQLObjectsControl WHERE Name = ‘ObjectName’

  • Package file version: Windows Explorer > Properties > Details

  • Assembly version: .NET Reflector or similar tool

  • Vault application version: M-Files Admin > Applications > Details

Change control summary

Each procedure, table, or function has its own change control section; see the relevant object docs. Summaries below capture the highlights per release.

5.13.37.81 (Initial published Release 5)

Summary

  • New Context Menu implementation using UIX v2 for the M-Files New Desktop. Classic desktop does not show buttons; a UIX v1 workaround is available. See Installing the Context Menu.

  • Operations consolidated into three execution types: object-focused, non-object operations, and workflow/event-triggered SQL execution.

  • End-to-end logging improvements for traceability across M-Files → task handoff → MFSQL ProcessBatch execution. See Using and managing logs.

  • Performance and reliability optimizations for ODBC and Web API transactions.

  • Upgrade scope covers VAF, UIX, assemblies, SQL procedures, and Web API. See Upgrade to Release 5.

Component changes

  • VAF (Vault Application Framework) - Target framework version aligned with M-Files 25 (VAF 25.3). - Logging expanded to trace task lifecycle and outcomes for context menu operations. - Harmonized routing for the three execution types to simplify configuration and troubleshooting.

  • UIX (User Interface eXtensions) - Adopted UIX v2 for the New Desktop experience; actions exposed through the new context menu. - Classic Desktop limitation: buttons are not rendered; use the UIX v1 package as a temporary workaround when Classic is required.

  • Web API - Tuned for reduced latency and improved resiliency when invoking server-side operations. - Aligned with VAF updates for consistent parameter handling and logging correlation.

  • Wrapper assemblies (.NET) - Upgraded to .NET Framework 4.8. - Stability and performance improvements when marshalling parameters and processing results. - Logging enriched to surface actionable error details to SQL-side logs and VAF traces.

  • SQL (procedures, tables, functions) - Adjustments to support consolidated operation types and improved correlation IDs in logs. - Procedures invoked via context menu and workflow/event triggers aligned with updated routing. - No behavioral changes required for standard table updates; review individual object docs for specifics, e.g. spMFUpdateTable, spMFUpdateMFilesToMFSQL.

SQL object changes (highlights)

The following procedure/function updates were made as part of the initial Release 5 rollout. See each object page for full details.

  • spMFDeleteHistory — Add @BatchSize parameter (default 2000), switch to batched deletes to reduce locks, improved error handling and progress logging. (2025-01-05)

  • spMFProcessBatchDetail_Insert — Returns ProcessBatchDetail_ID to enable accurate duration calculation at detail step level. (2025-07-02)

  • spMFLogProcessSummaryForClassTable — Handle MFSQL_Message being NULL when composing log summaries. (2025-07-30)

  • spMFCheckLicenseStatus — Reduce ProcessBatchDetail log noise during routine checks. (2025-05-27)

  • spMFGetLicense — Culture-safe datetime formatting for license expiry handling. (2025-01-07)

  • spMFDropAndUpdateMetadata — Include Text and Multi-line Text in WithColumnReset processing. (2025-05-06)

  • spMFUpdateTableinBatches — Fix: updates from SQL→MF when only new objects present in list (2025-05-21); Guard: prevent update when @objids is NULL; suppress unwanted messages (2025-04-30)

  • fnMFRemoveIllegalXMLCharacters — New helper to sanitize illegal XML characters in strings. (2025-06-13)

  • fnMFObjectHyperlink — Update to support new-style web hyperlinks. (2025-08-19)

  • fnMFExcelObjectHyperlink — Update to render new-style web hyperlinks in Excel-friendly output. (2025-08-19)

Compatibility and prerequisites

  • Windows Server 2022 or later (installer uses 64‑bit ODBC).

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

  • .NET Framework 4.8.

Deployment impact

Run the upgrade on:

  • SQL Server (database objects and assemblies)

  • M-Files Server (VAF and UIX)

  • Web Server (if Web API is used)

5.x.x.x

Planned changes (post-initial)

The following items are planned for iterative updates in Release 5. Details and sequencing may evolve; refer to Future enhancements for the latest status.

  • Leverage M-Files Configurations to set up and operate the Connector - Configure MFSettings and MFVaultSettings from M-Files - Select classes to include and auto-create class tables in SQL - Manage custom class/property settings - Surface operational status (errors, ProcessBatch stats, usage dashboard)

  • Automate SQL procedures and views via Configurations - Curate custom procedures for class updates and reporting views - Use VAF to trigger automatic metadata structure updates in SQL

  • Reporting and metadata - Streamline reporting flows; improve ease-of-use and in-M-Files consumption - Continuous metadata sync without affecting transaction processing

  • Transaction processing - Reduce check-out/check-in operations and end-to-end processing time - Transition from XML to JSON payloads to remove XML limits and improve performance

  • Commercial - Evolve pricing to be more usage-focused