Sakai Properties Reference - S
sak11204.forceupgrade
Whether or not to force the upgrade required to fix SAK-11204 on startup.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.5
sakai.datawarehouse.dbLoader.properties.alterTables
Whether or not to alter the data warehouse tables.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.5
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.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.5
sakai.datawarehouse.dbLoader.properties.createTables
Whether or not to create the data warehouse tables.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.5
sakai.datawarehouse.dbLoader.properties.dropTables
Whether or not to drop the data warehouse tables.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.5
sakai.datawarehouse.dbLoader.properties.indexTables
Whether or not to create indexes for the data warehouse tables.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.5
sakai.datawarehouse.dbLoader.properties.populateTables
Whether or not populate the data warehouse tables.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.5
sakai.datawarehouse.dbLoader.properties.tableScriptFileName
The location of a script that will be run when initializing the OSP data warehouse.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.5
sakai.datawarehouse.useWarehouse
The types of reports to generate from the OSP data warehouse.
Syntax
Accepts a value of 0,1,2 or 3. Set to 0 to disable reports, 1 to generate warehouse reports, 2 to generate live reports, and 3 for both warehouse and live reports. The default value is 1.
Version
This property is used in the following version(s) of Sakai: 2.5
sakai.reports.forceColumnLabelUppercase
Controls whether or not the reports tool will force table column names to be entered in uppercase (used for better compatibility between Oracle and MySQL). Set to 0 to leave column names in their existing case, set to 1 to force column names into uppercase.
Syntax
can be set to 0 or 1.
Version
This property is used in the following version(s) of Sakai: 2.5
sakai.reports.useWarehouse
Controls the mode in which reports are generated. 0 is no reports. 1 is the warehouse reports. 2 is live data reports. and 3 is both warehouse and live data reports. The default is 1. The default report has a setting of operating on the warehouse.
Syntax
Can be set to 0,1,2 or 3
Version
This property is used in the following version(s) of Sakai: 2.5
sakai.rutgers.linktool.serverUrl
The URL that will be encoded into the signed set of parameters passed by the link tool.
Syntax
Accepts a valid URL.
Version
This property is used in the following version(s) of Sakai: 2.3,2.4,2.5
sakai.site.multiPlacementTools
The list of tool IDs to allow to be placed multiple times in a single site.
Syntax
Accepts a comma-delimited list of valid site IDs.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
sakai.xml.sax.parser
The classname of the SAX parser to use.
Syntax
Accepts the class name of a SAX parser.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
sakaiServerKey@org.sakaiproject.citation.api.ConfigurationService
The server key that is added to Google Scholar urls.
Syntax
A valid server key.
Version
This property is used in the following version(s) of Sakai: 2.5
sam_file_upload_comment_out
Whether or not to disable file uploads in SAMigo.
Syntax
Can be set to true or false. If this is true, file upload fields will be commented out and hence not available.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
samigo.answerUploadRepositoryPath
The directory in which file resources uploaded in SAMigo will be stored.
Syntax
Accepts a valid directory location.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
samigo.email.bypassAuth
Whether or not the mail server specified in samigo.smtpserver requires a username and password.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
samigo.email.password
The password to use when communicating with the mail server used for SAMigo.
Syntax
Accepts a valid password.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
samigo.email.prefixedPath
The directory in which to store samigo's email attachment directory.
Syntax
Accepts a valid directory location.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
samigo.email.prefixedPath
The directory in which to store samigo's email attachment directory.
Syntax
Accepts a valid directory location.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
samigo.email.username
The username to use when communicating with the mail server used for SAMigo mail messages.
Syntax
Accepts a valid username.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
samigo.samliteEnabled
Whether or not to display a "Quick Create" button on the Assesments home page in SAMigo.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
samigo.saveMediaToDb
Whether or to save media entered using samigo to the database.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.3,2.4,2.5
samigo.sizeMax
The maximum size (in bytes) allowed for a single file uploaded using samigo.
Syntax
Accepts an integer value.
Version
This property is used in the following version(s) of Sakai: 2.3,2.4,2.5
samigo.sizeThreshold
This parameter is set, but does not appear to be used by any code.
Syntax
Accepts an integer value.
Version
This property is used in the following version(s) of Sakai: 2.3,2.4,2.5
samigo.smtp.port
The port number to communicate with the mail server used for outgoing SAMigo messages.
Syntax
Accepts a valid integer.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
samigo.smtp.server
The mail server to use for messages sent by SAMigo.
Syntax
Accepts a valid hostname.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
scaffolding.permissions.map
Define the default scaffolding permissions for one or more roles.
Syntax
You must have a scaffolding.permissions.map.count parameter indicating the total number of roles for which default permissions are defined. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if scaffolding.permissions.map.count is set to 2, you would be expected to provide a scaffolding.permissions.map.1 and scaffolding.permissions.map.2 setting. In addition to the number instance itself (which defines the role for the permission map), the numbered instances of this variable should have their own options for siteTypes and value.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
scaffolding.permissions.map.{number}.siteTypes
A list of site types (portfolio, course, project, etc.) for which the permission map should be used.
Syntax
Accepts a list of valid site types.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
scaffolding.permissions.map.{number}.value
A list of the actual permissions that should be assigned to the role specified in scaffolding.permissions.map.{number}.
Syntax
You must have a scaffolding.permissions.map.{number}.value.count parameter indicating the total number of permissions defined for this role. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if scaffolding.permissions.map.{number}.value.count is set to 2, you would be expected to provide a scaffolding.permissions.{number}.value.map.1 and scaffolding.permissions.{number}.value.map.2 setting.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
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.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
scheduler.event.archive.enabled
This property does not currently appear to be used.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
scheduler.event.archive.length
The length of time (in milliseconds) that sessions are allowed to sit around before being archived.
Syntax
Accepts a valid integer.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
schemaUpdate@org.sakaiproject.springframework.orm.hibernate.SessionFactoryBase
Whether or not to execute a schema update after initialize the session factory.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
search.allow.maintain.admin
Whether or not to allow site maintainers to administer the search tool.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
search.alow.maintain.admin
Whether or not to allow site maintainers to administer the search tool.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.2,2.3
search.enable
Whether or not to enable the search tool.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
search.experimental
Whether or not to enable the search tool.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.2,2.3
search.indexbuild
Whether or not to build indexes for the search tool.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
separateIdEid@org.sakaiproject.user.api.UserDirectoryService
Whether or not to use a separate value for a user's ID and EID.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
server.info.url
A URL containing information about this Sakai instance. Can be set to point to a resource stored within Sakai.
Syntax
Accepts a valid relative or absolute URL.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
serverId
The unique identifier for a particular node in a cluster.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
serverName
The service hostname for this sakai installation.
Syntax
Accepts a valid hostname.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
serverUrl
The canonical URL associated with this sakai instance.
Syntax
Accepts a valid URL.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
setup.request
The return email address for Worksite Setup or Site Info tool change notification messages.
Syntax
Accepts a valid email address.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sharedJournalBase@org.sakaiproject.search.api.JournalSettings
The shared directory for search journaling.
Syntax
Accepts a valid directory location.
Version
This property is used in the following version(s) of Sakai: 2.5
sit.accessibility
The text associated with the URL specified in accessibility.url.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.contentporttit
The title associated with the content portal iframe.
Syntax
Any text that is valid inside the title attribute of an iframe tag.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.contentshead
The text of the header for the content portal iframe.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.help
The text associated with the help link.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.jumpcontent
The text associated with the "jump to content" link.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.jumptools
The text associated with the "jump to tools" link.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.jumpworksite
The text associated with the "jump to worksites" link.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.log
The failover text that appears when logout.text is null.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
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.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.mywor
The text associated with the "My Workspace" link.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.presenceiframetit
The title of the presence iframe displayed on the portal.
Syntax
Any text that is valid inside the title attribute of an iframe tag.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.presencetitle
The header text for the presence module displayed on the portal.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.selectmessage
The textual hint to assist users in using the "more sites" dropdown.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.toolshead
The textual hint to assist users in using the tools panel.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.worksite
The text to add at the end of each site's name.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.worksites
The title of the worksites iframe displayed on the portal.
Syntax
Any text that is valid inside the title attribute of an iframe tag.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sit.worksiteshead
The textual hint to assist users in using the worksite navigation tabs.
Syntax
Any text, including special characters and HTML.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
site-manage.campusUserDirectory
A url to look up a user id in your institute.
Syntax
Accepts a valid URL.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
site-manage.cms.subject.category
The category used for subject/department in the default CM impl data.
Syntax
Accepts a valid category.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
site-manage.cms.subject.label
The label used for subject/department in the default CM impl data.
Syntax
Accepts text including valid HTML.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
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.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
site.enableCreateAnyUser
Whether or not to allow users creating a site to search and add sections from other users.
Syntax
Can be set to true or false.
Version
This property is used in the following version(s) of Sakai: 2.4,2.5
site.setup.import.file
Whether or not to allow the import of a site from a file during the site setup.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
site.visit.unp
Whether or not to allow visits to an unpublished site.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
siteQuota@org.sakaiproject.content.api.ContentHostingService
The site resource quota (in Kb).
Syntax
Accepts an integer value. Set to 0 to disable site quotas.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sitebrowser.termsearch.property
The site property to use when searching by term
Syntax
Accepts a valid site property.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sitebrowser.termsearch.type
The type of site to search by term (typically "course").
Syntax
Accepts a valid site type.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
sitesearch.noshow.sitetype
The type of site to exclude from site search results. "My Workspace" sites are excluded whether or not this is set.
Syntax
Accepts a valid site type.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
skin.default
The default skin to use for the portal and sites.
Syntax
This should be set to the exact name of a directory stored in webapps/library/skin.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
skin.force
Whether or not to allow users to select a custom skin.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
skin.repo
The relative path to the directory containing all available skins.
Syntax
Accepts a valid path relative to the webapps directory of the sakai instance.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
skin.root
The relative or absolute URL of the directory containing all available skins.
Syntax
Accepts a valid relative or absolute URL.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
smtp.dns.1
The IP address for the primary DNS server (used by James to lookup the outgoing mail host).
Syntax
Must be a valid IP address and not a hostname.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
smtp.dns.2
The IP address for the primary DNS server (used by James to lookup the outgoing mail host).
Syntax
Must be a valid IP address and not a hostname.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
smtp.enabled
Whether or not to accept incoming SMTP requests.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
smtp.port
The port number on which James should listen for incoming SMTP requests.
Syntax
Must be set to a number corresponding to an unused port. On most UNIX variants, if this number is set below 1024, sakai must be run as root.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
smtp@org.sakaiproject.email.api.EmailService
The hostname of the server that handles outgoing SMTP messages.
Syntax
Accepts a valid hostname.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
smtpFrom@org.sakaiproject.email.api.EmailService
The smtp mail envelope return address used for outgoing messages.
Syntax
Accepts a valid email address.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
smtpPort@org.sakaiproject.email.api.EmailService
The port to use for outgoing SMTP mail messages.
Syntax
Accepts a valid port number.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
stealthTools@org.sakaiproject.tool.api.ActiveToolManager
The list of tool IDs to "stealth", or hide from the "Edit Tools" menu.
Syntax
A list of tool IDs separated by commas. If this is set to blank, all tools not listed in hiddenTools@org.sakaiproject.tool.api/ActiveToolManager will be available (not recommended).
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
storagePath@org.sakaiproject.archive.api.ArchiveService
The directory location in which to store directories and files created using the archive tool.
Syntax
Accepts a valid directory location.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
style.permissions.map
A map of the default permissions for the OSP style tool.
Syntax
You must have a style.permissions.map.count parameter indicating the total number of roles for which default permissions are defined. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if style.permissions.map.count is set to 2, you would be expected to provide a style.permissions.map.1 and style.permissions.map.2 setting. In addition to the number instance itself (which defines the role for the permission map), the numbered instances of this variable should have their own options for siteTypes and value.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
style.permissions.map.{number}.siteTypes
A list of site types (portfolio, course, project, etc.) for which the permission map should be used.
Syntax
Accepts a list of valid site types.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
style.permissions.map.{number}.value
A list of the actual permissions that should be assigned to the role specified in style.permissions.map.{number}.
Syntax
You must have a style.permissions.map.{number}.value.count parameter indicating the total number of permissions defined for this role. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if style.permissions.map.{number}.value.count is set to 2, you would be expected to provide a style.permissions.{number}.value.map.1 and style.permissions.{number}.value.map.2 setting.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
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.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
support.email
The email address used when rejecting incoming messages.
Syntax
Accepts a valid email address.
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5
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.
Syntax
Can be set to true or false
Version
This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5