Represents an external fixed content device accessible via an instance of IBM Content Integrator (formerly known as Information Integrator Content Edition or IICE). This representation serves a two-fold purpose: to identify and describe the external device, and to configure the behavior of the Content Federation Service (CFS) with respect to that device. CFS uses metadata from the external device to create and update FileNet P8 federated documents. (For information on content federation, and on the CFS import process in particular, see the ICFSImportAgentConfiguration interface.)

As a content device description, this interface ties together these main entities:

  • Federator database - This database acts as a transmission medium between the CFS exporter that pulls metadata from the external device and the CFS importer that creates and updates FileNet P8 documents using the metadata. To specify the database instance to use, set these properties: FederationJNDIDataSource and FederationJNDIXADataSource.
  • External device/repository - The external device can be a Content Services repository or any other type of repository supported by CFS. To specify the external repository to use and to allow CFS to access it, set these properties: SourceRepositoryName, CFSUserName, and CFSPassword properties.

As a means for configuring the behavior of CFS with respect to the external device, this interface can affect FileNet P8 document updates. CFS periodically pulls metadata and content from the external repository to keep FileNet P8 documents in sync with any changes made to the corresponding external documents. To control how CFS performs these periodic updates, set the FederationUpdateHasPriority property.


The following tables list the members exposed by IIICEFixedContentDevice.

Public Properties

 NameDescription
Public propertyCFSNamingFactoryInitialObsolete.  
Public propertyCFSNamingProviderURLObsolete.  
Public propertyCFSPasswordFor an external (non-FileNet-P8) repository, the password component of the credentials that CFS uses to logon in order to perform CFS functions. For more information on these credentials, including the name component of these credentials, see the CFSUserName property.
Public propertyCFSUserNameFor an external (non-FileNet-P8) repository, the name component of the credentials that CFS uses to logon in order to perform CFS functions. (For information on specifying the password component of these credentials, see the CFSPassword property.) CFS expects these credentials to be for a security principal with the requisite security privileges. Specifically, CFS needs privileges for reading documents in order to export document metadata and content from the external repository, and privileges for changing document security permissions in order to lockdown documents. Insufficient privileges result in failures when attempting to perform these functions.

For more information on CFS interaction with an external IBM Content Integrator repository, see the IIICEFixedContentDevice interface.

Public propertyFederationJNDIDataSourceThe JNDI name of the data source for the federator database associated with the external (non-FileNet-P8) repository.

For a related JNDI name, see the FederationJNDIXADataSource property. For information on specifying the external repository, see the SourceRepositoryName property.

Public propertyFederationJNDIXADataSourceThe JNDI name of the XA data source for the federator database associated with the external (non-FileNet-P8) repository.

For a related JNDI name, see the FederationJNDIDataSource property. For information on specifying the external repository, see the SourceRepositoryName property.

Public propertyFederationUpdateHasPriorityA boolean value that specifies whether CFS, when importing document metadata from an external (non-FileNet-P8) repository into a FileNet P8 repository, treats the changes made to documents residing in the external repository as having greater priority than any changes made to corresponding FileNet P8 documents. When the value of this property is true, the external document changes have priority, and CFS unconditionally updates FileNet P8 documents with the imported metadata. When false, CFS updates a FileNet P8 document only if the document has not been changed more recently than the corresponding external document.

Suppose, for example, that a FileNet P8 document X exists with a corresponding external document Y, a user within the FileNet P8 repository has changed the metadata for X yesterday, a user within the external repository has changed the metadata for Y the day before yesterday, and CFS, as scheduled, imports metadata today from the external repository into the FileNet P8 repository. CFS discovers that X has been changed more recently than Y, and therefore does not update X with the metadata from Y (presuming that the FederationUpdateHasPriority property has a value of false).

CFS performs the change date comparison based on the FileNet P8 DateLastModified property and the corresponding property on the external document. If the external document has no such corresponding property, CFS unconditionally updates FileNet P8 documents with imported metadata regardless of the value of this property.

Public propertyIICEConfigurationServerURLThe URL that needs to be provided to the IBM Content Integrator API in order for it to locate the Configuration Server.
Public propertyLockDownExceptionListObsolete.  
Public propertyLockDownPrincipalObsolete.  
Public propertyLockDownPrincipalTypeObsolete.  
Public propertySourceRepositoryNameThe name of the external (non-FileNet-P8) repository as known to the IBM Content Integrator instance.

CFS requires and expects this external repository to have a document model compatible with the FileNet P8 model. In particular, CFS requires that document content within an external repository not change, and locks down documents, as necessary, to enforce this requirement. (For an overview of the properties needed to implement a document lockdown, see the IIICEFixedContentDevice interface.) In addition to this requirement, CFS and the Content Engine expect the version order for a document to be unchanging. (If the external repository does not support document versioning, CFS considers each version series to consist of one version.) The consequences of violating this expectation by federating a version series with a non-immutable version order include the following:

  • Re-imported out-of-order version error - CFS expects the position of a document within a version series not to change. For example, if when first imported into FileNet P8 a particular document is version 2 within a version series, CFS expects that document, if subsequently re-imported, to still be after the version 1 document (if present) and before the version 3 document (if present). Otherwise, CFS generates an error. (CFS ignores any missing versions, and missing versions do not cause the other documents within the version series to be considered out of order.)
  • New out-of-order version ignored - CFS ignores any new (not previously imported) documents found to be out of order. For example, if a previously imported version series consists of 5 versions, and the external repository allows the next version to be added as version 4 instead of, as expected, version 6, CFS ignores the new version 4 document.

For more information on CFS document importing, see the ICFSImportAgentConfiguration interface.

Top

See Also