This appendix contains details about the contents of a Status Receipt file and associated record types and format.
NOTE: Status receipt files are the only receipt files currently available; postage statement receipts are unavailable.
C-1 Status Receipt File Content
The receipt file conforms to these specifications:
A receipt file shall contain one or more records represented by ASCII text. The text shall be in the subset of ASCII characters indicated by the decimal values 33 to 126.
A new line character or sequence of characters (this is platform dependent) shall terminate each record.
The records of a receipt file shall contain a predefined character that shall serve to distinguish its fields. The default character shall be a comma “,”.
NOTE: You can customize the “delimiter” character by changing the Delimiter parameter in the postal1.ini file. For more information, see Section 3.1.4, Downloading and Configuring the Windows Batch Processor or Section 3.1.5, Downloading and Configuring the UNIX Batch Processor.
The receipt file record may have various types. Only one record type has been specified at this point.
A record in a receipt file shall commence with a “record-type” field that shall serve in the record’s identification. Following the record-type field shall be various character-delimited fields following a predefined sequence.
C-2 Record Types and Record Format
This section provides details about the receipt file's record types and formats. For additional information about postal1.ini parameters, see the table in Sections 3.1.4, Downloading and Configuring the Windows Batch Processor or 3.1.5, Downloading and Configuring the UNIX Batch Processor.
Record Type: status receipts
The PostalOne! system allows Batch Processor users to receive Mail.dat transaction confirmations in the form of Status Receipt files. The Status Receipt file indicates the successive stages of a Mail.dat transaction being processed and can be transmitted in two formats: XML and character delimited.
The following is the XML schema for Status Receipts:
The current record type for PostalOne! receipt files is: transfer-status. The transfer-status record shall serve to indicate the progress of the processing of a Mail.dat file transferred to the PostalOne! Java upload server. The record shall trace, through its fields, the validation, the loading, and the processing of postage statements for a Mail.dat file transfer.
the version of this receipt file. (e.g. 1.0)
Mail.dat Job ID as presented in the header file specification of Mail.dat.
the part of the name of a Mail.dat file without the extension. For example, if the files sent are foo.hdr, foo.csm and foo.cqt, the filename is foo. If the receipt record is for a finalized, a canceled or a reversed postage statement, this record will contain the container ID of one of the containers that was finalized, canceled, or reversed.
The zip plus 4 code of the mailing facility where verification occurred.
a time stamp, represented in the 24 hour time system, that indicates the creation or the receipt of a file. The Java upload server provides the time that is used.
a binary value of P or F indicating successful validation or failed validation, respectively, of a Mail.dat file.
a binary value of P or F indicating whether a file has been successfully loaded to the Java upload server's data repository for loading to a database.
a binary value of P or F indicating the successful loading of a job from the Java upload server's data repository to the database.
a Boolean value of T or F indicating whether a postage statement has been generated or has not been generated.
a value of C or null indicating whether a postage statement has been canceled or no action has been taken, respectively.
a value of F, R or null indicating whether a postage statement has been finalized, reversed or no action has been taken, respectively.
a value of T or null indicating whether an mpu edit has occurred on the front-end or not.
a numeric error code generated by the PostalOne! Java upload server that represents the occurrence or absence of an error. A zero in the field indicates the absence of error.
a message generated by the PostalOne! Java upload server that describes, with brevity, an error or warning that has occurred. If there is no error or warning, this field will be null.
Record Type: transfer-status
The current record type for PostalOne! receipt files is: transfer-status.
The transfer-status record shall serve to indicate the progress of the processing of a Mail.dat file transferred to the PostalOne! Java upload server. The record shall trace, through its fields, the validation, the loading, and the processing of postage statements for a Mail.dat file transfer. The format for job status records is as follows:
transfer-statusversionjobidfilenameverification-facility-zip+4date-timevalidationjob-acceptanceinsertPS-genPS-canceledPS-finmpu-edit error-codeerror-msg
where
transfer-status : represents the literal text that will be placed at the beginning of a transfer-status record.
: represents the ASCII character used as the field delimiter.
version: the version of this receipt file. (e.g. 1.0)
jobid: the Mail.dat Job ID as presented in the header file specification of Mail.dat.
filename: the part of the name of a Mail.dat file without the extension. For example, if the files sent are foo.hdr, foo.csm and foo.cqt, the “filename” is foo. If the receipt record is for a finalized, a canceled or a reversed postage statement, this record will contain the container ID of one of the containers that was finalized, canceled, or reversed.
verification-facility-zip+4: The ZIP+4 Code of the mailing facility where verification occurred.
date-time: a time stamp, represented in the 24 hour time system, which indicates the creation or the receipt of a file. The Java upload server provides the time that is used.
validation: a binary value of “P” or “F” indicating successful validation or failed validation, respectively, of a Mail.dat file.
job-acceptance: a binary value of “P” or “F” indicating whether a file has been successfully loaded to the Java upload server’s data repository for loading to a database.
insert: a binary value of “P” or “F” indicating the successful loading of a job from the Java upload server’s data repository to the database.
PS-gen: a Boolean value of “T” or “F” indicating whether a postage statement has been generated or has not been generated.
PS-canceled: a value of “C” or indicating whether a postage statement has been canceled or no action has been taken, respectively.
PS-fin: a value of “F”, “R” or indicating whether a postage statement has been finalized, reversed or no action has been taken, respectively.
mpu-edit: a value of “T” or indicating whether an mpu edit has occurred on the front-end or not.
error-code: a numeric error code generated by the PostalOne! Java upload server that represents the occurrence or absence of an error. A zero in the field indicates the absence of error.
error-msg: a message generated by the PostalOne! Java upload server that describes, with brevity, an error or warning that has occurred. If there is no error or warning, this field will be empty.
: the platform-specific new line character sequence.
Appendix D. Postage Statement Receipt File Layout
Postage statement receipt files are not currently supported. See the Mail.XML Specification on the IDEAlliance Mail.XML site (http://www.mailxml.org) for the Postage Statement Query and Periodical Statement Query messages that will be supported in a future release.
Appendix E. Error Messages
This appendix contains a list of error messages generated during manual or batch file processing. Error messages may appear in one or more of the following places:
In the Validation.log file. By default, the file is on your machine in C:\Validation.log. This option is only available to manual file processing users.
In the Transfer Summary Report. On the left menu bar, click File Transfer, then click Transfer Summary. The Summary Report shows the status of all jobs. Click a failed job, and then click the name of the file with errors to see the error message. These messages are usually also in the Validation.log file. This option is available to all manual file transfer users with access to Preparer or Owner features in the PostalOne! system.
In the batch processor logs. See Server#.log (# = 1 to n) for general status information, and User#.log (#1 = 1 to n) for transfer error messages containing the error codes and messages as shown in this section. This option is only available to batch processing users.
In the Metrics Search. To view error messages, on the left menu bar, click Metrics Search. Search for the job if necessary. Click the F link for the failed job. The error report displays. This option is available to all users with access to Preparer or Owner features in the PostalOne! system.
NOTE: Errors produced by the database are not included in this appendix. Generally, a database error begins with “ORA-“ followed by a number. If you should receive one of these errors, confirm your data is formatted correctly (numeric fields do not contain letters, etc.). If your data appears to be correct, contact the Customer Care Center with the error message.
|
