PanelSwWixExtension 2.21.1

PanelSwWixExtension is the most comprehensive open source WiX extension. It features dozens of actions from querying XML, JSON and text files to installing ServiceBase-based and TopShelf services.

The commercial extension- JetWixExtension- complements PanelSwWixExtension with the following features:

• JetBA: The most comprehensive, fully customizable, extensible, WPF-based BootstrapperApplication.
• JetBA++: The only native fully customizable, extensible, Qt-based BootstrapperApplication.
• Preprocessor extension:
  • Harvest directly from WiX source code by executing Heat commands

    <?pragma heat.dir "$(sys.SOURCEFILEDIR)..\bin\Release" -cg BIN -dr INSTALLFOLDER -ag?>
    

  • Collection variables

    <?pragma tuple.NIR a; b; c?>
    <?pragma tuple.BAR x; y; z?>
    <?foreach i in $(tuple_range.BAR())?>
    <Component Feature="ProductFeature" Directory="INSTALLFOLDER">
      <File Source="$(sys.SOURCEFILEPATH)" Name="Product.$(tuple.NIR($(var.i))).$(tuple.BAR($(var.i))).wxs"/>
    </Component>
    <?endforeach?>
    <?pragma endtuple.BAR?>
    <?pragma endtuple.NIR?>
    

  • Generate random Id. Useful when deploying files with same name to different target folders:

    <ComponentGroup Id="random">
    	<Component Directory="Product.Dir">
    	<File Source="$(sys.SOURCEFILEPATH)" Id="$(jet.random_id())"/>
    	</Component>
    	<Component Directory="INSTALL_FOLDER">
    	<File Source="$(sys.SOURCEFILEPATH)" Id="$(jet.random_id())"/>
    	</Component>
    </ComponentGroup>
    

  • Generate random or pseudo-random Guid.

    <ComponentGroup Id="random">
      <?foreach account in localService;localSystem;networkService;applicationPoolIdentity?>
      <Component Id="webapp.$(var.account)" Guid="$(jet.Guid($(var.account)))" Transitive="yes">
        <Condition><![CDATA[IIS_ACCOUNT ~= "$(var.account)"]]></Condition>
        <CreateFolder />
        <iis:WebAppPool Id="$(var.account)" Name="WebUI" Identity="$(var.account)" ManagedRuntimeVersion="v4.0" ManagedPipelineMode="Integrated" />
        <iis:WebVirtualDir Id="$(var.account)" Directory="INSTALLFOLDER" Alias="WebUI" WebSite="WebUI">
          <iis:WebApplication Id="$(var.account)" Name="WebUI" WebAppPool="$(var.account)" />
        </iis:WebVirtualDir>
      </Component>
      <?endforeach?>
    </ComponentGroup>
    

• Detect bundles and get their versions in a variable:

  <jet:BundleSearch UpgradeCode="{1D1DB5E6-E0D8-3103-8570-369A82A9BF33}" VersionVariable="DetectedVC2013x86Version" NamePattern="\bx86\b"/>
  

• RebootBoundary attrbiute on bundle packages: force reboot after the package if any preceding package required reboot Contact the owner to obtain a license for JetWixExtension

PanelSwWixExtension WiX Elements

• Immediate Actions:
  • PathSearch: Search for a file on PATH environment variable folder list.
  • VersionCompare: Compare two versions, set result to property as -1, 0, or 1
  • 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 has 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.
• Deferred Actions:
  • WebsiteConfig: currently, can only stop a website
  • JsonJPath: Set values in JSON-formatted file.
  • Dism: Enable Windows Feature using DISM API. Features will be installed 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. Task definition XML should be in inner text.
  • 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.

Custom Actions

• 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'.