Common installation notes

Use these notes across all topologies; scenario pages call out only what differs.

Packages overview

  • Main installation package - Transfers and installs files for the MFSQL Connector application. - Can be run on a developer desktop, the M‑Files Server, or the SQL Server. In dev/test these are often the same machine.

  • Web API package (separate) - The main Installer does not install the Web API. Deploy this separate package when M‑Files and SQL are in different domains (e.g., M‑Files Cloud). - Quick start: Install the Web API — Detailed: Installing the Web API.

Context Menu (optional)

  • Only needed when SQL processes must be triggered from M‑Files via context menu actions.

  • New Desktop support uses UIX v2 and is available from Release 5.

  • Classic Desktop can use a UIX v1 fallback package.

When to use the Web API

  • Required for context menu actions in cross‑domain setups such as M‑Files Cloud (M‑Files ↔ Web API ↔ SQL).

  • Not required for on‑prem single‑server or split‑server in the same domain where the VAF connects directly to SQL.

  • Prerequisites include IIS with HTTPS and a web server with access to the SQL Server; see Install the Web API.

Where installer outputs go

  • The installer writes all outputs (VAF package, scripts, utilities, example scripts, and optional UIX/Web API packages) to the chosen install folder.

  • See the overview in Planning and prerequisites for itemized contents.