BCI Nodes - File

<File> - In BBj 11.00 and higher, this node extracts a file that is included in a jar. The parent must be a <Jar> node. Once a file is referenced in a <File> node it will no longer be installed with the <Directory> node.

Attribute Description Possible Values Default Value
name

The name of a file that is in a jar file.

File name None
installdir

The name of the directory into which this file will be installed. When not preceded by a slash, this directory is relative to the installation directory.

File name None
permission

The permission of the file. Where:

  • r = read

  • w = write

  • x = execute

  • With + means for all

  • Without + means just for the owner

  • rwx

  • r+w+x+

r+w (read for all, write for owner)
overwrite

Specifies if the file already exists, should it be overwritten or not.

true, false true
uninstall

Specifies under what condition the file will be removed at uninstall time.

never, always, notmodified notmodified

Common Attribute Description Possible Values Default Value
bit

Specifies the Java bit level for which the BCI node will be active.

0 All bit levels
32 32-bit level
64 64-bit level

In BBj 19.21 and higher, the following values may also be used:

1 32-bit level
2 64-bit level

0 = All bit levels

osbit

Specifies the OS bit level for which the BCI node will be active.

0 All bit levels
32 32-bit level
64 64-bit level

In BBj 19.21 and higher, the following values may also be used:

1 32-bit level
2 64-bit level

0 = All bit levels

osname In BBj 24.10 and higher, specifies the OS for which the BCI node will be active. Multiple OS's are comma separated.
Windows
Mac
Linux
AIX
All
portid

Specifies the port ID for which the BCI node will be active. Multiple port IDs are comma separated.

As of BBj 24.10, the portid attribute has been removed. Use osname instead.

See Platform Availability for possible port IDs.

All port IDs

<Variable> - In BBj 11.00 and higher, this node creates a variable that can be used instead of string value in the custominstall.xml. The following variables are provided by default:

Variable Name Variable Value

$BASISInstallDir

BASIS installation directory.

$BASISInstallDrive

BASIS installation drive on Windows resolves to the drive letter and colon (i.e. d:).

$DesktopDir

Desktop directory on Windows.

$InstallDir

Installation directory.

$InstallDrive

Installation drive on Windows resolves to the drive letter and colon (i.e. d:).

$ProgramsDir

Programs directory on Windows.

$UserHome

User's home directory.

$Version

BBj version.

Example

<File name="2166/bin/32/uninstall.exe" installdir="bin" osname="Windows" permission="r+wx+" bit="32"
  uninstall="never" />

BCI Nodes Listing

<BBExec>

<CustomAction>

<Directory>

<Exec>

<Feature>

<File>

<Jar>

<Keep>

<Kill>

<RegEntry>

<Replace>

<Shortcut>

<Suite>

<Suites>

<Variable>