IT Administrators‎ > ‎Installation‎ > ‎

Configuring Scope in MTop Search

 This article is suitable for an IT Adminstrator

Ref: 201309201717
Last Edited: September 23rd, 2013

The current Quick Search and Document Search are based on MTop Search Composer. Our standard implementation of the MTop-based search has changed recently to one which uses separate sets of files per library. The original implementations used a common index and set of indexing files, used by all library sites, with the search facility filtering results to the appropriate library site. We found that this configuration was limited in the number of libraries it could manage; hence the change to handle libraries separately.

Library-scoped MTop search will be the implementation for new installations, but existing, older installations, when upgraded, will retain the original configuration, as configuration files are deliberately not replaced on upgrade. Migrating from a global- to a library-scoped system isn't difficult, and an understanding of the structures and mechanism may help in this, and in identifying issues, should there be any.


Global-scoped search configuration

 
Folders and Files
 
Triaster\TriasterServer2011\
    MTopSearch\
        DocumentResults\
            <Common document index files>
        MapResults\
            <Common map index files>
        Docs.ini
        Maps.ini
        MTop Re-index.cmd
 
 
Configuration in Settings.xml
 
<Settings>
     .
    <ServerGeneral>
         .
        <LibraryLevelMTopINIFile>false</LibraryLevelMTopINIFile>
         .
    </ServerGeneral>
     .
    <PublicationSettings>
         .
        <Library Name="triaster sample library">
             .
            <Site Name="Live|Prelive|Sandpit">
                 .
                <PostPublish>
                    <task1 Filename="C:\Triaster\TriasterServer2011\MTopSearch\MTop Re-index.cmd">
                    </task1>
                </PostPublish>
                 .
                <ResultsURL>../../MTopSearch/DocumentResults/searchresult.asp</ResultsURL>
 
Note: There is no equivalent pointer to 'MapResults'.
 
 
Library-scoped search configuration
 
More recent implementations scope the search components to a library.
 
Folders and Files
 
Triaster\TriasterServer2011\
    MTopSearch\
        Triaster Sample Library\
            DocumentResults\
                <document index files>
            MapResults\
                <map index files>
            Docs.ini
            Maps.ini
            MTop Re-index.cmd
 
 
Configuration in Settings.xml
 
<Settings>
     .
    <ServerGeneral>
         .
        <LibraryLevelMTopINIFile>true</LibraryLevelMTopINIFile>
         .
    </ServerGeneral>
     .
    <PublicationSettings>
         .
        <Library Name="process library">
             .
            <Site Name="Live|Prelive|Sandpit">
                 .
                <PostPublish>
                    <task1 Filename="C:\Triaster\TriasterServer2011\MTopSearch\Process Library\MTop Re-index.cmd">
                    </task1>
                </PostPublish>
                 .
                <ResultsURL>../../MTopSearch/Process Library/DocumentResults/searchresult.asp</ResultsURL>
 

There are two primary parts to the search mechanism:

    • Creating an index
    • Linking a library site's search facility to the appropriate index
       

    Creating an Index

    Maps and documents are indexed by a post-publish task that's defined in Settings.xml. The 'MTop Re-index.cmd' script launches sessions of MTop Search Engine Composer configured by the appropriate INI file (docs.ini or maps.ini). Amongst other things, these INI files define:

    • The folders to index
    • The output folder to which to write the index files
    • The base URLs from which to build hyperlinks to indexed items
       
    docs.ini

    [INDEXOPTION]
     .
    LOCAL_ADDRESS=C:\Triaster\Documents
    BASE_URL=/Documents/
     .
    LOCAL_FOLDER=
     .

    [BUILDOPTION]
     .
    OUTPUT_FOLDER=C:\Triaster\TriasterServer2011\MTopSearch\Process Library\DocumentResults\
     .
    SUBSECTION=/Documents/*$$$$$$system:documents$$$$$$


    maps.ini

    [INDEXOPTION]
     .
    LOCAL_ADDRESS=C:\Triaster\TriasterServer2011\Settings
    BASE_URL=/Processlibraries 2011/
     .
    LOCAL_FOLDER=C:\Triaster\TriasterServer2011\ProcessLibraries\Process Library\Live\html\$$$$$$/Processlibraries 2011/Process Library/Live/html/$$$$$$C:\Triaster\TriasterServer2011\ProcessLibraries\Process Library\Prelive\html\$$$$$$/Processlibraries 2011/Process Library/Prelive/html/$$$$$$C:\Triaster\TriasterServer2011\ProcessLibraries\Process Library\Sandpit\html\$$$$$$/Processlibraries 2011/Process Library/Sandpit/html/$$$$$$c:\triaster\triasterserver2011\processlibraries\process library\ds\html\$$$$$$/processlibraries 2011/process library/ds/html/$$$$$$
     .
    NOT_INDEX_PAGES0=*/processlibraries 2011/*/*/html/*_files/*
    BOOL_NOT_INDEX_PAGES=1
    ONLY_INDEX_PAGES0=*/processlibraries 2011/*/*/html/*.*.html
    BOOL_ONLY_INDEX_PAGES=1
     .

    [BUILDOPTION]
     .
    OUTPUT_FOLDER=C:\Triaster\TriasterServer2011\MTopSearch\Process Library\MapResults\
     .
    SUBSECTION=/processlibraries 2011/Process Library/live/html/*$$$$$$system:Process Library:live$$$$$$/processlibraries 2011/Process Library/prelive/html/*$$$$$$system:Process Library:prelive$$$$$$/processlibraries 2011/Process Library/sandpit/html/*$$$$$$system:Process Library:sandpit$$$$$$/processlibraries 2011/process library/ds/html/*$$$$$$system:process library:ds$$$$$$


    Note that web URLs are relative to the root of a website, and are independent of host name and protocol, e.g.
    /Processlibraries 2011/Process Library/Live/html/

    which means they would retain validity if the host or alias name were to be changed, or if HTTPS were to be adopted.

    For the global- and library-scoped search systems, some configurations will be different (for example, the output folder), so the INI files aren't interchangeable. Early versions of the 'MTop Re-index.cmd' scripts may have explicit references to the full paths of the INI files, so aren't interchangeable without modification. However, later versions should be: a common copy could be found in each of the library sub-folders of 'MTopSearch'.
     
     
    Linking Search to the correct index
     
    The maps search results page will be in either:
     
    Triaster\TriasterServer\2011\MTopSearch\MapResults
     
    or
     
    Triaster\TriasterServer\2011\MTopSearch\<Library>\MapResults
     
    depending on the <LibraryLevelMTopINIFile> setting in Settings.xml.
     
    The documents search results page is set for each site as <ResultsURL>. This is set explicitly because it could be configured to target a webpage associated with a system other than MTop, for example, a SharePoint page.
     
    Of course, if Search is to report results from an index generated by MTop, then the results page setting must match the output location of the indexing process. A mismatch may result in a '404 - File or directory not found' error or a set of results that doesn't reflect the current contents of the library.





    Need further help? Contact the Triaster Support team by e-mailing support@triaster.co.uk or by calling us on + 44 (0)870 402 1234.
     
    Do you have any feedback or suggestions that you would like to share with Triaster? We would love to hear from you! Please e-mail feedback@triaster.co.uk