Folder Reference Properties

Source

Local folder:

The location of the folder on your development system whose contents you want to include in the install. You can click the Browse button to select a alternate folder.

Recurse subfolders

Include the contents of all subfolders within the specified Local folder. This will also maintain the directory structure within the specified Local folder. If unchecked, only the files within the root of the folder will be included.

Note: Folder references will not include empty folders in your setup. Only folders that contain files that are included in the setup (based on the file mask), will be created by Setup Factory at runtime.

File mask:

The file mask you want to use to determine which files will be included or excluded from the setup at build time. You can use wildcards in this field. For example, *.* for all files, *.txt for all files with the .txt file extension etc.

Files that match

Only include files that match the specified file mask.

Files that do not match

Only include files that do not match the specified file mask.

Description:

A design-time description of the folder reference. This description can be used by the developer to include further information about the particular folder reference. The end user will not see this information.

Run-time folder:

The location of the folder's contents during the install, i.e. where the setup executable can find the contents at run time.

Note: If the folder reference is located on the Archive tab of the design environment, this field will be read-only containing the text "Archive".

Destination

Install to:

The location that you want the folder's contents to be installed to on the user’s system. You can use any path-related session variable by itself or with a hard-coded path that you specify.

Note: Setup Factory will insert the correct directory here by default when you add the files to the project. Generally, you will not need to change the Install to setting.

Overwrite:

The action that will be taken if a file with the same name already exists in the location you want to install to. The relative newness of the file is determined by the version resource information built into the file. If the file does not contain version information, the file's date and time will be used as the criteria. Choose from:

Action

Description

Overwrite if existing file is same or older

If the file being installed is newer than or the same as the existing file, then overwrite the existing file.

Overwrite if existing file is older (Default)

If the file being installed is newer than the existing file, then overwrite the existing file.

Always overwrite existing file

The file being installed will always overwrite an existing file with the same name.

Never overwrite existing file

The file being installed will never overwrite an existing file with the same name.

Ask the user

The user will be asked whether or not the existing file should be overwritten.

 

Note: It is generally not a good idea to select "Always overwrite existing file" unless you are sure that is what you need to do. Also, do not select "Ask the user" unless you are sure that they have the knowledge to make such a decision. "Overwrite if existing file is older" is generally the safest and most conventional option for this situation.