This page guides you through the process of creating a dataset in Tilebox using the Tilebox Console.

Creating a dataset in the Console

1

Navigate to the Create dataset form

Create a dataset in Tilebox by going to My datasets and clicking the Create dataset button.

2

Select a dataset kind

Choose a dataset kind from the dropdown menu. Required fields for the selected dataset kind are automatically added.

Tilebox ConsoleTilebox Console
3

Specify a name, code name, and description

Complete these fields:

  • Name is the name of your dataset.
  • Code name is a unique identifier for the dataset within your team. It’s automatically generated, but you can adjust it if needed.
  • Description is a brief description of the dataset purpose.
Tilebox ConsoleTilebox Console
4

Define the dataset schema

Specify the fields for your dataset.

Each field has these properties:

  • Name is the name of the field (it should be snake_case).
  • Type and Array let you specify the field data type and whether it’s an array. See below for an explanation of the available data.
  • Description is an optional brief description of the field. You can use it to provide more context and details about the data.
  • Example value is an optional example for this field. It can be useful for documentation purposes.
Tilebox ConsoleTilebox Console
5

Save

Once you’re done completing the fields, click “Create” to create and save the dataset. You are redirected to your newly created dataset.

Automatic dataset schema documentation

By specifying the fields for your dataset, including the data type, description and an example value for each one, Tilebox is capable of automatically generating a documentation page for your dataset schema.

Dataset schema overviewDataset schema overview

Adding additional documentation

You can also add custom documentation to your dataset, providing more context and details about the data included data. This documentation supports rich formatting, including links, tables, code snippets, and more.

Tilebox ConsoleTilebox Console

To add documentation, click the edit pencil button on the dataset page to open the documentation editor. You can use Markdown to format your documentation; you can include links, tables, code snippets, and other Markdown features.

If you don’t see the edit pencil button, you don’t have the required permissions to edit the documentation.

Once you are done editing the documentation, click the Save button to save your changes.