Dataset Sites
Dataset Sites help data users to find your data, and interact with you if they find any issues. They are both human and machine readable, and allow your data to appear everywhere from the OpenActive Status Page to the Google Dataset Search.
- In order for data users to find your data feeds, and for your dataset to be featured on the OpenActive status page, you must deploy the Dataset Site Template (a simple mustache template) within your codebase.
- For booking systems or bespoke websites with a single database and one set of OpenActive data feeds, a single Dataset Site is likely to be sufficient for your organisation. This can be achieved by simply hard-coding the JSON passed into the mustache template.
- If you are a booking system with multiple databases, each of which has their own set of OpenActive data feeds, a Dataset Site is required for each customer. This can be achieved using customer configuration to drive the mustache template.
- Data publishers should be encouraged to provide links to their Dataset Site from their own website.
- A web page that can be referenced when discussing the dataset.
- A human and machine readable licence associated with the data (the Dataset Site contains invisible metadata which allows its details to be read automatically).
- A human and machine readable rights statement to specify how dataset users (innovators who want to build on top of/use your data) should attribute your data.
- An accessible "single point of truth" that explains where the data can be found.
- Links to documentation relating to the format of the data, including the specifications it follows, and the data fields it contains.
- A place where the community can contribute with comments, and raise issues - all Dataset Sites are linked to a GitHub issues board (e.g. this one) that allows data users to raise issues in the open.
A machine-readable dataset site is essential when publishing open data, and every dataset published within the OpenActive community to date has had one. However, the specification that describes a standard OpenActive dataset site is still yet to be formally defined, and has instead evolved as a de facto standard.
As such, this documentation is still based on a draft model that is designed to inform the OpenActive specification work with implementation feedback. It is mostly stable and has been largely unchanged for 2 years. However, it is still subject to change, as the Dataset API Discovery specification is yet to be formally released, and feedback is very welcome, both within the relevant OpenActive repository and on the related schema.org PR and issue.
To minimise any uplift work required to conform to the formal specification when it is released, it is recommended that you use one of the libraries below where possible. These libraries will be updated to meet the latest specification, and when used in their simplest mode (RenderSimpleDatasetSite, renderSimpleDatasetSite or TemplateRenderer.new) will only require a simple dependency update from you to do so.
The Dataset Site Template is very easy to use and quick to apply - it's essentially one of two mustache templates and an associated JSON structure. It is designed to work with minimal effort with an extremely wide range of platforms and languages.
It works across all browsers, and includes fully compliant DCAT and schema.org machine-readable metadata to ensure it is compatible with Google Dataset Search.
The dataset site template repository contains two mustache template options for creating an OpenActive dataset site.
There are two templates available, depending on your use case.
The Dataset Site Single-file Template is a self-contained mustache template of an HTML page that contains embedded CSS, two embedded images, and fonts loaded via the CDNs of Google Fonts and cdnjs (powered by Cloudflare).
- 1.Use one of the options below to dynamically render the 'single-file template' and output the result at an endpoint, for example
https://example.com/openactive/.
The Dataset Site CSP Compatible Template is a mustache template of an HTML page that references self-hosted static assets. This template must be rendered using a reference to its stylesheet at its self-hosted location. This is useful for implementations that have a Content Security Policy (CSP) in place.
- 1.
- 2.Use one of the options below to dynamically render the 'CSP compatible template' ensuring that the
"staticAssetsPathUrl"references the location of your self-hosted assets, without a trailing slash (/) (this can be a relative or absolute URL). - 3.Output the result at an endpoint, for example
https://example.com/openactive/.
Several libraries are available that make it really easy to render either dataset site template, accepting basic settings to configure your dataset site automatically.
The table below lists the available OpenActive libraries:
Language | Open Opportunity Data Feeds | Dataset Site |
.NET | ||
PHP | ||
Ruby | ||
JavaScript / TypeScript | ||
CLI | - |
A basic example of following the below render steps can be found here, and can be readily ported into other languages. An explanation of how this works is included below.
The Dataset Site Template is one of two mustache templates of an HTML page. It works across all browsers, and includes fully compliant DCAT and schema.org machine-readable metadata to ensure it is compatible with Google Dataset Search.
Steps to render the template:
- 1.
- 2.
- 3.Write code to do the following:
- Stringify the input JSON, and place the contents of the string within the
"jsonld"property at the root of the JSON itself (i.e. serialised JSON embedded in the original deserialised object). This is important as it is used to populate the machine-readable<script type="application/ld+json">tag within the generated HTML - view the source of this page to see an example. - If using the CSP compatible mustache template, set the
"staticAssetsPathUrl"property at the root of the JSON to the relative URL of the directory containing your self-hosted assets, without a trailing slash (/). Note this must take place after the"jsonld"property is set above so that this property is not included in the machine-readable JSON-LD. - Render the resulting JSON with the single file mustache template or CSP compatible mustache template, to output the HTML of the dataset site.
- Keep in mind that OpenActive will be providing updates to the mustache templates in the future, so it is best to write code that anticipates this.
The JSFiddle below simply demonstrates the Dataset Site Template render steps outlined above using plain JavaScript - it is not intended for protection use.
Please note this is only an example to demonstrate the logic and is not intended for production use. The mustache template must be copied locally and rendered server-side for production use, for security (to prevent XSS attacks), and as its primary purposes are SEO and machine readability.
Click the Result tab below to see the result of a template render.
The Dataset Site Template is designed to carry the customer's brand with minimal configuration.
For booking systems or bespoke websites with a single database and one set of OpenActive data feeds, a single Dataset Site is likely to be sufficient for your organisation. This can be achieved by simply hard-coding the JSON passed into the mustache template (see documentation and example), or hard-coding the settings passed to the library (see the relevant library documentation).
Note a single Dataset Site must only be used when all feeds it includes are part of the same dataset - for example a SessionSeries feed and ScheduledSession feed that together constitute the dataset of all providers in the booking system. Where multiple feeds exist that represent distinct datasets (e.g. SessionSeries feed for Provider A, SessionSeries feed for Provider B), they must be referenced from distinct Dataset Sites, which can be constructed as per the instructions in Multiple databases below.
For large booking systems with multiple databases, usually a separate database for each customer, a separate Dataset Site may be created for each database. The list below illustrates the minimal number of configurable properties that can be used to generate the whole dataset site in a way that is personalised to each customer. See the example here for how these map into the JSON data structure, for your reference - in practice the libraries supplied above take care of this mapping for you.
organisationNamee.g. "Better",datasetDocumentationUrle.g. "https://permalink.openactive.io/dataset-site/open-data-documentation" (which should be used if no system-specific documentation is available)organisationLegalEntitye.g. "GLL"organisationPlainTextDescriptione.g. "Established in 1993, GLL is the largest UK-based charitable social enterprise delivering leisure, health and community services. Under the consumer facing brand Better, we operate 258 public Sports and Leisure facilities, 88 libraries, 10 children’s centres and 5 adventure playgrounds in partnership with 50 local councils, public agencies and sporting organisations. Better leisure facilities enjoy 46 million visitors a year and have more than 650,000 members."organisationEmaile.g. "[email protected]"openBookingAPIDocumentationUrle.g. "https://permalink.openactive.io/dataset-site/open-booking-api-documentation" (which should be used if no system-specific documentation is available)
We suggest if you can provide the customer with a means of customising the logo and background image (e.g. via uploading an image to the cloudinary.com CDN, using their widget, which is free at low volume), these have the largest effect on the brand feel of the page.
Although the customer will likely be able to fill in most properties specific to them, there are two where they will require guidance:
datasetDiscussionUrl- the URL of the GitHub issues board for the dataset. If your customers are sufficiently large, you will need to create a GitHub issues board for each customer, either manually or automatically. See here for an example of Gladstone's GitHub organization containing a GitHub issues board for each customer.datasetDocumentationUrl- as a booking system you should provide at least a single page on your website that explains the OpenActive feeds. Each customer may have the option of providing their own documentation for their dataset site that links to this, or just linking to your documentation direct. If you do not have your own documentation page, you can just link to "https://developer.openactive.io/".
For Open Booking API implementations the following settings warrant additional consideration.
This is set by
openBookingAPIRegistrationUrl (in library settings) or accessService.landingPage (in raw Dataset JSON-LD) This must link to a page where developers can request access to your Open Booking API, ideally both to a sandbox and live environment.
In addition to access to your live environment, this page should also include a means of accessing a sandbox to support testing of your Open Booking APIs, to ensure that developers have the freedom to test their code in a safe environment. Such a sandbox should include its own Dataset Site akin to that of the live environment.
Where the dataset site represents data from multiple Sellers ("multi-seller systems"), the Booking System must offer a mechanism for Broker to provision a new Client ID and Client Secret (see multi-seller authentication). It is recommended that such a process is automated, with a form similar to the below:
Open Booking API Access Request Form (Multi-seller systems)Name: ______________________________Email: ______________________________Organisation name: ______________________________☑️ I understand our data protection obligations, and our technical obligations as a Broker as specified in the Open Booking API specification☑️ Our organisation holds a valid Cyber Essentials (or equivalent) certification and we understand our information security obligations☑️ Our organisation has already successfully integrated with the OpenActive Reference Implementation, and understands how an OpenActive integration works☑️ I agree to integrate with Sellers only with their explicit consent as granted via OpenID Connect, and understand that access to the Booking System does not guarantee access to Sellers, which is at their own individual discretion.☑️ I understand that payment reconciliation must be agreed with each seller individually.
Where the dataset site represents data from only a single Seller ("single-seller systems"), the Seller must offer a mechanism for Broker to request a new API key. This could be as simple as a Google Form or TypeForm, or could also be automated, with a form similar to the below:
Open Booking API Access Request Form (Single-seller systems)Name: ______________________________Email: ______________________________Phone number: ______________________________Organisation name: ______________________________Use case and business case for integration: ______________________________☑️ I understand our data protection obligations, and our technical obligations as a Broker as specified in the Open Booking API specification☑️ Our organisation holds a valid Cyber Essentials (or equivalent) certification and we understand our information security obligations☑️ Our organisation has already successfully integrated with the OpenActive Reference Implementation, and understands how an OpenActive integration works
This is set by
openBookingAPITermsOfServiceUrl (in library settings) or accessService.termsOfService (in raw Dataset JSON-LD)It is important that the terms and conditions and usage restrictions that apply to use of your Open Booking API are well documented so that third-party developers can easily integrate with your platform and understand their rights and responsibilities.
If you have any standard terms of service or usage restrictions that apply to your API, ensure that these are easily accessible from the URL referenced by this property. If not, ensure that this property is omitted entirely.
This is set by
testSuiteCertificateUrl (in library settings) or bookingService.hasCredential (in raw Dataset JSON-LD)This must be a link to a self-hosted OpenActive Test Suite Certificate that has been generated for the specific software version of the Booking System to which the dataset site is associated.
For cloud-based SaaS systems that operate a single version, this is best achieved by running the OpenActive Test Suite as part of any continuous integration process, and deploying the resulting certificate as part of any existing deployment process (e.g. via GitHub CI).
platformSoftwareVersion in library settings, or bookingService.softwareVersion in raw Dataset JSON-LD should be omitted in this case.For on-premise systems or systems with separately installed instances, this can be achieved by generating and hosting a new certificate for each version released, with the certificate's path based on the software version. The correct version of the certificate can then be referenced within the dataset site based on the software version of the instance. In this case, the version number should also be included in
platformSoftwareVersion in library settings, or bookingService.softwareVersion in Dataset JSON.The
discussionUrl is the url of the GitHub issues board for that specific dataset site.If you have multiple databases and customers with large data volumes, you should create one GitHub repository (that will include a GitHub Issues Board) for each customer. Single database systems need only create one GitHub repository (that will include a GitHub Issues Board).
If you "follow" these GitHub repositories using a new GitHub account created with your support e-mail address then you will receive notifications for each query, and be able to reply via e-mail to the notifications from your support e-mail address - these replies then appear directly in GitHub. Note that any administrator accounts automatically follow newly created GitHub repositories within your organisation.
- For booking systems we recommend naming the parent GitHub organisation after your own organisation
- For agencies or in-house tech teams we recommend naming parent GitHub organisation after your data publishing organisation.
A guide for creating a new GitHub repository for each customer can be found below.
The GitHub API provides a mechanism to automatically create GitHub repositories. The recommended properties for a new repository are included below:
{
"name": "AshfordLeisureTrust",
"description": "Issues relating to open data from Ashford Leisure Trust",
"homepage": "https://ashfordleisuretrust.leisurecloud.net/OpenActive/",
"private": false,
"has_issues": true,
"has_projects": false,
"has_wiki": false,
"auto_init": false
}
Use the validator to check that the JSON-LD within your Dataset Site is conformant, by using the Load URL feature in the menu to load your Dataset Site URL, while in the "Dataset Sites" mode. The validator will automatically extract the JSON-LD from your Dataset Site's HTML and validate it.
For booking systems with multiple databases, a Data Catalog must also be provided to allow the many Dataset Sites that are created to be easily indexed by the OpenActive Status Page and other data users.
A Data Catalog is very simply an array of the URLs of all your Dataset Sites (the
dataset array), presented within a DataCatalog wrapper following a specific format. An example of a live Data Catalog from the Gladstone system can be found here, and another example here.Please use the validator to check that your
DataCatalog is conformant, using the "Data Catalog" mode.OpenActive Data Catalogs provide a mechanism for registering OpenActive Datasite Sites so that they can be discovered and harvested by data users.
If you have created a new Dataset Site, simply create a Pull Request for the OpenActive Data Catalog for Singular Datasets and add your Dataset Site's production URL to the
dataset array.The pull request will trigger GitHub Actions to run the OpenActive Test Suite to validate the live feeds within dataset. OpenActive Test Suite validation must pass before the PR can be merged.
To force the validation to re-run, please submit an empty commit to the PR:
git commit --allow-empty -m "trigger GitHub actions"
git push
If you have created a new Data Catalog that links to your Dataset Sites, simply create a Pull Request for the OpenActive Data Catalog Collection and add your Data Catalog's production URL to the
hasPart array.Last modified 3mo ago