CmBackgroundSearch Properties This topic alphabetically lists the properties that apply to the CmBackgroundSearch class.
AllowStringTruncation PropertyIndicates whether string-valued property values can be truncated if their length exceeds the maximum length of the corresponding property on the search result.
Metadata AuditedEvents PropertyA collection of event objects audited for the object.
Metadata ClassDescription PropertyDescribes an object's class.
Metadata Creator PropertyThe name of the user who created this object.
Metadata DateCreated PropertyThe date and time this object was created.
Metadata DateLastModified PropertyThe date and time when this object was last modified.
Metadata DisplayName PropertyA user-intelligible name for the object.
Metadata EffectiveEndDate PropertyThe date and time after which this sweep rule becomes no longer eligible to run
Metadata EffectiveSQL PropertyThe SQL statement produced by the background search after parameter substitution has been performed.
Metadata EffectiveStartDate PropertyThe date and time this sweep rule becomes effective and eligible to run
Metadata ExaminedObjectCount PropertyThe total number of candidate objects discovered by the sweep.
Metadata FailedObjectCount PropertyThe total number of objects that failed when applying the sweep action for sweep.
Metadata FailureCount PropertyThe number of times this queued object has failed.
Metadata Id PropertyThe unique object ID.
Metadata InterBatchDelay PropertyThe minimum amount of time in milliseconds between each query for the next batch of candidate objects during the execution of a sweep
Metadata IsEnabled PropertyIndicates whether this object is enabled.
Metadata LastFailureReason PropertyA description of the reason for the last processing failure for this object.
Metadata LastModifier PropertyThe name of the user who last modified this object.
Metadata MaxSweepWorkers PropertyThe maximum number of workers that may be allocated for processing a sweep
Metadata MaximumExaminedRowCount PropertySpecifies the number of rows the background search should examine before stopping. A value of zero indicates that all rows be examined.
Metadata MaximumFailures PropertyThe maximum number of times a dequeue operation for a Queue Sweep will be retried following a failure
Metadata OrderByGroupedProperties PropertyIndicates whether the properties specified in the background search GROUP BY clause should be included in the underlying ORDER BY clause (if applicable).
Metadata Owner PropertyThe security owner of the object.
Metadata Permissions PropertyThe discretionary permissions for the object.
Metadata ProcessedObjectCount PropertyThe total number of objects processed by the sweep.
Metadata SearchExpression PropertyThe Content Platform Engine SQL expression used in the background search.
Metadata SearchObjectStore PropertyIndicates the object store against which this background search should execute.
Metadata SearchResults PropertyThe current enumeration of search results objects corresponding to the background search.
Metadata SweepBatchSize PropertyThe number of candidate objects that will be passed to the Sweep handler in a single batch
Metadata SweepEndDate PropertyA timestamp indicating the sweep has completed and when. If NULL, the sweep has not completed yet.
Metadata SweepRetryWaitInterval PropertyThe minimum number of seconds after retriable exception has occurred during the processing of a sweep batch before another attempt will be made to process the batch
Metadata SweepStartDate PropertyA timestamp indicating the sweep is in progress and when it started. Null means no sweep is currently in progress
Metadata SweepTarget PropertySpecifies the class for which instances will be swept
Metadata SweepTimeslots PropertyA list of Timeslot objects that determine the schedule for sweep processing.
Metadata This PropertyEnables the expression of relationships among objects in DMA queries and selects candidate objects in query results.
Metadata