Pre-release. Until the official launch, content may change, including published files.
Skip to content

Source: https://datamodels.jp/en/guide/ · Text CC BY 4.0

Guides ​

What the words on this site mean is in Terms.

Which page do I need? ​

First check whether a catalog model fits your data. If it does not fit as it is, a small change may be enough.

Does a model fit as it is?yesUse a modelUsing the modelsnoOnly the names differ?yesYour own namesaliasesnoNeed a few more attributes?yesAdding attributesan extensionnoNothing fitspublish on your own siteorpropose a model

Use a model ​

  • Tutorial: from a CSV file to a map: one real open-data file converted into a model, step by step. An optional second part loads it into a broker, queries it and shows it on a map.
  • Publishing your list: convert a municipality's CSV list into JSON that follows a model, and publish it as open data next to the CSV.
  • Using the models: validate JSON with the catalog models, send it to an NGSI-LD broker, and use it as linked data.

Adapt a model ​

  • Adding attributes: add attributes of your own to a model without copying it (an extension). The extension builder on the page makes the files in the browser.
  • Your own names: use your own names for attributes and types without changing the model (aliases).

Add to the catalog ​

  • Contributing: how to take part. The forms to propose a model, list an extension or a site, or tell us about another catalog, and what happens next.
  • Rules for models: what the catalog accepts, when to define a new type, the rules, mapping to standards, writing examples, and the stages of a model.

Models outside the catalog ​

  • Your own data models: where to publish a model that does not belong in this catalog: your own site, or Smart Data Models.
  • Your own site (Toolkit): publish your models with fixed URLs on a site of your own, step by step, and convert CSV lists.

Reference ​

  • Standards covered: the standards the models map, such as the municipal standard open datasets or the Essential Elements of Information (EEI), each with its model.
  • Mapping files: which field of a standard matches which attribute of a model. Where to find them and what they say.
  • The normalized form: the key-values and normalized forms of an entity, and the rules to turn one into the other, with an example.
  • URLs and versions: which URL to use, what never changes, versions and deprecation.
  • Other data model catalogs: catalogs of data models in the world and in Japan, worth checking before you propose.
  • Data model sites: the sites that publish their own data models and that datamodels.jp knows, one row each, with the catalog models they build on.

Terms ​

The site uses these words with these meanings:

  • model: which attributes one kind of data (a type) has, and what they mean. Published as an @context, a JSON Schema and examples.
  • entity: one record of data. One evacuation site is one entity.
  • attribute: one item of an entity, such as its name, its location or the hazards it covers.
  • subject: a group of related models with its own namespace and versions, such as disaster or transportation. URLs and commands write it as <subject>.
  • @context: a file that works like a dictionary: it links short names (such as hazardTypes) to IRIs.
  • IRI: a name for a type or an attribute that is unique on the whole web, such as https://datamodels.jp/ns/disaster/hazardTypes.
  • key-values form: plain JSON with attribute names and their values. The JSON Schema validates data in this form (The normalized form).
  • normalized form: the form you send to an NGSI-LD broker. Each attribute also says its kind, such as Property or Relationship (The normalized form).
  • validation: checking that data follows a JSON Schema or similar rules.
  • mapping file: a file that says which field of a standard or of your own list matches which attribute of a model (Mapping files).
  • extension: a small @context you publish to add your own attributes to a catalog model; technically, a profile of the model (Adding attributes). The toolkit's extend command is something else: it makes a new model on your own site that builds on a catalog model.
  • alias: your own name for a catalog type or attribute, with the same meaning (Your own names).
  • version alias: a URL with only the major version, such as v1.jsonld. It points to the latest compatible version (URLs and versions).