Data Fair

Version 3.88.7

User guide back-office

19 février 2024

1 - Getting started with Data Fair

Data Fair allows to enhance your data and share it internally or in opendata.

Your account allows to access the various features of Data Fair:

It is possible to work alone (personal account) or in a group (organization account).

The Data Fair interface allows to present your data in the form of APIs, data portal and interactive visualizations without any code.

Data Fair pages display various elements:

  1. The navigation bar allows you to access the different sections
  2. The breadcrumb trail allows you to know the section or sub-section displayed and to navigate in them.
  3. Page content
  4. Notifications of the account and the menu of the account

On the Home page, the available actions allow to initiate simplified paths to create, update or publish a dataset.

Navigation The Data Fair interface allows to quickly access your resources

The menu allows to change the active account and access the Notifications and Storage pages of the account.

Menu
The menu is available at the top right

In the image above, the active account is the Koumoul account. It is possible to switch accounts to your personal account.

My account

The My account page provides access to your personal account information such as your registration email, your avatar, the first name, last name and birthday entered.
You can renew your password in this section.

The My Organizations section displays a summary of the organizations you are a member.

It is also possible to delete your personal account.

Compte
Manage your personnal account

Notifications

The notifications page allows to configure various email or browser alerts you will receive.

Notifications
Select the notifications you want to receive

When a notification is triggered, a colored dot is present on the bell at the top right of Data Fair.
The bell display the summary of the alerts sent.

Storage

The storage page presents a summary of the datasets in your account.
Statistics of account are available such as number of datasets, total space consumed, total space available, and number of views.

3 - Dashboard

The Home Page of your active account is accessible using the navigation bar.

Depending on your rights in the organization, this page displays the Contribute and Manage datasets sections.

Contribute allows you to create, update and publish a dataset on your portals.

Manage allows you to validate the publications, to visualize the number of datasets in error and the number of datasets in draft.
This section is only available to administrators.

When you click on one of the 3 actions, you are redirected to the filtered datasets page.

Dashboard
Organization dashboard

4 - Datasets

On Data Fair, a dataset corresponds to an uploaded file or an editable or virutal source whith metadata filled in.

By default, all uploaded data is private on your account.
You can work with your team using an organization account.

Metadata

Metadata is the data characterizing your dataset, such as size, format, modification date, etc.
The title, description, provenance, license are metadata that you can modify in the edition page of a dataset.
With metadata your datasets are easier to find and to identify.

Concepts

On the dataset edition page, you will find the Schema section which allows to view the model of your data. The schema of a dataset corresponds to its architecture (all the columns). In this section you can fill in concepts. When you fill in a concept on a column, you associate a known elements of Data Fair to this column. This makes your data more meaningful for Data Fair.

Concepts are used in various functions, in some cases, they are essential. For example, if you want to project your data onto a map, the Latitude / Longitude or Geometry concepts must be present on your schema.

4.1 - Supported file formats

The following table shows the file formats supported by Data Fair:

Type Description Format Archived format (zip)
CSV Tabular data file format as comma separated values .csv -
TSV Open format of text representing tabular data as tab-separated values .tsv -
OpenDocument Open data file format for office applications .ods, .fods -
XLSX Office Open XML Spreadsheet File Format .xlsx -
XLS Excel spreadsheet file formatl .xls -
DBF Format de fichier de base de données DBase .dbf -
TXT Format de fichier texte qui ne contient qu'une suite de caractères .txt -
DIF Format de fichier texte de données ASCII .dif -
GeoJSON Format de de fichier de données géospatiales simples utilisant la norme JSON .geojson -
KML/KMZ Format destiné à la gestion de l'affichage de données géospatiales basé sur le formalise XML .kml, .kmz -
GPX Format de fichier permettant l'échange de coordonnées GPS .gpx ou .xml -
ESRI Shapefile Format de fichier pour les systèmes d'informations géographiques - .shp, .dbf et .shx (.prj optionel)

At this time, only Shapefile data can be contained in a .zip file.
Contact us if you have a compatibility issue or if you need a new format.

4.2 - Import a dataset

You can create a dataset on the dashbord or on the datasets pages.

Three differents datasets on Data Fair.

  1. Upload a file from your computer
  2. An editable dataset
  3. Metadata dataset
  4. A virtual dataset

Upload a file

You can import files using any Create a dataset action buttons on Data Fair.
The upload file process contains a list of the formats supported by Data fair. It is possible to add attachments in a zip archive to link it to the rows of the dataset.

Once the file is loaded, you are redirected to the dataset edit page. Data Fair continues processing the file on the dataset edit page.

Six have to be validated to use your dataset :

  1. Loading
  2. Conversion to a format used by the platform internally.
  3. Analysis, which will determine the schema of the dataset.
  4. Indexing, which will allow you to quickly find and access the data in the file.
  5. Enrichment, which supplements the data in the file with external data.
  6. The Finalization, which corresponds to the last processing before the dataset is available.

When finalization is complete, the dataset state is set to "available". It can then be edited, enriched or used in the various visualizations.

Incremental dataset

An editable dataset is an empty editable dataset created without a data file.
You will be able to define the columns of the dataset and then add the rows from Data Fair.

Each column is defined by its label and its type.

The schema of your editable dataset is defined when you have filled in all the columns of your dataset.

Choix de l'application
Add columns to create your editable dataset

You can then add rows to your dataset either through a form on a page of your site, your portal or through the Data section in the edit of the dataset.

Formulaire
Feedback form for portal visitors

Metadata dataset

A metadata dataset does not contain data.
It can be used to contain a set of files such as PDFs, images or videos.

Images can then be used on your portals as thumbnails for the datasets or used with their links.

Attachment descriptions can contain rich text in Markdown format for better formatting.

Virtual dataset

A virtual dataset is a view of one or more datasets (children's dataset).
It is used to present a portion of a dataset or to concatenate datasets with the same schema.

For exemple, it is possible to create a view of its municipality or its department on a national reference dataset without having to copy the data.
As a virtual dataset is a portion of a dataset, when the reference dataset is updated, the virtual dataset of the town (or department) will also be updated. The data always remains up to date with respect to the reference data set.

Jeu virtuel
Filter or aggregate your datasets values

4.3 - Edit a dataset

Datasets are represented by a card. To edit a dataset click on the card.

The edition page contains several sections: structure, metadata, data, visualizations, data sharing, activity, action buttons and content.

Structure

The Structure section contains of the Schema and the Enrichment.

Schema

The data schema allows to visualize all of the columns in your dataset.
Clicking on a column allows you to access the column information

  1. Selected column
  2. Label and description of the column
  3. Key, type and cardinality of the column
  4. Concept associated to the column

Concepts are known elements for the platform and are used in visualizations or the enrichment.

schema
Visualize the schemas of your data and fill in concepts to make sense of your data

Enrichment

Enrichment allows to import columns from a reference base. It is possible to improuve you data and cross with data from open data such as the SIRENE database, INSEE data, the cadastre or the BAN.

Several steps are necessary to create a data enrichment:

  1. On the schema, associate the concepts necessary for the enrichment you need.
  2. Choose the desired extension.
  3. Choose the columns you want to add and apply the enrichment

enrichissement
Enrich your data get even more value

The dataset will be processed and the progress can be viewed on the 6 different states of the dataset. Once the finalization step is complete, your data set is enriched.

In the lower part of the enrichment sheet, you will find the enrichment log, as well as a button to delete the enrichment.
The enrichment report allows you to check the quality of the enrichment and list the different lines that have not been enriched.

The columns that you have added to your dataset with enrichment will be automatically added to the dataset schema and it will be possible to download the enriched file with the additional columns.

Metadata

The Metadata section is made up of Information and Attachments.

Informations

In this section, you will find information about your dataset, such as:

  • The title
  • The description,
  • the name, extension and size of your file
  • Last update date of metadata and data
  • Lines number
  • License
  • The thematic
  • The source

Informations

Attachments

Attachments are used to attach a document to data such as a description or documentation in a PDF file for example.
The attached files will be available for download on the dataset page on your portals.

Data

In this section, the data can be displayed in the form of a table, map, calendar or thumbnails.

Table

The table lets you access the first 10,000 rows of the file.

Tableau

It contains several sections:

  1. search bar
  2. mode of visualization of the lines
  3. columns choice
  4. download
  5. filters on a column
  6. the filter on a value of a column

Tableau

  1. Filters on column values allow you to perform an "equal to" or "begins with" filter on columns with text and to perform "greater than or equal to" or "less than or equal to" filters on columns with numbers or dates. You can make several filters. The number of filtered rows is then available next to the search.
  2. Download of the filtered rows in different formats.
    Downloading in XLSX, ODS and Geojson format is limited to the first 10,000 rows.

Tableau

The column choices allow you to select the columns you want to display in the table.
It is then possible to download the file with only the columns you have selected.

Map

The Map tab is available if position concepts such as lat/lon or geometry, are associated with your data.

The map will allow you to quickly view your data on a territory and access raw data for each point or geometry.

Tableau

Calendar

The Calendar tab is available if the concepts Label, Start date and End date are associated with your data.
The calendar will allow you to view your data chronologically.

Thumbnails

The Thumbnails tab is available if the concept Images is associated with your data.

Tableau

Visualizations

In this section, there is a the list of visualizations using your dataset.
You can quickly navigate between the different visualizations to configure them or create a new visualization.
The order of the visualizations can be modified with a simple drag and drop of the visualization cards. This order will be applied on the dataset page of your portals.

Visualisations
Configure multiple visualizations to better understand your data

It is possible to add External Reuse.
External reuses will be displayed on the dataset portal page as a summary cards or the reuse will be framed on the page if you have the embed code.

Share

In this section you will be able to define the permissions of your dataset, the publication on your portals and the publication on external catalogs.
By default, a dataset is private.

Permissions

The list of your portals is available in this section.

Datasets can be published to multiple portals. Broadcast of data in stages is possible, you can publish your data internally, get feedback, then publish the data on an opendata portal. Publishing on different portals increase the quality of the shared data with multiple feedback.

Publishing on several portals allow to have the same data on all the portals without duplicating the data. In addition, when the data is updated, it will be updated for all portals.

Permissions

Catalogue

The list of configured catalogs is available the Catalogues page is available in this section.
You can thus publish your data to various external catalogs.

Activity

The activity log allows you to view the history of the last modifications made to the dataset.

Activité
Latest events in your dataset

Action buttons

On the right of the edit page you have access to several action buttons:

  • Original file, allows you to download the original file
  • Enriched file, allows you to download the file with all the new columns that you added thanks to the enrichissement in CSV format.
  • Update, allows you to modify the dataset loaded on your account with a new one from your computer.
  • Integrate on a site, allows access to the HTML code to integrate the table or the data map to an external site.
  • View on the data portal, allows access to the page on your portal. If you have published the dataset on more than one portal, there will be various links.
  • API, provides access to the interactive documentation of the dataset API.
  • Delete, remove the dataset from the platform.
  • Change owner, allows you to transfer the dataset to another account.

Contents

The content section allows you to quickly navigate between the different sections of the dataset edit page.

4.4 - Update a dataset

Updating a dataset can be done manually on the dataset edition page or can be automated with periodic processing.

Manual update

Before performing a manual update, check your data schema. For example, if a visualization uses your dataset, verify that the columns used by the visualization are still present in the new file you are importing.

The update is done using the Update action button on the dataset edit page you want to update.
You need to choose the new file to load on your computer and upload your dataset on Data Fair.

The file will be submitted to 6 processing steps:

  1. The Loading, which represents the progress bar.
  2. The Conversion to a format used by the platform.
  3. The Analysis, which will determine the schema of the dataset.
  4. Indexing, which will allow quick access to the data in the file.
  5. The "Enrichment, which will take into account the new values ​​of the dataset and will perform a new enrichment according to the extensions added for the dataset.
  6. The Finalization, which corresponds to the last processing before the dataset is available.

Visualisations Carto

When the finalization is complete, the dataset goes into "draft".

Draft mode allows to check the structure of the schema to add concepts to the new columns and to consult the first 100 lines of the new file.
New columns will be displayed in red.
You can cancel the update if the schema does not match what you want.

After performing the schema verification and giving, the Validate draft button allows you to launch the last stage of the update.

The file will again be subjected to the 6 processing steps.
When finalization is complete, the dataset goes to "available" state.
It can then be edited, enriched and used in visualizations.

4.5 - Concepts

The concepts are known elements for the platform. Your data is more explicit.
Concepts increase the reusability of your data and link your data to the functionalities of Data Fair such as enrichment.

The dataset edition page allows to select the concepts in the Schema section.

  1. Selected column
  2. Label and description of the column
  3. Key, type and cardinality of the column
  4. Concept associated with the column

Concepts
Concepts are needed to create of some visualizations.

A concept is unique for a dataset, it can only be attributed once to a dataset. For example, if the Latitude concept is associated with a column of your dataset, it cannot be associated with another column.

List of concepts

It is possible to create your own concepts and use them in your reference data.
Here is the default list of concepts used by Data Fair:

  • Label: An easily readable label
  • Description: A small descriptive text (HTML content accepted)
  • Image: URL to an illustration image of the current document
  • Street number: A house number, which can contain words like bis or ter
  • Street or locality: A street or locality name
  • Address: An full address written on one line
  • Municipality: Municipality name
  • Postal code: Postal code, on 5 digits
  • Municipality code: INSEE code of the municipality, on 5 characters, not to be confused with the postal code.
  • Department code: Department code on 2 or 3 characters
  • Region code: Region code on 2 digits
  • Latitude: Geographic coordinate related to the equator
  • Longitude: Geographic coordinate related to the Greenwich meridian
  • Latitude / Longitude: latitude / longitude separated by a comma
  • SIRET: The SIRET number is a 14-digit numeric identifier made up of the SIREN (9 digits) and the NIC (5 digits)
  • SIREN: The SIREN number is a company digital identifier (9 digits)
  • APE code: The APE code (main activity exercised) identifies the main branch of activity of the company or of the self-employed person with reference to the classification of French activities
  • Legal category (level 3): The legal category of level 3, sometimes called legal nature is a code on 4 numeric characters. It comes from a nomenclature of the French government.
  • Date of the event: Corresponds to the date of the event
  • Creation date: Date on which the resource was created
  • Parcel code: The cadastral parcel code is the unique number assigned by the Cadastre Service to identify a cadastral parcel at the national level. It is composed of 14 characters: INSEE commune code of 5 digits + cadastre section code of 5 characters + cadastre parcel number of 4 digits. For example 56197037ZC0063 is a valid french code.
  • GeoJSON geometry: A geometry (point, polygon, line, etc.) in GeoJSON format.
  • Attached files: Relative path to a file attached to the dataset or URL to a file hosted outside

4.6 - Data enrichment

Enrichment allows you to import columns from a reference base. It is possible to cross-reference its data with data from open data such as the SIRENE database, INSEE data, the cadastre or the BAN.

  • The SIRENE database brings together economic and legal information from more than 28 million french business establishments, including more than 11 million active establishments.
  • INSEE data makes it possible to retrieve various informations on french administrative divisions (municipalities, departments, regions)
  • The cadastre provides access to the various information concerning the plots. In particular, you can geocode plot codes or obtain the areas of your parcel on the french territory.
  • The NAB is the French National Address Base. It allows you to geolocate addresses or find addresses from coordinates.

Depending on your data, you can choose an enrichment and complete your data.

Create your own reference data

At this time, only Super Instance Admins can set a dataset as Reference Data.

  1. Upload a file and associate at least one concept with a column.
  2. Switch to super administrator mode
  3. Define your Reference Data

Once these 3 steps have been completed, you can enrich other data with your Reference data.

Upload and concept

When your dataset is created on your account, you will need to associate a concept to the column containing the uniques values. This column is the link to join data. Your column must contain unique codes, such as INSEE codes of municipality, SIRENE codes or Parcel codes.

Données de référence
A column with a concept is in bold

Super admin mode

Super administrator mode is only available for users authorized in the instance.
This mode is available in the menu at the top right on Data Fair.

Données de référence

Reference data

The imported datasets with concepts can be used as reference data for unitary searches or / and for mass enrichments.

The unit searches will allow to validate a code in your editable datasets.
If your editable dataset has the same concept as one of your reference datasets, when a value is filled in this column, the user will have valid propositions of this concept.

The mass enrichments will allow to perform a join and import columns from the reference data to your dataset.

Données de référence
Cross your data with reference data

On our image, we have created a SITADEL reference data with the concept parcel code which can be used in mass enrichments.
Any other dataset in your account with the concept parcel code can use the SITADEL enrichment to import various columns from the SITADEL reference base.

Create a concept

You can create your own unique value concepts in the Private Vocabulary section of Settings on your account. The concepts created will be available for your account.

A concept is defined by its Identifier, its Title, its Description and its Category. The identifier and title are required.

Données de référence
Create your own concepts

4.7 - Row Attachments

When you load a dataset, it is possible to associate a zip archive containing PDF, JPG, etc ... files with your dataset. These files can be latter used in visualizations.

In order for your zip file to be correctly associated with your dataset, your dataset and archive must follow these two rules:

  1. your dataset must have a column containing the paths and names of the files in the ZIP archive
  2. the name of your zip file must match the name column containing the paths of the files in the ZIP archive. Example: You column is Document, your file must be Document.zip.

s

PJ-1

In the Schema section of your dataset, the concept Attached digital document will be automatically associated with the column containing the names of the files of your ZIP archive.

PJ-2

The attachment indexing time can be long and will depend on the size of your attachments files.
The unzipped files size is counted in your data storage quota.

Please do contact us if you have any trouble.

5 - Visualizations

The services connected to Data Fair allow to present your data in dynamic visualizations and to make it more accessible.
You can create as many visualizations as you want.

The visualizations are divided into several categories: maps, graphics, textual visualizations, etc.

Map visualizations

Map visualizations allow to project your geographic data on a map using concepts latitude, longitude or geometry.

Visualisations Carto

Graphic visualizations

Graphic visualizations allow to represent your data on different perspective visualizations.

Visualisations graphiques

Textual visualizations

Textual visualizations can represent the majority of your data.

Visualisations texte

Gamification

Game visualizations present your data in mini-games. Gamification challenge your visitors, they will be able to test their knowledge and learn about your data.

Visualisations texte

Visualisations SCDL

SCDL visualizations make it possible to represent data respecting the format of the Common Base of Local Data (SCDL).

  • SCDL-Deliberations allows you to view administrative decisions. Grand Poitiers deliberations
  • SCDL-Equiements allows you to view the equipment of a territory on a map

5.1 - Create interactives visualizations

Interactive visualizations present and explore your data in a fun way.

The creation of a visualization can be initiated from the various buttons Configure a visualization available on Data Fair

Remark : Check your datasets to match the type of visualization you want to create and also check the concepts on your dataset. For example, to configure a map, the concepts Latitude and Longitude must be associated with the columns that contain these values ​​in your dataset. Please do contact us if you have any trouble.

Once you clicked on Configure visualization you are redirected to the configuration page of your visualization.
This page is divided into several parts:

  • Metadata at the top of the page with the title, description and thematic.
  • Configuration which includes the configuration menu on the left and the visualization preview on the right
  • Share section allows you to manage permissions, the sharing link for private viewing, publications on various portals and on external catalogs.
  • Activity to keep track of the latest changes to your visualization.

On the right of the page, action buttons are available.

Menu
Customize the rendering of your visualization

Configuration menu

The configuration menu consists of different sections which may differ depending on the application.
The menu is made up of at least three sections, the Data, the Render (or Presentation) and finally the Navigation.
The Data section allows you to choose the dataset used in the visualization.

Preview

The preview allows you to view the rendering of your visualisation. The preview is split into two modes sketch and Registered Version.

When you make changes to the configuration menu, they are directly represented in the sketch mode of the preview. You can modify and test different renderings of your visualization. When you are satisfied with your rendering, click on the Save button and the Registered Version will change to represent the saved visualization.

Share my visualization

A visualization can be public or private. By default, a visualization is private.
If your data is accessible to the public then your visualization can also be accessible to the public.

The Protected link section allows to create a link to access a private visualization.

Visualizations can be published on multiple portals. It's possible to publish your visualization internally to get feedback from your team and then publish the visualization on an opendata portal for exemple.

partage visu

Action buttons

On the right, there are the action buttons:

  • Full page.
  • Integrate into site. Allows you to display the code necessary to integrate the visualization in another site.
  • Capture. Image in PNG format.
  • API
  • Delete
  • Change owner

The Content allows to quickly navigate in the page.

5.2 - Visualization settings

The configuration menu of a visualization is divided into several sections.

The Save button turns orange when you modify any element of the configuration of your application.

The configuration menu contains the Data, Data preparation, Presentation sections.

Menu de configuration d'une visualisation graphique

Data

The Data section is available in all the configuration menus and allows to choose the dataset represented in the visualization.

On some configurations, static filters or interactive filters can be defined. Filters allow to restrict data to some values ​​or exclude values. You control the lines thanks to these filters.

Static filters

Static filters allow you to perform a hard filter on your data.

Data preparation

In this section, you can perform controls on the columns. You are able to define which columns you want to represent in your visualization.

Presentation

This section allows to configure the graphical aspect of the visualization. You can change colors and define interactive filters for exemple.

Filters

Interactive filters allow to have a filter section displayed in your visualization. The visualization will be dynamically modified according to the value entered in the filter by the users.

Map menu

The map visualization configuration menu contains the Data, Render, Navigation sections.

Menu de configuration d'une visualisation cartographique

Render

In this section you have the possibility to:

  • Fill in the field that corresponds to your legend.
  • Modify the content of cards or tooltips.
  • Display information specific to each of the visualizations.

This section groups the elements related to the navigation of your visualization. You can activate geolocation, define an initial position of the map or display an address search bar.

6 - Map visualizations

Map visualizations allow to project your geographic data on a map using concepts latitude, longitude or geometry.

Visualisations Carto

6.1 - Carto-stats

Carto-stats visualization is a map with geolocated data and dynamic filters.
An example of this visualization is the bicycle accidents map.

Carto-stats allows to create dynamic filters and to have filtered data on the map.
Compared to Infos-location, Carto-stats will be more suitable for large data and Info-locations will be more suitable for data containing special fields such as URL, images, descriptions, ...

Concepts

To configure a Carto-stats visualization, your active account contains a monthly dataset with [concepts] (./ user-guide / concept) Latitude and Longitude of associates in its schema.
Once you have updated your data schema, you can preview your data using the generic map. YOu can verify that the data is correctly projected on a map.

Create a Carto-stats map

To configure a Carto-stats visualization, click on Visualizations in the navigation bar, then on Configure visualization.

  1. Choose the application Carto-stats
  2. Enter the title of your visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains three submenus : Sources, Preparation and Presentation.

1.Sources

Sources allows to choose a dataset.

Once you have choosen a dataset compatible with the Carto-stats visualization, a map preview is displayed with geolocalised data.

You can configure dynamic filters, predefined filters and a slider.

  • Dynamic filters allow to choose fields that will be available to users of your visualization. These users will be able to use the filters to restrict the number of dots on the map.
  • Predefined filters allow to restrict or exclude values ​​in your data. The fields, or values, that you configure in this section will not be available in your visualization.
  • The Slider allows to choose an integer field, such as a year field. The user will be able to choose a year value on the slider, the data will be filtered on this year and displayed on the map.

2.Render options

In the menu Render options, you can customize the cards available on the markers and customize your legend.

The Tooltip menu allows you to select the different fields to be displayed on the cards of your markers.
The Color by value of a field defines the column used for your legend. The palette allows to choose a set of colors that will be associated with your legend values.

3.Navigation

In the Navigation menu, you can hide the search bar and set the initial position of the map

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

6.2 - Administrative divisions

The Administrative divisions visualization allows to create administrative, thematic or choropleth maps.
Administrative divisions is used to project statistical data on a set of territories. It is possible to navigate between the levels of territories using the zoom. To access the data, click on a territory.
An example of this visualization on the 2019 European election results map.

Administrative divisions allows to create maps at the levels of IRIS, EPCI, municipalities, departments and / or regions.

Concepts

To configure a Administrative divisions visualization, your active account contains a dataset with any of the concepts IRIS code, EPCI code, Municipality code, Department code and / or Region code.

Create an Administrative Divisions visualization

Click on Visualizations then on Configure a visualization.

  1. Choose the application Administrative divisions
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains four sub-menus: Data, Metric, Render and Navigation.

1.Data

In the Data menu, you can choose the dataset you want to use.
Once you chose a dataset compatible with the application Administrative divisions, a map preview is displayed.

2.Metric

In the Metric menu, the Numerator section allows to define the value of your dataset that you want to display on your map. It is possible to count, sum or average the values ​​of this field.

The Denominator section allows you to perform a ratio. For example, if you have the populations of the territories in a column of your dataset, you can enter a value in the Numerator divided by the population to have the ratio per capita.

3.Render

The Render menu allows to customize your visualization.
The Colors section allows to choose a set of colors that will be associated with the values ​​of your data. You can invert the colors in the palette and set a default color for your values.
The Calculation of intervals allows to define the type of intervals you want to display. It is possible to have intervals of the same size, from quantiles or to define them yourself.

4.Navigation

The Navigation menu is used to define the initial position of the map.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

6.3 - Geo Shapes

The Geo Shapes visualization display geometric data on a map. It is thus possible to visualize data such as the zones of the local urbanization plan or energy networks.
An example is the map of the Angers Loire Métropole LUP zones.
You can click on each zone to get more details and click on a color in the legend to filter by zone type.

Concepts

To configure a Geo Shapes visualization, your active account contains at least one dataset with the concept GeoJSON geometry to be able to project your data on the map.

Once you updated your data schema, you can preview your data using the generic map button. This allows to verify that your data is correctly projected on a map.

Create a Geo Shapes visualization

Click on Visualizations then on Configure a visualization.

  1. Choose the application Geo Shapes
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains three submenus: Data, Render and Presentation.

1.Data

In the Data menu, you choose the dataset you want to use. Once you chose a dataset compatible with the Geo Shapes visualization, a map preview is displayed.

2.Render

In the Render menu, the Value color defines the column used for your legend. A legend color can be defined by clicking on the color circle or each legend value. You manage the legend order with a drag and drop on the hamburger menu.

The Details Fiels allows to choose the fields to display when a user clicks on a geometric shape. Without any value in this section, the side panel will only be useful for navigation.
The map style allows to modify your basemap. You can customize the basemap of your application to have a better rendering.

3.Navigation

The Navigation menu is used to activate geolocation and define the initial position of the map.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

6.4 - Parcel info

The Parcel Info visualization allows you to project your data onto an interactive French cadastral map.

Prerequisites

To view your data on Parcel Info, your dataset must contain a column of parcel identifiers of 14 characters.
These identifier (or parcel code) are made up of this method: common INSEE code of 5 digits + cadastre section code of 5 characters + cadastral parcel number of 4 digits = structured parcel identifier for Parcel info.

For example 56197037ZC0063 is a valid code for Parcel info. An exemple is the dataset of agricultural plots managed by the agricultural management of the City of Toulouse which has a column with identifiers of 14 characters valid for Parcel info.

Your dataset must also contain latitudes and longitudes associated with each field code.
If you only have 14 character identifiers, it is possible to enrich your dataset and import the latitudes and longitudes according to the parcel identifiers with the help for the cadastre enrichment of the Koumoul platform.

Concepts

To configure a Parcel info visualization, your active account contains a data set with concepts Parcel code, Latitude and Longitude associated in its schema.

Once you update your data schema, the Map preview is available in the Data section. This allows to verify that your data is correctly projected on a map.

Create a Parcel info visualization

lick on Visualizations then on Configure a visualization.

  1. Choose the application Parcel info
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains four sub-menus: Data, Render and Navigation.

1.Data

In the Data menu, you choose the dataset you want to use.

Note: If your dataset is not available in this menu, make sure you have updated the concepts Latitude, Longitude and Parcel Code in your dataset.

2.Render

In the Render menu, the Color by value defines the column used for the colors of your legend. You can choose the different colors you want to associate with your legend values.

In the Tooltip parameter, you can select multiple columns to display when a user clicks on a parcel.

You can have a 3D render with the Field height.

3.Navigation

The Navigation menu is used to activate geolocation and define the initial position of the map.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

6.5 - Location info

The Location info visualization allows to project geolocated data on a map. The coordinates are represented by a clickable marker with a personalized card on each point.

Prerequisites

The data you want to project must contain latitudes and longitudes.
The visualization supports Lambert 93, Lambert II and WGS 84 system projections.

Configuration

1.Concepts

To use your data in a Location Info visualization, the concepts Latitude and Longitude must be associated with the schema of the dataset you want to use.

Then, associate the concept Label with the corresponding column of your dataset.
The values of this column will be used as card titles in your visualisation.

You can combine other concepts such as images, descriptions or web page to better inform your data. These concepts will be used on the marker cards.
Once you updated your data schema, you can preview your data using the generic map button. This allows to verify that your data is correctly projected on a map.

2.Create a Location info map

Click on Visualizations then on Configure a visualization.

  1. Choose the application Location Info
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains four sub-menus: Data, Render, Card and Navigation.

1.Data

In the Data menu, you choose the dataset you want to use.

Note: If your dataset is not available in this menu, make sure you have updated the concepts Latitude and Longitude in your dataset.

2.Render

In the Render menu, you can choose the Map Style that suits you the most.
The Color by value defines the column used for the colors of your legend. You can choose the different colors you want to associate with your legend values.

You can also choose Icons by field value to define the column used for the icons in your legend. You can define different icons for each value of one of your columns.

3.Card

The marker cards display certain concepts automatically. For example, on the European Heritage Days dataset, the concepts Latitude, Longitude, Label, Image, Description and Web page are associated with the corresponding columns.

In the Card menu, you can add Fields to be used in order to display them in each of the marker files.
You can add as much information as you want on a record, however, a card with a lot of information will be too large to display.

4.Navigation

The Navigation menu is used to activate geolocation and define the initial position of the map.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

6.6 - Catchment areas

The Catchment areas visualization is a map offering the possibility of identifying areas of responsibility or influence of an establishment, an entity or even an organization, for example.
The map uses EPCI, municipality, department, region codes to calculate the geometry according to values ​​of a column.

Create your catchment area map

To configure a Catchment areas visualization, click on Visualizations in the navigation bar, then on Configure visualization.

  1. Choose the application Catchment areas
  2. Enter the title of your visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains two submenus: Data and Render.

1.Data

The Territory code section allows to define the ladder of the territory IRIS code, EPCI code, town code or Department code).
The Aggregate values section allows to define the field to aggregate your data.
Filters are used to restrict the data displayed in the application.

2.Render

The Render menu manage the initial position, hide the position search bar and activate geolocation.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

6.7 - Cartographic workshop

The Cartographic workshop visualization allows to project geolocated data onto a map.

You have an example of this visualization on Move by bike.

Concepts

To configure a Cartographic workshop visualization, your active account contains at least one dataset with concepts Latitude et Longitude / Geometry associated with the columns of its schema.

Create a Cartographic Workshop visualization

To create your visualization, click on Visualizations then on Configure a visualization.

  1. Choose the visualization Cartographic workshop
  2. Enter the visualization title and save

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains three submenus : Data layers and Other options.

1.Data Layers

In the Data Layers section, you add the layers present in your visualization.
A layer corresponds to a dataset containing geographic data.
You can add multiple layers, each layer will have its own configuration.

When you add a layer, a new window is displayed. This window allows you to configure how your layer data is rendered using the Data Source, Details On Click, Display Type and *Color Adjustments sections. *.

Note: If your file is not available in the Data Source section, check that you have updated concepts Latitude and Longitude or Geometry in your dataset.

Details On Click allows to select multiple columns to display in the legend when a user of your visualization clicks on an item on your layer

Display type allows to define the representation of your layer: a single icon, icons based on the values ​​of a field, circles or even the geometries present in the dataset used for your layer.

Color Settings allows you to set the colors used by your layer.
You can use a single color, colors based on values ​​in an interval, or based on values ​​in a set. Single color can be set in configuration.
When working with colors based on values ​​within a range, you have three palette type options: Gradient Between Different Colors, Gradient Same Color Tone, or Specific Colors.
The Field containing values allows you to define the numeric column represented by the colors.
You can then define intervals of the same size, by quantiles or in manual adjustment.

Calques
Each frame represents a layer

2.Other options

In this section you can:

  • set the Map Style among nearly 10 different styles
  • show/hide search by address
  • enable geolocation
  • set the initial position of your map

7 - Graphic visualizations

Graphic visualizations allow to represent your data on different perspective visualizations.

Visualisations graphiques

7.1 - Bar Chart Race

Bar Chart Race represent rankings data over time.
An example of this visualization is the evolution of wages by region between 1966 and 2010 in France

Prerequisites

The data you want to visualise must have a column containing a temporality. In the evolution of wages example, the temporality is the years.

Bar Chart Race initialization

To configure a Bar Chart Bace visualization, click on Visualizations in the navigation bar, then on Configure visualization.

  1. Choose the application Bar Chart Race
  2. Enter the title of your visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains three submenus : Sources, Preparation and Presentation.

1.Sources

Sources allows to choose a dataset and define the Filters. Filters restrict the data displayed in the visualization.
It's possible to Restrict to Values from a column, Restrict to Range of Values from a column, or Exclude Values from a column.

2.Preparation

Preparation section define which columns you will use in your visualization.

  • Calculation allows to count rows, sum or average on column values.
  • Column allows to choose the column used for the Calculation.
  • Time field allows to choose the column containing the time values.
  • Value field allows to define the column containing the labels used on each bar.

Once all the options are filled in, you have a first glimpse of your visualization.

Premier aperçu
Evolution of the ranking of Ligue 1 teams for the 2016-2017 season

3.Presentation

The Presentation submenu allows to modify the Maximum number, the Duration in seconds, the Width, the Position, the colors of the bars of bars and if the visualization starts automatically.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

7.2 - Waffle Charts

The Waffle Charts visualization provide an intuitive overview of proportions in a dataset and the ability to compare them based on different categories / variables.
For example, they can be used to highlight indicators of achievement of objectives.

Create your waffle charts

To configure a Waffle Charts visualization, click on Visualizations in the navigation bar, then on Configure visualization.

  1. Choose the application Waffle Charts
  2. Enter the title of your visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains two submenus: Data and Render.

Data

In the Data menu, you can choose the data set you want to use.
The Value to compare section allows to define the comparison field of the 100 squares of a "waffle".
The Category section allows to define the number of different waffles you will display on your visualization.

The Calculation section allows to add a sum to a column or to count the rows The Calculate Field section allows to define the column that contains the values ​​for your sum.

Filters are used to restrict the data displayed in the application.

Render

The Render menu is used to modify the displayed icon in the waffles and to choose the colors.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

7.3 - Diagramme Sunburst

Sunburst diagram allows to visualize hierarchical data and to access to several levels of this data in a few clicks.

Create a Sankey diagram

Click on Visualizations then on Configure a visualization.

  1. Choose the application Sunburst
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains three submenus: Data, Preperation and Presentation.

1.Data

In the Data menu, you can choose the dataset to use.

2.Preperation

The Preperation menu allows to enter the columns you want to display and to have your first rendering.
Calculation allows to count the number of non-zero rows of a column or to calculate the sums of the values ​​of a column.
The Groups represent the number of levels you want to display on your sunburst diagram.

3.Presentation

In the Presentation menu, you can turn off the display of unique descendants, change the text color and change the color of your categories.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

7.4 - Sankey diagram

A Sankey diagram represent data flow and can acces to the information of each flow in one click.

Prerequisites

To configure a Sankey diagram, you need a dataset with one column containing numbers (integer) and two columns containing strings (string).

Deux colonnes string et une colonne integer
Dataset with the columns of type string, Country and Candidates, and one column of type integer, Number_of_voices

The values ​​of the two columns of character strings, Country and Candidates, are related to the numerical values ​​of the column of Number_of_voices.

Create a Sankey diagram

Click on Visualizations then on Configure a visualization.

  1. Choose the application Sankey
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains three submenus: Data, Preparation and Presentation.

1.Data

In the Data menu, you can choose the data set you want to use.

2.Preperation

The Preperation menu allows to configure the columns you want to display and have your first rendering.

Maximum sources allows to select the number of elements displayed. The Others group includes all the data elements that are not displayed individually.

Sort allows to sort the elements in alphabetical order or in descending order. If you have an Others category, it will be placed at the bottom of the diagram when sorting.

Palette color and Color palette name allow to choose the color of the elements.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

7.5 - Graphs / Networks

The Graphs / Networks visualization allows to generate dynamic graphs from two datasets, one containing the nodes and the other containing the links. An example is the tag network in Stackoverflow.

Create a Graphs / Networks visualization

Click on Visualizations then on Configure a visualization.

  1. Choose the application Graphs / Networks
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains two submenus: Data and Render.

1.Dataset

In the Data menu, you choose the two datasets of your vizualization.

2.Render

The Render menu allows to configure your graph.
You can choose the rendering method, SVG or Canvas, the strength of the links to better space the nodes of your graph and the font size of your labels.

In the section nodes you configure the rendering of your nodes by choosing the size of your nodes, the field of the names of your nodes and the color of your nodes.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

7.6 - Network diagram

Network diagram allows to generate dynamic graphs from two datasets, one containing the nodes and the other containing the links between the nodes.
An example of this visualization is the relationship between the players of the France team and their clubs.

Create your Network diagram

To configure a Network diagram visualization, click on Visualizations in the navigation bar, then on Configure visualization.

  1. Choose the application Network diagram
  2. Enter the title of your visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains three submenus: Data, Nodes and Links.

Data

In the Data menu, you choose the dataset you want to use.

Nodes

The Nodes menu allows to customize the two types of nodes in your visualization.
It is possible to modify the color and the icon representing your nodes.

You can customize the spacing of the nodes, sum or count the rows, the minimum and maximum size of the nodes as well as the size of the font of the nodes.

The Links menu allows you to configure the size, minimum and maximum size of links. The thickness of the links corresponds to the force between the different nodes.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

7.7 - Charts

The Charts visualization allows to compare several columns of your data with each other in different charts :

  • Histogram, chart in the form of vertical or horizontal columns, grouped or stacked.
  • Lines, chart as single lines or multiple lines.
  • Areas, chart in the form of areas and stacked areas.
  • Radar, spider web chart.
  • Pie, circle chart.

Différentes visualisations

In this visualization, you can aggregate the values of your data.
This visualization is a quite powerful, its configuration is more complex than other visualizations.

Create a chart

To configure a Chart visualization, click on Visualizations in the navigation bar, then on Configure visualization.

  1. Choose the application Chart
  2. Enter the title of your visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration Menu

The configuration menu contains five sub-menus: Data, Type, Preparation, Presentation and Navigation.

1.Data

The Data menu allows to select the columns to display and to have the first preview of your chart.

The Data type parameter allows to choose how you will represent your data. A different menu is displaued depending on the option you selected.

  • Option 1: Read rows one by one, the values ​​of your data are read directly from a column of your dataset.
  • Option 2: Group the rows and count them, the rows of the dataset are grouped according to one or two criterias and the displayed values ​​represent the sum of rows for each group.
  • Option 3: Group the rows and aggregate, the rows of the dataset are grouped according to one or two criterias and the displayed values ​​are the results of a calculation on a numerical column (sum, average, etc ...) that you choose.

  1. Read rows one by one :
  • Values ​column corresponds to the values re​​presented on the Y-Axis.
  • Columns of labels corresponds to the values represented on the X-Axis, these values ​​can be sorted.
  • Sort by allows you to sort your values.
  • Sequence allows you to order to your sort.
  • Maximum number of lines allows to limit the number of elements in the legend.

  1. Group the rows and count them :
    This option allows to group rows and count them on two levels. The first level corresponds to the value on the X-Axis, the second level corresponds to the legend.

1st level on the X-axis:

  • Group by, define the method to group the values. The graph will be able to read the exact values ​​of a column, define intervals of a date type column, define intervals of a numeric column
  • Group according to this column define the column you want to use on the X-axis.
  • Sort by allows to choose a sorting method

2nd level in legend: This group level is optional, it allows to separate the values even more​. For example it's possible to separate a line into several lines or delimit different sections on a bar in a histogram.

  1. Group the rows and aggregate :
  • Group by, allows to define the method to group the values. The chart can read the exact values ​​of a column, set the intervals of a date type column or define intervals of a numeric column.
  • Group according to this column allows to define the column you want to use on the X-axis.
  • Sort by allows to choose a sorting method.
  • Aggregate options: average, minimum value, maximum value, sum
  • Values column allows to choose the column for the aggregation.

2.Presentation

This section allows you to choose a color palette to use on your application.

3.Navigation

This section allows to define different types of interactive filters. The visualization with an interactive filter will be modified according to the values ​​provided in the filters by the visitor.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

7.8 - Periodic series

The Periodic series visualization is used to visualize a series of data to compare its evolution over time over a period.
You have an example of this visualization on the temperature variation and comparison between oceanic / continental climate.

Create your graph

Click on Visualizations then on Configure a visualization.

  1. Choose the application Periodic series
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains two submenus: Data and Render.

1.Data

In the Data menu, you choose the data set you want to use.
Filters are used to restrict the data displayed in the application.
You can Restrict to Values from a column, Restrict Range of Values from a column, or Exclude Values from a column.

The Measurement allows to choose the column of values you want to represent. The Metric allows to perform a calculation on your data according to the period you have chosen. The Category allows to choose a column to filter the Mesurement values of your visualization. The Transform the value section allows to perform a calculation in the form of a formula on all the values.

2.Render

In the Render menu , you choose the period of the graph and the unit of the graph.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

8.1 - Cards and list

The Cards and list visualization allows to filter, search and explore each of the rows of your data. It can for example be used to embed a search engine for your data on a site. The results are presented in the form of cards which may contain images.

Create a Cards and list visualization

Click on Visualizations then on Configure a visualization.

  1. Choose the application Cards and list
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains five sub-menus: Data, Thumbnail, Detailed card, Navigation and Display.

1.Data

The Data submenu allows to choose a dataset and define Predefined filters. Predefined filters restrict the data displayed in the application. You can Restrict to Values from a column, Restrict to Range of Values from a column, or Exclude Values​​ from a column.

2.Thumbnail

The Thumbnail sub-menu allows to choose the different fields displayed in the cards. If your dataset you contains the concepts Label, Image and Description, the application List and Forms will automatically display them in the cards.

3.Detailed card

The Detailed card sub-menu allows to activate the detailed cards. When the option Activate detailed cards is selected, the cards become clickable and will display a larger and more detailed card according to the fields that you choose.

4.Navigation

The Navigation sub-menu is used to manage the filters of your visualization. With filtering and sorting options, users will be able to explore your dataset smoothly.

5.Display

The Display submenu allows to choose the rendering of the image on the thumbnail. The image can be displayed as a banner, logo or not displayed.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

8.2 - Word clouds

The Word Clouds visualization allows to generate word clouds containing textual data.
You have an example of this visualization on our cloud of most popular names in 1900. The number of births is available by hovering over a first name.

To set up a Word Clouds visualization, choose the active account you want to work on. Your active account contains at least one dataset with textual data.

Create your Word Clouds

Click on Visualizations then on Configure a visualization.

  1. Choose the application Word Clouds
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains three submenus: Data, Preperation and Presentation.

Data

In the Data menu, you can choose the dataset you want to use.
Filters are used to restrict the data displayed in the application.
You can Restrict to Values from a column, Restrict to Range of Values​​ from a column, or Exclude Values from a column.

Preperation

In the Preperation menu, Text fields allows you to select the column you want to use in your word cloud.
Calculation allows to classify your text by the most significant words, by frequency or by a value from another column.

Presentation

The Presentation menu allows to customize your word cloud.
The Palette allows to choose a set of colors that will be associated with the values ​​of your data.
The Interactive filter makes the words clickable, a new word cloud will be created in relation to the word on which you clicked.
The other rendering options allos to choose the maximum number of words, the font, the minimum and maximum size of a word, the progression of the size of the words, the directions of rotation of the words and the spiral type of words.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

9 - Textual visualizations

Textual visualizations can represent the majority of your data.

Visualisations texte

9 - More visualisations

The various visualizations allow you to display your data with a different approach.
This section includes, for example, game visualizations and dashboards.

Visualisations texte

9.2 - Quiz game

The Quiz Game visualization allows to create a game in which labels are matched to descriptions or images. An example of this game is the quiz on the 2019 science festival.
A score is awarded to the player based on the number of correct answers and the time spent answering the questions.

Quiz game

Click on Visualizations then on Configure a visualization.

  1. Choose the application Quiz game
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains two submenus: Data and Presentation.

1.Data

In the Data menu, you choose the dataset you want to use.

The Label field allows to choose the column of your labels.
The Description, image, or question field allows to select the column of items to find.
The Elements number allows to choose the number of questions the visitors will have to answer before obtaining their score.
The Choices Number is used to define the number of possible answers for a question.
The Transform the value section allows to perform a calculation in the form of a formula on all the values.
The minimum label length allows to filter the Description, image, or question field to have understandable descriptions or questions displayed.

Filters are used to restrict the data displayed in the application.
You can Restrict to Values from a column, Restrict to Range of Values​​ from a column, or Exclude Values​​ from a column

2.Presentation

In the Presentation menu, you define the overall description of your game and you can select a presentation image of the game if you have added an image as an attachment to your data.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

9.3 - Localization game

The Localization game allows to create a game on a blind map. You have an example of this visualization on the map of location of world capitals.
A score is awarded to the player based on the distance from the correct answer and the time spent answering the questions.

Create your localization game

Click on Visualizations then on Configure a visualization.

  1. Choose the application Localization game
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains three submenus: Data, Render and Presentation.

1.Data

In the Data menu, you choose the dataset you want to use.

Filters are used to restrict the data displayed in the application.
You can Restrict to Values from a column, Restrict to Range of Values​​ from a column, or Exclude Values​​ from a column.

The Number of elements defines the number of points to find on the map.

2.Render

The Render menu allows you to choose the style of your map, the default markers icon, the size of the icons and the initial position of the map.

3.Presentation

In the Presentation menu, you define the overall description of your game and you can select a presentation image of the game if you have added an image as an attachment.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

9.4 - Sort game

The Sort game allows to create a game of classification of your data according to a numerical value. An example is the ranking of the top scorers of the Euro.
A score is assigned to the player based on the number of permutations and the time spent sorting the items.

Create your Sort game

Click on Visualizations then on Configure a visualization.

  1. Choose the application Sort game
  2. Enter the title of the visualization

You are redirected to the configuration page of your application with its different sections:

  1. Information
  2. Action buttons (full screen, integration on a site, capture, ...)
  3. Configuration menu
  4. Preview

Page de configuration

The title of the visualization can be changed anytime.
The Informations section shows a summary of the characteristics of your application.

Configuration menu

The configuration menu contains two submenus: Data and Presentation.

1.Data

In the Data menu, you choose the dataset you want to use.

The Label field is used to define the column containing the values ​​to be sorted.
The Comparaison value field is used to define the column containing the numerical values.
The Game Mode allows to choose your game mode number of distant elements as much as possible or one element of each value.

Filters are used to restrict the data displayed in the application.
You can Restrict to Values from a column, Restrict to Range of Values​​ from a column, or Exclude Values​​ from a column.

2.Presentation

In the Presentation menu, you define the overall description of your game. You can select an image for the game if you have added an image as an attachment on your dataset.

When you are satisfied with the preview click on Save to finalize your configuration.
You can add a description at the bottom of the page and make your application public.
You can consult it using the consult or full screen buttons.

10 - Organization

An organization account allows to work together on the same datasets and visualizations with various persons.
A personal account can create an organization.

Create an organization

Organizations can be created in the My Account space of the the Data Fair menu.
Click on the Create an organization button and fill in the title and description of your organization, you will then be the administrator of this new organization.

If you are an administrator of the organization, you can access member management. This allows you to invite members, define their roles, and remove members from your organization.

Active account

If you are a member of an organization, you have access to the organization workspace.

Compte actif

On our capture, the personal account is active. If you click on Koumoul organization, the active account will be the Koumoul organization account and you will have access to all the datasets and visualizations of the Koumoul organization.

10.1 - Organization management

As an administrator of your organization, the Organization management section is accessible in the Data Fair navigation bar.

On this page, you can manage the different members of your organization:

  • Invite new members with their email
  • Change members roles
  • Exclude members

Membres
Manage the members of your organization

Changing roles and removing a member can be accomplished through the action buttons on the member's row.

Invitation

To invite a member to your organization, all you need is their email.

Invitation
Invite members of your organization by email

An invitation email is sent to their address.
The email contains a link to validate the account on the platform and be part of your organization.
Once logged in, the invited person will have access to the different pages of the organization according to the role you assigned them.

Role

An organization allows people to work together on different datasets and visualizations.

Organizations follow this rules:

  • Not all members of an organization have the same rights.
  • Administrators of an organization can change the roles of different members of the organization.
  • There are three different roles, user, contributor and administrator

Each role has different permissions.

Defaut permissions :

Actions User Contributor Administrator
Add a dataset x x
Read a dataset x x x
Edit a dataset x x
Dataset administration x
Add a visualization x x
Read a visualization x x x
Edit a visualization x x
Visualization administration x
Modify organization settings x
Creation and modification of the portal x

Dataset or visualization administration is about deletion and visibility.
The administrator is the only one who can publish or delete a dataset or a visualization.
The user role is used to provide access to private organization resources.

The permissions for each resource can be modified by the organization's administrators.
An admin can remove access to resources for contributors or give them publishing rights on certain portals such as a pre-production portal before he validates the publishing request on a production portal.

If you need more permissions in your organizations, contact an administrator of the organization.

10.2 - Department

Departments allow you to distribute your members according to the datasets they have access to.

The following diagram describes the members of an organization with two departments:

Persmissions

Root organization admins and contributors can work on all datasets in the organization (including departments).
Administrators-1 and contributors-1 of department-1 will only be able to work on datasets of department-1.
Administrators-2 and contributors-2 of department-2 will only be able to work on datasets of department-2.

Consulting datasets

The consultation of the data sets can be carried out by API or on the portal

At the API level, datasets with granted permissions are accessible by API.

At the portal level, datasets with granted permissions that are published on the portal can be accessed from the portal.

The following image describes dataset accessibility based on permissions and dataset owner:

Persmissions

11 - Configure your data portal

Data Fair allows to present your data in a portal.
It is possible to configure several portals for the same account.
Portals can be public, for open data, or private to share data internally.

The portal configuration page is accessible through the navigation bar. A list of your portals is available. You can create, delete, configure and duplicate your portals.

Liste des portails

Configure a portal

A portal can be created with the Create a new portal button.
A default configuration is available on your portal.

When setting up your portal, you are working on a Draft. Once you are satisfied with your draft, you can save it to Current Version. The Current version is the version presented to the visitors of your portal.

The portal configuration interface is divided into 5 parts:

  1. The configuration menu allows to modify the various parameters of your portal.
  2. Allows you to switch from draft to current version
  3. The preview allows you to view the draft or the current version of your portal.
  4. The Publish draft button allows you to switch your draft to the current version. The Reset button allows to return to the default configuration.
  5. Edit content pages, allows you to add new written page to your portal

Configuration portail
Customize your data portals, without code

Configuration menu

General

The General section allows you to customize the elements common to the different portal pages such as colors, logo, main image and favicon.
You can activate or remove the authentication for your portal (open data portal, public portal with certain data in private, private portal).

It is possible to add several links in the footer.

Home page

This section allows you to customize the home page.
The main image can be displayed as a banner and it is also possible to display a visualization as a banner.

An editorial text will be displayed by entering a description.
It is possible to display the key indicators, the thematics and to highlight a visualization on your home page.
You can also define the number of datasets and / or visualizations you want to highlight.

Content

The content section allows to set the navigation mode on the dataset and visualization pages.
You can choose to have infinite scroll navigation or a pagination navigation.

Communication & contact

Allows to enter your website, twitter, Facebook, linkedin, youtube and instagram account.
By adding your contact email, the Contact page will be available in the navigation bar of your portal.

Monitoring

The monitoring allows to configure the activity tracking used on your portal such as Matomo (Piwik) or Google Analytics.

Technical settings

The technical settings allow you to customize the portal header and footer a little more.
It is possible to modify these two sections with HTML and CSS code.

Edit content pages

Content pages allow to create different types of pages: articles, thematic pages around several datasets, news pages, data storytelling, licenses, conditions of use, etc. and to give them even more context or create dashboards integrating different data.

A page is created with 3 steps: First you choose the page template, then you fill in the different elements using a form adapted to the chosen page template with a preview of the result.
It is possible to prepare pages and publish them later.
In addition to entering free text, it is possible to integrate different types of elements: dataset table, visualizations, list of datasets, integration of external content, etc.

Configuration portail
Customize your portal

It's possible to chose the acces to the content pages of your portal. Links can be displayed on the navigation bar, or in a scroll menu.

Content pages can be public or private.

11.1 - Create thematic pages on your portal

Content pages allow to highlight data, write articles, do data storytelling or even describe a license on your portal.

Create a content page

The Portals section of Data Fair allows you to access the configuration of your portals. You can then access the editing of content pages using the Edit content pages button at the top right.

Configurer votre portail

Then click on the create a new content page button.

A menu is displayed allowing you to fill in the parameters of your page:

  • The title of the page
  • Themes: choose the themes of your portal
  • The page template allows you to choose a predefined page layout.
  • The layout in the menu, as a direct link or in a sub-menu

Configurer votre portail
Parameters of this menu can be modified later.

On the image, the content page is called Land, has a thematic page template, a sub-menu layout and a Thematic as block name.

The blank page template allows to add and arrange the elements freely.
The thematic page template allows to add description of the page and a banner.
The news template allows you to create news pages

Configuration of your thematic page

On the left side of the editing page is the editorial content.
On the right side of your page, there is a preview of your content page updated in real time.

The editing part allows to add elements and page blocks like a CMS.

A block has different sections:

  • The title
  • General description
  • The visualization you want to present
  • The associated datasets which allow you to choose the datasets to highlight.
  • An accented text which allows to highlight an important text such as an information, a success, a warning or an error.

You can use the following video as an example to complete your first block:

Once your block has been edited, click on the pencil to exit edit mode.
You can then create multiple custom blocks.

After adding different blocks, you can publish your page so that it is accessible to visitors to your portal.
For an opendata portal, your page must be public to be available to visitors of your portal.

11.2 - Create a news page

The news pages allow you to communicate to your visitors the latest news that you want to put forward concerning the domain of your portal.

Creation of a news page

The Portals section of Data Fair allows you to access the editing of your portals. You can then access the editing of the Content Pages using the Edit Content Pages button at the top right.

Configurer votre portail

Then click on the create a new page button.

A menu is displayed allowing you to fill in the parameters of your page:

  • The title of the page
  • Themes : choose the themes of your portal
  • The page template allows you to choose a predefined page layout
  • The layout in the menu, in direct link or in a sub-menu

Créer votre news
Tous les paramètres de ce menu pourrons être modifié par la suite.

In our image the content page is called The new DATARMOR has arrived, that has a news page template and we have put Absent for the navigation bar.

Configuration of a news page

On the left side of the editing page is the editorial content, it will allow you to customize your page.
On the right side of your page, you have a preview of your content page that updates in real time.

The edition part allows you to fill in the elements of a news item:

  • The title displayed on the news page
  • The heading that allows a brief introduction
  • The image that will be displayed on the news page and in the news file
  • The general description which is the content of the news.

You can use the following video as an example to complete your first news item:

For an opendata portal, you will have to make your page public so that it is available to visitors not connected to your portal.

Portal configuration

Once you have made your first news, you can configure your portal so that the list of news is displayed on the first page:

Configurer votre portail pour avoir les news en page d'accueil

To display the news button on the navigation bar, choose infinite scroll list in the news section of your portal configuration:

Configurer votre portail

By clicking on the button in the navigation bar, visitors of your portal will be presented with a list of news items sorted from the most recent to the oldest:

Configurer votre portail

11.3 - Analytics setup

There are 2 steps in the configuration of the user tracking system

  1. Choosing the monitoring system on the portal
  2. Event configuration

You can choose between three different tracking systems, Matotmo, Google Analytics Universal Analytics (old version of GA) and Google Analytics 4 (new version of GA).

Matomo configuration

After creating the web site on Matoto, it will provide tracker url and th site id of your portal. You can then enter these codes on the configuration of your portal.

Google Analytics UA (old tracking system)

For Google Analytics Universal Analytics you will need the Tracking ID which you can find after creating your property on Google Analytics: Administration> Property Settings> Tracking ID .
The tracking ID is a code starting with UA- *

You can then enter this code on the configuration of your portal.

Configuration

Google Analytics 4 (new tracking system)

For Google Analytics Universal Analytics you will need the MEASURE ID which you can find after creating your property on Google Analytics: Administration> Property settings> Data feed > Add or click on data feed> MEASUREMENT ID.
The measure ID is a code starting with G- *.

You can then enter this code on the configuration of your portal.

Configuration

Event configuration

The event configuration is available in the Data Fair settings in the Webhooks category.

You can select which events you want to track in your analytics:

  • A new dataset has been created
  • A dataset has encountered an error
  • A dataset has been finalized and uploaded
  • A dataset has been published to a catalog
  • A new reuse has been created
  • A reuse encountered an error
  • A reuse has been published in a catalog
  • The file of a dataset has been updated

Configuration

11.4 - Réutilisations de vos données sur vos portails

When you set up a portal, you can enable reuses on your datasets.
Connected visitors will then be able to submit reuses using your data. You can decide to publish the reuses submited.

Enable reuses

In the configuration menu of your portal, you can activate the reuses for all connected users of your portal.

Réutilisations

Manage reuses

In the portal section of the back-office, you can access the administration of the reuses using the manage reuses button of your portal.

The elements of the reuses can be checked or modified by the administrators.
Once the validation is done, the administrator can check the publication box and save the reuse.
The visualization will then be available on the data pages used and on the list of reuses in your portal.

Réutilisations

11.5 - Réutilisations de vos données sur vos portails

Lorsque vous configurez un portail de données, vous pouvez activer les réutilisations sur vos jeux de données.
Les visiteurs connectés pourront alors soumettre une réutilisation des données de votre portail et vous pourrez décider de la publier.

Activer les réutilisations

Dans les menus de configuration de votre portail, vous pouvez activer les réutilisations pour tous les utilisateurs connectés de votre portail.

Réutilisations

Administrer les réutilisations

Dans la section portail du back-office, vous pouvez accéder à l'administration des réutilisation à l'aide du bouton gérer les réutilisations du portail.

Les éléments des réutilisations peuvent être vérifiés ou modifiés par les administrateurs.
Une fois la validation effectuée, l'administrateur peut cocher la case de publication puis enregistrer la réutilisation.
La visualisation sera alors disponible sur les pages de données utilisées et sur la liste des réutilisations de votre portail.

Réutilisations

12 - Account settings

Account settings are accessible from the navigation bar.

Sections in the account settings:

12.1 - Licenses and thematics

On the settings page you will find the Licenses and Themes sections.

Data can manage licenses and thematics lists for your data.

A license is referenced by its name and the address of a page that describes the content of that license.
A theme is defined by its name and color.

Licences
Add new licenses and themes easily

The licenses and thematics added to your configuration can then be assigned to the data.
The licenses and thematis will be available on your portal.

12.2 - API

On the settings page you will find the API Keys section.

API keys allow to use your account's global API for managing datasets, visualizations, catalogs or retrieving statistical informations.

You can create multiple different API keys.
Each key has its own label which allows them to be differentiated.

API-edition
Access your API

You can edit or delete your keys.
Help is available with the How to use this key button.

12.3 - Webhooks

Webhooks are used to synchronize computer systems. It is possible to send messages during updates on data for example.

List of triggering events:

  • Creation of a dataset
  • Errors on a dataset
  • Finalization of a dataset
  • Publication of a dataset in a catalog
  • Downloading a dataset
  • Creation of a visualization
  • Error on a visualization
  • Publication of a visualization in a catalog

Configure the event tracking for Google Analytics

To configure event tracking for Google Analytics, you will need a Google Analytics account with a configured property and a UA-XXXXXXXX-X number configured for your site.

Once you configured your Google Analytics account and got your UA-XXXXXXXX-X number, you can use it on the Webhooks section of your Data Fair account.

When you are on the settings page, you can add an 'External calls' using the + button.
A window appears to configure your call.
Fill in the title, the trigger events you want to track from the list, then choose Google Analytics as the target type.
In the Tracker ID section, enter your UA-XXXXXXXX-X number.

Once your webhook is validated, you will have a rendering like this:

webhook
Koumoul webhook for Google Analytics configured

If you have correctly configured your calls, you will be able to view the number of events by type that the users of your portal have carried out in the Behavior> Events> Main events section of your account Google Analytics.

webhook

To obtain the details of the downloads, click on Event action for the type of events dataset.

webhook

13 - Catalogs

Connectors allow you to interact, read and write, with other platforms or data services.

With the writing interaction, metadata is pushed into other catalogs.
An example of a catalog is the French National Open Data Catalog data.gouv.fr : datasets published with Data Fair can be automatically synchronized and any metadata changes on Data Fair are propagated to the remote catalog.

With the reading interaction, connectors are harvesters of metadata and data.
It is possible, for each connector, to configure the collection frequencies and the types of sources to harvest.

Data.gouv.fr catalog configuration

Here is the configuration of the Koumoul organization's data.gouv.fr catalog :

Catalogue
Set up catalogs and make your data accessible from other platforms

  1. Catalog title
  2. Catalog description
  3. Catalog API key
  4. Dataset link
  5. Visualization link

Links to datasets and visualizations correspond to the pages of your portal to which you wish to redirect visitors who are going to navigate to your portal.

The API key to be entered corresponds to the key you generate on your data.gouv.fr account in your personal space :

Catalogue
Create your API key

14 - Periodic processings

Periodic processing allows to fetch data, transform it and publish it on the platform.
They can be used for automatic data update on regular intervals.

Periodic processing differs from catalog connectors on several points:

  • Processing are limited to a small set of input and output sources. Typically, it can retrieve data in one place, metadata in another, and dump the data into a Data Fair source.
  • Collection frequencies can be higher: Data can be collected with a few seconds intervals, which is suitable for publishing IOT data.
  • Periodic processing can only be configured by a platform administrator. Please contact us if you are interested in periodic treatment.

Traitements périodiques
Collectez, transformez et publiez vos données automatiquement

Periodic processing includes several configuration elements:

  • Active or not active
  • The time step: Monthly, weekly, daily or hourly
  • The action: Create a new dataset or Update an existing dataset
  • Parameters: allow, for example, to delete uploaded data used for periodic processing

    The execution history is available and errors are reported in this log.

Traitements périodiques