Installer Custom Variables (MSI Public Properties)
The following custom properties (in UPPERCASE) are public MSI properties and can be set at install time via the msiexec command line tool.
See also the Deployment Guide for some generic examples.
Note
MSI public properties require a NAME=VALUE pair.
Examples:
MY_BOOLEAN_PROPERTY=1 or MY_BOOLEAN_PROPERTY=0 (boolean)
"MY_STRING_PROPERTY=Lorem Ipsum" (string with spaces — quote the whole pair)
Warning
The name alone is not valid, and the property will be ignored.
Property names (in uppercase) must match what the MSI supports, if a property is not known, it will be ignored without a warning or error.
Usage Examples for Custom (overwritable) Properties
Custom properties control both the installer behavior and the runtime behavior of the installed application. Properties that affect runtime are persisted to the Windows Registry under HKLM\SOFTWARE\idgard Sync during installation. The application reads these values at startup or on demand.
In the examples below we omit optional msiexec parameters, to keep the focus on the usecase of the custom property.
Override the Application Update Functionallity, set it to 1 to disable the auto update (default value is 0, update is active):
msiexec /i "setup.msi" /qn DISABLE_APP_UPDATE="1"
| PROPERTY | RegistryKey | Values | Use Case |
|---|---|---|---|
| DISABLE_APP_UPDATE | DisableAppUpdate | 0, 1 | Control Application Update |
Note
Only properties with an all-uppercase PROPERTY_NAME in the WiX source are public MSI properties.
Properties marked Secure="yes" are populated internally and cannot be overridden on the command line.
Standard Properties
Warning
Remember Standard Properties are exposed but should not modified by user.
These ARP properties control how the product appears in Add/Remove Programs (Programs and Features).
| Property | Description |
|---|---|
ARPCONTACT |
Support contact shown in Add/Remove Programs. |
ARPHELPLINK |
Help URL shown in Add/Remove Programs. |
ARPHELPTELEPHONE |
Support phone number shown in Add/Remove Programs. |
ARPPRODUCTICON |
Icon shown in Add/Remove Programs. |
Internal Properties
| Property | Description |
|---|---|
EXENAME |
Name of the main executable. |
TENANT_PRODUCT_NAME |
Display name of the tenant product. |
Secure / Read-Only Properties
All secure properties are set internally (Secure="yes") and cannot be set from the command line!
| Property | Description |
|---|---|
PREVIOUSVERSIONSINSTALLED |
Set by the upgrade table. |