Register with Configuration Hub

Before you begin

Ensure the following:

About this task

The Historian server and Web-based Clients must always point to the same Proficy Authentication server and Configuration Hub server. Only then you can access Web-based Clients (such as Configuration Hub, Trend Client, the Web Admin console, and REST APIs), and also view Historian license information on Configuration Hub. Therefore, you can use the Proficy Authentication Tool in the following cases:
  • If you changed the Proficy Authentication server used by Web-based Clients, the Historian server must point to the same Proficy Authentication and Configuration Hub servers.
  • If you did not select the Use existing Proficy Authentication and Configuration Hub Instance during the Historian Server, and now you want to register with the Proficy Authentication and Configuration Hub servers to use the Historian Web-based clients and view Historian license information on Configuration Hub.

This topic describes how to register the Historian Server with the Proficy Authentication server and Configuration Hub server without the need to reinstall it.

Procedure

  1. Access the UAAConfiguration.exe file. By default, it is located at <Install Drive>:\Program Files\Proficy\Proficy Historian\x64\Server.
    Alternatively, you can search for the Proficy Authentication Tool in the Windows search bar and open it.
    The Proficy Authentication Configuration tool window appears, displaying the Proficy Authentication server details that you specified while installing the Historian server. Also, it allows you to specify the Configuration Hub server details.
  2. In Proficy Authentication Server Details, provide the following details as described in the table below.
    Field Description
    Proficy Authentication server name Enter the name of the machine on which the Proficy Authentication server is installed. If the machine uses a fully qualified domain name (FQDN), provide the FQDN. By default, the local hostname is considered.
    Public https port Enter the port number used by the Proficy Authentication service. The default value is 443. Ensure that this port number matches the one on the TCP Port Assignments page during Web-based Clients installation.
    Admin Client Id The client ID to connect to the Proficy Authentication service.
    Admin Client Secret The password to connect to the Proficy Authentication service.
    Proficy Authentication Test Connection Option to test the status of the connection with external Proficy Authentication server.
  3. In Configuration Hub Server Details, provide the following details as described in the table below.
    Table 1.
    Field Description
    Configuration Hub server name The server name or the FQDN of the existing Configuration Hub server, as displayed in the address bar of the browser when you access Configuration Hub from the machine where Configuration Hub is installed.
    Configuration Hub Public https port The web server (https) port that you want to use for Configuration Hub. By default, it is 5000.
    Configuration Hub Test Connection Option to test the status of the connection with an existing Configuration Hub server.
  4. Select Configure.
    The Proficy Authentication server and Configuration Hub details are updated for the Historian server. The changes are reflected as soon as you refresh the browser in which you have opened any of the Web-based Clients components (such as Configuration Hub, the Web Admin console, Trend Client).
If testing the connection fails, try these steps:
  • Verify that you can ping the Proficy Authentication server. If you cannot ping the Proficy Authentication server, add the IP address and the server name in the hosts file located in C:\Windows\System32\drivers\etc.
  • Ensure that the following services are running on the Proficy Authentication server machine:
    • Proficy Operations Hub Httpd Reverse Proxy
    • Proficy Authentication Tomcat Web Server
    • All the GE Proficy Configuration Hub services
  • Verify that the Proficy Authentication server details provided during Web-based Clients installation match the ones you have specified in the Proficy Authentication Configuration tool.