CtrlPortals configuration
CtrlPortals 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”Beyond those, a setting sometimes points into a further group of settings — a plot’s traces, a trace’s SQL query, a portal’s theme. Those groups each have their own page under Setting groups in the sidebar, and every page says which setting reaches it.
The top level
Section titled “The top level”These are the sections you see when you first open the CtrlPortals configuration.
Sections
Portals
The portals that are available in the application. These are displayed in the right pane for an object when the user clicks on an object.
Dashboards
The dashboards that are available in the application. These are displayed in the main pane of M-Files and are not related to any specific object.
Dashboard groups
The dashboard groups that are available in the application. These are used to group dashboards together in the main pane of M-Files.
Comment configuration
The comment configuration is used to facilitate more advanced comment features, including replying to comments and editing comments. These features are optional and require your vault to be specifically configured with a Comment object and a set of specific properties. The fallback behavior for Portals is to present version comments in comment threads.
Employee configuration
Use this to configure Portals to work with an Employee object. This is not required, but many features of Portals depend on Employee objects. These features will be unavailable otherwise.
Query engine configuration
Use this to configure CtrlPortal's query engine parameters.
Data Sources
Use this to configure CtrlPortal's data sources for plotting, etc.
Portal configuration
Use this to configure Portal behaviour parameters.
Use server SMTP configuration
Set to true to use the server's SMTP configuration instead of the custom configuration below. (Not for cloud) Default: no.
SMTP Configuration
Shown when not (Use server SMTP configuration is Yes).
This setting has no description in the application yet.
Global Theme
Use this to configure a global theme for dashboards and portals (Can be overridden by each portal or dashboard)
Revision
Bumped by the server on every save of the configuration's own members (everything but the portals and dashboards, which carry revisions of their own), and what a later save is merged against (ItemSave). The editor sends it back untouched. Not for hands.
Main configuration settings, generated from CtrlPortals 3.26.9.53.
What each section is for
Section titled “What each section is for”Portals are shown in the right-hand pane when a user selects an object; dashboards are shown in the main pane and belong to no object. Dashboard groups decide how dashboards are grouped and which user groups see them.
Comment configuration and employee configuration are optional, and go together: threaded comments need an object type of their own and an Employee object to attribute them to.
Query engine configuration and data source configuration are what anything showing data reads through — caching and limits for the first, SQL connections for the second.
Portal configuration and theme are general client behaviour and appearance.
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.
A note on conditional settings
Section titled “A note on conditional settings”Many settings only appear once something else is set — a plot’s pie label layout is only shown once the plot type is Pie. Where that is the case, the setting says so. It is the same rule the configuration editor in M-Files Admin uses, read from the same place in the code.