Commissioning and first steps
39/152
5.5
"Onboard" (register) device in netFIELD Portal
5.5.1
Overview
This section describes how to register your device in the netFIELD Portal.
Before your device can be managed from the portal, it must first complete a
one-time registration process, called “onboarding”.
This process is initialized by the device itself, not by the portal. There are
three different onboarding methods:
Zero-Touch
,
Basic
and
Advanced
.
With the
Zero-Touch
method, the device registers itself automatically in the
portal after it has been put into operation. Note that this method is
implemented only in certain customer-specific Edge Device models.
With the
Basic
and
Advanced
methods, you start the registration process
by locally entering authentication data in the
Onboarding
page of the
Local
Device Manager
:
With the
Basic
method, you simply need to enter your netFIELD Portal’s
login credentials (if your user “role” in the portal entails permissions to
“onboard” and “create” devices).
With the
Advanced
method (which allows onboarding in a certain separate
instance of the netFIELD Portal), you must enter an
Activation Code
,
an
API Key
and an
API End-Point
URL. You must research
(respectively create) these parameters in the portal beforehand, then insert
them in the
Onboarding
page of the Local Device Manager via clipboard
(“copy and paste”). For the
Advanced
method, you therefore ideally need
simultaneous access to the portal and the device in order to be able to copy
the data from the portal conveniently into the corresponding fields of the
Onboarding
page of the Local Device Manager.
Note:
Before onboarding, make sure that your company’s firewall does
not block the TCP port (outgoing) of the upstream protocol (device-
to-cloud communication) that you intend to use. The upstream
protocol can be selected on the
Onboarding
page.
MQTT uses TCP port
8883
MQTT over WebSocket uses TCP port
443
AMQP (default protocol) uses TCP port
5671
AMQP over WebSocket uses TCP port
443
The following sections contain step-by-step instructions for the
Basic
and
Advanced
onboarding methods.
netFIELD OnPremise | User manual
DOC200901UM02EN | Revision 2 | English | 2021-06 | Released | Public
© Hilscher 2021