Tags

This document will help you understand and use the novem tagging features

Overview

Novem offers a set of basic tagging features to help you organise your data. The tags are split into two types of categories:

  • system - Tags predefined by novem that you cannot control, these are for things such as favourites and likes.
  • user - Your personal tags, these are for you to define and use.

The tags are exposed in the api at a top level tags endpoint as well as under each of the items that you can apply the tag to, such as plots, mails, grids and repos.

Below is an overview of the main tag endpoints.

.
├── admin
│   └── tags
│       └── +user_tag
│           ├── color
│           ├── description
│           └── name
├── tags
│   ├── +user_tag
│   │   ├── jobs
│   │   ├── repos
│   │   └── vis
│   │       ├── docs
│   │       │   └── @colleague~readme_doc
│   │       ├── grids
│   │       │   └── @colleague~layout
│   │       ├── mail
│   │       ├── plots
│   │       │   └── @other_user~other_plot
│   │       └── views
│   └── fav
│       ├── jobs
│       ├── repos
│       └── vis
│           ├── docs
│           ├── grids
│           ├── mail
│           │   └── @some_user~some_mail
│           ├── plots
│           │   ├── @other_user~other_plot
│           │   └── @username~plot_name
│           └── views
└── users
    └── other_user
        └── vis
            └── plots
                └── other_plot
                    └── tags
                        ├── +user_tag
                        └── fav

Tag types

As mentioned there are two types of valid tags on the novem platform, user tags and system tags.

User tags

The most common tag you will use are probably user tags. Usertags must always start with a + followed by a lowercase letter and then one or more lowercase letters, numbers, - and _.

Examples of valid tags:

  • +my_user_tag
  • +cat5
  • +sen-dev-stack

Examples of invalid tags:

  • abc
  • +5cat
  • +long_A

System tags

The novem system tags are special and only a few of them exist. They are defined by novem and not possible to change or modify.

There are currently 4 system tags:

  • fav a way to favourite a vis
  • like a way to like a vis

Tagging a vis

To tag a novem vis you simply PUT the tag in the respective vis’s tags folder. User tags will be automatically created if they don’t already exist.

PUT
/vis/plots/test_plot/tags/+important

For example, the above tags your own plot called test_plot, with your user tag +important.

PUT
/users/my_colleague/vis/plots/kpi_report/tags/+important

And this is how you tag your colleague’skpi_report plot with the same tag.

To tag an e-mail you would simply perform the same action on the e-mail endpoint.

PUT
/vis/mails/daily_kpi_report/tags/+important

Listing your tags

To list your tags you will find them available at the top level /tags endpoint. Simply navigate the structure and you’ll find all visualizations and other items under their respective tags.

Customization

You may further customize your user tags with colors, names and descriptions. This is done with POST to the respective endpoints under the admin structure.

└── admin
    └── tags
        └── +important
            ├── color
            ├── description
            └── name

For example, if you were to create a new tag +important to tag things that were important to you, you could customize it as follows.

POST
/admin/tags/+important/color
orange-500  -- you can choose any novem color or a hex code
POST
/admin/tags/+important/name
Important
POST
/admin/tags/+important/description
Key business indicators
← Overview
Social →