Difference between revisions of "SMILA/Documentation/2011.Simplification/Documentation for 5 Minutes to Success"

Revision as of 11:49, 1 March 2011

This page contains installation instructions for the SMILA application and helps you with your first steps in SMILA.

1 Download and unpack SMILA
2 Check the preconditions
3 Start SMILA
4 Check the log file
5 Configure crawler jobs
6 Start the File System Crawler
7 Configuring the File System Crawler
8 Search on indices
9 Configure and run the Web Crawler
10 Manage CrawlerController with jmxclient
11 5 Minutes for changing the workflow
12 Configuration overview

Download and unpack SMILA

Download the SMILA package and unpack it to an arbitrary folder. This will result in the following folder structure:

Check the preconditions

To be able to follow the steps below, check the following preconditions:

You will have to provide a JRE executable to be able to run SMILA. The JVM version should be at least Java 5.
Either:
- add the path of your local JRE executable to the PATH environment variable
  or
- add the argument -vm <path/to/jre/executable> pointing to the local JRE executable at the beginning of the file SMILA.ini.
  Make sure that -vm is indeed the first argument in the file and that there is a line break after it. It should look similar to the following:

-vm d:/java/jre6/bin/java ...

Since we are going to use Jconsole as the JMX client later in this tutorial, it is recommended to install and use a Java SE Development Kit (JDK) and not just a Java SE Runtime Environment (JRE) because the latter does not include this application.
When using the Linux distributable of SMILA, make sure that the file SMILA has executable permissions. If not, set it by running the following command in a console:

chmod +x ./SMILA

Start SMILA

To start the SMILA engine, simply double-click the SMILA.exe executable. Alternatively, open a command line, navigate to the directory where you extracted the files to, and call the SMILA.exe executable. Wait until the engine has been fully started. If everything is fine, you should see output similar to the one on the following screenshot:

Check the log file

Open the SMILA log file in an editor of your choice to find out what is happening in the background. This file is named SMILA.log and can be found in the same directory as the SMILA executable.

Configure crawler jobs

Now when the SMILA engine is up and running we can start a crawler job. Crawler jobs can be managed via the JMX protocol, therefore you can connect to SMILA using any JMX client you like. We are going to use JConsole in the following because it is included in the Java SE Development Kit.

Start the JConsole executable in your JDK distribution (<JAVA_HOME>/bin/jconsole). If the client is up and running, connect to localhost:9004.

Next, switch to the MBeans tab, expand the SMILA node in the MBeans tree on the left side of the window, and click the CrawlerController node. This node is used to manage and monitor all crawling activities.

Start the File System Crawler

To start the File System Crawler, open the Operations tab on the right pane, type "file" into text field next to the startCrawl button and click on startCrawl button.

You should receive a message similar to the following, indicating that the crawler has been successfully started:

Now we can check the log file to see what happened:

The configuration of the File System Crawler defines the folder c:\data to be crawled by default:

<Process>
   <BaseDir>c:\data</BaseDir>
   ...      
</Process>

Configuring the File System Crawler

A possible error message could be that the folder c:\data is not found:

2009-01-27 18:25:59,592 [Thread-12] ERROR impl.CrawlThread - org.eclipse.smila.connectivity.framework.CrawlerCriticalException: Folder "c:\data" is not found

The error message above states that the crawler tried to index folder at c:\data but was not able to find it. To solve this, let's create a folder with sample data, say c:\data, put some dummy text files into it, and configure the File System Crawler to index it. To configure the crawler to index other directories, open the configuration file of the crawler at configuration/org.eclipse.smila.connectivity.framework/file.xml. Modify the BaseDir attribute by setting its value to an absolute path that points to your new directory. Don't forget to save the file.

Note: Currently only plain text and html files are crawled and indexed correctly by SMILA crawlers.

Search on indices

To search on the indices those were created by the crawlers, point your browser to http://localhost:8080/SMILA/search. There are currently two stylesheets(SMILASearchDefault and SMILASearchAdvanced)for the search form. If you choose SMILASearchDefault you will be only able to search on the content (field Query) of the files. In the left column below the Indexlist header you may find the name of all available indices. Currently, there should be only one index in the list (test_index).

Now let's try to search for a word that occurs in your dummy files. In this tutorial we assume that there was a word "data" in both text files.

Now pick a file name of the files in your data folde. E.g. there was a file named glossary.html in the sample folder. Let's check whether it was indexed. Switch to SMILASearchAdvanced and type "glossary.html" (or the name of a file of your data folder) in the Filename field and click on Submit button again:

Configure and run the Web Crawler

Now that we know how to start and configure the File System Crawler and how to search on indices configuring and running the Web Crawler is straightforward: The configuration file of the Web Crawler is located at configuration/org.eclipse.smila.connectivity.framework directory and is named web.xml:

By default the Web Crawler is configured to index the URL http://wiki.eclipse.org/SMILA. To change this, open the file in an editor of your choice and set the content of the <Seed> element to the desired web site. Detailed information on the configuration of the Web Crawler is also available at the Web Crawler configuration page.

To start the crawling process, save the configuration file, open the Operations tab in JConsole again, type "web" into the text field next to the startCrawl button, and click the button.

Note: The Operations tab in JConsole also provides buttons to stop a crawler, get the list of current crawler task states. Default limit for downloaded documents is set to 1000 into webcrawler configuration, so it can take a while for web crawling job to finish. You can stop crawling job manually by typing "web" next to stopCrawl button and then clicking on this button. As an example the following screenshot shows the result after the getCrawlerTasksState button has been clicked while the Web Crawler is running:

When the Web Crawler's job is finished, you can search on the generated index just like described above with the File System Crawler (see step 7).

Manage CrawlerController with jmxclient

In addition to managing crawling jobs with JConsole it's also possible to use jmxclient from SMILA distribution. Jmxclient is a console application that allows to manage crawl jobs and create scripts for batch crawlers execution. For more information please check jmxclient documentation . Jmxclient application is located into jmxclient directory. You should use appropriate run script (run.bat or run.sh) to start the application. For example, to start the File System Crawler use the following command:

run crawl file

5 Minutes for changing the workflow

In previous sections all data collected by crawlers was processed with the same workflow and indexed into the same index, test_index. It's possible to configure SMILA so that data from different data sources will go through different workflows and will be indexed into different indices. This will require more advanced configuration than before but still is quite simple. Let's create additional workflow for webcrawler records so that webcrawler data will be indexed into separate index, say web_index.

Modify Listener rules

First, lets modify the default add rule in Listener and add another rule that will make webcrawler records to be processed by separate BPEL workflow. For more information about Listener, please see the section Listener of the QueueWorker documentation. Listener configuration is placed at the configuration/org.eclipse.smila.connectivity.queue.worker.jms/QueueWorkerListenerConfig.xml Open that file and edit the <Condition> tag of the Default ADD Rule. The result should be as follows:

<Rule Name="ADD Rule" WaitMessageTimeout="10" Threads="2">
  <Source BrokerId="broker1" Queue="SMILA.connectivity"/>
  <Condition>Operation='ADD' and NOT(DataSourceID LIKE 'web%')</Condition>
  <Task>
    <Process Workflow="AddPipeline"/>
  </Task>
</Rule>

Now add the following new rule to this file:

<Rule Name="Web ADD Rule" WaitMessageTimeout="10" Threads="2">
  <Source BrokerId="broker1" Queue="SMILA.connectivity"/>
  <Condition>Operation='ADD' and DataSourceID LIKE 'web%'</Condition>
  <Task>
    <Process Workflow="AddWebPipeline"/>
  </Task>
</Rule>

Notice that we modified condition in the ADD Rule to skip webcrawler data. Webcrawler data will be processed by new Web ADD Rule. Web ADD Rule defines that webcrawler data will be processed by AddWebPipeline workflow, so next we need to create AddWebPipeline workflow.

Create workflow for the BPEL WorkflowProcessor

We need to add the AddWebPipeline workflow to BPEL WorkflowProcessor. For more information about BPEL WorkflowProcessor please check the BPEL WorkflowProcessor documentation. BPEL WorkflowProcessor configuration files are placed at the configuration/org.eclipse.smila.processing.bpel/pipelines directory. There is a file addpipeline.bpel that defines AddPipeline process. Let's create the addwebpipeline.bpel file that will define AddWebPipeline process and put the following code into it:

<?xml version="1.0" encoding="utf-8" ?>
<process name="AddWebPipeline" targetNamespace="http://www.eclipse.org/smila/processor"
    xmlns="http://docs.oasis-open.org/wsbpel/2.0/process/executable" 
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:proc="http://www.eclipse.org/smila/processor" 
    xmlns:rec="http://www.eclipse.org/smila/record">
 
  <import location="processor.wsdl" namespace="http://www.eclipse.org/smila/processor"
      importType="http://schemas.xmlsoap.org/wsdl/" />
 
  <partnerLinks>
    <partnerLink name="Pipeline" partnerLinkType="proc:ProcessorPartnerLinkType" myRole="service" />
  </partnerLinks>
 
  <extensions>
    <extension namespace="http://www.eclipse.org/smila/processor" mustUnderstand="no" />
  </extensions>
 
  <variables>
    <variable name="request" messageType="proc:ProcessorMessage" />
  </variables>
 
  <sequence>
    <receive name="start" partnerLink="Pipeline" portType="proc:ProcessorPortType" operation="process"
        variable="request" createInstance="yes" />
 
    <!-- only process text based content, skip everything else -->
    <if name="conditionIsText">
      <condition>
        contains($request.records/rec:Record[1]/rec:A[@n="MimeType"]/rec:L/rec:V, "text/")
      </condition>
      <sequence name="processTextBasedContent">		  
 
        <!-- extract txt from html files -->
        <if name="conditionIsHtml">
          <condition>
          ($request.records/rec:Record[1]/rec:A[@n="MimeType"]/rec:L/rec:V[contains(., "text/html")]) 
          or 
          ($request.records/rec:Record[1]/rec:A[@n="MimeType"]/rec:L/rec:V[contains(., "text/xml")])
          </condition>
        </if>				
 
        <extensionActivity>
          <proc:invokePipelet name="invokeHtml2Txt">
            <proc:pipelet class="org.eclipse.smila.processing.pipelets.HtmlToTextPipelet" />
            <proc:variables input="request" output="request" />
            <proc:PipeletConfiguration>
              <proc:Property name="inputType">
                <proc:Value>ATTACHMENT</proc:Value>
              </proc:Property>				       
              <proc:Property name="outputType">
                <proc:Value>ATTACHMENT</proc:Value>
              </proc:Property>
              <proc:Property name="inputName">
                <proc:Value>Content</proc:Value>
              </proc:Property>
              <proc:Property name="outputName">
                <proc:Value>Content</proc:Value>
              </proc:Property>
              <proc:Property name="meta:title">
                <proc:Value>Title</proc:Value>
              </proc:Property>					
            </proc:PipeletConfiguration>       								
          </proc:invokePipelet>
        </extensionActivity>
 
        <extensionActivity>
          <proc:invokePipelet name="invokeLucenePipelet">
            <proc:pipelet class="org.eclipse.smila.lucene.pipelets.LuceneIndexPipelet" />
            <proc:variables input="request" output="request" />
            <proc:setAnnotations>
              <rec:An n="org.eclipse.smila.lucene.LuceneIndexService">
                <rec:V n="indexName">web_index</rec:V>
                <rec:V n="executionMode">ADD</rec:V>
              </rec:An>
            </proc:setAnnotations>
          </proc:invokePipelet>
        </extensionActivity>
 
      </sequence>				
    </if>		
 
    <reply name="end" partnerLink="Pipeline" portType="proc:ProcessorPortType" 
operation="process" variable="request" />
    <exit />
  </sequence>
</process>

Note that we use "web_index" index name for the LuceneService in the code above:

<rec:An n="org.eclipse.smila.lucene.LuceneIndexService">
  <rec:V n="indexName">web_index</rec:V>
  <rec:V n="executionMode">ADD</rec:V>
</rec:An>

We need to add our pipeline description to the deploy.xml file placed in the same directory. Add the following code to the end of deploy.xml before the closing </deploy> tag:

<process name="proc:AddWebPipeline">
  <in-memory>true</in-memory>
  <provide partnerLink="Pipeline">
    <service name="proc:AddWebPipeline" port="ProcessorPort" />
  </provide>    
</process>

Now we need to add our web_index to LuceneIndexService configuration.

Configure LuceneIndexService

For more information about LuceneIndexService, please see LuceneIndexService

Let's configure our web_index index structure and search template. Add the following code to the end of configuration/org.eclipse.smila.search.datadictionary/DataDictionary.xml file before the closing </AnyFinderDataDictionary> tag:

<Index Name="web_index">
  <Connection xmlns="http://www.anyfinder.de/DataDictionary/Connection" MaxConnections="5"/>
  <IndexStructure xmlns="http://www.anyfinder.de/IndexStructure" Name="web_index">
    <Analyzer ClassName="org.apache.lucene.analysis.standard.StandardAnalyzer"/>
    <IndexField FieldNo="8" IndexValue="true" Name="MimeType" StoreText="true" Tokenize="true" Type="Text"/>
    <IndexField FieldNo="7" IndexValue="true" Name="Size" StoreText="true" Tokenize="true" Type="Text"/>
    <IndexField FieldNo="6" IndexValue="true" Name="Extension" StoreText="true" Tokenize="true" Type="Text"/>
    <IndexField FieldNo="5" IndexValue="true" Name="Title" StoreText="true" Tokenize="true" Type="Text"/>
    <IndexField FieldNo="4" IndexValue="true" Name="Url" StoreText="true" Tokenize="false" Type="Text">
      <Analyzer ClassName="org.apache.lucene.analysis.WhitespaceAnalyzer"/>
    </IndexField>
    <IndexField FieldNo="3" IndexValue="true" Name="LastModifiedDate" StoreText="true" Tokenize="false" Type="Text"/>
    <IndexField FieldNo="2" IndexValue="true" Name="Path" StoreText="true" Tokenize="true" Type="Text"/>
    <IndexField FieldNo="1" IndexValue="true" Name="Filename" StoreText="true" Tokenize="true" Type="Text"/>
    <IndexField FieldNo="0" IndexValue="true" Name="Content" StoreText="true" Tokenize="true" Type="Text"/>
  </IndexStructure>
  <Configuration xmlns="http://www.anyfinder.de/DataDictionary/Configuration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://www.anyfinder.de/DataDictionary/Configuration ../xml/DataDictionaryConfiguration.xsd">
    <DefaultConfig>
      <Field FieldNo="8">
        <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
          <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
        </FieldConfig>
      </Field>
      <Field FieldNo="7">
        <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
          <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
        </FieldConfig>
      </Field>
      <Field FieldNo="6">
        <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
          <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
        </FieldConfig>
      </Field>        
      <Field FieldNo="5">
        <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
          <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
        </FieldConfig>
      </Field>
      <Field FieldNo="4">
        <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
          <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
        </FieldConfig>
      </Field>
      <Field FieldNo="3">
        <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
          <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
        </FieldConfig>
      </Field>
      <Field FieldNo="2">
        <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
          <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
        </FieldConfig>
      </Field>
      <Field FieldNo="1">
        <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
          <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
        </FieldConfig>
      </Field>
      <Field FieldNo="0">
        <FieldConfig Constraint="required" Weight="1" xsi:type="FTText">
          <NodeTransformer xmlns="http://www.anyfinder.de/Search/ParameterObjects" Name="urn:ExtendedNodeTransformer">
            <ParameterSet xmlns="http://www.brox.de/ParameterSet"/>
          </NodeTransformer>
          <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="AND" Tolerance="exact"/>
        </FieldConfig>
      </Field>
    </DefaultConfig>
 </Configuration>
</Index>

Now we need to add mapping of attribute and attachment names to Lucene "FieldNo" defined in DataDictionary.xml. Open configuration/org.eclipse.smila.lucene/Mappings.xml file and add the following code to the end of file before closing </Mappings> tag:

<Mapping indexName="web_index">
  <Attributes>
    <Attribute name="Filename" fieldNo="1" />
    <Attribute name="Path" fieldNo="2" />    
  <Attribute name="LastModifiedDate" fieldNo="3" />
  <Attribute name="Url" fieldNo="4" />
  <Attribute name="Title" fieldNo="5" />    
  <Attribute name="Extension" fieldNo="6" />
  <Attribute name="Size" fieldNo="7" />
  <Attribute name="MimeType" fieldNo="8" />           
  </Attributes>
  <Attachments>
    <Attachment name="Content" fieldNo="0" />      
  </Attachments>
</Mapping>

Put it all together

Ok, now it seems that we have finally finished configuring SMILA for using separate workflows for file system and web crawling and index data from these crawlers into different indices. Here is what we have done so far:

We modified Listener rules in order to use different workflows for web and file system crawling.
We created a new BPEL workflow for the Web Crawler.
We added the web_index index to the Lucence configuration.

Now we can start SMILA again and observe what will happen when starting the Web Crawler.

It's very important to shutdown SMILA engine and restart afterwards because modified configurations will load only on startup.

Now we can also search on the web_index from browser:

Configuration overview

SMILA configuration files are placed into configuration directory of the SMILA application. Following figure shows configuration files relevant to this tutorial, regarding SMILA components and data lifecycle. SMILA components names are black-colored, directories containing configuration files and filenames are blue-colored.

@@ Line 30: / Line 30: @@
 == Start SMILA ==
-To start the SMILA engine, simply double-click the<tt>SMILA.exe</tt> executable. Alternatively, open a command line, navigate to the directory where you extracted the files to, and call the <tt>SMILA.exe</tt> executable. Wait until the engine has been fully started. If everything is fine, you should see output similar to the one on the following screenshot:
+To start the SMILA engine, simply double-click the <tt>SMILA.exe</tt> executable. Alternatively, open a command line, navigate to the directory where you extracted the files to, and call the <tt>SMILA.exe</tt> executable. Wait until the engine has been fully started. If everything is fine, you should see output similar to the one on the following screenshot:
 [[Image:Smila-console-0.8.0.png]]
 == Check the log file ==
-You can check what's happening in the background by opening the SMILA log file in an editor. This file is named <tt>SMILA.log</tt> and can be found in the same directory as the SMILA executable.
+Open the SMILA log file in an editor of your choice to find out what is happening in the background. This file is named <tt>SMILA.log</tt> and can be found in the same directory as the SMILA executable.
 [[Image:Smila-log.png]]
 == Configure crawler jobs ==
-Now when the SMILA engine is up and running we can start the crawling jobs. Crawling jobs are managed over the JMX protocol, that means that we can connect to SMILA with a JMX client of your choice. We will use JConsole for that purpose since this JMX client is already available as a default with the Sun Java distribution.
+Now when the SMILA engine is up and running we can start a crawler job. Crawler jobs can be managed via the JMX protocol, therefore you can connect to SMILA using any JMX client you like. We are going to use JConsole in the following because it is included in the Java SE Development Kit.
-Start the JConsole executable in your JDK distribution (<tt><JAVA_HOME>/bin/jconsole</tt>). If the client is up and running, select the PID in the ''Connect'' window and click ''Connect''.
+Start the JConsole executable in your JDK distribution (<tt><JAVA_HOME>/bin/jconsole</tt>). If the client is up and running, connect to <tt>localhost:9004</tt>.
 [[Image:Jconsole.png]]

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Difference between revisions of "SMILA/Documentation/2011.Simplification/Documentation for 5 Minutes to Success"

Revision as of 11:49, 1 March 2011

Contents

Download and unpack SMILA

Check the preconditions

Start SMILA

Check the log file

Configure crawler jobs

Start the File System Crawler

Configuring the File System Crawler

Search on indices

Configure and run the Web Crawler

Manage CrawlerController with jmxclient

5 Minutes for changing the workflow

Modify Listener rules

Create workflow for the BPEL WorkflowProcessor

Configure LuceneIndexService

Put it all together

Configuration overview

Breadcrumbs

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Difference between revisions of "SMILA/Documentation/2011.Simplification/Documentation for 5 Minutes to Success"

Revision as of 11:49, 1 March 2011

Contents

Download and unpack SMILA

Check the preconditions

Start SMILA

Check the log file

Configure crawler jobs

Start the File System Crawler

Configuring the File System Crawler

Search on indices

Configure and run the Web Crawler

Manage CrawlerController with jmxclient

5 Minutes for changing the workflow

Modify Listener rules

Create workflow for the BPEL WorkflowProcessor

Configure LuceneIndexService

Put it all together

Configuration overview