IBM FileNet P8, Version 5.2.1

Object store assets

Each type of asset in the object store has its own specific capabilities and limitations that you must consider when you deploy it.

Abstract persistable

Description	The Abstract_Persistable asset is used to define a subclass that describes a class of objects, which are persistable but are not containable, do not carry content, are not versionable, and do not support lifecycle functions. Each custom root subclass is in a separate table in the object store database, which provides enhanced performance and scalability. Abstract_Persistable also provides replication and subscribable functions.
Deployment mechanism	FileNet® Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	All property templates that are referenced by the property definitions for the class definition.
Environment-specific data	None.

Abstract queue entry

Description	Customizable base for classes of objects that can be processed by a queue sweep. CmAbstractQueueEntry is solely intended for use by queues that are managed by the Content Engine sweep framework. Although the class definitions can be migrated, instances of Abstract Queue Entry subclasses are transitory in nature and cannot be migrated by using FileNet Deployment Manager.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	All property templates that are referenced by the property definitions for the class definition.
Environment-specific data	None.

Abstract search results

Description	A base class that is used to define a subclass that describes the class of objects that are returned as a search result from an instance of a background search template. The instances of search results are transitory and specific to a particular system. Only the class definition is intended to be migrated and deployed.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	All property templates that are referenced by the property definitions for the class definition.
Environment-specific data	None.

Abstract sequential

Description	Customizable base for classes of objects that have a system-generated, unique, monotonically increasing sequence number property. CmAbstractSequential can also be used for new classes of queue entry objects that are processed by a custom application. Although you can migrate a class definition, instances of Abstract Sequential subclasses are transitory in nature and cannot be migrated by using FileNet Deployment Manager.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	All property templates that are referenced by the property definitions for the class definition.
Environment-specific data	None.

Annotation object

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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	The annotated object that is referenced by the AnnotatedObject property. The storage area that is referenced by the StorageArea property, if the property is not null. The storage policy that is referenced by the StoragePolicy property, if the property is not null. Tips: As part of the import operation, FileNet Deployment Manager supports changing the storage policy and indirectly, the storage area of objects with content. For more information, see the description for the Select Storage Policy for Imported Objects option in Import converted objects. You can specify only 1 storage policy for the import operation. If objects require different storage policies or storage locations, you must import these objects separately. 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.

Audit definition

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.

Audit disposition policy

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.

Audit log entry

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.
Dependencies	Audit log entries cannot be imported into another object store.
Environment-specific data	Audit log entries cannot be imported into another object store.
Notes	Audit log entries cannot be imported into another object store. However, you can export these entries for use with a third-party reporting tool.

Audit processing bookmark

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.

Background search results

Description	A class definition that is a subclass of Abstract Search Result. The subclass defines the class of objects that are returned in a background search result from an instance of a background search template. The instances of a background search class are transitory and are not exportable.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	All property templates that are referenced by the property definitions for the class definition.
Environment-specific data	None.

Background search template

Description	A class definition that is subclass of the Background Search subclass, which is derived from the Sweep class hierarchy. When you create an instance of a Background Search Template, a background search is started automatically. Although the class definitions are exportable, the instances are not.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	All property templates that are referenced by the property definitions for the class definition. Optional assets that you must explicitly add to the export manifest if they are not already present in the destination environment: Background Search Results subclass definition that is referenced by the SearchResults property definition. Any property templates that are needed for any parameters included in the search expression. Any search function definitions that are used in the search expression.
Environment-specific data	Sweep timeslots that might need to be defined as a part of the Global Configuration Data at the destination.

Change preprocessor action

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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	Deployment of a change preprocessor action has the following dependencies: The code module that is referenced by the CodeModule property Restriction: An action handler can be part of a code module only when the handler is implemented as a Java™ component and not a JavaScript component. The class or JAR file that contains the external Java class that is referenced by the ProgId property, if that property is not null and a code module is not referenced by the CodeModule property. Class definition 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	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.

Choice list and choice list element

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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
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.

Class definition and property definition

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 depends on the containing class definition, and cannot be independently exported or imported.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	PropertyDefinition: The Property template that is referenced by the PropertyTemplate property The choice list that is referenced by the ChoiceList property, if that property is not null PropertyDefinitionObject: PropertyDefaultObject RequiredClassId ReflectivePropertyId ClassDefinition: All property templates that are referenced by the property definitions for the class definition All choice lists referenced by the property definitions for the class definition 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: DefaultInstanceOwner: Identifies the user or group that receives owner privileges when a new instance of this class is created. FileNet Deployment Manager updates this information for the destination environment when you convert assets for import. DefaultInstancePermissions: Identifies the users and groups to receive access privileges when a new instance of this class is created. FileNet Deployment Manager updates this information for the destination environment when you convert assets for import. Important: The permissions that are defined by the DefaultInstancePermissions property of a class definition are always imported, regardless of whether the Import Security Permissions option is selected in the import options for FileNet Deployment Manager.
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.

Code module

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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
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	If an action handler references supporting libraries that are not included in the code module, ensure that those libraries are available in the class path of the Content Platform Engine application server in the destination environment. You can create versions of code modules. If a deployed code module is revised (has a major version greater than 1), then any action that references the code module does not reference the latest version. If this situation occurs, deploy actions that reference the correct version of the code module (mostly likely the latest version). Alternatively, you can manually update the referencing actions on the destination system by copying a reference of the code module into the action object. For more detail, see the last step of the instructions in Modifying an action. When you export a code module, make sure to also export any actions that reference the code module. Exporting the actions at the same time that you export the code module reduces the risk of actions that reference the incorrect version of a code module.

Creation and modification information

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: Creator Date Created Last modifier Date Last Modified 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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
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.

Custom object

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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	The folder that is referenced by the SecurityFolder property, if that property is not null The security policy that is referenced by the SecurityPolicy property, if that property is not null 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	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.

Document

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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	The storage area that is referenced by the StorageArea property, if that property is not null The storage policy that is referenced by the StoragePolicy property, if that property is not null Tips: FileNet Deployment Manager provides support for changing the storage policy and indirectly, the storage area of objects with content as part of the import operation. For more information, see the description for the Select Storage Policy for Imported Objects option in Import converted objects. You can specify only 1 storage policy for the import operation. If objects require different storage policies or storage locations, you must import these objects separately. The folder that is referenced by the SecurityFolder property, if that property is not null. The security policy that is referenced by the SecurityPolicy property, if that property is not null. The lifecycle policy that is referenced by the DocumentLifecyclePolicy property, if that property is not null. The document that is referenced by the OwnerDocument property (for published documents only), if that property is not null. The document that is referenced by the SourceDocument property (for published documents only), if that property is not null. The folder that is referenced by the PublishingSubsidiaryFolder property (for published documents only), if that property is not null. 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.

Document lifecycle action

Description	Represents an action that the system performs when a document moves from one state to another.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	Deployment of a document lifecycle action has the following dependencies: The code module that is referenced by the CodeModule property Tip: An action handler can be part of a code module only when the handler is implemented as a Java component and not a JavaScript component.) The class or JAR file that contains the external Java class that is referenced by the ProgId property, if that property is not null and a code module is not referenced by the CodeModule property. Class definition 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	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 runtime.

Document lifecycle policy

Description	Defines the states of a document and identifies the lifecycle action that starts in response to state changes.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	The lifecycle action that is referenced by the DocumentLifecycleAction property 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.

Email template (email services extensions)

Description	Email services extensions define classes and properties of an email notification system that supports Social Collaboration Notification Extensions for Content Navigator. The email template class is a base class that is derived from Abstract Persistable and whose instances represent a localized template for the email body and subject. Instances of email template classes can be found in the Uncontained objects node of the Add Assets navigation pane of FileNet Deployment Manager.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	For instances of email template, dependencies exist for the class and property definitions for the subclass of which it is a member. The subclass is typically introduced to an environment by the Social Collaboration Notification Extensions for Content Navigator, extensions that define classes and properties for an event notification system that supports IBM® Content Navigator.
Environment-specific data	If used with Social Collaboration Notification Extensions for Content Navigator, verify the configuration of IBM Content Navigator in the destination environment to ensure that the event notification feature is enabled.

Event action

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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	Deployment of an event action has the following dependencies: The code module that is referenced by the CodeModule property Tip: An action handler can be part of a code module only when the handler is implemented as a Java component and not a JavaScript component.) The class or JAR file that contains the external Java class that is referenced by the ProgId property, if that property is not null and a code module is not referenced by the CodeModule property. Class definition 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	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.

Event queue item

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.

Event subscription

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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	The event action that is referenced by the EventAction property. The subscribable object that is referenced by the SubscriptionTarget property. 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.

File store

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

Folder

Description	Provides a container for other folders and for references to documents, folders and custom objects
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	The security policy that is referenced by the SecurityPolicy property, if that property is not null The parent folder that is referenced by the Parent property (for all folders except the root folder) 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	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.

IBM Content Search Services index

Description	IBM Content Search Services is a search engine that both reads and writes object index information so that searches can be based on: Text that is in an object Properties that are assigned to an object 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: IBM Content Search Services index area
Environment-specific data	Deployment of an IBM Content Search Services index object is not dependent upon any environment-specific data.

IBM Content Search Services index area

Description	IBM Content Search Services is a search engine that both reads and writes object index information so that searches can be based on: Text that is in an object Properties that are assigned to an object 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. Root directory
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.

IBM Content Search Services index partition

Description	IBM Content Search Services is a search engine that both reads and writes object index information so that searches can be based on: Text that is in an object Properties that are assigned to an object 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.

IBM Content Search Services index partition implementation

Description	IBM Content Search Services is a search engine that both reads and writes object index information so that searches can be based on: Text that is in an object Properties that are assigned to an object 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 2. 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.

Index area

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

Link

Description	Represents a relationship between 2 objects.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	The object that is referenced by the Head property The object that is referenced by the Tail property 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.

Permission

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 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: A Class Definition contains a set of default permissions that are applied to new instances of the class. An entry template contains a set of permissions that are applied to new documents or folders that are created by using the template.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
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. For example, the permissions that are defined by the DefaultInstancePermissions property of a class definition are always imported, regardless of whether the Import Security Permissions option is selected in the import options for FileNet Deployment Manager. 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.

Property template

Description	Provides a reusable template that is used to add a custom property to any number of classes
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
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. 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	The property template must exist in the destination object store before you import any class definition that references the template.

Queue item

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.

Referential containment relationship (RCR)

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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	The object that is referenced by the Head property The object that is referenced by the Tail property For Dynamic Referential Containment Relationships, the version series, or any document version in that series, that is referenced by the VersionSeries property 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	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.

Search function definition

Description	A Search Function Definition object is subtype of Sweep Action and specifies the handler implementation of a custom search function. The handler references either: A Java implemented handler that can be contained within a code module. The CodeModule is referenced by using the CodeModule property of the CmSweepAction object. A JavaScript implemented handler, which requires that the script is set on the ScriptText property of the object.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	If referenced, the Code Module. The exports include option 'Include objects that are referenced by object-valued properties' can be used to implicitly include the associated code module in the export. If JavaScript is used, the class or JAR file that contains the external Java class that is referenced by the JavaScript.
Environment-specific data	None.

Security policy and security template

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: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
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 access control entries from a security policy, FileNet Deployment Manager removes the security template access control entries. If the security template access control entries that are removed are Deny access control entries, access can be granted unintentionally to users or groups that were previously denied access.

Storage area

Description	Represents an area in which the files that represent the content elements of document and annotation objects are stored. There are 4 types of storage areas: file storage areas, fixed storage areas, database storage areas, and advanced 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.

Storage policy

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.

Sweep action

Description	A sweep action specifies the user-implemented action handler that processes the instances that are retrieved by the sweep object. Sweep actions can be explicitly included in an export manifest by navigating in the Events, Actions, Processes portion of the Add Assets dialog. Sweep actions can also be included implicitly in an export of the sweep object that references them by using the export include option "Include associated actions".
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	The code module that is referenced by the sweep action is automatically exported.
Environment-specific data	Sweep timeslots that might need to be defined as a part of the Global Configuration Data at the destination.

Sweep management

Description	A sweep is an instance of a background service that you configure to process objects in a database table or some other set of items. The purpose of a sweep is to do something with the items that match the filter conditions for the sweep. For example, you might create a sweep to delete selected objects or to create thumbnails for selected objects. A background service is represented by one of 3 types of sweep objects: Sweep Job, Sweep Policy, Queue Sweep. A sweep policy or queue sweep are persistent data and can be exported and imported. Many categories of system defined sweep objects, such as Thumbnail Requests Sweeps, Retention Update Policies, and Disposal Policies can be found under the Sweep Management node in the Add Assets navigation pane of FileNet Deployment Manager. A sweep job runs once and is finished. It is transitory in nature and is not exportable.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	Optional assets that can be explicitly added to the export manifest or implicitly included by using the export include options: Sweep Target (the include option is "Include immediate [user-defined] object-valued properties"). Sweep Action (the include option is "Include associated actions"). The code module is automatically exported if referenced by the sweep action. A sweep can produce sweep results. Sweep results are transitory and are not exportable.
Environment-specific data	Sweep time slots might need to be defined as a part of the Sweep Configuration that is stored with the Global Configuration Data at the destination.

Sweep policy

Description	A policy sweep processes the objects in a database table in an ongoing manner. In terms of implementation, a policy sweep consists of a policy component and a sweep component. Policies subscribe to sweeps in a many-to-one relationship: many policy components might share a sweep component. When you create a policy component, the appropriate sweep component is created automatically.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	None
Environment-specific data	None

Task

Description	A subclass definition that is derived from Task can be deployed by using FileNet Deployment Manager. Take care to explicitly include all other application assets that are required for the Task to function. One exception is if you are migrating only the localized values of display names and descriptive text. In such a case, the subclass definition is created by using the application tools, followed by usage of FileNet Deployment Manager to migrate only the subclass definition of Task to allow the localized values to be deployed in the destination environment. Although a class definition for a subclass that is derived from Tasks are exportable, instances are not.
Deployment mechanism	FileNet Deployment Manager: Create deployment data set Convert objects for import Analyze objects for import Import converted objects
Dependencies	For more information about assets that are associated with tasks, see Tasks.
Environment-specific data	None

Last updated: March 2016
roadmap_CE_object_store.htm

© Copyright IBM Corporation 2017.