Each type of asset in the object store has its own specific capabilities and limitations that you must consider when deploying it.
| Description | Defines a link between a document or other object and more
information. An annotation object can be deployed with its parent
object. An annotation object can annotate any containable object, such as a document, a folder, or a custom object. |
|---|---|
| Deployment Mechanism | FileNet® Deployment Manager: |
| Dependencies |
See also Common dependencies between objects. |
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes® | None |
| Description | Auditing is the process of capturing specific content information
when a specific event occurs and storing the captured results in the
audit log. An audit definition is a group of certain class properties that define the criteria by which content that belongs to that class is audited. |
|---|---|
| Deployment Mechanism | FileNet P8 does not have a tool that deploys auditing-related objects. Therefore, you must manually add auditing-related objects into the destination environment. |
| Dependencies | Deployment of an audit log entry does not have any dependencies. |
| Environment-specific data | Deployment of an audit log entry does not have any environment-specific requirements. |
| Notes | None |
| Description | Auditing is the process of capturing specific content information
when a specific event occurs and storing the captured results in the
audit log. The CmAuditDispositionPolicy object is one component of the audit disposition process, which identifies and deletes entries in the audit log that are ready for deletion The CmAuditDispositionPolicy object works with the CmAuditingConfiguration object and the CmAuditProcessingBookmark object to identify and delete record from the audit log. |
|---|---|
| Deployment Mechanism | FileNet P8 does not have a tool that deploys auditing-related objects. Therefore, you must manually add auditing-related objects into the destination environment. |
| Dependencies | Deployment of an audit log entry does not have any dependencies. |
| Environment-specific data | Deployment of an audit log entry does not have any environment-specific requirements. |
| Notes | None |
| Description | Auditing is the process of capturing specific content information
when a specific event occurs and storing the captured results in the
audit log. An audit log entry is the record of a specific audit, which is stored in the Audit Event table. |
|---|---|
| Deployment Mechanism | FileNet P8 does not have a tool that deploys auditing-related objects. Therefore, you must manually add auditing-related objects into the destination environment. |
| Dependencies | Deployment of an audit log entry does not have any dependencies. |
| Environment-specific data | Deployment of an audit log entry does not have any environment-specific requirements. |
| Notes | Audit log entries cannot be imported in to another object store.
However, you can export these entries for use with a third-party reporting
tool. To export audit log entries, use the query builder in FileNet Deployment Manager. The query builder provides a saved search, ExportEventsForObjects, that adds the audit log entries to the export manifest. When you create the export files, FileNet Deployment Manager places the audit log entries in the Group 7 XML files. |
| Description | Auditing is the process of capturing specific content information
when a specific event occurs and storing the captured results in the
audit log. The CmAuditProcessingBookmark object is one component of the audit disposition process, which identifies and deletes entries in the audit log that are ready for deletion. The CmAuditProcessingBookmark object works with the CmAuditingConfiguration object and the CmAuditDispositionPolicy object to identify and delete records from the audit log. Specifically, the CmAuditProcessingBookmark object records information at the end of the audit disposition sweep process so that the next audit disposition sweep process can identify eligible records. |
|---|---|
| Deployment Mechanism | FileNet P8 does not have a tool that deploys auditing-related objects. Therefore, you must manually add auditing-related objects into the destination environment. |
| Dependencies | Deployment of an audit log entry does not have any dependencies. |
| Environment-specific data | Deployment of an audit log entry does not have any environment-specific requirements. |
| Notes | None |
| Description | Change preprocessor actions are objects that reference and
describe server-side, user-implemented action handlers that can modify
new or updated source objects before they are persisted to the Content Platform Engine database. The action is set on the ChangePreprocessorAction property of a ChangePreprocessorDefinition object, which is contained in the ChangePreprocessorDefinitions multi-valued property of a class definition. That is, you associate a change preprocessor handler with a class definition. When a client saves an object of that class, the associated handler is triggered. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | Deployment of a change preprocessor action has the following
dependencies:
|
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | Use a code module for referencing change preprocessor actions instead of Java classes that are referenced from the Java virtual machine class path for the application server. If the change preprocessor action references a code module, the change preprocessor action handler code is exported and imported with the change preprocessor action. Using a code module reduces the risk of the change preprocessor action handler code not being available in the destination environment at run time. |
| Description | A choice list is a collection of predefined property values
that can be used to present users with a list of values from which
to choose. A choice list element is a single item within a choice list. A choice list element is a part of its parent choice list and cannot be retrieved, saved, or deployed independently. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | See Common dependencies between objects. |
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | None |
| Description | A class definition contains the mutable class metadata for
a Content Platform Engine class that
can be modified by a client application. A property definition is a collection of mutable metadata that originates from a property template. Each property definition is associated with a specific class definition and represents a property that belongs to the object instance of a class. A property definition is dependent on the containing class definition, and cannot be independently exported or imported. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | PropertyDefinition:
PropertyDefinitionObject:
ClassDefinition:
See also Common dependencies between objects. |
| Environment-specific data | Any object that is exported from an object store contains a
set of basic permissions that controls access to that object. These
permissions contain environment-specific information that identifies
users and groups. For more information, see Permission. ClassDefinition:
|
| Notes | If you import a class definition that has the same ID as an existing class definition in the destination environment, the existing class definitions are updated to include any new property definitions. |
| Description | Contains a Java event
handler that is implemented for your application. This event handler
starts when events are raised for an action-based object. The event handler, which can be a Java class or JAR file, must exist on the Content Platform Engine. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | See Common dependencies between objects. |
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes |
|
| Description | IBM® Content
Search Services is a Content Search Engine that both reads and writes
object index information so that searches can be based on:
The CmTextSearchIndex (IBM Content Search Services index) object contains the full-text indexing information that is created, updated, and searched by an IBM Content Search Services server. Content Platform Engine creates CmTextSearchIndex (IBM Content Search Services index) objects 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. |
|---|---|
| Deployment Mechanism | FileNet P8 does not have a tool that deploys IBM Content Search Services objects. Importing converted objects(IBM Content Search Services indexes are created automatically.) |
| Dependencies | Deployment of an IBM Content
Search Services index
object is dependent upon the following objects:
|
| Environment-specific data | Deployment of an IBM Content Search Services index object is not dependent upon any environment-specific data. |
| Notes | None |
| Description | IBM Content
Search Services is a Content Search Engine that both reads and writes
object index information so that searches can be based on:
The CmTextSearchIndexArea (search server index area) object contains the configuration information for an IBM Content Search Services index area, which stores 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. |
|---|---|
| Deployment Mechanism | FileNet P8 does not have a tool that deploys IBM Content Search Services objects. Therefore, you must manually add IBM Content Search Services objects into the destination environment. Importing converted objects |
| Dependencies | Deployment of an IBM Content Search Services index area object is not dependent upon any other objects. |
| Environment-specific data | An IBM Content
Search Services index
object has the following environment-specific data.
|
| Notes | An IBM Content Search Services server must be configured on the destination system before you can deploy an IBM Content Search Services index area. |
| Description | IBM Content
Search Services is a Content Search Engine that both reads and writes
object index information so that searches can be based on:
The CmTextSearchPartitionProperty (IBM Content Search Services index partition) object represents the base, abstract class whose instances see IBM Content Search Services index partitioning properties of CBR-enabled objects in an object store. A CBR-enabled object is a document, annotation, custom object, or folder object whose class description IsCBREnabled property is set to true. A property of a CBR-enabled object that is designated as an index partitioning property is used to determine the index in which to create an index for this object. |
|---|---|
| Deployment Mechanism | FileNet P8 does not have a tool that deploys IBM Content Search Services objects. Therefore, you must manually add IBM Content Search Services objects into the destination environment. Importing converted objects |
| Dependencies | Deployment of a search IBM Content Search Services index partition property object is not dependent upon any other objects. |
| Environment-specific data | Deployment of a search IBM Content Search Services index partition property object is not dependent upon any environment-specific data. |
| Notes | You can have no more than one string (CmTextSearchPartitionStringProperty) and one date (CmTextSearchPartitionDateProperty) index partitioning property that is assigned in an object store. |
| Description | IBM Content
Search Services is a Content Search Engine that both reads and writes
object index information so that searches can be based on:
The CmIndexPartitionConstraint (IBM Content Search Services index partition implementation) object represents an index partition implementation that is associated with an IBM Content Search Services index. |
|---|---|
| Deployment Mechanism | FileNet P8 does not have a tool that deploys IBM Content Search Services indexes partition implementation objects. IBM Content Search Services indexes partition implementation objects are created automatically in the IBM Content Search Services index.Importing converted objects |
| Dependencies | Deployment of an IBM Content Search Services index partition constraint object is not dependent upon any other objects. |
| Environment-specific data | Deployment of an IBM Content Search Services index partition constraint object is not dependent upon any environment-specific data. |
| Notes | Each CmTextSearchIndex (IBM Content
Search Services index) object, maintains
a list of zero to two CmIndexPartitionConstraint objects as its IndexPartitionConstraints property. This list is read-only and is maintained by the Content Platform Engine server. Each CmIndexPartitionConstraint object corresponds to an index partitioning property that associated with an object store. An index partitioning property is represented by a CmTextSearchPartitionProperty object. |
| Description | Represents the creation and modification information that is
contained in the following system properties for all independently
persistable objects in the Content Platform Engine:
These properties provide tracking and historical information for use in specific queries and by applications that are built on the FileNet P8 Platform. The properties are not objects; they are property values on other objects. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | None |
| Environment-specific data | The Creator and Last modifier values are strings that contain the LDAP principal short name of a user. |
| Notes | These property values are exported automatically with their
containing objects. To retain the values when you import these properties, select the Use Original Create/Update Timestamps and Users option in the import operation. If you do not select this option, the properties are assigned values as if the object is newly created. For more information, see Import converted objects. Restriction: You must have Modify
certain system properties permission for the destination object
store to set these system properties on import.
FileNet Deployment Manager does not update the short name values for the Creator and Last modifier properties when you convert objects for import. Because these properties provide historical information, updating the values for the destination environment is not appropriate. The property values do not affect the behavior of your application even if they identify short names that are not in the destination LDAP repository. |
| Description | Provides a general-purpose object that you can customize by applying the subclassing process and adding properties to complete a wide variety of tasks. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies |
|
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | Custom objects are not dependent on folders that contain them. If you import a custom object without importing its containing folder, you can run a search to locate the object in the destination environment. |
| Description | Represents a single version of a user document and contains the information that Content Platform Engine uses to identify and find that document. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies |
See also Common dependencies between objects. |
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | A Document object represents a specific version of a document.
Each Document object is associated with the other versions of the
same document by a version series ID. To retain this ID when you import
a Document object, select the Import Object
ID option, described in Import
converted objects. When you import a Document object, it is assigned the next appropriate major and minor version number. The major and minor version numbers from the source system are not retained. Therefore, be sure to import the document versions in order from oldest to newest. Any gaps in version number sequence in the source system are removed when the versions are imported. A Document object is not dependent on the containing folder. If you import a Document object without its containing folder, you can run a search to locate the document in the destination environment. You can also find the document in the Unfiled Documents folder in the Content Platform Engine administration console. |
| Description | Represents an action that the system performs when a document moves from one state to another. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | Deployment of a document lifecycle action has the following
dependencies:
|
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | Instead of using Java classes that are referenced from the Java virtual machine class path for the application server, have lifecycle event actions reference a code module. If the lifecycle event action references a code module, the event action code is exported and imported with the event action. Using the event action ensures that the event action code is available in the destination environment at run time. |
| Description | Defines the states of a document and identifies the lifecycle action that starts in response to state changes. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | The lifecycle action that is referenced by the DocumentLifecycleAction property |
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | None |
| Description | Represents a code procedure that your application implements as a Java class, which is based on the EventActionHandler interface. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | Deployment of an event action has the following dependencies:
|
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | Have event actions reference a code module rather than using Java classes that are referenced from the Java virtual machine class path for the application server. If the event action references a code module, the event action code is exported and imported with the event action. Using the event action ensures that the event action code is available in the destination environment at run time. |
| Description | Represents an event action occurrence that is queued for asynchronous processing by the Content Platform Engine |
|---|---|
| Deployment Mechanism | None |
| Dependencies | None |
| Environment-specific data | None |
| Notes | Event queue items are short-lived objects that are intended for processing in the FileNet P8 system in which they are created. Deployment of these objects is not recommended. |
| Description | Associates an event action with one or more events and identifies the object on which these events can be triggered. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies |
|
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | None |
| Description | Provides a container for document content in a hierarchy of folders on a local or shared network drive that is accessible by the Content Platform Engine server |
|---|---|
| Deployment Mechanism | There is no automated mechanism for exporting and importing file stores. Instead, you must re-create the file store objects in the destination environment. |
| Dependencies | Not applicable |
| Environment-specific data | Not applicable |
| Notes | None |
| Description | Provides a container for other folders and for references to documents, folders and custom objects |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies |
|
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | You implement a folder hierarchy by having each folder object
reference its parent folder by ID. The full path of the folder is
not saved with a folder nor is the path that is exported with the
folder object. FileNet Deployment Manager uses the ID, not the path, to identify the parent folder in which to place an imported folder. Therefore, you must ensure that the parent folder has the same ID in the destination environment as it did in the source environment. |
| Description | Represents the disk storage location and data necessary to
run full-text indexing for content retrieval. An IndexArea object contains the path name of a file system directory that is used to store the files for the collection. |
|---|---|
| Deployment Mechanism | There is no automated mechanism for exporting and importing an index area. Instead, you must re-create the index area in the destination environment. |
| Dependencies | Not applicable |
| Environment-specific data | Not applicable |
| Notes | None |
| Description | Represents a relationship between 2 objects. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies |
|
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | None |
| Description | Includes access control lists, owner information, and permission
lists. Permissions collections are not stand-alone objects that can be deployed separately. They are contained within other objects and must be deployed with those objects. In general, any object that you can add to the export 0.manifest in FileNet Deployment Manager contains a set of permissions. These permissions, which control access to that object, are contained in the Permissions property and the Owner property. Some objects have more permission collections that are used for other purposes, for example:
|
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | None |
| Environment-specific data | The options that you set in FileNet Deployment
Manager determine the export
and import of the basic set of permissions for independently securable
objects. The additional permission information that some objects have
is always exported and imported. Permissions contain environment-specific information that identifies users and groups. If the source and destination environment use different LDAP repositories and you export the permissions, the user and group information must be updated before you import the objects. Use FileNet Deployment Manager to convert the information as required. |
| Notes | None |
| Description | Provides a reusable template that is used to add a custom property to any number of classes |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | The choice list that is referenced by the ChoiceList property,
if that property is not null. A class definition does not import successfully unless the destination object store contains all the property templates and choice lists that are referenced by its property definitions. |
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | The property template must exist in the destination object store before you import any class definition that references the template. |
| Description | Represents a publishing operation that is queued for asynchronous processing by Content Platform Engine. |
|---|---|
| Deployment Mechanism | Not applicable Importing converted objects |
| Dependencies | Not applicable |
| Environment-specific data | Not applicable |
| Notes | Publishing queue items are short-lived objects that are intended for processing in the environment in which they are created. Therefore, these objects typically are not deployed. |
| Description | Provides two pointers, one of which points to a particular folder while the other points to a document, custom object, or folder. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies |
|
| Environment-specific data | Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | An object, such as a document or a custom object, that is referentially
contained in a folder is associated with that folder by the folder
ID rather than the folder name or path. If there the destination environment does not contain a folder with the correct ID, the Referential Containment Relationship import fails. However, the contained object is still imported although it is not filed in the folder. To locate the object, use the object ID to search for it. |
| Description | A security policy serves as a collection of security templates, each of which contains a predefined list of permissions, or Access Control Entries (ACEs), that can be configured to apply to a document, custom object, or folder. |
|---|---|
| Deployment Mechanism | FileNet Deployment Manager: |
| Dependencies | See Common dependencies between objects. |
| Environment-specific data | The TemplatePermissions property of the security template contains
permissions that must be updated for the destination environment. Any object that is exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information that identifies users and groups. For more information, see Permission. |
| Notes | Important: During an export and import of an object
that contains security template ACEs from a security policy, FileNet Deployment
Manager removes the security
template ACEs. If the security template ACEs that are removed are
Deny ACEs, access can be granted unintentionally to users or groups
that were previously denied access.
|
| Description | Represents an area in which the files that represent the content elements of document and annotation objects are stored. There are three types of storage areas: file storage areas, fixed storage areas, and database storage areas. |
|---|---|
| Deployment Mechanism | There is no automated export and import of storage areas. Instead, you must re-create the storage areas in the destination environment, and then link the new storage information to the imported document classes. |
| Dependencies | Not applicable |
| Environment-specific data | Not applicable |
| Notes | Although you cannot export and import these objects, FileNet Deployment Manager provides a storage area data map. Use the data map to replace references to storage areas during the convert operation. |
| Description | Provides mappings to specific physical storage areas. A storage policy indicates where the content for a class or object, such as a document, is stored. |
|---|---|
| Deployment Mechanism | There is no automated export and import of storage policy objects. You must re-create the storage policies in the destination environment, and then link the new storage information to the imported document classes. |
| Dependencies | Not applicable |
| Environment-specific data | Not applicable |
| Notes | Although you cannot export and import these objects, FileNet Deployment Manager provides a storage policy data map. Use the data map to replace references to storage policies during the convert operation. |