This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
admin:indexing:powersearch:custom [2012/01/30 19:25] doc |
admin:indexing:powersearch:custom [2012/01/30 22:49] doc |
||
|---|---|---|---|
| Line 17: | Line 17: | ||
| ==== Custom Usages ==== | ==== Custom Usages ==== | ||
| + | |||
| + | Usages are essential to the customization of PowerSearch. The POWERSEARCH option instructs Omnidex to evaluate the columns referenced in the WHERE clause of the SELECT statement, and matches their USAGE clauses with the preconfigured instructions for each USAGE. These instructions describe actions such as using synonyms, checking for misspelling, or even doing geographic searches. | ||
| + | |||
| + | |||
| + | === The Usages File Layout === | ||
| + | |||
| + | These preconfigured instructions can be customized or expanded to meet the needs of each application. The usage instructions exist in a tab-delimited file with six columns. It can be modified using a text editor such as 'Notepad' on Windows or 'vi' on UNIX. It can also be created in a spreadsheet program such as Microsoft Excel, which allows a file to be saved as a Tab-Delimited File. | ||
| + | |||
| + | The record layout of the usages table consists of six columns: | ||
| + | |||
| + | ^ Column Name ^ Datatype ^ | ||
| + | | $LIST | CHARACTER(32) | | ||
| + | | $USAGE | CHARACTER(32) | | ||
| + | | $PARSING | CHARACTER(32) | | ||
| + | | $FORMAT | CHARACTER(255) | | ||
| + | | $POWERSEARCH | STRING(4094) | | ||
| + | | $COMMENTS | STRING(255) | | ||
| + | |||
| + | == $LIST == | ||
| + | |||
| + | The name of the list, repeated for each row in the list. This name can be optionally referenced in the POWERSEARCH option to specify a specific list of usages. This allows different applications to use different sets of PowerSearch instructions. Omnidex is shipped with only one list named DEFAULT, which is used if no list is provided. | ||
| + | |||
| + | == $USAGE == | ||
| + | |||
| + | The name of the usage as declared for the column in the CREATE TABLE statement. | ||
| + | |||
| + | == $PARSING == | ||
| + | |||
| + | This column is reserved for future use and not used in this version of Omnidex. | ||
| + | |||
| + | == $FORMAT == | ||
| + | |||
| + | This column is reserved for future use and not used in this version of Omnidex. | ||
| + | |||
| + | == $POWERSEARCH == | ||
| + | |||
| + | The replacement string to be substituted in the WHERE clause when the POWERSEARCH option is used. There are special tokens that can be referenced in this field: | ||
| + | |||
| + | * %COLUMN% - This token is replaced with the name of the column applying this usage. | ||
| + | * %CRITERIA% - This token is replaced with the criteria passed in the WHERE clause for this column. | ||
| + | |||
| + | Typically, the replacement string uses a [[dev:sql:functions:contains|$CONTAINS]] clause that applies synonyms, misspellings or other Omnidex features. The use of a $CONTAINS clause is not required, though. While every SQL construct cannot be supported, administrators can use a wide variety of SQL clauses in this section, including complex, parenthesized, Boolean predicates, nested queries, etc. | ||
| + | |||
| + | == $COMMENTS == | ||
| + | |||
| + | Comments that are useful to the administrator to document this usage.. | ||
| + | |||
| + | |||
| ==== Custom Synonym Lists ==== | ==== Custom Synonym Lists ==== | ||
| Line 38: | Line 86: | ||
| | $WORD | STRING(127) | | | $WORD | STRING(127) | | ||
| | $REPLACEMENT | STRING(4094) | | | $REPLACEMENT | STRING(4094) | | ||
| - | |$COMMENTS | STRING(255) | | + | | $COMMENTS | STRING(255) | |
| Line 84: | Line 132: | ||
| | FIRST_NAMES | RICK | Rick, Ricky, Richard, Dick, >Fredrick | | | | FIRST_NAMES | RICK | Rick, Ricky, Richard, Dick, >Fredrick | | | ||
| + | == $COMMENTS == | ||
| + | |||
| + | Comments that are useful to the administrator in documenting this synonym. | ||
| === Installing a New Synonym List === | === Installing a New Synonym List === | ||