Site Search > App Settings > Data Management

The SearchStax Site Search solution offers several tools for uploading your website content to the Site Search index.

• Sitecore Module: Connects Sitecore directly to the SearchStax Site Search solution and lets you publish a custom search page immediately.
• Connectors: This menu option appears for Apps that elect Sitecore or Drupal connectivity.
  • Drupal Module: Integrates Site Search with recent versions of Drupal.
  • Crawler: The Crawler indexes the pages of your website starting with a single root node.
• Ingest API: Provides examples of using the Site Search /update endpoint.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Data Management appeared first on SearchStax Docs.

Site Search > App Settings > Data Management > Crawler

The SearchStax Site Search solution offers a Crawler add-on for Enterprise clients. The Crawler indexes the pages of your website starting with a single root node. See Crawler Walkthrough for the full procedure.

Crawler Perspective

For perspective on the Crawler feature (and a video demonstration) see Data Ingestion for Site Search.

Contents:

This page covers the following topics:

• What is the Crawler?
• Configure the Crawler
• Crawler List
• Settings Tab
  • Crawler Name
  • Start URL
  • Crawl Depth
  • Schedule
  • Manage Fields for Search Index
  • Exclusions
• History Tab

What is the Crawler?

The SearchStax Site Search solution’s Crawler is an add-on connector that finds and indexes all of the pages of a website, making them searchable through a Search App.

The Crawler begins with a root URL and follows page links from there to all connected pages using the same corporate domain, subject to a configurable crawl-depth limitation.

Each Search App can have multiple crawlers, putting multiple websites into a single combined index.

The crawlers automatically refresh the index at a predetermined interval, updating, adding, and deleting index entries as needed.

Configure the Crawler

If the Crawler feature is enabled for your Enterprise account, you’ll find it listed under Site Search > App Settings > Data Management > Crawler in the Navigation Menu:

This link opens the Crawler list, which is initially empty.

Crawler List

A Search App can have one or more Crawlers, each indexing pages from one or more websites.

How Many Crawlers Can You Have?

An Enterprise account may be authorized to create several concurrent crawlers. This limit is applied to the account, not to individual Site Search Apps. The progress bar on this screen shows the number of crawlers and the account limit.

From this list, you can monitor crawler status, open an editor to create or modify a crawler, kick off an immediate crawl, or delete a crawler.

When you rerun a crawler, it updates records of existing pages and deletes the records of pages that are no longer reachable. When you delete a crawler, the web pages it found are removed from the index.

To initiate a crawl, check the crawler in the list and use the Crawl Now button.

To view a crawler’s details, settings, and history, click the desired crawler in the list.

Settings Tab

Clicking on a crawler in the Crawler List takes you to the Crawler Details screen. Select the Settings tab.

Crawler Name

Each crawler in your SearchStax account must have a unique name. The names can be multi-word, mixed-case, and alphanumeric. Site Search will ignore case when checking for redundant names.

Start URL

The crawler requires a starting or “seed” web page to anchor the crawling process. The crawl follows all the outgoing links from that page recursively until it runs out of pages that have the same DNS domain as the starting page. The crawler will not wander into other domains. Create a second crawler if you want to include pages from another domain in the same index. Your Search App can support more than one, subject to the terms of your contract.

The Start URL can also point to a sitemap file, such as:

https://example.com/sitemap.xml

or a sitemap-index file:

https://example.com/sitemap_index.xml

Crawl Depth

The “crawl depth” is the number of links crawled from the Start URL. It has three defaults, depending on the Start URL:

• If the starting page is a sitemap.xml file, the default crawl depth = 1.

• If the starting page is a sitemap-index.xml file, the default crawl depth = 2.

• Otherwise, the default crawl depth is “0” meaning “unlimited.”

You can manually select a crawl depth of 1 through 10 to customize your crawl.

Schedule

When enabled, the crawler repeats its crawl daily at the indicated local time. Subsequent crawls add newly found pages, delete pages that can no longer be found, and refresh the remainder.

Subject to your contract, Site Search will impose a limit of one crawl per day.

Manage Fields for Search Index

The crawler maps information about a web page to Solr schema fields in the Site Search index. Although the crawler has a default set of mappings, some customization is normal. The Fields table lets you edit and refine your field mappings.

For a discussion of the default field mappings, see Crawler Default Fields.

You can delete a field using the in-line trash-can icon in the rightmost column.

To add a new custom field, click the Add Custom Field button. This opens a field editing form.

Notes on the field options:

• Site Search will modify the Custom Field Name to indicate the field type and language. For instance, field “paragraph” will become “paragraph-txt-en” in the list of fields.

• Meta Tag Name retrieves the content of a named meta tag in the web page. The default field list includes the “description” and “keywords” meta tags.

• XPath uses an XPath formula to scrape the content of HTML tags in the page. For instance, “//p//text()” retrieves the content of all paragraph (p) elements.

• CSS lets us input a CSS class selector. The crawler will retrieve the content of all HTML elements that match the selector. For instance, “class~=name” will match any element whose class attribute contains “name” as a separate word within a space-separated list of words.

• System offers a droplist of internal Site Search fields about a web page, such as id, title, url, and document_type. Most of these are predefined default fields.

• Field Type is a droplist of Solr schema field types: Boolean, Date, Float, Integer, String, and Text. This has implications for how the data is indexed and queried. For instance, a “String” field requires an exact whole-string match, but a “Text” field is tokenized to index individual words.

• The Apply Transformations feature becomes available when defining string and text fields. This makes transformers available to normalize irregular field values during ingestion. See Crawler Transformers in the Help Center.

Exclusions

After your initial crawl, experience may show that the Crawler needs to be more limited in scope. Exclusions are rules that prevent the crawler from exploring every branch of your domain.

Exclusion URLs: Enter part or all of a URL (or regex pattern) as the basis of an exclusion rule. Site Search will interpret it according to one of the following contexts:

• Beginning with: Excludes any page with a URL that begins with this string.
• Contains: Excludes any page containing the indicated substring.
• Ending with: Excludes any page where the URL ends with this string.
• Matching regex: Excludes any page where the URL matches the indicated regular expression.

Additional controls:

• Plus (+) icon: Click here to add the exclusion to the list of active exclusions.
• Save Changes button: Click to persist the changes you have made on this screen.

To delete an exclusion, check the box on the left of the exclusion and click the trashcan icon.

History Tab

The History tab presents summary statistics of crawler runs.

Not all of the discovered links can be crawled successfully, usually because of inappropriate file types. The Items Indexed and URL Crawled columns give a general idea of how successful the crawl was.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Crawler appeared first on SearchStax Docs.

SearchStax provides a special module that connects Sitecore directly to the SearchStax Site Search solution and lets you publish a custom search page immediately.

For perspective on the advantages of the Sitecore Module, see Data Ingestion for Site Search in our blog space.

Contents:

• What is the Sitecore Module?
• Install the Sitecore Module
• Configure the Sitecore Module
• Populate Schema and Rebuild
• Reload the Search App’s Schema
• Create a Search Page
• Computed Fields

What is the Sitecore Module?

This package is a Sitecore module that Sitecore developers can install to leverage all the search capabilities offered by SearchStax Site Search for your client-facing search pages. It contains a Sitecore index connector which can index your Sitecore items using the out-of-the-box Indexing Manager provided by Sitecore. Not only that, but it comes with a functional search page that can be built in minutes instead of weeks of work. With this package your client can focus immediately on improving the real search experience, since that is where the business value is.

Install the Sitecore Module

The first step is to contact the SearchStax team and ensure you already have a SearchStax Site Search account and App created with a Solr core configured to deal with your Sitecore. Once you have this you are ready to go.

This is almost a plug-and-play module, thus installing it is as easy as possible.

Below are the supported Sitecore versions, with the links for downloading the Sitecore package:

Once you download the package, open the Sitecore Installation Manager:

Use the Choose File option to select the downloaded file and upload it to your Sitecore.

Once the package is uploaded it’s time to properly install it. You can do this by clicking on Next and then on Install.

The installation should take no more than a few minutes. You will know the installation is completed when you see the below pop-up. Go ahead and click on the Configure SearchStax for Sitecore Package button:

Configure the Sitecore Module

Navigate to the SearchStax Module Configuration Page

From the Sitecore Launch Pad, click on the Sitecore Module Configuration button under SearchStax Site Search

This will open up the Site Search for Sitecore configuration page.

Enter credentials and select account and app.

1. Start by entering your SearchStax Site Search username and password. Then press the Load Accounts button. This will populate the Site Search Account drop down.
2. Select the appropriate Site Search Account. It’s probable only one account is available, but you might have access to multiple accounts. Once selected, this will populate the available Search Apps within the selected Studio Account.
3. Select the appropriate Search App.
4. Once you have selected the above options, then press the Create an Index button.

Configure Site Search for Sitecore

The next page that the configuration will take you to is the Index Properties page for the Search App that you selected in the previous step.

In the case that your Search App is using Basic Authentication, go here. Otherwise, follow these directions:

1. Select your root Item(s). This is going to be the Sitecore Path where the Index should start it’s indexing from. You can list multiple root item paths if there are multiple locations within your Sitecore Content tree that content should be searchable from. By default, the module will index every page under /sitecore/content/home/.

2. (Optional) You are given an opportunity to enter the Hosted Search Page Password. At this point, unless you know what this password is, and you have previously configured it, we can safely skip this field.

3. Press the Save button. Now move on to the next step.

Configure Site Search for Sitecore with Basic Authentication:

• Select your root Item(s). This is going to be the Sitecore Path where the Index should start it’s indexing from. You can list multiple root item paths if there are multiple locations within your Sitecore Content tree that content should be searchable from. By default, the module will index every page under /sitecore/content/home/.
• Read Only Solr Password and Admin Solr Password: These are the “Read-Only API Credentials” and the “Read-Write Search API Credentials” from the Search and Indexing tab of the Site Search > App Settings > All APIs screen. You’ll have to scroll down to the bottom of the screen to find them. The User ID is set by the system, but you can set the password (both Read only and Read Write need to be set).

• (Optional) You are given an opportunity to enter the Hosted Search Page Password. At this point, unless you know what this password is, and you have previously configured it, you can safely skip this field.

• Reset Index When Rebuilding: Check this field if you want SearchStax to completely clear your index right before rebuilding it. Keep in mind that doing so your index will be empty during the rebuilding process, which might take minutes, and that your search page will return no results during this period of time.

• Press the Save button.

After pressing Save you’ll be prompted a confirmation box. Press confirm to allow Sitecore to apply the appropriate configuration files.

Validate Index Creation and Populate Managed Schema

Once you have installed and configured the Sitecore module, you must run a Populate Schema operation on this new Solr collection to update its schema with the one used by Sitecore. You can find more details about this at https://doc.sitecore.com/xp/en/developers/90/platform-administration-and-architecture/solr-managed-schemas.html. This is a common operation that must be executed on every Solr index used in Sitecore and is very easy to perform. Open your Sitecore admin page and click on Control Panel -> Populate Solr Managed Schema.

Select your previously configured core name and then click on Populate.

Once this operation is completed, you should see a success message like this:

Now go back to the Control Panel and click on Indexing Manager. When it opens, select your previously configure core name and click on Rebuild.

Usually, it should only take a few minutes but keep in mind that the time this operation will take is proportional to the number of items you have in your Sitecore. 

Once this operation is completed you should see a success message like this:

This means that your schema is updated and your SearchStax index is ready to receive new indexed items and search queries.

Reload the Search App’s Schema from within the Site Search Dashboard

At this point, we navigate away from Sitecore and login to your SearchStax Site Search Dashboard.

(You can search SearchStax Site Search directly by going to www.searchstudio.com or click on Search Management from within Sitecore as shown below.)

1. From within Site Search, select the App you are in the process of setting up.  Site Search > Profile Selector > Apps List.
2. Then navigate to Site Search > App Settings > All APIs, scroll to the bottom of the screen, and press the Reload Schema button.

Rebuild the Index

Head back to the Sitecore Control Panel and select Indexing Manager.

Select the appropriate index and then click the Rebuild button.

Create a Search Page

• Configure Result Fields in Site Search
  • Go to Site Search > Navigation Menu > Search App > Search > Results Configuration
  • Select all fields that you would like to be displayed in Result Items. You can map some of the fields to the Result Cards to show them in a special way. Make sure you have at least one field set up.
  • Click on Publish to publish the Results Configuration.

• Configure Search Fields in Site Search
  • Go to Site Search > Configurations > Basic Configurations > Search Fields.
  • From the Search Fields, select one or more fields that you would like to search on. At least one field should be selected.
  • Click on Publish.

The Sitecore Module comes with a plug-and-play search page template that you can use to create your search page in a few minutes. Use the /sitecore/templates/Feature/SearchStax/SearchPage/SearchStaxPage template to create it.

And then use the SearchStax Index field to select which index must be used by this search page when performing queries:

You just need to publish it to start testing your new search experience:

Computed Fields

The Sitecore Module uses a few computed fields out-of-the-box. These fields improve the search experience of your initial search page, but they can be replaced or removed as your project matures. The module’s computed fields are described in the following sections.

For general information on Sitecore’s computed fields, see https://doc.sitecore.com/xp/en/developers/91/platform-administration-and-architecture/create-a-computed-index-field.html.

ResultTitle

This field contains the title of the result item, based on the Sitecore item DisplayName property. If that is empty, the returned string is its Name property value.

This field is not required by the module to make it work properly. However, it is the field that the module uses as the result template title. If you decide to remove or change, do not forget to change the Site Search config connector.fields.title property on the /Views/SearchStaxPage/Index.cshtml.

ResultURL

This field contains the result URL. It leverages the native Sitecore MediaManager.GetMediaUrl method for media items to get the item URL. When the item is not a media item, this fields starts by defining the current website context. It uses the indexed item Paths.FullPath property and tries to find a website definition which has the same Database property value and has a RootPath which is a parent item from the current one. Once it finds the current website context, it then leverages the native Sitecore LinkManager.GetItemUrl method to get the item URL.

This field is not required by the module to make it work properly. However, it is the field that is used as the result template clickable URL. If you decide to remove it or change, do not forget to change the Site Search config connector.fields.url property on the /Views/SearchStaxPage/Index.cshtml.

RenderedContent

This field contains a string value that improves the search relevance of the website. It indexes not only the current item text fields, but also the text fields from every data source present on any given indexed page rendering, except the renderings on the <renderedContentFieldExcludedRenderings> configuration list.

In order to add new rendering ids to this list and remove them from being indexed by this computed field, please edit the < renderedContentFieldExcludedRenderings > node children’s values on the App_Config/Modules/SearchStax/SearchStax.Cloud.config file. This field is not required by the module to make it work properly. You can remove it from your index if you wish.

Adding a Custom Computed Field

What if you would like to add a custom computed field to the configuration? After the SearchStax index has been created, find the index within [site]/App_Config/Modules/SearchStax/SearchStax.Connector.Provider.config, where [site] is the folder of your inetpub/wwwroot/site. In the <fields hint=”raw:AddComputedIndexField”> section, add an entry for the CustomComputedIndexField:

<field fieldName="CustomComputedIndexFieldName" returnType="string">
     YourNameSpace.CustomComputedIndexField,YourNameSpace
</field>

Bear in mind that computed index fields are expensive and place a load on the CPU. One should minimize their use.

The post Sitecore Module 3.0.0 appeared first on SearchStax Docs.

SearchStax has created a Drupal Module that integrates the SearchStax Site Search solution with a Drupal 8, Drupal 9, Drupal 10, or Drupal 11 environments. This section discusses how to install and configure the module.

For perspective on the advantages of using the Drupal Module, see Data Ingestion for Site Search in our blog space.

Latest Version

The latest version of the Drupal Module is available here under Releases in the end and this version works with Drupal 9, Drupal 10, and Drupal 11. You download the installation files and view the release notes from the project page on Drupal.org.

Drupal Module Backstory

The Drupal SearchStax integration module was developed jointly with Thomas Seidl (a.k.a. drunken monkey), the renowned creator and maintainer of the Drupal Search API. The SearchStax integration module follows all Drupal open-source code guidelines and is available in the Drupal project at https://www.drupal.org/project/searchstax.

Drupal Module Documentation

The product documentation for the Drupal Module includes:

• Set up Drupal Module
• Map Drupal Fields
• Drupal Module Functionality
• Drupal Auto-Suggest
• Drupal Integration FAQs

The post Drupal Module appeared first on SearchStax Docs.

Site Search > App Settings > Data Management > Ingest API

The SearchStax Site Search solution’s Ingest API exposes the project’s /update endpoint. It lets you update Solr documents in your Site Search project. For perspective on the advantages of using the Ingest API, see our Data Ingestion for Site Search blog post.

The /update endpoint uses the “Read-Write” Search API credentials from the Site Search > App Settings > All APIs > Search & Indexing screen.

Contents:

• Indexing JSON Documents
• Indexing XML Documents
• Indexing CSV Documents
• Deleting Documents
• API Limits

Indexing JSON Documents

For indexing a single JSON document, pass the JSON document to the /update endpoint as shown below:

For apps using Token Authentication:

curl -H "Authorization: Token b70dacf3956e6e148393fbfREDACTED" -X POST -H 'Content-type:application/json' --data-binary '{"id":"1"}' "https://searchcloud-2-us-east-1.searchstax.com/12345/custom-1234/update?commit=true"

For app using Basic Authentication:

curl -X POST -H 'Content-Type: application/json' 'https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/update/json/docs' --user app40-admin:REDACTEDPWD --data-binary '
{
  "id": "1",
  "title": "Doc 1"
}'

Adding multiple documents can be done by passing an array of JSON objects to the /update endpoint as shown below

curl -H "Authorization: Token b70dacf3956e6e148393fbfREDACTED" -X POST -H 'Content-type:application/json' --data-binary '[{"id":"1","title_t":"Test Title","description_t":"Testing","group_s":"Token"}]' "https://searchcloud-2-us-east-1.searchstax.com/12345/custom-1234/update?commit=true"

curl -X POST -H 'Content-Type: application/json' 'https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/update' --user app40-admin:REDACTEDPWD --data-binary '
[
  {
    "id": "1",
    "title": "Doc 1"
  },
  {
    "id": "2",
    "title": "Doc 2"
  }
]'

If the data is in a JSON file and contains an array of JSON objects, you can make a call to the /update endpoint as shown below

curl -H "Authorization: Token b70dacf3956e6e148393fbfREDACTED" -X POST -H 'Content-type:application/json' --data-binary @example.json "https://searchcloud-2-us-east-1.searchstax.com/12345/custom-1234/update?commit=true"

curl -X POST -H 'Content-Type: application/json' 'https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/update' --user app40-admin:REDACTEDPWD --data-binary @example.json -H 'Content-type:application/json'

Indexing XML Documents

To index XML documents, you can send one or multiple <add> tags to the \update request as shown below:

For apps using Token Authentication:

curl -H "Authorization: Token b70dacf3956e6e148393fbfREDACTED" -X POST -H 'Content-type:text/xml' --data-binary 
 '<add>
    <doc>
      <field name="id">id1</field>
      <field name="title">Document1</field>
      <field name="text">This is the first document</field>
    </doc>
  </add>' 
"https://searchcloud-2-us-east-1.searchstax.com/12345/custom-1234/update?commit=true"

For apps using Basic Authentication:

curl -X POST -H 'Content-Type: text/xml' 'https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/update?commit=true' --user app40-admin:REDACTEDPWD --data-binary '
<add>
  <doc>
    <field name="id">id1</field>
    <field name="title">Document1</field>
    <field name="text">This is the first document</field>
   </doc>
</add>'

• The <add> element introduces one more documents to be added. This can be substituted by <update> to update the document.
• The <doc> element introduces the fields making up a document.
• The <field> element presents the content for a specific field.

Indexing CSV Documents

The /update endpoint can load data files in comma-separated format (CSV). The format of the data file is very simple, as shown in the books.csv example that is distributed with Solr stand-alone installation files:

id,cat,name,price,inStock,author,series_t,sequence_i,genre_s
0553573403,book,A Game of Thrones,7.99,true,George R.R. Martin,"A Song of Ice and Fire",1,fantasy
0553579908,book,A Clash of Kings,7.99,true,George R.R. Martin,"A Song of Ice and Fire",2,fantasy
055357342X,book,A Storm of Swords,7.99,true,George R.R. Martin,"A Song of Ice and Fire",3,fantasy
0553293354,book,Foundation,7.99,true,Isaac Asimov,Foundation Novels,1,scifi
0812521390,book,The Black Company,6.99,false,Glen Cook,The Chronicles of The Black Company,1,fantasy
0812550706,book,Ender's Game,6.99,true,Orson Scott Card,Ender,1,scifi
0441385532,book,Jhereg,7.95,false,Steven Brust,Vlad Taltos,1,fantasy
0380014300,book,Nine Princes In Amber,6.99,true,Roger Zelazny,the Chronicles of Amber,1,fantasy
0805080481,book,The Book of Three,5.99,true,Lloyd Alexander,The Chronicles of Prydain,1,fantasy
080508049X,book,The Black Cauldron,5.99,true,Lloyd Alexander,The Chronicles of Prydain,2,fantasy

• Line 1 is the header, containing the field names used in the index. One of these must be a unique document ID.
• Subsequent lines each represent one index record. Commas separate values. Do not allow spaces immediately following a comma.
• A missing value is denoted by two adjacent commas (,,).
• Note the dynamic fields (series_t, sequence_i, genre_s) in the header. This mechanism lets you add custom fields to your index without the labor of modifying the Solr schema.

For apps using Token Authentication:

curl -H "Authorization: Token 8a931ae9bfe3538c2b4d8121fad564c676f7de0f" 
  -H 'Content-type:application/csv'
  --data-binary @books.csv
  'https://searchcloud-1-us-west-2.searchstax.com/95338/csvuploadapp-3684/update?commit=true

For apps using Basic Authentication:

curl -H 'Content-type:application/csv'
  --data-binary @books.csv
  --user app40-admin:REDACTEDPWD
  'https://searchcloud-1-us-west-2.searchstax.com/95338/csvuploadapp-3684/update?commit=true

Deleting Documents

When experimenting with document uploads, it is often helpful to be able to clear the index or to remove specific documents. See the following Help Center topics for examples:

• Clear a Site Search Index
• Delete Individual Documents

API Limits

• All update requests should have a maximum size of 2048KB.

The post Ingest API appeared first on SearchStax Docs.

Site Search > App Settings > All APIs

The SearchStax Site Search solution’s All APIs screen consists of three tabs leading to Site Search API endpoints and credentials.

• Search & Indexing: The Search Endpoint (/emselect), the Ingest Endpoint (/update), and the Auto-Suggest endpoint (/emsuggest), plus the API credentials.
• Discovery: The Related Searches Endpoint, the Popular Searches Endpoint, and the Discovery API Key.
• Analytics: The Analytics Tracking API and the Tracking Key; the Analytics Reporting API and the Reporting Key; and the Search Feedback script.

The post All APIs appeared first on SearchStax Docs.

Site Search > App Settings > All APIs > Search & Indexing

The SearchStax Site Search solution’s Search & Indexing tab displays the Search, Update and Suggest Endpoints.

• Search Endpoint: This endpoint, ending in /emselect, sends Solr queries to the App’s database of searches, content items, feedback, and so forth.
• Update Endpoint: The Update endpoint is used to upload data to the Search App.
• Auto-Suggest Endpoint: This endpoint, ending in /emsuggest, asks for suggestions when a search query returns no results.

Basic and Token Authentication

Search Apps use either Solr Basic Authentication or Token Authentication, depending on account settings. The Search API page covers these topics.

What is the RELOAD SCHEMA button for?

When you add an indexed field to your Sitecore or Drupal site, you must come here and click the Reload Schema button to update the Site Search index. The system will be offline until the update completes.

There is no need to use this button just to update a password.

The post Search & Indexing appeared first on SearchStax Docs.

Site Search > App Settings > All APIs > Discovery

The SearchStax Site Search solution’s Discovery API tab displays the App’s Related Searches Endpoint and the Popular Searches Endpoint. It also displays the APIKeys that enable these features.  These values are used by the Related Searches API and the Popular Searches API.

You can copy the endpoints to the clipboard by clicking the copy icons.

Access to this endpoint is authorized by one or more APIKeys. You may create a key by clicking the Create Key button.

You may mark an individual key active or inactive using the slide switch beside the key. You can delete a key using the (X) delete icon.

• If you inactivate the current key, Related Searches and/or Popular Searches will not appear in the Hosted Search App.
• If you inactivate the current key, have another active key in the table, and generate the Hosted Search App, the next active key from the top of the list will be used.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Discovery appeared first on SearchStax Docs.

Site Search > App Settings > All APIs > Analytics

The SearchStax Site Search solution’s Analytics screen displays the App’s Analytics Tracking endpoint and Analytics Key.  It also presents the Analytics Reporting endpoint and key. Both of these values are used by the Search Events API to send event messages to the correct App.

In addition, the screen includes a script for collecting user feedback.

The post Analytics appeared first on SearchStax Docs.

Introduction

Using the SearchStax Site Search solution, a Search App can be tailored to the viewer’s preferred language.

• Available Languages
• Components of a Specific-Language Experience
• Adding Language-Specific Experiences
• Managing Fields for Custom Apps
• Delete a Language from the Search App
• Setting the “Default” Language
• Building a Language-Specific Experience
• Language-Specific Searching

Available Languages

Language	Drupal*	Sitecore	Custom
Arabic (ar)		Sitecore 10.0+
Bulgarian (bg)
Catalan (ca)		Sitecore 10.0+
Simplified Chinese (zh-cn)		Sitecore 10.0+
Traditional Chinese (zh)		Sitecore 10.0+
Croatian (hr)
Czech (cs)
Danish (da)
Dutch (nl)
English (en)
English – Canada (en-ca)		Sitecore 10.0+
English – Hong Kong (en-hk)		Sitecore 10.0+
English – United Kingdom (en-gb)		Sitecore 10.0+
Estonian (et)		Sitecore 10.0+
Finnish (fi)
French (fr)
French – Canada (fr-ca)		Sitecore 10.0+
German (de)
Greek (el)
Hindi (hi)		Sitecore 10.0+
Hungarian (hu)
Indonesian (id)		Sitecore 10.0+
Irish (ga)		Sitecore 10.0+
Italian (it)		Sitecore 10.0+
Japanese (ja)
Korean (ko)		Sitecore 10.0+
Latvian (lv)
Norwegian (no)		Sitecore 10.0+
Persian (fa)		Sitecore 10.0+
Polish (pl)		Sitecore 9.3+
Portuguese (pt)
Romanian (ro)
Russian (ru)		Sitecore 10.0+
Slovak (sk)
Spanish (es)
Spanish – Latin America (es-419)		Sitecore 10.0+
Swedish (sv)
Thai (th)		Sitecore 10.0+
Turkish (tr)
Ukrainian (uk)		Sitecore 10.0+
Vietnamese (vi)		Sitecore 10.0+

The default language experience of all Search Apps is English (en).

Components of a Specific-Language Experience

When a Search App has multiple languages, each one includes a complete Search Experience profile. That is, each of the enabled languages has its own:

• Analytics: The Search App maintains separate databases of user behavior for each of the enabled language experiences. The Dashboard, Searches, Items, Power Search, and Search Feedback tables all summarize user behavior for one language only.
• Search: For each language, the Search App maintains a completely separate set of Results Configurations, Basic Relevance settings, and Search Profiles. The Search Preview and Hosted Search App draw from this language-specific profile of features.
• Recommendations: Auto-Suggest and Related Searches can be enabled for all available languages.

Adding Language-Specific Experiences

To add a language, navigate to Site Search > App Settings > Languages.

Click the Add Language button. Select an available language from the list, and click the next Add Language button.

Be sure to Save the changes. It can take half a minute for the Search App to build the infrastructure to support the new language experience.

Once a language is added, you should configure the App for the language – at a minimum the Results Configuration.

Managing Fields for Custom Apps

In order to support multiple languages on a Custom App, you will need to make sure your fields are formatted compatible with Site Search. This involves customizing your schema to include fields of the proper type. These fields can then be used to store and index data in different languages and types as per your app’s specific requirements.

The dynamic fields for supported languages are already present in your schema as follows:

 <dynamicField name="*_txt_es" type="text_es"  indexed="true"  stored="true"/>
 

The snippet above is for the Spanish language, but the same format applies to all available language types.

For all fields you intend to analyze for stemming, stopwords, synonyms, etc, use the format above. These are fields you typically use as display and search fields.

If you don’t need to analyze the field, e.g., faceting, or exact match, you can use the string type _es_s.

Delete a Language from the Search App

It is also possible to delete a language from a Search App. Select the checkbox beside the language and then click the trashcan icon.

Removing a language from a Search App permanently deletes all of the language-specific Search Experience settings and the Analytics data collected through that Search Experience. You can re-add the language later, but the previous work cannot be recovered.

Setting the “Default” Language

The Languages table and the Add Language dialog box mention a “default” language. This language-specific Search Experience will be used when the Search App receives a query with no language parameter specified.

You can change the default language by using the radio buttons on the Languages screen. Be sure to Save the change.

There is also a checkbox on the Add Language dialog that has the same effect. Again, after adding the language to the Search App you must remember to Save the changes.

Building a Language-Specific Experience

When you open a Search App for editing in Site Search, you must select which language-specific Search Experience to work on. You can edit only one language experience at a time. (You can switch from one language to another as long as you remember to save your changes.)

Pull down the language droplist in the Profile Selector and choose the desired language:

From that point on, building the Search Experience is the same for all language selections. Field boosting, for instance, works the same way for English, French, and Spanish experiences. Again, be sure to save your changes.

Language-Specific Searching

Now that you’ve built a language-specific Search Experience, how can you present it to your users?

Navigate to Site Search > Configurations > Search UI > Hosted Search Experience. This screen displays the URL of the Hosted Search Experience that serves the selected language.

In the image above, we selected “ES” (Spanish) as the selected language. Site Search then displayed the URL of the Spanish Hosted Search App. When your search users follow that URL, they will see the Spanish Search Experience.

Select a different language from the Language droplist and the URL will change to match that language.

The post Languages appeared first on SearchStax Docs.