SpagoBI and CKAN: self-service opendata
What is CKAN?
CKAN is the world’s leading open-source data portal platform. It is a powerful data management system that makes data accessible – by providing tools to streamline publishing, sharing, finding and using data. CKAN is aimed at data publishers (national and regional governments, companies and organizations) wanting to make their data open and available.
SpagoBI extends its set of data sources by providing native and out-of-the-box CKAN integration. By using such open data management system, SpagoBI grant access to the huge amount of dataset published in the World Wide Web (e.g. datahub.io, data.gov, data.lab.fiware.org, dati.gov.it, and more). SpagoBI allows now to search and handle opendata in a self-service manner, letting the users to integrate own dataset with external ones directly inside our suite. As instance, enterprise dataset can finally join opendata, bringing up the overall data value!
Dataset mapping between SpagoBI and CKAN
The term “dataset” has two different meaning in SpagoBI and CKAN:
The former uses dataset to indicate a unique data resource. It can be anything: a CSV file, a SQL query against a DB, a Java class, and so on;
The latter indicates dataset as a set of resources, where the only the resource contains the data. A dataset basically acts as a container, or a data package, where details (such as visilibility, or scope) are inherit by its resources.
Because of this difference, there is no direct mapping between SpagoBI and CKAN datasets. Therefore, the current approach is to consider a CKAN resource as a SpagoBI dataset. It still keep a reference to the parent, but it is now self-contained and its handling is indipendent from the package (aka CKAN dataset). The dataset listing and searching functions in SpagoBI reflect this mapping, directly showing the CKAN resources as importable SpagoBI dataset.
CKAN dataset categories
CKAN dataset can be divided in four main categories:
Any dataset set with public visibility, regardless its owner, can be seen as element of the collection of dataset publicly available.
Instead, a private dataset owned by an organization can be seen only by the members of such organization.
Acquired datasets are purchased from the FIWARE Store, whereas user private datasets are intent to be used only by the owner and/or shared between other users, but keeping its private visibility.
CKAN dataset access method
So far, CKAN provides two different access method:
By using the dataset URL, so having direct access to the file;
Through the DataStore extension, which allow to query the datasets avoiding to exchange the whole dataset.
The current release of SpagoBI makes use of the first method, since it allows to execute data parsing and validation processes. Future release will probably add support for the second method, which will help to handle dataset with large amount of records/information.
Limits and future developments
The dataset data parsing and validation processes rely on the SpagoBI file dataset management system, where CSV and XLS file formats are supported. This means that only CKAN resources with such formats are taken into account by SpagoBI, filtering the datasets availability by their format. With the future support for other formats (e.g. XML), SpagoBI will automatically increase the availability of CKAN resources, enhancing the overall CKAN integration.
How to use SpagoBI with CKAN
SpagoBI fully integrate CKAN API, where only the following parameters are needed:
URL of the target CKAN instance;
REST API Key.
As stated in “Limits and future developments”, SpagoBI currently relies on the FIWARE Identity Manager. This choice ties the current release with the FIWARE Data Lab, avoiding FIWARE users to specify the second and third parameter considering that they are obtained through the OAuth2 authentication process.
The file containing the URL parameter is ckan.config.properties, deployed inside the library SpagoBIUtils.jar. To change the target CKAN instance, it is necessary to extract the contents of the already mentioned library, modifying the parameter ckan.url with the preferred one. Once the modification is done and saved, the JAR library has to be created and deployed inside each SpagoBI engine in order to share the new CKAN configuration.
Explore the target CKAN repository
To start using CKAN dataset inside SpagoBI suite, click on My Data section.
The first tab (My Data Set) shows any dataset that belong to the user, plus any already imported CKAN resource. Click on the CKAN Data Set tab to start interacting with the configured CKAN instance.
Once the tab is selected, SpagoBI starts to interact with CKAN to obtain the first trunk of 200 CKAN datasets (exploding them into multiple CKAN resources). It usually takes between five and ten seconds, depending on the connection and network traffic situation.
The below image shows a list of CKAN resources mapped as CKAN datasets. These are not usable yet, but can start to handle them as we will show in the following. The dataset are shown with its name and description (see the red arrows). Other information (e.g. visibility, last modification date) are available with a specific Info action.
To have access to the other trunks of CKAN datasets, it is possible on the button More Dataset, placed at the bottom page. It will dinamically reload the current following trunk of datasets, if available.
By moving the cursor over a dataset, a list of actions will appear.
Clicking on the Info button, a set of information from the original CKAN resource will be shown by SpagoBI.
SpagoBI also enable searching CKAN-side, allowing user to directly access to a known dataset or to obtain a list of dataset starting from a specific keyword. As instance, in the following image the user searched for any CKAN resource/dataset containing the keyword inventory.
Let’s see how to use one of them, by simply import metadata information and then analyze the dataset on demand.
Save and handle dataset
If you want to use a dataset not used yet, any action on will start the metadata import wizard. Otherwise, the eye-like one is the button to start the import process.
If the dataset is correctly downloaded, the below message will appear, plus a set of mandatory parameters to set the parser configuration.
The seconda step of the importing wizard is important to set how your final dataset will appear. Be careful to choose the appropriate data type (String, Integer, Double) and field type (Measure, Attribute). After that, click on next to see the validation results and confirm to finalize dataset import.
Now the dataset is imported, and it will appear in the My DataSet tab, ready to be use through SpagoBI inquiring and analytics tools.
Inquiring the data via Query by Example
SpagoBI offers a tool to inquire data: it is called Query by Example (QbE). It allows user to easily explore data. Click on the Magnifier icon to start working with the QbE.
From this point, the user can start to build query interacting with the GUI.
In the below image two fields have been selected and grouping functions applied. To see the result, the user can click on the Preview button (in the top-right position).
Lastly, the results are shown as a table. It is now possible to save the this new QbE as a new SpagoBI dataset (click on the Save icon in the top-right position).
Analyze data through charts and tables
SpagoBI also offer tools to analyze data by using different types of charts (pie, bar, line) and tables (flat, pivot). Click on the Worksheet button to start analyze data.
As instance, the user can start to build a bar chart by simply drag&drop such chart into the working area.
Then, options, parameters and filter for that specific chart will appear, as shown below. Click on the Preview to show the result.
The following figure shows the final result.
Combining enterprise dataset with opendata