Workplace Base Extensions

The Workplace Base Extensions provides required functionality to support Application Engine ready-to-use behavior. This add-on feature adds several classes and properties to support user and site preferences, folder content identification, and creating and managing link associations between objects in Workplace XT, Workplace, and application integration.

Display Name
<Release> Workplace Base Extensions
XML Script Name
WorkplaceCommonExtensions.xml or WorkplaceExtensions.xml
Installation Type
Recommended
Predecessors
Required By

The Workplace Base Extensions provides property templates and implements custom classes, objects, and properties in the following areas throughout Enterprise Manager:

NOTE  The Workplace Base Extensions provides classes and properties which support ready-to-use behavior for Workplace XT and Workplace. Do not modify the values for properties on object instances created by FileNet ready-to-use applications; changing these values can cause application behavior issues with FileNet applications and add-on features. In addition, do not use other software applications to extend the classes. The descriptions included in this section are provided for informational purposes only.

Property templates

The following property templates are added by Workplace Base Extensions and implemented by various add-on features. These templates are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Property Templates.

Property Template Type Implementations Description
Container Type String Folder class Identifies the folder type and enables applications to determine folder content in a manner similar to how MIME types are implemented to identify document content. For example, iIn Workplace, container type icons can be registered to distinguish unique folder behavior, and container type strings can be used to associate actions available on a folder.
Custom Object Type String Custom Object class Specifies the type of a custom object and is used to determine which icon to display for the object in Workplace.

The customobjecticon.properties file (located at the root level of the Web tree) contains a mapping between custom object types and the icon to display for each type. At the very least, the file will contain the mapping of the base custom object type to the default custom object icon, which is located in the images/type directory. For example:

<CustomObjectType>=images/customobject/<IconName>

All other icons for other custom object types should be placed in the images/customobject directory. Icons should either be 16x16 or 32x32 bit GIF files.

Administrators can set the custom object type in Enterprise Manager to any string value specified in the customobjecticon.properties file. If the specified custom object type does not exist, or the property itself does not exist or is left unspecified, the default custom object icon is displayed. When the customobjecticon.properties file does not exist, the default custom object icon is displayed.

Custom Object Type is a hidden property added to the Custom Object class whenever a new object store is created, and inherited by all subclasses of the Custom Object class. In FileNet P8 3.5.1, a server side script will add this property to existing custom object classes.

Ignore Redirect Boolean Document class Used to specify whether the Application Engine / Workplace getContent servlet should check the redirect.properties file to determine if any custom servlets have been registered to support the retrieving of document content based on MIME type.
Preference Type String Preferences Document class Identifies the type of preference document: user (User) or site (Site). These options are specified in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Choice Lists > Preference Type.

Properties of Document Class and Subclasses

The following properties are added to the Document Class by Workplace Base Extensions. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class, right-click Properties > Property Definitions.

Property Type Modifiable Description
Ignore Redirect Boolean No Used to specify whether the Application Engine / Workplace getContent servlet should check the redirect.properties file to determine if any custom servlets have been registered to support the retrieving of document content based on MIME type.

Custom Subclasses Added to the Document Class

The following subclasses are derived from the Document Class by Workplace Base Extensions. These subclasses and their respective properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Custom Subclass Name.

Subclass Modifiable Description
Preferences Document No Used to persist user and site preferences which are then stored in a Preferences Folder.

Preferences Document, Subclass of Document Class

The following properties are added to the Preferences Document subclass by Workplace Base Extensions. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Preferences Document, right-click Properties > Property Definitions.

Property Type Modifiable Description
Application Name String No Identifies the application that created the preference document. This property is an implementation of the Application Name property template, which is added by Base Application Extensions.
Preference Type String No Identifies the type of preference document: user (User) or site (Site). These options are specified in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Choice Lists > Preference Type.

Properties of Custom Object Class

The following property is added to the Custom Object class (and all subclasses) by Workplace Base Extensions. This property is visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Custom Object and Custom Object > Custom Subclass Name.

Property Type Modifiable Description
Custom Object Type String Yes (Hidden) Specifies the type of a custom object and is used to determine which icon to display for the object in Workplace. The specified string value should exist in the customobjecticon.properties file (located at the root level of the Web tree) and the appropriate icon to display for the object type should be located in the images/customobject directory. For more information about this property, see the description of the Custom Object Type property template.

Properties of Folder Class and Subclasses

The following properties are added to the Folder Class by Workplace Base Extensions. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Folder, right-click Properties > Property Definitions.

Property Type Modifiable Description
Container Type String No Identifies the folder type and enables applications to determine folder content in a manner similar to how MIME types are implemented to identify document content. For example, in Workplace, container type icons can be registered to distinguish unique folder behavior, and container type strings can be used to associate actions available on a folder.

Custom Subclasses Added to the Folder Class

The following subclass is derived from the Folder Class by Workplace Base Extensions. This subclass is visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Folder > Custom Subclass Name.

Subclass Modifiable Description
Preferences Folder No Defines a folder to contain instances of the user and site Preferences Documents. This subclass introduces no new properties; it simply inherits the properties from the base system and folder class.

Subclasses of Link Class

The following subclass is derived from the Link Class by Workplace Base Extensions. This subclass is visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Link > Custom Subclass Name.

Subclass Modifiable Description
P8 AE Link No Defines a base link class for creating and managing link associations between objects. Workplace Base Extensions derives the Related Items subclass from the P8 AE Link Class for use by Workplace XT, Workplace, and application integration. Workplace E-mail Extensions derives the Email Items subclass to support e-mail application integration. This subclass introduces no new properties; it simply inherits the properties from the base system and link class.

Subclasses of P8 AE Link (Link Class)

The following subclass is derived from the P8 AE Link Class by Workplace Base Extensions, which itself is a subclass of the Link Class. This subclass is visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Link > P8 AE Link > Custom Subclass Name.

Subclass Modifiable Description
Related Items No Used to create link associations between related objects. For example: to create a link association between a Marketing Requirements Microsoft® Word document with the related Microsoft® Excel document that represents the Engineering Design Specification for the requirements document.

Related Items, Subclass of P8 AE Link

The following properties are added to the Related Items subclass by Workplace Base Extensions. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Link > P8 AE Link > Related Items, right-click Properties > Property Definitions.

Property Type Modifiable Description
Description String No Allows the user to capture a description that further identifies the purpose of this link. This property is an implementation of the Description property template, which is added by Base Application Extensions.
Title String No Identifies a title for the link. This property is an implementation of the Title property template, which is added by Publishing Extensions.