Run Message Bridge Configuration Utility

Before you begin

You must have installed the Plant Applications Web Client before you run the MessageBridge Configuration utility.

About this task

You must run the utility to update the Kafka details in the Message Bridge configuration.

Procedure

  1. On the Plant Applications Server node, from the Windows Start menu, expand Proficy.
  2. From the list, select Message Bridge Configuration.
    The Message Bridge Configurationwindow appears to enter the Plant Applications Database Server details.

  3. In the Message Bridge Configuration tab, enter the Plant Applications Database credentials as described in the following table.
    Note: The Message Bridge Configuration utility prompts to enter the Plant Applications Database connection details only for the first time you access the utility. Once the connection is established, the utility automaitically fetches the database details for the next time you access the utility.
    Credential Description
    Server name Enter the server name where the Plant Applications database is installed in the format HOST_NAME\INSTANCE. Where HOST_NAME is the host name (either a fully qualified domain name or IP address, of the server) and INSTANCE is the instance of the server used by the database.
    Note: If there is no instance for the server, you can enter HOSTNAME as the server name. Localhost is not an acceptable value for HOSTNAME.
    Database Enter the name of the Plant Applications database that you want to connect with the Plant Applications Web Client.
    Port Optional: Enter the number of the port that the instance uses to listen for client connections.
    Note: The default port is 1433.
    Username Enter the user name that has permissions to access the database you entered in the Database box. By default, the user name appears as sa.
    Password Enter the password for the user name you entered in the Username box.
  4. Select Validate to validate the database connection.
    If the database connection is successfully validated, the Next button is enabled.
  5. Select Next.
    You will be prompted to enter the Plant Applications Message Bridge configuration details.

  6. In the Message Bridge Configuration tab, enter the credentials to access the Kafka server as described in the following table.
    Credential Description
    Kafka ServerName Enter the host name of the Kafka server.
    Note: Instead of IP address, it is recommended to use the Kafka host name (computer name).
    Kafka Port Enter the Kafka port number.
    Note: The default port number is 9093.
    • Enterprise Installation: The default port number is always 9093.
    • Standard Installation: The port number is available in the server.properties file located at <Installation_directory>\Kafka\config. For example, C:\Kafka\config\server.properties.
  7. Select Validate to validate the Kafka Server connection.
    If the connection is successfully validated, enter the Plant Applications Administrator User details as described in the following table.
    Credential Description
    User Name Enter the user name for an administrator account in Plant Applications.
    Password Enter the password for the user name you entered in the User Name box.
    Validate Select Validate to validate the Plant Applications Administrator credentials.
  8. Once the Plant Applications Administrator User credentials are validated, select Apply.
    The entered Message Bridge configuration details are applied and the message bridge service is restarted.

Update Message Bridge User Credentials

About this task

Use this tab only to update the Message Bridge credentials if you have modified the Plant Applications user credentials.

Procedure

In the Update Message Bridge User Credentials tab, enter the Plant Applications Administrator user credentials for the Message Bridge service configuration as described below.

Credential Description
User Name Enter the user name for an administrator account in Plant Applications.
Password Enter the password for the user name you entered in the User Name box.
Update Select to update the Plant Applications Administrator credentials for Message Bridge service .