StorageArea Properties

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

AllowsContentToBeCached Property

Specifies whether the content data in this storage area can be cached (true) or not (false). The default is true.

Metadata

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

AllowsDelete Property

Indicates whether content can be deleted from a storage area. The default is true (deletes are allowed). When false, any attempt to delete (or move) content from the storage area will result in an exception.

Metadata

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

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

ClosureDate Property

Specifies the date and time when the storage area will close and no longer accept new content.

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

ContentElementCount Property

The number of content elements stored in this storage area.

For a ContentCacheArea object, this property returns null when the server cannot physically access the cache storage area and the CacheStatus property setting is Closed. Also, this statistic, along with the statistic concerning content element size (the ContentElementKBytes property), can become inaccurate as the result of power failures; properly timed failures will prevent servers from keeping the statistics in perfect sync with content creations and deletions. A cache sweep updates the statistics every 60 days to keep them reasonably accurate.

Metadata

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

ContentElementKBytes Property

The size of all content elements stored in this storage area (in kilobytes).

For the ContentCacheArea object, this property returns null when the server cannot physically access the cache storage area and the CacheStatus property setting is Closed. Also, this statistic can become inaccurate; for more information, see the ContentElementCount property.

Metadata

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

ContentElementsCreated Property

Total content elements created in a Storage Area.

Metadata

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

ContentElementsDeleted Property

The number of content elements deleted from this storage area.

For the ContentCacheArea object, a cache clearing operation initializes this number to 0 (zero). For information on cache clearing, see the CacheStatus property. For information on the potential inaccuracy of this number, see the ContentCacheArea class.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  DOUBLE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
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

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

DisplayName Property

The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  true
MaximumLengthString:  64
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
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:  true
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

MaximumContentElements Property

The maximum number of content elements designated for this storage area.

For a content cache area, new content can be added to a cache only if the number-of-content-elements statistic (the ContentElementCount property) is less than this maximum. (This maximum might be slightly exceeded, as statistics are managed on a delayed basis, and multiple servers can be adding content.) The value for this property must be greater than or equal to 1.

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

MaximumSizeKBytes Property

The maximum size of all content elements designated for this storage area (in kilobytes).

For a content cache area, new content can be added to a cache only if the size-of-content-elements statistic (the ContentElementKBytes property) is less than this maximum. (This maximum might be slightly exceeded, as statistics are managed on a delayed basis, and multiple servers can be adding content.) The value for this property must be greater than or equal to 1.

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_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

ResourceStatus Property

Contains a ResourceStatus object, which specifies the availability status of a storage or index area. The status value can be any one of the following:

Note: When the ResourceStatus value is UNAVAILABLE, the indexer creates a new collection and completes any pending index requests using the new collection.

The Content Engine supports the following automatic transitions between status values:

An area's status can also be changed manually as allowed by the following rules:

Metadata

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

RetentionPeriod Property

Specifies when a content element will expire, so that it can be deleted from a storage area object. A positive value represents the number of minutes the content element must be retained. Other possible values, as enumerated in the RetentionPeriod class, are:

Metadata

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

Site Property

Identifies the site associated with a given object. A site represents a geographical area in the FileNet P8 domain. If you do not specify a site when creating the associated object, the value of that object's Site property defaults to the value of Domain.DefaultSite.

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:  Site
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:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  StorageArea
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ