Create/Modify/Delete Semantic Groups

Create Semantic Group

You can create semantic group in different ways:

1. Create semantic group and template

  • Click the Create group button in the Data Semantics tab

  • In Create semantic group you will get all the prompts needed to create semantic group/template

The first dialog displays:

  1. Parent semantic group
  2. Name of the semantic group
  3. Choose existing template drop-down menu
  4. Create new template checkbox

Parent semantic group section displays the name of the root/parent group in case you are creating a subgroup of that group; if you are creating parent group it displays None.

In semantic group Name text box enter the name of the semantic group you are creating.

In Choose existing template drop-down menu, you can choose to create a semantic group from an already existing template (we will not do it in this case).

Create new template enables you to create a semantic group and a template made from that semantic group at the same time.

If you check Create new template checkbox:

  • New dialog will appear

Enter the required information and continue by creating new template:

  • Choose Attribute type
  • If you check the Attribute required box, value text box will be mandatory for all Attribute types

  • If numeric - enter number as value
  • If string - enter text as value
  • If boolean - check value box
  • If location - enter coordinates as value
  • You can add multiple Attributes

  • Continue by adding placeholder for sensor’s feed
  • Select the Feeds tab
  • Go to the Add feed link

  • In new text field enter Sensor name, Reading type, Unit and Stale (number of minutes after which the feed will go stale)
  • Now that you created a placeholder, click the Map data button to map sensor’s feed to the placeholder

/uploads/create-template-add-feed-18.12.3.png

  • New search dialog will appear
  • Search by entering device/feed’s name

  • Choose feed
  • Click Save
  • You can add multiple feeds
  • Continue by adding placeholder for Actuator
  • Select the Actuators tab
  • Go to the Add actuator link

  • In new text field enter Actuator name and Reading type
  • Now that you created a placeholder, click the Map data button to map actuator to the placeholder

  • New search dialog will appear
  • Search by entering device/actuator name

  • Choose actuator
  • Click Save
  • You can add multiple actuators
  • Continue by adding placeholder for Alarm
  • Select the Alarms tab
  • Go to the Add alarm link

  • In new text field enter Alarm name

  • Now that you created a placeholder, click the Map data button to map alarm to the placeholder
  • New search dialog will appear
  • Search by entering name of a(n) device/alarm

  • Choose alarm
  • Click Save
  • You can add multiple alarms

You have created template and semantic group.

  • Click Save to finalise the process

Semantic group with the added data will appear in the Data browser tab and the Data semantics tab in the Semantic groups field and the template you created will appear in the Templates tab.

Note: This way you have created parent/root semantic group and added data (attributes/feeds/actuators/alarms) to it.

For more information on how to create further subgroups for that semantic group, go to Create/Edit/Delete Semantic Group Data section of this guide.

2. Create template and then create semantic group

  • Go to the Templates tab
  • Click the button to create new semantic group template

  • You will jump to the Create templates screen

  • Create template as described in Create/Edit/Delete Templates section of this guide
  • Now that you have created the template, it will appear on the list in the Templates tab

To create semantic group from that template:

  • Go to the Data Semantics tab and click the Create group button

  • Create semantic group screen will appear
  • In Choose existing template field select the template you have previously created

  • The template with all the placeholders for attributes/feeds/actuators/alarms will be placed in the semantic group you are creating
  • Map the data to the placeholders as described in 1. Create semantic group and template
  • Click Save to finalise the process

Note: You can edit the template you imported for the semantic group you are creating by adding more placeholders (attributes/feeds/actuators/alarms). The editing will be applied to the semantic group you are creating. The original template will not be affected by editing.

3. Create semantic group without creating template

  • Go to the button and start creating semantic group as described in the beginning of this section
  • Skip choosing template or creating new template steps

  • Create your semantic group by adding any Attribute/Sensor/Actuator/Alarm as described in 1. Create new template while creating semantic group
  • Click Create to complete the process
  • Your semantic group will be created and listed in the Semantic groups tab

4. Create semantic group via Device Management module

You can create semantic group in the Device Management module while creating your device. At the final step of creating device, you can check the Create semantic group from this device box. The semantic group with the same name as the created device will appear in the Semantic groups list, the Data Browser tab in the Data Semantics module.

For more information on how to create semantic group in the Device Management module, go to User Guides/Device Management/Create/Delete Devices section.

Note: Each feed/actuator/alarm displayed in a semantic group is presented in form of a card with its name, graphic representation of sensor’s feed/actuator/alarm in question and the info if the source (sensor’s feed/actuator/alarm comes from) is active, inactive or removed.

Modify Semantic Group

You can modify semantic group in various ways:

  • Edit
  • Move to
  • Move to first level

Note: Move to first level operation is possible only in subgroups!

Edit Semantic Group

To edit semantic group:

  • Select a semantic group card
  • You will jump to the box that contains cards with feeds/actuators/semantic subgroups
  • Click the Edit group button above the box
  • New dialog with Info and Access tabs will appear

Info tab contains text file in which you can modify the name of the (sub)group.

  • You can also Add attribute, Cancel and Update the changes you made
  • Access tab enables you to modify the access to your semantic (sub)groups and the data it contains
  • Click the Edit group button
  • New dialog with the Info and Access tabs will appear

Note: Access tab in Edit semantic group dialog may/may not be displayed depending on your business context or the user role you have!

For more information on user roles, go to User and Role Management section of this guide.

In the Info tab you can edit name and add/edit attribute of the semantic group.

  • You can edit access permission (private/public) of the semantic group

In the Access tab you can edit the access to the semantic group you have created, or the one you have permission to modify.

  • A new dialog will display (sub)group access permission list and the name of the user who created it (Creator)

  • To change the access permission from Public (default) to Private, choose Private from a drop-down list

  • New Are you sure you want to change this device asset access to private? dialog will appear

  • Click CONFIRM
  • In new Add member text field add one or more users with whom you would like to share the (sub)group you have created or have the access to

  • You can add an infinite number of members
  • To expand the access to other subgroups, check the Propagate access list to all semantic subgroups check box
  • Click Update to confirm all the modifications you have made

Move To

Move to option in a semantic group window enables you to move the semantic GROUP in question to another semantic group and make it a SUBGROUP.

To do so:

  • Click the Move to button
  • New dialog will appear with the list of all the semantic groups you created/have the access to

  • Choose the semantic group
  • Click Save
  • Your semantic group is now a subgroup of the group you have chosen

Move to First Level

Move to First Level option allows you to move semantic SUBGROUP to the first level and make it a first level semantic GROUP.

To do so:

  • Click the Move to first level button
  • You will jump to the window with first level semantic groups

  • Your semantic subgroup is now displayed on the screen with all the other root groups

Delete Semantic Group

To delete semantic (sub)group:

  • Go to the Delete group button

  • New confirmation dialog will appear
  • Click Delete

Please note that if you delete semantic group, all of its data, including subgroups will be deleted from the Semantic groups list, but will remain in the Data tab.