Attachment JavaScript Functions

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

Extract Attachments

Use the following method to extract and store attachments from the attachment script: The resulting Attachment object contains the ID you need to inject back into the message. For more information, look at the User API. The return value for the JavaScript attachment script should be the final message string, with any attachments extracted out and replaced with attachment replacement tokens. addAttachment(data, type) Creates and stores an attachment for the current message. 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. The resulting Attachment object contains the ID you need to inject back into the message. For more information, look

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

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

Channel Properties

Item Name Description A Name The name of the channel. Only alphanumeric (a-z / 0-9) characters, spaces, hyphens, and underscores are allowed. B Enabled Indicates whether the channel is ready to be deployed. All enabled channels will automatically be deployed with the Mirth® Connect by NextGen Healthcare server starts up. If there is an error in your channel configuration, this will automatically be unchecked. C Set Data Types Dialog Configure data types across your entire channel, from the source connector to each of your destination connectors. Allows easy bulk editing of data type properties. For additional information, see Set Data Types. D Clear global channel map on deploy If checked, the global channel map for this channel will be cleared out whenever the channel is redeployed. E Set Dependencies Configures Code Template Libraries, Library Resources, and Deploy/Start Dependencies for this channel. For more information, see Set Dependencies Window. F Initial State Determines what

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

Attachment JavaScript Functions

Recommendations

The AttachmentUtil Class

Extract Attachments

Destination Settings

The Attachment Object

Channel Properties

Message Attachments

The AttachmentUtil Class

Extract Attachments

Destination Settings

The Attachment Object

Channel Properties

Message Attachments