Returning Checksum Data in the Response |
To return checksum data in the response, you must set the ReturnChecksum attribute to true. This attribute returns checksums that represent various parts of the print job and objects that are included on the document that is being printed.
History Explorer and Reprint Console use these checksum values to verify the content of the documents that are being reprinted by comparing the checksums of the new document with the old one. If the checksum values match, you can be sure that the document that you print exactly matches the old one. If the checksum values do not match, the new document has changed in some way. With that knowledge, you might choose to print the document with the difference, or you might choose to correct the difference so that the items match again before you print them. For a description of the returned checksum values, refer to FormatChecksum Response Tag.
The following example shows the response that is returned when the ReturnChecksum attribute is set to true.
<?xmlversion="1.0"encoding="utf-16"?>
<ResponseVersion="2.0"Name="09232006_103601_Job1"ID="123"AppName="BarTender"AppVersion="9.00"AppVersionId="900"AppVersionMajor="9"AppVersionMinor="00"AppVersionBuild="2345"AppInstancePid="12345"AppInstanceGUID="(5EFC7975-14BC-11CF-9B2B-00AA00573819)">
<User>Administrator</User>
<Server>MyServer</Server>
<CommandName="Cmd1">
<PrintGUID="{C87068F8-4972-41F1-A6E8-724381703764}"JobName="MCIJob"ID="1234"JobLastStatus="Sent"JobCompleted="true">
<JobStatusCompleted="true">
<TimeJobStart>02:24:34</TimeJobStart>
<TimeJobQueued>02:24:34</TimeJobQueued>
<TimeJobSent>02:24:34</TimeJobSent>
<LastStatus>Sent</LastStatus>
<Description>Finished sending print job to printer.</Description>
</JobStatus>
<PrintData>
<Summary>
<CommandLine>/AF="Document1.btw" /P</CommandLine>
<FormatGUID>C87068F8-4972-41F1-A6E8-724381703764</FormatGUID>
<FormatName>Document1.btw</FormatName>
<FormatLastModified>12:10:34 04/20/2007</FormatLastModified>
<FormatChecksumBarTenderVersion="900"All="12AB34E7">
<ObjectName="Barcode 1"Type="Barcode"Checksum="36874221">
</FormatChecksum>
<NumberSerializedLabels>5</NumberSerializedLabels>
<NumberIdenticalCopies>1</NumberIdenticalCopies>
<UseDatabase>false</UseDatabase>
<QueriedRecords>All</QueriedRecords>
<RecordRange>1...</RecordRange>
<Printer>HP LaserJet</Printer>
<PrinterModel>HP LaserJet1200</PrinterModel>
<PrinterPort>LPT1</PrinterPort>
<PrinterHost>MyServer</PrinterHost>
<PrinterComment>User Entered Comment</PrinterComment>
<Date>2008-03-19T14:14:41</Date>
<LabelWidth>100</LabelWidth>
<LabelHeight>100</LabelHeight>
<PageRows>2</PageRows>
<PageColumns>5</PageColumns>
<PrintSetupOptions>
<LogPrintJob>false</LogPrintJob>
<AutoPrintAgain>false</AutoPrintAgain>
<EnablePrinterCodeModifier>false</EnablePrinterCodeModifier>
<PrintToFile>false</PrintToFile>
<ShowPrinterCode>false</ShowPrinterCode>
<EnablePrompting>true</EnablePrompting>
<RefreshDatabases>false</RefreshDatabases>
</PrintSetupOptions>
<Performance>
<AllowFormatCaching>false</AllowFormatCaching>
<AllowGraphicsCaching>false</AllowGraphicsCaching>
<AllowSerialization>true</AllowSerialization>
<AllowStaticGraphics>true</AllowStaticGraphics>
<AllowStaticObjects>false</AllowStaticObjects>
<AllowVariableDataOptimization>false</AllowVariableDataOptimization>
<WarnWhenUsingTrueTypeFonts>true</WarnWhenUsingTrueTypeFonts>
</Performance>
<ObjectPrintMethod>
<TrueTypeText>TextOutput</TrueTypeText>
<Unsupported1DBarCodes>Auto</Unsupported1DBarCodes>
<Unsupported2DBarCodes>Auto</Unsupported2DBarCodes>
<Lines>Auto</Lines>
<Boxes>Auto</Boxes>
<Ellipses>Auto</Ellipses>
</ObjectPrintMethod>
<MediaHandling>
<Action>btMHPageBreak</Action>
<DataItemName>TheDataItemName</DataItemName>
<DataItemType>btMHNamedSubString</DataItemType>
<IgnoreCase>true</IgnoreCase>
<Occurrence>btMHAfterDataChange</Occurrence>
</MediaHandling>
<LicenseServerCheck>
<Address>Server Address</Address>
<Port>5160</Port>
<CheckResult>true</CheckResult>
<Timeout>15000</Timeout>
<Retries>3</Retries>
<AsyncCheck>true</AsyncCheck>
<CheckReason>0</CheckReason>
</LicenseServerCheck>
<TotalLabels>2</TotalLabels>
<TotalPages>1</TotalPages>
</Summary>
<PagesTotalLabels="2"TotalPages="2"MediaHandling="true">
<PagePrintedPageNumber="2"TotalPages="2"Status="Printed"MediaHandlingAction="Pause">
<LabelPosition="1">
<ObjectName="Text 1"Type="Text">
<SubStringPosition="1"ShareName="Sub-String 1"Type="Screen Data">
<Value>John Doe</Value>
</SubString>
<SubStringPosition="2"ShareName="Sub-String 2"Type="Date">
<Value>4/24/2007</Value>
</SubString>
</Object>
<ObjectName="RFID 1"Type="RFID">
<SubStringPosition="1"ShareName="RFIDCode"Type="Database">
<Value>30705E30A700004000000001</Value>
</SubString>
</Object>
</Label>
<LabelPosition="2">
<ObjectName="Text 1"Type="Text">
<SubStringPosition="1"ShareName="Sub-String 1"Type="Screen Data">
<Value>John Doe</Value>
</SubString>
<SubStringPosition="2"ShareName="Sub-String 2"Type="Date">
<Value>4/24/2007</Value>
</SubString>
</Object>
<ObjectName="RFID 1"Type="RFID">
<SubStringPosition="1"ShareName="RFIDCode"Type="Database">
<Value>30705E30A700004000000002</Value>
</SubString>
</Object>
</Label>
</Page>
</Pages>
</PrintData>
<MessageID="1606"GUID="{8A8E8550-C822-4e84-8713-212793DFD6E1}"Severity="Information"Category="Miscellaneous"Response="OK">
<Text>
BarTender successfully sent the print job to the spooler.
Job Name: MyJobName
BarTender Document: Document1.btw
Printer: Datamax H-4212 7.1.4
</Text>
</Message>
</Print>
</Command>
</Response>