Page tree
Skip to end of metadata
Go to start of metadata

Overview

In addition to the standard Java Client API you can use the Opensearch module to expose AIE query services via the Opensearch RSS format.

Required Modules

These features require the inclusion of the opensearch module when you run createproject to create the project directories.

View incoming links.

 

OpenSearch RSS API

To access the OpenSearch RSS API, select Modules -> OpenSearch RSS API in the AIE Administrator. The OpenSearch RSS API screen appears showing the Opensearch query form.

 You can also access the opensearch servlet:

http://localhost:{baseport}/opensearch

Queries

The default gateway form provides basic options for setting the query and what fields to use for well defined Opensearch result fields. You can add any CGI argument available in the JSON REST API to the url.

Results

Opensearch query results return in a well-defined RSS format according to the Opensearch specification with additional meta data in the attivio namespace as follows:

<!-- Copyright 2009 Attivio, Inc -->
<rss version="2.0" xmlns:attivio="http://developer.attivio.com/opensearchrss/1.0/" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <channel>
    <title>Attivio AIE RSS Feed</title>
    <link>/opensearch?query=table%3Acountry&amp;workflows=search&amp;feedName=Attivio+AIE+RSS+Feed&amp;titleField=title&amp;uriField=uri&amp;textField=text</link>
    <description>Search results for table:country</description>
    <opensearch:totalResults>260</opensearch:totalResults>
    <opensearch:startIndex>0</opensearch:startIndex>
    <opensearch:itemsPerPage>10</opensearch:itemsPerPage>
    <attivio:query>table:country</attivio:query>
    <item>
      <title>Aruba</title>
      <description>Discovered and claimed for Spain in 1499, Aruba was acquired by the Dutch in 1636 ... reset of description</description>
      <link>https://www.cia.gov/library/publications/the-world-factbook/geos/aa.html</link>
      <attivio:documentId>C:\aie1.5.2.whoknows\example\data\factbook\aa.xml</attivio:documentId>
      <attivio:agriprod>Aloes | Livestock | Fish</attivio:agriprod>
      <attivio:climate>Tropical Marine | Little Seasonal Temperature Variation</attivio:climate>
      <attivio:country>Aruba</attivio:country>
      <attivio:date>Mon Nov 16 09:26:20 EST 2009</attivio:date>
      <attivio:economy>Tourism is the mainstay of the small, open Aruban economy, with offshore banking ... rest of economy</attivio:economy>
      <attivio:ethnicity>Mixed White | Other</attivio:ethnicity>
      <attivio:filename>aa.xml</attivio:filename>
      <attivio:img>aa-flag.gif</attivio:img>
      <attivio:industry>Tourism | Transshipment Facilities | Oil Refining</attivio:industry>
      <attivio:inflationRate>3.4</attivio:inflationRate>
      <attivio:laborForce>41500</attivio:laborForce>
      <attivio:language>English</attivio:language>
      <attivio:languages>English</attivio:languages>
      <attivio:latitude>12.5</attivio:latitude>
      <attivio:location>Netherlands Antilles</attivio:location>
      <attivio:locationDesc>Caribbean, Island in the Caribbean Sea, North Of Venezuela</attivio:locationDesc>
      <attivio:longitude>-69.96666666666667</attivio:longitude>
      <attivio:map>Central America and the Caribbean</attivio:map>
      <attivio:position>0.2182,-1.2211</attivio:position>
      <attivio:publicDebt>46.3</attivio:publicDebt>
      <attivio:raw_latitude>12 30 N</attivio:raw_latitude>
      <attivio:raw_longitude>69 58 W</attivio:raw_longitude>
      <attivio:religion>Roman Catholic | Protestant | Other</attivio:religion>
      <attivio:resource>Negl; White Sandy Beaches</attivio:resource>
      <attivio:size>3774</attivio:size>
      <attivio:sourcepath>C:\aie1.5.2.whoknows\example\data\factbook\aa.xml</attivio:sourcepath>
      <attivio:spokenLanguage>Papiamento | Spanish | English | Dutch | Other | Unspecified or Unknown</attivio:spokenLanguage>
      <attivio:table>country</attivio:table>
      <attivio:teaser>Discovered and claimed for Spain in 1499, Aruba was acquired by the Dutch in 1636.  ... rest of teaser</attivio:teaser>
      <attivio:terrain>Flat With a Few Hills | Scant Vegetation</attivio:terrain>
      <attivio:unemploymentRate>6.9</attivio:unemploymentRate>
    </item>
    <!-- more results here -->
  </channel>
</rss>
  • No labels