One of the primary activities in setting up a queue involves editing the sample queue definition provided in the DesQueueDefinition.xml file (the format of which is defined by the queue schema file).
When you set up a queue, you identify the following:
One or more sets of queues (or queue sets)
(with each queue set providing an association for documents to a particular document type or purpose, or other company-defined criteria)
One or more queues, within each queue set
(that provide one or more views of the documents for that queue set, such as for particular departments or branches)
Within the file, edit the sample queue definition as needed to create one or more queue sets and one or more queues. To set up a single queue, the contents of the file would contain the following elements (where bold indicates attribute variables you specify):
<?xml version="1.0" encoding="UTF-8"?>
Elements and Attributes of the DesQueueDefinition.xml
When editing the sample queue definition in the file to set up queues, you need to appropriately configure the following elements.
QueueSet Element (Required)
You need at least one queue set within which to set up one or more queues. A queue set contains the following attributes.
Table 2. QueueSet Attributes
Attribute Type Description Required?
name NameType
1-255 characters
Specifies the name of the queue set. Specify the attribute as follows:
name="qsetname"
Where qsetname is the name you assign to this queue set.
Caution: Do not use the name “Inbox” or any variation thereof based on capitalization.
Yes
fileStorageDirectory String Specifies where the received document files are to be stored on a network drive. Specify the attribute as follows:
fileStorageDirectory="//server/sharedfolder"
Where server and sharedfolder are the names of your specific server and shared folder.
Only ASCII characters are valid when specifying the attribute.
If this attribute is not specified, the document files are stored as specified in
shared_resources.properties for the inboxdir property, in the QueueSets folder.
No
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
Queues Element (Required)
Under the Queues element, define the elements for one or more queues within the queue set.
Queue Element (Required)
This element contains the following attributes enabling you to set up a queue within the queue set.
Filters Element (Required)
Under the Filters element, define one Filter element for filtering which documents are to appear for the queue. You can define only one filter.
Table 4. Queue Attributes
Attribute Type Description Required?
name NameType
1-255 characters
Specifies the name of the queue within the queue set. Specify the attribute as follows:
name="qname”
Where qname is the name you assign to this queue.
Caution: Do not use the name “Inbox” or any variation thereof based on capitalization.
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 will display)
Yes
defaultMode String Determines in what mode the queue displays documents when the queue is selected in the the Web Client. Specify the attribute as follows:
defaultMode="qmode"
Where qmode is the display mode for the queue.
Valid settings are:
"Get Next" which displays the fields for sending the next available document. This is the recommended and default setting if this attribute is not specified.
"Browse" which displays a list of documents.
Caution: Using the setting "Browse" may produce undesirable results during operation, based on the following:
Allows a user (User B) to attempt to send a document that is already being worked on by another user (User A), thereby resulting in a
“locked” message for User B Uses more system memory
Requires more system resources because database and server overhead will be higher
No
Filter Element (Optional)
This element contains the following attributes to define a filter. If this element is not included in the definition of a queue, then all documents appear in the queue.
Table 5. Filter Attributes
Attribute Type Description Required?
customFieldName NameType 1-255 characters
Must be one of the named custom fields specified for the QueueSet element. Specify the attribute as follows:
customFieldName="customfieldname"
Where customfieldname is the name defined for a custom field for the queue set.
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
operator String Specifies the operation to occur between the filter value (defined for this element) and the value entered for routing a document to this queue in Kofax Front-Office Server Administration Console and Kofax Front-Office Server Web Client. Specify the attribute as follows:
operator="Equals"
Where Equals is one of the following valid settings:
"Equals", "Not Equals", "Like", "Greater Than",
"Less Than".
If you use the operator "Like", the following wildcard characters may be used: % and _.
Yes
value ValueType
1-255 characters
Specifies the specific data, when processed with the operator for this element, that associates a
document with this queue. Specify this attribute as follows:
value="data"
Where data is the value for associating the document with this queue.
You use this data value when setting up a shortcut in the Administration Console for sending a document to a queue, and when moving a document to a queue in the Web Client.
Note: Any spaces used when entering the value in the XML file are preserved. The data value is case sensitive.
Yes
Roles Element (Required)
Under the Roles element, define one or more Role elements for determining which users, based on roles defined in Kofax Front-Office Server Administration Console, have access to this queue.
Role Element (Required)
This element contains the following attributes to assign a role to a queue.