The IFileStorageArea type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyAllowsContentToBeCached
Specifies if and and under what condition the content data in this storage area can be cached. The property takes a CachedContentOption constant value.
(Inherited from IStorageArea.)
Public propertyAllowsDelete
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.
(Inherited from IStorageArea.)
Public propertyAuditedEvents
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from IStorageArea.)
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyClosureDate
Specifies the date and time when the storage area will close and no longer accept new content.
(Inherited from IStorageArea.)
Public propertyCmCompressionEnabled
Specifies whether content in this storage area should be compressed. Content compression reduces the space consumed in a storage area of any type, but there are performance tradeoffs in using it. For more information, see Content compression.

If you enable content compression, you can modify default operation settings with the CmCompressionThresholdPercent and CompressionBlockSize properties.

(Inherited from IStorageArea.)
Public propertyCmCompressionThresholdPercent
Specifies as a percentage of the original size, the minimum to which the initial portion of a content stream must be compressed in order for the entire stream to be compressed. For example, for a compression ratio of 80%, the entire data stream will be compressed if the first block of uploaded data, when compressed, is 80% or less of the original uncompressed size.

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 of the IContentConfiguration interface.

This property requires that content compression be turned on, as set in the CmCompressionEnabled property. For administrator-related information, see Content compression.

(Inherited from IStorageArea.)
Public propertyCmContentIntegrityOptions
Content integrity options are supported only on advanced storage areas. The options cannot be set on file, fixed, and database storage areas.

Specifies content validation on a storage area with a bitmask of [!:FileNet.Api.Constants.CmContentIntegrityOptions] values. Depending on the options specified, the server validates on content creation, content retrieval, and when the validateContent method is invoked on IStorageArea.

For advanced storage areas, options are provided for auto-repair of invalid content.

(Inherited from IStorageArea.)
Public propertyCmStandbyActivationPriority
The priority for changing this index area from a standby index area to an open index area. The higher the value of this property, the lower the priority. The highest priority is 0, which is the default value.

When an open index area 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 false, which instructs the Content Engine server to open a standby index area when an index area becomes full. Set this JVM parameter to true to instruct the Content Engine server to open a standby index area only when all the index areas are either full or closed. For information about how to assign JVM parameter values for your application server, see Setting JVM parameters.

(Inherited from IStorageArea.)
Public propertyContentElementCount
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.

(Inherited from IStorageArea.)
Public propertyContentElementKBytes
The size of all content elements stored in this storage area (in kilobytes). If content compression is turned on for a IStorageArea 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.

(Inherited from IStorageArea.)
Public propertyContentElementsCreated
Total content elements created in a Storage Area.
(Inherited from IStorageArea.)
Public propertyContentElementsDeleted
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.

(Inherited from IStorageArea.)
Public propertyCreator
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.

(Inherited from IStorageArea.)
Public propertyDateCreated
Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

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.

(Inherited from IStorageArea.)
Public propertyDateLastModified
Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

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

(Inherited from IStorageArea.)
Public propertyDeleteMethod
Indicates the deletion method for content in this storage area, as specified by a AreaDeleteMethod constant.
Public propertyDescriptiveText
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
(Inherited from IStorageArea.)
Public propertyDirectoryStructure
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.
Public propertyDisplayName
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

For ICmAuditProcessingBookmark and IAuditDefinition objects, this property is intended to identify client applications that process the audit log. For ICmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For IAuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality.

For ICmAuditProcessingBookmark and IAuditDefinition 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 ICmAuditProcessingBookmark or IAuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness.

(Inherited from IStorageArea.)
Public propertyDuplicateSuppressionEnabled (Inherited from IStorageArea.)
Public propertyEncryptionEnabled
Specifies whether content in this storage area should be encrypted.

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.

(Inherited from IStorageArea.)
Public propertyEncryptionKey
Sets the key used for encrypting content in the storage area. Setting this property overrides the existing encryption key. The value of this property is not persisted, and a call to retrieve its value returns 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.

(Inherited from IStorageArea.)
Public propertyId
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.

(Inherited from IStorageArea.)
Public propertyLastModifier
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).

(Inherited from IStorageArea.)
Public propertyMaximumContentElements
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.

(Inherited from IStorageArea.)
Public propertyMaximumSizeKBytes
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.

(Inherited from IStorageArea.)
Public propertyOwner
Manages the security owner assigned to the object.
(Inherited from IStorageArea.)
Public propertyPermissions
Manages the discretionary permissions assigned to the object.
(Inherited from IStorageArea.)
Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyResourceStatus
Specifies a 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 changess between status values:

  • OPEN to CLOSED: This change is always allowed.
  • OPEN to STANDBY: This change is always allowed.
  • CLOSED to OPEN: This change 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 change 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.
  • FULL to OPEN: This change 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.
  • FULL to CLOSED: This change is always allowed.
  • FULL to STANDBY: This change 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.
  • STANDBY to OPEN: This change is always allowed, but it should occur automatically when one index becomes full and a standby index is opened.
  • STANDBY to CLOSED: This change 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 marks an index to be deleted, 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 changes between status values:

  • OPEN to CLOSED: This change is always allowed.
  • OPEN to UNAVAILABLE: This change is always allowed.
  • CLOSED to OPEN: This change 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 change is always allowed.
  • FULL to OPEN: This change 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 change is always allowed.
  • FULL to UNAVAILABLE: This change 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 changes 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 changes between status values:

  • Changes to CLOSED, FULL, or STANDBY: These changes are allowed at any time (size, count, or closure date limits do not restrict the change).
  • Changes to OPEN: These changes 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.
(Inherited from IStorageArea.)
Public propertyRetentionPeriod Obsolete.
Deprecated.
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:
  • 0: No minimum retention period (content may be deleted at any time).
  • -1: Infinite retention period (content can never be deleted).
  • -2: Same retention period as the associated fixed content device. (For FixedStorageArea objects only.)
  • -101: Reserved for internal use only.
  • -102: Retention period is not supported. This is the default if no RetentionPeriod value has been defined for the storage area.
(Inherited from IStorageArea.)
Public propertyRootDirectoryPath
The fully qualified path to the root directory for this index area, file storage area, or advanced storage file system device. The path can be a local mount point, a local path, or a UNC path.

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.

Public propertySite
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 IDomain.DefaultSite.

Note that you cannot change the site directly on an IObjectStore object. To move an object store to a different site, you must change this property on the ICmDatabaseConnection object that is referenced by the IObjectStore object.

For IIsolatedRegion, this property is deprecated.

(Inherited from IStorageArea.)

ToggleSee Also