Include options for assets in FileNet Deployment Manager
The include options in FileNet Deployment Manager specify which related objects and associated metadata are included in the export set for an object. The include options must be set correctly to ensure that the object can be imported into any target environment.
The include options for FileNet Deployment Manager control individual assets or objects. The include options that are specified for an asset are propagated to any related objects that are added to the export data set as a result of the include options settings for the original asset. These include options cascade from one object to the next as the export operation finds associated objects to add to the export data set based on the specified include options.
When you use FileNet Deployment Manager to migrate assets for a solution application, specify include options that narrowly target the assets to export. This narrow focus is intended to avoid implicit inclusion of unwanted objects that can be caused by propagation of the include options. In the Include Options window in FileNet Deployment Manager, click None to clear all the include options that are selected. After you clear the include options, only the asset that is listed in the export manifest will be exported and placed into the deploy dataset.
- Objects that are exported along with associated custom metadata
- For an object such as a folder or document that is exported with
associated custom metadata, such as property templates that are used
as metadata to describe custom properties for the folder or document,
keep the include options that are selected by default in the Data
Design section. Tips:
- For associated metadata that was created in the source system after an add-on was installed, install the same add-on into the target object store instead of moving the metadata by using FileNet Deployment Manager.
- To avoid the accidental inclusion of metadata that is created by the IBM® Business Automation Workflow deploy solution process, explicitly include any custom metadata in the export manifest instead of implicitly including the metadata by using the Data Design include options.
- Moving all content in a folder
- If all content in a folder is to be moved, export the folder and
implicitly include the contents and subfolders with the relationships.
In this case, keep the include options that are selected by default
in the Folders and Contained Objects section. Tips:
- For more control over the export, add the parent folder explicitly to the export manifest instead of by using the Include parent folders option.
- Do not select Include parent folders if you export assets in the case instance folder hierarchy. The case folder and case instances must be created by the IBM Business Automation Workflow deploy solution process and IBM Business Automation Workflow server at runtime.
- Associated objects that an asset is dependent on
- Explicitly specify in the manifest other associated objects that an asset is dependent on, such as workflow definitions, search templates, and form templates. Select the Include relationship to containing folders option and maintain relationships to the parent folder.
- Documents that are revised as the solution design changes
- For documents that are revised as the solution design changes, such as form templates, search templates, and workflow definitions, use the include option to ensure that subsequent exports with the same export manifest use the latest of the version document. If you do not want to export all versions, edit the export manifest to delete the document, and then add it to the manifest again to ensure that the export action uses the latest version of the document.
- Compound documents, annotations, and thumbnails
- Use other document-related include options for compound documents, annotations, and thumbnails on an as needed basis.
- Class definitions
- For class definitions, explicitly include the custom property templates and implicitly include
the choice lists for the custom property templates.
For document classes, exclude any subscriptions and event actions that are associated with the document class definitions. Because unique IDs are assigned to subscriptions and event actions on each system, duplicate items are created if you include these items in the export.
Do not use the Data Design include options for the class definitions themselves. This approach reduces potential side-effects that can be caused by the export of property templates from add-ons, or by the export of a case type class definition when an exported object refers to metadata that is associated with the case type, such as a case property or case activity.
Typically, the Include modified system classes option is not selected and should be used with caution.
- Objects other than class definitions with subscriptions and events
- For objects other than class definitions with subscriptions and events, implicitly export the subscriptions and events by selecting the Include event subscriptions attached to objects and Include event actions associated with subscriptions options.
The General include options can typically be left with their default values.
For more information about FileNet Deployment Manager include options, see the IBM FileNet P8 documentation.