---+ ODS and Inclusion Engine Integration

%TOC%

---++What is it?

The integration enables an open standards based metadata to be injected into ODS pages.
   
---++Why is it important?

The ODS Framework and ODS Application collect RDF data but they are not part form HTML code. Inclusion Engine enables agile management of open standards based metadata embedded in HTML docs as part of Search Engine Optimization (SEO) and related content discovery related activities. 

---++How do I use it?

The injection can be enabled for every ODS Application by an instance creation or edit its properties:

   <img src="%ATTACHURLPATH%/ApplicationProperties.png" style="wikiautogen"/>

The metadata injection is possible only for public instances. They collect data in the public RDF graph [Host]/dataspace used by Inclusion Engine to prepare injected metadata. The injection is only for URL which are URI of the ODS objects.

The injected data can be browse using [[https://github.com/openlink/structured-data-sniffer][Openlink Structured Data Sniffer (OSDS)]].

   <img src="%ATTACHURLPATH%/ODS_IE_Weblog_Post.png" style="wikiautogen"/>


   <b><nowiki>Wiki Post Metadata</nowiki></b>


<img src="%ATTACHURLPATH%/ODS_IE_Briefcase.png" style="wikiautogen"/>


<b><nowiki>Briefcase Instance Metadata</nowiki></b>


<img src="%ATTACHURLPATH%/ODS_IE_Calendar.png" style="wikiautogen"/>


<b><nowiki>Calendar Instance Metadata</nowiki></b>


---+++API Description

The following procedures are located in the <nowiki><code>sql/hosted_services.sql</code></nowiki> file of ODS Framework VAD:

|*API Name*|*API Entry parameters*|*Description*|
|<b><nowiki>ODS.DBA.incluson_engine_is_possible</nowiki></b>|None|This procedure checks if the inclusion is possible. Returns true or false.|
|<b><nowiki>ODS.DBA.incluson_engine</nowiki></b>|in app varchar|This procedure is a virtual dir post procedure which prepare parameters for the metadata injection. The 'app' parameter is a instance type name.|
|<b><nowiki>ODS.DBA.incluson_engine_wiki</nowiki></b>|None|This procedure is a virtual dir post procedure special for ODS Wiki instances.|
|<b><nowiki>ODS.DBA.incluson_engine_domain</nowiki></b>|in app varchar|Determine the instance ID based on URL or params. The 'app' parameter is a instance type name.|
|<b><nowiki>ODS.DBA.incluson_engine_post</nowiki></b>|in app_id integer|This procedure enables or disables the injection for the instance with ID = app_id|
|<b><nowiki>ODS.DBA.incluson_engine_path_escape</nowiki></b>|in path varchar|This procedure escapes the path.|

---++References
   * [[http://wiki.usnet.private/dataspace/dav/wiki/Main/InclusionEngineDocs][Inclusion Engine]]
   * [[https://github.com/openlink/structured-data-sniffer][Openlink Structured Data Sniffer (OSDS)]]