Jama Connect User Guide

Upload custom reports or exports


Self-hosted customers with system or organization administrator permissions can complete this task.

You can upload reports or exports so that other users can access them.

If you're uploading a Velocity or Office Template export that uses pre-selected data in the main panel, the exports appear under Exports > Office Templates. If you're uploading BIRT or Velocity reports that pull data at a project or cross-project level, they appear under Reports in the Jama Connect header. Read more about Jama Connect and Velocity here.

Report shows in the navigation header of Jama Connect


Before uploading a report or export, check with the person who created it about the best settings to use because report criteria is unique to each one.

To upload custom reports or exports:

  1. Log in as root user and select Reports. If you're an organization administrator for a self-hosted instance, select Admin > Reports. This shows a list of all currently available reports or export templates.

  2. Select Add report in the top right corner to open the Add/Edit Report window.

  3. Enter a name for the custom report or export template so that other users can identify it.

  4. Select the report or export template type (BIRT, Velocity, or Microsoft Office Template), and the format you want to use.


    For templates with Microsoft Word or HTML formats, the option to export the report to PDF is also available.

    For Office Templates, any user with a creator license can add their own custom export to make it visible under Export > Office Templates.

  5. To define availability for reporting, select the Data Access type.

  6. Next to Report File Name, select Choose File to open a window where you can select the report or export template you want to upload. BIRT reports have the file extension .rptdesign. Velocity reports have the file extension .vm.

  7. Enter a Description that helps users understand the output.

  8. Use Scope, to determine whether the report or export template is available to all users (Organization) or only users in a particular project (Project). Default reports that come with Jama Connect have a scope set to System.

  9. Select Visible to Users for it to appear in the application. 

  10. If you're uploading a Velocity export that only applies to data referenced on the user's main panel, select Context Sensitive. This export appears in the window that opens when users select Exports > Office Templates.

  11. (Optional) Class name and path is only used for custom plug-ins for BIRT or Velocity reports and can be left blank. 

  12. For Office Templates, set any parameters you want to use in the report or export template.

  13. In the Criteria section, select the plus sign to add criteria for this report or export template.

    • From the drop-down menu, select the type of data for this individual criteria. For example, select "Release" for it to pass in a release ID, or "Baseline" for it to pass in a baseline ID.

    • For Display, enter the label you want users to see. This name is what the user reads when publishing the report and exporting from Jama Connect and describes the expected input from the user.

    • For Name, enter a case-sensitive name that is passed to the report or export template. Each parameter in a report or export template must be unique. When users publish a report or export Jama Connect content, these are displayed in alphabetical order by the name field, not in the order shown in the report setup screen.


    If you're editing an existing report or export template, and you change the Name criteria, you must change the reference to the criteria in your report or export template or it breaks.

  14. Select Save to upload the report or export template and save your changes.