KC Search

Group

Field

Type/ Options

 Optional/
Mandatory 

Description

Basic

Database

Text

M

Enter the name of the database containing the KnowledgeCenter folders/articles to be searched.

Defaults to knowledgecenter

Basic

Root folder name

Text | Data object

M

Name of the primary folder to search in

Basic

Folder name

Text | Data object

M

Name of any subfolder of the root folder (or set as the same)

Basic

Language

Text | Data object

O

For use with Multi Language Support

Basic

Selected item path

Text

M

Name of container that stores the result of the selected article (which includes KC article ID, name, folder, ext_id)

Basic

Search term

Data object

M

Term used in text search (usually a data object from a form input box).

Note that:

- "[search phrase]" will return results where there is an exact match on the search phrase entered in quotes

- [word1 word2] will return results where word 1 AND word 2 occur in the article, but not necessarily together or in that order.

Basic

Result snippet length

Number

M

Maximum number of words that will be retrieved as a snippet to be displayed as the search results. Maximum limit is 64 words.

Basic

Results count path

Text

Name of data object that is populated with the number of serach results retrieved

Basic

Include topic tags

Options [1,0]

M

Option to include [1] or exclude [0] the topic tags in the search result container

Basic

Search tags

Options [on,off]

M

Option to include [on] or exclude [off] the text contained in KC article tags

Basic

Tasklist ID

n/a

n/a

Not yet released functionality

Basic

On click action

Text

O

Javascript function that controls what happens on clicking any search result. This is normally a callback function, specifics depending on the desired behavior of the client application.

Requires JS expertise, or contact your LogicNets PM regarding Professional Services to create the desired action.

Styling

Ellipses text

Text

O

Text shown at start and end of snippet to indicate partial string. For example entering "....." here would result in search results looking like this:

.....[snippet snippet snippet].....

Styling

Ellipses styling

Text

O

CSS styling declarations to be applied to ellipses text above.

Example could be color:blue;font-weight:bold;

Styling

Match styling

Text

O

CSS styling declarations to be applied to snippet text.

Example could be color: red;font-weight:normal;

Styling

No results message

Text

O

Text (with or without HTML DIV structure for additional styling options) displayed when the search returns no results.

Default text is "No results"

Styling

Search folder message

Text

O

Text (with or without HTML DIV structure for additional styling options) displayed with search results indicating the folder searched.

Default if left blank is "Searched in folder: [folder name from above]"