Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.
Creating a Template Fragment
A Template Fragment can return data from either an SQL Query, Model Scripts or Project Browser data. The process of defining the content of a Template Fragment depends on which of these types of data you want your Template Fragment to return, although in all cases the process is very similar to creating a normal document template.
Access Project Browser | Right-click on Package | Documentation | Generate Documentation (F8) > Templates
Create a new Template Fragment
Step |
Action |
See also |
---|---|---|
1 |
Click on the . The 'New Document Template' dialog displays. |
Document Templates |
2 |
In the 'New Template' field, type the name for the Template Fragment. |
|
3 |
In the 'Template Type' field, click on the drop-down arrow and select the 'Fragments' option. |
|
4 |
In the 'Copy Template' field, click on the drop down arrow and select either:
|
|
5 |
In the 'Template Group' field either:
The Template Group determines the location of the Template Fragment in the Resources window. |
Resources |
6 |
Click on the . The Document Template Designer displays in the Diagram View. |
Design Custom Document Templates |
7 |
Define the contents of your Template Fragment; the actual steps you follow depend on the data type you want the Template Fragment to return:
Alternatively, if you want to use the Template Fragment to call other Fragments depending on element type, define it as a Template Selector. |
Custom SQL Fragments Design Custom Document Templates Custom Script Fragments Define a Template Selector |
8 |
Once you have created the Template Fragment, you incorporate it into a normal template (or into an existing Template Fragment, if you wish). |
Adding Fragments to a Document Template |
Notes
- As with normal document templates, Template Fragments can also be created and opened via the Resources window
- Template Fragments in the Resources window are held in a Fragments folder in each of the Document Generation > System Templates and Document Generation > User Templates folders, and are indicated by a T symbol
- If you have an existing template that you want to use as a Template Fragment, copy the template as the base of a new Fragment (as above)
- If you embed a Template Fragment within another Fragment, report generation from the parent template will be slower
Learn more
Learning Center topics
- Alt+F1 | Enterprise Architect | Reporting | RTF Template Fragments |
- Create a SQL based Fragment 1
- Create a SQL based Fragment 2
- Create a Script Fragment 1
- Create a Script Fragment 2
- Create a Filtered Fragment 1
- Create a Filtered Fragment 2
- Combine Filtered Fragments