Skip to content
CtrlDocsSupport Portal

M-Files trace data configuration

The M-Files data source for a plot trace. Deliberately shaped to feel like — an object source (type/class/conditions/relation) plus Label / Value / Trace, and an aggregation — rather than the Querying engine's Series. Because M-Files has no GROUP BY, the aggregation is explicit here (the SQL source does it in the query); grouping is by Label and (optionally) Trace, which is the "double group-by" that the Plot View's SplitColumns used to cover, so SplitColumns is dropped. Values come in two shapes, chosen by . "Single property" is one series per Trace Property value (or one series) over the Value Property. "Several properties" is one series PER VALUE PROPERTY over the label axis - the value properties take the place of the trace property, which is then not used - so several counters on the same objects are aggregated from one pass over them instead of one visual, and one retrieval, per counter. Objects can be left out of a value: and take an object out of a measure's sum, mean and count when its value is empty or too small, without taking it out of the other measures or of the drill-down. Without them an empty counter is a zero that drags a Mean down. The Where conditions are written into the configuration; take their value from the current object or the signed-in user's employee object when the plot loads (the M-Files counterpart of the SQL source's parameters) - see . Retrieved against the permanent vault (the complete overview, like SQL plots), in internal batches, asynchronously, and cached — see CtrlPortals.API.GetTraceAsync.

Reached from M-Files Configuration on Trace configuration.

Settings

Object Type

Type
M-Files object type

The object type to retrieve and aggregate.

Class

Type
M-Files class

Optionally restrict to a single class.

Where

Type
Search conditions JA

Search conditions to filter the objects. The current user can be referenced with the -100 placeholder; for a value read from the current object or the user's employee object, add a condition from the context below.

Conditions from the context

Type
List of Plot context condition

Search conditions whose value is read when the plot loads, from the current object (the one whose portal the plot is on) or from the signed-in user's employee object - a property of it, or the object itself for 'Responsible is me' - and added to the Where conditions. A plot that needs an object or an employee it does not have - on a dashboard, or for a user without an employee object - or whose value is empty on that object, is not shown; it says why in its place.

Settings on each entry — 4 of them

Indirect Relation

Type
M-Files property

A property used to find objects that are indirectly related to the current portal object.

Aggregation

Type
One of a list
Default
Count

How to aggregate each group. Count needs no value property; Sum and Mean aggregate the Value Property. Default: Count.

  • Count
  • Sum
  • Mean

Label Property

Type
M-Files property

The property whose value forms the label axis (each distinct value becomes a group).

Values

Type
One of a list
Default
Single property

Shown when Aggregation is Sum or Mean.

Single property: one series (or one per Trace Property value) over the Value Property. Several properties: one series per value property below, over the Label Property, all from one pass over the objects; the Trace Property is not used. Default: SingleValueMode.

  • Single property
  • Several properties

Value Property

Type
M-Files property
Accepts
Integer, Integer64, Floating

Shown when Aggregation is Sum or Mean and Aggregation is Sum or Mean and Values is not Several properties.

The numeric property to Sum / Mean. Not used for Count.

Value properties

Type
List of Plot value property

Shown when Aggregation is Sum or Mean and Aggregation is Sum or Mean and Values is Several properties.

Each is aggregated with the Aggregation above, as its own series, from one pass over the objects. Sort by Value uses the first.

Settings on each entry — 2 of them

Trace Property

Type
M-Files property

Shown when Aggregation is Sum or Mean and Values is not Several properties.

Optionally split the data into multiple traces by this property (a second group-by). Not used with several value properties, which are the traces then.

Ignore empty values

Type
Yes or no

Shown when Aggregation is Sum or Mean.

Leave out objects whose value property is empty. Otherwise an empty value counts as 0, which drags a Mean down. Applies to every value property. Default: no.

Minimum value

Type
Number

Shown when Aggregation is Sum or Mean.

Leave out objects whose value is below this - for example 1 to skip counters standing at 0. Empty means everything counts. Applies to every value property.

Round Date/Time Unit

Type
One of a list

If the Label Property is a date/time, round it to this unit before grouping (e.g. group by month). For example, rounding to the nearest week converts dates to the Monday of their week.

  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Sort By

Type
One of a list

Optionally sort the points by their label or their aggregated value.

  • Label
  • Value

Sort Direction

Type
One of a list

The sort direction.

  • Ascending
  • Descending

Cache lifetime (minutes)

Type
Whole number
Default
30

Results are cached for this many minutes to reduce server load. 0 disables the cache. We recommend no less than 5 minutes. Default: 30.

Generated from CtrlPortals 3.26.9.53.