Basics: Patch Parameters

Main patch parameters are listed in the table below.

 

Parameter

Description

Patch Name

Patch name must form a valid name of file, thus using of such symbols as < > : " / \ | * ? is not allowed. It cannot be changed after patch creation.

Patch Type

Currently there are 2 types of patches: v-2-v and Cumulative

1. v-2-v. Building of this type of a patch leads to creation of independent patch modules, used to perform an update from one arbitrary version to another. Contents of old versions to be updated using this patch is defined by differences which exist in the new version.

2. Cumulative. This patch type is used to generate an update module capable to perform the update from several versions up to one another version. All necessary actions are taken to minimize the size of this patch module during the building process. Contents of old versions which can be updated using this patch module is defined by differences which exist in the new version.

Allow df

Flag, which defines whether difference between files with the same name is used during the update procedure.

Value YES (default) allows such updating. If set to NO then full copies of new files are used if they differ from old version files.

Allow update on reboot

General flag. Provides replacing of files to be updated at system restart (often if such files are occupied by other processes). YES by default.

Allow uninstall on reboot

General flag. Provides replacing of files to be uninstalled/repaired at system restart (often if such files are occupied by other processes). YES by default.

Save/restore file

security data

This option is useful only for NTFS file system and provides saving of file owner, group, access control and audit information. The patch module must have necessary privileges in order to use this facility. Processing of security data may decrease the speed of backup/restore operation, so, please, set this option to YES only if you understand its meaning and really need it, in most cases security processing is not required for home users. YES by default.

InnoSetup script

Name of the InnoSetup script file used to generate the update module. If only the name is specified (not the full path) then is it assumed that the script-file is stored in the "<PatchFactory Root Folder>\ Scripts" folder.

Wizard

Uninstallable

Flag which defines whether backup information necessary to perform uninstall/rollback of patch is saved. If set to Yes, the backup copy of all replaced/modified files (for which backup is allowed) is saved and a record is added into Add/Remove programs list.

If set to No (default) then rollback/uninstall of the patch after its successful applying is impossible. In this case backup copies of files are stored in the temporary system folder during patch applying only to provide rollback if an error occurred during patch applying to maintain an old version operating, and after patch is succesfully apllied they are deleted.

Show Backup page

 

Available values: Yes (default), No.

If set to No, then "Update Installation parameters" dialog page (asking an end-user to select whether to perform backup with further Rollback and to choose the backup folder) will not be displayed to an end-user during update installation.

Output

Directory

Folder where the output update modules are saved to. If empty then it is assumed that result patch-files are saved in the "<Product Folder>/<New Version>/patches/<Patch Name>" folder.

File name Template

Template for update modules names. To prepare a template you can use the following specificators:

{P} : Product Name.

{U} : Patch Name.

{O} : Old version name (empty string for Cumulative patch).

{N} : New version name.

{PID} : Product ID.

{OID} : Old version ID (empty string for Cumulative patch).

{NID} : New version ID.

To include '{' character use '{{' instead.

 

See also: Patch definition in terms of PatchFactory v3.

 

Converted from CHM to HTML with chm2web Standard 2.75 (unicode)