CSV Template Structure (Add new items)

Overview

This document outlines the required CSV structure when adding new metadata objects using the Export/Import feature in Decube. It covers supported object types, required fields, field-level constraints, and examples to help you construct your templates accurately.

Supported Object Types

You can use the Add New Items workflow to create:

  • Glossary Objects: Glossary, Category, Term (within a single template)

  • Classification Policies

To get started, download the appropriate CSV templates from the Export/Import > Export > Add New Items tab.

⚠️ Important Notes & Tips

Before starting lets just focus on important notes first

  • Use official templates only: Download templates from docs.decube.io to avoid schema mismatch errors.

  • Don’t rename headers: Modifying column headers will break import.

  • Fill in correct Type values: Type must be correctly set as Glossary, Category, Term, etc.

  • Multi-value fields (Tags, Owners, Related Terms, Linked Assets) must use comma-separated values.

  • One logical operation per file: For new items, keep only relevant object types per file (e.g., all glossary rows or all policy rows).

  • Do not leave required fields blank: All required fields must be filled. Optional fields can be left empty.

  • Check limits:

    • Descriptions: Max 8000 characters

    • Tags/Owners: Max 3

    • Names: Max 100 characters

  • Linked Assets and Related Terms require strict formatting:

    • Linked Assets → type:source.schema.table.column

    • Related Terms → Glossary.Category.Term

  • Empty attributes will not throw errors but will be treated as intentionally empty.

Below is a breakdown of editable fields, format requirements, character limits, and constraints by object type.

All empty value in any editable attribute will overwrite and clear the existing value.

Glossary, Category, Term

All three object types—Glossary, Category, and Term—are handled in a single CSV file. The Type column determines what you're creating on each row. Required fields vary based on the type selected.

Use this template to create new glossary, category and term.

When handling glossary objects with a . in the name, please use escape slash before the . to indicate. eg. glossary object "Marketing.Plans" should be marketing\.plans

  • Use "Glossary", "Category", or "Term" in the Type column to identify the object.

  • For terms added under a category, both Glossary and Category fields are required.

  • Term can be added directly under a glossary.

  • Leave unused identifier fields blank depending on the Type.

Template Columns

Field

Field Type

Required

Description

Constraints

Example

Glossary

Identifier

Yes

Name of the glossary

Max 100 chars, unique

Glossary_1

Category

Identifier

Conditional (read description)

Required (if creating term under category or category) Not required (for adding glossary)

Max 100 chars, unique

-

Term

Identifier

Conditional (read description)

Required (if creating term) Not required (for adding glossary or category)

Max 100 chars, unique

-

Type

Identifier

Yes

Type of the object ( whatever object you are creating)

Must be Glossary, Category or Term

Glossary

Data Owners

Editable Attribute

No

Designated data owners

Comma-separated emails, ≤3

Business Owners

Editable Attribute

No

Designated business owners

Comma-separated emails

Description

Editable Attribute

Yes

Glossary, category and term level description

Max 8000 chars

Some text

Classifications

Editable Attribute

No

Policy tags (only applicable for term)

Must exist policy

PII

Related Terms

Editable Attribute

No

Related terms (only applicable for terms)

glossary.term, comma-separated

Glossary_1.Term_1

Classification Policies

Use this template to create new policies.

Template Columns

Field

Field Type

Required

Description

Constraints

Example

Name

Identifier

Yes

Name of the classification policy

Unique

PII Classification

Policy Tag

Identifier

Yes

Short unique tag for the policy

Max 5 chars, unique

PII

Description

Editable Attribute

No

Description of the policy

-

Protects PII data

Purpose

Editable Attribute

No

Purpose of the policy

-

Regulatory

Stewards

Editable Attribute

No

Responsible users

Comma-separated emails

These format ensures consistent structure and validation for adding metadata in bulk via CSV Export/Import. Make sure identifier fields are correct and that each row adheres to constraints to avoid import failures.

Last updated