Common installation notes

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

Installation package overview

  • Single installation package

  • Installs the MFSQL Connector components on both M‑Files and SQL servers or a workstation.

  • Transfers and installs files for the MFSQL Connector application to the machine.

  • The destination machine is determined by the selected installation mode.

  • Requires M‑Files Desktop on the machine where the installer runs.

  • The installer user must have M‑Files System Admin (temporary) and SQL sysadmin rights.

  • Can be run multiple times to add components or re-run failed steps.

  • The main Installer does not install the Web API. Deploy this separately from the files in installation folder when M‑Files and SQL are in different domains (e.g., M‑Files Cloud).

  • Context Menu is 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.

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

  • The Web API is not required for on‑prem single‑server or split‑server in the same domain where the VAF connects directly to SQL.

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.