---+ODS Ubiquity Commands


%TOC%


---++ What is the ODS Ubiquity Commands implementation?

ODS provides Ubiquity commands to manipulate user accounts as well as instances and instance
specific data using the ODS Controllers API. This command set is available only for the Firefox
browser with the Ubiquity extension installed.

---++ How does it work?

---+++ Installation

First, the [[https://wiki.mozilla.org/Labs/Ubiquity][Ubiquity]] Firefox extension must be
installed.  Then, ODS Ubiquity commands can be installed by accessing
<code><nowiki>http://host:port/ods/ods_ubiquity.html</nowiki></code> page. Ubiquity commands
are accessed by the ctrl-space key combination.

---++ Commands

---+++ Utility Commands
   1 show current ODS Ubiquity params:
<verbatim>
Syntax: ods-get-params
Example: ods-get-params
</verbatim>
   1 enable log command execution - steps and parameters. The log can be shown on Firebug console:
<verbatim>
Syntax: ods-log-enable
Example: ods-log-enable
</verbatim>
   1 disable log command execution:
<verbatim>
Syntax: ods-log-disable
Example: ods-log-disable
</verbatim>

---+++ Basic Session Setup  Commands

---++++ ODS Instance Identification
Assuming you are using the server at: http://myopenlink.net/, in order to change it use
the command:
<verbatim>
Syntax: ods-host <host_url>
Example: ods-host http://demo.openlinksw.com/ods
</verbatim>

Example usage you can find [[VirtuosoOdsUbiquityTutorialsPublBookmark][here]].

---++++ ODS OAuth Endpoint Identification
Assuming the OAuth endpoint: http://myopenlink.net/OAuth, in order to change it use the
command:
<verbatim>
Syntax: ods-oauth-host <host_url>
Example: ods-oauth-host http://demo.openlinksw.com/OAuth
</verbatim>

Example usage you can find [[VirtuosoOdsUbiquityTutorialsOAuth][here]].

---++++ ODS Command Mode
There are two command modes available to ubiquity commands when working against an ODS
instance: oauth or sid.

In OAuth mode, for every ODS application instance, an OAuth key must be obtained and then
initialized via the following steps:
   1 obtain an ODS based OAuth session-key via the ODS example endpoint:
http://host:port/ods/oauth_sid.vsp
<verbatim>
http://myopenlink.net/ods/oauth_sid.vsp
</verbatim>
   1 bind session key to command session via the command: *ods-set-oauth &lt;oauth-key&gt;* or
use *ods-set-[class name]-oauth &lt;oauth-key&gt;* when oauth-key was generated for particular
application instance.
      * Example usage you can find [[VirtuosoOdsUbiquityTutorialsOAuth][here]].

If you choose the SID mode of interaction with ODS you have to perform the following steps:
   1 set mode via command: *ods-set-mode sid* or *ods-set-mode oauth*
   1 set sid via command: *ods-set-sid sid*
      * Example usage you can find [[VirtuosoOdsUbiquityTutorialsPublBookmark][here]].

*Note*: The sid is a session ID applicable to all ODS commands for a given bound instance
and user combination. It's obtained from an ODS session.




---+++ODS Application Commands By Functionality Realm

---++++ ODS Object Information

   1 get information for ODS object by uri: *ods-get-uri-info*:
<verbatim>
Syntax: ods-get-uri-info <uri>
Example: ods-get-uri-info http://myopenlink.net/dataspace/person/kidehen
</verbatim>

---++++ User Management

   1 create user in ODS: *ods-create-user*:
<verbatim>
Syntax: ods-create-user <user_name> password <password> email <email>
Example: ods-create-user test password test email test@openlinksw.com
</verbatim>
   1 authenticate user in ODS: *ods-authenticate-user*:
<verbatim>
Syntax: ods-authenticate-user <user_name> with <password>
Example: ods-authenticate-user demo with demo
</verbatim>
      * Example usage you can find [[VirtuosoOdsUbiquityTutorialsPublCalendar][here]].
   1 get user info: *ods-get-user test*:
<verbatim>
Syntax: ods-get-user <user_name>
Example: ods-get-user test
</verbatim>
   1 enable user: *ods-enable-user*:
<verbatim>
Syntax: ods-enable-user <user_name>
Example: ods-enable-user test
</verbatim>
   1 disable user: *ods-disable-user*:
<verbatim>
Syntax: ods-disable-user <user_name>
Example: ods-disable-user test
</verbatim>
   1 user removal: *ods-delete-user*:
<verbatim>
Syntax: ods-delete-user <user_name>
Example: ods-delete-user test
</verbatim>

---++++ User Annotations

   1 new annotation:
<verbatim>
Syntax: ods-create-user-annotation <iri> has <relation> with <value>
Example: ods-create-user-annotation http://yahoo.com has see:Also with test
</verbatim>
   1 remove existing annotation:
<verbatim>
Syntax: ods-delete-user-annotation <iri> has <relation> with <value>
Example: ods-delete-user-annotation http://yahoo.com has see:Also with test
</verbatim>

---++++ User Topic Of Interests

   1 new topic of interest:
<verbatim>
Syntax: ods-create-user-topicOfInterest <topicURI> [label <topicLabel>]
Example: ods-create-user-topicOfInterest http://yahoo.com label Yahoo Search Engine
</verbatim>
   1 remove existing topic of interest:
<verbatim>
Syntax: ods-delete-user-topicOfInterest <topicURI>
Example: ods-delete-user-topicOfInterest http://yahoo.com
</verbatim>

---++++ User Thing Of Interests

   1 new thing of interest:
<verbatim>
Syntax: ods-create-user-thingOfInterest <thingURI> [label <thingLabel>]
Example: ods-create-user-thingOfInterest http://facefook.com
</verbatim>
   1 remove existing thing of interest:
<verbatim>
Syntax: ods-delete-user-thingOfInterest <thingURI>
Example: ods-delete-user-thingOfInterest http://facefook.com
</verbatim>

---++++ User Biographical Data

   1 new annotation:
<verbatim>
Syntax: ods-create-user-bioevent <bioEvent> on <bioDate> in <bioPlace>
Example: ods-create-user-bioevent bio:Birth on 1970-01-01 in London
</verbatim>
   1 remove existing annotation:
<verbatim>
Syntax: ods-delete-user-bioevent <bioEvent> on <bioDate> in <bioPlace>
Example: ods-delete-user-bioevent bio:Birth on 1970-01-01 in London
</verbatim>

---++++ User's <nowiki>OfferList</nowiki>

   1 new offer:
<verbatim>
Syntax: ods-create-user-offer <offerName> [comment <offerComment>]
Example: ods-create-user-offer LCD Monitor
</verbatim>
   1 new offer property:
<verbatim>
Syntax: ods-create-user-offer-property <offerName> property <offerProperty> value <offerPropertyValue>
Example: ods-create-user-offer-property LCD Monitor property gr:price value $199.95
</verbatim>
   1 remove existing offer property:
<verbatim>
Syntax: ods-delete-user-offer-property <offerName> property <offerProperty> 
Example: ods-delete-user-offer-property LCD Monitor property gr:price
</verbatim>
   1 remove existing offer:
<verbatim>
Syntax: ods-delete-user-offer <offerName>
Example: ods-delete-user-offer LCD Monitor
</verbatim>

---++++ User's <nowiki>WishList</nowiki>

   1 new thing of interest:
<verbatim>
Syntax: ods-create-user-wish <wishName> type <wishType> [comment <wishComment>]
Example: ods-create-user-wish Keyboard type wishs
</verbatim>
   1 remove existing wish:
<verbatim>
Syntax: ods-delete-user-wish
Example: ods-delete-user-wish Keyboard
</verbatim>

---++++ Instance Management
   1 get instance id: *ods-get-instance-id*:
<verbatim>
Syntax: ods-get-instance-id <instance_name>
Example: ods-get-instance-id demo's Bookmarks
</verbatim>
      * Example usage you can find at [[VirtuosoOdsUbiquityTutorials][Tutorials section]].
   1 freeze instance: *ods-freeze-instance*:
<verbatim>
Syntax: ods-freeze-instance <instance_id>
Example: ods-freeze-instance 10
</verbatim>
   1 unfreeze instances: *ods-unfreeze-instance*:
<verbatim>
Syntax: ods-freeze-instance <instance_id>
Example: ods-unfreeze-instance 10
</verbatim>


---+++ Briefcase
   * [[VirtuosoOdsUbiquityBriefcase][Briefcase Ubiquity Commands]]

---+++ Bookmarks
   * [[VirtuosoOdsUbiquityBookmarks][Bookmarks Ubiquity Commands]]


---+++ Calendar
   * [[VirtuosoOdsUbiquityCalendar][Calendar Ubiquity Commands]]


---+++Addressbook
   * [[VirtuosoOdsUbiquityAddressbook][Addressbook Ubiquity Commands]]


---+++ Polls
   * [[VirtuosoOdsUbiquityPolls][Polls Ubiquity Commands]]

---+++ Weblog
   * [[VirtuosoOdsUbiquityWeblog][Weblog Ubiquity Commands]]



---+++Feed Manager
   * [[VirtuosoOdsUbiquityFeeds][Feed Manager Ubiquity Commands]]

---+++Discussion
   * [[VirtuosoOdsUbiquityDiscussion][Discussion Ubiquity Commands]]

---+++Gallery
   * [[VirtuosoOdsUbiquityGallery][Gallery Ubiquity Commands]]


---++Learn More

   * [[VirtuosoOdsUbiquityTutorials][Virtuoso ODS Ubiquity Commands Tutorials]]

---++References

   * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/OAuth][OpenLink's explanation of OAuth]]
   * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtuosoOAuthServer][Virtuoso OAuth server]]
   * [[VirtOAuthControllers][Using OAuth with ODS]]
   * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtOAuth][Virtuoso OAuth Implementation]]
   * [[VirtuosoOdsControllers][ODS Controllers]]      
   * [[VirtODSOAuthQA][Testing Virtuoso OAuth with 3rd Party OAuth Clients]]
   * [[VirtuosoOdsUbiquityTutorialsOAuth][OAuth Ubiquity Tutorial]]
   * [[VirtOAuthTestTool][Virtuoso OAuth Test Tool for ODS Controllers]]
   * [[http://virtuoso.openlinksw.com/wiki/main/Main/VirtOAuthSPARQL][Virtuoso SPARQL OAuth Tutorial]]
   * [[VirtuosoOdsUbiquityTutorials][ODS Ubiquity Tutorials]]
   * [[VirtOAuthExamples][OAuth Applications Authentication examples]]
   * [[http://oauth.net/core/1.0/][OAuth API]]



CategoryODS CategoryOpenSource CategoryWebSite