After you have successfully installed the application, you should configure Word Writer.
- 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 Writer.
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 metadata changed • Object changed state • Object entered state • Object left state • OnComment • Orchestrated | Type of event that triggers the execution of this rule. 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. On comment. If this option is selected, rule will run whenever a comment is added to the source object. 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>File action | ||
| Name | Text | Unique action name |
| Enabled | Yes/No | Specifies whether the action is in use. |
| Action | One of the following: • InsertImage • InsertExcelObject • InsertMFilesValues | InsertImage. If this option is selected image from path, source object or object from search will be inserted to configured bookmark in the word file on the source object. InsertExcelObject. If this option is selected excel sheet from excel document defined from path, source object or object from search will be inserted as image to configured bookmark in the word file on the source object. InsertMFilesValues. If this option is selected value from M-Files object property will be inserted in table cell or to bookmark or to textbox in the word file on the source object. |
| Action: InsertImage | ||
| Word bookmark | Text | Word bookmark name representation |
| Image type | One of the following: • FromPath • FromSourceObject • FromSearch | FromPath. If this option is selected image will be added from the defined full image file path. FromSourceObject. If this option is selected image is added from source object or from referenced object on source. FromSearch. If this is selected image is added from the search result object. |
| Image type: FromPath | ||
| Path | Text with placeholders | Full image file path. |
| Image type: FromSourceObject | ||
| Property | Text with placeholders | Property expression from source object to object that contains image. Leave empty if file is located directly on the source object. |
| Filename wildcards | Text with placeholders | Filename wildcards used to fetch the appropriate file from object. If none set, using first file from object. |
| Image type: FromSearch | ||
| Image search | List of search conditions | Search conditions for finding object with image. |
| Search timeout (sec) | Integer | Search timeout in seconds. Value should be between 1 and 90 seconds. This timeout is applied to search operation that retrieves object with image from vault. |
| Filename wildcards | Text with placeholders | Filename wildcards used to fetch the appropriate file from object. If none set, using first file from object. |
| Insert image behaviour | One of the following: • Replace • Append | Replace. If image already exists at the bookmark it will be replaced. Append. Append images to pre-existing ones on the bookmark. |
| Max width (in points) | Integer | Resize image so that its width is not greater than selected width, expressed in points. Image will keep its original proportions when resized. |
| Max height (in points) | Integer | Resize image so that its height is not greater than selected height, expressed in points. Image will keep its original proportions when resized. |
| Action: InsertExcelObject | ||
| Word bookmark | Text | Word bookmark name representation |
| Insert as | One of the following: • SheetPicture | SheetPicture. Excel sheet will be inserted as image to the word bookmark. |
| Excel sheet | ||
| Resource type | One of the following: • FromPath • FromSourceObject • FromSearch | FromPath. If this option is selected sheet will be added from the defined full excel file path. FromSourceObject. If this option is selected sheet will be added from source object or from referenced object on source. FromSearch. If this is selected sheet will be added from the search result object. |
| Resource type: FromPath | ||
| Path | Text with placeholders | Full excel file path. |
| Resource type: FromSourceObject | ||
| Property | Text with placeholders | Property expression from source object to object that contains excel file. Leave empty if file is located directly on the source object. |
| Filename wildcards | Text with placeholders | Filename wildcards used to fetch the appropriate file from object. If none set, using first file from object. |
| Resource type: FromSearch | ||
| Excel sheet search | List of search conditions | Search conditions for finding object with excel file. |
| Search timeout (sec) | Integer | Search timeout in seconds. Value should be between 1 and 90 seconds. This timeout is applied to search operation that retrieves object with excel file from vault. |
| Filename wildcards | Text with placeholders | Filename wildcards used to fetch the appropriate file from object. If none set, using first file from object. |
| Excel sheet name | Text | Excel sheet name representation. |
| Max width (in points) | Integer | Resize image so that its width is not greater than selected width, expressed in points. Image will keep its original proportions when resized. |
| Max height (in points) | Integer | Resize image so that its height is not greater than selected height, expressed in points. Image will keep its original proportions when resized. |
| Action: InsertMFilesValues | ||
| Word lookup type | One of the following: • Cell • Textbox • Bookmark | Cell. Property value will be inserted to the defined cell in word table. Textbox. Property value will be inserted to the defined word textbox. Bookmark. Property value will be inserted to the defined word bookmark. |
| Word lookup type: Cell | ||
| Word table | Text | Word table alternative text representation. |
| Row | Integer | Word row to use as write target (1,2,3,..). |
| Column | Integer | Word column to use as write target (1,2,3,..). |
| Word lookup type: Textbox | ||
| Word textbox | Text | Word textbox alternative text representation. |
| Word lookup type: Bookmark | ||
| Word bookmark | Text | Word bookmark name representation. |
| Value | Text with placeholders | Define value to write in word file. |
| Value type | One of the following: • Text • Lookup | Select how placeholder is represented. |
| Value type: Lookup – Multi select value behaviour | ||
| Multi-select lookup insert format | One of the following: • SimpleValue • HorizontalTable • VerticalTable • UnorderedList • NumberedList | Choose how multi-select lookup will be represented in word file. |
| Multi-select lookup insert quantity | One of the following: • All • First | Choose first or all values of multi-select lookup. |
| Multi-select lookup item sort by | One of the following: • ById • ByName | Choose value representation of multi-select lookup values. |
| Multi-select lookup item sort direction | One of the following: • Ascending • Descending | Sort direction of multi-select lookup values. |
