The text of a filter expression that, when evaluated, determines the action to be taken on the object. This property applies to IStoragePolicy, ISubscription, IAuditDefinition, ICmSweepPolicy, and ICmSweepJob objects.

For a IStoragePolicy object, FilterExpression is used as the selection criteria for determining into which storage area the content for a document or annotation should be stored. The expression is evaluated against all storage areas to determine which ones are deemed "equivalent" in terms of this storage policy. For more information, see Storage policies.

For a ISubscription-based object, FilterExpression is used to determine whether the event action should be launched. For IAuditDefinition, FilterExpression is used to determine whether an event should be audited. The filter is applied to either the source object, or optionally, to the object specified in the FilteredPropertyId property of ISubscription or IAuditDefinition. Note that for version series subscriptions, the filter is applied to the document version in the transaction and not to the version series.

For ISubscription, the Content Engine server evaluates the filter expression, as follows:

  • If the value of the expression evaluates to true, the event specified by the subscription is fired or enqueued, as appropriate (depending on whether the event code is set to execute synchronously or asynchronously).
  • If the value evaluates to false or unknown (typically resulting from a property that has no value), or if there is an error in the evaluation (such as a syntax error in the expression or an incorrect reference to a property), the event is silently discarded.

For a sweep job or sweep policy, FilterExpression is used to evaluate each instance of of the sweep-target class. If the value of the expression evaluates to true, an operation is applied to the instance. The operation performed depends on the type of sweep.

For IAuditDefinition objects, FilterExpression is only applicable to events of type IObjectChangeEvent. If the value of the expression evaluates to true, the event is audited; otherwise, it is not audited.

The syntax of this property must be a fragment of a SQL where-clause expression (for example, VersionStatus = 1) and use supported operators. See SQL Syntax Reference.

Note that some operators that are valid in an ad hoc SQL query are not supported in FilterExpression. The following operators are not supported.

  • Binary compare operators (e.g., Equal Binary)
  • Contains
  • Exists
  • Float64 To Integer 32 Round/Truncate
  • In Folder and In Subfolder
  • Integer32 To Float 32
  • IsDefined
  • Joins (e.g., Full Outer Join)

Note that a filter expression can include conditions expressed against non-queryable and non-persistent properties. For example, the following is a valid expression: Owner='jsmith'

For ISubscription and IAuditDefinition objects only, you can use the IsModified predicate, for filtering events based on modified properties of the source object.

A filter expression using the IsModified predicate must be constructed as follows: IsModified(property), where property can be in any form supported elsewhere in the query, for example, table_alias.property_alias.

Note that the IsModified predicate can only be used in a filter expression. It cannot be used in an ad hoc SQL query.

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

ToggleSyntax

Visual Basic (Declaration)
Property FilterExpression As String
C#
string FilterExpression { get; set; }
Visual C++
property String^ FilterExpression {
	String^ get ();
	void set (String^ value);
}
JavaScript
function get_filterExpression();
function set_filterExpression(value);

ToggleRemarks

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: true
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: SETTABLE_ONLY_ON_CREATE
TargetAccessRequired: READ

ToggleSee Also