3 Creating Client Scripts

This chapter describes the various events and classes that can be used to create scripts for Capture client.

Capture enables you to create custom scripts to suit your business requirements. Scripts provide hooks into client events. You can create a client script that gets executed when certain Capture client events are triggered.

Extensions allow you to customize client scripts. You can write and incorporate JavaScript extensions to extend Capture functionality. For more information on JavaScript extensions, see Managing Oracle WebCenter Enterprise Capture.

This chapter includes the following sections:

• Client Events

• Event Classes

• Capture Client Core Classes

• Capture Client FieldEdit Classes

• Sample Client Scripts

3.1 Client Events

Client scripts are JavaScript modules that enable you to customize the behavior of certain client events.

This section describes the following events:

• AttachmentCreated

• AttachmentRemoved

• AttachmentSelected

• BatchScanBegin

• BatchScanComplete

• BatchSelected

• CaptureImage

• CaptureInitialize

• DBSearchComplete

• DBSearchResults

• DBSearchStart

• DocumentCreated

• DocumentRemoved

• DocumentSelected

• FieldGotFocus

• FieldLostFocus

• FieldProcessKey

• InitializeFields

• PageCreated

• PreBatchDelete

• PreBatchScan

• PreCaptureImage

• PreDocumentProfileChange

• DocumentProfileChanged

• PreDownloadItem

• PrePageDelete

• PreReleaseBatch

• PreUploadItem

• PostCaptureImage

• PostDownloadItem

• PostUploadItem

• RegionSelected

• ScriptStart

3.1.1 AttachmentCreated

The AttachmentCreated event occurs after an attachment has been created.

3.1.2 AttachmentRemoved

The AttachmentRemoved event occurs after an attachment has been removed.

3.1.3 AttachmentSelected

The AttachmentSelected event occurs when an attachment has been selected.

3.1.4 BatchScanBegin

The BatchScanBegin event occurs when scanning into a batch is about to begin.

3.1.5 BatchScanComplete

The BatchScanComplete event occurs when scanning into a batch is complete.

3.1.6 BatchSelected

The BatchSelected event occurs when a batch has been selected.

3.17 CaptureImage

The CaptureImage event occurs when an image is about to be captured from the scan source.

3.1.8 CaptureInitialize

The CaptureInitialize event occurs prior to images being captured, and it can be used to initialize properties of the Capture source.

3.1.9 DBSearchComplete

The DBSearchComplete event occurs when the database search is completed and before the results are being processed.

3.1.10 DBSearchResults

The DBSearchResults event occurs as database search results are being processed.

3.1.11 DBSearchStart

The DBSearchStart event occurs just before a database search.

3.1.12 DocumentCreated

The DocumentCreated event occurs after a document has been created.

3.1.13 DocumentRemoved

The DocumentRemoved event occurs after a document has been removed.

3.1.14 DocumentSelected

The DocumentSelected event occurs when a document has been selected.

3.1.15 FieldGotFocus

The FieldGotFocus event occurs when a metadata field receives the input focus.

3.1.16 FieldLostFocus

The FieldLostFocus event occurs when a field has lost the input focus.

3.1.17 FieldProcessKey

The FieldProcessKey event occurs when a key event happens while the focus is in a metadata field.

3.1.18 InitializeFields

The InitializeFields event occurs before the dataFields model is initialized.

3.1.19 PageCreated

The PageCreated event occurs when a page is being added to a document.

3.1.20 PreBatchDelete

The PreBatchDelete event occurs when a batch is about to be deleted.

3.1.21 PreBatchScan

The PreBatchScan event occurs before a batch is about to be scanned.

3.1.22 PreCaptureImage

The PreCaptureImage event occurs before an image has been captured from the scan source.

3.1.23 PreDocumentProfileChange

The PreDocumentProfileChange event occurs when a document profile is about to change.

3.1.24 DocumentProfileChanged

The DocumentProfileChanged event occurs after a document profile is changed.

3.1.25 PreDownloadItem

The PreDownloadItem event occurs when a batch item is about to be downloaded.

3.1.26 PrePageDelete

The PrePageDelete event occurs when one or more pages are about to be deleted.

3.1.27 PreReleaseBatch

The PreReleaseBatch event occurs when a batch is about to be released.

3.1.28 PreUploadItem

The PreUploadItem event occurs when a batch item is about to be uploaded.

3.1.29 PostCaptureImage

The PostCaptureImage event occurs after an image has been captured from the scan source.

3.1.30 PostDownloadItem

The PostDownloadItem event occurs after a batch item has been downloaded.

3.1.31 PostUploadItem

The PostUploadItem event occurs after a batch item has been uploaded.

3.1.32 RegionSelected

The RegionSelected event occurs when a region has been selected on a document page.

3.1.33 ScriptStart

The ScriptStart event occurs when scripting is first initialized.

The syntax for this event is: public void ScriptStart();

3.2 Event Classes

An event class is used to define an event. This section describes the following event classes:

• AttachmentCreatedEvent

• AttachmentRemoveEvent

• AttachmentSelectedEvent

• BatchDeleteEvent

• BatchScanEvent

• BatchSelectedEvent

• DBSearchEvent

• DocumentRemoveEvent

• DocumentSelectedEvent

• PreDocumentProfileChangeEvent

• DocumentProfileChangedEvent

• DownloadItemEvent

• FieldEvent

• ImageCaptureEvent

• InitializeFieldsEvent

• PageCreatedEvent

• PageDeleteEvent

• RegionSelectedEvent

• ReleaseBatchEvent

• UploadItemEvent

3.2.1 AttachmentCreatedEvent

The AttachmentCreatedEvent class is used in events that occur when an attachment has been created.

3.2.2 AttachmentRemoveEvent

The AttachmentRemoveEvent class is used in events that occur when a user removes one or more attachments from a document.

3.2.3 AttachmentSelectedEvent

The AttachmentSelectedEvent class is used in events that occur when a user selects an attachment.

3.2.4 BatchDeleteEvent

The BatchDeleteEvent class is used in events that occur when a user deletes a batch.

3.2.5 BatchScanEvent

The BatchScanEvent class is used in events that occur when a user scans a batch.

3.2.6 BatchSelectedEvent

The BatchSelectedEvent class is used in events that occur when a user selects a batch.

3.2.7 DBSearchEvent

The DBSearchEvent class is used in events that occur when a user initiates a database lookup.

3.2.8 DocumentRemoveEvent

The DocumentRemoveEvent class is used in events that occur when a user removes a document from the batch.

The following table describes the syntax for isRemove() method:

The following table describes the syntax for isDelete() method:

3.2.9 DocumentSelectedEvent

The DocumentSelectedEvent class is used in events that occur when a user selects a document.

3.2.10 PreDocumentProfileChangeEvent

The PreDocumentProfileChangeEvent class is used in events that occur when a user is about to change a document profile.

3.2.11 DocumentProfileChangedEvent

The DocumentProfileChangedEvent class is used in events that occur when a user has changed a document profile.

3.2.12 DownloadItemEvent

The DownloadItemEvent class is used in events that occur when batch items are downloaded from the server.

3.2.13 FieldEvent

The FieldEvent class is used in events that occur when a user enters a field, exits a field, or types into a field.

3.2.14 ImageCaptureEvent

The ImageCaptureEvent class is used in events that occur when the user is capturing an image.

3.2.15 InitializeFieldsEvent

The InitializeFieldsEvent class is used in events that occur before the fieldedit control is initialized on the client. You can use this class to modify or remove the DataFields from the list.

3.2.16 PageCreatedEvent

The PageCreatedEvent class is used when a page is created.

3.2.17 PageDeleteEvent

The PageDeleteEvent class is used when a page is being deleted.

3.2.18 RegionSelectedEvent

The RegionSelectedEvent class is used in events that occur when a user selects a region of the image in the viewer.

3.2.19 ReleaseBatchEvent

The ReleaseBatchEvent class is used in events that occur when a batch is about to get released or unlocked.

3.2.20 UploadItemEvent

The UploadItemEvent class is used in events that occur when batch items are uploaded to the server.

3.3 Capture Client Core Classes

This section describes the following Capture Client Core classes:

• AttachmentType

• AttachmentTypes

• BarcodeInfo

• CaptureAttachment

• CaptureAttachments

• CaptureBatch

• CaptureBatchStatus

• CaptureDataType

• CaptureDocument

• CaptureDocumentPage

• CaptureDocumentPages

• CaptureDocuments

• CaptureErrorManager

• CaptureField

• CaptureFields

• CaptureItem

• CaptureItems

• CaptureOperation

• CaptureStateManager

• CaptureWorkspace

• ClientProfile

• ClientReleaseProcess

• ClientReleaseProcesses

• ClientUI

• DBLookupProfile

• DBLookupResult

• DbSearchResultRow

• DbSearchFieldInfo

• DocumentType

• DocumentTypes

• FieldDefinition

• FieldDefinitions

• ImageCaptureEngine

• MicrInfo

• Source

• TWAINSource

3.3.1 AttachmentType

The AttachmentType class contains all properties of an attachment type.

3.3.2 AttachmentTypes

The AttachmentTypes class is a map of attachment types. It is of type LinkedHashMap<String, AttachmentType> and the map key is the attachment type ID. Use the LinkedHashMap methods to retrieve the attachment types from instances of this class.

See the Java API documentation for more information on the LinkedHashMap class and its methods.

3.3.3 BarcodeInfo

The BarcodeInfo class contains all the properties associated with a bar code detected by a scanner.

3.3.4 CaptureAttachment

The CaptureAttachment class contains all properties of an attachment.

The following table describes the syntax for persist() method:

3.3.5 CaptureAttachments

The CaptureAttachments class is a collection of attachments and is of type Vector<CaptureAttachment>. Use the Vector methods to retrieve attachments from instances of this class.

See the Java API documentation for more information on the Vector class and its methods.

3.3.6 CaptureBatch

The CaptureBatch class contains all properties and operations for a batch.

The following table describes the syntax for persist() method:

3.3.7 CaptureBatchStatus

The CaptureBatchStatus class contains the properties of a batch status.

3.3.8 CaptureDataType

The CaptureDataType is an enumeration that defines the data types for metadata field definitions. The following are valid Capture data types:

• NUMERIC

• ALPHA

• ALPHANUMERIC

• DATE

• FLOAT

3.3.9 CaptureDocument

The CaptureDocument class contains all properties of a document.

The following table describes the syntax for persist() method:

3.3.10 CaptureDocumentPage

The CaptureDocumentPage class contains the properties of a document page.

3.3.11 CaptureDocumentPages

The CaptureDocumentPages class is a collection of document pages and is of type Vector<CaptureDocumentPage>. Use the Vector methods to retrieve document pages from instances of this class.

See the Java API documentation for more information on the Vector class and its methods.

3.3.12 CaptureDocuments

The CaptureDocuments class is a collection of documents and is of type Vector<CaptureDocument>. Use the Vector methods to retrieve documents from instances of this class.

See the Java API documentation for more information on the Vector class and its methods.

3.3.13 CaptureErrorManager

The CaptureErrorManager class manages what error messages are logged.

The following table describes the syntax for logMessage() method:

The following table describes the parameters for logMessage() method:

3.3.14 CaptureField

The CaptureField class contains the properties of a document metadata field.

The following table describes the syntax for setDate() method:

The following table describes the parameters for setDate() method:

3.3.15 CaptureFields

The CaptureFields class is a map of metadata field definitions. It is of type LinkedHashMap<String, CaptureField> and the map key is the field name. Use the LinkedHashMap methods to retrieve the fields from instances of this class.

See the Java API documentation for more information on the LinkedHashMap class and its methods.

3.3.16 CaptureItem

The CaptureItem class contains properties of an item (single image or non-image file) associated with a document page.

The following table describes the syntax for persist() method:

3.3.17 CaptureItems

The CaptureItems class is a map of Capture items. It is of type TreeMap<String, CaptureItem> and the map key is the item filename. Use the TreeMap methods to retrieve the items from instances of this class.

See the Java API documentation for more information on the TreeMap class and its methods.

3.3.18 CaptureOperation

This is an enumeration that defines the capture operation being performed on the batch. The following are valid Capture operation values:

• Create

• Append

• Insert

• Replace

3.3.19 CaptureStateManager

The CaptureStateManager class contains properties related to the current state of the client. The instance of this class is available to all scripting events through the Capture property.

3.3.20 CaptureWorkspace

The CaptureWorkspace class contains all properties and operations for a workspace.

The following table describes the syntax for getDBLookupProfile() method:

The following table describes the parameter for getDBLookupProfile() method:

3.3.21 ClientProfile

The ClientProfile class contains the properties of a client profile as defined in the Capture Workspace Console.

The following table describes the enumeration and values for the ClientProfile class:

3.3.22 ClientReleaseProcess

The ClientReleaseProcess class contains all properties of a client release process.

3.3.23 ClientReleaseProcesses

The ClientReleaseProcesses class is a list of client release processes. It is of type ArrayList<ClientReleaseProcess>. Use the ArrayList methods to retrieve the client release processes from instances of this class.

See the Java API documentation for more information on the ArrayList class and its methods.

3.3.24 ClientUI

The ClientUI class allows the user to invoke user interface related actions and can be accessed through client scripts.

This class includes the following methods:

• releaseBatch()

• setActiveMetadataFieldByName()

• setActiveMetadataFieldByID()

• execDBSearch()

• execDBSearch()

• selectDocument()

• refreshDocumentMetadata()

releaseBatch()

The following table describes the syntax for releaseBatch() method:

The following table describes the parameters for releaseBatch() method:

setActiveMetadataFieldByName()

The following table describes the syntax for setActiveMetadataFieldByName() method:

The following table describes the parameter for setActiveMetadataFieldByName() method:

setActiveMetadataFieldByID()

The following table describes the syntax for setActiveMetadataFieldByID() method:

The following table describes the parameter for setActiveMetadataFieldByID() method:

execDBSearch()

The following table describes the syntax for execDBSearch() method:

The following table describes the parameters for execDBSearch() method:

execDBSearch()

The following table describes the syntax for execDBSearch() method:

The following table describes the parameters for execDBSearch() method:

selectDocument()

The following table describes the syntax for selectDocument() method:

The following table describes the parameters for selectDocument() method:

refreshDocumentMetadata()

The following table describes the syntax for refreshDocumentMetadata() method:

3.3.25 DBLookupProfile

The DBLookupProfile class represents a profile for database lookup. This class includes the following method:

execDBLookup()

The following table describes the syntax for execDBLookup() method:

The following table describes the parameters for the execDBLookup() method:

3.3.26 DBLookupResult

The DBLookupResult class represents the result of a database lookup.

3.3.27 DbSearchResultRow

The DbSearchResultRow class represents one row result returned from a database lookup.

3.3.28 DbSearchFieldInfo

The DbSearchFieldInfo class represents the field information describing the results of a database lookup.

3.3.29 DocumentType

The DocumentType class represents a document profile. A document profile dictates what metadata fields are available to documents created from this type.

3.3.30 DocumentTypes

The DocumentTypes class is a map of document profiles. It is of type TreeMap<String, DocumentType> and the map key is the document profile ID. You can use the TreeMap methods to retrieve the document profiles from instances of this class.

See the Java API documentation for more information on the TreeMap class and its methods.

3.3.31 FieldDefinition

The FieldDefinition class represents a metadata field’s definition.

3.3.32 FieldDefinitions

The FieldDefinitions class is a map of metadata field definitions. It is of type LinkedHashMap<String, FieldDefinition> and the map key is the metadata field definition ID. You can use the LinkedHashMap methods to retrieve the metadata field definitions from instances of this class.

See the Java API documentation for more information on the LinkedHashMap class and its methods.

3.3.33 ImageCaptureEngine

The ImageCaptureEngine class contains all the properties and operations associated with image capture.

3.3.34 MicrInfo

The MicrInfo class contains all the properties associated with the magnetic data detected by a scanner.

3.3.35 Source

The Source class is a low-level class used to interact with a TWAIN scanner.

This class includes the following methods:

• getCurrentPrinter()

• getPrinterIndex()

• getPrinterMode()

• getPrinterString()

• getPrinterSuffix()

• getSupportedPrinters()

• isPrinterEnabled()

• isBarcodeDetectionEnabled()

• getBarcodeMaxRetries()

• getBarcodeMaxSearchPriorities()

• getBarcodeSearchMode()

• getBarcodeTimeout()

• getBarcodeSearchPriorities()

• getSupportedBarcodeTypes()

• getBarcodesDetected()

• isPatchCodeDetectionEnabled()

• getPatchCodeMaxRetries()

• getPatchCodeMaxSearchPriorities()

• getPatchCodeSearchMode()

• getPatchCodeTimeout()

• getPatchCodeSearchPriorities()

• getSupportedPatchCodeTypes()

• getPatchCodesDetected()

• isMicrEnabled()

• getMicrDetected()

• setPrinter(int printer)

• setPrinterIndex(int printerIndex)

• setPrinterMode(int printerMode)

• setPrinterString(String printerString)

• setPrinterString(String[ ] printerString)

• setPrinterSuffix(String printerSuffix)

• setBarcodeDetectionEnabled(boolean enabled)

• setBarcodeMaxRetries(int maxRetries)

• setBarcodeMaxSearchPriorities(int maxSearchPriorities)

• setBarcodeSearchMode(int searchMode)

• setBarcodeTimeout(int timeout)

• setBarcodeSearchPriorities(int[] value)

• setPatchCodeDetectionEnabled(boolean enabled)

• setPatchCodeMaxRetries(int maxRetries)

• setPatchCodeMaxSearchPriorities(int maxSearchPriorities)

• setPatchCodeSearchMode(int searchMode)

• setPatchCodeTimeout(int timeout)

• setPatchCodeSearchPriorities(int[] value)

• setMicrEnabled(boolean enabled)

getCurrentPrinter()

The following table describes the syntax for getCurrentPrinter() method:

getPrinterIndex()

The following table describes the syntax for getPrinterIndex() method:

getPrinterMode()

The following table describes the syntax for getPrinterMode() method:

getPrinterString()

The following table describes the syntax for getPrinterString() method:

getPrinterSuffix()

The following table describes the syntax for getPrinterSuffix() method:

getSupportedPrinters()

The following table describes the syntax for getSupportedPrinters() method:

isPrinterEnabled()

The following table describes the syntax for isPrinterEnabled() method:

isBarcodeDetectionEnabled()

The following table describes the syntax for isBarcodeDetectionEnabled() method:

getBarcodeMaxRetries()

The following table describes the syntax for getBarcodeMaxRetries() method:

getBarcodeMaxSearchPriorities()

The following table describes the syntax for getBarcodeMaxSearchPriorities() method:

getBarcodeSearchMode()

The following table describes the syntax for getBarcodeSearchMode() method:

getBarcodeTimeout()

The following table describes the syntax for getBarcodeTimeout() method:

getBarcodeSearchPriorities()

The following table describes the syntax for getBarcodeSearchPriorities() method:

getSupportedBarcodeTypes()

The following table describes the syntax for getSupportedBarcodeTypes() method:

getBarcodesDetected()

The following table describes the syntax for getBarcodesDetected() method:

isPatchCodeDetectionEnabled()

The following table describes the syntax for isPatchCodeDetectionEnabled() method:

getPatchCodeMaxRetries()

The following table describes the syntax for getPatchCodeMaxRetries() method:

getPatchCodeMaxSearchPriorities()

The following table describes the syntax for getPatchCodeMaxSearchPriorities() method:

getPatchCodeSearchMode()

The following table describes the syntax for getPatchCodeSearchMode() method:

getPatchCodeTimeout()

The following table describes the syntax for getPatchCodeTimeout() method:

getPatchCodeSearchPriorities()

The following table describes the syntax for getPatchCodeSearchPriorities() method:

getSupportedPatchCodeTypes()

The following table describes the syntax for getSupportedPatchCodeTypes() method:

getPatchCodesDetected()

The following table describes the syntax for getPatchCodesDetected() method:

isMicrEnabled()

The following table describes the syntax for isMicrEnabled() method:

getMicrDetected()

The following table describes the syntax for getMicrDetected() method:

setPrinter(int printer)

The following table describes the syntax for setPrinter(int printer) method:

setPrinterIndex(int printerIndex)

The following table describes the syntax for setPrinterIndex(int printerIndex) method:

setPrinterMode(int printerMode)

The following table describes the syntax for setPrinterMode(int printerMode) method:

setPrinterString(String printerString)

The following table describes the syntax for setPrinterString(String printerString) method:

setPrinterString(String[ ] printerString)

The following table describes the syntax for setPrinterString(String[ ] printerString) method:

setPrinterSuffix(String printerSuffix)

The following table describes the syntax for setPrinterSuffix(String printerSuffix) method:

setBarcodeDetectionEnabled(boolean enabled)

The following table describes the syntax for setBarcodeDetectionEnabled(boolean enabled) method:

setBarcodeMaxRetries(int maxRetries)

The following table describes the syntax for setBarcodeMaxRetries(int maxRetries) method:

setBarcodeMaxSearchPriorities(int maxSearchPriorities)

The following table describes the syntax for setBarcodeMaxSearchPriorities(int maxSearchPriorities) method:

setBarcodeSearchMode(int searchMode)

The following table describes the syntax for setBarcodeSearchMode(int searchMode) method:

setBarcodeTimeout(int timeout)

The following table describes the syntax for setBarcodeTimeout(int timeout) method:

setBarcodeSearchPriorities(int[] value)

The following table describes the syntax for setBarcodeSearchPriorities(int[] value) method:

setPatchCodeDetectionEnabled(boolean enabled)

The following table describes the syntax for setPatchCodeDetectionEnabled(boolean enabled) method:

setPatchCodeMaxRetries(int maxRetries)

The following table describes the syntax for setPatchCodeMaxRetries(int maxRetries) method:

setPatchCodeMaxSearchPriorities(int maxSearchPriorities)

The following table describes the syntax for setPatchCodeMaxSearchPriorities(int maxSearchPriorities) method:

setPatchCodeSearchMode(int searchMode)

The following table describes the syntax for setPatchCodeSearchMode(int searchMode) method:

setPatchCodeTimeout(int timeout)

The following table describes the syntax for setPatchCodeTimeout(int timeout) method:

setPatchCodeSearchPriorities(int[] value)

The following table describes the syntax for setPatchCodeSearchPriorities(int[] value) method:

setMicrEnabled(boolean enabled)

The following table describes the syntax for setMicrEnabled(boolean enabled) method:

3.3.36 TWAINSource

The TWAINSource class is an instance of ImageCaptureSource, and it represents the source used by TWAIN scanning.

3.4 Capture Client FieldEdit Classes

The FieldEdit class is the user interface component for entering metadata values. This section describes the following Capture Client FieldEdit classes:

• DataField

• DateField

• FloatField

• IntegerField

• PicklistEntry

• PicklistField

• TextField

3.4.1 DataField

The DataField class represents the data for a single field of the FieldEdit component and is the base class for the various field types.

3.4.2 DateField

The DataField class extends from DataField and represents a date field.

3.4.3 FloatField

This FloatField class extends from DataField and represents a float field.

3.4.4 IntegerField

The IntegerField class extends from DataField and represents an integer field.

3.4.5 PicklistEntry

The PicklistEntry class is used in picklist-type fields to determine the display and commit values. This class includes the following methods:

• getCommitValue()

• getDisplayValue()

getCommitValue()

The following table describes the syntax for getCommitValue() method:

getDisplayValue()

The following table describes the syntax for getDisplayValue() method:

3.4.6 PicklistField

The PicklistField class extends from DataField and represents a Pick-list (Choice List) field.

3.4.7 TextField

This TextField class extends from DataField and represents an alphanumeric field.

3.5 Sample Client Scripts

The section describes the following sample client scripts:

• Sample Client Script 1

• Sample Client Script 2

• Sample Client Script 3

3.5.1 Sample Client Script 1

This sample script customizes client behavior in the following ways:

• Prevents the client user from leaving a metadata field if the entry contains the word test.

• Prevents the user from entering an asterisk in any metadata field.

• Outputs event information to the java console, such as coordinates after a user right-mouse-drags a selection on an image.

• Stops releasing the batches to predefined processors and unlocks the batches.

Note that this script also writes out a line (printIn) to the java console for each script event, for verification or debugging purposes.

function ScriptStart() {
    java.lang.System.out.println("ScriptStart");
}

function PreBatchScan(event) { // BatchScanEvent
    java.lang.System.out.println("PreBatchScan");
}
 
function BatchScanBegin(event) { // BatchScanEvent
    java.lang.System.out.println("BatchScanBegin");
}
 
function BatchScanComplete(event) { // BatchScanEvent
    java.lang.System.out.println("BatchScanComplete");
    java.lang.System.out.println(event.getBatch().getBatchName() + " finished Scanning.");
}
 
function BatchSelected(event) { // BatchSelectedEvent
    java.lang.System.out.println("BatchSelected: " + event.getBatch().getBatchName());
}
 
function PreBatchDelete(event) { // BatchDeleteEvent
    java.lang.System.out.println("PreBatchDelete");
}
 
function CaptureImage(event) { // ImageCaptureEvent
    java.lang.System.out.println("CaptureImage");
}
 
function DocumentCreated(event) { // CaptureDocument
    java.lang.System.out.println("DocumentCreated");
}
 
function DocumentSelected(event) { // DocumentSelectedEvent
    java.lang.System.out.println("DocumentSelected: " + event.getDocument().getTitle());
}
 
function FieldGotFocus(event) { // FieldEvent
    java.lang.System.out.println("FieldGotFocus");
}
 
function FieldLostFocus(event) { // FieldEvent
    var dataField;
    java.lang.System.out.println("FieldLostFocus");
    dataField = event.getField();
    if (dataField.getUncommittedText().equalsIgnoreCase("test")) {
        event.setCancel(true);
        java.lang.System.out.println("invalid value. script will not allow leaving focus.");
    }
}
 
function FieldProcessKey(event) { // FieldEvent
    var keyEvent;
    // java.lang.System.out.println("FieldProcessKey");
    keyEvent = event.getKeyEvent();
    if (keyEvent.getID() == java.awt.event.KeyEvent.KEY_TYPED) {
        //java.lang.System.out.println(keyEvent.getKeyChar());
        if (new java.lang.Character(keyEvent.getKeyChar()).equals(new java.lang.Character('*'))) {
            java.lang.System.out.println("Asterisk not allowed in any field.");
            keyEvent.consume();
        }
    }
}
 
function PostCaptureImage(event) { // ImageCaptureEvent
    java.lang.System.out.println("PostCaptureImage");
}
 
function PreCaptureImage(event) { // ImageCaptureEvent
    java.lang.System.out.println("PreCaptureImage");
}
 
 
function PreUploadItem(event) { // UploadItemEvent
    java.lang.System.out.println("PreUploadItem: " + event.getCaptureItem().getFilename());
}
 
function PostUploadItem(event) { // UploadItemEvent
    java.lang.System.out.println("PostUploadItem: " + event.getCaptureItem().getFilename());
}
    
function DBSearchComplete(searchEvent) { // DBSearchEvent
    java.lang.System.out.println("DBSearchComplete.");
}
 
function DBSearchResults(searchEvent) { // DBSearchEvent
    var results;
    var resultRow;
    var searchParameters;
 
    java.lang.System.out.println("DBSearchResult");
 
    results = searchEvent.getRowResults();
    java.lang.System.out.println("Found " + results.size() + " results.");
}
 
function DBSearchStart(searchEvent) {  // DBSearchEvent
    java.lang.System.out.println("DBSearchStart");
    java.lang.System.out.println("Metadata value being sought: " + searchEvent.getMetadataValue());
}
 
function DocumentRemoved(event) { // DocumentRemovedEvent
    java.lang.System.out.println("DocumentRemoved");
}
 
function PostDownloadItem(event) { // DownloadItemEvent
    java.lang.System.out.println("PostDownloadItem: " + event.getCaptureItem().getFilename());
}
 
function PreDownloadItem(event) { // DownloadItemEvent
    java.lang.System.out.println("PreDownloadItem: " + event.getCaptureItem().getFilename());
}
 
function RegionSelected(event) { // RegionSelectedEvent
    java.lang.System.out.println("RegionSelected");
    var rect = event.getSelectionRectangle();
    java.lang.System.out.println("Rectangle (X,Y): (" + rect.getX() + "," + rect.getY() + 
        "); (W,H): (" + rect.getWidth() + "," + rect.getHeight() + ")");
}
 
function PreReleaseBatch(event) { // ReleaseBatchEvent
    // Skips the postProcess setting specified in the Capture profile and only unlocks the batch.
    event.setProcessorID(null);
    event.setJobID(null);
}

3.5.2 Sample Client Script 2

This sample script customizes client behavior in the following ways:

• Uses the BatchScanBegin function to restrict files that can be imported to those with a .TIF extension only.

• Uses the DBSearchResults function to modify the results of a database lookup so that only the first result is used, and prevents the results list from displaying.

function BatchScanBegin(event) { // BatchScanEvent
    // Check if there are files being imported.
    var sourceFilesList = event.getSourceFiles();
    if (sourceFilesList != null) {
        // Create a list to hold the filtered results.
        var filteredList = new java.util.ArrayList();
        
        // Loop through each of the files.
        var iterator = sourceFilesList.iterator();
        while (iterator.hasNext()) {
            // If the file name ends with ".TIF", add it to the list.
            var file = iterator.next();
            var filename = file.getName().toUpperCase();
            if (filename.endsWith(".TIF")) {
                filteredList.add(file);
            }
        }
        
        // Replace the original list with the filtered list.
        event.setSourceFiles(filteredList);
    }
}
 
function DBSearchResults(searchEvent) { // DBSearchEvent
    var results;
    var resultRow;
    var searchParameters;
 
    // Return only the first search result.
    results = searchEvent.getRowResults();
    if (results.size() > 0) {
        resultRow = results.get(0);
        results.clear();
        results.add(resultRow);
        // Do not display the list of results to the user.
        searchEvent.setDisplayHitlist(false);
    }
}

3.5.3 Sample Client Script 3

This sample script customizes client behavior in the following ways:

• Uses the PreReleaseBatch event to copy metadata from the first document in a batch to the remaining documents in the batch. Copying of metadata takes place when the batch is released. The variable, fieldsToCopy, specifies which metadata fields are to be copied. For each document to which fields are being copied, if a field already contains a value, that value is not overwritten.

• Iterates through the documents in a batch.

• Obtains the metadata fields from a document.

• Sets the metadata field values.

• Saves the changes to a document.

function PreReleaseBatch(event) {
    // Metadata fields to copy to remaining documents
    var fieldsToCopy = new Array("Account Name", "Account Number");
    
    // Loop through each batch being released
    var batches = event.getBatches();
    for (var batchIdx = 0; batchIdx < batches.size(); batchIdx++) {
        var batch = batches.get(batchIdx);
        var documents = batch.getDocuments();
        if (documents.size() == 0)
            continue;
        // Get the first document from which we'll be copying
        var firstDocument = documents.get(0);
        var captureFields = [];
        // Create an array of the first document's fields
        var fieldDefs = batch.getWorkspace().getFieldDefinitions();
        for (var fieldIdx = 0; fieldIdx < fieldsToCopy.length; fieldIdx++) {
            var fieldID = fieldDefs.findByName(fieldsToCopy[fieldIdx]).getId();
            captureFields[fieldIdx] = firstDocument.getFields().get(fieldID);
        }
        // Loop through the remaining documents in the batch
        for (var documentIdx = 1; documentIdx < documents.size(); documentIdx++) {
            var destDocument = documents.get(documentIdx);
            var fields = destDocument.getFields();
            // Copy the source document's field values to the destination document
            for (var fieldIdx = 0; fieldIdx < captureFields.length; fieldIdx++) {
                var sourceField = captureFields[fieldIdx];
                // If the field in the source document was never set, skip it.
                if (sourceField == null)
                    continue;
                // Look up the field in the document
                var destField = fields.get(sourceField.getFieldName());
                // If it doesn't exist yet, create it
                if (destField == null)
                    destField = fields.add(sourceField.getFieldName());
                // If the value hasn't been set yet, set it
                if ((destField.getValue() == null) || (destField.getValue().isEmpty())) {
                    destField.setValue(sourceField.getValue());
                    destField.setDisplayValue(sourceField.getDisplayValue());
                }
            }
            // Save the document.
            destDocument.persist();
        }
    }
}