Skip to content

Latest commit

 

History

History
151 lines (122 loc) · 9.75 KB

README.md

File metadata and controls

151 lines (122 loc) · 9.75 KB
Raw

A Mirth Connect plugin to add cross channel searching and present a summary view of channels via a Settings tab

A Mirth Connect plugin started from Kaur Palang's [sample plugin] (https://github.com/kpalang/mirth-sample-plugin). Allows cross-channel searching and generates a jQuery-accordion style [nested summary] (https://github.com/mjtrac/mirth-sample-plugin/blob/master/sample-plugin-generated.html) of your channels. Relevant non-boilerplate is in client/src/main/java/com/mitchtrachtenberg/mirthpluginsearchsummary/client

Installation by building

  1. Install Java
  2. Install Maven
  3. Run git clone https://github.com/mjtrac/mirth-searchsummary-plugin
  4. Run mvn install to install dependencies to local cache (see below if you get an error message indicating you are Unauthorized to download from the github repo)
  5. Run mvn clean package to verify the build works
  6. Install the sample plugin by getting the .zip archive from mirth-searchsummary-plugin/distribution/target

Installation of pre-built zip for Mirth Connect 4.3.0 (see below for flag you MUST use with Mirth Administrator Launcher after installing)

  1. git clone https://github.com/mjtrac/mirth-searchsummary-plugin
  2. This will create a directory under your current directory, named mirth-searchsummary-plugin
  3. Run Mirth Connect 4.3.0 (this zip will only work with 4.3.0)
  4. In the Mirth Connect Administrator for 4.3.0, in the upper left corner, select Extensions from the main menu
  5. At the bottom of the Extensions page, beneath "Install Extension from File System," browse to the file searchsummaryplugin.zip in the distribution folder of your cloned mirth-searchsummary-plugin tree. This was built for Mirth Connect 4.3.0
  6. Click Install at the right. You should be prompted to restart the server and administrator.
  7. Restart the Mirth Connect Server and run the Administrator Launcher with the "-k" argument which will allow you to accept a self-signed certificate on the extension.
  8. If you run into trouble, you can go to your Mirth Connect appdata folder and, in extension.properties, change the line Search\ Summary\ Plugin=true to Search\ Summary\ Plugin= false and restart server and client.

Usage

IMPORTANT: Once this extension is installed, the Mirth Connect Administrator Launcher will need to be run with the -k flag that allows you to accept self-signed certificates, as the provided plugin certificate is self-signed. You will then need to accept the prompt the launcher displays when it encounters the plugin.

After the extension is installed into Mirth 4.3.0 (currently the only version checked is 4.3.0) Mirth will have a new Search/summary tab in Settings view.
You may search for a complete property name (e.g.: port) or for a property value (e.g.: 6661). All channels will be searched and you will be presented with a path to each reference (e.g.: channel(Channel with a Long Name)/sourceConnector/properties/listenerConnectorProperties/port/ = 6661).

searchsummary1

Using the Menu items in the Search/summary menu to the left, you may generate a temporary file with either text or html for all channels. The html is generated to allow quick navigation.

searchsummary2

This repository showcases use of mirth-plugin-maven-plugin to generate plugin.xml file!

  • Any external libraries that you might want to use in the plugin at runtime, go into libs/runtime/{type}
  • Any external libraries that you might want to use at compiletime, go into libs/compiletime/{type}

IF YOU GET UNAUTHORIZED WHEN YOU TRY TO USE THE KPALANG GITHUB REPO

If you want to build this for your current version of Mirth, first clone Kaur Palang's mirth-plugin-maven-plugin project, build it, and install it locally:

git clone http://github.com/kpalang/mirth-plugin-maven-plugin
cd mirth-plugin-maven-plugin
mvn clean
mvn install

you should see lines like the following:

[INFO] Installing /Users/mjtrac/Documents/GitHub/mirth-plugin-maven-plugin/pom.xml to /Users/mjtrac/.m2/repository/com/kaurpalang/mirth-plugin-maven-plugin/1.0.2-SNAPSHOT/mirth-plugin-maven-plugin-1.0.2-SNAPSHOT.pom
[INFO] Installing /Users/mjtrac/Documents/GitHub/mirth-plugin-maven-plugin/target/mirth-plugin-maven-plugin-1.0.2-SNAPSHOT.jar to /Users/mjtrac/.m2/repository/com/kaurpalang/mirth-plugin-maven-plugin/1.0.2-SNAPSHOT/mirth-plugin-maven-plugin-1.0.2-SNAPSHOT.jar

Then, you can manually install the current Mirth jar files into your local Maven repository with a series of commands modeled on this one, one for each jar file that Maven cannot download from the kpalang repo and therefore reports as an error.

In this example command, the jar file is located in the Mirth Connect install tree's server-lib folder, but other required jar files may be located in other subfolders.

Replace 4.3.0 below with the version number of Mirth you've installed, and replace the file, groupId, and artifactId as necessary. (The command can be entered as a single line.)

mvn install:install-file \
  -Dfile=<path to your local Mirth install>/server-lib/mirth-server.jar \
  -DgroupId=com.mirth.connect \
  -DartifactId=mirth-server \
  -Dversion=4.3.0
  -Dpackaging=jar

This adds the file to your standard "local repository" (typically ~/.m2/repository) so that maven will not need to download it from elsewhere.

The command should give a response that includes something like:

[INFO] Installing <path to your Mirth install>/server-lib/mirth-server.jar to <your home dir>/.m2/repository/com/mirth/connect/mirth-server/4.3.0/mirth-server-4.3.0.jar

If you want to build this for your current version of Mirth, first clone Kaur Palang's mirth-plugin-maven-plugin project, build it, and install it locally:

git clone http://github.com/kpalang/mirth-plugin-maven-plugin
cd mirth-plugin-maven-plugin
mvn clean
mvn install

you should see lines like the following:

[INFO] Installing /Users/mjtrac/Documents/GitHub/mirth-plugin-maven-plugin/pom.xml to /Users/mjtrac/.m2/repository/com/kaurpalang/mirth-plugin-maven-plugin/1.0.2-SNAPSHOT/mirth-plugin-maven-plugin-1.0.2-SNAPSHOT.pom
[INFO] Installing /Users/mjtrac/Documents/GitHub/mirth-plugin-maven-plugin/target/mirth-plugin-maven-plugin-1.0.2-SNAPSHOT.jar to /Users/mjtrac/.m2/repository/com/kaurpalang/mirth-plugin-maven-plugin/1.0.2-SNAPSHOT/mirth-plugin-maven-plugin-1.0.2-SNAPSHOT.jar

Then, you can manually install the current Mirth jar files into your local Maven repository with a series of commands modeled on this one, one for each jar file that Maven cannot download from the kpalang repo and therefore reports as an error.

In this example command, the jar file is located in the Mirth Connect install tree's server-lib folder, but other required jar files may be located in other subfolders.

Replace 4.3.0 below with the version number of Mirth you've installed, and replace the file, groupId, and artifactId as necessary. (The command can be entered as a single line.)

mvn install:install-file \
  -Dfile=<path to your local Mirth install>/server-lib/mirth-server.jar \
  -DgroupId=com.mirth.connect \
  -DartifactId=mirth-server \
  -Dversion=4.3.0
  -Dpackaging=jar

This adds the file to your standard "local repository" (typically ~/.m2/repository) so that maven will not need to download it from elsewhere.

The command should give a response that includes something like:

[INFO] Installing <path to your Mirth install>/server-lib/mirth-server.jar
  to <your home dir>/.m2/repository/com/mirth/connect/mirth-server/4.3.0/mirth-server-4.3.0.jar

After running mvn install commands following the style above, my local repository has the following Mirth Connect 4.3.0 files installed (you may not need all of these):

/Users/mjtrac/.m2/repository/com/mirth/connect/...
...mirth-client-core/4.3.0/mirth-client-core-4.3.0.jar
...donkey-model/4.3.0/donkey-model-4.3.0.jar
...mirth-client/4.3.0/mirth-client-4.3.0.jar
...mirth-server/4.3.0/mirth-server-4.3.0.jar
...donkey-server/4.3.0/donkey-server-4.3.0.jar
...connectors/vm-shared/4.3.0/vm-shared-4.3.0.jar
...connectors/vm-server/4.3.0/vm-server-4.3.0.jar
...connectors/vm-client/4.3.0/vm-client-4.3.0.jar
...plugins/messagebuilder-shared/4.3.0/messagebuilder-shared-4.3.0.jar
...plugins/rulebuilder-shared/4.3.0/rulebuilder-shared-4.3.0.jar
...plugins/messagebuilder-client/4.3.0/messagebuilder-client-4.3.0.jar
...plugins/rulebuilder-client/4.3.0/rulebuilder-client-4.3.0.jar

The groupId is com.mirth.connect for the mirth- and donkey- files and com.mirth.connect.plugins for plugins; the artifactId to use is the jar name less the version and jar extension; ...donkey-model/4.3.0/donkey-model-4.3.0.jar --> artifactId donkey-model.

To add additional versions, you can repeat the process with other versions of Mirth Connect, which can be downloaded from https://mirthdownloadarchive.s3.amazonaws.com/connect-downloads.html

TODO

  • Allow file selector saving of generated text and html.
  • Add data type properties for filters and transformers.
  • Investigate adding capability to channel view rather than settings.
  • Enable retrieval via Mirth Connect API

NOTE

Although I am an instructor for NextGen, this work is completely independent of my job and any errors are my own. Also, the Mirth Connect build system, Mirth Connect's dependencies, Java versioning, and Java build systems are all mysteries to me, so I've just tried to follow Kaur Palang's structure and guide, for which I am grateful.

Mitch Trachtenberg, mjtrac at gmail dot com.