Batch Fields

Batch Fields are defined for individual Batch Profiles to capture data that is associated with all documents in one batch. In effect, batch fields are used to contain data that is common to all documents within a batch.

Creating/Editing Batch Fields

Batch Fields are created and edited from the Fields section on the Batch Profiles Panel in the Process Manager Application. To add a new Batch Field, click on the plus (+) sign to the right of the Fields caption. This is a split button. If clicked directly, the Add Field... option is used. If the arrow is clicked, the choices are Add Field... and Copy from another Process....

Figure 1 - Batch Profile Fields

Figure 2 - Add Field options

Add Field

The Add Batch Profile Field dialog appears after clicking this option. Look to Batch Profile Field Properties below for an explanation of each property.

Figure 3 - Add Document Type Field dialog

Copy from another Process

A new Batch Profile field may be created using the settings of an existing field. The Copy an Index Field dialog appears after clicking this option.

Figure 4 - Copy Field dialog

Select a Process Type to see the list of available Batch Profiles and Document Types. Check the checkbox next to the field and click Save to copy the field. Click on a Field to see the read-only properties of that field.

Figure 5 - Field properties launched from Copy Field dialog

Batch Profile Field Properties

Batch Field Properties define data characteristics and behaviors for each field.

Field Name	The Field Name is the display name for the field. The Field Name will appear as a label on Indexing forms and other areas within Quillix Capture where field values are displayed or edited.
Data Type	The Data Type defines how the field's underlying data is stored in the database. Choices for Data Type include: String - all alphanumeric and special characters Number - numbers only Date/Time - date/time format A value of String is the most flexible option, even for most numeric data such as dollar amounts and account numbers. The format of acceptable data input can be controlled using a Field Mask to restrict field entry to numbers only. The Number data type is only recommended when numeric sorting is required. The Date/Time data type is recommended for all dates. Important: The Data Type cannot be changed once a field has been created. Important: User selection of the Date/Time Data Type automatically selects a Date/Time Display Mask. The use of a Standard or Custom Display Mask is required when using the Date/Time Data Type.
Display Type	The Display Type defines how the field is displayed in the Web Client. Edit Box - A standard browser edit control. recommended for most fields. Text Area - A multiline version of the Edit Box. Useful for fields containing a large amount of information. Check Box - A standard browser check box. The underlying field value when using a check box is FALSE (unchecked) or TRUE (checked). Picklist - A predefined list of values from which a selection can be made. When this display type is selected, a pick list must be defined for the field by clicking the Edit Picklist... link below the Display Type selector. Multi-Select Picklist - works the same as a standard Picklist, except all the selected values are stored in the field as a delimited list.
Edit Picklist	The Edit Picklist link is enabled when the Display Type is set to either Picklist or Multi-Select Picklist. When clicked, the Edit Picklist dialog box will be displayed to allow for editing the picklist values.
Default Value	The Default Value is automatically populated in this field when a new Batch of this type is created. Additionally, you can pre-fill a batch field with a dynamically generated default value that is based on information in the possession of the capture system at the time the Quillix Capture client user is indexing a document. The system default values you can choose from in the list are explained below: [blank] — Used only for pick lists (lists of known values), this default value ensures that the first value in the list is empty, rather than the first value defined in the list. For text box fields, this is the same as if there where no default value defined. [Current Date] — This default value will place the current date into the document field in the format: M/D/YYYY. The date recorded is dictated by the user's computer and it is saved when the document's index values are saved. [Current Date/Time] — This default value will place the current date and time into the document field in the format: M/D/YYYY H:M:S PM. The date recorded is dictated by the user's computer and the time is when the file was first loaded into the Quillix client document viewer. Both the date and the time are saved when the document's index values are saved. [Batch Name] — This default value will place the name of the batch that initially captured the file that is currently assigned to the current document into the document field. [Batch Profile] — This default value will place the name batch profile used the classify the batch that initially captured the file that is currently assigned to the current document into the document field. [Scan Date] — This default value will place the date that the currently viewed image was scanned (or when the current file was imported) into the document field in the format: MM/dd/YYYY. [Scan Date/Time] — This default value will place the date that the currently viewed image was scanned (or when the current file was imported) into the document field in the format: MM/dd/YYYY hh:mm:ss A\\M. [Scan User] — This default value will place into the document field the name of the user that was logged on to the Quillix client when the image was scanned or when the file was imported. [Current User] — This default value will place into the document field the name of the user that is currently logged on to the Quillix client. This information is recorded when the document's indexes are saved.
Display Mask	A Display Mask restricts data entry into the field based on the format of the mask. Display Masks are dependent on Data Type and Display Type. Quillix provides these standard Display Masks: SSN (###-##-####) - available for String and Numeric data types Zip (#####) - available for String and Numeric data types Zip + 4 (#####-####) - available for String and Numeric data types Telephone (1 (###) ###-####) - available for String and Numeric data types Currency ($#,###,###,###.00) - available for String and Numeric data types Currency 2 ((#,###,###,###.00) - available for String and Numeric data types Credit Card (####-####-####-####) - available for String and Numeric data types Date (MM/dd/YYYY) - available for Date/Time data types Date/Time (MM/dd/YYYY hh:mm:ss A\\M) - available for Date/Time data types Custom Display Masks In addition to the standard display masks available in Quillix Capture, custom display masks may also be created. See the topic Creating Custom Display Masks for more information. Important: The use of a Standard or Custom Display Mask is required when using the Date/Time Data Type.
Min Length	The Min Length property determines the minimum number of characters a field may contain when edited. This property is enforced in the Web Client at the time of editing.
Max Length	The Max Length property determines the maximum number of characters a field may contain when edited. This property is enforced in the Web Client at the time of editing.
Visible	The Visible property determines the visibility of a field in the Web Client. When checked (default) the field will be visible and editable with the appropriate user permissions. When unchecked, the field will not be visible in the Web Client. A field that is not visible can be useful in holding intermediate values for workflow decisions and as flags for conditions that are used by other integrated systems.
Read Only	The Read Only property disables editing and input of the field in the Web Client. This property only affects behavior in the Web Client, and the field value can still be changed by QSX modules or other processes outside the Web Client.
Required	The Required property is enforced by the Web Client when editing. When checked, the Required property will not allow the field value to be saved without a value.
Searchable	The Searchable property makes the field available for searching in areas of the product that provide searching capability. Matching on the Field in TransactionMatch QSX and case searching on the Field in the Web Client require this property to be set.
Trigger a database lookup	This property enables a database lookup to be triggered from the field when the focus leaves the field during editing. A database lookup will initiate a database query using the value of the field as a key value. Data returned from the query is then populated in one or more index fields. When enabling this feature, a database lookup must be configured by clicking the Edit button next to the property check box. See the topic Database Lookup for more information on configuring Database Lookups for fields.

Batch Field Ordering

The order in which Fields are displayed in the Web Client can be changed by dragging and dropping the field in the field list.

Batch Field Value Propagation to Document Fields

Batch field values can be automatically propagated or "copied" to document fields by ensuring that the Document Types used for indexing within that batch have document fields with the same names as the batch fields. The benefit of this approach is to allow the indexing operator to key in a value one time at the "batch" level for all documents within the batch.

For example, if a Batch Profile is defined with a field named "Company", and a Document Type is defined with a field named "Company", a value entered once in the Batch Field named "Company" will be automatically propagated to all documents created from that batch. For a 10 document batch, the value would be entered by the operator once, and copied to the 10 created documents automatically.