Author: buildbot
Date: Tue Jul 10 08:33:39 2012
New Revision: 825214
Log:
Staging update by buildbot for stanbol
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/entityhub-overview.png
(with props)
Modified:
websites/staging/stanbol/trunk/content/ (props changed)
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/index.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/managedsite.html
Propchange: websites/staging/stanbol/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Jul 10 08:33:39 2012
@@ -1 +1 @@
-1359510
+1359520
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/entityhub-overview.png
==============================================================================
Binary file - no diff available.
Propchange:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/entityhub-overview.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/index.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/index.html
(original)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/index.html
Tue Jul 10 08:33:39 2012
@@ -82,40 +82,20 @@
</div>
<div id="content">
<h1 class="title">Entityhub</h1>
- <p>The Entityhub provides two main services. The Entityhub provides the
connection to external linked open data sites as well as using indexes of them
locally. Its services allow to manage a <strong>network of sites</strong> to
consume entity information and to <strong>manage entities locally</strong>.<br
/>
-</p>
-<p>A small index of approx. 43k entities from dbpedia comes with the default
installation.</p>
-<h2 id="service-endpoints">Service Endpoints</h2>
-<p>The RESTful API of the Entityhub ist structured as follows:</p>
-<h3 id="entity-network-entityhubsite">Entity Network ("/entityhub/site*"):</h3>
+ <p>The Entityhub is the Stanbol component responsible for providing the
information about Entities relevant to the users domain. The following figure
tries to provide an overview about the features of the Entityhub.</p>
+<p><img alt="Features of the Stanbol Entityhub" src="entityhub-overview.png"
/></p>
+<p>The main Features are the:</p>
<ul>
-<li>The Referenced Site Manager @ <a
href="http://localhost:8080/entityhub/sites";>/entityhub/sites</a> allows to
manages sites and retrieve/search Entities in all sites of the Entity
Network.</li>
-<li>A Referenced Site @ /entityhub/site/{siteName} refers to a single site of
the Referenced Site Manager and allows to retrieve all active sites. Referenced
sites provide the same interface as the referenced site manager.</li>
+<li><strong>Entityhub</strong> (<code>/entityhub<code>): Allows to manage
local entities as well as import entities from Sites or to define mappings from
local Entities to Entities managed by Sites. An Apache Stanbol instance can
only have a single Entityhub so if you want to manage multiple controlled
vocabularies you should preferable use <a
href="managedsite.html">ManagedSite</a> instead.</li>
+<li><strong>Site Manager</strong> (<code>/entityhub/sites</code>): The
SiteManager provides a unified access to all currently active Sites - your
Entity Network. Requests sent to this endpoint will be forwarded to all
currently active Sites. Users should note that queries (requests to the
<code>/entityhub/sites/find</code> and <code>/entityhub/sites/query</code>
endpoints) might be slow as remote services might need to be called for
answering those requests. Retrieval of Entities (requests to the
<code>/entityhub/sites/entity</code> endpoint) and also LDpath requests should
perform reasonable well.</li>
+<li><strong>Sites</strong> (<code>/entityhub/site/{siteId}</code>): Sites
represent entity sources that are integrated with the Stanbol Entityhub. There
are two different types of Sites<ul>
+<li><strong>ReferencedSite</strong>: This site allows to refer remote services
to dereference (Entity id based retrieval) and query entities. It also supports
local caches and indexes. A local cache allows to locally store retrieved
Entity data to speed-up retrieval on subsequent requests. A local index is a
locally available index over all/some of the data of the remote dataset. If
such an index is available all requests will be processed using the index. The
remote services are only used as a fallback. Local Indexes are created by the
Entityhub Indexing tool. The usage scenario <a
href="../customvocabulary.html">Working with Custom Vocabularies</a> provides a
good overview on how to use this feature.</li>
+<li><strong>ManagedSite</strong>: <a href="managedsite.html">ManagedSites</a>
allow users to manage their own entity by using the RESTful API of the
Entityhub. They are very similar to the <code>/entityhub</code> endpoint but do
not allow to manage mappings are to import Entities from other Sites.</li>
</ul>
-<p>For both services, several features are available:</p>
-<ul>
-<li>
-<p><a
href="http://localhost:8080/entityhub/sites/referenced";><strong>Referenced</strong></a>
returns a json array containing the IDs of all available sites. Sites returned
by this method can be accessed via the site service endpoint.</p>
-</li>
-<li>
-<p><a
href="http://localhost:8080/entityhub/sites/entity";><strong>Entity</strong></a>
searches all referenced sites for the entity with the parsed URI.</p>
-</li>
-<li>
-<p><a
href="http://localhost:8080/entityhub/sites/find";><strong>Find</strong></a>
provides a label based search service over all sites.</p>
</li>
-<li>
-<p><a
href="http://localhost:8080/entityhub/sites/query";><strong>Query</strong></a>
allows to parse JSON serialized field queries to the sites endpoint.</p>
-</li>
-</ul>
-<p>Currently active referenced sites at the demo server are available and
running for <a
href="http://dev.iks-project.eu:8080/entityhub/site/dbpedia/";>dbpedia</a>, <a
href="http://dev.iks-project.eu:8080/entityhub/site/dblp/";>dplp</a> and <a
href="http://dev.iks-project.eu:8080/entityhub/site/geonames/";>geonames</a>.</p>
-<h3 id="entityhub-entityhub">Entityhub ("/entityhub"):</h3>
-<ul>
-<li>Local Entities @/entityhub/entity: Full CRUD operations on Entities
managed by the Entityhub</li>
-<li>Entity Mappings @ /entityhub/mapping: Lookup mappings from local Entities
to Entities managed by a Referenced Site</li>
-<li>Local Search @/entityhub/find: Find locally managed Entities by label
based search.</li>
-<li>Local Query @/entityhub/query: Find locally managed Entities by parsing
queries</li>
-<li>Entity Lookup @/entityhub/lookup: Lookup Entities by id. This supports
also to lookup Entities managed by Referenced Sites and the import of found
Entities to the Entityhub.</li>
</ul>
+<h2 id="restful-services">RESTful services</h2>
+<p>The documentation of the RESTful services provided by the Stanbol Entityhub
is served by the Web UI of your Stanbol instance. If you do not have a running
Stanbol server <a href="../tutorial.html">this introduction</a> provides you
with all necessary information. You can also try to access the documentation on
the Stanbol demo server available on the <a
href="http://dev.iks-project.eu/";>IKS development server</a> at <a
href="http://dev.iks-project.eu:8081/entityhub";>http://dev.iks-project.eu:8081/entityhub</a>.</p>
</div>
<div id="footer">
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/managedsite.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/managedsite.html
(original)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/entityhub/managedsite.html
Tue Jul 10 08:33:39 2012
@@ -98,12 +98,14 @@
<p>This example assumes that Stanbol is running on 'localhost' port '8080' and
that a ManagedSite with the id 'iptc' was configured. The uploaded file
'subject-code.rdf' contains the IPTC <a
href="http://cv.iptc.org/newscodes/subjectcode/";>subject-codes</a>. To upload
also the vocabulary containing the <a
href="http://cv.iptc.org/newscodes/genre/";>genre</a>s one needs to call</p>
-<div class="codehilite"><pre>curl -i -X PUT -H <span
class="s2">"Content-Type: application/rdf+xml"</span> -T genre.rdf
<span class="s2">"http://localhost:8080/site/iptc/entity"</span>
+<div class="codehilite"><pre>curl -i -X PUT -H <span
class="s2">"Content-Type: application/rdf+xml"</span> -T genre.rdf
<span class="se">\</span>
+ <span class="s2">"http://localhost:8080/site/iptc/entity"</span>
</pre></div>
<p>Calls like that will create/update all Entities contained in the parsed RDF
data. If one wants to ensure that only a single Entity is created/updated one
can specify the 'id' parameter.</p>
-<div class="codehilite"><pre>curl -i -X PUT -H <span
class="s2">"Content-Type: application/rdf+xml"</span> -T genre.rdf
<span
class="s2">"http://localhost:8080/site/iptc/entity?id=http://cv.iptc.org/newscodes/genre/Exclusive"</span>
+<div class="codehilite"><pre>curl -i -X PUT -H <span
class="s2">"Content-Type: application/rdf+xml"</span> -T genre.rdf
<span class="se">\</span>
+ <span
class="s2">"http://localhost:8080/site/iptc/entity?id=http://cv.iptc.org/newscodes/genre/Exclusive"</span>
</pre></div>
@@ -123,7 +125,7 @@
<ul>
<li><strong>ID</strong>: This MUST BE unique to all other Yards. It is
recommended to use "{siteId}Yard".</li>
<li><strong>Solr Index/Core</strong>: This is the name of the SolrCore that
will be used to store the data. Here it is recommended to use the same name as
the {siteId}. This is because the RESTful API of the SolrCore is published
under <code>http://{stanbol-instance}/solr/default/{solrCore}</code>. So using
the same name as {siteId} and {solrCore} makes it easier for map the RESTful
API of the SolrCore with the ManagedSite published under
<code>http://{stanbol-instance}/entityhub/stite/{siteId}</code>.</li>
-<li><strong>Use default SolrCore configuration</strong>: If enabled the
SolrCore will be automatically created by using the default configuration.
Users will typically want to use this option. Only users that want to use a
special SolrCore configuration will need to deactivate this option and to
provide a <code>{solrCore}.solrindex.zip</code> archive containing the special
configuration in the <code>{stanbol-workingdir}/stanbol/datafiles</code>
directory. See the<a
href="../utils/commons-solr.html#managingsolrindexes">Managing Solr Indexes</a>
section for detailed information. </li>
+<li><strong>Use default SolrCore configuration</strong>: If enabled the
SolrCore will be automatically created by using the default configuration.
Users will typically want to use this option. Only users that want to use a
special SolrCore configuration will need to deactivate this option and to
provide a <code>{solrCore}.solrindex.zip</code> archive containing the special
configuration in the <code>{stanbol-workingdir}/stanbol/datafiles</code>
directory. See the<a
href="../utils/commons-solr.html#managing-solr-indexes">Managing Solr
Indexes</a> section for detailed information. </li>
</ul>
<h4 id="configuration-of-a-clerezzayard">Configuration of a ClerezzaYard:</h4>
<p>This describes how to configure an ClerezzaYard to be used with an YardSite
by using the Configuration tab of the Apache Felix Webconsole <a
href="http://localhost:8080/system/console/configMgr";>http://{stanbol-instance}/system/console/configMgr</a>.</p>
