Stay organized with collections
Save and categorize content based on your preferences.
Create a type
This guide describes how to create a new type in Manufacturing Data Engine (MDE). You
can create a type using the configuration API or MDE web interface.
Before you begin
Among other configuration settings, types lets you define the
contextualization scope for records of that type - the metadata buckets that can
or must be used to contextualize records. If you want to associate a metadata
bucket to a type, you first need to create the bucket. For more information, see
how to create a metadata bucket.
Types naming
When you create a type, the name must be unique in an MDE
deployment. Type names must not contain spaces or special characters such as
&, @, or %.
Create a type
To create a type with one metadata bucket association and typical storage
specifications you can use either the terminal or the console interface.
ARCHETYPE: Name of the archetype. One of DISCRETE_DATA_SERIES,
CLUSTERED_DISCRETE_DATA_SERIES,
NUMERIC_DATA_SERIES,
CLUSTERED_NUMERIC_DATA_SERIES,
CONTINUOUS_DATA_SERIES,
CLUSTERED_CONTINUOUS_DATA_SERIES.
TYPE_NAME: Name of the type to be created.
BUCKET_NAME: Name of the bucket to be associated to this type.
BUCKET_VERSION: Version of the bucket to be associated to this
type.
Console
To create a new Type using the Console open the Type section
tab.
All available types in the MDE instance are
listed in this section. The list exposes the basic configuration of each
type, including:
Name: Unique name of the type. All types must have different
unique names.
Storage: Displays the current Storage Specs associated to the
type.
Archetype: Shows the name of the archetype defining the type.
Each type is associated to a unique archetype. The archetype
association can't be modified after the type is created.
Version: Version number of the type. A type can be
versioned. The default view in this list only displays the latest
version available for the type. It is possible to show older version
by un-checking the Show Latest check-box.
Metadata: Renders a color-coded badge for each metadata bucket
associated to the type. Tag metadata buckets are differentiated
from Record metadata buckets using a specific icon inside the badge.
Transformations: Displays a badge for each transformation type
associated to the type.
Enabled: Displays a true value if the type is enabled and
a false value if it isn't. You can enable or disable types at
any time.
Active: When types are created take a certain time to provision.
While types are being provisioned their active status is
false. When they are ready they show as true.
Each new type provisions its own infrastructure to store its tags
and Records for all Data Sinks when it is created. For example, a
new type will create a new Table in BigQuery with the new of the
type and will automatically populate the schema corresponding to its
archetype in it. While the type is provisioned it appears as Non Active.
To create a new Type, click Add New Type. The
following form will appear:
To define a new Type provide its name and its
archetype. Once the type is created, its name and archetype can't be
changed. All types must have different unique names. Archetypes must
be selected from the available archetype list. You can't create or modify
existing archetypes as they are part of the system configuration.
Open the Data Schema section to define, if needed,
the JSON schema defining the data field of the mew type:
The Data Schema needs to be a valid JSON Schema or won't be
accepted. This data schema is not enforced as part of the ingestion
pipelines. In future MDE versions, the data object
in the incoming messages
will be validated against the data schema of its type. The data
schema provides visibility over the structure of the data field
available in the different Data Sinks. Each data schema
specification needs also to be defined according to the characteristics of
the archetype.
Complete the definition of the new type by defining the
metadata buckets that are associated with the type opening the
Metadata buckets section:
To add a metadata bucket to the type click ADD.
Pick from the list of available metadata buckets the ones to add.
Only the latest version of those buckets is displayed. metadata bucket
Versions can be updated later creating a new version of the type. A
new badge appears in the Metadata section after the buckets are added.
Define the default storage settings by opening the
Storage Settings section of the form. Inside this section there is a toggle
button for each data sink available in this instance of MDE.
Select each sink where the tags belonging to this type are be stored
by default. The storage specification is inherited by the tags when
they are created. The storage specification can be modified at the
tag level at any time.
To complete the definition of a new Type select which
transformations are associated to this type by opening the
Transform & Connect section.
After all the parameters have been added, save the new Type by
clicking CREATE. If any of the parameters are incorrect
an error message is displayed. If the operation is successful, a
confirmation message is displayed.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Create a type\n=============\n\nThis guide describes how to create a new type in Manufacturing Data Engine (MDE). You\ncan create a type using the configuration API or MDE web interface.\n\nBefore you begin\n----------------\n\nAmong other configuration settings, types lets you define the\ncontextualization scope for records of that type - the metadata buckets that can\nor must be used to contextualize records. If you want to associate a metadata\nbucket to a type, you first need to create the bucket. For more information, see\n[how to create a metadata bucket](/manufacturing-data-engine/docs/guides/model/how-to-create-a-metadata-bucket).\n\nTypes naming\n------------\n\nWhen you create a type, the name must be unique in an MDE\ndeployment. Type names must not contain spaces or special characters such as\n`&`, `@`, or `%`.\n\nCreate a type\n-------------\n\nTo create a type with one metadata bucket association and typical storage\nspecifications you can use either the terminal or the console interface. \n\n### REST\n\nExecute the following REST API request:\n\n`POST /configuration/v1/types` \n\n {\n \"archetype\": \"\u003cvar translate=\"no\"\u003eARCHETYPE NAME\u003c/var\u003e\",\n \"name\": \"\u003cvar translate=\"no\"\u003eTYPE_NAME\u003c/var\u003e\",\n \"metadataBuckets\": [\n {\n \"bucketName\": \"\u003cvar translate=\"no\"\u003eBUCKET_NAME\u003c/var\u003e\",\n \"version\": \"\u003cvar translate=\"no\"\u003eBUCKET_VERSION\u003c/var\u003e\"\n }\n ],\n \"storageSpecs\": [\n {\n \"sink\": \"BIG_QUERY\",\n \"disabled\": \"false\",\n \"materializeCloudMetadata\": \"true\"\n },\n {\n \"sink\": \"BIG_TABLE\",\n \"disabled\": \"false\",\n \"materializeCloudMetadata\": \"false\"\n },\n {\n \"sink\": \"GCS\",\n \"disabled\": \"false\",\n \"materializeCloudMetadata\": \"false\"\n },\n {\n \"sink\": \"PUBSUB_PROTO\",\n \"disabled\": \"false\",\n \"materializeCloudMetadata\": \"false\"\n },\n {\n \"sink\": \"PUBSUB_JSON\",\n \"disabled\": \"false\",\n \"materializeCloudMetadata\": \"false\"\n }\n ]\n }\n\nReplace the following:\n\n- `ARCHETYPE`: Name of the archetype. One of `DISCRETE_DATA_SERIES`, `CLUSTERED_DISCRETE_DATA_SERIES`, `NUMERIC_DATA_SERIES`, `CLUSTERED_NUMERIC_DATA_SERIES`, `CONTINUOUS_DATA_SERIES`, `CLUSTERED_CONTINUOUS_DATA_SERIES`.\n- `TYPE_NAME`: Name of the type to be created.\n- `BUCKET_NAME`: Name of the bucket to be associated to this type.\n- `BUCKET_VERSION`: Version of the bucket to be associated to this type.\n\n### Console\n\n1. To create a new **Type** using the Console open the **Type** section\n tab.\n\n2. All available types in the MDE instance are\n listed in this section. The list exposes the basic configuration of each\n type, including:\n\n- **Name**: Unique name of the type. All types must have different unique names.\n- **Storage**: Displays the current Storage Specs associated to the type.\n- **Archetype**: Shows the name of the archetype defining the type. Each type is associated to a unique archetype. The archetype association can't be modified after the type is created.\n- **Version** : Version number of the type. A type can be versioned. The default view in this list only displays the latest version available for the type. It is possible to show older version by un-checking the **Show Latest** check-box.\n- **Metadata** : Renders a color-coded badge for each metadata bucket associated to the type. Tag metadata buckets are differentiated from Record metadata buckets using a specific icon inside the badge.\n - **Transformations**: Displays a badge for each transformation type associated to the type.\n- **Enabled** : Displays a `true` value if the type is enabled and a `false` value if it isn't. You can enable or disable types at any time.\n- **Active** : When types are created take a certain time to provision. While types are being provisioned their active status is `false`. When they are ready they show as `true`.\n\nEach new type provisions its own infrastructure to store its tags\nand Records for all Data Sinks when it is created. For example, a\nnew type will create a new Table in BigQuery with the new of the\ntype and will automatically populate the schema corresponding to its\narchetype in it. While the type is provisioned it appears as `Non Active`.\n\n1. To create a new **Type** , click **Add New Type**. The\n following form will appear:\n\n2. To define a new **Type** provide its name and its\n archetype. Once the type is created, its name and archetype can't be\n changed. All types must have different unique names. Archetypes must\n be selected from the available archetype list. You can't create or modify\n existing archetypes as they are part of the system configuration.\n\n3. Open the **Data Schema** section to define, if needed,\n the `JSON schema` defining the data field of the mew type:\n\n4. The **Data Schema** needs to be a valid `JSON Schema` or won't be\n accepted. This data schema is not enforced as part of the ingestion\n pipelines. In future MDE versions, the data object\n in the incoming messages\n will be validated against the data schema of its type. The data\n schema provides visibility over the structure of the data field\n available in the different Data Sinks. Each data schema\n specification needs also to be defined according to the characteristics of\n the archetype.\n\n5. Complete the definition of the new type by defining the\n metadata buckets that are associated with the type opening the\n **Metadata buckets** section:\n\n6. To add a **metadata bucket** to the type click **ADD**.\n\n7. Pick from the list of available **metadata buckets** the ones to add.\n Only the latest version of those buckets is displayed. metadata bucket\n Versions can be updated later creating a new version of the type. A\n new badge appears in the Metadata section after the buckets are added.\n\n8. Define the default **storage settings** by opening the\n **Storage Settings** section of the form. Inside this section there is a toggle\n button for each data sink available in this instance of MDE.\n\n9. Select each sink where the tags belonging to this type are be stored\n by default. The storage specification is inherited by the tags when\n they are created. The storage specification can be modified at the\n tag level at any time.\n\n10. To complete the definition of a new **Type** select which\n transformations are associated to this type by opening the\n **Transform \\& Connect** section.\n\n11. Select the **transformations** to be associated to the type and define\n its parameters as per\n [how to configure a Transformation](/manufacturing-data-engine/docs/guides/transform/how-to-configure-transformers).\n\n12. After all the parameters have been added, save the new **Type** by\n clicking **CREATE**. If any of the parameters are incorrect\n an error message is displayed. If the operation is successful, a\n confirmation message is displayed."]]