Silent File concepts

The purpose of using a silent file is to quickly duplicate an installation on multiple machines without running the Installer and entering the same parameters over and over again.

The Installer's silent mode takes these values from existing or generated silent files. Before you can use this procedure, you must have the necessary silent files available. You can generate these files by installing a product at least once by completing the dialogs up until the point of clicking Install.

Creation

A silent file can be created:

  • After an installation
  • or
  • After completing the Installer dialogs up until the point of clicking Install

The Installer's SilentFile directory contains the properties file (Install_Axway_Installer_V4.9.0 properties) and the product property files you might need to install. You must not modify anything in this file except the InstallDir, SynchronyLogicalName and list of IncludeFiles. The product property files cannot be used outside of the main Installer file.

Location

The silent file is created in:

<install directory>\SilentFile\<InstallationDateTime_Action>\<Install_ProductShortName_V<Version>.properties

Where:

  • InstallationDateTime corresponds to Year_Month_Day_Hour_Minute_Second.
  • Action corresponds to the action done, for example if you performed an install or configure.

Variables

A silent file is a collection of parameters in the form of key-value pairs, each on one line. The variable stores the name of the parameter (it is the key) and the value stores the other string.

The structure of a variable inside the silent file is:

Variable = Value
Note   The extra spaces around the variable are trimmed.

Some special types of variables can be identified.

Variable.Property = Value

Variable.Default = <LinkToAnotherVariable> | Value

A variable property signifies or provides some additional information about that specific variable (commonly known as metadata; it might be used for validation purposes, for parsing purposes, etc.).

For example, information on the creation date:

CreationDate = 13-02-2010

CreationDate.Format = dd-MM-yyyy

Specify the creation date of the silent file (currently, the date the silent file was last modified by the build tool - effectively the date of the build used by the current kit) and below, the format used to parse this date variable (the format used by the date variable).

If a value is missing, the Installer takes the default value instead. If the default value links to another variable, the link is replaced by the value of the linked variable (this is called a feedback link).

Encrypted variables

For security reasons, some variables (passwords) are encrypted in the silent case. This means the Format property contains the used encryption algorithm (default is plain).

  • If you want to change the value of an encrypted variable, you must use the silent file editor tool.
  • You can disable the encryption of the variable by deleting the Format property.

Environment variables

If you need to deploy a product installation on several machines, with only a few changes to make on the installation parameters, use the same silent file. In the silent file you can replace the unwanted parameters with environment variables that you defined on your machine before the installation. You can then use these variables instead of the Variable Values.

You can use environment variables when installing or configuring in Silent mode (limited to Silent mode only.)

  • In Windows: %env_var%
  • UNIX and Linux: ${env_var}

There are restrictions for certain variables and therefore you cannot use an environment variable for the following parameters:

  • Component properties
  • Variable properties
  • Installer variables (in the file Install_Axway_Installer_VX.Y.Z.properties), except InstallDir, SynchronyLogicalName

Example

You can use any text editor or the Silent File Editor to modify variables in the silent file.

An example of changing the installation directory:

InstDir = C:\<install directory>\

InstDir.Type = String

 

InstDir2 = C:\<install directory>\Composer

InstDir2.default = <InstDir>/Composer

Related Links