Kofax Front-Office Server 3.0 - Manual (Page 44)

Kofax Front-Office Server Administrator’s Guide
44 Kofax, Inc.
CustomFields Element (Required)
Under the CustomFields element, define up to five CustomField elements. A custom field enables
you to define the data element by which you will subsequently filter documents to appear in a
queue, thereby associating certain documents with a queue within the queue set.
Where the queue set is comparable to the type of document to be associated with the queue set,
the custom fields are comparable to index fields, which provides the basis for associating a
document with a particular queue.
Although you can define up to five custom fields for a queue set, having more than one custom
field makes it possible for a user to send a document to more than one queue. This situation occurs
when the user provides information for more than one custom field when scanning or moving a
document to a queue. By using only one custom field for any queue set, you eliminate the
possibility of sending or moving a document to more than one queue.
CustomField Element (Required)
This element contains the following attributes enabling you to define a custom field for the queue
set.
Table 3. CustomField Attributes
Attribute Type Description Required?
dataType String Specifies the type of data required for defining this
attribute. Specify the attribute as follows:
dataType="string"
Currently, the only valid setting is "string". Yes
name NameType
1-255 characters Specifies the name of the custom field. Specify the
attribute as follows:
name="customfieldname"
Where customfieldname is the name you assign.
This name is used when providing or prompting for
queue information in the the Web Client and the
Administration Console.
Caution: The name does not use the following, if
entered as part of the name in the XML file:
Spaces at the beginning of the name
Spaces at the end of the name
More than one consecutive space within the name
(only one space is used) Yes
id unsignedInteger
1 character Specifies the unique ID of the custom field (for
internal database purposes). Specify the attribute as
follows:
id="1"
Where 1 is a valid numerical ID setting.
Valid settings are: "1", "2", "3", "4", "5".
Caution: The ID must be unique for each custom
field defined for a queue set. Yes