Registration and Proficy Authentication

You must register the MQTT Client with the Proficy Authentication server and the Configuration Hub server.

After installing the MQTT Client application from the <Integrated Installer>.iso disc file, ensure that you have the Configuration Hub and the Proficy Authentication servers installed on the same machine or on a machine that is accessible on the network.
Note: If the Configuration Hub and Proficy Authentication servers are not installed, you can install them from the Common Components of <Integrated Installer>.iso disc file.
To enable the connection between the MQTT server and Configuration Hub, you must register the MQTT Client with the Proficy Authentication and the Configuration Hub servers.
To register the MQTT Client with the Proficy Authentication and the Configuration Hub servers:
  1. Double-click the MQTT Client Registration desktop shortcut.
    Note: The MQTT Client Registration desktop shortcut appears only after you install the MQTT Client application from the <Integrated Installer>.iso disc file. Refer to MQTT Client Installation for more information.
    The MQTT Plug-in Registration page appears.
  2. Enter your login credentials and then, click Login.
    Note: Enter the login credentials you created during the MQTT Client installation.

    The Configuration Hub Server Registration page appears.

  3. In the Configuration Hub section, enter the following details:
    Field Description
    SERVER NAME The name of the Configuration Hub server to which you want to register. In the <Fully qualified domain name> format.
    SERVER PORT The port number of the Configuration Hub server to which you want to register.
    PLUG-IN ALIAS NAME The alias name for the MQTT plugin that you want to see in the Configuration Hub.
    Note: By default, the name populated is the machine name where the MQTT Client is installed. However, you can update it to how you want to see the MQTT plugin name in the Configuration Hub.
    Important: Do not use the dot (.) character for the MQTT plugin alias name.
    CLIENT ID The client ID of the Configuration Hub server that you provided during the Configuration Hub installation.
    CLIENT SECRET The client secret of the Configuration Hub server that you provided during the Configuration Hub installation.
  4. In the Proficy Authentication section, enter the following details:
    Field Description
    SERVER NAME The name of the Proficy Authentication server to which you want to register the Configuration Hub server and the MQTT Client. In the<Fully Qualified Domain Name> format.
    SERVER PORT The port number of the Proficy Authentication server to which you want to register the Configuration Hub server and the MQTT Client.
    Use Configuration Hub Authentication Credentials for Proficy Authentication Select this check box if you entered the same credentials (Client ID and Client Secret) for both Configuration Hub and Proficy Authentication during installation.
    CLIENT ID The Client ID of the Proficy Authentication server.
    CLIENT SECRET The Client secret of the Proficy Authentication server.
  5. If the root certificates of the Configuration Hub server and the Proficy Authentication server are not trusted:
    • Click Not trusted.

      The Certificate Details page appears.

    • Click Trust.

    The Root certificate Import successful message appears.

  6. To test the server connection, click Test Server Connection.

    If the connection to the Configuration Hub or the Proficy Authentication server is successful, you will receive a success dialog. If your connection is unsuccessful, retry to connect to another valid Configuration Hub or Proficy Authentication server.

  7. Click Register.

    The Configuration Hub Server registration success message appears.

    By default, the ch_admin user is created with a password the same as the Proficy Authentication secret, and the required Group Membership is assigned to the ch_admin user to access the MQTT Client. For more information, refer to Manage Identity Providers, Groups, and Users.

  8. Click OK.
    Note:
    • You can return to the Configuration Hub Server Registration window to modify the field entries in the Configuration Hub and Proficy Authentication sections, and then click Update to apply the changes.
    • If you uninstall and then reinstall the MQTT Client application, you must register your MQTT Client with Configuration Hub again (See step 1 to step 8).
  9. Double-click the Configuration Hub desktop shortcut.
  10. Enter the following credentials, and then click SIGN IN.
    • User Identifier: The default user id for first time users, that is, ch_admin.
    • Password: The password you created during Proficy Authentication installation.

    The Configuration Hub user interface window appears.

    This indicates that you have the MQTT and Proficy Authentication server plugins or connections in the Configuration Hub server. You can see the PLUG-IN ALIAS NAME that you entered during the registration. Now you can configure your MQTT Client and communicate with IoT devices.
    Note:
    • If you are not licensed to use the MQTT Client application, the MQTT Client application will run in Demo mode for two hours, after which the following message will be displayed in the Configuration Hub user interface.

      Demo license expired. Restart the MQTTClient service.

      When you try to load the MQTT plugin connection, the following error message will be displayed.

      Service unavailable. Restart the MqttClient service.

    • Perform the following steps to start the MQTT Client Service:
      • Right-click the Windows Start menu, and then click Computer Management.
      • Click Services and Applications and then, double-click Services.
      • Click GE MQTT Client Service and click Start to start the GE MQTT Client Service.
    • After you start the GE MQTT Client Service, the Configuration Hub user interface will display the Demo license expiry time.