Simple Channel and Code Template History

An Open Integration Engine plugin for tracking version history of Channels and Code Templates.

Features

• Automatic version history tracking when channels and code templates are saved
• Decomposed component diff view with navigable tree (scripts, connectors, filter/transformer steps, plugin properties)
• Side-by-side diff viewer with word-level inline highlighting
• Color-coded change indicators (added, removed, modified, unchanged)
• Revert to any previous version
• Prune older versions to manage storage
• Deleted items tracking — automatically saves a final XML snapshot when channels or code templates are deleted
• Database-backed storage (history travels with database backups)

Supported Databases

• PostgreSQL
• MySQL
• Oracle
• SQL Server
• Derby

Building

Requires Java 17+ and OIE libraries in your Maven repository (local or remote).

The public repsy mirror at repo.repsy.io/mvn/kpalang/mirthconnect does not yet carry the 4.6.0 engine artifacts. Build the engine (ant in donkey/ then server/) from a sibling checkout, then run:

ENGINE_DIR=/path/to/engine ./scripts/install-engine-jars.sh

The script installs the 12 engine jars this plugin builds against (mirth-server, donkey-server, mirth-client-core, mirth-client, plus 8 connector/plugin shared jars) at version 4.6.0 into your local Maven repository. If ENGINE_DIR is unset, it defaults to ../engine relative to this repo.

Development Build (unsigned)

mvn clean package

Release Build (signed with YubiKey)

Signed builds require a YubiKey with a code signing certificate and the OpenSC PKCS#11 library.

1. Copy yubikey-pkcs11.cfg.example to yubikey-pkcs11.cfg and update the library path for your system
2. Create certchain.pem containing your certificate chain (your cert + intermediate CA + root CA in PEM format)
3. Build with the signing profile:

mvn clean package -Psigning -Dsigning.storepass=<your-yubikey-pin>

Or set the PIN via environment variable:

export YUBIKEY_PIN=<your-pin>
mvn clean package -Psigning

The plugin zip will be in package/target/simple-channel-history-<version>.zip.

Installation

Install using the Extensions manager in the OIE Administrator, or manually extract to the extensions directory. A restart is required after installation.

The plugin will create the necessary database tables on first startup.

Usage

Viewing History

• Select a channel and click "View History" in the Channel Tasks panel
• Or right-click a channel and select "View History"

Comparing Versions

• Select two versions in the history table
• Right-click and select "Show Diff"

Reverting

• Select a version in the history table
• Right-click and select "Revert to this version"

Pruning

• Select a version in the history table
• Right-click and select "Prune older revisions"
• All versions older than the selected version will be deleted

License

Mozilla Public License 2.0 (MPL-2.0)

Based on the original git-ext plugin by Kiran Ayyagari.