Add a type
- Last UpdatedApr 19, 2024
- 3 minute read
Sequential Data Store (SDS) types define the shape and structure of events and how to associate events with streams of data. Once created, you cannot modify a type. You can add one of two types: Standard Types or Enum Types.
To add a base type:
-
In the left pane, select Data Management > Sequential Data Store.
-
From the Streams dropdown list, select Types.
-
Select Add Type.
The Add Type pane opens.
-
Ensure Standard Type is selected.
-
Complete the following fields:
-
Id – Enter the Id for the type.
-
Name – (Optional) Enter a user-friendly name. If you do not enter a name, the Id is used as the name.
-
Description – (Optional) Enter a user-friendly description of the type.
-
Type – (Optional) To base the new type on an existing standard type, select the existing type from the dropdown. The new type inherits the properties of the base type. Inherited properties are read only and cannot be modified.
-
-
For each property to add to the type, select Add Property and complete the following fields:
-
Key – Select the checkbox to indicate the property is an index. Only system SDS types can be designated as keys. You can select up to three properties as indexes. Drag and drop the properties in the list to reorder the index keys.
Important: You can only create streams from types that have an indexed defined. In other words, the type must have a key defined, or the type will not be available for selection when Manage streams.
-
Id – Enter the identifier for referencing the property.
-
Name – Enter the name of the property. If you do not enter a name, the Id is used as the name.
-
Base Type – Select the SDS type of the property from the dropdown.
Note: To find the type in the list, filter the property types by entering text in the Filter Types field and use the System or Tenant controls to include or exclude these types. Tenant includes any types that were previously created in the selected namespace for a particular tenant. System includes SDS types that are provided and defined such as string, integer, double, datetime, and Boolean.
-
UOM – (Optional) Select a unit of measure for the property from the list.
-
-
To save the type, select Save.
You can also create enumeration types that you can include as a property in standard types.
To add an enum type:
-
In the left pane, select Data Management > Sequential Data Store.
-
From the Streams dropdown list, select Types.
-
Select Add Type.
The Add Type pane opens.
-
Select Enum Type.
-
In the Add Enum Type pane, complete the following fields:
-
Id – Enter the Id for the type.
-
Name – (Optional) Enter a user-friendly name. If you do not enter a name, the Id is used as the name.
-
Description – (Optional) Enter a user-friendly description of the type.
-
Enum Type – Select the enum type from the dropdown.
-
-
For each property to add to the enum type, select Add Property and complete the following fields:
-
Id – Enter the identifier for referencing the property.
-
Value – Enter the numeric value of the property.
Note: Accepted numeric values change based on the selected Enum Type. Refer to the following table for accepted values for each type.
Enum Type
Int1
-Int2
Nullable3
ByteEnum
✔
✖
✖
Int_X_Enum
✔
✔
✖
NullableByteEnum
✔
✖
✔
NullableInt_X_Enum
✔
✔
✔
NullableSByteEnum
✔
✔
✔
NullableUInt_X_Enum
✔
✖
✔
SByteEnum
✔
✔
✖
UInt_X_Enum
✔
✖
✖
1: Integer
2: Negative Integer
3: Nullable fields can be left empty -
-
To save the type, select Save.