Skip to content

M-Files Essentials configuration

M-Files Essentials 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.

The configuration has two branches, each holding one section per utility.

Each utility also has its own page under those headings in the sidebar, listing every setting it has. The mapping types a utility points into — an object type mapping, a rule, a notification — get their own pages too, and every page 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

Object Utilities

Type
Object utility configuration

Utilities related to working with M-Files objects.

Settings in this group — 14 of them

Workflow Utilities

Type
Workflow utility configuration

Utilities related to working with M-Files workflows.

Settings in this group — 4 of them

Main configuration settings, generated from M-Files Essentials 0.26.6.1.

Object utilities act on objects and their properties when an object is checked in: naming, identifiers, references, validation, published copies and records.

Workflow utilities act on where an object is in its workflow: due reminders, how long it has been somewhere, comments on a transition, and holds.

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.

Reading one utility’s page teaches you how to read the rest.

Enabled comes first and is off by default. Everything below it is inert until it is on.

A trigger — a search condition evaluated against the object being checked in. Leaving it empty matches everything of the configured type, which is rarely what is wanted.

Mappings are lists, one entry per object type or class that should behave differently. Each mapping usually has its own conditions and its own default.

A default value applies when no mapping matched. This is what happens to the objects nobody had in mind, so it is worth setting deliberately rather than leaving empty.

Some settings on these pages say they have no description in the application. That is accurate rather than a gap in the documentation: the setting carries no help text in the C#, so nothing is shown in M-Files Admin either. The Workflow Due Reminder utility is the largest gap.

Where that happens, the setting’s name and type are all the application offers, and it is worth asking before guessing.