The AttachmentUtil Class

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

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

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

JavaScript HTTP Authentication

Allows you to authenticate users with a custom JavaScript script. With this script you have access to source map variables, and can choose whether to send a challenged or failure response back to the client. The default script simply allows all requests to pass. The Script field will show <Default Script Set> if the default script is currently being used. If you have made any modification to the script, the Script field will show <Custom Script Set>. Select the Script field to edit the JavaScript: This script expects either a boolean ( true to accept the request, false to send back a failure response) or an AuthenticationResult object to be returned (for additional information, see User API) . There are three types of results you can return: AuthenticationResult.Success(): The request will be accepted and processed through the channel. AuthenticationResult.Challenged(authenticateHeader): The request will not be processed through the channel. A 401 response will be sent back to the clie

Mirth® Connect by NextGen Healthcare User Guide

Built-In Attachment Functions

getAttachmentIds() Get a List containing the IDs of all Attachments associated with this message. Uses the current connectorMessage variable. getAttachmentIds(channelId, messageId) Get a List containing the IDs of all Attachments associated with any channel / message. channelId The ID of the channel associated with the attachments. messageId The ID of the message associated with the attachments. getAttachments(base64Decode) Get List of Attachments associated with this message. This will get all attachments that have been added in the source and destination(s). base64Decode If true, the content of each attachment will first be Base64 decoded for convenience. getAttachment(attachmentId, base64Decode) Get a specific Attachment associated with this message. Uses the current connectorMessage variable. attachmentId The ID of the attachment to retrieve. base64Decode If true, the content of the attachment will first be Base64 decoded for convenience. getAttachment(channelId, messageId, attachm

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

The AttachmentUtil Class

Recommendations

The Attachment Object

Attachment JavaScript Functions

Extract Attachments

JavaScript HTTP Authentication

Built-In Attachment Functions

The User API (Javadoc)

The AttachmentUtil Class

The Attachment Object

Attachment JavaScript Functions

Extract Attachments

JavaScript HTTP Authentication

Built-In Attachment Functions

The User API (Javadoc)