In this section, you will find explanations of all functions below the menu item “IoT Data Hub”. All functions known from the predecessor system niota 1.0 can be found here.

Applications

The “Applications” menu item takes you to an overview page of all applications that you can access through your main account and its sub-accounts, depending on your permissions. An application represents e.g. a project, a specific group of devices, or a location (e.g. an office or a school). In an application, devices of the same or different types are grouped to easily edit and manage many devices in real-time. Clicking on an application will take you to the details page of the application. With the corresponding user rights, you can apply the different functions.

Search for Applications

Above the list of apps on the Overview page is a search bar where you can search for an app by title. As soon as you have entered a letter, the search results are automatically displayed. You can use the “Account Filter” button to filter the list by applications of specific accounts to which you have access. You can select multiple accounts. You can reset the search by clicking the reset button to the right of the filter button.

Create a new Application

Click on the “Create” button to create a new application quickly and easily. A new window opens in which you provide the following information for the application.

Put an image at the top for easy identification of the application
Title:* Give your application a unique title.
Account:* Select the application’s account from a list of accounts available to you.
Description: Describe the application and use of the devices grouped here.
IoT Service Builder URL: If available, insert a URL of your IoTService Builder dashboard. This creates the button “Dashboard” on the detail page at the top right, which links to the IoT Service Builder. The dashboard opens in a new window.
Tags: Use keywords for the simple definition of the application.
Diagram: Set the time period for visualizing packet data in a diagram.
Fixed send interval: Click the box to set a fixed send interval.
View Options Details (Show): When you select Nominal, Status, Statistics, SF Chart (Spreading Factor), more report details appear on the application details page. You can read more about these report options in the next section, “Editing and updating existing applications”.
Address input: Enter the address where you want this application to be displayed on the map. Search results from our database will appear as you type. If they match, click on the address, and latitude and longitude will be determined automatically.
Latitude and longitude: As an alternative to entering the address, you can also fill in these fields manually

Only title and account are mandatory fields marked with an asterisk. When you have entered all the data, click on “Save + Create”. If the application is successfully created, a green confirmation message “Application created” appears. The new application appears immediately in the overview.

Edit and update existing application

Clicking on an application on the overview page will take you to the application’s details tab. This detailed view gives you an overview of the devices included in the application, their off or online status, and packet traffic in real-time statistics.

At the top of the page, you will find the description text of the application. If you click on the “CSV Download” button next to it to download the package data of the devices included in the application, a window will open.

You can select the time period and the variable. You can select whether the CSV file should be generated per device and variable, per device or per application. You can specify an e-mail address to which a download link will be sent after the download is completed. You can find the file by clicking on the “CSV” button in the upper right corner of the menu bar. Then the page “CSV-Export” will open, where you can download the file.

On the page, you can view reports from different time periods. In the button field at the top right, you can click on 1 day, 1 week, 4 weeks, and 1 year to get the corresponding information in the report details below. Below this, visualizations and summaries report on the following content:

Device overview: Percentage representation of how many devices of the application are online and offline.
Active devices: List and number of active devices with labels. If you click on a device in any of the rows, you will be taken to the details page of that device.
Inactive devices: List and number of inactive devices with labels. If you click on a device in any of the rows, you will be taken to the details page of that device.
Live View: View of parcel traffic in real-time.
Battery status: Here each battery status of the devices are listed. You can filter by status using the icons above the list. To obtain a meaningful battery status, you must first set it in the device type of the device. You can also set battery thresholds that differ from the device type individually for individual devices.
Battery message: Devices whose battery is in critical mode and may need to be replaced are listed here. You can filter by status using the icons above the list.

If you selected Nominal, Status, Statistics, SF Chart when creating or editing the applications, 4 more report details will appear on the page. Nominal devices are devices in which a threshold of the minimum expected data packets per day has been specified in the device type. By specifying a minimum number of data packets, the operating status of devices is easy to monitor.

Nominal Active Devices – Device Overview: Percentage representation of how many devices of the application are nominal or non-nominal or have a specified threshold for operational status verification.
Nominal Devices: List of devices for which you have set a threshold for rated operation in the device type, which has not fallen below the value and is therefore in working operating status.
Not Nominal/Not Set: List of devices for which you either did not set a threshold value in the device type (colored orange) or did set a value but fell below it and the operating status is not secured (colored red).
Operating status Overview: For each individual device, you can specify an operating status on the details page of the device under the menu item “Devices”, e. g. For example, “In Transit” or “In Operation. ” This report detail gives you an overview of all the status of the devices that are part of the application. You can filter by the respective state: In Operation (green), In Transit (red), or No Status (orange).
Statistics Report: Here you will find daily and monthly reports about the total sent packets, average packet quantity, and sending time.
Received packets per hour: A bar chart shows the packets received per hour over a 12-hour period.
Packages received per day: The graph shows you the number of packages received per day over a period of 1 month.
RSSI/SNR: The graph shows RSSI and SNR values over a period of 4 weeks. The performance of the LoRaWAN network can be assessed using Received Signal Strength Indication and Signal-to-Noise ratio.
Spreading Factor (SF): This diagram shows the average Spreading Factor of the devices. Spreading Factors are used in the LoRaWANnetwork to set the data transfer rate relative to the range. The Spreading Factor should always be between 7 and 12.
Sensors: Position and signal strength: A map view shows the position and signal strength of the devices.

Add devices in Application

Click the Devices tab at the top to go to the area of devices added to the application. Here you will find a list of all devices with title, EUI, originator, status, and creation date. Here you have several options to add a device or more devices: via the EUI, ID, or UUID, via an originator such as firefly, or manually add a completely new device. Newly added or created devices are immediately listed in the Device Overview.

Add devices in Application via EUI, ID, or UUID

Click on the “Add” button. A window opens – then select an originator, e. g. For example, an originator based on DIGIMONDO’s LoRaWANnetwork server firefly.
Then the next window appears where you enter the EUI, ID, or UUID of the device into the grey field. If you add multiple devices at the same time, separate the IDs with a comma.
Click on “Search” and the search result will appear under the field. If the ID was not found in the originator, an error message appears and you cannot click the “Add” button. If the search was successful, click on the device and then click on the “Add” button. The device will immediately appear in the overview list.

Add devices in Application via Originator

Click on the “Add” button. A window opens – then select an originator, e.g. an originator based on DIGIMONDO’s LoRaWAN Network Server firefly.
Then the next window appears, in which you click on “Add Originator Devices. ” A menu will open in which you either select all devices by clicking on the button “Select all” or select individual devices by clicking on the cross at the bottom right. The devices that are not yet in an application in niotix via the originator are listed for selection.
Your choice of devices appears below the field. Now you can click the “Add” button. The device will immediately appear in the overview list.

Create new Devices and add them to an Application

Click on the “Add” button. A window will open - then select an originator, e.g. an originator based on DIGIMONDO’s LoRaWAN network server firefly.
Then the next window appears where you click on the green button “Add new device”.

A window will appear where you specify the data of the new device.

Title:* Give the device a meaningful title for easy identification in the originator.

ABP/OTAA:* Activate via the switch “Activation by personalization” (ABP) or “Activation over the air” (OTAA). Depending on which activation method you select for the device, there are different mandatory fields for the process.

Device Type: If available, select the device type to which the new device belongs.

Description: Enter a short description of the device that will appear on the details page.

Tags: Enter keywords that appear on the detail page.

ADR Limit: Adaptive Data Rate is a mechanism to optimize data rates, transmission time, and energy consumption in the network. Here you determine with which spreading factor a device should send packets at least. This can lead to higher energy consumption, but also increase the probability of receiving the packets in the surrounding gateways.

Region: As in firefly you can select the LoRaWAN frequency in niotix for the international deployment of our IoT software. Note: You cannot change this setting afterwards.

__EUI*__: A globally unique identifier (EUI) of 8 bytes (16 hex characters) is created for each device. Enter the EUI of your device here.

Device Address:* Enter the address the device uses to communicate with the network with 4 bytes (8 hex characters).

Application Key:* Enter the key the device uses for the join handshake.

Application Session Key:* Enter the 16-byte key used to encrypt the application payload. If the field is empty, the application payload cannot be decrypted.

Network Session Key:* This field appears only if you do not enable ABP/OTAA above. Then you have to specify the 16 byte key for encryption.

Create in a specific Organization: firefly organization ID: If the field is empty, the device will be created in the originator’s root organization.

Device Class ID: Specify the ID of the device class in firefly in which the device should be created.

Device is Class C enabled: Enable class C only if the device supports it. Otherwise, failure packets will not be received by the device.

Synchronize location: Enable the function to synchronize the location from the settings in the niotix application and set it to “permanent” in the remote system.

Address input: Enter the address where this application should be displayed on the map. Search results from our database will appear as you type. If they match, click on the address and latitude and longitude will be determined automatically.

Latitude and Longitude: As an alternative to entering the address, you can also fill in these fields manually.
When you have filled in all mandatory fields marked with an asterisk, the save icon will change color and you can click save. The device will immediately appear in the list.

Edit multiple devices in Application simultaneously

Applications are especially useful for editing a large number of devices at the same time. Either select which devices you want to edit from the device list or click on the field in the first line next to ID to select all devices currently visible on the list. Then click on the “Edit All” button at the top of the device overview. Then a new window with the heading “Update devices” will open with a list of all devices you have selected.

You can also delete multiple devices from the application using the trash icon at the top. You can set the following settings for these devices:

ADR Limit: Adaptive Data Rate is a mechanism to optimize data rates, transmission time, and energy consumption in the network. Here you determine with which spreading factor a device should send at least packets. This can lead to higher energy consumption, but also increase the probability of receiving the packets in the surrounding gateways.
Tile Name: This name will be used as a tile name for all devices in the application.
Operational Status: You can choose between “unset”, “in transit”, “ready for operation”, “in operation”, “temporarily inactive” or “decommissioned”. To check the status of the report display on the details page, the most recent operating status of the device is combined with the threshold value. Note: The “in operation” status is set when the device is operating normally.
Threshold for nominal operation: To monitor the operating status of devices in the device detail view and in the application, you can set a threshold value for the selected devices here. This is the minimum number of data packets per day that a device must send to be considered a normally functioning device. If this is not set, the default setting is: “Expected number of packets” of the device type.
Battery Warning Level: Note: Set the battery level variable in the device type first. The battery level of the device used to consider the battery is not working at 100%. This level is higher than the alarm level. It is used as a warning in both the device and application levels.
Battery Alert Level: Note: Set the battery level variable in the device type first. The battery level of the device with which the battery is considered is low, critical, or damaged. This level is lower than the warning level. It is used as a critical status at both device and application level.
Maximum Idle time | Time Units: Set the period for the maximum idle time (e.g. 2 hours). If niotix has not received a packet within this time period, you will be notified as a user.
Device type: If the selected devices belong to a certain device type, you can select this type from the list and assign it directly to the devices.
Application: If you want to move the devices to another application, you can select it from the list of applications available to you.

Click the “Save” icon at the top of the window to save your changes.

Delete application

On the overview page, behind each application, you will find two icons for editing and deleting an application. Click on the “Trash” icon to delete an application. If the deletion was successful, a green-colored confirmation message “Application deleted” will appear.

Gateway Management

The menu “Gateway Management” will take you to an overview page of all gateways to which you have access via your main account and the corresponding sub-accounts (according to your permissions). With a click on a gateway you will be forwarded to the detail page of the gateway. With the appropriate user rights you can use the different functions.

Search for gateway

On the overview page, above the list of gateways, there is a search bar where you can search for a gateway by its title or its EUI. As soon as you enter a letter or a number, the search results will be displayed automatically.

Using the “Account Filter” button you can filter the list by gateways of specific accounts you have access to. As soon as you select an account, the “Performance Dashboard” button also appears in the top menu bar. This opens a new window that displays several statistics showing the number of packets received, the average RSSI/ LSNR value, and the average spreading factor of all gateways in the account compared to each other. You can set the time period for the display in the dashboards at the top. In the gateway management, the network server index is used to display the number of packets by issuing a query in the Elasticsearch index of the network server. All LoRaWAN traffic via the gateway is taken into account here. The network server index therefore also indexes packets from unknown devices. This gives you a statement about the general gateway traffic, which is independent of devices created in firefly.

Via the button “Set gateways refresh time interval” you can define an interval (in minutes) for the monitoring, which automatically updates the list of the gateway overview as well as the performance dashboard.

The “Warning Level” button shows all gateways that are highlighted in yellow and have exceeded the previously set time limit for receiving the last packet. This value is 5 hours by default. The same applies to the “Alarm level” button, which shows all gateways marked in red and whose limit value is usually set at 12 hours.

You can reset the search using the reset button to the right of the filter button.

Map view

The “Load Map” button displays all gateways you have access to on a map with their correspondingly colored status.

Also in this view, you have the possibility to filter for critical gateways on the map in the lower-left corner. If you click on one of the gateways, a small information box about that gateway will appear. If you want to see more information about the gateway, you can click on “View details” to get to its detailed view.

Add a new gateway

To create a new gateway quickly and easily, click on the “Create” button. A new window opens where you select an originator that creates the gateway in parallel in the corresponding firefly organization.

Now another window appears where you enter the following information:

Import from firefly:* If you activate this button, you can import already existing gateways from your firefly organization into your niotix account based on the gateway title. If the button remains deactivated, you create a completely new gateway in both systems.
Title:* Give your gateway a unique title.
GW-EUI:* Add the EUI of the gateway
Account:* Select the account of the gateway from a list of accounts available to you.
Description: Optionally give your gateway a description for easy identification.
Manufacturer:* Add the manufacturer of the gateway.
Serial number: Add the serial number in addition to the EUI.
Firmware Version: Specify the firmware version of your gateway.
Group: Add the gateway to a specific group.
Ethernet/ Sim Card: Select whether the gateway is operated via an Ethernet connection or via a Sim card. Depending on this you can optionally enter the sim card information.
Link to GW management tool: Add the link to the respective GW management tool of the manufacturer where your gateway is registered to get detailed performance information or to perform actions like firmware updates, reboots, etc.
Warning level: Set a time threshold for the warning level in hours that the arrival of the last incoming packet must not exceed. Otherwise, the gateway will change color from green to yellow and will be listed among the critical gateways in the “Monitoring” menu. By default, this value is set to 5 hours.
Alarm level: Set a time threshold for the alarm level in hours, which the occurrence of the last incoming packet must not exceed. Otherwise, the color of the gateway will change from yellow to red and will be listed under the critical gateways menu “Monitoring”. By default, this value is set to 12 hours.
Latitude and Longitude: As an alternative to entering the address, you can also fill in these fields manually.
File attachments: It is also possible to upload important documents to the gateway.

Only title and account are mandatory fields marked with an asterisk. When you have entered all data, click on “Save + Create”. If the creation was successful, a green-colored confirmation message “Gateway created” appears. The new gateway appears immediately in the overview.

Add multiple gateways via CSV - bulk upload

With this method, you can easily import multiple gateways at once using a CSV file into one or more accounts. This is useful when a large number of gateways need to be created at the same time, such as during a roll-out.

Click on the button to the left of “Create”. This is for the CSV upload. A new page with instructions will open.
Download the sample CSV file if needed.
Click on the button “Upload CSV” and insert your file.
Below you will see another box with a list of gateways. You can remove gateways from the import list here by clicking the delete button.
When all the required information is available, the “Import” button will be activated. Then click the button. If the addition was successful, a confirmation will appear. The new devices will immediately appear in the list. In addition, it will appear in the firefly organization of the assigned originator.

Edit and update existing gateway

By clicking on a gateway in the overview page you will be taken to the detail tab of the gateway. In this detail view you get an overview of the gateway’s master data, the set warning and alarm levels and the packet traffic in real-time statistics. By clicking on the pencil in the upper right corner you can make changes for the gateway and update it.

At the top of the page you will find the description text of the gateway. In this overview you can view reports from different time periods. In the button field of the statistics you can click on 24 hours, Last week or Last month to get the corresponding information in the report details below. Below that, visualizations and summaries report on the following content:

Number of packages: Here you will find daily/weekly as well as monthly reports on the total data packets sent by the gateway.
Packets received per day: In a bar chart you can see the packets received per hour over a period of 24 hours.
Packets received per week: In the chart you can see the number of packets received per day over a period of one week.
Packets received per month: The graph shows you the number of packets received per day over a period of one month.
RSSI/SNR: The graph shows the average RSSI and SNR values over the previously specified time period. Received Signal Strength Indication and Signal-to-noise ratio can be used to assess the average performance of the LoRaWAN network.
Spreading Factor (SF): In this diagram you can see the average spreading factor of all devices sending data packets to the gateway. Spreading Factor are used in LoRaWAN network to adjust the data transmission rate versus the range. The spreading factor should always be between 7 and 12.
Map: At the top, a map view shows the location of the gateway.

Delete gateway

On the overview page, you will find two icons behind each gateway for editing and deleting a gateway. Click on the “trash” icon to delete a gateway. If the deletion was successful, a green-colored confirmation message “Gateway deleted” appears.

Consumers

The menu item “Consumer” takes you to an overview page of all available consumers with ID, Name, Type, Account, and Creation Date and you can also sort them according to the columns. A consumer is an access point to access the data from outside. It acts as a data sink through which the data is passed to an external third-party system. According to your access rights, you can view, create, edit or delete consumers of your account. You can edit and delete consumers using the icons in the list of existing consumers.

Search for consumer

On the overview page, above the list of consumers, there is a search bar where you can search for a consumer by its name or type. As soon as you enter a letter, the search results will be displayed automatically.

Create new consumer

Click on the “Create” button to create a new consumer.
A new window will open where you will first enter a unique, self-explanatory name for easy identification. Select the consumer type: MQTT, Websocket, Webhook, Azure, or, if available, IEC-608570-5-104. Then, select the application you want this consumer to connect to. These are required fields. In the bottom field, you can add a description of the consumer.
There are specific requirements for some types:
- Webhook: see separate chapter below
- Websocket: see separate chapter below
- IEC-60870-5-104: see separate chapter below
- MQTT broker:
  - A connection to the consumer’s MQTT broker is only allowed if formatted according to the topic described in the consumer. Other topic subscriptions are not allowed.
  - The connection requires SSL/TLS encryption to be enabled.
  - Multiple clients can connect with the same credentials (user/pass) - this is not recommended for security reasons!
  - Note: In addition to the device information, the geo-coordinates or address data as well as customer-specific device properties are also included in the mqtt-output.
- Azure:
  - Hostname
  - Device ID (Azure)
  - Shared Access Key
Click on “Save & Create”

Edit consumer

Click on a specific consumer in a row in the overview list. You will be redirected to the details page. Here you can update data like name and description. You can check the interface details for data transfer. In the bottom section under the “Detail Configuration” tab, you can add more applications to the consumer. Under the tab “JSON Transformation” you can modify JSON templates and test them in the test area. This is a feature for advanced users. A consumer generates a JSON template and sends it to another system for data exchange. During JSON generation, you can influence the JSON object structure by modifying it to your requirements and test it in the test area.

Delete Consumer

On the overview page, you will find two icons behind each consumer for editing and deleting. Click on the “Trash” icon to delete a consumer. The consumer will no longer appear in the list.

IEC-608570-5-104 Consumer

The IEC-608570-5-104 consumer is a specific consumer for connecting niotix e.g. with SCADA-systems. It is an additional service that is not part of the niotix core-system and needs to be installed and activated separately.

If you are interested in this consumer, please contact Digimondo. Besides, we can also provide an interoperability statement upon request.

After you click the “save and create” button as described above, a new window will open where you can configure the consumer:

Name: The name of the consumer
Description: The description of the consumer
Port: 2404 is default, all ports are allowed (if - in case of OnPremise installations - the firewall allows it)
k Value: Maximum number of unacknowledged messages sent (optional, default: 12, min: 1, max: 32767).
w Value: Maximum number of unacknowledged messages received before sending ack (optional, default: 8, min: 1, max: two thirds of kValue).
t1 Timeout: Max time to wait for ACK in seconds (optional, default: 15, min: 1, max: 255).
t2 Timeout: max time to wait to send ACK in seconds (optional, default: 10, min: 1, max: 255).
t3 Timeout: Max idle time to send test frame in seconds (optional, default: 20, min: 1, max: 172800 (=48hours)).
Polling Interval: Interval in seconds with which data updates are retrieved from niotix. The IEC-608570-5-104 consumer is a server that runs in a separate service and polls according to this interval data from niotix, to provide it to the IEC-server-inferface
Config. ID: An automatically generated identifier
Allow anonymous clients: Any client can connect and the white list will be ignored (Optional, default: false). This feature should only be activated for testing purposes to make debugging easier!
Server Timezone is UTC: Should the time tags of data sent via IEC104 contain. The time in UTC (true) or in the local time zone (false) (Optional, default: false).

In the tab “IEC Server Settings", under the metadata and server settings, you can add a new data-point (link devices to IEC104 data points) by clicking the “add data-point” button. A new window will open where you have to fill in the following fields.

Choose Device: Select the device from niotix IoT Data Hub.
Choose a measurement: The data points from the device that should be linked
Common Address: Set the IEC104 Common-Adress (CA; min: 1, max: 65534). By clicking on the calculator icon ([1]) you can calculate the CA and even change the endianness
Information-Object-Address: Set the IEC104 Information object address (IOA; min: 1, max: 16777215). By clicking on the calculator icon ([1]) you can calculate the CA and even change the endianness
Type: The IEC104 type of this data point.
Dead-Band: Sometimes also called threshold. A value change has to be greater than the dead-band in order to be reported spontaneously as an event. It is optional (default = 0.0) and only relevant for measured values, allowed types are int and float (e.g. “deadband”: 3.0).

In the box “IEC Master IPs Whitelist", you can add IP-addresses that are allowed to connect to the server and read data. This whitelist is only applied if the toggle button “Allow Anonymous Clients” is deactivated. As this gives you additional security, we recommend to use this option.

In the tab “Metrics", you can see updates of the IEC104 data points for monitoring and debugging after you set up the consumer.

Webhook Consumer

Via the Webhook Consumer, you can transfer data of an application and thus also the data of the devices contained in it. Through the Webhook URL, the data packets are transferred to the respective destination. The Webhook uses the HTTP protocol, which is standard for almost all data transfers on the Internet. Mostly the data is formatted in JSON or XML.

For a short test, you can find several simple solutions on the internet, e.g. at “webhook.site”. There you can generate a webhook URL and then store it in the metadata of the webhook consumer. You can also specify your own Webhook URL, but the destination of the URL should be designed for the reception.

An example of configuring a Webhook Consumer is shown in the image above. The URL of the Webhook Consumer will be added by the edit window after the initial creation. Likewise, you can still do a JSON transformation after the fact. This is necessary if the formatting of the JSON body passed does not match the receiver’s specifications. As soon as new data packets arrive at the application, they are automatically transferred via the Webhook Consumer to the respective target URL using HTTP POST.

Websocket Consumer

Via the Websocket Consumer you can transfer data of an application and therefore also the data of the devices contained in it. Through the Websocket Location the data packets are transferred to the respective Websocket Server. The Websocket uses the Websocket protocol, which is based on TCP and was designed to establish a bidirectional connection between a web application and a Websocket server or a web server.

For a short test, various simple solutions can be found on the Internet, e.g. at “Websocket.org”. There you can integrate a WebSocket location. The metadata of the WebSocket consumer shows the WebSocket location of the client. (For this WebSocket consumer: wss://niota.io/api/x/websocket/consumers/625?auth=5D60254E-E473-4523-A47A-FAECBF672527). The location is unique for each WebSocket consumer.

An example of configuring a WebSocket consumer is shown in the image above. The location of the WebSocket consumer can be found directly in the client window under the heading. Authentication is done by the connection key. You can also perform a subsequent JSON transformation. This is necessary if the formatting of the transferred JSON body does not correspond to the specifications of the receiver. As soon as new data packets arrive at the application, they are automatically transferred via the WebSocket consumer to the respective location of the WebSocket server using PUSH.

Devices

Under the menu item “Devices” you have an overview of all devices belonging to your account. With the appropriate user rights, you can use the various functions. You can create new devices, edit them individually or in groups and delete them.

Search for devices

On the overview page, above the list of devices, there is a search bar where you can search for devices by title or EUI. As soon as you enter a character, the search results will be displayed automatically. You can use the “Account Filter” button to filter the list by devices of specific accounts you have access to. You can select multiple accounts. You can reset the search by clicking the reset button to the right of the filter button.

Create new device

To create a new device in your account, you have several options.

Add new device via originator like firefly

This method is based on the fact that you have already created devices in an originator like DIGIMONDO’s LoRaWAN network server firefly. You can simply transfer them to the IoT Data Hub of niotix.

Click on the button “Create” in the upper right corner. A new window appears.
First, select the application you want to add this device to.
Select the originator and click “Add devices from originator”. A list of devices created in the originator appears.
Select one or more devices. They will appear in a list at the bottom of the window.
Once you have added a device, the “Add” button will be activated. When you click the button, the device will immediately appear on the overview page.

Add new device via Search with EUI, ID, or UUID

This method is based on the fact that you have already created devices in an originator like DIGIMONDO’s LoRaWAN network server firefly. You can transfer these to niotix’ IoT Data Hub by searching for EUI, ID, or UUID.

Click on the button “Create” in the upper right corner. A new window will appear.
First, select the application where you want to add this device.
Select the originator and then click on “Search Devices”
The next window will appear where you enter either the EUI, ID, or UUID of the device in the gray field. If you add multiple devices at once, separate the IDs with a comma.
Click on “Search” and the search result will appear below the field. If the ID was not found in the originator, an error message will be displayed and you will not be able to click the “Add” button. Once the search is successful, click on the device and then on the “Add” button. The device will immediately appear in the overview list.

Create and add a new device manually

In this method, you create a device from scratch with all the necessary information.

Click the “Create” button in the upper right corner. A new window will appear.
First, select the application where you want to add this device.
Select the originator and then click on “Add new device”.
A window will open where you can enter all the information about the device:

Then the next window appears where you click on the green button “Create new device”. A window will appear in which you can enter the data of the new device:

Title:* Give the device a meaningful title for easy identification.

ABP/OTAA:* Activate via the switch “Activation by personalization” (ABP) or “Activation over the air” (OTAA). Depending on which activation method you select for the device, there are different mandatory fields for the process.

Device Type: If available, select the device type to which the new device belongs. This is displayed on the detail page of the device. If you click on the displayed device type, you will be redirected to the detail page of this device type.

Description: Enter a short description of the device that will appear on the detail page.

Tags: Enter tags that appear on the detail page.

ADR Limit: Adaptive Data Rate is a mechanism for optimizing data rates, transmission time, and energy consumption in the network. Here you determine with which spreading factor a device should send packets at least. This can lead to higher energy consumption, but also increase the probability of receiving packets from surrounding gateways.

Region: As in firefly, you can select the LoRaWAN frequency in niotix for international deployment of our IoT software. Note: You cannot change this setting afterwards.

EUI:* A globally unique identifier (Unique Identifier) of 8 bytes (16 hex characters) is created for each device. Enter the EUI of your device here.

Device Address:* Enter the address that the device uses to communicate with the network with 4 bytes (8 hex characters).

Application Key:* Enter the key the device uses for the join handshake.

Application Session Key:* Enter the 16 byte key used to encrypt the application payload. If the field is empty, the application payload cannot be decrypted.

Network Session Key:* This field appears only if you do not enable ABP/OTAA above. Then you have to specify the 16 byte key for encryption.

Create in a specific Organization: firefly organization ID: If the field is empty, the device will be created in the originator’s root organization.

Device Class ID: Enter the ID of the device class in firefly in which the device should be created.

Device is Class C enabled: Enable class C only if the device supports it. Otherwise, failure packets will not be received by the device.

Synchronize location: Enable the function to synchronize the location from the settings in the niotix application and set it to “permanent” in the remote system.

Address input: Enter the address where this application should be displayed on the map. Search results from our database will appear as you type. If they match, click on the address, and latitude and longitude will be determined automatically.

Latitude and Longitude: As an alternative to entering the address, you can also fill in these fields manually.

Add multiple devices via CSV - Bulk Upload

With this method you can easily import multiple devices at the same time using a CSV file into one or more application(s). This is useful when a large amount of devices need to be created at the same time such as a roll-out.

Click on the button to the left of “Account Filter”. This is for the CSV upload. A new page with instructions will open.
Click on the “Upload CSV” button above and paste your file.
A new window will appear where you specify the default settings for all devices.
- Application:* Select the application to which you want to add these devices.
- Originator:* Select the originator.
- Device Type: Optionally select a device type already here.
- OTAA | ABP:* Select which activation should be used.
- Variable Mapper: Assign the associated keys of the devices to the variable mapper. If you select ABP, the mandatory fields are Device Title, Device EUI, APP_sKey, DEV_ADR. If you select OTAA, the mandatory fields are Device Name, EUI, APPKey. If this is not done, the devices cannot be read and created.
Below appears a third box with a list of devices. You can add an additional device here by clicking the button “+ New row”. You can add an additional property to all devices by clicking the “+ New column” button.
When all the necessary information is available, the “Create all” button will be activated. Then click the button. If the addition is successful, a confirmation will appear. The new device will immediately appear in the list. Moreover, it will appear in the organization of the assigned originator, such as firefly.

Edit device

Edit a single device by clicking on a device in the overview list. This will take you to the details page of the device. Here you can change various properties like title, EUI, description, etc. by clicking on the “Edit” icon at the top.

You can set the following settings for this device.

ADR Limit: Adaptive Data Rate is a mechanism for optimizing data rates, transmission time and energy consumption in the network. Here you determine with which spreading factor a device should at least send packets. This can lead to higher energy consumption, but also increase the probability of receiving the packets in the surrounding gateways.
Tile Name: This name will be used as tile name for all devices in the application.
Operational Status: You can choose between “unset”, “in transit”, “ready for operation”, “in operation”, “temporarily inactive” or “decommissioned”. To check the status for the report display on the details page, the most recent operating status of the device is combined with the threshold value. Note: The “in operation” status is set when the device is operating normally.
Threshold for nominal operation: To monitor the operating status of devices in the device detail view and in the application, you can set a threshold value for the selected devices here. This is the minimum number of data packets per day that a device must send to be considered a normally functioning device. If this is not set for the individual device, the default setting is “Expected number of packets” of the device type.
Battery Warning Level: Note: Set the battery level variable in the device type first. The battery level of the device used to consider the battery is not working at 100%. This level is higher than the alarm level. It is used as a warning at both the device and application levels.
Battery Alert Level: Note: Set the battery level variable in the device type first. The battery level of the device with which the battery is considered is low, critical, or damaged. This level is lower than the warning level. It is used as a critical status at both device and application level.
Maximum idle time | Time Units: Set the period for the maximum idle time (e.g. 2 hours). If niotix has not received a packet within this time period, you will be notified as a user.
Details View Options Details (Show/Hide): If you select Nominal, Status, Statistics, SF Chart (Spreading Factor), more report details will appear on the details page of the application.
Device Type: If the selected devices belong to a specific device type, you can select that type from the list and assign the devices directly.
Application: If you want to add the devices to another application, you can select it from the list of applications available to you.

As soon as you click on the save icon, the changes will be applied and displayed immediately.

Meaning of the status of the device monitoring

The operating statuses have the following meanings:

Unset: No status has been inserted.
In transit: The device is configured ready and is on the way.
Ready for operation: The device has been delivered and is ready for installation.
In operation: The device has been put into operation and is sending packets.
Temporarily inactive: The battery is damaged or the device requires maintenance.
Decommissioned: The device is damaged and cannot be put back into service.

“In Operation” is the only status in which the device sends packets, otherwise the user is warned and notified about it.

Edit multiple devices at the same time

In the overview list of all devices available to you, there is a possibility to edit a large number of devices at the same time. Either select which devices you want to edit from the device list or click on the field in the first line next to ID to select all devices currently visible on the list. Then click the “Edit all” button at the top of the device overview. Then a new window with the heading “Update devices” will open with a list of all devices you have selected. You can also delete multiple devices from the application using the trash icon. You can find the settings further up at “Edit device”. Click the Save icon at the top of the window to save your changes.

Statistics and visualization of data packets from devices

On the details page of a device, in the “Details” and “Packet Visualization” tab, you can find several visualizations and statistics that allow you to check data packets and their transmission process in detail.

Signal strength

On the details page, you will find the information about the signal strength in the upper field among other details like creation date and name. The display of the signal at each device is composed of the last RSSI value:

Signal is excellent: RSSI > -60 dBm
Signal is good: -60 dBm < RSSI < -90 dBm
Signal is average: -90 dBm < RSSI < -110 dBm
Signal is weak: -110 dBm < RSSI < -150 dBm
No signal: RSSI < -150 dBm

Packet visualization for devices

On the details page you can view a graphical representation of the packets received in a certain period (Last 24 hours, Last week, Last month) under “Packets Received in Timeframe”. If you have selected Statistics and SF Chart (Spreading Factor) at “View Options Details” in the edit window, more report details will appear on the details page of the application. These give RSSI and SNR values over the selected time period. Received Signal Strength Indication and Signal-to-noise ratio can be used to assess the performance of the LoRaWAN network.

Advanced package search on the device detail page

Under the statistics of the packets is a listing of the packets with the time of delivery, payload, spreading factor, frequency, RSSI, LSNR, and Bandwidth. With the advanced package search, you have the possibility to search for packages. Set a specific date and time in the box above to search for packages from a specific date and time. Click on “Load more packets” to expand the view and display more packages.

When you click on a packet’s line, a box pops up below it with detailed information about the packet such as the unparsed payload, device address, EUI, gateway ID, and the parsed, broken down packet data.

Visualization of individual packages

On the detail page under the tab “Package visualization”, you can see visualizations of the relevant broken down data values of the device (e.g. battery level, CO2, temperature, pressure) broken down individually. The graph shows the most recent package data. To load more packets, click on “Load more packets” below and the graph will expand. Note: This function is only displayed if a device type is stored.

Downloading data packages of a device as CSV

On the details page of the device, you can see the “CSV” button at the top. If you click on it, a new window will open. Here you can select the variables of the data as well as the time period and the packet limit. You have the option to group the data by timestamps. Click CSV or JSON below to download a file with the data packets in the appropriate format.

Downloading data packages of a device as CSV

On the details page of the device you can see the “CSV” button at the top. If you click on it, a new window will open.

Here you can select the variables of the data and the time period. You can choose if the CSV file should be generated per variable or per device. You can specify an e-mail address to which a download link will be sent after the download is finished. You can find the file by clicking on the button “CSV” in the upper right corner of the menu bar. Then the page “CSV-Export” will open, where you can download the file.

Send downlinks to devices

For devices from an actility network server (data source “Actility”), niotix provides the possibility to send downlinks directly from the devices-page. In comparison to the standard downlinks configured in the device types, here you can send individual payloads to a device.

To send a downlink, select the actility-device and scroll down to the section “send downlinks” in the device details:

Payload: The payload send to the device
Port: The port which will be used
Confirmed: Request a downlink-received-confirmation
Flush queue: Flush queue of downlinks
Send: By clicking on the button, the downlink will be submitted to the device

Delete device

On the overview page, you will find two icons behind each device for editing and deleting a device. Click on the “Trash” icon to delete a device. If the deletion was successful, a green-colored confirmation message “Device deleted” will appear.

Please note that the device is only deleted in niotix and not in connected systems such as firefly. If a device is to be deleted completely, it must be deleted both in niotix and again separately in firefly.

Monitoring

The menu item “Monitoring” contains the device monitoring and the gateway monitoring.

Device Monitoring

Under the menu item “Monitoring” you can see device warnings of the devices belonging to your account at a glance. This is especially helpful to prevent device failures at an early stage and also to check multiple devices for battery status or network coverage.

Battery warning: Warnings that the battery should be checked as a precaution. This value can also be set individually in the device type.
Battery alert: Critical battery levels that will soon lead to a failure of the device. This value can be set individually in the device type.
Idle time exceeded: Refers to devices that send packets below the specified threshold per day. The value of the expected packets per day is specified in the device type. In addition, monitoring data is used to verify the operational status of the device in the application.

You can filter devices by accounts if you manage multiple sub-accounts, or by the alert type with a click over the icons in the top row and reset the filter with the button on the far right. You can also download the list of devices with alerts as CSV. If there is no warning message, nothing is displayed in the list.

A device is only listed in the device monitoring, if at least one paket was received in niotix. This means, that devices in niotix which never send a paket before are not monitored. In addition, a device must at least send one paket a day to be monitored.

Gateway Monitoring

With the gateway monitoring you can see warnings of the gateways belonging to your account at a glance.

You can filter the critical gateways by account, if you manage multiple sub-accounts, or by warning type (warning or alert level) with a click over the icons in the top row and reset the filter with the button on the far right. The button “Load map” shows you the gateways on a map instead of the list view.

Furthermore, you have the possibility to set up an email notification for critical gateways that are in the alarm stage by clicking the button to the left of the “Load map”. The prerequisite for the setup is an existing email connector from the account settings.

The system checks the status of the gateways every 5 minutes. As soon as there are changes, a notification is sent to the recipients again. Using the account filter, you can decide whether only critical gateways from a specific account or from all accounts accessible to you are evaluated for notification. Please note that other email recipients, who may not have the same permissions as you, will also receive the list of critical gateways accessible to you.

Devicetypes

Under the menu item “Devicetypes” you will see a list of the device types to which you have access with your account. Here you create templates for using and grouping devices with the same functions and data structures with the appropriate user rights. You can use standards for converting packet data via a packet parser.

Search for device types

On the overview page, above the list of device types, there is a search bar where you can search for a type by its title. As soon as you have entered a letter, the search results will be displayed automatically. By clicking the “DIGIMONDO Certified” button you can filter the list by device types that carry the “DIGIMONDO Certified” certificate. Device types receive the DIGIMONDO certification if they meet certain standards and have proven themselves in tests and practice. Certified device types are preceded by a green icon in the title.

The “Used Device Types” button allows you to filter the list by device types to which at least one device is assigned. You can reset the search using the reset button to the right of the filter button.

Create device type

To create a new device type, click on the “Create” button in the upper right corner. Then a new window will open where you enter the details of the type:

Copy from a Device-Type: If the type already exists in the same form, you can select it from the list of types.
Image: add an image of the device type for unique identification.
Certified by: If you have the appropriate permissions as an administrator, you can certify device types and enter the name of your company. When you click on “Certified”, the icon will appear in the title.
Title:* Enter an easily identifiable name for the device type.
Visibility:* Select whether the device type appears only in the selected account or in all accounts to which you have access.
Account:* Select the account or sub-account to which this type should be added.
Description: Give a more detailed description of the device type.
Manufacturer Devicename: Specify the exact device name of the manufacturer
Extended number of packets (heartbeats) in 24h: Specify how many packets this device type should receive at least within 24 hours. This value is used to determine the threshold for nominal operation.
Attachments: Attach files such as the device’s datasheet, manual, or installation instructions.
Installation Notes: Here you can provide bullet points about the installation.
Highlights: Provide additional keywords or key information about the device type.
Technical Specifications: Enter additional useful information about the device type here, such as model, usage, configuration, connectivity, frequency, TX power, TX distance, power supply, operating temperature, security, mounting, dimensions, weight, standards, battery, battery life, firmware, precision, installation height, other.
JSON: All previously entered values under Technical Specification appear in the expandable menu in JSON format.

All mandatory fields are marked with an asterisk. When you have filled in all mandatory fields, the button “Save and Create” will be activated. As soon as you press this button, the type appears in the overview list.

Edit Devicetype

If you click on a device type in the list, you will get to the detail page of the type with the information like description or manufacturer information.

Click on the “Edit” button to open a new window. Here, in addition to the values set in the creation process, you can also enter the values for checking the battery level for device monitoring.

Battery Level Variable: Select a variable from the list that shows the battery level.
Battery Level Type: If you select an appropriate variable, you can set the unit here.
Battery Warning Level: Set the value at which the battery warning level starts. It is used as a warning at both the device and application levels. The battery level of the unit used to consider the battery is not working at 100%. This level is higher than the alarm level.
Battery Alert Level: Set from which value the battery alarm level starts. It is used as a critical status on both device and application level. The battery level of the device with which the battery is considered is low, critical, or damaged. This level is lower than the warning level.

Under the “Devices” tab on the details page, you can see all the devices from your account and, if applicable, the sub-accounts associated with the device type.

You can search for devices by their title using the search field. Clicking on a device in the list will take you to the device’s details page. You can edit single or multiple devices at once by clicking on one or all devices in the row next to ID. This activates the “Edit” button. With a click on it, a window opens and you can edit the devices. Read more in the chapter “Edit multiple devices in applications at once”.

Select Packet Parser for Devicetype

Under the “Packet Parser” tab on the details page, you can configure the parser for this device type. Parsers are used to interpret and decrypt the transmitted payload of the sensor. You can find a quick guide on the parser setup page to better understand the configuration details. You can select a single parser, multi-parser, or a function parser. If no parser is selected, you can choose the parser form on the page. Then a window opens where you can configure the parser.

Use predefined parsers

For some device types, there are already predefined parsers created by the DIGIMONDO team. Choose one of these parsers if it fits your device type. In this case, you don’t have to set anything else. You have the option to assign types to the target variable under “Type definitions”. You can also test the parser with a sample payload.

Use single parser

Select this parser for simple payloads that do not require complex transformations.

Click on “Single parser” on the overview page. This will take you to the configuration details page.
At the top, you will find a quick guide and the possibility to use a predefined single parser.
In the “Parser” field, specify the bits and types (integer, boolean, string, float) for the target variables (e.g. temperature). You can add further target variables by clicking on the plus icon. Use the trash can icon to remove variables.
Define transformation formulas or a calculation for the target variables in the “Calculations” field. You can add further calculations for target variables by clicking on the plus icon. With the trash can icon you can remove them.
Define the type of the target variable in the field “Type definitions”. If measurement values are to be indexed in InfluxDB and visualized with Grafana, it is necessary to assign types to the variables. The list is automatically filled with the target variables from the previous sections. Select a type from the list that opens in the “Type” field that matches the variable. If no type fits, select “Number”.
In the “Parser tester” field, test if the definitions work by using a sample payload (encoded as hexadecimal code). Enter this payload into the specified text field. Click the “Parse” button and check the result.
Click the “Save” button in the upper right corner to save the parser settings.
If you want to change the parser form, click the red “Change parser” button. You will be redirected to the overview page of the parser types. All previously entered data will be deleted.

Use multi-parser

Select this parser for interpreting more complex payloads using a switch parser. Here, different single parsers are combined with each other.

Click on “Edit switch parser” to configure the switch parser. A window opens.
At the top you will find a short tutorial and the possibility to use a predefined single parser.
In the field “Parser” define the bits and types (integer, boolean, string, float) for the target variables (e.g. temperature). You can add further target variables by clicking on the plus icon. Use the trash can icon to remove variables.
Define a transformation formula or a calculation for the target variables in the “Target parser calculation” field. You can add further calculations for target variables by clicking on the plus icon. Remove them with the trash can icon.
Test in the field “Parser tester” if the definitions work by using a sample payload (coded as hexadecimal code). Enter this payload into the given text field. Click the “Parse” button and check the result.
Click the “Save” button in the upper right corner to save the parser settings.
Click on “Edit default parser” to configure the default parser. A window will open. If the payload does not match any of the single parsers in the switch parser, it will be assigned to the default parser.
Create the default parser as described above in the instructions for the single parser.
If you want to change the parser form, click on the red “Change parser” button. You will be redirected to the overview page of the parser types. All previously entered data will be deleted.

Use Function Parser

Select this parser to define a custom parser in Javascript or Elixir or to use an external parser (URL payload parser) to transform the payload.

Above you find a short instruction with examples how to write the parser in Javascript or Elixir.
Enter the parser code in the command field under “Parser”. The window above the field lets you switch between Elixir and Javascript or the URL Payload Parser. The function of the URL payload parser is described in the next chapter.
Define transformation formulas or a calculation for the target variables in the “Calculations” field. You can add more calculations for target variables by clicking on the plus icon. With the trash can icon, you can remove them.
In the “Type definitions” field, specify the type and layout of the target variables in the parser. If measured values are to be indexed in InfluxDB and visualized with Grafana, it is necessary to assign types to the variables. The list is automatically filled with the target variables from the previous sections. Select a type from the list that opens in the “Type” field that fits the variable. If no type fits, select “Number”.
In the “Parser tester” field, test if the definitions work by using a sample payload (encoded as hexadecimal code). Enter this payload into the specified text field. Click the “Parse” button and check the result.
Click the “Save” button in the upper right corner to save the parser settings.

Extended Return Structure

Virtual devices have special new features in conjunction with Javascript and Elixir function parsers. The parser can return a result object or a list of result objects (array). The structure of this object list is explained below by way of example. With this object list it is possible to return multiple values per packet at different times. This is interesting if, for example, it is a water meter that takes 24 measurements per day and then transmits the measurements with the corresponding reading time stamps once a day. These 24 values can now be stored at the data point of the virtual device with the corresponding time stamp.

This also works with MQTT and WebHook Inbound virtual devices, here, for example, a list of parsed payload objects can be transferred for a payload that has already been parsed .
The meta object of the extended return structure can be specified in the objects and then ensures that the values can be written to the state at any moment in time.

  module.exports = function (payload, meta) {
  const port = meta.lora.fport;

  const buf = Buffer.from(payload, 'hex');
  const battery = buf.readUInt16BE(0);  // parse 2 bytes with offset 0
  const temperature = buf.readFloatBE(2); // parse 4 bytes with offset 2

  return [
    {
      battery: battery,
      temperature: temperature,
      meta: {                           // meta tag is optional
        time: "2020-01-01T12:34:56Z"
      },
    },
    {
      battery: battery,
      temperature: temperature,
      meta: {                           // meta tag is optional
        time: "2020-01-01T12:34:56Z"
      },
    }
  ]
}

Note: with the Extended Return Structure, due to the fast processing of the values from the array, inconsistencies can occur during the execution of rules at high system load (rule evaluation with wrong value). This is extremely rare. Nevertheless, it is not recommended to use sensors that send multiple measured values in one packet if the use case is critical and rules are to be executed based on the supplied data.

URL Payload Parser

This type of parser is used when you want to use an external parser that can be reached via HTTP. In this case, the payload for conversion is sent to the specified URI as an HTTP POST in the “Body” as a JSON object, and the response then contains the converted payload. You can find an example JSON in the parser quick reference in the system.

Configure standard downlinks

In the tab “Downlinks” standard downlinks for device types can be configured. With this, simple downlink messages can be sent to devices from the devices in niotix, e.g. for resetting or switching on or off. Currently only firefly devices are supported. You can only use the downlinks for device types that are not digimondo certified. Contact your DIGIMONDO account manager if you want to create downlinks for certified devices.

Configure a downlink in the “Configuration” field by clicking on the plus button and entering the following information:
Name: * Specify the name of the downlink.
Port: Select the port between -1 and 9 using the arrows.
Payload _: Specify the payload to be sent.
Encoding _: Select between the encodings base16, base64 or utf8.
Gateways ID: Specify the ID of the gateway.

Fields with asterisks are required fields. Click on the “Save” button. This default downlink is now available for all devices of this device type. On the details page of a device, you can select and send a downlink.

Devices

The devices that have assigned the device type are displayed in this list. Attention, only devices from the IoT-Data-Hub are currently displayed here, no virtual devices!

Device Health Config

This function is only used in the virtual devices. Here you set which variables play a role in calculating the system status of a virtual device. First, the variables can be selected in the list view, which are then provided with a calculation logic in a second step in order to calculate the system status.

After the variables have been selected, a calculation logic can be defined using the Add button. After the calculation logic has been defined and saved, the configuration made serves as a template for all virtual devices that will be assigned this device type in the future.

The specific configuration for determining the system status on the virtual device is created from this template, but can be individually adjusted by the user at the virtual device level.

Delete Devicetype

On the overview page, you will find two icons behind each device type for editing and deleting. Click on the “Trash” icon to delete a type. If the deletion was successful, a green-colored confirmation message “Device type deleted” appears.

Sources

Under the “Sources” menu, the two menu items “Originators” and “Datasources” fold out. They are used to get data into the IoT Data Hub. Only administrators and authorized users with advanced IoT knowledge have access to these functions.

Originators

An originator is a connection to a kind of “data pipeline” in which various other data sources are brought together. You can receive data from different sources through an originator. It represents a specific data stream or a connection of incoming data in combination with secure credentials from a specific data source.

The menu item “Originators” leads you to the list of available originators. Depending on your access rights, you can create, update and delete originators.

Search for Originator

On the overview page, above the list of originators, there is a search bar where you can search for an originator by title. As soon as you enter a letter, the search results will be displayed automatically.

Create new Originator

The originator types are already created in the system. Click on the “Create” button in the upper right corner. A window opens with the possible types: LoRaWAN, Sigfox, NB-IoT, Discovergy, Temetra, Actility, Webhook or File System.
Select the originator type. Then a new window will open where you specify the data of the originator:

Image: insert an image for easy identification.

Title:* Give the originator a meaningful title.

Type:* Specify the previously selected type. You cannot change this field.

Description:* Provide a short description of the originator for more detailed identification.

Account:* Select the account to which the originator will be assigned from the list displayed.

Data Source:* Select the data source that will be assigned to the originator. This is done according to the type, e.g. for LoRaWAN a LoRaWAN source.

Mandatory fields are marked with *. Depending on the originator type, additional fields like API Key or Webhook APIKey appear.
When you have filled in all mandatory fields, the “Save & Create” button will be activated in the upper right corner. Click the button to save the originator.
The new originator will immediately appear in the overview list.

Edit Originator

To edit an originator, click on the “Edit” icon on the right side of the line of the originator you want to edit. A window will open where you can change all the data required above in the creation process. Click the “Save” button to save the changes.

Originator Live-Status

On the originator overview page, you can see the respective originator’s live status under the “Status” column. The icons have the following meaning:

Visible to administrators only: A spinning refresh icon means that the originator is linked to another account. The connection status is only visible if the administrator is logged into the corresponding account.
A green cloud icon with a checkmark indicates that the originator is connected and working properly.
A red circle indicates that the originator is not working properly and there is a problem.

Delete Originator

On the overview page, you will find two icons behind each originator for editing and deleting. Click on the “trash” icon to delete an originator. If the deletion was successful, a green-colored confirmation message will appear.

Datasources

In the menu item “Datasources” you will find an overview of all created sources with the corresponding ID, source, type, status (public/private), active, and creation date. Depending on your permissions you can either see only the data sources listed or additionally their status and details. A data source is the main source for different types of data with different credentials. You need a data source when creating new originators, see “Create originator” above.

Search for Datasource

On the overview page, above the list of data sources, there is a search bar where you can search for a source by title. Once you enter a letter, the search results are automatically displayed.