Remote Automation Solutions FBxEdge Manager User guide

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

Energy and Transportation Solutions

Emerson FBxEdge™ Manager User Guide

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

ii

Application & Device Safety Considerations

 Reading these Instructions

Before operating a device or application, read these instructions carefully and understand their safety implications. In some

situations, improper use may result in damage or injury. Keep this manual in a convenient location for future reference. Note

that these instructions may not cover all details or variations in equipment or cover every possible situation regarding

installation, operation, or maintenance. Should problems arise that are not covered sufficiently in the text, immediately contact

Customer Support for further information.

 Protecting Operating Processes

The failure of a device or application – for whatever reason – may leave an operating process without appropriate protection and

could result in possible damage to property or injury to persons. To protect against this, review the need for additional backup

equipment or provide alternate means of protection (such as alarm devices, output limiting, fail-safe valves, relief valves,

emergency shutoffs, emergency switches, etc.). Contact Energy and Transportation Automation Solutions for additional

information.

 Using Qualified Personnel

Installation, configuration, and any subsequent modifications to a device or application should only be performed by qualified,

suitably trained personnel information.

 System Training

A well-trained workforce is critical to the success of your operation. Knowing how to correctly install, configure, program,

calibrate, and trouble-shoot your Emerson equipment provides your engineers and technicians with the skills and confidence to

optimize your investment. Energy and Transportation Solutions offers a variety of ways for your personnel to acquire essential

system expertise. Our full-time professional instructors can conduct classroom training at several of our corporate offices, at

your site, or even at your regional Emerson office. You can also receive the same quality training via our live, interactive Emerson

Virtual Classroom and save on travel costs. For our complete schedule and further information, contact the Energy and

Transportation Solutions Training Department at 800-338-8158 or email us at education@emerson.com.

 Grounding Equipment

Refer to Emerson Machine Automation Solutions product documentation for further information.

 Protecting from Electrostatic Discharge (ESD)

Refer to Emerson Machine Automation Solutions product documentation for further information.

 Ethernet Connectivity

This automation device is intended to be used in an Ethernet network which does not have public access. The inclusion of this

device in a publicly accessible Ethernet-based network is not recommended.

 Returning Equipment

If you need to return any equipment to Energy and Transportation Solutions (ETS), it is your responsibility to ensure that the

equipment has been cleaned to safe levels, as defined and/or determined by applicable federal, state and/or local law

regulations or codes. You also agree to indemnify ETS and hold ETS harmless from any liability or damage which ETS may incur or

suffer due to your failure to ensure device cleanliness.

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

Contents iii

Contents

Chapter 1. Introduction 1

1.1 Setting a Static IP Address ................................................................................................................... 2

1.2 FBxEdge Manager and FBxEdge ......................................................................................................... 3

Chapter 2. Accessing FBxEdge Manager 5

2.1 Accessing the FBxEdge Manager Admin Console ............................................................................ 5

2.2 Licensing and Activating an FBxEdge Manager ............................................................................... 7

2.3 Activating an Edge Device ................................................................................................................... 9

2.3.1 Acquiring an Activation Code ................................................................................................. 9

2.3.2 Sending an Activation Request ............................................................................................. 14

2.3.3 Accepting the Activation Request ........................................................................................ 15

Chapter 3. The FBxEdge Manager GUI 17

3.1 System Dashboard .............................................................................................................................. 18

3.2 Displaying Licenses ............................................................................................................................. 18

3.3 Managing Edge Devices ..................................................................................................................... 19

3.4 Creating and Managing Templates .................................................................................................. 22

3.4.1 Why Use Templates? .............................................................................................................. 22

3.4.2 Creating a Template from a Device ..................................................................................... 24

3.4.3 Uploading a Template from a File........................................................................................ 28

3.4.4 Applying a Template .............................................................................................................. 29

3.4.5 Editing Template Information .............................................................................................. 29

3.4.6 Parameterizing a Template ................................................................................................... 31

3.4.7 Downloading a Template ...................................................................................................... 35

3.4.8 Deleting a Template ............................................................................................................... 35

3.5 Managing Applications ...................................................................................................................... 37

3.5.1 Launching an Application ...................................................................................................... 39

3.6 Managing Settings .............................................................................................................................. 41

3.6.1 Managing Project Setting Information ............................................................................... 41

3.6.2 Managing Project Members Information ........................................................................... 42

3.6.3 Managing Project Credentials .............................................................................................. 43

Appendix A. Creating and Deploying a Sparkplug B Application A-1

A.1 Locating the Docker Image Files .................................................................................................... A-1

A.2 Defining a User for the Docker Registry ........................................................................................ A-2

A.3 Uploading Image Files to the Docker Registry ............................................................................. A-5

A.4 Accessing the Marketplace .............................................................................................................. A-6

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

iv Contents

A.5 Selecting a Registry for the Applications ....................................................................................... A-9

A.6 Adding an Application .................................................................................................................... A-12

A.7 Creating a Release ........................................................................................................................... A-13

A.8 Creating a Variable of the Release ................................................................................................ A-14

A.9 Creating the Application ................................................................................................................. A-16

A.10 Deploying an Application to Edge Devices .................................................................................. A-18

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

1

Chapter 1. Introduction

Important

Your IT department must have previously installed the FBxManager .ova file on your

server.

This guide provides a quick introduction to the Emerson FBxEdge™ Manager web-based

software. Once you have defined one or more FBxEdge edge devices (refer to the Emerson

FBxEdge User Guide [D301913X012] for more information), you then use the FBxEdge

Manager software to remotely monitor and manage those edge devices. You can also

remotely perform device onboarding, manage licenses, deploy applications, consolidate

data mapping, manage an MQTT broker, apply licenses, and reboot edge devices.

Additionally, FBxEdge Manager’s template feature allows you to quickly apply device

definitions to multiple edge devices at the same time. For example, you might have

defined an edge device attached to four devices: two FB3000 RTUs and two ROC800 RTUs.

Each RTU provides the edge device with different data, which the edge device then sends

to different locations (a SQL database, an MQTT broker connected to a SCADA system, or

to cloud analytics), based on your organization’s needs. You can then create a template

based on the edge device’s total configuration (encompassing all four RTUs and their

data definitions) as well as component templates based on the configurations of the

individual RTUs.

When you add more edge devices to your site, FBxEdge Manager enables you to apply

one or all of those templates to the new edge device. In minutes you can quickly create a

clone of your original edge device or apply any or all of the RTU-specific templates to the

new edge devices. You can create an unlimited number of templates, and then apply

multiple templates to each edge device, tailoring them to your specific requirements. For

further information, refer to Section 3.5, Creating and Managing Templates.

In summary, the FBxEdge Manager provides tools to remotely manage:

 Device onboarding

 Edge device firmware updates

 Mappings for consolidated data

 Usernames and passwords

 Application deployment

 MQTT broker configuration

 Propagation of configuration changes

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

2

 Edge devices licenses

Figure 1-1. The FBxEdge Manager Environment

1.1 Setting a Static IP Address

1. Log onto FBxEdge Manager from the ESXI virtual machine console with the Username

fbx_setup and the password Se34@1FbL!.

2. At the command prompt enter

NEW_IP=xxx.xxx.1.222

sudo /opt/lem/bin/lem-update-domain-names.sh $NEW_IP $NEW_IP

sudo /opt/lem/bin/stop-all-nomad-jobs.sh

sudo vi /etc/netplan/01-netcfg.yaml

3. Update the .yaml file (here, 01-netcfg.yaml) with the desired IP, gateway4, and

nameservers addresses:

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

3

Figure 1-2. Command Prompts

4. Save the .yaml file.

5. From a command line, run the commands:

sudo netplan apply

sudo reboot

1.2 FBxEdge Manager and FBxEdge

Important

Complete the configuration of at least one edge device before you attempt to connect

the edge device to the FBxEdge Manager. Refer to the FBxEdge User Guide, D301913X012.

Refer to Section 2.2, Activating an FBxEdge Device, for step-by-step instructions. In

summary, to establish a relationship between the FBxEdge Manager and an edge device:

1. Log onto the FBxEdge Manager Admin Console web interface, locate the supplied

license key, and submit it for activation (see Section 2.1 below).

2. In a separate browser session, log onto FBxEdge and configure the edge device’s tags,

flows, analytics, docker containers, and MQTT connections (refer to the FBxEdge User

Guide, D301913X012).

3. In an another separate browser session, log onto FBxEdge Manager and create a

device configuration (see Section 2.2 below),

4. In FBxEdge, select the System icon and select Device Management. The Cloud

Activation page displays.

5. Click Edit and enter the IP address for the FBxEdge Manager. The system displays a

dialog asking you to access the certificate from FBxEdge Manager.

6. Click Yes, trust the certificate. In response, FBxEdge Manager sends an activation

configuration code.

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

4

7. Copy the activation configuration code and paste it into the Activation Code field on

the Cloud Activation page. The system displays an Activation request has been sent

message.

At this point you need to approve the activation request using FBxEdge Manager.

8. Open the FBxEdge Manager browser session and select Activation and Requests.

Look for the request received from the edge device.

9. Under Action, click the three dots and select Approve from the menu.

The edge device should now display under Edge Devices in FBxEdge Manager.

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

5

Chapter 2. Accessing FBxEdge Manager

Important

Complete the configuration (devices, tags, flows, analytics, docker containers, and MQTT

broker connection) of at least one edge device before you attempt to connect the edge

device to the FBxEdge Manager. Refer to the FBxEdge User Guide, D301913X012.

2.1 Accessing the FBxEdge Manager Admin

Console

FBxEdge Manager enables you to monitor and manage a network of edge devices. To be

included in that network, each edge device requires a license. Additionally, you must also

license the FBxEdge Manager. Licenses are perpetual but are keyed to a specific version

of the software: when a new software version is released it is accompanied by a new

license.

To access the Admin Console:

1. Enter the IP address for the Admin Console in the Google™ Chrome™ web browser

(the only supported web browser). This address is typically a standard IP address

followed by a port designator (here, https://fbxedge-manager-ip:8446). The FBxEdge

Manager Admin Console login page displays.

Important

The first time you boot up, the FBxEdge Manager Admin Console page may take as

long as 30 minutes to display. During that time the system displays an Application

Starting Up message during the boot.

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

6

Figure 2-1. FBxEdge Manager Admin Console Login Page

2. Provide a username and password (admin/admin for the first login) and click Login.

Note

The admin/admin credentials apply only to the first login, after which you must

define a new password.

3. Select a company and then a project; the Edge Management dashboard displays.

Note

If this is your first access to FBxEdge Manager, you must create a company and at

least one project (defined as a specific field or a collection of edge devices) for that

company.

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

7

Figure 2-2. FBxEdge Manager Admin Console Dashboard

2.2 Licensing and Activating an FBxEdge Manager

Before you can license and activate one or more edge devices you must first license and

activate the FBxEdge Manager for those devices.

1. From the FBxEdge Manager Admin Console, select the Settings icon ( ); the License

Settings screen displays.

Figure 2-3. FBxEdge Manager Admin Settings Screen

2. Select the Licenses option; the Licenses screen displays.

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

8

Figure 2-4. FBxEdge Manager Admin Licenses Screen

3. Click Add License; the Available Licenses portion of the screen expands to include an

Add a New License section:

Figure 2-5. Add a New License section

4. Complete the Activation Key field with the ETS-provided license activation key and

click Submit (this button activates once you enter a valid activation key).

The system displays a pop-up confirming a successful FBxEdge Manager license

activation and then displays the License Settings screen; the Available Licenses

section now contains the newly added license. The Status field ( ) indicates the

Manager is ready for use. Proceed to Section 2.3, Activating an Edge Device.

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

9

2.3 Activating an Edge Device

Important

Ensure that the FBxEdge Manager is licensed and activated, and then complete the

configuration (devices, tags, flows, analytics, docker containers, and MQTT broker

connection) of at least one edge device before you attempt to activate the edge device

using FBxEdge Manager. Refer to the FBxEdge User Guide, D301913X012.

Activating an edge device has three basic steps:

1. From FBxEdge Manager, acquiring an activation code for the edge device.

2. From FBxEdge, applying the activation code to the edge device and sending an

activation request to FBxEdge Manager.

3. From FBxEdge Manager, approving the activation request (which then activates the

edge device).

Important

Activating an edge device requires you to switch between browser sessions for both

FBxEdge and FBxEdge Manager. Once you have opened a session for FBxEdge Manager,

keep that session open when you need to access FBxEdge.

2.3.1 Acquiring an Activation Code

1. Acquire the IP address for the edge device (refer to Chapter 3, Configuring the Edge

Device, in the FBxEdge User Guide).

2. Open a Chrome browser session and enter the IP address/URL (https://fbxedge-

manager) for the FBxEdge Manager application. The FBxEdge Manager log in page

displays:

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

10

Figure 2-6. FBxEdge Manager Log In Page

3. Enter a username/password and click Log In. The FBxEdge Manager Companies page

displays.

Important

The initial username/password combination for FBxEdge Manager is demo/demo.

After the first time you log in, the system immediately prompts you to change the

password since system security prevents those credentials from being reused.

Note

If your organization has already defined a company and one or more projects, you

can skip to step 9.

Figure 2-7. FBxEdge Manager Companies Page

4. Click + ADD to add a company. The Create a company page displays:

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

11

Figure 2-8. FBxEdge Manager Create a company Page

5. Enter the name of a company (here, Southridge) and click Create. The Companies

page reappears, displaying your newly added company.

Figure 2-9. FBxEdge Manager Companies Page (2)

6. Click the tile for the newly added company; the Projects page displays:

Figure 2-10. FBxEdge Manager Projects Page

In this context, “Projects” are operational components of a company, such as specific

fields or collections of edge devices.

7. Click + ADD to add a project (here, a field named NorthField). The system redisplays

the Projects page showing your new project:

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

12

Figure 2-11. FBxEdge Manager Projects Page (2)

8. Click the tile for the newly added project to display that project’s dashboard page:

Figure 2-12. FBxEdge Manager Projects Dashboard Page

Once you have created a company and a project, you can now create an activation

configuration.

9. Select Activation and then Configuration from the navigation menu at the left side

of the page. The Activation Configuration page displays, listing any available

activation codes:

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

13

Figure 2-13. FBxEdge Manager Activation Configuration Page

Important

If you are activating your first edge device, this page does not list any activation

codes. To add an activation code, click the + icon in the upper right of the page. The

Activation Code page displays.

Figure 2-14. FBxEdge Manager Activation Code Page

10. Complete this page to define the edge device’s characteristics (Limits, License Type,

Licenses, Templates, etc.). Click Save; the system redisplays the Activation Code page,

showing the newly assigned activation code.

11. Click the activation code; a copy icon appears to the right of the code.

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

14

Figure 2-15. Copy Icon

12. Click the copy icon to copy the activation code to the clipboard.

2.3.2 Sending an Activation Request

1. Open the FBxEdge tab on your browser and select System and Device Management

from the navigation menu. The FBxEdge Cloud Activation page displays.

Figure 2-16. FBxEdge Cloud Activation Page

2. Click Edit and complete the Data & Device Management Endpoint field with the IP

address of the server on which the FBxEdge Manager is installed (for example,

https://10.211.223.254 ). The system changes the label on the Edit button to Set. Click

Set. The Certificate dialog displays:

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

15

Figure 2-17. FBxEdge Certification dialog

3. Click Yes, trust the certificate. The Cloud Activation page displays

Note

The system changes the label on the Set button back to Edit.

4. Paste the activation code (placed on the clipboard in step 11 of Section 2.2.1) in the

Activation Code field and click Activate (at the top right of the page).

5. The system displays a message indicating that FBxEdge has sent an activation request

to FBxEdge Manager:

Figure 2-18. Activation Request dialog

6. Click Close to close the dialog.

2.3.3 Accepting the Activation Request

1. Open the FBxEdge Manager tab on your browser and select Activation and

Requests from the navigation menu. The Activation Request List page displays.

Emerson FBxEdge Manager User Guide

D301916X012

October 2023

16

Figure 2-19. FBxEdge Manager Activation Request List Page

2. Select the most-current activation request (review the Created On field), click the

three dots (…) in the Action column, and select Approve from the menu.

3. Select Edge Devices from the navigation menu: the edge device should now display

in the list.

Important

Note that the system automatically assigns each edge device a hostname (such as

fbxedge-0003e1981650 or fbxedge-7ccbe2e22074 in the figure above). Giving each edge

device a “friendly name” enables you to quickly recognize a particular edge device. Refer

to Section 3, Configuring the Edge Device in the FBxEdge User Guide (D301913X012) for

details on giving an edge device a “friendly” name.

This establishes a communication between FBxEdge Manager and your edge device.

Note

Repeat this activation process for each edge device you define.

Page is loading ...

Remote Automation Solutions FBxEdge Manager User guide

Remote Automation Solutions FBxEdge Manager User guide

Related papers

Other documents