Specifies rank ordering behavior for content-based retrieval (CBR) queries that request rank order. The possible values are as follows, set with a CBRQueryRankOverride value.
  • DISABLED (0 or null). This setting applies to CBR searches that combine both a full text query and a relational search on a database (DB), and when the CBRQueryOptimization property is set to DYNAMIC_SWITCHING.

    In dynamic switching mode and for a search requesting rank order, the server can only calculate results in rank order when the search is performed content first (CBR-first search). It is not possible for the server to perform the search database first (DB-first search) with rank order calculated.

    This setting forces CBR-first only searches for combined queries that request rank order. The server will not perform DB-first searches if rank order is requested. If you want results to always be ordered by rank, set this property to DISABLED.

  • ENABLED (1). This setting applies to CBR searches that combine both a full text query and a relational search on a database (DB), and when the CBRQueryOptimization property is set to DYNAMIC_SWITCHING.

    For optimized execution of combined searches that request rank order, set this property to ENABLED. The server will dynamically switch between CBR first and DB first, and will return CBR-first searches in rank order. The server will suppress the request for rank order if dynamic switching chooses a DB-first search.

  • REQUIRED (2). This setting suppresses a request for rank order for all CBR searches, with or without dynamic switching enabled, including CBR-first searches.

    With dynamic switching and a setting of REQUIRED, the server will dynamically switch between CBR first and DB first, and it will suppress the request for rank order for both DB-first and CBR-first searches. Removing all rank ordering can help performance, especially for searches running against multiple collections.

For more information, see CBR Query Optimization.

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

ToggleSyntax

Visual Basic (Declaration)
Property CBRQueryRankOverride As Nullable(Of CBRQueryRankOverride)
C#
Nullable<CBRQueryRankOverride> CBRQueryRankOverride { get; set; }
Visual C++
property Nullable<CBRQueryRankOverride> CBRQueryRankOverride {
	Nullable<CBRQueryRankOverride> get ();
	void set (Nullable<CBRQueryRankOverride> value);
}
JavaScript
function get_cbrQueryRankOverride();
function set_cbrQueryRankOverride(value);

ToggleRemarks

ToggleSee Also