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.
Difference between revisions of "SMILA/Documentation"
< SMILA
m (→Pipelines and Pipelets: Synchronous Workflows of Java components) |
m (→Indexing & Searching) |
||
| (55 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
== Basics == | == Basics == | ||
| + | * [[SMILA/5_Minutes_Tutorial|Installing and Running (5 Minutes Tutorial)]] | ||
| + | * [[SMILA/Documentation/HowTo|HowTos]] | ||
* [[SMILA/Documentation/Architecture_Overview|Architecture]] | * [[SMILA/Documentation/Architecture_Overview|Architecture]] | ||
* [[SMILA/Documentation/Default_configuration_workflow_overview|Overview of Default Configuration]] | * [[SMILA/Documentation/Default_configuration_workflow_overview|Overview of Default Configuration]] | ||
* [[SMILA/Documentation/Data_Model_and_Serialization_Formats|Data Model, XML, JSON, BON]] | * [[SMILA/Documentation/Data_Model_and_Serialization_Formats|Data Model, XML, JSON, BON]] | ||
| − | * [[SMILA/Documentation/Using_The_ReST_API|Using the | + | * [[SMILA/Documentation/Using_The_ReST_API|Using the REST API, REST Client]] |
* [[SMILA/Documentation/REST_API_Reference|REST API Reference]] | * [[SMILA/Documentation/REST_API_Reference|REST API Reference]] | ||
* [[SMILA/Documentation/Enable Remote Access|Enabling Remote Access to SMILA]] | * [[SMILA/Documentation/Enable Remote Access|Enabling Remote Access to SMILA]] | ||
| − | == | + | == Development Environment == |
* [[SMILA/Documentation/HowTo/Howto_set_up_dev_environment|Setting up your Eclipse IDE for SMILA]] | * [[SMILA/Documentation/HowTo/Howto_set_up_dev_environment|Setting up your Eclipse IDE for SMILA]] | ||
* [[SMILA/Documentation/HowTo/Howto_build_a_SMILA-Distribution|Building SMILA]] | * [[SMILA/Documentation/HowTo/Howto_build_a_SMILA-Distribution|Building SMILA]] | ||
| Line 18: | Line 20: | ||
** [[SMILA/Documentation/HowTo/How_to_integrate_test_bundle_into_build_process|Adding a new Test Bundle to the Build]] | ** [[SMILA/Documentation/HowTo/How_to_integrate_test_bundle_into_build_process|Adding a new Test Bundle to the Build]] | ||
| − | == Pipelines and Pipelets: Synchronous Workflows | + | == Pipelines and Pipelets: Synchronous Workflows == |
* [[SMILA/Documentation/Pipelets|What are Pipelines? What are Pipelets?]] | * [[SMILA/Documentation/Pipelets|What are Pipelines? What are Pipelets?]] | ||
* [[SMILA/Documentation/BPEL_Workflow_Processor|Configuring and Creating BPEL Pipelines]] | * [[SMILA/Documentation/BPEL_Workflow_Processor|Configuring and Creating BPEL Pipelines]] | ||
| Line 26: | Line 28: | ||
** [[SMILA/Documentation/Processing/JSON_REST_API_for_pipelets|Getting Pipelet Descriptions]] | ** [[SMILA/Documentation/Processing/JSON_REST_API_for_pipelets|Getting Pipelet Descriptions]] | ||
** [[SMILA/Documentation/Processing/JSON_REST_API_for_BPEL_pipelines|Getting Pipeline Descriptions]] | ** [[SMILA/Documentation/Processing/JSON_REST_API_for_BPEL_pipelines|Getting Pipeline Descriptions]] | ||
| − | ** [[SMILA/Documentation/Processing/JSON_REST_API_for_BPEL_pipelines| | + | ** [[SMILA/Documentation/Processing/JSON_REST_API_for_BPEL_pipelines|Creating, Editing, and Executing Pipelines]] |
* Basic Pipelets | * Basic Pipelets | ||
| − | ** [[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets|Common Pipelets | + | ** [[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets|Common Pipelets]] |
| − | ** [[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets.xmlprocessing|XML Processing Pipelets | + | ** [[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets.xmlprocessing|XML Processing Pipelets]] |
| + | ** [[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets.boilerpipe|Boilerpipe Pipelet (extract text from HTML content)]] | ||
| + | ** [[SMILA/Documentation/TikaPipelet|TikaPipelet (extract text from binary content)]] | ||
| + | ** [[SMILA/Documentation/JdbcLoggingPipelet|JdbcLoggingPipelet, JdbcFetcherPipelet, JdbcSelectPipelet (write/read to/from a database)]] | ||
** More special pipelets are provided by the components described below. | ** More special pipelets are provided by the components described below. | ||
| − | * Developing Pipelets | + | * Developing new Pipelets |
| − | ** [[SMILA/Documentation/HowTo/How_to_write_a_Pipelet| | + | ** [[SMILA/Documentation/HowTo/How_to_write_a_Pipelet|Writing a Pipelet]] |
** [[SMILA/Documentation/Usage_of_Blackboard_Service|Using the Blackboard Service]] | ** [[SMILA/Documentation/Usage_of_Blackboard_Service|Using the Blackboard Service]] | ||
| − | == | + | == Scripting == |
| + | {{note| Available since SMILA 1.3!}} | ||
| + | |||
| + | * [[SMILA/Documentation/Scripting|Scripting SMILA with JavaScript]] | ||
| + | * [[SMILA/Documentation/Scripting/Debugging|Debugging JavaScripts running in SMILA]] | ||
| + | |||
| + | == Indexing & Searching == | ||
| + | |||
| + | * [[SMILA/Documentation/Indexing|Build a Solr search index]] | ||
* [[SMILA/Documentation/Search|Search Processing and APIs]] | * [[SMILA/Documentation/Search|Search Processing and APIs]] | ||
| − | * [[SMILA/Documentation/Solr|Solr Integration | + | * [[SMILA/Documentation/Solr 4.x|Solr 4 Integration]] |
== JobManager: Asynchronous Workflows == | == JobManager: Asynchronous Workflows == | ||
| − | * [[SMILA/Documentation/JobManager| | + | * [[SMILA/Documentation/JobManager|What are Jobs and Tasks?]] |
| − | ** [[SMILA/Documentation/JobManagerFirstExample| | + | ** [[SMILA/Documentation/JobManagerFirstExample|JobManager Walk-Through]] |
* Creating Workflows and Jobs | * Creating Workflows and Jobs | ||
| − | ** [[SMILA/Documentation/DataObjectTypesAndBuckets| | + | ** [[SMILA/Documentation/DataObjectTypesAndBuckets|Data Object Types and Buckets]] |
| − | ** [[SMILA/Documentation/WorkerAndWorkflows| | + | ** [[SMILA/Documentation/WorkerAndWorkflows|Workers and Workflows]] |
| − | ** [[SMILA/Documentation/JobDefinitions| | + | ** [[SMILA/Documentation/JobDefinitions|Jobs]] |
| − | ** [[SMILA/Documentation/JobParameters| | + | ** [[SMILA/Documentation/JobParameters|Job Parameters]] |
* [[SMILA/Documentation/JobRuns|Running and Monitoring Jobs]] | * [[SMILA/Documentation/JobRuns|Running and Monitoring Jobs]] | ||
* [[SMILA/Documentation/JobManagerConfiguration|Configuring the Job Manager]] | * [[SMILA/Documentation/JobManagerConfiguration|Configuring the Job Manager]] | ||
| Line 53: | Line 66: | ||
* Worker Reference | * Worker Reference | ||
** [[SMILA/Documentation/Bulkbuilder|Bulkbuilder worker]] | ** [[SMILA/Documentation/Bulkbuilder|Bulkbuilder worker]] | ||
| − | ** [[SMILA/Documentation/Worker/PipelineProcessorWorker| | + | ** [[SMILA/Documentation/Worker/ScriptProcessorWorker|ScriptProcessor Worker]] |
| + | ** [[SMILA/Documentation/Worker/PipelineProcessorWorker|PipelineProcessor Worker]] | ||
** [[SMILA/Documentation/Worker/PipeletProcessorWorker|PipeletProcessor Worker]] | ** [[SMILA/Documentation/Worker/PipeletProcessorWorker|PipeletProcessor Worker]] | ||
| − | ** | + | ** (see [[SMILA/Manual#Importing|Importing]] section for more workers) |
| − | * Developing Workers | + | * Developing new Workers |
| − | ** [[SMILA/Documentation/WorkerManager|WorkerManager: Workers Made | + | ** [[SMILA/Documentation/WorkerManager|WorkerManager: Workers Made Easily]] |
** [[SMILA/Documentation/HowTo/How_to_write_a_Worker|How to Write a Worker]] | ** [[SMILA/Documentation/HowTo/How_to_write_a_Worker|How to Write a Worker]] | ||
** [[SMILA/Documentation/TaskGenerators|Task Generators]] | ** [[SMILA/Documentation/TaskGenerators|Task Generators]] | ||
== Importing == | == Importing == | ||
| − | * [[SMILA/Documentation/Importing/Concept|Concepts]] | + | * [[SMILA/Documentation/Importing/Concept|Concepts, Workflow and Components]] |
| − | * Importing Workers | + | ** [[SMILA/Documentation/Importing/CompoundExtractorService|Compound Extractor Service]] |
| + | * Reference of Import Workers | ||
**[[SMILA/Documentation/Importing/Crawler/File | FileCrawler and FileFetcher Worker]] | **[[SMILA/Documentation/Importing/Crawler/File | FileCrawler and FileFetcher Worker]] | ||
**[[SMILA/Documentation/Importing/Crawler/Web | WebCrawler and WebFetcher Worker]] | **[[SMILA/Documentation/Importing/Crawler/Web | WebCrawler and WebFetcher Worker]] | ||
| + | *** [[SMILA/Documentation/Importing/CrawlingMultipleStartURLs | Crawling multiple start URLs in one job run]] | ||
| + | **[[SMILA/Documentation/Importing/Crawler/JDBC | JdbcCrawler and JdbcFetcher Worker]] | ||
| + | **[[SMILA/Documentation/Importing/Crawler/Feed | FeedCrawler Worker]] | ||
**[[SMILA/Documentation/Importing/DeltaCheck | DeltaChecker Worker]] | **[[SMILA/Documentation/Importing/DeltaCheck | DeltaChecker Worker]] | ||
**[[SMILA/Documentation/Importing/UpdatePusher | UpdatePusher Worker]] | **[[SMILA/Documentation/Importing/UpdatePusher | UpdatePusher Worker]] | ||
| − | * Developing | + | * Developing new Import Workers |
| − | ** [[SMILA/Documentation/Importing/VisitedLinks | VisitedLinks service]] | + | ** [[SMILA/Documentation/Importing/VisitedLinks | Using the VisitedLinks service]] |
** [[SMILA/Documentation/Importing/Crawler/Web#Internal_structure|Extending the WebCrawler worker]] | ** [[SMILA/Documentation/Importing/Crawler/Web#Internal_structure|Extending the WebCrawler worker]] | ||
| − | ** [[SMILA/Documentation/HowTo/How to add a new Data Source to the importing framework|Adding a Data Source to the SMILA | + | ** [[SMILA/Documentation/HowTo/How to add a new Data Source to the importing framework|Adding a Data Source to the SMILA Import Framework]] |
| + | * Additionally | ||
| + | ** [[SMILA/Documentation/Importing/RemoteCrawling | Remote Crawling]] | ||
| − | == | + | == Embedded HTTP Server == |
* [[SMILA/Documentation/JettyHttpServer|Configuring Jetty]] | * [[SMILA/Documentation/JettyHttpServer|Configuring Jetty]] | ||
* [[SMILA/Documentation/JettyHttpServer#JSON_Handlers|Developing JSON ReST Handlers for SMILA]] | * [[SMILA/Documentation/JettyHttpServer#JSON_Handlers|Developing JSON ReST Handlers for SMILA]] | ||
| Line 82: | Line 102: | ||
* [[SMILA/Documentation/Bundle_org.eclipse.smila.clusterconfig|ClusterConfig Service]] | * [[SMILA/Documentation/Bundle_org.eclipse.smila.clusterconfig|ClusterConfig Service]] | ||
** [[SMILA/Documentation/Bundle_org.eclipse.smila.clusterconfig.simple|Simple Implementation]] | ** [[SMILA/Documentation/Bundle_org.eclipse.smila.clusterconfig.simple|Simple Implementation]] | ||
| + | * [[SMILA/Documentation/Bundle_org.eclipse.smila.zookeeper|Zookeeper Service]] | ||
* [[SMILA/Documentation/ObjectStore/Bundle_org.eclipse.smila.objectstore|ObjectStore]] | * [[SMILA/Documentation/ObjectStore/Bundle_org.eclipse.smila.objectstore|ObjectStore]] | ||
** [[SMILA/Documentation/ObjectStore/Bundle_org.eclipse.smila.objectstore.filesystem|Filesystem Objectstore Implementation]] | ** [[SMILA/Documentation/ObjectStore/Bundle_org.eclipse.smila.objectstore.filesystem|Filesystem Objectstore Implementation]] | ||
| Line 90: | Line 111: | ||
* [[SMILA/Documentation/SesameOntologyManager|Ontology Processing with Sesame: Configuration and Pipelets]] | * [[SMILA/Documentation/SesameOntologyManager|Ontology Processing with Sesame: Configuration and Pipelets]] | ||
* [[SMILA/Documentation/MimeTypeIdentifier|MimeTypeIdentifier]] | * [[SMILA/Documentation/MimeTypeIdentifier|MimeTypeIdentifier]] | ||
| + | * [[SMILA/Documentation/ParameterDefinition|Description of Worker and Pipelet Parameters]] | ||
* [[SMILA/Documentation/PublishingJAXWSWebservices|Publishing Web Services]] | * [[SMILA/Documentation/PublishingJAXWSWebservices|Publishing Web Services]] | ||
* [[SMILA/Documentation/General JPA Configuration in SMILA|General JPA Configuration in SMILA]] | * [[SMILA/Documentation/General JPA Configuration in SMILA|General JPA Configuration in SMILA]] | ||
| + | * [[SMILA/Documentation/SMILA_Versioning|SMILA Version Information]] | ||
| + | * [[SMILA/Documentation/Adding_JDBC_Drivers|Adding JDBC Drivers]] | ||
== Deprecated Components == | == Deprecated Components == | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
** [[SMILA/Documentation/Management|JMX Management]] | ** [[SMILA/Documentation/Management|JMX Management]] | ||
*** [[SMILA/Documentation/Management#JMX_Client|JMX Clients]] | *** [[SMILA/Documentation/Management#JMX_Client|JMX Clients]] | ||
** [[SMILA/Documentation/Record_Storage|RecordStorage]] | ** [[SMILA/Documentation/Record_Storage|RecordStorage]] | ||
| + | |||
[[Category:SMILA]] | [[Category:SMILA]] | ||
Latest revision as of 03:25, 13 April 2015
Contents
Basics
- Installing and Running (5 Minutes Tutorial)
- HowTos
- Architecture
- Overview of Default Configuration
- Data Model, XML, JSON, BON
- Using the REST API, REST Client
- REST API Reference
- Enabling Remote Access to SMILA
Development Environment
- Setting up your Eclipse IDE for SMILA
- Building SMILA
- Creating new Components
- Testing new Components
- Adding Third Party Libraries to SMILA
- Using OSGi Declarative Services
- Extending the build process:
Pipelines and Pipelets: Synchronous Workflows
- What are Pipelines? What are Pipelets?
- Configuring and Creating BPEL Pipelines
- Using the SMILA BPEL Designer
- ReST APIs
- Basic Pipelets
- Common Pipelets
- XML Processing Pipelets
- Boilerpipe Pipelet (extract text from HTML content)
- TikaPipelet (extract text from binary content)
- JdbcLoggingPipelet, JdbcFetcherPipelet, JdbcSelectPipelet (write/read to/from a database)
- More special pipelets are provided by the components described below.
- Developing new Pipelets
Scripting
Available since SMILA 1.3!
Indexing & Searching
JobManager: Asynchronous Workflows
- What are Jobs and Tasks?
- Creating Workflows and Jobs
- Running and Monitoring Jobs
- Configuring the Job Manager
- TaskManager: Asynchronous Scheduling of Tasks
- Worker Reference
- Bulkbuilder worker
- ScriptProcessor Worker
- PipelineProcessor Worker
- PipeletProcessor Worker
- (see Importing section for more workers)
- Developing new Workers
Importing
- Concepts, Workflow and Components
- Reference of Import Workers
- Developing new Import Workers
- Additionally
Embedded HTTP Server
Common Services
- Configuration Helper
- Workspace Helper
- ClusterConfig Service
- Zookeeper Service
- ObjectStore
- BinaryStorage
- Processing Security Information
- Ontology Processing with Sesame: Configuration and Pipelets
- MimeTypeIdentifier
- Description of Worker and Pipelet Parameters
- Publishing Web Services
- General JPA Configuration in SMILA
- SMILA Version Information
- Adding JDBC Drivers