Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

What's New In This Guide

• New and Changed Features for 11g Release 1 (11.1.1.9) - October 2017 Patch
• New and Changed Features for 11g Release 1 (11.1.1.9)
• Other Significant Changes in this Document for 11g Release 1 (11.1.1.9)

1 Introduction to Developing Scripts with Oracle WebCenter Enterprise Capture

• 1.1 Developing Scripts with WebCenter Enterprise Capture

2 Integrating the Client With Other Web Applications

• 2.1 Configuring a Client Integration
  • 2.1.1 Example Client Integration Web Address

3 Creating Client Scripts

• 3.1 Client Events
  • 3.1.1 BatchScanBegin
  • 3.1.2 BatchScanComplete
  • 3.1.3 BatchSelected
  • 3.1.4 CaptureImage
  • 3.1.5 DBSearchComplete
  • 3.1.6 DBSearchResults
  • 3.1.7 DBSearchStart
  • 3.1.8 DocumentCreated
  • 3.1.9 DocumentRemoved
  • 3.1.10 DocumentSelected
  • 3.1.11 FieldGotFocus
  • 3.1.12 FieldLostFocus
  • 3.1.13 FieldProcessKey
  • 3.1.14 PreBatchDelete
  • 3.1.15 PreCaptureImage
  • 3.1.16 PreDocumentRemove
  • 3.1.17 PreDownloadItem
  • 3.1.18 PrePageDelete
  • 3.1.19 PreReleaseBatch
  • 3.1.20 PreUploadItem
  • 3.1.21 PostCaptureImage
  • 3.1.22 PostDownloadItem
  • 3.1.23 PostUploadItem
  • 3.1.24 RegionSelected
  • 3.1.25 ScriptStart
• 3.2 Event Classes
  • 3.2.1 BatchDeleteEvent
  • 3.2.2 BatchScanEvent
  • 3.2.3 BatchSelectedEvent
  • 3.2.4 DBSearchEvent
  • 3.2.5 DocumentRemovedEvent
  • 3.2.6 DocumentSelectedEvent
  • 3.2.7 DownloadItemEvent
  • 3.2.8 FieldEvent
  • 3.2.9 ImageCaptureEvent
  • 3.2.10 PageDeleteEvent
  • 3.2.11 PreDocumentRemoveEvent
  • 3.2.12 RegionSelectedEvent
  • 3.2.13 ReleaseBatchEvent
  • 3.2.14 UploadItemEvent
• 3.3 Capture Client Core Classes
  • 3.3.1 CaptureBatch
  • 3.3.2 CaptureBatchStatus
  • 3.3.3 CaptureDataType
  • 3.3.4 CaptureDocument
  • 3.3.5 CaptureDocumentPage
  • 3.3.6 CaptureDocumentPages
  • 3.3.7 CaptureDocuments
  • 3.3.8 CaptureErrorManager
  • 3.3.9 CaptureField
  • 3.3.10 CaptureFields
  • 3.3.11 CaptureItem
  • 3.3.12 CaptureItems
  • 3.3.13 CaptureOperation
  • 3.3.14 CaptureStateManager
  • 3.3.15 CaptureWorkspace
  • 3.3.16 ClientProfile
  • 3.3.17 ClientUI
  • 3.3.18 DBLookupProfile
  • 3.3.19 DBLookupResult
  • 3.3.20 DbSearchResultRow
  • 3.3.21 DbSearchFieldInfo
  • 3.3.22 DocumentType
  • 3.3.23 DocumentTypes
  • 3.3.24 FieldDefinition
  • 3.3.25 FieldDefinitions
• 3.4 Capture Client FieldEdit Classes
  • 3.4.1 DataField
  • 3.4.2 DateField
  • 3.4.3 FloatField
  • 3.4.4 IntegerField
  • 3.4.5 PicklistEntry
  • 3.4.6 PicklistField
  • 3.4.7 TextField
• 3.5 Sample Client Scripts
  • 3.5.1 Sample Client Script 1
  • 3.5.2 Sample Client Script 2

4 Creating Recognition Processor Scripts

• 4.1 Recognition Processor Methods
  • 4.1.1 initialize
  • 4.1.2 processBatch
  • 4.1.3 restoreCaptureBatch
  • 4.1.4 beginPhase
  • 4.1.5 endPhase
  • 4.1.6 extractBatchItem
  • 4.1.7 barcodesFoundOnItem
  • 4.1.8 batchItemAllValidBarcodes
  • 4.1.9 determineSeparatorPage
  • 4.1.10 batchItemValidBarcode
  • 4.1.11 determineDocType
  • 4.1.12 beginDatabaseLookup
  • 4.1.13 determineIndexValues
  • 4.1.14 renameOrigCaptureDocTitle
  • 4.1.15 createCaptureDoc
  • 4.1.16 postProcess
  • 4.1.17 endBatchProcess
• 4.2 Recognition Processor Classes
  • 4.2.1 BarcodeDefinition
  • 4.2.2 DocumentDefinition
  • 4.2.3 PostProcessContext
  • 4.2.4 ProcessorDocument
  • 4.2.5 ProcessorItem
  • 4.2.6 ProcessorSeparatorPage
  • 4.2.7 RecognitionJob
  • 4.2.8 RecognitionJobField
  • 4.2.9 RecognitionProcessorContext
  • 4.2.10 SeparatorDefinition
  • 4.2.11 SeparatorRuleDefinition
• 4.3 Sample Recognition Processor Script

5 Creating Import Processor Scripts

• 5.1 Import Processor Events
  • 5.1.1 preProcess
  • 5.1.2 process
  • 5.1.3 postProcess
  • 5.1.4 preCreateBatch
  • 5.1.5 postCreateBatch
  • 5.1.6 preCreateDocument
  • 5.1.7 postCreateDocument
  • 5.1.8 preImportFile
  • 5.1.9 postImportFile
  • 5.1.10 preRelease
  • 5.1.11 postRelease
  • 5.1.12 preDatabaseSearch
  • 5.1.13 processDatabaseSearchResults
• 5.2 Email Source Events
  • 5.2.1 deleteMessage
  • 5.2.2 moveMessage
  • 5.2.3 newAttachment
  • 5.2.4 newMessage
• 5.3 Folder Source Events
  • 5.3.1 deleteDocumentFile
  • 5.3.2 newFolder
  • 5.3.3 renameDocumentFile
• 5.4 List File Source Events
  • 5.4.1 deleteListFile
  • 5.4.2 newFolder
  • 5.4.3 newListFile
  • 5.4.4 newListFileLine
  • 5.4.5 renameListFile
• 5.5 Import Processor Classes
  • 5.5.1 EmailSourceContext
  • 5.5.2 FolderSourceContext
  • 5.5.3 ImportJob
  • 5.5.4 ImportProcessorContext
  • 5.5.5 ListFileSourceContext
• 5.6 Sample Import Processor Script

6 Working with Common Capture Classes

• 6.1 Common Capture Classes
  • 6.1.1 BatchEntity
  • 6.1.2 BatchItemEntity
  • 6.1.3 BatchLockEntity
  • 6.1.4 BatchStatusEntity
  • 6.1.5 CaptureWorkspaceEntity
  • 6.1.6 DBSearchResults
  • 6.1.7 DBSearchResultRow
  • 6.1.8 DBSearchFieldInfo
  • 6.1.9 DocumentEntity
  • 6.1.10 DocumentPageEntity
  • 6.1.11 DocumentTypeEntity
  • 6.1.12 IndexDefinitionEntity
  • 6.1.13 IndexValue

A Keycodes