Skip to main content
Jump to: navigation, search

Difference between revisions of "SMILA/5 Minutes Tutorial"

m (Start indexing job run)
(Stop SMILA)
 
(58 intermediate revisions by 5 users not shown)
Line 2: Line 2:
 
[[Category:HowTo]]
 
[[Category:HowTo]]
  
This page contains installation instructions for the SMILA application which will help you taking the first steps with SMILA.
+
On this page we describe the necessary steps to install and run SMILA in order to create a search index on the [[SMILA]] Eclipsepedia pages and search them.
  
 
If you have any troubles or the results differ from what is described here, check the [[SMILA/FAQ|FAQ]].
 
If you have any troubles or the results differ from what is described here, check the [[SMILA/FAQ|FAQ]].
 +
 +
== Supported Platforms ==
 +
The following platforms are supported:
 +
*Linux 32 Bit
 +
*Linux 64 Bit
 +
*Mac OS X 64 Bit (Cocoa)
 +
*Windows 32 Bit
 +
*Windows 64 Bit
  
 
== Download and start SMILA ==
 
== Download and start SMILA ==
  
[http://www.eclipse.org/smila/downloads.php Download] the SMILA package and unpack it to an arbitrary folder. This will result in the following folder structure:
+
[http://www.eclipse.org/smila/downloads.php Download] the SMILA package matching your [[#Supported_Platforms|operation system]] and unpack it to an arbitrary folder. This will result in the following folder structure:
  
 
<pre>
 
<pre>
 
/<SMILA>
 
/<SMILA>
  /about_files
+
   /configuration  
   /configuration
+
  /features
+
  /jmxclient
+
  /plugins
+
  /workspace
+
  .eclipseproduct
+
 
   ...
 
   ...
 
   SMILA
 
   SMILA
Line 25: Line 27:
  
 
=== Preconditions ===
 
=== Preconditions ===
To be able to start SMILA, check the following preconditions:
+
To be able to start SMILA, check the following preconditions first:
 
+
==== Supported Platforms ====
+
The following platforms are supported:
+
*Linux 32 Bit
+
*Linux 64 Bit
+
*Mac OS X 64 Bit (Cocoa)
+
*Windows 32 Bit
+
*Windows 64 Bit
+
  
 
==== JRE ====
 
==== JRE ====
You will have to provide a JRE executable to be able to run SMILA. The JVM version should be at least Java 5. You may either:
+
You will have to provide a JRE executable to be able to run SMILA. The JVM version should be Java 7 (or newer). You may either:
 
* add the path of your local JRE executable to the PATH environment variable <br>or<br>
 
* add the path of your local JRE executable to the PATH environment variable <br>or<br>
* add the argument <tt>-vm <path/to/jre/executable></tt> right at the top of the file <tt>SMILA.ini</tt>. <br>Make sure that <tt>-vm</tt> is indeed the first argument in the file and that there is a line break after it. It should look similar to the following:
+
* add the argument <tt>-vm <path/to/jre/executable></tt> right at the top of the file <tt>SMILA.ini</tt>. <br>Make sure that <tt>-vm</tt> is indeed the first argument in the file, that there is a line break after it and that there are no leading or trailing blanks. It should look similar to the following:
 
<div style="margin-left: 1.5em;">
 
<div style="margin-left: 1.5em;">
 
<source lang="text">
 
<source lang="text">
-vm
+
-vm
d:/java/jre6/bin/java
+
d:/java/jre7/bin/java
...
+
...
 
</source>
 
</source>
 
</div>
 
</div>
  
 
==== Linux ====
 
==== Linux ====
When using the Linux distributable of SMILA, make sure that the files <tt>SMILA</tt> and <tt>jmxclient/run.sh</tt> have executable permissions. If not, set the permission by running the following commands in a console:  
+
When using Linux, make sure that the file <tt>SMILA</tt> has executable permissions. If not, set the permission by running the following commands in a console:  
 
<tt>
 
<tt>
 
  chmod +x ./SMILA
 
  chmod +x ./SMILA
chmod +x ./jmxclient/run.sh
 
 
</tt>
 
</tt>
  
 
==== MacOS ====
 
==== MacOS ====
When using MAC switch to <tt>SMILA.app/Contents/MacOS/</tt> and set the permission by running the following commands in a console:
+
When using MAC, switch to <tt>SMILA.app/Contents/MacOS/</tt> and set the permission by running the following command in a console:
 
<tt>
 
<tt>
 
  chmod a+x ./SMILA
 
  chmod a+x ./SMILA
Line 61: Line 54:
  
 
=== Start SMILA ===
 
=== Start SMILA ===
To start the SMILA engine, simply double-click the <tt>SMILA</tt> executable. Alternatively, open a command line, navigate to the directory where you extracted the files to, and execute the <tt>SMILA</tt> executable. Wait until the engine has been fully started. You can tell if SMILA has fully started if the following line is printed in the console window: <tt>HTTP server started successfully on port 8080</tt> and you can access SMILA's REST API at [http://localhost:8080/smila/ http://localhost:8080/smila/].
+
To start SMILA, simply start the <tt>SMILA</tt> executable.  
  
When using MAC, navigate to <tt>SMILA.app/Contents/MacOS/</tt> in terminal, then start with <tt>./SMILA</tt>
+
You can see that SMILA has fully started if the following line is printed on the OSGI console:
 +
<tt>
 +
  ...
 +
  HTTP server started successfully on port 8080
 +
</tt>  
 +
and you can access SMILA's REST API at [http://localhost:8080/smila/ http://localhost:8080/smila/].
  
Before continuing, [[SMILA/FAQ#How_can_I_see_that_SMILA_started_correctly.3F|check the log file]] for possible errors.
+
If it doesn't work, check the log file (SMILA.log) for possible errors.
  
== Install a REST client ==
+
=== Stop SMILA ===
  
We're going to use SMILA's REST API to start and stop jobs, so you need a REST client. In [[SMILA/Documentation/Using_The_ReST_API#Interactive_Tools|REST Tools]] you find a selection of recommended browser plugins if you haven't got a suitable REST client yet.
+
To stop SMILA, type <tt>exit</tt> into the OSGI console and press ''Enter'':
 +
 
 +
<tt>
 +
  osgi> exit
 +
</tt>
  
 
== Start Indexing Job and Crawl Import ==
 
== Start Indexing Job and Crawl Import ==
  
Now we're going to crawl the SMILA Eclipsepedia pages and index them using the embedded Solr.
+
Now we're going to crawl and process the SMILA Eclipsepedia pages, Finally we index and search them by using the embedded [[SMILA/Documentation/Solr|Solr integration]].
  
=== Start indexing job run ===
+
=== Install a REST client ===
  
We are going to start the predefined indexing job "indexUpdate" based on the predefined asynchronous "indexUpdate" workflow. This indexing job will process the imported data.
+
We're going to use SMILA's REST API to start and stop jobs, so you need a REST client. In [[SMILA/Documentation/Using_The_ReST_API#Interactive_Tools|REST Tools]] you find a selection of recommended browser plugins if you haven't got a suitable REST client yet.
  
Use your favorite REST Client to start a job run for the job "indexUpdateJob":
+
=== Start the indexing job run ===
  
<pre>
+
We are going to start the predefined indexing job "indexUpdate" based on the predefined asynchronous workflow with the same name. This indexing job will process the imported data.
POST http://localhost:8080/smila/jobmanager/jobs/indexUpdateJob/
+
</pre>
+
  
Your REST client will show a result like this:
+
Use your favorite REST Client to start a job run for the job "indexUpdate":
  
<pre>
+
<tt>
{
+
   POST http://localhost:8080/smila/jobmanager/jobs/indexUpdate/
   "jobId" : "20110901-121343613053",
+
</tt>
  "url" : "http://localhost:8080/smila/jobmanager/jobs/indexUpdateJob/20110901-121343613053/"
+
}
+
</pre>
+
  
You will need the "jobId" later on to finish the job run. The job run Id can also be found via the monitoring API for the job:
+
Your REST client will show a result like this:
 +
<tt>
 +
{
 +
  "jobId" : "20110901-121343613053",
 +
  "url" : "http://localhost:8080/smila/jobmanager/jobs/indexUpdate/20110901-121343613053/"
 +
}
 +
</tt>
  
<pre>
+
You will need the job run id ("jobId") later on to finish the job run. The job run Id can also be found via the monitoring API for the job:
GET http://localhost:8080/smila/jobmanager/jobs/indexUpdateJob/
+
 
</pre>
+
<tt>
 +
  GET http://localhost:8080/smila/jobmanager/jobs/indexUpdate/
 +
</tt>
  
 
In the <tt>SMILA.log</tt> file you will see a message like that:
 
In the <tt>SMILA.log</tt> file you will see a message like that:
<pre>
+
<tt>
INFO ... internal.JobRunEngineImpl  - started job run '20110901-121343613053' for job 'indexUpdateJob'
+
  INFO ... internal.JobRunEngineImpl  - started job run '20110901-121343613053' for job 'indexUpdate'
</pre>
+
</tt>
  
'''Further information''': The "indexUpdate" workflow uses the [[SMILA/Documentation/Worker/PipelineProcessorWorker|PipelineProcessorWorker]] that executes the synchronous "AddPipeline" BPEL workflow. So, the synchronous "AddPipeline" BPEL workflow is embedded in the asynchronous "indexUpdate" workflow. For more details about the "indexUpdate" workflow and "indexUpdate" job definitions see <tt>SMILA/configuration/org.eclipse.smila.jobmanager/workflows.json</tt> and <tt>jobs.json</tt>). For more information about job management in general please check the [[SMILA/Documentation/JobManager|JobManager documentation]].
+
'''Further information''': The "indexUpdate" workflow uses the [[SMILA/Documentation/Worker/ScriptProcessorWorker|ScriptProcessorWorker]] that executes the JavaScript "add.js" workflow. So, the synchronous script call is embedded in the asynchronous "indexUpdate" workflow. For more details about the "indexUpdate" workflow and "indexUpdate" job definitions see <tt>SMILA/configuration/org.eclipse.smila.jobmanager/workflows.json</tt> and <tt>jobs.json</tt>). For more information about job management in general please check the [[SMILA/Documentation/JobManager|JobManager documentation]].
  
=== Start the crawler ===
+
=== Start the crawl job run  ===
  
Now that the indexing job is running we need to push some data to it. There is a predefined job for indexing the SMILA Eclipsepedia pages which we are going to start right now. We need to start this job in the so-called {{code|runOnce}} mode, which is a special mode where tasks are generated by the system rather than by an input trigger and where the jobs are finished automatically. For more information why this is the case, please see [[SMILA/Documentation/Importing/Concept|Importing Concept]]. For more information on jobs and tasks, visit the [[SMILA/Documentation/JobManager|JobManager manual]].
+
Now that the indexing job is running we need to push some data to it. There is a predefined job for importing the [[SMILA|SMILA Wiki]] pages which we are going to start right now.
 +
<tt>
 +
  POST http://localhost:8080/smila/jobmanager/jobs/crawlSmilaWiki/
 +
</tt>
  
To start the job run, POST the following JSON fragment with your REST client to the SMILA job REST API at [http://localhost:8080/smila/jobmanager/jobs/crawlSmilaWiki http://localhost:8080/smila/jobmanager/jobs/crawlSmilaWiki]:
+
This starts the job <tt>crawlSmilaWiki</tt>, which crawls the SMILA Wiki starting with <tt>http://wiki.eclipse.org/SMILA</tt> and (by applying the configured filters) following only links that have the same prefix. All pages crawled matching this prefix will be pushed to the import job.
<source lang="javascript">
+
{
+
  "mode": "runOnce"
+
}
+
</source>
+
  
This starts the job <tt>crawlSmilaWiki</tt>, which crawls the [[SMILA|SMILA Eclipsepedia]] starting at <tt>http://wiki.eclipse.org/SMILA</tt> and following only links that have the same prefix. All pages crawled matching this prefix will be pushed to the import job.
+
Both job runs can be monitored via SMILA's REST API:
 +
* All jobs: [http://localhost:8080/smila/jobmanager/jobs/ http://localhost:8080/smila/jobmanager/jobs/]
 +
* Crawl job: [http://localhost:8080/smila/jobmanager/jobs/crawlSmilaWiki http://localhost:8080/smila/jobmanager/jobs/crawlSmilaWiki]
 +
* Import job: [http://localhost:8080/smila/jobmanager/jobs/indexUpdate http://localhost:8080/smila/jobmanager/jobs/indexUpdate]
  
If you like, you can monitor both job runs with your REST client at the following URIs:
+
The crawling of the SMILA Wiki pages should take some time. If all pages are processed, the status of the [http://localhost:8080/smila/jobmanager/jobs/crawlSmilaWiki crawlSmilaWiki]'s job run will change to {{code|SUCCEEDED}}. You can continue with the SMILA search (next chapter) to find out if some of the pages have already made their way into the Solr index.
* crawl job: [http://localhost:8080/smila/jobmanager/jobs/crawlSmilaWiki http://localhost:8080/smila/jobmanager/jobs/crawlSmilaWiki]
+
* import job: [http://localhost:8080/smila/jobmanager/jobs/indexUpdate http://localhost:8080/smila/jobmanager/jobs/indexUpdate]
+
Or just in one overview at
+
* [http://localhost:8080/smila/jobmanager/jobs/ http://localhost:8080/smila/jobmanager/jobs/]
+
  
The crawling of the wikipedia page should take some time. If all pages are processed, the status of the [http://localhost:8080/smila/jobmanager/jobs/crawlSmilaWiki crawlSmilaWiki]'s job run will change to {{code|SUCCEEDED}}. You can have a look at SMILA's search page to find out if some of the pages have already made their way into the Solr index.
+
'''Further information:''' For more information about importing and crawl jobs please see [[SMILA/Documentation#Importing | SMILA Importing ]]. For more information on jobs and tasks in general visit the [[SMILA/Documentation/JobManager|JobManager manual]].
 
+
You can find more information about the [[SMILA/Manual#Importing|Importing here]].
+
  
 
== Search the index ==
 
== Search the index ==
  
{{note|Since SMILA uses [[SMILA/Documentation/Solr#solrconfig.xml|Solr's autocommit feature]] (which is configured in <tt>solrconfig.xml</tt> to a period of 60 seconds or 1000 documents, whichever comes first) it might take some time until you retrieve results.}}
+
To have a look at the index state, e.g. how many documents are already indexed, call:
 +
<tt>
 +
  http://localhost:8080/solr/admin/
 +
</tt>
  
To search the index which was created by the crawlers, point your browser to <tt>http://localhost:8080/SMILA/search</tt>. There are currently two stylesheets from which you can select by clicking the respective links in the upper left corner of the header bar: The ''Default'' stylesheet shows a reduced search form with text fields like ''Query'', ''Result Size'', and ''Index Name'', adequate to query the full-text content of the indexed documents. The ''Advanced'' stylesheet in turn provides a more detailed search form with text fields for meta-data search like for example ''Path'', ''MimeType'', ''Filename'', and other document attributes.  
+
To search the created index, point your browser to  
 +
<tt>
 +
  http://localhost:8080/SMILA/search
 +
</tt>.  
 +
 
 +
There are currently two stylesheets from which you can select by clicking the respective links in the upper left corner of the header bar: The ''Default'' stylesheet shows a reduced search form with text fields like ''Query'', ''Result Size'', and ''Index'', adequate to query the full-text content of the indexed documents. The ''Advanced'' stylesheet in turn provides a more detailed search form with text fields for meta-data search like for example ''Path'', ''MimeType'', ''Filename'', and other document attributes.  
  
 
'''To use the ''Default'' Stylesheet''':
 
'''To use the ''Default'' Stylesheet''':
 
#Point your browser to <tt>http://localhost:8080/SMILA/search</tt>.
 
#Point your browser to <tt>http://localhost:8080/SMILA/search</tt>.
#Enter a word that you expect to be contained in your dummy files into the ''Query'' text field.
+
#Enter the search term(s) into the ''Query'' text field (e.g. "SMILA").
 
# Click ''OK'' to send your query to SMILA.  
 
# Click ''OK'' to send your query to SMILA.  
  
Line 144: Line 152:
 
#Point your browser to <tt>http://localhost:8080/SMILA/search</tt>.
 
#Point your browser to <tt>http://localhost:8080/SMILA/search</tt>.
 
#Click ''Advanced'' to switch to the detailed search form.
 
#Click ''Advanced'' to switch to the detailed search form.
#To find a file by its name, enter the file name into the ''Filename'' text field, then click ''OK'' to submit your search.
+
#For example, to find a file by its name, enter the file name into the ''Filename'' text field, then click ''OK'' to submit your search.
  
 
== Stop indexing job run ==
 
== Stop indexing job run ==
  
 
Although there's no need for it, we can finish our previously started indexing job run via REST client now:
 
Although there's no need for it, we can finish our previously started indexing job run via REST client now:
(replace <job-id> with the job-id you got before when you started the job run).
+
(replace <job-id> with the job run id you got before when [[#Start_indexing_job_run|you started the job run]]).
  
<pre>
+
<tt>
POST http://localhost:8080/smila/jobmanager/jobs/indexUpdate/<job-id>/finish   
+
  POST http://localhost:8080/smila/jobmanager/jobs/indexUpdate/<job-id>/finish   
</pre>
+
</tt>
  
 
You can monitor the job run via your browser to see that it has finished successfully:
 
You can monitor the job run via your browser to see that it has finished successfully:
<pre>
+
<tt>
http://localhost:8080/smila/jobmanager/jobs/indexUpdate/<job-id>
+
  GET http://localhost:8080/smila/jobmanager/jobs/indexUpdate/<job-id>
</pre>
+
</tt>
  
 
In the <tt>SMILA.log</tt> file you will see messages like this:
 
In the <tt>SMILA.log</tt> file you will see messages like this:
<pre>
+
<tt>
 
  INFO ... internal.JobRunEngineImpl  - finish called for job 'indexUpdate', run '20110901-141457584011'
 
  INFO ... internal.JobRunEngineImpl  - finish called for job 'indexUpdate', run '20110901-141457584011'
 
  ...
 
  ...
 
  INFO ... internal.JobRunEngineImpl  - Completing job run '20110901-141457584011' for job 'indexUpdate' with final state SUCCEEDED
 
  INFO ... internal.JobRunEngineImpl  - Completing job run '20110901-141457584011' for job 'indexUpdate' with final state SUCCEEDED
</pre>
+
</tt>
 +
 
 +
<br/>
 +
<br/>
 +
'''Congratulations, you've just finished the tutorial! '''
  
Congratulations, you've just crawled the SMILA Eclipsepedia, indexed the pages and searched through them. For more, just visit [[SMILA/Manual|SMILA Manual]].
+
You crawled the SMILA Wiki, indexed the pages and searched through them. For more, just continue with the chapter below or visit the [[SMILA/Documentation|SMILA Documentation]].
  
 
== Further steps ==
 
== Further steps ==
Line 173: Line 185:
 
=== Crawl the filesystem ===
 
=== Crawl the filesystem ===
  
SMILA has also a predefined job to crawl the file system, but you will have to either adapt the predefined job to point it to a valid folder in your filesystem or create your own job.
+
SMILA has also a predefined job to crawl the file system ("crawlFilesystem"), but you will have to either adapt the predefined job to point it to a valid folder in your filesystem or create your own job.  
  
 
We will settle for the second option, because it does not need that you stop and restart SMILA.
 
We will settle for the second option, because it does not need that you stop and restart SMILA.
  
 
==== Create your Job ====
 
==== Create your Job ====
POST the following job description to [[SMILA/Documentation/JobDefinitions#List.2C_create.2C_modify_jobs|SMILA's Job API]] at <tt>http://localhost:8080/smila/jobmanager/jobs</tt> (the name is just an example, as well as the {{code|rootFolder}}, which you should set to an existing folder on your machine where some data files (e.g. plain text, HTML files) reside.
+
POST the following job description to [[SMILA/Documentation/JobDefinitions#List.2C_create.2C_modify_jobs|SMILA's Job API]]. Adapt the <tt>rootFolder</tt> parameter to point to an existing folder on your machine where you have placed some files (e.g. plain text, office docs or HTML files). If your path includes backslashes, escape them with an additional backslash, e.g. <tt>c:\\data\\files</tt>.
<source lang="javascript">
+
<tt>
{
+
POST http://localhost:8080/smila/jobmanager/jobs/
 +
{
 
   "name":"crawlFilesAtData",
 
   "name":"crawlFilesAtData",
 
   "workflow":"fileCrawling",
 
   "workflow":"fileCrawling",
Line 187: Line 200:
 
     "dataSource":"file",
 
     "dataSource":"file",
 
     "rootFolder":"/data",
 
     "rootFolder":"/data",
     "jobToPushTo":"indexUpdate"
+
     "jobToPushTo":"indexUpdate",
  }
+
    "mapping":{
}
+
      "fileContent":"Content",
</source>
+
      "filePath":"Path",     
 +
      "fileName":"Filename",     
 +
      "fileExtension":"Extension",
 +
      "fileLastModified":"LastModifiedDate"
 +
      }
 +
  }
 +
}
 +
</tt>
  
For text files other than plain text and HTML you cannot search inside the document's text (at least not right now, but you might have a look at [[SMILA/Documentation/AperturePipelet|Aperture Pipelet]] which addresses this problem).
+
''Hint: Not all file formats are supported by SMILA out-of-the-box. Have a look [[SMILA/Documentation/TikaPipelet#Supported_document_types | here]] for details.''
  
 
==== Start your jobs ====
 
==== Start your jobs ====
  
#Start the <tt>indexUpdateJob</tt> (see [[#Start_indexing_job_run|Start indexing job run]]), if you have already stopped it. If it is still running, that's fine.
+
* Start the <tt>indexUpdate</tt> job (see [[#Start_indexing_job_run|Start indexing job run]]), if you have already stopped it. (If it is still running, that's fine)
# Start your <tt>crawlFilesAtData</tt> job similar to [[#Start_the_crawler|Start the crawler]] but now use the job name <tt>crawlFilesAtData</tt> instead of <tt>crawlSmilaWiki</tt>.<br> This new job behaves just like the web crawling job, but its run time might be shorter, depending on how much data actually is at your {{code|rootFolder}}.
+
<tt>
 +
  POST http://localhost:8080/smila/jobmanager/jobs/indexUpdate/
 +
</tt>
 +
 
 +
* Start your <tt>crawlFilesAtData</tt> job. This new job behaves just like the web crawling job we used above, but its run time might be shorter, depending on how much data actually is at your {{code|rootFolder}}.
 +
<tt>
 +
  POST http://localhost:8080/smila/jobmanager/jobs/crawlFilesAtData/
 +
</tt>
  
 
==== Search for your new data ====
 
==== Search for your new data ====
#After the job run's finished, wait a bit, then check whether the data has been indexed (see [[#Search_the_index|Search the index]] for help).
+
#After the job run's finished, wait a bit, then check whether the data has been indexed (see [[#Search_the_index|Search the index]]).
 
#It is also a good idea to check the log file for errors.
 
#It is also a good idea to check the log file for errors.
  
 
=== 5 more minutes to change the workflow ===
 
=== 5 more minutes to change the workflow ===
  
The [[SMILA/Documentation/5 more minutes to change the workflow|5 more minutes to change the workflow]] show how you can configure the system so that data from different data sources will go through different workflows and pipelines and will be indexed into different indices.
+
The [[SMILA/Documentation/5 more minutes to change the workflow|5 more minutes to change the workflow]] show how you can configure the system so that data from different data sources will go through different workflows and scripts and will be indexed into different indices.

Latest revision as of 08:58, 15 April 2015


On this page we describe the necessary steps to install and run SMILA in order to create a search index on the SMILA Eclipsepedia pages and search them.

If you have any troubles or the results differ from what is described here, check the FAQ.

Supported Platforms

The following platforms are supported:

  • Linux 32 Bit
  • Linux 64 Bit
  • Mac OS X 64 Bit (Cocoa)
  • Windows 32 Bit
  • Windows 64 Bit

Download and start SMILA

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

/<SMILA>
  /configuration    
  ...
  SMILA
  SMILA.ini

Preconditions

To be able to start SMILA, check the following preconditions first:

JRE

You will have to provide a JRE executable to be able to run SMILA. The JVM version should be Java 7 (or newer). You may either:

  • add the path of your local JRE executable to the PATH environment variable
    or
  • add the argument -vm <path/to/jre/executable> right at the top of the file SMILA.ini.
    Make sure that -vm is indeed the first argument in the file, that there is a line break after it and that there are no leading or trailing blanks. It should look similar to the following:
-vm
d:/java/jre7/bin/java
...

Linux

When using Linux, make sure that the file SMILA has executable permissions. If not, set the permission by running the following commands in a console:

chmod +x ./SMILA

MacOS

When using MAC, switch to SMILA.app/Contents/MacOS/ and set the permission by running the following command in a console:

chmod a+x ./SMILA

Start SMILA

To start SMILA, simply start the SMILA executable.

You can see that SMILA has fully started if the following line is printed on the OSGI console:

 ...
 HTTP server started successfully on port 8080

and you can access SMILA's REST API at http://localhost:8080/smila/.

If it doesn't work, check the log file (SMILA.log) for possible errors.

Stop SMILA

To stop SMILA, type exit into the OSGI console and press Enter:

 osgi> exit

Start Indexing Job and Crawl Import

Now we're going to crawl and process the SMILA Eclipsepedia pages, Finally we index and search them by using the embedded Solr integration.

Install a REST client

We're going to use SMILA's REST API to start and stop jobs, so you need a REST client. In REST Tools you find a selection of recommended browser plugins if you haven't got a suitable REST client yet.

Start the indexing job run

We are going to start the predefined indexing job "indexUpdate" based on the predefined asynchronous workflow with the same name. This indexing job will process the imported data.

Use your favorite REST Client to start a job run for the job "indexUpdate":

 POST http://localhost:8080/smila/jobmanager/jobs/indexUpdate/

Your REST client will show a result like this:

{
  "jobId" : "20110901-121343613053",
  "url" : "http://localhost:8080/smila/jobmanager/jobs/indexUpdate/20110901-121343613053/"
}

You will need the job run id ("jobId") later on to finish the job run. The job run Id can also be found via the monitoring API for the job:

 GET http://localhost:8080/smila/jobmanager/jobs/indexUpdate/

In the SMILA.log file you will see a message like that:

 INFO ... internal.JobRunEngineImpl   - started job run '20110901-121343613053' for job 'indexUpdate'

Further information: The "indexUpdate" workflow uses the ScriptProcessorWorker that executes the JavaScript "add.js" workflow. So, the synchronous script call is embedded in the asynchronous "indexUpdate" workflow. For more details about the "indexUpdate" workflow and "indexUpdate" job definitions see SMILA/configuration/org.eclipse.smila.jobmanager/workflows.json and jobs.json). For more information about job management in general please check the JobManager documentation.

Start the crawl job run

Now that the indexing job is running we need to push some data to it. There is a predefined job for importing the SMILA Wiki pages which we are going to start right now.

 POST http://localhost:8080/smila/jobmanager/jobs/crawlSmilaWiki/

This starts the job crawlSmilaWiki, which crawls the SMILA Wiki starting with http://wiki.eclipse.org/SMILA and (by applying the configured filters) following only links that have the same prefix. All pages crawled matching this prefix will be pushed to the import job.

Both job runs can be monitored via SMILA's REST API:

The crawling of the SMILA Wiki pages should take some time. If all pages are processed, the status of the crawlSmilaWiki's job run will change to SUCCEEDED. You can continue with the SMILA search (next chapter) to find out if some of the pages have already made their way into the Solr index.

Further information: For more information about importing and crawl jobs please see SMILA Importing . For more information on jobs and tasks in general visit the JobManager manual.

Search the index

To have a look at the index state, e.g. how many documents are already indexed, call:

 http://localhost:8080/solr/admin/

To search the created index, point your browser to

 http://localhost:8080/SMILA/search

.

There are currently two stylesheets from which you can select by clicking the respective links in the upper left corner of the header bar: The Default stylesheet shows a reduced search form with text fields like Query, Result Size, and Index, adequate to query the full-text content of the indexed documents. The Advanced stylesheet in turn provides a more detailed search form with text fields for meta-data search like for example Path, MimeType, Filename, and other document attributes.

To use the Default Stylesheet:

  1. Point your browser to http://localhost:8080/SMILA/search.
  2. Enter the search term(s) into the Query text field (e.g. "SMILA").
  3. Click OK to send your query to SMILA.

To use the Advanced Stylesheet:

  1. Point your browser to http://localhost:8080/SMILA/search.
  2. Click Advanced to switch to the detailed search form.
  3. For example, to find a file by its name, enter the file name into the Filename text field, then click OK to submit your search.

Stop indexing job run

Although there's no need for it, we can finish our previously started indexing job run via REST client now: (replace <job-id> with the job run id you got before when you started the job run).

 POST http://localhost:8080/smila/jobmanager/jobs/indexUpdate/<job-id>/finish  

You can monitor the job run via your browser to see that it has finished successfully:

 GET http://localhost:8080/smila/jobmanager/jobs/indexUpdate/<job-id>

In the SMILA.log file you will see messages like this:

INFO ... internal.JobRunEngineImpl   - finish called for job 'indexUpdate', run '20110901-141457584011'
...
INFO ... internal.JobRunEngineImpl   - Completing job run '20110901-141457584011' for job 'indexUpdate' with final state SUCCEEDED



Congratulations, you've just finished the tutorial!

You crawled the SMILA Wiki, indexed the pages and searched through them. For more, just continue with the chapter below or visit the SMILA Documentation.

Further steps

Crawl the filesystem

SMILA has also a predefined job to crawl the file system ("crawlFilesystem"), but you will have to either adapt the predefined job to point it to a valid folder in your filesystem or create your own job.

We will settle for the second option, because it does not need that you stop and restart SMILA.

Create your Job

POST the following job description to SMILA's Job API. Adapt the rootFolder parameter to point to an existing folder on your machine where you have placed some files (e.g. plain text, office docs or HTML files). If your path includes backslashes, escape them with an additional backslash, e.g. c:\\data\\files.

POST http://localhost:8080/smila/jobmanager/jobs/
{
 "name":"crawlFilesAtData",
 "workflow":"fileCrawling",
 "parameters":{
   "tempStore":"temp",
   "dataSource":"file",
   "rootFolder":"/data",
   "jobToPushTo":"indexUpdate",
   "mapping":{
     "fileContent":"Content",
     "filePath":"Path",       
     "fileName":"Filename",       
     "fileExtension":"Extension",
     "fileLastModified":"LastModifiedDate"
     }
  }
}

Hint: Not all file formats are supported by SMILA out-of-the-box. Have a look here for details.

Start your jobs

  • Start the indexUpdate job (see Start indexing job run), if you have already stopped it. (If it is still running, that's fine)

  POST http://localhost:8080/smila/jobmanager/jobs/indexUpdate/

  • Start your crawlFilesAtData job. This new job behaves just like the web crawling job we used above, but its run time might be shorter, depending on how much data actually is at your rootFolder.

 POST http://localhost:8080/smila/jobmanager/jobs/crawlFilesAtData/

Search for your new data

  1. After the job run's finished, wait a bit, then check whether the data has been indexed (see Search the index).
  2. It is also a good idea to check the log file for errors.

5 more minutes to change the workflow

The 5 more minutes to change the workflow show how you can configure the system so that data from different data sources will go through different workflows and scripts and will be indexed into different indices.

Back to the top