You are here: Reference > Rule types > Word Templates > Word Template rules - Completing the Main tab

  Word Template rules
Completing the Main tab

  1. About 
  2. New 
  3. Main 
  4. History 
  5. More... 

Use these buttons to access the Word file associated with this Word Template rule. Ordinarily, choose the Edit Word Template button unless you are copying a Word file from one rule to another or from one system to another.

The Word file associated with the Word Template rule uses the DOC file format.

Field

Description

Relative Path

Optional. Leave blank in most cases.

Enter a subdirectory of the Web server directory identified by the first key part of this rule instance.

Category

Leave blank. Reserved.

Upload File

Click to upload a Word file in DOC file format from your workstation into this rule. The file should be based on the WordMacroManagerDot.Dot template. Save the rule form after the upload completes.

Download File

This button is grayed out until a template has been uploaded and the rule has been saved. Click to download and save the Word file from this rule as a file on your workstation, so that you can edit or examine it.

Edit Word Template

This button is grayed out until a template has been uploaded and the rule has been saved. Click to edit the Word file associated with this rule. For a new Word Template rule, the document is initially blank. (Windows automatically downloads the WordMacroManagerDot.Dot template to your workstation if it is not already present. This DOT file is contains a digital certificate signed by Pegasystems Inc.)

Criteria  
Section

Leave blank. Reserved.

Validation

Leave blank. Reserved.

Data Transform

Leave blank. Reserved.

Embedding Field Codes for merge

If this Word document is to support the clipboard merge function, you can include the following directives as field codes. Select Insert > Field Code... from the Word menu.

Syntax

Result during clipboard merge

{pega:reference propertyreference }

Include the value of a scalar property present on the clipboard page.

{pega:insert corr="Name" }

Include the HTML code text from a correspondence rule with Name as the second key part.

{pega:attach CategoryName }

Include the HTML code text from a Word document that is the newest file attachment of the category CategoryName.

{pega:binary Name }

Include another Word document associated with a Rule-Template-Word rule with the value of Name including both keys to the rule using the format AppliesToClass.Purpose. For example, Work-.SampleWordTemplate.

About Word Template rules