Install Web-Based Clients Using the Installer

About this task

This topic describes how to install Web-based Clients using a GUI-based installer. You can also install Web-based Clients using the command line.

Procedure

  1. Run the InstallLauncher.exe file.
  2. Select Install Web-based Clients.
    The welcome page appears.
  3. Select Next.
    The license agreement appears.
  4. Select the Accept check box, and then select Next.
    The TCP port assignments page appears.

  5. As needed, change the values for TCP port assignments as described in the following table, and then select Next.
    Field Description
    Public https port Port for https protocol communication used by Web-based Clients. The default value is 443.
    UAA http port Port for http protocol communication used by the UAA service. The default value is 9480.
    UAA database port Port for the UAA database. The default value is 9432.
    Historian http port Port for the http protocol communication used by Web-based Clients. The default value is 8070.
    Historian database port Port for the PostgreSQL Historian database. The default value is 8432.
    UAA Idp config service port Port for the Configuration Hub identity provider service. The default value is 7010.
    UAA security app port Port for the UAA Configuration tool. The default value is 7010.
    The Fully Qualified Domain Name(s) page appears.

  6. In the FDQNs box, enter the fully qualified domain names and then, select Next.
    This enables you to access Historian web applications remotely. You can use it to access the Web Admin console using alias names. Enter the values separated by commas.
    To access the Web Admin console using any of the following URLs, enter Test.abc.ge.com,localhost,127.0.0.1,aliasName
    Important: Do not enter a space between the values.
    The User Account and Authentication Service page appears, allowing you to choose whether you want to install UAA along with Web-based Clients installation or use an existing UAA.
    • If you want to install UAA, clear the Use External UAA check box.
    • If you want to use an existing UAA, select the Use External UAA check box.


  7. If you want to install UAA, enter the Admin client secret, re-enter the secret, and then select Next.
    The admin client secret must satisfy the following conditions:
    • Must not contain only numbers.
    • Must not begin or end with a special character.
    • Must not contain curly braces.
    Note: The format of username for Historian Web-based Clients is <host name>.admin, where <host name> is the machine on which Web-based Clients are installed. And, the default client ID is admin. Both the host name and client ID are case-sensitive.

    If, however, the UAA server hostname is long, resulting in a username longer than 20 characters, Windows does not allow you to create the user. In that case, you can create a UAA user, and then create the corresponding Windows user, using the uaa_config_tool utility.

  8. Alternatively, if you want to use an external UAA service (that is, a UAA instance already installed by an external application such as Operations Hub):
    1. Select the Use External UAA check box.
      The fields for the external UAA service appear.

    2. Enter values as described in the following table.
      Field Description
      UAA Base URL Enter the URL of the external UAA server in the following format: https://<UAA server name>:<port number>, where <UAA server name> is the FQDN or hostname of the machine on which UAA is installed. By default, the port number is 443.
      Note: Do not enter a trailing slash character.
      Admin Client ID Enter the client name that you provided while installing the external UAA. The default value is admin.
      Admin client secret Enter the client secret that you provided while installing the external UAA.
    3. Select Test Connection.
      The results of the connection test appear. You cannot proceed until the connection is successful.
    4. Select Next.
    The Configuration Hub Installation page appears, allowing you to choose whether you want to install Configuration Hub along with Web-based Clients or an existing Configuration Hub, which is installed with iFIX.

    Configuration Hub allows you to add and manage a collector instance remotely. For more information, refer to About Configuration Hub.



  9. If you want to install Configuration Hub, ensure that the Use Existing Configuration Hub check box is cleared, and then provide values as described in the following table.
    Field Description
    Install Folder If needed, modify the installation folder for Configuration Hub.
    Server Port If needed, modify the port number that you want to use for the web server (NGINX). The default value is 5000.
    Container Port If needed, modify the port number for the Configuration Hub container. The default value is 4890.
    Client ID Enter the username to connect to Configuration Hub. The default value is admin. The value that you enter can contain:
    • All English alphanumeric characters (ABCDEFGHIJKLMNOPQRSTUVXYZ abcdefghijklmnopqrstuvwxyz_0123456789)
    • The following special characters: ><:~!@#$%^&*?|
    Client Secret Enter the password to connect to Configuration Hub. The value that you enter can contain:
    • Must contain at least eight characters.
    • All English alphanumeric characters (ABCDEFGHIJKLMNOPQRSTUVXYZ abcdefghijklmnopqrstuvwxyz_0123456789)
    • The following special characters: ><:~!@#$%^&*?|
    Re-enter secret Re-enter the password to connect to Configuration Hub.
  10. Alternatively, if you want to use an existing Configuration Hub:
    1. Select the Use External Configuration Hub check box.
      The fields for external Configuration Hub appear.

    2. Provide values as described in the following table.
      Field Description
      Server Name Enter 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.
      Server Port If needed, modify the port number that you want to use for the web server (NGINX). The default value is 5000.
      Client ID If needed, modify the username to connect to Configuration Hub. The default value is admin.
      Client Secret Enter the password to connect to Configuration Hub.
    3. Select Test Connection.
      The results of the connection test appear. You cannot proceed until the connection is successful.
    4. Select Next.
    The default installation drive appears.

  11. If needed, change the installation drive for Web-based Clients, and then select Next.
    The Customize Log Files Locations page appears.

  12. If needed, change the location for log files, and then select Next.
    The destination Historian server page appears.

  13. Provide the name of the destination Historian server to which Web-based Clients are connected by default. When you login to Configuration Hub, the default system will point to this server.
    Note: Provide the name of either Historian single-server or mirror primary server because the systems in Configuration Hub will be either a stand-alone system or a horizontally scalable system.
  14. select Next.
    Note: If you want to connect to a remote Historian server, you must disable the Enforce Strict Client Authentication and Enforce Strict Collector Authentication options using Historian Administrator in the remote server.
    A message appears, stating that you are ready to install Web-based Clients.
  15. Select Install. Restart your system if prompted to do so.
    The Web-based Clients installation begins.
  16. When you are prompted to reboot your machine, select Yes.

Results

Historian Web-based Clients are installed.