The IIMFixedContentDevice type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
(Inherited from IFixedContentDevice.)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. |
![]() | CSMCache |
Specifies the NCH 3-part name of the CSM cache that is nearer to the site than the default cache. Each part of
the name is separated by a colon and takes the form page_cache<n>:<domain>:<organization>.
There must be no more than one local CSM cache name for a given value of <domain>:<organization>.
For example, for domain ntvaga and organization FileNet, the names are of the form page_cache<n>:ntvaga:FileNet, where <n> is an unsigned decimal integer greater than or equal to 2. The default CSM cache on the document server is page cache number 1 (for example, page_cache1:ntvaga:FileNet). This property will be used when the Content Engine server is running within the site identified by this object's Site property. If a FileNet Image Services fixed content device is made available across multiple sites in a FileNet P8 domain, you should create an ImageServicesSiteSettings object for each site that has a local CSM cache. This SiteSettings object will override the value of the CSMCache property for the site to enable a local CSM cache to be utilized. |
![]() | 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 IFixedContentDevice.)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 IFixedContentDevice.)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). |
![]() | DefaultISDocumentClass |
Specifies the name of the Image Services (IS) document class that controls native content. The IS document
class definition has default values that control the IS document content security and media family where
the content will be stored.
The default document class is used for documents that are created in Content Platform Engine and are stored
in FileNet® Image Services.
|
![]() | DescriptiveText |
User-readable text that describes an object.
(Inherited from IFixedContentDevice.)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 IFixedContentDevice.)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. |
![]() | FcpPoolIdleTimeoutSeconds |
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.
(Inherited from IFixedContentDevice.) |
![]() | FcpPoolMaxInUse |
The maximum number of concurrent connections allowed for the fixed content device.
A value of -1 indicates that there is no limit.
(Inherited from IFixedContentDevice.) |
![]() | FcpPoolMaxWaitSeconds |
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.
(Inherited from IFixedContentDevice.) |
![]() | FcpPoolPreferredSize |
The minimum size to which the fixed content device provider pool will be
allowed to shrink after the idle timeout has expired.
(Inherited from IFixedContentDevice.) |
![]() | 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 IFixedContentDevice.)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. |
![]() | ImageServicesClassDescriptions |
Specifies an ImageServicesClassDescriptionList object, which contains a collection of the Image Services document class descriptions associated
with this FileNet Image Services fixed content device.
|
![]() | ImplementationClass |
Specifies the name of the fixed content provider class that implements the behavior for a
fixed content device. The classes include:
(Inherited from IFixedContentDevice.)
|
![]() | ISDomainName |
Specifies the domain name component of the NCH name. The NCH name specifies the address of the target
Image Services server. It's derived from the ISDomainName and ISOrganization properties.
|
![]() | ISOrganization |
Specifies the organization component of the NCH name. The NCH name specifies the address of the target
Image Services server. It's derived from the ISDomainName and ISOrganization properties.
In most cases, this value will be "FileNet".
|
![]() | ISPassword |
The UTF-8 encoded, non-encrypted password for the security principal identified by the ISUserName 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.
|
![]() | ISUserName |
Specifies the name of the security principal that will be used to access the Image Services server.
The name must already exist as an "integration user" in the IS security database used by CFS-IS.
|
![]() | LastModifier |
Indicates the name of the user who last modified the object.
(Inherited from IFixedContentDevice.)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). |
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | SiteSettings |
Specifies the SiteSettings objects associated with a fixed content device or with an advanced storage 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.
(Inherited from IFixedContentDevice.)For an EMC Centera fixed content device, this property allows the PoolAddress property to be different, depending on the site in which the Content Platform Engine server is running. If the 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 Platform Engine server is running. If the 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. For an advanced storage device, this property allows the ReplicaSynchronizationType property to be different, depending on the site in which the Content Platform Engine server is running. If the server is running in a site that does not correspond to one of the SiteSetting objects, then the ReplicaSynchronizationType property on the CmStorageDeviceConnection object is used as the default. |
![]() | TimeOutSeconds |
Specifies the maximum time in seconds that the Content Engine will wait when retrieving content from
an Image Services server.
|
![]() | VendorName |
Specifies a vendor name.
(Inherited from IFixedContentDevice.) |