Difference between revisions of "Silent Installation in QPR UI"

From Mea Wiki
Jump to navigation Jump to search
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
There is the '''silent installation''' option available for QPR UI, in which the installation is done in command line instead of the [[Installing QPR UI|installation wizard]]. Silent installation allows to fully automate QPR UI installation.
+
There is the [https://techterms.com/definition/silent_install silent installation] option available for QPR UI, in which the installation is done in command line instead of the [[QPR_UI_Windows_Installer|installation wizard]]. Silent installation allows to fully automate QPR UI installation.
 +
 
 +
==Silent installation procedure==
 +
# Download QPR UI installation package (link is available in this wiki's mainpage).
 +
# Store the installation package to '''C:\temp\''' (this is an example location; you may store it to different location).
 +
# Construct your silent installation command by using the example command below and list of available parameters.
 +
# Run the silent installation command by opening an elevated command prompt (open Windows '''Start Menu''', type '''cmd''', right-click '''Command Prompt''', and select '''Run as administrator'''). Paste the command to the command line and press enter.
 +
# Check that QPR UI has been installed correctly. Check also the installation log file for errors.
  
 
==Silent installation command==
 
==Silent installation command==
 
Silent installation command has the following syntax:
 
Silent installation command has the following syntax:
 
<pre>
 
<pre>
[InstallerExePath] /s /v"/qn /Lv \"[InstallerLogFilePath]\" parametername1=parametervalue1 parametername2=parametervalue2 parametername3=parametervalue3"
+
[InstallerExePath] /s /v"/qn /Lv \"[InstallerLogFilePath]\" parametername1=parametervalue1 parametername2=parametervalue2 ... parameternameN=parametervalueN"
 
</pre>
 
</pre>
  
Number of parameters is not restricted.
+
Example command:
 
+
<pre>
==Silent installation procedure==
+
C:\temp\QPR_UI.exe /s /v"/qn /Lv \"C:\temp\MDBInstallLog.txt\" INSTALLDIR=\"C:\Program Files\QPR Software Plc\QPR UI\" GLASSFISHDIR=\"C:\Program Files\QPR Software Plc\QPR UI\Glassfish\" IS_SQLSERVER_SERVER=localhost IS_SQLSERVER_USERNAME=myusername IS_SQLSERVER_PASSWORD=mypassword IS_SQLSERVER_DATABASE=QPREntice IS_SQLSERVER_AUTHENTICATION=1 MEAWSURL=http://localhost/metrics/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/ PAWSURL=http://localhost/current/MainService.svc/webHttp/ SSOS=WAS,http://localhost/metrics/Portal/QPR.Isapi.dll;PA,http://localhost/current/MainService.svc/webHttp/; WS,http://localhost/metrics/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/ "
# Download QPR UI installation package (link is available in this wiki's mainpage).
+
</pre>
# Store the installation package to '''C:\temp\''' (this is an example location; you may stored it to different location).
 
# Construct your silent installation command by using the example command below and list of available parameters.
 
# Test the silent installation command by opening command line (open Windows '''Start Menu''' and type '''cmd'''). Paste the command to the command line and press enter.
 
# Check that QPR UI has been installed correctly. Check also the installation log file for errors.
 
  
 
==Silent installation parameters==
 
==Silent installation parameters==
 
Following parameters are available:
 
Following parameters are available:
* '''INSTALLDIR''': QPR UI installation directory. It's usually '''C:\Program Files\QPR Software Plc\QPR UI\'''.
+
{| class="wikitable"
* '''GLASSFISHDIR''': Glassfish installation directory. It's usually '''C:\Program Files\QPR Software Plc\QPR UI\Glassfish\'''.
+
!'''Parameter name'''
* '''DBSETUP''': Use value '''ExistingDB''' to define that an existing database is used, or '''NewDB''' for a new database. This corresponds to the [[Installing QPR UI|installation wizard]] page 4 setting.
+
!'''Description'''
* '''IS_SQLSERVER_SERVER''': SQL Server hostname.
+
|-
* '''IS_SQLSERVER_DATABASE''': QPR UI database name in the SQL Server. By default it's '''QPREntice''' (the name reflects the internal technology used by QPR Software).
+
||INSTALLDIR
* '''USERDOMAIN''': Domain name for database user account. Used in Windows authentication.
+
||QPR UI installation directory, usually '''C:\Program Files\QPR Software Plc\QPR UI\'''.
* '''IS_SQLSERVER_USERNAME''': SQL Server username for database authentication.
+
|-
* '''IS_SQLSERVER_PASSWORD''': SQL Server user password for database authentication.
+
||GFADMINPORT
* '''IS_SQLSERVER_AUTHENTICATION''': Use value '''1''' for SQL Server authentication and '''0''' for Windows authentication. This corresponds to the [[Installing QPR UI|installation wizard]] page 5 setting.  
+
||GlassFish Server Administration Console port. When this setting is not defined, the standard port 4848 is used. Changing the GlassFish Server Administration Console port should only be done, if the standard port cannot be used.
* '''MEAWSURL''': QPR Suite Web Service location.
+
|-
* '''PAWSURL''': QPR ProcessAnalyzer Web Service location.
+
||GLASSFISHDIR
* '''SSOS''': [[Common QPR Authentication]] parameters that are stored to AUTHENTICATION_SERVICES setting in the QPR UI database.
+
||Glassfish installation directory, usually '''C:\Program Files\QPR Software Plc\QPR UI\Glassfish\'''.
* '''GLASSFISHDOMAIN'''
+
|-
* '''GLASSFISHSERVERNAME'''
+
||IS_SQLSERVER_SERVER
* '''DBINSTANCENAME'''
+
||SQL Server hostname and optionally port in the format '''host:port'''. The port can be left out by using format '''host'''. When the port is left out, the SQL Server default port 1433 is used.
* '''SKIPDBVALIDATION''': Use value '''1''' for SQL Server authentication and '''0''' for Windows authentication
+
|-
* '''SAML_AUTOMATIC_LOGIN''', '''SAML_CONSUMER_URL''', '''SAML_METADATA_URL''', '''SAML_REDIRECT_URL''', '''SAML_SERVER_ENTITY_IDENTIFIER''', '''SAML_SIGNING_CERTIFICATE''', '''SAML_USER_ID_ATTRIBUTE''': [[Federated Authentication in QPR UI|Federated authentication]] parameters that are stored in the QPR UI database with same setting names as are these silent installtion parameter names.
+
||IS_SQLSERVER_DATABASE
 
+
||QPR UI database name in the SQL Server. By default it is '''QPREntice''' (the name reflects the internal technology used by QPR Software).
==Example command==
+
|-
<pre>C:\temp\QPRMobileDashboard.exe /s /v"/qn /Lv \"C:\temp\MDBInstallLog.txt\" INSTALLDIR=\"C:\Program Files\QPR Software Plc\QPR UI\" GLASSFISHDIR=\"C:\Program Files\QPR Software Plc\QPR UI\Glassfish\" IS_SQLSERVER_USERNAME=user IS_SQLSERVER_PASSWORD=pass IS_SQLSERVER_DATABASE=QPREntice DBSETUP=ExistingDB IS_SQLSERVER_AUTHENTICATION=1 IS_SQLSERVER_SERVER=localhost MEAWSURL=http://localhost/metrics/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/ PAWSURL=http://localhost/current/MainService.svc/webHttp/ SSOS=WAS,http://localhost/metrics/Portal/QPR.Isapi.dll;PA,http://localhost/current/MainService.svc/webHttp/; WS,http://localhost/metrics/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/ "</pre>
+
||USERDOMAIN
 +
||Domain name for database user account. Used in Windows authentication. This setting is stored to QPR UI GlassFish server.
 +
|-
 +
||IS_SQLSERVER_USERNAME
 +
||SQL Server username for database authentication. This setting is stored to QPR UI GlassFish server.
 +
|-
 +
||IS_SQLSERVER_PASSWORD
 +
||SQL Server user password for database authentication. This setting is stored to QPR UI GlassFish server.  
 +
|-
 +
||IS_SQLSERVER_AUTHENTICATION
 +
||Use value '''1''' for SQL Server authentication and '''0''' for Windows authentication. This corresponds to the [[QPR UI Windows Installer|installation wizard]] page 5 setting. This setting is needed when configuring QPR UI GlassFish server.
 +
|-
 +
||MEAWSURL
 +
||QPR Suite Web Service location. This parameter is stored to QPR UI database configuration table as setting name MEA_SERVICE_LOCATION.
 +
|-
 +
||PAWSURL
 +
||QPR ProcessAnalyzer Web Service location. This parameter is stored to QPR UI database configuration table as setting name PA_SERVICE_LOCATION.
 +
|-
 +
||SSOS
 +
||[[Common QPR Authentication]] settings. This parameter is stored to QPR UI database configuration table as setting name AUTHENTICATION_SERVICES.
 +
|-
 +
||SKIPDBVALIDATION
 +
||Use value '''1''' to skip the database connection validation during the installation. Use value '''0''' to enable the database connection validation. If this setting is left out, the database connection validation is enabled. Database connection validation may be disabled in special cases, when the database connection validation fails for some reason, although the database connection from GlassFish will eventually work.
 +
|-
 +
||UPGRADERESULT
 +
||This parameter defines if you are doing an upgrade installation. The value of this parameter should be '''1''' when an upgrade installation is made.
 +
|-
 +
||SAML_AUTOMATIC_LOGIN,<br />SAML_CONSUMER_URL,<br />SAML_METADATA_URL,<br />SAML_REDIRECT_URL,<br />SAML_SERVER_ENTITY_IDENTIFIER,<br />SAML_SIGNING_CERTIFICATE,<br />SAML_USER_ID_ATTRIBUTE
 +
||[[Federated Authentication in QPR UI|Federated authentication]] parameters that are stored in the QPR UI database with same setting names as these silent installation parameter names. Note that other federated authentication related database settings cannot be set by the silent installation.
 +
|}
  
 
[[Category: QPR UI]]
 
[[Category: QPR UI]]

Latest revision as of 15:01, 15 January 2020

There is the silent installation option available for QPR UI, in which the installation is done in command line instead of the installation wizard. Silent installation allows to fully automate QPR UI installation.

Silent installation procedure

  1. Download QPR UI installation package (link is available in this wiki's mainpage).
  2. Store the installation package to C:\temp\ (this is an example location; you may store it to different location).
  3. Construct your silent installation command by using the example command below and list of available parameters.
  4. Run the silent installation command by opening an elevated command prompt (open Windows Start Menu, type cmd, right-click Command Prompt, and select Run as administrator). Paste the command to the command line and press enter.
  5. Check that QPR UI has been installed correctly. Check also the installation log file for errors.

Silent installation command

Silent installation command has the following syntax:

[InstallerExePath] /s /v"/qn /Lv \"[InstallerLogFilePath]\" parametername1=parametervalue1 parametername2=parametervalue2 ... parameternameN=parametervalueN"

Example command:

C:\temp\QPR_UI.exe /s /v"/qn /Lv \"C:\temp\MDBInstallLog.txt\" INSTALLDIR=\"C:\Program Files\QPR Software Plc\QPR UI\" GLASSFISHDIR=\"C:\Program Files\QPR Software Plc\QPR UI\Glassfish\" IS_SQLSERVER_SERVER=localhost IS_SQLSERVER_USERNAME=myusername IS_SQLSERVER_PASSWORD=mypassword IS_SQLSERVER_DATABASE=QPREntice IS_SQLSERVER_AUTHENTICATION=1 MEAWSURL=http://localhost/metrics/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/ PAWSURL=http://localhost/current/MainService.svc/webHttp/ SSOS=WAS,http://localhost/metrics/Portal/QPR.Isapi.dll;PA,http://localhost/current/MainService.svc/webHttp/; WS,http://localhost/metrics/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/ "

Silent installation parameters

Following parameters are available:

Parameter name Description
INSTALLDIR QPR UI installation directory, usually C:\Program Files\QPR Software Plc\QPR UI\.
GFADMINPORT GlassFish Server Administration Console port. When this setting is not defined, the standard port 4848 is used. Changing the GlassFish Server Administration Console port should only be done, if the standard port cannot be used.
GLASSFISHDIR Glassfish installation directory, usually C:\Program Files\QPR Software Plc\QPR UI\Glassfish\.
IS_SQLSERVER_SERVER SQL Server hostname and optionally port in the format host:port. The port can be left out by using format host. When the port is left out, the SQL Server default port 1433 is used.
IS_SQLSERVER_DATABASE QPR UI database name in the SQL Server. By default it is QPREntice (the name reflects the internal technology used by QPR Software).
USERDOMAIN Domain name for database user account. Used in Windows authentication. This setting is stored to QPR UI GlassFish server.
IS_SQLSERVER_USERNAME SQL Server username for database authentication. This setting is stored to QPR UI GlassFish server.
IS_SQLSERVER_PASSWORD SQL Server user password for database authentication. This setting is stored to QPR UI GlassFish server.
IS_SQLSERVER_AUTHENTICATION Use value 1 for SQL Server authentication and 0 for Windows authentication. This corresponds to the installation wizard page 5 setting. This setting is needed when configuring QPR UI GlassFish server.
MEAWSURL QPR Suite Web Service location. This parameter is stored to QPR UI database configuration table as setting name MEA_SERVICE_LOCATION.
PAWSURL QPR ProcessAnalyzer Web Service location. This parameter is stored to QPR UI database configuration table as setting name PA_SERVICE_LOCATION.
SSOS Common QPR Authentication settings. This parameter is stored to QPR UI database configuration table as setting name AUTHENTICATION_SERVICES.
SKIPDBVALIDATION Use value 1 to skip the database connection validation during the installation. Use value 0 to enable the database connection validation. If this setting is left out, the database connection validation is enabled. Database connection validation may be disabled in special cases, when the database connection validation fails for some reason, although the database connection from GlassFish will eventually work.
UPGRADERESULT This parameter defines if you are doing an upgrade installation. The value of this parameter should be 1 when an upgrade installation is made.
SAML_AUTOMATIC_LOGIN,
SAML_CONSUMER_URL,
SAML_METADATA_URL,
SAML_REDIRECT_URL,
SAML_SERVER_ENTITY_IDENTIFIER,
SAML_SIGNING_CERTIFICATE,
SAML_USER_ID_ATTRIBUTE
Federated authentication parameters that are stored in the QPR UI database with same setting names as these silent installation parameter names. Note that other federated authentication related database settings cannot be set by the silent installation.