Sakai Properties Reference - Full
- Former user (Deleted)
- Former user (Deleted)
- Former user (Deleted)
- Former user (Deleted)
Sakai Properties Reference - Full
Introduction
This is a full list of documented configuration options which can be set using the sakai.properties file. To view this file in sections, use the alphabetical index.
Sakai Properties Reference - A
Property Name |
Description |
|---|---|
accessPath |
Specifies the URL to the access path. This partial URL is used to construct the full URL for accessing resources. For example, the URL to a resource might be http://localhost:8080/access/content/group/1100899697301-3493876 /report.doc where serverUrl is http://localhost:8080, accessPath is /access and /content/group/1100899697301-3493876/report represents the location of the resource. |
accessToUnderlyingConnectionAllowed@javax.sql.BaseDataSource |
Whether or not to allow access to the underlying connections. |
accessibility.url |
A URL that provides accessibility information. The text specified in sit.accessibility is enclosed in the anchor tag associated with this value. |
activeInactiveUser |
Whether or not to allow site maintainers to activate/deactivate user enrollments. |
allow.basic.auth.login |
Whether or not to allow users to authenticate using HTTP Basic Auth. |
allowGroupAssignments@org.sakaiproject.assignment.api.AssignmentService |
Whether or not to enable group awareness in ungraded assignments. By default this is true and Assignments is group aware. |
allowGroupAssignmentsInGradebook@org.sakaiproject.assignment.api.AssignmentService |
Whether or not to enable group awareness in graded assignments. By default this is true and Assignments is group aware. |
allowGroupResources |
Whether or not to make the resources tool group-aware. |
announcement.merge.display |
Whether or not to show the "merge" link in the announcements tool to users with the appropriate permissions (site.upd). |
assignment.instructor.notifications |
Whether or not to enable instructor assignment notifications. If set to false, instructors will not be notified when students complete assignments, and the instructor email options will be hidden. |
assignment.instructor.notifications.default |
The method by which to send out assignment notifications to instructors. |
assignment.submission.confirmation.email |
Whether or not send assignment submission confirmation emails to students. |
assignment.useContentReview |
Whether or not to add assignment submissions to a queue that will be processed by a content review service. |
auto.ddl |
Whether or not to create and update database structures automatically |
availabilityChecksEnabled@org.sakaiproject.content.api.ContentHostingService |
Whether or not to allow availability dates for resources. |
Sakai Properties Reference - B
Property Name |
Description |
|---|---|
batchWrite@org.sakaiproject.event.api.EventTrackingService |
Whether or not to write events to the database in batches. |
bodyPath@org.sakaiproject.content.api.ContentHostingService |
The directory in which file resources will be stored. See bodyVolumes@org.sakaiproject.content.api.ContentHostingService for information about storing files in several directories. |
bodyVolumes@org.sakaiproject.content.api.ContentHostingService |
A list of folders to distribute file content between. Folders will be created in the directory location specified by the bodyPath@org.sakaiproject.content.api.ContentHostingService |
bottom.copyrighttext |
The copyright text that appears in the footer of the main portal and OSP portal. |
bottomnav |
One or more lines of text (including HTML) that appear as navigational links at the bottom of the main portal and OSP portal. |
Sakai Properties Reference - C
Property Name |
Description |
|---|---|
cache.osp.presentation |
Whether or not to cache presentation data for OSP presentations. |
cacheCleanerMinutes@org.sakaiproject.alias.api.AliasService |
The time (in minutes) between alias cache cleanings. |
cacheCleanerMinutes@org.sakaiproject.site.api.SiteService |
The time (in minutes) betweensite service cache cleanings. |
cacheCleanerMinutes@org.sakaiproject.user.api.UserDirectoryService |
The time (in minutes) between user directory cache cleanings. |
cacheLogging@org.sakaiproject.memory.api.MemoryService |
Whether or not the memory cache should log debugging messages. |
cacheMinutes@org.sakaiproject.alias.api.AliasService |
The time (in minutes) to cache an alias. |
cacheMinutes@org.sakaiproject.authz.api.SecurityService |
The time (in minutes) to cache authz information. |
cacheMinutes@org.sakaiproject.site.api.SiteService |
The time (in minutes) to cache site queries. |
cacheMinutes@org.sakaiproject.user.api.UserDirectoryService |
The time (in minutes) to cache user directory service queries. |
calendar |
The ID of the calendar to use instead of the site calendar. |
calendar.merge.display |
Whether or not to allow users to merge calendar entries. |
calendarSummary.highPriorityColor |
The color to use for high priority events in the calendar summary. |
calendarSummary.highPriorityEvents |
The name of a type of high-priority event. |
calendarSummary.lowPriorityColor |
The color to use for low priority events in the calendar summary. |
calendarSummary.lowPriorityEvents |
The name of a type of low-priority event. |
calendarSummary.mediumPriorityColor |
The color to use for medium priority events in the calendar summary. |
calendarSummary.mediumPriorityEvents |
The name of a type of a medium-priority event. |
calendarSummary.viewMode |
Whether the calendar summary should display a week or a month at a time. |
caseSensitiveId@org.sakaiproject.user.api.UserDirectoryService |
Whether or not user EIDs are case sensitive. If the EID and ID are different, this setting does not affect user IDs. |
channel |
The ID of the channel to use instead of the site channel. |
charon.directurl |
Whether or not to restore a saved restore state in the portal if it exists. |
chatMigrationExecuteImmediate@org.sakaiproject.chat2.model.impl.ChatDataMigration |
Whether or not to migrate data from the previous version of chat (Sakai 2.3 or earlier) to the current version (Sakai 2.5 or later). |
checkDb@org.sakaiproject.event.api.EventTrackingService |
Whether or not to check the database for new events. |
checkEvery@org.sakaiproject.tool.api.SessionManager |
How often (in seconds) to check for expired sessions. |
citationsEnabledByDefault@org.sakaiproject.citation.api.ConfigurationService |
Whether or not the citations helper is enabled by default for all sites. |
config@org.sakaiproject.section.api.SectionManager |
Used to control how sections are created in the Section Info tool. If set to MANUAL_MANDATORY, the section Info tool does not allow for externally managed sections, and sections will never be created automatically. If set to MANUAL_DEFAULT, the section Info tool allows the user to choose whether sections should be internally or externally managed. Sections will not be generated for sites unless a site maintainer switches the default "manual" setting to automatic. If set to AUTOMATIC_DEFAULT, the section Info tool allows the user to choose whether sections should be internally or externally managed. Sections will be generated for sites associated with any number of rosters. The default setting for new sites will be automatic management of sections. If set to AUTOMATIC_MANDATORY, the section Info tool does not allow for internally managed sections. Add sections are created automatically, based on the rosters associated with the site. |
configviewer.usejavascript |
Whether or not to use javascript within the Config Viewer tool to convert long text blocks to tooltips. |
container.login |
Whether or not to check the container on login. |
content.mime.inline |
A mime type (ala text/html) that is to be displayed inline. |
content.quota.{site type} |
The quota size (in bytes) for the specified site type. |
content.upload.ceiling |
Specifies an absolute maximum size (in bytes) allowed for a single file uploaded using a multipart form. Does not impact DAV. When not set, the value of content.upload.max is used. |
content.upload.dir |
Specifies the location where commons-fileupload stores uploads as they are being processed. |
content.upload.max |
The maximum size (in megabytes) allowed for a single file uploaded using a multipart form. Does not impact DAV. |
convertToFile@org.sakaiproject.content.api.ContentHostingService |
Whether or not to move file content stored in the database to the filesystem. |
copyright.use_creative_commons |
Whether or not to display additional configuration options used to select a particular variation of the Creative Commons License. |
copyrighttype |
The textual wording for an acceptable type of copyright to be used when uploading resources into Sakai. |
copyrighttype.new |
The textual wording of the default copyright to be used when uploading resources into Sakai. Must match one of the copyright types defined by a copyrighttype configuration parameter. |
copyrighttype.own |
The textual wording of the default copyright to be used when uploading resources into Sakai. Must match one of the copyright types defined by a copyrighttype configuration parameter. |
courseSiteType |
The type of site associated with a course (defaults to "course"). |
Sakai Properties Reference - D
Property Name | Description |
|---|---|
dateWidget.defaultFormat | The default format the date widget. If this is set to "dd/MM/yyyy", January 2nd 2003 would be displayed as 01/02/2003, otherwise it would be displayed as 02/01/2003. |
default.copyright | The textual wording of the default copyright to be used when uploading resources into Sakai. Must match one of the copyright types defined by a copyrighttype configuration parameter. |
default.copyright.alert | Whether or not to display an alert when the default copyright is selected. |
defaultAutoCommit@javax.sql.BaseDataSource | Whether or not to commit database changes automatically. |
defaultReadOnly@javax.sql.BaseDataSource | Whether or not borrowed database connections are read only by default. |
defaultTransactionIsolation@javax.sql.BaseDataSource | The integer value for the transaction isolation level. Use defaultTransactionIsolationString instead. |
defaultTransactionIsolationString@javax.sql.BaseDataSource | A string that controls transaction isolation, review the documentation for your JDBC driver before attempting to change this. Typically set to TRANSACTION_READ_COMMITTED (preferred for MySQL) or TRANSACTION_READ_UNCOMMITTED (the default for HSQL). |
| defaultValue@org.sakaiproject.user.api.UserNotificationPreferencesRegistration.XXXX | The integer value to set the default user notification preferences. XXXX should be substituted by the tool, the possible values are: content, announcement, content, external, mailarchive, matrix, syllabus, wizard Values: PREF_NONE = 0 (Default no preference) PREF_IGNORE = 1 (Do not send me low priority) PREF_DIGEST = 2 (Send me one email per day) PREF_IMMEDIATE = 3 (Send me each notification separately) |
disable.course.site.skin.selection | Whether or not to allow course sites to select a custom skin. |
disable.membership.unjoin.selection | Whether or not to disable the link used to unjoin a site. |
display.help.icon | Whether or not to display the help icon in the upper right of each tool window. |
display.help.menu | Whether or not to display a link to help on the left hand navigation menu. |
display.users.present | Whether or not to display the users present below the left-hand navigation bar. |
driverClassName@javax.sql.BaseDataSource | The JDBC driver to use when connecting to the database. |
Sakai Properties Reference - E
Property Name |
Description |
|---|---|
editViewRosterSiteType |
One or more site types (course, project, etc.) for which the roster edit view should be enabled. |
email.precedence.bulk |
Whether or not to add the "Precedence: Bulk" header to outgoing emails (avoids problems with vacation reminders). |
emailInAccountValue |
The default value entered in the account creation form when creating a non-official (guest) account. |
emailInIdAccount.url |
A URL containing information about non-official (guest) accounts, displayed on the account creation form. |
emailInIdAccountInstru |
The instructions to display when creating non-official (guest) accounts. |
emailInIdAccountLabel |
The label for non-official (guest) accounts, displayed on the account creation form. |
emailInIdAccountName |
A shorter label for non-official (guest) accounts. |
enable.privacy.status |
Whether or not privacy status is enabled. Does not appear to be accessed in any tools. |
enabled@org.sakaiproject.log.api.LogConfigurationManager |
As of Sakai 2.2, logging controls are part of the new LogConfigurationManager,? implemented as a component, the Log4jConfigurationManager, in the?util module.? This component works only if the log4j configuration?has a "sakai" appender (which ours does).? It can also be disabled by setting the property to false. |
expired@org.sakaiproject.cluster.api.ClusterService |
The time in seconds after which an inactive server will be expired from the cluster. |
Sakai Properties Reference - G
Property Name |
Description |
|---|---|
gatewaySiteId |
The site id of the site which is used for the installation's gateway (login page). This site will be shown when users go to the URL set in the serverURL property. |
gatewaySiteList |
A comma separated list of siteIDs to display on the gateway page (which is displayed to users before they log in). These sites must include the .anon role and at a minimum give the .anon role site.visit - and any other permissions you want(usually *.read). If the .anon role does not have site.visit, these sites will not appear in the gateway even if they are in this list. If this is not set, the portal simply displays a single gateway site specified by gatewaySiteId. |
gatewaySiteListDisplayCount |
The number of site tabs to display when presenting the gateway site to users who are not logged in. |
ghostingPercent@org.sakaiproject.cluster.api.ClusterService |
The percentage of maintenance passes to run the full de-ghosting / cleanup activities, including delisting stale server nodes. |
glossary.permissions.map |
A map of the default permissions for the each role used with the OSP glossary tool. Each numbered instance of this variable should have a corresponding siteTypes and value option. For example, if glossary.permissions.map.1 is set, at a minimum glossary.permissions.map.1.siteTypes, glossary.permissions.map.1.value.count and glossary.permissions.map.1.value.1 must be set. |
glossary.permissions.map.{number}.siteTypes |
A list of site types (portfolio, course, project, etc.) for which the permission map defined in glossary.permissions.map should be used. |
glossary.permissions.map.{number}.value.count |
A list of the default permissions that should be assigned to the role specified in glossary.permissions.map. |
glossary.permissions.override |
Whether or not to override the existing glossary permissions with those set in glossary.permissions.map. If set to true, only the permissions set in glossary.permissions.map will be set. If set to false, the permissions set in glossary.permissions.map will be set in addition to any existing permissions. |
googleSearchEnabled@org.sakaiproject.citation.api.ConfigurationService |
Whether or not searching via Google Scholar is enabled. |
gradToolsSiteType |
One or more site types (course, project, etc.) for which grad tools should be displayed. |
Sakai Properties Reference - H
Property Name |
Description |
|---|---|
help.button |
Whether or not to show the help button. |
help.hide |
A list of tools whose help should not be added to the help index. |
help.id |
The tool ID to display when opening the help tool. If specified, the help for the document with this ID will be opened instead of the contextual help for a specific tool |
help.location |
An external location for help information. |
help.redirect.external.webapp |
An external location for help information. |
help.url |
The URL to use instead of the built-in help. |
help.welcomepage |
The location of the help welcome page. |
helpPath |
Specifies the URL to the help path. This partial URL is used to construct the full URL for accessing help content. For example, http://localhost:8082/portal/help/TOCDisplay/content.hlp?docId=aqyk |
hibernate.c3p0.max_size |
The maximum size of the C3P0 connection pool. |
hibernate.c3p0.max_statements |
The maximum number of statements to cache, set to 0 to disable caching. |
hibernate.c3p0.min_size |
The minimum size of the C3P0 connection pool. |
hibernate.c3p0.timeout |
The maximum time (in seconds) to leave a connection idle before closing it. |
hibernate.default_schema |
Specifies the default database schema to use. |
hibernate.dialect |
Which hibernate dialect to use. |
hibernate.show_sql |
Whether or not to show the SQL statements used by hibernate in the tomcat logs. |
hibernateProperties@org.sakaiproject.springframework.orm.hibernate.SessionFactoryBase |
The location and name of the hibernate properties file (defaults to hibernate.properties). |
hiddenTools@org.sakaiproject.tool.api.ActiveToolManager |
The list of tool IDs to hide from the "Edit Tools" menu. This option and the stealthTools@org.sakaiproject.tool.api.ActiveToolManager together make up the entire list of tools that will not appear. You might use this if you wished to preserve the default settings for stealthTools but add a few additional tools to the list. |
Sakai Properties Reference - I
Property Name |
Description |
|---|---|
ical.experimental |
Whether or not to enable exports of calendar data in iCal format. |
iconNames |
One or more names to associated with an icon that will appear ?. |
iconSkins |
One or more skins to be associated with an icon that will appear ?. |
iconUrls |
One or more URLs for an icon that will appear ?. |
iframe.allowed.macros |
A list of macros that are allowed to be replaced in URLs handled by the web content tool. The allowed macros will be replaced with data from Sakai. Useful in tying web content to URLs specific to the user, session, et cetera. Valid macros are: ${SITE_ID},${USER_ID},${USER_EID},${USER_FIRST_NAME},${USER_LAST_NAME},${USER_ROLE}, and ${SESSION_ID}. |
import.importAsDraft |
Whether or not imported items should be flagged as a draft. |
inactiveInterval@org.sakaiproject.tool.api.SessionManager |
How long (in seconds) a session is allowed to be inactive before it can be removed. |
initialSize@javax.sql.BaseDataSource |
The number of initial connections created when the pool is started. |
invalidEmailInIdAccountString |
A list of patterns to detect invalid email addresses when creating new accounts. |
invalidNonOfficialAccountString |
A list of patterns to detect invalid email addresses when creating new accounts. |
Sakai Properties Reference - J
Property Name |
Description |
|---|---|
java.beep |
Whether or not to use a beep to notify of new messages in the chat tool. |
jcr.experimental |
Whether or not to enable JCR (Jackrabbit). |
jobscheduler.invocation.interval |
how often (in seconds) to invoke the job scheduler. |
Sakai Properties Reference - L
Property Name |
Description |
|---|---|
linktool.home |
The shared directory in which linktool keys are deployed in shared environments. |
localIndexBase@org.sakaiproject.search.api.JournalSettings |
A local directory used to store search index data. |
locales |
A comma-delimited list of supported locales. |
log.config |
Override the default logging for one or more components. Use the name of the actual fully qualified classname which has the logging in it (example: DEBUG.org.sakaiproject.email.impl.BasicEmailService) and not the classname of the service api. |
logAbandoned@javax.sql.BaseDataSource |
Whether or not to log stack traces for application code which abandons a statement or connection. |
logWriter@javax.sql.BaseDataSource |
The classname of the log writer. |
loggedOutUrl |
The URL users are sent to when they click the "logout" button. |
loggedOutUrl.userType |
If you want to send different user types to different URLs when they logout, set this property, eg loggedOutUrl.student= http://someplace.com. Will fallback to original loggedOutUrl if usertype is not set, or matching property is not set for this user type. |
login.browser.user.agent |
One or more additional browser agents to support when requesting HTTP basic authentication. The text of the actual setting should be a regex pattern that the desired agent will match. |
login.icon |
The source location of the login icon displayed in the portal. |
login.text |
The textual wording associated with the link to the login URL specified in the login.url property. Will not be displayed on the portal unless top.login is set to false. |
login.url |
The URL users are sent to when a login is required. This is the destination for the login link as well as the redirect that occurs when a protected resource is accessed without a login. |
login.use.xlogin.to.relogin |
Whether to force the use of "extreme logins" (/xlogin) instead of relogins. |
logout.icon |
The icon associated with the "logout" link. |
logout.text |
The textual wording of the link used to log out. |
Sakai Properties Reference - M
Property Name |
Description |
|---|---|
mail.importDir |
Used to specify the directory where email will be found when importing a non-Sakai email archive into Sakai. |
mail.support |
The email address users should contact for support. |
mailarchive.message-threshold |
The number of mail messages to return before disabling sorting, etc. for performance resaons. |
mailtool.group.aware.role |
Roles which should be group-aware in mailtool. |
mailtool.max.num.attachment |
The maximum number of attachments allowed per message. If this is not set, the default is 10000. Set to zero to disabled attachments. |
mailtool.show.renaming.roles |
Whether or not to show roles that have been renamed. |
mailtool.upload.directory |
The temporary directory to use when uploading attachments. Defaults to /tmp. |
maxActive@javax.sql.BaseDataSource |
The maximum number of active database connections (set to -1 for unlimited). |
maxIdle@javax.sql.BaseDataSource |
The maximum number of idle database connections (set to -1 for unlimited). |
maxOpenPreparedStatements@javax.sql.BaseDataSource |
The maximum number of prepared statements that can be allocated from the prepared statement pool at a single time (set to -1 for unlimited). |
maxRecipients@org.sakaiproject.email.api.EmailService |
Used to set the max recipients per outgoing?emails. It defaults to 100, which is the minimum?that the RFCs say an SMTP server should accept. If an announcement was made with notification, in a site with 500 participants, a setting of 100 results in 5 emails with 100 recipients each. |
maxWait@javax.sql.BaseDataSource |
The maximum amount of time (in milliseconds) to wait before throwing an exception when there are no available connections (set to -1 for unlimited). |
mc.default.{variable} |
The permission level for a particular role, where {variable} is replaced by an actual role name. |
mc.defaultLongDescription |
Whether or not to turn on the display of full descriptions by default. |
mc.disableLongDesc |
Whether or not to disable the display of full descriptions. |
mc.showForumLinksInNav |
Whether or not to show links to forums in message center. |
mc.threadedview |
Whether or not to display topics in a threaded view. |
melete.migrate |
Whether or not to migrate Melete content to Content Hosting. |
mercury.enabled |
Whether or not to enabled the mercury portal. Although tools should be secure when accessed through the mercury portal, the mercury portal makes it easier to find poorly secured tools and is typically only enabled for development use. |
mercury.login |
A list of eids that can be used to log in to the mercury portal. |
mercury.password |
A list of passwords associated with the eids defined using mercury.login. |
messagecenter.privacy.text |
The text of the privacy warning displayed on the private messages page. |
messagecenter.privacy.url |
A URL containing information about the site's privacy policy. This link will be associated with the text specified in messagecenter.privacy.text. |
migrateData@org.sakaiproject.content.api.ContentHostingService |
Whether or not to migrate content stored in the database to binary format. |
minEvictableIdleTimeMillis@javax.sql.BaseDataSource |
The amount of time (in milliseconds) an object may sit idle before it is eligible for eviction. |
minIdle@javax.sql.BaseDataSource |
The minimum number of Idle database connections. |
msgcntr.notification.from.address |
The email address Message Center notifications will appear to be from. |
msgcntr.notification.user.real.from |
Whether to send message center notifications using the user's email address. If set to true, notifications will appear to come from the email address of the user creating the notification. If set to false or if the 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 postmaster@(the value of the serverName property). |
myworkspace.info.url |
A page which describes the "My Workspace" site in general terms. |
Sakai Properties Reference - N
Property Name |
Description |
|---|---|
newcopyrightinput |
Whether or not to allow users to enter their own copyright formation. |
news.feedURL |
The default URL specified when adding a news tool to a worksite. |
news.title |
The default title specified when adding a news tool to a worksite. |
noEmailInIdAccountLabel |
The label for official (non-guest) accounts, displayed on the account creation form. |
noEmailInIdAccountName |
A shorter label for official (non-guest) accounts. |
noEmailInIdAccountValue |
The default value entered in the account creation form when creating an official (non-guest) account. |
nonOfficialAccount.url |
A URL containing information about non-official (guest) accounts, displayed on the account creation form. |
nonOfficialAccountInstru |
The instructions to display when creating non-official (guest) accounts. |
nonOfficialAccountLabel |
The label for non-official (guest) accounts, displayed on the account creation form. |
nonOfficialAccountName |
A shorter label for non-official (guest) accounts. |
nonOfficialAccountSectionTitle |
The title to use for the non-official (guest) account section of the acccount creation form |
nonOfficialAccountValue |
The default value entered in the account creation form when creating a non-official (guest) account. |
notifyNewUserEmail |
Whether or not to notify a new user that their account has been created. Used when creating guest accounts from the "Add Participants" section of the "Site Info" tool. |
numTestsPerEvictionRun@javax.sql.BaseDataSource |
The number of idle connections to evaluate per eviction run. |
Sakai Properties Reference - O
Property Name |
Description |
|---|---|
officialAccountLabel |
The label for official (non-guest) accounts, displayed on the account creation form. |
officialAccountName |
A shorter label for official (non-guest) accounts. |
officialAccountSectionTitle |
The title to use for the official (non-guest) account section of the acccount creation form |
officialAccountValue |
The default value entered in the account creation form when creating an official (non-guest) account. |
org.sakaiproject.site.tool.helper.order.rsf.PageListProducer.allowTitleEdit |
Whether or not to allow editing of tool titles using the page order helper tool. |
Sakai Properties Reference - OSP
Property Name | Description |
|---|---|
site.types | Enable creation of portfolio sites, in addition to course & project. This is required in Sakai 10 and later: site.types=course,project,portfolio |
cache.osp.presentation | Whether or not to cache presentation data for OSP presentations. |
metaobj.save.cookies | Default: false. Enable cookies to track form save attempts/success (SAK-15911); Default is false, meaning no new cookies |
notifyNewUserEmail | Default: true. Send an email to the user when the user is added (also controls whether or not guest users may be added to osp portfolios). |
osp.experimental.assignments | Default: false. No longer needed in current Sakai versions. Previously enabled selection & auto-population of matrix/wizard cells with assignments (SAK-10832). Current functionality allows this to happen without a Sakai property being set. |
osp.freeform.disabled | Default: false. Disables the ability for users to "Design Your Own" free form portfolios. Useful for those installations where only template-based portfolios are anticipated. |
osp.migration.developer | Whether or not to set the developer flag for migration testing. Should not be used on production systems. true / false |
osp.presentation.viewall | Default= false. If true, users with osp.presentation.review permission (SAK-16610); May view all portfolios in site (whether or not they've been shared). |
osp.preview.permission | Allow restricted view of preview matrices by permission (e.g. osp.matrix.scaffolding.edit) (SAK-15540); Default value is null (all can view) |
osp.reviewer.groups.allowall.global | Default: false. If true allow any (matrix/wizard) reviewer to view members independent of group membership |
osp.upgrade25 | Default: false. Set this to true when upgrading from Sakai 2.4 to 2.5 |
sakai.datawarehouse.dbLoader.properties.alterTables | Whether or not to alter the data warehouse tables. true / false |
sakai.datawarehouse.dbLoader.properties.createTables | Whether or not to create the data warehouse tables. true / false |
sakai.datawarehouse.dbLoader.properties.createTableScript | Whether or not to run the script specified in sakai.datawarehouse.dbLoader.properties.tableScriptFileName when initializing the Sakai data warehouse. true / false |
sakai.datawarehouse.dbLoader.properties.dropTables | Whether or not to drop the data warehouse tables. true / false |
sakai.datawarehouse.dbLoader.properties.indexTables | Whether or not to create indexes for the data warehouse tables. true / false |
sakai.datawarehouse.dbLoader.properties.populateTables | Whether or not populate the data warehouse tables. true / false |
sakai.datawarehouse.dbLoader.properties.tableScriptFileName | The location of a script that will be run when initializing the Sakai data warehouse. |
sakai.datawarehouse.useWarehouse | The types of reports to generate from the OSP data warehouse. |
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. true / false |
sakai.reports.useWarehouse | Default = 1. Controls the mode in which reports are generated. 0 is no reports. 1 is the warehouse reports. 2 is live data reports. 3 is both warehouse and live data reports. The default is 1. The default report has a setting of operating on the warehouse. |
xslt-portal.cacheTemplates | Default= true. Set this to false to disable caching of xslt templates (good for testing). |
OSP Legacy properties dealing with permissions
(pre-2.5; use standard Sakai permissions now)
Property Name |
|---|
glossary.permissions.map |
glossary.permissions.map.(number).siteTypes |
glossary.permissions.map.(number).value.count |
glossary.permissions.override |
presentation.permissions.map |
presentation.permissions.map.(number).siteTypes |
presentation.permissions.map.(number).value |
presentation.permissions.override |
presentationLayout.permissions.map |
presentationLayout.permissions.map.(number).siteTypes |
presentationLayout.permissions.map.(number).value |
presentationLayout.permissions.override |
presentationTemplate.permissions.map |
presentationTemplate.permissions.map.(number).siteTypes |
presentationTemplate.permissions.map.(number).value |
presentationTemplate.permissions.override |
review.permissions.map |
review.permissions.map.(number).siteTypes |
review.permissions.map.(number).value |
review.permissions.override |
scaffolding.permissions.map |
scaffolding.permissions.map.(number).siteTypes |
scaffolding.permissions.map.(number).value |
scaffolding.permissions.override |
style.permissions.map |
style.permissions.map.(number).siteTypes |
style.permissions.map.(number).value |
style.permissions.override |
wizard.permissions.map |
wizard.permissions.map.(number).siteTypes |
wizard.permissions.map.(number).value |
wizard.permissions.override |
Sakai Properties Reference - P
Property Name |
Description |
|---|---|
password@javax.sql.BaseDataSource |
The password to use when connecting to the database. |
performChatMigration@org.sakaiproject.chat2.model.impl.ChatDataMigration |
Whether or not to migrate chat data from version 1 to version 2 on server startup. |
period@org.sakaiproject.event.api.EventTrackingService |
The time to wait (in seconds) before checking the database for new events. |
podcasts.toolid |
The tool ID the podcasts tool will search for resources. Defaults to "sakai.resources" (the Resources tool). |
poh.unhideables |
The list of tools to prevent the pageOrderHelper from allowing to be unhidden. |
poolPreparedStatements@javax.sql.BaseDataSource |
Whether or not to pool prepared statements. |
portal.default.tabs |
The number of tabs to display in the portal by default. |
portal.error.email |
Email address to send errors caught by the portal, and user bug reports in response. |
portal.experimental.auto.reset |
Controls whether or not the state of a tool is reset each time it is opened using the site navigation menu. |
portal.experimental.includesubsites |
Whether or not to display sub-sites in the portal view. If set to "false", sub-sites will be displayed based on the preferences of each individual site. If set to "never", sub-sites will not be displayed regardless of site preferences. |
portal.experimental.maximizesinglepage |
Whether or not to maximize the display when only one site is available. |
portal.handler.default |
The portal handler prefix (the default is "site"). |
portal.includesubsites |
Whether or not to include subsites in the portal. If set to never, subsites will never be included. If set to false, subsites may be included depending on the site preferences. If set to any other value, subsites will always be included. |
portal.path |
Specifies the URL to the portal path. This partial URL is used to construct the full URL for accessing Sakai (e.g., http://localhost:8080/portal) |
portal.pda.experimental.iframesuppress |
Controls the use of iframes in the PDA portal. If the string contains the text ":none:", then iframes will not be suppressed. If the string contains the text ":all:", then by default all iframes will be suppressed, and only the tools whose ids are specified will be displayed with iframes. If the string contains the text ":debug:", then additional debugging information will be included in the HTML output. |
portal.pda.iframesuppress |
Controls the use of iframes in the PDA portal. If the string contains the text ":none:", then iframes will not be suppressed. If the string contains the text ":all:", then by default all iframes will be suppressed, and only the tools whose ids are specified will be displayed with iframes. If the string contains the text ":debug:", then additional debugging information will be included in the HTML output. |
portal.styleable |
Whether or not to attempt to generate a custom stylesheet based on the user preferences. |
portal.styleable.contentSummary |
Whether or not to attempt to generate javascript to support a custom stylesheet based on the user preferences. |
portal.use.dhtml.more |
Whether or not to use the DHTML version of the "More" tab on the portal. |
portalPath |
The path to the portal. |
portlet.support |
If set to "stealth", portlet support will be stealthed. Otherwise, portlets will be available in myworkspace, project, and course worksite types. |
powered.alt |
The alternate text associated with the image specified in the powered.img property. |
powered.img |
The "powered by" image to display in the footer of the main portal and OSP portal. |
powered.url |
The image specified by the powered.img property will be enclosed in a link to this URL. |
preference.pages |
A comma-delimited list of preference tabs (prefs_tab_title, prefs_noti_title, prefs_timezone_title, prefs_lang_title) which controls the order in which they are displayed. |
prefs.research.collab |
Whether or not collaborative research is enabled. Does not appear to be read from any tools. |
presence.inchat.icon |
As of 2.1.2, the presence in chat icon is to the left of the username, and is controlled by the tool_base.css file. The icon used is chatpresicon.gif. |
presentation.permissions.map |
A map of the default permissions for the OSP presentation tool. Each numbered instance of this variable should have a corresponding siteTypes and value option. For example, if presentation.permissions.map.1 is set, at a minimum presentation.permissions.map.1.siteTypes, presentation.permissions.map.1.value.count and presentation.permissions.map.1.value.1 must be set. |
presentation.permissions.map.{number}.siteTypes |
A list of site types (portfolio, course, project, etc.) for which the permission map defined in presentation.permissions.map should be used. |
presentation.permissions.map.{number}.value |
A list of the permissions that should be assigned to the role specified in presentation.permissions.map. |
presentation.permissions.override |
Whether or not to override the existing presentation permissions with those set in presentation.permissions.map. If set to true, only the permissions set in presentation.permissions.map will be set. If set to false, the permissions set in presentation.permissions.map will be set in addition to any existing permissions. |
presentationLayout.permissions.map |
A map of the default permissions for the OSP presentation layout tool. |
presentationLayout.permissions.map.{number}.siteTypes |
A list of site types (portfolio, course, project, etc.) for which the permission map should be used. |
presentationLayout.permissions.map.{number}.value |
A list of the actual permissions that should be assigned to the role specified in presentationLayout.permissions.map.{number}. Each numbered instance of this variable should have a corresponding siteTypes and value option. For example, if presentationLayout.permissions.map.1 is set, at a minimum presentationLayout.permissions.map.1.siteTypes, presentationLayout.permissions.map.1.value.count and presentationLayout.permissions.map.1.value.1 must be set. |
presentationLayout.permissions.override |
Whether or not to override the existing presentation layout permissions with those set in presentationLayout.permissions.map. If set to true, only the permissions set in presentationLayout.permissions.map will be set. If set to false, the permissions set in presentationLayout.permissions.map will be set in addition to any existing permissions. |
presentationTemplate.permissions.map |
A map of the default permissions for the OSP presentation template tool. Each numbered instance of this variable should have a corresponding siteTypes and value option. For example, if presentationTemplate.permissions.map.1 is set, at a minimum presentationTemplate.permissions.map.1.siteTypes, presentationTemplate.permissions.map.1.value.count and presentationTemplate.permissions.map.1.value.1 must be set. |
presentationTemplate.permissions.map.{number}.siteTypes |
A list of site types (portfolio, course, project, etc.) for which the permission map should be used. |
presentationTemplate.permissions.map.{number}.value |
A list of the actual permissions that should be assigned to the role specified in presentationTemplate.permissions.map.{number}. |
presentationTemplate.permissions.override |
Whether or not to override the existing presentation template permissions with those set in presentationTemplate.permissions.map. If set to true, only the permissions set in presentationTemplate.permissions.map will be set. If set to false, the permissions set in presentationTemplate.permissions.map will be set in addition to any existing permissions. |
prevent.public.announcements |
One or more site types (course, project, etc.) for which public announcements should be disallowed. |
prevent.public.resources |
One or more site types (course, project, etc.) for which public resources should be disallowed. |
prioritySortEnabled@org.sakaiproject.content.api.ContentHostingService |
Whether or not to allow sorting of resources by user-specified priority. |
profile.photoRepositoryPath |
The location of the directory in which user profile pictures are stored. |
profile.updateUser |
Whether or not to update a user's object in memory when they update their profile. |
provider.kerberos.auth.login.config |
The location of a custom kerberos auth login configuration file. |
provider.kerberos.krb5.conf |
The location of a custom kerberos5 configuration file. |
provider.kerberos.showconfig |
Whether or not to output the Kerberos user provider's configuration information to the logs. |
Sakai Properties Reference - R
Property Name |
Description |
|---|---|
refresh@org.sakaiproject.cluster.api.ClusterService |
How often (in seconds) a server should register that it is still alive. |
removeAbandoned@javax.sql.BaseDataSource |
Whether or not to remove abandoned connections. |
removeAbandonedTimeout@javax.sql.BaseDataSource |
The time (in seconds) before an abandond connection can be removed. |
reset.button |
Whether or not to show the tool reset button. |
resetRoles |
The roles to allow to reset their passwords using the password reset tool. |
resources.expanded_folder_size_limit |
The maximum size at which the resources tool will expand a collection (folder, basically). |
resources.show_all_collections.dropbox |
Whether or not to display the "Show Other Sites" link in the list mode of the dropbox tool. |
resources.show_all_collections.helper |
Whether or not to display the "Show Other Sites" link in the list mode of the file picker. |
resources.show_all_collections.tool |
Whether or not to display the "Show Other Sites" link in the list mode of the resources tool. |
review.permissions.map |
A list of site types (portfolio, course, project, etc.) for which the permission map should be used. Each numbered instance of this variable should have a corresponding siteTypes and value option. For example, if review.permissions.map.1 is set, at a minimum review.permissions.map.1.siteTypes, glossary.permissions.map.1.value.count and review.permissions.map.1.value.1 must be set. |
review.permissions.map.{number}.siteTypes |
A list of site types (portfolio, course, project, etc.) for which the permission map should be used. |
review.permissions.map.{number}.value |
A list of the actual permissions that should be assigned to the role specified in review.permissions.{number}. |
review.permissions.override |
Whether or not to override the existing review permissions with those set in review.permissions.map. If set to true, only the permissions set in review.permissions.map will be set. If set to false, the permissions set in review.permissions.map will be set in addition to any existing permissions. |
rollbackOnBorrow@javax.sql.BaseDataSource |
Whether or not to roll back each connection when borrowing it from the pool. |
roster.available.weeks.before.term.start |
The number of weeks before a term that its rosters are available. |
roster.defaultSortColumn |
The default sort column for the roster. |
roster.display.firstNameLastName |
Whether or not to display the first and last name in association with the photo. Does not appear to be used. |
roster.display.hideSingleGroupFilter |
Whether to hide the group components when there is only a single group. |
roster.privacy.display |
Whether or not to display the privacy message in the roster. |
roster_privacy_text |
The textual wording associated with the link to the login URL specified in the lroster.privacy.url property. |
roster_privacy_url |
The URL containing information about the privacy policy for roster information. |
roster_view_email |
Whether or not to show emails in the roster. Set to true by default. |
Sakai Properties Reference - S
Property Name |
Description |
|---|---|
sak11204.forceupgrade |
Whether or not to force the upgrade required to fix SAK-11204 on startup. |
sakai.datawarehouse.dbLoader.properties.alterTables |
Whether or not to alter the data warehouse tables. |
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. |
sakai.datawarehouse.dbLoader.properties.createTables |
Whether or not to create the data warehouse tables. |
sakai.datawarehouse.dbLoader.properties.dropTables |
Whether or not to drop the data warehouse tables. |
sakai.datawarehouse.dbLoader.properties.indexTables |
Whether or not to create indexes for the data warehouse tables. |
sakai.datawarehouse.dbLoader.properties.populateTables |
Whether or not populate the data warehouse tables. |
sakai.datawarehouse.dbLoader.properties.tableScriptFileName |
The location of a script that will be run when initializing the OSP data warehouse. |
sakai.datawarehouse.useWarehouse |
The types of reports to generate from the OSP data warehouse. |
sakai.mailbox.search-threshold |
The maximum number of messages that are allowed in a mailarchive channel before searching is disabled for that channel. |
sakai.rutgers.linktool.serverUrl |
The URL that will be encoded into the signed set of parameters passed by the link tool. |
sakai.site.multiPlacementTools |
The list of tool IDs to allow to be placed multiple times in a single site. |
sakai.xml.sax.parser |
The classname of the SAX parser to use. |
sakaiServerKey@org.sakaiproject.citation.api.ConfigurationService |
The server key that is added to Google Scholar urls. |
sam_file_upload_comment_out |
Whether or not to disable file uploads in SAMigo. |
samigo.answerUploadRepositoryPath |
The directory in which file resources uploaded in SAMigo will be stored. |
samigo.autoSumit.enabled |
Whether or not to automatically submit assessments. |
samigo.editPubAssessment.restricted |
Whether or not to allow editing of published assessments. |
samigo.email.bypassAuth |
Whether or not the mail server specified in samigo.smtpserver requires a username and password. |
samigo.email.password |
The password to use when communicating with the mail server used for SAMigo. |
samigo.email.prefixedPath |
The directory in which to store samigo's email attachment directory. |
samigo.email.prefixedPath |
The directory in which to store samigo's email attachment directory. |
samigo.email.username |
The username to use when communicating with the mail server used for SAMigo mail messages. |
samigo.samliteEnabled |
Whether or not to display a "Quick Create" button on the Assesments home page in SAMigo. |
samigo.saveMediaToDb |
Whether or to save media entered using samigo to the database. |
samigo.sizeMax |
The maximum size (in bytes) allowed for a single file uploaded using samigo. |
samigo.sizeThreshold |
This parameter is set, but does not appear to be used by any code. |
samigo.smtp.port |
The port number to communicate with the mail server used for outgoing SAMigo messages. |
samigo.smtp.server |
The mail server to use for messages sent by SAMigo. |
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. |
scaffolding.permissions.map.{number}.siteTypes |
A list of site types (portfolio, course, project, etc.) for which the permission map should be used. |
scaffolding.permissions.map.{number}.value |
A list of the actual permissions that should be assigned to the role specified in scaffolding.permissions.map.{number}. |
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. |
scheduler.event.archive.enabled |
This property does not currently appear to be used. |
scheduler.event.archive.length |
The length of time (in milliseconds) that sessions are allowed to sit around before being archived. |
schemaUpdate@org.sakaiproject.springframework.orm.hibernate.SessionFactoryBase |
Whether or not to execute a schema update after initialize the session factory. |
search.allow.maintain.admin |
Whether or not to allow site maintainers to administer the search tool. |
search.alow.maintain.admin |
Whether or not to allow site maintainers to administer the search tool. |
search.enable |
Whether or not to enable the search tool. |
search.experimental |
Whether or not to enable the search tool. |
search.indexbuild |
Whether or not to build indexes for the search tool. |
separateIdEid@org.sakaiproject.user.api.UserDirectoryService |
Whether or not to use a separate value for a user's ID and EID. |
server.info.url |
A URL containing information about this Sakai instance. Can be set to point to a resource stored within Sakai. |
serverId |
The unique identifier for a particular node in a cluster. |
serverName |
The service hostname for this sakai installation. |
serverUrl |
The canonical URL associated with this sakai instance. |
servlet.container |
The name of the servlet container to use. Setting this to "websphere" enables specific functionality. Any other setting enables the default behavior. |
setup.request |
The return email address for Worksite Setup or Site Info tool change notification messages. |
sharedJournalBase@org.sakaiproject.search.api.JournalSettings |
The shared directory for search journaling. |
sit.accessibility |
The text associated with the URL specified in accessibility.url. |
sit.contentporttit |
The title associated with the content portal iframe. |
sit.contentshead |
The text of the header for the content portal iframe. |
sit.help |
The text associated with the help link. |
sit.jumpcontent |
The text associated with the "jump to content" link. |
sit.jumptools |
The text associated with the "jump to tools" link. |
sit.jumpworksite |
The text associated with the "jump to worksites" link. |
sit.log |
The failover text that appears when logout.text is null. |
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. |
sit.mywor |
The text associated with the "My Workspace" link. |
sit.presenceiframetit |
The title of the presence iframe displayed on the portal. |
sit.presencetitle |
The header text for the presence module displayed on the portal. |
sit.selectmessage |
The textual hint to assist users in using the "more sites" dropdown. |
sit.toolshead |
The textual hint to assist users in using the tools panel. |
sit.worksite |
The text to add at the end of each site's name. |
sit.worksites |
The title of the worksites iframe displayed on the portal. |
sit.worksiteshead |
The textual hint to assist users in using the worksite navigation tabs. |
site-manage.campusUserDirectory |
A url to look up a user id in your institute. |
site-manage.cms.subject.category |
The category used for subject/department in the default CM impl data. |
site-manage.cms.subject.label |
The label used for subject/department in the default CM impl data. |
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. |
site.enableCreateAnyUser |
Whether or not to allow users creating a site to search and add sections from other users. |
site.setup.import.file |
Whether or not to allow the import of a site from a file during the site setup. |
site.visit.unp |
Whether or not to allow visits to an unpublished site. |
siteQuota@org.sakaiproject.content.api.ContentHostingService |
The site resource quota (in Kb). |
sitebrowser.termsearch.property |
The site property to use when searching by term |
sitebrowser.termsearch.type |
The type of site to search by term (typically "course"). |
sitesearch.noshow.sitetype |
A type of site to exclude from site search results. "My Workspace" sites are excluded whether or not this is set. |
skin.default |
The default skin to use for the portal and sites. |
skin.force |
Whether or not to allow users to select a custom skin. |
skin.repo |
The relative path to the directory containing all available skins (generally TOMCAT_HOME/webapps). |
skin.root |
The relative or absolute URL of the directory containing all available skins. |
smtp.dns.1 |
The IP address for the primary DNS server (used by James to lookup the outgoing mail host). |
smtp.dns.2 |
The IP address for the primary DNS server (used by James to lookup the outgoing mail host). |
smtp.enabled |
Whether or not to accept incoming SMTP requests. |
smtp.port |
The port number on which James should listen for incoming SMTP requests. |
smtp@org.sakaiproject.email.api.EmailService |
The hostname of the server that handles outgoing SMTP messages. |
smtpFrom@org.sakaiproject.email.api.EmailService |
The smtp mail envelope return address used for outgoing messages. |
smtpPort@org.sakaiproject.email.api.EmailService |
The port to use for outgoing SMTP mail messages. |
stealthTools@org.sakaiproject.tool.api.ActiveToolManager |
The list of tool IDs to "stealth", or hide from the "Edit Tools" menu. |
storagePath@org.sakaiproject.archive.api.ArchiveService |
The directory location in which to store directories and files created using the archive tool. |
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. |
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. |
style.permissions.map.{number}.siteTypes |
A list of site types (portfolio, course, project, etc.) for which the permission map should be used. |
style.permissions.map.{number}.value |
A list of the actual permissions that should be assigned to the role specified in style.permissions.map.{number}. |
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. |
support.email |
The email address used when rejecting incoming messages. |
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. |
Sakai Properties Reference - T
Property Name |
Description |
|---|---|
tags.focus |
Whether to use "archival" or "rich" rules when excluding tags. |
termendtime |
The end time of a defined term. Each numbered instance should match a term defined in termterm. |
termiscurrent |
Whether or not a defined term is the default. |
termlistabbr |
The abbreviation to use for a defined term. Each numbered instance should match a term defined in termterm. |
termstarttime |
The start time of a defined term. Each numbered instance should match a term defined in termterm. |
termterm |
The name of a defined term. |
termyear |
The calendar year of a defined term. Each numbered instance should match a term defined in termterm. |
testMode@org.sakaiproject.email.api.EmailService |
Whether or not to send outgoing messages. If set to true, no outgoing messages will be sent. |
testOnBorrow@javax.sql.BaseDataSource |
Whether or not to test the health of a database connection when checking it out from the pool. |
testOnReturn@javax.sql.BaseDataSource |
Whether or not to test the health of a database connection when returning it to the pool. |
testWhileIdle@javax.sql.BaseDataSource |
Whether or not to test idle connections. If this is set to false, no idle evictions will occur. |
timeBetweenEvictionRunsMillis@javax.sql.BaseDataSource |
The time to wait (in milliseconds between) eviction runs. During an eviction run, idle connections above the minimum are returned to the pool. |
timeToLive@db.cache.SAKAI_ALIAS_PROPERTY |
The time (in seconds) to cache table rows in memory for queries run against the sakai_alias_property table. |
timeToLive@db.cache.SAKAI_REALM_PROPERTY |
The time (in seconds) to cache table rows in memory for queries run against the sakai_realm_property table. |
timeToLive@db.cache.SAKAI_SITE_GROUP_PROPERTY |
The time (in seconds) to cache table rows in memory for queries run against the sakai_site_group_property table. |
timeToLive@db.cache.SAKAI_SITE_PAGE_PROPERTY |
The time (in seconds) to cache table rows in memory for queries run against the sakai_site_page_property table. |
timeToLive@db.cache.SAKAI_SITE_PROPERTY |
The time (in seconds) to cache table rows in memory for queries run against the sakai_site_property table. |
timeToLive@db.cache.SAKAI_USER_PROPERTY |
The time (in seconds) to cache table rows in memory for queries run against the sakai_user_property table. |
timeoutSeconds@org.sakaiproject.presence.api.PresenceService |
The time (in seconds) before an entity that has not updated its presence information is considered to no longer be present. |
titleEditableSiteType |
One or more site types (course, project, etc.) for which the title should be editable. |
top.login |
Whether or not to provide a login form on the portal itself (typically on the top). |
Sakai Properties Reference - U
Property Name |
Description |
|---|---|
ui.service |
The text displayed as the root of the bread crumb bar. In other words, the common name of your Sakai instance. |
url@javax.sql.BaseDataSource |
The connection URL to be passed to the JDBC driver (example: jdbc:mysql://127.0.0.1:3306/sakai?useUnicode=true&characterEncoding=UTF-8). The syntax can vary by implementation, consult the vendor documentation for details. |
username@javax.sql.BaseDataSource |
The username to use when connecting to the database. |
Sakai Properties Reference - V
Property Name |
Description |
|---|---|
validationQuery@javax.sql.BaseDataSource |
The query to use when checking the health of a database connection. |
vendor@org.sakaiproject.db.api.SqlService |
The hibernate vendor, which must match the dialect set in hibernate.dialect. |
version.sakai |
The version text that appears next to the word "Sakai" in the footer of the portal. |
version.service |
The version text that appears next to the service name in the footer of the portal. |
visibleTools@org.sakaiproject.tool.api.ActiveToolManager |
The list of tool IDs to make visible, regardless of whether they are hidden or stealthed. Any valid tool listed here will appear on the "Edit Tools" menu. |
Sakai Properties Reference - W
Property Name |
Description |
|---|---|
webcontent.instructions.url |
The URL containing instructions for new "web content" tool instances whose URL is unset. |
webdav.cookies |
if set to true, a set-cookie response will be received after an authenticated webDAV URL request if and only if you don't already have the same dav cookie. Default setting (false) is recommended for production installations. |
webdav.ignore |
One or more regular expressions indicating content the DAV servlet should ignore. |
webdav.instructions.url |
The location of the end-user webDAV instructions. |
webservice.IPCheck |
Whether or not to check the IP address of clients attempting to use web services. |
webservice.portalIP |
A list of IP addresses allowed to use web services. |
webservice.portalsecret |
Indicates the shared secret between the Sakai JSR-168 Portlet and this instance of Sakai. |
webservices.allow |
A comma-delimited list of regular expressions matching hostnames that are allow to use web services. A host matching a pattern in both webservices.allow and webservices.deny will be denied access. If this is set to .* or left empty, all accesses will be allowed. |
webservices.allow-log |
Whether or not to log web services requests that are allowed because they match one of the patterns defined in webservices.allow. |
webservices.allowlogin |
Whether or not to allow logins via web services. |
webservices.deny |
A comma-delimited list of regular expressions detailed hosts that are allowed to use web services. A host matching a pattern in both webservices.allow and webservices.deny will be denied access. |
webservices.deny-log |
Whether or not to log web services requests that are denied because they match one of the patterns defined in webservices.deny. |
wiki.comments |
Whether or not to allow comments in the Rwiki tool. |
wiki.display.user.id |
Whether or not to display user IDs in the Wiki tool. Set to false by default. |
wiki.experimental |
Whether or not to enable the Rwiki tool. |
wiki.notification |
Whether or not to enable notification for the Rwiki tool. |
wiki.trackreads |
Whether or not to track wiki page views in the event tracking table. |
wiki.ui.homepage |
The name of the default wiki home page (defaults to "Home"). |
withDissertation |
Whether or not to display links to the grad tools. |
wizard.permissions.map |
A map of the default permissions for the OSP wizard tool. Each numbered instance of this variable should have a corresponding siteTypes and value option. For example, if wizard.permissions.map.1 is set, at a minimum wizard.permissions.map.1.siteTypes, wizard.permissions.map.1.value.count and wizard.permissions.map.1.value.1 must be set. |
wizard.permissions.map.{number}.siteTypes |
A list of site types (portfolio, course, project, etc.) for which the permission map should be used. |
wizard.permissions.map.{number}.value |
A list of the actual permissions that should be assigned to the role specified in wizard.permissions.map.{number}. |
wizard.permissions.override |
Whether or not to override the existing wizard permissions with those set in wizard.permissions.map. If set to true, only the permissions set in wizard.permissions.map will be set. If set to false, the permissions set in wizard.permissions.map will be set in addition to any existing permissions. |
wsetup.disable.joinable |
One or more site types (course, project, etc.) for which the joinable flag should be disabled. |
wsetup.disable.unjoin |
One or more site types (course, project, etc.) users are not allowed to unjoin. |
wsetup.group.support |
Whether to display the group toolbar in the "Site Info" tool. |
wsetup.skipCourseSectionSelection |
Whether or not to allow users to select a course section when creating a worksite. |
wysiwyg.editor |
The name of the WYSIWYG editor to use in most parts of sakai. |
wysiwyg.twinpeaks |
Whether or not to enable twinpeaks support in the WYSIWYG editor. |