Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "SMILA/FAQ"

Line 1: Line 1:
This pages contains the frequently asked questions of the SMILA project. Please note that in some of the questions and answers you might run across the abbreviation SMILA, which refers to the former name of the SMILA project.
+
This pages contains the frequently asked questions of the SMILA project.  
 
+
== Launching SMILA ==
+
 
+
=== Why is the ''SMILA'' package not in the JConsole tree? ===
+
 
+
I've started <tt>SMILA.exe</tt> but the SMILA package isn't in the tree of JConsole.
+
 
+
To solve this try the following:
+
 
+
# Create a new connection.
+
# Change your connection by setting the port "9004" on the ''Remote'' tab.
+
# Click the ''Connect'' button, switch to the ''MBeans'' tab, and check the tree again.
+
  
 
== Building SMILA ==
 
== Building SMILA ==
Line 27: Line 15:
 
# Save and build again.
 
# Save and build again.
  
== Launching crawler bundles ==
 
  
=== How do I overcome the ''Could not find crawler id'' error message? ===
+
== Launching SMILA ==
 +
 
 +
=== Bundles ===
 +
 
 +
==== Launching crawler bundles - How do I overcome the ''Could not find crawler id'' error message? ====
  
 
While launching SMILA I receive the following error message:
 
While launching SMILA I receive the following error message:
Line 48: Line 39:
 
<li>Open the <tt>build.properties</tt> file of your bundle and include the folders <tt>schemas/</tt>, <tt>OSGI-INF/</tt>, and the file <tt>plugin.xml</tt>.</li>
 
<li>Open the <tt>build.properties</tt> file of your bundle and include the folders <tt>schemas/</tt>, <tt>OSGI-INF/</tt>, and the file <tt>plugin.xml</tt>.</li>
 
</ol>
 
</ol>
 +
 +
==== I changed the implementation of a bundle, deployed it and restarted SMILA, but SMILA still seems to use the old bundle ====
 +
 +
Close SMILA, delete the following directories in your configuration folder and restart SMILA again:
 +
* <tt>org.eclipse.core.runtime/</tt>
 +
* <tt>org.eclipse.equinox.app/</tt>
 +
* <tt>org.eclipse.osgi/</tt>
 +
* <tt>org.eclipse.update/</tt>
 +
 +
==== I changed bundle startup settings in my config.ini, but after SMILA restart nothing changed ====
 +
 +
see last question (resp. answer)
 +
 +
 +
=== JConsole ===
 +
 +
==== Why is the ''SMILA'' package not in the JConsole tree? ====
 +
 +
I've started <tt>SMILA.exe</tt> but the SMILA package isn't in the tree of JConsole.
 +
 +
To solve this try the following:
 +
 +
# Create a new connection.
 +
# Change your connection by setting the port "9004" on the ''Remote'' tab.
 +
# Click the ''Connect'' button, switch to the ''MBeans'' tab, and check the tree again.
 +
 +
==== Why is the ''SMILA/CrawlerController MBean'' not in the JConsole tree? ====
 +
 +
Check if all needed bundles are active. Open the equinox console and type:
 +
* <tt>ss crawler</tt>
 +
* <tt>ss deltaindexing.impl</tt>
 +
 +
If one of these is not active:
 +
* check the <tt>configuration/config.ini</tt>
 +
* check the log file for errors
 +
 +
 +
 +
== Configuring/Running SMILA ==
 +
 +
=== Crawler ===
 +
 +
==== I tried to crawl/index a data source but nothing seem to happen ====
 +
 +
Check if your queue is receiving records:
 +
* Open the JConsole's MBeans tab and go to
 +
 +
 +
# Did you crawl the data source before? If so, try a <code>clearAll</code> on the DeltaIndexing-MBean in your JConsole
 +
 +
=== Pipeline ===
 +
 +
==== Why do I get a timeout exception during a (long running) pipeline execution? ====
 +
 +
In SMILA there's a timeout configured for a pipeline execution:
 +
: <tt>org.eclipse.smila.processing.bpel/processor.properties</tt>
 +
See entry: <code>pipeline.timeout</code>
 +
 +
=== Lucene Indexing / Search ===
 +
 +
==== How can I browse/search an existing Lucene Index? ====
 +
 +
Try [http://www.getopt.org/luke/ LUKE]
 +
 +
==== Why are attributes in my Lucene index missing / permuted? ====
 +
 +
Open your configuration files:
 +
* <tt>configuration/org.eclipse.smila.lucene/Mappings.xml</tt>
 +
* <tt>configuration/org.eclipse.smila.search.datadictionary/DataDictionary.xml</tt>
 +
 +
Check:
 +
* if all index fields are specified in these two files
 +
* if the field numbers are compatible to each other
 +
 +
Still the same problem?
 +
* Close SMILA, remove '''workspace''' file (if exists): <tt>workspace/org.eclipse.smila.search.datadictionary/DataDictionary.xml</tt> and restart SMILA
 +
 +
==== SMILA doesn't return search results, although I see (e.g. via LUKE) appropriate entries for my query in the Lucene index ====
 +
 +
Open the file: <tt>configuration/org.eclipse.smila.search.datadictionary/DataDictionary.xml</tt>
 +
* Check the <code>Constraint</code> entries for all fields: All fields that are set <code>required</code> must contain the query string!
 +
 +
Still problems? Try removing the workspace version of that file if it exists:
 +
* Close SMILA, remove <tt>workspace/org.eclipse.smila.search.datadictionary/DataDictionary.xml</tt>, and restart SMILA.
 +
 +
 +
== Implementing Pipelets / Processing Services / Bundles ==
 +
 +
=== Configuration ===
 +
 +
==== I want to use the <code>ConfigUtils</code> class in my Processing Service to read the configuration, where do I have to put my configuration files? ====
 +
 +
Configuration files are searched for in the following order:
 +
# <tt>configuration/<bundle-name>/<config-file></tt>
 +
# <tt><config-file></tt> in the root path of the bundle jar-file
 +
 +
=== Deploy / Launch ===
 +
 +
==== I implemented a Processing Service in a new bundle but SMILA log says that it couldn't be found ====
 +
 +
Check your new bundle, it should contain a file like that:
 +
* <tt>OSGI-INF/<mySevice>.xml</tt>
 +
 +
In this file your new processing service should be referenced.
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
 
[[Category:SMILA]]
 
[[Category:SMILA]]

Revision as of 06:29, 6 May 2009

This pages contains the frequently asked questions of the SMILA project.

Building SMILA

I receive an Out of Memory error? What can I do?

While building with SMILA.builder I receive the following errror message:

Build Failed - Out of Memory - Java heap space

The reason for this is that Ant hasn´t enough heap space to build the project. You will have to expand the heap space by setting the VM arguments accordingly. In eclipse try the following:

  1. Click Open external tools dialog and select your Ant build profile.
  2. Switch to the JRE tab and add the following VM arguments: -Xms40m -Xmx512m.
  3. Save and build again.


Launching SMILA

Bundles

Launching crawler bundles - How do I overcome the Could not find crawler id error message?

While launching SMILA I receive the following error message:

Could not find crawler id

If you started SMILA.launch to launch SMILA: The launcher didn't start your new crawler bundle. Try this:

  1. Add your bundle by selecting "Open Run dialog" in eclipse and choose your SMILA profile.
  2. Select your bundle in the list and set the checkmark.
  3. Set the start level to "4" and the autostart to "true".

If you started SMILA.EXE to launch SMILA: Your bundle isn`t defined in config.ini or the start level isn´t correct. Try this:

  1. Open the file config.ini and add your bundle as show below:
    org.eclipse.smila.connectivity.framework.crawler.owncrawler@5:start, \
  2. Open the build.properties file of your bundle and include the folders schemas/, OSGI-INF/, and the file plugin.xml.

I changed the implementation of a bundle, deployed it and restarted SMILA, but SMILA still seems to use the old bundle

Close SMILA, delete the following directories in your configuration folder and restart SMILA again:

  • org.eclipse.core.runtime/
  • org.eclipse.equinox.app/
  • org.eclipse.osgi/
  • org.eclipse.update/

I changed bundle startup settings in my config.ini, but after SMILA restart nothing changed

see last question (resp. answer)


JConsole

Why is the SMILA package not in the JConsole tree?

I've started SMILA.exe but the SMILA package isn't in the tree of JConsole.

To solve this try the following:

  1. Create a new connection.
  2. Change your connection by setting the port "9004" on the Remote tab.
  3. Click the Connect button, switch to the MBeans tab, and check the tree again.

Why is the SMILA/CrawlerController MBean not in the JConsole tree?

Check if all needed bundles are active. Open the equinox console and type:

  • ss crawler
  • ss deltaindexing.impl

If one of these is not active:

  • check the configuration/config.ini
  • check the log file for errors


Configuring/Running SMILA

Crawler

I tried to crawl/index a data source but nothing seem to happen

Check if your queue is receiving records:

  • Open the JConsole's MBeans tab and go to


  1. Did you crawl the data source before? If so, try a clearAll on the DeltaIndexing-MBean in your JConsole

Pipeline

Why do I get a timeout exception during a (long running) pipeline execution?

In SMILA there's a timeout configured for a pipeline execution:

org.eclipse.smila.processing.bpel/processor.properties

See entry: pipeline.timeout

Lucene Indexing / Search

How can I browse/search an existing Lucene Index?

Try LUKE

Why are attributes in my Lucene index missing / permuted?

Open your configuration files:

  • configuration/org.eclipse.smila.lucene/Mappings.xml
  • configuration/org.eclipse.smila.search.datadictionary/DataDictionary.xml

Check:

  • if all index fields are specified in these two files
  • if the field numbers are compatible to each other

Still the same problem?

  • Close SMILA, remove workspace file (if exists): workspace/org.eclipse.smila.search.datadictionary/DataDictionary.xml and restart SMILA

SMILA doesn't return search results, although I see (e.g. via LUKE) appropriate entries for my query in the Lucene index

Open the file: configuration/org.eclipse.smila.search.datadictionary/DataDictionary.xml

  • Check the Constraint entries for all fields: All fields that are set required must contain the query string!

Still problems? Try removing the workspace version of that file if it exists:

  • Close SMILA, remove workspace/org.eclipse.smila.search.datadictionary/DataDictionary.xml, and restart SMILA.


Implementing Pipelets / Processing Services / Bundles

Configuration

I want to use the ConfigUtils class in my Processing Service to read the configuration, where do I have to put my configuration files?

Configuration files are searched for in the following order:

  1. configuration/<bundle-name>/<config-file>
  2. <config-file> in the root path of the bundle jar-file

Deploy / Launch

I implemented a Processing Service in a new bundle but SMILA log says that it couldn't be found

Check your new bundle, it should contain a file like that:

  • OSGI-INF/<mySevice>.xml

In this file your new processing service should be referenced.

Back to the top