Difference between revisions of "SMILA/Documentation"

From Eclipsepedia

Jump to: navigation, search
(Pipelines and Pipelets: Synchronous Workflows)
(48 intermediate revisions by 6 users not shown)
Line 1: Line 1:
This page provides an overview of all available documentation pages for already implemented components.
+
== Basics ==
*JavaDoc
+
* [[SMILA/Documentation_for_5_Minutes_to_Success|Installing and Running]]
*[http://build.eclipse.org/rt/smila/javadoc/current current version JavaDoc]
+
* [[SMILA/Documentation/HowTo|HowTos]]
 +
* [[SMILA/Documentation/Architecture_Overview|Architecture]]
 +
* [[SMILA/Documentation/Default_configuration_workflow_overview|Overview of Default Configuration]]
 +
* [[SMILA/Documentation/Data_Model_and_Serialization_Formats|Data Model, XML, JSON, BON]]
 +
* [[SMILA/Documentation/Using_The_ReST_API|Using the REST API, REST Client]]
 +
* [[SMILA/Documentation/REST_API_Reference|REST API Reference]]
 +
* [[SMILA/Documentation/Enable Remote Access|Enabling Remote Access to SMILA]]
  
*Common
+
== Development Environment ==
**[[SMILA/Documentation/Data Model and Serialization Formats|Data Model and Serialization Formats]]
+
* [[SMILA/Documentation/HowTo/Howto_set_up_dev_environment|Setting up your Eclipse IDE for SMILA]]
**[[SMILA/Documentation/JettyHttpServer|Configuration and Usage of the embedded Jetty HTTP server]]
+
* [[SMILA/Documentation/HowTo/Howto_build_a_SMILA-Distribution|Building SMILA]]
**[[SMILA/Documentation/MimeTypeIdentifier|MimeTypeIdentifier]]
+
* [[SMILA/Documentation/HowTo/Create_a_bundle_(plug-in)|Creating new Components]]
***[[SMILA/Documentation/ApertureMimeTypeIdentifier|ApertureMimeTypeIdentifier]] (<span style="color:#ff0000">This component is not yet available in our repository.</span>)
+
* [[SMILA/Documentation/HowTo/Create_a_test_bundle_(plug-in)|Testing new Components]]
**[[SMILA/Documentation/PublishingJAXWSWebservices|Publishing JAX-WS Webservices]]
+
* [[SMILA/Documentation/HowTo/3rd_party_bundle|Adding Third Party Libraries to SMILA]]
**[[SMILA/Documentation/General_JPA_Configuration_in_SMILA|General JPA Configuration in SMILA]]
+
* [[SMILA/Documentation/Declarative_Services|Using OSGi Declarative Services]]
**[[SMILA/Documentation/Bundle org.eclipse.smila.clusterconfig|Configuration bundle org.eclipse.smila.clusterconfig]]
+
* Extending the build process:
**[[SMILA/Documentation/Bundle org.eclipse.smila.clusterconfig.simple|Simple configuration implementation bundle org.eclipse.smila.clusterconfig.simple]]
+
** [[SMILA/Documentation/HowTo/How_to_integrate_new_bundle_into_build_process|Adding a new Component Bundle to the Build]]
 +
** [[SMILA/Documentation/HowTo/How_to_integrate_test_bundle_into_build_process|Adding a new Test Bundle to the Build]]
  
*Connectivity
+
== Pipelines and Pipelets: Synchronous Workflows ==
**[[SMILA/Documentation/ConnectivityManager|ConnectivityManager]]
+
* [[SMILA/Documentation/Pipelets|What are Pipelines? What are Pipelets?]]
**[[SMILA/Documentation/DeltaIndexingManager|DeltaIndexingManager]]
+
* [[SMILA/Documentation/BPEL_Workflow_Processor|Configuring and Creating BPEL Pipelines]]
**[[SMILA/Documentation/ConnectivityFramework|ConnectivityFramework]]
+
** [[SMILA/Documentation/HowTo/How_to_filter_and_access_record_data_in_BPEL|Accessing SMILA records in BPEL activities]]
***[[SMILA/Documentation/CrawlerController|CrawlerController]]
+
* [[SMILA/BPEL_Designer|Using the SMILA BPEL Designer]]
***[[SMILA/Documentation/Crawler|Crawler]]
+
* ReST APIs
****[[SMILA/Documentation/Filesystem Crawler|Filesystem Crawler]]
+
** [[SMILA/Documentation/Processing/JSON_REST_API_for_pipelets|Getting Pipelet Descriptions]]
****[[SMILA/Documentation/Web Crawler|Web Crawler]]  
+
** [[SMILA/Documentation/Processing/JSON_REST_API_for_BPEL_pipelines|Getting Pipeline Descriptions]]
****[[SMILA/Documentation/JDBC Crawler|JDBC Crawler]]
+
** [[SMILA/Documentation/Processing/JSON_REST_API_for_BPEL_pipelines|Creating, Editing, and Executing Pipelines]]
***[[SMILA/Documentation/AgentController|AgentController ]]
+
* Basic Pipelets
***[[SMILA/Documentation/Agent|Agent]]
+
** [[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets|Common Pipelets in Bundle org.eclipse.smila.processing.pipelets]]  
****[[SMILA/Documentation/Mock Agent|Mock Agent]]
+
** [[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets.xmlprocessing|XML Processing Pipelets in Bundle org.eclipse.smila.processing.pipelets.xmlprocessing]]
****[[SMILA/Documentation/Feed Agent|Feed Agent]]
+
** [[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets.boilerpipe|Boilerpipe Pipelets in Bundle org.eclipse.smila.processing.pipelets.boilerpipe]]
****[[SMILA/Documentation/JobFile Agent|JobFile Agent]]
+
** [[SMILA/Documentation/TikaPipelet|TikaPipelet in bundle org.eclipse.smila.tika]]
***[[SMILA/Documentation/CompoundManagement|CompoundManagement]]
+
** More special pipelets are provided by the components described below.
+
* Developing new Pipelets
*Processing
+
** [[SMILA/Documentation/HowTo/How_to_write_a_Pipelet|Writing a Pipelet]]
**[[SMILA/Documentation/BPEL Workflow Processor|BPEL Workflow Processor]]
+
** [[SMILA/Documentation/Usage_of_Blackboard_Service|Using the Blackboard Service]]
**[[SMILA/Documentation/Processing/JSON REST API for BPEL pipelines|JSON REST API for BPEL pipelines]]
+
**[[SMILA/Documentation/Processing/JSON REST API for pipelets|JSON REST API for pipelets]]
+
**[[SMILA/Documentation/Usage of Blackboard Service|Usage of Blackboard Service]]
+
**[[SMILA/Documentation/Pipelets|Pipelets]]
+
**Available Pipelets
+
***[[SMILA/Documentation/Solr|SMILA/Documentation/Solr]]
+
***[[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets|Bundle org.eclipse.smila.processing.pipelets]]  
+
***[[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets.xmlprocessing|Bundle org.eclipse.smila.processing.pipelets.xmlprocessing]]
+
***[[SMILA/Documentation/SampleSecurityConverterPipelet|SampleSecurityConverterPipelet]]  
+
***[[SMILA/Documentation/AperturePipelet|AperturePipelet]] (<span style="color:#ff0000">This pipelet is not yet available in our repository.</span>)
+
  
*Search:
+
== Searching ==
**[[SMILA/Documentation/Search|Search API and Processing]]
+
  
*[[SMILA/Documentation/Security|Security]]
+
* [[SMILA/Documentation/Search|Search Processing and APIs]]
**[[SMILA/Documentation/LDAPSecurityResolver|LDAPSecurityResolver]]
+
* [[SMILA/Documentation/Solr 3.5|Solr Integration: Configuration and Pipelets]]
**[[SMILA/Documentation/SecurityProcessingServices|SecurityProcessingServices]] (SampleSecurityConverter)
+
+
*Storage
+
**[[SMILA/Documentation/Binary Storage|Binary Storage]]
+
**[[SMILA/Documentation/Record Storage|Record Storage]] (not used in 0.9 by default)
+
**[[SMILA/Documentation/ObjectStore/Bundle org.eclipse.smila.objectstore|Bundle org.eclipse.smila.objectstore]]
+
**[[SMILA/Documentation/ObjectStore/Bundle org.eclipse.smila.objectstore.filesystem|Bundle org.eclipse.smila.objectstore.filesystem]]
+
  
*Job Management
+
== JobManager: Asynchronous Workflows ==
**[[SMILA/Documentation/JobManager|JobManager]]
+
* [[SMILA/Documentation/JobManager|What are Jobs and Tasks?]]
**[[SMILA/Documentation/TaskManager|TaskManager]]
+
** [[SMILA/Documentation/JobManagerFirstExample|JobManager Walk-Through]]
**[[SMILA/Documentation/WorkerManager|WorkerManager]]
+
* Creating Workflows and Jobs
** Worker
+
** [[SMILA/Documentation/DataObjectTypesAndBuckets|Defining Buckets]]
***[[SMILA/Documentation/Bulkbuilder|Bulkbuilder worker]]
+
** [[SMILA/Documentation/WorkerAndWorkflows|Modeling Workflows]]
***[[SMILA/Documentation/Worker/PipelineProcessorWorker | Pipeline worker (BPEL worker) ]]
+
** [[SMILA/Documentation/JobDefinitions|Creating Jobs]]
***[[SMILA/Documentation/Worker/PipeletProcessorWorker | Pipelet worker]]
+
** [[SMILA/Documentation/JobParameters|Evaluating Job Parameters]]
** Workers for Importing
+
* [[SMILA/Documentation/JobRuns|Running and Monitoring Jobs]]
***[[SMILA/Documentation/Importing/Concept | The idea]]
+
* [[SMILA/Documentation/JobManagerConfiguration|Configuring the Job Manager]]
***[[SMILA/Documentation/Importing/DeltaCheck | DeltaCheck worker]]
+
* [[SMILA/Documentation/TaskManager|TaskManager: Asynchronous Scheduling of Tasks]]
***[[SMILA/Documentation/Importing/UpdatePusher | UpdatePusher worker]]
+
* Worker Reference
***[[SMILA/Documentation/Importing/Crawler/File | FileCrawler worker]]
+
** [[SMILA/Documentation/Bulkbuilder|Bulkbuilder worker]]
***[[SMILA/Documentation/Importing/Crawler/Web | WebCrawler worker]]
+
** [[SMILA/Documentation/Worker/PipelineProcessorWorker|PipelineProcesor Worker]]
***[[SMILA/Documentation/Importing/VisitedLinks | VisitedLinks service]]
+
** [[SMILA/Documentation/Worker/PipeletProcessorWorker|PipeletProcessor Worker]]
**Examples
+
** See [[SMILA/Manual#Importing|Importing]] below for more workers
***[[SMILA/Documentation/JobManagerFirstExample]]
+
* Developing new Workers
 +
** [[SMILA/Documentation/WorkerManager|WorkerManager: Workers Made Easily]]
 +
** [[SMILA/Documentation/HowTo/How_to_write_a_Worker|How to Write a Worker]]
 +
** [[SMILA/Documentation/TaskGenerators|Task Generators]]
  
*[[SMILA/Documentation/Management|Management]]
+
== Importing ==
+
* [[SMILA/Documentation/Importing/Concept|Concepts, Workflow and Components]]
*Utilities
+
** [[SMILA/Documentation/Importing/CompoundExtractorService|Compound Extractor Service]]
**[[SMILA/Documentation/Management#JMX_Client|JMX Client]]
+
* Reference of Import Workers
**[[SMILA/Documentation/Workspace Handling|Workspace Handling]]
+
**[[SMILA/Documentation/Importing/Crawler/File | FileCrawler and FileFetcher Worker]]
**...
+
**[[SMILA/Documentation/Importing/Crawler/Web | WebCrawler and WebFetcher Worker]]
+
**[[SMILA/Documentation/Importing/Crawler/JDBC | JdbcCrawler and JdbcFetcher Worker]]
*Semantic Layer: Ontology Integration
+
**[[SMILA/Documentation/Importing/Crawler/Feed | FeedCrawler Worker]]
**[[SMILA/Documentation/SesameOntologyManager|Sesame Ontology Manager]]
+
**[[SMILA/Documentation/Importing/DeltaCheck | DeltaChecker Worker]]
 +
**[[SMILA/Documentation/Importing/UpdatePusher | UpdatePusher Worker]]
 +
* Developing new Import Workers
 +
** [[SMILA/Documentation/Importing/VisitedLinks | Using the VisitedLinks service]]
 +
** [[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 Import Framework]]
 +
* Additionally
 +
** [[SMILA/Documentation/Importing/CrawlingMultipleStartURLs | Crawling multiple start URL in one job run]]
  
*Concerning Third Party Software
+
== Embedded HTTP Server ==
**[[SMILA/Documentation/SNAPSHOT versions - which and why|SNAPSHOT versions - which and why]]
+
* [[SMILA/Documentation/JettyHttpServer|Configuring Jetty]]
 +
* [[SMILA/Documentation/JettyHttpServer#JSON_Handlers|Developing JSON ReST Handlers for SMILA]]
 +
 
 +
== Common Services ==
 +
* [[SMILA/Project Concepts/Simple configuration handler|Configuration Helper]]
 +
* [[SMILA/Documentation/Workspace Handling|Workspace Helper]]
 +
* [[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.zookeeper|Zookeeper Service]]
 +
* [[SMILA/Documentation/ObjectStore/Bundle_org.eclipse.smila.objectstore|ObjectStore]]
 +
** [[SMILA/Documentation/ObjectStore/Bundle_org.eclipse.smila.objectstore.filesystem|Filesystem Objectstore Implementation]]
 +
* [[SMILA/Documentation/Binary_Storage|BinaryStorage]]
 +
* [[SMILA/Documentation/Security|Processing Security Information]]
 +
** [[SMILA/Documentation/LDAPSecurityResolver|Implementation for using LDAP]]
 +
** [[SMILA/Documentation/SecurityProcessingServices|Example Pipelets]]
 +
* [[SMILA/Documentation/SesameOntologyManager|Ontology Processing with Sesame: Configuration and Pipelets]]
 +
* [[SMILA/Documentation/MimeTypeIdentifier|MimeTypeIdentifier]]
 +
* [[SMILA/Documentation/ParameterDefinition|Description of Worker and Pipelet Parameters]]
 +
* [[SMILA/Documentation/PublishingJAXWSWebservices|Publishing Web Services]]
 +
* [[SMILA/Documentation/General JPA Configuration in SMILA|General JPA Configuration in SMILA]]
 +
* [[SMILA/Documentation/SMILA_Versioning|SMILA Version Information]]
 +
 
 +
== Deprecated Components ==
 +
 
 +
** [[SMILA/Documentation/Management|JMX Management]]
 +
*** [[SMILA/Documentation/Management#JMX_Client|JMX Clients]]
 +
** [[SMILA/Documentation/Record_Storage|RecordStorage]]
  
  
 
[[Category:SMILA]]
 
[[Category:SMILA]]

Revision as of 08:17, 12 February 2013

Contents

Basics

Development Environment

Pipelines and Pipelets: Synchronous Workflows

Searching

JobManager: Asynchronous Workflows

Importing

Embedded HTTP Server

Common Services

Deprecated Components