Summary Response Tag

ClosedDescription

The root tag for print job Summary tags. The Summary tag returns the print job's template and page design information in the response.

ClosedSyntax

<Summary>...</Summary>

ClosedChild Elements

The following child element tags are supported.

Tag

Description

CommandLine

The Automation or DOS command line that started BarTender.

Date

The date the print job was submitted.

FormatChecksum

The checksum values for the document. The values will be 32-bit hex numbers.

FormatGUID

The unique number that BarTender applied to the document.

FormatLastModified

The date and time that the document was last modified.

FormatName

The file name of the document being printed.

LabelHeight

The height of the printed item.

LabelWidth

The width of the printed item.

LicenseServerCheck

The results of the License Server validation check.

MediaHandling

The Page Setup dialog's Media Handling tab settings.

NumberIdenticalCopies

The number of copies of the document being printed.

NumberSerializedLabels

The number of serial numbers in the print job.

ObjectPrintMethod

The Print dialog's Object Print Method tab settings.

PageColumns

The number of columns on the page.

PageRows

The number of rows on the page.

Performance

The Print dialog's Performance tab settings.

Printer

The printer receiving the print job.

PrinterComment

Any comments that are associated with the printer.

PrinterHost

The name of the computer that the printer is physically connected with.

PrinterModel

The model of the printer receiving the print job.

PrinterPort

The port that connects the printer receiving the print job to the system.

PrintSetupOptions

The Print dialog's Options mini-tab settings.

QueriedRecords

The method used to select the records that were used to provide data.

RecordRange

The range of records that were used to provide data.

TotalLabels

The total number of items printed.

TotalPages

The total number of pages printed.

UseDatabase

Whether or not the print job used information from a database.

ClosedParent Tag

<PrintData>

ClosedExample

<?xml version="1.0" encoding="utf-16"?>

<Response Version="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>

<Command Name="Cmd1">

<Print GUID="{C87068F8-4972-41F1-A6E8-724381703764}" JobName="MCIJob" ID="1234" JobLastStatus="Sent" JobCompleted="true">

<JobStatus Completed="true">

...

</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>

<FormatChecksum BarTenderVersion="900" All="FFE2CC9F" Page-Setup="655FDE47" ObjectPrintMethod="2133DF1C" PCMActions="00000000" PCMScript="00000000">

<Object Name="Text1" Type="Text" Checksum="7D6EA0D3">

</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>

...

</PrintSetupOptions>

<Performance>

...

</Performance>

<ObjectPrintMethod>

...

</ObjectPrintMethod>

<MediaHandling>

...

</MediaHandling>

<LicenseServerCheck>

...

</LicenseServerCheck>

<TotalLabels>2</TotalLabels>

<TotalPages>1</TotalPages>

</Summary>

</PrintData>

<Message ID="1606" GUID="{8A8E8550-C822-4e84-8713-212793DFD6E1}" Severity="Information" Category="Miscellaneous" Response="OK">

...

</Message>

</Print>

</Command>

</Response>

ClosedRequirements

BTXML Script version 2.0 (BarTender 9.0 and later versions)