Saturday, May 28, 2022
Home Uncategorized Take a Tour of System Settings in Mirth Connect Now

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 a System Administrator that manages that integration engine and server settings. However, Integration Engineers still need to possess this knowledge, especially as it pertains to the Mirth Connect engine because they will not always have the luxury of depending on a Systems Administrator.

To access the Mirth system settings, select Settings under the Mirth Connect panel on the left-hand side.

Afterward, you will see numerous tabs across the top of the screen (see below).

These include Server, Administrator, Tags, Configuration Map, Database Tasks, Resources, Data Pruner. By default, you will start on the Server tab.

This article will touch on each of these separately. Keep in mind that some of these settings will be more relevant to your daily work than others. For example, most Mirth Engineers will be adding or deleting entries in the configuration map more often than configuring the data pruner, which is typically done once after Mirth is installed.

Regardless of how often you use these settings, it’s essential that Mirth Engineers know the purpose of each.

Settings

Server

Click on the Server tab and you will see the following configuration options.

Server settings are broken down into three sections: General, Channel, and Email.

General

The Environment name would be something to the effect of ‘PROD’, ‘TEST’, or ‘DEV’, for example (It is good practice to have at least a Test and a Production interface server). Consequently, Mirth gives you the opportunity to document that here.

Similarly, Integration Engineers should place the interface server name in the Server name field.

Lastly, users have the option to report stats back to NextGen in order to improve the Mirth Connect engine going forward. Clicking More Info will take you to a legal notice on NextGen’s website.

Channel

Typically, the global map is only cleared when the server restarts. However, if you tell Mirth to clear global map on redeploy, the global map will be cleared and the global scripts will be re-run when one or more channels are redeployed. This is something that most Mirth Engineers don’t initially realize early on.

The default queue buffer size sets the standard size of a source or destination queue in Mirth. This is typically set to 1000 messages that persist in system memory.

Finally, Mirth Developers can set the default metadata columns. By default ‘Source’ and ‘Type’ are checked. These standard metadata columns are the additional fields that show when viewing messages within the dashboard. This setting applies to every channel; however, specific metadata settings can also be configured on the channel level.

In your dashboard, you will see SOURCE and TYPE as far right-hand columns on your channel.

Email

Mirth Connect can send and receive emails using the SMTP Sender and SMTP Reader connectors, respectively. Consequently, this section allows you to configure an SMTP host. Enter the server name in the SMTP host field and then the port number. You can now click ‘Send Test Email’ to see if your Mirth instance can communicate with the SMTP host.

Administrator

Click on the Administrator tab and you will see the following configuration options.

Administrator settings are broken down into three sections: System Preferences, User Preferences, and Code Editor Preferences.

System Preferences

System Preferences contain a variety of settings that pertain to engine operations and the user interface of Mirth Connect Administrator. For example, say you want to dashboard to refresh every 5 seconds instead of every 10 seconds. System Preferences is where you would set that.

The last two settings are particularly relevant to Integration Developers. Under Channels, you can import or export a channel. Typically, a dialog will pop up asking if you want to include the code template functions with the import/export. You can set the default action to always import/export or never import/export by selecting ‘Yes’ and ‘No’, respectively, using the following two settings:

I would recommend keeping both of these settings as ‘Ask’ because there will be times where you will want the code templates and times where you won’t.

User Preferences

There is only one setting under User Preferences:

If you have been using Mirth Connect for any period of time, you will have noticed the dialog that pops up when you launch the Administrator. This dialog updates users when new versions of Mirth Connect Administrator are released. If you don’t plan on upgrading versions and rather not see this dialog, you can set this setting to ‘No’. Otherwise, it is good to leave as ‘Yes’.

Code Editor Preferences

The Code Editor Preferences primarily allow Mirth professionals to modify shortcut keys when programming in the code editor:

The default settings are consistent with the well-known shortcuts you might use with other applications. Consequently, there isn’t a real need to make any modifications.

Tags

Click on the Tag tab and you will see the following configuration options.

Tag settings are broken down into two sections: Tags and Channels.

The Tag tab is an all-encompassing management widget for your channel tags. Users can add tags to channels in order to help with searching. This is very convenient when your Mirth Connect instance has a large number of channels.

Tags

You can search by tag with the search bar at the bottom of the screen under the Channels view.

To get here, click Channels on the left-hand side.

Afterward, you should see the Filter text field at the bottom center of your screen.

Back in Settings, you can add tags to the system by clicking Add on the right-hand side.

After you add your tag, make sure to click Save on the left-hand side.

Note: You can also add tags at the channel level. The Tags tab in Settings is just used to manage everything at a Mirth instance level.

Channels

This section allows users to bulk apply tags to one or more channels. This is a much more efficient way to assign tags without going into every channel and assigning them manually.

To use this feature, first select the tag you want to assign. Afterward, check one or more channels below to make the association.

Again, make sure to hit Save on the left-hand side to keep your changes.

Configuration Map

The Configuration Map, like the other Mirth maps, stores key-value pairs that can be used in channels. It can be accessed the same way you would use the channelMap, globalChannelMap, or globalMap. However, the Configuration Map should contain values that rarely change and should be used for configuration purposes, hence the name.

This includes data like database connection strings, endpoints, constants that may be passed into functions repeatedly, etc.

Click here to take a deeper dive into Mirth’s Configuration Map.

Database Tasks

As a Mirth Connect user, there isn’t much that you need to know about Database Tasks. This tab just serves as a viewer for cleanup or optimization tasks on mirthdb (Mirth’s internal Postgres database). If you notice any weird behavior or application failures, it might be a good idea to check this tab for any evidence of database issues.

You can see that there are two basic sections, the frame that shows the task and the frame that shows affected channels. Again, you shouldn’t have to visit this tab very frequently as a Mirth Engineer.

Resources

The Resources tab lets users view the external software components or systems that the Mirth Connect instance can interact with.

If you have the free version of Mirth, the only resource type available for use is Directory.

Most commonly you will see the Default Resource contain one or more jar files composed of Java methods that are invocable in the code editor. Below you will see that the Default Resources contains one jar file, named MirthDev.jar.

You might be trying to think of a case where you would need to write some custom Java code for your Mirth Connect project. Consider a Mirth engineer who writes his own Java method to perform an HTTP GET request. Instead of using Mirth’s built-in HTTP connector with the SSL Manager, a Mirth engineer can perform HTTP GETs as many times as necessary within the code editor. This is different from the Mirth HTTP connector which only allows you to perform the GET one time.

Data Pruner

The Data Pruner is a background process in Mirth Connect that handles the deletion of messages. You can read our entire piece on the Data Pruner here. However, here is a preview of what you can configure with the Data Pruner:

Data Pruner settings are broken down into four sections: Status, Schedule, Prune Settings, and Archive Settings. Mirth engineers should check this tab to get a better high-level idea of any message pruning or mirthdb storage issues.

RELATED ARTICLES

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...

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)....

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