Appendix A. Standard InstallAnywhere Variables
InstallAnywhere includes a number of default variables that store information essential to the installation process. The variables listed in Table A.1 are standard InstallAnywhere variables.
| Variable | Definition | Status |
|---|---|---|
| $/$ or $$ | These represent platform-specific file separators, which are most useful to refer to paths in a platform-independent manner. These have the same value as the Java property file separator. | This variable is read-only. |
| $;$ or $:$ | These represent platform-specific path separators. | This variable is read-only. |
| $CHOSEN_DIALOG_BUTTON$ | This variable is set to the return value as set by the end-user's choice in the Show Message Dialog Box action. If the end-user chooses button 1, this variable will be set to 1. | |
| $CHOSEN_INSTALL_BUNDLE_<#>$ | If Choose Product Features were enabled, there would be one variable for each feature as given in the variable $CHOSEN_INSTALL_BUNDLE_NUM$. This holds the short name of a feature to be installed. For example, if $CHOSEN_INSTALL_ BUNDLE_NUM$ equals 2, then there will be two variables of the form $CHOSEN_INSTALL_ BUNDLE_1$ and $CHOSEN_INSTALL_BUNDLE_2$ | This variable is read-only. |
| $CHOSEN_INSTALL_BUNDLE_LIST$ | This variable is a comma-separated list of all install features (short name) chosen for the installation. | This variable is read-only. |
| $CHOSEN_INSTALL_BUNDLE_NUM$ | If Choose Product Features were enabled, this variable would hold the total number of components (as a string) that the end-user had chosen to install. | This variable is read-only. |
| $CHOSEN_INSTALL_SET$ | If Choose Product Features were enabled, this variable would hold the short name of the feature chosen by the end-user. If the end-user were to choose to customize the install, this variable would hold the string CUSTOM. | This variable can be set before install time. |
| $CMD_LINE_ARGUMENTS$ | This is a special InstallAnywhere variable that is resolved by the launcher and not by the installer. If this variable is in the LAX property lax.command.line.args, it will resolve to the arguments sent to the LaunchAnywhere executable. | This variable is used by Launch-Anywhere. |
| $COMMA$ | This resolves to a comma (,). | This variable is read-only. |
| $DEVELOPER_DISK_SPACE_ADDITIONAL$ | This variable specifies an arbitrary additional value as a string representing the additional bytes that the Check Disk Space action will add to the computed required disk space for the installation. By default this variable has a value of 0. | Developers may set this variable. |
| $DOLLAR$ | This resolves to $. | This variable is read-only. |
| $EMPTY_STRING$ | This variable represents a null value; it is useful to determine whether or not any variables have been initialized. Variables that have not yet been initialized will have this as their value. | This variable is read-only. |
| $EXTRACTOR_DIR$ | This is the full path to the directory containing the self-extractor executable (from where it was launched). | This variable is read-only. |
| $EXTRACTOR_EXECUTABLE$ | This is the full path to the self-extractor executable (from where it was launched). | This variable is read-only. |
| $FREE_DISK_SPACE_BYTES$ | This is the free disk space available on the destination install volume. It is a string that represents the free bytes as determined by the Check Disk Space action. The variable gains its value immediately before the installation of any files or folders listed in the Install task. | This variable is read-only. |
| $IA_CLASSPATH$ | This is the classpath as specified in the InstallAnywhere designer environment. | Developers may set this variable in the advanced designer. |
| $IA_INSTALL_LOG$ | Setting this variable will generate an XML-formatted installation log to the $USER_ INSTALL_DIR$ location. This document will detail the installation along with warnings and errors. | This variable is read-only. |
| $INSTALL_LOG_DESTINATION$ | As the creation of the install log is the last action of an installation, this variable can be set anytime during pre-install, install, or post-install. The end-user can choose the installation log location. | Developers may set this variable. |
| $INSTALL_SUCCESS$ | This variable alerts the end-user if the installation completed successfully or failed. There are four possible values for this variable: SUCCESS, WARNING, NONFATAL_ERROR, and FATAL_ERROR. | This variable is read-only. |
| $INSTALLER_LAUNCH_DIR$ | This is a full path to the installer's self-extractor. | This variable is read-only. |
| $INSTALLER_LOCALE$ | This is the locale as a string (see java.util.Locale.toString()) that the end-user selected at the beginning of the installation. | This variable is read-only. |
| $INSTALLER_TEMP_DIR$ | This is the path to a temp directory for use by an installer. It will be deleted when its use is completed, assuming no items are in use. | This variable is read-only. |
| $INSTALLER_TITLE$ | This is the title of the installer and is displayed in the title bar. | You may set this variable. |
| $INSTALLER_UI$ | This resolves to the UI mode for the installer. | This variable is read-only, but devel-opers may set it at the start. |
| $JAVA_DOT_HOME$ | This is what the Java property java.home will report. | This variable is read-only. |
| $JAVA_EXECUTABLE$ | This is the path to the chosen Java executable. | This variable is read-only. |
| $JAVA_HOME$ | This is the root of the Java installation. | This variable is read-only. |
| $JDK_HOME$ | This is the path to the root of a Java Development Kit (JDK) installation. It is only set if the chosen VM is a JDK. If it is not, then this variable will have a blank value. | This variable is read-only. |
| $lax.nl.env.[ENVIRONMENT VARIABLE NAME]$ | [Windows and UNIX only]: Access any system environment variable (for example, access PATH via $lax.nl.env.PATH$) by specifying the variable name as an all uppercase string. These variables are resolved at application runtime, when LaunchAnywhere executes. Developers can also access system environment variables via LaunchAnywhere properties. | This variable is read-only. |
| $lax.nl.env.exact_case.[Environment_Variable_Name]$ | [Windows and UNIX only]: Access any system environment variable (for example, access Path via $lax.nl.env.exact_case.Path$) by specifying the variable name as a string of the exact case as it is defined in the environment. Note that these variables are resolved at application runtime, when LaunchAnywhere executes. Developers can also access system environment variables via LaunchAnywhere properties. | This variable is read-only. |
| $NULL$ | Currently, this is the same as $EMPTY_STRING$. | This variable is read-only. |
| $PRODUCT_ID$ | This resolves to the value of the product ID in the Project | Description task. | This variable is read-only. |
| $PRODUCT_NAME$ | This is the product name. | Developers may set this variable. |
| $PRODUCT_VERSION_NUMBER$ | This resolves to the value of the product version in the Project | Description task. | This variable is read-only. |
| $PROMPT_USER_CHOSEN_OPTION$ | This variable is set to the return value as set by the end-user's choice in the Show Message Console Dialog Box action. If the end-user chooses option 1, this variable will be set to 1. | This variable is read-only. |
| $prop.[JAVA PROPERTY]$ | Access any Java property through InstallAnywhere variables. An example is $prop.os.name$, which will return the value of the os.name property. | This variable is read-only. |
| $REQUIRED_DISK_SPACE_BYTES$ | This represents the disk space required by the installer. It is a string representing the required bytes as determined by the Check Disk Space action. The variable gains its value immediately before the installation of any files or folders listed in the Install task. | This variable is read-only. |
| $RESTART_NEEDED$ | This tells the installer or uninstaller if the system needs to restart to complete the installation. | This variable is read-only. |
| $SHORTCUT_NAME$ | This variable resolves to “Shortcut” on Win32 systems, “Alias” on Mac OS X and Classic systems, and “Link” on all other systems. | This variable is read-only. |
| $UNINSTALL_STATUS$ | This is the same as $INSTALL_STATUS$, but for the uninstaller. | This variable is read-only. |
..................Content has been hidden....................
You can't read the all page of ebook, please click here login for view all page.