After you have successfully installed the application, you should configure Word Reader.
- 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 Word Reader.
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. |
| Description | Text | Optional rule description. |
| Enabled | Yes/No | Specifies whether the rule is in use. |
| Configuration mode | Simple/Advanced | Display simple or advanced configuration options for rule. |
| Trigger | One 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] | Text | Filename wildcards used to select files from object on which action will be executed. |
| Rule Groups>Group>Rule>Monitored property condition | ||
| Property | Property definition | Property whose value will be checked. |
| Monitor type | One of the following: • AnyChange • WithCondition | Any 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 from | One of the following: • CurrentVersion • PreviousVersion | Execute condition for property value in selected object version. |
| Operator | One of the following: • = • != • > • < • >= • <= • Contains • Does not contain • Starts with • Does not start with | Operator for monitored property condition. |
| Value mode | One of the following: • Dynamic value • Static value • Empty value | Property value to use in condition. Can be static or dynamic (from current object). |
| Value | Value | Property value to use in condition. |
| Rule Groups>Group>Rule>Trigger source | ||
| Object type | List of object types | Object type of source object. |
| Class | List of classes | 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>Group>Rule>Trigger source>Search filters | ||
| Search condition | 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. |
| Rule Groups>Group>Rule>M-Files word action | ||
| Name | Text | Unique action name |
| Enabled | Yes/No | Specifies whether the action is in use. |
| Action type | One 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 wildcards | Text with placeholders | Tables wildcards used to select word tables from word file to use as data. |
| Is vertical | Yes/No | Columns of table are vertical or horizontal. |
| Start row | Row | Start table row to use as mapping source (1,2,3,..). |
| Start column | Column | Start table column to use as mapping source (1,2,3,..). |
| Last row | Row | End table row to use as mapping source (1,2,3,..). If not set all rows in the table will be used. |
| Last column | Column | End table column to use as mapping source (1,2,3,..). If not set all columns in the table will be used. |
| Rows for one object | Number | Use multiple rows for one object when creating or updating objects. |
| Column names in first row | Yes/No | Whether table has defined headers or not. |
| Create if doesn’t exist | Yes/No | Create object or value list item if it does not exist in vault. |
| Object type | List of object types | Type of object that will be created. |
| Object class | List of classes | Class of object that will be created. |
| Target search | List of search filters | Search 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 conditions | List of match conditions | Define 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 source | One of the following: • FromData • FromHeader • FromSourceName | FromData. 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 row | Row | Word row to use as mapping source (1,2,3,..). |
| Mapping type | One of the following: • SimpleValue • ValueListItem • Object | Type of property value to set. |
| Delimiter | Text | Lookup values delimiter. |
| Create if doesn’t exist | Yes/No | Create 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 property | Property definition | Mapping lookup property for word action mapping. |
| Action type: Property | ||
| Map mode | One of the following: • Specify target object • Source object | Determines whether properties will be mapped on specified target object, or on source object. |
| Target object | Target object search | Search to find object properties will be mapped to. |
| Value type | One of the following: • SimpleValue • ValueListItem • Object | Type of property value to set. |
| Value type: SimpleValue | ||
| Simple property | Property definition | Simple property definition for word action mapping. |
| ValueType: ValueListItem | ||
| Delimiter | Text | Lookup values delimiter. |
| Create if doesn’t exist | Yes/No | Create 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 property | Lookup property definition | Lookup property definition for word action mapping. |
| ActionType: Object | ||
| Delimiter | Text | Lookup values delimiter. |
| Create if doesn’t exist | Yes/No | Create 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 class | List of classes | Class of object that will be referenced on selected lookup. |
| Lookup property | Lookup property definition | Lookup property definition for word action mapping. |
| Lookup type | One 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 | ||
| Row | Row | Word table row to use as mapping source (1,2,3,..). |
| Column | Column | Word table column to use as a mapping source (1,2,3,..). |
| LookupType: Textbox | ||
| Textbox wildcard | Text with placeholders | Textbox name used to select textbox from word file to use as data. |
| LookupType: Bookmark | ||
| Bookmark wildcard | Text with placeholders | Bookmark name used to select bookmark from word file to use as data. |
