Summary
NOTE: This data encoder sends the object in Client XML format to the profile's
_datainput.
The XML data encoder passes an object as generic XML to a Lobster Integration profile. This reference describes its parameter and error behavior. It is intended for integration specialists and IT admins.
Important
IMPORTANT: This variant is available only for compatibility reasons. For new configurations, use the Server data encoder or the JSON data encoder.
Purpose
The XML data encoder converts a Lobster Data Platform object into XML. The transfer uses the Client XML format. The target profile receives the data at the _data input. In the Call profile behavior, you select the encoder using the value CLIENT.
Parameters
Parameter | Type | Default value | Description |
|---|---|---|---|
Class field name | Text |
| Name of the XML attribute that declares an object's class. If you leave the field empty, the output XML omits the reference to the data type. |
Error behavior
If the Class field name contains invalid characters, the encoder fails at runtime. Special characters and spaces are invalid.
If the encoder needs to create an XML element without a name, it fails with the message Failed to encode: INVALID_CHARACTER_ERR.
Difference from other data encoders
The Server data encoder uses the internal Server XML format and keeps the data structure unchanged. The JSON data encoder produces JSON. The XML data encoder produces Client XML instead.
Counterpart: XML data decoder
The XML data decoder reads the profile's response as XML. Together, the encoder and decoder form the outbound and return path of the data transfer.