Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,090 of 9,090 pages
About the help in other languages
All help pages

Designing a dataset class

For site builders in a public body who need dataset pages: a content class "Dataset" with a "Distribution" child class, built in Setup > Classes from the datatypes Exponential ships, with identifiers that map to DCAT…

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/government/open-data/designing-a-dataset-class.md

On this page

Designing a dataset class

This page is for website creators and administrators who build the place where a public body publishes its datasets. Exponential ships no dataset class, so you make one in the class editor. The design below uses only datatypes that ship with the kernel, and names its fields after the DCAT 3 terms catalogs use, so a later DCAT export can be written from them. The class editor steps come from Content classes for websites.

Contents

  1. Two classes: dataset and distribution
  2. The Dataset class
  3. The Distribution class
  4. Creating the classes
  5. Decisions to write down
  6. Pitfalls

Two classes: dataset and distribution

DCAT separates a dataset (the collection of data, with its description) from its distributions (each file or format you offer: a CSV, a JSON file, a spreadsheet). The same split works well as content:

ContentClassContainerDCAT term
Data catalog folderFolder (shipped)yesdcat:Catalog
One dataset pageDataset (yours)yesdcat:Dataset
One file below itDistribution (yours), or the shipped File classnodcat:Distribution

Making the dataset a container keeps its files together, so the dataset page can list its children and an RSS export of the catalog folder can follow new datasets.

The Dataset class

Attribute nameIdentifierDatatypeRequiredTranslatableDCAT term
TitletitleText line (ezstring)yesyesdct:title
DescriptiondescriptionRich text (ezxmltext)yesyesdct:description
PublisherpublisherText line, or an object relation to an organization pageyesnodct:publisher
Contact pointcontact_pointE-mail (ezemail) of a team mailbox, never a personyesnodcat:contactPoint
LicenselicenseSelection (ezselection)yesnodct:license
ThemethemeTags (eztags) or Selectionnonodcat:theme
KeywordskeywordsKeywords (ezkeyword)noyesdcat:keyword
IssuedissuedDate (ezdate)yesnodct:issued
ModifiedmodifiedDate (ezdate)nonodct:modified
Update frequencyaccrual_periodicitySelectionnonodct:accrualPeriodicity
Spatial coveragespatialText linenoyesdct:spatial
Temporal coveragetemporalText line, such as "2020-2025"noyesdct:temporal
Conformance or schemaconforms_toURL (ezurl)nonodct:conformsTo

Set the object name pattern to <title>. Mark Title, Description and Keywords Searchable. The contact point is a function mailbox (for example [email protected]) so the page names no individual.

The Distribution class

Attribute nameIdentifierDatatypeDCAT term
TitletitleText linedct:title
FilefileFile (ezbinaryfile)dcat:downloadURL (the download address)
Or: access addressaccess_urlURL, for data served elsewheredcat:accessURL
FormatformatSelection: CSV, JSON, XML, XLSX, GeoJSON ...dct:format
DescriptiondescriptionText block (eztext)dct:description

The shipped File class (file) also works when you do not need a format field: its name and file are enough, and the MIME type of the upload is shown by the file datatype.

Creating the classes

  1. Open Setup > Classes, the group Content, then New class.
  2. Name Dataset, identifier dataset, object name pattern <title>, tick Container.
  3. For each row of the table: choose the datatype under Add attribute, press Add, give the name and the identifier, set Required, Searchable and Translatable as in the table.
  4. For the License selection, enter the licenses your body has approved (see "Licensing datasets").
  5. Press OK. Repeat for distribution.
  6. Allow the classes where they belong: give the data team content/create for the classes dataset and distribution below the catalog folder (Roles and policies).

Decisions to write down

  • Which fields are required: few required fields make drafts easy, but license, publisher and contact point should never be empty on a published dataset.
  • Which fields are translated: titles and descriptions yes; dates, licenses and formats no.
  • Who owns the class: a change to an identifier later breaks every template that reads it.

Pitfalls

  • Removing an attribute deletes its data from every object. Add new fields freely; remove them only after a backup (Content classes for websites).
  • Do not reuse the article class for datasets: the fields differ, and templates and feeds become hard to keep apart.
  • No schema check. The Format field records what the editor chose; Exponential does not inspect the file.

Become an Exponential Partner

Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x