Dataset module

Setup

To begin using the Dataset Module in your H5mag project, we need to enable it for you. This feature is currently available to Enterprise subscribers only. Please contact us if you are interested.

Overview

The Dataset Module is designed to store and manage large volumes of (relational) data, functioning similarly to a database. This module is particularly useful for customers looking to dynamically display data in their magazines, enabling real-time data integration and visualization.

For example, consider an 'Employees' dataset. It contains 4 'fields' that define one row of data, which can be utilized in your publications. In this scenario, a dynamic list of employees could be displayed.

Getting started

Once the dataset module is enabled for your project, proceed by selecting Dataset in the top menu bar.

1. Create your first dataset, a title is required in order to identify the dataset.
2. Add fields related to the data you wish to store, such as "First Name," "Last Name," or "Job Title".
3. Click on 'Create dataset'.
4. Now that you have created the dataset, you can start adding data to it. Click on + Add row.
5. Fill in the fields with your data.
6. Your data is now ready for use in your magazine. For the right implementation of the data in your magazine please contact us.

Using the API

Access to the datasets module is available through the API, with detailed documentation available on Stoplight. The API supports features such as:

• Creating datasets
• Editing datasets
• Adding data to the datasets
• Uploading data in CSV format

To utilize all functionalities of the datasets API, an API key is required. This can be found under Accounts/ H5mag.