IBM FileNet P8, Version 5.2.1

Creating custom search functions

A custom search function is a user-defined function that can be included in a search expression. A function is evaluated one time for each search result row.

For an example of a search function in a search expression, see Relational query syntax introduction.

Before you begin

Implement the SearchFunctionHandler interface in either JavaScript or Java™. See Implementing a Search Function Handler.

About this task

You create a search function with a search function definition, which references the implemented search function handler. The name of the search function is specified in the search function handler in the following format: name-space::short-name. This same name must be used in the search expression to reference the search function. The name of a search function and the name of the search function definition for that function can be different.

Start of change You cannot use custom search functions in a stored search. You can use these functions in ad hoc or background searches in a SELECT list only. End of change

Tip: To use predefined search functions, install the Reporting Enablement Extensions add-on. For information about these predefined functions, see Search Function Definitions.

Procedure

To create a search function definition:

Start the New Search Function Definition wizard in the administration console:
1. In the domain navigation pane, select the object store.
2. In the object store navigation pane, select the Events, Actions, Processes > Search Function Definitions folder.
3. On the Search Function Definitions tab, click New.
Complete the wizard.