Public Properties

  Name Description
Public property CacheStatus The setting that enables or disables a cache area for active use. The CacheStatus enumeration has constants defined for the cache status settings.

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 IContentCacheConfiguration interface.
Public property ContentElementCount 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.

Public property ContentElementKBytes 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.

Public property ContentElementsCreated Total content elements created in a Storage Area.
Public property ContentElementsDeleted 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 IContentCacheArea interface.

Public property Creator 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 property DateCreated 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.

Public property DateLastModified 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).

Public property DeleteMethod The setting that specifies the deletion method for content in this storage area. The 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.
Public property DescriptiveText 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 property DirectoryStructure The setting that determines the directory structure type for this storage area. The 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.

Public property DisplayName The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
Public property Id 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 property LastModifier 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 property MaximumContentElements 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.

Public property MaximumSizeKBytes 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.

Public property MaximumTimeToLive The maximum number of minutes a content element can remain in an unaccessed state in the cache and not be considered an expired file. An expired file is subject to deletion during a prune action. Note that prune actions delete files for other reasons besides expiration. For an overview of pruning and a discussion of the categories of files deleted during a prune action, see the IContentCacheArea interface.

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.

Public property PreloadOnCreate A value indicating whether the cache receives duplicates of any new content added to the main storage area. When true, and when content normally gets cached (because the cache status is OPEN, cache capacity has not been exceeded, etc.), content newly added to the main storage area also gets added to the cache area.
Public property PruneAmount The percentage amount of cache content to delete during a cache prune action. The calculated amount determines the number of files to delete (based on the PruneThresholdContentElements property) and also the total size of files to delete (based on the PruneThresholdSizeKBytes property).

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:

  • prune-target = prune-threshold - (prune-percentage * prune-threshold)
  • directory-quota = (current-amount - prune-target) / number-of-directories

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 IContentCacheArea interface.

Public property PruneThresholdContentElements The minimum number of content elements in the cache area sufficient to trigger a cache prune action. Specifically, a background process periodically checks whether the content element count statistic (as indicated by the ContentElementCount property) has exceeded this prune number threshold, or whether the content element size statistic (as indicated by the ContentElementKBytes property) has exceeded the prune size threshold (as specified by the PruneThresholdSizeKBytes property). If so, a mandatory prune action gets launched; its purpose is to ensure that cache content remains under the prune threshold levels.

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

Public property PruneThresholdSizeKBytes The minimum size of all content elements in the cache area sufficient to trigger a cache prune action (in kilobytes). Note that the PruneThresholdContentElements property defines another pruning threshold. For details on the prune action that occurs in response to prune threshold crossings, see that property.
Public property RootDirectoryPath The fully qualified path to the root directory for this storage area. The path can be a local mount point, a local path, or a UNC path.

The following information is specific to the use of VerityIndexArea.RootDirectoryPath:

  • If the value of VerityIndexArea.TempDirectoryPath is not null, the value for the this property can be a local directory on the Verity server.
  • If multiple Verity servers are used for the same index area, and the value of this property is local to the Verity server, each Verity server for the index area must be on the same machine.
  • When multiple Verity index areas are defined in an object store, each index area can have the same value for this property; however, the directories may be located on different machines (depending on the location of the Verity servers).
Public property Site 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.
Top

See Also