The ICenteraFixedContentDevice type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | AuditedDeletePrefix |
Specifies a prefix string to use when deleting a C-Clip using the audited delete function for an
ICenteraFixedContentDevice object. If the string is blank, audited delete will not be
invoked (FPClip_Delete will be used). Otherwise, the string will be used as the prefix
of the delete reason passed to FPClip.AuditedDelete (the document ID GUID is appended
to the prefix string to form the complete delete reason text).
|
![]() | BlobReadAheadSize |
Specifies the maximum buffer size used to determine if the entire content blob should be read with a
single call to FPTag_BlobRead. If the content size is less than or equal to the parameter value,
the entire blob is read using a single call (a buffer of content size must be allocated), and the data
is passed back via the callers data stream as requested. If the content size is greater than the
parameter value, FPTag_BlobReadPartial is used to read only the data of the size requested by
the caller (no buffer is created).
|
![]() | BlobWriteCollisionsAvoidanceFlag |
Specifies the collision avoidance option for an ICenteraFixedContentDevice object. When
creating Centera content, the provider combines this value with FP_OPTION_CLIENT_CALCID_STREAMING
to form the options parameter of FPTag_BlobWrite. There are three possible values:
|
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | ConcurrentReaders |
Specifies the maximum number of concurrent Centera reader threads allowed in the object store service process.
|
![]() | 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. |
![]() | 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). |
![]() | DefaultRetentionPassThrough |
Specifies whether the retention period is set to the current Centera system setting (true) or not (false).
This flag only applies when a fixed storage area's retention period is configured to use the retention period
of the fixed content device (that is, when the fixed storage area's RetentionPeriod property is set to -2).
Normally the provider will examine the value of the FP_RETENTION pool capability and explicitly set the retention
period to either zero or infinite, depending on the capability setting. When DefaultRetentionPassThrough is set
to 1, the retention period is set to RETENTION_PERIOD_DEFAULT (meaning that the Clips use the current Centera
system setting, which can be altered by changing the compliance mode of the system).
|
![]() | 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. |
![]() | EmbeddedDataThreshold |
Specifies the maximum size threshold in bytes for embedding content in the C-Clip. By default this
value is zero (content is never embedded). The maximum value for this parameter is 102400 (bytes).
If a greater value is supplied, it will be reduced to 102400 internally by the Centera provider.
Note that this limit is per content element. The overall size of embedded data can exceed this limit
if multiple content elements are embedded in a single Clip (up to the maximum size of the C-Clip).
|
![]() | 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.) |
![]() | FPLogConfigFile |
The fully qualified name of a configuration file used to configure the native
logging performed by the Centera fixed content device. If native logging is
not enabled, Content Engine ignores this property. If native logging is
enabled, Content Engine passes the configuration file name specified by
this property to the Centera fixed content device. The specified file must
exist and have valid configuration parameters. To enable native logging,
set the FPLogEnabled property to true.
For example, if you define the Centera log file name and other logging parameters in a file named CenteraLogging.cfg, you would set the value of this property to be the fully qualified name for that file, such as C:\config\CenteraLogging.cfg, and Content Engine would then pass that file name to Centera. The information logged by Centera to your specified log file can be useful for diagnosing connectivity and performance issues between Content Engine and the Centera fixed content device. For information on the configuration parameters, see the Centera documentation. The following are some of the parameters currently available:
For example, a configuration file might specify these parameters and
values:
|
![]() | FPLogEnabled |
A boolean that enables or disables the native logging performed by the Centera
fixed content device. Set the value of this property to true to
enable logging and false to disable logging.
When you enable Centera native logging, you must set the value of the FPLogConfigFile property appropriately. |
![]() | FPOpenStrategy |
Specifies the approach used by FPPool_Open to open connections. Possible values are:
|
![]() | FPPoolBufferSize |
Specifies the size in bytes of the internal C-Clip buffer. The default value is 16*1024.
|
![]() | FPPoolClusterNonAvailTime |
Specifies the time in seconds that a cluster is marked as not available before retrying with a
probe. Other clusters in the pool will be used while the cluster is unavailable. The default
value is 600 (10 minutes).
|
![]() | FPPoolDefaultCollisionAvoidance |
Indicates whether collision avoidance is enabled at the pool level (true) or not (false). By default,
collision avoidance is not enabled. If enabled, an additional blob discriminator for read and write
operations of C-Clips and blobs will be used. (BlobWriteCollisionAvoidanceFlag is used in tag
write and only applies to blobs.)
|
![]() | FPPoolEnableMulticlusterFailover |
Specifies whether multi-cluster failover is enabled (true) or not (false).
By default, multi-cluster failover is enabled.
|
![]() | FPPoolMaxConnections |
Specifies the maximum number of sockets that will be allocated. (Sockets are used to communicate with the
Centera clusters managed in each pool object.) The default value is 100.
|
![]() | FPPoolMulticlusterDeleteStrategy |
Specifies the failover strategy for delete operations (FPClip_Delete and FPClip_AuditedDelete) and
the deprecated purge operations (FPClip_Purge and FPTag_BlobPurge). Possible values are:
|
![]() | FPPoolMulticlusterExistsStrategy |
Specifies the failover strategy for exists operations (FPClip_Exists and FPTag_BlobExists).
Possible values are:
|
![]() | FPPoolMulticlusterQueryStrategy |
Specifies the failover strategy for query operations (FPPoolQuery_Open).
Possible values are:
|
![]() | FPPoolMulticlusterReadStrategy |
Specifies the failover strategy for read operations (FPClip_Open, FPTag_BlobRead,
and FPTag_BlobReadPartial). Possible values are:
|
![]() | FPPoolMulticlusterWriteStrategy |
Specifies the failover strategy for write operations (FPClip_Write and FPTag_BlobWrite).
Possible values are:
|
![]() | FPPoolPrefetchSize |
Specifies the size of the prefetch buffer. (The buffer is used to assist in determining the size
of the blob.) The default size is 32 KB.
|
![]() | FPPoolRetryCount |
Specifies the number of times an operation will be retried before failure is reported. The default
value is 6. If the first execution of the function fails, the system will retry the function 6 more
times (for a total of 7 tries).
|
![]() | FPPoolRetrySleep |
Specifies the time to wait in milliseconds before a failed API function should be retried. If not
specified, an exponential back-off scheme is used where the sleep time increases after each retry,
starting at 1 second and then doubling after each subsequent try.
|
![]() | FPPoolTimeout |
Specifies the TCP/IP Connection timeout in milliseconds. The default value is 120000 (2 minutes).
|
![]() | 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. |
![]() | 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.)
|
![]() | 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). |
![]() | MaxReaderSemaphoreWaitTime |
Specifies the maximum waiting time in milliseconds to get a read semaphore for a read
operation before the system fails the operation.
|
![]() | NeverDeleteClipsOrContent |
Indicates whether an ICenteraFixedContentDevice object prevents the deletion of Clips
or Blobs on the Centera device (true) or not (false). If true, the provider never attempts to delete
Clips or Blobs and all content is left completely intact on the Centera device. Note that normally this
setting has no impact on enforcement of the retention period (the storage area honors the retention
period and prevents deletion when appropriate).
|
![]() | PoolAddress |
Specifies the Centera pool address that is passed to the FPPool class constructor as the
PoolAddress parameter (which identifies the location of the Centera fixed content device). This pool
address will be used when the Content Engine server is running within the site identified by the Site
property of this object.
|
![]() | 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. |
![]() | VendorName |
Specifies a vendor name.
(Inherited from IFixedContentDevice.) |