Performing a silent installation - Data360_Analyze - 3.12

Data360 Analyze Desktop Installation

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

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 for both the Local User and All Users installation options. The Local User option installs the application for use by a single user of the target computer. In the following Local User installation examples, <<user>> should be replaced with the username of the user who will use Data360 Analyze. The All Users option enables all users who log onto the target computer to use Data360 Analyze.
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.

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

createDesktopLinkAction$Boolean

Specifies whether to display a Data360 Analyze desktop icon.

For example: createDesktopLinkAction$Boolean=true

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/

laeLocalDataDir

Specifies the location of the Data360 Analyze site directory.

For example, for the Local User installation option:

laeLocalDataDir=C\:/Users/<<user>>/AppData/Local//site

where <<user>> is replaced with the username.

Or for the All Users installation option:

laeLocalDataDir=C\:/ProgramData//site

laeServerLicenseFile

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

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

laeServerPort$Long

Specifies the Data360 Analyze Server port.

For example: laeServerPort$Long=7731

laeWebAppHome

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

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

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, for the Local User installation option:

laeWebKeyStorePath=C\:/Users/<<user>>/AppData/Local//site/data

where <<user>> is replaced with the username.

Or for the All Users installation option:

laeWebKeyStorePath=C\:/ProgramData//site/data

localUserDataInstallDir

Sets the location of the Data360 Analyze data directory.

For example, for the Local User installation option:

localUserDataInstallDir=C\:\\Users\\<<user>>\\AppData\\Local

where <<user>> is replaced with the username.

Or for the All Users installation option:

localUserDataInstallDir=C\:\\ProgramData

Tip: The data directory is where backup files and temp files are stored.

localUserInstall$Boolean

For the Local User installation option, set this parameter to true:

localUserInstall$Boolean=true

For the All Users installation option, set this parameter to false:

localUserInstall$Boolean=false

restoreFromBackUp$Boolean

If you want to restore your system to an earlier state, please contact support.

To perform a fresh installation, set this parameter to false:

restoreFromBackUp$Boolean=false

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

If you are performing a backup, you also need the to specify where the backup file is located in the backupFile property.

 

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.4.3, you can only restore to a backup file that was created on a 3.4.3 installation.

backupFile

Specifies the location of the backup file, for example:

backupFile=C\:\\temp\\backups\\backup-2018_11_02__100359_323_Desktop.lxp

selectedInstallType$Integer

For the Local User installation option, set this parameter to 0:

selectedInstallType$Integer=0

For the All Users installation option, set this parameter to 1:

selectedInstallType$Integer=1

startData360 AnalyzeOnLogon$Boolean

Specifies whether to start Data360 Analyze on logon.

For example: startData360 AnalyzeOnLogon$Boolean=true

Tip: It is recommended that you set this parameter to true if your users will be using the Automation Services (scheduling) feature.

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.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\\

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.programGroupAllUsers$Boolean

Indicates whether to create a Data360 Analyze desktop icon for all users if you are using the All Users installation option.

For example: sys.programGroupAllUsers$Boolean=false

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=

Example Local User varfile

Example All Users varfile

Running a silent installation

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

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

Performing a silent uninstallation

  1. Locate the response.varfile in the .install4j folder of the installation directory. This is the same varfile that is used for installation.
  2. Copy the response.varfile to a different location.
  3. Add the following uninstall parameters to the response.varfile, configuring the values with the settings that you want to apply to your user's machines:
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

  1. Run Windows Command Prompt as an Administrator.
  2. Change the directory to point to the location of the installation.
  3. Type the following command, referencing the location of the varfile that you copied in step two:

     

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