Configuring Sakai John Leasia [email protected] Sakai Vancouver Conference May 30 – June 2, 2006

Configuring SakaiJohn Leasia

[email protected]

Sakai Vancouver Conference

May 30 – June 2, 2006

2

This session:

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

What can be configured in Sakai to fit your environment once the integration coding has

finished

3

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?

4

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

5

Worksite Types• Worksite type specified when worksite is created

6

Worksite Types• Other types are possible

– project, course, GradToolsStudent, Research, … – A type can be defined by using it

• Create a site using Admin Sites tool and enter a type

7

Worksite Types

8

Worksite Types• To change the types presented in Worksite Setup when

creating new sites, seetomcat/webapps/sakai-legacy-tools/tools

subversion: /trunk/sakai/legacy/tools/src/webapp/tools/sakai.sitesetup.xml

9

sakai.sitesetup.xml<?xml version="1.0"?>

<registration>

<tool

id="sakai.sitesetup"

title="Worksite Setup"

description="Modify your sites and create new ones.">











<configuration name="siteTypes" value="course,project" />



<configuration name="defaultSiteType" value="project" />



<configuration name="publicChangeableSiteTypes" value="project" />



<configuration name="publicSiteTypes" value="course" />



<configuration name="privateSiteTypes" value="" />

<configuration name="site_mode" value="sitesetup" type="final" />

<category name="myworkspace" />

</tool>

</registration>

10

Worksite TypesWhich tools can be chosen in a site?

11

<?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 Types• Which tools can be chosen in a site?

– Specified in the tool’s registry fileeg: trunk/sakai/legacy/tools/src/webapp/tools/sakai.membership.xml

Membership tool is only in My Workspaces

12

Worksite Types/svn/content/trunk/content-tool/tool/src/webapp/tools/sakai.resources.xml(Sakai 2.2)

<?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="myworkspace" />

</tool> </registration> Resource tool is in all site typesResource tool is in all site types

13

Worksite TypesAdditional control via stealthTools property

– Trumps the category_name values

Default:[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

[email protected]=

sakai.su, sakai.site.roster, sakai.assignment

Wiki tool shows up according to what is defined in sakai.rwiki.xml category_name values

14

Tools in Worksites• So, which tools can be added to a particular type

of worksite is controlled by entries in the tool’s <tool>.xml file

• What order are the tools displayed?

15

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

16

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.


17

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

18

• toolOrder.xml goes in the Sakai Home folder

e.g., sakai folder in tomcat root folder

/usr/local/tomcat/sakai

• Subversion: example file provided in /svn/reference/trunk/demo/


toolOrder.xml

http://toolOrder.xml.txt/

19

• 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


20

• We’ve specified – Types of worksites in our installation

• To add a new type of site– Edit 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 setting 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

Tools in Worksites

21

General configuration settings• General configuration used by tools

– Defaults set in • components.xml file

SVN: /svn/trunk/sakai/legacy/legacy-components/src/webapp/WEB-INF/components.xml

• sakai.propertiesSVN:/svn/trunk/sakai/kernel/component/src/config/org/sakaiproject/config/sakai.properties

– Override with settings in sakai.home/sakai.properties

e.g. /usr/local/tomcat/sakai/sakai.properties

22

components.xml (snippet)

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springkernel.org/dtd/spring-beans.dtd">

<beans>

</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>

<property name="logger"><refbean="org.sakaiproject.service.framework.log.Logger"/></property>

</bean> components.xml

General configuration settings

23

Override component.xml setting• 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> <property name="logger"><refbean="org.sakaiproject.service.framework.log.Logger"/></property>

</bean>

To override: [email protected]=214.433.23.119

(put in the sakai.properties file)

24

sakai.properties• Tool configuration via properties

Assign a value to the property

Default values:version.service=sakai_2-1-2_010

version.sakai=sakai_2-1-2_010

display.users.present=true

To override (put these in the sakai.properties file):version.service=2.1.2version.sakai=2.1.2display.users.present=false

sakai.properties

http://sakai.properties.txt/

25

sakai.properties• Multiple configuration files supported

– sakai.properties– local.properties (if present, overrides sakai.properties)

– security.properties

Documents in the Sakai Development site Resources: How to Configure Sakai

Resources/Architecture Docs/Sakai 2/Sakai Configuration/content/group/1097928811887-22636/Architecture%20Docs/Sakai%202/sakai_config.pdf

Sakai Properties

Resources/Architecture Docs/Sakai 2/Sakai Properties/content/group/1097928811887-22636/Architecture%20Docs/Sakai%202/sakai_properties.pdf

26

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

• Footer links• Server name, URL• Login fields• Footer copyright notice, links• Skins• Resource copyright notices• Semester labels and dates

27

Examples

• UMich sakai.properties• UMich toolOrder.xml

• Now it’s time to login!

Additional configurations done as Admin user

http://um-sakai.properties.txt/

http://um-sakai.properties.txt/

http://um-toolOrder.xml.txt/



28

Admin configurations

• Default Roles and Permissions (realms)

• User types (different from role in a site)

• My Workspace default tools

• Gateway tools

• MOTD

• Miscellaneous configurations

29

Worksite type default roles, permissions

• 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>

30


Sakai OOTBSakai OOTB

31


UM CToolsUM CTools

32


• A site’s default roles are defined in the site’s realm !site.template site.template.course

access Instructormaintain Student

Teaching Assistant

• Specify the site creator’s role– Defaults are maintain, Instructor

33

What is in a realm?

Edit !site.template realmSee creator role setting, roles

34


• Example - UM– !site.template.project !site.template.course

Owner OwnerOrganizer InstructorMember AssistantObserver Student

ObserverAffiliate

• Issues associated with different sets of roles• Implications with externally provided users (registrar)

35

• Group templates, permissions



36

Groups• Group template should have same roles• Same inheritance mechanism

– e.g., !group.template.course

– Permissions for group aware tools only

37

Groups

38


• Each role has a set of permissions(These are the permission that can be set in the Permissions page of tools)

39


Review• Create !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.templates– Easiest to copy an existing role to a new one– Add the role description

• Define default permissions for each role

40

Helper realm

• Another way to influence role permissions

• Add permission settings to *all* sites

• !site.helper realm– !site.helper realm permission settings are

added to corresponding roles in realms of all sites

– Can be used to add new permission settings to roles in old sites

41

!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

Helper realm

Note!

42

User types• Users can have types

– Scope 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 !site.template.<type>

43

User types

44


User types

45

UM CToolsUM CTools

User types

46

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

47

User typesSakai 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

48

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

49

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 their account type• A site template is used to define the pages/tools

– Users (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

50

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

51

The User My Workspace• Use the Admin Site tool to edit/create !user.<type>

templates– Easiest to copy !user to !user.sometype

52

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

53

The User My Workspace

• Editing sites– Add a new page– Add tools to a page

– Demo• Add Web Content tool to the My Workspace !user

template

54

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 configurations– Gateway page– MOTD– Welcome Message

55

Gateway Page• The !gateway site

56

Gateway Page

• Edit the !gateway site– Create 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?

57

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

58

Gateway Page• Announcement tool configuration for displaying

the motd on the gateway page

/announcement/channel/!site/motd/announcement/channel/!site/motd

59

Gateway Page• Edit the Welcome message

– The Welcome message is displayed in a Web Content tool (sakai.iframe.service) specially configured

– Displays the content at

Other information files…

/library/content/server_info.html

60

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

61

Gateway page• Also - Information behind Gateway pages should be customized to your installation, tools

62

Information Files– To edit them,

• Edit the source – (not recommended)– sakai\reference\library\src\webapp\content – sakai\reference\library\src\webapp\content\gateway

• Create new files– 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

63

Gateway Page• /content/public/server_info.html in the

Admin’s Resources/public folder

64

Gateway Page

• Gateway page is setup– Pages and tools on the page in the left hand

menu column have been specified– MOTD and Welcome message have been

edited

65

• Other things to think about– Skins

• 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

https://source.sakaiproject.org/svn/trunk/sakai/docs/architecture/sakai_skin_portal.doc

https://source.sakaiproject.org/svn/trunk/sakai/docs/architecture/sakai_skin_portal.doc

66

A couple examples• After install, problem joining sites

– User can join site, but doesn’t see the tab– User is shown as a participant when looking at the

site’s realm

1. First thought – missing or incorrect role entered in the ‘joinable’ field of the site

But that can’t be if the site was made joinable via wsetup since that tool provides selections or roles that exist in the site

67

Example 1, cont.

1. Must be something with the roleChecked permissions (realm) for the site – saw that the role did

not have site.visit

68

Example 2

• We had a project site that wanted an associated class roster– Added the ‘provider id’, but students couldn’t see the

site.

• Roles in our sites: – Project – Owner, Organizer, Member, Observer– Course – Owner, Instructor, Assistant, Student

• Externally provided users come in as Instructor or Student.

69

Example 2

• Solution:– Add Instructor and Student roles to the project

site’s realm (edit that site’s realm to add, not the template)

70

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

[email protected]

http://collab.sakaiproject.org/

mailto:[email protected]

71

Questions• Documents

– Sakai 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

Configuring Sakai

John [email protected]

Sakai Vancouver Conference

May 30 – June 2, 2006