IBM Support

Export to Microsoft Word results in missing Table of Contents using IBM Rational DOORS

Troubleshooting


Problem

Attempts to export to Microsoft Word from Document Generation using IBM Rational DOORS result in the Table of Contents not being generated

Symptom

From the IBM DOORS Formal Module Navigate to:

File -> Export -> Document Generation -> Export

Click Advanced button

Check for "Use custom template"

Browse to the custom template for example *.dotm

Click OK

Export

The Table of Contents not being generated after exporting a document to Microsoft Word.

Cause

The reason is because the macro is missing the custom template. The Table of Contents issue only occurs on custom defined template using Document Generation -> Export option. The Export to Microsoft Word or using default template with Document Generation -> Export option does populate the Table of Contents.

Environment

IBM Rational DOORS 9.6
Microsoft Word 2010

Diagnosing The Problem

In IBM DOORS versions pre and including 9.6.0, export tries to run default macro called 'rpe'. If this macro is not available in the supplied Microsoft Word template all fields remain not updated. If you provide a custom template via Advanced dialog, the IBM DOORS still aim to run this macro.

Background how DOORS TOC generations works:
By default IBM DOORS uses a rpe.dot template. This is supplied with IBM DOORS under:
C:\Program Files (x86)\IBM\Rational\DOORS\9.x\lib\dxl\standard\export\RPE_light\utils\word\rpe.dot
This is a Microsoft Word template which contains 'rpe' macro which generates (and updates) the Table of Contents

Resolving The Problem

In order to have the Table of Contents updated, you can perform one of the following:
- Use Ctrl+A and F9 combination on generated document - but that is not an automated approach
- Update your custom template with macro similar to the one from rpe.dot - a default macro should be named rpe
Default macro from rpe.dot available under C:\Program Files (x86)\IBM\Rational\DOORS\9.x\lib\dxl\standard\export\RPE_light\utils\word\rpe.dot

[{"Product":{"code":"SSKR2T","label":"IBM Engineering Requirements Management DOORS"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"Documentation","Platform":[{"code":"PF033","label":"Windows"}],"Version":"9.2;9.2.0.1;9.2.0.2;9.2.0.3;9.2.0.4;9.2.0.5;9.3;9.3.0.1;9.3.0.2;9.3.0.3;9.3.0.4;9.3.0.5;9.3.0.6;9.3.0.7;9.3.0.8;9.4;9.4.0.1;9.4.0.2;9.5;9.5.0.1;9.5.0.2;9.5.1;9.5.1.1;9.5.1.2;9.5.1.3;9.5.2;9.5.2.1;9.5.2.2;9.6","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}}]

Document Information

Modified date:
01 May 2020

UID

swg21682781