Industrial Edge MQTT Connector
Congurator V1.5
Operating Manual
02/2022
General Data Protection
Regulation (GDPR) 1
Introduction to Industrial
Edge MQTT Connector 2
User Interface for Industrial
Edge MQTT Connector
Congurator Home Page 3
Working with Industrial
Edge MQTT Connector
Congurator 4
Additional Information A
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage
to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices
referring only to property damage have no safety alert symbol. These notices shown below are graded according to
the degree of danger.
DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.
WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.
CAUTION
indicates that minor personal injury can result if proper precautions are not taken.
NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will be
used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property
damage.
Qualied Personnel
The product/system described in this documentation may be operated only by personnel qualied for the specic
task in accordance with the relevant documentation, in particular its warning notices and safety instructions.
Qualied personnel are those who, based on their training and experience, are capable of identifying risks and
avoiding potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:
WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended or
approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance
are required to ensure that the products operate safely and without any problems. The permissible ambient
conditions must be complied with. The information in the relevant documentation must be observed.
Trademarks
All names identied by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication may
be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software described.
Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this
publication is reviewed regularly and any necessary corrections are included in subsequent editions.
Siemens AG
Digital Industries
Postfach 48 48
90026 NÜRNBERG
GERMANY
Ⓟ 02/2022 Subject to change
Copyright © Siemens AG 2022.
All rights reserved
Table of contents
1 General Data Protection Regulation (GDPR).......................................................................................... 5
2 Introduction to Industrial Edge MQTT Connector ................................................................................. 7
3 User Interface for Industrial Edge MQTT Connector Congurator Home Page ..................................... 9
4 Working with Industrial Edge MQTT Connector Congurator............................................................. 13
4.1 Managing Users................................................................................................................. 13
4.1.1 Add Users .......................................................................................................................... 13
4.1.2 Delete Users ...................................................................................................................... 14
4.1.3 User View Tab .................................................................................................................... 15
4.2 Managing Topics................................................................................................................ 16
4.2.1 Add Topics ......................................................................................................................... 16
4.2.2 Topic View Tab................................................................................................................... 20
4.2.3 Delete Topics ..................................................................................................................... 21
4.3 Enable End-to-end Secure Connection................................................................................ 21
4.4 Import/Export Conguration............................................................................................... 23
4.5 Conguring Bridge ............................................................................................................. 24
4.6 Deploy Updates.................................................................................................................. 26
A Additional Information ........................................................................................................................ 29
A.1 Connect to IE MQTT Connector .......................................................................................... 29
A.2 Notes on use...................................................................................................................... 31
A.3 Known issues..................................................................................................................... 33
Industrial Edge MQTT Connector Congurator V1.5
Operating Manual, 02/2022 3
Table of contents
Industrial Edge MQTT Connector Congurator V1.5
4Operating Manual, 02/2022
General Data Protection Regulation (GDPR) 1
Siemens adheres to the principles of data protection, in particular the principles of data
minimization (Privacy by Design).
For this product, Industrial Edge MQTT Connector Congurator, this means:
Personal data
There is no personal data* collected but following data is stored to allow machine to machine
communication:
• Individual client credentials for connecting to IE MQTT Connector
• Topics associated with each user for publishing, subscribing, or both over IE MQTT Connector
• App usage data
If the customer links the data mentioned above to other data (e.g. shift plans) or if the customer
saves personal information on the same medium (e.g. hard disk) and thus creates a personal
reference, the customer has to ensure that the guidelines regarding data protection are
observed.
Note
* This section refers to any personal data processed by the Application other than the personal
data contained in log-les / tracking data (if any). "Personal data" are any information relating to
an identied or identiable natural person. Please note that IP-addresses, device identiers such
as IMEI, UDID, IMSI, MAC-address, MSISDN, location data or machine data (if machine data
tracks events triggered by user interaction with the machine) usually qualify as personal data.
Purposes
The data mentioned above is required for the following purpose:
• Access protection and security measures
Storage of the data is aected for a suitable purpose and is limited to what is strictly necessary,
as the information is indispensable in order to identify the authorized clients.
Securing of data
The above data will not be stored anonymously or pseudonymized, as the purpose
(identication of the operating personnel) cannot be achieved otherwise. This data will be used
only within the product and within the Edge eco-system and will not be automatically passed on
to third parties or unauthorized persons. This data is secured by adequate technical measures,
such as encryption.
The customer must ensure the access protection as part of his process conguration while using
IE MQTT Connector.
Industrial Edge MQTT Connector Congurator V1.5
Operating Manual, 02/2022 5
Deletion policy
This product does not provide an automatic deletion for the IE MQTT Connector and server user
credentials already provided by the user. IE MQTT Connector user credentials can be deleted.
Data conguration
The customer can congure the above data for the product using the App Congurator on
Industrial Edge Management. Once the conguration is completed, the data will be stored
securely.
General Data Protection Regulation (GDPR)
Industrial Edge MQTT Connector Congurator V1.5
6Operating Manual, 02/2022
Introduction to Industrial Edge MQTT Connector 2
The Industrial Edge MQTT Connector (IE MQTT Connector) allows you to connect remote clients
to the IED over MQTT. The data pushed to IE MQTT Connector is pushed to IE Databus on the
congured topics and is available to be consumed by other apps within the IED.
The IE MQTT Connector consists of the following two components:
1. Industrial Edge Databus Congurator (IE Databus Congurator) in Industrial Edge
Management:
The IE Databus Congurator in Industrial Edge Management includes a user interface. The IE
Databus and IE MQTT Connector use the same congurator app and the IE MQTT Connector
Congurator functionalities are performed using IE Databus Congurator app. The IE MQTT
Connector Congurator gives you an overview of the IE MQTT Connector-specic details of
the corresponding Industrial Edge Device.
2. IE MQTT Connector:
The IE MQTT Connector is a distributed application that runs on the individual Industrial Edge
Device.
Industrial Edge MQTT Connector Congurator V1.5
Operating Manual, 02/2022 7
Introduction to Industrial Edge MQTT Connector
Industrial Edge MQTT Connector Congurator V1.5
8Operating Manual, 02/2022
User Interface for Industrial Edge MQTT Connector
Congurator Home Page 3
Prerequisite
• IE MQTT Connector app must be installed and running on the Industrial Edge Device.
• IE Databus Congurator app must be installed and running on the Industrial Edge
Management.
Home page
When you launch IE MQTT Connector Congurator, the Congurator home page is displayed as
follows:
Industrial Edge MQTT Connector Congurator V1.5
Operating Manual, 02/2022 9
①User View Tab
②Add User Icon
③Topic View Tab
④Certicate Tab
⑤Bridge Congure
⑥Deploy Button
⑦Delete User Icon
⑧Add Topic Icon
⑨User Information
⑩Delete Topic Icon
⑪Logs/Import/Export Icons
UI Elements
The following table lists the dierent UI elements in the IE MQTT Connector Congurator home
page.
Symbol Description
User View Tab Displays the users and their assigned topics and associated access rights.
Add User Icon Enables to add a user.
Topic View Tab Displays all the topics as an individual row with the related user and asso‐
ciated access rights.
Certicate Tab Enables to congure secure/unsecure connection.
Bridge Congure Allows you to set up connection between data bus to external applications
through MQTT connector
User Interface for Industrial Edge MQTT Connector Congurator Home Page
Industrial Edge MQTT Connector Congurator V1.5
10 Operating Manual, 02/2022
Symbol Description
Deploy Button Opens the "Deploy" dialog box to deploy conguration to specic IEDs. If
you close the IE MQTT Connector Congurator, then all the unsaved con‐
gurations are lost.
"Deploy" button enables to deploy the conguration to Industrial Edge
Runtime. It saves the conguration on the Industrial Edge Runtime.
Delete User Icon Enables to delete a user.
Add Topic Icon Enables to add a topic.
User Information Displays the users and their assigned topics and associated access rights.
Delete Topic Icon Enables to delete a topic.
Logs/Import/Export Icons Displays the activities of users and its associated topics.
Enable to import and export the conguration. For more information, re‐
fer Import/Export Conguration (Page 23).
User Interface for Industrial Edge MQTT Connector Congurator Home Page
Industrial Edge MQTT Connector Congurator V1.5
Operating Manual, 02/2022 11
User Interface for Industrial Edge MQTT Connector Congurator Home Page
Industrial Edge MQTT Connector Congurator V1.5
12 Operating Manual, 02/2022
Working with Industrial Edge MQTT Connector
Congurator 4
The IE MQTT Connector Congurator provides you information about all available users
including their access rights for the corresponding Industrial Edge Device. In addition, you can
create users and grant users access rights to the IE MQTT Connector of the corresponding
Industrial Edge Devices.
The data pushed to IE MQTT Connector is pushed to IE Databus on the congured topics. You can
connect any external client and apps to IE MQTT Connector and thereby obtain access rights to
the IE MQTT Connector. This allows you to use the data from the remote clients for your
individual application.
The IE MQTT Connector Congurator supports multiple user access with the following scenarios:
• One user can access IE MQTT Connector Congurator on multiple Industrial Edge Device
(IED).
But the user cannot access IE MQTT Connector Congurator on the same IED in multiple tabs
of same browser or multiple browsers.
• Two users can access IE MQTT Connector Congurator on two dierent IEDs simultaneously.
When the two users access IE MQTT Connector Congurator on the same IED, a message is
displayed to the second user that the IED is in use already. Therefore, the second user cannot
access IE MQTT Connector Congurator.
4.1 Managing Users
4.1.1 Add Users
You can add a user in the IE MQTT Connector Congurator and provide the necessary access
rights to a topic of the IE MQTT Connector of the corresponding Industrial Edge Device.
Prerequisite
The IE MQTT Connector application must be running.
Industrial Edge MQTT Connector Congurator V1.5
Operating Manual, 02/2022 13
Procedure
To add a user, follow these steps:
1. Launch the IE MQTT Connector Congurator.
The IE MQTT Connector Congurator home page is displayed.
2. Click in the "Users" section.
The "Add User" dialog box is displayed as follows:
3. Complete the following elds:
Field Name Denition
Username Denes the username of the new user.
Password Denes the corresponding password of the user.
User is successfully added, and is displayed under the "User" view tab.
4.1.2 Delete Users
The IE MQTT Connector Congurator allows you to delete a user. When you delete a user, the
"Users" section is updated with the updated list of the users to IE MQTT Connector of the
corresponding Industrial Edge Device.
Once a user is deleted, the user no longer has access to the IE MQTT Connector of the
corresponding Industrial Edge Device.
Prerequisite
The IE MQTT Connector application must be running, and a user must be available.
Working with Industrial Edge MQTT Connector Congurator
4.1 Managing Users
Industrial Edge MQTT Connector Congurator V1.5
14 Operating Manual, 02/2022
Procedure
To delete a user, follow these steps:
1. Launch the IE MQTT Connector Congurator.
The IE MQTT Connector Congurator home page is displayed.
2. Click on the user that you want to delete.
The delete icon is enabled.
3. Click .
The user is deleted and removed from the IE MQTT Connector.
You must click "Deploy" to deploy the changes to Industrial Edge Runtime.
4.1.3 User View Tab
The "User View" tab is the default view tab when you launch the IE MQTT Connector
Congurator. It displays all the available users including their access rights for the assigned
topics.
The user list gives you an overview of the users that are created in the IE MQTT Connector of the
corresponding Industrial Edge Device. If you click on a user from the user list, the "Topics" list
displays the topics that the user can access, including the topic's access rights.
As depicted in the above image, the "User View" tab provides you the following features:
• Sorting Feature
You can sort the users, topics, or access rights column using the sorting icon in their
respective column.
• Searching Feature
You can search a user, topic, or access rights using the available lter area in their respective
column
• The green check box indicates the status of the MQTT connector.
Working with Industrial Edge MQTT Connector Congurator
4.1 Managing Users
Industrial Edge MQTT Connector Congurator V1.5
Operating Manual, 02/2022 15
4.2 Managing Topics
4.2.1 Add Topics
You can add a topic in the IE MQTT Connector Congurator and assign the required access rights
for a user. The user based on the assigned permissions can access the topic.
Prerequisite
The IE MQTT Connector application must be running, and a user must be available.
Procedure
To add a topic, follow these steps:
1. Launch the IE MQTT Connector Congurator.
The IE MQTT Connector Congurator home page is displayed.
You can add topics using:
– User View
– Topic View
Working with Industrial Edge MQTT Connector Congurator
4.2 Managing Topics
Industrial Edge MQTT Connector Congurator V1.5
16 Operating Manual, 02/2022
Adding topics in User View tab
To assign "Topics" to users in "User "view tab, perform the following:
1. Click in the "Topics" section. The The "Add Topic" pop-up appears as follows:
2. You can choose to enter a new topic by clicking "New" tab, and select the "Permission" type.
Complete the following elds:
Field Description
Topic name Species the topic name that is used for the
unique to assign it to users. You can search the
topics using the "Search Topic" option. The rele‐
vant topics are displayed in the drop-down list.
Permission Species the access rights of the user to the IE
MQTT Connector. The available options are as
follows:
• "No Permission": The user has no access
rights.
• "Subscribe Only": The user can only read data
from the IE MQTT Connector and use it for
other applications.
• "Publish and Subscribe": The user can send
data to the IE MQTT Con‐nector and use data
from the IE MQTT Connector for further ap‐
plications.
Actions Allows you to delete the topics.
Working with Industrial Edge MQTT Connector Congurator
4.2 Managing Topics
Industrial Edge MQTT Connector Congurator V1.5
Operating Manual, 02/2022 17
3. Click "Add".The topic is added, and is displayed in the "New" tab area.
You can choose to search and import topics "From MQTT", and assign it to user as shown
below:
4. You can choose to search for topics "From Databus", and assign it to user as shown below:
5. Click "Add".The topic is assigned to the user and displayed in the "Users" section. You must
click "Deploy" to deploy the changes to Industrial Edge Runtime.
Working with Industrial Edge MQTT Connector Congurator
4.2 Managing Topics
Industrial Edge MQTT Connector Congurator V1.5
18 Operating Manual, 02/2022
Adding Topics in Topic View tab
To assign "Topics" to users in "Topic" view tab, perform the following:
1. Click in the "Topics" section.
The The "Add Topic" pop-up appears as follows:
2. Complete the following elds:
Field Name Description
Username Lists the username to which you are adding the topic.
Topic name Denes the topic name. Alternatively, you can select an existing topic
from the drop-down list. The topic name is used for the unique assign‐
ment of the user to the access area.
Permission Species the access rights of the user to the topic. The available options
are as follows:
• "No Permission": The user has no access rights.
• "Subscribe Only": The user can only read data from the IE MQTT Con‐
nector and use it for other applications.
• "Publish and Subscribe": The user can send data to the IE MQTT Con‐
nector and use data from the IE MQTT Connector for further applica‐
tions.
Note: The above options are available in Topic view only.
Working with Industrial Edge MQTT Connector Congurator
4.2 Managing Topics
Industrial Edge MQTT Connector Congurator V1.5
Operating Manual, 02/2022 19
3. You can use to add up to ve topics as follows:
4. Click "OK".The topic is added to the user's topic list and to the Industrial Edge Device's IE MQTT
Connector with the appropriate access permissions.
You must click "Deploy" to deploy the changes to Industrial Edge Runtime.
4.2.2 Topic View Tab
The "Topic View" tab displays a complete overview of all the topics including their assigned users
and access rights.
Working with Industrial Edge MQTT Connector Congurator
4.2 Managing Topics
Industrial Edge MQTT Connector Congurator V1.5
20 Operating Manual, 02/2022
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
/
