Include options for assets in FileNet Deployment Manager
The include options for FileNet Deployment Manager control individual assets or objects. Include options set for an asset are automatically applied to related objects added to the export data set. 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 helps prevent the unintended inclusion of objects that result from include option propagation. 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 deployment dataset.
- Objects that are exported along with associated custom metadata
- For objects such as folders or documents that include custom metadata—like property templates
used to describe custom properties—retain the default include options in the Data
Design section. These default settings help ensure that associated metadata is correctly
exported with the object. Tips:
- To support associated metadata created in the source system after installing an add-on, install the same add-on in the target object store. Avoid moving the metadata by using FileNet Deployment Manager.
- To prevent the accidental inclusion of metadata created during the workflow deployment process, explicitly add any custom metadata to the export manifest. Do not rely on the Data Design include options to include metadata implicitly.
- 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 workflow deploy solution process and workflow server at run time.
- Associated objects that an asset depends on
- In the export manifest, explicitly list any associated objects that the asset depends on, such as workflow definitions and search templates. To maintain folder relationships, select the Include relationship to containing folders option.
- Documents that are revised as the solution design changes
- When documents such as search templates and workflow definitions are updated as part of solution design changes, select the option. This helps ensure that future exports that use the same manifest include the latest version of each document. If you do not want to export all versions, remove the document from the manifest and add it again. This refreshes the reference and helps ensure that the export includes the most recent version.
- 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 helps avoid side effects from exporting add-on property templates or case type metadata, such as case properties or activities.
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.