General structure of the xml file, Custom xml elements – Kofax Ascen 7.0 Release Script User Manual

Page 9

Advertising
background image

Ascent® 7.0 Release Script for XML Release Notes

Kofax, Inc.

5

General Structure of the XML File

The general structure of an XML file released with this release script is shown below. Like any

XML document, the file is made up of XML elements (or tags). Each element, which consists of a

start tag and an end tag, delimits data released from Ascent Capture about a batch. Some of the

elements have values or attributes.

For more details about the XML elements, refer to the Help available with the Ascent 7.0 Release

Script for XML (Help keyword: XML elements).

For the intentions of the example below, sample values/attributes are shown in italics. In an actual

XML file, the released values would be used.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE kfx:XMLRELEASE SYSTEM "

filename.dtd

">

<kfx:XMLRELEASE xmlns:kfx="http://www.kofax.com/dtd/">
<kfx:KOFAXXML>
<kfx:BATCHCLASS ID="

batch ID

" NAME="

batch name

">

<kfx:DOCUMENTS>
<kfx:DOCUMENT DOCID="

document ID

" DOCUMENTCLASSNAME="

document class

">

<kfx:DOCUMENTDATA />
<kfx:PRIMARYFILES />
<kfx:SECONDARYFILES />
<kfx:OCRTEXTFILES />
</kfx:DOCUMENT>
</kfx:DOCUMENTS>
</kfx:BATCHCLASS>
<kfx:BATCHSTATUS>

batch status value

</kfx:BATCHSTATUS>

</kfx:KOFAXXML>
<

user-specified prefix

:CUSTOMXML xmlns:

demo

="

user-specified URI

">

</

demo

:CUSTOMXML>

</kfx:XMLRELEASE>

For additional examples of XML files, including examples of DTD files, refer to Help available

with the Ascent 7.0 Release Script for XML (Help keyword: Examples).

Custom XML Elements

In addition to the standard XML elements used to store information about document/batch data

and released files, the Ascent 7.0 Release Script for XML allows you to define custom XML

elements. The custom XML elements can be used for batch-level information that is intrinsic to the

back end system.

For more information about setting custom XML elements, refer to the Help available with the

Ascent 7.0 Release Script for XML (Help keyword: Custom XML element).

Advertising