After you have successfully installed the application, you should configure Vault to Vault module.
- 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
- 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 Vault to Vault
Field Description #
| Field | Value | Description |
| Enabled | Yes/No | Specifies whether the module is in use. |
| Configuration Mode | Simple/Advanced | Display basic or advanced configuration options for module. |
| Rule Groups> Group | ||
| Name | Text | Specifies group name. |
| Rule Groups>Group>Rule | ||
| Name | Text | Custom rule name. |
| Alias | Text | Unique rule alias. |
| Description | Text | Optional rule description. |
| Enabled | Yes/No | Specifies whether the rule is in use. |
| Configuration mode | Simple/Advanced | Configuration mode |
| Trigger type | One of the following: • Object created • Object changed • Object entered state • Object ChangedState • RunOnce • Scheduled • OnComment • Object deleted • Orchestrated | Type of event that triggers the execution of this rule. Object created. If this option is selected, rule will be executed on creation of source object. Object entered state. If this option is selected, rule will be executed when source object changes workflow state. Object changed. If this option is selected, rule will be executed when any change is made on source object. Run once. 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. Scheduled. If this option is selected, rule will be run on inserted time. On comment. If this option is selected, rule will run whenever a comment is added to the source object. |
| Rule Groups>Group>Rule>Trigger source | For event based triggers, these filters define source object whose change will trigger rule execution. For Scheduled and RunOnce triggers, these filters will be used to find objects rule will be executed on. | |
| 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. Note! If you have entered a state, you must also enter the workflow above. |
| Rule Groups>Group>Rule>Trigger source>Search filters | ||
| SearchCondition | 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. |
| Rules > Rule [n] > Source object > Search filters > Filter [n] | ||
| SearchConditions | SearchConditions | 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. |
| Rules > Rule [n] >Vault | Vault action will be invoked in. | |
| Vault name | Text | Name of the vault. |
| Login type | One of the following: Windows M-Files | Specifies login type for vault. |
| Domain | Text | Display only if login type is Windows. Windows user domain. |
| Username | Text | Username |
| Password | Text | Password |
| Protocol | One of the following: TcpIp LocalProcedureCall Spx Https | Specifies which protocol to use for connection to vault. |
| Network address | eg. localhost | The network address forconnect to the vault |
| Port | Integer | Port for connect to the vault |
| Encrypted connection | Yes/No | Specifies whether is connection encrypted. |
| Local computer name | Text | Specifies local computer name which contains vault. |
| Rules > Rule [n] > Action | ||
| Action | One of the following: CreateObject UpdateObject DeleteObject | Action to invoke in another vault. |
| Rules > Rule [n] > Create settings> Object type | ||
| Alias | Text | Object Type alias. |
| Guid | Text | Object Type guid. |
| Id | Text | Object type id. |
| Name | Text | Object type name. |
| Rules > Rule [n] > Create settings> Object class | ||
| Alias | Text | Class alias. |
| Guid | Text | Class guid. |
| Id | Text | Class id. |
| Name | Text | Class name. |
| Rules > Rule [n] > Create settings> Property mappings [n] | ||
| Source type | One of the following: Property Constant Expression | Source type of property mapping. |
| Source | Property definition/Text/Placeholder editor | It depends on the choice of source type. |
| Rules > Rule [n] > Create settings> Property mappings [n]> Target | ||
| Alias | Text | Target object alias. |
| Guid | Text | Target object guid. |
| Id | Text | Target object id. |
| Name | Text | Target object name. |
| Target property | One of the following: Unspecified SimpleValue ValueListLookup ObjectLookup | Traget property type. |
| Create if doesn’t exist | Yes/No | Displayed only if ValueListLookup or ObjectLookup are selected for target property. If target property is lookup based, this setting controls whether specified object or value list item will be created, if they don’t exist in target vault. For value list lookups, make sure that ‘Allow users to add new values to this list’ checkbox is enabled. For real object lookups, note that only objects without any required properties can be created in this way, because only name and class properties will be set on creation. |
| Include files | Yes/No | Include object files. |
| Rules > Rule [n] > Update settings> Object type | ||
| Alias | Text | Objet type alias. |
| Guid | Text | Objet type guid. |
| Id | Text | Objet type id. |
| Name | Text | Objet type name. |
| Rules > Rule [n] > Update settings> Object class | ||
| Alias | Text | Class alias. |
| Guid | Text | Class guid. |
| Id | Text | Class id. |
| Name | Text | Class name. |
| Rules > Rule [n] > Update settings> Property condition [n]> Property [n] | ||
| Alias | Text | Property alias. |
| Guid | Text | Property guid. |
| Id | Text | Property id. |
| Name | Text | Property name. |
| Rules > Rule [n] > Update settings> Property condition [n] | ||
| Operator | One of the following: • = • =! • < • > • <= • >= • Contains • Does not contain • Starts with • Does not start with | Operator to apply in comparison of actual and expected property value |
| Value | Placeholder editor | Expected property value. Can be static value, or dynamic expression. |
| Rules > Rule [n] > Update settings> Status field condition[n] | ||
| Field | One of the following: ID ExternalID Type Version Deleted | Field types for status field condition. |
| Operator | One of the following: • = • =! • < • > • <= • >= | Operator to apply in comparison of actual and expected property value |
| Value | Text | Status field value. |
| Rules > Rule [n] > Update settings> Status field condition[n]>Value | Displayed only if Type is selected as Field. | |
| Alias | Text | Object Type alias. |
| Guid | Text | Object Type guid. |
| Id | Text | Object Type id. |
| Name | Text | Object Type name. |
| Rules > Rule [n] > Update settings | ||
| File update behavior | One of the following: DoNotUpdate Append AppendAndReplace Overwrite | File update behavior. DoNotUpdate: Does not modify target object files. Append: Appends all files from source object to target object that is being updated. If any existing file on target has the same filename as any of the source files, it will be replaced. Replace: Replaces all files on target object with files from source object. |
| Include files on create | Yes/No | Include object files when creating new object. |
| Rules > Rule [n] > Advanced setting | ||
| Search timeout (sec) | Integer | Search timeout in seconds. Value should always be between 1 and 90 seconds. This timeout is applied to any search that is executed inside operation (eq. any configured Vault Search, or retrieval of indirectly referenced objects). |
| Execution mode | One of the following: EventHandler Bacground | Defines when rule is executed: – EventHandler. During object check in. – Background. In background, after object has been checked in. |
| Business critical | Yes/No | If set to true, rule will be logged in SEQ. |
