Skip to content
Software Architecture Guide

Use of external and open data

Explanation

Section titled “Explanation”

Many applications need data they do not produce themselves. Public bodies publish some of it for anyone to use. Architects should know such sources exist and plan how the application will reach them.

What makes data open

The Open Definition sets three basic conditions for an open work:

  • Legal status. The work is in the public domain or under an open license. An open license lets anyone reuse the work.
  • Access. The work is available as a whole. It costs no more than a reasonable one-time reproduction fee. Ideally, anyone can download it free over the Internet.
  • Machine-readable. A computer can process the work readily, without manual conversion.

Open government data

Data.gov is the US government’s open data site. US law requires government data to be released in open, machine-readable formats. Open government data is data that public bodies publish under conditions like these.

Finding data across catalogs

Data catalogs list datasets. DCAT is a W3C vocabulary, built on RDF, that helps catalogs on the Web work together. RDF is a W3C way of describing data. Catalogs that use DCAT can describe their datasets in a shared way.

What this means for architecture

An external source is a system outside your control. Show it as an external system in your context view. That view is a diagram of your system and everything it exchanges data with. See the article “Context View” for details. Plan the access path to the source as well.

Example

Section titled “Example”

A city app shows nearby services on a map. The team finds a government portal that offers a free, openly licensed dataset in a machine-readable form. They add the portal to the context diagram as an external system. They also record in the architecture document how the app will obtain the data.

Trade-offs

Section titled “Trade-offs”

The verified facts cover what open data is and where it is published. They do not cover quality, availability, or legal risks of depending on external sources. Check those for each source before you rely on it.

Checks

Section titled “Checks”
  • External data sources the system uses appear as external systems in the context view.
  • For each open data source, the document states its license, or that it is in the public domain.
  • For each open data source, the document states that the data is machine-readable and how it can be obtained.
Section titled “Related”

Sources

Section titled “Sources”