Enabling Message Detail

A single Message can potentially contain thousands or millions of records. This has the potential to overload the MessageDetail if used indiscriminately.

To address this, MessageDetail can be enabled for a queue+interface combination either at the level of "AllRecords", "ErrorRecordsOnly” or "None" using ExternalReference. This allows an administrator to tune MessageDetail population as appropriate. Also, please see the "Document Storage" section for information on how to configure the storage of MessageDetail in Elasticsearch instead of Oracle, further improving scalability.

Message Detail is supported without code changes for CSV interfaces of type "Default CSV Processor" and "SQL Processor". Likewise, outbound CSV integration is also supported without code changes. For other integration formats, the processor must use the Message Detail API to write Message Detail records.

Table 16.21. External Reference Entry

Field

Value

REF_TYPE

PLT.MessageDetail:Enable

EXTERNAL_VALUE

  • <VC ID>~<Queue Name>~<Ent Name>~<interface name>~<interface version> : Enable for Enterprise-level queue and interface

  • <VC ID>~<Queue Name>~<interface name>~<interface version> : Enable for VC-level queue and interface

  • <VC ID>~<Queue Name>~<Ent Name> : Enable for Enterprise-level queue, for all interfaces

  • <VC ID>~<Queue Name>: Enable for VC-level queue, for all interfaces

LOCAL_VALUE

  • AllRecords: Message Detail enabled for all records

  • ErrorRecordsOnly: Message Detail enabled for only error records

  • None: Message Detail disabled

Sample values:

#* Ref Type,* External Value, Local Value, Description
PLT.MessageDetail:Enable,100~inbox/CSV,AllRecords, Message Detail enabled for all records
PLT.MessageDetail:Enable,100~inbox/CSV~ZBKS.EnterpriseLoad~1.0,ErrorRecordsOnly,Message Detail enabled for error records only