Kryloff Technologies Configuring Subject Search Server™
Search the site for: 
Subject Search Spider
Subject Search Scanner
Subject Search Pad
Subject Search Summarizer
Subject Search Siter
Subject Search Sleuth
Subject Search Server
   Technical details
   Download
KT Text Filters

Configuring Subject Search Server™:
Instructions for Web Masters

SSServer™ and Subject Search Server™ are trademarks of Kryloff Technologies, Inc.
Table of Contents
  1. Introduction
  2. SSServer Search Form
  3. Search Query Parameters and Macro Instructions
  4. Multi-language Support in SSServer
  5. Remote Installation
  6. File Types Supported by SSServer
  7. System Requirements and SSServer Messages

1. Introduction

SSServer™ is a powerful search tool that automates the retrieval and selection of all the useful information available on your Web Site. SSServer allows to:

  1. Search for data based on users' questions. The resulting reports contain the most relevant data retrieved directly from your site. Furthermore, users may enter questions in the language of their choice (see also: Multi-language support in SSServer).
  2. Build a map of your site. SSServer formats and displays the map in an easy-to-understand and navigate hierarchy of directories.
SSServer is fully configurable: you may select a desired query form template, files and directories of your Web server to be scanned while searching, language of your documents, etc. Along with the traditional Literal Search approach, SSServer also supports the Subject Search method developed by Kryloff Technologies, which provides outstanding search quality! The Subject Search method works in more than 37 languages: we are proud of the work we have done and think that we provide the most comprehensive and easy-to-use language support available.

The general search procedure is as follows:

  1. You create a search form in one or several HTML-documents accessed from your Web server;
  2. Having loaded this form into a browser, your visitors type in queries and post the data onto your Web server;
  3. The server executes the file ssserver.exe, which accepts the queries, scans an index of your files and responds with the resulting report;
  4. The Web server sends it back to the users, who are now given a powerful capability to search through your Web site.

2. Search Form

Below is an example form to be included in one or several HTML documents on your Web server. You may copy and paste this form into a temporary HTML document, then modify or translate its contents into another language (the form layout has been simplified).

According to our License Agreement, you are not allowed to remove the link to Kryloff Technologies:
Search on this site is provided by Kryloff Technologies, Inc.

Search phrase:
The rest of the FORM elements given below are optional; the default values are shown on the form and can be changed by modifying the configuration file "ssserver.ini":
Use search method: Subject Search (smart fuzzy) Literal Search (exact)
Report to you with: selections from the most relevant pages
Display selections as:
Each selection contains: characters
  Show plain text only in each selection
Extract no more than: quotations from the same document (relevant if the Subject Search method is selected)
Include quotes with the relevancy: (%) or higher (Subject Search only)
Search for: (Literal Search only)
Case sensitiveness: (Literal Search only)

Here's this search form contents in HTML format (unnecessary tags excluded):

<!-- To be included within the <body> tag of your HTML files -->
<FORM ACTION="cgi-bin/ssserver.exe" METHOD="POST">
<INPUT TYPE="HIDDEN" name="CONFIG" VALUE="ssserver.ini">

Search on this site is provided by
<a href="http://www.kryltech.com">Kryloff Technologies, Inc.</a>
<!-- You cannot remove the link to Kryloff Technologies, Inc. -->

Search phrase: <INPUT TYPE="TEXT" name="QUERY" SIZE="72" MAXLENGTH="255" VALUE="">

The rest of the FORM elements given below are optional; the default values are 
shown on the form and can be changed by modifying the configuration file 
"ssserver.ini".

Use search method:
<INPUT TYPE="RADIO" name="METHOD" VALUE="FUZZY" CHECKED>Subject Search (smart fuzzy)
<INPUT TYPE="RADIO" name="METHOD" VALUE="EXACT">Literal Search (exact)

Report to you with:
<SELECT name="QUOTES">
<OPTION>10
<OPTION SELECTED>25
<OPTION>50
<OPTION>100
<OPTION>250
<OPTION>500
<OPTION>1000
</SELECT>
selections from the most relevant pages

Display selections as:
<SELECT name="REPORTWITH">
<OPTION VALUE="Q" SELECTED>Quotations from original pages
<OPTION VALUE="B">Beginning of each page found
<OPTION VALUE="DQ">Page summary or quotations
<OPTION VALUE="DB">Page summary or beginning
</SELECT>

Each selection contains:
<SELECT name="QUOTESIZE">
<OPTION>100
<OPTION>500
<OPTION SELECTED>1000
<OPTION>2500
<OPTION>5000
</SELECT>
characters

<INPUT TYPE="CHECKBOX" name="PLAINTEXT" VALUE="YES">Show plain text only in each selection

Extract no more than:
<SELECT name="QUOTESPERDOC">
<OPTION>1
<OPTION>2
<OPTION>3
<OPTION>4
<OPTION SELECTED>5
<OPTION>6
<OPTION>7
<OPTION>8
<OPTION>9
<OPTION>10
<OPTION>11
<OPTION>12
<OPTION>13
<OPTION>14
<OPTION>15
</SELECT>
quotations from the same document (relevant if the Subject Search method is selected)

Include quotes with the relevancy:
<SELECT name="RELEVANCY">
<OPTION>10
<OPTION>20
<OPTION>30
<OPTION SELECTED>40
<OPTION>50
<OPTION>60
<OPTION>70
<OPTION>80
<OPTION>90
<OPTION>100
</SELECT> (%) or higher (Subject Search only)

Search for:
<SELECT name="TERMS">
<OPTION VALUE="ANY">for any term
<OPTION VALUE="ALL" SELECTED>for all terms
<OPTION VALUE="PHRASE">as a phrase
</SELECT> (Literal Search only)

Case sensitiveness:
<SELECT name="CASE">
<OPTION VALUE="INSENSITIVE" SELECTED>case insensitive
<OPTION VALUE="SENSITIVE">case sensitive
</SELECT> (Literal Search only)

<INPUT TYPE="SUBMIT" name="SEARCH" VALUE="Search">
<INPUT TYPE="SUBMIT" name="SITEMAP" VALUE="Site Map">
<INPUT TYPE="SUBMIT" name="HELP" VALUE="Help">
</FORM>



3. Search Query Parameters

SSServer processes query strings posted on the application by a remote browser when the user presses any of the SUBMIT buttons on the search query form. The query string should contain all or any of the following parameters:

QUERY=<query string>
CONFIG=<configuration file name>
SUBJECTLAYOUT=<report template file name used when the user selects Subject Search>
LITERALLAYOUT=<report template file name used when the user selects Literal Search>
SITEMAPLAYOUT=<template file name used for displaying the site map>
LANGUAGE=<language dictionary file name>
FILELIST=<name of the file, which lists files/directories to be searched>
HELPFILE=<name of the End-User Help file>
WARNINGS=<YES or NO>
FILEEXTENSIONS=<list of file extensions to be processed by SSServer>
EXCLUDEFILEEXTENSIONS=<list of file extensions to be skipped by SSServer>
SITEROOTURL=<your Web server's Internet address>
WORKDIR=<directory in which SSServer keeps temporary and work files>
ACTION=<action>
QUOTES=<number of quotes to generate>
QUOTESIZE=<quotation size>
QUOTESPERDOC=<max. number of quotes that can be extracted from the same file>
METHOD=<search method>
RELEVANCY=<relevancy in the range 0-100>
TERMS=<Literal Search option>
CASE=<Literal Search option>
REPORTWITH=<Q, B, DQ or DB>
SUBJECTREPORTWITH=<Q, B, DQ or DB>
LITERALREPORTWITH=<Q, B, DQ or DB>
ALLOWSITEMAP=<YES or NO>
PLAINTEXT=<YES or NO>

The description of each of the parameters follows:

  • QUERY contains a question that remote users (visitors to your Web site) enter into the form with a browser. The default value is 'NoPhrase'; this is the only unconditional parameter that is required to process queries; the rest of the parameters are optional and may or may not be present in SSServer query strings.

  • CONFIG points out to a configuration file, for example: "CONFIG=C:\KrylTech\ssserver\ssserverdata\ssserver.ini". Its file path is relative to the ssserverdata subdirectory of the directory, in which SSServer has been installed. Under this example, having just "CONFIG=ssserver.ini" is enough if the full path for ssserver.exe is C:\KrylTech\ssserver\ssserver.exe.

    This file contains all or any of the query string parameters (except for the CONFIG option, again: recursion is not allowed). Each parameter occupies one line. Example:
    FILELIST=filelist.txt
    SUBJECTLAYOUT=layout_s.htm
    LITERALLAYOUT=layout_l.htm
    LANGUAGE=English.ssl
    HELPFILE=help.htm
    SITEROOTURL=http://www.mycompany.com
    WORKDIR=workdir\
    ALLOWSITEMAP=NO

    It is not usually necessary to include such parameters as QUOTES or ACTION because they are primarily selected by site visitors. However, if you have simplified the Search Query form and some of the options are not now selectable by users, the default values for them may be set in the configuration file. For example: the statement METHOD=FUZZY in the configuration file instructs SSServer to use the Subject Search Method.

    The default value for the CONFIG parameter is not defined, e.g. SSServer does not look for or read configuration files automatically. This means that in order to reassign the default values for query string parameters, your search query form should contain a reference to the configuration file; this reference should be present as the very first and invisible statement in the search query form. For example:
    <INPUT TYPE="HIDDEN" name="CONFIG" VALUE="ssserver.ini">

    Basically, configuration file is used to define search string parameters that are common to all queries and cannot be changed by site visitors. For example, if a number of pages on your server are in Latin, and you want your visitors to be able to search in this language, the configuration file for the corresponding Search in Latin form should contain the statement: "LANGUAGE=Latin.ssl". Apart from assigning the defaults, you may use configuration files to prevent visitors from obtaining your site map. Just include the statement "ALLOWSITEMAP=No" in it.

  • SUBJECTLAYOUT, LITERALLAYOUT and SITEMAPLAYOUT
    SSServer generates reports in a manner which lets you fully customize the report layout to your own requirements, namely: you may add or modify the header or footer section of SSServer reports, control the textual contents of the report, its background and colors, position on screen, etc.

    The SUBJECTLAYOUT parameter affects the layout of those reports only, which are built when the user selects Subject Search; for building reports when the Literal Search method is selected, SSServer uses the LITERALLAYOUT parameter, and for displaying Site Maps used is SITEMAPLAYOUT. When SSServer finishes processing a query and needs to display the resulting report, it first reads the layout file whose name is specified by the corresponding parameter. It is supposed that the layout file contains a number of macro instructions, which SSServer finds out, "understands", and replaces with its findings. Finally, SSServer passes the resulting report file onto the user. So, the layout files are used as report templates and therefore, they should be correct HTML files with all required HTML tags, such as <HTML> and <BODY>. The default values for SUBJECTLAYOUT, LITERALLAYOUT, SITEMAPLAYOUT are layout_s.htm, layout_l.htm, and sitemap.htm, respectively. The file path of these files is relative to the SSSERVERDATA subdirectory of the directory in which SSServer has been installed.

    Note: the Header, Footer, and the Template options, which were originally implemented in SSServer 1.0, are now obsolete: the implementation of layout files gives much more flexibility to make SSServer reports fit into the overall design of your site.

    In the examples below macro instructions are painted in blue; follow this link to obtain the full list of macro instructions that SSServer supports.

  • Example file ssserverdata/layout_s.htm:
    <html>
    <head>
    <title>SSServer(TM) Search Results</title>
    <!-- the STYLE tag below is placed here to minimize space occupied
         by quotations; you may remove it if it does not match the style
         that you use in other documents on your site. -->
    <STYLE TYPE="TEXT/CSS"><!--
    H1,H2,H3 {font-size:14pt; margin:0pt}
    H4,H5,H6,P {margin:0pt}
    UL,OL,DL {margin-top:0pt; margin-bottom:0pt}
    --></STYLE>
    <!-- the STYLE tag below controls the colors of the actual phrases matched -->
    <STYLE TYPE="TEXT/CSS"><!--
    FONT.highlight {color:#FF0000; background:#FFFFCC}
    --></STYLE>
    </head>
    <body BGCOLOR="#FFFFFF" LINK="#0000FF" ALINK="#FF0000" VLINK="#990099"
          TOPMARGIN=2 LEFTMARGIN=4 MARGINHEIGHT=2 MARGINWIDTH=4>
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699">
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2>
    <TR><TD BGCOLOR="#FFFFCC">SSServer™ search results for:
        <FONT COLOR="0000FF"><B>%SearchPhrase%</B></FONT>
    <BR>Processed: <B>%NumFiles%</B> files in %Language% and selected
        <B>%NumQuotes%</B> quotations which exceeded the <B>%MinRelevancy%</B> relevancy.<BR>
        The actual phrases matched are
        <FONT COLOR="#FF0000" CLASS="highlight">shown in red</FONT> below.</TD></TR>
    <TR>
    <TD BGCOLOR="#FFFFCC">
    <TABLE WIDTH="100%" CELLSPACING=2 CELLPADDING=0 BORDER=0>
    <TR>
    <TD COLSPAN="3" ALIGN="CENTER"><FONT SIZE="-1">SSServer™ is a trademark of
        <A HREF="http://www.kryltech.com">Kryloff Technologies, Inc.</A></FONT></TD>
    <TD ALIGN="RIGHT" VALIGN="BOTTOM"><FONT SIZE="-1">%SearchDate%</FONT></TD>
    </TR>
    </TABLE>
    </TD>
    </TR>
    </TABLE>
    </TD></TR></TABLE><BR>
    %QuoteBegin%
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699">
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2><TR><TD>
    <FONT COLOR="#FFFFFF"><B>%QuoteOrder%.</B></FONT></TD>
    <TD BGCOLOR="#AADDFF" WIDTH="100%"><B>%QuoteTitle%</B></TD><TD>
    <FONT COLOR="#FFFFFF">Relevancy <B>%QuoteRelevancy%%</B></FONT></TD></TR></TABLE>
    </TD></TR></TABLE>
    %QuoteText%
    %QuoteEnd%
    <!-- New Search form -->
    <table width=100% border=0 cellpadding=0 cellspacing=0>
    <tr>
    <td><font size=0> <font></td>
    </tr>
    <tr>
    <td bgcolor="#336699">
     <table width=100% border=0 cellpadding=2 cellspacing=1>
     <tr>
     <td align="center">
      <font face="Verdana,Arial,Helvetica" color="#ffffff"><b>New Search</b></font>
     </td>
     </tr>
     <tr>
     <td bgcolor="#ffffcc">
      <table width=100% border=0 cellpadding=6 cellspacing=0>
      <tr>
      <form action="ssserver.exe" method="POST">
      <td align="center" nowrap>
       <input type="hidden" name="config" value="ssserver.ini">
    <table border=0>
    <TR><TD>
    Search for:
    </TD><TD><INPUT TYPE="TEXT" name="QUERY" SIZE="60" MAXLENGTH="255" VALUE=""></TD>
    </TR><TR><TD>
    Report to you with:
    </TD><TD>
     <SELECT name="QUOTES">
      <OPTION>10
      <OPTION SELECTED>25
      <OPTION>50
      <OPTION>100
      <OPTION>250
      <OPTION>500
      <OPTION>1000
     </SELECT>
    selections from the most relevant pages
    </TD></TR><TR><TD>
    Display selections as:
    </TD><TD>
     <SELECT name="REPORTWITH">
      <OPTION VALUE="Q" SELECTED>Quotations from original pages
      <OPTION VALUE="B">Beginning of each page found
      <OPTION VALUE="DQ">Page summary or quotations
      <OPTION VALUE="DB">Page summary or beginning
     </SELECT>
    </TD></TR><TR><TD>
    Each selection contains:
    </TD><TD>
     <SELECT name="QUOTESIZE">
      <OPTION>100
      <OPTION>500
      <OPTION SELECTED>1000
      <OPTION>2500
      <OPTION>5000
     </SELECT>
    characters
    </TD></TR><TR><TD>
    Extract no more than:
    </TD><TD>
     <SELECT name="QUOTESPERDOC">
      <OPTION>1
      <OPTION>2
      <OPTION>3
      <OPTION>4
      <OPTION SELECTED>5
      <OPTION>6
      <OPTION>7
      <OPTION>8
      <OPTION>9
      <OPTION>10
      <OPTION>11
      <OPTION>12
      <OPTION>13
      <OPTION>14
      <OPTION>15
     </SELECT>
    quotations per a page
    </TD></TR><TR><TD>
     
    </TD><TD>
    <INPUT TYPE="CHECKBOX" name="PLAINTEXT" VALUE="YES">Show plain text only in each selection
    </TD></TR><TR><TD COLSPAN="2"><HR></TD></TR><TR><TD>
    Apply search method
    </TD><TD><INPUT TYPE="RADIO" name="METHOD" VALUE="FUZZY" CHECKED>
    Subject Search (smart fuzzy) with <SELECT name="RELEVANCY">
     <OPTION>10
     <OPTION>20
     <OPTION>30
     <OPTION SELECTED>40
     <OPTION>50
     <OPTION>60
     <OPTION>70
     <OPTION>80
     <OPTION>90
     <OPTION>100
    </SELECT> %
    of relevancy
    <HR>
    <INPUT TYPE="RADIO" name="METHOD" VALUE="EXACT">Literal Search (exact)
    <SELECT name="TERMS">
     <OPTION VALUE="ANY">for any term
     <OPTION VALUE="ALL" SELECTED>for all terms
     <OPTION VALUE="PHRASE">as a phrase
    </SELECT>
    <SELECT name="CASE">
     <OPTION VALUE="INSENSITIVE" SELECTED>case insensitive
     <OPTION VALUE="SENSITIVE">case sensitive
    </SELECT>
    </TD>
    </tr><tr><td colspan=2>
    <table width=100% cellspacing=3 cellpadding=0><tr><td align="left">
    <INPUT TYPE="SUBMIT" name="SEARCH" VALUE="Search"></td><td align="center">
    <INPUT TYPE="SUBMIT" name="HELP" VALUE="Help"></td><td align="right">
    <INPUT TYPE="SUBMIT" name="SITEMAP" VALUE="Site Map"></td></tr></table>
    
    </td></tr></table>
      </td>
      </form>
      </tr>
      </table>
     </td>
     </tr>
     </table>
    </td>
    </tr>
    <tr>
    <td><font size=0> <font></td>
    </tr>
    </table>
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699">
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2><TR>
    <TD ALIGN="CENTER" BGCOLOR="#FFFFCC"><FONT SIZE="-1">
    The search results have been provided by %KryloffLink%</FONT></TD></TR>
    </TABLE></TD></TR></TABLE>
    </body>
    </html>
    

    Example file ssserverdata/layout_l.htm:
    <html>
    <head>
    <title>SSServer(TM) Search Results</title>
    <!-- the STYLE tag below is placed here to minimize space occupied
         by quotations; you may remove it if it does not match the style
         that you use in other documents on your site. -->
    <STYLE TYPE="TEXT/CSS"><!--
    H1,H2,H3 {font-size:14pt; margin:0pt}
    H4,H5,H6,P {margin:0pt}
    UL,OL,DL {margin-top:0pt; margin-bottom:0pt}
    --></STYLE>
    <!-- the STYLE tag below controls the colors of the actual phrases
    matched -->
    <STYLE TYPE="TEXT/CSS"><!--
    FONT.highlight {color:#FF0000; background:#FFFFCC}
    --></STYLE>
    </head>
    <body BGCOLOR="#FFFFFF" LINK="#0000FF" ALINK="#FF0000" VLINK="#990099"
          TOPMARGIN=2 LEFTMARGIN=4 MARGINHEIGHT=2 MARGINWIDTH=4>
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699">
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2>
    <TR><TD BGCOLOR="#FFFFCC">SSServer™ search results for:
        <FONT COLOR="0000FF"><B>%SearchPhrase%</B></FONT>
    <BR>Scanned: <B>%NumFiles%</B> files in %Language% and
        selected <B>%NumQuotes%</B> files of <B>%QueryQuotes%
        </B> requested.<BR>
    The search conditions are: <B>Literal</B> search;
        <B>%TermsAsString%</B>; <B>%CaseAsString%</B>.<BR>
    The first occurrences of the search terms are
        <FONT COLOR="#FF0000" CLASS="highlight">shown in red</FONT> below.</TD></TR>
    <TR>
    <TD BGCOLOR="#FFFFCC">
    <TABLE WIDTH="100%" CELLSPACING=2 CELLPADDING=0 BORDER=0>
    <TR>
    <TD COLSPAN="3" ALIGN="CENTER"><FONT SIZE="-1">SSServer™ is a trademark of
        <A HREF="http://www.kryltech.com">Kryloff Technologies, Inc.</A></FONT></TD>
    <TD ALIGN="RIGHT" VALIGN="BOTTOM"><FONT SIZE="-1">%SearchDate%</FONT></TD>
    </TR>
    </TABLE>
    </TD>
    </TR>
    </TABLE>
    </TD></TR></TABLE><BR>
    %QuoteBegin%
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699">
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2><TR><TD>
    <FONT COLOR="#FFFFFF"><B>%QuoteOrder%.</B></FONT></TD>
    <TD BGCOLOR="#AADDFF" WIDTH="100%"><B>%QuoteTitle%</B></TD></TR></TABLE>
    </TD></TR></TABLE>
    %QuoteText%
    %QuoteEnd%
    <!-- New Search form -->
    <table width=100% border=0 cellpadding=0 cellspacing=0>
    <tr>
    <td><font size=0> <font></td>
    </tr>
    <tr>
    <td bgcolor="#336699">
     <table width=100% border=0 cellpadding=2 cellspacing=1>
     <tr>
     <td align="center">
     <font face="Verdana,Arial,Helvetica" color="#ffffff"><b>New Search</b></font>
     </td>
     </tr>
     <tr>
     <td bgcolor="#ffffcc">
      <table width=100% border=0 cellpadding=6 cellspacing=0>
      <tr>
      <form action="ssserver.exe" method="POST">
      <td align="center" nowrap>
       <input type="hidden" name="config" value="ssserver.ini">
    <table border=0>
    <TR><TD>
    Search for:
    </TD><TD><INPUT TYPE="TEXT" name="QUERY" SIZE="60" MAXLENGTH="255" VALUE=""></TD>
    </TR><TR><TD>
    Report to you with:
    </TD><TD>
     <SELECT name="QUOTES">
      <OPTION>10
      <OPTION SELECTED>25
      <OPTION>50
      <OPTION>100
      <OPTION>250
      <OPTION>500
      <OPTION>1000
     </SELECT>
    selections from the most relevant pages
    </TD></TR><TR><TD>
    Display selections as:
    </TD><TD>
     <SELECT name="REPORTWITH">
      <OPTION VALUE="Q" SELECTED>Quotations from original pages
      <OPTION VALUE="B">Beginning of each page found
      <OPTION VALUE="DQ">Page summary or quotations
      <OPTION VALUE="DB">Page summary or beginning
     </SELECT>
    </TD></TR><TR><TD>
    Each selection contains:
    </TD><TD>
     <SELECT name="QUOTESIZE">
      <OPTION>100
      <OPTION>500
      <OPTION SELECTED>1000
      <OPTION>2500
      <OPTION>5000
     </SELECT>
    characters
    </TD></TR><TR><TD>
    Extract no more than:
    </TD><TD>
     <SELECT name="QUOTESPERDOC">
      <OPTION>1
      <OPTION>2
      <OPTION>3
      <OPTION>4
      <OPTION SELECTED>5
      <OPTION>6
      <OPTION>7
      <OPTION>8
      <OPTION>9
      <OPTION>10
      <OPTION>11
      <OPTION>12
      <OPTION>13
      <OPTION>14
      <OPTION>15
     </SELECT>
    quotations per a page
    </TD></TR><TR><TD>
     
    </TD><TD>
    <INPUT TYPE="CHECKBOX" name="PLAINTEXT" VALUE="YES">Show plain text only in each selection
    </TD></TR><TR><TD COLSPAN="2"><HR></TD></TR><TR><TD>
    Apply search method
    </TD><TD><INPUT TYPE="RADIO" name="METHOD" VALUE="FUZZY">Subject Search (smart fuzzy) with
    <SELECT name="RELEVANCY">
     <OPTION>10
     <OPTION>20
     <OPTION>30
     <OPTION SELECTED>40
     <OPTION>50
     <OPTION>60
     <OPTION>70
     <OPTION>80
     <OPTION>90
     <OPTION>100
    </SELECT> %
    of relevancy
    <HR>
    <INPUT TYPE="RADIO" name="METHOD" VALUE="EXACT" CHECKED>Literal Search (exact)
    <SELECT name="TERMS">
     <OPTION VALUE="ANY">for any term
     <OPTION VALUE="ALL" SELECTED>for all terms
     <OPTION VALUE="PHRASE">as a phrase
    </SELECT>
    <SELECT name="CASE">
     <OPTION VALUE="INSENSITIVE" SELECTED>case insensitive
     <OPTION VALUE="SENSITIVE">case sensitive
    </SELECT>
    </TD>
    </tr><tr><td colspan=2>
    <table width=100% cellspacing=3 cellpadding=0><tr><td align="left">
    <INPUT TYPE="SUBMIT" name="SEARCH" VALUE="Search"></td><td align="center">
    <INPUT TYPE="SUBMIT" name="HELP" VALUE="Help"></td><td align="right">
    <INPUT TYPE="SUBMIT" name="SITEMAP" VALUE="Site Map"></td></tr></table>
    
    </td></tr></table>
      </td>
      </form>
      </tr>
      </table>
     </td>
     </tr>
     </table>
    </td>
    </tr>
    <tr>
    <td><font size=0> <font></td>
    </tr>
    </table>
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699">
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2><TR>
    <TD ALIGN="CENTER" BGCOLOR="#FFFFCC"><FONT SIZE="-1">
    The search results have been provided by %KryloffLink%</FONT></TD></TR>
    </TABLE></TD></TR></TABLE>
    </body>
    </html>
    

    Example file ssserverdata/sitemap.htm:
    <HTML>
    <HEAD>
    <TITLE>SSServer(TM) Report - Map of %QuerySiteRootURL%</TITLE>
    </HEAD>
    <BODY BGCOLOR="#FFFFFF" LINK="#0000FF" ALINK="#FF0000" VLINK="#990099"
          TOPMARGIN=2 LEFTMARGIN=4 MARGINHEIGHT=2>
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699">
    <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2>
    <TR><TD BGCOLOR="#FFFFCC"><B><CENTER> Site map of %QuerySiteRootURL%
    provided by SSServer™</CENTER></B></TD></TR>
    <TR><TD BGCOLOR="#FFFFCC"><TABLE WIDTH="100%" CELLSPACING=2 CELLPADDING=0 BORDER=0>
    <TR><TD WIDTH="70%" ALIGN="CENTER"><FONT SIZE=-1><B>SSServer™</B> is a trademark of
    <A HREF="http://www.kryltech.com">Kryloff Technologies, Inc.</A></FONT></TD>
    <TD ALIGN="RIGHT" VALIGN="BOTTOM">%SearchDate%</TD></TR></TABLE>
    </TD></TR></TABLE></TD></TR></TABLE>
    <!-- Variable v4 shows if browser supports expandable site maps -->
    <SCRIPT LANGUAGE="JavaScript1.2"><!--
    if(v4)document.write('<TABLE WIDTH=100% BORDER=0>
          <FORM><TR><TD WIDTH=50% ALIGN="center">
          <INPUT TYPE="BUTTON" VALUE="Expand All Branches"
          onClick="showAll(document,false);arrange()"></TD>
          <TD ALIGN="center"><INPUT TYPE="BUTTON" VALUE="Collapse All Branches"
          onClick="hideAll(document,0);arrange()"></TD></TR></FORM></TABLE>');//-->
    </SCRIPT>
    
    %SiteMap%
    
    <BR><TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0>
    <TR><TD BGCOLOR="#336699"><TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2>
    <TR><TD ALIGN="CENTER" BGCOLOR="#FFFFCC"><FONT SIZE=-1>The search results
    are provided by %KryloffLink%</FONT>
    </TD></TR></TABLE>
    </TD></TR></TABLE>
    </BODY>
    </HTML>
    

    Macro Instructions used in SSServer Layout Files

    When SSServer builds a report, it first scans the corresponding layout file and substitutes the actual query parameters for all macro instructions in the layout file, then the resulting file is passed onto the user. It is not obligatory to include all the macros in each layout file. For example, if you do not want your visitors to know how many pages are stored on your Web server, edit your layout files and remove the macro instruction %NumFiles%.

    The following macro instructions are supported by SSServer version 1.1:

    %SearchPhrase% stands for the user search query;
    %NumFiles% specifies the total number of pages accessed while executing a query;
    %Language% specifies the language of the user search phrase;
    %NumQuotes% specifies the number of quotations found by SSServer and included into the final report (Subject Search method) or the number of pages selected during the search (Literal Search);
    %MinRelevancy% is the minimum percentage of relevancy specified by user or set in the configuration file (relevant to the Subject Search only);
    %SearchDate% specifies the current date;
    %QuoteBegin% is a special macros. It points out a position in the report file where SSServer should place its selections (quotations, page descriptions or headers). The %QuoteBegin% macros must be paired with %QuoteEnd% in each layout file where it is present; the sector of the layout file between %QuoteBegin% and %QuoteEnd% is scanned for macro instructions for each selection found by SSServer;
    %QuoteOrder% is the number of a hit included into the final report;
    %QuoteTitle% specifies the title of the page selected by SSServer;
    %QuoteRelevancy% specifies the percentage of relevancy that SSServer assigns to a given quotation (relevant to the Subject Search method only);
    %QuoteText% stands for the text of SSServer's selection, e.g. a quotation, page description or its beginning;
    %QuoteEnd% is a special macro instruction to be used only with %QuoteBegin%. A pair of these macros specify the sector of the report file where SSServer should place its selections;
    %TermsAsString% is only relevant when the user selects Literal Search. It can be either "for any term", "for all terms" or "as a phrase";
    %CaseAsString% is only relevant when the user selects Literal Search. Can be either "case sensitive" or "case insensitive";
    %QueryQuotes% is replaced with the value of the Quotes parameter;
    %QueryQuoteSize% is replaced with the value of the QuoteSize parameter;
    %QueryQuotesPerDoc% is replaced with the value of the QuotesPerDoc parameter;
    %QueryMethod% is either "FUZZY" or "EXACT" depending on the search method being used;
    %QueryRelevancy% specifies the value of the Relevancy parameter;
    %QueryTerms% is relevant to literal searches only; can be either "ANY", "ALL", or "PHRASE";
    %QueryCase% is relevant to literal searches only; it is either "SENSITIVE" or "INSENSITIVE";
    %QueryLanguage% specifies the value of the Language parameter;
    %QueryFilelist% specifies the value of the Filelist parameter. As a rule, you should use this macros only for debugging;
    %QuerySubjectLayout% is replaced with the SubjectLayout parameter. Implemented to help you debug and fine-tune your copy of SSServer;
    %QueryLiteralLayout% specifies the value of the LiteralLayout parameter. To be used for debugging purposes only;
    %QuerySiteRootURL% is the value of the SiteRootURL parameter;
    %QueryWorkdir% stands for the value of the Workdir parameter. You may use it while tuning your copy of SSServer;
    %QueryConfig% stands for the Config parameter, use it to customize SSServer reports to your requirements;
    %QueryReportWith% is the value of the ReportWith parameter;
    %QueryPlainText% specifies the value of the PlainText parameter;
    %SiteMap%; this macro instruction is replaced with the actual map of your site which is presented as a tree. This macro instruction can be used only in the template file which name is specified by the SITEMAPLAYOUT parameter;
    %KryloffLink% is replaced with a link to Kryloff Technologies' Web site as follows:
    "<!--*--><A HREF="http://www.kryltech.com/">Kryloff Technologies, Inc.</A><!--*-->".
    According to our License Agreement, you are obliged to include a link to Kryloff Technologies to your search form and all reports that SSServer produces.

  • LANGUAGE specifies the language of your Web site documents. You should specify the corresponding language dictionary, for example: "LANGUAGE=Latin.ssl". The default language dictionary is English.ssl; its file path is relative to the ssserverdata subdirectory of the SSServer root directory.

    Important: Your visitors should enter questions in the language of your Web site documents and also in the same encoding if your language allows using different coding tables. You should keep in mind that SSServer does not translate questions into English nor does it perform encoding of any sort. If your Web page contains documents in more than one language, you may create several search forms for each group.
    See also:
    Multi-language support in Kryloff Technologies' products.

  • FILELIST specifies a name of the file, which lists documents to be searched by SSServer. This file must exist on your server; by default, it is filelist.txt. Its file path is relative to the ssserverdata subdirectory of the SSServer root directory. If you have renamed this file or placed it in another directory, you should specify its full or relative path, for example: C:\KrylTech\ssserver\ssserverdata\filelist.txt.

    The file list contains a sequence of paired lines, which should follow right after each other. Each pair is either:

    FILE=<local file name>
    URL=<Internet address of this file>
    
    or
    
    DIR=<name of a local directory>
    URL=<Internet address of this directory>
    
    or
    
    TREE=<name of a local directory>
    URL=<Internet address of this directory>
    

    Each pair points out a local file or a directory on your Web server and a URL that corresponds to the file or directory. The "FILE=" instruction instructs SSServer to process one file; The "DIR=" instruction causes processing all files in a given directory without subdirectories; finally, the "TREE=" instruction makes SSServer recursively process all files in a given directory including all subdirectories.

    Example file filelist.txt:
    Dir=c:\kryltech
    URL=http://www.kryltech.com/
    
    Tree=c:\kryltech\download
    URL=http://www.kryltech.com/download/
    
    File=c:\kryltech\samples\getid.htm
    URL=http://www.kryltech.com/samples/getid.htm
    

    In this example SSServer processes all files in the directory c:\kryltech, all files in the directory c:\kryltech\download and all its subdirectories (if any), and also the file c:\kryltech\samples\getid.htm.

    While executing the instructions "Dir=" or "Tree=", SSServer appends local file names to their directory's Internet address (URL) to obtain the URL's of each file within the directory. Duplicated files are being removed, e.g. SSServer does not process the same file twice or more even if the corresponding file list directly or indirectly specifies the same file many times.

    See also: The options FILEEXTENSIONS and EXCLUDEFILEEXTENSIONS.

  • HELPFILE specifies the name of the file, which SSServer displays when user presses on the HELP button in the Search Query form. By default, it is help.htm. You may translate it into another language if required.
    See also:
    Multi-language support in Kryloff Technologies' products.

  • WARNINGS allows or forbids displaying warning messages in SSServer reports. If the configuration file contains the line "WARNINGS=NO", SSServer does not warn users of the possible mismatch between the language of the user query and one specified by the Language option. Also, the user is not notified of the fact that case insensitive search is not supported in DBCS languages such as Japanese, Chinese and Korean. By default, including warning messages is allowed (WARNINGS=YES).

  • FILEEXTENSIONS specifies a list of allowed file extensions. While scanning directories specified by the "DIR=" or "TREE=" statements in the SSServer file list, SSServer processes those files only, which extensions are present is the list set by this parameter. Use semicolon ";" to separate extensions from each other. If you want SSServer to process files without extension, include the empty extension in the list as ";;".
    Example: "FILEEXTENSIONS=HTM;HTML" causes SSServer to process only files which extension is either HTM> or HTML. By default, SSServer processes all files regardless of their extension.

    See also: The parameter EXCLUDEFILEEXTENSIONS

  • EXCLUDEFILEEXTENSIONS specifies a list of file extensions. Files whose extensions are present in this list, are skipped by SSServer when it executes "DIR=" or "TREE=" statements in the SSServer file list. Use semicolon ";" to separate extensions from each other. If you want SSServer to skip files which do not have any extension, include the empty extension in the list as ";;".
    Example: "EXCLUDEFILEEXTENSIONS=LST;TMP" instructs SSServer to skip files with the extension LST and TMP. Regardless of the value of this option that you may specify, the string "GIF;JPG;JPEG" is always appended to the list, e.g. SSServer does not process image files. To avoid possible conflicts with the FILEEXTENSIONS parameter, EXCLUDEFILEEXTENSIONS takes effect only in case when FILEEXTENSIONS is not specified or empty.

    See also: The parameter FILEEXTENSIONS

  • SITEROOTURL specifies the Internet address (URL) of your site. The default value http://siteurl.com, obviously, should be reassigned in the SSServer configuration file.

  • WORKDIR selects a working directory for ssserver.exe, in which the application should be allowed to create, read, modify and delete temporary files. By default, SSServer creates the subdirectory ssserverdata/workdir/ of its root directory. The contents of this directory are fully controlled by ssserver.exe: do not modify it.

  • ACTION instructs SSServer what it should do: to perform a search, to generate a map of your site or to respond with the contents of the HELP file (see the HELPFILE parameter above).
    If there is no parameter in the query string which stands for ACTION, by default ssserver.exe does a search. If generating site maps is not allowed on your server (see ALLOWSITEMAP below), ssserver.exe responds with a warning message. Allowed values include:
    1. SEARCH=<just Search or another value that corresponds to your language>;
    2. SITEMAP=<Site Map or its translation into another language>;
    3. HELP=<Help or any corresponding string>

    For example, when ssserver.exe detects the "SEARCH=something" substring in the query string, it searches for data.

  • QUOTES
    This parameter selects the maximum number of hits a user can receive in the search report (25, by default).

  • QUOTESIZE selects the size of quotations to be placed in the search report (in characters). The default value for this parameter is 1,000 characters.

  • QUOTESPERDOC specifies number of quotations from the same document that SSServer can extract and place in the search report. The lowest value of this option (set to 1) does not allow SSServer to quote the same document twice or more even if the corresponding document brings up the same subject many times in different paragraphs. This option mostly affects quoting long documents. By default, SSServer can quote the same document no more than 5 times.

  • METHOD selects search method SSServer should use while processing a query; can be either:
    1. METHOD=FUZZY (for Subject Search; this method is used by default) or
    2. METHOD=EXACT (for Literal Search).

    SSServer™ supports two types of searches: Subject Search and Literal Search. Developed by Kryloff Technologies, Inc., the Subject Search method is the intelligent and the most powerful way of information retrieval. The core Subject Search technique is also used in the rest of Kryloff Technologies' products known as Subject Search Suite™. This method accepts natural language enquiries and is used by default, so it is unlikely that you would need to change it.

    In addition to Subject Search, SSServer™ supports the traditional Literal Search approach. Visitors can use this method while looking for digits, number, names, etc. Using this method, SSServer extracts quotations "as is". Unlike the Subject Search approach, when the user is looking for "John Griffiths" on your pages, Literal Search method does not select "Jon Griffit". This feature can be also quite useful in a number of cases, so it is recommended that you allow visitors to use both search methods: do not remove the corresponding radio-buttons from the search query form unless your documents do not have enough space.

  • RELEVANCY
    The Relevancy parameter (Minimum percentage of relevancy) is only relevant to those queries for which the
    Subject Search method is selected. SSServer generates reports with the most relevant quotes/extracts from your documents. Each quotation is ranked for relevancy with some value in the 0%-100% range. This option instructs SSServer to skip those quotations that do not exceed the value specified by this parameter. The higher the value, the fewer quotes. The default value is 40.

  • TERMS
    This parameter specifies additional options for the
    Literal Search method. The following values of this option are allowed:
    1. TERMS=ANY (instructs SSServer to search for any term in user's query);
    2. TERMS=ALL (SSServer searches for all terms, by default);
    3. TERMS=PHRASE (search for occurrences of the entire phrase)

  • CASE specifies additional options for the Literal Search method. Allowed settings are either "Sensitive" or "Insensitive":
    1. CASE=SENSITIVE instructs SSServer™ to treat uppercase and lowercase letters equally;
    2. CASE=INSENSITIVE causes SSServer™ to make a distinction between "A" and "a", "B" and "b", etc.
    Important: this option is supported not only in English but also in all European languages (see Multi-language support in Kryloff Technologies' products to obtain the full list of languages).

  • REPORTWITH, SUBJECTREPORTWITH and LITERALREPORTWITH specify what type of selections SSServer should place in its reports:
    "Q": instructs SSServer to place the most relevant quotations from pages it selects.
    "B": the final report contains the beginning of each page selected by SSServer.
    "DQ": for each page that SSServer selects, it places its description. Pages which do not contain the "description" meta tag (<META name="description" content="page summary">) are to be quoted, e.g. for such files SSServer assumes "REPORTWITH=Q".
    "DB": causes including page descriptions in the resulting reports. For pages without description SSServer places the beginning sections.

    The REPORTWITH parameter affects the type of SSServer selections regardless of the search method: it is applicable to the Subject Search as well as to the Literal Search methods. The default value for this option is not defined.
    Two additional options, SUBJECTREPORTWITH and LITERALREPORTWITH have been implemented to allow you differentiate the type of SSServer selections for a particular search method. Thus, the SUBJECTREPORTWITH parameter affects those reports only that are built using the Subject Search method; LITERALREPORTWITH instructs SSServer to display a particular sort of selections when it performs literal searches. By default, SUBJECTREPORTWITH=Q and LITERALREPORTWITH=DQ, e.g. SSServer quotes documents while applying the Subject Search method, and displays page descriptions when Literal Search is selected.

    It is recommended that you include the options SUBJECTREPORTWITH and LITERALREPORTWITH into the SSServer configuration file; the option REPORTWITH can be used by your site visitors as it is shown in the example Search Form above (see the "Display selections as" field).

  • ALLOWSITEMAP allows or forbids generating site maps. If the configuration file contains the line "ALLOWSITEMAP=NO", ssserver.exe prevents visitors from obtaining your site map. By default, SSServer is allowed to generate site maps on user's request.

  • PLAINTEXT=YES instructs SSServer to exclude any text formatting tags from selections it displays in the resulting report. By default, PLAINTEXT=NO; this makes selections (e.g. quotations or heading sections) look as close to those in the original pages as possible.


    4. Multi-language Support in SSServer™

    SSServer version 1.1 is able to search in the following languages:
    Afrikaans
    Arabic (Windows encoding)
    Bulgarian
    Catalan
    Chinese (Traditional Big5 encoding)
    Chinese (Simplified GB2312 encoding)
    Czech
    Danish
    Dutch (standard and Belgian)
    English (all dialects)
    Estonian
    Finnish
    French (all dialects)
    German (all dialects)
    Greek (standard)
    Greek (Latin encoding)
    Hebrew
    Hungarian
    Icelandic
    Indonesian
    Irish
    Italian (standard and Swiss)
    Japanese (Shift-JIS encoding)
    Japanese (EUC encoding)
    Korean (EUC encoding)
    Latin
    Latvian
    Lithuanian
    Norwegian (Bokmal and Nynorsk)
    Polish
    Portuguese (standard and Brazilian)
    Romanian
    Russian (Windows encoding)
    Russian (KOI-8 encoding)
    Slovak
    Spanish (all dialects)
    Swedish
    Turkish
    

    Since Kryloff Technologies is constantly improving its Multi-Language Support, it is recommended that you visit our Multi-Language Support Page to obtain additional languages dictionaries if your language is not yet listed above.



    5. Remote Installation

    Even in the case when your Web site is hosted on a remote computer and, therefore, you are unable to run our powerful Setup Wizard, you can still properly install and use SSServer. Obviously, the best and the easiest way is to ask your Web administrator to do it. But, if you have remote access to your Web server (typically, via FTP), you can do it yourself! Just copy the contents of your Web site on your "home" PC, then run the SSServer Setup Wizard and install the application into a temporary directory. Then launch the File List Editor and configure SSServer as it is supposed to work on your computer at home.

    After this, run the configuration editor and replace all file paths with those that correspond to your Web server. Remember, that SSServer makes the "ssserverdata\" subdirectory the current one while running, so all file paths are relative to this subdirectory. By default, it is: "c:\KrylTech\SSServer\ssserverdata".

    Having finished configuring, upload the SSServer directory with its subdirectories to your Web server. Finally, make sure that the Web server application can execute files from the directory in which you have uploaded SSServer. After completing these steps, your visitors will be able to use the search form and search your site!


    6. File Types Supported by SSServer™.

    SSServer v1.1 is able to search files written in Hyper-Text Markup language as well as standard ASCII text files. File names do not obligatory have to end up with ".HTM", ".HTML" or ".TXT" extension: the application automatically detects the type of each file it processes.

    Despite the fact that SSServer does not internally support other file types, you may still make it process files written under ANY data storage format such as Rich Text Format (.RTF), Portable Data Format (.PDF), etc. For each "external" file you may create a corresponding text file containing just the textual information of the original one. Then, edit the SSServer File List (usually, it is the file ssserverdata\filelist.txt), and replace the local "external" file name with the name of its textual copy. After these changes, SSServer will search for queries in text files while supply its findings with the references to the original ones!

    Example: say your Web site contains the file ExternalFile.RTF in Rich Text Format and you want SSServer to search in it as well. Do the following:

    1. Using the SSServer File List Editor, first, include ExternalFile.RTF into the list of files to be processed. After this, the file filelist.txt will contain:
       ...
      FILE=ExternalFile.RTF
      URL=http://www.mysiteurl.com/ExternalFile.RTF
       ... 

    2. Then, create a text file ExternalFile.TXT and copy the contents of ExternalFile.RTF into it.

    3. Finally, replace the string ExternalFile.RTF with ExternalFile.TXT:
       ...
      FILE=ExternalFile.TXT
      URL=http://www.mysiteurl.com/ExternalFile.RTF
       ... 

    This "trick" makes SSServer search the file ExternalFile.TXT and extract quotations from it but then include the link to the original file http://www.mysiteurl.com/ExternalFile.RTF in the resulting reports!

    To create text files, you may use our GetText utility available for free downloading at http://www.kryltech.com/freestf.htm


    7. System Requirements and SSServer™ Messages.

    SSServer functions under the following environment:

    Windows version:

    • OS Microsoft Windows NT 4.0, Windows 95, Windows 98, Windows 2000, Windows XP, Windows 2003, Windows Vista, Windows 7;
    • A pre-installed Web Server application (either Microsoft Internet Information Server or Microsoft Personal Web Server is preferable);
    • A pre-installed Web browser;
    • at least 32 MB of memory;

    Linux version:

    • OS Linux;
    • A pre-installed Web Server application;

    FreeBSD version:

    • OS FreeBSD 3.x;
    • A pre-installed Web Server application;

    All versions:

    SSServer automatically builds file indexes (or deletes them if required) in its working directory. If some of your documents have been modified, SSServer automatically rebuilds the corresponding index files. The only case you should be careful of is the situation when you delete documents from your Web server. If, having deleted some document, you do not also delete the corresponding "FILE=" statement in the file list, SSServer starts generating a warning message "Error reading file XXX" in each report.

    Important: To prevent your visitors from seeing error messages, it is strongly recommended that you issue at least one query right after deleting any files or modifying SSServer configuration files (filelist.txt, ssserver.ini or template.txt). If you do not see any error messages in the report, all changes have been done correctly and your visitors will not see any error or warning messages either. See also: The WARNINGS option.

    If you issue a query for the very first time, it may take a while as none of your documents have been indexed yet. All subsequent searches are done much faster. Index files occupy approximately as much space as the original documents, so make sure that there is enough disk space on the drive in which SSServer keeps temporary files.
    See also: The WORKDIR option.


  • Home | Download | Purchase | Contact | Company

    Copyright © 1997-2010 Kryloff Technologies, Inc. All Rights Reserved