Message Detail using CSV file (Default Model CSV Processor) as Example

This provides an example of enabling MessageDetail for an InboundInterface with a Default Model CSV Processor.

  1. Create an inbound interface of format type CSV
    For this example, we will create an Inbound Interface for loading Enterprise data. Name the interface EnterpriseLoad.

    images/download/attachments/144836159/message-detail-ent-inbound-interface-version-1-modificationdate-1645137679000-api-v2.png


    Use the Format tab to specify which fields are present in the interface, and the Processor tab to specify which action to execute. Click Add Fields, then click Enterprise within the list of Models.

    images/download/attachments/144836159/message-detail-inbound-interface-add-fields-version-1-modificationdate-1645137686000-api-v2.png


    images/download/attachments/144836159/message-detail-ent-fields-inbound-interface-version-1-modificationdate-1645137697000-api-v2.png


    Configure the Processor as "Default Model CSV Processor". Specify a default custom model name and/or action in the interface itself. Provide Standard Enterprise for Default Custom Model Name and PLT.InsertOrUpdate for Default Action Name.

    images/download/attachments/144836159/message-detail-inbound-interface-csv-processor-version-1-modificationdate-1645137718000-api-v2.png


    Now save and submit your MPT. At this point, you have an Inbound Interface which you can use to load Enterprises. To enable the MessageDetail feature, you must add an entry into ExternalReference as “AllRecords”, “ErrorRecordsOnly” (or “None”). Create new file called PLT_ExternalReference.csv or add entry in existing external reference csv file with following content:

    #* 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

    Load this external reference entry for message detail using PLT.ExternalReference_IB 1.0

  2. Now create csv file which contains enterprise data and load it.

    images/download/attachments/144836159/message-detail-ent-csv-version-1-modificationdate-1645137730000-api-v2.png



  3. As we have an ExternalReference at queue level as well as queue+interface, first priority will be given to queue+interface (100~inbox/CSV~ZBKS.EnterpriseLoad~1.0). Thus Platform will capture only error records in Message Detail:

    images/download/attachments/144836159/message-detail-records-version-1-modificationdate-1656018627000-api-v2.png


    Message Detail Table Entries:

    images/download/attachments/144836159/message-detail-table-records-version-1-modificationdate-1645137739000-api-v2.png
  4. Adding the MessageDetailReport will display these entries in a user-readable format:

    images/download/attachments/144836159/message-detail-report-for-a-interface-version-1-modificationdate-1645137746000-api-v2.png
  5. Likewise, if we were to change our policy to AllRecords, we would see a different outcome, with a mix of SUCCESS and ERROR:

    images/download/attachments/144836159/message-detail-ent-search-report-all-records-version-1-modificationdate-1645137780000-api-v2.png
  6. If we want to be available for more or less then the default 30 days, we can add entry below into ExternalReference:

    #* Ref Type,* External Value, Local Value, Description
    PLT.MessageDetail:PurgeAfter,100~inbox/CSV,10, Message Detail entries for this queue older than 10 days gets deleted
    PLT.MessageDetail:PurgeAfter,100~inbox/CSV~EnterpriseLoad~1.0,20, Message Detail entries for this queue and interface older than 20 days gets deleted

    The time-based workflow below will execute automatically each evening to purge according to these rules.

    images/download/attachments/144836159/message-detail-purge-jmx-console-version-1-modificationdate-1645137797000-api-v2.png