Skip to content

CtrlSync configuration

CtrlSync is configured in M-Files Admin, under the vault’s Applications node. Every setting on these pages is generated from the configuration classes in the shipping application, so it describes the version you have rather than the version someone last wrote about.

Three areas carry real narrative and have their own pages: General settings for the Graph credentials and the schedule, Document configurations for what happens to an incoming file, and Property mappers for turning a path or a Graph value into metadata.

Everything those point into has a page under Setting groups in the sidebar, and every one of those says which setting reaches it.

Sections

Logging

Type
NLog logging configuration

This setting has no description in the application yet.

Settings in this group — 7 of them

Microsoft Graph configuration

Type
Graph configuration

Configuration for Microsoft Graph API integration.

Settings in this group — 19 of them

Employee Configuration

Type
Employee configuration

Configuration for employee data synchronization.

Settings in this group — 3 of them

Connection Configurations

Type
List of Connection configuration
Default
[]

Configuration for synchronization of documents from connections.

Settings on each entry — 27 of them

Synchronization frequency

Type
Frequency
Default
Every 10 minutes

Frequency at which synchronization operations are performed.

Settings in this group — 3 of them

Maintenance Frequency

Type
Frequency
Default
Every hour

Frequency at which maintenance operations are performed. These include connections that have entered an error state.

Settings in this group — 3 of them

Max Batch Processors

Type
Whole number
Default
1

Maximum number of batch processors to use. Each processor handles one batch of synchronization operations concurrently.

Batch Size

Type
Whole number
Default
100

Number of synchronization operations to process, at most, in each batch.

Main configuration settings, generated from CtrlSync 0.26.6.0.

Graph is the connection to Microsoft 365 — the tenant, client and secret — and the properties CtrlSync writes onto connection objects and the documents it imports.

Connections decides which classes of connection object CtrlSync acts on, and how it treats each one.

Documents decides what an incoming file becomes: its class, its workflow, and which property mappers run over it.

Employee maps an M-Files login account to the object representing that person, so an author imported from Microsoft 365 resolves to somebody in the vault.

Logging and email come from the M-Files framework rather than from the application itself, and are identical everywhere, so they are documented once at Logging and email.