Install Web-Based Clients at a Command Prompt

Before you begin

  1. Install the Historian server. During the installation, in the Proficy Authentication page, select the Yes, I want to use Web-based Clients check box, and provide the Proficy Authentication server name and port number.
  2. If you want to use Web-based Clients in a cluster environment, ensure that your network is enabled for multicast traffic, and set up high availability on each node in the cluster.

About this task

This topic describes how to install Web-based Clients at a command prompt. You can also install Web-based Clients using an installer.

During the installation, you can choose to use Web-based Clients in a cluster environment, thus ensuring high availability of connection to the Historian server using the client applications.

Procedure

  1. If you want to install Web-based Clients with the default values, run the following command: 
    install.exe /quiet AdminClientSecret=<password> ConfigHubClientSecret=<password>
  2. If you want to modify the default values, run the following command: 
    install.exe /quiet AdminClientSecret=<password> ConfigHubClientSecret=<password> <parameter>=<value>
    The following table describes the installation parameters.
    Parameter Description Default Value
    PublicPort Port for https protocol communication used by Web-based Clients. Ensure that the value for this parameter matches the one you specify while installing the Historian server. In addition:
    • If you will install Operations Hub later on the same machine, the value that you provide for this parameter is populated while installing Operations Hub.
    • If you have already installed Operations Hub on the same machine, provide the same value that you provided while installing Operations Hub.
    		443
    UAAHttpPort Port for http protocol communication used by the Proficy Authentication service. 9480
    UAADatabasePort Port for the Proficy Authentication database. 9432
    HistorianHttpPort Port for the http protocol communication used by Web-based Clients. 8070
    HistorianDatabasePort Port for the PostgreSQL Historian database. 8432
    EmbeddedWebServerAlternativeNames The fully qualified domain names 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.
    For example, 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.
    • If you have already installed Operations Hub on the same machine, enter the same value that you have provided while installing Operations Hub.
    • If you will install Operations Hub later on the same machine, the value that you provide for this parameter is used while installing Operations Hub.
    • You must add the IP address and alias name in the hosts file located at C:\Windows\System32\drivers\etc. The IP address that you add must be a static or fixed IP address.

      Format: <IP address> <alias name>

      Example: 1.2.3.4 myservername

    • FQDN is not supported for Configuration Hub.
    AdminClientId The client ID to connect to the Proficy Authentication service.
    AdminClientSecret The password to connect to the Proficy Authentication service. The password must satisfy the following conditions:
    • Must not contain only numbers.
    • Must not begin or end with a special character.
    • Must not contain curly braces.
    If the password does not satisfy these conditions, the installation may be successful, but Web-based Clients will not work.
    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 Proficy Authentication 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 Proficy Authentication user, and then create the corresponding Windows user, using the uaa_config_tool utility.

    		 Not applicable
    UseExternalUaa Identifies whether you want to use an external Proficy Authentication service (that is, a Proficy Authentication instance already installed by an external application such as Operations Hub). If you want to use external Proficy Authentication, enter 1. 0
    ActiveUaaBaseUrl The base URL to connect to external Proficy Authentication. A value is required only if you want to connect to an external Proficy Authentication service. Enter a value in the following format: https://<Proficy Authentication server machine name>:<public https port number>. By default, the port number is 443.
    DoConfigHubNeedToInstall Identifies whether you want to install Configuration Hub as part of the web-based clients. You can enter 1 to install, or 0 to not install Configuration Hub as you may already have it installed. 1
    ConfigHubContainerPort The web server (httpd) port that you want to use for Configuration Hub. 5000
    ContainerPort The port for the Configuration Hub container. 4890
    ConfigHubAdminPort The port for the administration service for Configuration Hub. 4920
    ConfigHubInstallFolder The installation folder for Configuration Hub. C:\Program Files (x86)\GE\ConfigurationHub
    UseExternalConfigHub Identifies whether you want to use Configuration Hub installed with iFIX or on a remote machine. If you want to use an external Configuration Hub, enter 1. 0
    ExternalConfigHubMachineName 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.
    ConfigHubClientID The username to connect to Configuration Hub. The value that you enter can contain:
    • All English alphanumeric characters (ABCDEFGHIJKLMNOPQRSTUVXYZ abcdefghijklmnopqrstuvwxyz_0123456789)
    • The following special characters: ><:~!@#$%^&*?|
    		 admin
    ConfigHubClientSecret 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: ><:~!@#$%^&*?|
    IsClusterNode Indicates whether you want to install Web-based Clients in a cluster environment. If you want to install Web-based Clients in a cluster environment, enter 1. This is not applicable if you are upgrading Web-based Clients. 0
    PostgresBaseDir The folder in the shared drive that you want to use for Historian database if you want to add the Web-based Clients server to a cluster. C:\ProgramData\GE\Operations Hub
    ClusterFQDN Enter the client access point of the role for which you have added the resources while setting up high availability.
    MulticastAddress The common IP address that all the nodes in the cluster can use. Enter a value between 224.0.0.0 and 239.255.255.255 (or a hostname whose IP address falls in this range). 228.0.0.4
    HistorianClusterMembershipPort The common port number that all the nodes in the cluster can use. This port number, in conjunction with the multicast address, is used to create the cluster. 45564
    HistorianClusterReceiverPort The multicast port number that you want to use for incoming Historian data. 4000
    DataPath The path to the log files. C:\ProgramData\HistorianWebBasedClientsLogs
    DestinationHistorian The name of the destination Historian server.
    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.
    To install Web-based Clients with local Proficy Authentication and local Configuration Hub, run the following command: 
    Install.exe /quiet PublicPort=443 UAAHttpPort=9480 UAADatabasePort=9432 HistorianHttpPort=8070 
HistorianDatabasePort=8432 AdminClientId=admin AdminClientSecret=abc 
ConfigHubContainerPort=5000 ContainerPort=4890 ConfigHubInstallFolder="C:\Program Files (x86)\GE\ConfigurationHub" 
ConfigHubClientID=admin ConfigHubClientSecret=xyz 
DataPath="C:\ProgramData\HistorianWebBasedClientsLogs"
    To install Web-based Clients with local UAA and an external Configuration Hub, run the following command: 
    Install.exe /quiet PublicPort=443 UAAHttpPort=9480 UAADatabasePort=9432 HistorianHttpPort=8070 
HistorianDatabasePort=8432 AdminClientId=admin AdminClientSecret=abc 
UseExternalConfigHub=1 ExternalConfigHubMachineName=abc123 ConfigHubClientID=admin
ConfigHubClientSecret=xyz DataPath="C:\ProgramData\HistorianWebBasedClientsLogs"
    To install Web-based Clients with external Proficy Authentication and a local Configuration Hub, run the following command: 
    Install.exe /quiet PublicPort=443 UAAHttpPort=9480 UAADatabasePort=9432 HistorianHttpPort=8070 
HistorianDatabasePort=8432 AdminClientId=admin AdminClientSecret=abc UseExternalUaa=1 ActiveUaaBaseUrl=https://<extrenal UAA machine hostname>:443 
ConfigHubContainerPort=5000 ContainerPort=4890 ConfigHubInstallFolder="C:\Program Files (x86)\GE\ConfigurationHub" 
ConfigHubClientID=admin ConfigHubClientSecret=xyz 
DataPath="C:\ProgramData\HistorianWebBasedClientsLogs"
    To install Web-based Clients in a cluster environment with local Proficy Authentication and local Configuration Hub, run the following command:
    Install.exe /quiet PublicPort=443 UAAHttpPort=9480 UAADatabasePort=9432 
HistorianHttpPort=8070 HistorianDatabasePort=8432 AdminClientId=admin AdminClientSecret=abc ConfigHubContainerPort=5000 
ContainerPort=4890 ConfigHubInstallFolder="C:\Program Files (x86)\GE\ConfigurationHub" 
ConfigHubClientId=admin ConfigHubClientSecret=xyz DataPath="C:\ProgramData\HistorianWebBasedClientsLogs" 
DestinationHistorian=<Historian server host name> IsClusterNode=1 
PostgresBaseDir="E:\pgsql" ClusterFQDN="cluster.domain.com" 
HistorianClusterMembershipPort=45564 HistorianClusterReceiverPort=4000 
UAAClusterMembershipPort=45565 UAAClusterReceiverPort=4005 MulticastAddress=228.0.0.4

Results

Web-based Clients are installed in the following folder: <installation drive>:\Program Files\GE, and the following registry paths are created:
  • HKEY_LOCAL_MACHINE\SOFTWARE\GE Digital
  • HKEY_LOCAL_MACHINE\SOFTWARE\GE

What to do next

If you want to use Configuration Hub installed using other products such as iFIX, Plant Applications, and so on, set up authentication to point to the Proficy Authentication instance.