The data portal allows visitors to quickly access data.

The portal consists of different pages:

1. Home page
2. Data page
3. Visualizations page
4. Content Pages

The home page provides an overview of the data present on the data portal.
It allows visitors to quickly access the data highlighted, view key figures, search for data or connect to the portal.

Home page

We will describe the home page of the Koumoul open data portal .

1. Portal logo
   By clicking on the logo of the portal you can access the institutional site.
2. Portal title
3. Links to the social networks of the portal producer
4. Navigation bar
   The navigation bar takes you to the main data and visualization pages as well as the content page, your notifications, and portal login if available.
5. Notifications
   The notification bell allows you to view the latest notifications on your account. Clicking on a notification navigates you to the dataset page.
   Notifications are only available to logged in users.
6. Login to the portal
   On some portals, it is possible to create an account and connect to your account. Accounts are required to access private data or to use portal notifications.
7. Description and main image
8. Research
   The search bar allows you to search the metadata of portal datasets.
9. Themes
   A click on a theme allows you to filter the data by this theme.
10. Featured visualization and twitter of the portal producer
    Portals can display a featured visualization as well as the latest tweets from the producer's account. The visualization can be used directly on the home page. The visualization page can be accessed by clicking on the visualization title.
11. Latest dataviz
    Visualizations are presented as cards with a title, a preview of the visualization, and two action buttons. The first action button is used to display the visualization in a window while remaining on the home page. The second action button takes you to the visualization page.
12. Latest datasets
    The data files are presented in the form of cards with a title, a description, action buttons and the date of the data update. Three action buttons are always available: The table which provides access to the first 10,000 rows of data in tabular format, the dataset API documentation and the dataset schema. If the dataset has coordinates, the icon to display a generic map will be available.
13. Footer
    In the footer you can find the links to the social networks of the producer as well as links added by the producer of the portal. Links can be displayed as logo

The data page gives you access to all of the portal's data.
The display is responsive and allows browsing both on a computer and on a mobile device.

The number of datasets to which you have access as well as the dataset catalog download button is displayed on the first line of the page.
The search function as well as filters by concepts and sorting are available.
It is also possible to sort the datasets by theme by clicking on one or more of the themes displayed.

Each dataset is presented in the form of a card containing the title, the beginning of the description, the theme and action buttons. The action buttons allow you to access the windowed or full-screen table, the API documentation, the dataset schema as well as the generic map of the datasets if it has contact information.

Clicking on the card takes you to the dataset page.

The page of a dataset is composed of several elements:

1. The title and description of the dataset
2. Dataset metadata and action buttons
3. Social media sharing icons
4. Visualizations

External visualizations can be added at the end of the dataset page.

)

Title and description

The title and description of the dataset provide context to the data. The description presents the data, differents process to obtain the data or presents the producer of the data.

Metadata and action buttons

Metadata is available as a card. They contain the number of lines, the size of the csv file, the data source when it is external, the license as well as the data producer when it is filled in.

Action buttons are also dsiplayed in this section.
From left to right: the table, the full screen table, the generic map, the API documentation, the original file download, the enriched data download, the data schema, the HTML code to embed the table or the map to a site as well as the notification bell to subscribe to the dataset.

Table

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

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

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.

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.

The full screen table

The full-screen table has the same functionality as the table.

1. search bar
2. navigation pages
3. columns choice
4. download
5. filters on a column
6. the filter on a value of a column
7. navigation bar

The generic map

The generic map presents geographical data. A click on one of the points or geometries allows you to display the raw data of the element.

<img src="./images/user-guide-frontoffice/carte-g.png" height="300" style="margin:15px auto;" /

API Documentation

Each dataset has its own API. The API's interactive documentation allows developers to perform queries and view results quickly.

Download the original file The download button in the metadata allows you to download the raw data file. The format depends on the type of file imported by the data producer.

Download enriched data The download button in the metadata allows you to download the CSV file containing the raw data as well as the enriched data. The enriched data are presented in the form of columns at the end of the table.

Schema description

You can access to the key, name, type, concept and description of each of the columns of the dataset.

Embed code

This code allows you to embed a table or map of a dataset on an external site as an iframe. Visitors of your site will have access to the data without having to navigate to the data portal.

Attachments

Attachments correspond to files added to the dataset. They can contain a dictionary of variables, a description of the data in PDF format or even an image corresponding to the data.

Notifications

It is possible to activate two types of notifications on a dataset:

• Updating data
• Data compatibility break

The data compatibility break corresponds to a modification of the dataset schema.

Sharing icons

Sharing icons allow you to quickly share the page link on different social networks. The share thumbnail is the thumbnail of the first visualization of the page.

Visualization

Interactive visualizations make it easy to access and explore the dataset.
The descriptions provides a better understanding of the data and the producer of the data can put forward some interesting points.

Clicking on the title of a visualization takes you to the visualization's page. On this page, you find the description and the visualization is displayed larger.

The visualizations page gives you access to all of the portal's visualizations.
The display is responsive and allows browsing both on a computer and on a mobile device.

The search bar as well as filters by type of visualization and sorting are available at the top of the page. It is also possible to sort the visualizations by theme by clicking on one or more of the themes displayed.

Each visualization is presented in the form of a card containing the title, an overview of the visualization, the theme and action buttons.
The action buttons allow you to access the visualization in a window or in full screen.

Clicking on the card takes you to the visualization page.

The page of a dataset is composed of several elements:

1. The title and description of the dataset
2. Dataset metadata and action buttons
3. Icons for sharing on social networks
4. Visualization
5. Data used in visualization

Title and description

The title and description of a visualization help to provide context, better understand the data and discover certain points put forward by the producer of the data.

Metadata and action buttons

Metadata are available as a card. They contain the organization that published the visualization, the type of visualization, action buttons, and the date the visualization was updated.

Action buttons provide access to HTML code to embed the visualization on an external site as well as a full-screen presentation of the visualization.

Sharing icons

Sharing icons allow you to quickly share the page link on different social networks.
The share thumbnail is the visualization preview.

Visualization

All of our visualizations are interactive. They make it easier to explore the data.

Données utilisées

The data used are presented in the form of sheets. Each card is composed of a title, a description, themes and action buttons.
Clicking on the card takes you to the dataset page.

Content pages are available in the navigation bar as a direct link to the page or as submenus.
These pages make it possible to present a set of data sets, a license or a particular approach.

For the moment, two types of presentations of these pages are available: the thematic pages and the free presentation pages.

Thematic pages

Theme pages are presented with an image as a banner.

The thematic pages are composed of several blocks, presenting one or more datasets per block.

Each blocks are contain a title, a description, a visualization and the datasets associated with the block.

Free pages

Free pages are less structured than theme pages and are more easily customizable.

Freeform pages allow more different content to be displayed and easier to modify page components

An account allows you to submit reuses as well as to have faster access when calling APIs.

In your personal area, you have access to the data provided and also the password renewal and deletion of your account.

Submit a reuse

Once logged in you can submit a reuse from your personal space or directly on a data page.

Fill in the different elements of the reuse. As long as you have not submitted your reuse, you can modify it.

After submitting your reuse, using the green arrow, only the portal administrators will be able to modify and validate the submission.

Notifications

The notifications section allows you to enable global notifications on the addition of datasets to the portal or the addition of a particular portal topic.

For targeted notifications on datasets, visit the dataset page and click on the bell in the metadata.

Clés d'API

API keys allow you to have a better throughput for your requests.
You can create multiple API keys, the throughput will then be shared across all your keys.

• An anonymous user may not make more than 100 requests per 5-second interval. Its total download speed will be limited to 2 MB/s for static content (data files, attachments, etc.) and 500 kB/s for other calls.
• An authenticated user (session or API key) may not make more than 100 requests per 1 second interval. Its total download speed will be limited to 4 MB/s for static content (data files, attachments, etc.) and 1 MB/s for other calls.