Adding Microsoft Word export templates to Helix ALM

Before users can export Helix ALM items to Word, templates must be created and added to Helix ALM. A template is a Word document that controls what information Helix ALM exports and formatting of the resulting document. See Creating Microsoft Word export templates.

After creating a template, upload it to the server and select the security groups who can use it to export items. You can mark new templates as drafts and preview what an export using them looks like. This helps you see if any changes are needed before making templates available to users.

When a template is ready to use, clear the Draft setting so users can access it. See Exporting items to Microsoft Word for information about exporting items.

1. Choose File > Export > Configure Word Export Templates. You can also click Configure Templates in the Export to Microsoft Word dialog box.

The Configure Word Export Templates dialog box opens.

2. Click Add.

A template named 'New template' is added to the list.

3. Enter and select the basic template information.

  • Name identifies the template. You can enter up to 128 characters.
  • Description provides additional information about the template. You can enter up to 1000 characters.
  • Security groups are the groups that can use the template for exports. You can select a specific group, multiple groups, or <All> to let all groups use the template. Users with security permissions to configure templates can view all templates in the Configure Word Export Templates dialog box.
  • Draft indicates the template is still in development and not ready to be used for exports. If this option is selected, the template is not available when users export items. Clear this option when the template is ready for use.

4. Click Upload and select the Word template file. Only .docx and .docm files are supported.

Any Word review comments in the template file are removed when uploading it. You may want to use Word's hidden text feature to include any comments in the template. See the Word help for information.

5. Click Open.

Helix ALM checks the template for syntax and other errors before uploading it to the server. If the template is successfully uploaded, the template file name is displayed in the dialog box. If the upload fails because the template contains errors, you are prompted to view and correct them. Click View Errors to open the template with error information and fix any errors before uploading again. See Correcting Microsoft Word export template errors.

6. Click Preview to preview an export using the template. See Previewing Microsoft Word exports.

7. Click Save.

8. Click Close when you finish.

If export problems occur, you can create a ZIP file that contains information about a template and send it to Perforce Support for troubleshooting help. See Generating debug files for troubleshooting Microsoft Word export problems.