Create or Import a Report

There are two ways to create new reports in ItemPath:

1. Manually select a theme, then build the report by adding columns, filters, etc.
2. Import a report template. Report templates are .itempath.json files generate by ItemPath that save report configuration details.

A report theme determines the tables of data that you can select columns from in your report. For information about available themes, consult with our Report Data Reference.

A report theme is a collection of tables. Rows in your report (without column groupings) are instances of the base table (this table shares a name with your report theme). The theme also includes related tables. 

Manually create a new report

To create a new report:

1. Navigate to Reports using the navigation bar.
2. Use New Report.
3. Select the theme and enter the name of your report.
4. Create Report.

After creating the report, you can add columns, filters, or snapshots to further define the information included in your reports “Data” tab.

Copy a report

If you'd like to use a report as the basis for creating a new report, you can create a duplicate by pressing the copy icon in the All Reports view.

Import a report

Report templates are files with the extension (.itempath.json) that store the configuration of reports, allowing you to quickly set up standard reports or share configurations. If you have a valid report template, you can create a report in ItemPath by importing the template file.

To import a template:

1. Navigate to the Reports page in ItemPath.

2. Select Import Template.

   

3. Use Browse… to find and upload your .itempath.json file.

   

4. If successful, ItemPath will create a report using settings from the template.

Troubleshooting

Issues with importing reports typically come from the report template file:

• Incorrect File Extension: Verify that the file extension is .itempath.json. If the file extension is incorrect, you should receive an error message indicating the file type is invalid.
• Unexpected Data: Verify that no new key-value pairs are in the file. ItemPath expects a standard data structure and will not load templates that do not conform with this structure.
• Invalid JSON Format: Verify that the template is valid JSON. ItemPath requires the file to be valid JSON. If you are modifying the file, ensure that it adheres to valid JSON syntax with the help of your editor’s tools (for example, all commas and brackets are properly placed).

Sample Report Templates

The ItemPath team maintains a library of sample report templates. Download and import templates that interest you to populate your initial set of reports.

Note: Sample templates may be ZIP archives. You will need to unzip the .itempath.json.zip file before you import.

Tips

• Copying Reports: You can use this as a way of creating copies of a report as a starting point for new reports. Within an installation, you can also use the copy icon in the All Reports view to create a copy of a report.
• Moving Reports Between Environments: Exporting and importing report templates is often done to move reports between different ItemPath environments (for example, from a test environment to production). Modifying the report name (title) in the template file to include an indicator of the source environment can help you track where a report originated.
• Reviewing Templates in an Editor: Report template files are standard JSON. If you plan on reviewing or modifying them in a text editor, using an editor extension or online tool that formats or “prettifies” JSON will make the file structure much easier to read and understand.