The IDatabaseStorageArea type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | AllowsContentToBeCached |
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.) |
![]() | AllowsDelete |
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.) |
![]() | AuditedEvents |
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from IStorageArea.) |
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | ClosureDate |
Specifies the date and time when the storage area will close and no longer accept new content.
(Inherited from IStorageArea.) |
![]() | CmCompressionEnabled |
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.
(Inherited from IStorageArea.)If you enable content compression, you can modify default operation settings with the CmCompressionThresholdPercent and CompressionBlockSize properties. |
![]() | CmCompressionThresholdPercent |
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.
(Inherited from IStorageArea.)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. |
![]() | CmContentIntegrityOptions |
Content integrity options are supported only on advanced storage areas.
The options cannot be set on file, fixed, and database storage areas.
(Inherited from IStorageArea.)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. |
![]() | CmStandbyActivationPriority |
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.
(Inherited from IStorageArea.)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. |
![]() | ContentElementCount |
The number of content elements stored in this storage area.
(Inherited from IStorageArea.)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. |
![]() | ContentElementKBytes |
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.
(Inherited from IStorageArea.)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. |
![]() | ContentElementsCreated |
Total content elements created in a Storage Area.
(Inherited from IStorageArea.) |
![]() | ContentElementsDeleted |
The number of content elements deleted from this storage area.
(Inherited from IStorageArea.)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. |
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
(Inherited from IStorageArea.)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. |
![]() | DatabaseType |
Specifies the database type (DB2, MSSQL, or ORACLE).
For IObjectStore, this property is deprecated. Use ICmDatabaseConnection.DatabaseType. |
![]() | DateCreated |
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.
(Inherited from IStorageArea.)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. |
![]() | DateLastModified |
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.
(Inherited from IStorageArea.)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). |
![]() | DescriptiveText |
User-readable text that describes an object.
(Inherited from IStorageArea.)The text is not locale-specific to the retrieving user except for the following classes:
|
![]() | DisplayName |
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
(Inherited from IStorageArea.)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. |
![]() | DuplicateSuppressionEnabled | (Inherited from IStorageArea.) |
![]() | EncryptionEnabled |
Specifies whether content in this storage area should be encrypted.
(Inherited from IStorageArea.)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. |
![]() | EncryptionKey |
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.
(Inherited from IStorageArea.)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. |
![]() | 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}.
(Inherited from IStorageArea.)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:
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. |
![]() | JNDIDataSource |
Specifies the Java™ Naming and Directory Interface (JNDI) name of the non-XA data source
defined in the Java™ Platform Enterprise Edition (Java EE) application server.
For IObjectStore, this property is deprecated. |
![]() | JNDIXADataSource |
Specifies the Java™ Naming and Directory Interface (JNDI) name of the XA data source
defined in the Java™ Platform Enterprise Edition (Java EE) application server.
For IObjectStore, this property is deprecated. |
![]() | LastModifier |
Indicates the name of the user who last modified the object.
(Inherited from IStorageArea.)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). |
![]() | MaximumContentElements |
The maximum number of content elements designated for this storage area.
(Inherited from IStorageArea.)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. |
![]() | MaximumSizeKBytes |
The maximum size of all content elements designated for this storage area (in kilobytes).
(Inherited from IStorageArea.)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. |
![]() | Owner |
Manages the security owner assigned to the object.
(Inherited from IStorageArea.) |
![]() | Permissions |
Manages the discretionary permissions assigned to the object.
(Inherited from IStorageArea.) |
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | ResourceStatus |
Specifies a ResourceStatus constant, which indicates the availability status
of an index area, index, or storage area.
(Inherited from IStorageArea.)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:
For these CmTextSearchIndexArea objects, the Content Engine server supports only the following manual changess between status values:
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:
For these CmTextSearchIndex objects, the Content Engine server supports only the following manual changes between status values:
For StorageArea objects, this property specifies the availability status of a storage area. This property can hold one of the following values:
For these StorageArea objects, the Content Engine server supports the following automatic changes between status values:
For these StorageArea objects, the Content Engine server supports only the following manual changes between status values:
|
![]() | RetentionPeriod | Obsolete.
Deprecated. (Inherited from IStorageArea.)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:
|
![]() | 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 IDomain.DefaultSite.
(Inherited from IStorageArea.)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. |