Use Cases

The Common components include Configuration Hub and Proficy Authentication elements. Install these components from the MQTT Client 2024 Proficy installer welcome screen once on your machine within the same network. The Common components serve as shared centralized services for the MQTT Client product.

The following scenarios guide you in choosing the appropriate registration methods for MQTT Client installed before or after upgrading common components to version 2024 or higher.

Use case 1

First time Install: MQTT Client and Common components (Version 2024 or higher)
Scenario Tasks to Perform
Common components installed before MQTT Client installation. Perform Install Time Registration for MQTT Client during the MQTT Client installation.
Note:
If you skip providing Configuration Hub and Proficy Authentication details during Install Time Registration method, then perform Central Registration for MQTT Client method after MQTT Client installation.
Common components installed after MQTT Client installation. Perform Central Registration for MQTT Client after MQTT Client installation.

Use case 2

MQTT Client Upgrade from Version 2023 to 2024 or higher version
Scenario Tasks to Perform
Common components already upgraded to version 2024 or higher. Perform Install Time Registration for MQTT Client during the MQTT Client upgrade.
Note:
If you skip providing Configuration Hub and Proficy Authentication details during the Install Time Registration method, then perform Central Registration for MQTT Client method after the MQTT Client upgrade.
Common components are installed later with version 2024 or higher. Perform Central Registration for MQTT Client after upgrading MQTT Client.
Common components installed but not upgraded to version 2024 or higher.
Important:
Upgrade common components to version 2024 or higher.

Use case 3

MQTT Client Unregistration
Scenario Tasks to Perform
MQTT Client registered with version 2024 common components or higher. Unregister MQTT Client centrally from Configuration Hub.
MQTT Client of version 2023 (registered conventionally) to common components of version 2024 or higher. Unregister MQTT Client conventionally.

Use case 4

Pre-2024 MQTT Client Registration
Scenario Tasks to Perform
MQTT Client registration and unregistration before version 2024 with common components of version 2024 or higher. Follow the conventional process for registration and unregistration.

Use case 5

Migration of Common Components (Version 2024 or later) Post-Registration
Scenario Tasks to Perform
If you migrate to a new Proficy Authentication server.
  1. Unregister MQTT Client plugin.
  2. Unregister Configuration Hub with the old Proficy Authentication server and register with the new Proficy Authentication server.
  3. Perform Steps 13 to 19 in the Central Registration for MQTT Client task to provide the credentials for the new Proficy Authentication server.
  4. Register the MQTT Client plugin using the Configuration Hub Administration plugin.
If you migrate to a new Configuration Hub server.
  1. Unregister MQTT Client plugin from the old Configuration Hub server.
  2. Register the new Configuration Hub server with the existing Proficy Authentication server.
  3. Register the MQTT Client plugin using the Configuration Hub Administration plugin.
If you migrate both the new Configuration Hub server and the Proficy Authentication server.
  1. Unregister MQTT Client plugin from the old Configuration Hub server.
  2. Register the new Configuration Hub server with the new Proficy Authentication server.
  3. Perform Steps 13 to 19 in the Central Registration for MQTT Client task to provide the credentials for the new Proficy Authentication server.
  4. Register the MQTT Client plugin using the new Configuration Hub's Administration plugin.