WORD Mail merge function

The WORD Mail merge function in RPA.

Help CentreBuilding Processes

This article describes the RPA Word functionality to mail merge.

For a full list of available functions, please read WORD functions.


Description

The WORD Mail merge function allows you to populate placeholder tokens in paragraphs and tables with values.


Setting it up

To use the WORD Mail merge function, follow these instructions:

{{popups:rpas/add:action=word-mail-merge}}

Once on a process map:

  1. Navigate to the process where you would like to add the WORD Mail merge function
  2. Click on the green button's drop-down (right side of the green button labelled "Process")
  3. On the menu that appears, click on the "+ Activity" item
  4. From here you can select the WORD Mail merge option
  5. Click "Add" once you are done

Input parameters

ParameterRequiredTypeDefaultDescription
Data (JSON)YesTextarea-Dictionary of placeholder names to replacement values as JSON. Populates {{placeholder}} tokens in paragraphs and tables

Output variables

This action does not produce output variables.


Errors

ErrorDescription
Word not openMicrosoft Word is not running
Invalid JSONThe data parameter is not valid JSON

Tips

  • Use double curly braces for placeholders e.g. {{name}}
  • Works in both paragraphs and table cells
  • Use variables for dynamic data

Related functions

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.