MirthVisualizer README

The MirthVisualizer tool is designed to interface with Nextgen (Mirth) Connect and generate a linked channel report (PDF) from its backup configuration file. The report includes:

  • Bookmarks

  • Table of Contents

  • Channel Listing

    • Channel name/type

    • Source filter & transform code links

    • Destinations with links

    • Destination filter & transform code links

  • Global Code Templates

  • Source and Destination Code

License Purchase & Application Support

In order to purchase a license, or if you have any issues with MirthVisualizer, please send us an email at mirthvisualizer@shastanetworks.com.

——

All versions of MirthVisualizer are backwards compatible and support all of the versions of Mirth that previous versions of MirthVisualizer supported.

MirthVisualizer may work on older or newer versions of Mirth than what is listed below. However, Shasta Networks only officially supports the versions listed below.

Current MirthVisualizer Version  —  1.0.0
Minimum Version of Mirth Supported for File  —  3.1.1
Minimum Version of Mirth Supported for REST  —  3.5.0
Maximum Version of Mirth Supported  —  3.7.1
Operating Systems  —  Windows, macOS X
Environment  —  
  • Java Runtime Environment (JRE) 8 or above.
  • If you're using OpenJDK, you'll need to download JavaFX 8 or above.
  • An internet connection is required for license validation.
——

Known Issues

  1. There is a known bug with older versions of Java 8 (OpenJDK) that causes an application crash on macOS 10.14 (Mojave). See https://bugs.openjdk.java.net/browse/JDK-8211304 for full details.

    • If the application is showing a dialog and the user switches to any other application, the application crashes.

    • The bug is fixed in recent Java versions.

How To Use MirthVisualizer

  1. After launching MirthVisualizer, you are presented with two options. You can either use the REST Client to reach out to Mirth over the network and download the Configuration Backup, or provide the file path to the location of a Configuration Backup file.

    • REST Client: This functionality requires at least Mirth version 3.5.0. Enter the URL, username and password for your Mirth instance.

    • File Path: A username and password are not needed for this step, so the corresponding text fields are disabled. All that is needed is the path to a previously downloaded Configuration Backup XML file.

      1. To obtain a backup Configuration Backup XML file, follow the steps below:

        1. Log into your Mirth instance.

        2. Navigate to Settings on the left hand side of the Mirth UI.

        3. Then click on "Backup Config" in the Server Tasks Pane.

        4. Mirth will ask you where you want to store this file. This same path is what you need to enter for your File Path in MirthVisualizer.

  2. After you click Submit, a new screen will appear with a text area showing progress, status, or errors.

  3. If an error occurs, the error will be displayed and what needs to be done to remedy. You will also have the option to return to the previous screen and make corrections.

  4. Once the application has completed, it will notify you where your file has been written and allow you to exit the program.