Install Single-Server Historian at a Command Prompt

Before you begin

  • If you are changing the role of a Historian server that was previously a distributed node in any other configuration (single-server or mirror primary server), you must first uninstall Historian.

About this task

This topic describes how to install single-server Historian at a command prompt. You can also install single-server Historian using the installer.

After you install Historian at a command prompt, you can choose to generate a template XML file, which contains the installation parameters and the values that you have provided. You can use this XML file for subsequent installations. Similarly, you can use a template XML file instead of providing command-line arguments.

Procedure

  1. Open Command Prompt, and navigate to the <DVD drive>:\Historian folder (for example, E:\Historian).
  2. Run the following command: 
    install.exe <argument>=<value> <flag> HistorianCmd=StandAlone
    The following table provides a list of arguments that you must enter.
    Argument Description
    RootDrive The drive letter where the Historian server binary files will be installed.
    DataPath The disk path where the Historian data files will be stored.
    HistAdministratorPassword The password for the built-in administrator account.
    ActiveUaaBaseUrl The URL to connect to UAA to allow Web-based Clients to access Historian. Only if you want to use Web-based Clients, this parameter is required for user authentication. UAA provides identity-based security for applications and APIs. It supports open standards for authentication and authorization, including Oauth2.

    UAA details are required if you want to use Web-based Clients.

    By default, the local hostname and the port number of 443 are considered. If the UAA service is on the same machine on which you are installing the Historian server, you can accept the default value. If, however, the UAA service is on a different machine or uses a different port number, replace those values in the URL as follows:

    https://<local host name>:<port number>/uaa
    where:
    • <UAA server> is the name of the machine on which UAA is installed. If the machine uses a fully qualified domain name (FQDN), provide the FQDN.
    • <port number> is the one that you have specified for the public https port in the TCP Port Assignments page during Web-based Clients installation.
    Note: You can install a UAA service using Operations Hub or Historian Web-based Clients. You can provide the URL of an existing UAA instance. Or, if a UAA service is not available, you can install it during Web-based Clients installation. In that case, provide the server name where UAA is installed.
    CreateHistorianSecurityGroups Indicates whether you want the installer to create Historian security groups.

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

    Enter true or false. If you enter true:
    • You must add a Windows user to the appropriate group (for example, add an administrative user to the iH Security Admins group). Only then you can configure this server.
    • If the Historian server and collectors are installed on the same machine, you can skip this step; by default, the machine name of the local Historian server is considered. If, however, they are installed on different machines, you must provide the credentials of the Windows user who can access the Historian server machine. In addition, if security groups are available, add the user to the appropriate group (for example, add an administrative user to the iH Security Admins group). Only then you can access Web-based Clients without LDAP.
    For more information, refer to Implementing Historian Security.
    The following table provides a list of flags that you can use.
    Flag Description
    [-q], [-quiet], [-s], [-silent] Use any of these flags for a silent installation. The installation will then happen in the background (without a UI).
    [-passive] Use this flag for a passive installation. The progress of the installation then appears on your screen.
    /t Use this flag to generate the template file, which will contain all the installation arguments and the values that you have provided for each of them. You can then use this file for subsequent installations.

    By default, this file is named Template_Historian.xml, and it is placed in the temp folder, defined by the%temp% environment variable. If, however, you want to save the file in another folder as well, enter: /t TemplateOutputDirectory=<path>
    /c TemplateInputFile=<path> Use this flag to use a template file (instead of providing command-line arguments). However, if you do provide command-line arguments as well, they take precedence over the values in the template.
    Single-Server Historian is installed on your machine. 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 About Installing and Managing Collectors Remotely.
    • The UAA Configuration tool: A utility that allows you to specify the UAA server details to match with the UAA 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 Change the UAA Server.

What to do next

While installing the Historian server, if you have allowed the installer to create Historian security groups, create a local Windows user with the format <Web-based Clients server name>.admin, and add the user to the ihSecurityAdmins group.

This user will log in to Web-based Clients.

Alternatively, you can create UAA users in an external UAA and map their security groups. For information, refer to About UAA Groups.

Depending on whether the Historian server will use local or domain security groups, select the appropriate option in Historian Administrator.