Install the Web API

Overview

The MFSQL Connector Web API is a separate package. It is not installed by the main Installer. Use it when the M‑Files Server and SQL Server are in different domains (e.g., M‑Files Cloud) so that context menu actions can securely call SQL over HTTPS.

When to use

  • Cross‑domain or cloud deployments where ODBC direct connections from VAF to SQL are not possible.

  • Optional for on‑prem deployments in the same domain; VAF can call SQL directly without the Web API.

Prerequisites

  • IIS 7+ with HTTPS binding and a valid certificate

  • Service account for the application pool, with outbound access to SQL

  • Connectivity from the web server to the SQL instance/port used by MFSQL Connector

Install steps (summary)

  1. On the web server, create an IIS site (or application) with HTTPS.

  2. Copy and extract the MFSQLConnectorWebAPI ZIP from the Installer folder (60_Addons) to the site folder.

  3. Configure the site/application pool identity and start mode.

  4. Update web.config: - Set the SQL connection string to the MFSQL Connector database (e.g., user MFSQLConnect and password). - Set the Web API shared username/password (used in M‑Files configuration).

  5. Start IIS and browse to the Web API URL to verify it loads (e.g., https://server/MFSQLConnectorWebAPI).

  6. In M‑Files Admin → Configurations → MFSQL Connector → Web API Details, enter the URL and the shared credentials.

  7. Test a context menu action and confirm it executes on SQL.

Full guide

For detailed, step‑by‑step instructions and screenshots, see: