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

Message Attachments

An attachment is a piece of data extracted from the raw incoming message and stored separately. Attachments are not associated with connector messages, but instead with the overall message. The extraction happens at the very beginning of the message lifecycle, even before the preprocessor script runs. When a destination connector dispatches data outbound, any attachments associated with the message will be automatically re-inserted into the outgoing data. In this way, attachment data is only stored once, and multiple copies of it for each connector and for each content type (e.g. Raw / Transformed / Encoded) will not be stored. Using attachments can greatly improve the memory footprint of your channels. More additional information on attachments and how they are extracted, see Attachment Handlers. Parent topic: About Message Data

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

Edit Global Scripts

Select a script type from the drop-down menu and edit the script in the text area below. There is also a Reference List to the right for easy drag-and-drop of common helper methods / code templates. The following global script types can be edited: Deploy Script: This script executes once whenever any channel or set of channels deploys. You have access to the global / configuration maps here. Typically this script is used to perform a one-time operation, such as loading a properties file from disk, or instantiate a database connection. Undeploy Script: This script executes once whenever any channel or set of channels is undeployed. You have access to the global / configuration maps here. Typically this script is used to cleanup any data created from the deploy script, such as closing a database connection. Preprocessor Script: This script applies across all channels, and executes once for every message, after the attachment handler has run but before the message reaches the source filte

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

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

Extract Attachments

addAttachment(data, type)

Recommendations

Scope Variables

Message Attachments

The Attachment Object

Edit Global Scripts

The AttachmentUtil Class

Destination Settings

Extract Attachments

addAttachment(data, type)

Scope Variables

Message Attachments

The Attachment Object

Edit Global Scripts

The AttachmentUtil Class

Destination Settings