Mirth® Connect and JavaScript

Mirth® Connect by NextGen Healthcare User Guide

The User API (Javadoc)

The user API (application programming interface) is a collection of Java classes and methods that helps you interact with channels and the message that is being processed. It also provides helper methods for common tasks such as date formatting. Wherever you are editing JavaScript code in Mirth® Connect, you can view the API by selecting the View User API function in the Other panel, which is available on all Mirth® Connect Administrator views. Image of the View User API task on the Other menu. You can also right-click/command+click in the text area of any JavaScript Editor, and on the drop-down menu, select View User API. Image of the process of viewing the user API from the JavaScript Editor. The Javadoc appears in your default web browser, in which you can select classes to view their method signatures and descriptions. Image of the Javadoc. Note: You can also view the API via this link: http://javadocs.mirthcorp.com/connect/3.6.0/user-api/ Parent topic: Mirth Connect and JavaScript

Mirth® Connect by NextGen Healthcare User Guide

Using JavaScript in Mirth® Connect

This section shows you how to use JavaScript to perform various messaging operations within Mirth® Connect. About E4X Accessing Message Data with E4X Adding Segments to a Message Segments are a group of fields that can contain varying types of data. Each segment exists independently and can be used in multiple messages. Deleting a Segment Iterating Over Message Segments Iterating Over Repeating Fields Adding a New Repeating Field Message Variables Built-In Code Templates Using Java Classes Regular Expressions Logging with JavaScript Generating a Hash with JavaScript How to generate a hash using Javascript. Parent topic: Mirth Connect and JavaScript

Mirth® Connect by NextGen Healthcare User Guide

Mirth® Connect Debugger

The Mirth Connect Debugger tool allows you to troubleshoot JavaScript errors throughout the Mirth® Connect application. The Debugger can be used for the following scripts and connectors: Deploy, Undeploy, Preprocessor, and Post Processor scripts Attachment/Batch scripts Source Connectors: Filters/Transformers Database Reader and JavaScript Reader types Destination Connectors: Filters/Transformers. Database Writer and JavaScript Writer types Response transformers Before You Begin If your Java application does not interact directly with a user, use the following steps to change the Headless mode to false. Setting this mode to false means that your Java application: Displays windows or dialog boxes. Accepts keyboard or mouse input. Uses any heavyweight AWT (Abstract Windowing Toolkit) components. To Edit the mcserver.vmoptions file Use the Debugger Debugger Window Debugger Menus Parent topic: Mirth Connect and JavaScript

Mirth® Connect by NextGen Healthcare User Guide

Using the JavaScript Editor

Mirth® Connect has a rich JavaScript editor that includes automatic code completion, code folding, multi-line tabs/comment toggles, auto-indentation, bracket matching, macros, and much more. Using the Context Menu in the JavaScript Editor Remapping Editor Shortcut Keys Using the Auto-Completion Popup in the JavaScript Editor Using the Context Menu in the JavaScript Editor Using the Auto-Completion Popup in the JavaScript Editor Remapping Editor Shortcut Keys Parent topic: Mirth Connect and JavaScript

Mirth® Connect by NextGen Healthcare User Guide

Variable Maps

Throughout the Message Processing Lifecycle, your channels and messages have access to various maps. Depending on the scope, the map may only be available in the current channel/connector, or may be globally available across your entire system. These variable maps allow you to store a piece of information that can be used later (in a downstream channel, connector, or somewhere else). A common use for these variables is to provide easy drag-and-drop for connector properties. The Destination Mappings list will display all available connector/channel map variables for example. They are also used in other ways, such as populating Custom Metadata Columns. The following variable maps exist throughout Mirth® Connect: Name JavaScript Variable Get/Put Shortcut Variable Response Map responseMap $r Connector Map connectorMap $co Channel Map channelMap $c Source Map sourceMap $s Global Channel Map globalChannelMap $gc Global Map globalMap $g Configuration Map configurationMap $cfg The table above

Mirth® Connect by NextGen Healthcare User Guide

Attachment JavaScript Functions

Attachment Handlers are used to extract a portion of a message (or the entire message) and store it separately as an attachment. The portion of the message that was extracted is replaced with an attachment replacement token. When you use a destination connector to send a message downstream, Mirth® Connect will automatically take the message and replace any attachment tokens with the actual attachment data (unless you have Reattach Attachments turned off in the Destination Settings) . Throughout the message lifecycle you can retrieve, modify, and add new attachments with built-in helper functions. Built-In Attachment Functions The AttachmentUtil Class The Attachment Object Examples Built-In Attachment Functions The AttachmentUtil Class The Attachment Object Examples Parent topic: Mirth Connect and JavaScript

Mirth® Connect and JavaScript

Recommendations

The User API (Javadoc)

Using JavaScript in Mirth® Connect

Mirth® Connect Debugger

Using the JavaScript Editor

Variable Maps

Attachment JavaScript Functions

The User API (Javadoc)

Using JavaScript in Mirth® Connect

Mirth® Connect Debugger

Using the JavaScript Editor

Variable Maps

Attachment JavaScript Functions