ELM Server Exchange Edition Live Indexing and Search version 5.5

Transcription

1 ELM Server Exchange Edition Live Indexing and Search version 5.5

2 Copyright 2016 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International, Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

3 Table of Contents 1 Introduction Components... 1 Installing the Live Indexing Plug-In Running the Set-up Adding a New Plug-In Configuring the Plug-In.... Creating a Normal Job for Live Indexing....5 Creating a Group for Live Indexing Configuring a Group for Live Indexing....6 Starting the Job and Searching Live s... 6 Troubleshooting Post-Processing Service Configuration Notification Service Configuration Useful Keys Starting the Services... 9

4 ELM Server Exchange Edition Live Indexing and Search version Introduction SAPERION ELM Server Exchange Edition provides full-text search over archived content. Beginning with ELM version 5.0, it is also possible to search in live s. ELM provides a single interface (the web interface, "ArchiveWeb") which end users and auditors can use to search active and archived s. Since the amount of live messages in an organization can be quite high, the goal of this feature is not to index all live s, but to provide search capabilities until the s are archived. In a typical scenario, all s of a defined age are automatically archived. The indexing that occurs during archiving ensures that the archived content will be searchable. The live s up to that particular age are, however, not indexed, and therefore not searchable (or are only searchable using a different search application). By defining an age after which s should be archived, the amount of live s is kept to reasonable levels. Live indexing works by first searching for non-archived s. These s are put into a database, from which they are sent to the search/index service for processing. i 2 To make live indexing available, the mailbox must already be imported in ELM. Components The live indexing and search feature consists of the following components, which need to be configured and synchronized: ELM Search server The ELM Search server is the central search and index management application. The live index is stored in the same index files as the archived index; the management is the same for both types of mails. collector-scheduler script To collect s eligible for live indexing, a special scheduled job containing a specialized script is responsible for data collection. Post-processing plug-in Once the live s are collected by the automatic job, the indexing is invoked by a special postprocessing plug-in for live indexing. The plug-in is managed by the post-processing service and is responsible for communication with the search server. Live notification service The live notification service is responsible for monitoring the already-indexed live s, and for removing live s which no longer exist from the index. This keeps messages which have been deleted before being archived out of the live index. 1

5 Installing the Live Indexing Plug-In ArchiveWeb ArchiveWeb is the search and ediscovery interface which allows searching in live s as well. Installing the Live Indexing Plug-In The installation consists of the following three steps:.1 Running the Set-up The installation file for this feature is called ELM Live Indexing_x.x.xx.exe, where x.x.xx stands for the current version number. Simply run the setup to install the feature..2 Adding a New Plug-In To add a the post-processing plugin: 1. Open SAPERION Enterprise Manager and navigate to the View > Manager > PostProcessing tab. 2. Right-click the plug-in list, and choose Add from the context menu.. From the drop-down list, select the PostProcessingMCSSearchLive.PPMCSSearchLivePlugin, as shown in the following image: Fig. 1: Add Plug-In. Add the plug-in to the list of processed plug-ins by clicking the [Add] button. 2

6 . i 5.. Configuring the Plug-In The live plug-in should only be added once. If the plug-in is added multiple times, it could create redundant information in the full-text index. Open SAPERION Enterprise Manager and navigate to the View > Manager > PostProcessing tab. Check that the new plug-in has been added to the plug-in list. Configuring the Plug-In Once you have confirmed that the plug-in has been successfully added, you can configure it. To configure the plug-in: 1. Right-click it and select Properties from the context menu. 2. The "Plugin is active" check box must be checked in the pop-up window. A correctly configured plug-in should look like the plug-in shown in the following image: Fig. 2: Configure Plug-In For more details about the Post Processing service configuration, please refer to the ELM Server Exchange Edition Administrator Manual.. Creating a Normal Job for Live Indexing To create a normal job for live indexing: 1. In Enterprise Manager > Manager view, click the "Jobs" tab. 2. Right-click in the job list (left pane) and select New job from the context menu.

7 Installing the Live Indexing Plug-In. In the pop-up dialog, enter the name of the job, e.g. LiveIndexing. By default, the job type is set to Normal.. Click [OK]. You can leave the default settings for the job..5 Creating a Group for Live Indexing If you do not have a group of users for which you want to activate the live indexing, you need to create a new group and define its members. To create a group for live indexing: 1. In Enterprise Manager, click Tools > Addressbook Manager. 2. On the Groups tab, right-click inside the list view.. In the context menu, select Task > Add group wizard. The wizard helps you to quickly create a group and add its members. For a detailed description of the wizard, see the ELM Server Exchange Edition Administrator Manual. Fig. : Add Group Wizard.5.1 Configuring a Group for Live Indexing 1. In the Enterprise Manager > Manager view > Groups tab, double-click the group created in the previous step to open its Properties. 2. In the Scheduler tab in the Select job drop-down menu, choose the job you created in the previous section.

8 .5. Creating a Group for Live Indexing In the Script tab, copy and paste the content of the "Live IndexingSchedulerScript.js" file from the installation package. The path to the file is: c:\program Files (x86)\common Files\SAPERION\Services\MCSPostProcessingSv\Plugins\PostProcessSearchLive\Live IndexingSchedulerS. import System; import System.Convert; import System.Collections; import MCSScriptEngine; import PamDataAccess; class Script { public static function Main(MAILLIST : MailEvaluatorArrayList, SCRIPTENGINE : IScriptEngine) : void { var i : int; SCRIPTENGINE.DebugMessage("Script 'Live indexing' started"); for (i = 0; i < MAILLIST.Count; i) { var m; var comparedate : DateTime; MAILLIST[i].IsArchivable = false; m = MAILLIST[i].MailObject; comparedate = DateTime.Now.Subtract(TimeSpan.FromDays(0)); if (m.receiveddate < comparedate) continue; var cmd: PamDBCommand; cmd = SCRIPTENGINE.GetCommand(); cmd.commandtype = System.Data.CommandType.StoredProcedure; if (typeof(cmd.oraclecommand) == "undefined") { cmd.commandtext = SCRIPTENGINE.Schema ".SP_EXPAM_ADDTOLIVEINDEXPOOL"; } else { cmd.commandtext = SCRIPTENGINE.Schema ".EXCHANGEPAM.SP_EXPAM_ADDTOLIVEINDEXPOOL"; } cmd.addparameter("entryid", FieldType.VARCHAR); cmd.addparameter("creationdate", FieldType.DATE); cmd.addparameter("mbxid", FieldType.INTEGER); cmd.addparameter("parentfolder", FieldType.VARCHAR); cmd.setparameter("entryid", m.entryid); cmd.setparameter("creationdate", m.receiveddate); 5

9 Installing the Live Indexing Plug-In cmd.setparameter("mbxid", m.mbxid); cmd.setparameter("parentfolder", m.parentfolder); cmd.executenonquery(true); } } } Using this script, the Scheduler service sends the group members' unarchived s to the indexing service. By default, the script is set to index s that are 0 days old or newer. To index and then search older s as well, set this in the script by simply changing the number 0 to the desired number of days in the following line: comparedate = DateTime.Now.Subtract(TimeSpan.FromDays(0)).6 Starting the Job and Searching Live s After the job has started and had enough time to index all non-archived mails, the search functionality in ArchiveWeb can be used: 1. Start ArchiveWeb and execute a search by going to Search > SaperionELM and selecting "Search in live s" on the "More choices" tab. Fig. : Search in Live s 2. In the search results, live s are highlighted in dark green. 6

10 .1 Post-Processing Service Configuration Fig. 5: Search Results Troubleshooting Should an issue arise during live indexing and search, check that the following settings are configured as specified..1 i Post-Processing Service Configuration Before you begin, the Post Processing service (ELMPostProcessingSv) needs to be stopped. The service can be found under Start > Administrative Tools > Services. Fig. 1: Services The Post Processing service needs to be extended with a configuration key-value pair. The configuration file of the service (ELMPostProcessingSv.exe.config) is located in the following directory: C:\Program Files (x86)\common Files\SAPERION\Services\MCSPostProcessingSv To configure the service, open the file in a text editor (e.g. Notepad.exe) and create the following key inside the appsettings section (between the <appsettings> and </appsettings> tags): <add key="epamwsurl" value=" The <servername> placeholder stands for the ELM server name, and must contain the correct value. The Port number is optional and must only be specified when the default communication port (80) is not available for ELM Server Exchange Edition. Following is a sample configuration file: <configsections> <section name="errorcodes" type="system.configuration.dictionarysectionhandler" /> <section name="postprocessrecipients" type="system.configuration.dictionarysectionhandler"/> </configsections> 7

11 Troubleshooting <PostProcessRecipients> <add key="allmailboxes" value="1" /> </PostProcessRecipients> <appsettings> <add key="connectionstring" value="**********"/> <add key="dbuser" value="******"/> <add key="dbschema" value="******"/> <add key="dbpassword" value="******"/> <add key="dbtype" value="******"/> <add key="debuglevel" value="0"/> <add key="checkinterval" value="******"/> <add key="workermaxruntime" value="*******"/> <add key="maxdocsperround" value="**"/> <add key="maxdocprocattempts" value="*"/> <add key="emcswsurl" value=" </appsettings>.2 Notification Service Configuration The plug-in notification service is called LiveIndex.NotificationSv. This service starts the notification job, then loads a batch of documents from the database. The service can be found in the installation directory under C:\Program Files (x86)\common Files\SAPERION\Services. The configuration file in the installation directory (LiveIndex.NotificationSv.exe.config) contains configuration keys used to optimize the service. The missing values are entered in the config file within quotation marks. The green hints help you locate the correct values in the registry. Example To find the correct DBServer value string, locate the following registry key: HKEY_LOCAL_MACHINE \ SOFTWARE \ SAPERION \ Mail Compliance Suite \ DataBase \ DBConnectionString As instructed in the hint, copy the Data Source value from the key and enter it as the DBServer value in the config key, as follows: add key= DBServer add value= <copied Data Source value> <?xml version="1.0" encoding="utf-8"?> <configuration> <appsettings> <!--Set the Database configuration keys from registry--> <!--HKEY_LOCAL_MACHINE\SOFTWARE\SAPERION\Mail Compliance Suite\DataBase\DBConnectionString >> Data Source = DBServer--> <add key="dbserver" value="" /> <!-- The possible values are MSSQL or ORACLE--> <add key="dbtype" value="" /> 8

12 . Useful Keys <!--HKEY_LOCAL_MACHINE\SOFTWARE\SAPERION\Mail Compliance Suite\DataBase\DBConnectionString >> Initial Catalog = DBTable--> <add key="dbtable" value="" /> <!--HKEY_LOCAL_MACHINE\SOFTWARE\SAPERION\Mail Compliance Suite\DataBase\DBConnectionString >> User Id = DBUser--> <!--Leave this value empty, if you are using integrated windows authentification--> <add key="dbuser" value="" /> <!--HKEY_LOCAL_MACHINE\SOFTWARE\SAPERION\Mail Compliance Suite\DataBase\PamDBPassword--> <add key="dbpassword" value="" /> <!--HKEY_LOCAL_MACHINE\SOFTWARE\SAPERION\Mail Compliance Suite\DataBase\PamDBSchema--> <add key="dbschema" value="" /> <add key="cronexpression" value="*/2 * * * *" /> <add key="maxruntime" value="1" /> <add key="batchsize" value="20" /> <add key="lucenefturi" value="tcp://localhost:8228/mcssearch"/> </appsettings> </configuration>. Useful Keys DBType Defines the type of database used by ELM Server Exchange Edition. The possible values are MSSQL or ORACLE. CronExpression Cron is a time-based job scheduler in UNIX-like computer operating systems. Cron enables users to schedule jobs (via commands or shell scripts) to run periodically. For a detailed explanation, see: MaxRunTime Specifies the maximum allowed time for the job to run in MINUTES. If it takes more time for the job to process the documents, the job will be paused and will be restored at the next start time. BatchSize The size of document collection to be checked on Exchange Server at once. lucenefturi URL address of the ELM Search. Starting the Services Check that the Post Processing service and the Live Notification service (added by the setup) are started, by navigating to Start > All Programs > Administrative Tools > Services. 9

13 Fig. 2: Start Services 10 Troubleshooting