Extract Organ Information

Important Notice

This script is not officially supported by Hauptwerk. If you are unfamiliar with the use of the Terminal, there is a risk of inadvertently disrupting your Hauptwerk setup.

Please ensure that you carefully follow the instructions provided in the README.md file on GitHub, and create a full backup of your settings before making any changes.

Use this script at your own risk. No responsibility is taken for any issues that may occur as a result of using this script.

What The Script Does

This script is designed to extract essential data from Hauptwerk organ sample sets and organ installation package files. It operates in a read-only mode to ensure the integrity and safety of all Hauptwerk configuration files, performing no modifications to existing data. The script is intended for use on macOS and may also be compatible with Windows environments via WSL (Windows Subsystem for Linux).

It processes Hauptwerk configuration files and exports the extracted data into CSV (Comma-Separated Values) files. This widely supported format ensures compatibility with spreadsheet applications such as Apple Numbers and Microsoft Excel, as well as easy import into various database systems. File locations are automatically identified by referencing a central Hauptwerk configuration file.

The script generates three CSV files, which are saved directly to the desktop for convenient access.

SampleSets.csv – This CSV file contains general information about the sample set. The following data is extracted from the organ definition files (ODFs):

Filename
UniqueOrganID
Name
LCDDisplayShortName
Location
Builder
BuildDate
OrganInfo_Comments
OrganDefinitionSupplierID
OrganDefinitionSupplierName

RequiredInstallationPackages.csv – This CSV file contains information about the required packages per sample set. This data is extracted from the organ definition files (ODF):

UniqueOrganID
InstallationPackageID
Name
ShortName
PackageSupplierID
SupplierName
MinimumPackageVersion

OrganInstallationPackagesInfo.csv – This CSV file contains information about organ installation packages. The following data is extracted from the installation package definition stored within each installation package:

UniqueInstallationPackageID
Name
ShortName
PackageSupplierID
SupplierName
PackageVersion
PreviousMinInstalledPackageVersionRequiredWhenUpgradingToThisVersion

Notes:

Since one organ can require multiple installation packages, this data is stored in a separate file. You can join the CSVs using the UniqueOrganID field.
The script supports both short (compact) and long format Hauptwerk ODFs.
The script automatically detects and converts incorrectly encoded XML files to UTF-8 in memory.

How to Use the Script

This script will be soon available on GitHub.

Kindly review the comprehensive instructions provided in the README.md file for detailed guidance.