These CKAN Versions are exactely matched:

• 2.10.0
• 2.10.1
• 2.10.2
• 2.10.3
• 2.10.4
• 2.10.5
• 2.10.6
• 2.10.7
• 2.10.8
• 2.10.9
• 2.11.0
• 2.11.1
• 2.11.2
• 2.11.3
• 2.11.4
• 2.12.0
• 2.9.0
• 2.9.0a
• 2.9.1
• 2.9.10
• 2.9.11
• 2.9.13
• 2.9.2
• 2.9.3
• 2.9.4
• 2.9.5
• 2.9.6
• 2.9.7
• 2.9.8
• 2.9.9

ckanext-portal

With this plugin, you extend the organization, and dataset entities to comply with the portal metadata structure.

Requirements

This plugin includes schemas and thus the ckanext-scheming is a requirement for it to function properly.

Installation

1. Activate your CKAN virtual environment:

   . /usr/lib/ckan/default/bin/activate

2. Install the ckanext-portal Python package:

   pip install ckanext-portal

3. Add portal to the ckan.plugins setting in your CKAN config file.

4. Restart CKAN.

Config settings

Adding and enabling the portal schema will modify the forms used to update and create each entity. Enable the plugin by including it in the configuration options:

ckan.plugins = ... portal ...

Set the schemas you want to use:

# For dataset portal schema:
scheming.dataset_schemas = ckanext.portal:scheming/schemas/portal.json

# For organization portal schema:
scheming.organization_schemas = ckanext.portal:scheming/schemas/organization/portal_organization.json

Portal dataset schema keys

• carousel_active: choose to display a dataset in the portal’s carousel widget
• carousel_order: set the order in which you want the dataset to be displayed in the carousel widget
• carousel_image: set an image URL to be displayed as a background image
• carousel_text: set a description to be displayed in your carousel activated dataset

Portal organization schema keys

• portal_intro_text: set an intro text to be displayed in your portal’s homepage screen

API Endpoints

• scheming_package_show: An extended version of package_show, returning information fitted to what the Dataplatform Portal needs.

License

AGPL-3.0