Sakai Properties Reference - Full

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

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 /content/group/ 1100899697301-3493876 /report represents the location of the resource.

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

accessToUnderlyingConnectionAllowed@javax.sql.BaseDataSource

Whether or not to allow access to the underlying connections.

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

accessibility.url

A URL that provides accessibility information. The text specified in sit.accessibility is enclosed in the anchor tag associated with this value.

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

activeInactiveUser

Whether or not to allow site maintainers to activate/deactivate user enrollments.

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

affiliatecampus

The title of an affiliate campus.

Syntax

You must have a affliatecampus.count parameter indicating the total number of affiliate campuses. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if affiliatecampus.count is set to 2, you would be expected to provide an affliatecampus.1 and affiliatecampus.2 setting. This parameter is tied to the afilliatesubjects and affiliateuniqnames parameters, such that affiliatecampus.1 refers to the same entity as affiliateuniqnames.1, etc.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

affiliatesubjects

The list of subjects at a given affiliate campus.

Syntax

You must have a affliatesubjects.count parameter indicating the total number of affiliate subjects. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if affiliatesubjects.count is set to 2, you would be expected to provide an affliatesubjects.1 and affiliatesubjects.2 setting. This parameter is tied to the afilliatecampus and affiliateuniqnames parameters, such that affiliatecampus.1 refers to the same entity as affiliatesubjects.1, etc.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

affiliateuniqnames

The list of unique names for a given affiliate campus.

Syntax

You must have a affliateuniqnames.count parameter indicating the total number of affiliate unique names. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if affiliateuniqnames.count is set to 2, you would be expected to provide an affliateuniqnames.1 and affiliateuniqnames.2 setting. This parameter is tied to the afilliatesubjects and affiliatecampus parameters, such that affiliatecampus.1 refers to the same entity as affiliateuniqnames.1, etc.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

allow.basic.auth.login

Whether or not to allow users to authenticate using HTTP Basic Auth.

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

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.

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

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.

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

allowGroupResources

Whether or not to make the resources tool group-aware.

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

announcement.merge.display

Whether or not to show the "merge" link in the announcements tool to users with the appropriate permissions (site.upd).

Syntax

Can be set to 0 or 1.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

assignment.instructor.notifications

Whether or not to enable instructor assignment notifications.

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

assignment.instructor.notifications.default

The method by which to send out assignment notifications to instructors.

Syntax

Can be set to "none", "each", or "digest".

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

assignment.submission.confirmation.email

Whether or not to enable student assignment notifications.

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

assignment.useContentReview

Whether or not to add assignment submissions to a queue that will be processed by a content review service.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

auto.ddl

Whether or not to create and update database structures automatically

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

availabilityChecksEnabled@org.sakaiproject.content.api.ContentHostingService

Whether or not to allow availability dates for resources.

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

Sakai Properties Reference - B

batchWrite@org.sakaiproject.event.api.EventTrackingService

Whether or not to write events to the database in batches.

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

bodyPath@org.sakaiproject.content.api.ContentHostingService

The directory in which file resources 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

bodyVolumes@org.sakaiproject.content.api.ContentHostingService

A list of folders to distribute file content between.

Syntax

Accepts a comma separated list of valid folder names contained in the directory specified in bodyPath@org.sakaiproject.content.api.ContentHostingService. For example, if you have multiple NFS shares mounted in a single directory, you would list each of these in bodyVolumes@org.sakaiproject.content.api.ContentHostingService and list their parent directory in bodyPath@org.sakaiproject.content.api.ContentHostingService.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

bottom.copyrighttext

The copyright text that appears in the footer of the main portal and OSP 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

bottomnav

One or more lines of text (including HTML) that appear as navigational links at the bottom of the main portal and OSP portal.

Syntax

You must have a bottomnav.count parameter indicating the total number of navigational elements. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if bottomnav.count is set to 2, you would be expected to provide a bottomnav.1 and bottomnav.2 setting.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

Sakai Properties Reference - C

cacheCleanerMinutes@org.sakaiproject.alias.api.AliasService

The time (in minutes) between alias cache cleanings.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

cacheCleanerMinutes@org.sakaiproject.site.api.SiteService

The time (in minutes) betweensite service cache cleanings.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

cacheCleanerMinutes@org.sakaiproject.user.api.UserDirectoryService

The time (in minutes) between user directory cache cleanings.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

cacheLogging@org.sakaiproject.memory.api.MemoryService

Whether or not the memory cache should log debugging messages.

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

cacheMinutes@org.sakaiproject.alias.api.AliasService

The time (in minutes) to cache an alias.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

cacheMinutes@org.sakaiproject.authz.api.SecurityService

The time (in minutes) to cache authz information.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

cacheMinutes@org.sakaiproject.site.api.SiteService

The time (in minutes) to cache site queries.

Syntax

Accepts an integer value

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

cacheMinutes@org.sakaiproject.user.api.UserDirectoryService

The time (in minutes) to cacheuser directory site queries.

Syntax

Accepts an integer value

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

calendar

The ID of the calendar to use instead of the site calendar.

Syntax

Must be set to a valid calendar ID.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

calendar.merge.display

Whether or not to allow users to merge calendar entries.

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

calendarSummary.highPriorityColor

The color to use for high priority events in the calendar summary.

Syntax

Accepts a hex color code (example: #ff0000).

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

calendarSummary.highPriorityEvents

The name of a type of high-priority event.

Syntax

You must have a calendarSummary.highPriorityEvents. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if calendarSummary.highPriorityEvents is set to 2, you are expected to provide a value for calendarSummary.highPriorityEvents.1 and calendarSummary.highPriorityEvents.2.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

calendarSummary.lowPriorityColor

The color to use for low priority events in the calendar summary.

Syntax

Accepts a hex color code (example: #00ff00).

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

calendarSummary.lowPriorityEvents

The name of a type of low-priority event.

Syntax

You must have a calendarSummary.lowPriorityEvents. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if calendarSummary.mediumPriorityEvents is set to 2, you are expected to provide a value for calendarSummary.lowPriorityEvents.1 and calendarSummary.lowPriorityEvents.2.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

calendarSummary.mediumPriorityColor

The color to use for medium priority events in the calendar summary.

Syntax

Accepts a hex color code (example: #0000ff).

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

calendarSummary.mediumPriorityEvents

The name of a type of a medium-priority event.

Syntax

You must have a calendarSummary.mediumPriorityEvents. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if calendarSummary.mediumPriorityEvents is set to 2, you are expected to provide a value for calendarSummary.mediumPriorityEvents.1 and calendarSummary.mediumPriorityEvents.2.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

calendarSummary.viewMode

Whether the calendar summary should display a week or a month at a time.

Syntax

Accepts either "week" or "month"

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

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.

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

channel

The ID of the channel to use instead of the site channel.

Syntax

Must be set to a valid channel ID.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

charon.directurl

Whether or not to restore a saved restore state in the portal if it exists.

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

chatMigrationExecuteImmediate@org.sakaiproject.chat2.model.impl.ChatDataMigration

Whether or not to migrate data from the previous version of chat to the current version.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.5

checkDb@org.sakaiproject.event.api.EventTrackingService

Whether or not to check the database for new events.

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

checkEvery@org.sakaiproject.tool.api.SessionManager

How often (in seconds) to check for expired sessions.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

citationsEnabledByDefault@org.sakaiproject.citation.api.ConfigurationService

Whether or not the citations helper is enabled by default for all sites.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.5

config@org.sakaiproject.section.api.SectionManager

Used to control how sections are created in the Section Info tool.

Syntax

Can be set to MANUAL_MANDATORY, MANUAL_DEFAULT, AUTOMATIC_DEFAULT, AUTOMATIC_MANDATORY. 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.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

configviewer.usejavascript

Whether or not to use javascript to convert long text blocks to tooltips.

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

container.login

Whether or not to check the container on login.

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

content.upload.ceiling

Specifies an absolute max value that cannot be exceeded on uploads which use the request filter init parameter upload.max. When not set, the value of content.upload.max is used.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

content.upload.dir

Specifies the location where commons-fileupload stores uploads as they are being processed.

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

content.upload.max

The maximum size (in bytes) allowed for a single file uploaded using a multipart form. Does not impact DAV.

Syntax

This value must be a number with no unit of measurement (don't append Mb, Kb, etc.)

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

convertToFile@org.sakaiproject.content.api.ContentHostingService

Whether or not to move binary content stored in the database to the filesystem.

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

copyright.use_creative_commons

Whether or not to display additional configuration options used to select a particular variation of the Creative Commons License.

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

copyrighttype

The textual wording for an acceptable type of copyright to be used when uploading resources into Sakai.

Syntax

You must have a copyrighttype.count parameter indicating the total number of copyright types. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if copyrighttype.count is set to 2, you would be expected to provide a copyrighttype.1 and copyrighttype.2 setting.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

copyrighttype.new

The textual wording of the default copyright to be used when uploading resources into Sakai.

Syntax

Must match one of the copyright types defined by a copyrighttype configuration parameter.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

copyrighttype.own

The textual wording of the default copyright to be used when uploading resources into Sakai.

Syntax

Must match one of the copyright types defined by a copyrighttype configuration parameter.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

courseSiteType

Type type of site associated with a course (defaults to "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

Sakai Properties Reference - D

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.

Syntax

Can be set to "dd/MM/yyyy" or left unset.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

default.copyright

The textual wording of the default copyright to be used when uploading resources into Sakai.

Syntax

Must match one of the copyright types defined by a copyrighttype configuration parameter.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

default.copyright.alert

Whether or not to display an alert when the default copyright is selected.

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

defaultAutoCommit@javax.sql.BaseDataSource

Whether or not to commit database changes automatically.

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

defaultReadOnly@javax.sql.BaseDataSource

Whether or not borrowed database connections are read only by default.

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

defaultTransactionIsolation@javax.sql.BaseDataSource

The integer value for the transaction isolation level. Use defaultTransactionIsolationString instead.

Syntax

Accepts an integer value corresponding to one of the constants defined in org.apache.commons.dbcp.Connection.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

defaultTransactionIsolationString@javax.sql.BaseDataSource

A string that controls transaction isolation, review the documentation for your JDBC driver before attempting to change this.

Syntax

One of the constants defined in org.apache.commons.dbcp.Connection that controls the transaction behavior. Typically set to TRANSACTION_READ_COMMITTED (preferred for MySQL) or TRANSACTION_READ_UNCOMMITTED (the default for HSQL).

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

disable.course.site.skin.selection

Whether or not to allow course sites 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

disable.membership.unjoin.selection

Whether or not to disable the link used to unjoin a 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

display.help.icon

Whether or not to display the help icon in the upper right of each tool window.

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

display.help.menu

Whether or not to display a link to help on the left hand navigation menu.

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

display.users.present

Whether or not to display the users present below the left-hand navigation bar.

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

driverClassName@javax.sql.BaseDataSource

The JDBC driver to use when connecting to the database.

Syntax

Accepts the class name of the JDBC Driver.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

Sakai Properties Reference - E

editViewRosterSiteType

One or more site types (course, project, etc.) for which the roster edit view should be enabled.

Syntax

You must have a editViewRosterSiteType.count parameter indicating the total number of copyright types. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if editViewRosterSiteType.count is set to 2, you would be expected to provide a editViewRosterSiteType.1 and editViewRosterSiteType.2 setting.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

emailInIdAccount.url

A URL containing information about accounts that correspond to an email address.

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

emailInIdAccountInstru

The instructions to display when creating accounts that correspond to email addresses.

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

emailInIdAccountLabel

The label to associate with accounts that correspond to email addresses.

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

emailInIdAccountName

A shorter label for accounts that correspond to email addresses.

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

enable.privacy.status

Whether or not privacy status is enabled. Does not appear to be accessed in any tools.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

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.

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

expired@org.sakaiproject.cluster.api.ClusterService

The time in seconds after which an inactive server will be expired from the cluster.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

Sakai Properties Reference - G

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.

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

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.

Syntax

Accepts a list of valid site IDs.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

gatewaySiteListDisplayCount

The number of site tabs to display when presenting the gateway site to users who are not logged in.

Syntax

Accepts a valid integer.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

ghostingPercent@org.sakaiproject.cluster.api.ClusterService

The percentage of maintenance passes to run the full de-ghosting / cleanup activities, including delisting stale server nodes.

Syntax

Accepts an integer value from 0 to 100.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

glossary.permissions.map

A map of the default permissions for the OSP glossary tool.

Syntax

You must have a glossary.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 glossary.permissions.map.count is set to 2, you would be expected to provide a glossary.permissions.map.1 and glossary.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

glossary.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

glossary.permissions.map.{number}.value.count

A list of the actual permissions that should be assigned to the role specified in glossary.permissions.map.{number}.

Syntax

You must have a glossary.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 glossary.permissions.map.{number}.value.count is set to 2, you would be expected to provide a glossary.permissions.{number}.value.map.1 and glossary.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

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.

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

googleSearchEnabled@org.sakaiproject.citation.api.ConfigurationService

Whether or not searching via Google Scholar is enabled.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.5

gradToolsSiteType

One or more site types (course, project, etc.) for which grad tools should be displayed.

Syntax

You must have a gradToolsSiteType.count parameter indicating the total number of ?. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if gradToolsSiteType.count is set to 2, you would be expected to provide a gradToolsSiteType.1 and gradToolsSiteType.2 setting.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

Sakai Properties Reference - H

help.button

Whether or not to show the help button.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

help.hide

A list of tools whose help should not be added to the help index.

Syntax

Accepts a comma-delimited list of tools.

Version

This property is used in the following version(s) of Sakai: 2.5

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

Syntax

Accepts a valid document ID

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

help.location

An external location for help information.

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

help.redirect.external.webapp

An external location for help information.

Syntax

If this is set to "sakai" (the default), help information will be displayed as usual. If not, help requests will be redirected to the specified URL.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

help.url

The URL to use instead of the built-in help.

Syntax

Accepts a valid URL.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

help.welcomepage

The location of the help welcome page.

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

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

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

hibernate.c3p0.max_size

The maximum size of the C3P0 connection pool.

Syntax

Accepts a valid integer.

Version

This property is used in the following version(s) of Sakai: 2.5

hibernate.c3p0.max_statements

The maximum number of statements to cache, set to 0 to disable caching.

Syntax

Accepts a valid integer.

Version

This property is used in the following version(s) of Sakai: 2.5

hibernate.c3p0.min_size

The minimum size of the C3P0 connection pool.

Syntax

Accepts a valid integer.

Version

This property is used in the following version(s) of Sakai: 2.5

hibernate.c3p0.timeout

The maximum time (in seconds) to leave a connection idle before closing it.

Syntax

Accepts a valid integer.

Version

This property is used in the following version(s) of Sakai: 2.5

hibernate.default_schema

Specifies the default database schema to use.

Syntax

Accepts a valid database schema.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

hibernate.dialect

Which hibernate dialect to use.

Syntax

Should be one of the supported dialects that can be used with Sakai, such as: org.hibernate.dialect.HSQLDialect, org.hibernate.dialect.MySQLDialect, org.hibernate.dialect.Oracle9Dialect

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

hibernate.show_sql

Whether or not to show the SQL statements used by hibernate in the tomcat logs.

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

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

The location and name of the hibernate properties file (defaults to hibernate.properties).

Syntax

Accepts a valid path and filename.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

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.

Syntax

A list of tool IDs separated by commas.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

Sakai Properties Reference - I

ical.experimental

Whether or not to enable exports of calendar data in iCal format.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.5

iconNames

One or more names to associated with an icon that will appear ?.

Syntax

You must have an iconNames.count parameter indicating the total number of ?. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if iconNames.count is set to 2, you would be expected to provide a iconNames.1 and iconNames.2 setting. A numbered instance of this variable is paired with the iconSkins and iconUrls instances with the same number.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

iconSkins

One or more skins to be associated with an icon that will appear ?.

Syntax

You must have an iconSkins.count parameter indicating the total number of ?. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if iconSkins.count is set to 2, you would be expected to provide a iconSkins.1 and iconSkins.2 setting. A numbered instance of this variable is paired with the iconNames and iconUrls instances with the same number.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

iconUrls

One or more URLs for an icon that will appear ?.

Syntax

You must have a iconURLs.count parameter indicating the total number of ?. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if iconURLs.count is set to 2, you would be expected to provide a iconURLs.1 and iconURLs.2 setting. A numbered instance of this variable is paired with the iconSkins and iconNames instances with the same number.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

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.

Syntax

Accepts a comma separated list of macros to replace in URLs. Valid macros are: ${SITE_ID},${USER_ID},${USER_EID},${USER_FIRST_NAME},${USER_LAST_NAME},${USER_ROLE}, and ${SESSION_ID}.

Version

This property is used in the following version(s) of Sakai: 2.3,2.4,2.5

import.importAsDraft

Whether or not imported items should be flagged as a draft.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

inactiveInterval@org.sakaiproject.tool.api.SessionManager

How long (in seconds) a session is allowed to be inactive before it can be removed.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

initialSize@javax.sql.BaseDataSource

The number of initial connections created when the pool is started.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

invalidEmailInIdAccountString

A list of patterns to detect invalid email addresses when creating new accounts.

Syntax

Accepts a string containing a comma-delimited list of patterns that correspond to invalid email addresses.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

Sakai Properties Reference - L

linktool.home

The shared directory in which linktool keys are deployed in shared environments.

Syntax

Accepts a valid directory location.

Version

This property is used in the following version(s) of Sakai: 2.5

localIndexBase@org.sakaiproject.search.api.JournalSettings

A local directory used to store search index data.

Syntax

Accepts a valid directory location.

Version

This property is used in the following version(s) of Sakai: 2.5

locales

A comma-delimited list of supported locales.

Syntax

Accepts a list of valid locales separated by commas (there should be no spaces or quotes next to the commas).

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

log.config

Override the default logging for one or more components.

Syntax

You must have a log.config.count parameter indicating the total number of log settings 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 log.config.count is set to 2, you would be expected to provide a log.config.1 and log.config.2. setting. 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.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

logAbandoned@javax.sql.BaseDataSource

Whether or not to log stack traces for application code which abandons a statement or connection.

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

logWriter@javax.sql.BaseDataSource

The classname of the log writer.

Syntax

A valid classname.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

loggedOutUrl

The URL users are sent to when they click the "logout" button.

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

login.browser.user.agent

One or more additional browser agents to support when requesting HTTP basic authentication.

Syntax

You must have a login.browser.user.agent.count parameter indicating the total number of additional browser agents. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if login.browser.user.agent.count is set to 2, you would be expected to provide a login.browser.user.agent.1 and login.browser.user.agent.2 setting. The text of the actual setting should be a regex pattern that the desired agent will match.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

login.icon

The source location of the login icon displayed in the portal.

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

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.

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

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.

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

logout.icon

The icon associated with the "logout" link.

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

logout.text

The textual wording of the link used to log out.

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

Sakai Properties Reference - M

mail.importDir

Used to specify the directory where email will be found when importing a non-Sakai email archive into Sakai.

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

mail.support

The email address users should contact for support.

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

mailtool.group.aware.role

Roles which should be group-aware in mailtool.

Syntax

Accepts a comma-delimited list of valid site roles.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

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.

Syntax

Accepts an integer.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

mailtool.show.renaming.roles

Whether or not to show roles that have been renamed.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

mailtool.upload.directory

The temporary directory to use when uploading attachments. Defaults to /tmp.

Syntax

Accepts a valid directory location.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

maxActive@javax.sql.BaseDataSource

The maximum number of active database connections (set to -1 for unlimited).

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

maxIdle@javax.sql.BaseDataSource

The maximum number of idle database connections (set to -1 for unlimited).

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

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).

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

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.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

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).

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

mc.default.{variable}

The permission level for a particular role, where {variable} is replaced by an actual role name.

Syntax

A string consisting of a valid permission level.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

mc.defaultLongDescription

Whether or not to turn on the display of full descriptions by default.

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

mc.disableLongDesc

Whether or not to disable the display of full descriptions.

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

mc.showForumLinksInNav

Whether or not to show links to forums in message center.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.5

mc.threadedview

Whether or not to display topics in a threaded view.

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

melete.migrate

Whether or not to migrate Melete content to Content Hosting.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.5

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.

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

mercury.login

A list of eids that can be used to log in to the mercury portal.

Syntax

You must have a mercury.login.count parameter that indicates the total number of eids. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if mercury.login.count is set to 2, you would be expected to provide a mercury.login.count.1 and mercury.login.count.2 setting.

Version

This property is used in the following version(s) of Sakai: 2.5

mercury.password

A list of passwords associated with the eids defined using mercury.login.

Syntax

You must have a mercury.password.count parameter that indicates the total number of eids. You are then expected to have a numbered instance of this element for each number between 1 and the total count. For example, if mercury.password.count is set to 2, you would be expected to provide a mercury.password.count.1 and mercury.password.count.2 setting.

Version

This property is used in the following version(s) of Sakai: 2.5

messagecenter.privacy.text

The text of the privacy warning displayed on the private messages page.

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

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.

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

migrateData@org.sakaiproject.content.api.ContentHostingService

Whether or not to migrate content stored in the database to binary format.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.5

minEvictableIdleTimeMillis@javax.sql.BaseDataSource

The amount of time (in milliseconds) an object may sit idle before it is eligible for eviction.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

minIdle@javax.sql.BaseDataSource

The minimum number of Idle database connections.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

myworkspace.info.url

A page which describes the "My Workspace" site in general terms.

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

Sakai Properties Reference - N

newcopyrightinput

Whether or not to allow users to enter their own copyright formation.

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

news.feedURL

The default URL specified when adding a news tool to a worksite.

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

news.title

The default title specified when adding a news tool to a worksite.

Syntax

Accepts any text including valid HTML.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

noEmailInIdAccountLabel

The label to associate with accounts that do not correspond to email addresses.

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

noEmailInIdAccountName

A shorter label for accounts that do not correspond to email addresses.

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

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.

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

numTestsPerEvictionRun@javax.sql.BaseDataSource

The number of idle connections to evaluate per eviction run.

Syntax

Accepts an integer value.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

Sakai Properties Reference - O

osp.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.2,2.3,2.4

osp.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.3,2.4

osp.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.2,2.3,2.4

osp.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.2,2.3,2.4

osp.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.2,2.3,2.4

osp.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.2,2.3,2.4

osp.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.3,2.4

osp.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.4

osp.experimental.assignments

Whether or not to allow assignments to be associated with an OSP matrix cell.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.5

osp.migration.developer

Whether or not to set the developer flag for migration testing.

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

Sakai Properties Reference - P

password@javax.sql.BaseDataSource

The password to use when connecting to the database.

Syntax

Any string that can be used as a database password.

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

performChatMigration@org.sakaiproject.chat2.model.impl.ChatDataMigration

Whether or not to migrate chat data from version 1 to version 2 on server startup.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.5

period@org.sakaiproject.event.api.EventTrackingService

The time to wait (in seconds) before checking the database for new events.

Syntax

Accepts an integer value

Version

This property is used in the following version(s) of Sakai: 2.2,2.3,2.4,2.5

poh.unhideables

The list of tools to prevent the pageOrderHelper from allowing to be unhidden.

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

poolPreparedStatements@javax.sql.BaseDataSource

Whether or not to pool prepared statements.

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

portal.default.tabs

The number of tabs to display in the portal by default.

Syntax

Accepts a valid integer.

Version

This property is used in the following version(s) of Sakai: 2.5

portal.error.email

Email address to send errors caught by the portal, and user bug reports in response.

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

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.

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

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.

Syntax

Can be set to "false", "never", or left blank.

Version

This property is used in the following version(s) of Sakai: 2.5

portal.experimental.maximizesinglepage

Whether or not to maximize the display when only one site is available.

Syntax

Can be set to true or false

Version

This property is used in the following version(s) of Sakai: 2.5

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 )

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

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.

Syntax

A string containing the text ":all:" or ":none" and optionally containing a list of tool IDs and a ":debug:" flag.

Version

This property is used in the following version(s) of Sakai: 2.5

portal.styleable

Whether or not to attempt to generate a custom stylesheet based on the user preferences.

Syntax

Can be set to true or false.

Version

This property is used in the following version(s) of Sakai: 2.4,2.5

portal.styleable.contentSummary

Whether or not to attempt to generate javascript to support a custom stylesheet based on the user preferences.

Syntax

Can be set to true or false.