Adding a Byte-Order Mark to the SOAP Messages

By default, a message sent by an InterSystems IRIS® data platform web client does not start with a BOM (byte-order mark).

The BOM is usually not needed because the message is encoded as UTF-8, which does not have byte order issues. However, in some cases, it is necessary or desirable to include a BOM in a SOAP message; this BOM merely indicates that the message is UTF-8.

To add a BOM to the messages sent by an InterSystems IRIS web client, set the RequestMessageStart property of the client. This property must equal a comma-separated list of the parts to include at the start of a message. These parts are as follows:

• DCL is the XML declaration:

  <?xml version="1.0" encoding="UTF-8" ?>
  

  

• BOM is the UTF-8 BOM.

The default is "DCL".

In practice, RequestMessageStart can equal any of the following values:

• "DCL"

• "BOM"

• "BOM,DCL"