Classes
Type | Class | Description |
---|---|---|
![]() | ContentValidationRequest |
Represents a data object to be used with the batch form of StorageArea.ValidateContent.
|
Interfaces
Type | 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 AddOn object by calling CreateInstance on the Factory.AddOn class. Creating an add-on automatically registers it in the FileNet P8 Global Configuration Data (GCD) database. A registered add-on can then be:
|
![]() | IAddOnInstallationRecord |
Represents a record that contains information pertaining to the installation of an add-on. An
AddOnInstallationRecord object is created whenever an AddOn or
UpgradeAddOn object is installed on an object store.
|
![]() | IAsyncProcessingConfiguration |
Represents configuration data for asynchronous processing of events.
This class allows administrative clients to set or access
event dispatcher configuration settings.
An IAsyncProcessingConfiguration object can be assigned to objects of the server hierarchy
(IDomain, ISite, IVirtualServer, and IServerInstance), and is persisted in the GCD.
To create a IAsyncProcessingConfiguration object, call the CreateInstance method on the IAsyncProcessingConfiguration class. To instantiate an IAsyncProcessingConfiguration object, retrieve the SubsystemConfigurations property from an object of the server hierarchy, then iterate the ISubsystemConfigurationList for the IAsyncProcessingConfiguration object. |
![]() | 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
ISubscribableClassDefinition
object or subobject for auditing.
Create an IAuditDefinition object for each event that you want to audit for the class.
Multiple AuditDefinition objects for the same event type can be placed on a class to allow multiple audit clients to process the same event under different conditions, as expressed in the FilterExpression property. For example, client A retrieves update event records for flood claims flagged for suspected fraudulence, while client B retrieves update event records for settled flood claims. For more information, see Configuring Multiple Audit Definitions for the Same Event. To create a IAuditDefinition object, call the createInstance method on the Factory.AuditDefinition class. Once created, set its properties, which define the event to be audited and other parameters. For each IAuditDefinition object that you create, add it to a IAuditDefinitionList collection, then set the collection on the ISubscribableClassDefinition object. To retrieve IAuditDefinition objects, get the IAuditDefinitionList collection and iterate it. |
![]() | 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 CenteraSiteSettings
object contains a property that, if populated, will override the corresponding property of the same name
on the CenteraFixedContentDevice 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
IIICEFixedContentDevice 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 ISubsystemConfiguration derived interfaces, an ICFSImportAgentConfiguration instance can be associated with the following types of objects (via the SubsystemConfigurations property): IServerInstance, representing one server; IVirtualServer, representing one or more servers; ISite, representing a yet larger grouping of servers and other objects based on a geographic location; and a IDomain, 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 IServerInstance object representing itself, then the IVirtualServer 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 ICFSSiteSettings 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 IIICEFixedContentDevice 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:
|
![]() | 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 Site property. This
configuration works in conjunction with the
standard CFS import configuration. For more information, see the
ICFSImportAgentConfiguration
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 Choice object is a dependently persistable object; it has no Save method and therefore cannot be independently saved. Because any given Choice object is dependent on the independently persistable com.filenet.api.admin.ChoiceList object to which it belongs, its state is not saved until you call the Save method of the ChoiceList object that owns it. For a given Choice object to belong to a com.filenet.api.admin.ChoiceList object, it must be added to the com.filenet.api.collection.ChoiceList collection that is returned by the com.filenet.api.admin.ChoiceList object's ChoiceValues property. The type of data that a Choice object can represent is determined by the ChoiceType constant value that you specify with its ChoiceType property. This property determines whether a Choice object represents an integer-type choice item, a string-type choice item, a group node for a nested collection of integer-type choice items, or a group node for a nested collection of string-type choice items. Locale support is provided by the DisplayNames property, using the same mechanism that ClassDefinition and PropertyTemplate objects use. However, unlike those objects, the Choice object does not have a DescriptiveTexts property. To provide locale support for a Choice object, set its DisplayNames property to a LocalizedStringList object containing a collection of LocalizedString objects. Each object in this collection represents a locale-specific, user-readable display name that can be used for a Choice object; set its LocaleName property to a locale ID and its LocalizedText property to the locale-specific text for the display name. Once you have set the DisplayNames property, the server will automatically set the value of the DisplayName property to the LocalizedText property value of the LocalizedString object in the LocalizedStringList collection that corresponds to the object store's default locale. A Choice object's display name, or label, identifies it and is stored by its DisplayName property. You can either set the DisplayName property directly or you can set it indirectly by setting the DisplayNames property. Setting the DisplayNames property is the preferred method. You must set either a Choice object's DisplayName property or its DisplayNames property; you cannot set both. If you set the DisplayName property, the server will automatically create a LocalizedString object with its LocaleName property set to the object store's default locale and add it as a single item in the DisplayNames property's LocalizedStringList collection. If you set the DisplayName property directly, locale support will be bypassed and the language of its text may not match the specified locale. For example, if you store English text (en-us) in the DisplayName property and the default locale is French (fr-fr), the DisplayNames property will return a collection containing a single LocalizedString object that specifies a French locale with English text. Note that this behavior is unique to Choice objects. A Choice object's display name, which is always a string value, should not be confused with its value, which can be a string, an integer, or a collection of Choice objects (when a Choice object acts as a group node). A Choice object's display name is assigned with the DisplayName property, while its value is assigned using the appropriate property, depending on its type: ChoiceIntegerValue for integer-type choice items, ChoiceStringValue for string-type choice items, or ChoiceValues for group nodes. Although the server does not check the display names and values of the choice items within a given choice list for uniqueness, it is recommended that they be unique to avoid ambiguity. To create a Choice object, call the Factory.Choice.CreateInstance method. In order to save the state of a new Choice object (when you save the com.filenet.api.collection.ChoiceList object to which it belongs), you must, at a minimum, set its ChoiceType and DisplayNames properties. The DisplayNames property can be either set directly, by setting it to a LocalizedStringList object; or set indirectly, by setting the DisplayName property. To create a list collection of Choice objects (com.filenet.api.collection.ChoiceList object), call the Factory.Choice.CreateList method. |
![]() | IChoiceList |
Represents a choice list in an object store. Each choice list contains a list collection of
Choice 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 TypeID constant values, which are stored in a ChoiceList object's DataType property:
A ChoiceList object is independently persistable (that is, it can be saved directly using its Save method) and controls the state of any dependently persistable Choice objects that belong to it. You can access each Choice object that belong to a ChoiceList object in the com.filenet.api.collection.ChoiceList collection that is specified by its ChoiceValues property. Each Choice object in this collection represents either an individual choice item or a group node for a nested collection of Choice objects. A choice list's display name is stored in its DisplayName property and must be unique within an object store. Unlike a Choice object, a ChoiceList object does not have a mechanism for localizing its display name. Choice list hierarchy is specified by its HasHierarchy property. This read-only property indicates whether a given choice list has a hierarchical structure or not. If the choice list contains at least one Choice object that represents a group node, the server automatically sets this property to true. 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 ChoiceList property to the com.filenet.api.admin.ChoiceList object representing the choice list. To create a new ChoiceList object, call the Factory.ChoiceList.CreateInstance method. Set the appropriate properties and add any Choice objects to the com.filenet.api.collection.ChoiceList collection specified by its ChoiceValues property. Call the Save method to save the new object to the persistent store. For the save to be successful you must, at a minimum, set the new ChoiceList object's DisplayName and DataType properties. |
![]() | IClassDefinition |
Represents the class definition (mutable class metadata) of non-versionable, non-subscribable classes.
Subclasses of the Subscribable class are defined in SubscribableClassDefinition objects, except for the Document class
and its subclasses, which are defined in DocumentClassDefinition objects, and the Event class and its subclasses, which
are defined in EventClassDefinition 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 ClassDescription property.
|
![]() | ICmAbstractQueueEntry |
Customizable base for classes of objects that can be processed by a queue sweep.
ICmAbstractQueueEntry is solely intended for use by queues managed by
the Content Engine sweep framework.
As an abstract class definition, the class' metadata is not mutable. You must subclass this class to create a concrete root class with customizable metadata. Subclasses of CmAbstractQueueEntry can be set as sweep targets. |
![]() | ICmAdvancedStorageArea |
A storage area supporting these underlying advanced storage devices:
OpenStack cloud storage and file system storage.
One or more advanced storage devices, represented as
ICmStorageDevice objects,
can be associated with an advanced storage area.
An advanced storage area supports native content replication for disaster recovery and high availability solutions. In addition, an advanced storage area leverages the Content Platform Engine sweep service to perform queue processing for replication, content deletion, and abandoned content backout. An advanced storage area can co-exist with other storage areas: database, file system, or fixed content. Content can be moved between an advanced storage area and other types of storage areas. And like other storage areas, advanced storage areas can be assigned to storage policies. An association between an advanced storage device and an advanced storage area is made as a connection, represented as a ICmStorageDeviceConnection object. An advanced storage device object must exist before it can be connected to an advanced storage area. A list of ICmStorageDeviceConnection objects is set on an advanced storage area. |
![]() | ICmAtmosFixedContentDevice |
Represents the description of a EMC Atmos fixed content device.
|
![]() | ICmAuditDispositionPolicy |
Defines the criteria in which audit records are identified for disposition (deletion).
A ICmAuditDispositionPolicy is specified at the object store level, and is applied by the audit disposition thread,
configured with ICmAuditingConfiguration.
Dispostion uses an audit disposition policy in conjunction with the object store's bookmark objects
(ICmAuditProcessingBookmark ).
Disposition is executed by a Content Engine instance that is local to the target object store.
The criteria for selecting audit records for deletion is specified in a disposition rule. For example, criteria for deleting update events after three months is a rule. A disposition rule is expressed as the where clause of a query expression. ICmAuditDispositionPolicy is an independently persistable object, specifying one disposition rule. You can create or retrieve an ICmAuditDispositionPolicy object with a Factory method. You can create more than one ICmAuditDispositionPolicy object, and more than one associated schedule (configured with ICmAuditingConfiguration). For more information, see Audit Disposition. |
![]() | ICmAuditingConfiguration |
Represents configuration data for audit disposition,
a subsystem for automatic pruning (deletion) of audited events in the Content Engine audit log (Event table).
Audit disposition runs as a background thread within the Content Engine.
A ICmAuditingConfiguration object can be assigned to objects of the server hierarchy (IDomain, ISite, IVirtualServer, and IServerInstance), with the first encountered by the current server being the active instance. A default instance is created at the domain level during domain creation. ICmAuditingConfiguration objects are persisted in the GCD. ICmAuditingConfiguration allows admininistration clients to set or access audit disposition configuration settings, for example, the disposition schedule and the number of audited events deleted at one time. The disposition schedule is defined through a list-of-object property called IAuditDispositionTimeslots, where each element is a ICmTimeslot object with properties that specify a weekday, start time, and duration. Complementing ICmAuditingConfiguration are the ICmAuditDispositionPolicy class, for setting the event selection criteria (query expression) that are applied by the audit disposition thread, and ICmAuditProcessingBookmark, a class with which an audit processing client can set its leave-off point in the audit log. Audit disposition is enabled for the server or servers to which the configuration object applies when the AuditDispostionEnabled property is true and the AuditDispositionTimeslots list is non-empty. However, no disposition processing will take place for a particular object store until there is at least one enabled ICmAuditDispositionPolicy object defined in that object store. To create a ICmAuditingConfiguration object, call the CreateInstance method on the Factory.CmAuditingConfiguration class. To instantiate a ICmAuditingConfiguration object, retrieve the SubsystemConfigurations property from an object of the server hierarchy, then iterate the ISubsystemConfigurationList for the ICmAuditingConfiguration object. For more information, see Audit Disposition. |
![]() | ICmAuditProcessingBookmark |
Represents a leave-off point in the audit log (Event table), which indicates
the last record processed by an audit processing client, such as an analytics or
case history application.
Audit disposition uses bookmarks to determine the scope of records for deletion.
All audit records that precede the last record processed by any audit processing application are eligible for deletion.
An audit processing client is responsible to first create an instance of ICmAuditProcessingBookmark, and then update that same instance as subsequent batches of records are processed. A client uses Factory methods to create and retrieve a ICmAuditProcessingBookmark object. When it creates the object, the client sets the DisplayName property to identify itself as the bookmark creator, and the LastProcessed property to specify the audit sequence number of the last audit record processed. For subsequent audit processing operations, the client retrieves the object and updates the LastProcessed property. Because there can be multiple audit processor clients, an object store can contain multiple bookmarks, retrievable with the AuditProcessingBookmarks property of an IObjectStore object. The actual audit records to be deleted are determined by the rules of an object store's disposition policies, represented by ICmAuditDispositionPolicy objects. Only audit records that are selected by disposition policy rules and that possess an audit sequence number less than the lowest-valued bookmark will be deleted. If an audit processing client neglects to create or update its ICmAuditProcessingBookmark object, audit disposition will be controlled solely by the ICmAuditDispositionPolicy objects. Depending on the disposition rules defined in the objects, unprocessed audited records might get deleted prematurely. For more information, see Audit Disposition. |
![]() | ICmChangePreprocessorDefinition |
Associates a CmChangePreprocessorAction object with a class definition.
When an instance of the defined class is created or updated, a change preprocessor handler referenced in
the CmChangePreprocessorAction object is invoked.
A CmChangePreprocessorDefinition object is added to a ChangePreprocessorDefinitionsList object, which is set on the SubscribableClassDefinition object that represents the class definition. A CmChangePreprocessorDefinition object can be disabled at the class scope; therefore, the action it references will not be invoked within a given class hierarchy. |
![]() | ICmContentConversionAction |
This class is not supported.
Defines a content conversion handler. |
![]() | ICmContentConversionConfiguration |
This interface is not supported.
Specifies configuration settings for the content conversion subsystem. |
![]() | ICmContentConversionSettings |
This class is not supported.
Defines settings for and results produced by a content conversion operation. |
![]() | ICmConversionSettingsClassDefinition | |
![]() | ICmCustomStorageDevice |
A content storage device that is implemented by a custom handler.
|
![]() | ICmDatabaseConnection |
Contains database connection information
for object stores, event export stores, and isolated regions.
This administrative object is used to define the XA and non-XA
data source pair that provides the JDBC connection to the database.
ICmDatabaseConnection can be used to configure database connection sharing, allowing you to use a single XA and non-XA data source pair for multiple object stores, event export stores, and isolated regions residing in the same database. To configure database connection sharing, set the same ICmDatabaseConnection object on all objects that will share the same database. You can change a ICmDatabaseConnection object on an object store event export store, or isolated region if and only if the new database connection object points to the same database, or a copy of that database. Deletion of a ICmDatabaseConnection object is prevented if referenced by any object store, event export store, or isolated region. You can have multiple ICmDatabaseConnection objects contained within a domain. Each ICmDatabaseConnection object must reference unique data sources defined in the application server. You can change the data source values as long as they do not duplicate the data source values of another ICmDatabaseConnection object. In addition, the new data source values must point to the same database or a copy of the database for all objects that reference the ICmDatabaseConnection object. |
![]() | ICmDirectoryConfigurationConnections |
Represents the configuration object for the IBM Connections provider.
If you use the IBM Connections provider, the types of searches that you can specify for users and groups are restricted. For more information, see the method descriptions for IRealm.FindUsers and IRealm.FindGroups. An instance of ICmDirectoryConfigurationConnections requires no configuration. |
![]() | ICmDirectoryConfigurationDomino |
Configuration object for Domino LDAP security provider.
|
![]() | ICmDirectoryConfigurationOID |
Represents the configuration object for an Oracle Internet Directory (OID)
security provider. An OID 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 Realm object and a
CmDirectoryConfigurationOID object. Therefore, you must
create one CmDirectoryConfigurationOID object for each
authentication provider in each realm. To create an instance of the
CmDirectoryConfigurationOID class, call
Factory.CmDirectoryConfigurationOID.createInstance(). The
group of type-specific directory configuration objects is contained in the
CmDirectoryConfigurationOIDList collection object.
|
![]() | ICmDirectoryConfigurationRadiantOne |
Represents the configuration object for a RadiantOne security provider.
|
![]() | ICmDirectoryConfigurationVMM |
Represents the configuration object for the Content Platform Engine's VMM provider.
To use VMM (IBM Virtual Member Manager), Content Platform Engine requires
WebSphere Application Server version 7.0 or above.
VMM security provider supports a single FileNet P8 realm. Only the first page of search results for users or groups can be returned by a IRealm object. An instance of ICmDirectoryConfigurationVMM requires no configuration. |
![]() | ICmEventExportStore |
Represents an event export store used by the Case Analyzer or Case History publishing service.
These services collect and process events from a Content Engine object store
and from a workflow system.
In IBM Content Foundation, Case Analyzer is not supported. ICmEventExportStore also defines the underlying database. You can configure CmIEventExportStore to share database connections with object stores, isolated regions, or other event export stores, depending on how you set the DatabaseConnection property. |
![]() | ICmFileSystemStorageDevice |
Represents an advanced storage device that stores content in a file system.
|
![]() | ICmHitachiFixedContentDevice |
Represents the description of a Hitachi Content Platform fixed content storage device.
For information about Hitachi Content Platform, see your vendor documentation. The following code sample illustrates how to create a Hitachi fixed content device object. public void createHCPDevice() { String name = "HCP1"; String description = "HCP1 Content Store"; String namespaceURL = "http://dev.cemp.hcp.usca.ibm.com"; String root = "stores/hcpstore1"; bool largeStructure = false; String user = "hcpuser"; String pwd = "hcppassword"; int maxConnections = 10; ICmHitachiFixedContentDevice h = Factory.CmHitachiFixedContentDevice.CreateInstance(en.Get_LocalDomain()); h.DisplayName = name; h.DescriptiveText = description; h.HcpNamespaceUrl = namespaceURL; if (largeStructure) h.DirectoryStructure = DirectoryStructure.DIRECTORY_STRUCTURE_LARGE; else h.DirectoryStructure = DirectoryStructure.DIRECTORY_STRUCTURE_SMALL; h.HcpUser = user; h.HcpPassword = pwd.GetBytes(); h.HcpMaxConnections = maxConnections; h.RootDirectoryPath = root; h.Save(RefreshMode.REFRESH); } |
![]() | ICmHold |
Represents a hold on an object of type ICmHoldable,
preventing that object from being deleted for
an indefinite period of time, until the hold is explicitly removed.
Holds can be repeatedly applied and removed on an ad hoc basis
during the object's lifecycle.
A hold is applied by associating a ICmHold object with a ICmHoldable object through an intermediate CmHoldRelationship object. Every hold in which a ICmHold object participates is reflected in the object's ICmHoldRelationships property. Deleting a ICmHold object results in a cascade delete of the set of ICmHoldRelationship objects referenced by the CmHoldRelationships property. Thus, the hold is removed from all of the ICmHoldable objects to which the hold previously applied. Note: Deleting a ICmHold object that is referenced by a large number of ICmHoldRelationship objects can result in a database transaction failure. If you anticipate large-scale hold removals, configure the application server transaction timeout and transaction log space to accommodate the operation. By default, only object store administrators have the right to create ICmHold instances. The initial default instance permissions for ICmHold grant full control to object store administrators and read-only access to general users. See Hold Concepts |
![]() | ICmHoldable |
Abstract base class for classes to which holds (deletion prevention) can be applied.
A ICmHoldable object participates in a hold relationship
represented by a ICmHoldRelationship,
which includes properties for setting a ICmHold instance
(the hold object) and a ICmHoldable instance (the held object).
All of the holds in which a ICmHoldable object participates
are contained in the CmHoldRelationships property.
A hold is removed on a ICmHoldable object by deleting the ICmHoldRelationship object that references it. See Hold Concepts |
![]() | ICmHoldRelationship |
Defines a hold-held relationship between ICmHold (hold object)
and ICmHoldable object (the held object).
A ICmHold object can be referenced by more than one instance of this class, allowing a
many-to-many relationship between holds and held objects.
Therefore, a single hold can apply to multiple held objects,
and multiple holds can apply to a single held object.
Deletion of a ICmHoldRelationship object removes the hold on the held object; it does not delete the ICmHold object and ICmHoldable objects referenced by the ICmHoldRelationship object. Created with a Factory method, a ICmHoldRelationship object is independently persistable, but it is not independently securable. It takes its security from the ICmHold object. By default, only object store administrators have the right to create and delete ICmHoldRelationship subclasses and instances. See Hold Concepts |
![]() | ICmIndexDefinition |
Defines a database table's index.
Using the properties on this class, you can:
Note that these properties are all SETTABLE_ONLY_ON_CREATE. Therefore, instances of CmIndexDefinition are immutable once created. To change an index, you must delete the existing CmIndexDefinition instance (which results in the index being dropped from the database), and then create a new instance with the required changes. If you create a CmIndexDefinition object for a manually created index (an index that a database administrator created using the native database tools), the name specified for the CmIndexDefinition object must be the same as the name for the manually created index. The server will detect that the physical index already exists and, in such cases, will update only the metadata in the tables (skipping the actual index creation but performing the index definition creation).
|
![]() | ICmIndexedColumn |
Defines a column that forms part of a database index, and the manner in which the column participates
in the index.
Using the properties on this class, you can:
Note that these properties are all SETTABLE_ONLY_ON_CREATE. Therefore, instances of CmIndexedColumn are immutable once created. |
![]() | ICmIndexJobResyncItem |
Represents an index job that resynchronizes a full-text index with the data in an object store database.
This type of index job addresses out-of-sync conditions that can occur between an index and database,
such as when an index restored from a backup does not reflect changes to the database after
the backup was made.
For the index that is being resynced, the resync index job deletes index entries for the following types of objects: deleted objects, objects that are moved to a different index, or objects that are no longer CBR-enabled. Also, the index job creates any required index entries for objects that are not currently indexed in the index. If the ResyncModificationDate date is set, existing index entries are updated if the corresponding object was modified after the specified date. Like other index jobs, a CmIndexJobResyncItem object is added to a index job item list, which is set on an IndexJob instance. Note: Avoid creating an index job with multiple resync index job items. If such an index job fails, determining which resync items completed and which items need to be rerun is difficult. Also, no performance benefits result from creating such an index job versus creating a separate index job for each resync index item. |
![]() | ICmIndexPartitionConstraint |
Represents an index partition constraint associated with an IBM® Content Search Services index.
An index partition constraint of an index determines which CBR-enabled objects can be indexed into it.
A CBR-enabled object is a Document, Annotation, CustomObject, or Folder
object whose class description’s IsCBREnabled property has been set to true. Each index partition
constraint corresponds to a property on a CBR-enabled object that has been identified as an index partitioning property.
When an index partitioning property is specified in a text-search query, only indexes with the same partition property
are searched. Therefore, by configuring index partitioning in an object store, you can decrease the number of indexes
that must be searched as a result of a query, provided that your application uses index partitioning properties in the query.
Each CmTextSearchIndex object, which represents an IBM Content Search Services index, maintains a list of zero to two CmIndexPartitionConstraint objects via its IndexPartitionConstraints property. This list is read-only and is maintained by the Content Engine server. Each CmIndexPartitionConstraint object corresponds to an index partitioning property associated with an object store, represented by a CmTextSearchPartitionProperty object. Only CBR-enabled objects satisfying this constraint are stored in this index. |
![]() | ICmIndexPartitionConstraintDate |
Represents the date range of a date partition constraint for an IBM® Content Search Services index.
A date partition constraint determines which CBR-enabled objects can be indexed into a date-partitioned
IBM Content Search Services index. This constraint is based on the value of the custom property
that has been assigned as the date index partitioning property for the object store. A CBR-enabled
object with the assigned date index partitioning property is only indexed into a given date-partitioned
index if the value of that property is within the date range of the date partition constraint of the index.
|
![]() | ICmIndexPartitionConstraintString |
Represents the name and value of a string partition constraint for an IBM® Content Search Services index.
A string partition constraint determines which CBR-enabled objects can be indexed into a string-partitioned
IBM Content Search Services index. This constraint is based on the name and value of the custom property
that has been assigned as the string index partitioning property for the object store. A CBR-enabled
object with the assigned string index partitioning property is only indexed into a string-partitioned
index if the name and value of that property matches the string partition constraint of the index.
|
![]() | ICmIndexRequest |
Represents the base class for index requests. Each index request object is associated with a CBR-enabled object. Index request
objects are created by the indexing process, and cannot be created using the API. You can perform read and update operations on index
request objects, and there are properties with status, failure and retry information recorded. Index request objects are assigned security from the
default instance security for this class.
|
![]() | ICmIsilonFixedContentDevice |
Represents the description of a EMC Isilon fixed content device.
|
![]() | 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.
|
![]() | ICmOpenStackStorageDevice |
Represents an advanced storage device available through an OpenStack-conformant
object storage service.
|
![]() | ICmProcessEngineConfiguration |
Specifies configuration settings for the Process Engine,
including the Case Analyzer and Case History publishing services.
In IBM Content Foundation, Case Analyzer is not supported. Properties associated with Case Analyzer are ignored. A ICmProcessEngineConfiguration object can be assigned to objects of the server hierarchy (IDomain, ISite, IVirtualServer, and IServerInstance), with the first encountered by the current server being the active instance. A default instance is created at the domain level during domain creation. ICmProcessEngineConfiguration objects are persisted in the Global Configuration Database (GCD). |
![]() | ICmQueueEntryClassDefinition |
Mutable metadata class defining a subclass of ICmAbstractQueueEntry.
You can modify class definition metadata with its properties and property definitions throughout the life of an instantiated object.
Note, however, that you cannot modify a class definition's ClassDescription property.
|
![]() | ICmReplicaSynchronizationSiteSettings |
An object defining site-specific replica settings for a connection between an
advanced storage area and an advanced storage device.
|
![]() | ICmSearchFunctionDefinition |
Defines a custom SQL search function that can be invoked during a background search.
Specify the function name with the CmFunctionName property. If a handler requires
configuration settings to control its operation, create a subclass of
CmSearchFunctionDefinition and extend it with custom properties.
The function is coded by the user as a Java™ or JavaScript implementation of the ICmSearchFunctionDefinition interface. The user-implemented action is set on ICmSearchFunctionDefinition with the CodeModule or ScriptText property, depending on how the action is implemented. |
![]() | ICmSecuredStorageDevice |
Base for storage device types for which a username and password must be supplied.
|
![]() | ICmSMTPConfiguration |
Contains configuration settings for SMTP services. The email sweep action handler that
is included in the Email Services Extensions add-on uses the information stored in a
CmSMTPConfiguration object.
|
![]() | ICmStorageDevice |
Abstract base class for objects that represent different types of advanced storage devices.
A device is implemented in a concrete subclass. An instantiated class is connected to a
ICmAdvancedStorageArea
A device connection to an advanced storage area is represented as a
ICmStorageDeviceConnection.
|
![]() | ICmStorageDeviceConnection |
An object defining a connection between an advanced storage area and an advanced storage device.
A ICmStorageDeviceis set on this object,
along with the replication role of the storage device.
One or more ICmStorageDeviceConnection objects are set on an
ICmAdvancedStorageArea.
|
![]() | ICmTextExtractionSettings |
This class is not supported.
Defines settings and results produced by text extraction. |
![]() | ICmTextIndexingPreprocessorAction |
This interface is not supported.
Defines a text indexing preprocessor handler. |
![]() | ICmTextIndexingPreprocessorDefinition |
This interface is not supported.
Defines a text indexing preprocessor to be applied to instances of the defined class. |
![]() | ICmTextSearchAffinityGroup |
Represents an affinity group of IBM® Content Search Services servers. An affinity group is a group of
one or more servers that is dedicated to one or more IBM Content Search Services index areas. An affinity group
can contain multiple servers and have multiple index areas assigned to it. Create an affinity group if you want to
override the built-in load balancing feature of the Content Engine and dedicate servers to specific index areas.
The Content Engine server uses a load-balancing algorithm to automatically assign IBM Content Search Services servers to indexes according to the indexing workload of the servers. If you want to override this built-in load balancing feature, you can create affinity groups and manually dedicate IBM Content Search Services servers to specific index areas. An IBM Content Search Services server can belong to, at most, one affinity group. A server that is a member of an affinity group can serve only index areas that are assigned to that affinity group and that belong to the same site as the server. A server that is not a member of an affinity group can serve only index areas that do not belong to an affinity group and belong to the same site as the server. An IBM Content Search Services index area can be assigned to, at most, one affinity group. An index area that is assigned to an affinity group can be served only by members of the affinity group that belong to the same site as the index area. An index area that is not assigned to an affinity group can be served only by servers that are not members of an affinity group and belong to the same site as the index area. |
![]() | ICmTextSearchConfiguration |
Represents the configuration information for Content Engine server dispatcher and worker threads,
which control the processing of IBM® Content Search Services content indexing requests. In addition,
CmTextSearchConfiguration object properties can be used to control the configuration of
text filters, which the Content Engine server uses to convert files from binary format to text format.
|
![]() | ICmTextSearchIndex |
Represents an IBM® Content Search Services index, which holds the full-text
indexing information that is created, updated, and searched by an IBM Content Search Services server.
The Content Engine creates IBM Content Search Services indexes automatically as needed within an
IBM Content Search Services index area. Each IBM Content Search Services index can be associated
with only a single IBM Content Search Services index area. An IBM Content Search Services index specifies
its status with the ResourceStatus property. When an index reaches its
full capacity, its status is automatically set to FULL. Within a given object store, you can associate an
IBM Content Search Services index with a date-valued property that acts as a date partition
constraint and a string-valued property that acts as a string partition constraint.
|
![]() | ICmTextSearchIndexArea |
Represents the configuration of an IBM® Content Search Services index area.
An IBM Content Search Services index area holds indexes that are created, updated, and queried by
IBM Content Search Services servers. An IBM Content Search Services index area and the IBM
Content Search Services servers that use it must all belong to the same site. Within each index area,
you can control the number of indexes that can be created and the capacity of each of these indexes.
In addition, you can specify the root directory to use for storing these indexes.
New indexes can only be created in an index area if the ResourceStatus property is set to OPEN. However, indexes in an index area are always searched during a query, regardless of the setting of the ResourceStatus property. If the number of indexes in an index area is equal to the value of the MaxIndexes property, the ResourceStatus property is automatically set to FULL by the Content Engine server. This setting indicates that no more indexes can be created in the index area. Users are not allowed to set the status of an index area to FULL; only the Content Engine server can set this value. If there are no open index areas available, the Content Engine server searches for the an index area having a status of STANDBY and sets it to OPEN. |
![]() | ICmTextSearchIndexRequest |
Represents an index request generated for a text search-enabled object for IBM® Content Search Services.
|
![]() | ICmTextSearchPartitionDateProperty |
Represents a custom, date-valued CBR-enabled object property that is assigned
in an object store to define the interval for date-based partitioning of CBR-enabled objects
in an IBM® Content Search Services index. This property must have a settability of
SETTABLE_ONLY_ON_CREATE. You can have no more than one date index
partitioning property assigned in an object store.
|
![]() | ICmTextSearchPartitionProperty |
Represents the base, abstract class whose instances refer to IBM® Content Search Services index partioning properties
of CBR-enabled objects in an object store. A CBR-enabled object is a Document,
Annotation, CustomObject, or Folder object whose class description’s
IsCBREnabled property has been set to true. A property of a CBR-enabled object
that has been designated as an index partitioning property is used to determine the index in which
to create an index for this object. When partition properties are specified in a text-search query,
only indexes with the same partition property names and values are searched. Therefore, by
configuring index partitioning in an object store, you can decrease the number of indexes that must be
searched as a result of a query, provided that you use index partitioning properties in the query.
Each property of a CBR-enabled object that is assigned as an index partitioning property must be a custom string- or date-valued property with a settability of SETTABLE_ONLY_ON_CREATE. You can have no more than one string and one date index partitioning property assigned in an object store. |
![]() | ICmTextSearchPartitionStringProperty |
Represents a custom, string-valued CBR-enabled object property that is assigned
in an object store to define the string-based partitioning of CBR-enabled objects
in an IBM® Content Search Services index. This property must have a settability of
SETTABLE_ONLY_ON_CREATE. You can have no more than one string index
partitioning property assigned in an object store.
|
![]() | ICmTextSearchServer |
Represents the connection and configuration information for an IBM® Content Search Services server.
An IBM Content Search Services server is associated with a particular site and can be used by any
object store within that site. When you configure an IBM Content Search Services server, you can specify
which tasks it performs (searching, indexing, or both). In addition, you can enable or disable an IBM
Content Search Services server, and determine its connectivity to the Content Engine server.
|
![]() | ICmThreadPoolConfiguration |
Configures the server thread pools for background tasks.
When activated, a background task is assigned an available thread in a pool.
When task execution is completed, the thread is released back to the pool.
There are two types of thread pools: a dispatcher pool to execute tasks at scheduled intervals, and a worker pool to execute nonscheduled tasks. |
![]() | ICmTimeslot |
Defines a schedule for a text indexing, audit disposition, or sweep-job background task.
ICmTimeslot specifies when the task will start and how long it will run.
You create a ICmTimeslot object with a Factory method, and set its weekday, start time, and duration properties. The day and times that you set are interpreted relative to the server's local time, not Coordinated Universal Time (UTC). You add ICmTimeslot objects to a ICmTimeslotList, which you set on a ICmTextSearchConfiguration, ICmAuditingConfiguration, ICmSweep, or ICmSweepConfiguration object. Note that the times of multiple timeslots might overlap, in which case the overlapping timeslots are effectively combined. For more information, see Content-Based Retrieval Concepts, Audit Disposition, Thumbnail Concepts, or Disposal Policy Concepts. |
![]() | ICmTivoliManagementClass |
A management class that represents a specific retention setting for an IBM® Tivoli®
Storage Manager (TSM) server. A TivoliFixedContentDevice class can have one or more
CmTivoliMangementClass classes associated with it (via its TSMManagementClasses property).
Each management class that you create represents a retention scheme type and a retention period that
you can associate with a specific TivoliFixedContentDevice class. Note that if data retention
protection is turned off (controlled via the TSMArchiveProtectionFlag property of a TivoliFixedContentDevice
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:
|
![]() | ICmVerityIndexRequest |
Represents the base class for IBM® Legacy Content Search Engine index requests. Each index request object is associated with a
content element and properties. Index request objects are created by the indexing process, and cannot be created using the API. You can perform
read and update operations on index request objects, and there are properties with status, failure and retry information recorded. Index
request objects are assigned security from the default instance security for this class.
|
![]() | ICodeModule |
Represents a Java action handler to be stored on the Content Engine.
An action handler is a user-implemented interface in the Engine package
of the Content Engine Java API. A handler executes as a server-side extension to the Content Engine
when certain actions are performed.
As an alternative to representing a Java action handler as an ICodeModule object, you could specify the Java action handler in the classpath of your application server. However, it is recommended that you check in an action handler and any supporting libraries as a code module. Code modules are automatically available when deploying the Content Engine to multiple application server instances, or moving your content metadata from one system to another. If you reference action handlers in the classpath of an application server, you must manually distribute the action handlers to new systems. To create an ICodeModule object, call the CreateInstance method on the Factory.CodeModule class, and then set the content elements on the object. A content element can be a Java class or a JAR file. Each content element must have the correct MimeType property value. For content elements containing a Java class, acceptable MIME types are "application/java", "application/java-byte-code", and "application/x-java-class". For content elements containing a JAR file, the MIME type must be "application/java-archive". The content elements that you set on an ICodeModule object must be of type IContentTransfer, not IContentReference. If you attempt to save an ICodeModule object with an IContentReference type, the server will throw an EVENT_CM_CONTENTREFERENCE_NOT_ALLOWED exception. Note If you update an action handler, you must update the ICodeModule object with the new version of the action handler. Then you must update the CodeModule property of any IAction-based subobjects that reference the ICodeModule object that has been updated. For cache configuration considerations, see the applicable code module-related properties in the IServerCacheConfiguration interface. |
![]() | IColumnDefinition |
Represents the description of a column in a Content Engine database table. A ColumnDefinition object describes a column used
by a TableDefinition 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
IContentCacheConfiguration interface.
Document content consists of the content elements associated with documents (as specified by the ContentElements property on the Document object). The cache receives new content in the following circumstances:
In both circumstances, new content can be added to the cache only when its storage capacity (as defined by the MaximumContentElements and MaximumSizeKBytes properties) exceeds the current amount of content (as indicated by the ContentElementCount and ContentElementKBytes properties). Cache content, however, can end up slightly exceeding the designated storage capacity, as statistics are managed on a delayed basis, and multiple servers can be adding content. 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 MaximumTimeToLive property). An old file is a file that, compared to other files in the same directory, has been accessed less recently. Note that these categories are not mutually exclusive; an abandoned file might also be an expired file, and an expired file an old file. 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 DirectoryStructure property. For a detailed discussion on prune action behavior, see the PruneAmount property. Prune actions get triggered in three different ways:
Cache sweeping does not update the count of content element creations (the ContentElementsCreated property) or the count of content element deletions (the ContentElementsDeleted property). These statistics can become inaccurate over time, but can be optionally reset by clearing the cache. For more information on cache clearing, see the CacheStatus property. |
![]() | IContentCacheConfiguration |
Defines the configuration for a content cache. This includes, in particular,
the file storage area for the cache (the ContentCacheArea property).
A cache configuration can be associated with a server or with a group of servers. More specifically, a ContentCacheConfiguration instance can be associated with the following types of objects: ServerInstance, which represents one server; VirtualServer, which represents one or more servers; and Site, which represents a still yet larger grouping of servers and other objects based on a geographic location. (A cache configuration can also be associated with a Domain, but typically you would not want servers in different geographical sites to use the same cache, since the cache must be local to the server to benefit server performance.) On startup, and periodically thereafter, a 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 cache configuration. Referred to as the primary cache, the first cache found becomes the cache for that server. Otherwise, in the absence of any cache configuration, the server does not use a cache. 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, and 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 is 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 might be 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 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 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. It also guarantees 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 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 DirectoryConfiguration object is used to configure the directory service providers
that are used for authorization checks within the servers.
You can create one or more DirectoryConfiguration objects for each FileNet P8 domain. For example, if you have two Active Directory forests to be accessed by the FileNet P8 domain, you must create two Active Directory-specific DirectoryConfiguration objects--one for each forest. To create an instance of the DirectoryConfiguration class, call the type-specific CreateInstance factory method. For example, to create an instance of an Active Directory configuration object, call Factory.DirectoryConfigurationAD.CreateInstance(). |
![]() | 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 DirectoryConfiguration objects--one for each forest.
To create an instance of the DirectoryConfigurationAD class, call
Factory.DirectoryConfigurationAD.CreateInstance(). The group of type-specific directory configuration
objects is contained in the DirectoryConfigurationADList collection object.
The Active Directory security provider supports the following high-availability failover features: failover by virtual IP, failover by host list, and failover by domain-name or multiple IP addresses. |
![]() | 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 Realm object and a DirectoryConfigurationAdam object. Therefore,
you must create one DirectoryConfigurationAdam object
for each authentication provider in each realm.
To create an instance of the DirectoryConfigurationAdam class, call
Factory.DirectoryConfigurationAdam.CreateInstance(). The group of type-specific
directory configuration
objects is contained in the DirectoryConfigurationAdamList collection object.
|
![]() | IDirectoryConfigurationCA |
Represents the configuration object for a CA (Computer Associates International Inc.) eTrust security provider.
Each P8 realm requires a configuration object of this type. For example, when CA eTrust
is the security provider, you must configure a DirectoryConfigurationCA object for each P8 realm.
To create an instance of the DirectoryConfigurationCA class, call Factory.DirectoryConfigurationCA.CreateInstance(). The CA eTrust directory service provider supports searching of static, dynamic, and hybrid groups. Members of a static group might change infrequently whereas the members of a dynamic group might change often. Hybrid groups allow use of features of both dynamic and static groups. The CA eTrust directory service provider also supports configurable Content Engine Group.Id and User.Id properties. You can set LDAP attributes that will be used as the values for these properties. |
![]() | 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 Realm object and a DirectoryConfigurationIBM object. Therefore, you must create one
DirectoryConfigurationIBM object for each authentication provider in each realm.
To create an instance of the DirectoryConfigurationIBM class, call
Factory.DirectoryConfigurationIBM.CreateInstance(). The group of type-specific directory configuration
objects is contained in the DirectoryConfigurationIBMList collection object.
The IBM Tivoli security provider supports the following high-availability failover features: failover by virtual IP, failover by host list, and failover by multiple IP addresses. |
![]() | 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 Realm object and a DirectoryConfigurationNovell object. Therefore, you must create one
DirectoryConfigurationNovell object for each authentication provider in each realm.
To create an instance of the DirectoryConfigurationNovell class, call
Factory.DirectoryConfigurationNovell.CreateInstance(). The group of type-specific directory configuration
objects is contained in the DirectoryConfigurationNovellList collection object.
|
![]() | IDirectoryConfigurationSunOne |
Represents the configuration object for a Oracle (formerly SunOne) security provider.
A Oracle 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 Realm object and a DirectoryConfigurationSunOne object. Therefore, you must create one
DirectoryConfigurationSunOne object for each authentication provider in each realm.
To create an instance of the DirectoryConfigurationSunOne class, call
Factory.DirectoryConfigurationSunOne.CreateInstance(). The group of type-specific directory configuration
objects is contained in the DirectoryConfigurationSunOneList 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 Document 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 ClassDescription property.
|
![]() | IDocumentClassificationQueueItem |
Represents a pending (queued) document auto-classification request. The QueuedObject 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 IEventClassDefinition object,
call the getInstance or fetchInstance method on the
Factory.EventClassDefinition class.
To use IEventClassDefinition in a subscription or for
auditing, set the EventClass property on a
ISubscribedEvent or
IAuditDefinition object, respectively.
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 ClassDescription property. |
![]() | 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 IEventQueueItem interface includes properties for setting and retrieving
the source object and event of the pending event action.
To instantiate a IEventQueueItem object, call the getInstance or fetchInstance method on the Factory.EventQueueItem class. |
![]() | 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 GenericFixedContentDevice
object provides an extensible mechanism for implementing interfaces to fixed content devices not currently
supported by IBM®. 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.
|
![]() | 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
ICFSImportAgentConfiguration 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 FederationUpdateHasPriority property. |
![]() | 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 ImageServicesSiteSettings
object contains a property that, if populated, will override the corresponding property of the same name
on the IMFixedContentDevice 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. You can configure two types of index areas, one for each type of content search engine:
|
![]() | IIndexJob |
Initiates and tracks the status of a full-text indexing operation. An IndexJob object 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:
Although currently indexed data is available while indexing is in progress, some queries will get duplicate matches from full-text searches because of matches in both the old and the new index data. Once the index job operation completes, old copies of the data are removed and duplicate matches will no longer occur. If a base class is indexed or a full-text index is reindexed, and that index job is canceled (or terminates abnormally), indexing data for some objects will exist in two text indexes. The reason is because this type of index job does not delete the original index items until after the entire index job has completed successfully. To remove the duplicate index items, resubmit the index job for the base class or the full-text index. Note that if a single item index job or a non-base class index job is canceled, no duplicate index items will be created because these types of index jobs continuously delete individual index items from the indexes. Most index jobs sweep the database to find classes and indexes to be indexed. This sweep requires a table scan in the database (which can take a large amount of time for a large table), even if the amount of data to be indexed is minimal. Database table scans are performed once for all classes to be indexed in a table, and once for all indexes to be indexed in a table. Therefore, to minimize the number of table scans required, IBM recommends you put all classes and indexes to be indexed that are in the same table into a single index job operation. |
![]() | IIndexJobClassItem |
Identifies the class to be full-text indexed. When a property or class is enabled for indexing (CBR-enabled), objects associated with that newly
enabled property or class need to be indexed. Conversely, when a property or class is disabled for indexing, objects associated with that newly
disabled property or class need to be removed from existing indexes. The specified class can be any base class
(such as, Document or Folder), or any of its subclasses, that support indexing. All instances of the specified class are indexed.
Warning Do not change the CBREnabled status of a class or property while an IndexJob operation is running on that class. Doing so can cause unpredictable results. Instead, stop any index job running on a class before changing the configuration, then resubmit the index job for that class. If the class selected to index is a base class (Versionable, Document, Annotation, Folder, or CustomObject), the server creates CmTextSearchIndex objects to hold the new indexing information. When the indexing operation completes, the server deletes the existing IBM® Content Search Services indexes that previously held the indexing information. When indexing information is deleted, the server deletes all relevant indexes rather than deleting indexes on a per-object basis. Therefore, indexing a base class is faster than indexing a subclass of the base class. Note For indexing purposes, the Document class is also considered to be a base class, because the Document class is the only subclass of the Versionable class and no instances of the Versionable class can be created. |
![]() | IIndexJobCollectionItem |
Identifies an IBM® Content Search Services index to be full-text indexed. If the indexing data for one
or more indexes becomes corrupted or lost (due to a storage device failure), the index must
be reindexed. The reindexing operation deletes the current indexing data and creates new full-text index data to replace it.
Warning Do not use indexing to address a change in the IsCBREnabled property status on a class or property definition. Only the existing data in the index or collection is submitted to be indexed (even if all the indexes of an object store are selected). Any classes that are newly enabled or disabled for indexing will not be reindexed because instances of these classes might not be in the existing indexes. |
![]() | 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 Document or Annotation object), or some aspect of the configuration
needs to be changed, the affected item can be reindexed by using a single-item index job.
This operation attempts to reindex an object whose class is CBR-enabled and attempts to delete an
object from any existing indexes whose class is not CBR-enabled.
|
![]() | IIsolatedRegion |
Contains the connection information necessary to access the isolated region of a workflow system.
This information is persisted in the GCD (Global Configuration Database).
An isolated region represents a logical subdivision of a workflow system. Each isolated region is referenced by one or more connection points (IPEConnectionPoint instances). The set of isolated regions defined is reflected in the IsolatedRegions property on the IDomain or IObjectStore. An isolated region and object store used by IBM Case Manager must use the same database connection. An isolated region can use a legacy workflow system. |
![]() | 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 LocalizedString object by calling the CreateInstance method on the Factory.LocalizedString class. |
![]() | IPEConnectionPoint |
Routes Process Engine requests to an isolated region (IIsolatedRegion instance). This information is persisted in the GCD
(Global Configuration Database). Multiple IPEConnectionPoint instances can reference the same isolated region.
The IPEConnectionPoint 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 IDomain.PEConnectionPoints 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,
PropertyDefinitionBinary defines a property that returns a binary value,
PropertyDefinitionBoolean defines a property that returns a Boolean value, and so on).
When a property definition is added to a class definition's PropertyDefinitions collection,
a user-defined property is added to that class.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyDefinitionBinary |
Represents the definition of a property that holds a binary value. A PropertyDefinitionBinary object
is created from a PropertyTemplateBinary object and contains mutable property metadata that you can customize.
When a PropertyDefinitionBinary object is added to a class definition's
PropertyDefinitions collection, a user-defined property is created in that class.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyDefinitionBoolean |
Represents the definition of a property that holds a Boolean value. A PropertyDefinitionBoolean object
is created from a PropertyTemplateBoolean object and contains mutable property metadata that you can customize.
When a PropertyDefinitionBoolean object is added to a class definition's
PropertyDefinitions collection, a user-defined property is created in that class.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyDefinitionDateTime |
Represents the definition of a property that holds a DateTime value. A PropertyDefinitionDateTime object
is created from a PropertyTemplateDateTime object and contains mutable property metadata that you can customize.
When a PropertyDefinitionDateTime object is added to a class definition's
PropertyDefinitions collection, a user-defined property is created in that class.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyDefinitionFloat64 |
Represents the definition of a property that holds a Double (Float64) value. A PropertyDefinitionFloat64 object
is created from a PropertyTemplateFloat64 object and contains mutable property metadata that you can customize.
When a PropertyDefinitionFloat64 object is added to a class definition's
PropertyDefinitions collection, a user-defined property is created in that class.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyDefinitionId |
Represents the definition of a property that holds a GUID string value. A PropertyDefinitionId object
is created from a PropertyTemplateId object and contains mutable property metadata that you can customize.
When a PropertyDefinitionId object is added to a class definition's
PropertyDefinitions collection, a user-defined property is created in that class.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyDefinitionInteger32 |
Represents the definition of a property that holds an integer value. A PropertyDefinitionInteger32 object
is created from a PropertyTemplateInteger32 object and contains mutable property metadata that you can customize.
When a PropertyDefinitionInteger32 object is added to a class definition's
PropertyDefinitions collection, a user-defined property is created in that class.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyDefinitionObject |
Represents the definition of a property that holds a Content Engine object value. A PropertyDefinitionObject object
is created from a PropertyTemplateObject object and contains mutable metadata that you can customize.
When you add a PropertyDefinitionObject object to a class definition's PropertyDefinitions collection,
a user-defined (custom), object-valued property is created on that class.
The value of a custom, object-valued property can be one of the following types of objects:
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyDefinitionString |
Represents the definition of a property that holds a string value. A PropertyDefinitionString object
is created from a PropertyTemplateString object and contains mutable property metadata that you can customize.
When a PropertyDefinitionString object is added to a class definition's
PropertyDefinitions collection, a user-defined property is created in that class.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | 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.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyTemplateBinary |
Represents a property template for creating PropertyDefinitionBinary 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.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyTemplateBoolean |
Represents a property template for creating PropertyDefinitionBoolean 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.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyTemplateDateTime |
Represents a property template for creating PropertyDefinitionDateTime 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.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyTemplateFloat64 |
Represents a property template for creating PropertyDefinitionFloat64 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.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyTemplateId |
Represents a property template for creating PropertyDefinitionId 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.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyTemplateInteger32 |
Represents a property template for creating PropertyDefinitionInteger32 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.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyTemplateObject |
Represents a property template for creating PropertyDefinitionObject 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.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPropertyTemplateString |
Represents a property template for creating PropertyDefinitionString 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.
Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties. |
![]() | IPublishingConfiguration |
References the configuration data for a publishing operation. This class allows administrative clients
to set or access publishing-related configuration settings. A PublishingConfiguration
object can be assigned to objects of the server hierarchy (Domain, Site,
VirtualServer, and ServerInstance), 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 IQueueItem, but you can call GetInstance or FetchInstance on Factory.QueueItem to retrieve an instance of this subclassable class. |
![]() | 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 the configuration settings for the replication components of a server.
The properties of this object allow you to control how inbound and outbound
replication is processed on the server.
Inbound replication occurs when an object is replicated from an external
repository to a Content Engine object store. Outbound replication occurs when an
object is replicated from a Content Engine object store to an external repository.
|
![]() | 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 ISecurityPropagationQueueItem, but you can retrieve a persisted object by calling FetchInstance or GetInstance on Factory.SecurityPropagationQueueItem. |
![]() | 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 ServerCacheConfiguration object is contained in the SubsystemConfigurationList property of the server hierarchy objects (Domain, Site, Virtual Server, and ServerInstance). To access a ServerCacheConfiguration object, call Get_SubsystemConfigurations to retrieve the SubsystemConfigurationList from the "host" independent object, then iterate the returned list. To create a new instance, call Factory.ServerCacheConfiguration.CreateInstance and add the new object to the SubsystemConfigurationList of the appropriate server hierarchy object. (Note: The SubsystemConfigurationList of the Domain object cannot be modified. To update its ServerCacheConfiguration object, locate the pre-existing object in the list and update it.) The created object is a dependent object and is only persisted when its parent object (the independently persistable object that references it) is persisted. The ServerCacheConfiguration object is associated with a Domain, Site, Virtual Server, or ServerInstance object. The values of the cache configuration properties are used while the FileNet P8 system is running and override the default values defined at installation time. |
![]() | 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.
ServerInstance objects are created dynamically during system initialization and startup based on the configured topology of the application server or via specific system properties. They cannot be created via the API. You can retrieve a persisted ServerInstance object by calling GetInstance or FetchInstance on the Factory.ServerInstance class. |
![]() | 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 Site 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 Site class, called Initial Site, is created and referenced by the Domain.DefaultSite property. As Virtual Servers, Server Instances, and resources (object stores, storage areas, etc.) are added to the domain, they are assigned to the DefaultSite, unless a different site is explicitly specified. A user with system administrator privileges can change the Domain.DefaultSite to a different default site, if desired. 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 Factory.Site.CreateInstance. |
![]() | 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
SiteSettings 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
concrete subclasses. A FixedStorageArea object is associated with a
FixedContentDevice object when it is created. A ICmAdvancedStorageArea object
is associated with one or a combination of ICmFileSystemStorageDevice and
ICmOpenStackStorageDevice objects.
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. |
![]() | IStoragePolicy |
Represents a subset of available storage areas that are deemed equivalent based on common,
user-specified criteria. If a Document or Annotation object is set
to use this StoragePolicy, 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. SubscribableClassDefinition objects hold the class definitions for all subclasses
of the Subscribable class except for the Document class and its subclasses,
whose class definitions are held by DocumentClassDefinition 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 ClassDescription 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 (Domain, Site, VirtualServer, and ServerInstance) are represented as a collection of dependent objects (SubsystemConfigurationList). To access a SubsystemConfiguration object, retrieve the SubsystemConfigurations property from the "host" independent object. |
![]() | ITableDefinition | Represents the description of a Content Engine database table. All the tables used by the Content Engine database have
corresponding TableDefinition objects that are accessible using the TableDefinitions property of an ObjectStore object.
You can also access a TableDefinition object as follows:
|
![]() | ITivoliFixedContentDevice |
Represents the description of an IBM® Tivoli® Storage Manager (TSM) server fixed content device.
TSM servers provide automated, policy-based storage management services to clients and support
a wide variety of hardware mass storage devices that can be used as the fixed content system in
support of a P8 fixed storage area. Included in this support is IBM System Storage™ DR550,
which 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 TraceFlag constant class contains the
trace log settings available. These settings can be ORed together to apply multiple settings to a subsystem. The
TraceLoggingEnabled property on this (TraceLoggingConfiguration)
class enables or disables trace logging for all of the configured subsystems. Use the AppenderNames 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 UpgradeAddOn object
has the following characteristics:
|
![]() | IVerityCollection |
Identifies the full-text indexing information used for a particular base class and all of its subclasses. A VerityCollection
is associated with only one index area, and the full-text indexing information is stored in a file system directory identified by the
RootDirectoryPath property of a VerityIndexArea object.
For each VerityCollection object in the Content Engine database, there is a corresponding collection maintained by the Verity software that holds the full-text index data. The name of this collection is identified by the CollectionName property. VerityCollection objects are automatically created by the server when needed, and do not need to be created by a client application. When full-text indexing is available, and the first instance of a class is created or modified, the server looks for an existing VerityCollection object associated with the appropriate base class, and uses this VerityCollection object. If a VerityCollection object is not found, a new VerityCollection object is created, along with the corresponding collection maintained by the Verity software. An application can set the ResourceStatus property to CLOSED. if a problem occurs with writing data to a particular VerityCollection object, or to UNAVAILABLE if the collection is expected to be made available again. The ResourceStatus property is set to FULL by the server when the number of rows in the collection is greater than the value of the VerityServerConfiguration.MaxRowsPerCollection property (no new data will be written to the collection). Whenever a collection is needed for writing full-text information, the collection is selected from the list of eligible open collections. If no open collection exists, then a collection with a status of STANDBY is selected, and that collection’s status is changed to OPEN. 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 VerityCollection object must be deleted. Note Beginning in the 5.1.0 release, the Legacy Content Search Engine is deprecated and support will be removed in a future release. |
![]() | IVerityDomainConfiguration |
Contains the Verity configuration properties that are common to all servers in a domain. Only one
VerityDomainConfiguration object can exist per domain (attempts to create multiple instances
of a VerityDomainConfiguration object will throw an exception). The
Factory.VerityDomainConfiguration.FetchInstance method does not require an Id to fetch the
VerityDomainConfiguration object.
The only two properties that must be set in VerityDomainConfiguration for full text indexing to be operational are the VerityAdminMasterServerPort and VerityAdminMasterServerHostname properties. The UserName, UserPassword, UserDomain, and UserGroup properties must all be set if security is to be enabled. The VerityServerConfiguration object contains Verity configuration properties that can be different for each server in the domain. Note Beginning in the 5.1.0 release, the Legacy Content Search Engine is deprecated and support will be removed in a future release. |
![]() | IVerityIndexArea |
Represents the configuration of an IBM® Legacy Content Search Engine index area.
An IBM Legacy Content Search Engine index area holds indexes that are created, updated, and queried by
Verity servers. Within each index area, you can control the number of indexes that can be created and
the capacity of each of these indexes. In addition, you can specify the root directory to use for storing these indexes.
The CBRLocale property of the object store must be set before creating an instance of this class.
New Verity collections can only be created in an index area if the ResourceStatus property is set to OPEN. However, Verity collections in an index area are always searched during a query, regardless of the setting of the ResourceStatus property. If the number of Verity collections in an index area is equal to the value of the MaxCollections property, the ResourceStatus property is automatically set to FULL by the Content Engine server. This setting indicates that no more Verity collections can be created in the index area. Users are not allowed to set the status of an index area to FULL; only the Content Engine server can set this value. If there are no open index areas available, the Content Engine server searches for the an index area having a status of STANDBY and sets it to OPEN. Note Beginning in the 5.1.0 release, the Legacy Content Search Engine is deprecated and support will be removed in a future release. |
![]() | IVerityServerConfiguration |
Contains the Verity configuration data (properties) for a server instance. This configuration data can differ from one server to the next.
A VerityServerConfiguration object is contained in the SubsystemsConfiguration property of Domain,
Site, VirtualServer, and ServerInstance objects. The VerityServerConfiguration object used is the first
occurrence found by searching (in this order) the ServerInstance instance, the VirtualServer instance, the Site
instance, and the Domain 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. Note Beginning in the 5.1.0 release, the Legacy Content Search Engine is deprecated and support will be removed in a future release. |
![]() | IVersionableClassDefinition |
Represents the parent of the DocumentClassDefinition class, which holds the class definition of a
Document 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 VirtualServer, rather than interacting with a specific
ServerInstance. If a VirtualServer consists of a single ServerInstance, then the two are functionally
equivalent. If a VirtualServer consists of multiple server instances, then client requests are distributed
between each individual ServerInstance, providing scalability and high availability. Clients are not aware
of which ServerInstance actually fulfilled their request.
When multiple server instances are configured to run as a VirtualServer, a third-party (non-FileNet) load balancing mechanism must exist if you want to distribute incoming requests among the server instances. This could be a Java™ Platform Enterprise Edition (Java EE) application server's clustering implementation, or it could be an external hardware or software load balancing product. In either case, an administrator, using the third-party's load balancing configuration tools, is responsible for configuring the load balancing for a VirtualServer. VirtualServer objects are created dynamically during system initialization and startup based on the configured topology of the application server or via specific system properties. They cannot be created via the API. You can retrieve a persisted VirtualServer object by calling GetInstance or FetchInstance on the Factory.VirtualServer class. |
![]() | IXMLPropertyMappingScript |
Represents the definition of a Document 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 XMLPropertyMappingScript object, in addition to having all of the capabilities of a Document 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 XMLDocumentType property in order to map it onto property values for the properties associated
with the target document class identified by the TargetClass property.
|