Sakai 10 new properties and permissions

Sakai 10 new properties and permissions

1.0 Property additions/changes

 

Release

Tool/Service

Property

Ticket

Change

Release

Tool/Service

Property

Ticket

Change

10.0

Search

Not recommended, but available for using the pre-Sakai 10 search tool. ElasticSearch is the default. These properties would revert to legacy search.

search.service.impl=org.sakaiproject.search.component.service.impl.ConcurrentSearchServiceImpl
search.indexbuilder.impl=org.sakaiproject.search.component.service.impl.SearchIndexBuilderImpl

https://sakaiproject.atlassian.net/browse/SRCH-130

ElasticSearch is the new default. Using the legacy search tool is not recommended.

10.0

Search

 

https://sakaiproject.atlassian.net/browse/SRCH-119

 

10.0

Samigo (Test and Quizzes)

All question types are enabled by default.

It is correct that multiplechoice has two properties to be set (historical reasons for this)

samigo.question.show.extendedmatchingitems 
samigo.question.show.fileupload 
samigo.question.show.essay 
samigo.question.show.audio 
samigo.question.show.matching 
samigo.question.show.truefalse 
samigo.question.show.multiplechoicesinglecorrect 
samigo.question.show.multiplechoicemultiplecorrect 
samigo.question.show.fillintheblank 
samigo.question.show.fillinnumeric 
samigo.question.show.survey 
samigo.question.show.matrixsurvey 
samigo.question.show.calculatedquestion

https://sakaiproject.atlassian.net/browse/SAM-2296

New feature for Sakai 10. Institutions may configure which question types they use in Samigo and which they do not.

10.0

OSP (Portfolios)

osp.freeform.disabled=true

 

OSP layouts are off by default. Do not turn OSP layouts on without consulting with the Sakai developer community (in other words it is strongly recommended you keep OSP layouts turned off by default.)

10.0

Support for Google Analytics

example properties

portal.google.analytics_id=UA-12345-5 
portal.google.analytics_domain=http://www.dr-chuck.com/ 
portal.google.analytics_detail=true 

When a analytics_id is specified, the GA (ga.js) code is include in the portal pages. If analytics_detail is true, the user's eid and siteId are sent as Custom Variables 1 and 2. 

https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingCustomVariables

https://sakaiproject.atlassian.net/browse/SAK-25634

This JIRA will add support to Sakai's portal to include JavaScript to add Google analytics to all of the pages served by Sakai.

10.0

Polls

poll.allow.public.access is false by default. New property.

https://sakaiproject.atlassian.net/browse/SAK-25399

Polls can now be made public more easily.

10.0

Mailsender

Default is OOTB "postmaster@"+host.

This can be problematic for institutions that need to configure this value for dev/qat environments. 

smtp.postmaster.address.local-part 
smtp.postmaster.address.domain

https://sakaiproject.atlassian.net/browse/SAK-25393

Allow configuration of mail "from:"

10.0

Portal

bottom.copyrighttext is "currentYearFromServer",

https://sakaiproject.atlassian.net/browse/SAK-25293

To save system administrators' time, the copyright end date should automatically update to the current year, if the institution chooses.

10.0

Messages

The new feature to display profile images will be disabled by default.

msgcntr.pvtmsg.showProfileInfo = true 

Additionally, if profile images are enabled and you do not want to allow linking to the profile information, you can utilize the following profile2 property. If absent, this defaults to true: 

profile2.profile.link.enabled

https://sakaiproject.atlassian.net/browse/SAK-24869

Just like Forums is displaying the profile picture [1], our users can see the sender's picture when reading their messages

10.0

Forums

example:

msgcntr.forums.defaultAvailabilityTime=8:00am

https://sakaiproject.atlassian.net/browse/SAK-24866

Instead of using the current time as default for availability.

10.0

Forums

msgcntr.forums.import.openCloseDates=true (false by default)

https://sakaiproject.atlassian.net/browse/SAK-24862

Supports a case where instructors create parent sites and import the information into section sites for the same semester.

10.0

Forums

mc.alwaysShowFullDesc=true (default false)

https://sakaiproject.atlassian.net/browse/SAK-24858

When you load the main forum's page, let there be a property that will allow an institution to decide whether the full description is shown or hidden. 

10.0

Forums

msgcntr.forum.rankimage.maxsize

https://sakaiproject.atlassian.net/browse/SAK-24854

 

10.0

Messages

Default is false.

mc.messages.forwardEmailDisabled=true/false

 

https://sakaiproject.atlassian.net/browse/SAK-24850

This can turn on/off the "CC" option when sending a message in the "Message" tool for all sites (institution level). If the property is true, then all sites will not have this option, otherwise, it defers to site level settings.

10.0

Messages

mc.messages.ccEmailDisabled=true/false

https://sakaiproject.atlassian.net/browse/SAK-24849

An institution can not disable the CC option, until now. They can set the default to false (mc.messages.ccEmailDefault=false) but an instructor could change it at the site level. This property completely removes this from the UI and force the value to false: 

10.0

PDA Portal

portal.pda.iframesuppress=:all: (new default)

https://sakaiproject.atlassian.net/browse/SAK-25494

 

10.0

Config

#How many days to retain deleted content 
content.keep.deleted.files.days=30

https://sakaiproject.atlassian.net/browse/SAK-24426

 

10.0

Site Info

The sakai.properties introduced by this patch are: 
- sitemanage.join.joinerGroup.enabled=[true/false]  - default is false
- sitemanage.join.notification.enabled=[true/false] 
- sitemanage.join.excludeFromPublicList.enabled=[true/false] 
- sitemanage.join.limitAccountTypes.enabled=[true/false 
- sitebrowser.join.enabled=[true/false] 
- sitemanage.join.allowedJoinableAccountTypeCategories (count + list) 
- sitemanage.join.allowedJoinableAccountTypes (count + list) 
- sitemanage.join.allowedJoinableAccountTypeLabels (count + list)

https://sakaiproject.atlassian.net/browse/SAK-24423

 

10.0

Password Validation

account-validator.terms - default is null

https://sakaiproject.atlassian.net/browse/SAK-24366

Required checkbox on the signup page which is only shown if account-validator.terms is set to a URL which contains the terms and conditions.

10.0

Password validation

Updating the default props 

# Role that can use the password reset tool by default. 
# guest users are ones that are created by Site Info when adding external participants. 
# registered users are ones the are created by the New Account tool on the Gateway site. 
# Default: guest 
#resetRoles=guest,registered 

# resetAllRoles allows this to work for any roles in the system (overrides resetRoles above) 
# Default: false 
#resetPass.resetAllRoles=true

https://sakaiproject.atlassian.net/browse/SAK-24365

 

10.0

 

# If you are running Sakai in a cluster behind a load balancer and the load balancer is changing the 
# scheme during forwarding, oauth validation will fail because the scheme is taken into account during the 
# signature comparison. Set this to the scheme that your load balancer is running under and the 
# launch request will be validated, or at least the scheme won't break it. 
# basiclti.provider.forcedurischeme=

https://sakaiproject.atlassian.net/browse/SAK-23997

 

10.0

Assignments

property: (default true) 
assignment.usePeerAssessment=(true|false)

https://sakaiproject.atlassian.net/browse/SAK-23812

 

10.0

Password validation

 ## SAK-23737 - User types allowed to bypass password validation when editing account details
# An empty list (no property set) indicates that all types require password validation (default behavior)
# Which user types are provided and will therefore be allowed to bypass the password validation step
#user.type.provided=asdf,qwerty

https://sakaiproject.atlassian.net/browse/SAK-23737

 

10.0

Site Creation

In the default SectionFieldProviderImpl the sizes are limited to subject=8, course=3, section=3. This should be configurable, since most places use this default implementation. 

Adding 3 new properties 

wsetup.sectionfield.required_fields_subject.max 
wsetup.sectionfield.required_fields_course.max 
wsetup.sectionfield.required_fields_section.max

https://sakaiproject.atlassian.net/browse/SAK-23652

 

10.0

Portal

default

portal.title.shortdescription.show=false

https://sakaiproject.atlassian.net/browse/SAK-23597

 

10.0

Turnitin

property: 

turnitin.forceSingleAttachment (false by default) 

to turn on property: 

turnitin.forceSingleAttachment=true 


This forces the UI to select "Single File Upload Only" and disable the other options. Toggling re-enables the options.

https://sakaiproject.atlassian.net/browse/SAK-23592

 

10.0

Resources

# list of macros that will be expanded when used in a web link in resources. 
content.allowed.macros=${USER_ID},${USER_EID},${USER_FIRST_NAME},${USER_LAST_NAME} 

Note that site related properties will not work because the resolver code is actually called from access which has no context. 
It may be possible to pass in the context since the original resource has context, then site properties would work, however this may have security implications where the link is embedded in another site and that aspect needs to be fully explored. As such it has not been included. It is a trivial exercise to add this though, see BaseContentService in the kernel.

https://sakaiproject.atlassian.net/browse/SAK-23587

 

10.0

Site

The property site.title.maxlength allow long site titles fix the UI by cutting the end of the title in tabs. 

We've got many long site titles and very similar, for example, "This is the subject part I", "This is the subject part II". In these cases both cutted titles appears to be the same "This is the subj...". 

We want a more flexible way to do it. With 2 new properties: 

   site.title.cut.method = customize the cut method. Default 100:0. 
   site.title.cut.separator = separator string. Default ... 

The value has the format X:Y, wich means X percent of maxlength at the beginning and Y percent of maxlength at the end. Now if you choose 50:50 and [...], the above example, will get something like "This is[...]part I" and "This is[...]part II". 

# Max length for site title display 
# Default 25 characters 
#site.title.maxlength=25 

# Cut method for site title display 
# Default 100:0 display the first site.title.maxlength characters and the separator string at the end 
# Other values: 
# 0:100 display the last site.title.maxlength characters and the separator string at the beginning 
# 50:50 display first site.title.maxlength*50% characters the separator string and the last site.title.maxlength*50% 
#site.title.cut.method=100:0 

# Separator string used to separate characters in cut method 
# Default ... 
#site.title.cut.separator= ... 

https://sakaiproject.atlassian.net/browse/SAK-23567

 

10.0

Student Success Portal

Configuration will work like so: 
# SSP Early Alert integration 
# Allow Early Alerts integration? (default: false) 
ssp.allowed.alerts=true 
# URL to the SSP server 
ssp.server.url=http://ssp.unicon.net/ssp-platform/sso 
# the shared password between SSP and Sakai 
ssp.alerts.shared.password=********* 
# roles allowed to have SSP Early Alerts (default: access,Student) 
ssp.allowed.alert.roles=access,Student

https://sakaiproject.atlassian.net/browse/SAK-23562

 

10.0

Site section management

# Allow instructors to create and manage sections by themselves while also
# having some types of sections locked (read only). With this configuration
# (and MANUAL type set) an Instructor can create and manage sections except
# with the configured readonly categories.
# Defines the category codes of sections that are readonly (e.g. 01.lct,02.lab)
# Default: "" (empty) - all sections can be edited
#section.info.readonly.section.categories=

https://sakaiproject.atlassian.net/browse/SAK-23495

 

10.0

Site creation

# Sites with non-editable title (by site type) 
# Example: course - course sites will have read only title. 
# Set as empty "site.type.titleNotEditable=", every site title would be modified. 
# Default: course 
#site.type.titleNotEditable=course,project

https://sakaiproject.atlassian.net/browse/SAK-23469

 

10.0

Portal Chat

# Specifies the amount of time, in milliseconds, between latestData requests sent by the javascript client.
#portal.chat.pollInterval=5000

https://sakaiproject.atlassian.net/browse/SAK-23374

 

10.0

Portal Chat & Video

# Set this to true and video calling will be enabled on portal chat.
# DEFAULT: false
# portal.chat.video=true

# A list of nat traversal servers to try during portal chat video calling.
# DEFAULT: stun:stun.l.google.com:19302
# portal.chat.video.servers={list of ice servers}

# The timeout, in seconds, for operations like waiting for a call to be answered.
# DEFAULT: 25
# portal.chat.video.timeout=50

https://sakaiproject.atlassian.net/browse/SAK-23349

 

10.0

 

# Control the default hidden status of imported resources content
# when using Import from Site > Re-use Content feature in Site Info (SAK-23305)
# Default: false (visible)
# Since: 2.10
#content.import.hidden=true

https://sakaiproject.atlassian.net/browse/SAK-23305

 

10.0

Portal Chat

# Set this to true and portal chat will be disabled for a user UNLESS portal.chat.permitted is set
# in their MyWorkspace site. Defaults to false.
#portal.chat.securedByUser=false

https://sakaiproject.atlassian.net/browse/SAK-23259

 

10.0

 

#### SAK-23257: Restrict site maintainer from adding or elevating users to certain roles.
#### For example, prevent the Instructor of a course site from adding new Instructor users
# DEFAULT: empty (no restricted roles)
# You can narrow the restriction to a specific type of site by appending .sitetype
# sitemanage.addParticipants.restrictedRoles=CustomRole
# sitemanage.addParticipants.restrictedRoles.course=Instructor
# sitemanage.addParticipants.restrictedRoles.project=maintain

https://sakaiproject.atlassian.net/browse/SAK-23257

 

10.0

 

 

https://sakaiproject.atlassian.net/browse/SAK-23237

 

10.0

Gradebook

property: 

gradebook.defaultMaxDisplayedScoreRows 

options: 

gradebook.defaultMaxDisplayedScoreRows=5 
gradebook.defaultMaxDisplayedScoreRows=10 
gradebook.defaultMaxDisplayedScoreRows=15 
gradebook.defaultMaxDisplayedScoreRows=20 
gradebook.defaultMaxDisplayedScoreRows=50 
gradebook.defaultMaxDisplayedScoreRows=100 
gradebook.defaultMaxDisplayedScoreRows=0 (this means "all") 

By default, the option stays at 50. Also, if you put an option not listed above, it will default to 50

https://sakaiproject.atlassian.net/browse/SAK-23193

 

10.0

Sections

# SAK-22537: How many sections can be added at one time?
# DEFAULT: 10
#sections.maxgroups.category=20

https://sakaiproject.atlassian.net/browse/SAK-22537

 

10.0

Login

# Log failed login attempts? Defaults to true.
#login.log-failed=true

https://sakaiproject.atlassian.net/browse/SAK-22430

 

10.0

Resources

defaults to true

content.upload.dragndrop=(true|false)

https://sakaiproject.atlassian.net/browse/SAK-22306

 

10.0

Citations

citations.default.list.page.size=50

https://sakaiproject.atlassian.net/browse/SAK-22297

 

10.0

Assignment

assignment.group.submission.enabled=true

https://sakaiproject.atlassian.net/browse/SAK-22282

 

10.0

Portal

HTML code for branding the Sakai online help

help.header 
help.footer

https://sakaiproject.atlassian.net/browse/SAK-22245