Create an entity type
In the top left-hand corner of the main dashboard screen, click the Admin Panel icon:
.On the Admin Panel, click Definitions
.On the right-hand side of the Entity Types screen, click the Entity Type icon:
.Configure the entity type settings as required:
Setting
Description
Name
Name of the entity.
Note
It must be 3-64 alphabetic characters only.
It must be in lower case only.
Display Name
Displayed name of the entity. It the name displayed everywhere to represent the entity.
Note
It must be 2-32 alphabetic character only.
Domain
Name of the domain.
Description
Description for the entity.
Tags
Enter one or more descriptive tags for the entity type. Hit Enter on the keyboard after typing the tag descriptor to add it to the list. It will be used for categorizing & searching the entity type.
QDC
Select in which type of database the entity type is to be inserted.
QDC-Primary
QDC-TimeSeries
Global
Select whether the entity type is to be inserted in the global QDC-Timeseries database to be shared across tenants or inserted only in the QDC-Timeseries database for that particular tenant.
Metrics Ingestion
Select whether it should be ingested as MetricV3 data. If enabled, it will contain the historic data.
Entity Ingestion
Select whether it should be ingested as entity data. If enabled, it will contain only the latest updated data.
Unique Columns
Select whether the columns should act as a composite key to uniquely identify a record.
RE-File System
Select whether it should be ingested in the RE-File System database.
Click on the Create Properties icon
and if you choose Form then configure the following Metric Schema Properties as required:Setting
Description
Property Name
The name to be used for this property.
Note
It must be 2-40 characters only.
Data Type
Select one of the following standard data types for the property:
string
boolean
date
number
dateRange
numberRange
object
point
polygon
lineString
multiPoint
multiLineString
multiPolygon
geometryCollection
ipRange
ip
Key Name
The name of the key to be used for this property.
Note
It must be 2-40 characters only.
The reserved keywords that are not to be used as the entity type key names are "entityId", "eventType", "entity_type", "parentId", "domain", "meta_properties", "metric_properties", "event_properties", "lastUpdated", "timestamp", "ruleId", "sopId", "taskId", "eventId", "address", "provider", "manufacturer", "state", "mobility", "sid", "label", "version", "entityType", "regionId", "last_updated", "geoAddress", "label", "physicalDevice", "physical_device", "tenantID", "tenant_id", "created_at", "updated_at", "entity_id", "entity-type", "parent_id", "region_id", "geo_address".
Unit Type
The unit type to be used for this property.
Minimum Value
If the Data Type selected is number then enter an integer as the minimum value of the property.
Note
It must be 0-1000 only.
Maximum Value
If the Data Type selected is number then enter an integer as the maximum value of the property.
Note
It must be 0-1000 only.
Description
Enter an optional description for this property.
Enables you to add another metric schema property.
Deletes the metric schema property.
Note
Existing entity type properties cannot be deleted.
If you choose Text Editor then enter the metric schema properties in the JSON displayed and click the Add Schema button to add them.
Click Save.
Note
Click on the Clear All Fields button to clear all the data entered in the fields.