Fixed Content Devices properties (General tab)

The Fixed Content Devices General property page identifies general information about fixed content devices configured for the P8 domain, including configuration parameters.

Name
The fixed content device's name.
Description
The fixed content device's description.
Type
The fixed content device's provider. Currently supported are FileNet Image Services, EMC Centera, SnapLock, Tivoli Storage Manager (DR550).
Vendor
The fixed content device's vendor (read-only).
ID
The fixed content device's GUID (read-only).

FileNet Image Services configuration parameters

See FileNet P8 Content Federation Services for Image Services Guidelines for more information about these values.

Attribute Name Attribute Value
FCD Pool Idle Timeout Seconds Integer
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.
FCD Pool Preferred Size Integer
The minimum size to which the fixed content device provider pool will be allowed to shrink after the idle timeout has expired.
FCD Pool Max Wait Seconds Integer
The maximum number of seconds to wait for a connection after the limit specified by the FCP Pool Max In Use limit 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.
FCD Pool Max In Use Integer
The maximum number of concurrent connections allowed for the fixed content device. A value of -1 indicates that there is no limit.
IS User Name String
The CFS-IS Administrative User account that administers CFS for IS. This user name must already exist on the Image Services server. Enter up to 40 alphanumeric characters without spaces. The following characters are valid:
" ' # [ ] ! < > ? * "
IS Password/Confirm Password String
The password for the CFS-IS Administrative User, up to eight alphanumeric characters.
IS Domain Name String
The Image Services domain name as defined in the Image Services Configuration Database (CDB). This value is stored as one part of the Service name configuration parameter in the fixed content device. Enter up to 20 alphanumeric characters.

The <domain> portion of a two- or three-part NCH name of the associated Image Management System (IMS). NCH names are case-sensitive. NCH three-part names use form: <object>:<domain>:<organization>. The object name must be 1 to 40 bytes (bytes, not characters). If present, it always has the value of DefaultIMS. The domain name must be 1 to 20 bytes.
IS Organization String
In most cases, this value is "FileNet." This value is stored as another part of the Service name configuration parameter in the fixed content device. Enter up to 20 alphanumeric characters.

The <organization> portion of a two- or three-part NCH name of the associated Image Management System (IMS). NCH names are case-sensitive. NCH three-part names use the form: <object>:<domain>:<organization>. The object name must be 1 to 40 bytes (bytes, not characters). If present, it always has the value of DefaultIMS. The organization name must be 1 to 20 bytes.
Timeout Seconds Integer
Timeout in seconds for retrieving content from IMS. If no timeout is desired, type 0.
CSM Cache String
Colon-separated three-part name of a local CSM cache. The names use 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>.

Example: For domain "ntvaga" and organization "CompanyName," the names use the form page_cache<n>:ntvaga:CompanyName, 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:CompanyName.

The parameter should be null if, and only if, there are no CSM caches local to the current Content Engine server.

EMC Centera configuration parameters

Attribute Name Attribute Value
FCD Pool Idle Timeout Seconds Integer
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.
FCD Pool Preferred Size Integer
The minimum size to which the fixed content device provider pool will be allowed to shrink after the idle timeout has expired.
FCD Pool Max Wait Seconds Integer
The maximum number of seconds to wait for a connection after the limit specified by the FCP Pool Max In Use limit 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.
FCD Pool Max In Use Integer
The maximum number of concurrent connections allowed for the fixed content device. A value of -1 indicates that there is no limit.
Pool Address String
The Centera Pool Address, passed to FPPool_Open as the 'PoolAddress' parameter. Enter the fixed content device DNS name or IP address, expressed in dotted quad format (decimal values of its 4 bytes, separated by periods); for example, 127.0.0.1. If more than one access node is used, separate the entries with a comma. This parameter also supports the use of an Application Profile (PEA) file.

PEA files control access of a client application to the Centera system. They map a given application to a Virtual Storage Pool. Using Virtual Storage Pools is a best practice recommended by EMC to separate storage from multiple applications, and for replication purposes. FileNet provides:

  • The discrete access values required in the PEA file for Content Engine to access the pool
  • Specification on how to pass the reference to the PEA file as part of the Centera connection string.

P8 Content Engine does not require a specific PEA file. By default, it uses the "anonymous" profile if none is specified. However, it does support passing a PEA file reference as part of the Centera connection string. The PEA file is generated using the Centera administration tool with the following settings and transferred to the Content Engine server:

Read: ON
Write: ON
Exist: ON
Delete: ON

A PEA file example:

10.10.16.1,10.10.16.2?c:\centera\my.pea

Or, if the file is shared by more than 1 computer, the filename is a shared path name:

10.10.16.1,10.10.16.2?\\myhost\centera\my.pea

NOTE   For additional information on available connection string options, refer to the EMC Centera documentation.

An advanced technique is to write the XML (see About Centera > Pool Address Site Mapping XML Data for an example) to a UNICODE file (prefix the XML with "sitemap"), then set the Centera connection string to the file name (with ‘file:’ prefix). Consider placing the file in the P8 domain GCD share, since it is already shared and accessible from all Content Engine service computers in the P8 domain, has proper security settings, and should be part of regular system backups.

For example, if the file ‘Map_Centera.xml’ is copied to the GCD share, set the connection string to ‘file:\\server\FNCE_server$\Map_Centera.xml’.

Concurrent Readers

Integer
Used to limit the maximum number of concurrent Centera reader threads. A semaphore ensures that a given OSS process allows only a maximum of Concurrent Readers to simultaneously call FPTag_BlobReadPartial.

Max Reader Semaphore Wait Time Used with the Maximum Reader Threads configuration value. If the maximum number of reader threads are currently busy reading from Centera, the new thread waits the duration of Max Reader Semaphore Wait Time (MRSWT) for a slot to open up (so it can perform a Centera read). If the full time expires, the thread fails the read request.
Default Retention Pass Through

Boolean
This flag only applies when a fixed storage area's Default Retention Period is configured to use the Same as the retention period of the fixed content device. Normally, the provider examines the FP_RETENTION pool capability value and explicitly sets the retention period to either zero or infinite, depending on the capability setting. When Default Retention Pass Through is set to 1 (TRUE), the retention period is set to FN_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).

Never Delete Clips Or Content

Boolean
If set to 1 (TRUE), the Centera provider never attempts to delete Clips or BLObs, all content is left completely intact on the Centera device. Note that normally this setting has no impact on enforcement of the retention period--Content Engine still honors the retention period and prevents delete when appropriate. This flag is only examined by the low-level delete routine within the provider; if TRUE, the delete is not processed.

Note that referrals can still be deleted from the store (as well as content for reservations and annotations).

Set this flag to 1 to run Centera in a write-once and delete-never mode, and still delete documents from the object store.

BLOb Write Collision Avoidance Flag Integer
Used by the provider when creating Centera content, the value is combined with FP_OPTION_CLIENT_CALCID_STREAMING to form the options parameter of FPTag_BlobWrite. There are three possible [decimal] values:
  • 0 - Use the collision avoidance scheme of the Centera system.
  • 64 - FP_OPTION_ENABLE_COLLISION_AVOIDANCE override system setting, enable collision avoidance.
  • 128 - FP_OPTION_DISABLE_COLLISION_AVOIDANCE override system setting, disable collision avoidance
BLOb Read Ahead Size Integer
A maximum buffer size, used by the provider 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 using the callers 'stream' as requested. If the content size is greater than the parameter value, FPTag_BlobReadPartial reads only the data of the size requested by the caller (no buffer is created).
Embedded Data Threshold

Integer
The maximum data size per content element to embed in the C-Clip. By default this value is zero, meaning that content is never embedded in the C-Clip. The maximum value for this parameter is 102400 (bytes); if a greater value is supplied, it is 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).

Audited Delete Prefix String
A prefix string to use with Centera audited delete. If the string is blank, audited delete is not invoked (FPClip_Delete is used). If the string is not blank, the string is not 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).
Buffer Size Integer
The size of an internal C-Clip buffer in bytes. The default value is 16*1024. The minimum value is 1 KB. The maximum value is 10 MB.

Timeout Integer
TCP/IP connection timeout in milliseconds. The default value is 120000 ms (2 minutes). The maximum value is 600000 ms (10 minutes).
Enable Multicluster Failover Boolean
When set to TRUE (1), multicluster failover is enabled; by default, the option is TRUE (1). To turn multicluster failover off for all capabilities, specify FALSE (0).
Default Collision Avoidance Binary
To enable collision avoidance at pool level, set this option to TRUE (1); the default is FALSE (0). If you enable this option, the SDK uses an additional BLOb discriminator for read and write operations of C-Clips and BLObs. (BLOb Write Collision Avoidance Flag is used in tag write and only applies to BLObs.)
Prefetch Size Integer
Helps determine the BLOb size. The default size is 32 KB. The maximum size is 1 MB.
Maximum Connections Integer
The maximum number of sockets the SDK allocates for your application. Sockets communicate with the Centera clusters managed in each pool object. The default value is 100. The maximum value is 999.
Retry Count Integer
The number of times an operation retries before reporting failure to the client
application. The default value is 6. If the first execution of the function fails, the system retries the function six times. In total, the function executes seven times. The maximum value is 99.
Retry Sleep Integer
The time to wait before the failed API function call retries, in milliseconds. The maximum value is 100000 ms. If no retry sleep has been defined, the SDK uses an exponential back-off scheme. The sleep time increases after each retry, starting at 1 second, and doubles after each retry
Cluster Nonavailable Time Integer
The time in seconds that a cluster is marked as not available before retrying with a probe. Other clusters in the pool are used while the cluster is unavailable. The default value is 600 (10 minutes). The minimum is 0. The maximum is 36000 (10 hours).
Open Strategy

Integer
The approach used by FPPool.Open() to open connections to addresses in the connection string. Choices are:

  • FP_NORMAL_OPEN(0) — FPPool_Open() attempts to open connections to all addresses in the connection string, and to all associated replication addresses. Consider using this strategy if your application performs numerous operations while the pool is open. This strategy is the default. This option is equivalent to FP_OPTION_DEFAULT_OPTIONS.
  • FP_LAZY_OPEN (1)— FPPool_Open() opens connections to addresses only as needed. Consider using this strategy if your application frequently opens and closes the pool.
Multicluster Read Strategy

Integer
The multicluster failover strategy for read operations: FPClip_Open(), FPTag_BlobRead(), FPTag_BlobReadPartial().

Choices are:

  • FP_NO_STRATEGY(0)
  • FP_FAILOVER_STRATEGY(1)
  • FP_REPLICATION_STRATEGY (2, default)
Multicluster Write Strategy

Integer
The multicluster failover strategy for write operations: FPClip_Write(), FPTag_BlobWrite().

Choices are:

  • FP_NO_STRATEGY(0, default)
  • FP_FAILOVER_STRATEGY(1, Not supported)
  • FP_REPLICATION_STRATEGY (2)
Multicluster Delete Strategy

Integer
The multicluster failover strategy for delete operations:

FPClip_Delete(), FPClip_AuditedDelete(). This option also controls failover for the deprecated purge operations: FPClip_Purge(), FPTag_BlobPurge().

Choices are:

  • FP_NO_STRATEGY(0, default)
  • FP_FAILOVER_STRATEGY(1, Not supported)
  • FP_REPLICATION_STRATEGY (2)
Multicluster Exists Strategy

Integer
The multicluster failover strategy for exists operations: FPClip_Exists(), FPTag_BlobExists().

Choices are:

  • FP_NO_STRATEGY(0)
  • FP_FAILOVER_STRATEGY(1, Default)
  • FP_REPLICATION_STRATEGY (2)
Multicluster Query Strategy

Integer
The multicluster failover strategy for query operations: FPPoolQuery_Open().

Choices are:

  • FP_NO_STRATEGY(0)
  • FP_FAILOVER_STRATEGY(1, Default)
  • FP_REPLICATION_STRATEGY (2)

SnapLock configuration parameters

Attribute Name Attribute Value
FCD Pool Idle Timeout Seconds Integer
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.
FCD Pool Preferred Size Integer
The minimum size to which the fixed content device provider pool will be allowed to shrink after the idle timeout has expired.
FCD Pool Max Wait Seconds Integer
The maximum number of seconds to wait for a connection after the limit specified by the FCP Pool Max In Use limit 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.
FCD Pool Max In Use Integer
The maximum number of concurrent connections allowed for the fixed content device. A value of -1 indicates that there is no limit.
Root Directory Path

String
Root directory of the file system-based fixed content device where content is stored in a file store-like directory structure (for example: \\green\snap_vol\p8fx1).

Directory Structure

Boolean
Select a possible value: Small or Large. Settable only on create, and cannot be changed after the fixed device is created.

  • Small structures consist of two levels of directories, each with 23 nodes at each level (total of 529 directories at the second level). Directories are named 'S0' through 'S22'. Content is stored only at the second level, never in the first-level directories.
  • Large structures extend the small structure with a third level of 23 nodes, for a total of 12,167 directories at the third level. Content is stored only at the third level.
SnapLock User Name String
User name to connect to remote SnapLock device.
SnapLock Password String
Password to connect to remote SnapLock device.
Confirm Password String
Password to connect to remote SnapLock device.
Device Address String
IP Address or host name of SnapLock device.
Device Root Directory String
Used in SnapLock only, the absolute path on the SnapLock device starting from the volume name. In the example /snap_vol/v16, snap_vol is the volume name. Use this path for delete: setRetentionPeriod ONTAPI

Tivoli Storage Manager (DR550) configuration parameters

Attribute Name Attribute Value
FCD Pool Idle Timeout Seconds Integer
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.
FCD Pool Preferred Size Integer
The minimum size to which the fixed content device provider pool will be allowed to shrink after the idle timeout has expired.
FCD Pool Max Wait Seconds Integer
The maximum number of seconds to wait for a connection after the limit specified by the FCP Pool Max In Use limit 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.
FCD Pool Max In Use Integer
The maximum number of concurrent connections allowed for the fixed content device.
Configuration Files Share String
The full path of the root directory that contains the configuration options files for the TSM server fixed content device. This directory must already exist and must be shared so that the Content Engine system user has read and write access. Do not modify these configuration options files; they are written to by the Content Engine server whenever various TivoliFixedContentDevice object properties are changed. The TSM server cannot run if these files are missing or damaged, so back them up frequently.
IP Address String
The IP address or computer name of the TSM server. This property corresponds to the TCPSERVERADDRESS option in a TSM options file.
Port Integer
The port number of the TSM server. This property corresponds to the tcpport option in a TSM options file.
Archive Protection Flag Boolean
Specifies whether data retention protection is enabled on the TSM server (true) or not (false). If data retention protection is enabled, an archived object cannot be deleted from the server until policy-based retention requirements for that object have been satisfied. This property corresponds to the value of the ENABLEARCHIVERETENTIONPROTECTION option in a TSM options file.
Compression Flag Boolean
Specifies whether files will be compressed before they are sent to the TSM server (true) or not (false). This property corresponds to the value of the COMPression option in a TSM options file.
Node Name String
The name of the client node to use for connecting to the TSM server.

All Content Engine objects that are archived to the TSM server will be written and retrieved under this node name. The client node must be configured to have proper read and write access to the TSM system, and must be allowed to make multiple connections to the TSM server.

Password String (encrypted)
The password of the client node name to use for connecting to the TSM server.
Confirm Password String
The password to use for connecting to the TSM server.
Owner Name String (optional)
The owner name to use for connecting to the TSM server and for archiving and retrieving Content Engine objects. This property is included for legacy reasons and is normally left blank.
Filespace Name String
The file space name to use for archiving Content Engine objects archived by TSM. The file space name must begin with a forward slash (/).
Application Type String
A string that identifies an application to the TSM server.
Options String (optional)
A string that contains configuraton options to be passed to the TSM server when connecting to it. These configuration options override the settings specified in the TSM options files. This string is not normally used and might contain P8-specific data that is not passed to the TMS server.
DSMI Directory String (optional)
If this property is set, it indicates that a CE UNIX server (the TSM client) is connected to the TSM server and specifies the full path of the TSM client directory containing the message file, the dsmtca file, and the dsm.sys file. If this property is not set, it indicates that the CE server (the TSM client) is on a Microsoft® Windows® system.
Write Buffer Size Integer (optional)
The buffer size, in bytes, to use when transferring content from the Content Engine server to the TSM server.
Mount Wait Duration This property is not supported.