Generating Reports

Overview

You can generate reports in TopTeam to share the selected artifact and its desired details. The generated report will be in PDF or Word format, depending on your preference.

TopTeam allows you to change the report template to meet your specific needs, making this function more user-friendly.

Different methods for generating reports

TopTeam offers two different methods for generating reports:

Ad Hoc Report – allows you to easily generate detailed report for different sections without the need to create a template.
Saved Templates – Select a predefined template to generate your report. You can also personalize a template to suit your needs. To personalize a report in Saved Templates, you must add commands/syntaxes to the template.

It is important to note that this is for advanced users who should know the commands to make the desired template changes. To see a list of all commands that can be used in a template for customization, see DocProcessor Commands Reference Guide.

$C:\Users\admin\AppData\Local\Temp\SNAGHTML305900e0.PNG$

You may decide which method you want to use for generating a report.

However, using both methods, you can generate a report for single as well as multiple artifacts.

Let’s first understand how to generate an Ad Hoc Report and then how to generate a report using Saved Templates.

Generating Ad Hoc Report

Step 1. Opening Generate Ad Hoc Report

You can open Generate Report screen in the following ways:

For a single artifact
For multiple artifacts
For a package
For a project

1. Opening Generate Ad Hoc Report for a Single Artifact

You can access Generate Report action for a single artifact from the icon in Detail Editor or split pane toolbar in the repository.

Select an artifact in the explorer or any interface such as document-like view, tree view, etc.
Click the icon.
Click Generate Report.

Screenshot showing the opening of Generate Report from Detail Editor

NOTE

You can also generate a report of a single artifact by selecting a project in the explorer. On the Generate Report screen, you need to select a specific artifact for which you want to generate the report.

This will open Generate Report screen from where you can generate Ad Hoc Report.

To jump to the steps for generating Ad Hoc Report, click here.

2. Opening Generate Ad Hoc Report for Multiple Artifacts

You can access Generate Report action for multiple artifacts from a Project, Package or select multiple artifacts in the explorer.

A floating toolbar appears whenever you select multiple artifacts or packages in any interface such as explorer, document-like view, tree view, list view, etc.

From there, you can click the icon and select Generate Report.

NOTE

When you generate a report for a package, the generated report will include all the package contents by default.

The following image shows the opening of Generate Report screen from Artifact Tree View. In a similar method, you can open the screen from other interfaces.

This will open Generate Report screen from where you can generate Ad Hoc Report.

To jump to the steps for generating Ad Hoc Report, click here.

3. Opening Generate Ad hoc Report for a Package

Select a package and click icon and select Generate Report. This will generate a report for all the package’s artifacts.

$C:\Users\admin\AppData\Local\Temp\SNAGHTML33dea02f.PNG$

To jump to the steps for generating Ad Hoc Report, click here.

4. Opening Generate Ad hoc Report for a Project

Select a project and click the icon and select Generate Report. From here, you can specify the location of the artifacts for which you want to view the report.

$C:\Users\admin\AppData\Local\Temp\SNAGHTML33e3b8b0.PNG$

$C:\Users\admin\AppData\Local\Temp\SNAGHTML1bb41fec.PNG$

Step 2. Generating Ad Hoc Report

When you invoke the Generate Report screen either for single artifact or multiple artifacts, the following screen will display.

$C:\Users\admin\AppData\Local\Temp\SNAGHTML33f4d28f.PNG$

The following sections provide important details for the options of the Generate Report screen.

Step 2.1. Selected Records or Select Records

This section will show you selected artifact, package, or number of artifacts based on where you have opened the Generate Report screen from, i.e., from the detail editor, package, or multiple artifacts from any interface, respectively.
This section will allow you to select a single artifact or multiple artifacts (by specifying their location) if you have opened the Generate Report screen from a project.

Step 2.2. Select Layout Set

Select a Layout Set to display a specific layout for the artifact details in the report. For more information on Layout Set, see Creating a Layout Set.

You can also make your own Layout Set by clicking the Manage Layout Set link.

Step 2.3. Select Sub-Report(s)

Select Sub-report(s) from the drop-down menu of the Select Sub-Reports. For each artifact of the main report, a Sub-Report is executed and placed under the primary artifact.

$C:\Users\admin\AppData\Local\Temp\SNAGHTML3419b946.PNG$

TIPS

$F:\Glyphs and Icons\IconDrawer\Classic 512 (New)\PNG\128\018.png$

To select Sub-Reports, use any of the following options:

Drag and drop one or more Sub-Reports from the Available Reports to the Selected Reports box. Or, vice-versa to remove one or more selected Sub-Reports.
Double-click a Sub-Report in the Available Reports box to move it to the Selected Reports box. Or, vice-versa to remove the selected Sub-Reports.
Select one or more Sub-Reports and click button to move it to the Selected Reports box. To remove, use this button.
To select all Sub-Reports, click button. To remove all, use this button.

Step 2.4. Output Document Format

You can choose to generate a report in PDF or Word document format.

Step 2.5. Click Generate to generate the report

Sample Report

An artifact details in a generated report

Generating Saved Report

Step 1. Opening Generate Saved Report

The process for opening Generate Report action for a single artifact, multiple artifacts, package and a project is identical to those for the Ad Hoc Report. Click the following links to know more about it.

Opening Generate Report for a Single Artifact
Opening Generate Report for Multiple Artifacts
Opening Generate Report from a Package
Opening Generate Report for a Project

Once, Generate Report screen opens, go to the Saved Templates tab.

Step 2. Generating Saved Report

$C:\Users\admin\AppData\Local\Temp\SNAGHTML343cab32.PNG$

Step 2.1. Either select a predefined template or use your own template

TopTeam ships with default report templates representing the most commonly used report layouts. You can use these default templates as the starting point to create your customized report layouts. The templates that you will see are based on the type of artifacts you have selected.

Overview

Different methods for generating reports

Generating Ad Hoc Report

Step 1. Opening Generate Ad Hoc Report

1. Opening Generate Ad Hoc Report for a Single Artifact

2. Opening Generate Ad Hoc Report for Multiple Artifacts

3. Opening Generate Ad hoc Report for a Package

4. Opening Generate Ad hoc Report for a Project

Step 2. Generating Ad Hoc Report

Step 2.1. Selected Records or Select Records

Step 2.2. Select Layout Set

Step 2.3. Select Sub-Report(s)

Step 2.4. Output Document Format

Step 2.5. Click Generate to generate the report

Sample Report

Generating Saved Report

Step 1. Opening Generate Saved Report

Step 2. Generating Saved Report

Step 2.1. Either select a predefined template or use your own template

Step 2.2. Output Document Format

Step 2.3. Generate Report

Sample Report

Related Articles