| Field | Value | Description |
| Trigger | One of the following: • Object metadata changed • Object changed state • Object entered state • Object left state • OnComment • Orchestrated • Button click |
Type of event that triggers the execution of this rule. Object metadata changed. If this option is selected, rule will be executed only on any metadata change but not on file change. Object changed state. If this option is selected, rule will be executed when source object changes workflow state. Object entered state. If this option is selected, rule will be executed when source object enters specified workflow state. Object left state. If this option is selected, rule will be executed when source object lefts specified workflow state. On comment. If this option is selected, rule will run whenever a comment is added to the source object. Orchestrated. If this option is selected, rule will be run only from the orchestrator rule. Button click. If this option is selected, rule will be triggered on right click or from three dots menu. |
| Rule Groups>Group>Rule>Source filename wildcard | ||
| Action execution mode | One of the following: • MultiVersion • SingleVersion |
Determines how rule actions will be executed. MultiVersion – Each document change will create new version of a object. SingleVersion – All document changes will be committed in a single version. |
| Filename wildcard [n] | Text | Filename wildcards used to select files from object on which action will be executed. |
| Rule Groups>Group>Rule>Monitored property condition | ||
| Property | Property definition | Property whose value will be checked. |
| Monitor type | One of the following: • AnyChange • WithCondition | Any change – all changes will be monitored, and rule will be triggered on any property change. With condition – rule will be triggered on property change only if specified condition is satisfied. |
| Rule Groups>Group>Rule>Monitored property condition>WithCondition | ||
| Value from | One of the following: • CurrentVersion • PreviousVersion | Execute condition for property value in selected object version. |
| Operator | One of the following: • = • != • > • < • >= • <= • Contains • Does not contain • Starts with • Does not start with |
Operator for monitored property condition. |
| Value mode | One of the following: • Dynamic value • Static value • Empty value |
Property value to use in condition. Can be static or dynamic (from current object). |
| Value | Value | Property value to use in condition. |
| Rule Groups>Group>Rule>Trigger source | ||
| Object type | List of object types | Object type of source object. |
| Class | List of classes | Class of source object. |
| Workflow | Workflow | Workflow of source object. |
| State | Workflow state | Workflow state of source object. Note! If you have entered a state, you must also enter the workflow above. |
| Rule Groups>Group>Rule>Trigger source>Search filters | ||
| Search condition | Search conditions | Optional additional conditions that source object needs to satisfy. Conditions inside a single filter are combined with AND, while multiple filters are combined with OR operator. |
| Look in | One of the following: • Latest obj version • All obj versions |
When trying to match the above source conditions, look in all object versions, or only the latest one. Latest obj version. If this option is selected, the current object version must match the specified conditions for object to be treated as source for this rule. All obj versions. If this option is selected, any object version must match the specified conditions for object to be treated as source for this rule. |
| Rule Groups>Group>Rule>File action | ||
| Name | Text | Unique action name |
| Description | Text | Optional rule action description. |
| Enabled | Yes/No | Specifies whether the action is in use. |
| Action | One of the following: • RemoveElement • AddElement |
RemoveElement. If this option is selected, all matching elements defined by the XPath expression will be removed from the XML file on the source object. AddElement. If this option is selected, a new XML element will be added to the document at a specified location. The element is inserted relative to one or more target elements identified by a relative XPath expression, and its values can be static or populated from M-Files metadata or file data. |
| Action: RemoveElement | ||
| Name | Text | Optional unique action configuration name. |
| Xml element XPath expression | Text with placeholders | XPath expression used to select one or more Xml elements in the document. All matched elements will be removed when this action is executed. |
| Action: AddElement | ||
| Name | Text | Optional unique action configuration name. |
| Placement | One of the following: • AddAfterElement • AddBeforeElement • AddAsChildElement |
AddAfterElement. New element will be added after the specified element. AddBeforeElement. New element will be added before the specified element. AddAsChildElement. New element will be added as a child element of the specified element. |
| Relative Xml element XPath | Text with placeholders | XPath expression that identifies one or more target XML elements in the document. The new element will be inserted relative to these targets — either as a child, before, or after the matched elements. |
| Xml element | Xml | Define the Xml body of the new element, which will be iserted in the specified Xml file. |
| Xml element variables | Variables used in the Xml element body. Variables are prefixed with @ sign when used in the Xml element body. Eq. to use variable named var, write @var. |
|
| Rule Groups>Group>Rule>Set properties | Optional properties that will be set on source object based on ‘Error handling behavior’. Can be either static or dynamic, referencing properties from source, vault search, specify search or reference objects. NOTE: OnError properties will be only set if ‘Error handling behavior’ is set to Stop. |
Extension Kit for M-Files | Documentation
Configuration
Updated on January 26, 2026
