Create stream type

You can create a type using the CONNECT portal. This user-friendly method makes the type-creation process easier by setting safeguards that reduce the likelihood of creating an invalid type definition—the forms available while creating a type includes system validation that flags any properties or settings that are invalid.

Want to create a type for entities or events? See Types Store instead.

To create a stream type

1. In the navigation rail, select Data stores.

2. From the Change data store dropdown, verify that the data store instance containing the resources and data you want to work with is selected.

3. Select the Streams card.

4. Select the Stream types tab.

5. Select Create type.

   The Create type side sheet opens.

6. Verify that Standard type is selected. Enum type is described in Create enum type.

7. Enter identification information for the type. You will use this information later to find the type within your account.

   Complete the following fields:

   • ID: Identifier for the type.

   • Name: Name for the type.

   • Description: A description of the type.

8. (Advanced) Base type: An existing type on which to base the type you are adding. If you select a base type, the type you are creating inherits properties from the base type. Inherited properties are read only and cannot be modified. For more information, see Base type.

   If you are making a type for the first time, skip this step.

9. Add a property of type DateTime and set it as key.

   The structure of a type is comprised of two or more properties, which are fields that capture information about an environment measurement over time. For a detailed description, see Type properties.

   The first property included in a type is almost always a timestamp of type DateTime, which should be set as the key property. The key property is used to create a unique identifier for stream data points. It’s also used to index stream data after data is written to the stream.

   1. Select Add property.

   2. Select the Key checkbox.

   3. Enter an ID.

   4. Enter a Name.

   5. From Type, select a DateTime data type.

   A property of type DateTime is usually sufficient to create a unique identifier, but some streams may require a compound key, which uses more than one property to create a unique identifier. For more information, see Keys.

10. Add additional Properties to the type.

    The subsequent properties that you add to the type represent the data points that you want to associate with the key. These properties can represent things like a temperature reading, water consumption, or speed.

    Want to add an enumeration set as a property? See Create enum type before continuing.

    1. Select Add property.

    2. Enter an ID.

    3. Enter a Name.

    4. From Type, select the data type for the property. For more information, see Property type.

    5. Select a unit of measure (UOM) for the property, if applicable.

       It is best practice to assign a unit of measure to each property. This assignment provides context to users reading stream data derived from the type later. It is also used in conversions to other UOMs.

    6. To add more properties, repeat these substeps.

11. Select Save.

    The type is saved to your selected service instance. You can now create streams based on the type. For more information, see Add Stream.