Base Content Engine Extensions

The Base Content Engine Extensions add a mechanism for generating a map (array) of lookup strings, which can be implemented to locate custom or application-specific properties, as well as to create labels for generic properties. This AddOn also specifies a title for all documents stored in a FileNet P8 Content Engine object store, which becomes the Name property for all P8 applications, and provides the ability to indicate whether the GUI elements that represent a folder in FileNet P8 should be made visible to the user.

Display Name
<Release> Base Content Engine Extensions
XML Script Name
ContentEngineInstallObjects.xml
Installation Type
Recommended
Predecessors
None
Required By

The Base Content Engine Extensions provide property templates and implement custom classes, objects, and properties in the following areas throughout Enterprise Manager:

Unless otherwise noted, any vendor software client may modify the following property values to address application-specific needs, even when initial values have been provided by Content Engine and Workplace XT or Workplace. However, property values should only be modified when a thorough knowledge of their use throughout all applications is well understood.

Property Templates

The following property templates are added by Base Content Engine Extensions and implemented by various feature AddOns. These templates are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Property Templates.

Property Template Type Implementation(s) Description
AssociatedPropertyID GUID
Application Defined Templates, StringLookup, and Version Status Lookup classes
The identifier for a particular property of the class with which this instance of the StringLookup subclass is associated. This is the identifier for the string name specified in the PropertyLookupName property.
Component Binding Label String Document class This is a string property added to the Document base class to support dynamic label component relationships between a parent and child document in a compound document.
Document Title String
Document class
Provides a title for all documents stored in a FileNet P8 Content Engine object store, where the maximum length of the title is 255 characters. This property is the Name property for all P8 applications. For more information about the Name property, see Class properties (Property Definitions tab) and Name properties.
IsHiddenContainer Boolean
Folder class
Indicates whether the GUI elements that represent a folder in FileNet P8 should be made visible to the user. By default, this property is set to False causing the GUI elements to be displayed. This property is not directly enforced by Content Engine, but is employed by the client application, such as Workplace.
LookupIDList String
Application Defined Templates, StringLookup, and Version Status Lookup classes
An ordered array of identifiers that correspond to the list of lookup strings specified in the LookupList property.
LookupList String
Application Defined Templates, StringLookup, and Version Status Lookup classes
An ordered array of strings representing the list of lookup strings.
PropertyLookupName String
Application Defined Templates, StringLookup, and Version Status Lookup classes
The string name for a particular property of the class with which this instance of the StringLookup subclass is associated. The corresponding identifier for the string is specified in the AssociatedPropertyID property. When the PropertyLookupName property is available, it becomes the Name property for all P8 applications. For more information about the Name property, see Class properties (Property Definitions tab) and Name properties.

Properties of Document Class and Subclasses

The following properties are added to the Document Class by Base Content Engine 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
Component Binding Label String Yes This is a string property added to the Document base class to support dynamic label component relationships between a parent and child document in a compound document.
Document Title String
Yes
Provides a title for all documents stored in a FileNet P8 Content Engine object store, where the maximum length of the title is 255 characters. This property is the Name property for all P8 applications. For more information about the Name property, see Class properties (Property Definitions tab) and Name properties.

Custom Subclasses of Custom Object

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

Subclass
Modifiable
Description
StringLookup
Yes
Facilitates the mechanism of generating a map (array) of lookup strings. This class can be implemented to locate custom or application-specific properties, as well as to create labels for generic properties, such as version status.

Base Content Engine Extensions also add two subclasses derived from the StringLookup class to Enterprise Manager: Application Defined Templates and Version Status Lookup.

StringLookup, Subclass of Custom Object

The following properties are added to the StringLookup subclass by Base Content Engine Extensions. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Custom Object > StringLookup, right-click Properties.

Property Type
Modifiable
Description
AssociatedPropertyID GUID
Yes
The identifier for a particular property of the class with which this instance of the StringLookup subclass is associated. This is the identifier for the string name specified in the PropertyLookupName property.
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 in the Workplace Base Extensions section.

LookupIDList String
Yes
An ordered array of identifiers that correspond to the list of lookup strings specified in the LookupList property.
LookupList String
Yes
An ordered array of strings representing the list of lookup strings.
PropertyLookupName String
Yes
The string name for a particular property of the class with which this instance of the StringLookup subclass is associated. The corresponding identifier for the string is specified in the AssociatedPropertyID property. When the PropertyLookupName property is available, it becomes the Name property for all P8 applications. For more information about the Name property, see Class properties (Property Definitions tab) and Name properties.

Properties of Folder Class and Subclasses

The following properties are added to the Folder Class by Base Content Engine 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
IsHiddenContainer Boolean
Yes
Indicates whether the GUI elements that represent a folder in FileNet P8 should be made visible to the user. By default, this property is set to False causing the GUI elements to be displayed. This property is not directly enforced by Content Engine, but is employed by the client application, such as Workplace.

Custom Objects

The following objects are added to the object store by Base Content Engine Extensions. These objects and their respective properties are visible in Enterprise Manager by running a query for their name or their class.

Subclass
Modifiable
Description
Application Defined Templates
Do not delete
This object is an instance of the StringLookup Subclass that provides a lookup for the names and identifiers associated with Application Security Templates. The object maintains pairs of string names and identifiers, which are strictly implemented by Enterprise Manager to enable users to select application-specific security policies and templates.
Version Status Lookup
Do not delete
This object is an instance of the StringLookup Subclass that provides a lookup for the names and identifiers which correspond to the four version states of a document: Released, In Process, Reservation, and Superseded. Document version states within Content Engine are assigned numbers, rather than names. Applications can either hard code string names to correspond with these version state values, or they can use the Version Status Lookup object to lookup application-specific names for these states. This object is used by Workplace XT, Workplace, and Enterprise Manager to display the proper name for a version state.

Application Defined Templates

The following properties are modified by Base Content Engine Extensions. These properties are visible in Enterprise Manager by running a query for the custom object's name or class, then clicking the Application Defined Templates custom object in the Search Results pane, then right-click Properties. For a complete description of these properties, see the StringLookup Subclass.

Property Type
Modifiable
Description
AssociatedPropertyID GUID
Yes
No value specified.
LookupIDList String
Yes
No value specified.
LookupList String
Yes
No value specified.
PropertyLookupName String
Yes
Application Defined Templates

Version Status Lookup

The following properties are modified by Base Content Engine Extensions. These properties are visible in Enterprise Manager by running a query for the custom object's name or class, then clicking the Application Defined Templates custom object in the Search Results pane, then right-click Properties. For a complete description of these properties, see the StringLookup Subclass.

Property Type
Modifiable
Description
AssociatedPropertyID GUID
Yes
{36321A70-7F6E-44CD-9B49-738615072081}
LookupIDList String
Yes
{95ad7aed-dfa0-4459-ae95-2ca2fc041602},
{e76e4f72-545c-4180-97c1-8449883b83cf},
{f9ed916d-ccb7-4d7e-8cc1-563f1692c67c},
{a0a5a26e-d19f-4415-8451-6795386ad1bb}
LookupList String
Yes
Released, In Process, Reservation, Superseded
PropertyLookupName String
Yes
Version Status Lookup

Folders

The following folders are added to the object store by Base Content Engine Extensions. These objects and their respective properties are visible in Enterprise Manager by Domain Root > Object Stores > Object Store Name > Root Folder > Folder Name.

Folder Name
Modifiable
Description
CodeModules
Do not delete
When an event action is created successfully, the associated code module is checked into the object store and filed in a folder named CodeModules under the Root Folder. All code modules created through Enterprise Manager are filed in the CodeModules folder.