IBM FileNet P8, Version 5.2.1            

Workplace assets

Workplace assets in object stores

Access roles

Description Default access roles control access to administrative functions and to specific workflow-related tools. Default access roles are created when the application is installed.

Custom access roles determine which users can access specific features and commands within Workplace.

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 site preferences in which the access roles are configured.
Tip: FileNet Deployment Manager does not recognize site preferences as associated objects of access roles and, therefore, does not automatically include them in the export files. You must specifically add the site preferences to the export manifest.

See Common dependencies between objects.

Environment-specific data The principals that are referenced by the Secured Role 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 The access roles for a Workplace site are stored in an Access Roles folder within the source object store that is specified in the site preferences for the Workplace installation.

When you import access roles, FileNet Deployment Manager might return a bad reference exception if access roles exist in the destination object store. If this exception occurs, the access roles are still imported. However, FileNet Deployment Manager places them in the Unfiled Documents folder. You must move them to the Access Roles folder.

Document entry template

Description Provides a wizard that steps a user through adding a document. An entry template, which is created by using the Entry Template Designer, can provide default values for the destination folder, properties, and security. The entry template might hide some pages in the add wizard, and the template can start a workflow when the new item is added.
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 the document class that is specified by the Target Object Class Id property
  • The workflow that is referenced by the document entry template
Tip: FileNet Deployment Manager does not recognize the preceding objects as associated objects of document entry templates and, therefore, does not automatically include them in the export files. You must specifically add these objects to the export manifest.

See Common dependencies between objects.

Environment-specific data
  • The object store that is referenced by the Entry Template Object Store Name property
  • The object store that is referenced by the Target Object Store Name 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 To deploy a document entry template, you must locate the folder in which the template was filed when it was created.

Folder entry template

Description Provides a wizard that steps a user through adding a folder. An entry template, which is created by using the Entry Template Designer, can provide default values for the destination folder, properties, and security. The entry template might hide some pages in the add wizard, and the template can launch a workflow when the new item is added.

To deploy a folder entry template, you must locate the folder in which the template was filed when it was created.

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 the folder class that is specified by the Target Object Class Id property
  • The workflow that is referenced by the folder entry template
Tip: FileNet Deployment Manager does not recognize the preceding objects as associated objects of folder entry templates and, therefore, does not automatically include them in the export files. You must specifically add these objects to the export manifest.

See Common dependencies between objects.

Environment-specific data
  • The object store that is referenced by the Entry Template Object Store Name property
  • The object store that is referenced by the Target Object Store Name 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 None

Link

Description Used to organize objects that are related to each other in some way.
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 Links and, if used, their custom Link subclasses are automatically added to the export manifest as associated objects. The 2 objects that a Link references (document, folder, or custom object type). The objects that are referenced by a Link do not themselves reference the Link, so you cannot automatically include the Link object when you export an object that the Link references. Therefore, you must explicitly export Link objects. See Common dependencies between objects.
Environment-specific data 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 This feature must be enabled in the site preferences for the Workplace Site. If you are deploying this object, you must either deploy the site preferences from your source site to your destination or you must enable links on your destination.

Search template

Description Represents a file that is created in Search Designer that is run from either the Workplace Search or Browse page. Using the search template usually prompts the Workplace user to enter or change values and then displays a list of the documents 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
  • 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

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.

Site preferences

Description Provides configuration settings that affect Workplace appearance, behavior, and connectivity. Administrators set site preferences by using the Site Preferences application. Non-administrative users can set personal preferences, which override some site preferences.
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 If any class or object dependencies exist, they must be manually added to the export manifest; otherwise they are not exported. For information about dependencies, see Common dependencies between objects.
Environment-specific data 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 Site preferences files are saved in the /Preferences folder of the object store.

When you import site preferences, FileNet Deployment Manager might return a bad reference exception if site preferences exist in the destination object store. If this exception occurs, the site preferences are still imported. However, FileNet Deployment Manager places them in the Unfiled Documents folder. You must move them to the Preferences folder.

Tip: FileNet Deployment Manager does not recognize access roles as associated objects of site preferences and, therefore, does not automatically include them in the export files. You must specifically add the access roles to the export manifest.
Tip: Import a Preferences folder only if there is an existing Preferences folder in the destination object store.

A number of Workplace sites can be pointed at a FileNet P8 environment. Therefore, after you import the site preferences, you must update the site preferences information in the bootstrap.properties file for the Workplace site.

Stored search

Description Represents a file that is created in Search Designer that is run from the Workplace Browse page. Using the stored search displays a list of the documents 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
  • 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

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 the templates before you export them.

User preferences

Description Represents the preference settings of an individual user. The user preferences override the equivalent site preferences.
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 user account for which the user preferences are set. If any class or object dependencies exist, they must be manually added to the export manifest; otherwise they are not exported. For information about dependencies, see Common dependencies between objects.
Environment-specific data 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 User preferences that are specific to Content Platform Engine are saved as files in the /Preferences folder of the object store and can be exported, converted, and imported by using the instructions in this table. By contrast, user preferences from the Tasks section are stored in the database. For information about how to export and import workflow system objects, see User preferences.

Before you use FileNet Deployment Manager to convert exported user preferences, ensure that the users for whom preferences are being exported are included in the security principals data map. For more information, see Create a security principal data map.

Do not deploy Workplace user preferences objects if you are mapping more than one source security principal to a single destination security principal. User preferences embed the SID of the user to which they apply in their folder containment name. Because the Content Platform Engine server enforces unique containment names within a folder, an error results if more than one of those mapped principals contains a user preference in the deployment data set. Although the user preference objects are imported successfully, the referential containment relationships that file them in the Preferences folder cause an import error. As a result, only a single user preferences object is filed in the Preferences folder on the target environment; the remaining user preferences objects are unfiled.

If you imported more than one user preference that is mapped to the same security principal at the destination and you want to change the preference document that is filed in the Preferences folder, use the following procedure:
  • Use Administration Console for Content Platform Engine to verify that the user preferences document that you want to use is present, but unfiled. Find it by creating a query or by viewing the Unfiled Documents folder.
  • From the Preferences folder, unfile the user preferences document that you do not want to use.
  • File the user preferences document that you want to use in the Preferences folder.

When you import user preferences, FileNet Deployment Manager might return a bad reference exception if user preferences exist in the destination object store. If this exception occurs, the user preferences are still imported. However, FileNet Deployment Manager places them in the Unfiled Documents folder. You must move them to the Preferences folder.

Tip: Import a Preferences folder only if there is an existing Preferences folder in the destination object store.

Workplace add-on features

Email

Description Provides functionality that is required to support Microsoft Outlook application integration.

This feature add-on adds several classes and properties to support Outlook message content, such as the message sender, recipients, and date/time information, in addition to creating and managing link associations between Outlook messages and related objects.

Deployment Mechanism The classes and properties are created automatically in the object store when the email add-on is installed in the destination environment.
Dependencies Workplace Common Extensions
Environment-specific data Not applicable
Notes After you deploy the email add-on, you must configure email integration in the site preferences for the Workplace.

Workplace custom configuration files

Custom configuration files

Description If the source installation of Workplace has custom modifications that you would like to retain in the destination installation of Workplace, you must copy the updated configuration files out of the following source directories and manually add them into the destination:
  • Workplace_installed_dir\config\AE directory
  • Deployed Workplace directory
Important: The term "deployed" Workplace directory refers to the deployment of the Workplace application and not the deployment of the entire FileNet P8 system.
Deployment Mechanism FileNet P8 does not have a tool that deploys Workplace custom configuration files. Therefore, you must manually add the custom configuration files into the destination environment.
Dependencies Workplace custom configuration files do not have any dependencies upon any other objects.
Environment-specific data Workplace custom configuration files do not have any dependencies upon any environment-specific data.
Notes
  • Following are the deployed Workplace directories by application server:
    WebSphere®
    WAS_HOME/profiles/default/installedApps/node_name/Workplace.ear/app_engine_war.ear/app_engine.war
    WebLogic
    AE_install_path/Workplace
    JBoss
    JBOSS_HOME/server/server_name/deploy/Workplace.war
  • The custom configuration files that are located in the deployed Workplace directory on the source system must be copied to the following "install location" on the destination:
    All application servers
    install_path/Workplace/WEB-INF/
    Important: The term "deployed" Workplace directory refers to the deployment of the Workplace application and not the deployment of the entire FileNet P8 system.
  • Do not transfer a copy of the bootstrap.properties file from the Workplace_installed_dir\Config\WebClient directory located on the source system to the corresponding directory on the destination system -- even if it has customized settings that you would like to retain.

    It is best that you log in to Workplace XT to configure and save the bootstrap.properties file on the destination system as you would with any new installation of Workplace XT. You can then manually enter the customized settings to match the customized settings on the source installation, if needed.



Last updated: March 2016
roadmap_workplace.htm

© Copyright IBM Corporation 2016.