This page refers to running Vault Application Framework applications within the M-Files Cloud infrastructure. These notes may not be applicable when running code within other cloud infrastructures, such as those provided by our partners.
In order to maintain a high quality of service for customers within our Cloud infrastructure, any code (Vault Application Framework or VBScript) must first be validated by our Cloud Ops department before it can be run within the M-Files Cloud. This applies to both premium and standard cloud offerings. Please note that code validation incurs a charge depending upon the complexity of the code needing validation. For more information please speak to our support team who can organise an estimate.
To request code validation, please open a support ticket via firstname.lastname@example.org. The support team will request details on the vault it is to be installed into and your code to be validated.
- The time required for validation will depend heavily on the complexity of the application. If the application is large or complex then this may be worth discussing with the support team prior to initial development.
- There will be some “lead time” on the validation so ensure that this is noted within your project plans. Try to reserve at least two weeks, but longer may be needed for complex applications, situations where validation takes a number of iterations, or during common vacation times. If you have specific deployment deadlines then please let us know as early as possible so that we can allocate resources.
- Validation is done “per version”; if you make changes in the future then these may be subject to additional validation.
- The validation team will require the source code to your VAF applications, including the source code of any libraries . Common libraries (e.g. Newtonsoft) can be referenced from nuget. Libraries provided by a trusted entity (e.g. libraries signed by Microsoft or other reputable sources) may be accepted without source code. If in doubt, please contact us prior to initiating the validation process. We reserve the right to make minor changes to enable validation to pass.
- The validation team will compile the code themselves, and it is this compiled code which will be delivered to the cloud operations team to install. Ensure that all solution files, project files, resources, imagery, libraries or other references are included in the supplied package. Good practice is to take the package you are delivering onto another machine and attempt to compile it using just the files in the package. If it does not compile for you there then it will not compile for us here.
Rules of thumb
- Do not provide source code that includes credentials. We will store your application inside our source control system (for quicker validation of changes), and our Quality Management procedures prohibit us from storing code that includes credentials.
- Be aware that code may run in a shared environment, so try and be as lightweight as possible.
- Ensure that you do not touch anything outside of the vault (e.g. filesystem, registry, etc.), as the host Windows machine can be switched out and your changes will be lost.
- Be careful when designing solutions that use external resources; connections to external network addresses are typically denied, and sending email could be a potential avenue for abuse.
- Process objects in a batched way (GetPropertiesOfMultipleObjects, CheckOutMultipleObjects, CheckInMultipleObjects, etc.), where possible, as this is vastly more efficient than processing individual items.
- If you need multiple properties on an object, consider retrieving all the properties in one call rather than one-by-one, as this is vastly more efficient.
- Do not perform operations that have a significant overhead in a frequently-called background operation.
- If working with files, consider accessing the content via a byte array (DownloadFileInBlocks), rather than downloading and then re-reading the file.
This checklist is provided for initial guidance only and details the common items that will be checked by the validation process. Adherence to this checklist does not ensure validation will be successful, but should reduce the time (and potential iterations) required.
If a vault application does not comply with the validation checklist then we will - where feasible - provide guidance on how to modify the application so that it will be compatible. It is your responsibility to implement these changes and to confirm that the application continues to work as expected.
This checklist is a living document and is periodically updated with feedback from our Cloud Operations and Product Development teams.
The validation team will check a number of items in the source code, including:
- The application must not attempt to modify any Windows-level settings.
- The application must not install any Windows applications or reboot the server.
- The application must not excessively use server resources, even in dedicated environments.
- Note that many cloud implementations use shared environments, so any intensive operation might be cause for concern.
- The application must not access the file system, aside from utilizing short-lived temporary files. Treat the filesystem as transient as changes will be lost as the host machine is upgraded/migrated.
- The application should not access the registry.
- Use temporary folders for storing temporary files (use the SysUtils class to obtain temporary files and folders).
- Temporary files, handles, and other resources must be properly disposed of.
- File operations (upload/download) using the M-Files API are typically restricted.
- The application must not attempt to access or modify any server-level settings in M-Files (login accounts, scheduled jobs, etc.).
- The application must not connect to arbitrary internet addresses. Connections to specific addresses may be allowed. Note that connections may be allowed where the web address is only configurable by the M-Files Cloud Ops teams - please contact support for more details.
- If the application must send emails directly then it must use the customer’s own mail servers for doing so.
- The application must not attempt to establish separate connections to the vault.
- The application must not attempt to alter anything outside of the vault during the initialization routines.
- The application must not run input as code.
- Do not log errors to the Windows event log.
- Your application must be Multi-Server Mode-compatible to run in the New Cloud, and is highly recommended for new M-Files Vault Application Development in general. After a short transition period this will become a mandatory requirement for all applications that are to be installed in cloud.