Breadcrumbs Reporting > About Custom Reports (beta)

About Custom Reports (beta)

IMPORTANT: You must have Beta Functionality enabled in Site Settings to use access the Custom Reports (beta) screen. For more information, contact your Surpass Account Manager.

In Surpass, the Custom Reports (beta) screen is where proficient HTML writers can create custom reports for individual candidates based on test result data. This data can be generated in Custom Reports (beta) or via the CustomReportGeneration API.

This article explains what the Custom Reports (beta) screen is and how to use its features.

In This Article

Navigating to the Custom Reports (beta) screen

To view the Custom Reports (beta) screen, go to Reporting > Custom Reports (beta).

About the Custom Reports (beta) grid

The Custom Reports (beta) grid lists all HTML custom report templates created in the Custom Reports (beta) screen. Refer to the following table for more information on each column.

Column Description
Name Displays the name of the custom report template.
Reference Displays the template’s unique alphanumeric reference number.
Date Displays the date on which the custom report template was created.
Entities

Displays the data used to generate the custom report.

NOTE: Only the TestResult entity is available.
Generate Reports

Generates custom reports from a custom report template.

NOTE: Custom reports can also be generated via the CustomReportGeneration API.
Delete Deletes the selected custom report template.

Creating a custom report template

IMPORTANT: You must have the Manage Custom Reports permission to create custom report templates. For more information, read About roles and permissions.

Select Create Template to create a new custom report template.

In the Create Template dialog, enter your template’s name and unique alphanumeric reference number.

Select Upload to upload your custom report template.

IMPORTANT: The custom report template must be in an HTML format.

Select Add Template to upload the custom report template.

When you have uploaded the custom report template, it appears in the Custom Reports (beta) table.

EXAMPLE: Here is a basic example of what a custom report template could look like:

Generating a custom report template

IMPORTANT: You must have the Generate Custom Reports permission to generate custom report templates. For more information, read About roles and permissions.

Select Generate to generate a custom report from a template.

You must enter a valid keycode in the Generate Report dialog. Each keycode is used to generate a custom report containing test feedback for individual candidates.

NOTE: You can enter a maximum of 1000 keycodes.

Select Generate Report to generate the custom report. The custom report will open in a new tab in your browser.

EXAMPLE: Here is a basic example of what a custom report could look like:

Further reading

To learn more about Reporting, read the following articles:

NOTE: This form is to provide feedback to help improve the Surpass Help documentation only. If you need live support, contact support@surpass.com.