IBM FileNet P8, Version 5.2.1            

Specifying the include options of an asset

In an export manifest, you might want to include the assets of associated objects, such as metadata or folders, in the export set. To specify which associated objects of an asset to include in the export data set, specify the include options for the data set.

Restriction: You can add assets from only one object store or isolated region to an export manifest. Specifically, the Add Assets dialog does not support addition of assets from multiple object stores to an export manifest.

Use the Include Options window to include in the export data set some, all, or none of the associated objects that an asset depends on, without a requirement to explicitly identify and add each associated object to the export manifest. For example, to export a folder and its contents, specify the include options for the data set to add the folder and its contents to the export data set with one action. You are not required to individually add each object that is contained by the folder to the export manifest. However, if an export manifest or the target object store already contains those associated objects, you are not required to include those objects again.

Include option propagation

FileNet® Deployment Manager include options control individual assets or objects. The include options are propagated from one object to the next as the export operation finds associated objects that are based on the include options on the objects in the export manifest.

In FileNet Deployment Manager, the include options that you specify for an individual asset are propagated to any related objects that are added to the export data set as a result of the include options settings for that asset. The include options cascade from one object to the next as the export operation finds associated objects to add to the export data set that is based on the include options settings. For example, if the Include subfolders, Include contents of folders, and Include annotations on documents, folders, and custom objects include options are selected for a specific folder in the export manifest, the following sequence occurs (but not necessarily in this order):
  1. Because the folder is in the export manifest, the export operation adds it to the export data set.
  2. The Include subfolders include option setting causes the export operation to add all the subfolders of the original folder to the export data set, as if each of these folders existed in the export manifest.
  3. Because the Include subfolders include option propagates to each subfolder, the export operation also adds all of the subfolders of each subfolder so that the entire folder tree under the original folder is eventually added to the export data set, as if each of these folders existed in the export manifest.
  4. Because the Include contents of folders include option also propagates to each subfolder, the entire contents (documents and custom objects) of each folder in the folder tree is added to the export data set, as if each of these documents or custom objects existed in the export manifest.
  5. Because the Include annotations on documents, folders, and custom objects include option propagates to each document, folder, and custom object that is added to the export data set, every annotation that exists on those objects is also added to the export data set, as if each of these annotations existed in the export manifest.

To specify the include options of an asset:

  1. In the FileNet Deployment Manager tree view pane, expand the Environments node, and expand the environment definition node that contains the export manifest that you want to modify.
  2. Expand the Export Manifests node and double-click the export manifest that you want to modify.
  3. In the export manifest editor, select one or more assets for which you want to specify include options.
  4. From the Export Manifest menu, select Include Options.
  5. In the Include Options window, specify the object types to include as follows:
    • To select every include option, click the All toolbar button.
    • To select none of the include options, click the None toolbar button.
    • To select the default include options, click the Default toolbar button. The default include option settings are listed here:
      • Include modified system classes is cleared for all assets.
      • Include subclasses is selected only for assets that belong to the ClassDefinition asset category.
      • Include subfolders is selected only for assets that belong to the Folder asset category.
      • All other include options are selected for all assets.
      • Include options for Social Collaboration assets are all cleared.
    • To specify a custom list of include options, select the check box next to an include option that you want to specify and clear the check box next to an include option that you do not want to specify. If you selected multiple assets to control from a single Include Options window, each check box next to an include option that has a mixture of selections for those assets is shaded. To change the state of a shaded check box, click it one time to clear it (clearing the include option for all of the selected assets), click it again to select it (selecting the include option for all of the selected assets), or click it a third time to restore the original selections.
  6. After you select which object types to include, click OK.
  7. To save your changes to the export manifest, select Save from the file menu.

Include options list

You can specify the following include options for each asset. Each asset category has its own set of default include options, which are selected when you click the Default button. Each of the include options is displayed as a default include option for every asset category, unless otherwise noted:
  • General:
    • Include immediate user-defined object-valued properties: Includes the objects that are referenced through any user-defined, object-valued properties, including those objects that are defined by FileNet P8 add-on features, on an object. Because include options are propagated, any objects that are referenced by user-defined properties on the referenced object are also included in the export data set. Otherwise, if this include option is not selected, only the object reference (ID) of each user-defined, object-valued property is included in the export data set, not the object itself.
    • Include security objects: Includes any security policies and security templates that are associated with an object. A security policy contains security templates that you can use to manage security that is applied to documents, folders, and custom objects. This Include option also includes the security folder of objects that are referenced by any object-valued properties if the SecurityProxyType property of each referenced object is set to FULL or INHERITANCE.
    • Include marking sets related to objects Includes any marking sets that are used by the selected asset.
    • Include associated actions Includes action objects such as event actions, sweep actions, and other actions that are referenced by the selected asset.
  • Browse (Folders and Contained Objects):
    • Include subfolders: Includes all the subfolders that exist under a folder. Because this include option propagates to each folder, selecting this include option adds the entire folder tree under the folder. This include option applies to folders only.

      This include option is a default include option for the Folder asset category only.

    • Include contents of folders: Includes all of the immediate contents of a folder (documents, custom objects, referentially contained folders), including the referential containment relationship objects between the folder and its contents. If selected, the following include options are also propagated to the included contents: Include relationships to containing folders, and Include parent folders. This include option applies to folders only.
    • Include relationships to containing folders: Includes any referential containment relationship objects that file a containable object in a folder. This include option applies to containable objects only, which are objects that can be referentially contained in a folder: documents, custom objects, and referentially contained folders.

      Use this include option when you want to ensure that an object that is explicitly added to the export manifest and is filed in a folder that is the same folder at the destination. By contrast, use the Include contents of folder include option when you explicitly add a folder to the export manifest and want to include its contents.

    • Include parent folders: Includes the parent folder containment hierarchy (excluding the root folder) of a folder to ensure that objects are filed in the same folders on the target object store, even if those parent folders do not exist. If this include option is selected, the parent folder containment hierarchy is exported without contents, unless you explicitly add the contained objects to the export manifest. Use this include option directly on a folder to export all its parent folders, which allows the folder to be imported even if its parent folders do not currently exist at the destination.

      If this include option is applied to a containable object (document, custom object, or referentially contained folder), the parent folder containment hierarchy (excluding the root folder) is added only if the Include relationships to containing folders include option is also selected. Use this include option on a document or custom object, and select the Include relationships to containing folders include option, to export every folder that contains the object and parents of those folders.

      If the Include parent folders include option is not selected and a containing folder does not exist at the destination, the following statements are true:

      • The object is imported.
      • The referential containment relationship object that related the object with the containing folder fails to import.
      • If the object is not filed in any folders, the object can be found by using a search or by looking in the Unfiled Documents folder in the Content Platform Engine administration console.
  • Document-Related:
    • Include all document versions: Includes the entire document version series of a document.
    • Include compound document components: Includes related compound document links and components when applied to a single component of a compound document.
    • Include annotations on documents, folders, and custom objects: Includes any annotations that are associated with a document, folder, or custom object.
    • Include user-defined thumbnails: Images can be generated by a third-party application but persisted on the Content Platform Engine.
  • Data Design:
    • Include subclasses: Includes the class definitions that define any subclasses that exist for the class that is defined by a class definition.

      This include option is a default include option for the ClassDefinition asset category only.

      Restriction: The Default Instance Security of class definitions is always imported.
    • Include non-system classes: Depending on the type of exported object that is selected, this include option starts different behaviors in the export operation:
      • For a document, folder, or custom object, the export operation includes any user-defined class definitions that are associated with the object. The export operation does not include system classes. Any class definitions that are created by FileNet P8 feature add-ons are included because these classes are not considered as system classes.
      • For a class definition, the export operation includes the parent class hierarchy for the class definition.
    • Include modified system classes: Includes the class definition of an object if the object is a system class and is user-modified. This include option is not commonly used because users do not typically modify system classes, and because many system classes are considered as modified because of the changes that are introduced by FileNet P8 add-on features. However, if you add custom properties on any FileNet P8 system classes that are associated with the objects that you are adding to the manifest, either select this include option or explicitly add those class definitions to the export manifest.

      This include option is not a default include option for any asset category.

      Before you select this option, consider the following information:
      • If you change only the values of system properties of the class, asystem class is not considered to be modified . If you want to export a system class with changed property values, you must explicitly add the class definition to the export manifest.
      • Use this include option with caution. Some system class definitions, such as the base Document class definition, are considered as modified because of the changes that are introduced by the standard FileNet P8 add-on features. If the class definitions are associated with the object that you added to the export manifest, selecting this include option adds those class definitions to your deployment data set. Importing that deployment data set with enabled updates applies any changes from the source system to the destination, most notably replacing the permissions in the access control list (ACL) on the destination class definition with the permissions from the source class definition.
    • Include property templates on classes: Includes all property templates that are referenced by the property definitions that are defined by a class definition.
    • Include choice lists on property templates: Includes any choice lists that are defined in the property templates that are referenced by the property definitions that are defined by a class definition.
  • Event and Lifecycle:
    • Include event subscriptions attached to objects: Includes any event subscriptions that are attached to an object. This include option applies to all object types that have subscriptions that are attached to them.
    • Include change preprocessor actions that are associated with class definitions: Includes all change preprocessor actions that are referenced by the property definitions that are defined by a class definition.
    • Include lifecycle policies attached to objects: Includes any lifecycle policies that are attached to a document.
    • Include lifecycle actions attached to lifecycle policies: Includes all the lifecycle actions that are set on any lifecycle policies that are attached to a document.
  • Social Collaboration:
    • Include comments: Includes user comments that are associated with the document.
    • Include recommendations: Includes user recommendations that are associated with the document.
    • Include followers: Includes followers of the objects.
    • Include tags: Includes objects that are tagged by users.
Parent topic: Adding assets to an export manifest by browsing

Last updated: March 2016
prep_data_ce_include_options.htm

© Copyright IBM Corporation 2017.