Glossary
| Term | Definition |
|---|---|
| ACK | Acknowledgment message sent back to a sender confirming receipt of a message (common in HL7) |
| Attachment | Content stored with a message but apart from its body. The attachment handler extracts attachments as a message arrives, and a script can add or update them later. See Attachments |
| Batch | A single inbound payload that is split into multiple messages |
| Channel | The unit of integration in OIE: one source connector and one or more destinations, each with its own filter and transformer, plus the channel scripts. Cloverleaf and Rhapsody users may know the same idea as an interface or a route |
| Channel Group | A named group of channels, shown in the Channels view and on the Dashboard |
| Channel Map | A key-value store scoped to a single message across all connectors in a channel. Shorthand $c. Read-only in the postprocessor |
| Channel Writer/Reader | Internal connectors for routing messages between channels within the same OIE instance |
| Code Template | A reusable JavaScript function or code snippet shared across channels |
| Configuration Map | Server-wide key-value pairs accessible in all channel scripts; configured in Settings. Shorthand $cfg |
| Connector | The source or a destination of a channel. Its type, such as TCP Listener, File Writer, or JavaScript Writer, decides its settings and what it does |
| Connector Map | A key-value store scoped to a single message within a single connector. Shorthand $co |
| Dashboard | The main operational view showing deployed channels and their real-time statistics |
| Data Pruner | A background process that automatically removes old message data |
| Data Type | A message format (e.g., HL7 v2.x, XML, JSON, DICOM) and the settings the engine uses to serialize and deserialize it. The data type decides what msg and tmp are: E4X XML for XML-based types, a JavaScript object for JSON, a JavaScript String object for Raw |
| Deploy | Loading a saved channel definition into the engine. Scripts are compiled, connectors created, tables reconciled, and the channel is then started, paused, or left stopped according to its Initial State. See Deploy, Start, and Channel State |
| Derby | Apache Derby; the embedded database used by default for development |
| Destination | A connector that runs after the source, with its own filter and transformer. It usually sends the message somewhere, but need not: a Channel Writer left at None sends nothing. See Connectors |
| Destination Set | The set of destinations that will process a given message. Available on the source connector only, and modifiable from the source filter or transformer via destinationSet |
| DICOM | Digital Imaging and Communications in Medicine; a standard for medical imaging |
| Donkey | The internal message processing engine that handles queuing, storage, and message lifecycle |
| E4X | ECMAScript for XML; the syntax used to access message fields when the data type is XML-based (HL7 v2.x, HL7 v3.x, XML, EDI/X12, NCPDP, Delimited Text, DICOM). JSON and Raw messages are not E4X |
| EDI | Electronic Data Interchange; a standard for business document exchange |
| Extension | An add-on the engine loads at startup, such as a connector, data type, or transformer step. Most built-in features ship as extensions. See Plugin Guide |
| Filter | A set of rules that determine whether a message should be processed or rejected. Compiled into the same script as its transformer: a variable a rule assigns without var is still there in the transformer, while one declared with var stays inside its rule |
| Global Channel Map | A key-value store shared across all messages within a specific channel. Shorthand $gc. Held in memory, not stored with messages, and cleared when the channel deploys unless its setting says otherwise. Not present in the global deploy and undeploy scripts |
| Global Map | A key-value store shared across all channels on the server. Shorthand $g. Held in memory until the server restarts, not stored with messages, and cleared on Redeploy All by default |
| HL7 | Health Level Seven; a set of international standards for healthcare data exchange |
| Iterator | A transformer step and filter rule type that loops over repeating segments or elements |
| Mapper | A transformer step type that extracts a value from the source message into a variable |
| Message | One unit of data processed by a channel |
| Message Browser | The UI for searching, viewing, and managing individual messages. Channel and connector map entries appear on its Mappings tab |
| Message Builder | A transformer step type that sets a field in the outbound message |
| Message Storage Mode | Controls how much message content is persisted (Development, Production, Raw, Metadata, Disabled) |
| MLLP | Minimal Lower Layer Protocol; the standard framing protocol for HL7 over TCP |
| NACK | Negative Acknowledgment; indicates a message was received but could not be processed |
| NCPDP | National Council for Prescription Drug Programs; a pharmacy transaction standard |
| OIE | Open Integration Engine; this project |
| Postprocessor | A channel script that runs after all destinations have processed a message. Its source map and channel map are read-only; its response map is writable |
| Preprocessor | A channel script that runs before the source filter and transformer, receiving the raw message as a String in message |
| Pruning | The process of removing old message data from the database |
| Queue | A set of rows in the database, not an in-memory structure: the source queue is this connector's messages in RECEIVED status, a destination queue is that destination's messages in QUEUED status. Each keeps a small in-memory buffer filled from that query. See Queueing |
| Response | What a destination got back when it sent a message |
| Response Map | A key-value store holding each destination's response under its d key, plus anything a script puts there. The source can return any entry as its response. Shorthand $r |
| Rhino | Mozilla Rhino; the JavaScript engine used by OIE. Language version is set by rhino.languageversion in mirth.properties |
| Rule | A single condition within a filter (Rule Builder, JavaScript, External Script, or Iterator) |
| Serialization | Converting a message from its inbound data type into the internal representation that filters and transformers work with: XML for every built-in data type except JSON and Raw. Deserialization is the reverse, from the internal representation to the outbound data type |
| Source | The connector that receives inbound messages for a channel |
| Source Map | A key-value store populated by the source connector with metadata (e.g., remote address). Shorthand $s |
| Step | A single operation within a transformer (Mapper, Message Builder, JavaScript, etc.) |
| Tag | A label applied to channels, used to filter them in the Channels view and on the Dashboard |
| Template | Either a transformer's outbound message template, which becomes tmp, or a destination connector's content field, which supports variable substitution |
| Transformer | A sequence of steps that modify message content as it passes through a connector |
| Transmission Mode | The framing protocol used by TCP connectors (MLLP, Basic) |
| Undeploy | The reverse of deploy: the channel is stopped, its connectors are undeployed, its undeploy script runs, and the engine unloads it. See Undeploy |
| VM | The underlying connector protocol for channel-to-channel routing; exposed in the UI as Channel Reader (source) and Channel Writer (destination) |