A boolean that enables or disables Content Engine text extraction for purposes of building content-based retrieval (CBR) indexes. Text extraction refers to the extraction of text from documents of various types, such as Microsoft Word, PDF, and so on. Set the value of this property to true to extract text from documents using Content Engine and false to extract text using the text search engine. The text search engine builds the CBR indexes using the extracted text in both cases.
Set the property value to true only if the Content Engine text extraction capabilities have been installed. If those capabilities have not be installed, Content Engine logs the error "CBRPreFilter is not deployed" to the FileNet P8 log file when it attempts to filter the text for a document.
Java Virtual Machine (JVM) options for Content Engine text extraction
Content Engine creates a separate subprocess to filter the text
for each document. On occasion, a malformed document might cause a
subprocess to enter an unstable state such that it can never complete its
text extraction task. You can configure how long Content Engine allows a
subprocess to run by setting the CBRPreFilterInitialTimeout JVM option. When
a timeout occurs, Content Engine terminates the subprocess and can retry
the filter operation by creating another subprocess. Use the
CBRPreFilterMaxRetryCount JVM option to specify the maximum number of
retry subprocesses. The descriptions for these JVM options follow:
- CBRPreFilterInitialTimeout (Integer)
An interval in seconds that Content Engine uses to calculate the timeout intervals for the text extraction subprocesses that work on a particular document. The default value for this option is 60. The timeout interval for the initial subprocess is specified by this option value, and the interval for any subsequent retry subprocess is twice as large as the interval for the previous subprocess. That is, the calculation is as follows:subprocess n timeout interval = 2(n-1) * option value
where n is one for the first subprocess, two for the second (retry) subprocess, and so on. For example, if the value for this option is 60, the timeout period for the first subprocess is 1 minute (60 seconds); for the second, 2 minutes; for the third, 4 minutes; and so on. Content Engine considers no timeout interval to be in effect when the the value for this option is zero. - CBRPreFilterMaxRetryCount (Integer)
The maximum number of retry subprocesses that Content Engine sequentially creates to work on a particular document. The default value for this option is 3.
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
<ObsoleteAttribute("As of release 5.1.0.")> _ Property CBRPreFilterEnabled As Nullable(Of Boolean) |
C# |
---|
[ObsoleteAttribute("As of release 5.1.0.")] Nullable<bool> CBRPreFilterEnabled { get; set; } |
Visual C++ |
---|
[ObsoleteAttribute(L"As of release 5.1.0.")] property Nullable<bool> CBRPreFilterEnabled { Nullable<bool> get (); void set (Nullable<bool> value); } |
JavaScript |
---|
function get_cbrPreFilterEnabled(); function set_cbrPreFilterEnabled(value); |
Remarks
Metadata
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ