Installing Combined Search in Triaster Server 12 and later

 This article is suitable for an IT Adminstrator

Ref: 201209100855
Last Edited: September 24th, 2012

Introduction

Combined Search is a development of the Search tool which is new in Triaster Server 12. Quick Search now returns listings of process maps and documents, but on separate tabs.
 
This requires installing third-party search software, MTop Search Engine Composer.

Procedure

Prerequisites

Enable classic ASP

Windows Server 2003
  1. Check whether Active Server Pages is enabled.
    1. Open Internet Information Services (IIS) Manager.
      Start > 'Administrative Tools' > 'Internet Information Services (IIS) Manager'
    2. In the left-hand pane, expand '<Computer Name> (local computer)'.
    3. Click on 'Web Server Extensions'.
    4. In the right-hand pane, ensure 'Active Server Pages' is set to 'Allowed'.
  2. If 'Active Server Pages' isn't listed, then install it.
    1. Start > Control Panel > Add or Remove Programs.
    2. Click 'Add/Remove Windows Components'.
    3. In the 'Windows Components Wizard', click 'Application Server' to select it (so click its text, not its check box), and click 'Details...'.
    4. In the 'Application Server' dialog, click 'Internet Information Services (IIS)' to select it, and click 'Details...'.
    5. In the 'Internet Information Services (IIS)' dialog, click 'World Wide Web Service' to select it, and click 'Details...'.
    6. In the 'Word Wide Web Service' dialog, ensure 'Active Server Pages' is checked, and click OK.
    7. Click OK to close the dialogs to return to the 'Windows Components Wizard' dialog.
    8. Click 'Next >'.
    9. Click 'Finish'.
    10. Ensure Active Server Pages is enabled, as described above.
 
Windows Server 2008
  1. Check whether ASP is enabled.
    1. Open Server Manager.
      Start > 'Administrative Tools' > 'Server Manager'
    2. In the left-hand pane, expand 'Roles'.
    3. Click 'Web Server (IIS)'.
    4. In the middle pane, under 'Role Services', ensure 'ASP' is listed as 'Installed' (under Web Server > Application Development).
  2. If ASP isn't installed, install it.
    1. Continuing from above, click 'Add Role Services'.
    2. Ensure ASP is checked.
    3. Click 'Next >'.
    4. Click 'Install'.

Installation

  1. Log on to the Triaster Server as the publication user (the user account under which the 'Triaster Publication Server 2011' service runs).
  2. Install MTop Search Engine Composer by running the setup executable.
    Note: This would be in the 'Combined Search' package available from Triaster's Software Download page. The expected version is 5.9.
  3. Before running the software, replace 'xlhtml.exe' with the updated version supplied (v0.5.5.0).
    Typical location:
    'C:\Program Files\MTop Software\Search Engine Composer\Convert\xls'
  4. Run Search Engine Composer, and enter the licence information supplied.
  5. Create folders for the Search data:
    C:\Triaster\TriasterServer2011\
        MTopSearch\
            DocumentResults\
            MapResults\
  6. Create an 'MTopSearch' virtual directory in IIS.
    Windows Server 2003:
    1. Open 'Internet Information Services (IIS) Manager'.
      Start > Administrative Tools > Internet Information Services (IIS) Manager
    2. In the left-hand pane, expand '<Computer Name> (local computer)' > Web Sites > Default Web Site.
    3. Right-click 'Default Web Site' > 'New' > 'Virtual Directory...'.
    4. In the 'Virtual Directory Creation Wizard', click 'Next >'.
    5. Set 'Alias' to 'MTopSearch', and click 'Next >'.
    6. Set 'Path' to the 'MTopSearch' folder created earlier, typically:
      'C:\Triaster\TriasterServer2011\MTopSearch'
      and click 'Next >'.
    7. Set permissions:
      Read - TRUE
      Run scripts (such as ASP) - TRUE
      and click 'Next >'.
    8. Click 'Finish'.
    Windows Server 2008:
    1. Open 'Internet Information Services (IIS) Manager'.
      Start > Administrative Tools > Internet Information Services (IIS) Manager
    2. In the left-hand pane, expand '<Computer Name> (<User Name>)' > 'Sites' > 'Default Web Site'
    3. Right-click 'Default Web Site' > 'Add Virtual Directory...'
    4. In the 'Add Virtual Directory' dialog, set 'Alias' to 'MTopSearch'.
    5. Set 'Physical path' to the 'MTopSearch' folder created earlier, typically:
      'C:\Triaster\TriasterServer2011\MTopSearch'
    6. Click OK.
  7. In Windows Explorer, create a 'Documents' folder in the 'Triaster' folder, typically:
    'C:\Triaster'
  8. In Internet Information Services (IIS) Manager, create a 'Documents' virtual directory under 'Default Web Site', associating it with the 'Triaster\Documents' folder created earlier.
    (See the creation of the MTopSearch virtual directory described earlier for instructions.)
  9. Copy the following files to the 'MTopSearch' folder:
    docs.ini
    global.ini
    maps.ini
    MTop Re-index.cmd
    Re-index Document Store.cmd
  10. Ensure these files aren't blocked.
    For each of those files:
    1. Right-click the file > Properties.
    2. If there's an 'Unblock' button at the bottom-right of the dialog, click it.
    3. Click OK to close the dialog.
    Note: If these files have been downloaded from the Internet, they may have been tagged with the security zone of their origin, i.e. Internet. When attempting to run such a file, Windows may prompt for confirmation. If that happens in a non-interactive automated publication, the publication will appear to hang. Unblocking the files removes those tags and allows them to be run without the prompt.
  11. Configure 'docs.ini'.
    1. Open 'docs.ini' in Notepad.
    2. Ensure the file paths and URLs reflect this installation, and replace references to 'localhost' with the name or alias of the server. The significant settings are:
      [INDEXOPTION]
      LOCAL_ADDRESS
      BASE_URL
      [BUILDOPTION]
      OUTPUT_FOLDER
      SUBSECTION
    3. Save and close the file.
  12. Configure 'maps.ini'.
    1. Open 'maps.ini' in Notepad.
    2. Ensure the file paths and URLs reflect this installation, and replace references to 'localhost' with the name or alias of the server. The significant settings are:
      [INDEXOPTION]
      LOCAL_ADDRESS
      BASE_URL
      LOCAL_FOLDER
      [BUILDOPTION]
      OUTPUT_FOLDER
      SUBSECTION
    3. Save and close the file.
  13. Configure 'MTop Re-index.cmd'.
    1. Open 'MTop Re-index.cmd' in Notepad.
    2. Ensure the paths to the MTop Search Engine Composer executable and indexing configuration files are correct, by default:
      'C:\Program Files (x86)\MTop Software\Search Engine Composer\search.exe'
      'C:\Triaster\TriasterServer2011\MTopSearch\maps.ini'
      'C:\Triaster\TriasterServer2011\MTopSearch\docs.ini'
    3. Close the file, saving changes if necessary.
  14. Configure 'Re-index Document Store.cmd'.
    1. In Windows Explorer, create a 'Re-index Document Store' folder in the 'TriasterServer2011' folder.
    2. Open 'Re-index Document Store.cmd' in Notepad.
    3. Ensure the path to the 'Re-index Document Store' folder is set correctly.
    4. Close the file, saving changes if necessary.
  15. Index the map HTML and document stores.
    1. Run 'MTop Re-index.cmd', typically found in:
      'C:\Triaster\TriasterServer2011\MTopSearch'
  16. Create a scheduled task to index the stores nightly.
    Windows Server 2003:
    1. Click Start > Control Panel > right-click 'Scheduled Tasks' > Open.
    2. In 'Scheduled tasks', double-click 'Add Scheduled Task'.
    3. In the 'Scheduled Task Wizard', click 'Next >'.
    4. Click 'Browse...', select 'MTop Re-index.cmd' (typically found in 'C:\Triaster\TriasterServer2011\MTopSearch'), and click 'Open'.
    5. Retain the name (or choose a new one if thought more suitable), select 'Daily' for when to 'Perform this task', and click 'Next >'.
    6. Set a suitable start time.
      This should be after any nightly scheduled publications so that the newly-published HTML is included in the index. Publications are often scheduled to run at or shortly after midnight, so 2:00 a.m. could be such a time.
    7. Ensure the task is set to run 'Every Day' at a suitable start date, and click 'Next >'.
    8. Enter the credentials (typically of the publication user), and click 'Next >'.
    9. Tick 'Open advanced properties...', and click 'Finish'.
    10. On the 'Task' tab of the task dialog, set 'Comments' to 'Re-index the process library document and HTML stores.'
    11. Click OK to close the dialog.
    Windows Server 2008:
    1. Click Start > Administrative Tools > Task Scheduler.
    2. In 'Task Scheduler', in the left-hand pane, click 'Task Scheduler Library'.
    3. Right-click 'Task Scheduler Library' > 'New Folder...'.
    4. Name the new folder 'Triaster', and click OK.
    5. In the left-hand pane, ensure 'Task Scheduler Library' is expanded, and click on 'Triaster'.
    6. In the right-hand pane, click 'Create Task...'.
    7. In 'Create Task', on the 'General' tab, set:
      Name: MTop Re-index
      Description: Re-index the process library document and HTML stores.
      Run whether user is logged on or not - TRUE
      Run with highest privileges - TRUE
      Hidden - FALSE
      Configure for: Windows Vista or Windows Server 2008
    8. Click on the 'Triggers' tab, and click 'New...'.
    9. In 'New Trigger', set:
      Begin the task: On a schedule
      Settings: Daily
      Start: <Current date> 02:00:00
      Delay task for up to (random delay): FALSE
      Repeat task every: FALSE
      Stop task if it runs longer than: 2 hours
      Expire: FALSE
      Enabled: TRUE
      and click OK.
    10. Click the 'Actions' tab, and click 'New...'.
    11. In 'New Action', set:
      Action: Start a program
      Program/script: browse to and select 'MTop Re-index.cmd' (typically found in 'C:\Triaster\TriasterServer2011\MTopSearch').
      Add arguments (optional): <Blank>
      Start in (optional): <Blank>
      and click OK.
    12. Click the 'Settings' tab, and set:
      Stop the task if it runs longer than: 2 hours
      Retain other default settings.
    13. Click OK to close the task.
  17. Create a scheduled task to check for triggers intended to index the stores.
    (This is the purpose of 'Re-index Document Store.cmd'.)
    Windows Server 2003:
    1. If 'Scheduled Tasks' isn't already open, Click Start > Control Panel > right-click 'Scheduled Tasks' > Open.
    2. In 'Scheduled tasks', double-click 'Add Scheduled Task'.
    3. In the 'Scheduled Task Wizard', click 'Next >'.
    4. Click 'Browse...', select 'Re-index Document Store.cmd' (typically found in 'C:\Triaster\TriasterServer2011\MTopSearch'), and click 'Open'.
    5. Name the task, 'MTop Re-index Document Store on demand', select 'Daily' for when to 'Perform this task', and click 'Next >'.
    6. Set a start time of '00:00'.
    7. Ensure the task is set to run 'Every Day' from a start date of the current day, and click 'Next >'.
    8. Enter the credentials (typically of the publication user), and click 'Next >'.
    9. Tick 'Open advanced properties...', and click 'Finish'.
    10. On the 'Task' tab of the task dialog, set 'Comments' to 'Check for a trigger file, and if found, re-index the process library document and HTML stores.'
    11. Click the 'Schedule' tab, and click 'Advanced...'.
    12. In the 'Advanced Schedule Options' dialog, set:
      Repeat task: TRUE
      Every: 15 minutes
      Duration: 24 hours
      and click OK.
    13. Click OK to close the task dialog.
    Windows Server 2008:
    1. Click Start > Administrative Tools > Task Scheduler.
    2. In 'Task Scheduler', in the left-hand pane, expand 'Task Scheduler Library'.
    3. If there isn't already a 'Triaster' folder, right-click 'Task Scheduler Library' > 'New Folder...'.
    4. Name the new folder 'Triaster', and click OK.
    5. In the left-hand pane, ensure 'Task Scheduler Library' is expanded, and click on 'Triaster'.
    6. In the right-hand pane, click 'Create Task...'.
    7. In 'Create Task', on the 'General' tab, set:
      Name:  MTop Re-index Document Store on demand 
      Description:  Check for a trigger file, and if found, re-index the process library document and HTML stores.
      Run whether user is logged on or not - TRUE
      Run with highest privileges - TRUE
      Hidden - FALSE
      Configure for: Windows Vista or Windows Server 2008
    8. Click on the 'Triggers' tab, and click 'New...'.
    9. In 'New Trigger', set:
      Begin the task: On a schedule
      Settings: One time
      Start: <Current date> 00:00:00
      Delay task for up to (random delay): FALSE
      Repeat task every: TRUE, '15 minutes' for a duration of 'Indefinitely'
      Stop task if it runs longer than: 2 hours
      Expire: FALSE
      Enabled: TRUE
      and click OK.
    10. Click the 'Actions' tab, and click 'New...'.
    11. In 'New Action', set:
      Action: Start a program
      Program/script: browse to and select 'Re-index Document Store.cmd' (typically found in 'C:\Triaster\TriasterServer2011\MTopSearch').
      Add arguments (optional): <Blank>
      Start in (optional): <Blank>
      and click OK.
    12. Click the 'Settings' tab, and set:
      Stop the task if it runs longer than: 2 hours
      Retain other default settings.
    13. Click OK to close the task.
    14. Enter the credentials of the publication user, and click OK.
  18. Enable MTop Search for each of the process library sites.
    For each library site, the files for which are typically found in:
    'C:\Triaster\TriasterServer2011\ProcessLibraries\<Library>\<Site>'
    1. Open the Search 'config.xml' file in Notepad:
      'C:\Triaster\TriasterServer2011\ProcessLibraries\<Library>\<Site>\Tools\Search'
    2. Ensure the following setting is made:
      <DocumentSearchEnabled>mtop</DocumentSearchEnabled>
    3. Save and close the file.
  19. Enable Combined Search for each of the process library sites.
    1. In Windows Explorer, navigate to the 'Settings' folder, typically found in:
      'C:\Triaster\TriasterServer2011'
    2. Take a back-up copy of 'Settings.xml'.
      Note: This is important, as a corrupt 'Settings.xml' file would disable much of the Triaster Server functionality.
    3. Open 'Settings.xml' in Notepad.
    4. Search for instances of '<CombinedSearch>', and ensure this setting:
      <CombinedSearch>True</CombinedSearch>
      Note: There will be a setting for each site.
    5. Save the file.
  20. Implement a re-index of the stores at the end of each site publication.
    1. With 'Settings.xml' open in Notepad, search for instances of '<PostPublish>', and ensure this setting:
      <PostPublish>
          <task1 Filename="C:\Triaster\TriasterServer2011\MTopSearch\MTop Re-index.cmd"></task1>
      </PostPublish>
      ensuring the path to the CMD file is correct.
      Note: There will such a setting for each site.
    2. Save and close the file.

Validation

The Search results will, of course, depend on there being suitable maps published to HTML and documents. If the observations differ from those expected, the files and configurations described in the installation procedure should be checked.

MTop Search

This is to verify that the MTop Search is active and working properly for 'Search Documents'.
  1. In Internet Explorer, open a process library site.
  2. In the navigation bar, click 'SEARCH'.
  3. On the Search page, click 'Search Documents'.

    The page should look similar to this:

    Document Search page with MTop search enabled

  4. Type a search term, and click 'GO'.

    The results should be listed like this:

    Search results from the MTop Document Search


Quick Search

This is to verify that Quick Search operates on both maps and documents.
  1. In Internet Explorer, open a process library site.
  2. In the 'Quick Search' box in the navigation bar, type a search term, and click the adjacent 'Search Now' symbol.

    The process map search results should be listed like this:

    Quick Search process maps results

  3. Click the 'Document Search Results' tab.

    The document search results should be listed like this:

    Quick Search documents results




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