Upload
brittany-stewart
View
214
Download
0
Embed Size (px)
Citation preview
This session:
For: New users, support, admins,
About:Changes that can be made to Sakai OOTB from a Support Admin role
Explain some of the one time setup tasks that you should undertake
Provide an explanation of permissions, realms, site and user templates.
Sakai configurations to fit your environment once the integration coding has finished
Configurations
What types of users, worksites will you use?
Do you want to limit tools based on types of worksites?
Do you want to order tools in worksites consistently?
What roles in different types of worksites? What permissions for each role?
What will user My Workspaces contain?
Configurations – cont.
MOTD
What will your ‘Gateway’ site look like?
Help
Do you want user presence on?
What is your policy regarding account creation?
What are the defaults for certain tools?
There are many settings that affect tools. You should decide if the defaults fit your needs.
Worksite Types
Worksite type specified when worksite is created
Worksite Types
Other types are possibleproject, course, GradToolsStudent, Research, …
A type can be defined by using it • Create a site using Admin Sites tool and enter a type
Worksite Types
Worksite Types
To change the types presented in Worksite Setup when creating new sites, see sakai.sitesetup.xml in subversion/site-manage/trunk/site-manage-tool/tool/src/webapp/tools/
sakai.sitesetup.xml<?xml version="1.0"?><registration>
<toolid="sakai.sitesetup"title="Worksite Setup"description="Modify your sites and create new ones."><!-- types are separated by , --><!-- Steps for adding new site type: --><!-- 1. add the site type into the following siteTypes value --><!-- 2. add the site type as category into related tool reg files--><!-- 3. if the site title is editable, add the site type into titleEditableSiteType in sakai.properties file --><!-- 4. if specific tool order for the site type is needed, specify it inside toolOrder.xml file -->
# <configuration name="siteTypes" value="course,project" /> <configuration name="siteTypes" value="course,project,Research" /><!-- default site type --><configuration name="defaultSiteType" value="project" /><!-- types of sites that can either be public or private --><configuration name="publicChangeableSiteTypes" value="project" /><!-- types of sites that are always public --><configuration name="publicSiteTypes" value="course" /><!-- types of sites that are always private --><configuration name="privateSiteTypes" value="" /><configuration name="site_mode" value="sitesetup" type="final" /><category name="myworkspace" /></tool>
</registration>
Worksite Types
Worksite Tools
Which tools can be chosen in a site?
<?xml version="1.0"?><registration>
<toolid="sakai.membership"title="Membership"description="View and modify your membership in sites you may join.">
<category name="myworkspace" />
<configuration name="reset.button" value="false" type="final" /></tool>
</registration>
Worksite ToolsWhich tools can be chosen in a site?
Specified in the tool’s registry file, i.e. sakai.membership.xml in sakai/site-manage/site-manage-tool/tool/src/webapp/toolssvn: /svn/site-manage/trunk/site-manage-tool/tool/src/webapp/tools
Membership tool is only in My Workspaces
Worksite Tools
/svn/content/trunk/content-tool/tool/src/webapp/tools/sakai.resources.xml
<?xml version="1.0"?> <registration> <tool id="sakai.resources" title="Resources" description="For posting documents, URLs to other websites"> <configuration name="home" value="" />
<configuration name="optional_properties" value="true" /> <configuration name="user_sees_all_their_sites" value="true" />
<configuration name="collections_per_page" value="50" /> <configuration name="resources_mode" value="resources" type="final" /> <category name="course" /> <category name="project" /> <category name="portfolio" /> <category name="myworkspace" />
</tool> </registration> Resource tool is in all site typesResource tool is in all site types
Worksite Tools
Additional control via stealthTools property Trumps the category_name values
Default (for 2.3, includes a long list of tools, including osp tools):[email protected]=
sakai.su, sakai.site.roster, sakai.rwiki, sakai.assignment
SU, Roster, Rwiki Assignments (w/o grades) tools won’t show up regardless of what’s in their xml files
Override in sakai.properties
sakai.su, sakai.site.roster, sakai.assignment
Wiki tool shows up according to what is defined in sakai.rwiki.xml category_name values
Worksite Tools
Additional configuration options as of 2.3Easy control of stealthed provisional tools that ship with Sakai
In sakai.properties, use# make specified tools visible to users when creating/editing site
# hide specified tools from users when creating/editing site
Worksite ToolsSo, which tools can be added to a particular type of worksite is controlled by entries in the tool’s <tool>.xml file and sakai.properties
What order are the tools displayed?
Tools in Worksites – controlling the order
We are really talking about the order of Pages
The left hand menu column contains page names
Though typically (so far) Sakai has one tool per page, more are possible (e.g., Home page)
Page ordering in a site type can be optionally controlled using the toolOrder.xml file
toolOrder.xml goes in the Sakai Home folder
e.g., sakai folder in tomcat root folder
/usr/local/tomcat/sakai
subversion:/svn/component/trunk/component-api/component/src/config/
org/sakaiproject/config/toolOrder.xml
Tools in Worksites – controlling the order
toolOrder.xml
toolOrder.xml<?xml version="1.0"?><toolOrder> <category name="course"> <tool id = "sakai.synoptic.chat" /> <tool id = "sakai.synoptic.discussion" /> <tool id = "sakai.synoptic.announcement" /> <tool id = "sakai.syllabus" /> <tool id = "sakai.schedule" /> <tool id = "sakai.announcements" /> <tool id = "sakai.resources" /> <tool id = "sakai.discussion" /> <tool id = "sakai.assignment" /> <tool id = "sakai.assignment.grades" /> <tool id = "sakai.samigo" />
<tool id = "sakai.gradebook.tool" /> <tool id = "sakai.dropbox" /> <tool id = "sakai.chat" /> <tool id = "sakai.mailbox" /> <tool id = "sakai.news" /> <tool id = "sakai.iframe" /> <tool id = "sakai.siteinfo" />
<tool id = "sakai.sakai.help" /><tool id = "sakai.contact.support" />
</category></toolOrder>
Doesn’t control which tools appear
If no entry for a worksite type, alpha order
Any page that has a tool in the list will be placed in the order set by the list.
If the page has multiple tools, it will be ordered with the first one in this list.
Tools in Worksites – controlling the order
toolOrder.xml<?xml version="1.0"?><toolOrder>
<category name="course"><tool id = "sakai.synoptic.chat" /><tool id = "sakai.synoptic.discussion" /><tool id = "sakai.announcements" selected = "true" />
….<tool id = "sakai.mailbox" /><tool id = "sakai.news" /><tool id = "sakai.iframe" /><tool id = "ctools.reserves" /><tool id = "sakai.siteinfo" required = "true" /><tool id = "sakai.contact.support" />
</category>
Tools in Worksites – additional controls in toolOrder.xml
If no toolOrder.xml file (default)Existing order isn’t changed
Tools added to site get added to end of list
If Home or Site Info are added, they are added at the top and bottom
If Home or Site Info is already in the site, their position isn’t changed
Tools in Worksites – controlling the order
Tools in Worksites – controlling the order
PageOrder tool – contrib in 2.3/contrib/asu/PageOrderHelper/ svn: http://bugs.sakaiproject.org/
confluence/display/POH/Home
We’ve specified Types of worksites in our installation
• To add a new type of siteEdit sitesetup.xml to add the site type
What tools show up in the list when adding tools to a worksite
• Edit the tool registration file to let Worksite Setup know to present that tool for selection
• Remember the stealthTool related settings in sakai.properties
The order of tools in the different types of worksites
• Edit the toolOrder.xml file to place the tool in the left hand menu
Still more to do before logging in
Worksite Tools
General configuration settings
General configuration used by toolsDefaults set in
• Tool components.xml files
• sakai.properties
svn: /svn/component/trunk/component-api/component/src/
config/org/sakaiproject/config/sakai.properties
Override with settings in <sakai.home>/sakai.properties
e.g. /usr/local/tomcat/sakai/sakai.properties
components.xml (snippet from /svn/email/trunk/email-impl/pack/src/webapp/ WEB-INF/components.xml)
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springkernel.org/dtd/spring-
beans.dtd"> <beans>
<bean id="org.sakaiproject.email.api.EmailService"class="org.sakaiproject.email.impl.BasicEmailService"init-method="init"destroy-method="destroy"singleton="true">
<lookup-method name="serverConfigurationService" bean="org.sakaiproject.component.api.ServerConfigurationService" />
<property name="smtp"><null/></property><property name="smtpPort"><null/></property><property name="smtpFrom"><null/></property><property name="maxRecipients"><value>100</value></property><property name="oneMessagePerConnection"><value>false</value></property><property name="testMode"><value>false</value></property>
</bean>
General configuration settings
Override components.xml settings
In sakai.properties, to override a component propertyForm a key: property @ bean = value
Default setting:</bean>
<bean id="org.sakaiproject.service.framework.email.EmailService" class="org.sakaiproject.component.framework.email.BasicEmailService" init-method="init" destroy-method="destroy" singleton="true">
….<property name="smtp"><null/></property> ….
</bean>
To override: [email protected]=214.233.26.119
(put in the sakai.properties file)
To override: [email protected]=214.233.26.119
(put in the sakai.properties file)
sakai.properties
Tool configuration via properties
Assign a value to the property
Default values:version.service=sakai_2-3-0
version.sakai=sakai_2-3-0
display.users.present=true
To override (put these in the sakai.properties file):version.service=Ruler 1.0version.sakai=2.3display.users.present=false
sakai.properties
Multiple configuration files supportedsakai.properties
local.properties (if present, overrides sakai.properties)
security.properties
Documents in the Sakai Development site Resources and svn: svn/reference/trunk/docs/architecture
How to Configure Sakai Resources/Architecture Docs/Sakai 2/Sakai Configuration
Sakai Properties
Resources/Architecture Docs/Sakai 2/Sakai Properties
sakai.properties
Use sakai.properties to set
• Email• Support, help email addresses• Help on/off• Presence• ‘Affiliate’ participants• Active/Inactive user control• Edit site title control• Course,Subject,Section field size (now set in provider implementation)
• Footer links• Server name, URL• Login fields• Footer copyright notice, links• Skins• Resource copyright notices• Semester labels and dates
sakai.properties
Examples
UMich sakai.properties
UMich toolOrder.xml
Now it’s time to login!
Additional configurations done as Admin user
Admin configurations
Default Roles and Permissions (realms)
User types (different from role in a site)
My Workspace default tools
Gateway tools
MOTD
Miscellaneous configurations
A site when created inherits a realm template
Use the Admin Realm tool to edit realms
Worksites get!site.template.<type>
Where <type> is the worksite type (e.g., course, project)
!site.templateFor untyped worksites, or worksties without a
corresponding !site.template.<type>
Worksite type default roles, permissions
A site’s default roles are inherited from the associated realm template !site.template !site.template.course
access Instructormaintain Student
Teaching Assistant
The realm also specifies the site creator’s role
Defaults are maintain, Instructor
Worksite type default roles, permissions
Sakai OOTBSakai OOTB
Worksite type default roles, permissions
UM CToolsUM CTools
Worksite type default roles, permissions
What is in a realm?
Edit !site.template realmSee creator role setting, roles
Worksite type default roles, permissions
Example - UM!site.template.project !site.template.course
Owner OwnerOrganizer InstructorMember AssistantObserver Student
ObserverAffiliate
Issues associated with different sets of rolesImplications with externally provided users (registrar)
Worksite type default roles, permissions
Group templates, permissions
Sakai OOTBSakai OOTB
Worksite type default roles, permissions
Groups
Group template should have same roles
Same inheritance mechanisme.g. !group.template.course
Permissions for
group aware tools only
Groups
Assignments Resources Schedule Announcements
Worksite type default roles, permissions
Each role has a set of permissionsThese are all the permissions that can be set in all the
Permission pages of tools (and then some)
ReviewCreate !site.template, !group.template realms to match worksite types (if you want to)
Easiest to copy an existing realm to a new one
Define roles in the !site.templatesEasiest to copy an existing role to a new one
Add the role description
Define default permissions for each role
Worksite type default roles, permissions
Keep a master list of your settings
Worksite type default roles, permissions
Helper realm
Another way to influence role permissionsAdd a permission setting to a role in all existing sites that contain that role!site.helper realm
!site.helper realm permission settings are added to corresponding roles in realms of all sitesCan be used to add new permission settings to roles in old sites
!site.helper/site/1123342-334
tool.perm1 tool.perm2 tool.perm3 tool.perm4 tool.perm5
Resultant permissions for Instructor role in site 1123342-335
Permissions settings for Instructorrole in site and helper realms
Examples – • asn.grade permission added• Gradebook permissions in 2.0
Note!
Helper realm
User types
Users can have typesScope is the installation
These are different from Roles scoped in a site
Users (accounts) get realms from!user.template.<type>
Where <type> is the account type (e.g., guest, registered)
!user.templateFor untyped accounts, or accounts without a
corresponding !user.template.<type>
User types
Admin User tool – creating a new userAdmin User tool – creating a new user
Account tool – creating a new userAccount tool – creating a new user
Sakai OOTBSakai OOTB
User types
UM CToolsUM CTools
User types
User types
!user.templates are realms – they have roles
It is the .auth role for a !user.template that controls the account’s rights in the application scope
site.add permission in the .auth role controls whether the account can create new worksites or not
User types
Sakai OOTB - .auth role
!user.template site.add
!user.template.guest site.add
!user.template.maintain site.add
!user.template.registered site.add
!user.template.sample site.add
User types
Example: UM CTools - .auth role
!user.template site.add
!user.template.friend site.add
!user.template.guest site.add
!user.template.colleague site.add
!user.template.uniqname site.add
Still new discoveries!
Published: September 30, 2006
A redwood tree discovered in a remote California forest has turned out to be the world’s tallest tree, edging out one nearby that had been the titleholder.
Prof. Steve Sillett of Humboldt State University said the record-setting tree, named Hyperion, was 379.1 feet tall, bettering the previous record holder, the 370.5-foot-tall Stratosphere Giant.
On the October 6th Saturday Night Live's Weekend Update segment, it was said that the tree was found using a method called "looking."
The User My Workspace
When a user first logs in, their My Workspace is created
The My Workspace pages/tools an account has is determined by the account type
A site template is used to define the pages/toolsUsers (accounts) get a My Workspace based on
!user.<type>Where <type> is the account type (e.g., guest, registered)
!userFor untyped accounts, or accounts without a
corresponding !user.<type> template
The User My Workspace
Use !user.<type> templates if you want different types of users to have different My Workspace pages/tools
Sakai OOTB - !userSakai OOTB - !user
The User My Workspace
Use the Admin Site tool to edit/create !user.<type> templates
Easiest to copy !user to !user.sometype
The User My Workspace
Example – UM
!user.uniqname Home
Worksite Setup
Site Browser
Membership
Schedule
Announcements
Resources
UM Webmail
News
Web Content
Preferences
My Profile
!user.guest Home
Worksite Setup
Site Browser
Membership
Schedule
Announcements
Resources
News
Web Content
Preferences
My Profile
The User My Workspace
Editing sitesAdd a new page
Add tools to a page
Demo• Add Web Content tool to the My Workspace !user
template
User accounts, my workspaces
ReviewWe’ve decided on site and account types, Defined default roles and permissions in sites,Specified who can add new sites, Decided on what pages/tools show up
A few other configurationsGateway pageMOTDWelcome Message
Gateway Page
The !gateway site
Gateway Page
Edit the !gateway siteCreate a MOTD
Edit the Welcome message
Edit the info files (About, Training, etc.)
Admin Sites tool to edit pages/tools• Remove the New Account tool?
Gateway Page
Create a MOTD In the Admin site – create a MOTD using the tool on the admin’s MOTD page
• This tool is a specially configured Announcement tool (sakai.announcement) that creates announcements on the
channel = /announcement/channel/!site/motd
The Message of the Day tool (sakai.motd) on the gateway site – special display tool to view the motd
• sakai.motd displays the announcement channel
/announcement/channel/!site/motd
Gateway Page
Announcement tool configuration for displaying the motd on the gateway page
/announcement/channel/!site/motd/announcement/channel/!site/motd
Gateway Page
Edit the Welcome messageThe Welcome message is displayed in a Web Content tool (sakai.iframe.service) specially configured (a clone of sakai.iframe)
Displays the content at
Other information files…
/library/content/server_info.html
Information files
Displayed by various iframe toolsWeb Content (sakai.iframe)
webcontent.instructions.url = /library/content/webcontent_instructions.htmlInstructions that appear when URL is blank in Web Content tool
My Workspace Information Display (sakai.iframe.myworkspace) myworkspace.info.url = /library/content/myworkspace_info.html A message for My Workspaces (tool in the !user template)
Service Information Display (sakai.iframe.service) server.info.url = /library/content/server_info.html Welcome message on gateway
Site Information Display (sakai.iframe.site) Displays the description in a site – Worksite Info tool on site Home page
Also, while were talking about library fileswebdav.instructions.url = /library/content/webdav_instructions.html
Gateway page
Information behind Gateway pages should be customized to your installation, tools
Information Files
To edit them, • Edit the source – (not recommended)
Files in:› /reference/trunk/library/src/webapp/content › sakai\reference\library\src\webapp\content\gateway
• Or, create new files in Admin’s Resources› Put them in public, public/gateway› Override default locations by adding new URLs in
sakai.properties, e.g.
server.info.url = /content/public/the_server_info.html
myworkspace.info.url = http://someserver.org/somepath/somefile.html
Gateway Page/content/public/server_info.html in the Admin’s Resources/public folder
Gateway Page
Gateway page is setupPages and tools on the page in the left hand menu column have been specified
MOTD and Welcome message have been edited
ReviewNew instance setups
!user.template.registered !user.template.<types>Change site.add permission based on account type to control who can add new sites
Add institutional roles to !site.template!site.template !site.template.<sitetypes>Add Roles, adjust permissions
Edit roles, permissions in !group.templates
Upload files to Admin’s Resources/public folder• Local server_info, training, features, about, webcontent, error page…• Edit !gateway site to use WebContent tools pointed to these files• Edit !error site to point to error page
Review
New instance setups, cont.
!user site template !user.<accounttype>
Edit tools as needed in these My Workspace templates (e.g., institutional webmail)
Add tools to !admin site (e.g., Become User tool)
Add MOTD
Edit !admin realm to add admin users
Still more…
Other things to think aboutSkins
• see documentSubversion: trunk/
sakai/docs/architecture/sakai_skin_portal.doc Collab site:
Skin docs in ‘Resources: architecture docs/sakai 2’
Help, support email addresses
News tool default URL
A few new things
Imports – drafts or not?By default, assignment, discussion, and announcement items import with draft status
import.importAsDraft = false # imports come in posted – not as drafts
A few new things
Hide left hand menu column items by role
e.g.,
Web Content
A few new things
Hide left hand menu column items by roleHide left hand menu column items by role
A few new things
Before 2.3content.all.groups
content.new
content.read
content.delete
content.revise
For 2.3content.all.groups
content.new
content.read
content.delete.own
content.delete.any
content.revise.own
content.revise.any
Resources (content) permissions(similar permissions added for Schedule, Account)Resources (content) permissions(similar permissions added for Schedule, Account)
A few new things
Before 2.3user.add
user.del
user.upd.any
user.upd.own
For 2.3user.add
user.del
user.upd.any
user.upd.own
user.upd.own.email
user.upd.own.name
user.upd.own.passwd
user.upd.own.type
Account permissionsAccount permissions
A few new things
Before 2.3calendar.all.groups
calendar.delete
calendar.import
calendar.new
calendar.read
calendar.revise
For 2.3calendar.all.groups
calendar.delete.any
calendar.delete.own
calendar.import
calendar.new
calendar.read
calendar.revise.any
calendar.revise.own
Schedule permissionsSchedule permissions
Questions
Create an account at http://collab.sakaiproject.org
Use the Membership tool in your my Workspace to join the Sakai Development worksite
Send email to
Questions
DocumentsSakai Development site Resources on collab
• sakai.configuration.pdf in particular• sakai_properties.pdf• helper_realm.pdf• sakai_permissions.pdf
Word docs in subversion – make corrections! https://source.sakaiproject.org/svn/reference/trunk/docs
Email archive at the Sakai Development site
Confluence http://bugs.sakaiproject.org/confluence/
› Sakaipedia, Sakai Installation FAQ