Making tool hidden to students, but visible to Teachers and Administrators

[Juan Velasquez]

Aloha,
I'm a new developer writing a new tool,
this tool will be usable only by Teachers and Administrators,  not
visible by students at all.
Do I use the SecurityService for this?

Also,  the JavaDocs don't see to be available,
http://nightly2.sakaiproject.org/javadoc/org/sakaiproject/authz/api/SecurityService.html
Does anyone know the url?


Thanks.
Juan.


--
This message has been scanned for viruses and
dangerous content by MailScanner, and is
believed to be clean.

----------------------
This automatic notification message was sent by Sakai Collab (https://collab.sakaiproject.org/portal) from the DG: Development (a.k.a. sakai-dev) site.
You can modify how you receive notifications at My Workspace > Preferences.

[Harriet Truscott]

Hi Juan

Well, you could save yourself a bit of work and simply get the site owners
to hide your tool from students when they add it to the site using the Page
Order tool?

Harriet



- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Centre for Applied Research in Educational Technologies
University of Cambridge
16 Mill Lane
Cambridge
01223 765 040

> -----Original Message-----
> From: Juan Velasquez [mailto:juan@...]
> Sent: 13 March 2008 09:20
> To: sakai-dev@...
> Subject: Making tool hidden to students, but visible to
> Teachers and Administrators
>
> Aloha,
> I'm a new developer writing a new tool,
> this tool will be usable only by Teachers and Administrators,
>  not visible by students at all.
> Do I use the SecurityService for this?
>
> Also,  the JavaDocs don't see to be available,
> http://nightly2.sakaiproject.org/javadoc/org/sakaiproject/auth
> z/api/SecurityService.html
> Does anyone know the url?
>
>
> Thanks.
> Juan.
>
>
> --
> This message has been scanned for viruses and
> dangerous content by MailScanner, and is
> believed to be clean.
>
> ----------------------
> This automatic notification message was sent by Sakai Collab
> (https://collab.sakaiproject.org/portal) from the DG:
> Development (a.k.a. sakai-dev) site.
> You can modify how you receive notifications at My Workspace
> > Preferences.
>
> No virus found in this incoming message.
> Checked by AVG.
> Version: 7.5.519 / Virus Database: 269.21.7/1327 - Release
> Date: 12/03/2008 13:27
>  
>

No virus found in this outgoing message.
Checked by AVG.
Version: 7.5.519 / Virus Database: 269.21.7/1327 - Release Date: 12/03/2008
13:27


----------------------
This automatic notification message was sent by Sakai Collab (https://collab.sakaiproject.org/portal) from the DG: Development (a.k.a. sakai-dev) site.
You can modify how you receive notifications at My Workspace > Preferences.

[csev]

Juan,

This is pretty easy.  Take a look at this document:

https://source.sakaiproject.org/svn/reference/trunk/docs/architecture/sakai_workgroup_portal.doc

Here is an excerpt from that document.

<registration>
<tool        id="sakai.rutgers.linktool"
title="Link Tool"
description="A tool to link to external  
applications.">

<category name="course" />
<category name="project" />

<!-- Allow this to be set -->
<configuration name="functions.require" />
</tool>
</registration>

As we explore the use of these features, remember that the key value  
of functions.require is to make tools disappear when a user is missing  
a permission.  So this allows a site to have many tools that are all  
there when people are logged in and then have those buttons disappear  
for anonymous users or for users with or without a particular role.

In Sakai 2.3 there were very few tools that made use of this  
capability - for the Rutgers link tool the key was to allow a tool  
(and its page) to be suppressed for students if it was a link to a  
campus-wide grading system.  In this example the tool registration  
does not specify which function was required to include the tool in  
the buttons on the left hand side of the Sakai display.  For the link  
tool, often a function like site.upd was used as an indicator of  
highly powered users - any function will do - it does not have to be a  
function for the tool itself.  Another possible function might be  
content.new if this function were only given to instructor or maintain  
roles.

Here is an example of the use of this in the resources tool  
registration:

<registration>
<tool
id="sakai.resources"
title="Resources"
description="For posting documents, URLs to other websites, etc.">

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

<configuration name="functions.require" value="content.read" />
</tool>
</registration>

The full file is here:

https://source.sakaiproject.org/svn/content/trunk/content-tool/tool/src/webapp/tools/sakai.resources.xml

So after all that - the quick summary is that if you want to hide a  
tool except for Site Owners, add a line like

<configuration name="functions.require" value="site.upd" />

To your tool registration.

A nice thing is that all this functions.require sets is the default  
value - it can be overridden by tech support on a a case by case basis  
once the tool is placed in a site.  I think that the Page Order tool  
also changes this property on a tool placement as well - so if you  
enable page order, I think that even the instructor can fiddle with  
this setting on a case by case basis.

/Chuck

On Mar 13, 2008, at 5:20 AM, Juan Velasquez wrote:

> Aloha,
> I'm a new developer writing a new tool,
> this tool will be usable only by Teachers and Administrators,  not  
> visible by students at all.
> Do I use the SecurityService for this?
>
> Also,  the JavaDocs don't see to be available, http://nightly2.sakaiproject.org/javadoc/org/sakaiproject/authz/api/SecurityService.html
> Does anyone know the url?
>
>
> Thanks.
> Juan.
>
>
> --
> This message has been scanned for viruses and
> dangerous content by MailScanner, and is
> believed to be clean.
>
> ----------------------
> This automatic notification message was sent by Sakai Collab (https://collab.sakaiproject.org/portal 
> ) from the DG: Development (a.k.a. sakai-dev) site.
> You can modify how you receive notifications at My Workspace >  
> Preferences.
>
>
>

[see attachment: "message0.html", size: 9033 bytes]


Attachments:

message0.html
https://collab.sakaiproject.org/access/content/attachment/fc31fda9-0358-4ed5-0080-9732f23823ca/message0.html

----------------------
This automatic notification message was sent by Sakai Collab (https://collab.sakaiproject.org/portal) from the DG: Development (a.k.a. sakai-dev) site.
You can modify how you receive notifications at My Workspace > Preferences.

[Seth Theriault]

Juan Velasquez wrote:

> Also,  the JavaDocs don't see to be available,
> http://nightly2.sakaiproject.org/javadoc/org/sakaiproject/authz/api/SecurityService.html
> Does anyone know the url?

The closest thing to nightly javadocs is currently:

http://qa2-us.sakaiproject.org:9090/javadocs/

These are based on the latest 2.5 QA tag.

Seth

----------------------
This automatic notification message was sent by Sakai Collab (https://collab.sakaiproject.org/portal) from the DG: Development (a.k.a. sakai-dev) site.
You can modify how you receive notifications at My Workspace > Preferences.

[Maurer, Christopher Wayne]

There¹s a jira that was reopened a week or so ago in regard to the nightly
javadoc build issues:
http://bugs.sakaiproject.org/jira/browse/SAK-13008

Anyone is welcome to help us figure out why it won¹t build!

Chris


On 3/13/08 9:06 AM, "Seth Theriault" <slt@...> wrote:

> Juan Velasquez wrote:
>
>> > Also,  the JavaDocs don't see to be available,
>> >
>> http://nightly2.sakaiproject.org/javadoc/org/sakaiproject/authz/api/SecurityS
>> ervice.html
>> > Does anyone know the url?
>
> The closest thing to nightly javadocs is currently:
>
> http://qa2-us.sakaiproject.org:9090/javadocs/
>
> These are based on the latest 2.5 QA tag.
>
> Seth
>
> ----------------------
> This automatic notification message was sent by Sakai Collab
> (https://collab.sakaiproject.org/portal) from the DG: Development (a.k.a.
> sakai-dev) site.
> You can modify how you receive notifications at My Workspace > Preferences.
>
>

[see attachment: "message0.html", size: 1645 bytes]

[see attachment: "smime.p7s", size: 2141 bytes]


Attachments:

message0.html
https://collab.sakaiproject.org/access/content/attachment/07a95263-4353-4447-005c-35db00a61075/message0.html

smime.p7s
https://collab.sakaiproject.org/access/content/attachment/a79d2603-a65f-4473-8003-19e9342e3020/smime.p7s

----------------------
This automatic notification message was sent by Sakai Collab (https://collab.sakaiproject.org/portal) from the DG: Development (a.k.a. sakai-dev) site.
You can modify how you receive notifications at My Workspace > Preferences.

[Peter liu-2]

You could simply define a configuration attribute in your sakai.yourTool.xml
registration XML file such as:

...
<configuration name="functions.require" value="yourtool.view" />
...

Of course, you first need to define the permission in your tool. The line
above will hide the tool away for people who don't have this permission.

Cheers,
Peter

-----Original Message-----
From: Harriet Truscott [mailto:harriet@...]
Sent: Thursday, March 13, 2008 6:03 AM
To: 'Juan Velasquez'; sakai-dev@...
Subject: RE: Making tool hidden to students, but visible to Teachers and
Administrators

Hi Juan

Well, you could save yourself a bit of work and simply get the site owners
to hide your tool from students when they add it to the site using the Page
Order tool?

Harriet



- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Centre for Applied Research in Educational Technologies
University of Cambridge
16 Mill Lane
Cambridge
01223 765 040

> -----Original Message-----
> From: Juan Velasquez [mailto:juan@...]
> Sent: 13 March 2008 09:20
> To: sakai-dev@...
> Subject: Making tool hidden to students, but visible to
> Teachers and Administrators
>
> Aloha,
> I'm a new developer writing a new tool,
> this tool will be usable only by Teachers and Administrators,
>  not visible by students at all.
> Do I use the SecurityService for this?
>
> Also,  the JavaDocs don't see to be available,
> http://nightly2.sakaiproject.org/javadoc/org/sakaiproject/auth
> z/api/SecurityService.html
> Does anyone know the url?
>
>
> Thanks.
> Juan.
>
>
> --
> This message has been scanned for viruses and
> dangerous content by MailScanner, and is
> believed to be clean.
>
> ----------------------
> This automatic notification message was sent by Sakai Collab
> (https://collab.sakaiproject.org/portal) from the DG:
> Development (a.k.a. sakai-dev) site.
> You can modify how you receive notifications at My Workspace
> > Preferences.
>
> No virus found in this incoming message.
> Checked by AVG.
> Version: 7.5.519 / Virus Database: 269.21.7/1327 - Release
> Date: 12/03/2008 13:27
>  
>

No virus found in this outgoing message.
Checked by AVG.
Version: 7.5.519 / Virus Database: 269.21.7/1327 - Release Date: 12/03/2008
13:27


----------------------
This automatic notification message was sent by Sakai Collab
(https://collab.sakaiproject.org/portal) from the DG: Development (a.k.a.
sakai-dev) site.
You can modify how you receive notifications at My Workspace > Preferences.

----------------------
This automatic notification message was sent by Sakai Collab (https://collab.sakaiproject.org/portal) from the DG: Development (a.k.a. sakai-dev) site.
You can modify how you receive notifications at My Workspace > Preferences.