After you have successfully installed the application, you can start adding calculation rules.
- 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 Validation
Field Description #
| Field | Value | Description |
| Enabled | Yes/No | Specifies whether the module is in use. |
| Configuration mode | Simple/Advanced | Specifies basic or advanced options for the module. |
| Error message | Text | Displayed only if [Advanced] is selected as configuration mode. Error message to display when any condition for the object is unsatisfied. |
| Rule groups [n] > Group [n] | ||
| Name | Text | Specifies rule group name. |
| Rule groups [n] > Group [n] > Rule [n] | ||
| Name | Text | Custom rule name |
| Description | Text | Optional rule description. |
| Enabled | Yes | Specifies whether the rule is in use. |
| Configuration mode | Simple/Advanced | Specifies simple or advanced option for the module. |
| Trigger | One of the following • Object Created; • ObjectChanged; • ObjectEnteredState; • ObjectChangedState; • OnComment; | Type of event that triggers the execution of this rule. ObjectCreated. If this option is selected, the rule will be executed when the source object is created. ObjectChanged. If this option is selected, the rule will be executed when the source object is changed. ObjectEnteredState. If this option is selected, the rule will be executed when the source object has entered a new state. ObjectChangedState. If this option is selected, the rule will be executed when the source object has changed its state. OnComment. If this option is selected, the rule will be executed when a new comment is written to the source object. |
| Search timeout (seconds) | Integer | Displayed only if [Advanced] is selected as Configuration mode. Search timeout in seconds. The value should always be between 1 and 90 seconds. |
| Business critical | Yes/No | If set to true, the rule will be logged in SEQ |
| Rule groups [n] > Group [n] > Rule [n] > Monitored properties [n] | ||
| Property Definition | Property Definition | Optional filter by properties on source object whose change triggers rule execution. |
| Rule groups [n] > Group [n] > Rule [n] > Trigger source | ||
| Object Type | Object type | Object type of source object. |
| Class | Object class | 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 [n] > Group [n] > Rule [n] > Trigger source > Search filters > Filter [n] | ||
| Search Conditions | Search conditions | Displayed only if [Advanced] is selected as Configuration mode. Optional additional conditions that the 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 | Specifies whether the source object must match specifies conditions: in the current version, or in any version in history. |
| Rule groups [n] > Group [n] > Rule [n] > Property validation rules > Property validation rule [n] | ||
| Name | Text | Custom rule name. |
| Description | Text | Optional rule description. |
| Enabled | Yes/No | Specifies whether the rule is in use. |
| Configuration mode | Simple/Advanced | Displayed simple or advanced options for configuration mode. |
| Value from | One of the following: • Source; • Vault search | Displayed only if [Advanced] is selected as configuration mode. Specifies where is the location of the property that needs to be validated. Source. If this option is selected, the property for validation is located on the trigger source object. VaultSearch. If this option is selected, the property for validation is located in the vault. |
| Referenced object | Property definitions | List of property definitions representing reference chain from source object on which property for validation is located. |
| Custom error message | Text | Optional custom error message |
| Rule groups [n] > Group [n] > Rule [n] > Property validation rules > Property validation rule [n] > Referenced object > Property definition [n] | ||
| Property definition | Property definition | This indicates the property chain to an object that has properties that need to be validated. That means you can put property from the source object that contains a reference to a different object and properties from that object will be validated. It is possible to reference an object on reference object multiple times and get down on hierarchy as much as you want. |
| Rule [n] > Property validation rules > Property validation rule [n] > Property validation rule [n] Property condition | ||
| Property | Property definition | Property whose value condition needs to be satisfied. |
| Operator | One of the following: • =; • !=; • >; • <; • >=; • <=; • Contains; • DoesNotContain; • StartsWith; • DoesNotStartWith; • Matches regex | Operator to apply in comparison of actual and expected property value. |
| Rule groups [n] > Group [n] > Rule [n] > Property validation rules > Property validation rule [n] > Property condition > Value | ||
| Mode | One of the following: • Dynamic value; • Static value; • Empty value; | Dynamic value. If this option is selected, the expected value will be read from the source object. Static value. If this option is selected, the expected value will be the specified constant. Empty value. If this option is selected, the expected value will be empty. |
| Static value | Placeholder editor | Displayed only when Mode is Static value. The expected value of a selected property. |
| Dynamic value | Placeholder editor | Displayed only when Mode is Dynamic value. The expected value of a selected property. Any property placeholders will be expanded to specified property values from source object. |
| Rule groups [n] > Group [n] > Rule [n] > Vault search > Search [n] | ||
| Conditions | Property definition | An optional list of conditions that must be satisfied in a vault in order for this rule to be executed. |
| Search result type | One of the following; • Any • None | Any. If this option is selected, the vault search will be considered satisfied if at least one matching object is found in the vault. None. If this option is selected, the vault search will be considered satisfied if no matching objects are found in the vault. |
| Rule groups [n] > Group [n] > Rule [n] > Vault search > Search [n] > Conditions > Property condition [n] | ||
| Property | Property definition | Specifies the property whose value will be checked. |
| Operator | One of the following; • =; • !=; • >; • <; • >=; • <=; • Contains; • DoesNotContain; • StartsWith; • DoesNotStartWith; | Operator to use for comparing actual and expected property value. |
| Value | Property value | Property value to compare actual value against. |
| Rule groups [n] > Group [n] > Rule [n] > Vault search > Search [n] > Conditions > Property condition [n] < Value | ||
| Mode | One of the following: • Dynamic value; • Static value; • Empty value; • No action; | Dynamic value. If this option is selected, a 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, the comparison value will be empty. No action. If this option is selected, no action will be performed. This is an invalid state. |
| Dynamic value | Placeholder editor | Displayed only if Dynamic value is selected as a mode. Specifies search comparison value using properties from the source object. |
| Static value | Text | Displayed only if Static value is selected as a mode. Specifies constant search comparison value. |
| Rule groups [n] > Group [n] > Rule [n] > Vault search sort | ||
| Sort by | Property | Property by which results will be sorted. |
| Sort direction | Ascending/Descending | The direction in which results will be sorted. |
| 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. |
| Retry interval (milliseconds) | Integer | Number of milliseconds to wait between retries. |
