PI Web API silent installation

A silent.ini file is included in the PI Web API setup kit wrapper. To invoke a silent installation, enter:

setup.exe -f silent.ini

Note: Before executing the silent install command, you must specify the OmfAssetServerName, OmfAssetDatabaseName and OmfDataArchiveName options in the configuration JSON file. For more information, see Options for CONFIG_FILE parameter.

If you make no changes in the silent.ini file, default installation setting values are used to install PI Web API. You can customize the silent.ini file to specify the installation folder, the application data folder, and other configuration settings with the following parameters:

ADDLOCAL

ADDLOCAL values consist of a comma-separated list and cannot contain any spaces. To install all features, use ADDLOCAL=ALL.

Example:

ADDLOCAL=ALL

You can specify the following features using the ADDLOCAL property:

Note: The Open Messaging Format (OMF) feature is installed by default during silent installation. If you want to exclude the OMF feature, you must explicitly specify all features you require in the ADDLOCAL parameter.

ADMINS_GROUP_TYPE

Specify the type of local group for PI Web API Administrators:

• Use Default to indicate that you wish to create and use a PI Web API Admins group as the administrator group for PI Web API.

• Use Existing to indicate that you wish to use an existing Windows group as the administrator group for PI Web API.

Example:

ADMINS_GROUP_TYPE=Existing

ADMINS_GROUP_NAME

You specify an existing administrator group when ADMINS_GROUP_TYPE is set to Existing.

Example:

ADMINS_GROUP_NAME="PI Web API Admins"

INSTALLATION_DIR

Enter the full path to the directory where you want PI Web API to be installed, in the following format:

INSTALLATION_DIR="c:\path\to\installation\folder"

If there are no spaces in the path, you can omit the double quotes around the path.

DATA_DIR

Enter the full path to the directory where you want PI Web API application data to be installed, in the following format:

DATA_DIR="d:\path\to\data\folder"

If there are no spaces in the path, you can omit the double quotes around the path. We recommend you create the PI Web API application data folder on a non-system drive (if one is available). The size of the application folder could grow to be very large, and it might cause Windows performance degradation if the application folder resides on the system drive.

CONFIG_FILE

You can change other installation settings, such as the configuration asset server name, the configuration instance name, or the listen port number from the default values. The configuration file normally created by the installation is called InstallationConfig.json, which can be found in the PI Web API installation folder.

CONFIG_FILE="c:\path\to\config\file"

Refer to Options for CONFIG_FILE parameter for details on the content of the configuration file.

Example of the PI Web API section of a default silent.ini file

; PI Web API

; CUSTOMIZATION OPTIONS for PI Web API install -->
;  ADMINS_GROUP_TYPE  Following list of types are possible

;     Default   Creates and uses "PI Web API Admins" group as the administrator's group for PI Web API.

;     Existing  Uses an existing local group as the administrator’s group for PI Web API.
;  ADMINS_GROUP_NAME  Specifies the name of the local group when ADMINS_GROUP_TYPE is specified as "Existing".
;  CONFIG_FILE  Specifies the path of the configuration file to be used in the configuration process immediately.

;  DATA_DIR  Specifies the path of the application data folder for PI Web API.
;  INSTALLATION_DIR  Specifies the path of the installation folder for PI Web API.

7 = /qn REBOOT=Suppress

If you want to, for example, specify a different installation directory and a configuration file, modify the example to the following:

; PI Web API

; CUSTOMIZATION OPTIONS for PI Web API install -->
;  ADMINS_GROUP_TYPE  Following list of types are possible

;     Default   Creates and uses "PI Web API Admins" group as the administrator's group for PI Web API.

;     Existing  Uses an existing local group as the administrator’s group for PI Web API.
;  ADMINS_GROUP_NAME  Specifies the name of the local group when ADMINS_GROUP_TYPE is specified as "Existing".
;  CONFIG_FILE  Specifies the path of the configuration file to be used in the configuration process immediately.

;  DATA_DIR  Specifies the path of the application data folder for PI Web API.
;  INSTALLATION_DIR  Specifies the path of the installation folder for PI Web API.

7 = /qn REBOOT=Suppress INSTALLATION_DIR="C:\PIWebAPI\" CONFIG_FILE="C:\MyConfigFile.json"