Abstract

This document provides best practices related to the publication and usage of data on the Web designed to help support a self-sustaining ecosystem. Data should be discoverable and understandable by humans and machines. Where data is used in some way, whether by the originator of the data or by an external party, such usage should also be discoverable and the efforts of the data publisher recognized. In short, following these best practices will facilitate interaction between publishers and consumers.

Status of This Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.

This version of the document shows its expected scope and future direction. A template is used to show the "what", "why" and "how" of each best practice. Comments are sought on the usefulness of this approach and the expected scope of the final document.

This document was published by the Data on the Web Best Practices Working Group as a Working Draft. This document is intended to become a W3C Recommendation. If you wish to make comments regarding this document, please send them to public-dwbp-wg@w3.org (subscribe, archives). All comments are welcome.

Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

This document is governed by the 1 August 2014 W3C Process Document.

Table of Contents

1. Introduction

This section is non-normative.

The best practices described below have been developed to encourage and enable the continued expansion of the Web as a medium for the exchange of data. The growth of open data by governments across the world [OKFN-INDEX], the increasing publication of research data encouraged by organizations like the Research Data Alliance [RDA], the harvesting and analysis of social media, crowd-sourcing of information, the provision of important cultural heritage collections such as at the Bibliothèque nationale de France [BNF] and the sustained growth in the Linked Open Data Cloud [LODC], provide some examples of this phenomenon.

In broad terms, data publishers aim to share data either openly or with controlled access. Data consumers (who may also be producers themselves) want to be able to find and use data, especially if it is accurate, regularly updated and guaranteed to be available at all times. This creates a fundamental need for a common understanding between data publishers and data consumers. Without this agreement, data publishers' efforts may be incompatible with data consumers' desires.

Publishing data on the Web creates new challenges, such as how to represent, describe and make data available in a way that it will be easy to find and to understand. In this context, it becomes crucial to provide guidance to publishers that will improve consistency in the way data is managed, thus promoting the re-use of data and also to foster trust in the data among developers, whatever technology they choose to use, increasing the potential for genuine innovation.

This document sets out a series of best practices that will help publishers and consumers face the new challenges and opportunities posed by data on the Web.

Best practices cover different aspects related to data publishing and consumption, like data formats, data access, data identification and metadata. In order to delimit the scope and elicit the required features for Data on the Web Best Practices, the DWBP working group compiled a set of use cases [UCR] that represent scenarios of how data is commonly published on the Web and how it is used. The set of requirements derived from these use cases were used to guide the development of the best practices.

The Best Practices proposed in this document are intended to serve a more general purpose than the practices suggested in Best Practices for Publishing Linked Data [LD-BP] since it is domain-independent and whilst it recommends the use of Linked Data, it also promotes best practices for data on the web in formats such as [CSV] and [JSON]. The Best Practices related to the use of vocabularies incorporate practices that stem from Best Practices for Publishing Linked Data where appropriate.

2. Conformance

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words MUST and SHOULD are to be interpreted as described in [RFC2119].

3. Audience

This section is non-normative.

This document provides best practices to those who publish data on the Web. The best practices are designed to meet the needs of information management staff, developers, and wider groups such as scientists interested in sharing and re-using research data on the Web. While data publishers are our primary audience, we encourage all those engaged in related activities to become familiar with it. Every attempt has been made to make the document as readable and usable as possible while still retaining the accuracy and clarity needed in a technical specification.

Readers of this document are expected to be familiar with some fundamental concepts of the architecture of the Web [WEBARCH], such as resources and URIs, as well as a number of data formats. The normative element of each best practice is the intended outcome. Possible implementations are suggested and, where appropriate, these recommend the use of a particular technology such as CSV, JSON or RDF. A basic knowledge of vocabularies and data models would be helpful to better understand some aspects of this document.

4. Scope

This section is non-normative.

This document is concerned solely with best practices that:

As noted above, whether a best practice has or has not been followed should be judged against the intended outcome, not the possible approach to implementation which is offered as guidance. A best practice is always subject to improvement as we learn and evolve the Web together.

5. Context

This section is non-normative.

In general, publishing data on the Web means publishing datasets in order to share them with multiple users. For this document, as defined by [DCAT], "a dataset is a collection of data, available for access or download in one or more formats". By data, "we mean known facts that can be recorded and that have implicit meaning" [Navathe]. To meet the requirements of different users, a single dataset may be available in different data formats or distributions. Again quoting the DCAT specification, a distribution "Represents a specific available form of a dataset. Each dataset might be available in different forms, these forms might represent different formats of the dataset or different endpoints. Examples of distributions include a downloadable CSV file, an API or an RSS feed" [VOCAB-DCAT]

6. Data on the Web Challenges

This section is non-normative.

The openness and flexibility of the Web creates new challenges for data publishers and data consumers. In contrast to conventional databases, for example, where there is a single data model to represent the data and a database management system (DBMS) to control data access, data on the Web allows for the existence of multiple ways to represent and to access data. Furthermore, publishers and consumers may be unknown to each other and be part of entirely disparate communities with different norms and in-built assumptions so that it becomes essential to provide information about data structure, quality, provenance and any terms of use. The following diagram summarizes some of the main challenges faced when publishing or consuming data on the Web. These challenges were identified from the DWBP Use Cases and Requirements [UCR] and are described by one or more questions. As presented in the diagram, each one of these challenges is addressed by one or more best practices.

Fig. 1 Diagram showing how best practices address each of the challenges faced when publishing data on the Web

Each one of these challenges originated one or more requirements as documented in the use-cases document. The development of Data on the Web Best Practices were guided by these requirements, in such a way that each best practice should have at least one of these requirements as an evidence of its relevance.

7. Best Practices Template

This section presents the template used to describe Data on the Web Best Practices.

Best Practice Template

Short description of the BP, including the relevant RFC2119 keyword(s)

Why

This section answers two crucial questions:

  • Why this is unique to publishing or re-using data on the Web?
  • How does this encourages publication or re-use of data on the Web?
A full text description of the problem addressed by the best practice may also be provided. It can be any length but is likely to be no more than a few sentences.

Intended Outcome

What it should be possible to do when a data publisher follows the best practice.

Possible Approach to Implementation

A description of a possible implementation strategy is provided. This represents the best advice available at the time of writing but specific circumstances and future developments may mean that alternative implementation methods are more appropriate to achieve the intended outcome.

How to Test

Information on how to test the BP has been met. This might or might not be machine testable.

Evidence

Information about the relevance of the BP. It is described by one or more relevant requirements as documented in the Data on the Web Best Practices Use Cases & Requirements document

Issue 1

Which section of a BP is normative, and whether the use of RFC2119 keywords is appropriate, is Issue-146

8. Best Practices Summary

9. The Best Practices

This section contains the best practices to be used by data publishers in order to help them and data consumers to overcome the different challenges faced when publishing and consuming data on the Web. One or more best practices were proposed for each one of the previously described challenges. Each BP is related to one or more requirements from the Data on the Web Best Practices Use Cases & Requirements document.

9.1 Example

This example serves as a basis for elaboration that will be described in subsequent sections. It helps to illustrate how best practices may be applied.

John works for the Transport Agency of MyCity and he is in charge of the publication of data on the Web about bus timetables as well as real time data about the traffic of the city. John decides to create two datasets: one for the bus timetables and other one for the real time traffic data.

Some requirements that should be addressed:

  • The dataset for bus timetables must be available in two languages: english and portuguese;
  • Both datasets must be available in csv and json-ld formats;
When necessary RDF examples will be used to show the result of the application of some best practices. RDF examples in this document are written in Turtle syntax [TURTLE] and [JSON-LD].
Note

In this current version, examples are presented just in Turtle syntax.

9.2 Metadata

The Web is an open information space, where the absence of a specific context, such a company's internal information system, means that the provision of metadata is a fundamental requirement. Data will not be discoverable or reusable by anyone other than the publisher if insufficient metadata is provided. Metadata provides additional information that helps data consumers better understand the meaning of data, its structure, and to clarify other issues, such as rights and license terms, the organization that generated the data, data quality, data access methods and the update schedule of datasets.

Metadata can be used to help tasks such as dataset discovery and re-use, and can be assigned considering different levels of granularity from a single property of a resource to a whole dataset, or all datasets from a specific organization.

Metadata can be of different types. These types can be classified in different taxonomies, with different grouping criteria. For example, a specific taxonomy could define three metadata types according to descriptive, structural and administrative features. Descriptive metadata serves to identify a dataset, structural metadata serves to understand the structure in which the dataset is distributed and administrative metadata serves to provide information about the version, update schedule etc. A different taxonomy could define metadata types with a scheme according to tasks where metadata are used, for example, discovery and re-use.

Best Practice 1: Provide metadata

Metadata must be provided for both human users and computer applications

Why

Providing metadata is a fundamental requirement when publishing data on the Web because data publishers and data consumers may be unkown to each other. Then, it is essential to provide information that helps data consumers, i.e., human users and computer applications, to understand the data as well as other important aspects that describes a dataset.

Intended Outcome

It must be possible for humans to understand the metadata, which makes it human readable metadata.

It should be possible for computer applications, notably user agents, to process the metadata, which makes it machine readable metadata.

Possible Approach to Implementation

Possible approaches to provide human readable metadata:
  • to provide metadata as part of an HTML Web page
  • to provide metadata as a separate text file
Possible approaches to provide machine readable metadata:
  • machine readable metadata may be provided in a serialization format such as Turtle and JSON, or it can be embedded in the HTML page using [JSON-LD], or [HTML-RDFA] or [Microdata]. If multiple formats are published separately, they should be served from the same URL using content negotiation. Maintenance of multiple formats is best achieved by generating each available format on the fly based on a single source of the metadata.
  • when defining machine readable metadata, reusing existing standard terms and popular vocabularies are strongly recommended. For example, Dublin Core Metadata (DCMI) terms [DC-TERMS] and Data Catalog Vocabulary [VOCAB-DCAT] should be used to provide descriptive metadata (see Section 9.9 Data Vocabularies).

to be done

How to Test

For human readable metadata, check that a human user can understand the metadata associated with a dataset.

For machine readable metadata, access the same URL either with a user agent that accepts a more data oriented format or a tool that extracts the data from an HTML page.

Evidence

Relevant requirements: R-MetadataAvailable, R-MetadataDocum, R-MetadataMachineRead

Best Practice 2: Provide descriptive metadata

The overall features of a dataset must be described by metadata

Why

Explicitly providing dataset descriptive information allows user agents to automatically discover datasets available on the Web and it allows humans to understand the nature of the dataset. 

Intended Outcome

It should be possible for humans to understand the nature of the dataset.

It should be possible for user agents be able to automatically discover the dataset.

Possible Approach to Implementation

Discovery metadata should include the following overall features of a dataset:

  • The title and a description of the dataset.
  • The keywords describing the dataset.
  • The date of publication of the dataset.
  • The entity responsible (publisher) for making the dataset available.
  • The contact point of the dataset.
  • The spatial coverage of the dataset.
  • The temporal period that the dataset covers.
  • The themes/categories covered by a dataset.

The machine readable version of the discovery metadata may be provided according to the vocabulary recommended by W3C to describe datasets, i.e. the Data Catalog Vocabulary [VOCAB-DCAT]. This provides a framework in which datasets can be described as abstract entities.

Machine-readable

The example below shows how to use [VOCAB-DCAT] to provide the machine readable discovery metadata for the timetable dataset (dataset-001).

   :dataset-001
       a dcat:Dataset ;
       dct:title "Bus timetable of MyCity" ;
       dcat:keyword "transport","mobility" ,"bus" ;
       dct:issued "2015-05-05"^^xsd:date' ;
       dct:modified "2015-05-05"^^xsd:date' ;
       dcat:contactPoint <http://example.org/transport-agency/contact>;
       dct:temporal <http://reference.data.gov.uk/id/year/2014>;
       dct:spatial <http://www.geonames.org/3399415>;
       dct:publisher :transport-agency-mycity  ;
       dct:accrualPeriodicity <http://purl.org/linked-data/sdmx/2009/code#freq-A>  ;       
       .

The following paragraph was extracted from the DCAT specification (to review): In order to express frequency of update in the example above, we chose to use an instance from the Content-Oriented Guidelines developed as part of the W3C Data Cube Vocabulary efforts. Additionally, we chose to describe the spatial and temporal coverage of the example dataset using URIs from Geonames and the Interval dataset from data.gov.uk, respectively. A contact point is also provided where comments and feedback about the dataset can be sent. Further details about the contact point, such as email address or telephone number, can be provided using VCard [vcard-rdf].

Human-readable

Example page with human-readable description of dataset is availabe.

How to Test

Check that the metadata for the dataset itself includes the overall features of the dataset.

Check if a user agent can automatically discover the dataset.

Evidence

Relevant requirements: R-MetadataAvailable, R-MetadataMachineRead, R-MetadataStandardized

Best Practice 3: Provide locale parameters metadata

Information about locale parameters (date, time, and number formats, language) should be described by metadata.

Why

Providing locale parameters metadata helps data consumers, i.e., human users and computer applications, to understand and to manipulate the data, improving the re-use of the data. A locale is a set of parameters that defines specific data aspects, such as language and formatting used for numeric values and dates. Providing information about the locality for which the data is currently published aids data users in interpreting its meaning. Date, time, and number formats can have very different meanings, despite similar appearances. Making the language explicit allows users to determine how readily they can work with the data and may enable automated translation services.

Intended Outcome

It should be possible for data consumers to interpret the meaning of dates, times and numbers accurately by referring to locale information.

Possible Approach to Implementation

Locale parameters metadata should include the following information:

  • The language(s) of the dataset.
  • The formats used for numeric values, dates and time.

The machine readable version of the discovery metadata may be provided according to the vocabulary recommended by W3C to describe datasets, i.e. the Data Catalog Vocabulary [VOCAB-DCAT].

The example below shows the machine readable metadata for dataset-001 with the inclusion of the locale parameters metadata.

   :dataset-001
       a dcat:Dataset ;
       dct:title "Bus timetable of MyCity" ;
       dcat:keyword "transport","mobility" ,"bus" ;
       dct:issued "2015-05-05" ;
       dct:modified "2015-05-05" ;
       dcat:contactPoint <http://example.org/transport-agency/contact>;
       dct:temporal <http://reference.data.gov.uk/id/year/2014>;
       dct:spatial <http://www.geonames.org/3399415>;
       dct:publisher :transport-agency-mycity  ;
       dct:accrualPeriodicity <http://purl.org/linked-data/sdmx/2009/code#freq-A> ; 
       dct:language <http://lexvo.org/id/iso639-3/eng> ;
       dct:language <http://lexvo.org/id/iso639-3/por> ;
       .

To declare the languages the dataset is published in use dct:language. If the dataset is available in mutiple languages, use multiple values for this property [[VOCAB-DCAT]. As proposed in Dataset Descriptions from HCLS Community [HCLS] values were taken from the Lexvo.org Ontology [Lexvo].

Note
to include date and numbers formats!

Issue 2
DCAT has a property to describe language, but there are no properties to describe date, time and numeric formats. Which vocabulary should be used to provide this type of metadata? This is Issue-167.

How to Test

Check that the metadata for the dataset itself includes the language in which it is published and that all numeric, date, and time fields have locale metadata provided either with each field or as a general rule.

Evidence

Relevant requirements: R-FormatLocalize, R-MetadataAvailable

Best Practice 4: Provide structural metadata

Information about the schema and internal structure of a distribution must be described by metadata

Why

Providing information about the internal structure of a distribution can be helpful when exploring or querying the dataset. Besides, structural metadata provides information that helps to understand the meaning of the data.

Intended Outcome

It should be possible for humans to understand the internal structure or schema of a distribution.

It should be possible for user agents be able to automatically process the structural metadata about a distribution.

Possible Approach to Implementation

Structural metadata is available according to the format of a specific distribution and it may be provided within separate documents or embedded into the document. For more details see the links below.

to be done

How to Test

Check that the distribution itself includes structural information about the data organization.

Check if a user agent can automatically process the structural information about the distribution.

Evidence

Relevant requirements: R-MetadataAvailable

9.3 Data Licenses

A license is a very useful piece of information to be attached to data on the Web. As defined by the Dublin Core Metadata Initiative [DC-TERMS], a license is a legal document giving official permission to do something with the data with which it is associated. According to the type of license adopted by the publisher, there might be more or fewer restrictions on sharing and re-using data. In the context of data on the Web, the license of a dataset can be specified within the data, or outside of it, in a separate document to which it is linked.

Best Practice 5: Provide data license information

Data license information should be available

Why

The presence of license information is essential for data consumers to assess the usability of data. User agents, for example, may use the presence/absence of license information as a trigger for inclusion or exclusion of data presented to a potential consumer.

Intended outcome

It should be possible for humans to understand possible restrictions placed on the use of a distribution.

It should be possible for machines to automatically detect the data license of a distribution.

Possible Approach to Implementation

The machine readable version of the data license metadata may be provided using one of the following vocabularies that include properties for linking to a license:

There are also a number of machine readable rights languages, including:
  • The Creative Commons Rights Expression Language [ccREL]
  • The Open Data Rights Language [ODRL]
  • The Open Data Rights Statement Vocabulary [ODRS].

The example below shows the machine readable metadata for :dataset-001-csv with the inclusion of the data license information.

   :dataset-001-csv
       a dcat:Distribution ;
       dcat:mediaType "text/csv";
       dct:license <http://creativecommons.org/licenses/by-sa/3.0/>;
       .

How to Test

Check that the metadata for the dataset itself includes the data license information.

Check if a user agent can automatically detect the data license of the dataset.

Evidence

Relevant use cases: R-LicenseAvailable and R-MetadataMachineRead

9.4 Data Provenance

Provenance originates from the French term "provenir" (to come from), which is used to describe the curation process of artwork as art is passed from owner to owner. Data provenance, in a similar way, is metadata that allows data providers to pass details about the data history to data users. Provenance becomes particularly important when data is shared between collaborators who might not have direct contact with one another either due to proximity or because the published data outlives the lifespan of the data provider projects or organizations.

The Web brings together business, engineering, and scientific communities creating collaborative opportunities that were previously unimaginable. The challenge in publishing data on the Web is providing an appropriate level of detail about its origin. The data publishers may not necessarily be the data provider and so collecting and conveying this corresponding metadata is particularly important. Without provenance, consumers have no inherent way to trust the integrity and credibility of the data being shared. Data publishers in turn need to be aware of the needs of prospective consumer communities to know how much provenance detail is appropriate.

Best Practice 6: Provide data provenance information

Data provenance information should should be available.

Why

Without accessible data provenance, data consumers will not know the origin or history of the published data.

Intended Outcome

It should be possible for humans to know the origin or history of the dataset.

It should be possible for machines to automatically process the provenance information about the dataset.

Possible Approach to Implementation

The machine readable version of the data provenance may be provided according to the ontology recommended by W3C to describe provenance information, i.e., the Provenance Ontology [PROV-O].

The example below shows the machine readable metadata for dataset-001 with the inclusion of the provenance metadata.

   :dataset-001
       a dcat:Dataset , prov:Entity;
       dct:title "Bus timetable of MyCity" ;
       dcat:keyword "transport","mobility" ,"bus" ;
       dct:issued "2015-05-05" ;
       dct:modified "2015-05-05" ;
       dcat:contactPoint <http://example.org/transport-agency/contact>;
       dct:temporal <http://reference.data.gov.uk/id/year/2014>;
       dct:spatial <http://www.geonames.org/3399415>;
       dct:publisher :transport-agency-mycity  ;
       dct:accrualPeriodicity <http://purl.org/linked-data/sdmx/2009/code#freq-A>  ; 
       dct:language <http://id.loc.gov/vocabulary/iso639-1/en>  ;
       prov:wasAttributedTo :john;  
       .
       
  :john
       a foaf:Person, prov:Agent;
       foaf:givenName "John";
       foaf:mbox ;
       prov:actedOnBehalfOf :transport-agency-mycity;
       .
  :transport-agency-mycity
       a foaf:Organization, prov:Agent;
       foaf:name "Transport Agency of Mycity";
       .

How to Test

Check that the metadata for the dataset itself includes the provenance information about the dataset.

Check if a computer application can automatically process the provenance information about the dataset.

Evidence

Relevant requirements: R-ProvAvailable, R-MetadataAvailable

9.5 Data Quality

Data quality is commonly defined as “fitness for use” for a specific application or use case. It can affect the potentiality of the application that use data, as a consequence, its inclusion in the data publishing and consumption pipelines is of primary importance.

Usually, the assessment of quality involves different kinds of quality dimensions, each representing groups of characteristics that are relevant to publishers and consumers. Measures and metrics are defined to assess the quality for each dimension. There are heuristics designed to fit specific assessment situations that rely on quality indicators, namely, pieces of data content, pieces of data meta-information, and human ratings that give indications about the suitability of data for some intended use.

Best Practice 7: Provide data quality information

Data Quality information should be available.

Why

Data quality might seriously affect the suitability of data for specific applications, including applications very different from the purpose for which it was originally generated. Documenting data quality significantly eases the process of datasets selection, increasing the chances of re-use. Independently from domain-specific peculiarities, the quality of data should be documented and known quality issues should be explicitly stated in metadata.

Intended Outcome

It should be possible for humans to have access to information that describes the quality of the dataset.

It should be possible for machines to automatically process the quality information about the dataset.

Possible Approach to Implementation

The machine readable version of the dataset quality metadata may be provided according to the vocabulary that is being developed by the DWBP working group , i.e., the Data Quality and Granularity vocabulary.

to be done

How to Test

Check that the metadata for the dataset itself includes quality information about the dataset.

Check if a computer application can automatically process the quality information about the dataset.

Evidence

Information about the relevance of the BP is described by requirements documented in the Data on the Web Best Practices Use Cases & Requirements document: Requirements for Data Quality

9.6 Data Versioning

Issue 3
This section provides an initial idea of how we are planning to deal with versioning. We're keen to hear comments about our proposal to represent the relationship between a dataset and its different versions as well as the use of PAV ontology as a solution to track dataset versioning. Issue-192
Issue 4
To discuss if the items in yellow each represent a different dataset (they report different data points) or a different version, if released independently. This is Issue-193.
Issue 5
To debate if versions attempt to report the same data. This is Issue-193.

Data on the Web often changes over time. Many datasets are updated on a scheduled basis, such as census data or funding data that changes every fiscal year. Other datasets are changed as improvements in collecting the data make updates worthwhile. Still other data changes in real time or near real time. All these types of data need a consistent, informative approach to versioning, so data consumers can understand and work with the changing data.

In order to deal with changes over time, multiple versions may be created for a single dataset. To illustrate this let us consider a simple example: a dataset that collects data about weekly weather forecast for MyCity. The following figure shows the relation between the dataset (Dataset001) and its different versions (Dataset001_W1, Dataset001_W2, Dataset001_W3 and Dataset001_W4), where each version corresponds to the weather forecast of a week of May 2015. Each dataset version has two different distributions: one in CSV and one in JSON. For example, the version Dataset001_W1 has two distributions: Dataset001_W1_csv and Dataset001_W1_json.

A single node on the left hand side is the Dataset, lines from here split to link to 4 versions of the dataset, each of which is linked to two distributions of each one, making a total of 8 files for this one dataset.
Fig. 2 Diagram showing the relationships between Dataset, Versions and Distributions

The following best practices address issues that arise in tracking and managing different versions of datasets.

Best Practice 8: Provide versioning information

Information about dataset versioning should be available.

Why

Version information makes a dataset uniquely identifiable. Uniqueness can be used by data consumers to determine how data has changed over time and to determine specifically which version of a dataset they are working with. Good data versioning enables consumers to understand if a newer version of a dataset is available. Explicit versioning allows for repeatability in research, enables comparisons, and prevents confusion. Using unique version numbers that follow a standardized approach can also set consumer expectations about how the versions differ.

Intended Outcome

It should be possible for data consumers to easily determine which version of the dataset they are working with.

Possible Approach to Implementation

The precise method adopted for providing versioning information may vary according to the context, however there are some basic guidelines that can be followed, for example:

  • Include a unique version number as part of the metadata for the dataset.
  • Use a consistent numbering scheme with a meaningful approach to incrementing digits, such as [SchemaVer].
  • Provide a description of what has changed since the previous version.
  • If the data is made available through an API, the URI used to request the latest version of the data should not change as the versions change, but it should be possible to request a specific version through the API.
  • Use the Memento protocol, or components thereofe, to declare that a given resource is versioned and express its relation to other versions.

The Web Ontology Language provides a number of annotation properties for version information [OWL2-QUICK-REFERENCE] and the Provenance Ontology [PROV-O] defines several types of link between versions.

to be completed

Using Memento

A query for the headers of a resource such as dbpedia:Paris using

curl -L -I http://dbpedia.org/resource/Paris
shows
http://mementoarchive.lanl.gov/dbpedia/timegate/http://dbpedia.org/page/Paris
as part of the links with a "timegate" relation. This timegate itself points to the latest memento of the web representation of the resource with a "last memento" relation:
http://dbpedia.mementodepot.org/memento/20120515/http://dbpedia.org/page/Paris
A query for a particular datetime will point to the closest memento available:
curl -H "Accept-Datetime: Sat, 16 Jun 2012 00:00:00 GMT" -L -I http://mementoarchive.lanl.gov/dbpedia/timegate/http://dbpedia.org/page/Paris

How to Test

Check that a unique version number or date is provided with the metadata describing the dataset.

Evidence

Relevant requirements: R-DataVersion

Best Practice 9: Provide version history

A version history should be available.

Why

In creating applications that use data, it can be helpful to understand the variability of that data over time. Interpreting the data is also enhanced by an understanding of its dynamics. Determining how the various versions of a dataset differ from each other is typically very laborious unless a summary of the differences is provided.

Intended Outcome

It should be possible for data consumers to understand how the dataset typically changes from version to version and how any two specific versions differ.

Possible Approach to Implementation

Provide a list of published versions and a description for each version that explains how it differs from the previous version. An API can expose a version history with a single dedicated URL that retrieves the latest version of the complete history.

Issue 6
Which vocabulary should be used to describe the versioning history? This is Issue-168

to be done

How to Test

Check that a list of published versions is available, and that each version is described.

Evidence

Relevant requirements: R-DataVersion

9.7 Data Identification

Issue 7

To discuss about limiting this section to information that applies to publishing *data*. Issue-194

Identifiers are simple conventions of labels that allow us to distinguish what is being identified from anything else. Identifiers are used extensively in every information system, making it possible to refer to any particular element. The Web is predicated on a uniform system of identifiers that are globally unique and can be looked up by dereferencing them over the Internet. There are three terms in common use for these identifiers and, although they are often used interchangeably, there are differences.

Of these three, the term URL is by far the most commonly used. The term URI, and even more so, IRI, may cause confusion among some audiences, however, in the context of data on the Web, URI is more appropriate since data points and datasets very often refer to real world objects and phenomena. The term IRI is used where necessary.

Data discovery, usage and citation on the Web depends fundamentally on the use of HTTP (or HTTPS) URIs.

It is perhaps worth emphasizing some key points about URIs in the current context.

  1. URIs are 'dumb strings', that is, they carry no semantics. Their function is purely to identify a resource.
  2. Although the previous point is accurate, it would be perverse for a URI such as http://example.com/datset.csv to return anything other than a CSV file. Human readability is helpful.
  3. When de-referenced (looked up), a single URI may offer the same resource in more than one format. http://example.com/dataset may offer the same data in, say, CSV, JSON and XML. The server returns the most appropriate format based on content negotiation .
  4. One URI may redirect to another.
  5. De-referencing a URI triggers a computer program to run on a server so that the URI acts as a call to an API. The server may therefore do something as simple as return a single, static file, or it may carry out complex processing. Precisely what processing is carried out, i.e. the software on the server, is completely independent of the URI itself.

Best Practice 10: Use persistent URIs as identifiers

Datasets must be identified by a persistent URI.

Why

Adopting a common identification system enables basic data identification and comparison processes by any stakeholder in a reliable way. They are an essential pre-condition for proper data management and re-use.

Intended Outcome

Datasets or information about datasets, must be discoverable and citable through time, regardless of the status, availability or format of the data.

Possible Approach to Implementation

To be persistent, URIs must be designed as such, backed up by organizational commitments. There have been a number of articles written on this topic and the following summarizes many of the key points made.

  • Follow a pattern (e.g. http://{domain}/{type}/{concept}/{reference})
  • Re-use existing identifiers (e.g. http://education.data.gov.uk/id/school/123457)
  • Link multiple representations (e.g. http://data.example.org/doc/foo/bar.rdf and http://data.example.org/doc/foo/bar.html)
  • Implement 303 redirects for real-world objects (e.g. http://www.example.com/id/alice_brown and http://www.example.com/doc/alice_brown)
  • Use a dedicated service (i.e. independent of the data originator)
  • Avoid stating ownership (e.g. http://education.data.gov.uk/ministryofeducation/id/school/123456)
  • Avoid version numbers (e.g. http://education.data.gov.uk/doc/school/v01/123456)
  • Avoid using auto-increment (e.g. http://education.data.gov.uk/id/school/123456 and e.g. http://education.data.gov.uk/id/school/123457)
  • Avoid query strings (e.g. http://education.data.gov.uk/doc/school?id=123456)
  • Avoid file extensions (http://education.data.gov.uk/doc/schools/123456.csv)

Where a data publisher is unable or unwilling to manage its URI space directly for persistence, an alternative approach is to use a redirection service such as purl.org . This provides persistent URIs that can be redirected as required so that the eventual location can be ephemeral. The software behind such services is freely available so that it can be installed and managed locally if required.

Digital Object Identifiers (DOIs) offer a similar alternative. These identifiers are defined independently of any Web technology but can be appended to a 'URI stub.' DOIs are an important part of the digital infrastructure for research data and and libraries.

How to Test

Check that each dataset in question is identified using a URI that has been assigned under a controlled process as set out in the previous section. Ideally, the relevant Web site includes a description of the process and a credible pledge of persistence should the publisher no longer be able to maintain the URI space themselves.

Evidence

Relevant requirements: R-UniqueIdentifier, R-Citable

Best Practice 11: Assign URIs to dataset versions and series

URIs should be assigned to individual versions of datasets as well as the overall series.

Why

Like documents, many datasets fall into natural series or groups. For example:

  • noon temperature readings in central London 1850 to the present day;
  • today's noon temperature in London;
  • the temperature in London at noon on 3rd June 2015.

In different circumstances, it will be appropriate to refer separately to each of these examples (and many like them).

Intended Outcome

It should be possible to refer to a specific version of a dataset and to concepts such as a 'dataset series' and 'the latest version.'

Possible Approach to Implementation

The W3C provides a good example of how to do this. The (persistent) URI for this document is http://www.w3.org/TR/2015/WD-dwbp-20150224/. The URI for the 'latest version' of this document is http://www.w3.org/TR/dwbp. At the time of publication, these two URIs both resolve to this document. However, when the next version of this document is published, the 'latest version' URI will be changed to point to that.

To complete the London temperature example, one might imagine URIs as follows:

  http://weather.example.com/temperature/UK/London/noon
  http://weather.example.com/temperature/UK/London/noon/today
  http://weather.example.com/temperature/UK/London/noon/2015-06-03  

How to Test

Check that each version of a dataset has its own URI, and that logical groups of datasets are also identifiable.

Evidence

Relevant requirements: R-UniqueIdentifier, R-Citable

9.8 Data Formats

The formats in which data is made available to consumers are a key aspect of making that data usable. The best, most flexible access mechanism in the world is pointless unless it serves data in formats that enable use and reuse. Below we detail best practices in selecting formats for your data, both at the level of files and that of individual fields. W3C encourages use of formats that can be used by the widest possible audience and processed most readily by computing systems. Source formats, such as database dumps or spreadsheets, used to generate the final published format, are out of scope. This document is concerned with what is actually published rather than internal systems used to generate the published data.

Best Practice 12: Use machine-readable standardized data formats

Data must be available in a machine-readable standardized data format that is adequate for its intended or potential use.

Why

As data becomes more ubiquitous, and datasets become larger and more complex, processing by computers becomes ever more crucial. Posting data in a format that is not machine readable places severe limitations on the continuing usefulness of the data. Using non-standard data formats is costly and inefficient, and the data may lose meaning as it is transformed. On the other hand, standardized data formats enable interoperability as well as future uses, such as remixing or visualization, many of which cannot be anticipated when the data is first published.

Intended Outcome

Published data on the Web must be readable and processable by typical computing systems. Any data consumer who wishes to work with the data and is authorized to do so must be able to do so with computational tools typically available in the relevant domain.

Possible Approach to Implementation

Consider which data formats potential users of the data are most likely to have the necessary tools to parse. Formats suggestion are shown in the . Standard data formats as well as the use of standard data vocabularies will better enable machines to process the data.

to be done

How to Test

Check that the data format conforms to a known machine-readable data format specification in current use among anticipated data users.

Evidence

Relevant requirements: R-FormatMachineRead, R-FormatStandardized

Best Practice 13: Use non-proprietary data formats

Data should be available in a nonproprietary data format.

Why

Non-proprietary data formats are usable by anyone. Proprietary data formats may be difficult or impractical for some data users to view or parse. Thus, the use of open data formats increases the possibilities for use and re-use of data.

Intended Outcome

It should be possible for any person who wants to use or re-use the data to do so without investment in proprietary software.

Possible Approach to Implementation

Make data available in open data formats including but not limited to CSV, XML, Turtle, NetCDF, JSON and RDF.

to be done

How to Test

Check if it is possible to read, process, and store the data without using any proprietary software package.

Evidence

Relevant requirements: R-FormatOpen

Best Practice 14: Provide data in multiple formats

Data should be available in multiple data formats.

Why

Providing data in more than one format reduces costs incurred in data transformation. It also minimizes the possibility of introducing errors in the process of transformation. If many users need to transform the data into a specific data format, publishing the data in that format from the beginning saves time and money and prevents errors many times over. Lastly it increases the number of tools and applications that can process the data.

Intended Outcome

It should be possible for data consumers to work with the data without transforming it.

Possible Approach to Implementation

Consider the data formats most likely to be needed by intended users, and consider alternatives that are likely to be useful in the future. Data publishers must balance the effort required to make the data available in many formats, but providing at least one alternative will greatly increase the usability of the data.

to be done

How to Test

Check that the complete dataset is available in more than one data format.

Evidence

Relevant requirements: R-FormatMultiple

9.9 Data Vocabularies

Issue 9
There is a discussion going on in the group if the creation (and publication) of vocabularies is in the scope of the DWBP document.
Issue 10
The section needs terminological discussion on whether we keep "vocabularies", which could be replaced by "data models" or "schemas" and whether we should remove "controlled vocabularies" from the picture. Issue-134
Issue 11
A big part of the section (starting by the section name) is biased towards linked data technology. It should be completed with other references and alternative implementation approaches. Issue-144

Data is often represented in a structured and controlled way, making reference to a range of vocabularies, for example, by defining types of nodes and links in a data graph or types of values for columns in a table, such as the subject of a book, or a relationship “knows” between two persons. Additionally, the values used may come from a limited set of pre-existing values or resources: for example object types, roles of a person, countries in a geographic area, or possible subjects for books. Such vocabularies ensure a level of control, standardization and interoperability in the data. They can also serve to improve the usability of datasets. Say, a dataset contains a reference to a concept described in several languages. Such reference allows applications to localize their display of their search depending on the language of the user.

According to W3C, vocabularies define the concepts and relationships (also referred to as “terms”) used to describe and represent an area of concern. Vocabularies are used to classify the terms that can be used in a particular application, characterize possible relationships, and define possible constraints on using those terms. Several categories of vocabularies have been coined, for example, ontology, controlled vocabularies, thesaurus, taxonomy, semantic network.

There is no strict division between the artifacts referred to by these names. “Ontology” tends however to denote the vocabularies of classes and properties that structure the descriptions of resources in (linked) datasets. In relational databases, these correspond to the names of tables and columns; in XML, they correspond to the elements defined by an XML Schema. Ontologies are the key building blocks for inference techniques on the Semantic Web. The first means offered by W3C for creating ontologies is the RDF Schema [RDF-SCHEMA] language. It is possible to define more expressive ontologies with additional axioms using languages such as those in The Web Ontology Language [OWL2-OVERVIEW].

On the other hand, “controlled vocabularies”, “concept schemes”, “knowledge organization systems” enumerate and define resources that can be employed in the descriptions made with the former kind of vocabulary. A concept from a thesaurus, say, “architecture”, will for example be used in the subject field for a book description (where “subject” has been defined in an ontology for books). For defining the terms in these vocabularies, complex formalisms are most often not needed. Simpler models have thus been proposed to represent and exchange them, such as the ISO 25964 data model [ISO-25964] or W3C's Simple Knowledge Organization System [SKOS-PRIMER].

Best Practice 15: Use standardized terms

Standardized terms should be used to provide metadata

Why

The need for standardized terms for describing metadata is to avoid as much as possible ambiguity and clashes in the terms chosen for metadata information. The key reason is to be able to refer to the standardized body/organization which defines the term as a clear reference.

Intended Outcome

The benefit of using standardized terms is to enable interoperability and consensus among data publishers and consumers.

Possible Approach to Implementation

An approach to implementation is the case of a vocabulary developed within a Working Group or a standardized body such as the W3C.

The Open Geospatial Consortium (OGC) could define the notion of granularity for geospatial datasets, while [DCAT] vocabulary provides a vocabulary reusing the same notion applied to catalogs on the Web.

How to Test

Check that the terms to be used are defined in a standard organization/working group of body such as IETF, OGC, W3C, etc.

Evidence

Relevant requirements: R-MetadataStandardized

Best Practice 16: Document vocabularies

Vocabularies should be clearly documented.

Why

Documentation defines what is within the vocabulary and the better the documentation the higher the possibility of re-use the vocabulary and the datasets built with it.

Intended Outcome

The description of the vocabulary must be human-readable.

Possible Approach to Implementation

A vocabulary may be published together with human-readable Web pages, as detailed in the recipes for serving vocabularies with HTML documents in the Best Practice Recipes for Publishing RDF Vocabularies [SWBP-VOCAB-PUB]. Elements from the vocabulary are defined with attributes containing human-understandable labels and definitions, such as rdfs:label, rdfs:comment, dc:description, skos:prefLabel, skos:altLabel, skos:note, skos:definition, skos:example, etc.. Documentation may benefit from the additional presence of visual documentation such as the UML-style diagram of the W3C Organization Ontology [ORG]

How to Test

Check that a human user can understand the documentation associated with a vocabulary.

Evidence

Relevant requirements: R-VocabDocum

Best Practice 17: Share vocabularies in an open way

Vocabularies should be shared in an open way

Why

Sharing vocabularies in an open way may increase the usage of a data vocabulary and help to understand the relationships among different vocabularies.

Intended Outcome

The vocabulary should be available for data consumers to use or re-use it.

Possible Approach to Implementation

Provide the vocabulary under an open license such as Creative Commons Attribution License CC-BY [CC-ABOUT]. Create entries for the vocabulary in repositories such as LOV, Prefix.cc, Bioportal and the European Commission's Joinup.

How to Test

Check that an open license is available looking for URL or link to the document where the copyright is provided.

Evidence

Relevant requirements: R-VocabOpen

Best Practice 18: Vocabulary versioning

Vocabularies should include versioning information

Why

Versioning information guarantees compatibility over time by providing a way to compare different versions as the vocabulary evolves.

Intended Outcome

It should be possible to identify changes to a vocabulary over time.

Possible Approach to Implementation

A vocabulary may be given a unique identifier for 'the latest version' that remains stable over time, even as the vocabulary evolves. In addition, each version of the vocabulary has its own unique identifier. URI versioning for W3C documents provides examples. The latest version of this document is always found at http://www.w3.org/TR/dwbp/ but individual versions such as http://www.w3.org/TR/2015/WD-dwbp-20150224/ each have their own URL as well so that an initial effort can be made towards understanding, characterizing and tracking data evolution and specific versions pointed to if required.

Several vocabularies, including OWL [OWL2-OVERVIEW] and schema.org [SCHEMA-ORG], include properties for version numbers.

How to Test

Different versions of a vocabulary can be easily identified;

Evidence

Relevant requirements:R-VocabVersion

Best Practice 19: Re-use vocabularies

Existing reference vocabularies should be re-used where possible

Why

re-using vocabularies increases interoperability and reduces redundancies between vocabularies, encouraging re-use of the data.

Intended Outcome

Datasets (and vocabularies) should re-use core vocabularies.

Possible Approach to Implementation

The Standard Vocabularies section of the W3C Best Practices for Publishing Linked Data [LD-BP] provides guidance on the discovery, evaluation and selection of existing vocabularies.

How to Test

Check that terms used do not replicate those defined by vocabularies in common use within the same domain.

Evidence

Relevant requirements: R-VocabReference

Best Practice 20: Choose the right formalization level

When creating or re-using a vocabulary for an application, a data publisher should opt for a level of formal semantics that fit data and applications.

Why

Formal semantics may help one to establish precise specifications that support establishing the intended meaning of the vocabulary and the performance of complex tasks such as reasoning. On the other hand, complex vocabularies require more effort to produce and understand, which could hamper their re-use, as well as the comparison and linking of datasets exploiting them. Highly formalized data is also harder to exploit by inference engines: for example, using an OWL class in a position where a SKOS concept is enough, or using OWL classes with complex OWL axioms raises the formal complexity of the data according to the OWL Profiles [OWL2-PROFILES]. Data producers should therefore seek to identify the right level of formalization for particular domains, audiences and tasks, and maybe offer different formalization levels when one size does not fit all.

Intended Outcome

The data supports all application cases but should not be more complex to produce and re-use than necessary;

Possible Approach to Implementation

Identify the "role" played by the vocabulary for the datasets, say, providing classes and properties used to type resources and provide the predicates for RDF statements, or elements in an XML Schema, as opposed to providing simple concepts or codes that are used for representing attributes of the resources described in a dataset. When simpler models are enough to convey the necessary semantics, represent vocabularies using them. For instance, for Linked Data, SKOS may be preferred for simple vocabularies as opposed to formal ontology languages like OWL; see for example how concept schemes and code lists are used in the RDF Data Cube Recommendation [QB].

How to Test

For formal knowledge representation languages, applying an inference engine on top of the data that uses a given vocabulary does not produce too many statements that are unnecessary for target applications.

Evidence

Relevant requirements: R-VocabReference, R-VocabDocum, R-QualityComparable

Issue 12
The best practice on formalization above (especially sections "Intended outcome" and "How to test") should be re-written in a more technology-neutral way. Issue-144

9.10 Sensitive Data

Sensitive data is any designated data or metadata that is used in limited ways and/or intended for limited audiences. Sensitive data may include personal data, corporate or government data, and mishandling of published sensitive data may lead to damages to individuals or organizations.

To support best practices for publishing sensitive data, data publishers should identify all sensitive data, assess the exposure risk, determine the intended usage, data user audience and any related usage policies, obtain appropriate approval, and determine the appropriate security measures needed to taken to protect the data. Appropriate security measures should also account for secure authentication and use of HTTPS.

At times, because of sharing policies sensitive data may not be available in part or in its entirety. Data unavailability represents gaps that may affect the overall analysis of datasets. To account for unavailable data, data publishers should publish information about unavoidable data gaps.

Best Practice 21: Preserve people's right to privacy

Data must not infringe a person's right to privacy.

Why

Data publishers should preserve the privacy of individuals where the release of personal information would endanger safety (unintended accidents) or security (deliberate attack). Privacy information might include: full name, home address, mail address, national identification number, IP address (in some cases), vehicle registration plate number, driver's license number, face, fingerprints, or handwriting, credit card numbers, digital identity, date of birth, birthplace, genetic information, telephone number, login name, screen name, nickname, health records etc.

Data publishers should identify all personal data, assess the exposure risk, determine the intended usage, data user audience and any related usage policies, obtain appropriate approval, and determine the appropriate security measures needed to taken to protect the data including secure authentication and use of HTTPS for data transmission.

Intended Outcome

Data that can identify an individual person must not be published without their consent.

Possible Approach to Implementation

The data publisher should establish a security plan for publishing data and metadata. The plan should include preparatory steps to ensure personal data is protected or removed prior to publication. All steps need to be followed prior to publication of new data or new data formats particularly binary formats (word processing, spreadsheet etc) that may embed personal metadata in files.

Identify any personal data exposure risks. Write a security plan for publishing data and metadata that includes clear guidelines to follow. Prior to publication put security measures in place and follow them. In preparation to publication review data to ensure compliance.

to be done

How to Test

Write and test a plan for reviewing, curating and vetting data prior to publication.

Evidence

Relevant requirements: R-SensitivePrivacy

Best Practice 22: Provide data unavailability reference

References to data that is not open, or is available under different restrictions to the origin of the reference, should provide context by explaining how or by whom the referred to data can be accessed.

Why

Publishing online documentation about unavailable data due to sensitivity issues provides a means for publishers to explicitly identify knowledge gaps. This provides a contextual explanation for consumer communities thus encouraging use of the data that is available.

Intended Outcome

Publishers should provide information about data that is referred to from the current dataset but that is unavailable or only available under different conditions.

Possible Approach to Implementation

Data publishers may publish an HTML document that gives a human-readable explanation for data unavailability. RDF may be used to provide a machine readable version of the same information. If appropriate, consider editing the server's 4xx response page(s) to provide the information.

to be done

How to Test

If the dataset includes references to other data that is unavailable, check whether an explanation is available in the metadata and/or description of it.

Evidence

Relevant requirements: R-DataUnavailabilityReference

Issue 13
Should we use SHOULD or MUST on BP for Sensitive Data? Issue-123

9.11 Data Access

Providing easy access to data on the Web enables both humans and machines to take advantage of the benefits of sharing data using the Web infrastructure. By default, the Web offers access using Hypertext Transfer Protocol (HTTP) methods. This provides access to data at an atomic transaction level. However, when data is distributed across multiple files or requires more sophisticated retrieval methods different approaches can be adopted to enable data access, including bulk download and APIs.

One approach is packaging data in bulk using non-proprietary file formats (for example tar files). Using this approach, bulk data is generally pre-processed server side where multiple files or directory trees of files are provided as one downloadable file. When bulk data is being retrieved from non-file system solutions, depending on the data user communities, the data publisher can offer APIs to support a series of retrieval operations representing a single transaction.

For data that is streaming to the Web in “real time” or “near real time”, data publishers should publish data or use APIs to enable immediate access to data, allowing access to critical time sensitive data, such as emergency information, weather forecasting data, or published system metrics. In general, APIs should be available to allow third parties to automatically search and retrieve data published on the Web.

On a further note, it can be observed that data on the Web is essentially about the description of entities identified by a unique, Web-based, identifier (a URI). Once the data is dumped and sent to an institute specialised in digital preservation the link with the Web is broken (de-referencing) but the role of the URI as a unique identifier still remains. In order to increase the usability of preserved dataset dumps it is relevant to maintain a list of these identifiers.

Best Practice 23: Provide bulk download

Data should be available for bulk download.

Why

When web data is distributed across many URLs and logically organized as one container, accessing the data in bulk is useful. Bulk access provides a consistent means to handle the data as one container. Without it, individually accessing data is cumbersome leading to inconsistent approaches to handling the container.

Intended Outcome

It should be possible to download data on the Web in bulk. Data publishers should provide a way either through bulk file formats or APIs for consumers to access this type of data.

Possible Approach to Implementation

Depending on the nature of the data and consumer needs possible approaches could include:

  • Preprocessing a copy of the data in compressed archive format where the data more easily accessible as one URL. This is particularly useful for handling data that changes infrequently or on a scheduled basis.
  • Hosting an API such as a REST or SOAP service that dynamically retrieves individual data and returns a bulk container. This approach is useful when for capturing a snapshot of the data. The API can also be useful for consumers to customize what they want included or excluded.
  • Hosting a database, web page, or SPARQL endpoint that contains discoverable metadata [VOCAB-DCAT] describing the container and data URLs associated with the container.

to be done

How to Test

Humans can retreive copies of preprocessed bulk data through existing tools such as a browser. Clients can test bulk access through an API or queries to web resources with discoverable metadata about the bulk data.

Evidence

Relevant requirements: R-AccessBulk

Best Practice 24: Follow REST principles when designing APIs

APIs for accessing data should follow REST architectural approaches.

Why

Considering RESTful architectural aspects when designing an APIs can guarantee easier development, use of pre-existing infrastructure (the Web), a shorter learning curve for developers that want to build applications that access data. It also assures sustainability as "the technologies that make up this foundation include the Hypertext Transfer Protocol (HTTP), Uniform Resource Identifier (URI), markup languages such as HTML and XML, and Web-friendly formats" [RICHARDSON]. Furthermore, it can mitigate the use of specific clients or the need of UDDI.

APIs are frequently constructed over different approaches, such as SOAP. For data on the Web context, the architecture of the Web itself described at the documentation of REST architectural style offers the same entry for humans and machines to access data. If humans already have access to data in URLs, it can be also structured for offering multiple representations for formats and use content negotiation between applications easily.

Intended Outcome

  • It should be possible for machines to access data in a variety of formats from the same URI through content negotiation.
  • It should be possible for data consumers to access data using browser as a client.

Possible Approach to Implementation

Design always RESTful APIs using HTTP and good pragmatic REST principles. There is no unique agreed set of principles for REST APIs, some are implicitly defined by the HTTP standard and others have emerged on a consensus base or even are still under discussion. The following are a set of rules widely adopted so far:

  • Use hierarchical, readable and technology agnostic Uniform Resource Identifiers (URIs) to address resources in a consisten way.
  • Use the URI path to convey your Resources and Collections model.
  • Use nouns but no verbs (except for Controllers that does not involve resources). Use HTTP verbs instead to operate on the Collections and Resources.
  • Use standard HTTP methods accordingly to their expected default behavior. GET method and query parameters should not alter the state.
  • Use HTTP headers to provide metadata and for the serialization of data formats. Support multiple formats.
  • Use HTTP status codes (including error codes) accordingly to their original purpose.
  • Simplify associations. Use query parameters to hide complexity and provide filtering, sorting, field selection and paging for collections.
  • Version your API. Never release an API without a version and make the version mandatory.

to be done

How to Test

Use API testing tools to compare benefits of implementing RESTful design.

Evidence

Relevant requirements: R-AccessBulk, R-APIDocumented

Best Practice 25: Provide real-time access

When data is produced in real-time, it should be available on the Web in real-time.

Why

The presence of real-time data on the web enables access to critical time sensitive data, and encourages the development of real-time web applications. Real-time access is dependent on real-time data producers making their data readily available to the data publisher. The necessity of providing real-time access for a given application will need to be evaluated on a case by case basis considering refresh rates, latency introduced by data post processing steps, infrastructure availability, and the data needed by consumers. In addition to making data accessible, data publishers may provide additional information describing data gaps, data errors and anomolies, and publication delays.

Intended Outcome

Data should be available at real time or near real time, where real-time means a range from milliseconds to a few seconds after the data creation, and near real time is a predetermined delay for expected data delivery.

Possible Approach to Implementation

Real-time data accessibility may be achieved through two means:

  • Push - as data is produced the producers communicates data to the data publisher either by disseminating data to the publisher or making storage available accessible to the data producer.
  • On-Demand (Pull) - available real-time data is made available upon request. In this case, data publishers will provide an API to facilitate these read-only requests.
In addition to data access, to ensure credibility providing access to error conditions, anomolies, and instrument "house keeping" data enhance real-time applications ability to interpret and convey real-time data quality to consumers.

to be done

How to Test

To adequately test real time data access, data will need to be tracked from the time it is initially collected to the time it is published and accessed. [PROV-O] can be used to describe these activities. Caution should be used when analyzing real-time access for systems that consist of multiple computer systems. For example, tests that rely on wall clock time stamps may reflect inconsistences between the individual computer systems as opposed to data publication time latency.

Evidence

Relevant requirements: R-AccessRealTime

Best Practice 26: Provide data up to date

Data must be available in an up-to-date manner and the update frequency made explicit.

Why

Data on the Web availability should closely coincide with data provided at creation time, collection time, or after it has been processed or changed. Carefully synchronizing data publication to the update frequency encourages data consumer confidence and re-use.

Intended Outcome

When new data is provided or data is updated, it must be published to coincide with the data changes.

Possible Approach to Implementation

Implement an API to enable data access. When data is provided by bulk access, new files with new data should be provided as soon as additional data is created or updated.

to be done

How to Test

Write test standard operating procedure for data publisher to keep test data on Web site up to date.

Following standard operating procedure:

  • Write test client to access published data.
  • Access data and save first copy locally.
  • Publish an updated version of data.
  • Access data and save second copy locally.
  • Compare first copy to second copy to verify change.

Evidence

Relevant requirements: R-AccessUptodate

Issue 14

To debate if the goal should be to adhere to a published schedule for updates. Issue-195

Best Practice 27: Maintain separate versions for a data API

If data is made available through an API, the API itself should be versioned separately from the data. Old versions should continue to be available.

Why

Developers need to be made aware of changes to an API so that they can update their code to use it. When an API is changed, as opposed to when the data it makes available is changed, releasing it as a new version makes it possible to gracefully transition from the old version to the new one. Keeping the older versions available avoids breaking applications that cannot be updated.

Intended Outcome

It should be possible for developers to transition easily from one version of the API to another. Applications that are impractical to transition should continue to work. The API version should not be updated when data versions are updated, only when the API itself changes, and that should be infrequent.

Possible Approach to Implementation

Release updates to your API under a slightly different base URI so that older versions remain available under the previous base URI. For example, http://myapi.org/v1/dogs/alfred retrieves the older version of data about a dog named Alfred, and http://myapi.org/v2/dogs/alfred retrieves the newer version of data about Alfred. Keeping the version number as far to the left as possible in the API call allows developers to switch to the newer version with the least effort.

to be done

How to Test

Existing calls to the API should continue to work when the API is updated. New calls to a slightly different base URI should retrieve data according to the new rules.

Evidence

Relevant requirements: R-DataVersion

9.12 Data Preservation

This section describes best practices related to data preservation. Albeit being a closely related topic archiving is considered out of scope for this group and therefore not covered here.

Best Practice 28: Assess dataset coverage

The coverage of a dataset should be assessed prior to its preservation

Why

A chunk of Web data is by definition dependent on the rest of the global graph. This global context influences the meaning of the description of the resources found in the dataset. Ideally, the preservation of a particular dataset would involve preserving all its context. That is the entire Web of Data.

At ingestion time an evaluation of the linkage of Web data dataset dump to already preserved resources is assessed. The presence of all the vocabularies and target resources in uses is sought in a set of digital archives taking care of preserving Web data. Datasets for which very few of the vocabularies used and/or resources pointed out are already preserved somewhere should be flagged as being at risk.

Intended Outcome

It should be done an evaluation of the preservation coverage for a given dataset.

Possible Approach to Implementation

The assessement could be performed by the digital preservation institute or the dataset depositor. It essentially consists in checking whether all the resources used are either already preserved somewhere or provided along with the new dataset considered for preservation.

to be done

How to Test

Datasets making references to portions of the Web of Data which are not preserved should receive a lower score than those using common resources.

Evidence

Relevant requirements:R-VocabReference

Best Practice 29: Use a trusted serialisation format for preserved data dumps

Data depositors willing to send a datadump for long term preservation must use a well established serialisation

Why

Web data is a abtract data model that can be expressed in different ways (RDF, JSON-LD, ...). Using a well established serialisation of this data increases its chances of re-use.

Institute doing digital preservation are tasked with monitoring file format obsolescence. Datasets which have been acquired in some format some years ago may have to be converted into another format in order to still be usable with more modern software (see [ROSENTHAL]). This tasks can be made more challenge, or even impossible, if non standard serialisation formats are used by data depositors.

Intended Outcome

It should be possible to read and load the dataset into a database even its software is no longer supported.

Possible Approach to Implementation

Give preference to Web data serialisation formats available as open standards. For instance those provided by the W3C [FORMATS].

to be done

How to Test

Try to dereference the URI of the data dump with Content-Type header according to the format you expect to get, using for example [cURL]

Evidence

Relevant requirements:R-FormatStandardized

Best Practice 30: Update the status of identifiers

Preserved datasets should be linked with their "live" counterparts

Why

URI dereferencing is a primary interface to data on the Web. Linking preserved datasets with the original URI inform the data consumer of the status of these resources.

During its life cycle a dataset may undergo several modifications. Although URIs assigned to things are not expected to change, the description of these resource will evolve over time. During this evolution, several snapshots could be made available for preservation and access as versions.

Intended Outcome

A link is maintained between the URI of a resource, the most up-to-date description available for it, and preserved descriptions. If the resource does not exist any more the description should say so and refer to the last preserved description that was available.

Possible Approach to Implementation

There is a variety of HTTP status codes that could be put into use to relate the URI with its preserved description. In particular, 200, 410 and 303 can be used for different scenarios:

  • 200 => there is a new description which contains pointers to archived description
  • 410 => the resource is no longer available but it has been removed under a controlled process cf. 404 which simply states that something is not available.
  • 303 => the resource identified by this URI is no longer served here but there is a preserved description at a different location.

In addition to the status codes, HTTP Link headers can also be used to relate resources to preserved descriptions.

to be done

How to Test

Check that de-referencing the URI of a preserved dataset returns information about its current status and availability.

Evidence

Relevant requirements:R-DataUnavailabilityReference, R-PersistentIdentification

9.13 Feedback

Publishing data on the Web enables data sharing on a large scale, providing data access to a wide range of audiences with different levels of expertise. Data publishers want to ensure that the data published is meeting the data consumer needs and user feedback is crucial. Feedback has benefits for both data publishers and data consumers, helping data publishers to improve the integrity of their published data, as well as to encourage the publication of new data. Feedback allows data consumers to have a voice describing usage experiences (e.g. applications using data), preferences and needs. When possible, feedback should also be publicly available for other data consumers to examine. Making feedback publicly available allows users to become aware of other data consumers, supports a collaborative environment, and allows user community experiences, concerns or questions are currently being addressed.

From a user interface perspective there are different ways to gather feedback from data consumers, including site registration, contact forms, quality ratings selection, surveys and comment boxes for blogging. From a machine perspective the data publisher can also record metrics on data usage or information about specific applications consumers are currently relying upon. Feedback such as this establishes a line of communication channel between data publishers and data consumers. In order to quantify and analyze usage feedback, it should be recorded in a machine-readable format. Blogs and other publicly available feedback should be displayed in a human-readable form through the user interface.

This section provides some BP to be followed by data publishers in order to enable data consumers to provide feedback about the consumed data. This feedback can be for humans or machines.

Best Practice 31: Gather feedback from data consumers

Data publishers should provide a means for consumers to offer feedback.

Why

Providing feedback contributes to improving the quality of published data, may encourage publication of new data, helps data publishers understand data consumers needs better and, when feedback is made publicly available, enhances the consumers' collaborative experience.

Intended Outcome

It should be possible for data consumers to provide feedback and rate data in both human and machine-readable formats. The feedback should be Web accessible and it should provide a URL reference to the corresponding dataset.

Possible Approach to Implementation

Provide data consumers with one or more feedback mechanisms including, but not limited to: a registration form, contact form, point and click data quality rating buttons, or a comment box for blogging.

Collect feedback in machine-readable formats to represent the feedback and use a vocabulary to capture the semantics of the feedback information.

to be done

How to Test

  • Demonstrate how feedback can be collected from data consumers.
  • Verify that the feedback is persistently stored. If the feedback is made publicly available verify that a URL links back to the published data being referenced.
  • Check that the feedback format conforms to a known machine-readable format specification in current use among anticipated data users.

Evidence

Relevant requirements: R-UsageFeedback, R-QualityOpinions

Best Practice 32: Provide information about feedback

Information about feedback should be provided.

Why

Sharing information about feedback allows data consumers to be aware of feedback given by other consumers.

Intended Outcome

It should be possible for humans to have access to information that describes feedback on a dataset given by one or more data consumers.

It should be possible for machines to automatically process feedback information about a dataset.

Possible Approach to Implementation

The machine readable version of the feedback metadata may be provided according to the vocabulary that is being developed by the DWBP working group , i.e., the Dataset Usage Vocabulary.

to be done

How to Test

  • Check that the metadata for the dataset itself includes feedback information about the dataset.
  • Check if a computer application can automatically process feedback information about the dataset.

Evidence

Relevant requirements: R-UsageFeedback, R-QualityOpinions

9.14 Data Enrichment

Issue 15

To discuss about enrichment yields derived data, not just metadata. For example, you could take a dataset of scheduled and real bus arrival times and enrich it by adding on-time arrival percentages. The percentages are data, not metadata. Issue-196

Issue 16

To discuss about the meaning of the word “topification”. Issue-196

Data enrichment refers to a set of processes that can be used to enhance, refine or otherwise improve raw or previously processed data. This idea and other similar concepts contribute to making data a valuable asset for almost any modern business or enterprise. It also shows the common imperative of proactively using this data in various ways.

This section provides some advice to be followed by data publishers in order to enable data consumers to enrich data.

Best Practice 33: Enrich data by generating new metadata.

Data should be enriched whenever possible, generating richer metadata to represent and describe it.

Why

There is a large number of intelligent techniques that can be used to enrich raw or previously treated data and to extract new metadata from it, making data an even more valuable asset. These methods include those focused on data categorization, entity recognition, sentiment analysis, topification, among others. Providing new and richer metadata may help data consumers to better understand the data they are dealing with.

Intended Outcome

Describe a dataset using richer sets of metadata, which can be readable by humans.

Possible Approach to Implementation

The implementation depends on what types of metadata should be produced. They require the implementation of methods for data categorization, disambiguation, sentiment analysis, among others, according to the suggestions described in Data Enrichment Technical Note. After new metadata is extracted, it can be provided as part of an HTML Web page or any open data format.

How to test

Check whether the metadata being extracted by the techniques are in accordance with human-knowledge and can be readable by humans.

Evidence

Relevant requirements: R-DataEnrichment

10. Conclusions

A. Acknowledgements

The editors gratefully acknowledge the contributions made to this document by all members of the working group and the chairs: Hadley Beeman, Steve Adler, Yaso Córdova, Deirdre Lee.

B. References

B.1 Normative references

[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119

B.2 Informative references

[BNF]
Bibliothèque nationale de France. Reference information about authors, works, topics. URL: http://data.bnf.fr/
[CC-ABOUT]
Creative Commons: About Licenses URL: http://creativecommons.org/about/licenses/
[CC-VOCAB]
Creative Commons Rights Expression Language. URL: http://creativecommons.org/ns
[CSV]
Y. Shafranovich. Common Format and MIME Type for Comma-Separated Values (CSV) Files. October 2005. RFC 4180. URL: https://www.ietf.org/rfc/rfc4180.txt
[DC-TERMS]
Dublin Core Metadata Initiative. Dublin Core Metadata Initiative Terms, version 1.1. 11 October 2010. DCMI Recommendation. URL: http://dublincore.org/documents/2010/10/11/dcmi-terms/.
[DCAT]
Fadi Maali; John Erickson. Data Catalog Vocabulary (DCAT). 16 January 2014. W3C Recommendation. URL: http://www.w3.org/TR/vocab-dcat/
[FORMATS]
Ivan Herman. Unique URIs for File Formats. URL: http://www.w3.org/ns/formats/
[HCLS]
Alasdair J.G. Gray; Joachim Baran; M. Scott Marshall; Michel Dumontier. Dataset Descriptions: HCLS Community Profile. URL: http://www.w3.org/TR/vocab-dcat/
[HTML-RDFA]
Manu Sporny. HTML+RDFa 1.1 - Second Edition. 17 March 2015. W3C Recommendation. URL: http://www.w3.org/TR/html-rdfa/
[ISO-25964]
Stella Dextre Clarke et al. ISO 25964 – the international standard for thesauri and interoperability with other vocabularies. URL: http://www.niso.org/schemas/iso25964/
[JSON]
D. Crockford. The application/json Media Type for JavaScript Object Notation (JSON). July 2006. Informational. URL: https://tools.ietf.org/html/rfc4627
[JSON-LD]
Manu Sporny; Gregg Kellogg; Markus Lanthaler. JSON-LD 1.0. 16 January 2014. W3C Recommendation. URL: http://www.w3.org/TR/json-ld/
[LD-BP]
Bernadette Hyland; Ghislain Auguste Atemezing; Boris Villazón-Terrazas. Best Practices for Publishing Linked Data. 9 January 2014. W3C Note. URL: http://www.w3.org/TR/ld-bp/
[LODC]
Max Schmachtenberg; Christian Bizer; Anja Jentzsch; Richard Cyganiak. The Linking Open Data Cloud Diagram. URL: http://lod-cloud.net/
[Lexvo]
Lexvo.org. URL: http://www.lexvo.org/
[Microdata]
Ian Hickson. HTML Microdata. 29 October 2013. W3C Note. URL: http://www.w3.org/TR/microdata/
[Navathe]
Ramez Elmasri; Shamkant B. Navathe. Fundamentals of Database Systems. 2010.
[ODRL]
Renato Iannella; Susanne Guth; Daniel Paehler; Andreas Kasten. ODRL Version 2.0 Core Model. 24 April 2012. W3C Community Group Specification. URL: http://www.w3.org/community/odrl/two/model/
[ODRS]
Leigh Dodds. Open Data Rights Statement Vocabulary. 29 July 2013. URL: http://schema.theodi.org/odrs/
[OKFN-INDEX]
Open Knowledge Foundation. Global Open Data Index. URL: http://index.okfn.org/
[ORG]
Dave Reynolds. The Organization Ontology. 16 January 2014. W3C Recommendation. URL: http://www.w3.org/TR/vocab-org/
[OWL2-OVERVIEW]
W3C OWL Working Group. OWL 2 Web Ontology Language Document Overview (Second Edition). 11 December 2012. W3C Recommendation. URL: http://www.w3.org/TR/owl2-overview/
[OWL2-PROFILES]
Boris Motik; Bernardo Cuenca Grau; Ian Horrocks; Zhe Wu; Achille Fokoue. OWL 2 Web Ontology Language Profiles (Second Edition). 11 December 2012. W3C Recommendation. URL: http://www.w3.org/TR/owl2-profiles/
[OWL2-QUICK-REFERENCE]
Jie Bao; Elisa Kendall; Deborah McGuinness; Peter Patel-Schneider. OWL 2 Web Ontology Language Quick Reference Guide (Second Edition). 11 December 2012. W3C Recommendation. URL: http://www.w3.org/TR/owl2-quick-reference/
[PROV-O]
Timothy Lebo; Satya Sahoo; Deborah McGuinness. PROV-O: The PROV Ontology. 30 April 2013. W3C Recommendation. URL: http://www.w3.org/TR/prov-o/
[QB]
Richard Cyganiak; Dave Reynolds. The RDF Data Cube Vocabulary. 16 January 2014. W3C Recommendation. URL: http://www.w3.org/TR/vocab-data-cube/
[RDA]
Research Data Alliance. URL: http://rd-alliance.org
[RDF-SCHEMA]
Dan Brickley; Ramanathan Guha. RDF Schema 1.1. 25 February 2014. W3C Recommendation. URL: http://www.w3.org/TR/rdf-schema/
[RICHARDSON]
Leonard Richardson; Sam Ruby. RESTful Web Services: Web services for the real world. 2007. O'Reilly Media.
[ROSENTHAL]
David Rosenthal; Thomas Lipkis; Thomas Robertson; Seth Morabito. Transparent Format Migration of Preserved Web Content. 2004. DLib Magazine.
[SCHEMA-ORG]
Schema.org. URL: http://schema.org/
[SKOS-PRIMER]
Antoine Isaac; Ed Summers. SKOS Simple Knowledge Organization System Primer. 18 August 2009. W3C Note. URL: http://www.w3.org/TR/skos-primer
[SWBP-VOCAB-PUB]
Diego Berrueta; Jon Phipps. Best Practice Recipes for Publishing RDF Vocabularies. 28 August 2008. W3C Note. URL: http://www.w3.org/TR/swbp-vocab-pub/
[SchemaVer]
Alex Dean. Introducing SchemaVer for semantic versioning of schemas. 2014. URL: http://snowplowanalytics.com/blog/2014/05/13/introducing-schemaver-for-semantic-versioning-of-schemas/
[TURTLE]
Eric Prud'hommeaux; Gavin Carothers. RDF 1.1 Turtle. 25 February 2014. W3C Recommendation. URL: http://www.w3.org/TR/turtle/
[UCR]
Deirdre Lee; Bernadette Farias Lóscio; Phil Archer. Data on the Web Best Practices Use Cases & Requirements. Note. URL: http://www.w3.org/TR/dwbp-ucr/
[VOCAB-DCAT]
Fadi Maali; John Erickson. Data Catalog Vocabulary (DCAT). 16 January 2014. W3C Recommendation. URL: http://www.w3.org/TR/vocab-dcat/
[WEBARCH]
Ian Jacobs; Norman Walsh. Architecture of the World Wide Web, Volume One. 15 December 2004. W3C Recommendation. URL: http://www.w3.org/TR/webarch/
[XHTML-VOCAB]
XHTML 2 Working Group. XHTML Vocabulary. 27 October 2010. URL: http://www.w3.org/1999/xhtml/vocab
[cURL]
Daniel Stenberg. cURL, a command line tool and library for transferring data with URL syntax. URL: http://curl.haxx.se/
[ccREL]
Hal Abelson; Ben Adida; Mike Linksvayer; Nathan Yergler. ccREL: The Creative Commons Rights Expression Language. 1 May 2008. W3C Member Submission. URL: http://www.w3.org/Submission/ccREL/