Manually Adding a Tool to a Sakai Site

By default, provisional tools for each version of Sakai are added to a list of tools which are available, but which cannot be added to a site using the "Site Info" or "Worksite Setup" tools.

Adding the tool manually involves a few additional steps, which are outlined here using Rwiki as an example.

1. log into Sakai as a superadmin.
2. open the "Administration Workspace" site.
3. Find the site using the "Sites" tool (you may wish to search for the site using the "Worksite Setup" tool and then copying and pasting the site ID into the search found in the "Sites" tool). Click the site ID to open its site information.
4. On the site information page, click the "Pages" button near the bottom of the screen.
5. Click the "New Page" link near the top of the screen that appears.
6. Enter the desired title (Typically the end-user name of the tool that appears in the left navigation menu, something like "Rwiki"). Without clicking the "Save" button, click on the "Tools" button.
7. Click on the "New Tool" link at the top of the page that appears.
8. Rwiki's tool id should appear on the next page of radio-buttoned tools, if it is indeed registered. Select its radio button. Save your changes using the "Save" button at the very bottom of the screen.

As mentioned above, you can use this procedure to add "stealthed" tools to a site. You can also add one or more options to your sakai.properties file to control whether not a tool is stealthed. To unstealth all tools, clear out the list of stealthed tools by adding a line like the following to your sakai.properties file

stealthTools@org.sakaiproject.api.kernel.tool.ActiveToolManager=

To make a particular tool visible without making any other stealthed tools, you can add a line like the following to your sakai.properties file:

visibleTools@org.sakaiproject.api.kernel.tool.ActiveToolManager=sakai.rwiki

You can also manually add tools to a site type (course, project, etc.) for which they would not otherwise be allowed. To change the list of site types for which a tool is allowed, you need to edit its TOOL_ID.xml file (sakai.rwiki.xml in the case of rwiki) and update the list of allowed site types. The code below is an example XML snippet:

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

Once you have located and updated this file, you will need to stop, rebuild, redeploy, and start your Sakai installation for the changes to take effect.