Go to main content
1/13
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
What's New In This Guide
Significant Documentation Changes for 12c (12.2.1.3.0)
New and Changed Features for 12c (12.2.1.1)
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 URL
3
Creating Client Scripts
3.1
Client Events
3.1.1
AttachmentCreated
3.1.2
AttachmentRemoved
3.1.3
AttachmentSelected
3.1.4
BatchScanBegin
3.1.5
BatchScanComplete
3.1.6
BatchSelected
3.1.7
CaptureImage
3.1.8
CaptureInitialize
3.1.9
DBSearchComplete
3.1.10
DBSearchResults
3.1.11
DBSearchStart
3.1.12
DocumentCreated
3.1.13
DocumentRemoved
3.1.14
DocumentSelected
3.1.15
FieldGotFocus
3.1.16
FieldLostFocus
3.1.17
FieldProcessKey
3.1.18
InitializeFields
3.1.19
PageCreated
3.1.20
PreBatchDelete
3.1.21
PreBatchScan
3.1.22
PreCaptureImage
3.1.23
PreDownloadItem
3.1.24
PrePageDelete
3.1.25
PreDocumentProfileChange
3.1.26
DocumentProfileChanged
3.1.27
PreReleaseBatch
3.1.28
PreUploadItem
3.1.29
PostCaptureImage
3.1.30
PostDownloadItem
3.1.31
PostUploadItem
3.1.32
RegionSelected
3.1.33
ScriptStart
3.2
Event Classes
3.2.1
AttachmentCreatedEvent
3.2.2
AttachmentRemoveEvent
3.2.3
AttachmentSelectedEvent
3.2.4
BatchDeleteEvent
3.2.5
BatchScanEvent
3.2.6
BatchSelectedEvent
3.2.7
DBSearchEvent
3.2.8
DocumentRemoveEvent
3.2.9
DocumentSelectedEvent
3.2.10
DownloadItemEvent
3.2.11
FieldEvent
3.2.12
ImageCaptureEvent
3.2.13
InitializeFieldsEvent
3.2.14
PageCreatedEvent
3.2.15
PageDeleteEvent
3.2.16
PreDocumentProfileChangeEvent
3.2.17
DocumentProfileChangedEvent
3.2.18
RegionSelectedEvent
3.2.19
ReleaseBatchEvent
3.2.20
UploadItemEvent
3.3
Capture Client Core Classes
3.3.1
AttachmentType
3.3.2
AttachmentTypes
3.3.3
BarcodeInfo
3.3.4
CaptureAttachment
3.3.5
CaptureAttachments
3.3.6
CaptureBatch
3.3.7
CaptureBatchStatus
3.3.8
CaptureDataType
3.3.9
CaptureDocument
3.3.10
CaptureDocumentPage
3.3.11
CaptureDocumentPages
3.3.12
CaptureDocuments
3.3.13
CaptureErrorManager
3.3.14
CaptureField
3.3.15
CaptureFields
3.3.16
CaptureItem
3.3.17
CaptureItems
3.3.18
CaptureOperation
3.3.19
CaptureStateManager
3.3.20
CaptureWorkspace
3.3.21
ClientProfile
3.3.22
ClientReleaseProcess
3.3.23
ClientReleaseProcesses
3.3.24
ClientUI
3.3.25
DBLookupProfile
3.3.26
DBLookupResult
3.3.27
DbSearchResultRow
3.3.28
DbSearchFieldInfo
3.3.29
DocumentType
3.3.30
DocumentTypes
3.3.31
FieldDefinition
3.3.32
FieldDefinitions
3.3.33
ImageCaptureEngine
3.3.34
MicrInfo
3.3.35
Source
3.3.36
TWAINSource
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
3.5.3
Sample Client Script 3
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
ProcessorAttachment
4.2.5
ProcessorDocument
4.2.6
ProcessorItem
4.2.7
ProcessSeparatorPage
4.2.8
RecognitionJob
4.2.9
RecognitionJobField
4.2.10
RecognitionProcessorContext
4.2.11
SeparatorDefinition
4.2.12
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.5.6
Sample Import Processor Scripts
5.5.6.1
Sample Import Processor Script 1
5.5.6.2
Sample Import Processor Script 2
6
Creating Document Conversion Processor Scripts
6.1
DocumentConverterContext Class
6.2
Document Conversion Processor Events
6.2.1
Initialize
6.2.2
preProcessBatch
6.2.3
postProcessBatch
6.2.4
preProcessDocument
6.2.5
postProcessDocument
6.2.6
preProcessAttachment
6.2.7
postProcessAttachment
6.2.8
preProcessPage
6.2.9
postProcessPage
6.2.10
preInvokeExternalProcess
6.2.11
postInvokeExternalProcess
6.3
Sample Document Conversion Processor Scripts
6.3.1
Sample Document Conversion Processor Script 1
6.3.2
Sample Document Conversion Processor Script 2
6.3.3
Sample Document Conversion Processor Script 3
7
Creating Commit Processor Scripts
7.1
CommitEventObject Class
7.2
Commit Processor Events
7.2.1
preCommit
7.2.2
preReleaseDocument
7.2.3
postReleaseDocument
7.2.4
postCommit
7.3
Sample Commit Processor Scripts
7.3.1
Sample Commit Processor Script 1
7.3.2
Sample Commit Processor Script 2
7.3.3
Sample Commit Processor Script 3
8
Working with Common Capture Classes
8.1
Common Capture Classes
8.1.1
BatchEntity
8.1.2
BatchItemEntity
8.1.3
BatchLockEntity
8.1.4
BatchManagerSession
8.1.5
BatchStatusEntity
8.1.6
CaptureWorkspaceEntity
8.1.7
DBSearchResults
8.1.8
DBSearchResultRow
8.1.9
DBSearchFieldInfo
8.1.10
DocumentEntity
8.1.11
DocumentPageEntity
8.1.12
DocumentTypeEntity
8.1.13
IndexDefinitionEntity
8.1.14
IndexValue
A
Keycodes
Scripting on this page enhances content navigation, but does not change the content in any way.