Provides classes and interfaces that are used in the administration of a FileNet P8 Content Engine server. These classes are used to configure servers and content storage devices within a geographical site, to configure full text indexing and directory service access parameters, and to perform related tasks. This namespace also contains the classes used to author custom metadata (the class and property definitions that define applicaton-specific metadata). Most of the administration classes reside in the FileNet P8 domain's Global Configuration Data (GCD) database, outside of any object store (although the metadata authoring objects are defined within an object store).
Classes
Class | Description | |
---|---|---|
![]() |
ContentValidationRequest | Represents a data object to be used with the batch form of . |
Interfaces
Interface | Description | |
---|---|---|
![]() |
IAddOn | Represents a product extension to the core FileNet P8 Content Engine components. These extensions consist of properties and/or classes to support a specific feature. Add-ons can be non-FileNet products that are compatible with FileNet P8, or they can be FileNet-supplied and provide additional functionality. You can create an
|
![]() |
IAddOnInstallationRecord | Represents a record that contains information pertaining to the installation of an add-on. An object is created whenever an or object is installed on an object store. |
![]() |
IAsyncProcessingConfiguration | Represents configuration data for asynchronous processing of events. This class allows admininistrative clients to set or access event dispatcher configuration settings. An object can be assigned to objects of the server hierarchy (IDomain, ISite, IVirtualServer, and IServerInstance), and is persisted in the GCD. To create a |
![]() |
IAsyncUpgradeQueueItem | For internal use only. Represents a pending (queued) execution of an asynchronous upgrade action. |
![]() |
IAuditDefinition | Represents a definition that specifies audit-event parameters. Audit events are set on a per-class basis: use this interface to configure a object for each event that you want to audit for the class. To create a For each To retrieve |
![]() |
ICenteraFixedContentDevice | Represents the description of an EMC Centera fixed content device. |
![]() |
ICenteraSiteSettings | Represents the configuration settings that can be overridden for the EMC Centera fixed content devices on the specified site. For each setting that can be overridden, the object contains a property that, if populated, will override the corresponding property of the same name on the object. |
![]() |
ICFSImportAgentConfiguration | 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 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 Some site-specific settings might override the settings configured here. For more information, see the 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
|
![]() |
ICFSSiteSettings | For a particular FileNet P8 site, configures the Content Federation Service (CFS). For information on specifying the site, and on the relationship between the FileNet P8 site and domain, see the property. This configuration works in conjunction with the standard CFS import configuration. For more information, see the interface. |
![]() |
IChoice | Represents a single choice item in a choice list that can be assigned to a property, or represents a group node for a nested collection of choice items within a choice list. A choice item is a single possible value, or choice, in a choice list. A choice item can be of two possible types: integer or string. An integer-type choice item holds a single integer value and can be assigned only to an integer-valued property. A string-type choice item holds a single string value and can be assigned only to a string-valued property. A The type of data that a Localization is provided by the A A To create a |
![]() |
IChoiceList | Represents a choice list in an object store. Each choice list contains a list collection of objects that, when associated with a property, provides a discrete set of possible values that the property can hold. By using a choice list, you can enforce restrictions on property values. There are two types of choice lists: integer and string. A choice list's type is specified by the following
constants, only and are valid constants for a object's property. A A choice list's display name is stored in its Choice list hierarchy is specified by its For a choice list to be useful, it must be associated with a property. You can either associate a choice list with a property template, therefore causing it to be automatically associated with every property definition created from that property template, or you can associate a choice list with an individual property definition. To associate a choice list with a property template or a property definition, set its To create a new |
![]() |
IClassDefinition | Represents the class definition (mutable class metadata) of non-versionable, non-subscribable classes. Subclasses of the Subscribable class are defined in objects, except for the class and its subclasses, which are defined in objects, and the class and its subclasses, which are defined in objects. You can modify class definition metadata via its properties and property definitions throughout the life of an instantiated object. Note, however, that you cannot modify a class definition's property. |
![]() |
ICmDirectoryConfigurationOID | Configuration object for Oracle Directory Server security provider. |
![]() |
ICMODApplicationGroup | Represents an IBM Content Manager OnDemand (CMOD) application group that can be configured for content federation. An application group is a collection of one or more OnDemand applications with common indexing and storage management attributes. |
![]() |
ICMODFixedContentDevice | Represents the description of an IBM Content Manager OnDemand (CMOD) external fixed content storage device. |
![]() |
ICmTivoliManagementClass | A management class that represents a specific retention setting for an IBM Tivoli Storage Manager (TSM) server. A class can have one or more classes associated with it (via its property). Each management class that you create represents a retention scheme type and a retention period that you can associate with a specific class. Note that if data retention protection is turned off (controlled via the property of a class), any management classes that specify a chronological retention scheme will be made unavailable by the Content Engine server. There are two types or retention schemes that a management class can represent: chronological or event. The type of retention scheme used by the management class determines how the retention period is interpreted:
|
![]() |
ICodeModule | Represents a user-implemented Java event handler that executes when an To create an Note:
object must be of type , not . If you attempt to save an object with an type in the content element list, the object will throw an exception.
, such as by updating the event handler content, then you must set the new version to the CodeModule property of any -based object for which the new version is intended.To instantiate an As an alternative to representing a Java event handler as an For cache configuration considerations, see the applicable code module-related properties in the See also the Javadocs for the following interfaces: |
![]() |
IColumnDefinition | Represents the description of a column in a Content Engine database table. A object describes a column used by a object. By reading the properties of these objects, you can query the values contained in a table. |
![]() |
IContentCacheArea | Represents a file storage area that stores duplicates of the document content most frequently requested, and permits those duplicates to be accessed in lieu of the originals in order to enhance the document retrieval performance of local servers. For example, a content cache area can be shared by several servers on a LAN to minimize the number of times they need to access a main storage area on the WAN. For information on configuring a content cache for a server or group of servers, see the Document content consists of the content elements associated with documents (as specified by the
In both circumstances, new content can be added to the cache only when its storage capacity (as defined by the Cache pruning is the process of deleting the content least frequently requested from the cache. Pruning deletes three main categories of files: abandoned, expired, and old. An abandoned file is an incomplete file that has been not properly added to the cache as a result of a server failure of some sort (such as a power failure). An expired file is a file that has remained in an unaccessed state longer than the maximum-time-to-live (as specified by the Pruning considers the most recent access time for a file equivalent to its time-of-last-use. This time gets updated to the current time when the file first gets added to the cache, and also whenever the file gets retrieved, provided more than 10 minutes have elapsed since the previous time-of-last-use update. Consequently, the accuracy of the time-of-last-use for a file is within 10 minutes. Prune actions--specific instances of pruning--operate on the cache directory by directory. For a general discussion on the advantages of this approach, see the Prune actions get triggered in three different ways:
Cache sweeping does not update the count of content element creations (the |
![]() |
IContentCacheConfiguration | Defines the configuration for a content cache. This includes, in particular, the file storage area for the cache (the property). A cache configuration can be associated with a server or with a group of servers. More specifically, a In order for a cache area to be used, at least one server must be configured to be part of the same site as the cache. |
![]() |
IContentConfiguration | Configures the Content Management Subsystem. The Content Management Subsystem is the part of the Content Engine Object Store Service that is responsible for adding and retrieving document content to and from managed storage areas in response to client requests. The ContentConfiguration interface allows the operation of the Content Management Subsystem to be tuned for the local environment in which it is executing. Just as it must do for all other client requests involving the creation, update, or deletion of data in an object store, the Object Store Service must also guarantee transactional integrity with respect to adding content. Guaranteeing the transactional integrity of content upload and storage is one of the primary functions of the Content Management Subsystem. In order to make this guarantee, the process of adding content is divided into two stages: Stage one involves copying content into a temporary location on the server while stage two is primarily concerned with copying the content to its permanent location. Stage one occurs within the context of a client initiated transaction involving content upload; for example, checking in a document. In this stage, the content associated with the object or objects participating in the transaction are copied from the client to a temporary location that is associated with the designated storage area in which the content will ultimately be stored. This temporary location may be a specially designated file system directory, sometimes referred to as the "inbound directory" or it may a table in the database. The type of temporary storage depends on the destination storage area type. Any metadata changes associated with the participating objects are also carried out at this during this stage. At the conclusion of the first stage of the operation, the transaction must be committed in order to make the changes durable. Committing the transaction includes adding a message to the ContentQueue, when processed, that will result in the second stage of the operation to be executed. The fact that the transaction has been committed after stage one necessarily implies that the server guarantees that the second stage will be carried out - even in the event of server disruptions, power failures, etc. It is important to note that after a transaction involving content upload has been committed, that is, after stage one has completed, the new content has functionally been added to the storage area; a user can retrieve (or perform any other legal operation) on the new content just like any other content in the storage area, despite the fact that it may actually still reside in the temporary storage location. At the conclusion of stage one of the operation or at anytime during its execution, the transaction can also be aborted and, therefore, must be rolled back. Rolling back a transaction in simple terms means guaranteeing that any intermediate changes that occurred during the execution of the transaction will be undone so that the system is restored to the state that it was in prior to the transaction and guaranteeing that none of these changes will be visible to any other transaction while they are being cleaned up. With respect to content upload there are two categories of changes that need to be undone: Metadata changes and content that has been copied to the temporary storage area. The cleanup of the former is handled by the normal transaction processing mechanisms provided by the Object Store Service but the latter is a special case and is managed by the Content Management Subsystem. The way it works is temporary content is flagged as "abandoned". While it is in this state it is invisible to clients and is effectively "not there" from the client's point of view. The Content Management Subsystem then periodically sweeps the temporary storage areas and deletes all abandoned content. Many of the functions of the Content Management Subsystem described above are parameterized such that their behavior can be modified. This is the purpose of the ContentConfiguration interface: To expose those aspects of content operations that can be adjusted in order to optimize the performance of the Object Store Service within a given operational environment. |
![]() |
IDatabaseStorageArea | Represents a storage area for content elements stored in the database. |
![]() |
IDirectoryConfiguration | Represents the base configuration object for all security providers and holds directory configuration data. The object is used to configure the directory service providers that are used for authorization checks within the servers. You can create one or more |
![]() |
IDirectoryConfigurationAD | Represents the configuration object for the Active Directory security provider. You must create a configuration object for each Active Directory forest that is accessed by the FileNet P8 domain. For example, if you have two Active Directory forests to be accessed by the FileNet P8 domain, you need to create two Active Directory-specific objects--one for each forest. To create an instance of the class, call . The group of type-specific directory configuration objects is contained in the collection object. |
![]() |
IDirectoryConfigurationAdam | Represents the configuration object for an ADAM or AD LDS security provider. A Microsoft Active Directory Application Mode (ADAM) directory server or a Microsoft Active Directory Lightweight Directory Services (AD LDS) directory server can be mapped to multiple FileNet P8 realms. Each FileNet P8 realm has a one-to-one relationship with the authentication provider. There is also a one-to-one relationship between a FileNet P8 object and a object. Therefore, you must create one object for each authentication provider in each realm. To create an instance of the class, call . The group of type-specific directory configuration objects is contained in the collection object. |
![]() |
IDirectoryConfigurationCA | This interface is not supported. An instance represents the configuration object for a CA eTrust security provider. |
![]() |
IDirectoryConfigurationIBM | Represents the configuration object for an IBM Tivoli security provider. An IBM Tivoli directory server can be mapped to multiple FileNet P8 realms. Each FileNet P8 realm has a one-to-one relationship with the authentication provider. There is also a one-to-one relationship between a FileNet P8 object and a object. Therefore, you must create one object for each authentication provider in each realm. To create an instance of the class, call . The group of type-specific directory configuration objects is contained in the collection object. |
![]() |
IDirectoryConfigurationNovell | Represents the configuration object for a Novell eDirectory security provider. A Novell eDirectory server can be mapped to multiple FileNet P8 realms. Each FileNet P8 realm has a one-to-one relationship with the authentication provider. There is also a one-to-one relationship between a FileNet P8 object and a object. Therefore, you must create one object for each authentication provider in each realm. To create an instance of the class, call . The group of type-specific directory configuration objects is contained in the collection object. |
![]() |
IDirectoryConfigurationSunOne | Represents the configuration object for a SunOne security provider. A SunOne directory server can be mapped to multiple FileNet P8 realms. Each FileNet P8 realm has a one-to-one relationship with the authentication provider. There is also a one-to-one relationship between a FileNet P8 object and a object. Therefore, you must create one object for each authentication provider in each realm. To create an instance of the class, call . The group of type-specific directory configuration objects is contained in the collection object. |
![]() |
IDITARenditionEngineConnection | Represents site-specific connection data for a DITA Rendition Engine that is referenced by a publishing configuration. (A DITA Rendition Engine is one that uses a DITA Open Toolkit deployment for publishing documents.) |
![]() |
IDocumentClassDefinition | Represents the class definition (mutable class metadata) of the class and its subclasses. You can modify class definition metadata via its properties and property definitions throughout the life of an instantiated object. Note, however, that you cannot modify a class definition's property. |
![]() |
IDocumentClassificationQueueItem | Represents a pending (queued) document auto-classification request. The property specifies the document that is the subject of the queued request. |
![]() |
IEventClassDefinition | Represents the class definition (mutable class metadata) of event classes whose instances can be subscribed to or audited. To instantiate a object, call the or method on the in a subscription or for auditing, set the property on a You can modify class definition metadata via its properties and property definitions throughout the life of an instantiated object. Note, however, that you cannot modify a class definition's |
![]() |
IEventQueueItem | Represents a pending (queued) execution of an asynchronous event action, or an asynchronous event queue item that remains unprocessed because its retry count is zero. The interface includes properties for setting and retrieving the source object and event of the pending event action. To instantiate a |
![]() |
IFileStorageArea | Represents a storage area for content elements stored in the file system. |
![]() |
IFixedContentDevice | Represents the base, abstract class for all classes relating to fixed content devices. A fixed content device has the following characteristics:
|
![]() |
IFixedStorageArea | Represents a storage area for content elements stored in a fixed content device. |
![]() |
IGenericFixedContentDevice | Represents the description of a generic fixed content device. The object provides an extensible mechanism for implementing interfaces to fixed content devices not currently supported by FileNet. The ConfigurationParameters property provides the set of parameters that will be passed to a custom implementation of a fixed content provider used to connect to the fixed content device. Note that there is no fixed format for the ConfigurationParameters property (other than, it must be a string that the custom implementation of the fixed content provider can understand and parse). This object is for future use only and is not currently supported by FileNet. |
![]() |
IIICEFixedContentDevice | 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 interface.) As a content device description, this interface ties together these main entities:
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 |
![]() |
IImageServicesClassDescription | Represents the description of an Image Services document class. |
![]() |
IImageServicesImportAgentConfiguration | Represents configuration data for an Image Services import operation. |
![]() |
IImageServicesPropertyDescription | Represents the description of an Image Services document class property. |
![]() |
IImageServicesSiteSettings | Represents the configuration settings that can be overridden for the Image Services fixed content devices on the specified site. For each setting that can be overridden, the object contains a property that, if populated, will override the corresponding property of the same name on the object. |
![]() |
IIMFixedContentDevice | Represents the description of a FileNet Image Services fixed content device. |
![]() |
IIndexArea | Represents the disk storage location and data necessary to perform full-text indexing for content-based retrieval. A single index area holds data for only one object store, using one file system directory. Spreading the indexing information across multiple file systems requires the use of multiple index areas. The |
![]() |
IIndexJob | Initiates and tracks the status of a full text indexing operation. is used to rebuild the full text index in the event that it becomes corrupted, or a configuration change requires that the full text index be rebuilt. The following types of indexing scenarios are supported:
All currently indexed data is available while indexing is in progress, but some queries will get duplicate matches from full text searches, due to matches in both the old and the new index data. When the Most index jobs require sweeping the database looking for collections or classes to be indexed. This sweep requires a table scan on the database (taking a considerable length of time on a large table), even if the amount of data to be indexed is minimal. The database table scans are performed once for all classes to be indexed in a table, and once for all collections to be indexed in a table. To minimize the number of table scans required, we recommend you put all classes or collections to be indexed for the same table into a single |
![]() |
IIndexJobClassItem | Identifies the class to be full text indexed. When a property or class is enabled or disabled for indexing, objects with newly enabled properties/classes need to be indexed, and objects with newly disabled properties/classes need to be removed from the index. The specified class can be any base class (such as, or ), or any of its subclasses, that support indexing. All instances of the specified class are indexed. Warning: Do not change the If the class selected to index is a base class ( Note: For indexing purposes, the For |
![]() |
IIndexJobCollectionItem | Identifies a Verity collection to be full text indexed. When the indexing data for one or more Verity collections becomes corrupted or lost (due to a storage device failure), the collection needs to be reindexed. This operation deletes the current indexing data, and creates new full text index data to replace it. Warning: Do not use collection indexing to address a change in the |
![]() |
IIndexJobItem | Indicates a particular item that is being full text indexed. |
![]() |
IIndexJobSingleItem | Identifies an object to be full text indexed. When the original index attempt results in an indexing failure for a single object (such as a or object), or some aspect of the configuration (such as a Verity style file) needs to be changed, the affected object can be reindexed. Performing this operation on an object whose class is CBR enabled attempts to reindex the object. Performing this operation on an object whose class is not CBR enabled attempts to delete the object from any existing indexes. |
![]() |
IIsolatedRegion | Contains the connection information necessary to access the Process Engine isolated region. This information is persisted in the GCD (Global Configuration Data). An isolated region represents a logical subdivision of the Process Engine database. Each isolated region is referenced by one or more Process Engine connection points ( |
![]() |
ILocalizedString | Provides a means of support for locale-specific display names and descriptive text used by a class definition or property template. You can create an instance of a |
![]() |
IPEConnectionPoint | Routes Process Engine requests to an isolated region ( instance). This information is persisted in the GCD (Global Configuration Data). Multiple instances can reference the same isolated region. The allows individual applications to use an arbitrary, application-specific name to refer to an isolated region. The set of connection points defined is reflected in the property. |
![]() |
IPropertyDefinition | Represents the base class for all property definition classes. A property definition is created from a property template and holds mutable property metadata. Each property definition class corresponds to a specific property data type (for example, defines a property that returns a binary value, defines a property that returns a Boolean value, and so on). When a property definition is added to a class definition's collection, a user-defined property is added to that class. |
![]() |
IPropertyDefinitionBinary | Represents the definition of a property that holds a binary value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
![]() |
IPropertyDefinitionBoolean | Represents the definition of a property that holds a Boolean value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
![]() |
IPropertyDefinitionDateTime | Represents the definition of a property that holds a DateTime value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
![]() |
IPropertyDefinitionFloat64 | Represents the definition of a property that holds a Double (Float64) value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
![]() |
IPropertyDefinitionId | Represents the definition of a property that holds a GUID string value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
![]() |
IPropertyDefinitionInteger32 | Represents the definition of a property that holds an integer value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
![]() |
IPropertyDefinitionObject | Represents the definition of a property that holds a Content Engine object value. A object is created from a object and contains mutable metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
![]() |
IPropertyDefinitionString | Represents the definition of a property that holds a string value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
![]() |
IPropertyTemplate | Represents the base class for all property template classes. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
![]() |
IPropertyTemplateBinary | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding binary values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
![]() |
IPropertyTemplateBoolean | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding Boolean values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
![]() |
IPropertyTemplateDateTime | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding DateTime values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
![]() |
IPropertyTemplateFloat64 | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding Double (Float64) values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
![]() |
IPropertyTemplateId | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding GUID string values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
![]() |
IPropertyTemplateInteger32 | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding integer values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
![]() |
IPropertyTemplateObject | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding Content Engine object values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
![]() |
IPropertyTemplateString | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding string values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
![]() |
IPublishingConfiguration | References the configuration data for a publishing operation. This class allows admininistrative clients to set or access publishing-related configuration settings. A object can be assigned to objects of the server hierarchy ( , , , and ), and is persisted in the GCD. |
![]() |
IQueueItem | Is the base class for all queue-related classes. Queue-related classes represent a pending (queued) execution of an asynchronous action on a target object. For example, a document may have a pending document classification action. You cannot create a new instance of |
![]() |
IRenditionEngineConnection | Represents site-specific connection data for a Rendition Engine that is referenced by a publishing configuration. |
![]() |
IReplicableClassDefinition | Represents the class definition (mutable class metadata) of classes of which an object instance can be replicated. |
![]() |
IReplicationConfiguration | Represents configuration settings for the replication components of a server. |
![]() |
ISecurityPropagationQueueItem | Represents a pending (queued) execution of an asynchronous security propagation action on a target object. Security propagation means the security assigned to a parent object will be inherited by its child objects. You cannot create a new instance of |
![]() |
IServerCacheConfiguration | Defines configuration options for all server caches that do not have object store-specific characteristics. The options apply to the following caches: code module cache, GCD cache, marking set cache, metadata cache, subject cache, and user token cache. Options include a time-to-live (TTL) value for managing cache entry residency and a value that, when exceeded, triggers cache refresh activity on a least-recently-used basis. (Object store-related cache options, such as folder cache TTL and object security cache attributes, are set at the object store level.) The To create a new instance, call The |
![]() |
IServerInstance | Represents a single instance of a Java Virtual Machine (JVM) running in an application server. One or more logically connected server instances working together constitute a virtual server. One or more virtual servers make up a site within a FileNet P8 domain.
|
![]() |
ISite | Identifies a geographical area within a FileNet P8 domain. A domain can have one or more configured sites. Each site is identified by a unique name and has associated servers and resources (such as object stores, index areas, storage areas, and content caches). Associated resource objects in the same geographical area have the same property. When a Content Engine server in a geographically distributed environment processes a user request, it determines what resources it will need to process the request, and makes use of the site information in these resources to determine how best to process the request. The site information will determine whether or not content retrievals and uploads are processed through a content cache, and whether or not the request will be forwarded to a server in another site, closer to the resources required to process the request. When the Content Engine server is initialized and the GCD created, a factory-generated instance of the For more information about request forwarding, see "Request Forwarding Concepts" in the Content Engine Administration documentation. To create a new instance of this class, call |
![]() |
ISiteSettings | Represents an abstract, dependent object that provides site-specific, configuration value overrides. For each fixed content device type with settings that can be overridden, a corresponding subclass of is defined with properties that, if populated, will override the corresponding properties of the same name on the fixed content device object. |
![]() |
ISnapLockFixedContentDevice | Represents the description of a NetApp SnapLock fixed content device. |
![]() |
IStorageArea | Represents the physical storage location where content will be stored. This base, abstract class has three concrete subclasses: , , and . A object is associated with a object when it is created. The concrete classes are customizable. This means that you can add custom properties to them (and to the base class) and create custom subclasses. By customizing the concrete classes, you can add custom criteria for selecting storage areas via a |
![]() |
IStoragePolicy | Represents a subset of available storage areas that are deemed equivalent based on common, user-specified criteria. If a or object is set to use this , the Content Engine will assign a storage area from this subset (pseudo-randomly, to balance load). |
![]() |
ISubscribableClassDefinition | Represents the class definition (mutable class metadata) of classes whose instances can be the target of a subscription and can be audited. objects hold the class definitions for all subclasses of the class except for the class and its subclasses, whose class definitions are held by objects. You can modify class definition metadata via its properties and property definitions throughout the life of an instantiated object. Note, however, that you cannot modify a class definition's property. |
![]() |
ISubsystemConfiguration | Represents a configuration object related to a particular subsystem or functional area that can be configured relative to a server hierarchy. This interface is the superclass for configuration objects. For each object in the hierarchy, there are a number of associated configuration objects. Each of these configuration objects has one or more attributes defining various configuration options for a particular subsystem area (such as content cache, server caching, trace logging, and so on). All of the configuration objects available on the objects of the server hierarchy ( |
![]() |
ITableDefinition | Represents the description of a Content Engine database table. All the tables used by the Content Engine database have corresponding objects that are accessible using the property of an object. You can also access a
|
![]() |
ITivoliFixedContentDevice | Represents the description of an IBM Tivoli Storage Manager (TSM) fixed content device. Although TSM supports a variety of storage devices, the class currently supports only IBM System Storage DR550. IBM System Storage DR550 provides automated data protection and allows you to comply with data retention requirements. |
![]() |
ITraceLoggingConfiguration | Configures and enables trace logging on the Content Engine host for the supported subsystems. Each of the supported subsystems is a property on this class, enabling trace logging to be configured per subsystem. Configuring trace logging for a subsystem applies the trace logging settings to all classes in that subsystem. The constant class contains the trace log settings available. These settings can be ORed together to apply multiple settings to a subsystem. The property on this ( ) class enables or disables trace logging for all of the configured subsystems. Use the property to specify the output destination classes for the trace logs. Trace logging is implemented using the Apache log4j package (org.apache.log4j). |
![]() |
IUpgradeAddOn | Specifies how to upgrade a set of existing add-ons to a new set of add-ons. An object has the following characteristics:
|
![]() |
IVerityCollection | Identifies the full text indexing information used for a particular base class and all of its subclasses. A is associated with only one IndexArea, and the full text information is stored in a file system directory identified by the . For each
An application can set the The New indexing information is written only to collections having a status of "open". However, all collections, regardless of their status, are searched when queries are performed. To prevent a collection from being searched, the associated |
![]() |
IVerityDomainConfiguration | Contains the Verity configuration properties that are common to all servers in a domain. Only one object can exist per domain (attempts to create multiple instances of a object will throw an exception). The method does not require an Id to fetch the object. The only two properties that must be set in Note: The |
![]() |
IVerityIndexArea | Contains information about an index area that is specific to the Verity content-based retrieval engine. The property must be set before creating an instance of this class. The |
![]() |
IVerityServerConfiguration | Contains the Verity configuration data (properties) for a server instance. This configuration data can differ from one server to the next. A object is contained in the property of , , , and objects. The object used is the first occurrence found by searching (in this order) the instance, the instance, the instance, and the instance. None of the properties on this object must be set or changed to enable full text indexing. This object is used only to address performance issues. |
![]() |
IVersionableClassDefinition | Represents the parent of the class, which holds the class definition of a class and its subclasses. |
![]() |
IVirtualServer | Represents a logical entity for managing a group of server instances. Multiple server instances can run simultaneously on a single physical machine, or can be deployed on separate machines. A virtual server is composed of multiple server instances logically operating together to provide a service or services. Clients of the Content Engine interact with a , rather than interacting with a specific ServerInstance. If a consists of a single , then the two are functionally equivalent. If a consists of multiple server instances, then client requests are distributed between each individual , providing scalability and high availability. Clients are not aware of which actually fulfilled their request. When multiple server instances are configured to run as a
|
![]() |
IXMLPropertyMappingScript | Represents the definition of a subclass for defining XML property mapping scripts. The Content Engine XML Classifier uses XML property mapping scripts to populate document object properties with values based on data extracted from an XML document’s content. Administrators build mapping scripts that associate XML tags in the incoming document to properties, thus enabling the automatic classification of any XML document. An object, in addition to having all of the capabilities of a object, provides a container for user-authored XSL scripts for transforming XML documents of a specified type. The script contains instructions for extracting content from source XML documents of the type identified by the property in order to map it onto property values for the properties associated with the target document class identified by the property. |