Extension WireCloud Dashboards


Extension Basics

Title
WireCloud Dashboards
Name
ckanext-wirecloud_view
Type
Public extension
Description
CKAN view extension for the creation and display of resource data visualization dashboards through WireCloud embedded dashboards.
CKAN versions
Download-Url (zip)
Last commit
6 years ago (2019-06-24 12:39:03)
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

CKAN WireCloud dashboards

Build Status Coverage Status

CKAN view extension for the creation and display of resource data visualization dashboards through WireCloud embedded dashboards.

With this extension you can create a view for a resource using WireCloud. You can set the view to load an existing dashboard or create a custom dashboard from the view form.

Requirements

You need the Oauth2 extension for CKAN in order to make this extension work.

Installation

To install ckanext-wirecloud_view:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-wirecloud_view Python package into your virtual environment:

    pip install ckanext-wirecloud_view
    
  3. Add wirecloud_view to the ckan.plugins setting in your CKAN config file (e.g. /etc/ckan/default/production.ini).

  4. Add proper values for the ckan.wirecloud_view.url and ckan.wirecloud_view.editor_dashboard settings in your CKAN config file:

    # URL of the WireCloud instance to use for creating the dashboards
    ckan.wirecloud_view.url = https://mashup.lab.fiware.org
    
    # ID of the dashboard/workspace to use for creating new visualization dashboards
    ckan.wirecloud_view.editor_dashboard = wirecloud/ckan-editor
    
  5. Restart CKAN. For example if you’ve deployed CKAN with Apache:

    sudo service apache2 graceful
    

Development Installation

To install ckanext-wirecloud_view for development, activate your CKAN virtualenv and do:

git clone https://github.com/conwetlab/ckanext-wirecloud_view.git
cd ckanext-wirecloud_view
python setup.py develop
Version
1.1.0
Version release date
2018-01-01
Contact name
CoNWeT Lab
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

This extension integrates WireCloud dashboards as CKAN resource views. Requires OAuth2 extension for authentication. Users can either select existing WireCloud dashboards or create new ones directly from the CKAN interface. Configure the WireCloud instance URL and the editor dashboard ID. Dashboards are embedded as iframes in CKAN resource views.

Plugins to configure (ckan.ini)
wirecloud_view
CKAN Settings (ckan.ini)
# WireCloud View Configuration

# URL of the WireCloud instance to use for creating dashboards
# ckan.wirecloud_view.url = https://mashup.lab.fiware.org

# ID of the dashboard/workspace to use for creating new visualization dashboards
# ckan.wirecloud_view.editor_dashboard = wirecloud/ckan-editor

# Alternatively, set via environment variables:
# CKAN_WIRECLOUD_VIEW_URL = https://mashup.lab.fiware.org
# CKAN_WIRECLOUD_VIEW_EDITOR_DASHBOARD = wirecloud/ckan-editor

# OAuth2 Client ID (required for authentication)
# CKAN_OAUTH2_CLIENT_ID = your_client_id
DB migration to be executed
(not set)
<< back to Extensions