Unitfly Toolkit for M-Files logo color

Connect values from Word with M-Files Object properties based on business rules inside M-Files:

  • Map values from any row and cell in word tables
  • Map values from bookmarks
  • Map values from textboxes
  • Specify the rules.

Configuration #

After you have successfully installed the application, you should configure Word Reader.

  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 Word Reader.

Field description #

FieldValueDescription
EnabledYes/NoSpecifies whether the module is in use.
Configuration modeSimple/AdvancedDisplay basic or advanced configuration options for module.
Rule Groups> Group
NameTextSpecifies group name.
Rule Groups>Group>Rule
NameTextCustom rule name.
DescriptionTextOptional rule description.
EnabledYes/NoSpecifies whether the rule is in use.
Configuration modeSimple/AdvancedDisplay simple or advanced configuration options for rule.
TriggerOne of the following: •  Object created
•  Object changed •  Object metadata changed
•  Object changed state
•  Object entered state •  Object left state •  OnComment
•  Scheduled
•  RunOnce
•  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 changed. If this option is selected, rule will be executed when any change is made on source object. 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.
OnComment. If this option is selected, rule will run whenever a comment is added to the source object.  
Scheduled. If this option is selected, rule will be run on inserted time.
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.
Orchestrated. If this option is selected rule will be run only from the orchestrator rule.
Rule Groups>Group>Rule>Source filename wildcard
Filename wildcard [n]TextFilename wildcards used to select files from object on which action will be executed.
Rule Groups>Group>Rule>Monitored property condition
PropertyProperty definitionProperty whose value will be checked.
Monitor typeOne of the following: •  AnyChange •  WithConditionAny 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 fromOne of the following: • CurrentVersion • PreviousVersionExecute condition for property value in selected object version.
OperatorOne of the following:
•  =
•  !=
•  >
•  <
•  >=
•  <=
•  Contains
•  Does not contain
•  Starts with
•  Does not start with
Operator for monitored property condition.
Value modeOne of the following: •  Dynamic value •  Static value
•  Empty value
Property value to use in condition. Can be static or dynamic (from current object).
ValueValueProperty value to use in condition.
Rule Groups>Group>Rule>Trigger source
Object typeList of object typesObject type of source object.
ClassList of classesClass of source object.
WorkflowWorkflowWorkflow of source object.
StateWorkflow stateWorkflow 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 conditionSearch 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.
Rule Groups>Group>Rule>M-Files word action
NameTextUnique action name
EnabledYes/NoSpecifies whether the action is in use.
Action typeOne of the following: •  Property
•  Range
Property. If this option is selected cell range or entire sheet from source Excel file will be copied in target Excel file.
Range. If this option is selected value from M-Files object property will be inserted in selected cell.
Action type: Range
Tables wildcardsText with placeholdersTables wildcards used to select word tables from word file to use as data.
Is verticalYes/NoColumns of table are vertical or horizontal.
Start rowRowStart table row to use as mapping source (1,2,3,..).
Start columnColumnStart table column to use as mapping source (1,2,3,..).
Last rowRowEnd table row to use as mapping source (1,2,3,..). If not set all rows in the table will be used.
Last columnColumnEnd table column to use as mapping source (1,2,3,..). If not set all columns in the table will be used.
Rows for one objectNumberUse multiple rows for one object when creating or updating objects.
Column names in first rowYes/NoWhether table has defined headers or not.
Create if doesn’t existYes/NoCreate object or value list item if it does not exist in vault.
Object typeList of object typesType of object that will be created.
Object classList of classesClass of object that will be created.
Target searchList of search filtersSearch filters used to find targets. Multiple searches are combined with OR operator. Multiple conditions inside search filter are combined with AND operator.
Target search match conditionsList of match conditionsDefine M-Files status field and property conditions to match existing object values with values from word table cells.
Multiple match conditions are combined with OR operator. Multiple conditions inside match condition are combined with AND operator.
Rule Groups>Group>Rule>M-Files word action>Word mapping
Word mapping sourceOne of the following: •  FromData •  FromHeader •  FromSourceNameFromData. Data from table will be used in mapping. FromHeader. Data from table header will be used, available only if table data is sourced. FromSourceName. Source name will be used for setting property (table name).
Word rowRowWord row to use as mapping source (1,2,3,..).
Mapping typeOne of the following: •  SimpleValue •  ValueListItem •  ObjectType of property value to set.
DelimiterTextLookup values delimiter.
Create if doesn’t existYes/NoCreate object or value list item if it doesn’t exist in vault. For value lists, make sure that Allow users to add new values to this list item is enabled. Only objects without any required properties can be created this way, because only name and class will be set upon creation.
Mapping lookup propertyProperty definitionMapping lookup property for word action mapping.
Action type: Property
Map modeOne of the following: •  Specify target object •  Source objectDetermines whether properties will be mapped on specified target object, or on source object.
Target objectTarget object searchSearch to find object properties will be mapped to.
Value typeOne of the following: •  SimpleValue •  ValueListItem •  ObjectType of property value to set.
Value type: SimpleValue
Simple propertyProperty definitionSimple property definition for word action mapping.
ValueType: ValueListItem
DelimiterTextLookup values delimiter.
Create if doesn’t existYes/NoCreate value list item if it doesn’t exist in vault. For value lists, make sure that Allow users to add new values to this list item is enabled.
Lookup propertyLookup property definitionLookup property definition for word action mapping.
ActionType: Object
DelimiterTextLookup values delimiter.
Create if doesn’t existYes/NoCreate object if it doesn’t exist in vault. Only objects without any required properties can be created this way, because only name and class will be set upon creation.
Object classList of classesClass of object that will be referenced on selected lookup.
Lookup propertyLookup property definitionLookup property definition for word action mapping.
Lookup typeOne of the following: •  Cell
•  Textbox
•  Bookmark
How lookup values are set in word document.
Cell. All values are in one cell. Textbox. Value is in the textbox. Bookmark. Value is on the named bookmark.
LookupType: Cell
RowRowWord table row to use as mapping source (1,2,3,..).
ColumnColumnWord table column to use as a mapping source (1,2,3,..).
LookupType: Textbox
Textbox wildcardText with placeholdersTextbox name used to select textbox from word file to use as data.
LookupType: Bookmark
Bookmark wildcardText with placeholdersBookmark name used to select bookmark from word file to use as data.

Your one-stop hub for Unitfly Toolkit for M-Files!

Unitfly Toolkit Community is live!

News and updates on our products • Frequently asked questions • Support page