Federating data

Federation is a core feature of the data network we are building. Using it is a good way to enrich your own data, and it also gives others a new way to discover and reuse them.

Federation simple schema

Federation allows to redistribute an open dataset from your domain (Opendatasoft instance) or another domain in full or in part. It is a way to collect external sources of data on its own domain.

Source

To federate a dataset, go to the Catalog > Dataset page and hit New dataset. Then, hit the little arrow on the right side of the Add a source button.

../../_images/federation_source.png

There is then a link Add a dataset from the Opendatasoft network. It leads to a console from where it is possible to configure a new federated source.

../../_images/federation_source2.png

Click on Select a source dataset.

../../_images/federation_sources.png

Different sources are available :

  • The same domain

  • All open datasets from every Opendatasoft domains

  • Domain's subdomains (optional)

The next step is to either select a whole dataset or a part of it. The filters are the same as in the dataset explore console; there are pre-defined filters, a query box, and, if available, the geofilter.

../../_images/federation_sources-filter.png

Once the data is selected, the dataset appears in the back office like a normal one, except that there is no Processing tab. Indeed, the data is not duplicated, and it is not possible to transform it. Only the metadata and visualization configuration can be overridden.

../../_images/federation_federated-source.png

Overriding metadata and visualizations

Both metadata and visualization can be overridden. To do so, hit Override and enter the desired value. It is possible to come back to the original value by hitting Return to original value.

../../_images/federation_override.png

Limitations

The federation does not duplicate the data. Only the metadata and visualizations are duplicated; hence they can be overridden. There are two reasons for that:

  • It is then possible to redistribute data without impacting the size of the data defined in the contract,

  • When the data changes, the federated dataset is always up-to-date.

Federation schema

Important

Currently, the metadata of federated datasets are updated every day. However, other modifications on the original dataset (for example, visualizations configurations, dataset schema) will not trigger an automatic update: unpublishing and republishing the federated dataset is necessary for the latest modifications to be visible.