M-Files provides partners with a Visual Studio 2015/2017/2019 template that can be used to rapidly develop Vault Application Framework Applications using C#.

When installing the template into Visual Studio 2017 and 2019, a popup will be shown stating that the template does not use the 2017 format. This is expected, as the template is backwards compatible with Visual Studio 2015 as well. Simply accept the popup and continue installation.

Downloading the Template

The Vault Application Framework 2.1 template is part of the M-Files Online Visual Studio template package, which can be downloaded from the M-Files Partner Portal. If you are a partner and do not have access to the M-Files Partner Portal, then please contact your Channel Account Manager. To install the template, simply double-click on the “.vsix” file, which will then guide you through installing the templates into the version of Visual Studio that you have installed.

Both Vault Application Framework 2.0 and Vault Application Framework 2.1 project templates are included in the same package. The 2.1 runtime is only compatible with M-Files 19.9 onwards, so 2.0 should be used if targeting older installations.

Building your first application

In this example we will create a basic Vault Application Framework application and install it into the Sample Vault, running on the local machine.

If you do not have M-Files installed on the same machine as Visual Studio, then you must deploy the zip file manually. Debugging can be undertaken on remote applications by following these instructions.

Creating an application from the template

Creating a new Vault Application Framework application can be done from within Visual Studio by clicking File, New, Project, then selecting M-Files Vault Application 2.1 From the list of Visual C# templates:

Creating a new project

An overview of the project contents

The project contents

The default project contains a number of items:

  • appdef.xml The application manifest file, containing information such as the publisher details and the current version number.
  • Configuration.cs The configuration class used by the Vault Application Framework application.
  • install-application.ps1 A PowerShell script used to deploy the installation package to the local M-Files server.
  • VaultApplication.cs The actual Vault Application Framework application.
  • packages.conf The packages configuration file details the Nuget packages that are required for the Vault Application Framework to run.

The default application

The default application

The template automatically creates a VaultApplication class, which is the entry point to your application. This class derives from the VAF 2.1 base class and defines that the Configuration class is used for configuration.

To customise this default application, check out our samples and libraries or other tutorials.

The PowerShell script

The PowerShell script has not changed from the VAF 2.0 version.

Building and deploying

Building and deploying has not changed from the VAF 2.0 version.

Debugging

Debugging has not changed from the VAF 2.0 version.

Tips and tricks

Please also see the tips and tricks for the VAF 2.0 version, as they also apply here.

Nuget packages and versions

The Vault Application Framework 2.1 release requires Newtonsoft.Json (JSON.NET) version 10.0.3.