Apama recommends that you use copyUnmappedToDictionaryPayload instead of the deprecated copyUnmappedToPayload. Using copyUnmappedToDictionaryPayload puts all the payload fields in a standard EPL dictionary, it is more easily accessed, more efficient, and easier to use. In contrast, copyUnmappedToPayload uses a custom format that requires the use of the PayloadPlugin to decode and access.

The contents of the payload field used by copyUnmappedToPayload are structured as a list of field name and value pairs. Although this may be directly accessed as a string within EPL code, Apama provides the Payload Correlator plug-in to make extraction and manipulation of specific fields more straightforward. This plug-in is included with Apama.

The Payload Extraction plug-in is available as libPayloadPlugin.so in the Apama installation’s lib directory on UNIX. On Microsoft Windows it is available as PayloadPlugin.dll in the Apama installation’s bin folder.

For information on how to use the Payload Extraction plug-in, and on the suite of EPL functions it provides, see Using the Payload Extraction plug-in.