Install a Search Client in Khoros

Installing a search client on Khoros boards helps you find discussions and posts faster. This article shares the instructions on installing the Khoros search client. To start, download your Khoros (Lithium) search client and extract the components of the .zip file.

Create New Endpoints

There are five endpoints that need to be created for different SearchUnify properties, including setting up the connection between Khoros and SearchUnify, to collect search analytics, and to provide search recommendations.

1. Sign into your Khoros community as an admin. Click on your profile icon and select Community admin.

   

2. Click Studio.

   

3. Navigate to Endpoints and click New Endpoint.

   

4. Give your endpoint a Title and click Save.

   

    

5. Open the searchUnify_Endpoint file from the extracted search client files and copy its code.

6. Paste the code in View Content and select application/json as View Content Type. Press Save.

   

7. Similarly, create four more endpoints and use the code from searchunify_live_counts, searchunify_Recommedations, searchUnify_GptEndpoint, and searchunify_saves_results_Endpoint respectively. Make sure to select application/json as View Content Type for all the endpoints.

8. Copy the names of the all the endpoints.

   

Create New Khoros Component

1. Navigate to Components and click New Component.

   

2. Give your component a name and click Create.

   

3. Open the searchUnify_Component file from the extracted search client files and copy the code.

4. Paste the code in Component Content.

   

5. Scroll down the Component Content code and replace <your endpoint name> with respective endpoint names. For example, the name of the endpoint created with searchunify_Endpoint will go to the window.su_community_path.

   

   NOTE. Make sure you remove the angle brackets (<>) from the endpoint names and paste the endpoint names in this format: ("endpoint_name").

6. After you have entered all the endpoint names, press Save.

OPTIONAL. Create a New Khoros Page

The Khoros component that you created is to be inserted into a Khoros page. You can select one of your existing community pages to host SearchUnify-powered search and search results, or create a new page. This section explains how to create a page in Khoros from scratch.

1. Navigate to Page, and click New.

   

2. Enter a page name in New Page Name prefixed by ForumPage., select a layout from the Page Layouts dropdown (we recommend using One Column), and click Create.

   

Insert SearchUnify Component in a Khoros Page

1. From Admin > Page, open the page on which you want to use the search component. You can select the new page that you created or an existing page.

2. Expand Custom Components.

   

3. Click to add the component on the selected page.

   

4. Drag the component to main-content and press Save.

   

Insert SearchUnify Page on a Khoros Board

1. Navigate to Admin > Community Structure.

   

2. Click on Choose to select the Khoros Board on which you want to insert the page. For illustration, we selected the KhorosBoardM.

   

   NOTE. Select only a Khoros board. No other Khoros object is supported in SearchUnify.

3. Navigate to Content > Custom Pages.

   

4. In the Forum Page dropdown, select the page on which you deployed the SearchUnify component (refer to the Insert SearchUnify Component in a Khoros Page section). And click Save.

   

5. Click Go to Board and you will land on the search page powered by SearchUnify.