The IIndexJob type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyCreator
Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Public propertyDateCreated
Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Public propertyDateLastModified
Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Public propertyDescriptiveText
User-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

  • ClassDescription
  • PropertyDescription
  • ClassDefinition
  • PropertyTemplate
  • PropertyDefinition
Public propertyId
A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.Id.

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Public propertyIndexItems
The list of classes or collections to index. All objects in this list are a subclass of IndexJobItem.
Public propertyIndexRequests
Identifies the index requests associated with the index job.
Public propertyIsMigrationJob
Specifies whether this index job is for index migration purposes (true) or not (false). If this property is set to true, all of the IndexJobItem objects belonging to this index job must be of type IndexJobCollectionItem (for Verity collections).
Public propertyJobAbortRequested
Indicates whether this indexing job has been requested to abort.
Public propertyJobPauseRequested
Specifies whether this index job is paused (true) or not (false). If this property is set to true, the JobStatus property of the index job is set to IndexJobStatus.PAUSED. Otherwise, this index job is in progress and its JobStatus property is set to IndexJobStatus.IN_PROGRESS.
Public propertyJobStatus
The status of the indexing job. This can be one of the following: Pending, InProgress, AbortInProgress, Paused, TerminateNormally, or TerminatedAbnormally. For descriptions of each value, see FileNet.Api.Constants.IndexJobStatus.
Public propertyLastFailureReason
For IIndexJob and ICmIndexRequest objects, this property identifies the final failure condition for the index job.

For an IReplicationJournalEntry object, this property provides a description of the latest failure condition, if any, for the replication operation that generates this journal entry.

For an ICmThumbnailRequest object, this property states why document thumbnail generation failed.

For an ICmBackgroundSearch object, this property provides a description of the latest failure condition, if any, for the background search operation that generates this journal entry.

For an ICmTask object, this property indicates why the object has been set to the exception state. This property is settable only during the SET_EXCEPTION changeState transaction, for example:

ICmTask.changeState(SET_EXCEPTION);
ICmTask.set_LastFailureReason ( "Required document was not attached to workflow.");
ICmTask.save();

To reset LastFailureReason to a null value, clear the exception: ICmTask.changeState(CLEAR_EXCEPTION).

Public propertyLastModifier
Indicates the name of the user who last modified the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Public propertyMaxRequestQueueSize
The maximum number of index requests that are produced by this index job that are allowed to be outstanding (in progress or waiting) at any time.

Maintaining a limit on index requests for an index job can prevent large index jobs from causing performance problems. This index request limit applies only to the number of index requests for the index job that exists in the IndexRequests table; it is not a limit on the total number of index requests that an index job can create.

The default value is 100,000 and the minimum value is 1000. To impose no limits on outstanding index requests, set this property to -1.

Public propertyOwner
Manages the security owner assigned to the object.
Public propertyPermissions
Manages the discretionary permissions assigned to the object.
Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertySubmittedCount
The number of objects that currently have been submitted for indexing. This value is incremented as new requests are submitted to index additional objects.
Public propertyTimeAllSubmitted
Indicates the time when all requests have been submitted for this indexing job. This value is null if all index requests have not yet been submitted. Note that this property does not indicate completion of the requests contained in the indexing job (see the JobStatus property for this information).
Public propertyTimeLastProcessed
Indicates the time when the last activity occurred on this indexing job.

ToggleSee Also