SpACE-w PowerLink

The SpACE (Spatial Activities in Course Environments) project combines map data using Google Maps with related content and resources. It can be used for a wide range of activities, including walking tours, field trips, locations of distance students. SpACE-w is an implementation of the editor interface for creating such resources within the WebCT environment.

The SpACE-w PowerLink is written for WebCT Vista 4.2 (or higher) and WebCT Campus Edition 6.2 (or higher) but has only been tested with WebCT Vista 8.0. It has the following dependencies:

• Java Wikipedia API (Bliki engine)
• org.apache.commons.fileupload
• WebctDAO utility
• ProxyToolRegistry utility

It also uses the User Interface (UI) components from the Fluid project; specifically the Reorderer component.

This PowerLink allows users to add placemarks to a map and associate each one with some content. The map uses the Google Maps API and content is entered using MediaWiki markup. Resource files can be uploaded to the proxy tool and associated with one or more placemarks. The display generated by the application will depend upon the user's role and the options set by the server administrator and section designer.

Section Designer view

This view provides the following areas:

• Map - a map area allowing the default centre and zoom level to be set as well as any initial placemarks to be added
• Order - a list of any initial placemarks allowing them to put in sequence
• File Manager - a file facility allowing default files to be uploaded for use with the initial maps created by users
• Options - settings to configure this instance of the proxy tool:
  • open and close student access
  • create a separate map for each user?
  • maximum number of placemarks which can be added per user (0-26)
  • details of any categories of placemarks
  • maximum size of uploaded files (Kb) - this cannot exceed the server permitted maximum
  • details of any map overlays to be included
  • date/time from which student access is available
  • date/time at which students are no longer able to make changes
• Users - a list of users displaying for each one:
  • name
  • date when map was created
  • date of last modification to map
  • option to delete (reset) their map

Section Instructor view

This view provides the following areas:

• Map - a map area allowing placemarks to be added - the map will be initialised to that created via the Section Designer view
• Order - a list of placemarks allowing them to put in sequence
• Description - an area displaying content specific to the selected placemark
• Resources - a facility for adding additional resources to be associated with the selected placemark
• File Manager - a file facility allowing files to be uploaded for use with the placemarks added to the map (this area will not be displayed if file uploads are not being permitted)
• Users - a list of users displaying for each one:
  • name
  • date when map was created
  • date of last modification to map
  • option to view their map (using a read-only mode)

Student view

This view is identical to that of a Section Instructor (see above) except that it does not include the Users area.

Examples

The presentation of the editor and viewer displays is controlled by HTML and CSS files which can be tailored to meet individual requirements. Follow these links to see an example of the Student editor view and of the View-only mode. Note that these examples are static versions and are not connected to a database; hence editing changes cannot be saved and deleting files merely removes the item from the screen and not from any file system.

This PowerLink is installed in the same way as any other WebCT Vista 4+ PowerLink:

1. Create a directory called SpACE-w in the deployablecomponents area of the WebCT domain directory on each application server (including the administration server for a cluster).
2. Copy the SpACE-w.jar file into the SpACE-w directory.
3. Place a copy of the dependent java packages in the same directory as the PowerLink or the Common directory so they can be shared with other PowerLinks
4. Configure the ProxyToolRegistry utility if it has not already been done (see the ProxyToolRegistry utility page for details)
5. Restart the WebCT service.
6. Log into WebCT as serveradmin.
7. In the Utilities, Settings area click on the link labelled SpACE-w module in the System Integration column.
8. Enable the tool by selecting the radio button labelled True for the enable setting and click on the Save Values button at the bottom of the page.
9. In the Utilities, PowerLinks Proxy Tools area click on the Add Proxy Tool button.
10. Select SpACE-w module from the drop-down list and click on the Next button.
11. Enter details as required in the boxes provided; for example:
    • Proxy Tool Name: SpACE editor
    • Version: 1.0
    • Description: Editor for the SpACE tool.
    Note: the Proxy Tool Name is what will appear to Section Designers when they add the tool to their sections. Click on the Save button.
12. In the Utilities, Settings area click on the link labelled with the Proxy Tool Name entered in the previous step which should appear in the Tools column.
13. Clear the tick in the Lock setting checkbox for the Enable Tool setting. Click on the Save Values button.
14. Select the settings for the proxy tool again to enable the tool by default so that it is visible under the Add Content Link button within each section. Leaving it disabled will mean that Section Designers must enable the tool in each of their sections before it can be used.
15. Copy the files within the website.zip file in the distribution zip file onto a web server (location as specified in the configuration settings below).

The SpACE-w PowerLink has the following custom configuration settings:

Notes:

1. The level specifies the level of the learning context hierarchy at which this setting should be specified; it may, of course, be inherited from a higher level except for the space code suffix which is set automatically at the section level. Due to a bug in WebCT, value for settings at levels above Section should be edited for the module in the System Integration column of the Utilities area and not for the proxy tool itself in the tools column (see the known issues page for details).
2. A setting value of NA is treated as an empty string; this is a workaround to the SDK bug relating to locked empty settings (see the known issues page for details).
3. A unique API key is required for each domain name and should be obtained from Google.
4. This URL should be to the area containing the supporting website files (see Installation section above) and include the trailing /. It may reside on any accessible area of any web server. For example, the files may be placed in the Public Files directory on a specially created section within WebCT. This would be specified as http://webct.server.domain/webct/RelativeResourceManager/X/Public%20Files/, where X is the ID of the section template. One place to find the template ID is in the URL link to the section on a My Blackboard page (visible, for example, on the status bar when moving the mouse pointer over the link). This URL has the following form: http://webct.server.domain/webct/urw/lcY.tpX/startFrameSet.dowebct... where Y is the learning context ID and X is the template ID.
5. This directory will be automatically created in the Class Files area of the section if it does not already exist. Resource files will be placed in subdirectories for each instance of the proxy tool (see below). The path specified can include more than one directory level.

Managing the tool

Follow these steps to add a new instance of this tool within a section:

1. enable the tool (if it is not already) by selecting the proxy tool from the Manage Course, Settings page
2. on the Build tab, click on the Add Content Link button and select the Toolbox proxy tool
3. select an existing instance of this tool, or click on the Create button to add a new one
4. enter a title to be displayed on the page, and optionally any required maximum file upload size to override the server maximum
5. click on the Save button

After adding a new instance it can be customised to suit the particular needs; for example:

• on the Build tab, click on the ActionLinks icon next to the instance of the tool
• select the Preview option from the menu; this will open the configuration page in a new window
• add any placemarks to the map and related content (see below) which are to be initialised on the users' maps when they first access this instance of the tool
• upload any default resource files using the file manager - these will be copied to the users' file area when they first access this instance of the tool
• change the default settings on the Options tab as required; for example, select the shared map option if the same map is to be edited by all users, and open the tool once it is ready for use.

Managing placemarks

To add a new placemark:

1. if the map is not already displayed, click on the Map tab
2. click on the map (not on an existing placemark) at the point where the new placemark is to be added, a window will be displayed on the map
3. enter a name for the new placemark and click the OK button; or click the Cancel button to close the window without creating a new placemark

Note that placemarks added to the map displayed from the Build tab represent the defaults for new maps created by users; all other maps (from the Teach tab or for Students) are user-specific maps.

To change the selected placemark:

1. click on the placemark on the map; or
2. click on the placemark name from the list on the Order tab

The selected placemark will be displayed with a different coloured marker on the map and with a different coloured background in the ordered list. The Description and Resources areas of the page display content related to the selected placemark.

To change the title or description for a placemark:

1. select the placemark (see above)
2. if the description is not already displayed, click on the Description tab
3. click on the Edit button (either at the top or bottom of the current description)
4. edit the title or description text as required and click on the Save button; or click the Cancel button to close the edit area without saving any changes

The description of a placemark should be entered using MediaWiki markup. Any images to be displayed should first be uploaded (see below).

To move a placemark to a new location:

1. select the placemark to be moved (see above)
2. if the map is not already displayed, click on the Map tab
3. click and drag the placemark marker to the new location, release the mouse button when the marker is in its new location

Note that only the currently selected placemark can be moved.

To change the order of a placemark:

1. select the placemark to be moved (see above)
2. if the list of placemarks is not already displayed, click on the Order tab
3. click and drag the placemark name up or down the list; release the mouse button when the red line is displayed at the new position

Note that the letter associated with each placemark on the list and on the map will be automatically updated when a placemark is moved.

To delete a placemark:

1. select the placemark to be deleted (see above)
2. click on the Delete button next to the placemark title above the Description and Resources tabs
3. in the dialog box displayed, click on the OK button to delete the placemark; click on the Cancel button to retain the placemark

Note that deleting a placemark does not delete any image files displayed in its description.

To add a resource to a placemark:

1. select the placemark (see above)
2. if the resource list is not already displayed, click on the Resources tab
3. click on the Add button for the type of resource to be added
4. enter a title for the resource in the dialog box displayed
5. click on the OK button to continue; click on the Cancel button to stop the process of adding a new resource
6. enter a location (see below) for the resource in the dialog box displayed
7. click on the OK button; click on the Cancel button to stop the process of adding a new resource

The type of resource merely determines the icon displayed alongside it, except that quotes do not have to provide a location. The location of a resource should either be a URL or the name of an uploaded file (see below).

To edit a placemark resource:

1. select the placemark (see above)
2. if the resource list is not already displayed, click on the Resources tab
3. click on the Edit button next to the resource to be edited
4. change the name of the resource as required in the dialog box displayed
5. click on the OK button to continue; click on the Cancel button to stop editing the resource and not make any changes
6. change the location as required in the dialog box displayed
7. click on the OK button to save any changes to the name and/or the location; click on the Cancel button to stop editing the resource and not make any changes

To delete a placemark resource:

1. select the placemark (see above)
2. if the resource list is not already displayed, click on the Resources tab
3. click on the Delete button next to the resource to be deleted
4. in the dialog box displayed, click on the OK button to delete the resource; click on the Cancel button to retain the placemark

Note that deleting a resource does not delete any file used as its location.

Managing files

The File manager tab displays a list of files available to the user. This may include files copied from the default map when the map was first created, but the file area is specific to each individual user. Files uploaded into the tool may be used as:

• images displayed within the description of a placemark
• resources associated with a placemark

To upload a file:

1. if the file list is not already displayed, click on the File manager tab
2. enter the location of the file to be uploaded into the text box at the bottom of the list, or click on the Browse... button to locate the file
3. click on the Upload button to copy the file into the list

Note that any existing file of the same name is overwritten; a maximum file size limitation may also be set. The file extension is used to display an appropriate icon in the list.

To view a file:

1. if the file list is not already displayed, click on the File manager tab
2. click on the name of the file to be viewed; the file will be opened in a new browser window (or a Save dialog box will be displayed according to the type of file)

To delete a file:

1. if the file list is not already displayed, click on the File manager tab
2. click on the Delete button next to the file to be deleted
3. in the dialog box displayed, click on the OK button to delete the file; click on the Cancel button to retain the file

If you experience any problems using this PowerLink try the following to trace the cause:

• inspect the webct.log file for any reported errors
• as serveradmin, set the logging level for com.spvsoftwareproducts to DEBUG; the messages logged will be included in the webct.log file.
• check the setting for the supported files area and that this area contains the files from the distribition zip file

This work is written by Stuart Nicol and Stephen Vickers and is released under a Creative Commons GNU General Public Licence. The SpACE-w PowerLink will be available for download from OSCELOT where it is also possible to report bugs and submit feature requests.