Performing a silent installation - Data360_Analyze - 3.12

Data360 Analyze Server Installation

Product type
Software
Portfolio
Verify
Product family
Data360
Product
Data360 Analyze
Version
3.12
Language
English
Product name
Data360 Analyze
Title
Data360 Analyze Server Installation
Copyright
2024
First publish date
2016
ft:lastEdition
2024-07-04
ft:lastPublication
2024-07-04T12:57:13.885585

During a typical installation, users are required to select or confirm options, such as where the application should be installed. In a silent installation, these options are selected automatically and the installer runs without requiring any user input.

This topic is aimed at Administrators who want to run a silent (unattended) installation to silently install or upgrade Data360 Analyze on user machines, applying predefined settings, without the need for user interaction.

Configuring the varfile

Before performing a silent installation, you must first configure a response.varfile with the settings that you want to apply to your user's machines. You can use a response.varfile from an existing installation, as follows:

  1. Locate the response.varfile in the .install4j folder of the existing installation directory. For example:

    C:\Program Files\Data360 Analyze\.install4j\response.varfile

  2. Make a copy of this file and save it in the location where you want to run the silent installation.
  3. Edit the parameter values as required. The following table gives examples of how to configure the parameters.
Note: Upgrading from all versions lower than Data360 Analyze 3.2.1 may result in an install4j error. This produces an install4jError* file, but does not fail the silent upgrade. This is fixed from Data360 Analyze 3.2.2 onwards.

Common varfile variables

You can configure the varfile variables according to your installation needs. The examples in the table below show the Data360 Analyze default values. In the following examples, <<user>> should be replaced with the name of the user who will use Data360 Analyze.

Tip: For parameters that end with $<data type>, the parameter value must be in the specified data type. For example, $Boolean indicates that you must enter a Boolean value, i.e. add =true or =false at the end of the parameter string. If a data type is not specified, a string value is required.
Parameter Description

isPostgres

Defaults to true unless the default Database Provider is not Postgres.

For example: isPostgres=true

laeCustDataDirectory

Specifies the location of the Data Directory. This is the location where your data files and the Postgres Database are stored.

For example: laeCustDataDirectory=C\:\\Users\\<<user>>\\Data360 Analyze/data-7731

laeCustDataDirectoryForwardSlash

Specifies the location of the Data Directory. This is the location where your data files and the Postgres Database are stored.

For example: laeCustDataDirectoryForwardSlash=C\:/Users/<<user>>/Data360 Analyze/data-7731

laeCustSiteDirectory

Specifies the location of the Site Configuration Directory. This is the location where your customer-specific files are stored, including your license file, configuration files and application logs.

For example: laeCustSiteDirectory=C\:\\Users\\<<user>>\\Data360 Analyze/site-7731

laeCustSiteDirectoryForwardSlash

Specifies the location of the Site Configuration Directory. This is the location where your customer-specific files are stored, including your license file, configuration files and application logs.

For example: laeCustSiteDirectoryForwardSlash=C\:/Users/<<user>>/Data360 Analyze/site-7731

laeDataMethod

Defaults to file.

Note: It is not recommended to change this parameter.

laeHome

Specifies the Data360 Analyze home directory location. This should be the same as the installation directory, as set in the sys.installationDir parameter.

For example: laeHome=C\:/Program Files/Data360 Analyze

laeSecurityStoreCheckbox$Boolean

Specifies whether or not to store the security store password.

For example: laeSecurityStoreCheckbox$Boolean=true

laeSecurityStorePassword

Specifies the security store password.

For example: laeSecurityStorePassword=password where password is replaced with the password string.

laeSecurityStorePasswordConfirm

Specifies the security store password.

Note: The value specified in this parameter must match the value specified in the laeSecurityStorePassword parameter.

laeServerHostname

Defaults to *UNDEFINED*.

Note: It is not recommended to change this parameter.

laeServerLicenseFile

Specifies the path to your Data360 Analyze license file. For example:

laeServerLicenseFile=C\:\\Program Files\\Data360 Analyze\\docs\\license\\core_3_License.lic

laeServerPort$Long

Specifies the Data360 Analyze Server port.

For example: laeServerPort$Long=7731

laeWebAppDbPort$Long

Specifies the Postgres Server port.

For example: laeWebAppDbPort$Long=5432

laeWebAppHome

This should be the same as the installation directory, as set in the sys.installationDir parameter.

For example: laeWebAppHome=C\:/Program Files/Data360 Analyze

laeWebAppLaeServerName

Specifies the name of your domain.

For example: laeWebAppLaeServerName=localhost

laeWebAppStartPort$Long

Sets the Data360 Analyze Tomcat Server HTTP port.

For example: laeWebAppStartPort$Long=8080

laeWebAppStopPort$Long

Sets the Data360 Analyze Tomcat Server stop port.

For example: laeWebAppStopPort$Long=8089

laeWebKeyStorePath

Specifies the location for storing the web app .jks file.

For example:

laeWebKeyStorePath=C\:/Users/<<user>>/Data360 Analyze/site-7731/keystores

restoreFromBackUp$Boolean

To restore to a backup file, set this parameter to true.

Or, to perform a fresh installation, set this parameter to false.

For example: restoreFromBackUp$Boolean=false

Note: The backup / restore facility can only be used to restore your system to a previously known state on the same version. For example, if you are installing Data360 Analyze 3.6.0, you can only restore to a backup file that was created on a 3.6.0 installation.

storeExecutionLogs$Boolean

Specifies whether to retain temporary execution data.

For example: storeExecutionLogs$Boolean=true

executionLogsLocation

Specifies the location to save temporary execution data when storeExecutionLogs$Boolean is set to true

For example: executionLogsLocation=C\:\\Users\\<<user>>\\Documents

sys.adminRights$Boolean

Indicates whether Administrator rights are required.

For example: sys.adminRights$Boolean=true

Note: It is recommended that you always set this parameter to true.

sys.component.installLaeServer$Boolean

Defaults to true.

Note: It is not recommended to change this parameter.

sys.component.installLaeWebApplications$Boolean

Defaults to true.

Note: It is not recommended to change this parameter.

sys.component.installLaeWebContainerDatabase$Boolean

Defaults to true.

Note: It is not recommended to change this parameter.

sys.component.installLaeWebContainerServer$Boolean

Defaults to true.

Note: It is not recommended to change this parameter.

sys.installationDir

Specifies the Data360 Analyze installation directory.

For example, the following will install Data360 Analyze into the C:\ProgramFiles directory:

sys.installationDir=C\:\\Program Files\\Data360 Analyze

Note: The laeWebAppHome and laeHome parameter values should match the value set on this parameter.

sys.languageId

Sets the language for Data360 Analyze. Currently only English is supported.

For example: sys.languageId=en

sys.programGroupDisabled$Boolean

Indicates whether an entry should be added to the Windows Start menu.

To add an entry to the Windows Start menu, set this property to false:

sys.programGroupDisabled$Boolean=false

If this property is set to true, no entry will be added to the Windows Start menu.

Tip: If this parameter is not present, no entry will be added.

sys.programGroupName

Specifies the name of the group found under the Windows Start menu.

For example: sys.programGroupName=Data360 Analyze3.6

Example varfile

Server varfile

Running a silent installation on Windows

  1. Run Windows Command Prompt as an Administrator.
  2. Change the directory to point to the location of the Data360 Analyze installer and varfile.
  3. Type the following command, where <release_number> is the Data360 Analyze release version:

    Data360 Analyze_<release_number>-Server-windows-x86-64.exe -q -Dinstall4j.suppressUnattendedReboot=true -varfile <location of varfile>/response.varfile

  4. If you want to configure Data360 Analyze to use execution sandboxing features, run the laeConfig executionContainers enable command as detailed in the system administration section of the help.

Running a silent installation on Linux

  1. Change the directory to point to the location of the Data360 Analyze installer and varfile.
  2. Run the following command, where <release_number> is the Data360 Analyze release version:

    Data360 Analyze_<release_number>-linux-x86-64.sh -q -Dinstall4j.suppressUnattendedReboot=true -varfile <location of varfile>/response.varfile

  3. If you want to configure Data360 Analyze to use execution sandboxing features, run the laeConfig executionContainers enable command as detailed in the system administration section of the help.

Performing a silent uninstallation

  1. If Analyze has been configured as a multi-user installation then the following steps need to be taken before uninstalling:
  2. Navigate to yourData360 Analyze installation directory.
  3. As the <myInstall> user, run the following command: sudo bin/grantInstallerPermissions.sh
  4. At the prompt enter the <MyInstall> user name
  5. Locate the response.varfile in the .install4j folder of the installation directory. This is the same varfile that is used for installation.
  6. Copy the response.varfile to a different location.
  7. Add the uninstall parameters listed below to the response.varfile, configuring the values with the settings that you want to apply to your user's machines.
  8. Change the directory to point to the location of the Data360 Analyze installation.
  9. Run the following command, referencing the location of the varfile that you copied in step two:

    uninstall.exe -q -varfile <location of varfile>/response.varfile

Parameter Description

deleteDataDirectory$Boolean

Specifies whether to delete the local site directory.

Set this parameter to true to delete the site directory:

deleteDataDirectory$Boolean=true

deleteExecutionLogs$Boolean

Specifies whether to delete temporary execution data.

Set this parameter to true to delete temporary execution data:

deleteExecutionLogs$Boolean=true

removeBackups$Boolean

Specifies whether to delete backup files.

Set this parameter to true to delete backup files:

removeBackups$Boolean=true