Learning Objects Expo LX - Install Guide


Release 2.8.24
March 28, 2008

Requirements

NOTE: For information on new features and/or bugs fixed in this version, please visit the support section of our web site.

Important Notice

Due to an issue in Blackboard, you may experience a "PermGen space" error when installing or activating Campus Pack. The PermGen space is a special area of the Java memory map, called the permanent generation heap, used to hold class files and related data. Repeatedly installing building blocks tends to leak memory in this heap. When the heap becomes full, building blocks may fail. Sometimes they fail when they are activated (made available); other times they fail during use. Typically, restarting Blackboard (or just Tomcat) will resolve the error, as all old classfiles will be eliminated. Deployments that perform nightly Blackboard restarts rarely see this problem; on the other hand, deployments that have not restarted in some time are quite likely to see it.

As of Blackboard 7.2, 256 MB is allocated to the permanent generation heap. This is sufficient for many building block installations. Earlier versions of Blackboard allocated only 64 MB which is not sufficient to support installing many building blocks. On such systems it may be necessary to increase the PermGen space to prevent the out-of-memory error from occurring. To do so, perform the following steps:

  1. Edit the file blackboard/config/bb-config.properties. Note that this file may use UNIX line feeds which are hard to edit under Windows; it will appear as one long line with square characters instead of new lines. Please do your best to edit it anyway.
  2. Search for the bbconfig.jvm.options.extra.tomcat setting (you can typically just run a Find for "extra").
  3. Add the following value after the = character:
    -XX:MaxPermSize=256m -XX:PermSize=64m
    This will increase the heap size from 64 MB to 256 MB.
  4. Run the blackboard/tools/admin/PushConfigUpdates script and wait for it to complete. If you have a load-balanced system with shared configuration then you will need to bounce Tomcat on your other appservers; otherwise repeat this process on each appserver.

Note that you should only perform this process if you are familiar with, and comfortable running, the PushConfigUpdates script. For further information or assistance, please contact support@learningobjects.com.

Installation


IMPORTANT: If you have a previous release of Expo LX on your server, please review the update section at the end of this document.
  1. Download the loi-expolx-2.8.x.x.war file from the download site and save it to your desktop.
  2. Navigate to the System Admin tab in Blackboard.
  3. Click on Manage Building Blocks.
  4. Click on Install Building Block.
  5. Click on the Browse button, and find and select the saved loi-expolx-2.8.x.x.war file.
  6. Click the Submit button on the web page. The file will then upload.
  7. Click on the OK button on the receipt page to return to the Manage Building Blocks page.
  8. Change the status of Expo LX to Available.
  9. Click on the OK button on the Make Building Block Available page.
  10. The extension is now installed.
Registration


After installation, the extension must be registered with Learning Objects if you have not already registered or if you do not already have a license key for the application. To register, perform the following steps:
  1. Login to the Blackboard server as an administrator.
  2. Click on the System Admin tab.
  3. Click on Manage Expo LX link under Tools.
  4. Click on the Register your extension link.
  5. Complete the form on the Register Expo LX page and accept the license. If you do not have a promotional code, leave that field blank.
  6. Click submit on the form.
  7. Click OK on the receipt page.

    Within 24 hours, a registration key will be emailed to the address entered in the form.

  8. Return to the Expo LX License page.
  9. Click on the Install your key link.
  10. Copy the key from your email into the text box.
  11. Accept the license.
  12. Click submit on the form.
  13. The extension is now registered.
Enable Portal Module (Optional)

  1. Login to the Blackboard server as an administrator.
  2. Click on the System Admin tab.
  3. Click on the Manage Tabs link under Portal System - Management.
  4. Click on the Modify button associated with the My Institution tab.
  5. Click on the Default Content link.
  6. Find the Expo Sites portal module.
  7. Check both the Displayed and Required boxes.
  8. Click submit.
  9. The portal module is now available to all users.
Configuration (Optional)

  1. Login to the Blackboard server as an administrator.
  2. Click on the System Admin tab.
  3. Click on the Manage Expo LX link under Admin Tools.
  4. Click on the Manage Settings link.
  5. Update the storage location of Expo sites.
  6. Update the information the users are allowed to make publicly available.
  7. Update the name of the tab that the Expo LX portal module is on.
  8. Update the name of Expo LX.
  9. Click submit.
Supported Browsers


Expo LX uses the browser's Design Mode feature to implement WYSIWYG html editing. The following is a list of browsers that support Design Mode:
Known Issues

A full list of known issues is in the Campus Pack release notes

Uninstall

  1. Login to the Blackboard server as an administrator.
  2. Click on the System Admin tab.
  3. Click on Manage Building Blocks.
  4. Change the status of Expo LX to Inactive.
  5. Click on the OK button on the receipt page to return to the Manage Building Blocks page.
  6. Return to the Manage Building Blocks page.
  7. Click on the remove button for Expo LX.
Update / Upgrade


If a previous release of Expo LX is installed, it must be uninstalled by following the uninstall instructions (above), and then installing the newer release.

If you have a load-balanced configuration, special care must be taken when upgrading to be sure that all of the application servers properly reload the new version. The best way to ensure this is to restart each application server after upgrading each of the Campus Pack applications. If you are unable to restart your application servers, please wait 2 to 5 minutes after removing the old versions before attempting to install the new ones.

You can check to be sure that each of the application servers upgraded correctly by viewing the Expo LX logs.

  1. Login to the Blackboard server as an administrator.
  2. Click on the System Admin tab.
  3. Click on Manage Expo LX.
  4. Click Download Logs.
  5. When prompted, save the log archive to a temporary location.
  6. Open the ZIP file and view each of the included Expo LX log files. There should be one for each application server.
  7. Look in each log for a message showing that the old version stopped, and a following message showing that the new version started.
    Example:
    2006-04-25 14:50:42|INFO: Expo LX v2.6.0.4487 stopped [com.learningobjects.util.ExtensionUtil.destroy]
    2006-04-25 14:58:41|INFO: Logging at level INFO [com.learningobjects.util.ExtensionUtil.initLogging]
    2006-04-25 14:58:41|INFO: Expo LX vx.x.x.x started on Blackboard v6.3.1.374 [com.learningobjects.util.ExtensionUtil.init]
        
  8. If any application server is missing these messages, restart Tomcat on that server to force it to reload the application. After it finishes restarting, check the log for that host again to ensure that the correct version is running.