Deploy AVEVA ERM Application Server Components

The Install-Server-Upgrade.ps1 PowerShell script, located in the InstallTools\InstallServerUpgrade directory, manages both new installations and upgrades of AVEVA Enterprise Resource Management server components.

The script includes built-in PowerShell help. Running the Get-Help .\Installl-Server-Upgrade.ps1 -Full command displays a full description of the script, including available parameters and usage examples.

By default, the script installs or upgrades all AVEVA Enterprise Resource Management components, including:

• Application Server

• API

• API-REST

• Supplier Portal

• Import Service

• Multi Consumer Service

• Database

• Customizable Reports

Individual components are excluded by specifying one or more No component Install switches.

The script requires administrator privileges to run locally. When deploying to a remote machine, the UserName and Password parameters are supplied together with the ComputerName parameter.

Parameters

For new installations, the parameters Environment, DbServer, DbUser, and DbPassword are required.

For upgrades, only the Environment parameter is required; the values for DbServer, DbUser, DbPassword, LogLevel, and LogPath are resolved automatically from the existing installation, with the option to override them by supplying explicit command-line parameters.

[string]Environment (Mandatory): The name of the environment, for example, Prod or Test. The log file paths contains the name. Only valid characters for path and file names in Windows are allowed. Max length is 45 characters.

[string]SourcePath: The path to installation source root folder, and exists in file system. If not given, SourcePath will be derived from the location of the script. Parameter is not supported in configuration file.

[string]ConfigPath: The path to the configuration file (not the folder containing the file), is required to exist in file system. If not given, ConfigPath is derived from the root path of the environment (RootPath used in Setup-Environment.ps1), default value is C:\AVEVA\ServerUpgrade.config. Parameter is not supported in the configuration file.

[string]DataRootPath: The path to the root data folder, used as base for other folders defined in the FOLDER database table. When the parameter is given, the value is updated for Root in the FOLDER table. The parameter is ignored if NoDataFolderInstall is given.

[string]ComputerName: The computer on which to install the server, API, API-REST, Supplier Portal, Import Service, Multi Consumer Service and plugins. If the parameter given, Username and Password are mandatory and requires administrator privileges on ComputerName. The parameter is not supported in configuration file.

[string]Username: The username used to install on ComputerName or look up info on AppServer, required in format DOMAIN\user and have administrator privileges on ComputerName or AppServer. The parameters Username and Password are dependent, so either both of the parameters are given or none of the parameters are given. The parameter is not supported in configuration file.

[string]Password: The password for given Username. Parameters Username and Password are dependent, so either both are given or none are given. The parameter is not supported in configuration file.

[string]LogPath: The path to log folder, default value is C:\ProgramData\AvevaErm\Logs. The folder is only created if the folder does not exist.

[string]LogLevel: The level of logging to perform, valid values are Full (default) and Warning. For heavily loaded environments, set the parameter to Warning to improve performance.

[string]ConnectionName: A logical database connection name is set in web.config (is shown in client), and the default value is 'DbServer:DbUser'.

[string]CustomConnectionString: A custom database connection string is set in the connectionStrings.config file. If it is not provided, the existing connection string remains unchanged. The setting overrides the CreateConnectionString parameter.

[string]AppServer: The application server running the main AVEVA Enterprise Resource Management site, used for configuring other components, only needed if all components are not located on same server (scenario for Supplier Portal). If the parameter is given, Username and Password are mandatory and require administrator privileges on the AppServer.

[string]DbServer (Mandatory for new installations): The Oracle database SID name.

[string]DbUser (Mandatory for new installations): The Oracle database schema user name.

[string]DbPassword (Mandatory for new installations): The Oracle database schema user password.

[switch]CreateConfigFile: If available, a configuration file is be created or updated at ConfigPath based on the given parameters. The parameter is not supported in configuration file.

[switch]NoServerInstall: If available, application server is not installed. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]NoApiInstall: If available, the API is not installed. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]NoApiRestInstall: If available, the API-REST is not installed. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]NoSupplierPortalInstall: If available, the Supplier Portal is not installed. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]NoImportServiceInstall: If available, the import service is not installed. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]NoMultiConsumerServiceInstall: If available, the multi consumer service is not installed. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]NoDbInstall: If available, the database is not installed. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]NoReportsInstall: If available, the customizable reports are not installed. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]NoDataFolderInstall: If available, the data folder is not installed. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]NoHelpInstall: If available, the help files are not installed. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]PluginsInstall: If available, the plugins are installed. This behaviour is opposite than other install parameters. In the configuration file, use true or false as the value. An empty value is considered false.

[switch]Verbose: If available, the script generates a lot of status information in the console along the installation process, which is useful to find errors. If omitted, the script does not output anything unless an error occurs.