Requesting an Event Log
A client specifying zip-include-composerlog=yes needs to anticipate the possible file structure returned, as it can vary based on what happens during publishing. When a zip archive is requested and zip-include-composerlog=yes, the returned result can be one of the following:
• A zip archive of a specific format, which contains a manifest file listing the other files returned, the result of the publishing operation (whether it succeeds or generates errors), XML and HTML versions of the event log, and an error page if one was generated.
The manifest file provides an index to the zip archive contents. Arbortext PE Request Manager returns an HTTP result code of 200 if it returns a zip archive, regardless of whether the publishing operation is successful or has errors.
• A text/xml document containing an XHTML error page, if processing fails without being able to construct a zip archive.
In the case of an error generating only a text/xml type XHTML error page, there is no zip archive. The client should be able to handle the return of a text/xml document as a fatal error. Arbortext PE Request Manager returns an HTTP result code of 500 if it returns an XHTML error page.
The manifest.xml file is a short XML document of the following type:
<!ELEMENT convert-result EMPTY >
<!ATTLIST convert-result
success (yes|no) #REQUIRED
transaction-id #CDATA #IMPLIED
subprocess-id #CDATA #IMPLIED
status-code #CDATA #REQUIRED
fatal-count #CDATA #IMPLIED
output-name #CDATA #IMPLIED
reason-phrase #CDATA #REQUIRED
html-composer-log #CDATA #REQUIRED
error-count #CDATA #IMPLIED
warning-count #CDATA #IMPLIED
error-name #CDATA #IMPLIED
graphic-name #CDATA #IMPLIED
composer-log #CDATA #REQUIRED
</convert-result>
Any conversion requests including zipoutput=yes&zip-include-composerlog=yes in the URL will return the composer log in the returned zip archive.
The zip archive would contain the following:
