This appendix contains the following sections:
The following table lists all the properties that can be set for a Client Profile object (class name: oracle.oddc.data.Profile).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Profile Name |
profileName |
String |
Any value |
|
Description |
profileDesc |
String |
Any value |
|
Online |
profileStatus |
boolean |
Any value |
|
Apply Default Brightness and Contrast |
applyBrightness |
boolean |
Any value |
|
Batch Prefix |
batchPrefix |
String |
Any value |
|
Profile Type |
scanningType |
int |
1 - Capture only 2 - Capture and Index 3 - Index only |
|
Non-Image File Preview Page Limit |
maxPages |
int |
Any value |
|
Default Status |
defaultStatus |
String |
Any value |
|
Batch Priority |
defaultPriority |
int |
Any value |
|
Document Creation Option |
docOption |
int |
1 - One page (for example, Simplex) 2 - Two pages (for example, Duplex) 3 - Variable number of pages 4 - Prompt the user |
|
Separator Sheet Byte Threshold |
sepByteThreshold |
int |
Any value |
|
Blank Page Byte Threshold: |
blankByteThreshold |
long |
Any value |
|
Database Lookup Profile |
dbLookupProfile |
String |
Any value |
|
Always Display Records |
dbLookupHitList |
boolean |
Any value |
|
Dependent Choice List |
pickListRelationshipProfile |
String |
Any value |
|
Records Returned Limit |
dbLookupMaxRecords |
int |
Any value |
|
Brightness |
brightness |
int |
Any value |
|
Contrast |
contrast |
int |
Any value |
|
Batch Visibility |
batchVisibility |
int |
0 - User and workstation 1 - User 2 - All users |
|
Non-Image File Import Action |
nonImageImportAction |
int |
0 - Do not import 1 - Import in native format 2 - Convert to image format |
|
Additional Batch Prefixes (separate by ;) |
filterPrefix |
String |
Any value |
|
Days Old: From |
filterDaysFrom |
int |
Any value |
|
Days Old: To |
filterDaysTo |
int |
Any value |
|
Batch Statuses |
filterStatus |
List<String> |
Any value |
|
Priorities |
filterPriority |
List<Integer> |
[0,1,2,3,4,5,6,7,8,9,10] |
|
Primary Sort |
filterPrimarySort |
String |
BatchName/BatchPageCount/BatchDate/BatchPriority/BatchStatus |
|
Primary Sort Order |
filterPrimaryOrder |
int |
0 - Ascending 1 - Descending |
|
Secondary Sort |
filterSecondarySort |
String |
BatchName/BatchPageCount/BatchDate/BatchPriority/BatchStatus |
|
Secondary Sort Order |
filterSecondaryOrder |
int |
Any value |
|
Document Profiles |
supportedDocumentTypes |
List<String> |
Any value |
|
Batch Processor |
batchProcessorID |
String |
oracle.odc.docconverterprocessor.DocumentConverterProcessor/oracle.odc.commitprocessor.CommitProcessor/oracle.odc.recognitionprocessor.RecognitionProcessor |
|
Batch Processor Job |
batchProcessorJobID |
String |
Any value |
|
Default Color |
defaultColor |
int |
0 - Not specified 1 - Black and white 2 - Gray scale 3 - Color |
|
Default DPI: |
defaultDPI |
int |
0(Not specified)/100 /150/200/240/300/400/600 |
|
Prevent Default Override |
preventDefaultColorOverride |
boolean |
Any value |
|
Prevent Default Override |
preventDefaultDPIOverride |
boolean |
Any value |
|
Non-Image conversion : Color |
convertColor |
int |
0 - TIFF: black and white 1 - JPEG: color |
|
Non-Image conversion :JPEG Image Quality |
convertQuality |
int |
Any value |
|
Non-Image conversion:DPI |
convertDPI |
int |
0(Not specified)/100 /150/200/240/300/400/600 |
The following section lists all the properties that can be set for an Import Processor Job object (class name: oracle.odc.importprocessor.ImportJob).
This section contains the following topics:
The following table lists the General Import Job properties that can be set (use class name: oracle.odc.importprocessor.ImportJob).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Online |
isJobOnline |
Boolean |
Any value |
|
Import Job Name |
jobName |
String |
Any value |
|
Image Down-Sample |
imageDownsample |
Integer |
0 - None (retain image format) 1 - Down-sample color to 8 bit (gray scale) 2 - Down-sample color or gray scale to black and white |
|
JPEG Image Quality |
jpegQuality |
Integer |
Any value |
|
Batch Prefix |
batchPrefix |
String |
Any value |
|
Default Batch Status |
defaultBatchStatusID |
String |
Any value |
|
Default Batch Priority |
defaultPriority |
Integer |
Any value |
|
Database Lookup Profile |
dbSearchID |
String |
Any value |
|
Database Search Field |
dbSearchFieldID |
String |
Any value |
|
Default Document Profile |
defaultDocumentTypeID |
String |
Any value |
|
When more than one record is found |
searchResultOption |
Integer |
0 - Use first record 1 - Do not select a record |
|
Script |
scriptID |
String |
Any value |
|
Import Frequency |
importFrequency |
Integer |
15: 15 seconds 30: 30 seconds 60: 1 minute 300: 5 minutes 900: 15 minutes 1800: 30 minutes 3600: 1 hour -1: Daily |
|
Import Source |
importSourceClassName |
String |
oracle.odc.importprocessor.folder.FolderSource /oracle.odc.importprocessor.email.EmailSource /oracle.odc.importprocessor.listfile.ListFileSource |
|
Batch Processor |
batchProcessorClassName |
String |
oracle.odc.docconverterprocessor.DocumentConverterProcessor/oracle.odc.commitprocessor.CommitProcessor/oracle.odc.recognitionprocessor.RecognitionProcessor |
|
Batch Processor Job |
batchProcessorJobID |
String |
Any value |
|
Import Freq: Every Day: Time Hr: |
hour |
Integer |
Any value |
|
Import Freq: Every Day: Time Min: |
minute |
Integer |
Any value |
|
Default Locale |
locale |
Locale |
Any value |
|
If Image Validation Fails: |
imageFailureAction |
Integer |
0 - Delete the batch 1 - Skip the file |
|
Default Date Format |
defaultDateFormat |
String |
Any value |
|
Description |
description |
String |
Any value |
|
Encoding |
encoding |
String |
Any value |
The following table lists the Folder Import Job properties that can be set (use class name: oracle.odc.importprocessor.ImportJob).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Import Folder Path |
folder |
String |
Any value |
|
Process subfolders |
processSubfolders |
boolean |
Any value |
|
Create a New Batch |
batchCreationOption |
int |
0 - Per file 1 - Per folder |
|
File Mask(s) |
fileMasks |
String |
Any value |
|
Primary Sort Type |
primarySortType |
FolderSortType |
0 - None 1 - File Name 2 - File Extension 3 - File Modified Date |
|
Primary Sort Order |
primarySortOrder |
FolderSortOrder |
0 - Ascending 1 - Descending |
|
Secondary Sort Type |
secondarySortType |
FolderSortType |
0 - None 1 - File name 2 - File extension 3 - File modified date |
|
Secondary Sort Order |
secondarySortOrder |
FolderSortOrder |
0(Ascending) / 1(Descending) |
|
Ready File |
readyFile |
String |
Any value |
|
After Import |
postProcessingOption |
int |
0 - Delete file 1 - Change file extension 2 - Add file prefix |
|
New Extension |
fileExtension |
String |
Any value |
|
Prefix |
filePrefix |
String |
Any value |
|
Delete processed subfolder if empty |
deleteSubfolders |
boolean |
Any value |
The following table lists the List File Import Job properties that can be set (use class name: oracle.odc.importprocessor.ImportJob).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Import Folder Path |
folder |
String |
Any value |
|
Create a New Batch: |
batchCreationOption |
int |
0 - Per list file 1 - Per folder |
|
File Mask(s) |
fileMasks |
String |
Any value |
|
Process subfolders |
processSubfolders |
boolean |
Any value |
|
Field Delimiter |
fieldDelimiter |
String |
Any value |
|
Maximum Fields Per Document |
maxFieldsPerRecord |
int |
Any value |
|
Document File Field Position |
documentFieldPosition |
int |
Any value |
|
After Import |
postProcessingOption |
int |
0 - Delete file 1 - Change file extension 2 - Add file prefix |
|
New Extension |
fileExtension |
String |
Any value |
|
Prefix |
filePrefix |
String |
Any value |
|
Delete document files after successful import |
deleteDocumentFiles |
boolean |
Any value |
The following table lists the Email Job properties that can be set (use class name: oracle.odc.importprocessor.ImportJob).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
IMAP Connection Security |
imapConnectSecurity |
EmailConnectionSecurity |
0 - NONE 1 - STARTTLS 2 - SSL_TLS |
|
Email Server Name (DNS name or IP address) |
serverName |
String |
Any value |
|
Port |
port |
int |
Any value |
|
Folders to Process |
folderList |
List<String> |
Any value |
|
Message Filters: From Address |
filterFromAddressEnabled |
boolean |
Any value |
|
Message Filters: From Address Field Contains |
filterFromAddress |
String |
Any value |
|
Message Filters: Subject |
filterSubjectEnabled |
boolean |
Any value |
|
Message Filters: Subject Field Contains |
filterSubject |
String |
Any value |
|
Message Filters: Message Body |
filterMessageBodyEnabled |
boolean |
Any value |
|
Message Filters: Message Body Field Contains |
filterMessageBody |
String |
Any value |
|
Include attachments matching these mask(s) |
attachmentsMask |
String |
Any value |
|
Exclude attachments matching these mask(s) |
attachmentsExcludeMask |
String |
Any value |
|
Email Message Options |
includeMessageBodyOption |
int |
0 - Import as text 1 - Import in EML format |
|
Import message body file |
includeMessageBodyFile |
boolean |
Any value |
|
Import entire message in EML format |
includeEntireEMLFile |
boolean |
Any value |
|
Document Ordering |
emailDocumentOrder |
List<Integer> |
0 - Message body (text file) 1 - Message body (EML file) 2 - Email message (EML file) 3 - Attachment(s) |
|
Include when no attachments exist |
includeMessageBodyWithoutAttachments |
boolean |
Any value |
|
Upon Failed Import |
postProcessingFailureOption |
int |
0 - Delete the message 1 - Move the message to another folder 2 - Do not delete the message |
|
Upon Successful Import: |
postProcessingSuccessOption |
int |
0 - Delete message 1 - Move message to another folder |
|
Folder Name: |
postProcessingFailureMoveFolder |
String |
Any value |
|
Folder Name |
postProcessingSuccessMoveFolder |
String |
Any value |
|
Search Operator |
searchOperator |
int |
0 - AND 1 - OR |
|
Determined based on email importance |
determineBatchPriority |
boolean |
Any value |
|
Email Importance Low: Batch Priority |
batchPriorityLow |
int |
Any value |
|
Email Importance Normal: Batch Priority |
batchPriorityNormal |
int |
Any value |
|
Email Importance High: Batch Priority |
batchPriorityHigh |
int |
Any value |
|
Email Accounts to Process |
emailAccounts |
List<String> |
Any value |
The following table lists all the properties that can be set for a Recognition Processor Job object (class name: oracle.odc.recognition.RecognitionJob).
This section contains the following topics:
The following table lists the General Recognition Job properties that can be set (use class name: oracle.odc.recognition.RecognitionJob).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Recognition Job Name |
name |
String |
Any value |
|
Description |
description |
String |
Any value |
|
Script |
scriptID |
String |
Any value |
|
Online |
online |
Boolean |
Any value |
|
Bar Codes |
barcodes |
List<BarcodeDefinition> |
Any value |
|
Enable Auto-Detect |
autoDetectBarcodes |
Boolean |
Any value |
|
Validate optional checksum |
validateCheckSum |
Boolean |
Any value |
|
Bar Code Recognition |
symbologies |
List<Integer> |
[0,1,2,3,4,5,6,7,8,9] (Auto-Detectable 1-D Symbologies) / [10,11,12,13,14,15,16,17,18](Other 1-D Symbologies) / [19,20,21](2-D Symbologies) |
|
Organize documents based on |
batchOrganization |
Integer |
0 - Fixed number of pages per document 1 - None: Do not perform document organization 2 - Same bar code value on each page 3 - Separator pages 4 - Hierarchical separator pages |
|
Number of Pages Per Document: |
documentPageCount |
Integer |
Any value |
|
Number of pages per document to read bar codes: |
pagesPerDoc2ReadBarcodes |
Integer |
Any value |
|
Maximum Number of Pages Per Document: |
maxPageCountPerDoc |
Integer |
Any value |
|
Optimistic bar code detection |
optimizeBarcodeDetection |
Boolean |
Any value |
|
Separator Page: |
coverPages |
List<SeparatorDefinition> |
Any value |
|
If more than one value is found for a bar code within a document |
multiBarcodeValuesOption |
Integer |
0 - Use the first value found 1 - Always overwrite the bar code value 2 - Clear the bar code value |
|
Source Document Attachments: |
sourceDocAttachments |
Integer |
0 - Include all attachments to created documents 1 - Include attachments with matching Document Profile attachment types 2 - Do not include attachments |
|
Dynamic Document Profile Option: |
dynamicDocType |
Integer |
0 - Do not determine dynamically 1 - Determine dynamically using bar code 2 - Determine dynamically using separator page |
|
Default Document Profile: |
defaultDocTypeID |
String |
Any value |
|
Document Profile and Bar Code Value Mappings |
docTypeMappings |
List<DocumentDefinition> |
Any value |
|
Fields |
jobFields |
List<RecognitionJobField> |
Any value |
|
DB Lookup Using: |
dblookupUsing |
Integer |
0 - None 1 - Bar code 2 - Field value |
|
Field Name |
dblookupIndexDefID |
String |
Any value |
|
Database Lookup Profile |
dblookupProfile |
String |
Any value |
|
Database Search Field: |
dblookupSearchField |
String |
Any value |
|
When more than one record is found: |
dblookupMultipleRecordAction |
Integer |
0 - Use first record 1 - Do not link |
|
When no record is found: |
dblookupNoMatchAction |
Integer |
0 - Allow document commit 1 - Prevent document commit |
|
To rename the batch, enter a prefix: |
renamePrefix |
String |
Any value |
|
To send email notification, enter email address: |
renameEmail |
String |
Any value |
|
To change batch status, select a status: |
renameStatus |
String |
Any value |
|
To change batch priority, enter a priority between 1 to 10: |
renamePriority |
Integer |
Number between 1 to 10 |
|
Batch Processor |
processorID |
String |
Any value |
|
Batch Processor Job: |
processorJobID |
String |
Any value |
|
To rename the batch, enter a prefix: |
failureRenamePrefix |
String |
Any value |
|
To send email notification, enter email address: |
failureRenameEmail |
String |
Any value |
|
To change batch status, select a status: |
failureRenameStatus |
String |
Any value |
|
To change batch priority, enter a priority between 1 to 10: |
failureRenamePriority |
Integer |
Number between 1 to 10 |
|
Batch Processor |
failureProcessorID |
String |
Any value |
|
Batch Processor Job: |
failureProcessorJobID |
String |
Any value |
|
Bar Code Engine |
decoder |
Integer |
0 - Universal Decoder 1 - Windows Decoder |
|
Maximum Bar Codes per Image |
maxBarcodes |
Integer |
Number between 1 to 10 |
|
Minimum Bar Code Height |
minHeight |
Double |
Any valid value between 0.2 to 3.0 |
|
Unit of Measure |
unitMeasure |
Integer |
0 - Inch 1 - Centimeter |
|
Maximum Bar Code Width |
maxWidth |
Double |
Any valid value between minHeight to 10 |
|
Minimum Bar Code Characters |
minChars |
Integer |
Number between 1 to 1000 |
The following table lists the BarcodeDefinition properties that can be set (use class name: oracle.odc.recognition.RecognitionJob).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Name |
barcodeName |
String |
Any value |
|
Validation Rules |
validationRule |
Integer |
0 - None 1 - Length 2 - Mask 3 - Regular expression 4 - Choice list |
|
Length |
validationLength |
Integer |
Any value |
|
Mask |
validationMask |
String |
Any value |
|
Regular Expression |
validationRegularExpression |
String |
Any value |
|
Choice List Source |
pickListSourceID |
String |
Any value |
|
Choice List Source |
pickListID |
String |
Any value |
The following table lists the DocumentDefinition properties that can be set (use class name: oracle.odc.recognition.RecognitionJob).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Bar Code Value Matches: |
mappingType |
Integer |
0 - Single value 1 - Choice list |
|
Single Value: |
value |
String |
Any value |
The following table lists the RecognitionJobField properties that can be set (use class name: oracle.odc.recognition.RecognitionJob).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Auto Populate |
autoPopulate |
Integer |
0 - None 1 - Bar code 2 - Batch name 3 - Default 4 - Index date 5 - Scan date |
|
Barcode |
populateValue |
String |
Any value |
The following table lists the SeparatorDefinition properties that can be set (use class name: oracle.odc.recognition.RecognitionJob).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Rule Name |
name |
String |
Any value |
|
Delete this separator page upon commit |
deleteUponCommit |
Boolean |
Any value |
|
Operator |
operator |
Integer |
0 - OR 1 - AND |
|
Document Profile |
docTypeID |
String |
Any value |
|
Attachment Type |
attachmentTypeID |
String |
Any value |
The following table lists all the properties that can be set for a Commit Profile object (class name: oracle.odc.entity.CommitProfileEntity).
This section contains the following topics:
The following table lists the General Commit Profile properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Commit Profile Name |
profileName |
String |
Any value |
|
Document Output Format |
exportDriverID |
String |
oracle.odc.export.PDFSearchable/oracle.odc.export.PDFImageOnly/oracle.odc.export.TIFFMultiImage |
|
Attachment Document Output Format |
attachExportDriverID |
String |
oracle.odc.export.PDFSearchable/oracle.odc.export.PDFImageOnly/oracle.odc.export.TIFFMultiImage |
|
Commit Driver |
commitDriverID |
String |
oracle.odc.commit.TextFileCommitDriver(Text File)/oracle.odc.commit.cs.ContentCommitDriver(WebCenter Content) / oracle.odc.commit.ipm.IPMCommitDriver(WebCenter Content Imaging) |
|
Online |
active |
Boolean |
Any value |
|
Edit Execution Order |
executionOrder |
Integer |
Any value |
|
Error Handling Policy |
errorHandlingPolicy |
Integer |
0 - Continue to the next document 1 - Cancel to next commit profile 2 - Cancel commit |
|
Restrict Commit to Document Profiles |
documentTypes |
List<DocumentTypeEntity> |
Any value |
|
Default Locale |
defaultLocaleString |
String |
Any value |
|
Default Date Format |
defaultDateFormat |
String |
Any value |
|
Encoding |
encoding |
String |
Any value |
Note:
To update the Default Locale field associated with a commit profile, pass a value that includes all the three parts of a locale, that is, language, country, and variant. Use a vertical bar (|) to separate the parts of the locale. The following example sets the locale to Chinese (China): defaultLocaleString = zh|CN|.
The following table lists the Text File Commit Profile properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Do not create Commit Text File |
doNotCreateTextFile |
boolean |
Any value |
|
Store in subfolders |
useTextSubFolder |
boolean |
Any value |
|
Exclude Attachments |
excludeAttachment |
boolean |
Any value |
|
Text File Folder : Subfolder Options |
textSubFolderOption |
int |
0 - Year 1 - Year and month 2 - Year, month, and date |
|
Commit Text File Folder |
textFileFolder |
String |
Any value |
|
File Prefix |
textFilePrefix |
String |
Any value |
|
File Extension |
textFileExtension |
String |
Any value |
|
Create a copy for each page |
duplicateLinkedItems |
boolean |
Any value |
|
Create a folder per committed batch |
oneFolderPerBatch |
boolean |
Any value |
|
Store in subfolders |
useDocSubFolder |
boolean |
Any value |
|
Document Folder :Subfolder Options |
docSubFolderOption |
int |
0 - Year 1 - Year and month 2 - Year, month, and date 3 - Metadata field(s) |
|
Document Folder |
docFolder |
String |
Any value |
|
Selected Metadata Fields |
subFolderIndexes |
List<String> |
Any value |
|
SubFolder Path |
subFolderPath |
String |
Any value |
|
Field Delimiter |
delimiterOption |
int |
0 - Comma 1 - Semicolon 2 - Other |
|
Text Qualifier |
textQualifier |
int |
0 -None 1 - Double quote 2 - Single quote |
|
Other Character |
formatDelimiter |
String |
Any value |
|
Text Qualifier |
formatFields |
List<String> |
Any value |
|
Name document file based on metadata field values |
nameDoc |
boolean |
Any value |
|
If File Name Consists of Invalid Characters |
docNameInvalidCharOption |
int |
0 - Remove invalid characters 1 - Cancel document commit |
|
Document File Naming: Field Delimiter |
docNameDelimiter |
String |
Any value |
|
Fields to Include in Document File Name |
docNameFields |
List<String> |
Any value |
The following table lists the Webcenter Content Commit Profile properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Server URL |
serverURL |
String |
Any value |
|
Name document file based on metadata values |
documentFileNaming |
boolean |
Any value |
|
Document File Name |
documentFilename |
String |
Any value |
|
If file name consists of invalid characters: |
removeDocFilenameInvalidChars |
boolean |
Any value |
|
Document Title |
documentTitle |
String |
Any value |
|
Default Account |
documentAccount |
String |
Any value |
|
Default Security Group |
documentSecurityGroup |
String |
Any value |
|
Default Type |
documentType |
String |
Any value |
|
Assign Values Dynamically |
dynamicAssignment |
boolean |
Any value |
|
Assign Value |
dynamicMappingOption |
int |
0 - By field mappings 1 - By metadata field |
|
Metadata Field |
dynamicMappingIndexField |
String |
Any value |
|
Choice List Source |
dynamicMappingPicklistSourceId |
String |
Any value |
|
Choice List |
dynamicMappingPicklistId |
String |
Any value |
|
Account |
accountMappingField |
String |
Any value |
|
Type |
contentTypeMappingField |
String |
Any value |
|
Security Group |
securityGroupMappingField |
String |
Any value |
|
Content Attribute Mapping |
attributeMappingList |
List<ContentAttributeMappingInfo> |
Any value |
|
Bypass Workflows |
bypassWorkflow |
boolean |
Any value |
|
Alternative Check-In Service |
alternateCheckInService |
String |
Any value |
|
Select Capture metadata fields to assign to Content Server fields |
fieldMappingList |
List<CaptureToContentFieldMapping> |
Any value |
|
Custom Fields |
customMetadataList |
List<ContentFieldNameInfo> |
Any value |
|
Exclude Attachments |
excludeAttachments |
boolean |
Any value |
The following table lists the ContentAttributeMappingInfo Class properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Field Value |
fieldValue |
String |
Any value |
|
Type |
docType |
String |
Any value |
|
Security Group |
docSecurityGroup |
String |
Any value |
|
Account |
docAccount |
String |
Any value |
The following table lists the CaptureToContentFieldMapping Class properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Content Server Field |
captureField |
String |
Any value |
|
Capture Field |
contentField |
String |
Any value |
The following table lists the ContentFieldNameInfo Class properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Custom Field Name |
name |
String |
Any value |
|
Custom Field Caption |
caption |
String |
Any value |
The following table lists the Webcenter Imaging Commit Profile properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Commit Methods |
commitMethod |
int |
0 - Direct commit 1 - Input agent commit |
|
Search and append to matching Imaging documents |
append |
boolean |
Any value |
|
Imaging WebService URL |
url |
String |
Any value |
|
Security Policy |
policy |
int |
0 - Basic security 1 - Token security |
|
Capture Output Directory |
inputDir |
String |
Any value |
|
Input Agent Directory |
inputAgentDir |
String |
Any value |
|
Search Definition |
searchName |
String |
Any value |
The following table lists the PDF Searchable Document Output properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Create Text File |
textFormat |
Integer |
0 - Do not create text file 1 - Create text file format |
|
Languages: |
language |
String |
comma separated language IDs [0-122] For example, “0, 2, 3, 18" |
|
Text File Code Page |
codePage |
String |
Any value |
|
Professional Dictionaries |
profDictionary |
String |
Comma separated professional dictionary name. For example, “English Medical Dictionary, German Legal Dictionary" |
|
Color Image Quality |
colorImageQuality |
int |
0 - Minimum: minimum size 1 - Good: medium size 2 - Best: large size |
|
Compatibility |
compatibility |
String |
PDF14/PDF15/PDF16/PDF17/PDFA1B/PDFA2B/PDFA2U |
|
Create Linear PDF for Efficient Web Viewing |
linearized |
boolean |
Any value |
|
Preserve Original Image Orientation |
keepImgOrientation |
boolean |
Any value |
|
Single Language Detection per Page |
singleLangPerPage |
boolean |
Any value |
The following table lists the DOCS Commit Driver properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Server URL |
serverURL |
String |
Any value |
|
Name |
parentFolderName |
String |
Any value |
|
ID |
parentFolderID |
String |
Any value |
|
Sub-Folder Fields: |
subFolderFields |
List<String> |
Any value |
|
Create Sub-Folders using Field Values |
createSubFolders |
boolean |
Any value |
|
If folder name consists of invalid characters: |
folderInvalidCharOption |
int |
0 - Remove invalid characters 1 - Cancel document commit |
|
Use original file name for non-image files |
useOriginalFileName |
boolean |
Any value |
|
Name document file based on metadata field values |
nameDoc |
boolean |
Any value |
|
Fields to Include in Document File Name: |
docFileFields |
List<String> |
Any value |
|
Field Delimiter |
docFileDelimiter |
String |
Any value |
|
If file name consists of invalid characters: |
docFileInvalidCharOption |
int |
0 - Remove invalid characters 1 - Cancel document commit |
The following table lists all the properties that can be set for a Document Conversion Job object (class name: oracle.odc.docconverter.DocConverterJob).
| Property Name (on the UI) | Property Name (in the Class) | Data Type | Valid Options |
|---|---|---|---|
|
Name: |
jobName |
String |
Any value |
|
Online: |
online |
boolean |
Any value |
|
JPEG Image Quality |
jpegQuality |
Integer |
1<jpegQuality<=99 |
|
Documents to Convert: |
docFilter |
Boolean |
true: Selected non-image documents false: All non-image documents |
|
Attachments to Convert: |
docAttachmentFilter |
Boolean |
Any value |
|
Output Image Format: |
outputImageFormat |
Integer |
0 - TIFF: black and white 1 - JPEG: color |
|
File Name Filter: |
filterpattern |
String |
Any value |
|
Batch Merge Option: |
documentMergeType |
Integer |
0 - Do not merge documents 1 - Merge the first document with all other documents 2 - Merge the last document with all other documents 3 - Merge all documents |
|
Source Document Page Placement: |
mergeToBeginning |
boolean |
true: Start of the target document false: End of the target document |
|
Apply source document's metadata values |
applySourceMetadata |
boolean |
Any value |
|
Allow target document's metadata values to be overwritten |
overwriteDestinationMetadata |
boolean |
Any value |
|
Description: |
description |
String |
Any value |
|
Batch Processor: |
processorID |
String |
Any value |
|
Batch Processor Job: |
processorJobID |
String |
Any value |
|
To rename the batch, enter a prefix: |
renamePrefix |
String |
Any value |
|
To send email notification, enter email address: |
renameEmail |
String |
Any value |
|
To change batch status, select a status: |
renameStatus |
String |
Any value |
|
To change batch priority, enter a priority between 1 to 10: |
renamePriority |
Integer |
[1-10] |
|
Batch Processor: |
errProcessorID |
String |
Any value |
|
Batch Processor Job: |
errProcessorJobID |
String |
Any value |
|
To rename the batch, enter a prefix: |
errRenamePrefix |
String |
Any value |
|
To send email notification, enter email address: |
errRenameEmail |
String |
Any value |
|
To change batch status, select a status: |
errRenameStatus |
String |
Any value |
|
To change batch priority, enter a priority between 1 to 10: |
errRenamePriority |
Integer |
[1-10] |
|
DPI: |
dpi |
Integer |
100 / 150 /200 / 240/300/400/600 |
|
External Conversion Use: |
extConvEnabled |
Boolean |
true: On false: Off |
|
File Name Filter(s): |
extConvFilterPattern |
String |
Any value |
|
External Conversion Program: |
extConvProgram |
String |
Any value |
|
Command Line Parameters: |
extConvCommandLine |
String |
Any value |
|
Process Monitoring Method: |
extConvMonitoringMethod |
Integer |
0 - Duration time out 1 - Output file inactivity time out |
|
Timeout (minutes): |
extConvTimeout |
Integer |
[1-1000] |
|
Success Return Code |
extConvSuccessReturnCode |
Integer |
Any value |
|
Do not convert: |
doNotConvertDocs |
Boolean |
Any value |
|
Do not convert: |
doNotConvertDocAttachments |
Boolean |
Any value |
|
File Name Filter: |
attachmentFilterPattern |
String |
Any value |
|
Source Attachments: |
documentAttachmentMergeType |
Integer |
0 - Do not include attachments 1 - Include all attachments to the merged documents 2 - Include attachments with the matching Document Profile Attachment Types |
|
Restrict to Document Profiles: |
documentTypes |
List<DocumentTypeEntity> |
Any value |
|
Restrict to Attachment Types: |
attachmentTypes |
List<DocumentAttachmentTypeEntity> |
Any value |