M-Files Cloud and other hosted installations¶
Part of the MFSQL Connector installation occurs in the vault and therefore impacts a cloud vault. M-Files also requires all vault applications to be certified for installation in the cloud.
The MFSQL Connector vault application is certified and has a special edition that is signed for usage in a cloud vault. This edition of the VAF is available in the installation folder 60-Addons.
The vault application has several important functions. Configuration of the vault application will depend on how MFSQL is used.
The VAF is always required and must be licensed to be able to use the tool.
The Web API installation and associated configuration is only required if context menu functionality is applied in the deployment.
The logging configuration is only applicable for debugging and monitoring of the context menu functionality.
Installing MFSQL Connector for an M-Files Cloud vault has a number of specific steps to follow as part of the installation. Some of the steps may have to be done by M-Files Cloud Support.
Follow these steps:
1. Pre-installation.
Ensure that the MFSQL Connector user is created in the target vault. Ensure that M-Files Desktop is installed on the SQL Server and that M-Files on the SQL Server has access to M-Files through the MFSQL Connector user on the M-Files Desktop. Provision a Web Server with access to the SQL Server. This is only required if MFSQL Context Menu functions will be used in the deployment.
2. Run package. Run the MFSQL Connector installation package on the SQL Server using On Premise Installation with the following considerations:
Select the Cloud option in the “Location of M-Files Vault” window.
Note that the installation package will skip the window to log into the M-Files Server.
3. Complete M-Files login details.
Enter the following data in the installation window for the credentials: - Vault Name - MFSQL user name and Password - Change the protocol to HTTPS or gRPC depending on New Cloud (gRPC) or Classic Cloud (HTTPS). - Set the endpoint to the required port (e.g., 4466, 7766 or 443). - Update the M-Files version on the SQL Server. - Add the M-Files Server full URL for the cloud vault.
4. Complete installation.
Complete the installation of the package as outlined in the on-premise installation procedure.
5. Enable Context Menu functionality.
The Web API is required when M-Files will be used to action SQL procedures. The Web API allows calling the SQL Server from the M-Files Cloud vault.
Follow the Installing the Web API instructions for installing this functionality. Make a note of the username and password; these will be added later to the VAF configuration. The API URL will also be required in the next step.
6. Install the VAF on the cloud vault.
New Cloud installation allows the administrator to perform the majority of the VAF installation.
In Classic Cloud installation, create an M-Files support ticket to install the MFSQL Connector VAF in the vault. Pass the signed installation package to support for installation.
Note
Include the signed VAF package and the API URL when contacting M-Files support.
M-Files will install the VAF, add the API URL and run the content package to update the vault.
7. Finalize the Web API setup.
Provide the API URL to M-Files support to be added to the settings. This setting is only available for system administrators.
On confirmation that the VAF is installed, update the MFSQL Connector VaultApp in M-Files Admin by adding the username and password.
8. License and check.
Add the license for the MFSQL Connector VAF.
Right-click Configurations and select Refresh. Check the dashboard; this should now show the details of the settings in the SQL Server.
