FNP8_SetSearchWhereClause

Sets the search criteria (WHERE clause).

Syntax

bool FNP8_SetSearchWhereClause (StrParam)

Parameters

A string value of the SQL search criteria (that is, the WHERE clause). The criteria should follow the standard that is used by FileNet P8 query, which generally conforms to the SQL-92 standard. Smart parameters are supported. The clause is not validated until the FNP8_SearchAndDownload action is executed.

Returns

False if parameter is not a string. Otherwise, True.

Level

All levels.

Details

This action is optional before you call action FNP8_SearchAndDownload.

Set the SQL search criteria (that is, the WHERE clause). Set to empty string "" to reset a previously set WHERE clause.

Note: Only parametric search is supported, not content-based (full-text) search.

The syntax of the WHERE clause is not validated until the FNP8_SearchAndDownload action is executed. The SQL search criteria must follow the IBM FileNet standard, which generally conforms to SQL-92, with extensions for IBM FileNet specific constructs.

Example

FNP8_SetSearchClass("Invoice")
FNP8_SetSearchDownloadDir("C:/mylocaldir")
FNP8_SetSearchWhereClause("DocumentTitle LIKE '2017-Invoices%'")
FNP8_SearchAndDownload()