This topic alphabetically lists the properties that apply to the ContentCacheArea class.
Valid settings are:
OPEN (default setting): Enables the cache area for active use.CLOSED: Disables the cache area for active use.CLEARING: Disables the cache area for active use, deletes all content
from the cache, initializes the values for all cache statistical properties, and
automatically resets the cache status to the previous setting (OPEN or CLOSED). Once
started, this cache clearing operation always completes; you cannot stop the operation
or manually change the cache status from CLEARING to any other setting. In order for
the clearing operation to be performed and for the cache status not to remain set to
CLEARING indefinitely, at least one server must be associated with the same site as
that of the content cache. For information on associating a content cache with a site,
see the ContentCacheConfiguration interface.ClassDescription object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
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).
AreaDeleteMethod class has constants defined for the deletion method settings.
Valid settings are:
DESTRUCTIVE: Specifies that content be overwritten once with zeros before it is deleted.PURGE: Specifies that content be overwritten three times before it is deleted.
This is the most secure form of delete.STANDARD (default setting): Specifies that content be deleted using the normal
delete operation for the given device or file system. The text is not locale-specific to the retrieving user except for the following classes:
DirectoryStructure class has constants defined for the directory
structure type settings.
Valid settings are:
DIRECTORY_STRUCTURE_SMALL (default setting): Specifies a small
directory structure. Small structures consist of two levels of directories
with 23 nodes at each level (total of 529 directories at the 2nd level).
Content is stored only at the 2nd level. DIRECTORY_STRUCTURE_LARGE: Specifies a large directory structure.
Large structures extend the small structure with a third level of 23 nodes,
for a total of 12,167 directories at the 3rd level. Content is stored only at the 3rd level. null (non-accessible content cache): For the ContentCacheArea
object, this property returns null when the server cannot physically access the
content cache area and has not previously done so, and the CacheStatus property
setting is Closed. Note that, although a null value can be returned,
you cannot set this property to null. For the ContentCacheArea object, the directory organization of the
cache permits different servers to work on different directories, and thus allows
cache pruning to be scalable across multiple servers. All of the directories in the
cache contain roughly the same amount of recently added content (as a result of the
cache randomly selecting a directory for new content, and of pruning roughly
the same amount of content from each directory). Pruning, consequently, can occur
independently for each directory and yet still achieve the cache-wide result of
deleting the least frequently requested content.
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.
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.
A periodic prune occurs at maximum-time-to-live half-intervals. For example, if the specified maximum-time-to-live is two weeks, a periodic prune occurs once a week. The purpose of this prune is to ensure that expired files get deleted on a timely basis. A periodic prune is always a full prune. For a definition of full prune and a detailed discussion of pruning, see the PruneAmount property.
OPEN, cache capacity has not been exceeded, etc.), content
newly added to the main storage area also gets added to the cache area.
Specifically, a prune action begins by calculating two prune quotas: a number quota and a size quota. These quotas apply to each directory. The quota calculation takes into account the prune amount percentage (as specified by the PruneAmount property), the prune thresholds (as specified by the PruneThresholdContentElements and PruneThresholdSizeKBytes properties), the current amount of content in the cache (as indicated by the ContentElementCount and ContentElementKBytes properties), and the number of cache directories. Specifically:
For example, for the number quota, suppose when the prune action begins the cache contains 100,100 files, the prune threshold is 100,000 files, the prune percentage is 5%, and the cache has 529 directories. The prune target, in this case, is 95,000: 100,000 minus 5,000 (5% of 100,000). The quota for each directory equals 10: 100,100 minus 95,000, divided by 529 (rounded up). The size quota gets calculated in a similar manner.
A full prune action consists of two phases: an initial prune and a partial prune. An initial prune deletes all abandoned and expired files and also generates an LRU (least-recent-use) list for each directory. All files in the directory are put in ascending time-of-last-use order on this list; the first file listed has been accessed less recently than any other file (in other words, it is the oldest). A partial prune processes old files in LRU list order. As a file can be retrieved from the cache at any time--and thus might be younger than it was at LRU list generation time--a partial prune always checks the time-of-last-use for a file before deleting it. It skips any file with a time-of-last-use more recent than the LRU list creation time. The partial prune continues down the LRU list in this manner, taking files off the list as they are either deleted or skipped.
All old and expired files deleted in a directory count towards the quotas for that directory, although the quotas only control the number of old files deleted during the partial prune (as all expired files get deleted during the initial prune). Note that in a full prune the prune quotas might be satisfied during the initial prune phase. In this case, the second phase of the full prune--the partial prune--does not occur. Also, regardless of when the prune quotas might be satisfied during the course of the prune, an initial prune always generates a new LRU list.
For an overview of pruning and a discussion of the categories of files deleted during a prune, see the ContentCacheArea interface.
With respect to any given directory, a mandatory prune can be either a full or partial prune (and so, with respect to the cache as a whole, a mandatory prune can be a mixture of full and partial prunes). It is a full prune only when the LRU list needs to be generated. Specifically, it is a full prune in these circumstances: this is the first pruning action for a new cache, and consequently no LRU list yet exists; the LRU list has expired (it is older than 1 day); or a previous prune action exhausted the LRU list. (Note that a partial prune can exhaust the LRU list without satisfying the prune quotas.)
For an overview of cache pruning, see the ContentCacheArea interface. For definitions of pruning terms (full prune, partial prune, LRU list, etc.) and a detailed discussion of pruning, see the PruneAmount property.
Note that, as indicated above, the PruneThresholdSizeKBytes property defines another pruning threshold.
For CmTextSearchIndexArea objects, the root directory is used by IBM® Content Search Services servers
to store IBM Content Search Services indexes within a given index area. All the IBM Content Search Services
servers that belong to the same object store site that contains the index area must be given read and write
permissions to this directory. If the root directory that you specify does not exist on your machine, the server will create one.
If you assign an affinity group to an index area, only the IBM Content Search Services servers assigned to that affinity group need to have read and write permissions to the root directory of the index area; it is not necessary to assign permissions to the other servers in the site. When an index area is assigned to an affinity group, it is recommended that you use a root directory that is local for all the IBM Content Search Services servers in the affinity group. Doing so can improve performance because input/output operations are faster for local disks.
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.