Stored Search Extensions

The Stored Search Extensions add-on is created by Search Designer. This add-on feature contains a class and properties representing the information that is selected by the user by using Search Designer, such as the object stores and folders to search, object types and subclasses to query, the search criteria for each object type and the formats to use for the search results.

Display Name

Release Stored Search Extensions

XML Script Name

StoredSearchExtensions.xml

Installation Type

Recommended

Predecessors

Base Content Engine Extensions
Process Engine Extensions
Base Application Extensions

Required By

Workplace Access Roles Extensions
Workplace Base Extensions
Workplace E-mail Extensions
Workplace Templates Extensions

Stored Search Extensions provides property templates and implements custom classes, objects, and properties in the following areas:

Property templates
Subclasses of Document Class

You can view property templates in the administration console object store navigation pane in the Data Design > Property Templates folder.

Important: Stored Search Extensions provides classes and properties that support ready-to-use behavior for searching, including those created and modified by Search Designer. 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 Stored Search Extensions and implemented in the Stored Search class.

Property Template	Type	Implementations	Description
Search Type	Integer	Stored Search class	Specifies whether this is a stored search or a search template. A stored search contains a complete search ready for use and can include criteria based upon contents and property values of entities. A search template allows the user to modify the search criteria data and subclasses before the search is executed.
Searching Object Stores	String	Stored Search class	Specifies the object stores to be queried during execution of the search.
Searching Object Type	Integer	Stored search class	Specifies the types of objects to be searched for during execution of the search, including Document, Folder, Custom Object, or any combination of these types.

Custom Subclasses Added to the Document Class

The following subclasses are derived from the Document Class by Stored Search Extensions.

Subclass	Modifiable	Description
Stored Search	No	Contains the information selected by the user via the Search Designer, including the type of stored search to perform, the object types to search for and the object stores to query, as well as the name of the application associated with the search and a description.

Stored Search, Subclass of Document Class

The following properties of the Stored Search subclass are added or modified by Stored Search Extensions.

Property	Type	Modifiable	Description
Application Name	String	No	Specifies the name of the application that created the stored search or search template, which is entered by the user via the Search Designer UI when the stored search is created and saved. If the user does not enter a name, this property will be empty. This property is an implementation of the Application Name property template, which is added by Base Application Extensions.
Description	String	No	Provides a contextual description for the stored search or search template, which is entered by the user via the Search Designer UI when the stored search is created and saved. If the user does not enter a description, this property will be empty. This property is an implementation of the Description property template, which is added by Base Application Extensions.
Search Type	Integer	No	Specifies whether this is a stored search or a search template. A stored search contains a complete search ready for use and can include criteria based upon contents and property values of entities. A search template allows the user to modify the search criteria data and subclasses before the search is executed.
Searching Object Stores	String	No	Specifies the object stores to be queried during execution of the search.
Searching Object Type	Integer	No	Specifies the types of objects to be searched for during execution of the search, including Document, Folder, Custom Object, or any combination of these types.