Standard QIE Objects¶
QIE includes several standard objects that can be referenced and used in the scripting environment to facilitate message processing.
| Object | Description |
|---|---|
| Source Object | The source object is a read-only copy of the message data as it was received by the channel. Regardless of how the output message is changed, the source object always contains a copy of the original message data. |
| Message Object | The message object is a read/write copy of the message data. When a message enters the inbound queue, the message object is initialized to an exact copy of the source object. As mapping functions are applied, the message object is modified. When a message is sent to a destination, it is the message object data that is sent. |
| Message Cache | Message cache is a simple key-value pair in-memory-only array associated with the message. Once the message finishes processing through the channel, the message cache is discarded and no longer available. Message cache can be used to store values that need to be referenced by more than 1 node or function when processing messages through the channel (e.g. a value retrieved from a database query that needs to be referenced by another mapping function). |
| Channel Cache | Channel cache is a simple key-value pair database associated with the channel. It can be used to store configuration parameters that change or modify the behavior of the channel. It can also be used to store values that are set or retrieved while processing messages through the channel (e.g. date/time of last message sent). |
| Parameter Map | A parameter map is a simple key-value pair array used when calling web services and in other QIE functions. |
| Alternate Message | Alternate messages are custom data objects obtained from sources like database queries, web services, or files, then parsed as CSV, HL7, JSON, or other formats to supplement the main message. While not part of QIE's built-in standard objects, they function similarly and are referenced in templates when passed into the qie.evaluateTemplate() function. |
- Source Object, the original inbound message, read-only.
- Message Object, the working message, with the functions available for each message model.
- Message Cache Object is per-message key/value storage.
- Channel Cache Object is per-channel key/value storage.
- Shared Cache Object is key/value storage shared across channels.