> For the complete documentation index, see [llms.txt](https://docs.yansalabs.com/onesearch/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yansalabs.com/onesearch/technical-docs/getting-started.md).

# Getting Started

{% hint style="info" %}
If you haven’t already, you may want to watch available demo videos at the [Yansa Labs YouTube](https://youtube.com/playlist?list=PLa0hU0AR7Alskf9L7dhBF4CZrFOrIeis2\&si=kU8FxUqVmogt6wIb) channel. Most examples shown in the videos are included with the app.
{% endhint %}

## Installation

First, install OneSearch on your ServiceNow instance via the **System Applications** application in your left nav. Visit **YDS OneSearch** in your left nav and peruse the available modules. Be sure to enable annotations in your instance by clicking the **‘…’** icon in the top-right of any form. Every OneSearch form includes documentation to help you along. In particular, you will find useful information in the **Docs & Settings** module and the **Searchers** and **Sections** forms.

Finally, visit **YDS OneSearch->Test Page** to try out OneSearch against your KB and Service Catalog in Service Portal. It’s as easy as that! When you’re ready to try out OneSearch on a form, simply visit your Incident form, right-click the header, select **Personalize Form** and add the **YDS OneSearch** formatter beneath. Save, and you’re all set!

## Roles

* **x\_yala\_yds\_search\_user**: Necessary to view application & access some components, such as test pages, search logs, etc
* **x\_yala\_yds\_search\_admin**: Necessary to configure OneSearch

## Usage

#### The best way to get to know OneSearch is to use it, so we encourage you to get hands on. Here are a few basics to get you started.

* **Searchers** in OneSearch are the parent item that you can expose on your forms, pages, workspaces, etc. Searchers contain everything else.

<figure><img src="/files/n8t5Z1vGTQw61sVltSz8" alt=""><figcaption><p>Searcher</p></figcaption></figure>

* Within each Searcher can be one or more **Sections**, each having its own tab in the interface. Generally, each Section correlates to a search source, such as your KB, Service Catalog, or an external database.

<figure><img src="/files/UugAK4s3Vv7Xx7Wflbmo" alt=""><figcaption><p>Searcher Section</p></figcaption></figure>

* Within each Section, you can add **Filterable Fields** or **Order-by Fields**. These provided filtering and ordering capabilities that users may use to home in on the results they need.

<div><figure><img src="/files/RRn3826kjb4myhY3zZFC" alt=""><figcaption><p>Filterable Fields</p></figcaption></figure> <figure><img src="/files/ReyLQiMmzaz0GImc8HAt" alt=""><figcaption><p>Order-by Fields</p></figcaption></figure></div>

* Within each Section, you can also add **Actions**. Actions are like superpowers for your technicians, enabling them to complete multi-step client-side & server-side activities with a single click. Examples are attaching a KB article to a ticket and notifying the end user, associating an Incident to a parent Problem, or even kicking off a Flow.

<figure><img src="/files/fdTFJ6i4NmEm35vK0rFm" alt=""><figcaption><p>Actions</p></figcaption></figure>

* The look and feel of your Searchers can be customized by selecting or building custom [**Skins**](/onesearch/technical-docs/skins.md).
* The [**Analytics**](/onesearch/technical-docs/analytics.md) module is a great place to see the work OneSearch is doing in your environment. You can dig deeper into [**Search Logs**](/onesearch/technical-docs/analytics.md) to understand exactly what your users are doing and continually improve your content and search capabilities.