<docbook><section><title>VirtFacetBrowserInstallConfig</title><title> Installation and Configuration of the Virtuoso Faceted Browser</title> Installation and Configuration of the Virtuoso Faceted Browser
<bridgehead class="http://www.w3.org/1999/xhtml:h2"> Prerequisites</bridgehead>
<para>Requires Virtuoso 6.0 TP1 or higher, either <ulink url="http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VOSDownload">Open Source</ulink> or <ulink url="http://shop.openlinksw.com/license_generator/virtuoso-download/">Commercial Edition</ulink>.</para>
<bridgehead class="http://www.w3.org/1999/xhtml:h2"> Pre Installation</bridgehead>
<emphasis><emphasis>Note:</emphasis> This step is <emphasis>not</emphasis> required for Virtuoso Release 6.1 and later.</emphasis><para>If you have an existing Virtuoso 6.0 installation, and your Quad Store has more than 10,000 triples, please run  <ulink url="VirtFacetBrowserInstallConfigCommands">these commands</ulink> using the Virtuoso isql program before installing the Faceted Browser VAD.</para>
<emphasis><emphasis>Note:</emphasis> This step may take some time depending on how many triples are already in your Quad Store.</emphasis><bridgehead class="http://www.w3.org/1999/xhtml:h2"> VAD Package Installation</bridgehead>
<orderedlist spacing="compact"><listitem>Install the Virtuoso Faceted Browser VAD package called fct from the available packages listed in the <emphasis>Install Packages</emphasis> section of the <emphasis>System Admin -&gt; Packages</emphasis> tab of the Virtuoso Conductor.
 As an alternative you can <ulink url="http://virtuoso.openlinksw.com/download/">download the VAD</ulink> from our public download store.
<ulink url="VirtFacetBrowserInstallConfig/fb1.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb1.png" /></figure></ulink> </listitem>
<listitem>The HTML interface of the Faceted Browser Engine is exposed at:  http://&lt;cname&gt;/fct, where &quot;cname&quot; is the &lt;hostname&gt;:&lt;port-number&gt; your Virtuoso instance is running on.
<ulink url="VirtFacetBrowserInstallConfig/fb2.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb2.png" /></figure></ulink> </listitem>
<listitem>The Faceted Browser Engine exposes a REST API at the endpoint: http://&lt;cname&gt;/fct/service.</listitem>
</orderedlist><bridgehead class="http://www.w3.org/1999/xhtml:h2"> Post Installation</bridgehead>
<orderedlist spacing="compact"><listitem>Build Full Text Indexes by running the following commands using the Virtuoso isql program: <programlisting>RDF_OBJ_FT_RULE_ADD (null, null, &#39;All&#39;);
VT_INC_INDEX_DB_DBA_RDF_OBJ ();
</programlisting></listitem>
<listitem>Run the following procedure using the Virtuoso isql program to periodically populate label lookup tables and activate the Label text box of the Entity Label Lookup tab: <programlisting>urilbl_ac_init_db()
</programlisting></listitem>
<listitem>Run the following procedure using the Virtuoso isql program to calculate the IRI ranks.
<emphasis><emphasis>Note:</emphasis> This should be re-run periodically as the data grows to re-rank the IRIs.</emphasis> <programlisting>s_rank()
</programlisting></listitem>
<listitem>Fetch some Network Resources data to load some RDF triples in the quad store.
 This can easily be done by first installing the Virtuoso <ulink url="https://virtuoso.openlinksw.com/download/">Sponger Middleware</ulink> VAD and then loading the following URL in a Web browser, which will use the built-in Virtuoso description.vsp page to provides a hypertext description of RDF Linked Data.
 You may substitute any live Web page URL for &quot;http://news.cnet.com/&quot; but it is best if you select one known to have plenty of data.
<programlisting>http://&lt;cname&gt;/about/html/http://news.cnet.com/
</programlisting><ulink url="VirtFacetBrowserInstallConfig/fb3.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb3.png" /></figure></ulink> <ulink url="VirtFacetBrowserInstallConfig/fb4.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb4.png" /></figure></ulink> </listitem>
<listitem>Use the Faceted Browser Search and Find User Interface to search for information on &quot;CNET&quot;: <ulink url="VirtFacetBrowserInstallConfig/fb5.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb5.png" /></figure></ulink> </listitem>
<listitem>Results of the following form should be returned for the Network resource being fetched: <ulink url="VirtFacetBrowserInstallConfig/fb6.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb6.png" /></figure></ulink> </listitem>
<listitem>Click <emphasis>Types</emphasis> link shown at the right vertical Navigation: </listitem>
<listitem>Results of the classes/properties should be returned: <ulink url="VirtFacetBrowserInstallConfig/fb7.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb7.png" /></figure></ulink> </listitem>
<listitem>To get Type description, click &quot;Describe&quot; link for a given type, for ex.
 &quot;Person&quot;.
</listitem>
<listitem>A list of attributes and values should be presented for the given resource.
 Note that automatically is generated QRCode image for the described entity.
<ulink url="VirtFacetBrowserInstallConfig/fb8.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb8.png" /></figure></ulink> </listitem>
<listitem>Return back to the Attributes list from above by going to the &quot;Facets&quot; tab.
</listitem>
<listitem>To exclude a type, un-tick the checkbox associated with the type: <ulink url="VirtFacetBrowserInstallConfig/fb9.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb9.png" /></figure></ulink> </listitem>
<listitem>Click the <emphasis>Type URI</emphasis> link: </listitem>
<listitem>Results of excluding the Type(s) should be shown: <ulink url="VirtFacetBrowserInstallConfig/fb10.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb10.png" /></figure></ulink> </listitem>
<listitem>The Faceted Browser Web service endpoint <ulink url="VirtFacetBrowserInstallConfigQueried">can also be queried to obtain the same results</ulink>.
</listitem>
<listitem>Click &quot;New search&quot; from the Entity Relations Navigation and go to &quot;Entity Label Lookup&quot; tab: <ulink url="VirtFacetBrowserInstallConfig/fb11.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb11.png" /></figure></ulink> </listitem>
<listitem>In the <emphasis>Label</emphasis> auto-complete text box of the <emphasis>Entity Label Lookup</emphasis> tab, enter the name of an rdfs label to be Described: <ulink url="VirtFacetBrowserInstallConfig/fb12.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb12.png" /></figure></ulink> </listitem>
<listitem>Select a URI from the list of available Labels to obtain a description of the URI: <ulink url="VirtFacetBrowserInstallConfig/fb13.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb13.png" /></figure></ulink> <ulink url="VirtFacetBrowserInstallConfig/fb14.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb14.png" /></figure></ulink> </listitem>
<listitem>Click &quot;Facets&quot; and go to &quot;Entity URI Lookup&quot; tab: <ulink url="VirtFacetBrowserInstallConfig/fb15.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb15.png" /></figure></ulink> </listitem>
<listitem>In the <emphasis>URI</emphasis> auto-complete text box of the <emphasis>Entity URI Lookup</emphasis> tab enter the name URI to be Described: <ulink url="VirtFacetBrowserInstallConfig/fb16.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb16.png" /></figure></ulink> </listitem>
<listitem>Select a URI from the list of available Labels to obtain a description of the URI: <ulink url="VirtFacetBrowserInstallConfig/fb17.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb17.png" /></figure></ulink> <ulink url="VirtFacetBrowserInstallConfig/fb18.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb18.png" /></figure></ulink> </listitem>
<listitem>If data is loaded into the quad store via DML functions (TTLP, RDF_LOAD_RDFXML, etc.), the following procedure needs to be run from isql to rebuild the free text indexes each time: <programlisting>VT_INC_INDEX_DB_DBA_RDF_OBJ ()
</programlisting></listitem>
</orderedlist><bridgehead class="http://www.w3.org/1999/xhtml:h3"> URI Labels</bridgehead>
<orderedlist spacing="compact"><listitem>Go to http://&lt;cname&gt; <emphasis>fct</emphasis> </listitem>
<listitem>Enter a free text search pattern  (for example, &quot;Camcorder&quot; as consumer product), and click Search: <ulink url="VirtFacetBrowserInstallConfig/fb19.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb19.png" /></figure></ulink> </listitem>
<listitem>Your initial query results page will display a list of literal value snippets where for each URL will be displayed a label: <ulink url="VirtFacetBrowserInstallConfig/fb20.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb20.png" /></figure></ulink> </listitem>
<listitem>Click for ex.
 on the URL link of the first row result.
</listitem>
<listitem>The product description page should be shown and a list of Attributes and Values will be presented: <ulink url="VirtFacetBrowserInstallConfig/fb21.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb21.png" /></figure></ulink> <ulink url="VirtFacetBrowserInstallConfig/fb22.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb22.png" /></figure></ulink></listitem>
</orderedlist><ulink url="">
<para> </para>
<bridgehead class="http://www.w3.org/1999/xhtml:h3"> Usage Statistics</bridgehead>
<orderedlist spacing="compact"><listitem>Use the Faceted Browser Search and Find User Interface to search for information on &quot;Michael Jackson&quot;: <ulink url="VirtFacetBrowserInstallConfig/fb24.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb24.png" /></figure></ulink> </listitem>
<listitem>Results of the following form should be returned for the Network Resource being fetched: <ulink url="VirtFacetBrowserInstallConfig/fb25.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb25.png" /></figure></ulink> </listitem>
<listitem>Click the &quot;Types&quot; link under &quot;Entity Relations Navigation&quot;.
</listitem>
<listitem>Results about &quot;Michael Jackson&quot; as Type/Label/Count list should be displayed: <ulink url="VirtFacetBrowserInstallConfig/fb26.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb26.png" /></figure></ulink> </listitem>
<listitem>You can navigate amongst the search results pages by using the &quot;&lt;&quot; and &quot;&gt;&quot; buttons.
 Click for ex.
 &quot;&gt;&quot; in order to view the next page results: <ulink url="VirtFacetBrowserInstallConfig/fb27.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb27.png" /></figure></ulink> </listitem>
<listitem>Click a type link, for ex.: <programlisting>yago:EpicRecordsArtist
</programlisting></listitem>
<listitem>Displaying Ranked Entity Names and Text summaries should be shown: <ulink url="VirtFacetBrowserInstallConfig/fb28.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb28.png" /></figure></ulink> </listitem>
<listitem>Click the link: <programlisting>dbpedia:Michael_Jackson
</programlisting></listitem>
<listitem>Results about &quot;Michael Jackson&quot; as Attribute/Value list should be presented: <ulink url="VirtFacetBrowserInstallConfig/fb29.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb29.png" /></figure></ulink> <ulink url="VirtFacetBrowserInstallConfig/fb30.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb30.png" /></figure></ulink> <ulink url="VirtFacetBrowserInstallConfig/fb31.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb31.png" /></figure></ulink> </listitem>
<listitem>Go to &quot;Metadata&quot; tab.
</listitem>
<listitem>Results of usage statistics for &quot;Michael Jackson&quot; grouped in 4 tabs should be shown: <orderedlist spacing="compact"><listitem><emphasis>Source Documents</emphasis>: shows how many times the URI is found as object in the relevant graph(s): <programlisting>SPARQL
  SELECT ?g
         COUNT (*)
   WHERE
     {
       GRAPH ?g { ?s ?p &lt;URI&gt; }
     }
GROUP BY ?g
ORDER BY DESC 2
   LIMIT 20
;
</programlisting><ulink url="VirtFacetBrowserInstallConfig/fb35.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb35.png" /></figure></ulink> </listitem>
<listitem><emphasis>Referenced by Documents</emphasis>: shows how many times the URI is found as subject in the relevant graph(s): <programlisting>SPARQL
  SELECT ?g
         COUNT (*)
   WHERE
     {
       GRAPH ?g { &lt;URI&gt; ?p ?o }
     }
GROUP BY ?g
ORDER BY DESC 2
   LIMIT 20
;
</programlisting><ulink url="VirtFacetBrowserInstallConfig/fb36.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb36.png" /></figure></ulink> </listitem>
<listitem><emphasis>Explicit Coreferences</emphasis>: shows results as subject and calculated rank, based on running transitive closure over owl:sameAs of the URI in subject or object: <programlisting>SPARQL
  SELECT ?syn
         ( sql:rnk_scale (&lt;LONG::IRI_RANK&gt; (?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 = &lt;URI&gt; )
     }
ORDER BY DESC 2
   LIMIT 20
;
</programlisting><ulink url="VirtFacetBrowserInstallConfig/fb37.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb37.png" /></figure></ulink> </listitem>
<listitem><emphasis>Implicit Coreferences</emphasis>: shows expanded results for objects concur with the URI by IFP: <programlisting>SPARQL
  SELECT DISTINCT ?syn ?p ?o (sql:rnk_scale (&lt;LONG::IRI_RANK&gt; (?syn)))
   WHERE
     {
       &lt;URI&gt; ?p ?o .
     FILTER (0 != (&lt;LONG::bif:rdf_is_sub&gt; (&quot;b3sifp&quot;, ?p, lod:ifp_like, 3))) .
       ?syn ?p ?o .
     }
ORDER BY DESC 4
   LIMIT 20
;
</programlisting><ulink url="VirtFacetBrowserInstallConfig/fb38.png"><figure><graphic fileref="VirtFacetBrowserInstallConfig/fb38.png" /></figure></ulink></listitem>
</orderedlist></listitem>
</orderedlist><bridgehead class="http://www.w3.org/1999/xhtml:h2"> Tutorials</bridgehead>
<itemizedlist mark="bullet" spacing="compact"><listitem><ulink url="VirtuosoLODSampleTutorial">Linked Data Pivot (Faceted Data Exploration) Tutorial</ulink>.</listitem>
</itemizedlist><bridgehead class="http://www.w3.org/1999/xhtml:h2"> Related</bridgehead>
<itemizedlist mark="bullet" spacing="compact"><listitem>Downloads <itemizedlist mark="bullet" spacing="compact"><listitem>Virtuoso <ulink url="http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VOSDownload">Open Source</ulink> or <ulink url="http://virtuoso.openlinksw.com/download/">Commercial Edition</ulink> </listitem>
<listitem><ulink url="http://virtuoso.openlinksw.com/download/">Virtuoso Faceted Browser and other VAD downloads</ulink> </listitem>
</itemizedlist></listitem>
<listitem>Facets Web Service <itemizedlist mark="bullet" spacing="compact"><listitem><ulink url="VirtuosoFacetsWebService">Virtuoso Facets Web Service</ulink> </listitem>
</itemizedlist></listitem>
<listitem>Linked Data <itemizedlist mark="bullet" spacing="compact"><listitem><ulink url="VirtuosoFacetsViewsLinkedData">Faceted Views over Large-Scale Linked Data</ulink> </listitem>
</itemizedlist></listitem>
<listitem>Facet APIs <itemizedlist mark="bullet" spacing="compact"><listitem><ulink url="VirtFacetBrowserAPIs">Virtuoso APIs for FCT REST services</ulink> </listitem>
<listitem><ulink url="VirtFacetBrowserAPIsFCTEXEC"><span style="color: red">
      UNKNOWN tag:
      http://www.w3.org/1999/xhtml:nowikifct_exec</span> API Example</ulink> </listitem>
</itemizedlist></listitem>
<listitem>Pivot Viewer and CXML <itemizedlist mark="bullet" spacing="compact"><listitem><ulink url="http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtSparqlCxmlFacetPivotBridge#AncSparqlCxmlFacetPivotBridge">Facet Pivot Bridge -  A bridge to PivotViewer from Virtuoso&#39;s Faceted query service for RDF</ulink> </listitem>
<listitem><ulink url="http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtSparqlCxml#AncFacetTypeAutoDetection">Auto-Detection of Facet Type</ulink> </listitem>
</itemizedlist></listitem>
<listitem>Tutorials <itemizedlist mark="bullet" spacing="compact"><listitem><ulink url="VirtuosoLODSampleTutorial">Faceted Browsing Sample using LOD Cloud Cache data space</ulink> </listitem>
<listitem><ulink url="VirtuosoFacetsWebServiceSOAPExample">SOAP Facets Example</ulink> </listitem>
<listitem><ulink url="VirtFacetBrowserInstallConfigQueried">Querying The Faceted Browser Web Service endpoint</ulink> </listitem>
<listitem><ulink url="VirtFCTFeatureQueries">Virtuoso Faceted Browser Featured Queries</ulink> </listitem>
<listitem><ulink url="http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtVisualizeWithPivotViewer#GenFCT">Visualizing Your Data With PivotViewer Using The Faceted Browser</ulink> </listitem>
<listitem><ulink url="VirtTipsAndTricksCustomControlLabelsURI">Custom Controlling Virtuoso Labels for URI functionality Example</ulink> </listitem>
<listitem><ulink url="VirtuosoFacetsWebServiceCustmExamples">Facets Web Service: Examples for customizing different types</ulink> </listitem>
<listitem><ulink url="VirtuosoFacetsWebServiceChoiceExample">Facets Web Service: Choice of Labels Example</ulink></listitem>
</itemizedlist></listitem>
</itemizedlist></ulink></section></docbook>