XML Output (tick_24Enterprise Only)

This page controls options that are only available in the enterprise edition and that control the XML output of the Batch Wizard.

NOTE: If using the enterprise edition, then see the "EnterpriseExtras" folder in the installation folder for extras.

See also: XML Output Example

XML Output Options

Report format - Select the desired report format. XML report files will be in XML format instead of HTML, and the report filenames will end with ".xml". In v16+ you can now choose to simultaneously generate both HTML and XML reports instead of only one or the other. The default is "HTML Only".

Attach XSL style sheet - Check this option to attach the specified XSL style sheet/transformation to the XML file by adding the line <?xml-stylesheet type="text/xsl" href="(xsl file)"?> after the XML declaration. This option is not enabled by default. (New v10.9927)

XSL Style Sheet Edit - Specify the XSL file, with full path information, that HTML Validator copies to the report folder and uses for XML reports if the 'Attach XSL style sheet' option is checked. (New v10.9927)

XML Output Format, By Element

<body>

contains <report> elements

<csebatchwizardreportpage>

contains <head> and <body> elements

the root element of Batch Wizard XML report pages

"pagenumber" - the page number, can be zero, positive, or negative

0 - Summary Page

-1 - Single Page Report (as opposed to a multiple page report)

-2 - Master Link Report Page

-3 - Important Messages Report Page

-4 - Duplicate Page Titles Report Page

-5 - Duplicate Meta Descriptions Report Page

"pagetype" - a brief text description of the page type, if available (see the below list for possible values)

"dup_metadesc" - Duplicate Meta Descriptions Report Page

"dup_title" - Duplicate Page Titles Report Page

"imsgs" - Important Messages Report Page

"mlr" - Master Link Report Page

"reportpage" - A main report page in a multiple page report (pagenumber>0)

"singlepage" - Single Page Report (as opposed to a multiple page report)

"summary" - Summary Page

"totalpages" - the total number of pages

<docsource>

contains a section of the document source that corresponds to the <message> element that <docsource> is contained in

the document source must be available and the option to include the document source must also be enabled or this element will not exist

optionally contains a <highlight> element

<generateddate>

contained in the <head> element

contains the date when the report was generated in yyyy-mm-dd format (local time zone)

<generatedtime>

contained in the <head> element

contains the time when the report was generated in hh:mm:ss format (local time zone)

<gtdata>

empty element that contains data from the Grand Totals Report

"for" - what the data is for, like "errors", "warnings", "noerrorsorwarnings", "badlinks", or "totalprocessed"

"totaldocswith"

"percent"

"totalnumber"

<head>

contains elements like <title>, <generateddate>, <generatedtime>, <generator>, <reportfilename>, <targetlistfilename>, etc.

<highlight>

may be contained in the <docsource> element, if a highlighted portion of the source is available

used to contain/highlight the specific part of the document source that caused a message to be generated

<link>

contains a link in a <linklist> or <linkreport> element

"bytes" - the byte size of the link (attribute omitted if not available)

"charloc" - the starting character position on the line where the link appears (or 0 if not available) (New v11.0104)

"lineloc" - the line where the link appears (or 0 if not available) (New v11.0104)

"linkedfrom" - the document that linked to the link

"linktype" - the link type, like "A HREF", "IMG SRC", etc

"numtimes" - the number of times the link was linked to by the document that linked to it

"order" - the order in which the link appears in the document, available in target link reports

"restime" - the estimated server response time in milliseconds from request start to request completed (attribute omitted if not available) (New v15.9913)

"statusstring" - the link-check status of the link as a string

"statustype" - value is "bad", "warning", "ok", or "notchecked"

NOTE: The "charloc" and "lineloc" attributes will not exist if the Batch Wizard link report option to include an optional Line:Char column is not enabled.

<linklist>

contains <link> elements

<linkreport>

contains <link> elements

represents the link report of a target report if link checking is enabled; broken links should be shown here

<message>

contains the text of a validator or Batch Wizard message in the <messagetext> element

the format of this element can be changed by setting $_JOB.report.xmlmessageformat and/or $_JOB.report.xmlmessageformat_WCAG2; see $_JOB array

contains an optional <docsource> element that contains part of the source document that is relevant to the message

"category" - the message category if available

"charlength" - the length of the section of the line, starting at charnum, that caused the message to be generated, if available

"charnum" - the 1-based character number/location on the line that caused the message to be generated, if available

"linunum" - the 1-based line number of the line that caused the message to be generated, if available

"msgid" - the message ID of the message, if available

"subtype" - a message subtype, like "Accessibility", "CSS", "HTML Tidy", "JavaScript", "Nsgmls", "PHP", etc., if available

"type" - the type of the message, like "error", "warning", "message", or "comment"

<messagelist>

contains <message> elements

<messagetext>

contained in the <message> element

contains the message text of a validator or Batch Wizard message

<report>

contains <linkreport>, <messagelist>, and/or <targetlist> elements

"listed" - number of "listings" in the report - applicable to some reports

"name" - the name of the report, like "Duplicate Page Titles", "Grand Totals Report", "Important Messages/Errors From Job Run", "Master Link Report", "Summary Report", "Target Report", etc.

"target" - if a target report, then the full location/URL of the target

<reportfilename>

contained in the <head> section

contains the full path and filename of the XML report page (Example: C:\Reports\Batch Wizard\MyDomain_DMD.xml)

"reportbasename" - contains the base part of the report pages, with no path or extension (Example: MyDomain)

"reportpath" - contains only the path information, not ending in "\" (Example: C:\Reports\Batch Wizard)

"reportnopath" - contains the filename with the file extension but without a path (Example: MyDomain_DMD.xml)

"reportext" - contains the report file extension - typically "xml"

<target>

"errors" - the number of errors in the target

"badlinks" - the number of bad (error) links in the target (will always be 0 if link checking is not enabled)

"rwords" - the number of repeated words in the document (will always be 0 if repeated word checking is not enabled)

"misspelled" - the number of unique misspelled words in the document (will always be 0 if spell checking is not enabled)

"warnings" - the number of warnings in the target

<targetlist>

contains <target> elements

"for" - more information about what the target list is for (used with duplicate page title and duplicate meta description reports)

"type" - contains additional information about the type of targets in the list, if available (see the below list for possible values)

"dup_title" - the targets in the list have duplicate titles

"dup_metadesc" - the targets in the list have duplicate meta descriptions

"summary_complete" - the targets in the list are for a complete summary report

"summary_partial" - the targets in the list are for a partial summary report