Skip to main content
Version: 1.28 (Current)

Word

Audience: Low-code Engineers

Skill Prerequisites: Actions, Tokens, HTML, CSS

The Word add-on adds actions that create and read Word documents. One converts HTML styled with CSS into a .docx file. The other reads the text of a .docx file into a token.

note

These actions are part of the Word add-on (PlantAnApp.Word). The add-on is installed separately and needs the PAAWORD feature in your license. If it isn't licensed, the actions fail. If you don't see the actions in the Documents group, the add-on isn't installed.

Choosing an action​

ActionWhat it doesUse it to
Html to Word (.docx) - ExperimentalConverts HTML into a .docx, applying the CSS rules in <style> blocks. It can start from a Word template. It's experimental, so test the output.Build a Word file from HTML styled with classes and selectors.
Plain text from WordReads the body text of a .docx file into one token. The file can be a portal file or a file at a URL.Search an uploaded document for keywords, or pass its text to another action.

Other Word actions​

Two more Word actions come with the File Management add-on, not this one:

ActionWhat it doesUse it to
Replace Tokens in Word DocumentCreates a new .docx from a Word template by filling in content controls that hold tokens.Generate offer letters or contracts that users can still edit in Word.
Convert from HTML to WordConverts HTML into a .docx, using inline styles only. It's obsolete but still works.Maintain existing applications. For new ones, use Html to Word (.docx) - Experimental.

Use Html to Word (.docx) - Experimental when you build the whole document from HTML. Use Replace Tokens in Word Document when the layout is a Word file that someone maintains in Word. If the output doesn't need to be editable, Generate PDF in the PDF Generator add-on gives you more control over the look.

Working with the files​

  • Where the file goes. Html to Word (.docx) - Experimental saves the document in a portal folder you choose, and returns it in tokens. It doesn't send the file to the browser. Use Redirect to URL, or attach the file with Send Email.
  • Missing folders are created. If Folder is empty, the document is saved in the Temp folder.
  • Files with the same name. Handle Duplicates is Rename by default, which adds a unique suffix. Set it to Overwrite to replace the file.
  • .docx only. Plain text from Word accepts .doc files but reads them as .docx, so an older binary .doc file fails. The template of Html to Word (.docx) - Experimental must be a .docx file. Save older files as .docx in Word first.
  • Plain text only. Plain text from Word drops formatting, images and layout. To find values in the text, use the Parsing actions, such as Regex.

For PDF and Excel files, see the PDF Generator and Excel add-ons. For all add-ons, see Add-ons.

Revised 10/02/2026