×

Supercharge your Proficy solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Explore our Proficy 2024 releases!

MQTT Client
- Getting Started
- Utilities
- Configuration
  - MQTT Client in Configuration Hub
    Configuration Hub allows you to manage the MQTT Client connections to multiple broker(s) that collect, store, and retrieve data parameters.
    - MQTT Client Configuration
      Use the following steps to configure the MQTT connections in the Configuration Hub.
      - Manage Identity Providers, Groups, and Users
        By default, the username ch_admin is created in the Proficy Authentication server after registering MQTT Client with the Configuration Hub server. For the first time, you can log in to the Configuration Hub user interface using this username (the password will be the same as the Proficy Authentication secret). After you log in to Configuration Hub, as an administrator, navigate to Proficy Authentication > Security. Depending on the groups assigned to the user, the user will have permissions to access the MQTT client configuration.
      - MQTT Groups in Proficy Authentication
        Proficy Authentication provides group membership access for MQTT clients, such that the users can access the MQTT client configuration from Configuration Hub and read/write OPC UA data.
      - Add MQTT Server for Broker Connection
        MQTT Plugin for Broker connections are edited in the DETAILS section. After selecting a server configuration in the Connections panel, the DETAILS section populates the broker details such as server details, reconnect parameters, and so on.
      - Add Subscriptions to Broker Connection
        Subscriptions are created under the Broker(s) to subscribe to the data parameters.
      - Add Tags to Subscription
        For a Subscription, a Tag is added to load the subscribed MQTT data. Data stored in the tags will be translated from MQTT to OPC UA when the data is published.
      - Secure Connection with Broker
        To establish a secure connection with the MQTT broker, you must import the broker certificate and trust the certificate. This encrypts the data and keeps the broker connection data secure and authenticated.
    - Save and Publish
      When the MQTT node is plugged-in with Configuration Hub, the common toolbar will contain the Save button at the top left. Changes made in Configuration Hub for MQTT nodes are not saved on the server until the changes are published. Until then, any changes are stored in a separate directory on the node being configured.
    - Publish Log and Version
      After you publish the MQTT plugin changes, you can directly view the published log reports by clicking the icon.
    - OPC UA
      The OPC UA protocol is a standard communication mechanism for transferring data between interfaces. OPC UA clients connect to the OPC UA server and collect data from UA Variables.

MQTT Groups in Proficy Authentication

Proficy Authentication provides group membership access for MQTT clients, such that the users can access the MQTT client configuration from Configuration Hub and read/write OPC UA data.

Table 1. Group Membership
MQTT Group Membership	Access Provision
protocoltranslators.mqtt.<PLUG-IN ALIAS NAME>.config.read	Retrieve the list of broker, subscriptions, and tags on the specific MQTT client node that has the Alias name registered with Configuration Hub.
protocoltranslators.mqtt.<PLUG-IN ALIAS NAME>.config.write	Retrieve/modify/add/delete the list of broker, subscriptions, and tags on the specific MQTT client node that has that Alias name registered with Configuration Hub. Save and Publish the data.
protocoltranslators.mqtt.<PLUG-IN ALIAS NAME>.opcua.read	This group provides read access to OPC UA clients, so that the OPC UA clients can connect to the MQTT OPC UA server and read the OPC UA data on the specific node.
protocoltranslators.mqtt.<PLUG-IN ALIAS NAME>.opcua.write	This group provides read/write access to OPC UA clients, so that the OPC UA clients can connect to the MQTT OPC UA server and read/write the OPC UA data on the specific node.

Note:

The following groups are shared access groups that provide access to all MQTT client nodes on the network.

protocoltranslators.mqtt.shared.config.read
protocoltranslators.mqtt.shared.config.write
protocoltranslators.mqtt.shared.opcua.read
protocoltranslators.mqtt.shared.opcua.write

Important:

If the groups are not assigned to the user, the MQTT plugin connection will not load any data. Shared access groups are added by default to the ch_admin user during plugin registration.