New article
Recently updated
Using the MSI file creator
Who is this article for?
IT Administrators deploying the desktop application.
IT Administrator permissions are required.
Pentana.Tng.Tools.MSIBuilder.exe is a straightforward application designed to facilitate the creation of an MSI installer for the desktop client application. It utilises open-source tools (WiX).
This article will outline the steps required to generate an MSI file using Pentana.Tng.Tools.MSIBuilder.exe.
1. Prerequisites
The computer on which you intend to run this tool must have the following:
- .NET v4.8 or later.
- WiX toolset. This open-source tool is available from GitHub - wix314.exe is the most recently tested version.
- Copy of the existing MSI file if your new MSI package will be used to upgrade an existing deployment.
- Ready-to-deploy Pentana XCOPY folder (the newly created Firebird database, vision.bak, should be located in the LocalData directory).
If you don't have one:- Go to AppManager.
- Switch to the Configuration tab.
- Select Other from the Client Type dropdown.
- Modify the path.
This is to prevent overwriting any existing client folders. - "Install" the client.
Do not use the MSI option from the dropdown, as this feature is not implemented.
2. Downloading the tool
To download the tool:
- Download the MSI Builder package.
- Unblock the .zip file.
- Extract the downloaded content to C:\temp\Ideagen Ideagen Internal Audit (Aura) v6.0.1.8 MSIBuilder.
This will include both the MSI builder application and its configuration file:- Pentana.Tng.Tools.MSIBuilder.exe (Application)
- Pentana.Tng.Tools.MSIBuilder.exe.config (Configuration file)
3. Editing the configuration
The build process utilises values specified within the Pentana.Tng.Tools.MSIBuilder.exe.config file.
For new deployments, please use the suggested values in the table below.
If the MSI file is intended to upgrade an existing deployment, use the dark.exe tool to retrieve the necessary values, as described below.
3.1. Identifying configuration values
Assuming the previous MSI file being updated is named PentanaAuditUAT.msi and is located in c:\temp\OldMSI, execute the following command to run dark.exe:
"C:\Program Files (x86)\WiX Toolset v3.14\bin\dark.exe" "C:\temp\Old MSI\PentanaAuditUAT.msi"This will generate a new file, c:\temp\Old MSI\PentanaAuditUAT.wxs.
To identify existing configuration values:
- Open this file in Notepad.
- Locate the value for Version.
- Locate the value for UpgradeCode.
These values will be required for future steps in this process.
3.2. Editing configuration values
To edit configuration values:
- Open the Pentana.Tng.Tools.MSIBuilder.exe.config in Notepad.
- Update highlighted values using the table below for guidance.
Key |
Value (New deployment) |
Value (Existing deployment) |
| CandleToolPath | Path to candle.exe, typically C:\Program Files (x86)\WiX Toolset v3.14\bin\candle.exe | |
| LightToolPath | Path to light.exe, typically C:\Program Files (x86)\WiX Toolset v3.14\bin\light.exe | |
| TargetPath | Directory containing the xcopy folder to be packaged as an MSI file | |
| ProductName | Typically: Ideagen Internal Audit (Aura) UAT for a UAT client Ideagen Internal Audit (Aura) PRD for a production client |
|
| MSIName | Typically: PentanaAuditUAT for a UAT client PentanaAuditPRD for a production client |
|
| Description | Typically: Ideagen Internal Audit (Aura) Application for UAT Environment for a UAT client Ideagen Internal Audit (Aura) Application for PRD Environment for a production client |
|
| Version | Use the initial digits of the release, e.g. 6.0.1 | Use the current version incremented by one. For example, 6.0.1 would become 6.0.2 |
| UpgradeCode | Use a new GUID. Employ distinct GUIDs for UAT and production clients. |
Utilise the existing GUID |
Increment the version number for subsequent MSI file versions. Use separate GUIDs for UAT and Production clients.
4. Creating the MSI file
To create the MSI file, execute Pentana.Tng.Tools.MSIBuilder.exe.
This will be created in the parent directory of the TargetPath specified in the configuration file, which in this example would be c:\temp. Upon completion, the tool will display a screen similar to the following. You can exit it by entering 'n'.
The MSI file is now ready for use.