CtrlShare configuration
CtrlShare is configured in M-Files Admin, under the vault’s Applications node. Every setting here is generated from the configuration classes in the shipping application, so this describes the version you actually have rather than the version someone last wrote about.
How the configuration is organised
Section titled “How the configuration is organised”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.
The top level
Section titled “The top level”Sections
General
General CtrlShare behaviour: the document preview tab, the dialog Help link, and the command visibility toggles.
M-Files Configuration
Maps the document metadata properties and person mappings CtrlShare uses to track and share co-authored documents in this vault.
OneDrive for Business
The Microsoft Entra app registration CtrlShare uses to reach OneDrive for Business and the authorization code of the connected account.
Access Control
Who may use CtrlShare co-authoring and which documents are eligible: the user-group and document-condition whitelists. Leave both empty to allow every licensed internal user and every compatible document.
Workflow Mappings
When an object enters the configured state, the document is auto-checked-out to co-authoring and shared with the users referenced by the Viewer/Editor properties. While co-authoring is in progress the document cannot leave the state - by a user or by an automatic state transition - until it is checked back in with the CtrlShare Check In command (or discarded with Undo Check Out).
Localization Configurations
One entry per UI language. Translates every command, dialog, and email string CtrlShare shows. The entry marked Default is used when the user's M-Files language has no matching entry.
Main configuration settings, generated from CtrlShare 2.26.8.0.
What each section is for
Section titled “What each section is for”General holds the preview tab, the help URL, and which CtrlShare commands appear on a document. Hiding a command is how a deployment makes sessions start only from a workflow state.
M-Files names the properties CtrlShare writes to while a document is out — the file identifier, the links, and who it is shared with.
OneDrive is the connection: the Entra ID application, and the authorisation granted against one service account. See Add a OneDrive account.
Access decides which user groups may start a session at all.
Workflow mappings start a session automatically when an object enters a state, rather than waiting for somebody to choose the command.
Localisation holds every user-visible string, which is what makes the commands translatable.
A note on setting names
Section titled “A note on setting names”Four settings in the OneDrive area are stored under Microsoft’s own lower-case names —
client_id, client_secret, redirect_uri and authorization_code. Renaming them would break
every existing configuration, so they have been left alone.
M-Files Admin shows them by label — Client ID, Client Secret, Redirect URI, Authorization Code — and so do these pages. The lower-case names are what you see when reading the stored configuration directly out of named value storage, which is worth knowing before going looking for Client ID in the raw JSON.
Settings without a description
Section titled “Settings without a description”CtrlShare’s localisation section holds around a hundred settings that are each a single user-visible string. They carry a label and no help text, which is correct — the label is the documentation. Elsewhere, a setting with no description is a gap in the application rather than in these pages, and is worth reporting.