Child pages
  • Sakai Properties Reference - S
Skip to end of metadata
Go to start of metadata

Sakai Properties Reference - S

Property Name

Description

sak11204.forceupgrade

Whether or not to force the upgrade required to fix SAK-11204 on startup.
This property is used in Sakai version(s): 2.5,2.6

sakai.datawarehouse.dbLoader.properties.alterTables

Whether or not to alter the data warehouse tables.
This property is used in Sakai version(s): 2.5,2.6

sakai.datawarehouse.dbLoader.properties.createTableScript

Whether or not to run the script specified in osp.datawarehouse.dbLoader.properties.tableScriptFileName when initializing the OSP data warehouse.
This property is used in Sakai version(s): 2.5,2.6

sakai.datawarehouse.dbLoader.properties.createTables

Whether or not to create the data warehouse tables.
This property is used in Sakai version(s): 2.5,2.6

sakai.datawarehouse.dbLoader.properties.dropTables

Whether or not to drop the data warehouse tables.
This property is used in Sakai version(s): 2.5,2.6

sakai.datawarehouse.dbLoader.properties.indexTables

Whether or not to create indexes for the data warehouse tables.
This property is used in Sakai version(s): 2.5,2.6

sakai.datawarehouse.dbLoader.properties.populateTables

Whether or not populate the data warehouse tables.
This property is used in Sakai version(s): 2.5,2.6

sakai.datawarehouse.dbLoader.properties.tableScriptFileName

The location of a script that will be run when initializing the OSP data warehouse.
This property is used in Sakai version(s): 2.5,2.6

sakai.datawarehouse.useWarehouse

The types of reports to generate from the OSP data warehouse.
This property is used in Sakai version(s): 2.5,2.6

sakai.mailbox.search-threshold

The maximum number of messages that are allowed in a mailarchive channel before searching is disabled for that channel.
This property is used in Sakai version(s): 2.6

sakai.rutgers.linktool.serverUrl

The URL that will be encoded into the signed set of parameters passed by the link tool.
This property is used in Sakai version(s): 2.3,2.4,2.5,2.6

sakai.site.multiPlacementTools

The list of tool IDs to allow to be placed multiple times in a single site.
This property is used in Sakai version(s): 2.4,2.5,2.6

sakai.xml.sax.parser

The classname of the SAX parser to use.
This property is used in Sakai version(s): 2.4,2.5,2.6

sakaiServerKey@org.sakaiproject.citation.api.ConfigurationService

The server key that is added to Google Scholar urls.
This property is used in Sakai version(s): 2.5,2.6

sam_file_upload_comment_out

Whether or not to disable file uploads in SAMigo.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

samigo.answerUploadRepositoryPath

The directory in which file resources uploaded in SAMigo will be stored.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

samigo.autoSumit.enabled

Whether or not to automatically submit assessments.
This property is used in Sakai version(s): 2.6

samigo.editPubAssessment.restricted

Whether or not to allow editing of published assessments.
This property is used in Sakai version(s): 2.6

samigo.email.bypassAuth

Whether or not the mail server specified in samigo.smtpserver requires a username and password.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

samigo.email.password

The password to use when communicating with the mail server used for SAMigo.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

samigo.email.prefixedPath

The directory in which to store samigo's email attachment directory.
This property is used in Sakai version(s): 2.4,2.5,2.6

samigo.email.prefixedPath

The directory in which to store samigo's email attachment directory.
This property is used in Sakai version(s): 2.4,2.5,2.6

samigo.email.username

The username to use when communicating with the mail server used for SAMigo mail messages.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

samigo.samliteEnabled

Whether or not to display a "Quick Create" button on the Assesments home page in SAMigo.
This property is used in Sakai version(s): 2.4,2.5,2.6

samigo.saveMediaToDb

Whether or to save media entered using samigo to the database.
This property is used in Sakai version(s): 2.3,2.4,2.5,2.6

samigo.sizeMax

The maximum size (in bytes) allowed for a single file uploaded using samigo.
This property is used in Sakai version(s): 2.3,2.4,2.5,2.6

samigo.sizeThreshold

This parameter is set, but does not appear to be used by any code.
This property is used in Sakai version(s): 2.3,2.4,2.5,2.6

samigo.smtp.port

The port number to communicate with the mail server used for outgoing SAMigo messages.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

samigo.smtp.server

The mail server to use for messages sent by SAMigo.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

scaffolding.permissions.map

Define the default scaffolding permissions for one or more roles. Each numbered instance of this variable should have a corresponding siteTypes and value option. For example, if scaffolding.permissions.map.1 is set, at a minimum scaffolding.permissions.map.1.siteTypes, scaffolding.permissions.map.1.value.count and scaffolding.permissions.map.1.value.1 must be set.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

scaffolding.permissions.map.{number}.siteTypes

A list of site types (portfolio, course, project, etc.) for which the permission map should be used.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

scaffolding.permissions.map.{number}.value

A list of the actual permissions that should be assigned to the role specified in scaffolding.permissions.map.{number}.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

scaffolding.permissions.override

Whether or not to override the existing scaffolding permissions with those set in scaffolding.permissions.map. If set to true, only the permissions set in scaffolding.permissions.map will be set. If set to false, the permissions set in scaffolding.permissions.map will be set in addition to any existing permissions.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

scheduler.event.archive.enabled

This property does not currently appear to be used.
This property is used in Sakai version(s): 2.4,2.5,2.6

scheduler.event.archive.length

The length of time (in milliseconds) that sessions are allowed to sit around before being archived.
This property is used in Sakai version(s): 2.4,2.5,2.6

schemaUpdate@org.sakaiproject.springframework.orm.hibernate.SessionFactoryBase

Whether or not to execute a schema update after initialize the session factory.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

search.allow.maintain.admin

Whether or not to allow site maintainers to administer the search tool.
This property is used in Sakai version(s): 2.4,2.5,2.6

search.alow.maintain.admin

Whether or not to allow site maintainers to administer the search tool.
This property is used in Sakai version(s): 2.2,2.3

search.enable

Whether or not to enable the search tool.
This property is used in Sakai version(s): 2.4,2.5,2.6

search.experimental

Whether or not to enable the search tool.
This property is used in Sakai version(s): 2.2,2.3

search.indexbuild

Whether or not to build indexes for the search tool.
This property is used in Sakai version(s): 2.4,2.5,2.6

separateIdEid@org.sakaiproject.user.api.UserDirectoryService

Whether or not to use a separate value for a user's ID and EID.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

server.info.url

A URL containing information about this Sakai instance. Can be set to point to a resource stored within Sakai.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

serverId

The unique identifier for a particular node in a cluster.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

serverName

The service hostname for this sakai installation.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

serverUrl

The canonical URL associated with this sakai instance.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

servlet.container

The name of the servlet container to use. Setting this to "websphere" enables specific functionality. Any other setting enables the default behavior.
This property is used in Sakai version(s): 2.6

setup.request

The return email address for Worksite Setup or Site Info tool change notification messages.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sharedJournalBase@org.sakaiproject.search.api.JournalSettings

The shared directory for search journaling.
This property is used in Sakai version(s): 2.5,2.6

sit.accessibility

The text associated with the URL specified in accessibility.url.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.contentporttit

The title associated with the content portal iframe.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.contentshead

The text of the header for the content portal iframe.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.help

The text associated with the help link.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.jumpcontent

The text associated with the "jump to content" link.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.jumptools

The text associated with the "jump to tools" link.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.jumpworksite

The text associated with the "jump to worksites" link.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.log

The failover text that appears when logout.text is null.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.more

The text associated with the "more" link that appears when a user is enrolled in more sites than can be displayed as tabs.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.mywor

The text associated with the "My Workspace" link.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.presenceiframetit

The title of the presence iframe displayed on the portal.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.presencetitle

The header text for the presence module displayed on the portal.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.selectmessage

The textual hint to assist users in using the "more sites" dropdown.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.toolshead

The textual hint to assist users in using the tools panel.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.worksite

The text to add at the end of each site's name.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.worksites

The title of the worksites iframe displayed on the portal.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sit.worksiteshead

The textual hint to assist users in using the worksite navigation tabs.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

site-manage.campusUserDirectory

A url to look up a user id in your institute.
This property is used in Sakai version(s): 2.4,2.5,2.6

site-manage.cms.subject.category

The category used for subject/department in the default CM impl data.
This property is used in Sakai version(s): 2.4,2.5,2.6

site-manage.cms.subject.label

The label used for subject/department in the default CM impl data.
This property is used in Sakai version(s): 2.4,2.5,2.6

site-manage.courseManagementSystemImplemented

If set to true, the CM service is consulted to find courses associated with the user in order to create a course selection list. The user can still choose to setup sites ?manually? (by entering the course information rather than selecting from a list or dropdowns). If set to false, users are only able to setup course sites by manually entering the course information. The default is true.
This property is used in Sakai version(s): 2.4,2.5,2.6

site.enableCreateAnyUser

Whether or not to allow users creating a site to search and add sections from other users.
This property is used in Sakai version(s): 2.4,2.5,2.6

site.setup.import.file

Whether or not to allow the import of a site from a file during the site setup.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

site.visit.unp

Whether or not to allow visits to an unpublished site.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

siteQuota@org.sakaiproject.content.api.ContentHostingService

The site resource quota (in Kb).
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sitebrowser.termsearch.property

The site property to use when searching by term
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sitebrowser.termsearch.type

The type of site to search by term (typically "course").
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

sitesearch.noshow.sitetype

A type of site to exclude from site search results. "My Workspace" sites are excluded whether or not this is set.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

skin.default

The default skin to use for the portal and sites.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

skin.force

Whether or not to allow users to select a custom skin.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

skin.repo

The relative path to the directory containing all available skins (generally TOMCAT_HOME/webapps).
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

skin.root

The relative or absolute URL of the directory containing all available skins.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

smtp.dns.1

The IP address for the primary DNS server (used by James to lookup the outgoing mail host).
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

smtp.dns.2

The IP address for the primary DNS server (used by James to lookup the outgoing mail host).
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

smtp.enabled

Whether or not to accept incoming SMTP requests.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

smtp.port

The port number on which James should listen for incoming SMTP requests.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

smtp@org.sakaiproject.email.api.EmailService

The hostname of the server that handles outgoing SMTP messages.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

smtpFrom@org.sakaiproject.email.api.EmailService

The smtp mail envelope return address used for outgoing messages.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

smtpPort@org.sakaiproject.email.api.EmailService

The port to use for outgoing SMTP mail messages.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

stealthTools@org.sakaiproject.tool.api.ActiveToolManager

The list of tool IDs to "stealth", or hide from the "Edit Tools" menu.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

storagePath@org.sakaiproject.archive.api.ArchiveService

The directory location in which to store directories and files created using the archive tool.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

studentview.roles

A comma-delimited list of site roles to which users can switch. This allows admins to specify default roles for students if they do not already have a role in the site.
This property is used in Sakai version(s): 2.6

style.permissions.map

A map of the default permissions for the OSP style tool. Each numbered instance of this variable should have a corresponding siteTypes and value option. For example, if style.permissions.map.1 is set, at a minimum style.permissions.map.1.siteTypes, style.permissions.map.1.value.count and style.permissions.map.1.value.1 must be set.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

style.permissions.map.{number}.siteTypes

A list of site types (portfolio, course, project, etc.) for which the permission map should be used.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

style.permissions.map.{number}.value

A list of the actual permissions that should be assigned to the role specified in style.permissions.map.{number}.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

style.permissions.override

Whether or not to override the existing style permissions with those set in style.permissions.map. If set to true, only the permissions set in style.permissions.map will be set. If set to false, the permissions set in style.permissions.map will be set in addition to any existing permissions.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

support.email

The email address used when rejecting incoming messages.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

syllabus.resources.show_all_collections.helper

Whether or not to display the "Show Other Sites" link in the file picker used by the syllabus tool.
This property is used in Sakai version(s): 2.2,2.3,2.4,2.5,2.6

  • No labels

4 Comments

  1. Missing property:

    site.types

    This property allows you to specify the available list of site types to choose from in the Worksite Setup tool
    Defaults to course,project,portfolio if not specified.
    Since: 2.4 onwards.

  2. New property for 2.7+

    session.parameter.allow=true

    in order to use: http://SAKAIURL/portal=sakai.session=XXX

  3. From 2.6.3 forwards site.title.maxlength controls the manlength of site titles that can be added through Worksite Setup.

    As of 2.8 this property also controls the truncation of site titles in the display of portal tabs (as per https://jira.sakaiproject.org/browse/SAK-19152 ).

  4. The value of siteQuota@org.sakaiproject.content.api.ContentHostingService defaults to 1048576 (128MB). I've checked this for Sakai 2.5.3 and 2.8.

    I't quite confusing because one would expect it would be unlimited by default.