IBM Content Navigator assets

Different tools might be required to migrate and deploy an IBM Content Navigator application and its assets.

The tools that you must use are determined by the tools that are used to create the assets and the storage method for the assets.
  • If your application includes assets that were created by using IBM Content Navigator tools but that are stored in an object store, this topic provides information about the migration and deployment of those assets.
  • If your application includes assets that were created by using other tools but can be processed by IBM Content Navigator, see the information for the tool that was used to create the asset.
  • If your application includes configuration information that is managed with IBM Content Navigator instead of Content Cortex, you must use other tools for the migration and deployment of those assets. For more information, see Migrating assets for IBM Content Navigator External link opens a new window or tab in the online product documentation.

The following tables show migration and deployment information for IBM Content Navigator assets that are stored in object stores.

Documents designated as sensitive

Table 1. Documents designated as sensitive
Description In IBM Content Navigator V3.0.0 or later, role-based redactions limit a user's exposure to sensitive data based on the user's business role. When a user uses IBM Content Navigator to open, download, print, or email a document that contains sensitive data, redactions are burned into the document in real time.
If a sensitive document is exported with its associated redactions (annotations) and security objects, and the IBM Content Navigator role-based redaction configuration is present in the destination system, then the imported document is treated by the IBM Content Navigator as a sensitive document with the following caveats:
  • If the FileNet® Deployment Manager import options specify that an older document overwrites a newer document, the document in the destination system will reflect the state of the document in the source.
    • The Document object is assigned the next appropriate major and minor version number so the content from the source system becomes current. The major and minor version numbers from the source system are not retained.
    • For a redacted Document object, the annotations associated with the imported versions are created in the destination repository and will be presented as redactions if the document version is opened using IBM Content Navigator.
    • For a redacted Document object, the value of the sensitive attribute for the document at the destination will reflect the value from the source.
    These two behaviors ensure the content and sensitive state of the imported document reflect that of the exported document.
  • If the FileNet Deployment Manager import options specify an older source document will not overwrite the newer document at the destination, the content and sensitive state of the destination document remain unchanged by the import operation.
Deployment Mechanism FileNet Deployment Manager:
  1. Create deployment data set
  2. Convert objects for import
  3. Analyze objects for import
  4. Import converted objects
Dependencies
  • IBM Content Navigator configuration to enable the role-based redaction feature for both the source and destination repositories.
  • IBM Content Navigator export and import of the role-based redaction configuration from the source IBM Content Navigator configuration database to the destination IBM Content Navigator configuration database.
  • FileNet Deployment Manager export and import of the role-based redaction configuration objects from the source repository to the destination repository.
To ensure FileNet Deployment Manager exports all repository assets (object store data) and information related to redactions that are applied to a document, the following options must be specified to ensure that the export operation includes:
  • Security objects
  • Annotations on documents, folders, and custom objects
  • Relationships to containing folders [Optional to keep document filed into pre-existing parent folder]
  • All document versions [Optional to move document’s entire history]
These include options are enabled by default.
To ensure FileNet Deployment Manager imports all information related to redactions that are applied to a document, the following options must be specified to ensure that the import operation includes:
  • Security permissions
  • Object ID
These include options are enabled by default.
Important: If all objects and information related to the redacted document are not exported and imported as described above, the redactions might not be available and sensitive information might be exposed.
Environment-specific data
  • Any security principals referenced by the role-based redaction configuration objects.
Tip: FileNet Deployment Manager automatically recognizes the security principals as referenced objects and converts these references in the export files by using the appropriate data map.

Entry templates

Table 2. Entry templates
Description An entry template that is defined in IBM Content Navigator V2.0.3 or later can be used to add or check in a document or create a folder. The user who designs the entry template determines what can be seen and done when an item is added or checked in.
Deployment Mechanism FileNet Deployment Manager:
  1. Create deployment data set
  2. Convert objects for import
  3. Analyze objects for import
  4. Import converted objects
Dependencies
  • The class definitions and property definitions of any document class that is referenced in the entry template.
  • The workflow that might be referenced by the entry template.
  • Any folder path that is referenced in the entry template.
Tip: FileNet Deployment Manager does not recognize the preceding objects referenced in the entry template. You can either directly add these objects to the export manifest or use other means to ensure that these objects are present in the destination environment before the entry template is used. Otherwise, you must edit the entry template after it is imported to correct any references to these objects that are invalid in the destination environment.
Environment-specific data
  • Any object stores that are referenced in the entry template.
  • Any security principals that are named in the entry template.
Tip: FileNet Deployment Manager recognizes the preceding objects as referenced objects of the entry template and converts these references in the export files by using the appropriate data maps.

Folder preferences

Table 3. Folder preferences
Description A folder preference that is defined in IBM Content Navigator V2.0.3 or later can be used to associate a folder with an entry template. The entry template is invoked when a user attempts to add documents or subfolders to the associated folder.
Deployment Mechanism FileNet Deployment Manager:
  1. Create deployment data set
  2. Convert objects for import
  3. Analyze objects for import
  4. Import converted objects
Dependencies
  • Any entry template that is referenced by version series ID in the folder preference.
Tip: FileNet Deployment Manager does not recognize the preceding object as an associated object of the folder preference and therefore it does not automatically add it in the export files. You must specifically add this object to the export manifest or ensure that it is present in the destination environment before the folder preference is used.
Environment-specific data
  • Any object stores that are referenced in the folder preference.
  • Any security principals that are named in the folder preference.
Tip: FileNet Deployment Manager recognizes the preceding objects as referenced objects of the folder preference and therefore converts these references in the export files using the appropriate data maps.
Notes Folder preferences are a type of annotation and are not visible when you are browsing to add assets to an export manifest. To export them, you must add the folder for which the folder preference is defined and select the Include annotations on documents, folders, and custom objects option for the folder.

Office templates

Table 4. Office templates
Description Using IBM Content Navigator V3.0.0 or later, you can add Office Online templates that end users can use to create new Office documents in the Office Online server. When users add a document with IBM Content Navigator, they can specify one of the Office templates available in the P8 repository to use.

These Office templates can be moved between repositories using FileNet Deployment Manager. Before you can import the Office templates, you must enable Office Online on the destination repository in IBM Content Navigator and save the setting. Enabling the repository installs the IBM Content Navigator Office Online Extensions and other add-ons required to support the IBM Content Navigator document type of Office Template (symbolic name IcnOfficeTemplate).

Deployment Mechanism FileNet Deployment Manager:
  1. Create deployment data set
  2. Convert objects for import
  3. Analyze objects for import
  4. Import converted objects
Dependencies
  • IBM Content Navigator configuration to integrate with Microsoft Office Online for both the source and destination environments.
  • Any folder path where the Office template is filed.
Tip: FileNet Deployment Manager recognizes the folder path as associated objects of the Office template. Therefore, the folder objects can be included indirectly when exporting the Office template by selecting the appropriate include options in the export manifest. Alternatively, you can directly add these objects to the export manifest or use other means to ensure these objects are present in the destination environment before the Office template is imported.
Tip: Office templates can be added to an export manifest by browsing to their location, as a filed or unfiled document. Or the search feature can be used to locate all documents of type Office Template. For example, this query returns all Office Templates with the properties needed by FDM to display them for selection into the export manifest:
SELECT [This], [ClassDescription], 
[Description], [DocumentTitle], [Id], [Name],  
[Creator], [LastModifier], [DateCreated],
[DateLastModified] FROM [IcnOfficeTemplate]
Environment-specific data
  • Any security principals referenced by the Office template object.
Tip: FileNet Deployment Manager automatically recognizes the security principals as referenced objects of the Office template and converts these references in the export files by using the appropriate data map.

Role-based redactions configuration objects

Table 5. Role-based redactions configuration objects
Description In IBM Content Navigator V3.0.0 or later, role-based redactions limit a user's exposure to sensitive data based on the user's business role. When a user uses IBM Content Navigator to open, download, print, or email a document that contains sensitive data, redactions are burned into the document in real time.
If a sensitive document is exported with its associated redactions (annotations) and security objects, and the IBM Content Navigator role-based redaction configuration is present in the destination system, then the imported document is treated by the IBM Content Navigator as a sensitive document with the following caveats:
  • If the FileNet Deployment Manager import options specify that an older document overwrites a newer document, the document in the destination system will reflect the state of the document in the source.
    • The Document object is assigned the next appropriate major and minor version number so the content from the source system becomes current. The major and minor version numbers from the source system are not retained.
    • For a redacted Document object, the annotations associated with the imported versions are created in the destination repository and are presented as redactions if the document version is opened using IBM Content Navigator.
    • For a redacted Document object, the value of the sensitive attribute for the document at the destination reflects the value from the source.
    These two behaviors ensure the content and sensitive state of the imported document reflect that of the exported document.
  • If the FileNet Deployment Manager import options specify an older source document will not overwrite the newer document at the destination, the content and sensitive state of the destination document remain unchanged by the import operation.
Deployment Mechanism FileNet Deployment Manager:
  1. Create deployment data set
  2. Convert objects for import
  3. Analyze objects for import
  4. Import converted objects
Dependencies
  • IBM Content Navigator configuration to enable the role-based redaction feature for both the source and destination repositories.
  • IBM Content Navigator export and import of the role-based redaction configuration from the source IBM Content Navigator configuration database to the destination IBM Content Navigator configuration database.
To ensure FileNet Deployment Manager exports all repository assets (object store data) related to the Redaction Roles and Policies, the following options must be specified to ensure that the export operation includes:
  • Object referenced by object-valued properties
  • Security objects
These include options are enabled by default.
To ensure FileNet Deployment Manager imports all information that is related to the Redaction Roles and Policies, the following options must be specified to ensure that the import operation includes:
  • Security permissions
  • Object ID
These include options are enabled by default.
Tip: Role-based redaction policies and role-based redaction roles can be added to an export manifest by using the search feature to locate those objects.
For example, this query returns role-based redaction policy objects with the properties that are needed by FileNet Deployment Manager to display them for selection into the export manifest:
SELECT [This], [ClassDescription],
[ClbRedactionPolicyName], [Creator],
[DateCreated], [DateLastModified],
[Description], [Id], [LastModifier], [Name] FROM
[ClbRedactionPolicy]
As another example, this query returns objects representing role-based redaction roles with the properties that are needed by FileNet Deployment Manager to display them for selection into the export manifest:
SELECT [This], [ClassDescription], [Creator],
[DateCreated], [DateLastModified],
[Description], [Id], [LastModifier], [Name],
[RoleName] FROM [ClbRedactionRole]
Environment-specific data
  • Any security principals referenced by the role-based redaction configuration objects.
Tip: FileNet Deployment Manager automatically recognizes the security principals as referenced objects and converts these references in the export files by using the appropriate data map.

Saved searches

Table 6. Saved searches
Description A saved search represents a search that is created and saved by using the IBM Content Navigator search view. Running a saved search displays a list of the repository objects that meet the search criteria.
Deployment Mechanism FileNet Deployment Manager:
  1. Create deployment data set
  2. Convert objects for import
  3. Analyze objects for import
  4. Import converted objects
Dependencies
  • Folders that this search queries
Tip: FileNet Deployment Manager does not recognize the folders referenced in the search query. You must either directly add these objects to the export manifest or use other means to ensure that these objects are present in the destination environment before the saved search is used. Otherwise, you must edit the saved search after it is imported to correct any references to these objects that are invalid in the destination environment.
Environment-specific data
  • Object stores that are referenced by the Search in portion of the search criteria
Tip: FileNet Deployment Manager recognizes the preceding objects as referenced objects of the saved search. Therefore, it converts these references in the export files by using the appropriate data maps.
Notes Searches can be saved in various locations. Be sure to note the location of a saved search so that you can later add it to an export manifest.

Teamspaces

Table 7. Teamspaces
Description A teamspace is a folder with associated properties and content that is created and saved by using IBM Content Navigator.
Deployment Mechanism FileNet Deployment Manager:
  1. Create deployment data set
  2. Convert objects for import
  3. Analyze objects for import
  4. Import converted objects
Dependencies
  • Any entry templates associated with the teamspace
  • Any saved searches associated with the teamspace
  • Any document for a folder row associated with the teamspace
  • Any class definition associated with the teamspace
Tip: FileNet Deployment Manager recognizes the preceding objects as associated objects of the teamspace. Therefore, you have the option to include them in the export files. You can also specifically add these objects to the export manifest or ensure that they are present in the destination environment before the teamspace is used.
Environment-specific data
  • Any object store that is referenced in the teamspace properties
  • Any security principals that are named in the teamspace properties
Tip: FileNet Deployment Manager recognizes the preceding objects as referenced objects of the teamspace and therefore converts these references in the export files by using the appropriate data maps.
Notes Reviews and recovery bins cannot be deployed, so any of these objects associated with the teamspace are not included when deploying a teamspace. Subfolders and assets filed in folders can be included when you are adding assets to an export manifest, during the step to specify the include options of an asset.

Workplace XT legacy assets

The following tables show migration and deployment information for legacy Workplace XT assets stored in object stores and usable with IBM Content Navigator.

Table 8. Workplace XT search template
Description Represents a file that is created in Search Designer that is run from Workplace XT. Workplace XT search templates can be run in IBM Content Navigator, but cannot be edited in IBM Content Navigator.
Deployment Mechanism FileNet Deployment Manager:
  1. Create deployment data set
  2. Convert objects for import
  3. Analyze objects for import
  4. Import converted objects
Dependencies
  • Class definitions and property definitions of the objects for which this template is used to search
  • Any custom properties, specific classes, or folders that this template queries must be explicitly exported and imported into the destination system using options that retain their ObjectID values.

See Common dependencies between objects.

Environment-specific data Object stores that are referenced by the Searching Object Stores property

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
  • Search templates can be filed anywhere. Be sure to note the location of these templates before you export them.
  • If the search template involves multiple object stores, this data must be exported to the appropriate target object stores.
Table 9. Workplace XT stored search
Description Represents a file previously created in Search Designer from Workplace XT. Workplace XT Stored Searches can be run in IBM Content Navigator but stored searches that return both folders and docs are not supported. They cannot be edited in IBM Content Navigator.
Deployment Mechanism FileNet Deployment Manager:
  1. Create deployment data set
  2. Convert objects for import
  3. Analyze objects for import
  4. Import converted objects
Dependencies
  • Class definitions and property definitions of the objects that this search is used to locate
  • Any custom properties, specific classes, or folders that this search queries must be explicitly exported and imported into the destination system by using options that retain their ObjectID values.

See Common dependencies between objects.

Environment-specific data Object stores that are referenced by the Searching Object Stores property

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 Stored searches can be filed anywhere. Be sure to note the location of the searches before you export them.