Skip to content
CtrlDocsSupport Portal

Set up CtrlSync

By the end of this section one SharePoint library or Teams channel is synchronising with the vault.

Time: two to three hours for a first deployment. Most of it is the Entra ID registration and waiting for admin consent.

Who you need: someone with administrative access to the vault, and someone who can register an application in Microsoft Entra ID and grant admin consent for application permissions. These are usually two different people at the customer, and not lining them up in advance is the most common cause of a stalled deployment.

Before you start

Section titled “Before you start”
  • Administrative access to the target vault through M-Files Admin.
  • A Microsoft 365 tenant, and someone who can grant admin consent.
  • The CtrlSync .mfappx file and its .lic licence file.
  • An agreed window for a vault restart.
  • TLS 1.2 enabled on the server — see Enable TLS 1.2 on Windows Server if it is an older build.

Steps

Section titled “Steps”

  1. Register the Entra ID application.

    Create the registration, add the Graph permissions CtrlSync needs, and have an administrator consent to them. See Register the Entra ID application.

    Check: the permission list in Entra shows each permission as granted, not as Not granted.

  2. Install the application and its licence.

    Follow Install a vault application, then Install a vault application licence.

    Check: CtrlSync appears under the vault’s Applications node and the vault has been restarted.

  3. Create the vault structure.

    The object types and properties CtrlSync reads and writes, including the connection object type that names each SharePoint site or Teams channel. See Vault structure.

    Check: you can create a connection object by hand and fill in every property the configuration will ask for.

  4. Enter the Graph credentials.

    Put the tenant ID, client ID and client secret into the Graph settings, and save.

    Check: the application status in M-Files Admin reports no configuration or authentication error.

  5. Synchronise one connection.

    Create a single connection object pointing at one library or channel, make it active, and let it run. Add the rest only once this one has worked.

    Check: documents from that library appear in the vault, and a change made in the vault reaches the library on the next cycle.

If something goes wrong

Section titled “If something goes wrong”

See Troubleshooting. The first thing to check is the application status in M-Files Admin, which lists configuration errors directly.