CenteraFixedContentDevice Properties

Specifies a prefix string to use when deleting a C-Clip using the audited delete function for a CenteraFixedContentDevice 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).

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

Specifies the collision avoidance option for a CenteraFixedContentDevice 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:

• 0: Use the collision avoidance scheme of the Centera system.
• 64: Override system setting, enable collision avoidance (FP_OPTION_ENABLE_COLLISION_AVOIDANCE).
• 128: Override system setting, disable collision avoidance (FP_OPTION_DISABLE_COLLISION_AVOIDANCE).

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

Specifies the maximum number of concurrent Centera reader threads allowed in the object store service process.

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

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

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.

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

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:

• FP_LOGPATH=fully qualified log file name
• FP_LOG_STATE_POLL_INTERVAL=configuration file poll interval in minutes
• FP_LOGKEEP=[OVERWRITE|APPEND|CREATE]
• FP_LOGLEVEL=[1|2|3|4]
• FP_LOGFORMAT=[XML|TAB]

For example, a configuration file might specify these parameters and values:
FP_LOGPATH=C:\logs\Centera.log
FP_LOG_STATE_POLL_INTERVAL=10
FP_LOGKEEP=APPEND
FP_LOGLEVEL=1
FP_LOGFORMAT=TAB

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.

Specifies the approach used by FPPool.Open to open connections. Possible values are:

• 0: Specifies FP_NORMAL_OPEN where FPPool.Open attempts to open connections to all addresses in the connection string and all associated replication addresses. Consider using this strategy if your application performs numerous operations while the pool is open. This option is the default strategy and is equivalent to FP_OPTION_DEFAULT_OPTIONS.
• 1: Specifies FP_LAZY_OPEN where FPPool.Open opens connections to addresses only as needed. Consider using this strategy if your application frequently opens and closes the pool.

Specifies the size in bytes of the internal C-Clip buffer. The default value is 16*1024.

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

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

Specifies whether multi-cluster failover is enabled (true) or not (false). By default, multi-cluster failover is enabled.

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.

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:

• 0: FP_NO_STRATEGY (default)
• 1: FP_FAILOVER_STRATEGY (not supported)
• 2: FP_REPLICATION_STRATEGY

Specifies the failover strategy for exists operations (FPClip.Exists and FPTag.BlobExists). Possible values are:

• 0: FP_NO_STRATEGY
• 1: FP_FAILOVER_STRATEGY (default)
• 2: FP_REPLICATION_STRATEGY

Specifies the failover strategy for query operations (FPPoolQuery.Open). Possible values are:

• 0: FP_NO_STRATEGY
• 1: FP_FAILOVER_STRATEGY (default)
• 2: FP_REPLICATION_STRATEGY

Specifies the failover strategy for read operations (FPClip.Open, FPTag.BlobRead, and FPTag.BlobReadPartial). Possible values are:

• 0: FP_NO_STRATEGY
• 1: FP_FAILOVER_STRATEGY
• 2: FP_REPLICATION_STRATEGY (default)

Specifies the failover strategy for write operations (FPClip.Write and FPTag.BlobWrite). Possible values are:

• 0: FP_NO_STRATEGY (default)
• 1: FP_FAILOVER_STRATEGY (not supported)
• 2: FP_REPLICATION_STRATEGY

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.

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

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.

Specifies the TCP/IP Connection timeout in milliseconds. The default value is 120000 (2 minutes).

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 waiting time in milliseconds to get a read semaphore for a read operation before the system fails the operation.

Indicates whether a CenteraFixedContentDevice 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).

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.

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.

Specifies a vendor name.