DataKitchen DataOps Documention

Supported Naming Conventions

All objects in the DataKitchen DataOps platform should follow DataKitchen's naming conventions and best practices.

Basic Object Naming Rules

The basic rules apply generally to all object names.
- Names are case-sensitive.
- Names may include alpha-numeric and underscore characters.
- Names must NOT include hyphens, dashes, and other special characters.

The following table lists requirements specific to each object type.

Object Type
Name Requirements
Length

ALL OBJECTS

Case-sensitive
Allowed: alpha-numerics, underscore
Not allowed: hyphen, dash, other special characters

Kitchen

Unique within a customer implementation

2 chars min., 64 chars max.

Recipe

Unique within a kitchen

__

Variation

Unique within a recipe

__

Ingredient

Unique within a recipe

__

Node

Unique within a recipe

__

Graph

Unique within a recipe

__

Override Set

Unique within a recipe

__

Variable

Unique within a recipe
Cannot start with a number

__

Schedule

Unique within a recipe

__

Source/Sink

Unique within a node

__

Test

Unique within a node
Allowed: alpha-numerics, underscore, period, forward slash

256 chars max.

Step (in action node)

Unique within a node
Allowed: alpha-numerics, underscore, period, forward slash

256 chars max.

Mapping (in DataMapper node)

Unique within a node
Allowed: alpha-numerics, underscore, period, forward slash

256 chars max.

Runtime Variable

Cannot start with a number
Unique within a recipe (variables with the same names override each other)

__

Secret

Unique within a vault (global, kitchen)
Allowed: alpha-numerics, underscore, period, forward slash

__

Report

Allowed: ANY characters
Unique within a customer implementation

__

JSON Key Names

A JSON object is defined by a single pair of curly brackets surrounding one or more key-value pairs. A JSON dictionary is likely to contain several key-value pairs. The platform does not allow duplicate key names within a single JSON object or dictionary "block." Users can, however, place duplicate key names in nested objects.

No Duplicate Key Names

In any recipe file, you cannot use the same key name within a single JSON object.

Invalid Format
The platform will generate an error in the web app or command line interface if it tries to process this JSON format.

    {
      "samekey": "first value",
      "samekey": "second value"
    }

Valid Format

    {
       "samekey": {
           "samekey": "second value"
       }
    }

Updated 5 days ago

Supported Naming Conventions


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.