Transfer CFT 3.6 Users Guide Save PDF Selected topic Selected topic and subtopics All content Silent mode installation Silent mode enables you to perform an installation or configuration in a non-interactive mode. You do not have to enter any parameters in the GUI or console. To use this mode, you must install the product or run the installer program and perform configuration until just before you click Install. Then in your home installation directory you will have the silent file template you can use to duplicate installations on other machines. 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.8.0.properties) and the product property files you might need to install. You must not modify anything in this file except the InstallDir,InstallationLogicalName 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,InstallationLogicalName 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 Using silent mode To run the installer in silent mode, you need the following commands: UNIX: setup.sh –s <the absolute path to the installer Silent File> Windows: setup32.exe –s <the absolute path to the installer Silent File> setup64.exe –s <the absolute path to the installer Silent File> The installer's silent file is located in <install directory>/SilentFile/<DirectoryDate>/ after installation and is called Install_Axway_Installer_V<version>.properties. The Silent File directory contains the installer properties file (Install_Axway_Installer_V<version>.properties) and the product property files you might need to install. You should always call the Axway_Installer silent file from the command line no matter the number of products you want to install. You can add or delete products from the silent installation if necessary as long as they exist in the Silent File. Open the Axway_Installer properties file and scroll to the end. You will see a number of IncludeFiles specifying the number of products included for an installation. You must not modify anything else in this file except the InstallDir,InstallationLogicalName and list of IncludeFiles. The following related to the installation above is very important: You must use the absolute path to the silent file and not the relative one The command must point to the installer silent file and not the product silent file The product silent files installed in silent mode must be in the same directory as the installer silent file Install products silently in a directory with white spaces In Windows, the installer supports the silent installation in a folder, for example (c:\Program Files), with white spaces if: All products in the Silent File allow white spaces, regardless of the other products present in the installation package (which are not listed in the Silent File) The installer does not support installation in a folder with white spaces and the installation will stop if: At least one of the products in the Silent File does not allow white spaces, regardless of the other products present in the installation package (which are not listed in the Silent File) Configure product in silent mode To configure an installation in silent mode, you need the following commands: UNIX: configure.sh –s <the absolute path to the installer Silent File> Windows: configure32.exe –s <the absolute path to the installer Silent File> configure64.exe –s <the absolute path to the installer Silent File> Silent File Editor Use the Silent File Editor to modify variables in a silent file. It can be used from the command line or the GUI. The most common values that you replace when preparing a new installation using a silent file are the InstallDir and CommonDir variables. The value of these fields is used to concatenate other paths in the products silent file properties file. Location The Silent File Editor is in the installation directory in Tools/SilentFileEditor. Note Copying the Silent File Editor from the installation package is not supported because it uses binary files from the installer. Modifying a silent file using the command line To modify a silent file using the command line, run: In Windows: SilentFileEditor.bat In UNIX: SilentFileEditor.sh The parameters for the Silent File Editor are: The path to the silent file that you want to modify Three arguments in this format:The first argument is the name of the variable that you want to modify (for example, DB_ADMIN_PASSWORD). Each variable name given must exist in the silent fileThe second argument is the value that you want to assign to the variable given as the first argumentThe third argument is –c if the value is to be encrypted first and then saved in the silent file, or –u if the value does not need to be encrypted You can have more than one group of arguments as shown in the examples below. Example SilentFileEditor.bat SilentFilePath varName1 value1 –c/-u varName2 value2 –c/-u … varNameN valueN –c/-u Modifying a Silent File using the user interface Starting the GUI To start the Silent File Editor GUI, run SilentFileEditorGUI.bat or SilentFileEditorGUI.sh at <installation directory>\Tools\SilentFileEditor. Using the GUI The GUI displays the list of variables and values in the silent file. Use File > Open to open the silent file you want to edit. From the Tools menu you can: Encrypt Selected: Encrypts the Values selected with the AES128 algorithm Undo Selected: Undoes the changes made on the current selection Undo all changes: Undoes all changes made on the current selection Replace: Finds a variable and replaces it with the value you select. Inside of the Replace command there are other options: Replace all: Replaces all paths in all the variable values Find next: Goes to the next value occurrence and if you click Replace it replaces the value Encrypt: Encrypts the value in the Replace Value with field Once you have completed all the modifications, use File > Save to save the silent file, then File > Exit to quit the Silent File Editor UI. Related Links
Silent mode installation Silent mode enables you to perform an installation or configuration in a non-interactive mode. You do not have to enter any parameters in the GUI or console. To use this mode, you must install the product or run the installer program and perform configuration until just before you click Install. Then in your home installation directory you will have the silent file template you can use to duplicate installations on other machines. 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.8.0.properties) and the product property files you might need to install. You must not modify anything in this file except the InstallDir,InstallationLogicalName 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,InstallationLogicalName 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 Using silent mode To run the installer in silent mode, you need the following commands: UNIX: setup.sh –s <the absolute path to the installer Silent File> Windows: setup32.exe –s <the absolute path to the installer Silent File> setup64.exe –s <the absolute path to the installer Silent File> The installer's silent file is located in <install directory>/SilentFile/<DirectoryDate>/ after installation and is called Install_Axway_Installer_V<version>.properties. The Silent File directory contains the installer properties file (Install_Axway_Installer_V<version>.properties) and the product property files you might need to install. You should always call the Axway_Installer silent file from the command line no matter the number of products you want to install. You can add or delete products from the silent installation if necessary as long as they exist in the Silent File. Open the Axway_Installer properties file and scroll to the end. You will see a number of IncludeFiles specifying the number of products included for an installation. You must not modify anything else in this file except the InstallDir,InstallationLogicalName and list of IncludeFiles. The following related to the installation above is very important: You must use the absolute path to the silent file and not the relative one The command must point to the installer silent file and not the product silent file The product silent files installed in silent mode must be in the same directory as the installer silent file Install products silently in a directory with white spaces In Windows, the installer supports the silent installation in a folder, for example (c:\Program Files), with white spaces if: All products in the Silent File allow white spaces, regardless of the other products present in the installation package (which are not listed in the Silent File) The installer does not support installation in a folder with white spaces and the installation will stop if: At least one of the products in the Silent File does not allow white spaces, regardless of the other products present in the installation package (which are not listed in the Silent File) Configure product in silent mode To configure an installation in silent mode, you need the following commands: UNIX: configure.sh –s <the absolute path to the installer Silent File> Windows: configure32.exe –s <the absolute path to the installer Silent File> configure64.exe –s <the absolute path to the installer Silent File> Silent File Editor Use the Silent File Editor to modify variables in a silent file. It can be used from the command line or the GUI. The most common values that you replace when preparing a new installation using a silent file are the InstallDir and CommonDir variables. The value of these fields is used to concatenate other paths in the products silent file properties file. Location The Silent File Editor is in the installation directory in Tools/SilentFileEditor. Note Copying the Silent File Editor from the installation package is not supported because it uses binary files from the installer. Modifying a silent file using the command line To modify a silent file using the command line, run: In Windows: SilentFileEditor.bat In UNIX: SilentFileEditor.sh The parameters for the Silent File Editor are: The path to the silent file that you want to modify Three arguments in this format:The first argument is the name of the variable that you want to modify (for example, DB_ADMIN_PASSWORD). Each variable name given must exist in the silent fileThe second argument is the value that you want to assign to the variable given as the first argumentThe third argument is –c if the value is to be encrypted first and then saved in the silent file, or –u if the value does not need to be encrypted You can have more than one group of arguments as shown in the examples below. Example SilentFileEditor.bat SilentFilePath varName1 value1 –c/-u varName2 value2 –c/-u … varNameN valueN –c/-u Modifying a Silent File using the user interface Starting the GUI To start the Silent File Editor GUI, run SilentFileEditorGUI.bat or SilentFileEditorGUI.sh at <installation directory>\Tools\SilentFileEditor. Using the GUI The GUI displays the list of variables and values in the silent file. Use File > Open to open the silent file you want to edit. From the Tools menu you can: Encrypt Selected: Encrypts the Values selected with the AES128 algorithm Undo Selected: Undoes the changes made on the current selection Undo all changes: Undoes all changes made on the current selection Replace: Finds a variable and replaces it with the value you select. Inside of the Replace command there are other options: Replace all: Replaces all paths in all the variable values Find next: Goes to the next value occurrence and if you click Replace it replaces the value Encrypt: Encrypts the value in the Replace Value with field Once you have completed all the modifications, use File > Save to save the silent file, then File > Exit to quit the Silent File Editor UI.