Set sites as root

Requested by Yanik

Author: zdevaty

USER_GUIDE.md

@@ -79,7 +79,9 @@ Once configured, the app starts Continuous Asset Creation (CAC). Discovered reso
 
 After creation of assets, the assets are organized in Eliona the same way they are organized in OpenBOS. This structure is kept synchronized, and any movements in Eliona (e.g. renaming asset or moving a room to a different building) will be overwritten with next ontology update.
 
-Only exception is the asset "OpenBOS root" asset. You can rename or move this asset wherever you want, and the whole ontology will be moved with it.
+Only exception are the root assets. Root assets are created in the top-level directory, and correspond to the root of OpenBOS places structure. Typically, there is one Site in this role. Another root asset is the "OpenBOS unassigned" asset, containing unassigned assets and datapoints.
+
+You can rename or move the root assets wherever you want, and the whole ontology will be moved with it.
 
 It is not possible to change GAIs in Eliona for any of assets.
 
@@ -107,7 +109,7 @@ Complex data types from OpenBOS are split into separate attributes in Eliona.
 
 ### Orphan datapoints
 
-In case an asset is deleted from OpenBOS and there is still an alarm linked to that datapoint, OpenBOS leaves that datapoint in the ontology. Eliona respects that behaviour, and assigns those datapoints to a root asset.
+In case an asset is deleted from OpenBOS and there is still an alarm linked to that datapoint, OpenBOS leaves that datapoint in the ontology. Eliona respects that behaviour, and assigns those datapoints to an "OpenBOS unassigned" asset.
 
 ## Alarms
 

broker/broker.go

@@ -278,29 +278,22 @@ func FetchOntology(config appmodel.Configuration) (ontologyVersion int32, assetT
 		assetTypes = append(assetTypes, assetType)
 	}
 
-	root := eliona.Asset{
-		ID:                  "",
-		TemplateID:          "root",
-		Name:                "OpenBOS",
-		Config:              &config,
-		LocationalParentGAI: "",
-		FunctionalParentGAI: "",
-	}
-
-	// Initialize spaces map with root space
 	spaces := make(map[string]*ontologySpaceDTO)
-	spaces[""] = &ontologySpaceDTO{}
 	// Build spaces map
 	for _, space := range ontology.Spaces {
 		spaceCopy := space
 		spaces[space.ID] = &spaceCopy
 	}
 
+	var rootSpaces []ontologySpaceDTO
 	// Build parent-child relationships
 	for _, space := range ontology.Spaces {
 		if parentSpace, exists := spaces[space.ParentID]; exists {
 			parentSpace.children = append(parentSpace.children, *spaces[space.ID])
 			// No need to reassign parentSpace back to the map since it's a pointer
+		} else {
+			// This is a Site, serviving as a root
+			rootSpaces = append(rootSpaces, space)
 		}
 	}
 
@@ -310,8 +303,28 @@ func FetchOntology(config appmodel.Configuration) (ontologyVersion int32, assetT
 		assetsMap[asset.ID] = asset
 	}
 
-	// Build the asset hierarchy based on spaces
-	buildAssetHierarchy(&root, &assets, spaces, assetsMap, config)
+	for _, rootSpace := range rootSpaces {
+		asset := eliona.Asset{
+			ID:          rootSpace.ID,
+			Name:        rootSpace.Name,
+			TemplateID:  rootSpace.TemplateID,
+			Config:      &config,
+			IsRootSpace: true,
+		}
+		// Build the asset hierarchy based on spaces
+		buildAssetHierarchy(&asset, &assets, spaces, assetsMap, config)
+	}
+
+	unassigned := eliona.Asset{
+		ID:                  "",
+		TemplateID:          "unassigned",
+		Name:                "OpenBOS unassigned",
+		Config:              &config,
+		LocationalParentGAI: "",
+		FunctionalParentGAI: "",
+		IsRootSpace:         true,
+	}
+	assets = append(assets, unassigned)
 
 	// Handle assets not associated with any space
 	associatedAssetIDs := make(map[string]struct{})
@@ -328,8 +341,8 @@ func FetchOntology(config appmodel.Configuration) (ontologyVersion int32, assetT
 				Name:                asset.Name,
 				TemplateID:          asset.TemplateID,
 				Config:              &config,
-				LocationalParentGAI: root.GetGAI(),
-				FunctionalParentGAI: root.GetGAI(),
+				LocationalParentGAI: unassigned.GetGAI(),
+				FunctionalParentGAI: unassigned.GetGAI(),
 			})
 		}
 	}

broker/broker_test.go

@@ -132,17 +132,17 @@ func TestFetchOntology(t *testing.T) {
 		t.Fatalf("Expected 2 assets, got %v", len(assets))
 	}
 
-	rootAsset := assets[0] // Root should be the first asset in the slice
-	if rootAsset.Name != "OpenBOS" {
-		t.Errorf("Expected root asset name 'OpenBOS', got '%s'", rootAsset.Name)
+	unassignedCatcherAsset := assets[0] // unassignedCatcher should be the first asset in the slice
+	if unassignedCatcherAsset.Name != "OpenBOS unassigned" {
+		t.Errorf("Expected unassignedCatcher asset name 'OpenBOS unassigned', got '%s'", unassignedCatcherAsset.Name)
 	}
 
 	childAsset := assets[1]
 	if childAsset.Name != "Sensor 1" {
 		t.Errorf("Expected child asset name 'Sensor 1', got '%s'", childAsset.Name)
 	}
-	if childAsset.LocationalParentGAI != rootAsset.GetGAI() {
-		t.Errorf("childAsset LocationalParentGAI = %v, expected %v", childAsset.LocationalParentGAI, rootAsset.GetGAI())
+	if childAsset.LocationalParentGAI != unassignedCatcherAsset.GetGAI() {
+		t.Errorf("childAsset LocationalParentGAI = %v, expected %v", childAsset.LocationalParentGAI, unassignedCatcherAsset.GetGAI())
 	}
 }
 
@@ -488,24 +488,24 @@ func TestFetchOntologyWithSpaces(t *testing.T) {
 
 	assert.Equal(t, 4, len(assets), "There should be all assets")
 
-	rootAsset := assets[0]
-	assert.Equal(t, "OpenBOS", rootAsset.Name, "Root asset name mismatch")
-
-	// Check that "Building 1" has root asset as a parent
-	building1 := assets[1]
-	assert.Equal(t, rootAsset.GetGAI(), building1.FunctionalParentGAI, "Building 1 Functional parent")
-	assert.Equal(t, rootAsset.GetGAI(), building1.LocationalParentGAI, "Building 1 Locational parent")
+	// Check that "Building 1" is a root (typically it would be a "site")
+	building1 := assets[0]
+	assert.Equal(t, "", building1.FunctionalParentGAI, "Building 1 Functional parent")
+	assert.Equal(t, "", building1.LocationalParentGAI, "Building 1 Locational parent")
 	assert.Equal(t, "Building 1", building1.Name, "Building should come first")
 
 	// Check that 'Building 1' has 'Floor 1' as a locational child
-	floor1 := assets[2]
+	floor1 := assets[1]
 	assert.Equal(t, building1.GetGAI(), floor1.FunctionalParentGAI, "Floor 1 Functional parent")
 	assert.Equal(t, building1.GetGAI(), floor1.LocationalParentGAI, "Floor 1 Locational parent")
 	assert.Equal(t, "Floor 1", floor1.Name, "Floor should come second")
 
 	// Check that 'Floor 1' has 'Sensor 1'
-	sensor1 := assets[3]
+	sensor1 := assets[2]
 	assert.Equal(t, floor1.GetGAI(), sensor1.FunctionalParentGAI, "Sensor 1 Functional parent")
 	assert.Equal(t, floor1.GetGAI(), sensor1.LocationalParentGAI, "Sensor 1 Locational parent")
 	assert.Equal(t, "Sensor 1", sensor1.Name, "Sensor should come last")
+
+	rootAsset := assets[3]
+	assert.Equal(t, "OpenBOS unassigned", rootAsset.Name, "Root asset name mismatch")
 }

broker/client.go

@@ -378,16 +378,16 @@ func (ontology ontologyDTO) getAssetTemplates(orphanDatapoints []ontologyDatapoi
 		}
 	}
 
-	// Root asset containing orphan datapoints
-	rootAsset := ontologyAssetOrSpaceTemplateDTO{
-		ID:   "root",
-		Name: "root",
+	// Asset containing orphan datapoints
+	unassignedAsset := ontologyAssetOrSpaceTemplateDTO{
+		ID:   "unassigned",
+		Name: "unassigned",
 	}
-	ontology.SpaceTemplates = append(ontology.SpaceTemplates, rootAsset)
+	ontology.SpaceTemplates = append(ontology.SpaceTemplates, unassignedAsset)
 	for _, orphanDatapoint := range orphanDatapoints {
 		for _, dt := range ontology.DatapointTemplates {
 			if orphanDatapoint.TemplateID == dt.ID {
-				datapointTemplateMap["root"] = append(datapointTemplateMap["root"], dt)
+				datapointTemplateMap["unassigned"] = append(datapointTemplateMap["unassigned"], dt)
 			}
 		}
 	}

db/generated/alarm.go

@@ -198,13 +198,14 @@ func SetAllConfigsInactive(ctx context.Context) (int64, error) {
 	})
 }
 
-func InsertAsset(ctx context.Context, config appmodel.Configuration, projId string, globalAssetID string, assetId int32, providerId string) (assetID int64, err error) {
+func InsertAsset(ctx context.Context, config appmodel.Configuration, projId string, globalAssetID string, assetId int32, providerId string, isRootSpace bool) (assetID int64, err error) {
 	var dbAsset dbgen.Asset
 	dbAsset.ConfigurationID = config.Id
 	dbAsset.ProjectID = projId
 	dbAsset.GlobalAssetID = globalAssetID
 	dbAsset.AssetID = null.Int32From(assetId)
 	dbAsset.ProviderID = providerId
+	dbAsset.IsRootSpace = isRootSpace
 	if err := dbAsset.InsertG(ctx, boil.Infer()); err != nil {
 		return 0, fmt.Errorf("inserting asset: %v", err)
 	}