Providing Word merge operations

You can use a standard flow action to convert Field Codes in a Microsoft Word document to values of corresponding properties on the clipboard.

This process is used to create correspondence. It is also used to support features found in the Specification and Flow forms.

Prerequisites and restrictions

This feature requires Microsoft Word and supports .doc and .docx file formats. Refer to the Platform Support Guide on the PDN for a list of supported versions of Microsoft Word.

Configure your browser with the Microsoft Silverlight plug-in.

Install the Pega Platform Silverlight prerequisites file on your local machine:

  • Supported versions of Internet Explorer automatically prompt you to download and install the file the first time you use the Word Merge feature.
  • Supported versions of Firefox, Chrome, and Safari display a dialog to download a .zip file. You must first extract this file, run setup.exe, and restart your browser before using the Word Merge feature.
  • The Pega Platform Silverlight prerequisites file is available in the Pega Platform Resource kit. System administrators can use the file to set up multiple client systems at once.

If you are using Microsoft Word 2007 or 2010 on a Windows 7 or Vista machine, follow this procedure before using the Word merge feature. You can encounter browser error messages otherwise.

At run time, using this feature requires substantial memory on the workstation.


You can review this capability using two flow actions included in the sample flow PegaSample.WordEmbedMergeTest.

The first flow action PegaSample.EmbedWordTextAreaSet supports inline editing for three properties: pyDescription, pyMyEdits, and pyNewFormula.

The second flow action PegaSample.CreateMergedWordDoc searches these property values — each a Word document — for Field Codes that represent clipboard properties, and merges in the current values. You can also insert HTML code from correspondence rules, images from binary file rules, and other text as Field Codes.

How to configure clipboard merge operations

  1. Create an attachment category for the document.

  2. Design the appearance of the document.

  3. Create a Rule-Template-Word rule.

  4. In the Word Template rule form, click Edit Word Template to open a blank Word document in the Word installed on your workstation.

  5. Using Microsoft Word, compose your document.

  6. In Word, turn on the setting to show field codes instead of their values. (The steps to do this vary depending on your version of Word. The check box is typically in the Options > Advanced or Options > View set of option settings.)

  7. At the appropriate locations in the document, insert fields using one or more of these field codes as appropriate. (This are field codes, not JSP tags, though the syntax is similar.)

Syntax Result during clipboard merge
{pega:reference propertyreference }
Include the value of a scalar property present on the clipboard page.
{pega:attachment attachmentName }
Include the contents of an attachment.
{pega:binaryfile binaryFileName }
Include the value of a binary file rule. Identify all three key parts of the rule using the format AppName.imageFileName.FileType.
{pega:insert corr="Name" }
Include the HTML code text from a correspondence rule with Name as the second key part. The final key part of the correspondence rule must be mail.

After processing and the insertion of the text to the Word template, no newline will be added after the text. Use this Field Code to include the formatted and stream processed content of a correspondence rule within existing text contained in the Word template or in scenarios where template formatting requires no additional newline after the inserted text.

{pega:binary imagefile=imageFileName }
Include the image associated with a binary file rule. Identify all three key parts of the rule using the format AppName.imageFileName.FileType.
{pega:binary imagefilelocalpath="LocalPath" }
Include a local image. For example: {pega:binary imagefilelocalpath="C:\donut.jpg" }
  1. In Word, hide the field codes by clearing the setting to show field codes instead of their values.
  2. When your document is ready, protect all or parts of the document using Word's Protect Document setting. You can protect the entire document, or only specific sections defined by Word section breaks.
  3. Use the Save operation in Word to save the document into the Word Template rule. Then save the Word Template rule form.
  4. Configure at least one harness or section to include the property as an input field, following the instructions above.
  5. Copy and modify the standard flow action PegaSample.CreateMergedWordDoc into an appropriate RuleSet and Applies To work type in your application.
    • Enter an Action Name key part of you choosing.
    • Update the Before This Action. .. activity parameter to reference the Purpose value — second key part — of the Word Template rule.
    • In the After This Action activity parameters, enter as the pyCategory value the name of the attachment category you created in Step 1 above, within double-quotes.
  6. Save the flow action. Update a flow rule to reference the flow action.
  7. Test.

Internal notes

This feature requires Word macros contained in the template WordMacroManagerDot.Dot template file. This file has a certificate digitally signed by Pegasystems. Operation of macros is automatic and requires no user interaction.