WiX v3 
PanelSwWixExtension from the creator of JetBA is the most comprehensive open source WiX extension. I would like to thank JetBrains for their support of this project
- Bundle elements:
- ContainerTemplate: A container template to which bundle payloads can be assigned
- Heat extension command line arguments:
- -inc: Semicolon seperated list of filename to include. Wildcards are accepted. If specified, any file not matching the pattern will be excluded
- -exc: Semicolon seperated list of filename to exclude. Wildcards are accepted. If specified, any file matching the pattern will be excluded
- Immediate Actions:
- Md5Hash: Computes MD5 hash.
- WmiSearch: Execute a WMI query.
- PathSearch: Search for a file on PATH environment variable folder list.
- VersionCompare: Compare two versions, set result to property to value in range -4 to +4, denoting the version part that was different (-+4 if Major part was different, -+3 for Minor part, etc.)
- ForceVersion: Force a specified version for a file. Version overwrite is done on runtime in the MSI database.
- AccountSidSearch: Lookup an account's SID by account name.
- JsonJpathSearch: Read JSON values
- DiskSpace: Calculate available disk space for a target directory
- CertificateHashSearch: Find a certificate hash in local system MY store.
- Evaluate: Evaluate mathematical expressions and store result in property.
- SetPropertyFromPipe: Allows setting property from a pipe.
- SqlSearch: Execute a SQL query and place result in a property.
- ReadIniValues: Reads .INI file values.
- XmlSearch: Read XML values.
- RegularExpression: Execute a Regular Expression to replace or find matches in property values and in file contents.
- MsiSqlQuery: Execute a MSI-SQL query on the MSI database.
- CreateSelfSignCertificate: Create a self-sign certificate that can then be installed by WixIisExtension.
- ToLowerCase: Convert property value to lowercase.
- CustomPatchRef Support referencing custom table rows in a patch
- Payload Support extracting files from Binary table temporarilty during MSI execution
- PromptFileDowngrades Log each file that will be downgraded during the (re)install, and prompt the total downgrade count if larger than 0.
- Deferred Actions:
- RestartLocalResources: Register processes with the Restart Manager if they reside in the specified folder
- XslTransform: Apply a XSL transform on an installed XML file
- WebsiteConfig: currently, can only stop a website
- JsonJPath: Set values in JSON-formatted file.
- Dism: Enable or disable Windows Features using DISM API. Features will be modified when the parent component is being installed or repaired.
- ZipFile: Creates a ZIP archive from selected files.
- Unzip: Extract a ZIP archive to selected folder.
- CustomUninstallKey: Overwrite registry values in the product's Uninstall registry key
- RemoveRegistryValue: Removes registry values. Complements the standard RemoveRegistryValue WiX element that will only remove registry values during installation.
- ExecOn: Execute a custom command on component action.
- TaskScheduler: Add a task to Windows Task Scheduler.
- DeletePath: Delete folder or file specified by a path.
- FileRegex: Execute a Regular Expression to perform find & replace operations within files.
- ShellExecute: Call ShellExecuteEx with parameters.
- Telemetry: Send telemetry data to a given URL.
- InstallUtil: Install a .NET assembly service.
- TopShelf: Install a TopShelf based service.
- BackupAndRestore: Backup a file before install or upgarde and restore it after.
- SqlScript: Execute SQL scripts, optionally with text replacements.
- SplitFile: Splits a file to parts during build, and reconstruct it during install. Used to workaround MSI limitation of 2GB file size.
- $(psw.VarNullOrEmpty(VAR_NAME)): Return 1 if the variable is not defined, or if it defined as empty. Return 0 otherwise
- $(psw.AutoGuid(x,y,z,...)): Return a pseudo-random UUID per arguments
- $(psw.FileExists(path)): Return 1 if the file exists, 0 otherwise
- $(psw.DirExists(path)): Return 1 if the folder exists, 0 otherwise
- $(psw.DirEmpty(path)): Return 1 if the folder doesn't exist or if it has no files (including in subfolders). Return 0 otherwise
- TerminateSuccessfully_Immediate: Terminates the installation with a successful indication. Executed in-script.
- TerminateSuccessfully_Deferred: Terminates the installation with a successful indication. Deferred execution.
- SplitPath: Split a full path supplied in 'FULL_PATH_TO_SPLIT' property and places the parts in properties SPLIT_DRIVE, SPLIT_FOLDER, SPLIT_FILE_NAME, SPLIT_FILE_EXTENSION.
- PathExists: Tests whether the path supplied in 'FULL_PATH_TO_TEST' property exists. Sets 'PATH_EXISTS' property to 1 if it exists or clears it if it doesn't.
- SplitString: Splits a string. Property name specified in 'PROPERTY_TO_SPLIT' and split token specified in 'STRING_SPLIT_TOKEN'. Results are stored in properties following the name supplied in 'PROPERTY_TO_SPLIT'. For example, say PROPERTY_TO_SPLIT="MY_PROP", MY_PROP="1,2,3" and STRING_SPLIT_TOKEN=",". Scheduling SplitString custom action will yield properties MY_PROP_0="1", MY_PROP_1="2" and MY_PROP_2="3".
- TrimString: Trim whitespace characters in property with name specified in 'PROPERTY_TO_TRIM'.
PanelSwWixExtension uses error codes in Error table:
- 27000: TopShelf error template for prompting user on errors.
- 27001: ExecOn error template for prompting user on errors.
- 27002: ServiceConfig error template for prompting user on errors.
- 27003: Dism error template for prompting user on failures to add a Windows feature package.
- 27004: Dism error template for prompting user on failures to enable a Windows feature.
- 27005: SqlScript error template for prompting user on errors.
- 27006: ExecOn error template for prompting user on console output parsing.
- 27007: WebsiteConfig error template for prompting user on errors.
- 27008: SqlSearch error template for prompting user on errors.
- 27009: JsonJpath error template for prompting user on errors.
- 27010: Dism error template for prompting user on failures to remove a Windows feature package.
- 27011: ExecOn message template for prompting user on success with promptAlways.
- 27012: Prompt on file downgrades
The following properties hold localized built-in account names. To use them, add a PropertyRef element.
- DOMAIN_ADMINISTRATORS
- DOMAIN_GUESTS
- DOMAIN_USERS
- ENTERPRISE_DOMAIN_CONTROLLERS
- DOMAIN_DOMAIN_CONTROLLERS
- DOMAIN_COMPUTERS
- BUILTIN_ADMINISTRATORS
- BUILTIN_GUESTS
- BUILTIN_USERS
- LOCAL_ADMIN
- LOCAL_GUEST
- ACCOUNT_OPERATORS
- BACKUP_OPERATORS
- PRINTER_OPERATORS
- SERVER_OPERATORS
- AUTHENTICATED_USERS
- PERSONAL_SELF
- CREATOR_OWNER
- CREATOR_GROUP
- LOCAL_SYSTEM
- POWER_USERS
- EVERYONE
- REPLICATOR
- INTERACTIVE
- NETWORK
- SERVICE
- RESTRICTED_CODE
- WRITE_RESTRICTED_CODE
- ANONYMOUS
- SCHEMA_ADMINISTRATORS
- CERT_SERV_ADMINISTRATORS
- RAS_SERVERS
- ENTERPRISE_ADMINS
- GROUP_POLICY_ADMINS
- ALIAS_PREW2KCOMPACC
- LOCAL_SERVICE
- NETWORK_SERVICE
- REMOTE_DESKTOP
- NETWORK_CONFIGURATION_OPS
- PERFMON_USERS
- PERFLOG_USERS
- IIS_USERS
- CRYPTO_OPERATORS
- OWNER_RIGHTS
- EVENT_LOG_READERS
- ENTERPRISE_RO_DCs
- CERTSVC_DCOM_ACCESS
The following properties hold localized CSIDL folders. To use them, add a PropertyRef element.
- UserDesktopFolder: CSIDL_DESKTOPDIRECTORY
PanelSwWixExtension require the following prerequisites to build:
- CMake: CMake path can be specified in 'CMakeDir' property in 'TidyBuild.custom.props'
- ADK installed. Specifically, Dism API should be installed. Set DismApi folder path in 'DismApiDir' property in 'TidyBuild.custom.props'
- Update git submodules
To build the extension execute:
msbuild dirs.proj -restore "-p:SolutionDir=%CD%\"
Unit-test WiX are available in the solution folder 'UnitTests'. To build a unit test project execute:
msbuild UnitTests\ForceVersionUT\ForceVersionUT.wixproj -restore /p:Configuration=Release /p:Platform=x86 /t:Rebuild "/p:SolutionDir=%CD%\\"