Skip to main content
BOOK A DEMO

Action: Merge Word documents

skybow Support
  • Article Updated

Merge Word documents action allows you to merge Word documents (DOCX) to the file. 

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

To configure the action Merge Word documents additional properties should be specified:

Configuration

Property Required Type Description

Source Library

 yes Choice

A library where source document is located. It is possible to select:

  • from the current site, by selecting the 'On current site' option. The drop-down shows all available libraries on the site.
  • from any site, by selecting 'On any site' option and specifying the list in 'Select  Library' dialog or typing a server relative URL to a library.
  • Dynamic path which allows to specify expression based path to file

Add new source library (+)

 no Choice

Add new source library where source document is located. It is possible to select:

  • from the current site, by selecting the 'On current site' option. The drop-down shows all available libraries on the site.
  • from any site, by selecting 'On any site' option and specifying the list in 'Select  Library' dialog or typing a server relative URL to a library.
  • Dynamic path which allows to specify expression based path to file
Item Id(s) yes Integer ID(s) of the documents to be merged to the file or expression to be evaluated as ID(s) of a documents.
Target yes Choice

There are two options where merged document can be stored:

- Open in browser. 

- Save to library.
Target library yes Choice

A library where merged document will be stored.  It is possible to select:

  • from the current site, by selecting the 'On current site' option. The drop-down shows all available libraries on the site.
  • from any site, by selecting 'On any site' option and specifying the list in 'Select  Library' dialog or typing a server relative URL to a library.
  • Dynamic path which allows to specify expression based path to file
Folder no String

Library relative URL. If you want to store merged document to a new folder you can specify it in this property.
File name yes String

Fixed file name for merged document or dynamically calculated using an expression.
If already exists
 		yes Choice

If the file with the same name already exists you have several option to specify:
- Overwrite. It will overwrite to exiting document in the target document library.
- Rename and keep both. It will rename document you want to move and keep existing one.
- Fail. Action will fail with an error: A file or folder with the name [[FileName]] already exists at the destination.
Hide review changes no Toggle

This option allows to hide existing tracked changes in the merged document. 

Note1: Merge Styles - Default formatting settings and default styles (Like Normal, etc.) always took from the first document.
Note2: Header/footer always from the first document

Known issues:
- Page settings (page orientation, size, etc.) merging not supported (for the most cases took from the first document)
- Merging of online created documents and desktop created documents not supported.

Availability

Modern Forms List Actions Scheduled/Triggered Actions
✓ ✓ -

 

Example of Merge Word documents action configuration on the current site

MergeWordDocuments.png

 

Output

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

 

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

MergeWordOutputs.png

Related articles