Provides a set of constants that identifies the types of failures that have occurred as a result of an index request for a CBR-enabled object. A constant identifying each type of indexing failure is added to the bitmask returned by the CmIndexingFailureCode property of the CBR-enabled object and its associated index request. If there are no indexing failures, the CmIndexingFailureCode property returns a value of zero.

Namespace:  FileNet.Api.Constants
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Enumeration IndexingFailureCode
C#
public enum IndexingFailureCode
Visual C++
public enum class IndexingFailureCode
JavaScript
FileNet.Api.Constants.IndexingFailureCode = function();
FileNet.Api.Constants.IndexingFailureCode.createEnum('FileNet.Api.Constants.IndexingFailureCode', false);

ToggleMembers

TypeMember nameDescription
MALFORMED
Indicates some or all of the text to be extracted for the full text index is missing and the content was not read correctly.
OTHER
Indicates an uncommon error occurred. Check the value of the LastFailureReason property on CmIndexRequest to determine the cause.
TRUNCATED
Indicates the content text was truncated in the full text index. The maximum text limit is specified in the max.text.size parameter located in the parser_config.xml file for the document’s collection. For more information, see Text extracted from a document during indexing is truncated.
ENCRYPTED
Indicates some or all of the text to be indexed was not indexed because it was encrypted.
TIME_OUT
Indicates that the indexing operation has timed out.
SIZE_LIMIT_EXCEEDED
Indicates the size of the binary or XML content has exceeded a maximum value.
PASSWORD_PROTECTED
Indicates some or all of the text to be extracted for the full text index was not indexed because it was password-protected.
CONTENT_NOT_FOUND
Indicates that the CBR-enabled object does not have any content elements. Therefore, no text can be indexed.
PARTIALLY_INDEXED_CONTENT
Indicates one of the content elements was only partially indexed.
UNRECOGNIZED_ENCODING
Indicates the code page for the content was not identified.
FALLBACK_PARSER_INVOKED
Indicates the text extracted from the content for the full text index may be incorrect. The primary parser was unable to parse the content and the fallback parser was invoked. The content may have been partially indexed.
CONVERSION_DISABLED
Indicates the text extraction process used to convert content to plain text is disabled.
NO_TEXT_EXTRACTED
Indicates an empty file was found during indexing.
MARKED_AS_SKIPPED
Indicates that an administrator or an application (via the IndexingOperation property of a CmIndexRequest object) has marked a CBR-enabled object to be skipped for full-text indexing. If the indexing failure code of a CBR-enabled object is set to MARKED_AS_SKIPPED, the server will not index the object. If any additional index requests exist for the object, they will be deleted.
UNSUPPORTED_TYPE
Indicates some or all of the text to be extracted for the full text index was not indexed because the content type is not supported.

For IBM® Legacy Content Search Engine, this failure code is also returned for files that are password-protected.

MALFORMED_XML
Indicates the XML to be extracted for the full text index was not well-formed XML.

ToggleSee Also