> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/platform-documentation/process-node-parts/kc-free-text-search-beta.md).

# KC Free Text Search (BETA)

## Description

The *freetextsearch* part allows you to search a Knowledge Center, for example, allowing your application users to look for all occurrences of a search term in the application's Knowledge Center. When a user types text into a text-input part, the system can use this data as a search term for the free-text search. The free-text search returns a list of articles in which a match is found for the search term.

NOTE: This part is currently in the Beta phase. You can only use this part if your company has enhanced privileges or a system package.

**Node Type:** This part is located in process nodes in the *Misc* dropdown menu.

**Used With:** You can use this part with standalone and framework-based applications.

## Editor Fields

### Basic Tab Options

| Field Name                           | Description/Use                                                                                                                                                                                                                                                                                         | Type/Options                                                                                                                                 | Optional/Mandatory |          |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -------- |
| Database                             | This is the name of the database in which you want to search. The system defaults this field to *knowledgecenter*.                                                                                                                                                                                      | Text                                                                                                                                         | Mandatory          |          |
| Root folder name                     | This is the root folder, or primary folder, in the Knowledge Center in which you want to search for resources.                                                                                                                                                                                          | Text                                                                                                                                         | Optional           |          |
| Folder name                          | This is the folder in which the system searches. The system will search through all subfolders in this folder. If you do not enter a value in this field, the system uses the root folder as the starting point for the search.                                                                         | Text                                                                                                                                         | Optional           |          |
| Language                             | This is the language of the topics through which the system searches if the application uses Multi-Language Support (MLS) functionality                                                                                                                                                                 | Text                                                                                                                                         | Optional           |          |
| Selected item path                   | This is the container that stores the result of the search. It will contain the article ID, name, folder, and ext\_id of the topics in which the search term exists.                                                                                                                                    | Text                                                                                                                                         | Optional           |          |
| Search term                          | <p>This is the term for which the system will search.<br>- "\[search phrase]" returns results where there is an exact match on the search phrase entered in quotes<br>- \[word1 word2] returns results where word 1 AND word 2 occur in the article, but not necessarily together or in that order.</p> | Text                                                                                                                                         | Optional           |          |
| Result snippet length (max 64 words) | This is the maximum number of words the system will display as a search result snippet. The maximum length is 64 and the default is 64.                                                                                                                                                                 | Number                                                                                                                                       | Optional           |          |
| Results count path                   | This is the length of the selected item paths collection.                                                                                                                                                                                                                                               | Text                                                                                                                                         | Optional           |          |
| Result as file id                    | <p>If you click this checkbox, the system returns the result as a file id instead of an item id.<br>Default: <em>off</em></p>                                                                                                                                                                           | Checkbox                                                                                                                                     | Optional           |          |
| Include topic tags                   | <p>1                                                                                                                                                                                                                                                                                                    | 0<br>If you select "1", the system also uses the search term to match on topic tags associated with any article in the Knowledge Center.</p> | Dropdown           | Optional |
| On click action                      | This allows you to set a custom action the system follows when a user clicks on a search result.                                                                                                                                                                                                        | Text                                                                                                                                         | Optional           |          |

### Style Tab Options

| Field Name            | Description/Use                                                                                                                           | Type/Options | Optional/Mandatory |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------ |
| No results message    | This is text the system displays if no results are returned.                                                                              | Text         | Optional           |
| Search folder message | <p>After displaying the search results, the system displays the folders in which it searched.<br>Default: <em>Searched in folder</em></p> | Text         | Optional           |

## Example Project

Download and import the [KC Search Example Project](/release-9/example-gallery/example-projects-for-parts/kc-search-example-project.md) into your Designer.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://community-test.logicnets.com/release-9/platform-documentation/process-node-parts/kc-free-text-search-beta.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
