Skip to content

Check and save

Open the Check tab and click Check. Every tag in the document, headers and footers included, is checked against your org:

  • A tag that matches no field is marked Unresolved, with the reason, for example “Not a field of Account.”
  • A field used in the wrong place, inside or outside a repeating list, is flagged.
  • Tags left over from another document tool are listed under Not recognised.

Click any row to jump to that tag in the document. Turn on Highlight tags to shade every tag while you work. The shading is removed automatically when you save.

Opening the tab does not run the check by itself, because checking a whole document takes a moment. The count on the tab tells you whether a check has run and what it found. Salesforce also checks every tag again when you save.

The pane tells you which tags are wrong and where they are, but it does not suggest corrections.

  1. Open the Save tab.
  2. The card at the top shows where this save is going: a new template, or a new version of one you saved before, with that template’s current status.
  3. Give the template a name. It starts as the document’s file name. When you save a new version of an existing template, its current name is shown instead, so a save never renames it by accident.
  4. The base object is shown here but cannot be changed. Change it on the Build tab.
  5. Click Save template (or Save new version) in the bar at the bottom.

If the check found problems, a red banner on the Save tab says so, and warns that the saved version will be marked Invalid until they are fixed. You can still save. The add-in never stops you.

Save a new version of an existing template

Section titled “Save a new version of an existing template”
  1. Click ▤ My templates in the header to see the templates already saved for this base object.
  2. Pick one. Your next save creates a new version of it instead of a separate template, and the card on the Save tab names it.

To save as a separate template instead, choose New template… in the Save to dropdown. After any save, further saves from the same pane keep adding versions to that template.

You can change a template at any time: open the document in Word, make your changes, and save again. Until the template is first published, saving updates the current draft. After that, each save creates a new version for you to proof and publish. See Word-file templates.

Saving uploads the document and checks every tag against your org. The Save results panel then appears on the Save tab, starting with a VALID or INVALID label for the version you just saved:

  • A green banner means the template is valid and ready to publish.
  • A red banner means some tags could not be matched. Fix them and save again.

Below the banner, every tag is listed with its status:

StatusMeaning
ResolvedMatches a real field.
StructuralA loop or condition tag. These are expected.
UnresolvedNo matching field. This needs fixing.
FLS warningThe field exists, but the user generating the document may not be able to see it.

The panel also tells you, before you publish, whether the document can be made into a PDF. See Generate and publish.

The bottom bar then offers:

  • Generate: creates a test document from this saved version and a record you pick.
  • Open in Salesforce: opens the template in the Template Editor in Salesforce, on the version you just saved.
  • Fix in Check: takes you to the tag list, where you can jump to each tag. It appears only when there is something to fix.

An unresolved tag is almost always a typo, or a field that does not exist on the chosen object:

  • Check the spelling against the field list on the Build tab.
  • Re-insert the field from the picker instead of typing it by hand. That guarantees a valid tag.
  • Make sure you picked the right base object on the Build tab. A field that is valid on Opportunity does not resolve on a template built for Account.

Fix the document in Word, then save again. Moving between tabs does not lose anything you set on the Save tab, such as the target template, the base object or the test record.