Saturday, May 28, 2022
Home Integration/Interfaces Take a Tour of Mirth Connect's Dashboard Now

Take a Tour of Mirth Connect’s Dashboard Now

Open Mirth Connect Administrator Launcher and click Launch after selecting your environment.

Login to Mirth Connect Administrator.

When you first log in to the Administrator, Mirth will automatically start you out on the Dashboard.

At the very top, you will see all your channel groups. If you hit the plus icon to the left of the channel group, you will see the individual channels that make up that group.

Note that only deployed channels will show in the Dashboard. A full channel list can be seen by clicking Channels on the left-hand side. Here, you can see any undeployed channels as well as the deployed channels.

For example, you will see that channel ‘TEST 2’ is the only channel in the Default Group. Similarly, channel ‘TEST’ is one only channel in the group ‘TEST Group 1’.

On the bottom, you will see log and map information. There are three tabs that display different views, the Server Log, Connection Log, and Global Maps. Note that for any of these views, you can double click on the entry to see all the details.

The Server Log will give you all the details. It provides information such as operational steps for channels, Runtime errors in your channel code, issues deploying or un-deploying channels, and things of that nature. Additionally, you will see the log level on the left-hand side of the entry. See the above for an example of a Server Log entry.

When you click on the Connection Log tab, you will see one row per channel and connector. For example, channel ‘TEST’ has two rows. One for its Source and one for its Destination.

For each entry, the Connection Log has the timestamp of the log entry, the channel name, the connector info, event info, and a space for more info. The event column displays the status of the channel. Here you will see various statuses like ‘Idle’, ‘Reading’, ‘Connecting’, etc. However, this status isn’t something that an Integration Engineer or Developer should be overly concerned with. For example, you might see the event column change to ‘Reading’ as it is reading a file for a channel that has a File Reader as its source connector.

If you want to hone in on the Connection Log for a specific channel, make sure you have the channel selected before looking at the Connection Log.

Click on the Global Maps tab in order to view the global map key-value pairs that you created in your channels.

This information is displayed on the dashboard because a key’s value in the global map can potentially change as messages come in for any channel. This is how the global map works in Mirth. Keep in mind that the code needs to make it to a globalMap.put statement for at least one message for the map to appear in this log at all.

Next, double click on any channel to start viewing individual messages.

Immediately, you will see that there’s a lot going on here. The top section of the display is used for navigation, the middle section shows a list of messages in chronological order and the bottom section displays the message as well as the channel map key-value pairs. The channel map should not be confused with the global map.

Navigation Bar

In the top-left, you will see the search selections that you will use to search for messages.

The Start Time and End Time fields allow you to filter your message results by the date that Mirth receives the message. If the received timestamp falls between the Start Time and End Time then the message will appear in the results.

To populate the Start and End Time fields, simply click on the calendar icon on the right side of the field. The calendar dropdown should look something like this.

Once you click on the day, the date will populate in the field and the calendar dropdown will close. If you leave the End Time null then the search will span from the Start Time until the current date/time.

Note that if you search without a Start or End Time then the results will not filter by date whatsoever. Mirth Connect Administrator will simply return all messages in the Mirth database for that channel.

Additionally, there are some scenarios where you will want to check the ‘All Day’ checkbox. The ‘All Day’ checkbox is great to use when:

  • The Start Time is populated but the End Time is not
  • The Start Day is the same as the End Day

If the Start Time is populated but the End Time is not then you likely want to search all messages from that day forward. In this case, you would want to check the ‘All Day’ checkbox before hitting Search.

Similarly, if the start day is the same as the end day then you likely want to search for all messages on that given day. In this case, you would need to check the ‘All Day’ checkbox before hitting Search.

The Text Search field will simply filter out any message that doesn’t contain the string of text you entered. If you prefer to use a regular expression then make sure to check the ‘Regex’ checkbox to the right of the Text Search field.

The page size field controls how many messages appear per page when your search returns. For example, if you leave the page size as 20, then there will be 20 messages before you get to the bottom of the scroll pane. The 21st message will appear on the next page.

Additionally, you will see a series of message status checkboxes to the right of the Search button. By default, these are all left unchecked. When these are all left unchecked, Mirth doesn’t filter by message status at all. However, if at least one box is checked, then Mirth will only return the messages that are included in the message status selection.

If you just want to clear all your search criteria, simply click Reset to the left of Search.

If you need to perform a more complex search, click Advanced… to the left of Reset.

The advanced settings allow you to search by the specific content type. This includes all message states, maps, errors, etc.

In the contains fields, enter the text string that you want to search for in the content.

Similarly, you can filter the metadata by comparing it to a particular value. Your options include equal to, not equal to, contains, does not contain, starts with, does not start with, ends with, and does not end with.

For example, the ‘TYPE’ metadata will have the message type and the triggering event. By changing the metadata to ‘TYPE’ and placing the message type and triggering event separated by a single hyphen, you can easily filter based on any criteria involving message type.

Messages

At this point, you should have a good understanding of how to search for the messages you want to view. Once you get the selection you want, click on a message. The message should now appear in the box below. Note that there is one row per connector (Source or Destination) per message.

In the list, you will see the following columns:

  • Id
  • Connector
  • Status
  • Received Date
  • Response Date
  • Errors
  • SOURCE
  • TYPE

Pay particular attention to the Received Date and Response Date. These two fields will tell you how much time it took for the channel to process that message from start to finish.

You will see different radio buttons for each message state when viewing the message. When selecting the source, your only options are ‘Raw’, ‘Transformed’, or ‘Encoded’. When selecting a destination connector, your options are expanded to also include ‘Sent’ and ‘Response’.

‘Raw’ is exactly how the messages come into Mirth. ‘Transformed’ is Mirth serializing the raw data in XML format. ‘Sent’ is the message after it goes through the destination transformer and the ‘Response’ is the ACK or message that is received from the other system/destination.

Lastly, click on the Mappings tab at the bottom of the screen.

Here you can see the scope, variable (key), and the variable’s value for the different maps. The scope column tells you which map the variable belongs to. For example, since the scope of d1 is ‘Response’, d1 is a variable (key) in the Response Map.

Finally, you can double click on any variable in order to fully view its value.

Message Tasks

Now that you can find and select your messages you need to do something with your messages. On the left-hand side, you will find a panel of action items available to you.

Refresh

Clicking Refresh will update the selection of messages that are already on the screen with the most recent information. This is equivalent to hitting Search. In fact, you will even notice that the Search button is pressed when you click Refresh.

Send Message

Send Message is a great tool that you should take full advantage of. When you click Send Message the dialog below appears.

Instead of having to initiate a message from the sending system or from your own application (to a receiving system), you can simply paste your raw message into the dialog box.

If you’d prefer to load a message from a file, you can click Open Text File or Open Binary File. This will open up a file browsing dialog for you to select the file.

Once you choose which destinations should process the message, click Process Message. Afterward, click Search (or Refresh) one more time and you will see your new message at the top of the list.

Import Messages

Mirth allows you to import messages that you exported from another environment using the Import Messages option.

Browse to find your exported messages, input your File/Folder archive, make your selection on the ‘Include Sub-folders’ checkbox and click Import.

Export Results

Export Results is the inverse function of the Import Messages.

Choose your Content type and check the ‘Encrypt’ or ‘Include Attachments’ options if you need to.

Choose if you would like to compress the file and the type of compression (zip, tar, etc.).

Browse to find your export directory, input your Root Path, and File Pattern. Note that you can use the mapped variables in the File Pattern as you saw previously with messageId. In fact, you can simply drag and drop the variables into the File Pattern field. Finally, click Export.

Remove All Messages

Remove All Messages deletes all messages for the channel from Mirth’s database. Consequently, you will not be able to see these messages after you perform the Remove All Messages operation.

If you leave the ‘Clear statistics for affected channel(s)’ option checked, Mirth will set the counts on the Dashboard back to zero.

You may have to enter ‘REMOVEALL’ into the next dialog to confirm that you actually want to remove all messages.

Remove Results

Remove Results is the same as Remove All Messages except only the results of your search are removed from the Mirth database.

If you want to use this feature, make sure you perform your search prior to removing results.

Remove Message

Remove Message is the same as Remove All Messages except only the message you have selected in the list is removed from the Mirth database.

Make sure that you have the correct message selected before clicking Remove Message.

Reprocess Results

Reprocessing a message runs the message through the source filters, source transformers, destination filters, and destination transformers again from start to finish. Reprocess Results will do this for every message in your search selection.

Checking ‘Overwrite existing messages and update statistics’ will overwrite the previous mappings and message metadata. For example, Mirth will update fields like Received Date and Response Date.

If you want to use Reprocess Results, make sure you perform your search prior to removing results.

Reprocess Message

Reprocess Message is the same as Reprocess Results except that only the message you have selected in the list is reprocessed.

Make sure that you have the correct message selected before clicking Reprocess Message.


You should now have a great understanding of Mirth Connect’s Dashboard and all of its various bells and whistles. Continue to explore the features discussed above to increase your familiarity with Mirth’s Dashboard.

RELATED ARTICLES

Why You Must Learn Mirth Connect’s User API Now

Prerequisites Basic knowledge of Mirth ConnectBasic knowledge of JavaScriptBasic knowledge of software documentation and APIsBasic knowledge of Java development NextGen provides several different APIs (Application Programming...

Leverage Mirth’s Channel Scripts Now

Prerequisites Basic knowledge of Mirth ConnectBasic knowledge of JavaScript Each Mirth Connect channel gives you the ability to leverage four different scripts that have different triggers,...

Reference a Custom Jar File in Mirth Connect Now

Prerequisites Knowledge of Java developmentKnowledge of Eclipse or another Java IDEKnowledge of Mirth Connect Many Mirth professionals are unaware that they can write their own custom...

Most Popular

Mirth Connect Extensions: What You Need to Know

Prerequisistes Basic Knowledge of Mirth Connect Overview Users can navigate to Mirth Connect's Extensions screen by selecting Extensions on the left-hand side. You should now see the following...

Take a Tour of System Settings in Mirth Connect Now

Prerequisites Basic Knowledge of Mirth Connect Introduction Mirth Connect has a multitude of system settings that are available for configuration. In larger companies, there will often be...

Why You Must Master Mirth’s Message Template Tool Today

Prerequisuites Basic Knowledge of Mirth ConnectKnowledge of Programming in Mirth Connect Introduction When writing scripts in Mirth Connect, you have a message template tool that allows you...

Make Sense of HL7 v2 Messages Effortlessly Now

Prerequisites Beginner Knowledge of HL7 Introduction If you've been in Healthcare Information Technology for any period of time, you have definitely heard of HL7 (Health Level 7)....

Recent Comments