This topic alphabetically lists the properties that apply to the StorageArea class.
EventSet
collection of the Event
objects containing the audited events that have occurred for the
object.
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
If you enable content compression, you can modify default operation settings with the CmCompressionThresholdPercent and CompressionBlockSize properties.
Some data formats, such as JPEG and ZIP, do not compress well, and the server compression overhead might not be worth the marginal savings of storage space for such formats. This property allows you to define the threshold at which data will not be compressed. You can also define the block size of the content stream to be compressed, as set in the CompressionBlockSize property.
This property requires that content compression be turned on, as set in the CmCompressionEnabled property. For administrator-related information, see Content compression.
When an open index areas becomes full, the Content Engine server chooses the standby index area with the highest priority and sets it to open. If two or more index areas exist with the same priority, one of these standby index areas is chosen randomly by the server.
You can control this feature by setting the JVM parameter
com.filenet.engine.cbr.LegacyStandbyActivationPolicy on your application
server. By default, this JVM parameter is
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.
StorageArea
object,
this property reflects the compressed size of the content.
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.
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.
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.
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.
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).
The text is not locale-specific to the retrieving user except for the following classes:
Name
property of the object's class.
For CmAuditProcessingBookmark
and AuditDefinition
objects, this property is intended to identify client applications
that process the audit log.
For CmAuditProcessingBookmark
objects, this property, in support of the audit disposition feature, identifies the client that created the object.
For AuditDefinition
objects, this property identifies a set of audit definitions for a given client or client functionality.
For CmAuditProcessingBookmark
and AuditDefinition
objects, it is recommended that you set this property.
Specify a unique value to distinguish one client application from another.
Note, however, that the server does not prevent identical display names across multiple
CmAuditProcessingBookmark
or AuditDefinition
objects. Therefore, the client application is responsible for enforcing uniqueness.
true
, incoming content is not added to the storage area if identical content already exists in the storage area; only unique content is added.
Consider setting this property to true
for high-volume content ingestion, such as when archiving emails to a Content Engine repository.
However, because this feature impacts server performance, you might want to keep the default setting if the frequency of duplicate content is low.
For the FixedStorageArea
interface, you cannot set the value to true
in this release.
For more information, see Content duplication suppression.
Setting this property to true
generates a new encryption key, which is used to encrypt new content.
For more information on how content encryption works, see
Content encryption.
null
.
This property is intended for external management of encryption keys by supporting IBM products. In general, a custom application should not use this property, unless there is a compelling reason to supply its own key rather than use a server-generated key.
An encryption key must be 128 bits in length. An incorrect length results in a E_BAD_VALUE
exception.
It is recommended that a Federal Information Processing Standards (FIPS) 140-compliant algorithm be used to generate an encryption key.
Note that an encryption key is used only if the EncryptionEnabled property is set to true
.
If the EncryptionEnabled property is set to false
, the value set on this property is ignored.
If the EncryptionEnabled property is set to true
but this property is not set, then
the server automatically generates the encryption key.
For more information on how content encryption works, see Content encryption.
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:
PropertyDescription.get_Id()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_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.
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).
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.
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.
ResourceStatus
constant, which indicates the availability status
of an index area, index, or storage area.
For CmTextSearchIndexArea
objects, this property specifies the availability status of an
IBM® Content Search Services index area. This property can hold one of the following values:
OPEN
: The index area is active and new indexes can be created in it. New indexes
can only be created in an index area when this property is set to OPEN
. Existing indexes can also
be updated, deleted, or queried.CLOSED
: The index area is closed to new indexes. However, existing indexes can be updated,
deleted, or queried.FULL
: The index area has reached its full capacity because the number of its indexes
is equal to the value of its MaxIndexes property and all its indexes are either full or closed. This setting
indicates that no more objects can be indexed in the index area. However, existing indexes can be deleted
or queried. Only the Content Engine server can set the ResourceStatus property to FULL
.STANDBY
: The index area is inactive. New indexes cannot be created, but existing entries can
be updated, deleted, or queried. If there are no open index areas available, the Content Engine server can
set the status of an index area that is set to STANDBY
to OPEN
.
For these CmTextSearchIndexArea
objects, the Content Engine server supports only the following
manual transitions between status values:
OPEN
to CLOSED
: This transition is always allowed.OPEN
to STANDBY
: This transition is always allowed.CLOSED
to OPEN
: This transition is only allowed if the value of the MaxIndexes property is greater
than the number of indexes in the index area or there are open indexes in the index area.CLOSED
to STANDBY
: This transition is only allowed if the value of the MaxIndex property is greater
than the number of indexes in the index area or there are open indexes in the index area.FULL
to OPEN
: This transition is only allowed if the value of the MaxIndex property is greater
than the number of indexes in the index area or there are open indexes in the index area.FULL
to CLOSED
: This transition is always allowed.FULL
to STANDBY
: This transition is only allowed if the value of the MaxIndex property is greater
than the number of indexes in the index area or there are open indexes in the index area.STANDBY
to OPEN
: This transition is always allowed, but it should occur
automatically when one index becomes full and a standby index is opened.STANDBY
to CLOSED
: This transition is always allowed.
For CmTextSearchIndex
objects, this property specifies the availability status of an
IBM® Content Search Services index. This property can hold one of the following values:
OPEN
: The index is open for create index requests. New index entries
can only be created in an index when this property is set to OPEN
. Existing index entries can also be updated,
deleted, or queried.CLOSED
: The index is closed for create index requests. However, existing index entries can be updated,
deleted, or queried. If an index job closes an index for deletion, the server sets the ResourceStatus property to CLOSED
and sets the IndexingStatus property to REPLACING
. As long as the IndexingStatus property is set to
REPLACING
, you cannot change the ResourceStatus property from CLOSED
to
OPEN
by using the API. If the index job is canceled, the server sets the IndexingStatus property to
NORMAL
; the ResourceStatus property remains set to CLOSED
unless it is changed by the API.FULL
: The index has reached its full capacity, as defined by the index area
to which it belongs (MaxObjectsPerIndex and MaxSizePerIndexKbytes properties of a CmTextSearchIndexArea
object).
This setting indicates that no more index entries can be created. However, existing index entries can be deleted or queried.
Only the Content Engine server can set the ResourceStatus property to FULL
.UNAVAILABLE
: The index is unavailable for indexing. New indexes cannot be created and existing index
entries cannot be updated, deleted or queried. A query that includes an unavailable index will not fail, but it will not
produce any results. An administrator should inform users when an index has been set to UNAVAILABLE
.
An administrator typically sets an index to the UNAVAILABLE
status to prevent reindexing failures because of a corrupted index.
A corrupted index that has been set to UNAVAILABLE
allows reindexing to complete without
generating an error that can cause the entire reindexing operation to fail. After an index has been set to UNAVAILABLE
,
it cannot be set to any other state; this state is a final state for the index. It is recommended that an unavailable index be reindexed
as soon as possible. The server automatically creates a new index or opens a standby index to handle any pending index requests
for the unavailable index. After an unavailable index is reindexed, the server deletes the unavailable index.
For these CmTextSearchIndex
objects, the Content Engine server supports only the following
manual transitions between status values:
OPEN
to CLOSED
: This transition is always allowed.OPEN
to UNAVAILABLE
: This transition is always allowed.CLOSED
to OPEN
: This transition is only allowed if the index is not scheduled to be deleted
by an index job (that is, the IndexingStatus property is not set to REPLACING
).CLOSED
to UNAVAILABLE
: This transition is always allowed.FULL
to OPEN
: This transition is only allowed if the index is not at full capacity,
as defined by the index area to which it belongs (MaxObjectsPerIndex and MaxSizePerIndexKbytes
properties of a CmTextSearchIndexArea
object).FULL
to CLOSED
: This transition is always allowed.FULL
to UNAVAILABLE
: This transition is always allowed.
For StorageArea
objects, this property specifies the availability status of a storage area.
This property can hold one of the following values:
OPEN
: The storage area is open for new content. Existing content can be updated, deleted,
or retrieved.CLOSED
: The storage area has been disabled or its closure date is set and occurs in the past.
In a closed storage area, new content cannot be created and existing content cannot be updated. However, existing content
can be deleted or retrieved.FULL
: The maximum size or maximum number of content elements in the storage area has been exceeded.
In a full storage area, new content cannot be created and existing content cannot be updated. However, existing content
can be deleted or retrieved.STANDBY
: The storage area is in standby mode. In a standby storage area, new content cannot be
created. However, existing content can be updated, deleted, or retrieved.
For these StorageArea
objects, the Content Engine server supports the following automatic transitions between status values:
OPEN
to FULL
: Applied when adding a content element to a storage area exceeds the maximum size or
maximum number of content elements allowed in the storage area.OPEN
to CLOSED
: Applied when adding a content element to a storage area whose closure date is in the past.STANDBY
to OPEN
: Applied when adding a content element to a storage area and the storage policy contains a
standby storage area but no open storage areas.
For these StorageArea
objects, the Content Engine server supports only the following
manual transitions between status values:
CLOSED
, FULL
, or STANDBY
: These transitions are allowed at any time
(size, count, or closure date limits do not restrict the change).OPEN
: These transitions are allowed only when the size and count are below the specified limits,
and the closure date is in the future (or null
). This restriction includes changes from OPEN
to OPEN
,
which allow you to change limit values for an open area.RetentionPeriod
class, are:
FixedStorageArea
objects only.)Site
property defaults to the value of Domain.DefaultSite
.
Note that you cannot change the site directly on an ObjectStore
object.
To move an object store to a different site, you must change this property on the CmDatabaseConnection
object
that is referenced by the ObjectStore
object.
For IsolatedRegion
, this property is deprecated.