IBM FileNet P8, Version 5.2.1            

Workplace Base Extensions

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
  • Base Content Engine Extensions
  • Process Engine Extensions
  • Base Application Extensions
  • Stored Search Extensions
  • Publishing Extensions
Required By
  • Workplace Access Roles Extensions
  • Workplace E-mail Extensions
  • Workplace Forms Extensions
  • Workplace Templates Extensions

Workplace Base Extensions add property templates and custom subclasses and properties:

Important: Workplace Base Extensions provides classes and properties that 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.

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

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 the administration console object store navigation pane in the Data Design > Choice Lists > Preference Type folder.

Properties of Document Class and Subclasses

The following properties are added to the Document Class by Workplace Base Extensions.

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.

Subclass Modifiable Description
Preferences Document No Used to persist user and site preferences that 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.

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 the administration console object store navigation pane in the Data Design > Choice Lists > Preference Type folder.

Properties of Custom Object Class

The following property is added to the Custom Object class (and all subclasses) by Workplace Base Extensions.

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

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.

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.


Last updated: October 2015
_start_here_wpcom.htm

© Copyright IBM Corporation 2015.