View source for SMILA/5 Minutes Tutorial

[[Category:SMILA]]
[[Category:HowTo]]

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

== 1. Download and unpack the SMILA application. ==

[[Image:Save-and-extract.png]]

If you use Linux version of SMILA please make sure that the file SMILA has executable permissions. If not, you can set it by running ''chmod +x ./SMILA'' command in console.

== 2. Start the SMILA engine. ==

To start SMILA engine open terminal, navigate to the directory that contains extracted files, and run SMILA executable. Wait until the engine is fully started. If everything is OK, you should see output similar to the one on the following screenshot:

[[Image:Start-engine.png]]

Please note that to run SMILA you need to have jre executable added to your PATH environment variable. The jvm version should be at least java 5.

Optionally you can configure jvm into SMILA.ini file instead of environment variable. Put the argument ''-vm <path/to/jre/executable>'' at the beginning of SMILA.ini, for example:
 -vm
 /usr/java/jre1.5.0.16/bin/java
 ...

== 3. 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.

[[Image:Log-file.png]]

== 4. Configure crawling 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.

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''.

[[Image:Jconsole-connect.png]]

Next, switch to the ''MBeans'' tab, expand the SMILA node in the ''MBeans'' tree on the left side of the window, and click the <tt>org.eclipse.smila.connectivity.framework.CrawlerController</tt> node. This node is used to manage and monitor all crawling activities. Click a sub node and find the crawling attributes on the right pane.

[[Image:Mbeans-overview.png]]

== 5. Start the file system crawler. ==
To start filesystem crawler, open the ''Operations'' tab on the right pane, type "file" into text field next to the <tt>startCrawl</tt> button and click on <tt>startCrawl</tt> button.

[[Image:Start-file-crawl.png]]

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

[[Image:Start-crawl-file-result.png]]

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

[[Image:File-crawl-log.png]]

== 6. Configuring the filesystem crawler. ==
You could notice error message in log output after starting filesystem crawler:

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

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

{|width="100%" style="background-color:#ffcccc; padding-left:30px;"
|
Please note that currently only plain text and html files are crawled and indexed correctly by SMILA crawlers.
|}

[[Image:File-crawl-config-with-data.png]]

Now start the file system crawler with JConsole again (see step 5). This time there should be something interesting in the log file:

[[Image:Filesystem-crawler-in-work.png]]

It looks like something was indexed. In the next step we'll try to search on the index that was created.

== 7. Searching on the indices. ==
To search on the indices that were created by the crawlers, point your browser to <tt>http://localhost:8080/AnyFinder/SearchForm</tt>. Find the name of all available indices in the left column below the ''Indexlist'' header. Currently, there should be only one index in the list (test_index). Click its name to open the search form:

[[Image:Smila-search-form.png]]

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. 

[[Image:Searching-for-text-in-file.png]]

There was a file named <tt>1.txt</tt> in the sample folder. Let's check whether it was indexed. Type "1.txt" in the ''Filename'' field and click on Submit button again:

[[Image:Searching-by-filename.png]]

== 8. 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 <tt>configuration/org.eclipse.smila.connectivity.framework directory</tt> and is named <tt>web</tt>:

[[Image:Webcrawler-config.png]]

By default the web crawler is configured to index the URL ''http://en.wikipedia.org/ website''. To change this, open the file in an editor of your choice and set the content of the <tt>&lt;Seed&gt;</tt> element to the desired web site. Detailed information on the configuration of the web crawler is also available at the [[SMILA/Documentation/Web_Crawler|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 <tt>startCrawl</tt> button, and click the button.

[[Image:Starting-web-crawler.png]]

Note that the ''Operations'' tab in JConsole also provides buttons to stop a crawler, get the list of active crawlers and the current status of a particular crawling job.
As an example the following screenshot shows the result after the <tt>getActiveCrawlsStatus</tt> button has been clicked while the web crawler is running:

[[Image:One-active-crawl-found.png]]

{|width="100%" style="background-color:#d8e4f1; padding-left:30px;"
|
''Note:'' 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 <tt>stopCrawl</tt> button and then clicking on this button.
|}

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).

[[Image:Webcrawler-index-search.png]]

[[Category:SMILA]]


== 9. Managing CrawlerController with jmxagent. ==

In addition to managing crawling jobs with JConsole it's also possible to use jmxagent from SMILA distribution. Jmxagent is a console application that allows to manage crawl jobs and create scripts for batch crawlers execution. For more information please check [[SMILA/Project_Concepts/CrawlerController_Remote_Management#JMX_agent_application|jmxagent documentation ]].  Jmxagent application is located into <tt>jmxagent</tt> directory. You should use appropriate run script (run.bat or run.sh) to start the application. 
For example, to start filesystem crawler use following command:


<code>
''./run.sh -agent=org.eclipse.smila.connectivity.framework.CrawlerController -cmd=startCrawl -dataSourceId=file -crawler=FileSystemCrawlerDS
</code>''


[[Image:Crawlercontroller-jmxagent.png]]

For more examples on using jmxagent application please check <tt>sample.sh</tt> script from jmxagent directory and [[SMILA/Project_Concepts/CrawlerController_Remote_Management#JMX_agent_application|jmxagent documentation ]].


== 5 Minutes for Changing 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.

=== 1. Modify Listener rules. ===

First, lets modify the default add rule in the 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 [[SMILA/Documentation/QueueWorker/Listener|Listener]] of the [[SMILA/Documentation/QueueWorker|QueueWorker]] documentation.
Listener configuration is placed at the 
<tt>configuration/org.eclipse.smila.connectivity.queue.worker/ListenerConfig.xml</tt>
Open that file and edit the <tt><Condition></tt> tag of the Default ADD Rule. The result should be as follows:
<source lang="xml">
<Rule Name="ADD Rule" WaitMessageTimeout="10" Workers="2">
  <Source BrokerId="broker1" Queue="SMILA.connectivity"/>
  <Condition>Operation='ADD' and NOT(DataSourceID LIKE 'web%')</Condition>
  <Task>
    <Process Workflow="AddPipeline"/>
  </Task>
</Rule>
</source>
Now add the following new rule to this file:
<source lang="xml">
<Rule Name="Web ADD Rule" WaitMessageTimeout="10" Workers="2">
  <Source BrokerId="broker1" Queue="SMILA.connectivity"/>
  <Condition>Operation='ADD' and DataSourceID LIKE 'web%'</Condition>
  <Task>
    <Process Workflow="AddWebPipeline"/>
  </Task>
</Rule>
</source>
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.

=== 2. 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 [[SMILA/Documentation/BPEL_Workflow_Processor|BPEL WorkflowProcessor]] documentation.
BPEL WorkflowProcessor configuration files are placed at the <tt>configuration/org.eclipse.smila.processing.bpel/pipelines</tt> directory.
There is a file <tt>addpipeline.bpel</tt> that defines AddPipeline process. Let's create the <tt>addwebpipeline.bpel</tt> file that will define AddWebPipeline process and put the following code into it:
<source lang="xml">
<?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 name="invokeHtml2Txt">
          <proc:invokePipelet>
            <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 name="invokeLuceneService">
          <proc:invokeService>
            <proc:service name="LuceneIndexService" />
            <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:invokeService>
        </extensionActivity>
				
      </sequence>				
    </if>		

    <reply name="end" partnerLink="Pipeline" portType="proc:ProcessorPortType" operation="process" variable="request" />
    <exit />
  </sequence>
</process>
</source>

Note that we use "web_index" index name for the LuceneService in the code above:
<source lang="xml">
<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>
</source>

We need to add our pipeline description to the <tt>deploy.xml</tt> file placed in the same directory. Add the following code to the end of <tt>deploy.xml</tt> before the closing <tt></deploy></tt> tag:
<source lang="xml">
<process name="proc:AddWebPipeline">
  <in-memory>true</in-memory>
  <provide partnerLink="Pipeline">
    <service name="proc:AddWebPipeline" port="ProcessorPort" />
  </provide>    
</process>
</source>

Now we need to add our web_index to LuceneIndexService configuration.

=== 3. LuceneIndexService configuration ===
For more information about LuceneIndexService, please see [[SMILA/Documentation/LuceneIndexService|LuceneIndexService]]

Let's configure our web_index index structure and search template. Add the following code to the end of <tt>configuration/org.eclipse.smila.search.datadictionary/DataDictionary.xml</tt> file before the closing <tt></AnyFinderDataDictionary></tt> tag:
<source lang="xml">
<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>
  <Result>
    <Field FieldNo="0" Name="ID"/>
  </Result>
  <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>
    <Result Name="">
      <ResultField FieldNo="8" Name="MimeType"/>
      <ResultField FieldNo="7" Name="Size"/>
      <ResultField FieldNo="6" Name="Extension"/>
      <ResultField FieldNo="5" Name="Title"/>
      <ResultField FieldNo="4" Name="Url"/>
      <ResultField FieldNo="3" Name="LastModifiedDate"/>
      <ResultField FieldNo="2" Name="Path"/>
      <ResultField FieldNo="1" Name="Filename"/>
    </Result>
    <HighlightingResult Name="">
      <HighlightingResultField FieldNo="0" Name="Content" xsi:type="HLTextField">
        <HighlightingTransformer Name="urn:Sentence">
          <ParameterSet xmlns="http://www.brox.de/ParameterSet">
            <Parameter Name="MaxLength" xsi:type="Integer">
              <Value>300</Value>
            </Parameter>
            <Parameter Name="MaxHLElements" xsi:type="Integer">
              <Value>999</Value>
            </Parameter>
            <Parameter Name="MaxSucceedingCharacters" xsi:type="Integer">
              <Value>30</Value>
            </Parameter>
            <Parameter Name="SucceedingCharacters" xsi:type="String">
              <Value>...</Value>
            </Parameter>
            <Parameter Name="SortAlgorithm" xsi:type="String">
              <Value>Occurrence</Value>
            </Parameter>
            <Parameter Name="TextHandling" xsi:type="String">
              <Value>ReturnSnipplet</Value>
            </Parameter>
          </ParameterSet>
        </HighlightingTransformer>
        <HighlightingParameter xmlns="http://www.anyfinder.de/DataDictionary/Configuration/TextHighlighting"/>
      </HighlightingResultField>
    </HighlightingResult>
  </Configuration>
</Index>
</source>
Now we need to add mapping of attribute and attachment names to Lucene "FieldNo" defined in <tt>DataDictionary.xml</tt>. Open <tt>configuration/org.eclipse.smila.lucene/Mappings.xml</tt> file and add the following code to the end of file before closing <tt></Mappings></tt> tag:
<source lang="xml">
<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>
</source>

=== 4. Put it  all together ===
Ok, now it seems that we finally finished configuring SMILA for using separate workflows for Filesystem and Web crawlers and index data from these crawlers into different indices.
Here is what we have done so far:
# Modified Listener rules to use different workflows for Filesystem and Web crawlers
# Created new BPEL workflow for Web crawler
# Added webcrawler index to the lucence configurations.
No we can start SMILA again and look what's happening when we start Web crawler:

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


[[Image:Web_index.png]]
{|width="100%" style="background-color:#d8e4f1; padding-left:30px;"
|
To get output like on screenshot above you need to add line <tt>"log4j.logger.org.eclipse.smila.xmlstorage.internal.impl=DEBUG, file"</tt>  to the <tt>log4j.properties</tt> file from the root of the SMILA directory.

It will enable logging of records that are committed to xml storage.
|}



Web crawler records now contain web_index attribute as expected. Now we can also search on the web_index from browser:


[[Image:Web_index-search.png]]

== Configuration overview ==

SMILA configuration files are placed into <tt>configuration</tt> 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.

[[Image:Smila-configuration-overview.jpg]]