Unitfly Customer Portal

Vault to Vault

Vault to Vault module allows the transfer and creation of data between two document vaults based on predefined triggers. For example, when a document becomes invalid or expired, an archive record is created in the Document Archiving vault with an M-Files link to the original document.

Configuration

After you have successfully installed the application, you should configure Vault to Vault module.

  1. Open M-Files Admin
  2. In the left-side tree view, expand the desired connection to M-Files Server.
  3. In the left-side tree view, expand the Document Vaults
  4. Still in the left-side tree view, expand the vault where you installed the connector and select Configurations.
  5. Expand Other Applications
  6. Expand Extension Kit
  7. Click on Vault to Vault

Field Description

FieldValueDescription
EnabledYes/NoSpecifies whether the module is in use.
Configuration
Mode
Simple/AdvancedDisplay basic or advanced configuration options for module.
Rule Groups> Group
NameTextSpecifies group name.

Rule Groups>Group>Rule
NameTextCustom rule name.
AliasTextUnique rule alias.
DescriptionTextOptional rule description.
EnabledYes/NoSpecifies whether the rule is in use.
Configuration modeSimple/AdvancedConfiguration mode
Trigger typeOne 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 sourceFor 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 TypeList of object typesObject type of source object.
ClassList of classesClass of source object.
WorkflowList of workflowsWorkflow of source object.
StateList of workflow statesWorkflow 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
SearchConditionSearch conditionsOptional 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 inOne 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]
SearchConditionsSearchConditionsOptional 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] >VaultVault action will be invoked in.
Vault nameTextName of the vault.
Login typeOne of the following:
Windows
M-Files
Specifies login type for vault.
DomainTextDisplay only if login type is Windows. Windows user domain.
UsernameTextUsername
PasswordTextPassword
ProtocolOne of the following:
TcpIp
LocalProcedureCall
Spx
Https
Specifies which protocol to use for connection to vault.
Network addresseg. localhostThe network address forconnect to the vault
PortIntegerPort for connect to the vault
Encrypted connectionYes/NoSpecifies whether is connection encrypted.
Local computer nameTextSpecifies local computer name which contains vault.
Rules > Rule [n] > Action
ActionOne of the following:
CreateObject
UpdateObject
DeleteObject
Action to invoke in another vault.
Rules > Rule [n] > Create settings> Object type
AliasTextObject Type alias.
GuidTextObject Type guid.
IdTextObject type id.
NameTextObject type name.
Rules > Rule [n] > Create settings> Object class
AliasTextClass alias.
GuidTextClass guid.
Id TextClass id.
NameTextClass name.
Rules > Rule [n] > Create settings> Property mappings [n]
Source typeOne of the following:
Property
Constant
Expression
Source type of property mapping.
SourceProperty definition/Text/Placeholder editorIt depends on the choice of source type.
Rules > Rule [n] > Create settings> Property mappings [n]> Target
AliasTextTarget object alias.
GuidTextTarget object guid.
IdTextTarget object id.
NameTextTarget object name.
Target propertyOne of the following:
Unspecified
SimpleValue
ValueListLookup
ObjectLookup
Traget property type.
Create if doesn’t existYes/NoDisplayed 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 filesYes/NoInclude object files.
Rules > Rule [n] > Update settings> Object type
AliasTextObjet type alias.
GuidTextObjet type guid.
IdTextObjet type id.
NameTextObjet type name.
Rules > Rule [n] > Update settings> Object class
AliasTextClass alias.
GuidTextClass guid.
IdTextClass id.
NameTextClass name.
Rules > Rule [n] > Update settings> Property condition [n]> Property [n]
AliasTextProperty alias.
GuidTextProperty guid.
IdTextProperty id.
NameTextProperty name.
Rules > Rule [n] > Update settings> Property condition [n]
OperatorOne of the following:
• =
• =!
• <
• >
• <=
• >=
• Contains
• Does not contain
• Starts with
• Does not start with
Operator to apply in comparison of actual and expected property value
ValuePlaceholder editorExpected property value. Can be static value, or dynamic expression.
Rules > Rule [n] > Update settings> Status field condition[n]
FieldOne of the following:
ID
ExternalID
Type
Version
Deleted
Field types for status field condition.
OperatorOne of the following:
• =
• =!
• <
• >
• <=
• >=
Operator to apply in comparison of actual and expected property value
ValueTextStatus field value.
Rules > Rule [n] > Update settings> Status field condition[n]>ValueDisplayed only if Type is selected as Field.
AliasTextObject Type alias.
GuidTextObject Type guid.
IdTextObject Type id.
NameTextObject Type name.
Rules > Rule [n] > Update settings
File update behaviorOne 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 createYes/NoInclude object files when creating new object.
Rules > Rule [n] > Advanced setting
Search timeout (sec)IntegerSearch 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 modeOne 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 criticalYes/NoIf set to true, rule will be logged in SEQ.

Use Case

Customer wants to save archive records in different Vaults when the original document entered the state Expired. With Vault to Vault module an archive record can be created in the Document Archiving vault with an M-Files link to the original document.

Here is an example of an original document in the initial Vault:

Here is an example of created archive record with document link in the initial Vault.
Note! Before executing rules please be sure to enable rule and module.

Configuration

Table of Contents