Groups and Files
Previous Topic  Next Topic 

The file groups tree is used to coordinate the files and directories that will be included in your installer. Files and directories are stored under a file group, and file groups are then made part of a component (or multiple components).


When an install is first created, a single file group called "Program Files" is created with the project. If you are only creating a simple installer for your application, this one file group is usually all that you need.


See Files and Directories for more information about the files and directories that are contained within file groups.



File Group Properties

File groups are further defined by their individual properties. When a file group is created, it is setup with a default set of properties that you can alter if you need to. Each file group has a set of standard properties that are properties that are shared by many components in InstallJammer and a set of Advanced Properties that are specific to file groups.



Standard Properties

See Standard Properties.


Active

If a file group is marked inactive, all the files and directories included in that group will not be included in the installer when it is built.


Compression Method

This property defines the method of compression for the given file group.  All other files and directories in the given file group will have the same compression method.  If the compression method is left blank, the default compression method for the project will be used.


Destination Directory

The directory this file group will be installed to on the target system. The default is <%InstallDir%>, the main installation directory.


Display Name

If this property is set, it specifies the name to display when the name of the file group is shown during installation.  If this property is left blank, the actual name of the file group will be used.


File Update Method

This property tells InstallJammer what to do with files when it is updating them on the target system. Updating is when the file already exists, and we need to determine what to do with our file.


Follow File Links

If this property is true, any linked files found within the file group will be followed and the file they link to will be stored as an actual file in the installer.  If this property is false, any links will be saved as links in the installer and recreated as a link on the target system during installation.


Name

The name of this file group.


Save Files

If this property is false, only the toplevel directories in the file group will be saved.  All of the files and subdirectories of the top directories will not be stored in the project file and will be discovered at build time.  This is useful when you only want to store a directory but want everything in that directory to be built dynamically.


Size

If the size property is specified, it tells InstallJammer to override what may actually be the size of the files stored in the file group and use the given size instead.  The size should be given as an integer only which will automatically be converted to a readable size during installation.


Version

This property tells InstallJammer what Install Version to store for this file group on the target system.  If this property is left blank, InstallJammer will use the global <%InstallVersion%> variable for the project.



Build Platforms

This is a list of all the platforms that are supported by InstallJammer and whether or not this file group should be built for each platform. If a platform is marked No, this file group will not be included when the installer for that platform is built.


It is possible to build a file group into multiple platforms and then not install the file group based on parameters during installation, but this option specifically tells InstallJammer to not even include this file group for the given platform.



Permissions

This feature allows you to set the file permissions for the given file group, file or directory. By default, no permissions are set which means that the file or directory will be installed with some default permissions on the target system.


Permissions on a file group refer to the directory that will be created for the file group and not to all of the files in the file group. Directories and files can be set with their own permissions or be set as group when multiple files and directories are selected.


Both Windows attributes and UNIX permissions are provided and will be applied based on the target system. So, if a file has both Windows attributes and UNIX permissions, the Windows attributes will be applied when the file is installed on a Windows system, and the UNIX permissions will be applied when installed on a UNIX system.



Creating a new file group

Click the Add New File Group button on the toolbar to add a new file group to your install.


A new file group is created with default values that you can change after its creation. Your new file group will be at the bottom of the list.


Deleting a file group

Click the Delete button on the toolbar to delete the selected nodes from your install. This can also be done through the Delete key on your keyboard.


Any selected nodes in the file group tree will be deleted. This includes files, directories and file groups.


Adding files to a file group

Click the Add Files to File Group button on the toolbar to add new files to the selected file group. A file dialog will open and ask you to select the files you wish to add to the file group.


Files can also be added to a program folder by dragging and dropping them from your file explorer. Most major window managers are supported.


Adding directories to a file group

Click the Add Directory to File Group button on the toolbar to add new files to the selected file group. A directory selection dialog will open and ask you to select a directory you wish to add to the file group.


Directories can also be added to a program folder by dragging and dropping them from your file explorer. Most major window managers are supported.


Deleting files from a file group

Click the Delete button on the toolbar to delete the selected nodes from your install. This can also be done through the Delete key on your keyboard.


Selected nodes in the file group tree, including files and directories directly beneath the file group, will be deleted from the project.


Only files and directories that are directly beneath a file group can be deleted.  Subdirectories and files that are contained within directories cannot be deleted from a project.  If you do not wish to include files or directories that are contained in a subdirectory, you simply uncheck them.  Files and directories that are unchecked are not included in an install when it is built.


This is done so that once you include a directory in a file group, InstallJammer will maintain the entire directory structure regardless of what is included in the installer.  You can always add other subdirectories directly to the file group and have them install anywhere you like based on Destination Directory.


Excluding files and directories from a project

Files and directories can be excluded from a build by unchecking (or de-activating) them in the file group tree.  Any file or directory that does not have a check mark is considered inactive and will be ignored by InstallJammer when building your installer.


Disabling a directory will automatically disable everything contained in that directory, even if other files and directories in the directory are checked.  Once you disable a directory, all of its subdirectories and files are disabled as well.  If you wish to disable an entire directory but still include subdirectories beneath it, you will need to add those subdirectories directly to the file group.  You can modify their install locations through the Destination Directory property.


The File Explorer

The File Explorer button will bring up a directory and file explorer which can be used to drag-and-drop files and directories into file groups. If you did not specify a file explorer in your preferences, InstallJammer will attempt to find the best one based on your window manager.


On Windows, this defaults to Windows Explorer. You can specify exactly which file explorer you want to use in your preferences. InstallJammer supports drag-and-drop on most major window managers.