Endpoints

The Endpoints configuration page contains all of the accessible Endpoints and their associated nodes. An Endpoint is a logical representation of OPC server in the context of Qlarm environment, providing necessary data to manage an OPC server. Endpoints are the starting point of the main functional flow in the system, the messaging flow. All properties of an Endpoint should be configured to respond to the necessity of the flow. Starting from configuration of the Endpoint (its OPC server with Tags associated) via Event Definitions to Events raised and Notifications send to Recipients, Endpoints are the main trade for all of these entities.

Endpoints configuration
Fig 1. Endpoints configuration

Upon opening the Endpoints configuration the User is greeted with a list of the accessible Endpoints which can be filtered by entering a keyword in the Search Filter.

Each Endpoint is displayed with basic information: Name, Location, Status; and additional information: IoT Device Name, Description, Type, and Number of Tags. Type shows the type of the Endpoint (IoT Gateway or OPC UA Server). IoT Device Name and Descriptions may contain additional naming information for the specific Endpoint. Most of these information can be edited by clicking the Edit endpoint button, separately for each Endpoint. You can edit Name, Location, IoT Device Name and Description. Additionally, in this mode there is more information about a specific Endpoint: Update frequency (ms), Device primary connection string, Device secondary connection string, Date Time Format, Time Format, Time Zone, Longitude, Latitude, Geo Location (GeoName), Place named by (Nominatim), Keywords. If OPC UA Server Type is selected you can set OPC UA Server URL, IP Address and OPC UA Device info. IoT Device Name is the name of the device from the IoT Hub. Device primary connection string and Device secondary connection string are the connection strings for the IoT Device which is created when the Endpoint is created and you can expect these fields to be populated after the Endpoint is created. You can easily copy them and use them for your needs. This name is unique and is always prefixed with the low key tenant name and underscore. The Time Zone shows the time zone in which the Endpoint operates. Longitude, Latitude, Geo Location (GeoName), Place named by (Nominatim) can be easily populated by choosing a place on the map or inserting Longitude and Latitude. They provide additional info for endpoint location. For OPC UA Server type an installation package can be downloaded right after the Endpoint is created on click on the “Download” button in the header of the Endpoint panel Download installation package. You can also set the specific Endpoint to be the Default endpoint which will enable every information associated with it to appear first in any table content. When a specific Endpoint is not set as default the “Set Default” button is blank New Dashboard button, otherwise it is coloured New Dashboard button.

Endpoint add mode
Fig 2. Endpoint add mode - OPC UA Server
Endpoint edit mode
Fig 3. Endpoint edit mode - IoT Gateway

New Dashboard button contains the Logs for any changes associated with the specific Endpoint.

Endpoint logs
Fig 4. Endpoint logs

The Status Label displays if the Endpoint is online status or offline status.

Make asset button Make asset button enables creating an asset for the chosen endpoint and its tags, which will be visible in the Assets page in shape of a graph after its creation.

By clicking the New Dashboard button button the User can view the table of associated Tags for that endpoint. For each known Tag the table displays its Name, Description, OPC UA URL, Value Type, Precision, Deadband, Unit, Enable Live Data, Logs, Enable Status.

tags
Fig 5. Endpoint tags

By clicking on the online status button you can change the Actions for the specific Tag listed in the table, upon which an “Edit tag” form appears. Also, by selecting multiple Tags and clicking on the New Dashboard button button you can apply changes to all the selected Tags.

 Edit tag
Fig 6. Edit tag
Edit selected tags
Fig 7. Edit selected tags

The User can add a new Tag by clicking on the online status button, upon which an “Add tag” form appears which requires information to be provided.

Add tag form
Fig 8. Add tag form