Semantic template represents a mold based on which semantics can be created on the platform. For semantics that are using a template, the template represents their semantic type. User can add provide attributes, feeds, actuators and alarms and map them to the source of data - feeds to device sensors, actuators to device actuators, and alarms to device alarms.
Create Semantic Template
To create a semantic template:
- On the Semantic Template screen, click the Add button
- You will be prompted to the Create Semantic template screen
- Enter semantic template name
- Enter semantic template description (optional)
- Click Save
Add Attribute
To add an attribute to the semantic template:
- Click on the Add button and then click on Attribute inside the menu
- This will open the Add new attribute sidebar
- Enter attribute name
- Select attribute type from the drop-down list - String, Numeric, Boolean, or Location
- If you check the Required checkbox, it will be mandatory to add an attribute to the semantic group which is created based on a template
- Click on Add
Add Feed
To add a feed to the semantic template:
- Click on the Add button and then click on Feed inside the menu
- This will open the Add new feed sidebar
- Enter feed name
- Select reading type (type in at least 3 characters)
- Select unit from the drop-down list
- Click on Add
Add Actuator
To add an actuator to the semantic template:
- Click on the Add button and then click on Actuator inside the menu
- This will open the Add new actuator sidebar
- Enter actuator name
- Enter reading type (type in at least 3 characters) - String, Switch, or Count (Slider)
- Click on Add
Add Alarm
To add an alarm to the semantic template:
- Click on the Add button and then click on Alarm inside the menu
- This will open the Add new alarm sidebar
- Enter alarm name
- Click on Add
Create Semantic Group from a Template
You can create new semantic groups directly from the Semantic Templates screen.
To create a semantic group using the selected template:
- Click on
next to the template based on which you want to create a semantic group - This will open the Create Group sidebar
- Enter semantic group name, as well as mandatory attributes from the template
- Click on Save
You can also create a semantic group by double-clicking on the template and then clicking on in the top right corner of the screen:
This will open the Create Group sidebar, which you can proceed to fill in as in the manner described above.
Edit Semantic Template
Semantic template can be edited only if there are no semantic groups created based on that template. If a semantic is created from a template, the template represents its type and contains all of its metadata. Therefore, templates that are in use can’t be modified.
To edit a semantic template (requires Write access permission for Semantic Template):
- On the Semantic Templates screen, click on the template you want to edit
- This will open the Edit Semantic Template screen
- Edit template data
- Click on Update to save the changes
Note: You can only edit a semantic template if it is not used by a semantic group
Delete Semantic Template
To delete a semantic template (requires Write access permission for Semantic Template):
- Select the checkbox next to the semantic template you want to delete
- Click the Delete button
- A new dialog will appear asking you to confirm the action
- Click Delete
Note: You can delete a semantic template only if there are no semantics using it.