CmBackgroundSearch Properties

This topic alphabetically lists the properties that apply to the CmBackgroundSearch class.

AllowStringTruncation Property



Indicates whether string-valued property values can be truncated if their length exceeds the maximum length of the corresponding property on the search result.

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

AuditedEvents Property



A collection of event objects audited for the object.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Event
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ClassDescription Property



Describes an object's class.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Creator Property



The name of the user who created this object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

DateCreated Property



The date and time this object was created.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

DateLastModified Property



The date and time when this object was last modified.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

DisplayName Property



A user-intelligible name for the object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

EffectiveEndDate Property



The date and time after which this sweep rule becomes no longer eligible to run

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

EffectiveSQL Property



The SQL statement produced by the background search after parameter substitution has been performed.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

EffectiveStartDate Property



The date and time this sweep rule becomes effective and eligible to run

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ExaminedObjectCount Property



The total number of candidate objects discovered by the sweep.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DOUBLE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

FailedObjectCount Property



The total number of objects that failed when applying the sweep action for sweep.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DOUBLE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

FailureCount Property



The number of times this queued object has failed.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 0
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

Id Property



The unique object ID.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: GUID
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

InterBatchDelay Property



The minimum amount of time in milliseconds between each query for the next batch of candidate objects during the execution of a sweep

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: TBD [RD-3]
PropertyMinimumInteger32: TBD [RD-4]
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

IsEnabled Property



Indicates whether this object is enabled.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: true
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

LastFailureReason Property



A description of the reason for the last processing failure for this object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

LastModifier Property



The name of the user who last modified this object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

MaxSweepWorkers Property



The maximum number of workers that may be allocated for processing a sweep

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: TBD [RD-2]
PropertyMaximumInteger32: TBD [RD-3]
PropertyMinimumInteger32: TBD [RD-4]
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

MaximumExaminedRowCount Property



Specifies the number of rows the background search should examine before stopping. A value of zero indicates that all rows be examined.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 0
PropertyMaximumInteger32: TBD [RD-3]
PropertyMinimumInteger32: TBD [RD-4]
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

MaximumFailures Property



The maximum number of times a dequeue operation for a Queue Sweep will be retried following a failure

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: TBD [RD-2]
PropertyMaximumInteger32: TBD [RD-3]
PropertyMinimumInteger32: TBD [RD-4]
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

OrderByGroupedProperties Property



Indicates whether the properties specified in the background search GROUP BY clause should be included in the underlying ORDER BY clause (if applicable).

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Owner Property



The security owner of the object.

Metadata

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

Permissions Property



The discretionary permissions for the object.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: 8
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmAbstractPermission
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ProcessedObjectCount Property



The total number of objects processed by the sweep.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DOUBLE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

SearchExpression Property



The Content Platform Engine SQL expression used in the background search.

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

SearchObjectStore Property



Indicates the object store against which this background search should execute.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: DocSpace
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

SearchResults Property



The current enumeration of search results objects corresponding to the background search.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: BackgroundSearch
RequiredClass: CmAbstractSearchResult
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

SweepBatchSize Property



The number of candidate objects that will be passed to the Sweep handler in a single batch

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: TBD [RD-2]
PropertyMaximumInteger32: TBD [RD-3]
PropertyMinimumInteger32: TBD [RD-4]
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

SweepEndDate Property



A timestamp indicating the sweep has completed and when. If NULL, the sweep has not completed yet.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

SweepRetryWaitInterval Property



The 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

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: TBD [RD-2]
PropertyMaximumInteger32: TBD [RD-3]
PropertyMinimumInteger32: TBD [RD-4]
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

SweepStartDate Property



A timestamp indicating the sweep is in progress and when it started. Null means no sweep is currently in progress

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

SweepTarget Property



Specifies the class for which instances will be swept

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ClassDefinition
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

SweepTimeslots Property



A list of Timeslot objects that determine the schedule for sweep processing.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmTimeslot
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

This Property



Enables the expression of relationships among objects in DMA queries and selects candidate objects in query results.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmBackgroundSearch
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ