Report Wizard uses templates to generate reports. Each report file format depends on the type of template files. The type of template files that Report Wizard supports includes plain text, RTF, HTML, Office Open XML(ISO/IEC 29500:2008), OpenDocument format (ISO/IEC 26300), and XML template (DocBook or FO).
Report Wizard provides predefined templates such as Use Case, Model Extension, Data Dictionary, IEEE 1233, Class Specification Diagram, Business Process Diagram, and Web Publisher templates. The report template management pane in the Report Wizard dialog lists all of the report templates from which you can select to manage or generate your report.
Image Modified
There are many template
Template options, which are highlighted in orange, are available to choose from in the Report Wizard dialog.
Using the Template Management Pane
In this pane, you can create a new template, or use an existing one. The following table displays the buttons from which you can choose while working with your template. Additionally, the control buttons in the lower part of the dialog Image Modified,Image Modified, and Image Modified help you cancel an action, go to the next step, and generate a report.
Button
Function
Image Modified
Opens the New Template dialog through which you can create a new template.
Image Modified
Edits a template and saves it in Report Wizard.
Image Modified
Deletes a template from Report Wizard.
Image Modified
Opens a template file in the default editor.
Image Modified
Creates a new template variable and modify or delete an existing template variable in the Template Variable dialog.
Image Modified
Clones a selected template.
Image Modified
Copies a selected template and adds it to the project file.
Image Modified
Extracts an attached template to a local report templates folder.
Image Modified
Imports a template.
Image Modified
Exports a template
.
Working with a Template
The following instructions illustrate how to use each button in the Report Wizard to create, select, and manage a template.
Expand
title
How to
To create a template
On the MagicDraw main menu, click Tools > Report Wizard. The Report Wizard dialog will open.
Click Image Modified. The New Template dialog will open.
Image Modified
Creating a new template in the New Template dialog.
Enter the template name and description.
ClickImage Modified to select the location of the new template.
Select the template file location and click Image Modified.
Click Image Modified. The template file will be created in the Select Template pane.
Image Modified
The template file is created in
the Select Template pane
the Select Template pane.
Expand
title
How to
To edit a template
In the Report Wizard dialog, select a template and click Image Modified. The Edit Template dialog will appear.
Image Modified
Editing a template in the Edit Template dialog.
Edit the template name, description, category, and locate the template file’s location.
Click Image Modified.
Expand
title
How to
To delete a template
In the Report Wizard dialog, select a template and click Image Modified. The Confirm delete dialog will appear.
Click Image Modifiedto delete the selected template from the template list, or click Image Modified to cancel the operation.
Image Modified
The Confirm delete dialog
Expand
.
To
title
How to
clone a template
In the Report Wizard dialog, select a template and click Image Modified. The Clone Template dialog will appear.
Image Modified
Cloning a template in the Clone Template dialog.
Enter the name and description. The name of the cloned template should begin with Copy of (name of template).
Click Image Modified to clone the template.
Expand
title
How to
To copy a template and add it to the project file
Select a template in the Report Wizard dialog.
Click Image Modified to make a copy of the selected template and add it to the project’s files, so anyone with access to the project can generate a report.
Image Modified
The steps to attach a template to a project file.
The new template will be created and displayed in the Report Wizard dialog and the Containment tree. Image Modified
Result of attaching a template in the Report Wizard dialog.
Image Modified
Result of attaching a template in the Containment tree.
You can right-click the attached template in the Containment tree, and select Generate Report{attached template name} to open the Report Wizard dialog.
Image Modified
Opening the Report Wizard dialog via attached template in the Containment tree.
Image Modified
The Report Wizard template selection dialog
.
Info
title
Note
In the Report Wizard dialog, when you select the attached template, the Image Modified button will be changed to Image Modified button.
You can use the Image Modified button to extract the attached template to the local report template folder. After you finish editing, you can use the Image Modified button to re-attach the updated report template to your project.
Expand
title
How to
To extract a template
Select an attached template in the Report Wizard dialog.
Click Image Modified to extract the attached template to the local report template folder.
If the template already exists in the local report template folder, a confirmation dialog will be displayed.
Image Modified
The confirmation dialog when you extract a template.
Click Image Modified to extract the template. The attached template will be extracted to a local template.
Image Modified
A local template in the Report wizard's template selection pane.
Tip
After you finish editing, you can use the Image Modified button to re-attach the updated report template to your project.
You can remove an attached template from a project by selecting it and clicking Image Modified.
Expand
title
How to
To import a template
In the Report Wizard dialog, click Image Modified. The Select Location dialog will appear.
Image Modified
Selecting the location to import a template.
Select a Report Wizard template with the filename extension *.mrzip and click Image Modified. The following Message dialog will open. Image Modified
The Message dialog of a successful import.
Expand
title
How to
To export a template
In the Report Wizard dialog, select a template and click Image Modified. The Select Location dialog will open.
Image Modified
Selecting a location to export the template.
Select a directory or folder location in which you want to export the template.
Type the filename and click Image Modified. The Message dialog will open.
Click Image Modified.
Image Modified
The Message dialog of successful export.
Expand
title
How to
To open a template file in the default editor
In the Report Wizard dialog, select a template and click Image Modified. The template file will open in the default editor.
Working with a template variable
A template contains variables and their values. You can create a new template variable, and modify or delete an existing template variable in the Template Variable dialog. You cannot modify the variables of a built-in template. You can only create or modify a template variable of a user-created template.
Image Modified
The Template Variable dialog.
The Template Variable dialog, contains the following:
Variable pane: This pane consists of a table in which the first column is the variable name, the second column is the variable value, and also includes a report description field. You can view and directly edit the value of a selected variable in the second column.
Control buttons: Image Modified and Image Modified.
The following instructions explain how to manage the variables of a template.
Expand
title
How to
To create a template variable
Select a template in the Report Wizard dialog and click Image Modified. The Template Variable dialog will open.
Click Image Modified. The New Variable dialog will appear.
Image Modified
Creating a new variable in the New Variable dialog.
Enter the variable name (no space between characters) and description.
Select an owner for this new variable from the Owner drop-down list (optional).
Click Image Modified. You will see the newly-created variable’s name and value in the Variable pane.
In the Template Variables dialog, clickImage Modified.
Expand
title
How to modify a variable in the Template Variable dialog
You can
To modify a variable value in
either the Template Variable dialog or Variable value dialog.How to modify a value in
the Template Variable dialog
Select a template in the Report Wizard dialog, and click Variable to open the Template Variable dialog.
Double-click the Variable value column and modify the value in the column.
Image Modified
Editing a variable value in the Template Variable dialog.
Expand
title
How to
To modify a value in the Template Variable value dialog
Double-click the Variable value column in the Variable pane in the Template Variable dialog, and click the Image Modified button. The Variable value dialog will open.
Image Modified
Editing a variable value in the Variable value dialog.
To modify the variable value, you can enter the value of a report variable either in plain text or HTML by selecting the HTML check box in the Variable Value dialog. Image Modified
Entering a report variable value in HTML.
Click Image Modified.
When you finish modifying variables and their values in the Template Variable dialog, click either Image Modified to confirm the changes or Image Modifiedto discard them.
Expand
title
How to
To delete a variable
Select a variable in the Template Variable dialog and click Image Modified. The Question dialog will appear prompting you to confirm before deleting the selected variable.
Click Image Modifiedto delete the selected variable.
Image Modified
Deleting a variable
Panel
title
On this page
Table of Contents
Glossary
Expand
.
Glossary
title
Use case
Use case is
A a kind of behavior classifier that specifies a complete unit of useful functionality performed by one or more subjects to which the use case applies in collaboration with one or more actors. It also, for complete use cases, yields an observable result that is of some value to those actors or each subject. Use cases allow you to capture the requirements of systems under design or consideration, describe functionality provided by those systems, and determine the requirements those systems pose on their environment.
Expand
title
Business process diagram
Business process diagram is a
A road map for implementation. It outlines the expected outcome, and provides something concrete from which to build.
More information about working with templates in Report Wizard
To learn more about templates and template variables, you can visit the following pages: