Extract Attachments

Table 1. Parameters
Name	Type	Description
data	String or Byte array	The actual attachment data to insert. Man be either a String or a byte array. If a string is used, it is assumed to be a Base64 encoded representation of the actual attachment data.
type	String	The MIME type of the attachment. For additional information see Attachment Handlers.
<Return Value>	Attachment	The inserted Attachment object.

Mirth® Connect by NextGen Healthcare User Guide

Scope Variables

In addition to the standard global scope variables, the following are available from within the JavaScript attachment handler script: message: This is the raw inbound message string. If the data was passed in as a raw byte array, this variable will be the Base64 encoded string representation of the data. binary: This is a boolean that indicates whether the inbound data was passed in as a raw byte array. sourceMap: You have access to any variables in the source map. For additional information, see Variable Maps. Extract Attachments Parent topic: JavaScript Attachment Handler Properties

Mirth® Connect by NextGen Healthcare User Guide

The Attachment Object

When using these methods, you will likely be working with a special class called Attachment. This class is documented in the User API. A few of the available methods are documented here: Create a new Attachment new Attachment() new Attachment(id, content, type) new Attachment(id, content, charset, type) id The unique ID of the attachment. content The content (String or byte array) to store for the attachment. charset If the content passed in is a string, this is the charset encoding to convert the string to bytes with. If the content is a String and a charset is not used, UTF-8 will be used as the charset. type The MIME type of the attachment. Retrieve Attachment Content Note: When you retrieve an attachment using the Built-In Attachment Functions or The AttachmentUtil Class, you may want to pass in true for the base64Decode argument so that the attachment content is already decoded. getContent() Retrieves the raw byte array content of the attachment. Note that this may be the actual r

Mirth® Connect by NextGen Healthcare User Guide

Destination Settings

These are general settings that apply to all destination connectors. They include configuring the destination queue, whether to validate responses, and whether to re-attach attachments on outbound messages. Item Name Description A Queue Messages Never: Disable the destination queue. On Failure: Attempt to send the message first before queuing it. This will allow subsequent destinations and the Postprocessor to use the response from this destination if it successfully sends before queuing. Always: Immediately queue the message. Subsequent destinations and the Postprocessor will always see this destination's response as QUEUED. B Advanced Queue Settings Configure how often to re-attempt queued messages, increase queue threads, and more. C Validate Response Select Yes to validate the response. Responses can only be validated if the response transformer's inbound properties contains a Response Validation section. If validation fails, the message will be marked as queued or errored. For add

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 by NextGen Healthcare User Guide

JavaScript Reader Return Values

If you are using the JavaScript Reader to produce messages for the channel, all you need to do is return those messages from the script. The following return values are accepted: String: Any non-empty string returned will be sent to the channel as a message. RawMessage: This is a special object that contains not only the string message data, but also information about which destinations to dispatch to, and any source map variables you wish to inject. For additional information, see The User API (Javadoc). List: If a Java List is returned, all values in the list will be sent to the channel as discrete messages. The list may contain a mix of Strings, RawMessage objects, or other objects. Empty String / null / undefined: Returning any of these (including just a "return;" statement or no return statement at all) will cause no messages to dispatch to the channel. Any Object: Any other object returned will be converted to a String via the toString() method, and that String representation wil

Mirth® Connect by NextGen Healthcare User Guide

The AttachmentUtil Class

All of the Built-In Attachment Functions are also available from the AttachmentUtil utility class available from the User API. In addition to this, AttachmentUtil has some extra methods available that you can use to re-attach attachment data into a message string. For more information, check out the AttachmentUtil class in your locally hosted User API: The User API (Javadoc) You can also view the documentation for this class here: http://javadocs.mirthcorp.com/connect/3.6.0/user-api/com/mirth/connect/server/userutil/AttachmentUtil.html Parent topic: Attachment JavaScript Functions

Extract Attachments

addAttachment(data, type)

Recommendations

Scope Variables

The Attachment Object

Destination Settings

Attachment JavaScript Functions

JavaScript Reader Return Values

The AttachmentUtil Class