CD2H gitForager

Unicon/iclicker-sakai-integrate

Name: iclicker-sakai-integrate

Owner: Unicon, Inc.

Description: null

Forked from: azeckoski/iclicker-sakai-integrate

Created: 2016-11-15 20:07:13.0

Updated: 2016-11-17 20:57:07.0

Pushed: 2016-12-22 17:17:05.0

Homepage: https://confluence.sakaiproject.org/display/ICLKR/iClicker+Home

Size: 400

Language: Java

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

i>clicker integrate for Sakai

The >clicker integrate for Sakai plug-in allows instructors to easily synchronize their i>clicker and i>grader data with their campus Sakai server. Learn more about i>clicker products and features from the i>clicker website (http://www.iclicker.com)

Features

Students

Register and manage their remotes and i>clicker GO registrations from within Sakai Instructors
View reports within Sakai showing the status of student registrations in their classes
Download their Sakai roster and registrations directly into i>grader
Upload i>clicker scores directly into Sakai's Gradebook Administrators
Configurable for SSO
View and manage remote registrations

Sakai Compatibility

This version of the plug-in works with Sakai 11 and supports single sign-on. Installations of Sakai older than version 11 are not supported by the i>clicker integrate plug-in.

**Note on EntityBroker**

There will be a reduced number of REST feeds available if not using entitybroker and they will be available
as XML only (JSON is provided by entitybroker). Users will need to upgrade their version of EntityBroker to at least 1.3.5.

If you see an error like this one in the tomcat logs it indicates that you need to upgrade the version of entitybroker ::

    org.springframework.beans.factory.CannotLoadBeanClassException: 
        Error loading class [org.sakaiproject.iclicker.logic.entity.IClickerEntityProvider] 
        for bean with name 'org.sakaiproject.iclicker.logic.entity.IClickerEntityProvider' 
        defined in ServletContext resource [/WEB-INF/components.xml]: 
        problem with class file or dependent class; nested exception is 
        java.lang.NoClassDefFoundError: org/sakaiproject/entitybroker/entityprovider/capabilities/Describeable
    Caused by: java.lang.NoClassDefFoundError: org/sakaiproject/entitybroker/entityprovider/capabilities/Describeable
        at java.lang.ClassLoader.defineClass1(Native Method)

Build

The source code for this plugin is located at https://source.sakaiproject.org/contrib/iclicker/

Build the default version of the app (should work with Sakai 2.6-2.9) by running this command from the location of this README ::

mvn clean install

Install

There are 2 options for installation.

A. Execute the maven sakai deployment command from the location of this README ::

    mvn sakai:deploy

This should copy the war file into the sakai tomcat instance.

B. Manually copy the war file into your servlet container ::

    cp target/iclicker.war {your servlet container war file location}

Configuration

Configuration is stored in the sakai.properties file (normally in {TOMCAT_HOME}/sakai). All the properties are optional. If they are not included the default values are used as shown.

## i>clicker Tool configuration
# the iclicker tool title in the workspaces, DEFAULT: i>clicker
#iclicker.workspace.title={title}
# the email addresses to send notifications to on failures, DEFAULT: system admin email (e.g. admin@server.edu)
#iclicker.notify.emails={email (comma separated list)}
# disable the alternate remote id handling, DEFAULT: false
#iclicker.turn.off.alternate.remote.id={true|false}
# Control the default max limit of 100 courses to fetch from Sakai
# WARNING: making this number too large could cause performance issues
#iclicker.max.courses=100
# enable SSO support by setting a shared key (must be at least 10 chars long)
#iclicker.sso.shared.key={key string}
## Domain configuration
# the iclicker domain URL, DEFAULT: the Sakai server URL (e.g. http://your.server.edu)
#iclicker.domainurl={server url}

NOTE on Single Sign-On::

The single sign-on support allows Sakai installations with CAS, Shib, or other single sign-on (SSO)
systems to still authenticate from the i>clicker client to the Sakai LMS without using normal username
and password authentication (which usually will not work when using an SSO system). Once the SSO shared key
is set, the normal username and password authentication will stop working and only the SSO authentication
will function.
Admins will need to ensure the shared key is set to the same value in both the Sakai config and the i>clicker
admin setup and is at least 10 chars long.

Usage

Start Sakai and you will see the new app appear as a tool which can be added to your site. This tool should be added to the workspace template for all Sakai users so it is accessible to everyone in the institution.

Adding the plug-in as a tool in a site:

1. Log in to Sakai and enter the site where you want to add the i>clicker plug-in
2. Click on Site Info on the left
3. Click on Edit Tools (or just Tools in older versions)
4. Check the box next to the "i>clicker" tool in the list and click Continue
5. Click Continue to confirm, the tool is now installed in your site and ready for use

Configuring Sakai so the plug-in is added to all new workspaces (adding to the workspace template):

1. Log in to Sakai as admin and enter the administrator site
2. Click on the Sites tool
3. Click on the !user site
4. Click on the Pages button at the bottom
5. Click on New Page at the top
6. Enter a title of i>clicker (or whatever you want to call it) and click the Tools button
7. Click the New Tool link at the top
8. Select the i>clicker (sakai.iclicker) tool from the list
9. Click the Save button at the bottom to complete the template update

Adding the plug-in to all existing workspaces (steps are same to remove from all):

1. Log in to Sakai as admin and enter any site which has the i>clicker plug-in installed
2. Click on the Admin Tools link
3. Click the button in the upper right to install the tool in all workspaces (may take awhile)
4. The tool will now be added to all workspaces

REST data feeds

The REST feeds vary depending on the version of Sakai being used.

Sakai version 2.5 or older

There is a reduced set of REST feeds available for users on Sakai 2.5 or older. These feeds are sufficient
for i>clicker to operate but are unlikely to be very beneficial to institutions who want to create
mashups or consume data from the i>clicker system. The feeds are documented and located at ::

    http://{SAKAI_SERVER_HOSTNAME}/iclicker/rest

Sakai version 2.6 or newer

There is a complete set of REST data feeds for interacting with the i>clicker data so that institutions can
automate or control the i>clicker registrations and data as desired. The feeds are also used by the
i>clicker tools. The feeds are documented and located at ::

    http://{SAKAI_SERVER_HOSTNAME}/direct/iclicker/describe

The feeds require the `Sakai EntityBroker System <http://confluence.sakaiproject.org/x/E4D3>`_
be installed with your Sakai installation. If you are using Sakai version 2.6.0 or higher then everything you need is already
installed. If not you will need to install the current version (1.3.5+) of entitybroker in your Sakai system. 
The source for released versions can be found at https://source.sakaiproject.org/svn/entitybroker/tags/. 
See the `Sakai EntityBroker System <http://confluence.sakaiproject.org/x/E4D3>`_ page for installation
instructions (it is the same process as `Installing Sakai Contrib Tools <http://confluence.sakaiproject.org/x/JwA5Ag>`_).

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.