Sakai 27 Manual

1.01 06/13/08 J. Brown Revised section 2.1.27 Section Settings
1.02 07/31/08 J. Brown Revised section 2.1.28 Turning Categories On/Off (applies to CLE version 2.6.1)
1.03 07/10/09 S. Keesler Updates for 2.6 CLE
1.04 12/28/10 J. Mezzanotte Updates for 2.7 CLE
Copyright © 2011 rSmart. Members of the rSmart Support Network (RSN) may reproduce, repurpose, and create derivative works from this document at their discretion. They may also share this document and all derivative works with other organizations in the rSmart Support Network. All other rights reserved.
8/9/2019 Sakai 27 Manual
ADDITIONAL SOURCES OF INFORMATION ......................................................................................... 2
INSTALLING THE OPEN SOURCE RSMART CLE ................................................................................ 2
CLE INFRASTRUCTURE (OVERVIEW) ............................................................................................... 2
2 Advanced Configuration ............................................................................. 4
SAKAI.PROPERTIES AND LOCAL.PROPERTIES ................................................................................... 4
2.2
2.3
2.4 Configuring Turnitin integration for Assignments tool ............................................... 5
2.5 Sending group assignments to the Gradebook tool ................................................. 6
Calendar Summary Tool....................................................................................................... 6
Content Management (Resources) ..................................................................................... 7
2.9 Site quota .................................................................................................................. 8
2.12
Customizer Tool .................................................................................................................... 9
Database Management ....................................................................................................... 10
Elluminate Integration (Live Virtual Classroom Tool) ..................................................... 11
2.17 Elluminate settings .................................................................................................. 11
Email Archive Tool .............................................................................................................. 12
Forums Tool ........................................................................................................................ 12
Gradebook Tool .................................................................................................................. 13
Gradebook2 Tool ................................................................................................................ 13
2.24
2.25 Disabling Help links ................................................................................................ 14
2.26
2.28 Turn on the experimental Lessons (Melete)/Resources integration feature .......... 14
Membership Tool ................................................................................................................ 14
2.29 Disable the “unjoin” link in the Membership tool ..................................................... 15
Messages Tool .................................................................................................................... 15
News Tool ............................................................................................................................ 15
OSP ....................................................................................................................................... 16
2.34 Reviewer access to student matrices in all groups................................................. 16
Page Order Helper Tool ...................................................................................................... 16
2.35 Renaming tools with Page Order Helper tool ......................................................... 16
Password Reset .................................................................................................................. 16
Portal .................................................................................................................................... 17
2.39
2.40
Sections Management ........................................................................................................ 18
Server ................................................................................................................................... 19
Remove user IDs and email addresses from site roster ........................................ 20
Site Statistics Tool .............................................................................................................. 20
Site/User Management ....................................................................................................... 20
2.50 Stealthing/unstealthing tools ................................................................................... 21
2.52
Assigning “from” address for email notification ....................................................... 22 2.53 Disabling e-mail notification for guest users .......................................................... 22
2.54 Users present.......................................................................................................... 23
2.59 Specifying site IDs for master sites ........................................................................ 24
2.60 Specifying a site ID for a single master site ............................................................ 25
2.61 Enable detailed reporting for changed members and courses ............................... 25
2.62 Allow additional information for SIS courses file..................................................... 26
2.63 Allow for additional course properties ..................................................................... 26
2.64
2.66
2.68
2.69
2.70 Remove existing enrollments .................................................................................. 29
2.71 Assign “active” or “inactive” status to site members ............................................... 29
Term (Semester) Settings .................................................................................................. 29
2.72 Term settings .......................................................................................................... 29
2.73 Email server settings .............................................................................................. 32
2.74
2.75
2.76
SKINS AND BRANDING .................................................................................................................. 33
GETTING USERS INTO THE CLE AND ADDING USERS INTO COURSES ............................................... 34
Getting users into the CLE ............................................................................................... 35
Getting users into their courses ........................................................................................ 36
3
CLE FUNCTIONAL ADMINISTRATOR VS. SYSTEM ADMINISTRATOR .................................................. 37
WHAT MAKES A USER A CLE FUNCTIONAL ADMINISTRATOR? ......................................................... 37
ADMINISTRATION WORKSPACE TOOL OVERVIEW ........................................................................... 37
COMMON MANAGEMENT TASKS AND CONFIGURABLE COMPONENTS IN THE CLE ............................ 40
Creating CLE Functional Administrators ......................................................................... 40
3.1 How do I create a CLE Functional Administrator user? ......................................... 40
3.2
How do I make a current user a CLE Functional Administrator? ........................... 41
3.3
How do I create different levels of CLE Functional Administrator? ........................ 41
Installing the CLE ................................................................................................................ 41
3.4 How do I install the rSmart Sakai CLE 2.7? ........................................................... 41
3.5 How do I upgrade to CLE 2.7 from an earlier version? .......................................... 42
Managing Realms, Roles, and Permissions..................................................................... 42
3.6 Where can I view instructional videos on realms, roles, and permissions in the CLE? ................................................................................................................. 42
3.7 What is a site realm? Why would I ever need to edit one? How do I edit a site realm? .............................................................................................................. 42
3.8 How do I change the default roles for course, project and portfolio sites? ............. 44
3.9
How do I set/change default permissions for course, project and portfolio roles? . 47
3.10

3.11 Site owners are not able to edit permissions for some tools within their sites.
The checkboxes are gone and there is a black checkmark in their place. What is causing this? ....................................................................................................... 49
3.12 How do I change default permissions for a user account type? ............................. 49
3.13 What is the site.upd permission? ............................................................................ 50
3.14 How should I grant users permission to grade assessments in the Tests and Quizzes tool? .......................................................................................................... 51
3.15 How should I grant TAs permission to grade by sections in the Gradebook and Gradebook2 tools? ................................................................................................. 51
3.16
How do I set permissions for the Forums tool? ...................................................... 51
Managing Users .................................................................................................................. 52
3.17 How do I create a new user account type? ............................................................ 52
3.18 How do I change a user’s account type? ................................................................ 53
3.19 How do I manually add a user into the CLE? ......................................................... 54
3.20
How do I create a "junior admin" user? .................................................................. 54 3.21 How can I “decommission” a junior admin? ............................................................ 57
3.22 How does the Super User tool work? ..................................................................... 57
3.23 How can I give non-admins access to the Super User tool? .................................. 57
Managing My Workspace Sites ......................................................................................... 59
3.24 What happens if I delete a user's My Workspace? ................................................ 59
3.25 How do I reset the existing user My Workspaces? ................................................. 60
3.26
How do I change the My Workspace Information area? ........................................ 60
3.27
How do I change the default toolset for a user's My Workspace? ......................... 61
3.28 How can I add tools to all existing My Workspace sites in the CLE? ..................... 61
http://slidepdf.com/reader/full/sakai-27-manual 6/109
3.29 I am a CLE Functional Administrator. Why don't I have aggregated calendar and announcement items in my "My Workspace" like all the other users? ................... 62
3.30

How do I create a Message of the Day? ................................................................ 62
Managing Course, Project, and Portfolio Sites................................................................ 62

3.33 How do I change the title of a course site? (two methods) ..................................... 63
3.34 How can I change the text for a particular page in the CLE? (Message Bundle editor) ......................................................................................... 63
3.35 How do I create a site template? ............................................................................ 64
3.36 How do I provide a “master site,” and make sure the CLE uses this site to create new sites when it accesses the Student Information System (SIS)? ..................... 66
3.37
3.38
3.39
How do I change and manage skins for a course, project, or portfolio site? .......... 68
Managing Tools ................................................................................................................... 70
3.40 How do I add a stealthed tool to a site? ................................................................. 70
3.41 How do I turn on the Page Order Helper tool? ....................................................... 71
Managing Content ............................................................................................................... 71
3.42 I need to upload a large file into Resources, but the system indicates the file is too big for a single upload action. Is there a way around this? ..................... 71
3.43 How can I change the WebDAV instructions that appear to users?....................... 72

Online Help .......................................................................................................................... 73
Reset Password .................................................................................................................. 73
3.47 How do I enable the “Forgot Password” feature in the CLE? ................................. 73
Site Statistics Admin Tool.................................................................................................. 74
3.48
How do I add and use the Site Statistics Admin tool? ............................................ 74 3.49 What activities does the Site Statistics tool track? ................................................. 76
Integration with External Systems and Services ............................................................. 76
3.50 How do I configure LDAP or Active Directory? ....................................................... 76
3.51
How do I integrate external applications with the CLE? ......................................... 76
4 Tool Definitions and Tool IDs ................................................................... 77
5 Permissions in CLE 2.7 ............................................................................. 87
Default OOTB Permissions .............................................................................................. 87
Forums Tool Permissions ............................................................................................... 101
The rSmart Sakai CLE Administrator Guide, v. 2.7
1 Introduction The rSmart Sakai Collaboration and Learning Environment (CLE) is a unique environment that supports online activities for teaching, learning, projects, portfolios, clubs, organizations and more. The CLE is organized into different types of sites that
enable users to take classes; work together on research, course and other collaborative projects; and build their own electronic portfolios to share with anyone online. The purpose of the rSmart Sakai CLE Administrator Guide is to facilitate a thorough understanding of management tasks within the CLE so that you—a CLE Functional Administrator or System Administrator—can maintain a successful environment at your institution. CLE management and administration tasks fall into two categories:
• System Administrator tasks Management of configuration files and settings on the server
• CLE Functional Administrator tasks Configuration management and application of administration tools within the CLE
user interface
System Administrator tasks on the server If your school attended a configuration requirements session, rSmart has implemented configuration settings for your instance based on your institution’s specifications. In case you need to change some configuration settings, this guide includes instructions and examples of the CLE configuration files located on the server.
A system administrator must access these configuration files to make changes. If you are responsible for maintaining configuration files, this guide assumes that you have the technical expertise to perform these tasks given minimal guidance. If your institution’s CLE is hosted, rSmart is responsible for these files. In this case, please contact rSmart
for assistance when you need to make changes.
CLE Functional Administrator tasks within the CLE user interface This guide provides instructions and examples on using the Administration Workspace within the CLE to complete CLE management tasks. This guide assumes that you have a basic functional understanding of the rSmart Sakai CLE and are familiar with CLE navigation, sites, and tools.
Supported Browser/OS Combinations for Users Supported browser/OS combinations for the rSmart Sakai CLE include:
• Microsoft Windows o Internet Explorer 6.0 and later o Netscape 7.1 and later o Mozilla Firefox 1.5 and all subsequent versions released as of April 9,
2008 (2.0.0.13, 3.0.x)
• Linux o Netscape 7.1 and later o Mozilla Firefox 1.5 or later
• Mac OS X (10.x.x)
The rSmart Sakai CLE Administrator Guide, v. 2.7 2
o Netscape 7.1 and later o Mozilla Firefox 1.5 or later
Note: You will find hardware and environment requirements for the CLE server within the installation instructions located at http://rsn.rsmart.com .
Additional Sources of Information The rSmart Support Network, or RSN, is located at http://rsn.rsmart.com. There you can download additional technical and functional documentation, learn more about the CLE from Knowledge Base articles, view instructional videos and submit support cases. You can find general information about the community version of Sakai at the following locations:
• Sakai community homepage: http://www.sakaiproject.org/
• Sakai email lists: http://collab.sakaiproject.org/mailman/listinfo
• Sakai Confluence: http://confluence.sakaiproject.org • Sakai JIRA (bug tracking): http://jira.sakaiproject.org/jira
Note: The configurable components that exist in the community version of Sakai may differ from those in the CLE. Consult with rSmart before implementing any suggestions you receive from the community email lists or from the community Confluence pages.
Installing the Open Source rSmart CLE Visit our download registration page for installation instructions and the CLE download:
http://www.rsmart.com/sakai/try-it/download
The free download from the rSmart website is a binary distribution that is easy to install by completing a series of screens that collect and validate preferences. The downloadable CLE supports a GUI or console installation on Linux and Windows platforms.
The out-of-the-box version is pre-configured to be usable immediately (with the exception of the e-portfolio tools, which require situation analysis and planning). Most clients apply a minimal amount of branding to make the package look like it belongs to their institution.
Additionally, source code is available online at rsmart.com/cle-releases.
CLE Infrastructure (Overview) Now that the CLE is installed on your server, a tomcat.home directory exists on your server. This is the directory from which the CLE is running. It probably won't be called “tomcat.home,” as your system administrator may have decided to name it something else, such as “CLE” or “CLE27” or “apache-tomcat.” Usually the system administrator installing the application will choose where to place and how to name the tomcat.home
tomcat .
What is Tomcat? Apache’s Tomcat is the application server that starts and runs the Sakai CLE on your server. If you start Tomcat, you are starting the Sakai CLE. If you stop Tomcat, you stop Sakai, and users will not be able to access it.
What is the tomcat.home directory?
The tomcat.home directory is the directory on your server in which Tomcat exists. The
tomcat.home directory and its subdirectories contain all the files the Sakai CLE needs in order to run successfully. This includes configuration files, registration files, files with code in them, etc. Sometimes, a system administrator may need to access some files in the tomcat.home directory and make changes to them. Please proceed into this directory with caution.
The files within the tomcat.home directory tell Tomcat (the application server) what to do
with Sakai upon startup, including how certain things should display and which functionalcomponents are configured.
There are a few reasons to stop/start Tomcat:
• You may elect to automatically stop and start Tomcat on a regular basis (once per week is recommended).
• Any time you make changes to configuration settings within the file system, you must restart Tomcat.
How to stop and start Tomcat Usually, a system administrator will write a script to stop and start Tomcat easily
whenever necessary. A sample script (cle.sh) for Linux is included with the rSmart CLE.Here are instructions on how to do it manually.
If you are using Linux, complete these steps: • Determine which user the Tomcat server is running as and log in as that user. • Execute the shutdown.sh script in tomcat.home/bin to stop Tomcat.
• Tail catalina.out in /logs to make sure you’ve successfully stopped Tomcat before initiating the next action.
• Execute the startup.sh script in tomcat.home/bin to start Tomcat.
If you are using Windows and you are not running Tomcat as a windows service, complete these steps:
• Execute the shutdown.bat script in tomcat.home\bin to stop Tomcat. • Execute startup.bat in tomcat.home\bin to start Tomcat.
2 Advanced Configuration rSmart has implemented many of the following rSmart Sakai CLE settings according to your institution’s specifications. Changes to these settings are not required unless your institution’s specifications change.
Note: Be sure to archive these configuration files once you have modified them so that you have copies to move back into the CLE after upgrades.
This section of the guide includes tasks that must be performed by a Systems Administrator because they must be completed on the CLE server. Hosted customers do not have access to the server, so if your institution is hosted, you must contact rSmart or your hosting provider to make changes.
sakai.properties and local.properties If you decide to change any configuration components, it is important to become familiar
with the settings within the sakai.properties and local.properties files. A system administrator can make many configuration changes to the CLE using the sakai.properties and local.properties files. The values that exist within these two files govern everything from configuring your database to adding/removing functional components to and from the user interface.
The property files are located here: tomcat.home/sakai
Note: After editing either of these configuration files, you must restart Tomcat for any changes to take effect.
• sakai. properties – This file stores the default configuration settings for your CLE environment.
• local.properties – This file stores custom configuration settings for your CLE environment.
The same properties can exist in local.properties as in sakai.properties. If the same
setting exists in both files, the value in local.properties will OVERRIDE the value in
sakai.properties.
You can edit these .properties files with a text editor.
A complete guide to the configuration values in sakai.properties and local.properties is available online at: http://bugs.sakaiproject.org/confluence/display/DOC/Sakai+Properties+Reference
Note: Property settings that are unique to the rSmart distribution of Sakai will not be listed on this website.
Assignments Tool
2.1 Disable Assignments tool notification email feature Determines whether the feature that emails instructors submission notifications is available in the installation. To disable this feature across the entire CLE, add this setting to local.properties.
assignment.instructor.notifications=false
2.2 Assignments tool notification defaults This setting determines the default selected option for assignment email notifications (if enabled).
assignment.instructor.notifications.default=digest
The possible values are:
• digest--by default, instructors/site owners will receive one daily email for all assignment submissions that occurred that day. The instructor or site owner can change this default within each assignment.
• each--by default, instructors/site owners will receive an email for each assignment submitted by a student. The instructor or site owner can change this default within each assignment.
• none--by default, instructors/site owners do not receive an email notification when a student submits an assignment online. The instructor
or site owner can change this default within each assignment.
Note: This setting is merely the default selected option. Instructors can choose other options for email notification in the interface during the assignment creation process.
2.3 Assignmments tool confirmation emails This setting determines whether or not a confirmation email will be sent to the student when they submit their assignment. If set to true, an email is sent to the student whenever they click the submit button on the Submit Assignment page. To enable this feature, add this setting to local.properties.
assignment.submission.confirmation.email=true
2.4 Configuring Turnitin integration for Assignments tool The following settings are necessary for configuring the CLE for integration with the Turnitin service, which instructors access from within the Assignments tool. If your institution has a subscription to this service, instructors may opt to have assignment submissions sent to Turnitin and receive reports on the originality of the submissions. Instructors may also opt to let students view the reports.
If rSmart hosts your instance of the CLE, contact rSmart support and we'll configure the CLE for this integration. (Note: there is a fee for this service). If you host your own instance, a System Administrator must add the settings.
assignment.useContentReview=true
turnitin.aid=
#The sub account ID to which Sakai will submit content
turnitin.said=
#The TurnitIn API password for your Institution. If you don't
have one speak to your TurnitIn rep to have one set
turnitin.secretKey=
#The email of a default instructor for the API to use
turnitin.defaultInstructorEmail=
turnitin.defaultInstructorFName=
turnitin.defaultInstructorLName=
turnitin.defaultInstructorPassword=
sets up
#A default assignment name to use if none is specified
turnitin.defaultAssignId=
#A default assignment name to use if none is specified
turnitin.defaultAssignmentName=
2.5 Sending group assignments to the Gradebook tool Instructors or TA’s can create assignments within a course and release these assignments to specific groups or sections within the course. If this setting is set to true,
then instructors will also be able to send these group assignments to the Gradebook tool.
[email protected].
2.6 Default view for the Calendar Summary tool You can set the default view (currently set to month) for the Calendar Summary tool using this setting. Add this setting to local.properties. The possible values are week and month.
calendarSummary.viewMode=week
2.7 External content storage
View the following settings in local.properties to see where uploaded content from the Melete (Lessons) and Resources tool is stored:
[email protected] =
[email protected] =
fs1,fs2,fs3,fs4,fs5,fs6,fs7,fs8,fs9,fs10,fs11,fs12,fs13,fs14,fs15
,fs16
melete.packagingDir=<path to new
melete.packagingscormdir=<path to new
directory>/files/melete/uploads/scorm
2.8 Content upload limits You can set a limit to control the size of the content users upload to the Resources tool. This setting exists in sakai.properties and you can change it by setting a new value in
local.properties.
content.upload.max=20
• This limit is not enforced when uploading files via WebDAV.
• This limit applies to all files in a single upload action.
• This limit applies to users in all roles.
• This limit applies to all other tools that include an “add attachment” button.
2.9 Site quota Site Quota puts a limit on the total size of all resources in a site. This means that all course, project, portfolio and MyWorkspace sites have the SAME amount of storage space (default is 1GB or 1048576 kilobytes). You can change this setting by changing the numeric value 1048576 to a number of your choice (in kilobytes) in local.properties:
[email protected]=1048
576
Note: A CLE Functional Administrator may change the Site Size Quota for an individual site via the user interface.
2.10 Site type-specific quotas This setting allows the quota for each site type to be set independently, allowing all course sites to have default quotas different than project and portfolio sites.
content.quota.{site type}= {quota in kilobytes}
content.quota.project= {quota in kilobytes}
content.quota.portfolio= {quota in kilobytes}
content.quota.myworkspacebuserdguest= {quota in kilobytes}
content.quota.myworkspacebuserdregistered= {quota in kilobytes}
content.quota.myworkspacebuserdmaintain= {quota in kilobytes}
2.11 Enabling the “Show other sites” feature This setting enables the “Show Other Sites” link in the list mode of the Resources tool, the resources helper tool and the dropbox tool. By default, the CLE comes with the “Show other sites” feature enabled for the resources tool and the resources helper tool, but NOT for the dropbox. Enabling this feature allows users to copy files from resources
folders from other sites in the CLE and paste them into other folders or dropboxes. You can enable or disable each of these features in local.properties.
resources.show_all_collections.tool=true
resources.show_all_collections.helper=true
resources.show_all_collections.dropbox=true
2.12 Copyright type This setting configures copyright options that appear when adding/creating a file using
the Resources tool. These settings exist in sakai.properties and you can change the
settings by creating and editing the following values in local.properties.
# the copyright options for the resources tool
copyrighttype.count=6
copyrighttype.2=I hold copyright.
copyrighttype.4=I have obtained permission to use this material.
copyrighttype.5=Copyright status is not yet determined.
copyrighttype.6=Use copyright below.
copyrighttype.own=I hold copyright.
copyrighttype.new=Use copyright below.
default.copyright.alert=false
fairuse.url=http://fairuse.stanford.edu
newcopyrightinput=true
2.13 Enabling conditional release feature The following property, if set to “true,” activates the “conditional release” feature for the Resources tool. This feature lets instructors opt to have a resource become available to students only if a certain condition has been met for an item in the Gradebook tool.
conditions.service.enabled=true
By default, this property is set to “false.” You may configure this setting in local.properties.
Warning: We strongly recommend that you do NOT activate this feature, which was first
included in version 2.7.0 of the Sakai CLE. Users have experienced several issues withit in production, and through our testing, we have determined that many issues still exist. The feature is currently not activated in the default, out-of-the-box (OOTB) configuration of the CLE, and it has limited support.
Customizer Tool
2.14 rSmart Customizer tool options (destructive mode settings)
Note: These instructions assume you are familiar with the rSmart Sakai CLE
configuration spreadsheet and how it is used to configure the Sakai CLE.
The rSmart Customizer tool has four property settings for restarting Tomcat in "destructive mode." By restarting Tomcat in "destructive mode," you can:
• Immediately reset realm templates, permissions, roles, user workspace sites, user workspace permissions, tool names, categories and tool placement back to the default rSmart CLE configuration.
• Prepare your instance for complete reconfiguration—i.e., prepare your instance to load and process the configuration spreadsheet in such a way that the
spreadsheet completely resets some or ALL of your CLE configuration.
Warning: The options listed here are very dangerous, and you should use extreme caution when adjusting these settings on an existing production instance. In fact, we strongly suggest that you not use these options without first consulting rSmart support.
The four “destructive mode” settings are as follows.
1. This setting, if set to true, will reload default site template, realm template, tool & category info from the source code:
[email protected]=false
2. This setting, if set to true, will allow the configuration spreadsheet to overwrite
realms, roles, tools & categories:
.target=false
3. This setting, if set to true, will reset/reconfigure !user templates (the user MyWorkspace templates):
applySiteOptions@org.theospi.portfolio.admin.intf.SakaiIntegratio
nService.rsmart=false
4. This setting, if set to true, will cause only the realm info to be reset upon restart
and when the configuration spreadsheet is processed:
realm.reset=false
Database Management
2.15 Database settings Review the following example to become familiar with the database settings in your local.properties file. This example is for an institution using a MySQL database. rSmart has already configured these database values during the initial implementation. These
settings are not often changed.
[email protected]=user
[email protected]=pwd
[email protected]=mysql
[email protected]=com.mysql.jdbc.Driver
hibernate.dialect=org.hibernate.dialect.MySQLDialect
[email protected]=TRANSA CTION_READ_COMMITTED
[email protected]=jdbc:mysql://localhost:3306/cle25?us
4096&prepStmtCacheLimit=4096
2.16 Database connection maximum This setting defines the maximum number of active database connections (set to -1 for unlimited). You should coordinate with your DBA to make sure your database can handle the number specified. This setting may be added to local.properties.
Elluminate Integration (Live Virtual Classroom Tool)
2.17 Elluminate settings The Live Virtual Classroom tool allows teachers and students to manage and view Elluminate Live ! event schedules as well as attend Elluminate Live ! events from within Sakai. These settings exist in local.properties and can be changed to your institution- specific values. Your institution must have an Elluminate account in order to use the Live Virtual Classroom tool. For more information, see http://www.elluminate.com
# ip address or dns name of the machine where the virtual
classroom server is running
virtual_classroom.server.port=8888
# the name of the adapter in elluminate which the CLE talks to
virtual_classroom.server.adapter=default
# default capacity to use when creating a new virtual classroom
session
# specifies the maximum number of concurrent users allowed by the
virtual classroom server across the whole system
virtual_classroom.server.max_capacity=10
# specifies the time (in minutes) prior to the scheduled start
time of the virtual classroom session during which a user can
join. The options are 0, 15, 30, 45, and 60 minutes
virtual_classroom.server.grace_period=15
elluminate.sys.user=serversupport elluminate.sys.pass=elluminate
Email Configuration
2.18 Email configuration The rSmart CLE can be configured for both incoming and outgoing mail.
To review the outgoing mail configuration, see the following in local.properties:
# SMTP server for outgoing email
[email protected]=some.smtp.org (where
some.smtp.org is your outgoing mail server)
# set to false to allow email to be sent, otherwise it's logged
and not sent
To review the incoming mail configuration, see the following in local.properties:
# dns addresses used for incoming email
smtp.dns.1 = 255.255.255.1
smtp.dns.2 = 255.255.255.2
# SMTP port on which our SMTP server runs. Default is 25.
#Recommend running on 8025, and using a standard mailer on 25 to
forward mail to Sakai.
smtp.port = 25
# flag to enable or disable our SMTP server for incoming email
(true | false)
smtp.enabled = true
2.19 Notification email reply-to addresses Many events (posting announcements, updating resources, etc.) can initiate an email to users in the worksite. By default, all of this email comes from an email address to which recipients cannot respond. The CLE may be configured to send email from the user initiating the email. This setting exists in local.properties.
emailFromReplyable@org.sakaiproject.event.api.NotificationService
=true
Email Archive Tool
2.20 Set Email Archive search threshold This setting sets the maximum number of emails in an email archive before the search feature is disabled. Search through the email archive may affect server performance when searching through large numbers of messages. The default value is 2500 messages, but may be altered in local.properties.
sakai.mailbox.search-threshold=2500
Forums Tool
2.21 Default threaded message view This setting (if “true” ) will display a threaded view for posts within the Forums tool. This setting can be set or changed in local.properties.
mc.threadedview=true
Gradebook Tool
2.22 Gradebook letter grades This setting turns off the letter grade option in the Gradebook tool.
gradebook_enable_letter_grade=false
Gradebook2 Tool
2.23 Gradebook2 default configuration The following settings are for the default configuration of the Gradebook2 tool. Make
changes to these settings in local.properties.
# gradebook2 settings
#gb2.help.url=http://yourschool.edu/Gradebook2Documents.html
gb2.enabled.grade.types=points,percentages,letters
gb2.gradable.role.names=Student,Participant,
2.24 Exporting grades in Gradebook2 The following settings are for enabling the export of grades in Gradebook2 to an
institution’s external grade reporting system. Add these settings to local.properties.
Note: If you plan to export grades to an external reporting system, please contact rSmart support for configuration assistance. There is a services fee for the configuration and code writing required to export grades in Gradebook2.
# gradebook export feature
# uncomment for reference provider which support mid term and final
grades
#externalGradeProvider=org.sakaiproject.service.gradebook.shared.Extern
Help (Online)
2.25 Disabling Help links There are two settings for disabling Help links in the CLE.
• This setting disables the link in the tool menu, so “Help” will not appear.
display.help.menu=false
• This setting disables the Help icon in the tool iframe, so the icon will not appear next to a tool’s name.
display.help.icon=false
2.26 Online Help location This setting indicates the location of the online Help.
help.location=http://27.help.rsmart.com/rsmart-help-content
2.27 Custom Help links These settings may be used to create custom Help links in the top left box of the CLE Help pages. Complete this change in local.properties.
help.link.name.count=2
help.link.url.count=2
2.28 Turn on the experimental Lessons (Melete)/Resources integration feature
These settings turn on the Lessons/Resources enhancements to Melete. The default value is “true,” which means that the enhancement is turned ON by default in the rSmart
CLE. For more information on this feature, download the rSmart Sakai CLE 2.6.0 Release Notes from RSN. To turn this enhancement OFF, set the values to false. Complete this change in local.properties.
melete.editor.site.default=true
melete.allow.resource.links=true
Membership Tool
2.29 Disable the “unjoin” link in the Membership tool The following setting disables the “unjoin” link from within the Membership tool for all site types . This means that no one will be allowed to “unjoin” from a site using the Membership tool. Add this setting to local.properties.
disable.membership.unjoin.selection=true
The next settings allow you to specify the types of sites from which users must not be allowed to unjoin. In this example, there is one type of site that will not be joinable (as indicated by the value of “1” in the first setting listed) and the type of site that will not be
joinable is course (as indicated by the value of “course” in the second setting listed). All other site types not listed here will be unjoinable. Add this setting to local.properties.
wsetup.disable.unjoin.count=1
wsetup.disable.unjoin.1=course
Note: If your SIS (Student Information System) integration is configured to run add/drops
on a regular basis, a user who unjoins from a course site will be re-added to the siteupon the next synchronization with the SIS data, provided the user is still registered for the course in the SIS. Additionally, if a user unjoins from a site and then is re-added to the site, all of the user’s data will still exist in the site (assignment submissions, grades, test scores, discussion posts).
Messages Tool
2.30 Messages tool “from” email address These settings specify where message notifications appear to come from when the
messages tool sends emails to users.
msgcntr.notification.from.address=<[email protected]>
msgcntr.notification.user.real.from=true
• If msgcntr.notification.user.real.from is set to true, notifications will appear to come from the email address of the user sending the message.
• If msgcntr.notification.user.real.from is set to false, or if a user does not have an email address specified, notifications will appear to come from the address specified in msgcntr.notification.from.address.
• If msgcntr.notification.from.address is not set, notifications will appear to come
from [email protected] (or the value of your institution’s serverName property).
News Tool
2.31 Default news title and news feed URL This setting configures the default title and URL for the News tool that appears during site setup. Users may make changes to this default title and URL with the Site Setup tool. Place your customized default settings in local.properties.
news.title=Sakai Newsnews.feedURL=http://sakaiproject.org/announcements/feed
OSP
2.32 Experimental Assignments-Matrix integration Set the value to true to turn on the experimental Assignments-Matrix integration. This will allow you to link assignments with cells in a Matrix. When students submit work in response to an assignment linked to a matrix cell, that work will automatically be added to the matrix.
osp.experimental.assignments=true
2.33 Enable portfolio caching This setting enables caching portfolio presentation information, reducing load on the database when viewing portfolios and improving portfolio page load times.
cache.osp.presentation=true
2.34 Reviewer access to student matrices in all groups This setting allows matrix reviewers to access all student matrices in a worksite,
regardless of whether they belong to that student’s group. The default behavior is to only allow reviewers to view matrices of students in their groups.
osp.reviewer.groups.allowall.global=true
Page Order Helper Tool
2.35 Renaming tools with Page Order Helper tool This setting allows site owners to edit site tool names with the Page Order Helper tool in the Site Editor. If you do not want site owners to be able to change tool names, change
the value of this setting to “false.” For more information, see How do I turn on the PageOrder Helper tool?
org.sakaiproject.site.tool.helper.order.rsf.PageListProducer.allo
2.36 Password reset feature availability This set of properties determines which user types may reset their password using the Password Reset tool. By default, the CLE only allows “guest” users to reset their passwords. However, if registered and maintain users have local accounts (i.e., they do not have their authentication credentials stored in a directory outside of Sakai), they also
may be allowed to retrieve their passwords if these settings are enabled inlocal.properties.
resetRoles.count=3
resetRoles.1=guest
resetRoles.2=maintain
resetRoles.3=registered
Note: If registered and maintain users authentication information is stored in an external system, those users should be directed to the system’s self-service tools for password change requests, as appropriate.
Portal
2.37 Portal error email message If the portal catches any errors while processing a user request, the error report and the user’s bug report (if created) will be sent to the email address configured in this setting. This setting exists in local.properties.
[email protected]
2.38 “My Sites” display order
The order of the sites in the “My Sites” drop down menu is set by the order set by the “portal.term.order” properties. The default order is to order sites in reverse chronological order by term so as to keep the most recent (and likely relevant) sites at the top of the list. This order can be overridden by setting your own order in local.properties.
term.order.count=7
portal.term.order.1=SPRING 2011
portal.term.order.2=WINTER 2011
portal.term.order.3=FALL 2010
portal.term.order.4=SUMMER 2010
portal.term.order.5=SRPING 2010
portal.term.order.6=WINTER 2010
portal.term.order.7=FALL 2009
2.39 Turning categories on/off To disable the tool categories in your instance of the CLE, you must change the following setting in local.properties from “true” to “false.”
xslPortal.displayToolCategories=true
Preferences Tool (My Workspace)
2.40 Preferences tool—page order/visibility control The Preferences tool, which is typically available in a user’s My Workspace site, has several options that can be turned on by explicitly enabling or disabling settings in the
preference.pages property in local.properties.
# Controls the order pages appear in the Preferences tool, and
whether a page appears at all.
# To eliminate a page, explicitly set preference.pages and leave
the page value out.
preference.pages=prefs_tab_title, prefs_noti_title,
prefs_timezone_title, prefs_lang_title, prefs_privacy_title
Note: You cannot remove the prefs_tab_title setting because the rSmart CLE quicklinks require this function.
Sections Management
2.41 Section settings The following settings specify the types of sections instructors may create within their sites. The defaults are below. Create and make changes to these settings in local.properties.
section.category.count=5
section.category.code.1=01.lct
section.category.desc.2=Lab
section.category.code.3=03.dsc
section.category.desc.3=Discussion
section.category.code.4=04.rec
section.category.desc.4=Recitation
section.category.code.5=05.sto
section.category.desc.5=Studio
Note: For instances already in production, you can change the values here, but you should not remove any items or shorten the list. If you add to the list, adjust the section.category.count value appropriately.
2.42 Manual section creation (Sections tool) This setting allows you to configure the Sections tool once you decide whether instructors will be allowed to manually create course sections within their course sites. Make any configuration changes in local.properties.
[email protected]=MANUAL_MANDATO
The possible values for this setting are:
MANUAL_MANDATORY – Site owners must create their sections manually.
MANUAL_DEFAULT – By default, site owners must create their sections
manually, but if they so choose, they can have an external authority (an integrated Student Information System) create sections automatically. The SIS integration MUST be configured to automatically create sections in order for this option to work.
AUTOMATIC_DEFAULT – By default, Sakai will use an external authority to
automatically create sections within a course. If an instructor so chooses, he/she may switch the option to manual and create sections manually.
AUTOMATIC_MANDATORY – An external authority will automatically create
sections within a course, based on the rosters that exist within the course.
Instructors are not allowed to manually create sections.
Server
2.43 Server URL This setting specifies the URL to the server, including transport, DNS name, and port, if any. This setting exists in local.properties.
serverUrl=http://cle.myschool.edu:8080
This should be set to match the “port” defined in the tomcat.home/conf/server.xml file if you’re not using Apache.
2.44 Server ID This setting distinguishes servers in a cluster from one another. The “serverId” value is the server name displayed in the footer of the user interface and within the On-Line tool in the Administration Workspace. This setting exists in local.properties.
# identify your application server with a short name, unique
among the servers in your cluster.
# choose a server id even if you are running a single app server
serverId=server1
2.45 Virus scan If you want to enable virus scanning for files that are uploaded to the CLE, you can install anti-virus software on the server. These three settings will tell you whether virus scanning is enabled, the host IP, and the port at which it’s listening. These settings exist in local.properties.
virusScan.host=localhost
virusScan.port=3310
virusScan.enabled=false
We recommend ClamAV as an open source virus scanner that you can install on your
server.
Site Roster Tool
2.46 Remove user IDs and email addresses from site roster The site roster tool displays usernames and email addresses in the roster by default. To remove this information from the display, set the following properties in local.properties:
roster_view_email=false
roster_view_user_id=false
Site Statistics Tool
2.47 Enabling server-wide access to Site Statistics tool This setting allows admins access to site statistics across all sites in the CLE. Statistics include the following:
• total number of logins
• # unique users • # sites created
In local.properties, the value for this setting should be “true.”
serverWideStatsEnabled@org.sakaiproject.sitestats.api.StatsManage
r=true
To view these statistics you must also have the sitestats.admin.view permission in the site in which the Site Stats Admin tool is deployed. For more information, see How do I add and use the Site Statistics Admin tool?
Site/User Management
2.48 Editable site titles by site type Make changes to this setting if you want to give site creators the ability to edit the site title once the site is created. By default, course site titles are not editable. Make any changes in local.properties.
Default:
To make course site titles editable, change the setting to:
titleEditableSiteType.count=3
titleEditableSiteType.1=project
titleEditableSiteType.2=portfolio
titleEditableSiteType.3=course
Note: If your instance of the CLE is integrated with a Student Information System (SIS), you may choose not to make course site titles editable, as the SIS integration creates course titles automatically based on your specifications.
2.49 Turn on “soft delete” of sites This setting allows a Sakai systems administrator or a database administrator (DBA) to restore a site that is accidentally deleted by a site owner. When a site is deleted, a flag is changed in the database, so the site can no longer be accessed and appears deleted to the site owner. An admin can then change the flag and restore the site. If you would rather allow your site owners to “deep delete” sites instead of “soft deleting” sites, change the value of this setting to false. Make any changes in local.properties.
# uncomment to turn on logical delete of site data
[email protected]=true
Note: If your institution is a hosted client and you have this property set to “true,” contactrSmart for assistance with “undeleting” a site.
2.50 Stealthing/unstealthing tools Some tools in the CLE are “stealthed” by default, meaning that they are hidden from site owners upon site creation and within the Site Editor.
In order to stealth a tool, you first need to know its tool ID. If you are a CLE Functional Administrator, you can find a list of tool IDs by accessing a function of the Sites tool in the Administration Workspace. Alternatively, you can see the following section of this guide: Tool Definitions and Tool IDs. To stealth some tools, locate the tool IDs for the
tools you wish to stealth (example: Wiki, Site Roster, and Glossary), and then includethem in the stealthTools setting in local.properties. Here’s what the setting might look like:
[email protected]=sakai.rw
To unstealth a tool so that all site owners have access to it upon site creation, remove the appropriate tool ID from the stealthTools setting. Note: if you make any changes to this setting, be sure to restart Tomcat. Anyone with access to the Administration Workspace, such as a CLE Functional Administrator, can add a stealthed tool to an individual worksite. For instructions, see How do I add a stealthed tool to a site?
2.51 Super User (SU) tool--allowing non-admin access The following setting lets admins activate the Super User (SU) tool in sites other than the Administration Workspace:
# uncomment to turn on feature to allow non-admin users ability
to super user (CLE-4323)
use.su.realm=true
You must also configure the #su.realm= setting by including the site ID(s) for the site(s) into which you are adding the SU tool. For example:
su.realm=/site/b8a82ada-d875-4907-a1bd-2cdd540c402e
Important Notes:
1. You will have to edit the realm for the site(s) into which you add the SU tool and grant at least one role the su.can_su permission.
2. To access the su.can_su permission, you must first: a. Set the above properties. b. Restart Tomcat. c. Add the SU tool to the site(s) identified by the #su.realm= setting. d. Click on the SU tool link at least once in the site to which you just added
the SU tool.
For more information, see How can I give non-admins access to the Super User tool?
2.52 Assigning “from” address for email notification This setting controls the email address used as the “from” address for any email sent by Site Setup and Site Editor tools. This setting exists in local.properties.
[email protected]
2.53 Disabling e-mail notification for guest users Sometimes, a site owner (Course Instructor, Project Organizer or Portfolio Organizer) may choose to add guests to a site within your instance of the CLE. This function is available to all site owners via the user interface (From the Site Editor/Add Participants function).
If a site owner adds a guest user (using their email address), the CLE will create a user account for that user (assuming the user doesn’t already exist in the CLE) and send that
user an e-mail with their login information. To disable this e-mail notification for guest users, you must add the following to local.properties:
notifyNewUserEmail=false
2.54 Users present This setting controls whether or not the Users Present list shows in the left-hand menu column within a site. The list shows those who are ‘present’ (that is, looking at any page of the site). It may be desirable to remove this information across the site completely or to control which sites have the feature enabled in order to conform to local policy. This setting exists in sakai.properties and you can change the default value by adding this
setting to local.properties.
display.users.present=true
If this property is set to “true” or “false,” site presence display may be overridden (using
the Sites tool) by setting the site property value "display-users-present" to true or false for that site. If this property is set to always or never, site-specific property settings will have no effect.
# To turn off user presence in the user workspaces
display.users.present.myworkspace=false
2.55 Presence expiration A user’s presence will expire if not refreshed in this many seconds (in sites in which
display.users.present permits the presence display). This setting exists in sakai.properties and you can change the default value by adding this setting to
local.properties.
2.56 Session expiration A user’s session will expire if nothing happens in this many seconds (default is 3600 seconds/one hour)
2.57 Timeout Dialog settings
The timeoutDialogEnabled setting determines whether a timeout warning box will appear to users shortly before they are automatically logged off. Possible values are true or false. The default is false.
timeoutDialogEnabled=false
The timeoutDialogWarningSeconds setting specifies, in seconds, how much time will remain before automatic logoff when the timeout warning box appears. There is no default value for the timeout warning setting.
timeoutDialogWarningSeconds=
2.58 Enable role switching
This setting allows users with the site.roleswap permission to switch between a set of specified roles and return back to their own role. This feature allows Instructors to view the course sites as a Student, or portfolio site Organizers to view the site as a Participant. When a user enters a site in which they have the site.roleswap permission, a link or dropdown menu with available roles displays below the “My Sites” tab in the CLE portal.
studentview.roles=Student,Participant,Guest
Student Information System (SIS) Integration
2.59 Specifying site IDs for master sites If you have master sites that get duplicated when your courses are loaded into the CLE via SIS integration, you must specify the site ID for each master site by configuring the
cle.mastersiteid property setting in local.properties. By configuring this setting, you specify the master site that the CLE will use when creating a new site for a particular course in the SIS course file (courses.csv).
We recommend that you give a master site a unique site ID that is easy to remember,
such as “master.course” for a master site that will be used to create new course sites.
Keep in mind that a master site can be any type of site—course, project, or portfolio. For more information on creating master sites, see How do I create a “master site,” and make sure the CLE uses this site to create new sites when it accesses the Student Information System (SIS)?
If rSmart hosts your instance of the CLE, send us the site ID for your master site, and we'll make the necessary changes to the property setting. If you host your own instance, a System Administrator must make the changes.
Warning: We strongly recommend that you do NOT use an existing site template as a
master site for creating a new site. If you do, the CLE will create multiple “template sites” instead of just one new site.
You must also configure the property setting to specify the master site ID for the appropriate courses in the SIS course file. Let’s say you want to configure the cle.mastersiteid setting to specify the following:
• “course” for the master site ID in the SIS course file
• “master.course” for the site ID of the master site
You would then configure the following setting:
# Site Masters (will match site master id column in course csv file. If blank in csv file, will use masterSiteId from
CleCourseProcessor)
cle.mastersiteid.course=master.course
In this case, the CLE will duplicate the “master.course” site to create a new site for any course with the ID “course” in the site master ID column in the SIS course file (courses.csv).
Note: In your SIS courses.csv file, be sure to include the site ID of your master site in the “master course id” column for the appropriate courses. If you leave this entry blank,
the default master site will take precedence.
2.60 Specifying a site ID for a single master site If you plan to use only a single master site that the CLE will use to create sites when accessing a Student Information System (SIS), you may configure the following setting in local.properties.
# site id for course processor to clone
masterSiteId@com.rsmart.customer.integration.processor.cle.CleCou
rseProcessor=MasterSite
The value for this property is configurable, but it must be identical to the site ID of your master site. In this example, the site ID would be “MasterSite.”
The master site may be any type of site—course, project, or portfolio. In this example, the setting will clone the site with the ID “MasterSite” in your SIS courses.csv file to create new course sites.
For more information on creating master sites, see How do I create a “master site,” and make sure the CLE uses this site to create new sites when it accesses the Student Information System (SIS)?
2.61 Enable detailed reporting for changed members and courses
If your institution’s instance of the CLE accesses a Student Information System (SIS) when creating sites, setting the following properties in local.properties to “true” will enable detailed reporting for changed members and courses. You may access these reports in the catalina.out log when running the SIS synchronization job, to confirm that
your files are set up properly.
extendedReporting@com.rsmart.customer.integration.processor.cle.C
leCourseProcessor=true
By default, these properties are disabled. Note: Depending on the amount of data, reporting may generate a high volume of messages, resulting in an email that is excessively large.
2.62 Allow additional information for SIS courses file
Configuring the following settings in local.properties will allow for additional information
in the SIS courses.csv file used to create sites in the CLE.
# allow for additional columns for Contact Name (10th column) and
Contact Email (11th column) to be set in courses.csv
columns@com.rsmart.customer.integration.processor.cle.CleCoursePr
ocessor=11
# allow for a header row in the csv file; Semester, Site ID, etc.
The SISProcessor will start processing from the second row.
headerRowPresent@com.rsmart.customer.integration.processor.cle.Cl
2.63 Allow for additional course properties
Configure the following setting in local.properties to allow the courses.csv file to specify additional course properties. You may configure this setting for up to five additional properties.
# allow up to 5 properties to be specified in courses.csv file
and added as course properties.
ocessor=16
course.sis.property.count=5
course.sis.property.1=propertyName1
As an example, you might want to add the alternateCourseId and alternateName properties. To do so, you would configure the following setting:
course.sis.property.2=alternateName
Note that you must specifiy a value for the number of course properties you are adding, as well as the total number of columns in the courses.csv file needed for these additional properties. By default, the courses.csv file has 11 columns. So in this example, the value for the total number of columns should be 13.
2.64 Allow for additional user properties
Configure the following setting in local.properties to allow the users.csv file to specify additional user properties. You may configure this setting for up to five additional properties.
columns@com.rsmart.customer.integration.processor.cle.CleUserProc
user.sis.property.4=propertyName4
user.sis.property.5=propertyName5
As an example, you might want to add the alternateEmailAddress and alternateName properties. To do so, you would configure the following setting:
columns@com.rsmart.customer.integration.processor.cle.CleUserProc
essor=9
user.sis.property.count=2
user.sis.property.1=alternateEmailAddress
user.sis.property.2=alternateName
Note that you must specifiy a value for the number of user properties you are adding, as well as the total number of columns in the users.csv file needed for these additional properties. By default, the users.csv file has 7 columns. So in this example, the value for the total number of columns should be 9.
2.65 Auto-create URL alias based on external site ID
If the following setting is configured in local.properties, each site the CLE creates by accessing the SIS will be assigned a URL alias based on the external site ID (the unique course ID in the SIS courses.csv file). If the value for this setting is set to “false,” each site will be assigned an auto-generated URL (consisting of a long string of numbers and
letters).
createAlias@com.rsmart.customer.integration.processor.cle.CleCour
2.66 Allow users update
If the following property is set to "true" in local.properties, information in the users.csv file will overwrite information in the CLE database.
# allow information in CSV file to overwrite information in
database.updateAllowed@com.rsmart.customer.integration.processor.cle.CleUs
erProcessor=true
2.67 User password/removal (users created via SIS) Note: The following property settings are only applicable if your institution creates users through an SIS process.
Enable password update Configure the following setting in local.properties to allow user passwords to be updated.
updatePassword@com.rsmart.customer.integration.processor.cle.CleU
serProcessor=true
Allow auto generation of user passwords The following property in local.properties, if set to “true,” will allow user passwords to be automatically generated when the CLE imports users by accessing the SIS user file.
generatePassword@com.rsmart.customer.integration.processor.cle.Cl
Remove users from the CLE (remove user EIDs)
For the CLE to remove users by accessing a list of EIDs (the SIS removeusers.csv
file), you must add the following settings to local.properties.
#set location of remove file (one userid per line)
filename@com.rsmart.customer.integration.processor.cle.CleRemoveU
serProcessor=${sakai.home}/sis/removeusers.csv
# defaults to false, meaning it looks the user up by eid, set
this to true to lookup by user id
lookupByUserId@com.rsmart.customer.integration.processor.cle.CleR
emoveUserProcessor=false
2.68 Remove sections in sitesBy setting the following property to "true" in local.properties, sections will be removed from a site if they do not show up in the SIS sections file (sections.csv). Note: This
property only works on sites for which section data exists in the sections.csv file.
deleteSections@com.rsmart.customer.integration.processor.cle.CleS
2.69 Map student and TA roles
By configuring the following settings in local.properties, the CLE will assign student or teaching assistant roles to site members according to the roles listed for them in the members.csv file.
# allow for mapping of role names in the members.csv file to those
within the system
# allow for the removal of any existing enrollments for the
student or teaching assistants deleteTeachingAssistants@com.rsmart.customer.integration.processo
2.71 Assign “active” or “inactive” status to site members
By adding the following setting in local.properties, user status for a site can be controlled
by assigning the appropriate value to the SIS membership (members.csv) file. This setting adds a fourth column to the file. In this column, assign either “true” (active) or “false” (inactive) for each user.
columns@com.rsmart.customer.integration.processor.cle.CleMembersh
These settings exist in sakai.properties in the CLE .
Note: rSmart settings differ from the term settings in 2.7 community Sakai.
Make any changes in local.properties.
termterm
Terms (semesters) are known by different names at different institutions. This list is where the particular terminology used for terms/semesters is specified. The termterm.count value should match the number of terms specified by termterm.n entries.
termlistabbr.6=F11
termlistabbr.7=W12
termlistabbr.8=Sp12
termlistabbr.9=SpSu12
termlistabbr.10=Su12
termlistabbr.11=F12
termiscurrent termiscurrent specifies which term value shows up as the default in the “Term”
dropdown list that is displayed when creating a new course site.
At institutions where instructors create their own course sites (as opposed to institutions that bulk-create a site for every course), the course site creation for the next term usually starts sometime before the current term ends. About the middle of the current term, when current term course site creation falls off, it is useful to change the default that appears for the term choice in the “Term” dropdown menu to the next term. The
termiscurrent.count value should match the number of years specified by
termiscurrent.n entries.
termiscurrent.count=11
termiscurrent.1=true
termiscurrent.2=false
termstarttime Specifies the start date of the associated termterm.n. Format is yyyyMMddHHmmssSSS .
The termstarttime.count value should match the number of years specified by
termstarttime.n entries.
termstarttime.count=11
termstarttime.1=20100901000000000
termstarttime.2=20110101000000000
termstarttime.3=20110501000000000
termstarttime.4=20110515000000000
termstarttime.5=20110801000000000
termstarttime.6=20110901000000000
This setting specifies the end date of the associated termterm.n. Format is
yyyyMMddHHmmssSSS . The termendtime.count value should match the number of years
specified by termendtime.n entries.
termendtime.4=20110801000000000
termendtime.5=20110801000000000
termendtime.6=20111201000000000
termendtime.7=20120501000000000
termendtime.8=20120801000000000
termendtime.9=20120801000000000
termendtime.10=20120830000000000
termendtime.11=20121201000000000
Some schools choose to have only one “generic” term, which is helpful for institutions that do not use terms or choose not to identify terms for their courses within the CLE.
Additionally, some SIS integration processes will auto-provision courses with the appropriate term information. Consult with rSmart to review the SIS integration options you’ve chosen before editing these term settings.
Tests and Quizzes (Samigo) Tool
2.73 Email server settings
The Tests & Quizzes tool uses the following email settings in local.properties instead of the standard e-mail settings.
# outgoing SMTP server (If not set, the Sakai smtp server setting will be used)
samigo.smtp.server=smtp.somewhere.edu
# outgoing SMTP port (If not set, the default part 25 will be
used)
samigo.email.prefixedPath=/tmp/
2.74 File upload question type
These settings govern the file upload specifications for the Tests & Quizzes tool. Make changes to these settings in local.properties.
# ** Samigo File Upload question type settings **
# the following default settings:
# in Samigo web.xml can be overridden with the following settings
in sakai.properties:
/files/sam/uploads
2.75 Allow instructor to change published assessments This setting governs whether or not an instructor may edit an assessment after it has been published.
samigo.editPubAssessment.restricted=false
By default, this property is set to “false,” so instructors may edit a published assessment at any time, and regrade the entire assessment.
If you set this property to “true,” instructors will not be able to edit a published
assessment if at least one student has taken it.
Make changes to this setting in local.properties.
2.76 Enable auto-submit feature This setting enables a feature that provides an assessment option to automatically submit assessments on their due date. The “Auto Submit Assessments Job” must also be scheduled in the Job Scheduler tool in order for this feature to work.
samigo.autoSubmit.enabled=true
2.77 Word-2-QTI tool (“Create using markup text” feature) This setting allows you to enable/disable the “Create using markup text” (Word-2-QTI) feature within Samigo (Tests & Quizzes). This setting exists in sakai.properties and the default setting in the rSmart CLE is true (meaning the “Create using markup text” option is turned on). You can make any changes to this default value by adding/changing this setting in local.properties.
samigo.samliteEnabled=true
Skins and branding For information on skins and branding, visit RSN to download the rSmart Sakai CLE 2.7 Customization Guide.
Getting users into the CLE and adding users into courses Getting users into the CLE In order to access the CLE, a user must have a user ID, password and a user account type . A user’s account type determines the following:
1. The toolset available within the user’s My Workspace
2. The system permissions for that user – i.e., what privileges does this user get just by logging in ?
There are three default user account types in the rSmart CLE 2.7:
• registered
• maintain
• guest
Users may be added to the CLE in several ways. You can choose one or a combination
of the methods listed in the following section of this guide. Adding users into courses Before you can place a user into a course site (or other type of site), the user must have a local user account OR the user must exist in an external directory (read on for more information on LDAP/AD integration) that is integrated with your Sakai instance.
Whenever you place users into sites (course, project or portfolio) using any of the methods described in the following section, you must also assign a role for each user. A role is a collection of permissions, and a user’s role determines what the user is allowed to do within the site. Course sites, by default, have the following default roles (which can vary by institution):
• Instructor
• Student
• Guest
Each role has its own unique set of permissions within the course. If you add user “jsmith” into a course site, for example, the system will require you to determine what role jsmith has within that course.
You may decide that jsmith is going to be a student within this course. So, user jsmith can participate in this course with student-level permissions. Additionally, you may decide to add jsmith to another course, only this time, you assign jsmith the instructor
role. User jsmith is now a student in one course and an instructor in another course, andhas student permissions in one course and instructor permissions in the other course.
Read on to discover how users can get an account in the CLE and how you can enroll them in their course sites.
Note: For more information about user authentication and managing course and user data, visit RSN and download the rSmart whitepaper Integration Decisions for Authentication, Accounts and Courses.
Getting users into the CLE There are a number of ways to create user accounts in the CLE.
Create users manually, one-by-one See How do I manually add a user into the CLE? for instructions. This method is not
ideal if you have many users to add.
External Authentication using LDAP or Active Directory Configure the CLE to use LDAP or Active directory for user authentication. You can find configuration instructions in the RSN Knowledge Base article How can I integrate my LDAP server with the CLE?
Using LDAP/AD authentication benefits CLE Functional Administrators because it saves time—once you have configured the CLE to authenticate against your own internal system, you won’t need to create users manually. The users will, in fact, log in simply with their LDAP/AD user ID and password. LDAP/AD authentication also benefits users, because there is no need for them to remember an additional password.
For more information, visit RSN and download the rSmart whitepaper User Authentication with LDAP and the rSmart Sakai CLE.
Use another Identity Management (IDM) solution, such as CAS or Shibboleth, to manage user access to the CLE rSmart will be happy to consult with you regarding your existing IDM system and your IDM/Sakai integration needs.
Use the rSmart roster import tool In the absence of LDAP authentication, you can use the rSmart Roster Import tool to add all users into the CLE. We recommend that you test the Roster Import tool with just a few users before importing all users. For instructions, download Using the Roster Import Tool from RSN.
Invite them as guests into your course, and a user ID will be created for them with a “guest” user account type Use the Site Editor tool and click “Add Participants”. Add the email address of each new user that you wish to add to your site in the “Non-official Participants” area. Creating users in this way will send each new user an email with their login information.
Use the SIS integration code to mass-import your users into the CLE via a users.csv file. If your institution’s instance of the CLE is integrated with a Student Information System
(SIS), the CLE can optionally access a list of users (the users.csv file) exported fromthe SIS. This file will include each user’s enterprise ID (EID), which is the ID that will be used to log in to the CLE, as well as each user’s login password and email address.
Note: This option should not be used if your instance of the CLE is already integrated with LDAP/Active Directory (AD).
Getting users into their courses There are a number of ways to get users into their course sites.
Let the users enroll themselves using the Membership tool If you do not have a student information system and you also do not have a course
registration process at your institution, you could make all courses “joinable” and allowstudents to join courses using the Membership tool. This is not an ideal way to manage course registrations if you already have a student information system at your institution.
Tell instructors to manually enroll the users If the users already have an ID in the CLE, instructors can easily add a list of participants to a course using the Site Editor/Add Participants tool. Just paste the user IDs into the Site Editor/Add Participants page.
Integrate the CLE with your SIS (Student Information System) so that courses (and potentially sections) are automatically created and users are automatically enrolled.
For more information on this method of SIS integration, contact rSmart for assistanceand see the following RSN Knowledge Base article for instructions on preparing your SIS exports: What sorts of file exports does the CLE expect from my SIS?
SIS Integration with Flexible Site Creation You may also integrate the CLE with your SIS using the Course Management API.
This method uses the Sakai Course Management API to populate the CLE database with course, section and roster information exported regularly by your SIS. Instructors can manually create courses and choose the rosters to import into their newly created course sites.
Please note that implementation may require additional services work. Contact rSmart for assistance, and visit RSN to download Course Management SIS Integration for more information on configuring the Course Management API.
3 Managing the rSmart Sakai CLE
CLE Functional Administrator vs. System Administrator A CLE Functional Administrator is someone who has the highest level of permissions within the CLE and can manage configuration components of the CLE and help users troubleshoot within the user interface . A System Administrator is someone who has access to the CLE server and file system, manages configuration files and can