Skip to main content
Jump to: navigation, search

Difference between revisions of "SMILA/Documentation/5 more minutes to change the workflow"

(scripting)
(scripting)
Line 32: Line 32:
 
Predefined scripts are contained in the <tt>configuration/org.eclipse.smila.scripting/js</tt> directory. We can add new scripts by just adding them there.
 
Predefined scripts are contained in the <tt>configuration/org.eclipse.smila.scripting/js</tt> directory. We can add new scripts by just adding them there.
  
Copy the script file "add.js", name the copy "addWeb.js" and change the solr "CoreName" in there from "DefaultCore" to "WebCore":
+
Copy the script "add.js", name the copy "addWeb.js" and change the solr "CoreName" in there from "DefaultCore" to "WebCore":
  
 
<pre>
 
<pre>
    ...
+
  ...
    var solrIndexPipelet = pipelets.create("org.eclipse.smila.solr.index.SolrIndexPipelet", {
+
  var solrIndexPipelet = pipelets.create("org.eclipse.smila.solr.index.SolrIndexPipelet", {
    "ExecutionMode" : "ADD",
+
      "ExecutionMode" : "ADD",
    "CoreName" : "WebCore",
+
      "CoreName" : "WebCore",
 
   ...
 
   ...
 
</pre>
 
</pre>
Line 46: Line 46:
 
== Create and start a new indexing job ==
 
== Create and start a new indexing job ==
  
We define an indexing job based on the predefined asynchronous workflow "importToPipeline" (see <tt>SMILA/configuration/org.eclipse.smila.jobmanager/workflows.json</tt>). This indexing job will process the imported data by using our new BPEL pipeline "AddWebPipeline".
+
We define a new indexing job based on the predefined asynchronous workflow "indexWithScript" (see <tt>SMILA/configuration/org.eclipse.smila.jobmanager/workflows.json</tt>). This indexing job will process the imported data by using our new script "addWeb.js".
  
The "importToPipeline" workflow contains a [[SMILA/Documentation/Worker/PipelineProcessorWorker|PipelineProcessorWorker worker]] which is not configured for dedicated BPEL pipelines, so the BPEL pipelines handling adds and deletes have to be set via job parameter.  
+
The "indexWithScript" workflow contains a [[SMILA/Documentation/Worker/ScriptProcessorWorker|ScriptProcessorWorker worker]] which is not configured for a dedicated script, so the scripts handling adds and deletes have to be set via job parameter.  
  
 
Use your favourite REST Client to create an appropriate job definition:
 
Use your favourite REST Client to create an appropriate job definition:
Line 58: Line 58:
 
     "parameters":{       
 
     "parameters":{       
 
       "tempStore": "temp",
 
       "tempStore": "temp",
       "addPipeline": "AddWebPipeline",
+
       "addScript": "add",
       "deletePipeline": "DeletePipeline"  
+
       "deleteScript": "delete"  
 
     },
 
     },
     "workflow":"importToPipeline"
+
     "workflow":"indexWithScript"
 
   }
 
   }
 
</pre>
 
</pre>
  
Note that the "DeletePipeline" is not needed for our test szenario here, but we must fulfill all undefined workflow parameters.
+
Notes:
 +
* the "deleteScript" is not needed for our test scenario here, but we must fulfill all undefined workflow parameters.
 +
* in the add and the delete script we use the standard function ("process"), so we don't have to set/change this via parameter.
  
 
Afterwards, start a job run for the defined job:
 
Afterwards, start a job run for the defined job:
Line 77: Line 79:
 
Since the web crawl job already is predefined to push the crawled records to the <tt>indexUpdate</tt> job, we now either must define a new job or update the crawl job's definition in the {{code|job.json}} file. Here we choose the ''new job'' option.
 
Since the web crawl job already is predefined to push the crawled records to the <tt>indexUpdate</tt> job, we now either must define a new job or update the crawl job's definition in the {{code|job.json}} file. Here we choose the ''new job'' option.
  
POST the following update json using your favorite REST client:
 
 
<pre>
 
<pre>
 
POST http://localhost:8080/smila/jobmanager/jobs/
 
POST http://localhost:8080/smila/jobmanager/jobs/
Line 100: Line 101:
 
</pre>
 
</pre>
  
Now start the crawl job (don't forget runOnce!):
+
Now start the crawl job:
 
<pre>
 
<pre>
 
POST http://localhost:8080/smila/jobmanager/jobs/crawlWikiToWebCore
 
POST http://localhost:8080/smila/jobmanager/jobs/crawlWikiToWebCore
{
 
  "mode": "runOnce"
 
}
 
 
</pre>
 
</pre>
  
After a sufficiently long time to crawl, process and commit the data, you can have another look at the [http://localhost:8080/SMILA/search SMILA search page] to find your new core listed among the available cores, and if you choose it, you can search for e.g. ''SMILA'' in the new WebCore.
+
After some time to crawl, process and commit the data, you can have another look at the [http://localhost:8080/SMILA/search SMILA search page] to find your new core listed among the available cores, and if you choose it, you can search for e.g. ''SMILA'' in the new WebCore.
  
 
== Put it  all together ==
 
== Put it  all together ==
  
Ok, now it seems that we have finally finished configuring SMILA for using separate BPEL pipelines for file system and web crawling and index data from these crawlers into different indices.
+
Ok, now it seems that we have finally finished configuring SMILA for using separate scripts for file system and web crawling and index data from these crawlers into different indices.
 
Here is what we have done so far:
 
Here is what we have done so far:
 
# We added the <tt>WebCore</tt> index to the Solr configuration and copied it to the workspace.
 
# We added the <tt>WebCore</tt> index to the Solr configuration and copied it to the workspace.
# We created a new BPEL pipeline for Web crawler data referencing the new Lucene index.
+
# We created a new JavaScript script for Web crawler data referencing the new Solr index.
# We used a separate job for web indexing that references the new BPEL pipeline.
+
# We used a separate job for web indexing that references the new script.
# We updated the web crawl job to push the records to a different indexing job which references the new BPEL pipeline.
+
# We used a separate web crawl job to push the records to the new indexing job.
  
 
= Configuration overview =
 
= Configuration overview =
Line 132: Line 130:
 
* REST API: http://localhost:8080/smila/jobmanager
 
* REST API: http://localhost:8080/smila/jobmanager
  
'''BPEL Pipelines'''
+
'''Scripts'''
* configuration folder: <tt>org.eclipse.smila.processing.bpel</tt>
+
* configuration folder: <tt>org.eclipse.smila.processing.scripts</tt>
** <tt>pipelines/*.bpel</tt> (Predefined BPEL pipelines)
+
** <tt>js/</tt> (Predefined JavaScript scripts)
 
* Documentation
 
* Documentation
** [[SMILA/Documentation/BPEL_Workflow_Processor|BPELWorkflowProcessor]]
+
** [[SMILA/Documentation/Scripting|Scripting]]
** [[SMILA/Documentation/Processing/JSON REST API for BPEL pipelines|JSON REST API for BPEL pipelines]]
+
* REST API: http://localhost:8080/smila/script
* REST API: http://localhost:8080/smila/pipeline
+
  
 
'''Solr'''
 
'''Solr'''

Revision as of 06:06, 29 October 2014


Just another 5 minutes to change the workflow

In the 5 minutes tutorial all data collected by crawlers was processed with the same asynchronous "indexUpdate" workflow using the script "add.js". All data was indexed into the same solr/lucene index "DefaultCore". It is possible however, to configure SMILA so that data from different data sources will go through different workflows and pipelines and will be indexed into different indices. This will require more advanced configuration features than before but still quite simple ones.

In the following sections we are going to use the generic asynchronous "indexWithScript" workflow which let you specify the JavaScript script to process the data. We create an additional script for webcrawler records so that webcrawler data will be indexed into a separate index named "WebCore".

Configure new solr index

Please shutdown SMILA now if it's still running.

To configure your own index "WebCore" follow the description in the SMILA documentation for creating your own solr index.

|If you already started SMILA before (as we suppose you did), please copy your new Core configuration and the modified solr.xml file to the folder workspace\.metadata\.plugins\org.eclipse.smila.solr because the configuration will not be copied again, after the first start of the Solr bundle.

Please restart SMILA now.

Further information:: For more information about the Solr indexing, please see the SMILA Solr documentation.

Create a new indexing script

We need to add a new script for adding the imported webcrawler records. Predefined scripts are contained in the configuration/org.eclipse.smila.scripting/js directory. We can add new scripts by just adding them there.

Copy the script "add.js", name the copy "addWeb.js" and change the solr "CoreName" in there from "DefaultCore" to "WebCore":

   ...
   var solrIndexPipelet = pipelets.create("org.eclipse.smila.solr.index.SolrIndexPipelet", {
      "ExecutionMode" : "ADD",
      "CoreName" : "WebCore",
   ...

Further information: For more information about Scripting please check the Scripting documentation.

Create and start a new indexing job

We define a new indexing job based on the predefined asynchronous workflow "indexWithScript" (see SMILA/configuration/org.eclipse.smila.jobmanager/workflows.json). This indexing job will process the imported data by using our new script "addWeb.js".

The "indexWithScript" workflow contains a ScriptProcessorWorker worker which is not configured for a dedicated script, so the scripts handling adds and deletes have to be set via job parameter.

Use your favourite REST Client to create an appropriate job definition:

POST http://localhost:8080/smila/jobmanager/jobs/
  {
    "name":"indexWebJob",
    "parameters":{      
      "tempStore": "temp",
      "addScript": "add",
      "deleteScript": "delete" 
     },
    "workflow":"indexWithScript"
  }

Notes:

  • the "deleteScript" is not needed for our test scenario here, but we must fulfill all undefined workflow parameters.
  • in the add and the delete script we use the standard function ("process"), so we don't have to set/change this via parameter.

Afterwards, start a job run for the defined job:

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

Update the web crawl job

Since the web crawl job already is predefined to push the crawled records to the indexUpdate job, we now either must define a new job or update the crawl job's definition in the job.json file. Here we choose the new job option.

POST http://localhost:8080/smila/jobmanager/jobs/
{
  "name":"crawlWikiToWebCore",
  "workflow":"webCrawling",
  "parameters":{
    "tempStore":"temp",
    "dataSource":"web",
    "startUrl":"http://wiki.eclipse.org/SMILA",
    "filter":{
      "urlPrefix":"http://wiki.eclipse.org/SMILA"
    },
    "jobToPushTo":"indexWebJob"
  }
}

Please note that we used the following line to let the crawl job push the records to our new job:

"jobToPushTo":"indexWebJob"

Now start the crawl job:

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

After some time to crawl, process and commit the data, you can have another look at the SMILA search page to find your new core listed among the available cores, and if you choose it, you can search for e.g. SMILA in the new WebCore.

Put it all together

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

  1. We added the WebCore index to the Solr configuration and copied it to the workspace.
  2. We created a new JavaScript script for Web crawler data referencing the new Solr index.
  3. We used a separate job for web indexing that references the new script.
  4. We used a separate web crawl job to push the records to the new indexing job.

Configuration overview

SMILA configuration files are located in the configuration directory of the SMILA application. The following lists the configuration files and documentation links relevant to this tutorial, regarding SMILA components:

Jobmanager

Scripts

Solr

Back to the top