getdkan / dkan

DKAN Open Data Portal

DKAN

DKAN - An Open Data Catalog built on Drupal 9/10

---

Documentation

DKAN's documentation can be found at https://dkan.readthedocs.io/en/latest

Requirements: https://dkan.readthedocs.io/en/latest/installation/index.html#requirements

---

Features

• Harvesting of data from external catalogs that provide a data.json
• Dataset metadata and resources
• Web service API endpoints that provide remote/automated management of datasets
• Integration with a decoupled REACT front end
• A datastore to store CSV data files and make them queryable by third party applications.

---

License

DKAN and related modules are freely-available under the "GNU General Public License, version 2 or any later version" license.

---

Security

If you have found a vunerability in DKAN, please report this by e-mailing [email protected].

---

History

• DKAN’s initial v1.0 release was in 2014 (this code is still available on the 7.x-1.x branch, although no longer supported).
• In the fall of 2017, CivicActions took over sponsorship and maintenance of DKAN.
• In May 2020 CivicActions released a completely rewritten version of DKAN to support Drupal 8, then 9 and 10. This new version (v2) was a complete ground up rebuild of the platform, integrating architectural insight from DKAN v1 and many new capabilities.

dkan's Issues

Logo needs to be updated

Prepare for launch

1.0 Modules and Theme

Recline

• Create github repo
• Make necessary changes on a branch

DKAN Dataset

• Update makefile to reflect changes in distro
• Make necessary changes on a branch
• Make sure test pass

DKAN Datastore

• Update makefile to reflect changes in distro
• Update .info files
• Make sure test pass

Nuboot

• Create github repo
• Update .info files

DKAN

• Update .info files
• Make sure test pass

Create tags and releases

Respect the following order making sure tests pass on branches:

• Nuboot
• Recline
• DKAN Datastore
• DKAN Dataset (make sure it can get recline 1.0)
• DKAN Distro (make sure it can get recline 1.0, nuboot 1.0, dkan_dataset 1.0 and dkan_datastore 1.0)

Move all pending issues in drupal.org and close issues threads.

• Nuboot
• Recline
• DKAN Datastore
• DKAN Dataset
• DKAN Distro

Make sure everything relates to DKAN in README's files.

• Nuboot
• Recline
• Feeds flatstore processor
• DKAN Datastore
• DKAN Dataset
• DKAN Distro

DKAN-drops-7 (https://github.com/nuams/dkan-drops-7/)

Finish tags and releases before integration into master

• Rebuild on a branch from dkan 1.0
• Integrate into master

Move 'DKAN' admin menu into Configuration

Posted by pmackay on April 10, 2014 at 4:05am
For consistency with other modules and the administration menu overall, this is a suggestion to move the 'DKAN' menu item currently next to 'Content' into the 'Configuration' menu. This is a convention that has been adopted by Organic Groups, Rules and various other modules that have in the past had top level menu items.

Make dkan_dataset_content type display name match machine name

Update Change Log with Release Notes

Please update https://github.com/nuams/dkan/blob/7.x-1.x/CHANGELOG.txt for release notes.

Update links in Dataset and link to local version of API

The links in the Dataset API settings form are our of date. Update them and point to the local instance on the site.

Save recline's configuration

Issue moved here from https://drupal.org/node/2063905

Request Membership to this Group link doesn't change

Posted by acouch on April 2, 2014 at 9:42am
When someone clicks "Request Membership to this Group" and "Join" it should reflect the change in membership status to that group.

This could most easily be a achieved by creating a custom block with a link that does that.

Undefined index ref_field_sync in install_profile_modules() during site install

followed by "Trying to get property of non-object"

Change Taxonomy links to point to search results instead of taxonomy term page

See: https://drupal.org/node/1928272

Unable to delete dataset

Posted by robrice on April 10, 2014 at 3:36pm
After creating and saving a test dataset, return to edit and press delete.
Instead of removing the dataset, it presents the "Add Dataset" page:
http://gis05837.devcloud.ge.com/node/add/dataset

Create Harvesting Examples from CKAN and Socrata

Create a migration to do this.

Enable Authentication for API

Services supports requiring a key. Create a module to enable this functionality in the distro.

Change theme to nuboot

Errors trying to add Data in User Interface

Attached are 2 screenshots from the user interface when trying to add data, for some reason the UI is all messed up and I don't have the ability to add files, I verified this isn't limited to a single browser, testing it in Internet Explorer, Safari, Firefox and Chrome, all four looked exactly the same as the screenshots below, when I try to select any of those arrows such as for "link to a file" or "link to an API" nothing happens

I am using the 7.x-1.x branch, anyone else have similar problems?

About page menu item it's not being created

User Story: provide map-based preview of additional geodata file types: KML, SHP, others

Posted by drkloc on April 4, 2014 at 5:33pm
We have a couple of problems to pull this.

First, the shp file is tricky in many ways because it needs the .dbf file as well (http://en.wikipedia.org/wiki/Shapefile#Shapefile_attribute_format_.28.db...). There are two options to solve this:

• Upload the shape file zipped with all the layer files in (like https://recursos-data.buenosaires.gob.ar/ckan2/parcelas/parcelas.zip). We need to inspect the zip file content for .shp and .dbf files
• Upload two files in field_upload (shp and dbf).

Another issue that arises from this is that all the recline view functionality circles around getting data from something that relates an index (check out existing backends http://okfnlabs.org/recline/docs/tutorial-backends.html). Neither shapefiles or kml files are in principle that. We need the functionality provided by the recline field (just the file upload really) but none of the actual recline functionality (we just need a leaflet map, no need to initialise a recline multiview for this). I don't know if we are adding confusion if we aggregate this to the recline module.

Maybe we need to restructure things a little bit here. Initial thoughts are:

Show the grid/map/graph checkboxes only if the upload is a csv file (or something that relates an index)
Show another set of checkboxes if the file is a zip file (with shp and dbf inside), kml file or another format that acts as a map layer we present a 'Leaflet Map' checkbox
We only initialise the recline multiview if one of the recline's checkboxes are selected
We only initialise a Leaflet Map if one if the Leaflet checkbox is checked
For this, we need a lot (A LOT) of validation on the drupal side and a lot of hide/show behaviour on the client side.

Add specific version or commit numbers for contributed modules

Set admin theme/colorizer defaults

Dataset info is same color as links

Improve message on Data API of a Resource that has not been imported into Datastore

Posted by Krista Brenner on April 3, 2014 at 11:20am
To replicate, be anonymous. Visit:

http://demo.getdkan.com/node/5/api

Notice the message is:

This resources has a file that has not been added to the datastore.

Should be "This resource has..." (singular)

ALSO

If the resource is unable to be imported into the Datastore due to bad file type, then anonymous user gets no error or feedback at ALL. To replicate, stay anonymous, visit:

http://demo.getdkan.com/node/9/api

Notice there is no useful information there.

Undefined index on resource node form

Apps, Ideas etc.

Posted by batje on August 13, 2013 at 2:34am
CKAN has the concept of Apps, Ideas etc. (See: http://data.ug/dataset/fish-production-in-uganda/related )

This is very nice, and when you do a full Open Data Initiative, also very essential. Having a very basic first version would be awesome. Scoring, Flagging, tagging, commenting is all additional Drupal goodness for later.

Commenting system for datasets

I don't know if you already planned for the next DKAN release, but it would be nice to have a pluggable commenting system for datasets, with the support for Drupal standard and external systems like Disqus.

Document best practices for Internationalization

Internationalization has been tested and a public example will be available soon. Make this part of the distro. Allow enabling in installation.

File icons missing

Gold price demo dataset should use full range in the temporal_coverage field

Posted by marians on October 1, 2013 at 4:15am
In order to illustrate how the API returns values for the temporal_coverage field, the Gold Price sample dataset (http://demo.getdkan.com/node/7/json) should make use of that field.

From https://drupal.org/node/2074381

Groups tab not working on Add Dataset

When creating a dataset, doesn't appear you can add groups?

This page: /node/add/dataset
Additionally, there is different behavior on the next step, Add Resource, on that group tab /node/add/resource?dataset=19.

Expected behavior: Field should auto-populate with available groups.

Update behat tests for bootstrap theme

Behat uses regions to determine where certain items are on the page. This will need to be updated for the nuboot theme.

Notice: Undefined index: und in dkan_dataset_node_update() (line 385 of profiles/dkan/modules/dkan/dkan_dataset/dkan_dataset.module).

This is due to the language not being set for the node when checking for groups.

'missing table field_dataset_ref_target_id' in GoDaddy install

Install fails with message about missing table field_dataset_ref_target_id. Install is on GoDaddy, using the "DKAN" profile.

Remove master branch to reduce confusion.

The default branch on github is master. Shouldn't it be 7.x-1.x? I propose removing master branch entirely unless the project decouples itself from drupal versioning.

Support package_search API

It looks like the most promising avenue for this is this module: https://drupal.org/project/services_search_api

Remove vocabulary machine name patch

posted by gaele on January 27, 2014 at 8:17am
Currently DKAN distro uses a core patch #995156: Use vocabulary machine name for permissions. The issue is set at "Won't fix". The suggested alternative is to use Taxonomy access fix.

---

Posted by acouch on January 27, 2014 at 5:28pm
I don't want to add another module to the code base at this point to cover this use case.

I would consider removing this patch since I don't think we are using it. I would want to make sure we aren't breaking existing installations. I don't think that is the case unless someone is exporting taxonomy permissions which we wouldn't know about.

Accordian lists broken with nuboot theme in the admin

An example can be found at /admin/structure/features/dkan_sitewide_menu/recreate

Form cleanup

Modules unavailable for download...

The following modules are missing from the DKAN distro:

Feeds Flatstore Processor
Feeds Field Fetcher

Support resource_search API

This will be similar to: #26 API I'm afraid we will need to create a separate index for resources. Not sure if this is necessary since the package_search already searches resources.

Add support for Twitter Cards and Facebook OpenGraph tags for better social previews

Add twitter cards (https://dev.twitter.com/docs/cards) and facebook opengraph tags for better social previews (e.g.: https://twitter.com/chucker42/status/349643948555378688). See implementation example walkthrough here: http://webwash.net/tutorials/display-twitter-cards-drupal-using-meta-tag.... Would involve programming in some good defaults for data pages, so when people share a data page, it looks good.

Connects #1850

Install fails with "Missing bundle property on entity of type taxonomy_term"

Having hand-built the field_dataset_ref_target_id (using field types from nearby tables), install on GoDaddy fails with error:

Notice: Trying to get property of non-object in taxonomy_term_save() (line 633 of /home/content/o/p/e/opencrisisnet/html/data/modules/taxonomy/taxonomy.module).
Missing bundle property on entity of type taxonomy_term.

Untranslatable strings in the block "Other Access"

Posted by MaxMendez on March 17, 2014 at 12:14pm
The module dkan_sitewide has untranslatable strings in the block "Other Access".

Warning in features rebuild of dkan_sitewide_roles_perms. No module defines permission "use text format html". on install

Fields text is visible while collapsed in Recline view (IE8)

Posted by stonedr on November 29, 2013 at 12:09pm
Since it falls under the purview of recline (recline-fields-view), I would like to share an issue I've been having.
Only in IE8, the Fields (to the right of the spreadsheet) text is visible while collapsed in Recline view when first loading the Dataset->explore data page. Expanding and then collapsing the Fields fixes the issue and DKAN does not behave this way in IE11, Chrome, or Firefox. Any suggestions for a fix (all work computers still have IE8, and I have not modified its code for fear of breaking something-intern here)?

---

Create test for future updates from 1.0 on

getting access denied in homepage and public pages

Behat Tests are failing because of that.

As a reference, last succesful build was https://travis-ci.org/nuams/dkan/builds/23549176

Verify JSONP works on datastore api

Pivot table implementation

As requested here: datopian/datahub#364 but still not implemented on Recline side.

Would be nice to integrate one of this JS pivot table implementations:
http://rjackson.github.io/pivot.js/
https://github.com/nicolaskruchten/pivottable

We are available to take in charge the development of this feature.

Theme updated group link

The "Request membership" link was changed and the theming needs to be updated.

Missing Modules when installing DKAN distro via Windows...

It appears modules are missing when going through the install.php for the DKAN distro.

http://localhost:10916/install.php?profile=dkan&locale=en

Error
Required modules
Required modules not found.

The following modules are required but were not found. Move them into the appropriate modules subdirectory, such as sites/all/modules. Missing modules: Bueditor, Context, Context_ui, Chosen, Ctools, Date, Date_api, Date_popup, Delta, Diff, Double_field, Entity, Entity_token, Eva, Entityreference, Defaultcontent, Feeds, Facetapi, Facetapi_pretty_paths, Features, Field_group_table, Field_group, Gravatar, Link_iframe_formatter, Libraries, Link, Jquery_update, Job_scheduler, Markdowneditor, Markdown, Multistep, Og, Og_access, Og_extras, Og_ui, Pathauto, Rules, Rules_admin, Select_or_other, Search_api, Services, Search_api_ajax, Search_api_db, Search_api_facetapi, Search_api_views, Strongarm, Rest_server, Restws, R4032login, Schema, Token, Uuid, Views, Views_ui, Views_bulk_operations, Entity_rdf, Geofield, Geophp, Recline, Rdfui, Rdfx, Dkan_sitewide_menu, Dkan_sitewide_user, Dkan_sitewide_roles_perms, Dkan_sitewide_context, Dkan_default_content, Dkan_sitewide_demo_front, Dkan_dataset_groups, Dkan_sitewide_search_db, Dkan_sitewide, Dkan_dataset, Dkan_datastore, Dkan_datastore_api

Recline graph preview grouping results

Should look like this: