Action: Generate Word document

Generate Word document action allows you to generate documents based on a standard Microsoft Word file filled with SharePoint list data.

Example of Generate Word document action configuration for single item

For more information about Action Builder read Action Builder introduction
article.

For more information about Document generator and examples read Document Generator introduction article.

To configure the action Generate Word document additional properties should be specified.

Configuration

*Property*	*Required*	*Type*	*Description*
Template	yes	.docx Document	- Static path. Provide a new word template that contains placeholders or select existing template from library on the current site - Dynamic path. Allows to specify expression based path to template
Data source	yes	Choice	Select available option: 'For single items'/'For multiple items'
List or library	yes		A list or library from current site
For single item: Item Id	yes	Integer or string	The item id of the element to get the data into the generated document
For multiple items: Query	no	String	A valid CAML query string to filter the items in the list/library to generate a document for
For multiple items: View	no	Choice	Select a view configured on the list/library to filter the items. This can be used instead of a Query or in combination, where it will merge the Query and the View.
Target	yes	Choice	Select available option: "Save to library" / "Open in browser".
File name	yes	String	Fixed file name for generated document or dynamically calculated using an expression.
Overwrite file	no	Toggle	It will overwrite the document if the file with the same name already exists

*Modern Forms*	*List Actions*	*Scheduled/Triggered Actions*
✓	✓	✓

*Output Parameter*	*Type*	*Description*
ItemID*	Number	Returns the Id of the generated document in a library
FileName	String	Returns the file name of document
Url*	String	Absolute Url to the file. Starts with 'https://'
ServerRelativeUrl*	String	Server relative path to the file. Starts with '/'
LibraryRelativeUrl*	String	Library relative path to the filer. Starts with folder name

*Output parameter value is available in a case of using option "Save to library"

Related Articles
Introduction to Document Generator
What is the document generator? The "Document Generator" allows you to generate documents based on a standard Microsoft Word file filled with SharePoint list data. This can be triggered in actions used in list actions, modern forms or background ...
Action: Convert to PDF
Convert to PDF action allows you to convert the specified file to PDF. We support converting a wide variety of files: Microsoft Word documents (DOC, DOCX), Excel spreadsheets (XLS, XLSX) and PowerPoint files (PPT, PPTX). Example of Convert PDF action ...
Action Builder Introduction
The Teamsware Studio Action Builder is a tool that allows you to specify actions which are executed in consecutive order. You can build powerful workflows triggered from a form button, on form load, from a list view, scheduled or event triggered on a ...
How to use QR code image in the Document Generator template
There are a lot of services that generate QR codes. In this article, we use this service to generate QR code image with Send HTTP request action and use this image in the Document Generator template: 1. Add Send HTTP request action with the API ...
Action: Get image data
Get image data action allows you to retrieve the image data information such as geolocation and the size of the image. Example of Get image data action configuration on the current site For more information about Action Builder read Action Builder ...