ODSSemanticPingback Usage Guide for Semantic Pingback in ODS Usage Guide for Semantic Pingback in ODS What is Semantic Pingback? Semantic Pingback is a mechanism through which data space owners receive notification, in the form of triple statements, when external sources (typically other data spaces) make references to their data spaces. This mechanism is basically an adaptation of the blog pingback, with payloads now taking the form of RDF-based structured data resources. For instance, the owner of DataSpaceA might assert that they know the owner of DataSpaceB via a local foaf:knows assertion -- { DataSpaceA:owner foaf:knows DataSpaceB:owner } Depending on data space settings, the owner of DataSpaceB might then receive an email notice of the foaf:knows assertion, or DataSpaceA might use the notification to automatically generate a local reciprocal assertion. { DataSpaceB:owner foaf:knows DataSpaceA:owner } The Semantic Pingback functionality in ODS supports operation in both client and server modes. Semantic Pingback Endpoints in ODS <tgroup><thead /><tbody> <row><entry> <emphasis>XML-RPC</emphasis> </entry><entry> http://<cname>[:<port>]/semping </entry><entry> parameters 'source' and 'target' (strings) as explained in the specification </entry></row> <row><entry> <emphasis>REST</emphasis> </entry><entry> http://<cname>[:<port>]/semping/rest?source=<source uri>&target=<target uri> </entry><entry> parameters are as with XML-RPC, but payloads are delivered using HTTP POST or GET operations. </entry></row> </tbody></tgroup></table> <bridgehead class="http://www.w3.org/1999/xhtml:h2"> Semantic Pingback Setup in ODS</bridgehead> <para>This scenario assumes two ODS instances, where one is the <emphasis>Ping Receiver</emphasis> and the other is the <emphasis>Ping Sender</emphasis>.</para> <bridgehead class="http://www.w3.org/1999/xhtml:h3"> Configuring the Ping Receiver</bridgehead> <orderedlist spacing="compact"><listitem>The ODS data space owner designates data space applications for which ping notification will be enabled through the <emphasis>Application Settings</emphasis> menu <emphasis>Semantic Pingback Setup</emphasis> option. </listitem> <listitem>The data space owner must choose what will happen upon ping notification: email; automatic generation of reciprocal data (i.e., triple-based data generation); or both: <figure><graphic fileref="ODSSemanticPingback/step2.png" /></figure></listitem> </orderedlist><bridgehead class="http://www.w3.org/1999/xhtml:h3"> Actions to take on the Ping Sender</bridgehead> <orderedlist spacing="compact"><listitem>Go to a ping-enabled ODS data space application. For example, the <emphasis>Profile Manager and Editor</emphasis> includes an <emphasis>Annotations</emphasis> tab, which offers a UI for making arbitrary assertions about anything with triples-based statements. </listitem> <listitem>Make a simple Annotation claiming to know the owner of the Ping Receiver instance configured above, with a foaf:knows relation targeting the WebID of the Ping Receiver instance owner. </listitem> <listitem>Tick the <emphasis>Issue Semantic Pingback</emphasis> checkbox. </listitem> <listitem>Click the <emphasis>Add</emphasis> button to complete the pingback enabled annotation. <figure><graphic fileref="ODSSemanticPingback/step3.png" /></figure></listitem> </orderedlist><bridgehead class="http://www.w3.org/1999/xhtml:h3"> Actions to take on the Ping Receiver</bridgehead> <orderedlist spacing="compact"><listitem>Go to your ODS Profile Page, or simply load your WebID into the Address Bar of any HTTP compliant browser. </listitem> <listitem>Observe the addition of the new foaf:knows relation posted by the Ping Sender. <figure><graphic fileref="ODSSemanticPingback/step4.png" /></figure> </listitem> <listitem>If the email option was enabled, you will also receive an email indicating that you are the "Object" of a foaf:knows relation asserted by the Ping Sender.</listitem> </orderedlist><bridgehead class="http://www.w3.org/1999/xhtml:h2"> Security of Ping Notifications</bridgehead> <para>The access control feature of Virtuoso (your ODS host environment) may be used to add an ACL named 'SemanticPingback' via the Conductor admin interface. A variety of controls may be set there, as depicted below: <figure><graphic fileref="ODSSemanticPingback/semping_acl.png" /></figure></para> <bridgehead class="http://www.w3.org/1999/xhtml:h2">Related</bridgehead> <itemizedlist mark="bullet" spacing="compact"><listitem><ulink url="OdsConfig">Installing and Configuring ODS</ulink> </listitem> </itemizedlist></section></docbook>