# Main objects

In this section the major data objects in Lynx is described.

# Organization (org-unit)

Users can be organized into a tree of organizations. The tree can be extended by administrators to add or remove the organisations as needed. Depending on the role of the current user some parts of the organisational tree is hidden.

Example Organization tree

  • Root Org
    • Organization1
      • Suborg1
      • Suborg2
      • Suborg3
    • Organization2
      • Suborg1
      • Suborg2
      • Suborg3

# User

A user is a registered or created account. Default role applied to registered users is "User", this can be changed by the administrator.

# Role

Roles are global in the system. There are a few standard roles that should be sufficient for most installations. Under admin in the web gui it is possible to create, delete and edit roles. The admin part is only visible to the superadmin since settings in here are global.

Except for a list of premissions each role has a prioritu. This is an iportant part of the role. This number tells how "strong" the role is. A ser that has the permission to edit users may do so up to the priority of its own priority but not above.

# Installation

An installation is a representation of a location. It can be a gateway with connections to devices but it can also be a non physical location. A installations collects information about devices and functions. An installation belongs to an organization and users may be connected to the installation.

# Client

A Client may be connected to an installation. A client represent som type of hardware, typically a gateway. But it can also be something else.

# Device (See also DeviceX)

A device represents the physical unit reporting values. It can have information about battery type, size and other parameters. Devices are added to the installation using the integrations or the API.

# Function (See also FunctionX)

A function represents a virtual object that represent one or several values. A function is often represented in the UI as a row with a value. Functions keep parameters that describe topics used, type, formatting and other data needed to display or use the value.