Skip to main content

Jama Connect User Guide

Upload custom reports or exports

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

Important considerations

  • Self-hosted — For BIRT and Velocity reports, only self-hosted customers with system, organization, or report admin permissions can complete this task.

  • Cloud — You must contact support for help uploading custom BIRT reports. For more information, see Self-Service Reports Development on your Cloud Environment.

  • When you upload a Velocity or Office Template export that uses preselected (context-sensitive) data in the main project view, they appear under Exports > View all export options.

  • When you upload Velocity reports that pull data at a project or cross-project level, they appear under Reports in the Jama Connect header. For more information, read about Jama Connect and Velocity here.

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

  • For templates with Microsoft Word or HTML formats, you can also export to PDF. For Velocity and HTML templates, PDF export results might vary. For more information, see Quick Start: HTML Templates for Velocity PDF Reports.

  • For Office Templates, any user with a creator license can add a custom export, which appears under Export > View all export options.

To upload custom reports or exports:

  1. To add or edit a report:

    • (Self-hosted only) For BIRT reports, log in as root user and select Reports.

    • For Velocity or Office template reports, select Admin > Reports

  2. Select Add report in the top right corner.

  3. In the Add/Edit report window, complete the fields to define the report.


    The available options depend on the type of report you choose. For example, you see the Context Sensitive option when you select Velocity as the Report Type.

    • Report Name — Enter a name so that others can identify the custom report or export template.

    • Report Type — Select BIRT, Velocity , or MS Office Template.

    • Report Formats — Select HTML, PDF, Microsoft Word, or Microsoft Excel.

    • Excel Format — Select XLS format (legacy) or XLSX format.

    • Data Access — Select Limit data availability or Allow all data to be reported on regardless of user permission.

    • Restrict to Group — Select No group restriction or limit access to run custom reports. (Report admins do not have access to this setting).

    • Report File Name — Click Browse and select the report or export template to upload. BIRT reports have file extension .rptdesign and Velocity reports have file extension .vm.

    • Description — Enter an optional description to define the output.

    • Scope — Select Organization so the report or export template is available to all users or select Project to restrict it to users in a particular project. Default for Jama Connect reports is System.

      Report admins can only apply the scope setting to projects where they have project admin rights.

    • Organization — Select the organization from the drop-down menu.

    • Visible to Users — Select Visible to Users if you want other users to see the report.

    • Context Sensitive — Select Context Sensitive if you have an export that uses preselected (context-sensitive) data in the main project view.

      This export appears in the window that opens when users select Exports > View all export options.

    • Class name and path — Enter the class name and path for custom plug-ins for BIRT or Velocity reports. Otherwise, leave blank.

  4. In the Criteria section, select + to add report criteria.

    1. From the Select Parameter Type drop-down menu, select the type of data you want to include.

      • Release — Select the project release parameters as needed.

      • Location — Select a location for each parameter.

      • Baseline Parameter — Select one baseline for each baseline parameter.

      • String Parameter — Enter the string parameter.

      • Date Parameter — Enter the date.

      • Boolean — Select True or False. The value is sent to the reporting engine.

      • Test Plan — Select a test plan from the list of test plans in the selected project. Jama Connect passes the database ID to the report.

      • Review — Select a review from the list of reviews in the selected project. Jama Connect passes the ID to the report.

    2. Display — Enter the label you want users to see when publishing the report and exporting from Jama Connect.

    3. Name — Enter a case-sensitive name that is passed to the report or export template. Each parameter name must be unique.

      When you publish a report or export Jama Connect content, these parameters are displayed in alphabetical order by the name field, not in the order shown in the report setup screen.


    If you change the Name criteria, you must also change the reference to the criteria in your report or export template. Otherwise, the report or export template fails.

  5. Click Save to upload the report or export template.

The report or export is saved and appears in the Reports table.