Skip to main content

Visual Schema View

The Visual Schema View provides a graph representation of your Item Service schema for creation, editing, and management of the schema.

Viewing a Schema

To invoke the visual schema view:

  1. Expand the Item Service panel
  2. Expand the tree node for the project in which you want to view the schema
  3. Right click on the Schema folder and selec 'View Schema'

A new document will open with a graph representation of your Item Service schema, if one exists. The graph represents collections with orange rectangles, item types with blue rectangles, and reading types with pink circles. Relationships are represented by connections between the graph nodes.

Schema nodes can be dragged and dropped to organize their display.

By default, any collection without associated Item Types will be hidden from the view. You can turn on all collections by checkng 'Show all collections' in the schema view sidebar.

Interacting with the Visual Schema View

Create Collections#

You can create a new collection by right clicking on the view background and choosing Create Collection in the context menu.

See Create Collection command details for more info.

Import Items to a Collection#

You can import items to a NamedUserCollection or NamedTelemetryCollection by right clicking on the collection in the schema graph and choosing Import Items in the context menu.

See Import Items command details for more info

Import Readings to a NamedTelemetryCollection#

You can import readings to a NamedTelemetryCollection by right clicking on a telemetry collection in the schema graph and choosing Import Readings in the context menu.

See Import Readings command details for more info

Relate Items to items in another Collection#

You can relate items to other items in other collections by right clicking on a collection in the schema graph and choosing Relate Items in the context menu.

See Relate Items command details for more info

Create a Schema Type#

You can create a new Item Type or Reading Type by right clicking on the view background and choosing either Create Item Type or Create Reading Type in the context menu.

See Create Item Type command details for more info.

See Create Reading Type command details for more info.

Open a Schema Type#

To open an item type or reading type, right click on the node and select 'Open' from the menu.

Delete a Schema Type#

To delete an item type or reading type, right click on the node and select 'Delete' from the menu.

When deleting a scehma type, all references to the schema type will also be removed from the schema. Deleting an item type will remove it from any collections and any other item types that reference it. Deleting a reading type will remove it from any item types that reference it.

Create Schema Relations#

Relate Collections to Item Types#

Relations between collections and item types can be created by:

  1. Right click on a collection node
  2. Select 'Relate to Item Type' from the menu
  3. Drag a new connection to an item type node
  4. Click on the item type node to complete the connection

When hovering over a valid item type node, the node will highlight in green indicating a valid connection can be created.

You can cancel the connection with the ESC key or clicking anywhere on the view background.

Relate Item Types to Item Types#

Relations between item types can be created by:

  1. Right click on a Item Type node
  2. Select 'Relate to Other Item Type' from the menu
  3. Drag a new connection to an item type node
  4. Click on the item type node to complete the connection

When hovering over a valid item type node, the node will highlight in green indicating a valid connection can be created.

You can cancel the connection with the ESC key or clicking anywhere on the view background.

Relations between Item Types can only be created if both Item Types are associated to a collection.

Relate Item Types to Reading Types#

Relations between item types and reading types can be created by:

  1. Right click on an item type node
  2. Select 'Relate to Reading Type' from the menu
  3. Drag a new connection to an reading type node
  4. Click on the reading type node to complete the connection

When hovering over a valid reading type node, the node will highlight in green indicating a valid connection can be created.

You can cancel the connection with the ESC key or clicking anywhere on the view background.