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 |
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 (moved).
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)
Planned changes (next releases)¶
Release 5 are planned for iterative updates. Details and sequencing may evolve; refer to Future enhancements for the latest status.
The following changes where also included in this release:
spMFCommentForObjects: remove redundant code
spMFCheckLicenseStatus: code formatting changes; removed variable @LastcheckedDate_txt
spMFExportFiles: (fix bug where name_or_property column has been changed)
spMFCommentForObjects: remove redundant code
spMFCheckLicenseStatus: code formatting changes; removed variable @LastcheckedDate_txt
spMFExportFiles: (fix bug where name_or_property column has been changed)
spMFGetLicense: 2025-01-07 add culture check in datetime formatting; 2024-12-31 add additional variations of converting datetime for license; 2024-12-13 add additional debugging
spMFGetObjectvers: update notes; set default LastModifiedDate to ‘1985-01-01’
spMFInsertClass (Update MFObjectType_ID and Deleted in MFClass update (merge))
spMFUpdateMFilesToMFSQL: Improve handling of change history to suppress processing if no change history required
spMFUpdateObjectChangeHistory: 2024-04-28 resolve bug with batch item selection
spMFUpdateTableinBatches: update notes; resolve bug to stop full update when objid is null
Assembly LSConnectMFilesAPIWrapper: changes to elliminate illegal XML characters
MFLog: Quoted_Identifier is set to off
resolve issue that some of changes in previous version did not pull through in the package