Workplace XT assets

Workplace XT 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 XT.

Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies

The site preferences in which the access roles are configured

NOTE Enterprise 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 referenced by the Secured Role property

Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.

Notes

The access roles for a Workplace XT site are stored in an Access Roles folder within the source object store that is specified in the site preferences for the Workplace XT installation.

When you import access roles, Enterprise Manager might return a bad reference exception if access roles already exist in the destination object store. If this exception occurs, the access roles are still imported. However, Enterprise 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 using the Entry Template Designer, can provide default values for the destination folder, properties, and security. The entry template may hide some pages in the add wizard, and the template may launch a workflow when the new item is added.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies
  • The class definitions and property definitions of the document class specified by the Target Object Class Id property
  • The workflow referenced by the document entry template

NOTE Enterprise 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 referenced by the Entry Template Object Store Name property
  • The object store referenced by the Target Object Store Name property

Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying 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 using the Entry Template Designer, can provide default values for the destination folder, properties, and security. The entry template may hide some pages in the add wizard, and the template may 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
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies
  • The class definitions and property definitions of the folder class specified by the Target Object Class Id property
  • The workflow referenced by the folder entry template

NOTE Enterprise 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 referenced by the Entry Template Object Store Name property
  • The object store referenced by the Target Object Store Name property

Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying 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
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies Links and, if used, their custom Link subclasses are automatically added to the export manifest as associated objects.

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes This feature needs to be enabled in the site preferences for the Workplace XT Site. So if you are deploying this object you need to either deploy the site preferences from your source site to your destination or you need to enable links on your destination.

Search template

Description Represents a file created in Search Designer that is run from either the Workplace XT Search or Browse page. Using the search template usually prompts the Workplace XT user to enter or change values and then displays a list of the documents that meet the search criteria.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See 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 referenced by the Searching Object Stores property

Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying 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 will need to be exported to the appropriate target object stores.

Site preferences

Description Provides configuration settings that affect Workplace XT appearance, behavior, and connectivity. Administrators set site preferences using the Site Preferences application. Non-administrative users can set personal preferences, which override some site preferences.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying 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, Enterprise Manager might return a bad reference exception if site preferences already exist in the destination object store. If this exception occurs, the site preferences are still imported. However, Enterprise Manager places them in the Unfiled Documents folder. You must move them to the Preferences folder.

Enterprise 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.

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

Stored search

Description Represents a file created in Search Designer that is run from the Workplace XT Browse page. Using the stored search displays a list of the documents that meet the search criteria.
Deployment Mechanism
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See 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 referenced by the Searching Object Stores property

Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying 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
  1. Enterprise Manager export tool: See Create export files.
  2. FileNet Deployment Manager conversion tool: See Convert objects for import.
  3. Enterprise Manager import tool: See Import converted objects.
Dependencies

The user account for which the user preferences are set

See Common dependencies between objects.

Environment-specific data Any object exported from an object store contains a set of basic permissions that controls access to that object. These permissions contain environment-specific information identifying users and groups. For more information, see Permission.
Notes User preferences files are saved in the /Preferences folder of the object store.

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 or update a security principal data map.

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

Workplace XT add-on features

Email

Description

Provides functionality 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, as well as 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 XT 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 XT.