Documentation

Skip to end of metadata
Go to start of metadata

Introduction to Abiquo Reporting

Abiquo Reporting is an Abiquo plugin that offers integration with a Jaspersoft standalone reports server web service. Abiquo Reporting allows access to the reporting system from within the Abiquo user interface and authentication on the reports server with Abiquo user credentials. Abiquo Reporting includes a JasperReports Server repository with an Abiquo theme and a set of basic Abiquo reports that our customers can use as the basis for their own reports based on data from the Abiquo platform. Abiquo Reports, themes and the authentication module can be obtained from Abiquo Support directly.

Features

JasperReports Server features:

  • Web-based UI and also a Web Service API
  • Reports can drill down into different layers of detail
  • Report output in many formats (PDF, CSV, Flash, DOCX, RTF, ...)
  • Report output can include charts and images
  • Automatic scheduling and delivery of reports, including by email
  • Reports can be created using separate Jaspersoft iReport application on Windows or Mac
    • Use Jasper Studio for Eclipse in Linux

Components

  • Community Edition of Jaspersoft JasperReports Server: version 5.5.0 is supported by Abiquo 2.6
  • Bespoke Spring authentication plugin for JasperReports Server
  • JasperReports Server repository
    • JasperReports Server 'Theme' based on Abiquo user interface
    • Abiquo Reports is integrated with the Abiquo Privileges system

Abiquo Reporting Workflow

See Install Abiquo Reports for full details of how to configure Reports.

Access Abiquo Reports from Abiquo

After Abiquo Reporting is configured, you should be able to see the Reports icon on the Abiquo top icon bar.

If you cannot see the icon, check your configuration:

  • In Configuration View, General Tab, you must enter the URL of the Abiquo Reporting server for "Display Report icon linked to this URL"
  • Your Abiquo User must have the "Allow access to reports" privilege

Log In to JasperReports

Use your Abiquo credentials to log in.

Select a Report from JasperReports Home

Click on reports and select a Report from the Reports list. Click Run or double click the report name. Follow the instructions on screen. Enter dates in the format yyyy-mm-dd.

Report Types

Abiquo Reporting offers several different report categories:

Abiquo Report Descriptions
  • Cloud Operations Pack - snapshot data to save operations time finding customer and platform data

  • Planning Pack - capacity, usage, and trending for the Abiquo platform

  • Audit and Compliance Pack - activity, logons, logoffs, who did what and when

  • End User Pack - reports that aid users of the Abiquo system to understand and optimise their use of the Abiquo platform

Notes:

  • Reports use many Abiquo database tables, not just the Accounting tables.
  • All reports support the use of parameters to control the report presentation and filter report content.

Technical Overview

The Abiquo Jaspersoft Integration includes the Abiquo Jasperspoft authentication plugin and the Jaspersoft Tomcat hosted application. Ideally, Jaspersoft should be run on its own dedicated server. The Jaspersoft plugin uses the Abiquo API for authentication and then reads the SQL database directly. The plugin allows the authentication of a Jaspersoft user and provides SQL row-level security for the execution of SQL statements. The integration has been tested with the open source version of Jaspersoft (jasperforge.org) and MySQL (MariaDB) and PostgreSQL. Jaspersoft has a small internal database for users and report metadata. It can be installed locally or on a database cluster. It works with both MySQL and PostgreSQL. iReport is a report design program for working with Jaspersoft reports on Windows and Macintosh. On Linux use Jasper Studio for Eclipse.