Install the Historian Server Using the Installer

Before you begin

  • Set up the Historian environment.
  • If you want to install web-based clients and view Historian license information on Configuration Hub, you must provide the Configuration Hub and Proficy Authentication server details during installation. Therefore, ensure that you have already set up Proficy Authentication in Configuration Hub. For more information on setting up Proficy Authentication in Configuration Hub, refer to https://www.ge.com/digital/documentation/confighub/version2023/t_authentication_setup.html.
  • If you are changing the role of a Historian server that was previously a distributed/mirror server to any other configuration (single-server or mirror primary server), you must first uninstall Historian.
  • If you are installing a distributed/mirror server, use the same configuration, license key, installation drive, Proficy Authentication instance, and domain as the primary server.

About this task

This topic describes how to install the Historian server using the installer.

You can also install it at a command prompt.

Procedure

  1. Log in as an administrator to the machine on which you want to install the Historian server.
  2. Run the InstallLauncher.exe file.
  3. Select Install Historian Server.
    The welcome page appears.
  4. Select Next.
    The license agreement appears.
  5. Select the Accept check box, and then select Next.
    The Where do you want to install Historian? page appears.
  6. If needed, change the default installation drive of the Historian server, and then select Next.
    The Override the default Historian data Path? page appears.
  7. If needed, change the default folder of the log files, and then select Next. If you want to include the Historian server in a cluster, enter the path to the shared folder of the cluster.
    The Register with Configuration Hub page appears.
  8. Select the Use existing Proficy Authentication and Configuration Hub Instance check box, and provide values as described in the following table.
    This step is needed only in the following cases:
    • The Historian Server and the Web-based clients will be on two different machines.
    • You already installed Proficy Authentication and Configuration Hub, and you want to use the Historian Web-based clients and view the Historian license information on Configuration Hub.

      If you do not select the Use existing Proficy Authentication and Configuration Hub Instance during the installation, to use the Historian Web-based clients and view the Historian license information on Configuration Hub, you must use the Proficy Authentication Tool to register with Proficy Authentication and Configuration Hub servers.

      If you do not have Proficy Authentication and Configuration Hub installed, and you intend to use the Historian Web-based clients and view the Historian license information on Configuration Hub, you can install them while installing the Web-based clients.

    Note: Proficy Authentication is required for user authentication. It provides identity-based security for applications and APIs. It supports open standards for authentication and authorization, including Oauth2.
    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.
    Proficy Authentication 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.
    Proficy Authentication Admin Client Id The client ID to connect to the Proficy Authentication service.
    Proficy Authentication Admin Client Secret The password to connect to the Proficy Authentication service.
    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.
    Test Connection Option to test the status of the connection with external Proficy Authentication server.
    Note: If you change the Proficy Authentication server for Web-based Clients later, you must also change the Proficy Authentication server for the Historian server. This can be done using the Proficy Authentication Configuration Tool located at <Install Drive>:\Program Files\Proficy\Proficy Historian\x64\Server without the need to install the Historian server again. Alternatively, you can search for the Proficy Authentication Tool in the Windows search bar and open it.
  9. Select Next.
    The Historian Security Groups page appears.

    Using Historian security groups provides an added layer of control over access to your Historian system.

    By default, the option to create Historian security groups is not selected.

  10. If you want the installer to create Historian security groups, select the corresponding check box, and then select Next.
    The Choose the type of install you want to perform page appears.
  11. Select the type of the Historian server that you want to install, and then select Next.
    • Historian Single Server: This is for a stand-alone Historian system, which contains only one Historian server. This type of system is suitable for a small-scale Historian setup.
    • Historian Mirror Primary Server: This is for a horizontally scalable Historian system, which contains multiple Historian servers, all of which are connected to one another. Installing this server will allow you to add machines and distributed/mirror servers to this system.
    • Historian Distributed/Mirror Node: This is for a horizontally scalable Historian system. Installing this server will allow you to add this node to a primary server.
    The Historian Server Certificate-based Security page appears.
  12. If you want to enable certificate-based security (MTLS-based security), leave the Enable Certificate-based Security check box selected, and then enter Root Certificate Password.
    Note: Ensure to use the same password to create MTLS (client) certificates. For more information on creating MTLS (client) certificates, refer to Generate MTLS certificate.
    For more information on certificate-based security, refer to overview of the Certificate-based Security in Historian.
    Warning: If you do not select the Enable Certificate-based Security check box during the installation, you must generate the root certificates manually, as described in the Manually Install Certificates for Historian section. However, this is not recommended.
  13. Select Next.
    The You are ready to install page appears.
  14. Select Install.
    The installation begins.
  15. After the installation, when you are asked to reboot your system, select Yes.
    The Historian server is installed on your machine in the following folder: <installation drive>:\Program Files\Proficy\Proficy Historian\x64\Server, and the following registry path is created: HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc.\iHistorian\Services.
    In addition, the following components are installed:
    • The RemoteCollectorConfigurator utility: A command-line tool, which allows you to manage collectors remotely. By default, it is located in the C:\Program Files\GE Digital\NonWebCollectorInstantiationTool folder. For instructions on using this utility, refer to Overview of Remote Collector Management.
    • The Proficy Authentication Configuration tool: A utility that allows you to specify the Proficy Authentication server details to match with the Proficy Authentication server used by Web-based Clients. By default, it is located in the C:\Program Files\Proficy\Proficy Historian\x64\Server folder. For instructions on using this tool, refer to Register with Configuration Hub.