Resource Documents

When you set the parameters on the Generate Documentation dialog to define an output document as you need it, you might want to re-use that configuration to obtain a consistent view of changes to your model over time. You can capture the configuration as a Resource Document, which saves the:

Package name
Output file destination
Template
Output format
Options page settings
Exclude Filters
Element Filters and
Other Filters
 

The document is saved into the Document Generation > Defined Documents folder of the Resources window. Saving your often-used report configurations as Resource Documents can simplify future document generation, both in producing specific documents and in batch-generating all documents or a selection of documents.

Access    Project Browser package: F8 > Generate: Resource Document  or
Diagram element: F8 > Generate: Resource Document
 
Project | Resources (Alt+6) | Document Generation | Defined Documents

Manage Resource Documents

Task

Action

See also

Create a Resource Document

On the Generate Documentation dialog, click on the Resource Document button and, in the Enter Value field, type a name for the document.

Click on the OK button. The document is added to the Resources window for easy future access.

 

 

Open, Generate or Delete Documents

In the Resources window, expand the Defined Documents folder and right-click on the required document.

Select the required context menu option:

Open Document - Open the corresponding .document file, as specified by the document template Filename property
Generate Document - Open the Generate Documentation dialog, loaded with the specified template
Auto Generate Document - Generate documentation, with the document located at the path specified by the template's Filename property
Delete Document - Remove the specified document

 

 

Batch-generate a number of documents

Right-click on the Defined Documents folder name and select the Generate Documents context menu option; the Batch Document Generation dialog displays.

The dialog lists all resource documents in the Defined Documents folder, defaulted to selected; deselect the checkbox against each document that you do not want to generate (or click on the Deselect All button to clear all selections, then select those you require).

Click on the OK button to generate each of the remaining reports into their respective target file locations.

Alternatively, to automatically generate every document in the Defined Documents folder, without displaying the Batch Document Generation dialog, click on the Generate All Documents context menu option.

 

 

Learn more

Learning Center topics

Alt+F1 | Enterprise Architect | Reporting | Rich Text Reports | Generate an RTF Report