Files in a Batch
When the Manage Batches Utility is run in either "Create" or "Test" mode, a set of files are created under the Fulfillment virtual directory of the Emplifi Agent website. For each batch, a subdirectory is created whose name is in the following format: companyid_Bbatchid.
Examples:
SYS_B00000010
ABC_B00001234
The Batch Contents are stored in database tables: batch_letter, batch_enclosure, batch_exception, batch_summary, batch_document, and batch_document_summary.
The following files are included in the batch subdirectory:
FulfillmentRequest.xml: This file contains the TransactionRequest XML file that was run by the Manage Batches Utility when the "Create" or "Test" method was used to create the batch. It is only for reference and troubleshooting purposes. It is not used by any other process.
FulfillmentResponse.xml: This file contains the results of the batch operations. It is loaded and displayed in the Process Batch window after selecting a Batch ID. It contains the following three sections:
The PrintDocumentList of Print and Label documents created.
The SummaryList showing the number of exceptions, enclosure and letter type counts for the batch.
The DetailList showing the exact Cases, Letters, and Enclosures that are part of the batch and any that failed to be part of it due to exceptions.
UnBatchRequest01.xml: This file is created every time the Manage Batches Utility is run on the batch with any method other than "Create" or "Test." The number in the filename is incremented sequentially. The file contains the XML request for the process.
UnBatchResponse01.xml: This file contains the response to the request sent in the previous file. It is for reference only and is not used by any process.
[JNN_code;] This represents the Enclosure J code Split value defined in the configuration settings for fulfillment.
Labels;LabelTemplate.htm: This file is the print-ready HTML file for all labels needed to be printed for the batch. The name after the semicolon is the file name of the Letter Template Files used for the labels.
ReturnLabels;LabelTemplate.htm: Similar to the above file, it contains all of the Return Labels needed for enclosures.
[JNN_code;]N;LetterFormat;LetterTypeCode;Template.htm:
The file name is a combination of the following elements:
This is taken from the attribute "Print Doc Order" from the Letter Type Code definition. For more information about Letter Type Codes see, Defining Letter Type Codes.
The letter format (1=Plain Text, 2=HTML Text, X=enclosures without letters).
The Letter Type Code on the letter, or "NoLetter" for enclosures without letters.
The name of the Letter Template Files of the letter (or "PickList.htm" for enclosures without letters).
PickLIst[JNN_code].txt: This file is the Print Pick List document that contains the case enclosure items that need fulfilled. A file may exist for each of the split codes (JNN_code) defined for the Print Documents. The file format of the Pick List file has the following columns from the Case Enclosure:
|
|
For the last file type, there will be one of these files for each combination that was added to the Batch. Print files are combined for the above groups, since printing the different file types at the same time is not supported by Windows, and it is assumed that different Letter Type Codes require different physical paper.
Print documents can also be split by Label/No Label to make it easier for personnel to affix the labels to the correct letter envelopes. This option is controlled by a configuration setting. For details, see Configuration: Fulfillment.