%META:TOPICPARENT{name="VOSIndex"}%

---+ Installation and Configuration of the Virtuoso Faceted Browser

%TOC%

---++ Prerequisites

Requires Virtuoso 6.0 TP1 or higher, either [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VOSDownload][Open Source]] or [[http://shop.openlinksw.com/license_generator/virtuoso-download/][Commercial Edition]].

---++ Pre Installation

<i><b>Note:</b> This step is <b>not</b> required for Virtuoso Release 6.1 and later.</i>

If you have an existing Virtuoso 6.0 installation, and your Quad Store has more than 10,000 triples, please run
 [[VirtFacetBrowserInstallConfigCommands][these commands]] using the Virtuoso <code>isql</code> program
before installing the Faceted Browser VAD.

<i><b>Note:</b> This step may take some time depending on how many triples are already in your Quad Store.</i>

---++ VAD Package Installation

   1 Install the Virtuoso Faceted Browser VAD package called <code>fct</code> from the available packages listed in the <b>Install Packages</b> section of the <b>System Admin -> Packages</b> tab of the Virtuoso Conductor. As an alternative you can [[http://virtuoso.openlinksw.com/download/][download the VAD]] from our public download store.
%BR%%BR%<a href="%ATTACHURLPATH%/fb1.png" target="_blank"><img src="%ATTACHURLPATH%/fb1.png" width="600px" /></a>%BR%%BR%
   1 The HTML interface of the Faceted Browser Engine is exposed at:  <code>http://&lt;cname&gt;/fct</code>, where
"cname" is the &lt;hostname&gt;:&lt;port-number&gt; your Virtuoso instance is running on.
%BR%%BR%<a href="%ATTACHURLPATH%/fb2.png" target="_blank"><img src="%ATTACHURLPATH%/fb2.png" width="600px" /></a>%BR%%BR%
   1 The Faceted Browser Engine exposes a REST API at the endpoint: <code>http://&lt;cname&gt;/fct/service</code>.

---++ Post Installation

   1 Build Full Text Indexes by running the following commands using the Virtuoso <code>isql</code> program:
<verbatim>
RDF_OBJ_FT_RULE_ADD (null, null, 'All');
VT_INC_INDEX_DB_DBA_RDF_OBJ ();
</verbatim>
   1 Run the following procedure using the Virtuoso <code>isql</code> program to periodically populate label lookup
tables and activate the <code>Label</code> text box of the <code>Entity Label Lookup</code> tab:
<verbatim>
urilbl_ac_init_db()
</verbatim>
   1 Run the following procedure using the Virtuoso <code>isql</code> program to calculate the IRI ranks.
<i><b>Note:</b> This should be re-run periodically as the data grows to re-rank the IRIs.</i>
<verbatim>
s_rank()
</verbatim>
   1 Fetch some Network Resources data to load some RDF triples in the quad store. This can easily be done by first installing the Virtuoso [[https://virtuoso.openlinksw.com/download/][Sponger Middleware]] VAD and then loading the following
URL in a Web browser, which will use the built-in Virtuoso <code>description.vsp</code> page to provides a hypertext
description of RDF Linked Data. You may substitute any live Web page URL for "<code><nowiki>http://news.cnet.com/</nowiki></code>"
but it is best if you select one known to have plenty of data.
<verbatim>
http://<cname>/about/html/http://news.cnet.com/
</verbatim>
%BR%%BR%<a href="%ATTACHURLPATH%/fb3.png" target="_blank"><img src="%ATTACHURLPATH%/fb3.png" width="600px" /></a>
%BR%%BR%<a href="%ATTACHURLPATH%/fb4.png" target="_blank"><img src="%ATTACHURLPATH%/fb4.png" width="600px" /></a>%BR%%BR%
   1 Use the Faceted Browser Search and Find User Interface to search for information on "CNET":
%BR%%BR%<a href="%ATTACHURLPATH%/fb5.png" target="_blank"><img src="%ATTACHURLPATH%/fb5.png" width="600px" /></a>%BR%%BR%
   1 Results of the following form should be returned for the Network resource being fetched:
%BR%%BR%<a href="%ATTACHURLPATH%/fb6.png" target="_blank"><img src="%ATTACHURLPATH%/fb6.png" width="600px" /></a>%BR%%BR%
   1 Click <b>Types</b> link shown at the right vertical Navigation:
   1 Results of the classes/properties should be returned:
%BR%%BR%<a href="%ATTACHURLPATH%/fb7.png" target="_blank"><img src="%ATTACHURLPATH%/fb7.png" width="600px" /></a>%BR%%BR%
   1 To get Type description, click "Describe" link for a given type, for ex. "Person".
   1 A list of attributes and values should be presented for the given resource. Note that automatically is generated QRCode image for the described entity.
%BR%%BR%<a href="%ATTACHURLPATH%/fb8.png" target="_blank"><img src="%ATTACHURLPATH%/fb8.png" width="600px" /></a>%BR%%BR%
   1 Return back to the Attributes list from above by going to the "Facets" tab.
   1 To exclude a type, un-tick the checkbox associated with the type:
%BR%%BR%<a href="%ATTACHURLPATH%/fb9.png" target="_blank"><img src="%ATTACHURLPATH%/fb9.png" width="600px" /></a>%BR%%BR%
   1 Click the <b>Type URI</b> link:
   1 Results of excluding the Type(s) should be shown:
%BR%%BR%<a href="%ATTACHURLPATH%/fb10.png" target="_blank"><img src="%ATTACHURLPATH%/fb10.png" width="600px" /></a>%BR%%BR%
   1 The Faceted Browser Web service endpoint [[VirtFacetBrowserInstallConfigQueried][can also be queried to obtain the same results]].
   1 Click "New search" from the Entity Relations Navigation and go to "Entity Label Lookup" tab:
%BR%%BR%<a href="%ATTACHURLPATH%/fb11.png" target="_blank"><img src="%ATTACHURLPATH%/fb11.png" width="600px" /></a>%BR%%BR%
   1 In the <b>Label</b> auto-complete text box of the <b>Entity Label Lookup</b> tab, enter the name of an rdfs label to be <code>Described</code>:
%BR%%BR%<a href="%ATTACHURLPATH%/fb12.png" target="_blank"><img src="%ATTACHURLPATH%/fb12.png" width="600px" /></a>%BR%%BR%
   1 Select a URI from the list of available Labels to obtain a description of the URI:
%BR%%BR%<a href="%ATTACHURLPATH%/fb13.png" target="_blank"><img src="%ATTACHURLPATH%/fb13.png" width="600px" /></a>%BR%%BR%
%BR%%BR%<a href="%ATTACHURLPATH%/fb14.png" target="_blank"><img src="%ATTACHURLPATH%/fb14.png" width="600px" /></a>%BR%%BR%
   1 Click "Facets" and go to "Entity URI Lookup" tab:
%BR%%BR%<a href="%ATTACHURLPATH%/fb15.png" target="_blank"><img src="%ATTACHURLPATH%/fb15.png" width="600px" /></a>%BR%%BR%
   1 In the <b>URI</b> auto-complete text box of the <b>Entity URI Lookup</b> tab enter the name URI to be <code>Described</code>:
%BR%%BR%<a href="%ATTACHURLPATH%/fb16.png" target="_blank"><img src="%ATTACHURLPATH%/fb16.png" width="600px" /></a>%BR%%BR%
   1 Select a URI from the list of available Labels to obtain a description of the URI:
%BR%%BR%<a href="%ATTACHURLPATH%/fb17.png" target="_blank"><img src="%ATTACHURLPATH%/fb17.png" width="600px" /></a>%BR%
%BR%%BR%<a href="%ATTACHURLPATH%/fb18.png" target="_blank"><img src="%ATTACHURLPATH%/fb18.png" width="600px" /></a>%BR%%BR%
   1 If data is loaded into the quad store via DML functions (<code>TTLP</code>, <code>RDF&#95;LOAD&#95;RDFXML</code>,
etc.), the following procedure needs to be run from <code>isql</code> to rebuild the free text indexes each time:
<verbatim>
VT_INC_INDEX_DB_DBA_RDF_OBJ ()
</verbatim>


---+++ URI Labels

   1 Go to http://&lt;cname&gt;/fct/
   1  Enter a free text search pattern  (for example, "<code>Camcorder</code>" as consumer product), and click Search:
%BR%%BR%<a href="%ATTACHURLPATH%/fb19.png" target="_blank"><img src="%ATTACHURLPATH%/fb19.png" width="600px" /></a>%BR%%BR%
   1 Your initial query results page will display a list of literal value snippets where for each URL will be displayed a label:
%BR%%BR%<a href="%ATTACHURLPATH%/fb20.png" target="_blank"><img src="%ATTACHURLPATH%/fb20.png" width="600px" /></a>%BR%%BR%
   1 Click for ex. on the URL link of the first row result.
   1 The product description page should be shown and a list of Attributes and Values will be presented:
%BR%%BR%<a href="%ATTACHURLPATH%/fb21.png" target="_blank"><img src="%ATTACHURLPATH%/fb21.png" width="600px" /></a>
%BR%%BR%<a href="%ATTACHURLPATH%/fb22.png" target="_blank"><img src="%ATTACHURLPATH%/fb22.png" width="600px" /></a>%BR%%BR%

#UsageStatistics
---+++ Usage Statistics

   1 Use the Faceted Browser Search and Find User Interface to search for information on "Michael Jackson":
%BR%%BR%<a href="%ATTACHURLPATH%/fb24.png" target="_blank"><img src="%ATTACHURLPATH%/fb24.png" width="600px" /></a>%BR%%BR%
   1 Results of the following form should be returned for the Network Resource being fetched:
%BR%%BR%<a href="%ATTACHURLPATH%/fb25.png" target="_blank"><img src="%ATTACHURLPATH%/fb25.png" width="600px" /></a>%BR%%BR%
   1. Click the "Types" link under "Entity Relations Navigation".
   1. Results about "Michael Jackson" as Type/Label/Count list should be displayed:
%BR%%BR%<a href="%ATTACHURLPATH%/fb26.png" target="_blank"><img src="%ATTACHURLPATH%/fb26.png" width="600px" /></a>%BR%%BR%
   1 You can navigate amongst the search results pages by using the "<" and ">" buttons. Click for ex. ">" in order to view the next page results:
%BR%%BR%<a href="%ATTACHURLPATH%/fb27.png" target="_blank"><img src="%ATTACHURLPATH%/fb27.png" width="600px" /></a>%BR%%BR%
   1. Click a type link, for ex.:
<verbatim>
yago:EpicRecordsArtist
</verbatim>
   1. Displaying Ranked Entity Names and Text summaries should be shown:
%BR%%BR%<a href="%ATTACHURLPATH%/fb28.png" target="_blank"><img src="%ATTACHURLPATH%/fb28.png" width="600px" /></a>%BR%%BR%
   1. Click the link:
<verbatim>
dbpedia:Michael_Jackson
</verbatim>
   1 Results about "Michael Jackson" as Attribute/Value list should be presented:
%BR%%BR%<a href="%ATTACHURLPATH%/fb29.png" target="_blank"><img src="%ATTACHURLPATH%/fb29.png" width="600px" /></a>
%BR%%BR%<a href="%ATTACHURLPATH%/fb30.png" target="_blank"><img src="%ATTACHURLPATH%/fb30.png" width="600px" /></a>
%BR%%BR%<a href="%ATTACHURLPATH%/fb31.png" target="_blank"><img src="%ATTACHURLPATH%/fb31.png" width="600px" /></a>%BR%%BR%
   1 Go to "Metadata" tab.
   1 Results of usage statistics for "Michael Jackson" grouped in 4 tabs should be shown:
      1. <b>Source Documents</b>: shows how many times the URI is found as object in the relevant graph(s):
<verbatim>
SPARQL
  SELECT ?g
         COUNT (*)
   WHERE
     {
       GRAPH ?g { ?s ?p <URI> }
     }
GROUP BY ?g
ORDER BY DESC 2
   LIMIT 20
;
</verbatim>
%BR%%BR%<a href="%ATTACHURLPATH%/fb35.png" target="_blank"><img src="%ATTACHURLPATH%/fb35.png" width="600px" /></a>%BR%%BR%
      1. <b>Referenced by Documents</b>: shows how many times the URI is found as subject in the relevant graph(s):
<verbatim>
SPARQL
  SELECT ?g
         COUNT (*)
   WHERE
     {
       GRAPH ?g { <URI> ?p ?o }
     }
GROUP BY ?g
ORDER BY DESC 2
   LIMIT 20
;
</verbatim>
%BR%%BR%<a href="%ATTACHURLPATH%/fb36.png" target="_blank"><img src="%ATTACHURLPATH%/fb36.png" width="600px" /></a>%BR%%BR%
      1.  <b>Explicit Coreferences</b>: shows results as subject and calculated rank, based on running transitive closure over owl:sameAs of the URI in subject or object:
<verbatim>
SPARQL
  SELECT ?syn
         ( sql:rnk_scale (<LONG::IRI_RANK> (?syn)))
   WHERE
     {
       { SELECT ?s ?syn
          WHERE
            {
              {
                ?syn  owl:sameAs  ?s
              }
              UNION
              {
                ?s    owl:sameAs  ?syn
              }
            }
       }
       OPTION (transitive, t_distinct, t_min (0), T_in (?s), t_out (?syn)) .
       FILTER (!isliteral (?syn) &amp;&amp; ?s = <URI> )
     }
ORDER BY DESC 2
   LIMIT 20
;
</verbatim>
%BR%%BR%<a href="%ATTACHURLPATH%/fb37.png" target="_blank"><img src="%ATTACHURLPATH%/fb37.png" width="600px" /></a>%BR%%BR%
      1. <b>Implicit Coreferences</b>: shows expanded results for objects concur with the URI by IFP:
<verbatim>
SPARQL
  SELECT DISTINCT ?syn ?p ?o (sql:rnk_scale (<LONG::IRI_RANK> (?syn)))
   WHERE
     {
       <URI> ?p ?o .
     FILTER (0 != (<LONG::bif:rdf_is_sub> ("b3sifp", ?p, lod:ifp_like, 3))) .
       ?syn ?p ?o .
     }
ORDER BY DESC 4
   LIMIT 20
;
</verbatim>
%BR%%BR%<a href="%ATTACHURLPATH%/fb38.png" target="_blank"><img src="%ATTACHURLPATH%/fb38.png" width="600px" /></a>%BR%%BR%

---++ Tutorials

   * [[VirtuosoLODSampleTutorial][Linked Data Pivot (Faceted Data Exploration) Tutorial]].

---++ Related

   * Downloads
      * Virtuoso [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VOSDownload][Open Source]] or [[http://virtuoso.openlinksw.com/download/][Commercial Edition]]
      * [[http://virtuoso.openlinksw.com/download/][Virtuoso Faceted Browser and other VAD downloads]]
   * Facets Web Service
      * [[VirtuosoFacetsWebService][Virtuoso Facets Web Service]]
   * Linked Data
      * [[VirtuosoFacetsViewsLinkedData][Faceted Views over Large-Scale Linked Data]]
   * Facet APIs
      * [[VirtFacetBrowserAPIs][Virtuoso APIs for FCT REST services]]
      * [[VirtFacetBrowserAPIsFCTEXEC][<code><nowiki>fct_exec</nowiki></code> API Example]]
   * Pivot Viewer and CXML
      * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtSparqlCxmlFacetPivotBridge#AncSparqlCxmlFacetPivotBridge][Facet Pivot Bridge -  A bridge to PivotViewer from Virtuoso's Faceted query service for RDF]]
      * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtSparqlCxml#AncFacetTypeAutoDetection][Auto-Detection of Facet Type]]
   * Tutorials
      * [[VirtuosoLODSampleTutorial][Faceted Browsing Sample using LOD Cloud Cache data space]]
      * [[VirtuosoFacetsWebServiceSOAPExample][SOAP Facets Example]]
      * [[VirtFacetBrowserInstallConfigQueried][Querying The Faceted Browser Web Service endpoint]]
      * [[VirtFCTFeatureQueries][Virtuoso Faceted Browser Featured Queries]]
      * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtVisualizeWithPivotViewer#GenFCT][Visualizing Your Data With PivotViewer Using The Faceted Browser]]
      * [[VirtTipsAndTricksCustomControlLabelsURI][Custom Controlling Virtuoso Labels for URI functionality Example]]
      * [[VirtuosoFacetsWebServiceCustmExamples][Facets Web Service: Examples for customizing different types]]
      * [[VirtuosoFacetsWebServiceChoiceExample][Facets Web Service: Choice of Labels Example]]