Integration

Table of Contents

Related content

WebSynergy (Community Equity Documentation) Labels: integration, websynergy
Plugin V 2.0 specification (Community Equity Documentation) Labels: plugin, integration, specification
Integration (Community Equity Documentation) Labels: integration
Plugin Checklist (Community Equity Documentation) Labels: plugin, integration
Web Space Server + Liferay Integration (Community Equity Documentation) Labels: integration, webspace, liferay
Status.net Plugin (Community Equity Documentation) Labels: plugin, integration, laconica, status_net, activity_streams

Overview

The main functions of the Community Equity service are:
Input -> Equity calculation -> Output

  1. Input: collecting data (People, URL's and social activities)
  2. Equity Calculation
  3. Output: Community Equity calculated values for URLs, Persons and Tags

The Community Equity System (CEQ) is designed for easy integration into any web venues

Input requirements

  1. Collect unique URL's which can represent any content type like blog, wiki, forum etc.
  2. Collect all related meta data of an URL like title, description, access control, tags, author, ratings etc.
  3. Collect users of a web venue
  4. Collect group memberships and Roles (read,write,admin)
  5. Collect all social activities of a website like add, edit, delete, tag, view, rate etc.)

Output requirements

  1. Display Community Equity  enriched data on any website using widgets (as example: Top Contributors, Information listing etc.)
  2. Output Community Equity enriched data   (as example: RSS/ATOM feed, web services)

Integration options

Full Size
A Gliffy Diagram named: CeQ integration
Method 
Programing Effort
Requirement
Input Feed none
Input 1. (2.)
Widgets (CEQ Widgets) Minor programming
Input 1. (2.) Output 1.
Web Services (CEQ Platform ) Web services  programming
Input 1. 2. 3. 4. Output  3. 4.
Enterprise Java Beans
Java EJB skills
Input 1. 2. 3. 4.  Output 2. 3. 4.

Input Feed

The CeQ input feed service allows to read feeds from any  website and store the related information and metadata in the CeQ foundation service.

Full Size
A Gliffy Diagram named: input_feed_UI

Widgets

The standard CeQ widgets can be integrated into any web venue by embedding simple JavaScript code into a HTML page or a HTML template

Example
<html>
  <head>
    <title>Commenting Test Page</title>
    <meta http-equiv="Content-Type" content="text/html; charset=windows-1250">
    <link rel="stylesheet" href="/ceq-widget/css_global/ceq_default.css" type="text/css" media="all"/>
    <link rel="stylesheet" type="text/css" href="css/ceq_rating.css">
    <link rel="stylesheet" type="text/css" href="/ceq-widget/css_global/overlay-minimal.css"/>

    <!--  Base libraries   -->
    <script src="/ceq-widget/js/jquery/jquery.js"></script>
    <script src="/ceq-widget/js/jquery/jquery.template.js"></script>
    <script src="/ceq-widget/js/openajax.js"></script>
    <script src="/ceq-widget/js/jquery/jquery.jsonp-1.0.4.min.js"></script>
    <script src="/ceq-widget/js/jquery.overlay-1.0.1.min.js"></script>
    <script src="/ceq-widget/js/jquery.qtip-1.0.0-rc2.min.js"></script>
    <script src="/ceq-widget/ceq_listing_information/js/time_renderer.js"></script>

     <!--   Widget libraries   -->
    <script src="/ceq-widget/ceq_comment/js/comment_templates.js"></script>
    <script src="/ceq-widget/ceq_comment/js/jquery.comment.js"></script>
     <script src="/ceq-widget/ceq_listing_activity/js/activity_log_templates.js"></script>
    <script src="/ceq-widget/ceq_listing_activity/js/jquery.activity_log.js"></script>
  </head>
  <body>
     <!--   Widget placeholder   -->
    <div id="commentwidgetarea" style="width: 500px"> </div>
    <script type="text/javascript">
        var WIDGET_RESSOURCE_PATH = '/ceq-widget';
        $(document).ready(function() {
            var comment = new $.Commenting();
            comment.setURL(location.href);
            comment.enableViewcount();
            comment.loadRating();
            comment.deploy('commentwidgetarea');
        });
    </script>
  </body>
</html>

Following widgets are currently available

Widgets
Top Tag Country Widget (Community Equity Documentation) Labels: communityequity, widget
My Community Equity Widget (Community Equity Documentation) Labels: widget, community_equity
Information Listing Widget (Community Equity Documentation) Labels: widget, listing
Top Tag Equity People Widget (Community Equity Documentation) Labels: widget, community_equity, communityequity
Activity Listing Widget (Community Equity Documentation) Labels: widget, listing
Top Tag Equity Information Widget (Community Equity Documentation) Labels: widget, community_equity, communityequity
Top Tag Community Widget (Community Equity Documentation) Labels: communityequity, widget
Tag Cloud Widget (Community Equity Documentation) Labels: widget, tagging
Rating & Commenting Widget (Community Equity Documentation) Labels: widget, rating, comment, activity

Web Services

Specific integration can be done by using the CeQ web services.

Following web services are currently available

Web services
PersonListing WS Jersey API (Community Equity Documentation) Labels: webservice, listing, person
Community Equity Top lists WS (Community Equity Documentation) Labels: webservice, equity
Application Management WS Jersey API (Community Equity Documentation) Labels: webservice, other
EJB to Listings WS - API Suggestion (Community Equity Documentation) Labels: webservice, listing
Community Equity WS API (Community Equity Documentation) Labels: webservice, equity
InformationTags WS Jersey API (Community Equity Documentation) Labels: tagging, webservice
Feed input (Community Equity Documentation) Labels: feed, webservice
InformationRating WS Jersey API (Community Equity Documentation) Labels: webservice, rating
Tag Suggest WS API (Community Equity Documentation) Labels: tagging, webservice
Metadata Analysis WS API (Community Equity Documentation) Labels: webservice, metadata, aperture, tagging
InformationListing WS Jersey API (Community Equity Documentation) Labels: webservice, listing
Administration (Community Equity Documentation) Labels: webservice, administration, communityequity
UserProfile WS Jersey API (Community Equity Documentation) Labels: webservice, other
Feed output Webservice API (Community Equity Documentation) Labels: feed, webservice
InformationCommenting WS Jersey API (Community Equity Documentation) Labels: webservice, rating, commenting
Information Type Management WS Jersey API (Community Equity Documentation) Labels: webservice, other
ActivityListing WS Jersey API (Community Equity Documentation) Labels: webservice, activity, listing
Tag Cloud WS Jersey API (Community Equity Documentation) Labels: tagging, webservice
Tag WS Jersey API (Community Equity Documentation) Labels: webservice, other

Plugin

Consult the plugin guide for details

For a full integration of a web venue or site it is recommended to write a plugin to capture all social events of the respective web venue.
There are two proposed models

Online Synchronization

The events from the target web venue are synchronized in real time with the corresponding CeQ activities.

Offline Synchronization

The events from the target web venue are synchronized in an offline mode with the corresponding CeQ activities.

Enterprise Java Beans (EJB)

The EJB API's can be used to integrated the Community Equity Services with other EJB frameworks

Activities table

Enclosed table defines the activities used in the CeQ services and the mapping to the respective integration service

Activity
Input Feed
Rating Widget
Plugin
EJB
Created

Viewed/Downloaded
 
 
Rated
 
Commented
 
Content Updated
   
Meta data edited
   
Tagged
   
Deleted
   
Clone
   
Meta data Viewed
   
Deleted
   
Main author changed
   
add /delete user
   
add/delete group
   

Labels

integration integration Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Sign up or Log in to add a comment or watch this page.


The individuals who post here are part of the extended Sun Microsystems community and they might not be employed or in any way formally affiliated with Sun Microsystems. The opinions expressed here are their own, are not necessarily reviewed in advance by anyone but the individual authors, and neither Sun nor any other party necessarily agrees with them.

Copyright 1994-2009 Sun Microsystems, Inc.
Powered by Atlassian Confluence
Sun Guidelines on Public Discourse Privacy Policy Terms of Use Trademarks Site Map Employment Investor Relations Contact