com.filenet.api.admin

Interface CFSImportAgentConfiguration

  • All Superinterfaces:
    DependentObject, EngineObject, java.io.Serializable, SubsystemConfiguration

    public interface CFSImportAgentConfiguration
extends SubsystemConfiguration, DependentObject
    Configures the importer component of Content Federation Service (CFS). The CFS importer works in conjunction with the CFS exporter to map external documents to FileNet P8 documents in a one-to-one relationship. Specifically, using data extracted from an external repository and loaded into a federator database by the exporter, the importer creates and updates FileNet P8 documents known as federated documents. (For background information on the exporter and on the relationship between the federator database, the IBM Content Integrator instance, and the external repository, see the IICEFixedContentDevice interface.) A federated document is a FileNet P8 document created as a proxy for an external document, whereby FileNet P8 stores metadata (property values) mirroring the metadata stored in the external repository but keeps only a reference to the external stored content; the federated document accesses the external content in a transparent fashion, and thus behaves, with some limitations, like any other standard FileNet P8 document. The importer creates a new federated document to represent an external document when first importing the external document into FileNet P8. Thereafter, when subsequently re-importing the external document, the importer updates the metadata of the existing federated document.

    You can associate this import configuration with a server or a group of servers. Specifically, as with all configuration objects belonging to SubsystemConfiguration derived interfaces, a CFSImportAgentConfiguration instance can be associated with the following types of objects (via the SubsystemConfigurations property): ServerInstance, representing one server; VirtualServer, representing one or more servers; Site, representing a yet larger grouping of servers and other objects based on a geographic location; and a Domain, representing the largest possible collection of resources and services sharing the same Global Configuration Database (GCD). On startup, and periodically thereafter, the Content Engine server checks the ServerInstance object representing itself, then the VirtualServer object representing the virtual server of which it is a part, and so on, searching for the most closely associated import configuration. At least one such configuration always exists, because the automatic creation of a default CFSImportAgentConfiguration object occurs when you first create the domain.

    Some site-specific settings might override the settings configured here. For more information, see the CFSSiteSettings interface.

    The importer runs as part of the Content Engine, and one importer exists for each Content Engine instance. Each importer runs against all of the federator databases that have been defined for the domain (via GCD-stored IICEFixedContentDevice objects); consequently, multiple importers can be operating against the same federator database. Importers process batches of import requests created in the federator database by the exporter, where each import request represents a document version series stored in the external repository. In addition to the external metadata and content, an import request has properties indicating the target document class and the target object store. An importer can process an import request for any object store within the domain. The configuration of import request processing revolves around these importer sub-components:

    • Import Dispatcher
      The import dispatcher is the main sub-component of the importer; one dispatcher exists per importer. To enable or disable the dispatcher, set the DispatcherEnabled property.
    • Import Agent
      The import agent periodically scans the federator database for incoming import batches, loads the batches into an in-memory federation request queue, and assigns the batches from the queue to the import workers it creates. One agent exists per federator database per Content Engine instance. Consequently, this configuration might govern the behavior of more than one dispatcher. To control the activity level of the agent, set these properties: MaxInMemoryItems and DispatcherWaitInterval.
    • Import Worker
      The import worker performs the actual work of creating or updating FileNet P8 documents from the incoming external metadata and content. Each worker exists on a separate thread of execution. To control the number of workers and the distribution of work among workers, set these properties: MaxWorkerThreads, LeaseDuration, and BatchSelectionSize.

    For information about the properties on this class, see CFSImportAgentConfiguration Properties.

    Metadata

    Auditable: false
    AllowsInstances: true
    AllowsSubClasses: false
    ClassDefinitionName: None
    IsDependent: true
    IsHidden: false
    Searchable: false
    StorageType: Domain
    SuperclassName: SubsystemConfiguration

    • Method Detail

      • get_DispatcherWaitInterval

        java.lang.Integer get_DispatcherWaitInterval()
        Returns the value of the DispatcherWaitInterval property. For more information, see DispatcherWaitInterval Property.

      • set_DispatcherWaitInterval

        void set_DispatcherWaitInterval(java.lang.Integer value)
        Sets the value of the DispatcherWaitInterval property. For more information, see DispatcherWaitInterval Property.

      • get_DispatcherEnabled

        java.lang.Boolean get_DispatcherEnabled()
        Returns the value of the DispatcherEnabled property. For more information, see DispatcherEnabled Property.

      • set_DispatcherEnabled

        void set_DispatcherEnabled(java.lang.Boolean value)
        Sets the value of the DispatcherEnabled property. For more information, see DispatcherEnabled Property.

      • get_LeaseDuration

        java.lang.Integer get_LeaseDuration()
        Returns the value of the LeaseDuration property. For more information, see LeaseDuration Property.

      • set_LeaseDuration

        void set_LeaseDuration(java.lang.Integer value)
        Sets the value of the LeaseDuration property. For more information, see LeaseDuration Property.

      • get_MaxWorkerThreads

        java.lang.Integer get_MaxWorkerThreads()
        Returns the value of the MaxWorkerThreads property. For more information, see MaxWorkerThreads Property.

      • set_MaxWorkerThreads

        void set_MaxWorkerThreads(java.lang.Integer value)
        Sets the value of the MaxWorkerThreads property. For more information, see MaxWorkerThreads Property.

      • get_BatchSelectionSize

        java.lang.Integer get_BatchSelectionSize()
        Returns the value of the BatchSelectionSize property. For more information, see BatchSelectionSize Property.

      • set_BatchSelectionSize

        void set_BatchSelectionSize(java.lang.Integer value)
        Sets the value of the BatchSelectionSize property. For more information, see BatchSelectionSize Property.

      • get_MaxInMemoryItems

        java.lang.Integer get_MaxInMemoryItems()
        Returns the value of the MaxInMemoryItems property. For more information, see MaxInMemoryItems Property.

      • set_MaxInMemoryItems

        void set_MaxInMemoryItems(java.lang.Integer value)
        Sets the value of the MaxInMemoryItems property. For more information, see MaxInMemoryItems Property.

      • get_MoveContentLeaseThreshold

        java.lang.Integer get_MoveContentLeaseThreshold()
        Returns the value of the MoveContentLeaseThreshold property. For more information, see MoveContentLeaseThreshold Property.

      • set_MoveContentLeaseThreshold

        void set_MoveContentLeaseThreshold(java.lang.Integer value)
        Sets the value of the MoveContentLeaseThreshold property. For more information, see MoveContentLeaseThreshold Property.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

© Copyright IBM Corporation 2006, 2013. All rights reserved.