Table of Contents
Provides support for simple and advanced version numbering, as well as for manipulations of object and document’s major and minor versions.
Configuration #
- Open M-Files Admin
- In the left-side tree view, expand the desired connection to M-Files Server.
- In the left-side tree view, expand the Document Vaults node.
- Still, in the left-side tree view, expand the vault where you installed the connector and select Configurations.
- Expand Other Applications
- Expand Extension Kit
- Click on Versioning
Field description #
| Field | Value | Description |
| Enabled | Yes/No | Specifies whether the module is in use. |
| Configuration mode | Simple/Advanced | Display simple or advanced configuration options for module. |
| Rules > Versioning rule [n] | ||
| Name | Text | Custom rule name. |
| Description | Text | Optional rule description. |
| Configuration mode | Simple/Advanced | Display simple or advanced options for rule. |
| Trigger type | One of the following: • ObjectCreated • ObjectChanged • ObjectEnteredState • OnComment • Scheduled • RunOnce | Type of event that triggers the execution of this rule. ObjectCreated. If this option is selected, rule will be executed when the source object is created. ObjectChanged. If this option is selected, rule will be executed when any change is made to the source object ObjectEnteredState. If this option is selected, rule will be executed when the source object has entered a new state. OnComment. If this option is selected, rule will be executed when the source object has new comment. RunOnce. If this option is selected, rule will be run only once and on all matching objects in vault. NOTE: On vault restart, all enabled rules with Run once trigger will be run immediately. |
| Execute on | One of the following: • TriggerObject • VaultSearch | Displayed only if [Advanced] is selected as Configuration mode. Specify whether actions will be executed on trigger source object or vault search result object. |
| Business critical | Yes/No | If set to true, rule will be logged in SEQ. |
| Rules > Versioning rule [n] > Trigger source [n] | ||
| Object Type | List of object types | Object type of source object. |
| Class | List of classes | Class of source object. |
| Workflow | List of workflows | Workflow of source object. |
| State | List of workflow states | Workflow state of source object. |
| Rules > Versioning rule [n] > Trigger source [n] >Search filters > Filter [n] | ||
| SearchConditions | 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: • LatestObjVersion • AllObjVersion | 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 and for object to be treated as source for this rule. |
| Rules > Versioning rule [n] > Vault search [n] > Search [n] | ||
| Conditions | • Property definitions • Status field conditions | Optional list of conditions that must be satisfied in vault in order for this rule to be executed. |
| Search result type | One of the following: • Any • None | Displayed only if [Advanced] is selected as Configuration mode. Any. When this option is selected and at least one search condition is set, rule will be executed only if the vault search result has at least one matching result. None. When this option is selected and at least one search condition is set, rule will be executed only if the vault search result doesn’t have any matching results. |
| Rules > Versioning rule [n] > Vault search [n] > Search [n] > Status field condition [n] | ||
| Field | One of the following: • ID • Type • Version | Status field. |
| Operator | One of the following: • = • != • > • < • >= • <= | Operator to apply in comparison of actual and expected property value. |
| Value | Value | Status field value. |
| Rules > Versioning rule [n] > Vault search [n] > Search [n] > Property conditions [n] | ||
| Property | Property definition | Property whose value condition will be checked. |
| Operator | One of the following: • = • != • > • < • >= • <= • Contains • DoesNotContain • StartsWith • DoesNotStartWith | Operator to apply in comparison of actual and expected property value. |
| Rules > Versioning rule [n] > Vault search sort [n] | ||
| Sort by | Property definition | Property definition for vault search sort. |
| Sort direction | One of the following: • Ascending • Descending | Ascending. If this option is selected, search result will have ascending order. Descending. If this option is selected, search result will have ascending order. |
| Rules > Versioning rule [n] > Actions [n] > Action [n] | ||
| Action type | One of the following: • SetVersion • IncrementVersion • DecrementVersion • ObjectSnapshot | Type of action to execute. Set version. Sets the specified version property on object. Increment version. Increments the specified version property on object. Decrement version. Decrement the specified version property on object. Object Snapshot. Creates snapshot of current object and adds it in some collection. |
| Rules > Versioning rule [n] > Actions [n] > IncrementVersion > Version settings | ||
| Version type | One of the following: • Simple • TwoPart • Semantic • Custom | Type of version. |
| Version property | Property definition | Property whose value will be set. |
| Default value | Integer | Default version value. |
| Increment Value | Integer | Displayed only if Increment Version is selected as an Action type. Value of increment. |
| Decrement Value | Integer | Displayed only if Decrement Version is selected as an Action type. Value of decrement. |
| Increment version part | One of the following: • Major • Minor • Patch | Displayed only if [Increment Version] is selected as an Action type and [Semantic] is selected as Version type. This setting specifies which version number should be updated when creating new version. It is assumed that version number is comprised of one to three digits separated by a dot. Eq. in version number 1.2.3, 1 is major number, 2 is minor and 3 is patch. |
| Decrement version part | One of the following: • Major • Minor • Patch | Displayed only if [Decrement Version] is selected as Action type and [Semantic] is selected as Version type. This setting specifies which version number should be updated when creating new version. It is assumed that version number is comprised of one to three digits separated by a dot. Eq. in version number 1.2.3, 1 is major number, 2 is minor and 3 is patch. |
| Increment value | Integer | Increment that will be used when calculating next value. |
| Rules > Versioning rule [n] > Actions [n] > Versioning action [n] > Version settings > Value | ||
| Version type | One of the following: • Static • Numbered | Type of version. |
| Start numbering from | One of the following: • DefaultValue • Vault | Vault numbering should start from: DefaultValue. Start numbering from specified static default value. Vault. Search for object in vault that matches specified grouping conditions and contain this numbering property and start numbering from biggest found value of property. |
| Rules > Versioning rule [n] > Actions [n] > Versioning action [n] > Version settings > Simple | ||
| Version property | Property definition | Property whose value will be set on. Allowed property data types: • Number • Text • Text (multi – line) |
| Rules > Versioning rule [n] > Actions [n] > Versioning action [n] > Version settings > Value type > Numbered | ||
| Default value | Integer | Default value to use when none found in vault. |
| Increment value | Integer | Increment that will be applied when calculating numbered value from max value in vault or default value. |
| Search timeout (sec) | Integer | Search timeout in second. Value should always be between 1 and 9 seconds. This timeout is applied to search operation that retrieves max value of property from vault. |
| Include deleted objects | Integer | Include deleted objects when searching in Vault. |
| Rules > Versioning rule [n] > Actions [n] > Versioning action [n] > Version settings > Grouping > Grouping [n] | ||
| Group by | One of the following: • Property • PropertyCondition • StatusField • StatusFieldCondition | Group by conditions for numbering. |
| Property | Property | Displayed only if Property is selected as Group by. |
| Rules > Versioning rule [n] > Actions [n] > Versioning action [n] > Version settings > Value > Grouping > Grouping [n] > Property condition | ||
| Property | Property | Property whose value condition will be checked. |
| Operator | One of the following: • = • != • > • < • >= • <= • Contains • DoesNotContain • StartsWith • DoesNotStartWith | Operator to apply in comparison of actual and expected property value. |
| Rules > Versioning rule [n] > Actions [n] > Versioning action [n] > Version settings > Value > Grouping > Grouping [n] > Status field | ||
| Field | One of the following: • ID • Type • Version | Status field. |
| Rules > Versioning rule [n] > Actions [n] > Snapshot settings > Snapshot collection | ||
| Object type | Object type | Object type |
| Class | Object class | Object class |
| Name | Text | Collection name. If not set using source object’s name. |
| Rules > Versioning rule [n] > Actions [n] > Snapshot settings > Snapshot collection > Properties > Property setter [n] | ||
| Property | Object type | Object type |
| Class | Object class | Object class |
| Value type | One of the following: • Value • Function | Displayed only if SetValue is selected as Property mode. |
| Rules > Versioning rule [n] > Actions [n] > Snapshot settings > Snapshot collection > Properties > Property setter [n] > Value | ||
| Mode | One of the following: • No action • Dynamic value • Static value • Empty value | Displayed only if SetValue is selected as Property mode. Dynamic value. If this option is selected, comparison value will be created dynamically from source properties. Static value. If this option is selected, comparison value will be created statically i.e. constant value. Empty value. If this option is selected, comparison value will be empty. No action. If this option is selected, no action will be performed. This is an invalid state. |
| MultiSelectLookupBehaviour | One of the following: • Overwrite • Append • Remove | Displayed only when Value Type is Value. If property is multi-select lookup, this setting controls how the selected value will be added: overwriting existing ones, or appending. |
| Dynamic value | Placeholder editor | Displayed only if Dynamic value is selected as a mode. Specifies search comparison value using properties from source object. |
| Static value | Text | Displayed only if Static value is selected as a mode. Specifies constant search comparison value |
| Rules > Versioning rule [n] > Actions [n] > Snapshot settings > Snapshot object | ||
| Name | Text | Snapshot object name. |
| Rules > Rule [n] > Actions [n] > Snapshot settings > Snapshot object > Properties [n] > Property setter | ||
| Property | Property | Property from source object that will be set on snapshot object. |
| Mode | One of the following: • SetValue • FromSource | Controls how the value of property will be calculated: directly by copying value from source or as function of selected property values. |
| Rules > Rule [n] >Actions > Properties > Property value [n] > Function | ||
| Functions group | One of the following: • Text • Date • Numeric • Regex | Type of function that will be used to calculate property value. |
| Function | When Functions group is Text, one of the following: • Concatenate • ToLower • ToUpper • ToLowerInvariant • ToUpperInvariant When Functions group is Date, one of the following: • Add Hours • AddDays • AddMonths • AddYears When Functions group is Numeric, one of the following: • Sum • Subtract • Multiply • Divide • Average • Percent When Functions group is Regex, one of the following: • Extract | Function that will be used to calculate property value. |
| Rules > Rule [n] > New objects > New object [n] > Properties > Property value [n] > Function parameters | ||
| Separator | Text | Displayed only when Functions group is Text. Separator to use when function concatenates multiple text values. |
| Regex expression | Text | Displayed only if Function group is Regex. Regex expression to match. |
| Match group | Text | Displayed only if Function group is Regex. Function will use the specified matched group (zero based). |
| Start | Text | Displayed only if Function group is Regex. Function will start matching regex in parameter values at specified zero based index. |
| Rules > Rule [n] > New objects > New object [n] > Properties > Property value [n] > Function parameters > Date | ||
| Date type | • Property • Constant • Today • Now | Date type to use in function. |
| Date | Property definition | Displayed only if Property is selected as Date type. Define date for use in function. |
| Rules > Rule [n] > New objects > New object [n] > Properties > Property value [n] > Function parameters > Value to add | ||
| Value type | • Property • Constant | Value type to add as property. |
| Value to add | Integer/Property definition | Display Integer if value type is Constant. Display Property definition if value type is Property. |
| Rules > Rule [n] > New objects > New object [n] > Properties > Property value [n] > Function > Parameters > Parameters > Parameter [n] | ||
| Parameter type | One of the following: • Property • Constant | |
| Property | Property definition | Displayed only when Parameter type is Property. Property whose value will be used in function. |
| Constant | Constant value | Displayed only when Parameter type is Constant. Constant value that will be used as parameter in function. |
| Rules > Rule [n] > New objects > New object [n] > Properties > Property value [n] > Function > Parameters > Parameters > Parameter [n] | ||
| Parameter type | One of the following: • Property • Constant | Type of parameter to use in function. |
| Property | Property definition | Displayed only when Parameter type is Property. Property whose value will be used in function. |
| Constant | Constant value | Displayed only when Parameter type is Constant. Constant value that will be used as parameter in function. |
| Rules > Versioning rule [n] > Actions [n] > Snapshot settings > Source object | ||
| Collection reference property | Property | Property on source that will reference snapshot collection. |
| Rules > Versioning rule [n] > Actions [n] > Snapshot settings > Source object > Remove properties | ||
| Property | Number of retries | Properties to remove from source. |
| Advanced Settings | ||
| Time to wait (milliseconds) | Integer | Number of milliseconds to wait before executing any rule in background. |
| Number of retries | Integer | Maximum number of times COM errors are retried. |
Use cases #
Customer is using M-Files to manage document versions #
Customer is using M – Files for creating and managing the documents. All documents go through Document Approval Workflow (Picture 1). On creation of the document, document enters the state Draft and with Versioning the customer can add a new version (eg. 1.0) to them. They wanted the possibility of creating a new editable version of documents when a contract is expired.
With Versioning, customer solved their case by automatically adding a new version numbers to the document.
Configuration of Versioning #
When Customer creates new Document, version 1.0 will be added to the document.
When documents enter the state Expired, customer may want to have possibility of creating new version.
When document entered state Create New Version, new version number (eg. 2.0, 3.0) will be
added to document.
