Docs
Architecture
Architecture Architecture Jan 09, 2014Cloud editor* Library first
Components* Kagura API / Report Core* Core components* Storage Providers
Parameter Types
Connectors & Freemarker
Configuration Model
Helper Components* The “Export Handler” Authentication Providers & Model
Karaf* Camel / CXF routes Bundle
Assembly
Features
Example Authrest
Javascript / Jetty
Resources
Rest-API
Library first Kagura is a library first. Which means it was designed to be modular and self contained. It also provides minimal constraints in the way that you can use it, and is intended to be embedded into a larger scale application, such as some of the example components demonstrate.
Docs
As a Library
As a Library As a LibraryUpdated Jan 16, 2014*
As a Library Jan 16, 2014Cloud editor
Kagura has several “library” components you have 2 “compulsory parts”:
Report Storage Provider
Reports Core
And some optional components:
Authentication Providers
REST API Interfaces
Misc Helpers
Reports Core; is the part we are interested in if we want to generate output for a front end. It’s the work horse. Report Storage Providers; is required in-order to provide a list of reports, and the report contents.
Docs
Authentication Providers
Authentication Providers Building a basic JNDI/JDBC reportUpdated Jan 21, 2014*
Building a basic JNDI/JDBC report Jan 21, 2014Cloud editor
To build a report you need to create a file called: reports//reportconf.yaml . Where is an unique identifier for your reports. Before you continue you will have to ensure you have setup users.
For this report, we are going give it the report id: TheAnswers. Create a file called:
reports/TheAnswers/reportconf.yaml Data source selection Then you need to choose your data type.
Docs
Building a basic JNDI JDBC report
Building a basic JNDI JDBC report Maven RedeploymentUpdated Jan 10, 2014*
Maven Redeployment Jan 10, 2014Cloud editor
This is more involved process however it’s basically the Karaf Deployment but allows you to take the project entirely out of the Kagura project directory, which is useful if you want to keep your reports in some form of SCM. (Highly recommended.)
I have an example project setup athttps://github.com/arranubels/kagura-custom-assembly
We will check this out and get the container started.
Docs
Configurations
Configurations Kagura is flexible enough to be used in various configurations, here are a couple of use cases I can think of: As a stand alone reports web service
This is primarily what comes to mind when people think of using something like Kagura. Kagura has 2 ways of operating out-of-the-box as a fully functional web service;
As a Tomee compatible war file As a Jetty + Karaf (OSGI) service These are straight forwards to get started with, see the getting started guide.
Docs
Introduction
Introduction Kagura is an open source project created by base2Services. It is a flexible simple reporting platform that allows reports to be delivered in a speedy manner, without cumbersome designer UIs intended for a less technical market.
This page contains more information on the project.
[Screenshots](https://kagura.atlassian.net/wiki/spaces/KGR/pages/491543) [Configurations](https://kagura.atlassian.net/wiki/spaces/KGR/pages/491527) [Use Cases](https://kagura.atlassian.net/wiki/spaces/KGR/pages/491529) [Architecture](https://kagura.atlassian.net/wiki/spaces/KGR/pages/491540) [Getting Started](https://kagura.atlassian.net/wiki/spaces/KGR/pages/491542) [Documentation](https://kagura.atlassian.net/wiki/spaces/KGR/pages/491534) [Quick reference](https://kagura.atlassian.net/wiki/spaces/KGR/pages/491532) Aim
The aim of Kagura is to produce a simple and fast reporting framework, which can be used widely and customised heavily.
Docs
JDBC Report Template
JDBC Report Template JDBC Report Template reports/TheAnswers/reportconf.yaml type: “JDBC” classLoaderPath: “com.mysql.jdbc.Driver” jdbc: “jdbc:mysql://localhost:3306/test” username: “test” password: “test” sql: “SELECT id, question, answer FROM Answers <@where> <@clause render=param.questionQuery?has_content> question=${method.value(param.questionQuery)} /@clause /@where <@limit />” columns:
name: question label: Question name: answer label: Answer extraOptions: reportName: “The Answers” directory: “Folder 1” description: “This is a sample report” image: “http://jentrata.org/images/jentrata.png" paramConfig: { type: String, id: questionQuery, name: “Question to search for”, help: “Leave blank for any”, placeholder: “None” }
Docs
JNDI JDBC Freemarker Report
JNDI JDBC Freemarker Report JNDI/JDBC Freemarker ReportUpdated Jan 21, 2014*
JNDI/JDBC Freemarker Report Jan 21, 2014Cloud editor
This is the most likely type of report you will require. It’s a report which takes it’s data from a data source such as MySQL and returns the output. (Not all reports do this.) Prerequisites For this to work you need several things:
What parameters you are going to use, and how to query them
Docs
Kagura js
Kagura js Kagura.jsUpdated Feb 21, 2014*
Kagura.js Feb 21, 2014Cloud editor
Kagura.js is a javascript file which is the driving force of the example javascript web page, which you can use as a basis for your reporting front end. Or you can write something yourself. Or go half way and use the kagura.js javascript file and hire a web designer to make a nicer front end for you your site.
Docs
Karaf
Karaf KarafUpdated Feb 11, 2014*
Karaf Feb 11, 2014Cloud editor
The Kagura Karaf container is designed to work out of the box, with an accompanying HTTP server for the presentation layer. Out of the box Kagura’s karaf container provides the core Kagura reporting REST services. It comes with an example “Authentication REST” backend. This is a sample REST end point for if you were to use REST configuration. The true power in the Kagura REST container is the flexible container that it runs in, allowing live changes to parameters for instance.