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.


Self-hosted customers with system, organization, or report admin permissions can complete this task.

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

  • If you're uploading a Velocity or Office Template export that uses pre-selected data in the main panel, the exports appear under Exports > View all export options.

  • If you're uploading BIRT or Velocity reports that pull data at a project or cross-project level, the exports appear under Reports in the Jama Connect header.

    For more information, read about Jama Connect and Velocity here.

Report shows in the navigation header of Jama Connect


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

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. Define the report:

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

    • Report Type — Select a type (BIRT, Velocity, or Microsoft Office Template).

      For templates with Microsoft Word or HTML formats, you can also export to PDF. For Office Templates, any user with a creator license can add a custom export , which makes it visible under Export > View all templates.

    • Report Formats — Select a format (PDF, Microsoft Word, or Microsoft Excel).

    • Data Access — Select a type to define availability for reporting.

    • Restrict to Group — Select whether and how to limit access (by user permissions or user group) to run custom reports.

      To reduce exposure to potentially sensitive data, reports admins do not have access to this setting.

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

    • Description — Enter a description that helps users understand the output.

    • Scope — Define whether the report or export template is available to all users (Organization) or to only users in a particular project (Project). Default for Jama Connect reports is System.

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

    • Visible to Users — Select for this option to appear in the application.

    • If uploading a Velocity export that applies only to data referenced on the user's main panel, select Context Sensitive. This export appears in the window that opens when users select Exports > View all templates.

    • (Optional) Select Class name and path only for custom plug-ins for BIRT or Velocity reports; otherwise, leave blank.

    • For Office Templates, set the parameters you want to use.

  4. In the Criteria section, select the plus sign to add criteria.

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

      • Release — Shows all project releases in a pick list. The user can select release parameters as needed.

      • Location — Shows the project hierarchy in a pick list. The user can select a location for each location parameter.

      • Baseline Parameter — Shows all project baselines in a pick list. The user can select one baseline for each baseline parameter.

      • String Parameter — Presents a text field to enter a string.

      • Date Parameter — Presents a text field to enter a date.

      • Boolean — Presents a checkbox whose value ("true" or "false") is sent to the reporting engine.

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

      • Review — Presents a pick list of reviews in the selected project. Jama Connect passes the ID to the report.

    2. For Display, enter the label you want users to see when publishing the report and exporting from Jama Connect.

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

      When users 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 breaks.

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