You are here

Create a custom user interface in SkyVault Analytics

If you want to create a custom user interface in Analytics, you can display inline reporting data charts, without IFrame, inside SkyVault Share using Pentaho Community Chart Components 2 (CCC2).
The charting library, CCC2, is shipped as part of SkyVault Share. The CCC2 components accept data in the same format as the JSON data returned by the custom reports discussed in Create a custom REST service in SkyVault Analytics. CCC2 is wrapped as Aikau widgets in the SkyVault/charts/ccc/ package. There is a base class for charts called Chart.js and defined charts such as PieChart.js, DonutChart.js and BarChart.js. Here are some suggestions for how to create a custom interface.
  1. Create a service class that will pull data into your report.

    Take a copy of the SkyVault/services/ReportService.js class, and edit the URL and any other relevant information to reference your custom REST service, as defined in Create a custom REST service in SkyVault Analytics.

  2. Link the charts with the REST service.

    Use the SkyVault/reports/Report base class as a template. This is used by the SkyVault/reports/SiteContentReport.js and SkyVault/reports/TopSiteContributorReport.js community reports. These reports can be displayed as regular widgets anywhere in an Aikau JSON model.

  3. You can optionally display your report inside a dashlet.

    Use the SkyVault/dashlet/SiteContentReportDashlet.js or SkyVault/dashlet/TopSiteContributorReportDashlet.js as a template. These reports use the abstract SkyVault/dashlet/Dashlet.js class to display the reports as dashlets.