Skip to main content


Ensemble provides support for XML documents as virtual documents. A virtual document is a kind of message that Ensemble parses only partially. This kind of message has the standard Ensemble message header and the standard message properties such as ID, Priority, and SessionId. The data in the message, however, is not available as message properties; instead it is stored directly in an internal-use global, for greater processing speed.

Ensemble provide tools so that you can access values in virtual documents, for use in data transformations, business rules, and searching and filtering messages. For background information, see Ensemble Virtual Documents.

  • When reading XML documents, Ensemble removes the XML declaration, all processing instructions, and all comments.

  • If the name of an element or attribute includes a period (.), Ensemble replaces that with a tilde (~).

    For example, an XML element named My.Element appears as My~Element in Ensemble.

You can also work with XML documents as standard Ensemble messages. To do so, you can generate classes from the corresponding XML schema. For information, see Using Caché XML Tools.

In some cases, it may be more efficient to use XML-enabled objects in productions instead of XML Virtual Documents. See “XML-Enabled Objects Compared to XML Virtual Documents” for more information.

FeedbackOpens in a new tab