Introduction
• The SmartSearch XML Transform is an XML formatting
utility designed to facilitate automated import and
indexing of data and documents into SmartSearch ECM.
The power of XML Transform is its ability to format
virtually any XML data into a format that may be imported
both easily and automatically into SmartSearch. With
this ability, any document capture device or software
solution that can generate images with a corresponding
XML file can integrate directly into SmartSearch with
very little effort.
• The power of XML Transform is in the use of external
XSL (Extensible Stylesheet Language) files that can
quickly be tuned and customized to work against
any
XML output. This allows SmartSearch to integrate
with most any digital on-ramp connectors like ScanFlowStore for Xerox, DigiDocFlow for Ricoh/Savin, eCopy, NSI
AutoStore and ScanTag for Muratec.
• Remember that XML Transform is not limited to
just these four sources. Anything with the ability
to generate images with XML data can be managed. Simply
create a new XSL file to handle the conversion, or
contact Square 9 Softworks for support on developing
additional XSL transforms.
Installation
• XML Transform runs as a Windows™ service and once
configured and registered, will process XML data automatically
and unattended. Note that the service, “SSXMLTRANSFORM”
will be installed automatically by the XML Transform
installer, but will not be started automatically.
The service must be started prior to attempt to process
any files.
Administration
• XML Transform is configured from the Transform Configuration
program. Transform Configuration is available from
the XML Transform folder in the SmartSearch program
group from the Start menu. Clicking the Transform
Configuration icon will start the configuration program
as seen below
The Transform Configuration dialog consists of two
sections. The first, “Defined Transforms”, is a list
of all defined and active transforms that XML Transform
is configured to use
Select an item in this list to edit an existing transform,
make a copy of a transform, or delete a transform.
Note that this list will be empty until you add at
least one transform.
The Defined Transforms list contains 3 columns:
• Name – The user defined name of the transform. This
name is used only to help the user easily identify
the transform and what it is used for.
• XSL File – The file path and name of the XSL file
used when XML files are processed by this transform.
XML Transform ships with four transforms and are install
by default to C:\Program Files\Square9\XMLTransform\XSLT.
• Watch Directory – The file path where your capture
hardware or software will output its XML. One transform
entry can monitor only one watch directory. If you
need to monitor multiple paths, make a copy of the
transform by selecting it and altering its properties.
The second section, “Add/Edit XML Transforms”, is
where all additions, deletions, and modifications
of the items in the Defined Transforms list are performed.
Usage
• XML Transform will run unattended once properly
configured. Multiple copies of XML Transform can be
run across different workstation or servers but each
instance of XML Transform will require additional
licensing.
Creating XSL Files
• XML Transform comes preconfigured with four XSL
files. The principal function of any XSL file is to
manipulate the format of the file in a way that it
can be ingested into SmartSearch via the XML Import
Utility. SmartSearch expects XML to be formatted in
a particular way,.
• It is important to note that you should only include
fields that are valid fields of the specified Archive.
Invalid fields will cause the import into SmartSearch
to fail.
<Import>
<Archive Name=”Accounts Receivable”>
<Document>
<DocFile FileLoc=”C:\imports\Kofax\ARInvoices\020908001.TIF”
/>
<Fields>
<Field Name=”Invoice_Number” Value=”IN89002” />
<Field Name=”Date” Value=”02/08/2008” />
</Fields>
</Document>
</Archive>
</Import>
• SmartSearch XSL files follow standard conventions
for XSL Transformations. The Internet has volumes
of freely available information on writing XSLT. Google
“XSLT” for information on how to write your own transforms,
or contact Square 9 Softworks for more information
on having our services team assisting in developing
a new transform for your specific needs.
• Note that there are three parameters available
for use in your XSLT. These parameters are useful
when your XML data does not directly reference the
image file it describes.
These are:
• File_Path – The path to the current XML file.
• File_Name – The name of the current XML file.
• File_Name_NE – The name of the current XML file
with no extension.
They can be referenced in the following manner:
<xsl:param name="File_Path" />
<xsl:param name="File_Name" />
<xsl:param name="File_Name_NE" />
|
