Object store assets

Annotation object

Description Defines a link between a document or other object and additional 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
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See 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

    NOTES
    • As part of the import operation, Enterprise Manager supports changing the storage policy and, indirectly, the storage area of objects with content. For more information, see the description for the Storage Location for Imported Objects field in Import Helper (Import Options Tab).
    • You can specify only one 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 exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes None

Audit log entry

Description Represents an entry in an audit event log, which exist as a table in the object store database.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies Because audit log entries are not intended for import or deployment, their dependencies on other objects are not listed.
Environment-specific data Because audit log entries are not intended for import or deployment, their environment-specific data is not listed.
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.

To export audit log entries, use Content Engine Query Builder in Enterprise Manager. Query Builder provides a saved search, ExportEventsForObjects, that adds the audit log entries to the export manifest.

When you create the export files, Enterprise Manager places the audit log entries in the Group 7 XML files.

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
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies See Common dependencies between objects.
Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes None

Class definition and property definition

Description

A class definition contains the mutable class metadata for a Content Engine class that can be modified by a client application.

A property definition is a collection of mutable metadata originating from a property template. Each property definition is associated with a specific class definition and represents a property belonging 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
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies PropertyDefinition:
  • The Property template referenced by the PropertyTemplate property
  • The choice list referenced by the ChoiceList property, if that property is not null

PropertyDefinitionObject:

  • PropertyDefaultObject
  • RequiredClassId
  • ReflectivePropertyId

ClassDefinition:

  • All property templates referenced by its property definitions
  • All choice lists referenced by its property definitions.

See also Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying 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.
Notes If you import a class definition that has the same ID as an existing class definition in the destination environment, Enterprise Manager updates the existing class definition to add any new property definitions.

Code module

Description

Contains a Java™ event handler implemented for your application. This event handler is executed when events are raised for an action-based object.

The event handler, which can be a Java class or JAR file, must reside on the Content Engine.

Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies See Common dependencies between objects.
Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes If the event handler references supporting libraries that are not included in the code module, ensure that those libraries are available in the classpath of the application server used for Content Engine in the destination environment.

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 Engine:
  • Creator
  • Date Created
  • Last modifier
  • Date Last Modified

These properties provide tracking and historical information for use in ad-hoc queries and by applications build on the FileNet P8 Platform. The properties are not objects; they are just property values on other objects.

Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies None
Environment-specific data The Creator and Last modifier values are strings containing 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 Maintain System Properties option in Import Helper. If you do not select this option, the properties are assigned values as if the object is newly created. For more information, see Import Helper (Import Options tab).

NOTE 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 subclassing and adding properties to perform a wide variety of tasks.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies
  • The folder referenced by the SecurityFolder property, if that property is not null
  • The security policy referenced by the SecurityPolicy property, if that property is not null

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying 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 perform 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 Engine uses to identify and find that document.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies
  • The storage area referenced by the StorageArea property, if that property is not null
  • The storage policy referenced by the StoragePolicy property, if that property is not null

    NOTES
    • Enterprise Manager provides support for changing the storage policy of objects with content as part of the import operation. For more information, see the description for the Storage Location for Imported Objects field in Import Helper (Import Options Tab).
    • You can specify only one storage policy for the import operation. If objects require different storage policies or storage locations, you must import these objects separately.
  • The folder referenced by the SecurityFolder property, if that property is not null
  • The security policy referenced by the SecurityPolicy property, if that property is not null
  • The lifecycle policy referenced by the DocumentLifecyclePolicy property, if that property is not null
  • The document referenced by the OwnerDocument property (for published documents only), if that property is not null
  • The document referenced by the SourceDocument property (for published documents only), if that property is not null
  • The folder 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 exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes

A Document object in Content Engine 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 in Import Helper. For more information, see Import Helper (Import Options tab).

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 perform a search to locate the document in the destination environment. You can also locate the document using the Unfiled Documents view in Enterprise Manager.

Document lifecycle action

Description Represents an action that the system performs when a document moves from one state to another.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies
  • The code module referenced by the CodeModule property, if that property is not null
  • The external Java class referenced by the ProgId property, if that property is not null

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes Best practice: Have lifecycle event actions reference a code module rather than using Java classes that are referenced from the Java virtual machine classpath for the application server. If the lifecycle event action references a code module, the event action code is exported and imported with the event action. This reduces the risk of the event action code not being available in the destination environment at run time.

Document lifecycle policy

Description Defines the states of a document and identifies the lifecycle action that executes in response to state changes.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies The lifecycle action referenced by the DocumentLifecycleAction property

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes None

Event action

Description Represents a code procedure that your application implements as a Java class, based on the EventActionHandler interface.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies
  • The code module referenced by the CodeModule property, if that property is not null
  • The external Java class referenced by the ProgId property, if that property is not null

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes Best practice: Have event actions reference a code module rather than using Java classes that are referenced from the Java virtual machine classpath for the application server. If the event action references a code module, the event action code is exported and imported with the event action. This reduces the risk of the event action code not being 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 Engine
Deployment Mechanism None
Dependencies None
Environment-specific data None
Notes Event queue items are short-lived objects intended for processing in the P8 system in which they are created. Deployment of these objects is neither generally useful nor recommended.

Event subscription

Description Associates an event action with one or more events and identifies the Content Engine object on which these events can be triggered.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies
  • The event action referenced by the EventAction property.
  • The subscribable object referenced by the SubscriptionTarget property.

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes None

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 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

Folder

Description Provides a container for other folders and for references to documents, folders and custom objects
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies
  • The security policy referenced by the SecurityPolicy property, if that property is not null
  • The parent folder referenced by the Parent property (for all folders except the root folder)

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes You implement a folder hierarchy in Content Engine 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 exported with the folder object.

Enterprise 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.

Index area

Description Represents the disk storage location and data necessary to perform full-text indexing for content-based 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

Link

Description Represents a relationship between two objects.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies
  • The object referenced by the Head property
  • The object referenced by the Tail property

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes None

Permission

Description

Includes access control lists, owner information, and permission lists.

Permissions collections are not standalone 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 Enterprise 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 additional 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 created using the template.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies None
Environment-specific data The options you set in Enterprise Manager determine the export and import of the basic set of permissions for independently securable CE objects. The additional permission information that some objects have is always exported and imported.

Permissions contain environment-specific information identifying users and groups. If the source and destination environment use different LDAP repositories and you export the permissions, the user and group information needs to be updated before you import the objects. Use FileNet Deployment Manager to convert the information as required.

Notes None

Property template

Description Provides a reusable template that is used to add a custom property to any number of classes
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies The choice list 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 referenced by its property definitions.

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying 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 the Content Engine.
Deployment Mechanism Not applicable
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
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies
  • The object referenced by the Head property
  • The object 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 exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying 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 using 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 will not be filed in the folder. To locate the object, search using the object ID.

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
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies See Common dependencies between objects.
Environment-specific data

The TemplatePermissions property of the security template contains permissions that need to be updated for the destination environment.

Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.

Notes None

Storage area

Description Represents an area in which the files that represent the content elements of document and annotation objects are stored. There are 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 classes, storage policies, and 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 None

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 classes, storage policies, and 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 None