IoT Unified

User Guide
Created By Gabriel Turmail, Logan Kraus
Revision D
Revision Date: 5/09/2023

SORBA.ai™️ - EFFECTIVE 01 January 2023 | © SORBOTICS LLC., 2023

CONFIDENTIAL- Please Do Not Share.
ALL RIGHT RESERVED. ANY UNAUTHORIZED USE OR DISCLOSURE IS PROHIBITED BY LAW AND WILL RESULT IN PROSECUTION.
 1

Terms And Conditions User Agreement

All rights reserved. No part of this documentation shall be reproduced, stored in a retrieval system, or
transmitted by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
written permission. No copyright or patent liability is assumed with respect to the use of the information
contained herein. Although every precaution has been taken in the preparation of this documentation, the
publisher and the author assume no responsibility for errors or omissions. Neither is any liability assumed
for damages resulting from the use of the information contained herein.

The information in this documentation is subject to change without notice and does not represent a
commitment. The software described in this documentation is furnished under a license or nondisclosure
agreement. This software may be used or copied only in accordance with the terms of these agreements.

IoT Unified User Guide

 2

Table of Contents

TERMS AND CONDITIONS USER AGREEMENT............................................................................................1

TABLE OF CONTENTS ...................................................................................................................................2
INTRODUCTION ............................................................................................................................................7
ABOUT THIS MANUAL .................................................................................................................................................. 7
Technical Support ................................................................................................................................................ 7
SYSTEM OVERVIEW .......................................................................................................................................8
ACCESSING THE SYSTEM OVERVIEW ........................................................................................................................... 8
INFORMATION AVAILABLE IN THE SYSTEM OVERVIEW .................................................................................................. 8
Device Details ...................................................................................................................................................... 8
Connections .......................................................................................................................................................... 9
Hardware resources............................................................................................................................................. 9
Disk Volumes ........................................................................................................................................................ 9
Network Usage ................................................................................................................................................. 10
Network Interfaces ........................................................................................................................................... 10
Data Collection ................................................................................................................................................. 10
Device Nodes .................................................................................................................................................... 11
System Events .................................................................................................................................................... 11
Device Geolocation .......................................................................................................................................... 12
ACCESSING OTHER PORTIONS OF THE SORBA PLATFORM....................................................................................... 12
Workspace........................................................................................................................................................ 12
Dashboards ....................................................................................................................................................... 13
Workflows ........................................................................................................................................................ 13
Data View ......................................................................................................................................................... 14
Machine Learning Trainer ................................................................................................................................ 14
OEE .................................................................................................................................................................... 15
Vibration ........................................................................................................................................................... 15
System Supervisor............................................................................................................................................. 17
Task Flow ........................................................................................................................................................... 17
Identity Server................................................................................................................................................... 18
System Events .................................................................................................................................................... 18
Alarms ............................................................................................................................................................... 19
TOOLS AVAILABLE IN THE SYSTEM OVERVIEW........................................................................................................... 19
Extra Tools ........................................................................................................................................................ 19
Alarms and Notifications ................................................................................................................................. 19
Profile Tools ...................................................................................................................................................... 20
WORKSPACE .............................................................................................................................................. 21
ACCESSING THE WORKSPACE PAGE ........................................................................................................................ 21
ABOUT THE WORKSPACE PAGE ............................................................................................................................... 21
ASSETS..................................................................................................................................................................... 21
Alarms ............................................................................................................................................................... 22
Channels ............................................................................................................................................................ 22
Dashboards and Flows ..................................................................................................................................... 22
Groups ............................................................................................................................................................... 22
IOT Connectors ................................................................................................................................................. 22
Model Instances ................................................................................................................................................ 23
Scripts ................................................................................................................................................................ 23

IoT Unified User Guide

 3

INDIVIDUAL VS GLOBAL ............................................................................................................................................ 23

DEVICE NODE ............................................................................................................................................. 24
ABOUT DEVICE NODES............................................................................................................................................. 24
EDITING A DEVICE NODE .......................................................................................................................................... 24
Device Info ........................................................................................................................................................ 24
System Timeout Settings ................................................................................................................................... 25
Alarm Timeout Settings .................................................................................................................................... 25
Modbus TCP and OPC UA .............................................................................................................................. 25
Data Policy........................................................................................................................................................ 26
Hot Data Storage and In-Memory Database ................................................................................................ 27
The Core ............................................................................................................................................................ 27
Events Middleware............................................................................................................................................ 28
OS Info.............................................................................................................................................................. 29
Task Execution Database ................................................................................................................................. 29
Housekeeper...................................................................................................................................................... 29
IOT Connectors ................................................................................................................................................. 30
Machine Learning Runtime ............................................................................................................................... 30
Machine Learning API ...................................................................................................................................... 30
Dashboard Designer ......................................................................................................................................... 31
Script Engine ..................................................................................................................................................... 31
Networking........................................................................................................................................................ 32
Custom Fields .................................................................................................................................................... 32
ASSET AND GROUP CREATION ................................................................................................................ 33
CREATING AN ASSET ................................................................................................................................................ 33
CREATING A GROUP ................................................................................................................................................ 34
GROUP GRANULARITY ............................................................................................................................................. 34
Why Groups are Important ............................................................................................................................. 35
CHANNEL CREATION................................................................................................................................. 36
CREATING A CHANNEL ............................................................................................................................................. 36
NEW CHANNEL WARNING ...................................................................................................................................... 37
TAG CREATION .......................................................................................................................................... 38
WHAT IS A TAG ....................................................................................................................................................... 38
CREATING A TAG ..................................................................................................................................................... 38
Types of Tags.................................................................................................................................................... 39
Triggering Tags ................................................................................................................................................ 39
Connecting Tag to Data Pipeline .................................................................................................................... 40
Finishing Tag ..................................................................................................................................................... 40
GLOBAL VS ASSET LEVEL NODES ............................................................................................................. 41
WHEN TO USE EACH VERSION................................................................................................................................. 41
WHY IS THIS IMPORTANT ......................................................................................................................................... 41
ALARMS ...................................................................................................................................................... 42
HOW TO CREATE A NEW ALARM ............................................................................................................................. 42
Setting Up Alarm Trigger ................................................................................................................................ 43
Linking To Notification Channel ...................................................................................................................... 43
Saving Alarms................................................................................................................................................... 44
HOW TO MONITOR ALL ALARMS ............................................................................................................................. 44
NOTIFICATION CHANNELS ....................................................................................................................... 47

IoT Unified User Guide

 4

HOW TO CREATE A NOTIFICATION CHANNEL ........................................................................................................... 47

CONFIGURING A NOTIFICATION CHANNEL............................................................................................................... 47
Email .................................................................................................................................................................. 48
SMS ................................................................................................................................................................... 48
Slack and Teams ............................................................................................................................................... 48
SCRIPT ENGINE........................................................................................................................................... 49
WHAT IS THE SCRIPT ENGINE? .................................................................................................................................. 49
CREATING A NEW SCRIPT......................................................................................................................................... 49
Script Settings ................................................................................................................................................... 49
Finishing the Script ........................................................................................................................................... 51
IOT CONNECTORS ..................................................................................................................................... 52
WHAT ARE IOT CONNECTORS USED FOR? .............................................................................................................. 52
CREATING A NEW IOT CONNECTOR........................................................................................................................ 52
Adding Data Processors................................................................................................................................... 54
Servers and Clusters ......................................................................................................................................... 55
Finishing the IOT Connector ............................................................................................................................ 57
DASHBOARD AND FLOW NODES ............................................................................................................. 59
WHAT ARE DASHBOARD AND FLOW NODES USED FOR? ......................................................................................... 59
IMPORTING DASHBOARDS INTO ASSETS ................................................................................................................... 59
DASHBOARD REPORTS .............................................................................................................................................. 60
CUSTOM VARIABLES FOR DASHBOARD REPORTS ....................................................................................................... 61
CUSTOM FIELDS ......................................................................................................................................... 63
WHAT ARE CUSTOM FIELDS ..................................................................................................................................... 63
HOW TO MAKE CUSTOM FIELDS .............................................................................................................................. 63
TYPES OF CUSTOM FIELDS ........................................................................................................................................ 63
Text .................................................................................................................................................................... 63
Long Text .......................................................................................................................................................... 64
Number .............................................................................................................................................................. 64
Select ................................................................................................................................................................. 64
Checkbox .......................................................................................................................................................... 64
Radio ................................................................................................................................................................. 64
APPLY CHANGES ....................................................................................................................................... 66
WHAT DOES APPLYING CHANGES DO? ................................................................................................................... 66
CLOUD SYNCHRONIZATION..................................................................................................................... 67
DIFFERENCE BETWEEN SORBA CLOUD AND EDGE .................................................................................................... 67
HOW TO SYNCHRONIZE .......................................................................................................................................... 67
From the Edge ................................................................................................................................................... 67
From the Cloud ................................................................................................................................................. 67
Sync Menu ......................................................................................................................................................... 68
CLASSES AND INSTANCES......................................................................................................................... 69
WHAT ARE CLASSES AND INSTANCES?...................................................................................................................... 69
CREATING CLASSES AND INSTANCES ........................................................................................................................ 69
Turning an Asset into a Class .......................................................................................................................... 69
Turning a Class into an Asset .......................................................................................................................... 70
FOLLOW CLASS CHANGES....................................................................................................................................... 71
SNAPSHOTS................................................................................................................................................ 72

IoT Unified User Guide

 5

WHAT ARE SNAPSHOTS?.......................................................................................................................................... 72

HOW TO CREATE A SNAPSHOT ................................................................................................................................ 72
HOW TO RESTORE A SNAPSHOT .............................................................................................................................. 73
HOW TO DELETE A SNAPSHOT ................................................................................................................................. 74
WORKSPACE TOOLS .................................................................................................................................. 75
TOOLS WITHIN THE OPTIONS MENU......................................................................................................................... 75
Move .................................................................................................................................................................. 75
Clone ................................................................................................................................................................. 75
Delete................................................................................................................................................................. 76
TOOLS IN THE DATA TREE ......................................................................................................................................... 77
Search ................................................................................................................................................................ 77
Multiselect.......................................................................................................................................................... 78
TOOLS IN THE WRENCH MENU................................................................................................................................. 79
Ping.................................................................................................................................................................... 80
Port Check ......................................................................................................................................................... 80
Terminal ............................................................................................................................................................. 81
BACKUP AND RESTORE ............................................................................................................................................. 81
Creating a Backup............................................................................................................................................ 81
Restoring a Backup........................................................................................................................................... 83
DATA VIEW ................................................................................................................................................. 84
WHAT IS DATA VIEW? ............................................................................................................................................. 84
HOW TO GET TO DATA VIEW .................................................................................................................................. 84
POLLING MODE VS SUBSCRIPTION MODE ................................................................................................................ 85
WORKFLOWS .............................................................................................................................................. 87
WHAT ARE WORKFLOWS? ...................................................................................................................................... 87
HOW TO ACCESS WORKFLOWS ............................................................................................................................. 87
HOW TO CREATE A WORKFLOW............................................................................................................................. 87
SORBA In and SORBA Out ............................................................................................................................. 88
Deploying your Workflow ............................................................................................................................... 90
DASHBOARDS ............................................................................................................................................ 91
WHAT ARE DASHBOARDS? ....................................................................................................................................... 91
HOW TO ACCESS DASHBOARDS .............................................................................................................................. 91
HOW TO CREATE A NEW DASHBOARD .................................................................................................................... 92
Changing Dashboard View.............................................................................................................................. 94
Saving your Dashboard ................................................................................................................................... 95
IDENTITY SERVER ....................................................................................................................................... 97
HOW TO ACCESS THE IDENTITY SERVER .................................................................................................................... 97
USERS ...................................................................................................................................................................... 97
ROLES ...................................................................................................................................................................... 98
TENANTS .................................................................................................................................................................. 98
APIs.................................................................................................................................................................... 98
TASK FLOW ................................................................................................................................................ 99
WHAT IS THE TASK FLOW? ...................................................................................................................................... 99
HOW TO ACCESS THE TASK FLOW........................................................................................................................... 99
RELEASES AND DEPLOYMENTS ................................................................................................................................. 100
SYSTEM EVENTS ....................................................................................................................................... 103
HOW TO ACCESS SYSTEM EVENTS ......................................................................................................................... 103

IoT Unified User Guide

 6

FILTERING SYSTEM EVENTS...................................................................................................................................... 103

CHANGING DISPLAYED EVENT INFORMATION ......................................................................................................... 104
ADVANCED CLOUD SETTINGS ................................................................................................................ 106
HOW TO ACCESS ADVANCED CLOUD SETTINGS .................................................................................................... 106
WHAT ARE THE ADVANCED CLOUD SETTINGS?....................................................................................................... 106
Cache Time Live .............................................................................................................................................. 106
Tasks Execution ............................................................................................................................................... 107
Platform API ................................................................................................................................................... 107
ML Trainer API ................................................................................................................................................ 107
MQTT Broker .................................................................................................................................................. 107
Dashboard Designer ....................................................................................................................................... 108
Cold Data API ................................................................................................................................................ 108
APPLYING ADVANCED CLOUD SETTINGS ................................................................................................................ 109
DEPLOYING MODELS ............................................................................................................................... 110
HOW TO DEPLOY A MACHINE LEARNING MODEL................................................................................................... 110
Mapping .......................................................................................................................................................... 111
Output Mapping ............................................................................................................................................. 112
What is Auto Learning? ................................................................................................................................. 112
How to Adjust Auto Learning in a Model ..................................................................................................... 112
FINALIZING YOUR MODEL....................................................................................................................................... 114
APPENDIX A: INSTALLATION ................................................................................................................. 115
MINIMUM REQUIREMENTS ....................................................................................................................................... 115
INSTALLING OPERATING SYSTEM ............................................................................................................................ 115
INSTALLING SORBA............................................................................................................................................... 120
APPENDIX B: SCRIPT ENGINE EXAMPLES .............................................................................................. 123
BASIC SCRIPT ......................................................................................................................................................... 123
INITIALIZATION SCRIPT ............................................................................................................................................ 123
QUALITY FUNCTIONS ............................................................................................................................................. 124
CUSTOM DATA PROCESSOR ................................................................................................................................... 124
APPENDIX C: IOT CONNECTOR EXAMPLES ........................................................................................... 127
INFLUX TO MQTT .................................................................................................................................................. 127
MQTT TO INFLUX .................................................................................................................................................. 129
MOVING MEAN DATA PROCESSOR ........................................................................................................................ 131
SCALING DATA PROCESSOR................................................................................................................................... 132
APPENDIX D: CHANNEL EXAMPLES ....................................................................................................... 133
OPC UA ............................................................................................................................................................... 133
SIEMENS .............................................................................................................................................................. 134
MODBUS ............................................................................................................................................................. 134
APPENDIX E: ACCESSING VIRTUAL MACHINE IP ADDRESS ................................................................. 135
APPENDIX F: UPDATING SORBA LICENSE ............................................................................................. 136

IoT Unified User Guide

 7

Introduction
ABOUT THIS MANUAL
This manual is divided into a series of logical building block chapters that describe the various aspects of
using the SORBA IOT Unified Platform. The SORBA IOT Unified Users Guide will help you familiarize yourself
with the SORBA IOT Unified Platform and its tools.

Assumptions:
Users are familiar with Operating System: Windows, Linux, or Mac OS.
Users are knowledgeable of how-to use of a mouse, Windows menus, select options, browser navigation,
and accessing online Help.
Users are experienced with SORBA SDE user interface and Web configuration Tools interface.

TECHNICAL SUPPORT
Our Technical Support team offers a variety of support options to answer any questions on the SORBA IOT
Unified product and their implementation.

Prior to contacting technical support, please refer to the relevant chapter(s) in your SORBA IOT Unified
User's Guide for a possible solution to any problem(s) you may have with your system. If you find it
necessary to contact technical support for assistance, please make sure to have the following information
available:

1. The version of SORBA IOT Unified you are running.

2. The type and version of the operating system you are using. For example, Microsoft Windows 7.
3. The exact wording of system error messages encountered.
4. Details of the attempts you made to solve the problem(s) and your results.
5. Details of how to recreate the problem.
6. If known, the Technical Support case number assigned to your problem (if this is an on-going
problem).

Technical Support can be contacted during regular business hours at [email protected] or

https://www.sorba.ai/support. Please make sure to have the information stated above to assist in
determining rapid response solutions.

IoT Unified User Guide

 8

System Overview
ACCESSING THE SYSTEM OVERVIEW
System Overview is the first page you will access when you go into your instance.

System Overview Page

INFORMATION AVAILABLE IN THE SYSTEM OVERVIEW

From the System Overview page, you can access a large amount of information about your device and
system. Below we will go through each section of data.

DEVICE D ETAILS
Device details has general information about your device, including the device name, serial name,
operating system, device up time, and the current system time.

IoT Unified User Guide

 9

Device Details

CONNECTIONS
Connections shows you the current connection status, including the connection to the SORBA Cloud, the
connection to the VPN, and whether the device is connected to the internet

Connections

HARDWARE RESOURCES
Hardware resources shows you a summary of the resources available on your device.

Hardware Resources

DISK VOLUMES

IoT Unified User Guide

 10

Disk volumes shows you how much storage space is left on your device.

Disk Volumes

NETWORK USAGE
Network usage presents a summary of your device’s network usage over time.

Network Usage

NETWORK INTERFACES
Network interfaces shows you a list of your device’s current network interfaces.

Network Interfaces

DATA COLLECTION
Data collection shows you a summary of your data collection, including your current data collection rate.

IoT Unified User Guide

 11

Data Collection

DEVICE NODES
Device nodes shows you a summary of nodes and will display how many nodes of each different node
type you have within your IOT Unified Workspace (we will cover nodes in more detail in a later section of
this guide).

Device Nodes

SYSTEM EVENTS
System events is a summary of the events on your IOT Unified system including errors, warning, and
information events.

IoT Unified User Guide

 12

System Events

DEVICE GEOLOCATION
Device Geolocation provides you with the GPS location of your device so you can locate it. If you are
using a cloud instance with multiple devices you will be able to see all device locations.

Device Geolocation

ACCESSING OTHER PORTIONS OF THE SORBA PLATFORM

The system overview also provides a launching off point to access the other portions of SORBA. You can
click on any of these icons to jump to that portion of the platform:

WORKSPACE

IoT Unified User Guide

 13

Workspaces Navbar Icon

This icon will open your workspace to access your IOT Unified Platform, where you will be configuring your
data tags.

DASHBOARDS

Dashboards Navbar Icon

This icon will open dashboards, which you can use for visualizing your data.

WORKFLOWS

IoT Unified User Guide

 14

Workflows Navbar Icon

This icon will open workflows, which you can use to add logic to your data.

DATA VIEW

Data View Navbar Icon

This icon will open data view, where you can get a quick view of the current values on different data tags.

MACHINE LEARNING TRAINER

IoT Unified User Guide

 15

Machine Learning Trainer Navbar Icon

This icon will open the machine learning trainer, where you will be creating machine learning models.

OEE

OEE Navbar Icon

This icon will take you to see your specialized tools for OEE.

VIBRATION

IoT Unified User Guide

 16

Vibration Navbar Icon

This icon will take you to see your specialized tools for vibration.

IoT Unified User Guide

 17

SYSTEM SUPERVISOR

System Supervisor Navbar Icon

This icon will take you to the system supervisor, where you can see a summary of all the different SORBA
services and their statuses.

TASK FLOW

This icon will take you to the task flow, an area for deploying custom code and for receiving and
deploying over-the-air updates.

IoT Unified User Guide

 18

IDENTITY SERVER

Identity Server Navbar Icon

This icon will take you to your identity server. Here you can edit users, their roles, and the permissions
granted to various roles.

SYSTEM EVENTS

System Events Navbar Icon

This icon will take you to the history of your system events.

IoT Unified User Guide

 19

ALARMS

Alarms Navbar Icon

This icon will take you to the summary of your alarms.

TOOLS AVAILABLE IN THE SYSTEM OVERVIEW

Additionally, from the top right corner of the system overview page, you can access a few more tools. These
tools include:

EXTRA TOOLS

Extra tools
From the wrench icon you can access the ping check, the port check, and your terminal.

ALARMS AND NOTIFICATIONS

You can click on the bell icon to see your current alarms and notifications.

IoT Unified User Guide

 20

Alarms and notifications

PROFILE TOOLS
You can click on your profile to access the manage account, backup and restore, note types, about, and
logout options.

Profile Tools

IoT Unified User Guide

 21

Workspace
ACCESSING THE WORKSPACE PAGE
The workspace can be accessed by clicking on this button on the left side of your SORBA Platform.

Workspaces Navbar Icon

ABOUT THE WORKSPACE PAGE

Your workspace is the main area in which you will configure and organize your data collection. The IOT
Unified Workspace is organized into a variety of nodes that you can use to organize your data. The simplest
of these is the generic node, which is used for basic organization.

Generic Node
Then we have the device node. The device node represents the actual edge device that is in place within
your plant. The edge device on an IOT Unified Edge, there will only be one device node. However, on the
IOT Unified Cloud platform you should see multiple device nodes to represent each of the different devices
that are part of that cloud.

Device Node

ASSETS
Within your device node you will have a variety of assets. Assets are the base level of organization within
your data. An asset could represent an individual machine, or could represent a production line, it could even
represent an entire plant. It comes down to what level of granularity you want to achieve with your asset
organization.

IoT Unified User Guide

 22

Asset Node
Within an asset, you have Alarms, Channels, Dashboard, Flows, Groups, IOT connectors, Model Instances,
and Scripts.

ALARMS
Alarms are used to tell you when certain data values go outside of set ranges. Alarms can also be used to
compare the value from one data tag to the value of another data tag.

Alarms Node

CHANNELS
Channels are where you organize your data pipelines. This is where you establish connections between
SORBA and the machine you are trying to connect to.

Channels Node

DASHBOARDS AND FLOWS

Dashboards are your main area for controlling data visualization tools. The flows tab is where you manage
your workflows.

Dashboards Node

GROUPS
Groups are one of the most important parts of an asset. Within an asset, you use groups to organize your
individual data tags. You can add any groups you feel will help with data organization, and you can layer
groups within one another. But you’ll eventually get down within a group to an individual data tag. An
individual data tag represents a single variable that you are capturing within SORBA.

Groups Node

IOT CONNECTORS
You also have IOT connectors. IOT connectors are used to establish a connection between SORBA and an
external database and can also be used to establish connections between one SORBA platform and another
SORBA platform.

IoT Unified User Guide

 23

IOT Connectors Node

MODEL INSTANCES
Model instances is where you will deploy and control your machine learning models after you create them
in the SORBA machine learning trainer.

Model Instances Node

SCRIPTS
Finally, scripts provide you with a pipeline engine in which you can create simple logic to control your data.

Scripts Node

INDIVIDUAL VS GLOBAL
All these nodes are represented within your individual assets but can also be represented on a global level.
If you make any of these on a global level, they will be accessible to every asset that is in that device, and
they will also be able to access information from any of your individual assets.

IoT Unified User Guide

 24

Device Node
ABOUT DEVICE NODES
Within your IOT Unified Workspace, you can either go to an existing device to edit it, or you can go to your
instances and click the drop-down menu to add a new device. From your device node you will be able to
control all of the basic settings for your SORBA Edge Device as well as controlling the different networking
connections set up for that device. You can also import license or device credential right from the device
overview.

Import License and Import Device Credentials Buttons

If you’re on a SORBA Edge instance you will be able to have one edge device within your SDC. If you’re in
a cloud instance, you will be able to see all the different devices you have within your organization.

EDITING A DEVICE NODE

Edit Device Button

In the Edit Device menu, you can set much of the info for your edge device. Most of these settings you will
want to leave on their default values. You probably need to change them if you have a specific configuration
that is non-standard. If you change any values make sure to save before leaving the edit device menu.

DEVICE INFO
The first section is device info, which includes the name of the device, an optional description for the device,
if you want the device to follow class changes, and whether the device is enabled.
Lower on the page you can set the device into debug mode, which will give you system events with additional
information for the device, which will help debug problems in the SDC.

IoT Unified User Guide

 25

Device Info

SYSTEM TIMEOUT SETTINGS

Below this you can configure the system timeout settings, which lets you set how long the device takes to time
out when you apply settings, and if it takes longer than the For Shutdown/Restart timer, then it will time out
that request.

System Timeout Configuration

ALARM TIMEOUT SETTINGS

Lower you will see options to control your alarm timeout, and to change the ping frequency for the alarms.

Alarm Timeout Settings

MODBUS TCP AND OPC UA

IoT Unified User Guide

 26

Below are settings to enable the Modbus TCP Server and the OPC UA Server, both of which will expand
with options to set them up if enabled.

Modbus TCP Server

Modbus requires an IP Address and Port, while OPC requires a URL.

OPC UA Server

DATA POLICY
Then we have the Data Policy, which changes how long data is retained on the device. Below we have the
location for the device.

Data Policy

IoT Unified User Guide

 27

HOT D ATA STORAGE AND IN-MEMORY D ATABASE

Below this is Hot Data Storage, where we can choose to either use the local server with the default localhost
prefilled settings, or you can uncheck the box and fill in another hot data storage other than the localhost.

Hot Data Storage

The In-Memory database has the same setup as the Hot Data Storage.

In-Memory Database

THE CORE
Below are settings for the Core. The core is the main heartbeat of SORBA that controls the data flow within
SORBA. You can set the database being used for Hot Data Storage, the in-memory database number, and
the connection number.

Core Settings
In Other Options, you can change the batch size of how much data is being sent at once, the maximum body
size for the data packages, and the sample collection rate. You can also change how often the system

IoT Unified User Guide

 28

parameter is being updated, and the interrupt frequency and event control frequency. You can change how
many decimals are stored within the data and change if the timestamp source is internal or external.
Changing the timestamp source determines whether timestamp info from outside or inside the database is
prioritized. You can change the maximum number of OPC UA nodes to read, which helps prevent overloading
the OPC server by controlling the max number of possible nodes that it can read from the OPC UA. You can
control the internal queue max size as well. Next, you can enable or disable the in-memory database
subscribe and publish features, as well as their update frequency and whether a delay is enabled. You may
need to include a delay in situations where you have a large amount of data, so that way all of it actually
gets through.

Core - Other Options

EVENTS MIDDLEWARE
Below you can control the Events Middleware, where you can change the database from its default for hot
data storage or database number from its defaults for the in-memory database.

Events Middleware

IoT Unified User Guide

 29

OS INFO
Below you can change the OS info as well which lets you change the database number from default if you
need to for any reason.

OS Info

TASK EXECUTION DATABASE

Below this you can change the Task Execution database, which lets you change the database number from
the default, and the timeout settings for all tasks within the SDC. You can change the local queue timeout,
the task running timeout, and a setting to increment the previous two values by whatever percent you enter,
giving them a buffer.

Task Execution Database

HOUSEKEEPER
Next is the Housekeeper. This section controls how often things are being removed from the SDC, typically
system events. You can change whether it removes measurements, switch the frequency mode from cyclic to
scheduled, and then set that schedule to daily, weekly, or monthly and then specific that schedule with more
granular info like setting specific days for housekeeping. You can also change the batch size for how much
info is removed at once.

IoT Unified User Guide

 30

Housekeeper

IOT CONNECTORS
Below we have the IOT Connectors, where you can control the maximum data queue size for the IOT
Connectors.

IOT Connector

MACHINE LEARNING RUNTIME

Below this we have Machine Learning Runtime. Here you can change the database number if needed and
change the event interrupt frequency, debounce time, and queue filling pause from their default values.

Machine Learning Runtime

MACHINE LEARNING API

IoT Unified User Guide

 31

Below this, we can enable or disable whether we are using the Local Machine Learning API. If you want to
use the machine learning trainer that is associated with this SDC you can keep it on the local default value.
or you can specify the URL to use another API. This is typically used if you want to use a stronger central
computer to run machine learning training for a weaker edge device.

Machine Learning API

DASHBOARD D ESIGNER
Below you can change settings for the Dashboard Designer. You can either use the default dashboard
designer or specify the URL for a different one, alongside controlling the API user and password for this
dashboard.

Dashboard Designer

SCRIPT ENGINE
Below is the Script Engine, where you can control the cycle time for the entire script engine, starting with
cycle time. If you have a script that has a cycle time shorter than this cycle time, the script will default to this
master setting. You can also change whether it retains values within the script engine and edit the cycle time
for data retention.

Script Engine

IoT Unified User Guide

 32

NETWORKING
Below this we can control the networking for the device, allowing you to modify, add, or delete interfaces
for both Ethernet and Wi-Fi interfaces.

Ethernet and WIFI Interfaces

In this section you can choose the default interfaces for primary internet and routing, as well as control
additional routing paths for the device.

Routing

CUSTOM FIELDS
Finally, you can add custom fields to your device node if you choose.

Custom Fields

IoT Unified User Guide

 33

Asset and Group Creation

CREATING AN ASSET
Firstly, navigate to your workspace. Then go into the device you want to create an asset on, then go into
your assets. From here you go to options, add node, and click on the Add Asset button.

Options menu, Add Node menu, and Add Asset button

Once in the add asset menu, you must add a name for the asset. You can enter an alias or description if
wanted, and toggle whether you want your asset to follow class changes.

New Asset Menu

Once your asset is ready, click save, and then apply the change. Once this is done, press on the refresh
button to refresh the page and you should be able to see the new asset that you created.

IoT Unified User Guide

 34

CREATING A GROUP
To create a group, go into an asset, go to your groups, and then click on the Add Group button.

Group Node and Add Group Button

Once in the New Group Menu, you must add a name for the group. You can enter an alias or description if
wanted, and toggle whether you want your asset to follow class changes.

New Group Menu

Once your group is ready, click save, and then apply the change. Once this is done, press on the refresh
button to refresh the page and you should be able to see the new group that you created.

GROUP GRANULARITY
With your group created, you can now go to the options menu, go to add node, and you can add a tag to
your group, add a new group to create a nested group, or add a sibling group to create a separate
group on the same level of the tree as the current group.

IoT Unified User Guide

 35

Group Granularity Options

WHY GROUPS ARE IMPORTANT

These options exist to allow you to increase the granularity of your data tree structure. The Asset-Group-
Tag data structure is the main way in which you will organize your information within SORBA. This structure
can take different forms depending on your application. An asset could represent an individual machine,
or even an entire production line. In this case, the asset would be a production line, the group would be an
individual machine, and nested groups would represent different groupings of tags within that machine.
Or, you could simply have an asset representing one machine and use groups to represent different tags.
You might have one representing real-time variables, one representing machine learning values that are
being calculated by models, and so on and so forth.

IoT Unified User Guide

 36

Channel Creation
CREATING A CHANNEL
Firstly, navigate to your workspace. Then go into the device and asset you want to create a channel in.
From here you go to the channel portion, go to options, add node, and add channel.

Options menu and Add Channel button

Once in the New Channel menu, you must add a name for the channel. You can enter an alias or
description if wanted, and toggle whether you want your channel to follow class changes.

New Channel Menu, including name, alias, and description fields

Below this you can enter how many seconds you want it to wait before timing out the channel, and then you
can select whether you want the channel enabled or not, which you can think of as turning the channel on or
off. Below, in Driver Config, we have over 30 different drivers that help you connect to whatever machine
you are trying to connect to with this channel. Simply select the appropriate driver from the drop-down
menu and enter the necessary information to connect to the machine.

IoT Unified User Guide

 37

Driver Config and other channel settings

Once your channel is ready, click save, and then apply the change. Once this is done, press on the refresh
button to refresh the page and you should be able to see the new channel that you created.

NEW CHANNEL WARNING

When you first create a channel, it may show as not loaded or as an error. This is not a problem. This
typically shows up until the point you create a data tag and connect the data tag to your channel. Once
you have done so the channel should switch to showing it is currently running.

New Channel Warning

IoT Unified User Guide

 38

Tag Creation
WHAT IS A TAG
A tag is the most basic unit within your data tree structure that you create in your IOT Unified Workspace.
Remember that the data tree structure works going from an asset down to group, and finally down to an
individual tag.

CREATING A TAG
To create a tag, first select the group that you want the tag to go into. Then go to options, select Add
Node, and select Add Tag.

Options menu, Add Node Drop-Down menu, Add Tag Button

In the New Tag menu, you must first add a name for the tag. You can enter an alias or description if you
want.

IoT Unified User Guide

 39

New Tag Menu

Then you can enter a default value for the tag, which is what the tag will resort to if it is not getting data.
Below this you can toggle whether the tag follows class changes, whether the class is enabled, and whether
you want the tag to log its data. From here, we begin our tag configuration.

TYPES OF TAGS
First you select your type of tag. Your tag can be a Boolean, a Byte, a Sint, a Word, an Integer, a Double
Word, a Double Integer, a Real Value, or a String. You can also include a unit for your tag, which is a
piece of metadata and will not impact anything about tag configuration. You may select any
preprocessing you want on the tag, including having the tag give you the minimum value, maximum value,
average value, or time interval. If you select a preprocessing type, you can then enter the total number of
samples you want the preprocessing value to act on. This means that if we want the maximum value over
10 samples, we select Max for preprocessing and then set the total samples to 10. You can also set the
low limit and high limit for a tag, which are also metadata and will not impact the tag itself.

Tag Configuration Menu

TRIGGERING TAGS
Once the tag is configured, you can set up how you want the tag to trigger. This is essentially how you
want the data to be pulled. The most common trigger type is Cyclic data, which simply has the data

IoT Unified User Guide

 40

logged on a cyclic basis that you set using the trigger time and time unit. You can also have tags trigger
based on raw time value, which is like Cyclic but does not keep the trigger time synchronized between all
devices. There is also raw time with differential trigger, which triggers every time value only if the data is
above a certain threshold. Next is reach value, which triggers if the data passes a certain threshold value.
The tag can log on change, which is only when the data changes and is past a certain threshold value. Then
there is rising edge or falling edge, which log when the data reaches a high or low value. Always is the
fastest mode of data collection, which logs all values the system picks up. The final method is Based on
Event Trigger, which allows you to select another tag within your device and trigger this tag when that
target tag itself is triggered.

Tag Trigger Menu

CONNECTING TAG TO D ATA PIPELINE

Once Tag Triggering is set up, you go down to Channel and connect you tag to a data pipeline that you
created when you made a channel. You can always use the memory channel, which is for any tags that
exist only within SORBA, like calculated values made from the script engine or values generated by
machine learning models. However, if you are trying to get information from your machine, go into the
channel drop down and select the channel you made earlier. Next you enter in your channel parameters,
which change depending on the type of channel you select.

Tag Channel Menu

FINISHING TAG
Once your tag is ready, click save, and then apply the change. Once this is done, press on the refresh
button to refresh the page and you should be able to see the new tag that you created.

IoT Unified User Guide

 41

Global vs Asset Level Nodes

In this section we are going to go over a relatively simple but important element of SORBA that has is
mentioned in many other sections of the guide, Global vs Asset Level. For channels, alarms, dashboards,
flows, IOT connectors, model instances, and scripts, there are both global versions of these nodes and local
versions that exist within each asset. It is important to know when you should use each of the different
types.

WHEN TO USE EACH VERSION

Global versions of these nodes should be reserved for when you are either utilizing a node that takes
information from multiple assets, or that will be used among multiple different assets. For instance, if you
have a single data channel that will feed information to multiple different assets, it makes sense to put it as
a global channel. If you are creating a script that is pulling from multiple different assets, then you should
make it as a global script. However, if one of these nodes can be contained fully to an asset, then you
should try and contain it to the asset level.

WHY IS THIS IMPORTANT

The reason for this is entirely about replicating a solution out across your plants. When we are creating
templates based off our assets, all the channels, alarms, dashboards, scripts, and models that are within
that asset can be templated out and then replicated when you replicate that asset. However, if you are
using a global channel, that cannot be replicated when you create a template for your asset. If possible,
you should try and keep things within the asset level if you are only using information that relates to a
single asset. Global versions of all of these exist for the sake of situations where you need to take
information from multiple different assets but should be reserved in their usage for only when you are
using information across multiple different assets.

IoT Unified User Guide

 42

Alarms
HOW TO CREATE A NEW ALARM
Firstly, navigate to your workspace. Then go into the device and asset you want to create an alarm for.
From here you go to the alarms portion and click on Add Alarm.

Alarms Node and Add Alarm Button

Once in the Add Alarm menu, you must add a name for the alarm. You can enter an alias or description if
wanted, and toggle whether you want your alarm to follow class changes and if it should be enabled or
disabled.

Add Alarm menu, with name, alias, description, and follow class changes fields
Next, enter in the alarm debounce time, which is how long the alarm should wait to trigger again once it is
triggered. Then set the alarm type to one of LowLow, Low, High, HighHigh, Warning, or Info. Then you can
set the alarm priority level and the message you want to appear when the alarm is triggered.

IoT Unified User Guide

 43

Add Alarm menu lower section

SETTING UP ALARM TRIGGER

Next you can set up the rules that will dictate when the alarm is triggered. First, click on Add Rule.

Add Rule Button

Then select the tag you are monitoring with this alarm. Then select a comparison operator and select what
value you are comparing the tag to, either a value you can set or another tag.

Add Rule Menu

When this is done, press Add. Once added, you should be able to see the complete expression on the main
add alarm menu. You can add multiple rules to further customize your alarm.

LINKING TO NOTIFICATION CHANNEL

If you click on the Add Notification Channel button shown below, the following popup will appear.

IoT Unified User Guide

 44

From here, you can choose a notification channel that you have configured to link this alarm to. You can
also select the Alarm states that will trigger a notification. This can be set to trigger when the alarm is
activated, deactivated, and/or acknowledged. If this is enabled, a notification will be sent through the
associated notification channel when that status is true.

SAVING ALARMS
Once your alarm is ready, click save, and then apply the change. Once this is done, press on the refresh
button to refresh the page and you should be able to see the new alarm that you created in the data tree.

HOW TO MONITOR ALL ALARMS

To monitor all the alarms on your device, you will go to the left menu and click on alarms.

The Alarms Button

This will give you a summary of every alarm on your device, whether the alarm is active or inactive.

IoT Unified User Guide

 45

Alarms Page
On the page you can filter by alarm status, data range, alarm type, whether the alarm was
acknowledged, and the priority.

IoT Unified User Guide

 46

Filtering Options and Columns drop-down.

You can use the columns menu to change which columns are visible on this page. Finally, you can
acknowledge alarms from this page.

IoT Unified User Guide

 47

Notification Channels
HOW TO CREATE A NOTIFICATION CHANNEL
First, navigate, to your Workspace and find the Notification node as shown below.

CONFIGURING A NOTIFICATION CHANNEL

Once you have created a new notification channel, enter a name for the channel. Then select what type of
notification channel you are creating.

SORBA supports Email, SMS, Slack, and Teams notification channels. Once you have finished configuring
your channel, you can use the Test Provider button next to the Save button to test your notification channel.

IoT Unified User Guide

 48

EMAIL
For an email channel, you can use Sendgrid, SES, G-Mail, or Office 365. Each of these options has
different information required for the configuration that can be obtained from the email provider.

SMS
For text message notification, Sorba supports Twilio. To set up this channel, you will need the Messaging
Service SID, the Account SID, the Auth Token, and the SMS receiver.

SLACK AND TEAMS

To set up a Slack or a Teams notification channel, you must provide a Webhook URL.

IoT Unified User Guide

 49

Script Engine
WHAT IS THE SCRIPT ENGINE?
The script engine is a powerful tool within SORBA that allows you to manipulate variables in order to
create new variables that can then be used for data visualization, or directly used in your machine-
learning models.

CREATING A NEW SCRIPT

To access the script engine, you’ll first want to go to the IOT Unified Workspace. From here, you can access
the script engine in one of two ways. You can either create a global script, which uses variables from
across multiple different assets, or you can go into an asset and create a script within that asset. Once you
select a scripts node, simply press Add a Script to enter the New Script menu.

Script Node and Add Script button

SCRIPT SETTINGS
Once in the New Script menu, you must add a name for the script. You can enter an alias or description if
wanted, and toggle whether you want your script to follow class changes and if it should be enabled or
disabled.

IoT Unified User Guide

 50

New Script Menu with name, alias, description, and follow class changes fields
Below, you will enter in the information required for script configuration. First, specify if you want the script
to be run cyclically, on start, or on stop. The most common usage is with cyclic scripts. For this, you will enter
in a cyclic time in milliseconds that will control how frequently the script is run. You will also set the timeout,
or how long the script will take before the script times out. In addition to running the script cyclically, you
can also run the script on start or on stop, which will only run the script once, when the device starts or
stops. These are usually used for initialization of values, or for logging values when the machine stops so
they can be used later.

Script Config Settings

Python Editor
Python Editor
Once you have entered in your script configuration you will go into the python editor to create your script.
The python editor is a basic python engine that uses the same rules and syntax as python.
However, there is one important addition that is special to the SORBA Script Engine. That is the ability to
pull in a tag from your asset. You do this by typing the function sde[“asset.group.tag”], replacing asset,
group, and tag with the respective names of the asset group and tag that you want to pull into your script.

IoT Unified User Guide

 51

By placing that function on the left side of an equal sign you can set the value of that tag, and by placing
it on the right side of an equal sign you can set a temporary variable within your script to the current value
of the tag. You can also replace the name of the asset you are calling with the keyword ASSET (without
quotes around it) to refer to whatever asset the script is being created in. This allows the script to function
even if you make copies of the asset through a template or other means. In addition, you can use the
debug feature by typing the function debug(x) to check the current value of “x” variable, whatever you
want to check.

FINISHING THE SCRIPT

Once your script is ready, click save, and then apply the change. Once this is done, press on the refresh
button to refresh the page and you should be able to see the new script that you created in the data tree.
You should also be able to see the compiling result, runtime result, and debug logs generated by your
script within the script node.

IoT Unified User Guide

 52

IOT Connectors
WHAT ARE IOT CONNECTORS USED FOR?
IOT Connectors are used to send and receive information from external databases. This can be used to
send information to an external database, receive information from an external database, send
information to another SORBA SDC, receive information from another SORBA SDC. IOT Connectors are
ways to send and receive information using common communication protocols.

CREATING A NEW IOT CONNECTOR

To add an IOT you can either go within an asset to the IOT Connectors, or you can go to the global IOT
Connector. As with the other nodes, use the asset specific IOT Connectors if you are only using information
within that asset, or the global IOT Connector if you are using information from multiple assets. From either
page, click on Add IOT Connector to pull up the Add New IOT Connector Menu.

IOT Connector Node and Add Iot Connector Button

Once in the Add New IOT Connector menu, you must add a name for the IOT Connector. You can enter an
alias or description if wanted, and toggle whether you want your IOT Connector to follow class changes
and if it should be enabled or disabled.

IoT Unified User Guide

 53

IOT Connector General Information

You will then select your source. For your source, you can choose from AMQP, AWS, COSMOS,
HTTP/HTTPS, IBA HD, INFLUX 1.x, INFLUX 2.x, MQTT, REDIS, SPARKPLUG, UDP, REDSHIFT, PI WEB, and
SQL. You will also have to select the destination from the same list of options. Next you need to select a
mode, usually cyclic, a frequency in seconds and a batch size. The batch size is important because the next
setting, Start Time, allows you to have the IOT Connector backdate information and send information from
the past, which it will continue to do at the set frequency until it catches up with the present, at which point
it will just send real-time data. You can also set a trigger enable to only send data when certain conditions
are triggered, and a data processing batch size to determine the amount of data that will be processed at
a time.

Source Menu
The next options on this menu have you input the information for the source and destination, and each
source and destination will have different parameters that you will have to enter on this section of the

IoT Unified User Guide

 54

menu. Any source that is within the SORBA SDC will allow you to select which tags you want to include in
the data sent for this IOT Connector, and any destination that is within the SORBA SDC will require you to
select the destination tags that you want data sent to.

SORBA SDC Tag Selector

Adding Data Processors

The next section allows you to select any data processing pipelines that we want to add into this IOT
Connector. In order to do data processing, you need to click on the Add Data Processor button, and then
add Digital Signal Processing or Math Functions.

Add Data Processor Button

Once you select your category of data processing, you can then select your specific data processor. Each
data processor has its own parameters you will need to enter.

IoT Unified User Guide

 55

Adding a Data Processor

Once you add your data processors, you can enable or disable them from the main menu, as well as edit
or delete each of them. It is important to note that the output of each data processor serves as the input to
the next, and you can control the order of data processors by using the up and down arrows on the main
Add New IOT Connector menu.

Data Processors in the pipeline

SERVERS AND C LUSTERS

The next section has your Servers and Clusters.

IoT Unified User Guide

 56

Add Server Button

You can set multiple different servers using the Add Server button, and adding the server name, port, and
other required information in the Add Server pop-up window.

Add Server Menu

Once you are done adding your servers, you can use the clusters menu to create a cluster with the Create
Cluster button.

IoT Unified User Guide

 57

Create Cluster Button

The default cluster that is created with your first server in it. Your cluster needs a name and a mode,
broadcast sends the data to all servers included in the clusters, while redundancy tries to send the data to
the highest priority server and only resorts to the next server if it cannot send data to the higher priority
option. Select which servers to include in the cluster and then press the Add Cluster button to finalize it.

Add mqtt cluster menu

From the main menu you can edit or delete cluster configurations. The last parameters below this section
will be based on the destination that you selected.

FINISHING THE IOT CONNECTOR

Once you are finished with your IOT Connector, click save, and then apply the change. Once this is done,
press on the refresh button to refresh the page and you should be able to see the new IOT Connector that
you created in the data tree.

IoT Unified User Guide

 58

IoT Unified User Guide

 59

Dashboard and Flow Nodes

WHAT ARE DASHBOARD AND FLOW NODES USED FOR?
Dashboard Nodes and Flow Nodes relate to the Dashboard Designer and Workflow, respectively, that
can be found within other parts of the SORBA SDC. These nodes enable you to control and have a spot to
backup those different dashboards and workflows within your IOT Unified workspace.

IMPORTING DASHBOARDS INTO ASSETS

You can import any Dashboards from your Dashboard Designer to link them to a specific asset. To do so,
click on the Dashboards node with your desired asset and then click on the Import from Dashboard Designer
button to open the Import from Dashboard Designer Menu.

Import from Dashboard Designer button in a Dashboard Node

Simply select the dashboard you want to link to the asset and then hit the Done button to create the link.
This allows you to control that dashboard from within this asset.

IoT Unified User Guide

 60

Import from Dashboard Designer menu

DASHBOARD REPORTS
From a Dashboard node, you can click on the Add Dashboard Report button to set up automatic dashboard
reports.

IoT Unified User Guide

 61

You can set the frequency at which reports are generated from the Schedule dropdown. You can set the
data range displayed by the report from the Report Time dropdown. Finally, link the dashboard to a
notification channel and save.

CUSTOM VARIABLES FOR DASHBOARD REPORTS

When generating Dashboard Reports, you can use custom variables in order to streamline templating of a
solution with SORBA. To do this you must first access the Dashboard settings within the Dashboard Designer.

Here we can see the variable table_name with the default value of DEV183.MOTOR.

IoT Unified User Guide

 62

Within our panel for this dashboard, we can see the variable being used to define where the data is
being pulled from.

When making a dashboard report, you can input a value for the variable as shown below.

This allows you to change what this variable is set equal to when the dashboard report is sent. This alows
users to send different reports for different assets all while using a single dashboard. When templating out
a solution this can save time as it removes the need to create multiple similar dashboards for each of your
assets, using instead only a single one for all of your reporting.

IoT Unified User Guide

 63

Custom Fields
WHAT ARE CUSTOM FIELDS
Custom Fields are additional metadata that can be added on to any node within SORBA to give the user
additional information about that node. Custom Fields do not have a functional use within SORBA, they
exist so you can add in additional information so that other users of the software can better understand
what you were trying to accomplish. This extra information can help with organization, data management,
and with recording the intention behind different nodes.

HOW TO MAKE CUSTOM FIELDS

To add a Custom Node, go to the bottom of the menu when you are creating a new node, or go into the
edit feature of an already existing node. Press on the Add Custom Field button to open the New Custom
Field menu.

Add Custom Field Button

In this menu, add the name of the field you want to add and select a data type for the field.

New Custom Field menu

When you have finished your custom field press the Add button to return to your main menu, where a new
input has been generated so you can add a value to your custom field. Once you have added in the
values for your custom node, you can either create more custom nodes or save your asset and apply the
changes.

TYPES OF CUSTOM FIELDS

The types of custom fields are Text, Long Text, Number, Select, Checkbox, and Radio.

TEXT
The text custom field will give you a textbox that you can type into.

IoT Unified User Guide

 64

Text Custom Field

LONG TEXT
The long text custom field will give you a large textbox that can hold more words than the regular text
custom field.

Long Text Custom Field

NUMBER
The number custom field gives you a textbox that you can enter a number into.

Number Custom Field

SELECT
The select custom field will allow you to enter comma separated values for the different options. Once you
add this field, it will generate a drop-down menu with those options.

Select Custom Field

CHECKBOX
The checkbox custom field will allow you to enter comma separated values for the different options. Once
you add this field, it will generate checkboxes for each of those options.

Custom Field

RADIO
The radio custom field will allow you to enter comma separated values for the different options. Once you
add this field, it will generate a toggle field that lets you select only one of those options.

IoT Unified User Guide

 65

Radio Custom Field

IoT Unified User Guide

 66

Apply Changes
WHAT DOES APPLYING CHANGES DO?
The Apply button is used whenever you want to take the changes that you made in your SORBA SDC and
apply them to your actual runtime. For example, if you create a script and save it, it will not begin running
until you apply the changes to your runtime. You can make many changes on your SDC before you apply
changes, which could speed up the process if you are making many changes all at once to your SORBA
SDC.

Apply changes button

IoT Unified User Guide

 67

Cloud Synchronization
DIFFERENCE BETWEEN SORBA CLOUD AND EDGE
Within SORBA you can have both an IOT Unified Cloud as well as an Edge instance. From the IOT Unified
Cloud you can monitor all your different devices across all of your different facilities. Any nodes that are
not synchronized to the cloud will appear with a small red marker on them in the data tree of an edge
device to signify that they need to be synchronized.

Red Marker for showing which nodes are not yet synchronized to the cloud
In this section we will discuss how to synchronize a cloud device to an edge device.

HOW TO SYNCHRONIZE
You can synchronize from both cloud devices and edge devices.

FROM THE EDGE

In the edge, you simply select the device you want to synchronize, go to the options menu, open the
synchronization menu, and press Get config from IoT Cloud, or Send config to IoT Cloud.

The Options menu, Synchronization menu, and Get config from IoT Cloud and Send config to IoT Cloud buttons
Get config from IoT Cloud will download the most recent version of the device config from the cloud to the
edge, while Send config to IOT Cloud will upload the most recent version of the device config on the edge
to the cloud.

FROM THE CLOUD

In the cloud, you simply select the device you want to synchronize, go to the options menu, open the
synchronization menu, and then either press Get config from Device, or Send config to Device. Get config
from Device will download the most recent version of the device config from the edge to the cloud, while
Send config to Device will upload the most recent version of the device config on the cloud to the edge.

IoT Unified User Guide

 68

SYNC MENU
Whether you’re getting or sending the config from the device or the cloud, the menu operates the same
way. You select which steps you want to sync, set the local queue timeout in seconds and the task remaining
timeout in seconds and then press the Sync button.

Sync Menu (Send configuration to IoT Cloud menu pictured for example)

IoT Unified User Guide

 69

Classes and Instances

WHAT ARE CLASSES AND INSTANCES?
Classes and Instances are essentially the two different versions of nodes. Instances are active run-time
instances of nodes, while Classes are templates of nodes.

CREATING CLASSES AND INSTANCES

You can create a class of any instance and can create an instance from any of your classes. It is important
to note that you can turn an asset or device into a class, but not groups or tags.

TURNING AN ASSET INTO A CLASS

To turn an asset into a class, go to the asset you want to use, open the options menu, then press Create
Classes from this instance.

Options menu and Create Classes from this Instance button

This opens the Create Classes from this instances menu, where can decide whether to apply an automated
suffix to this class and if you want to include the parents of the asset in your class. If you do not apply an
automatic suffix, you can specify your own.

IoT Unified User Guide

 70

Create classes from this instances menu

When you are ready, press the Create button.

TURNING A CLASS INTO AN ASSET

To create an instance from a class, go to the class you want to use and open the options menu. From there
click on the Create instances from this class button to open the Create instances from this class menu.

Options menu and Create Instances from this Class button

On the menu, select how many copies to make, decide whether to apply an automated suffix to this
instance and if you want to include the parents of the class in your instance. If you do not apply an
automatic suffix, you can specify your own.

IoT Unified User Guide

 71

Create instances from this class menu

When you are ready, press the Create button.

FOLLOW CLASS CHANGES

In any instance, including both nodes made from scratch or those made from a class, you can select
whether that instance should follow class changes by checking or unchecking the Follow Class Changes
checkbox. If enabled, this makes it so that the instance node reflects any changes made to the template
class that it is linked to. This allows solutions that are made on one machine to be replicated out to all
similar machines across a plant, allowing SORBA solutions to be scaled up and replicated across a number
of devices off of the data collected and generated on one single device.

IoT Unified User Guide

 72

Snapshots
WHAT ARE SNAPSHOTS?
From your IOT Unified Workspace, you can generate a snapshot of your data structure that you can then
restore in case anything happens to your SDC.

HOW TO CREATE A SNAPSHOT

To create a snapshot, go to the node furthest out node on your data tree, open the options menu, and
press Take Snapshot to open the Take snapshot menu.

Options menu and Take Snapshot button

In this menu you can name the snapshot and optionally add a description to the snapshot, and then click on
the Take button.

IoT Unified User Guide

 73

Take Snapshot Menu

HOW TO RESTORE A SNAPSHOT

To restore a snapshot, go to the same node you created it for, which should be the further out node on
your data tree. In that node open the options menu and press the Restore Snapshot button to open the
Restore Snapshot menu.

Options menu and Restore Snapshot button

In the menu, select the snapshot you want to restore and press the Restore button to restore your data
structure to the state it was in when that snapshot was created.

IoT Unified User Guide

 74

Restore Snapshot Menu

HOW TO DELETE A SNAPSHOT

You can also delete snapshots from the restore snapshot menu. Access the menu the same as if you were
going to restore a snapshot, but then select the snapshot you want to delete and press the Remove
Snapshot button.

Remove Snapshot button in the Restore Snapshot menu

IoT Unified User Guide

 75

Workspace Tools
TOOLS WITHIN THE OPTIONS MENU
In the options menu on a node, there are a few things we can do. We can Move the node, Clone the node,
and Delete the node.

MOVE
Move Node allows you to move your selected node from one section of your data tree to another one. To
access move node, open the options menu on the node you want to move, then press the Move button.

The Options menu and Move button

This will open the Move Node menu, where you can select the destination in your data tree.

Move Node Menu

When you are ready, press the Move button to move your node.

CLONE
Clone Node allows you to create a copy of your selected node. To access clone node, open the options
menu on the node you want to clone, then press the Clone button.

IoT Unified User Guide

 76

The Options menu and Clone button

This will open the Clone Node menu, where you can specify how many clones you want to create.

Clone Node Menu

When you are ready, press the Clone button and copies of your node will appear in the same location on
the data tree as the original node, but with a suffix added to denote their status as a clone. You will have
to refresh to see the new nodes.

DELETE
You can also delete a node with a tool near the options menu. To delete a node, open the node you want
to delete and press on the red trash can icon next to the options menu button.

IoT Unified User Guide

 77

Delete Node Button

This will prompt you to confirm that you want to delete this node. Press Delete if you are sure and the node
will be deleted.

Node Deletion Prompt

TOOLS IN THE DATA TREE SEARCH

You can use the search bar within the data tree to search your nodes by their names.

IoT Unified User Guide

 78

Search tool example

You can also search for your nodes by their unique node ID. This node ID can be found by opening a node
and pressing on the Show Code button.

Location of the Show Code Button

The node ID will be the first line of the code.

Node ID Location

MULTISELECT

IoT Unified User Guide

 79

Open the options menu at the top of the data tree and click on the Enable multiselect button to enable
multiselect mode.

The options menu and Enable multiselect button

In this mode you can select multiple nodes in your data tree by clicking on them to select them, or clicking
on them again to deselect them.

Multiselect Example
Multiselect lets you take actions within the node options menu like Move, Clone, and Delete on multiple
nodes at the same time so you do not need to do things one by one.

TOOLS IN THE WRENCH MENU

In the wrench menu near your user profile, you can access the Ping, Port Check, and Terminal tools.

IoT Unified User Guide

 80

Locations of Ping, Port Check, and Terminal Tools

PING
Pressing the Ping button in the wrench menu will open the Ping menu, where you can enter the IP address
that you want to ping and select how many times you want to retry the ping.

Ping Menu
When you are ready, press the Ping button to attempt to ping that IP address. The results of this operation
will be displayed in this menu.

PORT CHECK
The Port Check tool allows you to check the status of a specific port and see if it is open or closed. Pressing
the Port Check button in the wrench menu will open the Port Check menu, where you can enter the IP
address of the host and then enter the port you want to check.

IoT Unified User Guide

 81

Port Check Menu

When you are ready, press the Check Port button. The results of this operation will be displayed in this
menu.

TERMINAL
Pressing the Terminal button in the wrench menu will open an SSH terminal that you can use to do back-end
changes to the SORBA platform. Typically, the terminal is only used to perform maintenance on the system,
and not day-to-day usage.

BACKUP AND RESTORE

You can access Backup and Restore by clicking on your user profile, which will open a drop-down menu.
Click on the Backup and Restore button to go to the Backup and Restore page.

User Profile Drop-Down and Backup & Restore Button

CREATING A BACKUP
On the Backup and Restore page, you can either create a backup immediately or schedule automatic
backups.

To create a backup, go to the Backups tab on the page and press the Create Backups button.

Backups Tab and Create Backups Button

This will open the Create Backup menu, where you can give your backup an optional description and then
select all the components within SORBA that you want to backup.

IoT Unified User Guide

 82

Create Backup Menu

When you are ready to create your backup, hit the Create button.

To schedule automatic backups, go to the Autobackup Settings tab on the page, click the checkbox to
enable automatic backups, and then enter the repeat frequency you want SORBA to create these
automatic backups.

IoT Unified User Guide

 83

Autobackup Settings Page

Lastly, input the path where you want these backups stored, how many copies of the backups to keep at a
time, and which components you want to be automatically backed up.

RESTORING A BACKUP
To restore a backup, you can go to the Backups tab on the Backup and Restore page and click on the
Upload from Disk button.

Backups Tab and Upload from Disk Button

This will allow you to select which backup you want to restore and then restore your SORBA SDC to the
state it was in when that backup was created.

IoT Unified User Guide

 84

Data View
WHAT IS DATA VIEW?
Data View is used after you have already completed your data configuration, or while you are doing
your data configuration, to give you a quick look at the current values for each of your data tags.

HOW TO GET TO DATA VIEW

In order to get to the Data View, go to the icons on the left side of the screen and press on the data view
button.

The Data View Button

The Data View will show you your current tree structure for your assets, groups, and tags.

Empty Data View

To monitor these values, go to the node that you want to select and click on the checkbox for an individual
tag, a group of tags, or an entire asset. Once you have selected all the tags that you want to show, click
on the run button.

IoT Unified User Guide

 85

Data View with running tags

From here, you will be able to see the tag values updating in real time. Additionally, if your tag is a
writeable value (established during tag creation when selecting if the tag is read, write, or read/write),
you can go to Write Values and click on the pencil icon for the value you want to write to, enter the new
value you want to change it to, and press the checkmark button.
If you have a lot of tags that you are trying to monitor, you can also use the Items per page drop-down
menu to see more tags at once.

POLLING MODE VS SUBSCRIPTION MODE

When using the data view, you can switch between polling mode and subscription mode. To change the
mode, click on the gear icon to open the Settings menu.

Gear Icon
In the settings menu you can change between polling mode and subscription mode, changing the update
frequency for polling mode if you have it selected. Polling mode shows you a new value after every
amount of time that you specify in the menu. In subscription mode, the value of each tag will change every
time the tag changes to a new value.

IoT Unified User Guide

 86

Settings Menu
When you are happy with which mode you have selected, press the Apply button to confirm the change.

IoT Unified User Guide

 87

Workflows
WHAT ARE WORKFLOWS?
The Workflows provides you with a drag-and-drop program that can do essentially anything that the
script engine can do. You can use this to manipulate and control your data.

HOW TO ACCESS WORKFLOWS

To access the Workflows, go to the icons on the left side of the screen and press on the Workflow button.

The Workflows Button

HOW TO CREATE A WORKFLOW

In order to create a workflow, you are going to press the plus icon to create a new workflow.

Creating a new workflow

From this blank workflow, you can use the drag-and-drop program to drag on different nodes from the
panel on the left and then connect them to each other to control the flow of the logic.

IoT Unified User Guide

 88

Logic Flow

For full documentation about how these nodes and logic work, you can access the node red website at
https://nodered.org/docs/ for more resources.

SORBA IN AND SORBA OUT

SORBA comes with two different nodes that help it interface with the SORBA SDC. These nodes are sorba
in and sorba out. To use each node, first drag the node into your workflow. Then you want to double click
on the node to open the Edit Node menu, where you can select which asset to connect the node to.

IoT Unified User Guide

 89

Editing a sorba in node

Once an asset is selected you then choose which group you want to look in and then can select which tags
from within that group you want to bring into your workflow through this node. Once you have the tags
that you want selected, press on the Select button to bring them down into the node. If you need to, you
can also select tags already in the node and press the Unselect button to remove them from the node.
When you are done editing the node, you can press the Done button to go back to the workflow editor.

Adding tags to sorba in node

You can use the various nodes to manipulate the data in any way, or to create new values for your tags.
Then you can use the sorba out node to write these values to any writeable tags (established during tag

IoT Unified User Guide

 90

creation when selecting if the tag is read, write, or read/write) in your SORBA SDC. Note that you can
have multiple outputs go into one single sorba out node, but to do so they must be organized as an array
of values and must match up to a tag within SORBA to ensure that the data writes to the tag correctly.

DEPLOYING YOUR WORKFLOW

Once your entire workflow is created, press the Deploy button to deploy your workflow.

Deploy Button

IoT Unified User Guide

 91

Dashboards
WHAT ARE DASHBOARDS?
Dashboards are your main tool within SORBA for visualizing and analyzing your Data.

HOW TO ACCESS DASHBOARDS

To access the Dashboards, go to the icons on the left side of the screen and press on the Dashboards
button. This brings you to the SORBA Dashboard Designer.

The Dashboards Button

Once in your Dashboard Designer, you can browse through all the dashboards that you have within your
device by going to the side panel on the left, clicking on the Dashboards button, and then pressing on the
Browse button.

IoT Unified User Guide

 92

Dashboards and Browse Buttons

HOW TO CREATE A NEW DASHBOARD

To create a new Dashboard, go to the Browse Dashboards page and click on the New Dashboard button.

New Dashboard Button

Once you have a blank dashboard, you can add in a new panel by pressing the Add a new panel button.

IoT Unified User Guide

 93

Add a new panel button

There are many different options that you can choose from for how you want to represent your data.
Some common ones include time series data, stats, and gauges. To change the panel visualization type,
navigate to the top right of your screen and click on the name of your current panel visualization type.

Change Visualization Type

You can then scroll through the other options for visualizations and click on one to select it.

IoT Unified User Guide

 94

Selecting a new visualization

Which panel visualization you choose will determine the fields that you can edit in your panel menu, but
you will always need to give your panel a Title and determine which assets you want to pull assets from.
Once you are done with your panel, press the Apply button to create the panel.

CHANGING DASHBOARD V IEW

You can add multiple panels to visualize your data in different ways. For more information regarding how
to fully utilize the dashboard designer, you can access documentation on the website for how to use each
of the different panels.
You can also change the time range you want to visualize data from by clicking on the time range button
on the top right of the page. You can either select a pre-set time range or create a custom time range in
this drop-down menu.

Changing Time Range

Finally, you can set your dashboard to automatically update with new information by clicking on the
refresh drop-down menu in the top right of the page and selecting an interval to refresh after. You can
also press the refresh button to immediately refresh the page with new data.

IoT Unified User Guide

 95

Auto Refresh and Manual Refresh Buttons

SAVING YOUR DASHBOARD

Once you are done making edits to your dashboard, you can press on the Save Dashboard button in the
top toolbar to save the dashboard.

Save Dashboard
The first time you save your dashboard it will open the Save Dashboard as menu, where you can name
your dashboard and select which folder to save it into.

IoT Unified User Guide

 96

Save Dashboard As menu

Press the Save button when you are ready to save the dashboard.

IoT Unified User Guide

 97

Identity Server
HOW TO ACCESS THE IDENTITY SERVER
To access the identity server, click on this icon shown below.

USERS
From the Users section, you can view all current users, assign their roles, edit existing users, reset user
passwords, delete users, and create new users.

When you add a new user, you will input their name, email, roles, username, and password.

IoT Unified User Guide

 98

ROLES
Roles allow you to set permission levels within Sorba. At a default level, Sorba has three roles: Admin,
Viewer, and Editor. However, the permissions granted to these levels can be customized and entirely new
roles with their own custom permissions can be added as well from this section.
Once you assign a user to a role with these assigned permissions, they will then only be able to access and
make changes to the portions of the platform that their role allows them to access and edit.

TENANTS
From the Tenants section of the Identity Server, you can add additional tenants. The default tenant is
sorba_sde. However, you can use this portion of the Identity Server to add new tenants and multi-tenancy is
supported.

APIS

IoT Unified User Guide

 99

This section allows you to view and edit the APIs that make up the SORBA platform. From here you can
also import and add new APIs as well.

Task Flow
WHAT IS THE TASK FLOW?
The Sorba Task Flow has two primary uses. From this area, you can add and deploy custom code within
SORBA. Additionally, this is where users can find over-the-air updates for SORBA and can deploy new
releases of the platform

HOW TO ACCESS THE TASK FLOW

To access the Task Flow, go to the Task Flow icon as shown below.

IoT Unified User Guide

 100

RELEASES AND DEPLOYMENTS

From your releases section, you can see any new releases of Sorba, and you can also add in your own
releases in order to deploy custom code.

To add a new release, click the New Release button shown above. From here you will enter a name for the
release, and you will then select your files and entry point for the release. You can then go to the

IoT Unified User Guide

 101

Workspace portion of the task flow and click on “Create Deployment” as shown below.

From here you can then select a release to create a deployment for, define a category for later sorting,
set a rollout schedule, and add pauses between the different deployment stages.

It is often helpful to schedule releases to occur outside of normal operation time and to instead happen
overnight or during a less busy time.

Once you have scheduled your release, its progress and status can be viewed from the Deployment section
of the Task Flow. The Active section shows deployments that are currently being processed. The Scheduled

IoT Unified User Guide

 102

tab shows all upcoming deployments that have been scheduled. Finally, the Finished tab shows all finished
releases as well as their statuses, as shown below.

IoT Unified User Guide

 103

System Events
HOW TO ACCESS SYSTEM EVENTS
To access the System Events, go to the icons on the left side of the screen and press on the System Events
button.

The System Events Button

This brings you to the System Events page, which gives you a constant update of your system events.

System Events Page

FILTERING SYSTEM EVENTS

IoT Unified User Guide

 104

To use the System Events page, you want to filter down the list of events to see only more specific events.
The first filtering option is to filter by Date, which allows you to select a time range to see events from
within. The next option is Severity, which allows you to select which levels of event severity you want to see.
The next option is Source, which is a drop-down menu that lets you select which source of events you want
to see events from. The next option is User, a drop-down menu that lets you select which user you want to
see events that triggered. The next option is Device, which is a drop-down menu that lets you select which
device you want to see events that trigger from. The final option is Deployment, which is a drop-down
menu that lets you select the deployment you want to see events from within.

Filtering Options and Column Display Settings

CHANGING DISPLAYED EVENT INFORMATION

IoT Unified User Guide

 105

You can control the view of what information is displayed within the System Events manager by opening
the columns drop-down menu and selecting which columns you want visible by checking or unchecking their
checkboxes.

IoT Unified User Guide

 106

Advanced Cloud Settings

HOW TO ACCESS ADVANCED CLOUD SETTINGS
You can access Advanced Cloud Settings by opening your user profile drop-down menu and pressing the
Manage Account button.

User Profile Drop-Down and Manage Account Button

On the Manage Account page, press on the Advanced Cloud tab to switch to that part of the page.

Advanced Cloud tab

Please note, in some versions of SORBA a few of these settings may not appear here in Advanced Cloud
Settings and can be found under your Device Node.

WHAT ARE THE ADVANCED CLOUD SETTINGS? CACHE TIME LIVE

Cache Time Live lets you determine how long it will be before the cache clears in seconds.

IoT Unified User Guide

 107

Cache Time Live

TASKS EXECUTION
Tasks Execution lets you set the Local Queue Timeout and Task Running Timeout in seconds, as well as
modify them both at once with a buffer using the Increment Percent in Timeout field, entering a percentage
to apply to the two other fields.

Tasks Execution

PLATFORM API
Platform API lets you determine if you are using the local default SORBA Platform API, you can uncheck the
box and enter a different platform API.

Figure 0.1: Platform API

ML TRAINER API
ML Trainer API lets you determine if you are using the local default SORBA Machine Learning API, you can
uncheck the box and enter a different ML API.

ML Trainer API

MQTT BROKER
MQTT Broker lets you choose whether to use the SORBA MQTT Broker, and if you do you can set the host
and the port here.

IoT Unified User Guide

 108

MQTT Broker

DASHBOARD D ESIGNER
Dashboard Designer lets you either use the default SORBA Dashboard Designer or uncheck the box and
specify a different dashboard designer URL and API.

Dashboard Designer

COLD D ATA API

Cold Data API lets you either use the default SORBA Web Cold Data API or uncheck the box and specify
a different web API if you choose to.

Cold Data API

IoT Unified User Guide

 109

APPLYING ADVANCED CLOUD SETTINGS

When you are done changing the Advanced Cloud Settings, press the Save Settings button to finalize your
changes.

IoT Unified User Guide

 110

Deploying Models
HOW TO DEPLOY A MACHINE LEARNING MODEL
Once you are done with the process of creating a machine learning model (we go over this in another one
of our guides), it is time to deploy it into a real-time environment. To do so, you are going to want to return
to your IOT Unified Workspace and open the relevant asset for the machine learning model. From the
asset, you should open the model instances node, open the options drop-down menu, open the side menu
for Add Node, and click on the Add Model Instance button.

Model Instances Node, Options Menu, Add Node Menu, and Add Model Instance Button
This will open the New Model menu, which is where you can begin creating your new model. First you want
to name your model, and optionally add a description.

New Model Info

IoT Unified User Guide

 111

Below this you can check whether you want the model to be enabled and whether you want it to follow
class changes. The next section is Model Details, where you specify the Project, Analysis, and Model that
you want to use. The menu will then pull details from you model, and new fields will be added based on
the type of model you select.

Model Details
In addition, when you are deploying a model, you can choose whether to automatically create a
dashboard that will show you the outputs from your model. You can select a dashboard template for the
automatically created dashboard, and there are templates for each algorithm type already within
SORBA.

Automatically Create Dashboards

MAPPING
Your model uses inputs that need data from the tags in the asset it is attached to. You must make sure the
inputs are lined up to the correct tags from the asset. When entering a tag into the model menu, you can
either type in the data path of the tag or begin typing its name and select the correct tag from the options
that are listed above the field.

IoT Unified User Guide

 112

Input and Output Maps

OUTPUT MAPPING
The output tags in the model try and match themselves to tags within your asset automatically. If the correct
tags do not exist, you can open the Mapping menu by clicking the Suggest New Mapping button.

Suggest new mapping

From here SORBA will suggest new tags for your asset, which you can either manually create or create
automatically by pressing the click here button. Once you are happy with your mapping, press the Apply
button to create the necessary tags and map them to the model.

WHAT IS AUTO LEARNING?

Auto Learning allows a model to develop over time, retraining the model with new data to develop to
changing conditions, or if you have new information that you want to include within that model.

HOW TO A DJUST A UTO LEARNING IN A MODEL

You can adjust auto learning features in SORBA either when you are creating a new machine learning
model within your workspace, or by editing a pre-existing model. Auto Learning is off by default for new
machine learning models.

IoT Unified User Guide

 113

To enable auto learning in a machine learning model you must first select a trigger tag, which is the tag
that will determine when you are going to conduct auto learning. The trigger tag must be a Boolean tag,
and when it becomes true the system will enter auto learning mode, and then set the tag back to false
when it is done retraining the model.

Auto Learning Menu

The next step is to tell the model what data you want it to retrain with. You do this first by telling it the
time range of data to look at, using the drop-down menu to either select Last, Range, or From Last Time
Trained. Last lets you determine an interval and looks at the data from within that last interval. Range lets
you look at data from between two pre-set times. From Last Time Trained looks at all data since the last
time the model was retrained.

Time Range
The next step is to determine if you want the model to keep auto learning parameters. If checked, the
model will keep all its parameters between times it retrains. If unchecked, the parameters will reset after
each time it automatically relearns, which will disable autolearning since it is not on by default.

Keep Auto-Learning Parameters

Next you determine if you want to keep or update Model Instance Settings. These are the settings for the
model instance, basically if you want them to stay constant or include the new ones after retraining.

Model Instance Settings

Then you determine if you want to disable or delete this version of the model instance after auto-learning.
Typically, we recommend disabling the model instance instead of deleting it, that way if for any reason
you want to go back to an older version of the model, it is not deleted, just disabled.

IoT Unified User Guide

 114

Model Instance Options

Next, you determine the roll back options for the machine learning model. This can either be worst score,
or never. Worst score means that after the model is retrained, if the score for that model is worse than the
score on the old model, it will switch back to the original model. Never means that the machine learning
model will always use the newer version, even if it has a lower score than the last version.

Roll Back Options

Finally, you can determine which dataset versions you want to include in the model. In this dropdown menu
you can choose between keeping the versions that were included on the model, all versions, just the last
version, the last two versions, the last five versions, and the last ten versions.

Include Dataset Versions

FINALIZING YOUR MODEL

Once you are done with all the settings for your model, click on the Save button and then press Apply to
put your model into effect.

IoT Unified User Guide

 115

Appendix A: Installation
This section goes over how to install Sorba. First, we will install the operating system (Ubuntu 18.04). Then
we will install Sorba through an installation script.

MINIMUM REQUIREMENTS
-RAM: 16 GB
-HDD: 80 GB
-Cores: 8
-OS: Ubuntu 18.04 live server

INSTALLING OPERATING SYSTEM

If installing as a virtual machine, you must first define the bootable pointing to the ISO of the operating
system. If installed on a physical machine, the ISO of the operating system would be on a flash drive that
we would load onto the device. From here the installation steps are the same.

1. Select Language.

2. Select keyboard. Use [DONE] to continue.

3. Configure Network: You can use the DHCP or MANUAL option, then press [DONE] to continue.
(Example Configuring DHCP)

IoT Unified User Guide

 116

(Example Configuring Manual)

IoT Unified User Guide

 117

4. Select Proxy. If you do not have a proxy, then press [DONE] to continue.

IoT Unified User Guide

 118

5. Select sources. Do not change. Press [DONE] to continue.

6. Install updates. Select Continue without updating and press [ENTER] to continue.

IoT Unified User Guide

 119

7. Storage configuration. Do not make edits, this part is 3 separate screens, click [DONE] on each of
the three.
8. Set Username and Password.

9. SSH Setup. Make sure to check the box to install OpenSSH server.

IoT Unified User Guide

 120

10. Features. Do not select any. Press [DONE] to continue.

11. Click on Cancel update and reboot.

INSTALLING SORBA

IoT Unified User Guide

 121

1. Connect and copy the installation script. You must know the IP address that you defined in step 3
of the OS installation above. If you are using Windows, you can use Putty to connect and WinSCP
to copy the installation file.
2. Copy files to /home/sdc
3. Login as root.

4. List files.

5. Set execution permissions to install the file.

6. Initialize the installation.

IoT Unified User Guide

 122

7. Let the script run until you see the message SUCCESS INSTALLATION

IoT Unified User Guide

 123

Appendix B: Script Engine Examples

This section goes over various examples of ways in which the script engine can be used. The scripts as well
as explanations of their functions are shown.

BASIC SCRIPT
global perc, count

sde["CAR.ENGINE.ENGINE_SPEED_PERC"]=perc(sde["CAR.ENGINE.ENGINE_SPEED"],60000)

if sde["CAR.ENGINE.CAR_SPEED"]>30:
count += 1

debug("COUNT: ", count)

This script shows several concepts. First, it shows the use of a global function as well as a global variable.
These will be initialized in a following script. This script also shows the use of the sde function which is used to
read and write tags to the IOT Unified Workspace. If the sde function is placed to the left of the equals sign,
it will set the value of that tag equal to whatever is on the right side. If the function is on the right side, the
function will return the current value of that tag. The debug function is used to display items in the debug menu
within the script engine. In this case the debug is being used to display the string COUNT: followed by the
current value of the global variable count.

INITIALIZATION SCRIPT
global perc, count

count=0

def perc(value,base):
return value/base*100

This script is being used to initialize a global variable, count, and a global function, perc. The variable is then
initialized in the script with the value 0, and the function perc is defined. Importantly, note that this script is not
being run cyclically, but is instead being run as an On Start script.

IoT Unified User Guide

 124

QUALITY FUNCTIONS
quality['ASSET.GROUP.TAG']

quality_check[List of tags]

quality_str(param)

quality_assert([List of tags])

The first of these, the quality function checks if the tag currently has a good quality.
The second function returns true if all tags within the list are good, false if any are not.
The third function gives the quality of every tag that is included in the list.
The final function checks if all tags in the list are currently of good quality. If any are not, the script will be
exited, and an error message will be sent.

CUSTOM DATA PROCESSOR

from data_processors.utils.array_tools import transform_arrays
import numpy as np

def crazy_function(value, m, n):

return np.array([n if x % m == 0 else x for x in value])

def crazy_data_proc(standard_pack: dict, num1: int, num2: int) -> dict:

return transform_arrays(standard_pack, crazy_function, m=num1, n=num2)

my_custom_iot_data_processors = {
"my_proc_category.crazy_processor": {

IoT Unified User Guide

 125

"function": crazy_data_proc,
"ui-config": {
"name": "Crazy Processor",
"description": "This is just for show an example. Check every value to know if it is a multiple of "
"Number 1 , then replace them wit Number 2",
"kwargs": {
"num1": {
"name": "Number 1",
"required": True,
"type": "number",
"default": 2,
"min": 0,
"max": 10,
"step": 1
},
"num2": {
"name": "Number 2",
"required": True,
"type": "number",
"default": 0,
"min": 0,
"max": 10,
"step": 1
}
}
}
}
}

This example shows how to create a custom data processor for use with IOT Connectors in the script engine.
This script works by defining some function that is to be carried out by the data processor. In this example, the
processor will check to see if a number is divisible by another number. If it is not, the number will be replaced

IoT Unified User Guide

 126

with that number. Once you have defined the function that the processor is to carry out, most of the script is
then defining the processor by defining the inputs that will be shown in the Data Processor UI. For this
example, you can see below what this processor would look like when making an IOT Connector.

IoT Unified User Guide

 127

Appendix C: IOT Connector Examples

This section goes over a few examples of IOT Connector configurations.

INFLUX TO MQTT

IoT Unified User Guide

 128

This IOT Connector is sending the tag MOTOR.RT.SPEED from Influx to MQTT, using the topic
DEV183/MOTOR. No Data Processors are being used. There is a single server in the cluster.

IoT Unified User Guide

 129

MQTT TO INFLUX

IoT Unified User Guide

 130

This IOT Connector is doing the reverse of the previous one. It is taking the data that we sent to MQTT with
the previous connector and sending it from MQTT to Influx. To find the topic, you can click on Discover Topics.
Then to map the data to the correct tag, you can click on Update Mapping on the topic. Once again, no data
processors are being used.

IoT Unified User Guide

 131

MOVING MEAN DATA PROCESSOR

This IOT Connector is the same as the previous, reading data from MQTT and sending it to Influx. However,
this one is sending the data through a Data Processor to calculate a moving mean. This function will take a
number of values equal to the Window Size defined within the data processor and will return the average of
those values.

IoT Unified User Guide

 132

SCALING DATA PROCESSOR

This IOT Connector is once again taking the SPEED tag from MQTT and sending to Influx. However, this one is
using a MinMaxScaler data processor. This data processor will scale the values to values within the minimum
and maximum set within the processor. Note that with both of these examples, you are able to add multiple
data processors and the results of one will feed into the next and so on.

IoT Unified User Guide

 133

Appendix D: Channel Examples

This section provides several examples of various channel configurations.

OPC UA

This shows an example of how to set up an OPC UA channel. Note that when setting the endpoint it should be
in the format opc.tcp://[ip address]:[port]. You can also set a security policy if necessary for the OPC server
you are connecting to. When using this type of channel, if you go to map a tag you will be able to do a
discovery option to discover all tags on the OPC server you are connected to.

IoT Unified User Guide

 134

SIEMENS

This shows a connection to a SIEMENS Profinet PLC. For this channel, you will need the PLC type. In this case it
is an S7 300/400. You will also need the connection number, IP address, rack, and slot.

MODBUS

This channel is showing a connection to Modbus TCP. For this channel, you will need the IP address, port, and
device ID. Note that when you are mapping tags connected to a Modbus TCP channel, you will need to input
the offset, not the actual address when configuring your tag.

IoT Unified User Guide

 135

Appendix E: Accessing Virtual Machine IP Address

1. Download and Import SORBA VM using the instructions from the Installation stage for installing
a SORBA VM.
2. Find VM IP using an IP Scanner software (The VM is configured by default with DHCP which will
take an IP on the network as long the network has a DHCP server on it), see image below:

3. Access IoT Unified Web Page using the IP address discovered with the scanning software.

4. If this method fails, you can also boot up the VM and access the IP address using the command
ifconfig once you are signed in. This will display the IP address associated with the VM.

IoT Unified User Guide

 136

Appendix F: Updating SORBA License

1. Navigate to the IOT Unified Web Page.
2. Obtain the Serial Number and MAC Address from the System Overview:

3. Send this information to the SORBA team in order to obtain a license key in return.
4. Access the Workspace and upload the license key as shown below:

IoT Unified User Guide

 137

5. The license status can be checked from the About page.

IoT Unified User Guide