UAF Plugin 19.0 LTR SP1 Documentation


On this page

The modeling tool report handling functionality allows you to store UAF report data in a UAF project. With this feature you can easily manage multiple reports with different properties and quickly print a report directly from the model. Another benefit from storing your report data within a project is that you can easily pass the report on to other users by passing the project.
UAFreports can be handled similarly as any other artifacts: diagrams, matrices, and tables. There is a report data element created by default in a project template for each UAF report. A report data element is filled in with predefined default data.

Creating a new report data element

You can create a new report data element from the shortcut menu of a viewpoint or view package.

To create a report data element


  1. In the Containment tree, right-click a package for which you want create a report data element .
  2. Choose Generate Report, select a required report group and a report template.
    A new report data element that stores the default data for a particular report is created.

The newly created report data element is filled in with default data for successful generation of the report. To see variables and data of the report, expand the report element node in the Containment tree.

Changing the data stored within a variable

If you need to change data stored within a variable, open the variable's Specification window and then edit the Value property value.

You can store not only variables as data within a report data element, but the editable default report properties as well. The following table lists available editable default report properties and their descriptions.


Property


Description

Name

To specify the name of the report data element.

Generate Recursively

Set to true to generate the report, recursively including all inner packages within a defined report scope.

Data

To select one or more packages and / or elements to define a scope for generating the report.

Auto Image Size

To specify an image size in the report.

Empty Text

To specify a value to be inserted when data contains no value.

Image Format

To select an image format for all the images in the report.

Template

To select a report template.

A report template is not a part of a project.

Variables

To add, remove, and order report input variables.


To edit a report property, open the report data element's Specification window.

Generating a report from the report data

You can generate a report directly from the report data.

To generate a report from the report data element


  1. Right-click a report data element and click Quick Generate Report.
    Quick Generate Report
  2. Specify the location to save the generated report.  
  3. Select whether or not to open the generated report directly after the generation.

You can create several reports with different data for each type of the report.

Generating a report using the Report Wizard

You can also use the Report Wizard for report generation. Using this wizard, you can generate a report either from existing report data elements (after loading them to the wizard) or from external report data.

 

To open the Report Wizard


  • Click Tools > Report Wizard and select the report templates for the UAF views.