SnapLockFixedContentDevice Properties

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

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.

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.

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

Specifies the default retention period. A positive value represents the number of days the content element must be retained. Other possible values 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.

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

Specifies an IP address or fully qualified domain name.

Specifies the absolute path to the SnapLock volume used to store content (from the perspective of the SnapLock device). The path starts from the volume name (for example, /snap_volume/v16) and corresponds to the same physical location that is referenced by the RootDirectoryPath property, which is the path as viewed from the Content Engine server.

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.

The user-readable, provider-specific name of an object. This property is usually the designated 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.

The number of seconds an idle connection can remain in the fixed content device provider pool before being eligible to be closed and removed from the pool. An idle connection will be closed when the next operation to the same fixed content device is performed after this idle period.

The maximum number of concurrent connections allowed for the fixed content device. A value of -1 indicates that there is no limit.

The maximum number of seconds to wait for a connection once the limit specified by the FcpPoolMaxInUse property has been reached. If a connection from the fixed content device provider pool does become available before this wait time expires, the request is allowed to proceed.

The minimum size to which the fixed content device provider pool will be allowed to shrink after the idle timeout has expired.

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

Specifies the name of the fixed content provider class that implements the behavior for a fixed content device. The classes include:

• CenteraFixedContentDevice: com.filenet.engine.content.fcprovider.centera.CenteraFCP
• IMFixedContentDevice: com.filenet.engine.content.fcprovider.is.ImageServicesFCP
• SnapLockFixedContentDevice: com.filenet.engine.content.fcprovider.fsb.SnaplockFCP

Indicates the name of the user who last modified this 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).

Specifies the maximum retention period in days.

Specifies the minimum retention period in days.

The fully qualified path to the root directory for this index area or file storage area. 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.

Specifies the SiteSettings objects associated with a fixed content device. Site settings provide site-specific, configuration value overrides. For each fixed content device type with settings that can be overridden, a corresponding subclass of SiteSettings is defined with properties that, if populated, will override the corresponding properties of the same name on the fixed content device object.

For an EMC Centera fixed content device, this property allows the PoolAddress property to be different, depending on the site in which the Content Engine server is running. If the Content Engine server is running in a site that does not correspond to one of the SiteSetting objects, then the PoolAddress property on the CenteraFixedContentDevice object is used as the default.

For a FileNet Image Services fixed content device, this property allows the CSMCache property to be different depending on the site in which the Content Engine server is running. If the Content Engine server is running in a site that does not correspond to one of the SiteSetting objects, then the CSMCache property on the IMFixedContentDevice object is used as the default.

For a NetApp SnapLock fixed content device, there are currently no properties that may be customized for a site.

The UTF-8 encoded, non-encrypted password for the security principal identified by the SnapLockUserName property. To maintain password security, you can use this property only to set a password, not to read its value. Instead of returning a password value, this property returns a zero-length byte array if it has been set with a password and returns a null value if it has never been set.

Specifies the security principal used to connect to a remote SnapLock device.

Specifies a vendor name.