Skip to content
CA Spectrum - 10.2 to 10.2.3
Documentation powered by DocOps

How to run reports using the JasperReports Server

Last update November 7, 2017

Improtant! You must log in to JasperReports Server to access reporting functionality.

Generate General Reports

Follow these steps:

  1. Open the OneClick console.
  2. Click the 'JasperConsole' link to open the CABI JasperReports Server web application login screen. 
  3. Log in to the CABI JasperReports Server.

    Important! If you are logged in as a Spectrum user, then you can generate reports only for the devices for which you have the access. If you are logged in as a non-Spectrum user or as a Jasper Super User, reports might not fetch any data. To fetch data in the reports for these users, set the value to 'False' for the Enable Security option in the Report Manager Preferences.

  4. Click View, Repository.
  5. (till r10.2.1) In the Folders pane, expand root, Organizations, spectrum, capability, and reports.
    (from r10.2.2) In the Folders pane, expand root, Public, ca, Spectrum, and reports.

    Note: Starting from CA Spectrum 10.2.2, all the Spectrum content in CABI JasperReports Server is saved under the 'Public' folder (root->Public), previously it was saved under the 'Organizations' folder (root->Organizations).

    For the 10.2.2 users, we recommend to keep the the old content, which was saved under the Organizations folder. However, you can delete the old content manually (Manage->Organizations then select Spectrum folder and click Delete).

  6. Click a report title to open 'Input Controls' and generate a report. 
  7. Specify the parameters in Input Controls dialog, Click Apply and OK.

Note: Do not copy or move the Spectrum reports from default folder to other folder. The Jasper reports should be run from the default folder. Running the reports from other folders will throw error.

 Following is the default location for the reports folder in the Jasper repository:

For r10.2.2: root -> Public -> ca -> Spectrum -> reports.
Till r10.2.1: root -> Organizations -> Spectrum -> capability -> reports.

Generate Ad Hoc Reports

Domains available in Jasper help you to generate Ad Hoc or custom reports. For example, using the Availability domain, you can design the Ad Hoc reports on availability or outage information.

Follow these steps to generate Ad Hoc Reports:

  1. Open the OneClick console. 
  2. Click the 'JasperConsole' link to open the CABI JasperReports Server web application login screen. 
  3. Log in to the CABI JasperReports Server. 
    Important! If you are logged in as a Spectrum user, then you can generate reports only for the devices for which you have the access. If you are logged in as a non-Spectrum user or as a Jasper Super User, reports might not fetch any data. To fetch data in the reports for these users, set the value to 'False' for the Enable Security option in the Report Manager Preferences. 
  4. Click Create, Ad Hoc View. 

    The Select Data window appears. 
  5. Select any Spectrum related domain (for example, here it is Availability Domain) from the list, and click Choose Data. 
  6. In the ‘Fields’ tab, select ‘Availability’ in the ‘Source’ box and click the button to move it to ‘Selected Fields’ box and click OK. 
    You can see the Availability field in the Fields pane. 
  7. Select Table and Sample Data from the drop-down fields available on the tool bar. 
  8. Expand the 'Availability' field in the left pane and add fields to Column and Group by drag and drop from the Availability field. 
    For example: If you want to see StartTime, EndTime and OutageType in the report, you can drag and drop these fields to Column. For Group, select fields from AdditionalModelInformation in Availability field. 


  9. To save the report, Click Save button from the tool bar and then select Save Ad Hoc View and Create Report. 
  10. Provide information like Data View Name and Report Name in the Save Ad Hoc View and Create Report window and click Save. 

    The Ad Hoc View Report is saved in the selected location.

Scheduling Reports

You can schedule the reports to automate the generation and distribution of reports. Provide the settings details in JasperReports Server to schedule the reports.

For more information, see the Scheduling Reports section in the JasperReports Server documentation.

Information! For scheduled reports, you receive emails with links to specific reports. The report links in the email may not work properly if they are referenced to 'http://localhost' instead of the real hostname (JasperReports Server). To set the real host name, update the 'report.scheduler.web.deployment.uri' attribute value in the 'js.quartz.properties' file, which is located at <jasperserver-pro>/WEB-INF/js.quartz.properties. The 'localhost' in the url should be replaced with server hostname, where the JasperReports Server is installed.

Example: report.scheduler.web.deployment.uri=http://localhost:8080/jasperserver-pro should be set to http://<jaser server hostname>/jasperserver-pro.

Managing Reports

You can save and export the reports to various formats. For more information, see the Exporting the Report section in the JasperReports Server documentation. 

Was this helpful?

Please log in to post comments.

  1. Shane Ryan
    2018-08-02 09:15

    We need to add a note that there are a lot of reports visible but do not contain any data, such as drill down reports of the main library. Many customners are running them and getting a "no resords found" error and opening support uissues as this is very unintuitive. These are default Jasper reports and as such cannot be hidden, so instead we should document clearly on various pages that thye should NOT be used.