The Vault Application Framework

Overview

Why use the Vault Application Framework?

Longevity

Microsoft has announced that VBScript is starting a deprecation process; future versions of Microsoft Windows will not include VBScript by default then, later, future versions will remove it entirely. It is strongly recommended that new customisations are written using the VAF to avoid this limitation.

Improvements over VBScript

Strong typing

Because C# is strongly typed, the compiler will highlight incorrect usages of the API well in advance of your users. For example: the compiler can identify if you try and pass a PropertyValue into a method that expects a TypedValue. This improves the quality of your solution by reducing the number of runtime errors that may be encountered.

Reduction in lines of code

Due to the design of the Vault Application Framework, the number of lines of code that you need to write is reduced. Functionality such as automated resolution of vault item aliases to internal IDs at runtime, along with helper utilities for building searches or outputting error conditions to the event log, mean that applications can be built faster and with a higher quality.

Utilisation of .NET Framework Class Library, and other .NET libraries

Because the Vault Application Framework is based upon .NET 4.5, applications can utilise the functionality available in the .NET Framework Class Library. This includes helpers for serialization and deserialization, as well as Linq, ADO.NET, threading, regular expressions support and more.

What’s even better is that other .NET libraries can be referenced for example, using NuGet. These packages can make complex processes simple such as wrapping access to web services, performing document manipulation, or providing logging frameworks. The power of these packages are available for you to utilise within your M-Files installations.

Better debugging

Debugging complex VBScripting can be time-consuming and frustrating. When using the Vault Application Framework, applications can instead be debugged within Visual Studio with full access to Visual Studio tools and resources. The Vault Application Framework even includes helper utilities for writing exception details to the Windows Event Log, where they can be reported on by standard monitoring software.

Simplicity of deployment

Deploying a Vault Application Framework application can be done simply using the M-Files Admin tool, which will automatically install event handlers and other code into their correct places within the M-Files Vault. Each application can additionally display a version number, which aids in identifying what code is running in each instance.

Additional functionality

Configuration

Built-in attributes such as MFConfiguration and MFIdentitifer reduce the boiler-plate code that is needed to manage tasks such as resolving vault aliases to M-Files IDs. Using this customisable configuration approach also provides a framework for identifying mandatory vault structure, and reporting out to the event log if the structure is not available.

Background Operations

Whereas most processes within M-Files typically operate synchronously, Background Operations allow you to execute periodic or time-consuming processes asynchronously, providing a smoother solution for your customers.

Helpers

Common functions such as building search conditions, or working with search results, are easier using built-in helpers. These extensibile helpers reduce the amount of code needed to be written, as well as providing more readable and more maintainable code for the future.

Versions

There are two public releases of the Vault Application Framework. Details are available on the dedicated Vault Application Framework version page.