Feature Compatibility Matrix

Version 2.2

Version 2.2 of the Vault Application Framework is compatible with M-Files 20.5 upwards. To target earlier versions of M-Files, please use an earlier version of the Vault Application Framework.

Alongside numerous internal bugfixes and performance work, this release brings compatibility with the M-Files Multi-Server Mode functionality. This version can also be used on single-server implementations of M-Files, provided the M-Files server version is at least 20.5.

In this release, if inheriting from ConfigurableVaultApplicationBase, the Vault Application Framework will only find and resolve MFIdentifier instances created on your Configuration class. If you are using MFIdentifier instances in other locations (e.g. directly on your VaultApplication class) then note that these will not automatically be resolved at vault startup.

Version 2.1

Version 2.1 of the Vault Application Framework is compatible with M-Files 19.9 upwards. To target earlier versions of M-Files, please use an earlier version of the Vault Application Framework.

Alongside numerous internal bugfixes and performance work, this release brings four new major features:

• The Vault Application Framework is now published to NuGet. This allows us to publish more easily - and faster - Vault Application Framework versions, and for code to be upgraded to use these new versions.

• Ability to define security constraints in configuration.

• Commands can be added to various built-in areas in the M-Files Admin Configurations area screens.

• Buttons within dashboards can call server-side code when clicked.

In addition, please note that there are two changes in method signatures from version 2.0. Both of these changes are implemented to work around situations where code attempts to start background operations when the vault may not yet be fully operational:

• BackgroundOperationManager.StartRecurringBackgroundOperation now returns a Task<BackgroundOperation>, a change from BackgroundOperation in VAF 2.0.
• BackgroundOperationManager.RunOnce now returns a Task, a change from void in VAF 2.0.

Version 2.0

Version 2.0 of the Vault Application Framework is compatible with M-Files 2015.3 upwards. Please see the note below regarding configuration compatibility with M-Files 2015.3.

Alongside numerous internal bugfixes and performance work, this release brings two new major features:

• Licensing

• Compatibility with the M-Files 2018 Administration Configuration interface

Configuration compatibility

Version 2.0 of the Vault Application Framework introduces a new pattern for exposing application-specific configuration into the M-Files 2018 Admin interface. As M-Files 2015.3 (and earlier) do not contain this section within the M-Files Admin interface, it is recommended that the earlier configuration approach (which continues to work in Version 2.0) is used for compatibility with M-Files 2015.3 systems.

Version 2.1 of the Vault Application Framework extends this configuration ability, allowing developers to instruct the user interface to mask values that are entered (e.g. passwords), to restrict sections of configuration so that only server administrators (not vault administrators) can change the values, and to add buttons to the dashboard which run server-side code.

Version 1.0

Version 1.0 of the Vault Application Framework was released in early 2016. This release included a wide variety of functionality, including:

• Attribute-based automated installation of scripts into the M-Files vault, including workflow state actions, property calculations, event handlers and more.
• Background operations
• Helper objects to aid working with the M-Files vault and Microsoft Windows environment.
• Search helpers

Name-Value Storage Configuration

The initial release of the framework supported configuration attributes that were used to mark up configuration objects used by each application. These configuration objects were serialised into Name-Value storage, and the Name-Value Storage Manager could be used to alter them at runtime.

The 2.0 release of the framework introduced another approach which integrates with the new configuration administration interface in M-Files 2018. It is recommended that applications that target M-Files 2018 and upwards migrate to the new version.

Upgrading versions

When you upgrade the Vault Application Framework you may need to make some small changes due to changes in class namespaces or method signatures.

From Version 2.1 to Version 2.2

New VAF 2.2 applications can be created using the M-Files Online Visual Studio template. Projects using the Vault Application Framework 2.1 nuget package can be manually upgraded to use the Vault Application Framework 2.2 runtime:

• Right-click on the project name and select Manage NuGet Packages...
• Select the existing M-Files.VAF reference and click the Update button to upgrade to the latest published 2.2 version.

To upgrade your VAF 2.2 application to be compatible with M-Files Multi-Server Mode, please follow the online conversion guidance.

If inheriting from ConfigurableVaultApplicationBase, the Vault Application Framework will only find and resolve MFIdentifier instances created on your Configuration class. If you are using MFIdentifier instances in other locations (e.g. directly on your VaultApplication class) then these should be moved into your Configuration class to continue to be resolved automatically. Alternatively you can call MFIdentifier.Resolve at runtime to manually resolve the items.

From Version 2.0 to Version 2.1

New VAF 2.1 applications can be created using the M-Files Online Visual Studio template. Projects using the existing Vault Application Framework 2.0 template need to be manually upgraded to use the Vault Application Framework 2.1 runtime:

• Open the existing project in Visual Studio.
• Locate the Solution Explorer window, and find the VAF project within the solution.
• Expand the project’s References node and delete the existing references to:
  • MFiles.Crypto
  • MFiles.VAF
  • MFiles.VAF.Configuration
  • MFilesAPI
• Right-click on the project name and select Manage NuGet Packages...
• Select the existing M-Files.VAF reference and click the Update button to upgrade to the latest published 2.1 version.

It is recommended to update your entry point class (typically VaultApplication) to use the new base class. This will require some changes to your code but is required to enable some of the new VAF 2.1 functionality. A sample on how to convert a VAF 2.0 application to VAF 2.1 is also available.

From Version 1.0 to Version 2.0

New VAF 2.0 applications can be created using the M-Files Online Visual Studio template. To upgrade an existing VAF 1.0 application to 2.0, the following steps need to be taken.

• Create a blank VAF 2.0 application from the updated template.
  • From the new application, locate the MFiles.VAF.dll, MFiles.VAF.Configuration.dll and MFiles.Crypto.dll files.
• Open the existing VAF 1.0 application in Visual Studio:
  • Update the references
    • Expand the References node in Solution Explorer.
    • Locate and delete the existing MFiles.VAF.dll reference.
    • Add a reference to MFiles.VAF.dll, MFiles.VAF.Configuration.dll and MFiles.Crypto.dll from the VAF 2.0 release.
    • Use nuget to update the Newtonsoft.JSON reference from 6.0.x to 10.0.3.
  • Resolve any namespace issues, for example:
    • MFIdentifier (and other configuration attributes) have moved from MFiles.VAF.Common to MFiles.VAF.Configuration.

At this point the VAF application can be altered to support 2.0 features such as licensing and integration into the M-Files 2018 Administration Configuration interface.