Annotation Properties

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

ActiveMarkings Property

The list of ActiveMarking objects currently applied to a given object. Each ActiveMarking object represents a marking that is in a MarkingSet associated with a property on the object.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  ActiveMarking
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

AnnotatedContentElement Property

Specifies the index of the document content element to which this annotation applies. This property is intended only as a means by which an application can match an annotation with a document content element. The server does not keep track of this property value nor does it enforce it for referential integrity.

Because the positional index of a given content element within a document's ContentElementList collection is subject to change, it is recommended that you populate this property with the value of the content element's ElementSequenceNumber property rather than its positional index. The value of the ElementSequenceNumber property is server-generated and provides a unique and unchanging number for a given content element. Because the number of content elements of a document is variable, if you choose to use a positional index it is up to your application to ensure that it accurately reflects the correct index of the content element to which the annotation applies. For example, if the AnnotatedContentElement property specifies the positional index of the third content element of a document with five content elements, and the second content element is then removed, the property will consequently reference the wrong content element.

Metadata

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

AnnotatedObject Property

Specifies an IndependentObject object of type Document, Folder, or CustomObject to which this annotation has been applied.

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:  Annotations
RequiredClass:  Containable
RequiresUniqueElements:  false
Settability:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  LINK

AuditedEvents Property

An EventSet collection of the Event objects containing the audited events that have occurred for the object.

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
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

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

Metadata

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

ContentElements Property

Specifies a ContentElementList object containing the list of content elements associated with this document or annotation. Each content element represents content data, which can either be local to an object store and stored in a file store or database (represented by a ContentTransfer object) or external to an object store and therefore outside the control of the Content Engine server (represented by a ContentReference object).

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:  null
RequiredClass:  ContentElement
RequiresUniqueElements:  true
Settability:  READ_WRITE
TargetAccessRequired:  READ

ContentElementsPresent Property

Specifies a StringList object containing the MIME type of each content element associated with this document or annotation at the time it was last saved.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

ContentSize Property

Specifies the size in bytes of the content data associated with this document, annotation, or ContentTransfer object. Note that if the document or annotation has more than one content element, then the size is the sum of all of the content elements.

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

Creator Property

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.

Metadata

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

DateContentLastAccessed Property

Specifies the date and time when the content data (represented by a ContentTransfer object) associated with this document or annotation was last accessed. The Content Engine stores dates and times using Coordinated Universal Time (UTC). The recording granularity of the date and time returned by this property is determined by the setting of the object store's ContentAccessRecordingLevel property. The content data associated with a document or annotation object is considered to be accessed when one of the following events occur: Each of these events will update the date of the DateContentLastAccessed property. Note that even if the content data is larger than the user-specified chunk size and multiple trips to the database or cache are required, the DateContentLastAccessed property will be set only to the date and time that the content data was first accessed. Applications that access content data frequently will cause continual updates of the DateContentLastAccessed property by the server, which can result in degraded performance. Therefore, it is recommended that you set the ContentAccessRecordingLevel property to control the frequency that the DateContentLastAccessed property is updated.

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

DateCreated Property

Indicates the date and time the object was created. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

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.

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:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  READ

DateLastModified Property

Indicates the date and time the object was last modified. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

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).

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

DescriptiveText Property

User-readable text that describes an object.

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
MaximumLengthString:  255
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

ExternalReplicaIdentities Property

Specifies an ExternalIdentityList collection of the ExternalIdentity objects representing the identities of replicas of this object in external repositories.

Metadata

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

Id Property

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 User and Group 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, calls to User.get_Id() and Group.get_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:

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.

Metadata

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

IndexationId Property

The object ID (GUID) of the Verity collection used. This will be null for objects that were full text indexed prior to the 4.0 release.

This property must be set if the property is to be CBR enabled (the PropertyDefinitionString.IsCBREnabled property).

Metadata

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

LastModifier Property

Indicates the name of the user who last modified this 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).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
MaximumLengthString:  80
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

MimeType Property

Specifies the Multipurpose Internet Mail Extensions (MIME) format string of the content data carried by this document, annotation, or document classification action.

For Document objects, you can set the MimeType property for a specific document version while it is a reservation object (at creation time and on subsequent check-outs). However, every time you check in a document, its MimeType property value reverts to its system-assigned value unless you explicitly set it again.

For Annotation objects, you can set this property at any time.

For DocumentClassificationAction objects, the MimeType property specifies the type of content that a document must hold in order to allow it to be auto-classified; you can set this property at any time.

Each content element that is attached to a document or annotation has its own MIME type, which is specified by its ContentType property. If you do not specify the MimeType property for a document or annotation, it is automatically determined by the Content Engine according to the setting of each content element's ContentType property and the following logic:

MIME is a communications protocol that allows for the transmission of data in many forms, such as audio, binary, or video. A MIME format string consists of a content type, a content subtype, and an optional parameter in the following format: "MIME::content type/subtype[;parameter]". For example: "MIME::text/html". MIME defines the following content types:

The following MIME types are specific to FileNet:

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
MaximumLengthString:  96
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

Name Property

The name for this object.

For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  true
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Owner Property

Manages the security owner assigned to the object.

Metadata

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

Permissions Property

Manages the discretionary permissions assigned to the object.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  true
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE_ACL
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  DiscretionaryPermission
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

ReplicationGroup Property

Specifies a ReplicationGroup object representing the replication group to which this replicable object belongs.

Metadata

AllowsDefaultChange:  true
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  true
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
ModificationAccessRequired:  WRITE_ACL
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  ReplicationGroup
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

StorageArea Property

Specifies the storage area for a content-carrying object.

Metadata

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

StorageLocation Property

Specifies the storage location for an object's content. This property is deprecated in FileNet P8 4.0 and is only set in upgraded object stores. It has been replaced by the StorageArea property.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
MaximumLengthString:  64
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

StoragePolicy Property

Specifies the document's storage policy, which identifies the set of available storage areas that are considered equivalent based on common, user-specified criteria. Assigning a storage policy to a document is the recommended method of selecting a storage area. The alternative is to directly assign the storage area (specify the StorageArea property).

When a document is created, the order of precedence for setting the storage on the Document instance is (from highest to lowest):

The default ClassDefinition for a document sets the StorageArea to "Database Storage Area" and the StoragePolicy to "All Storage Areas". Therefore, if you create a new Document instance of the default Document ClassDefinition with only the StoragePolicy property set, the document will use the class default for the StorageArea property (Database Storage Area).

To avoid this situation, you must set the instance value for the document's StorageArea property to null. Because the instance value for StorageArea is set, but has no value, the StoragePolicy property will be evaluated and used.

In general, storage policies should be used to allow administrators to properly administer their storage systems. They can assign multiple storage areas to be load balanced, and also assign standby storage areas to be used if any of the current storage areas become full.

Metadata

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

This Property

The current object. The primary purpose of this property is to enable the expression of relationships among objects in a Content Engine query and to select candidate objects in the query results.

Metadata

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