Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
1
Installation Guide
Apache and the Apache feather logo are trademarks of The Apache Software Foundation. Linux
is a registered trademark of Linus Torvalds. Microsoft, Active Directory, SQL Server, and
Windows are registered trademarks of Microsoft Corporation in the United States and/or other
countries. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Red Hat
and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other
countries. Sun, Java, JDBC, JDK, and Solaris are trademarks of Sun Microsystems, Inc. in the
United States and/or other countries. UNIX is a registered trademark of The Open Group.
Other product and company names mentioned herein may be the trademarks of their respective
owners.
No part of the contents of this manual may be reproduced or transmitted in any form or by any
means without the written permission of the publisher, Blackboard Inc.
Fresh Installations
If this is the first time you have installed Blackboard Learn, make sure to read the Release Notes
for the release that you are installing and any subsequent Service Packs, and then read this
section carefully. After reading the Release Notes and this section, you should be able to make
informed decisions about the configuration of Blackboard Learn at your institution. The next step
will be to read the configuration and installation instructions appropriate for the host environment:
Windows or UNIX.
If you are an experienced Blackboard Learn administrator, you will find some helpful information
in this section. After a quick review, proceed to the configuration and installation instructions
appropriate for your host environment.
Upgrades
If you are upgrading from a previous version of Blackboard Learn, see the Upgrade topics in
Blackboard Learn Help.
Before attempting to install, ensure that the appropriate skill sets are available to support the
installation and maintenance of Blackboard Learn.
Database Skills
The following database skills are recommended for installing and maintaining Blackboard Learn.
Network Skills
The following networking skills are recommended for installing and maintaining Blackboard Learn.
The following operating system and application server skills are recommended for installing and
maintaining Blackboard Learn.
Knowledge of how application servers work and how to start and stop the various servers
and system processes
Knowledge of how to add hardware to the server
Performing tape backups and tape archive programs and understand how to use these
backup tools to move files around the system and between machines
Experience managing multiple points of integration
Developer Skills
The following skills are recommended to create Blackboard Building Blocks or to use the Event-
Driven API.
Course Delivery
Community Engagement
Content Management
Outcomes Assessment
The features related to these capabilities are installed or updated based on the license file. This
means that all users follow the same install and update procedures regardless of which
capabilities are licensed.
Install and update tasks are accomplished using the same tool. When this tool is referred to as
the Installer, it is describing how the tool functions when installing software for the first time.
When this tool is referred to as the Updater, it is describing how the tool functions when it is run
on an existing installation.
Update Process
The Installer and Updater will update the system when run on an existing installation. Updates
are used to install:
The update will include all previous updates, hotfixes, and service packs into one package. From
time to time, Blackboard will release hotfixes to address specific issues. Hotfixes will not use the
Installer and Updater tool because they are so limited in scope. All hotfixes are included in the
next update.
The Installer and Updater can install set of capabilities in Blackboard Learn. It can be run on
single-server, dual-server, and load-balanced configurations. The Installer and Updater can be
run more than once. If stopped, the Installer and Updater must be restarted from the beginning.
The Installer and Updater presents several options when it is run on an existing installation:
Update: Installs the new features and fixes associated with a new release. An error
message will appear if it is not possible to update from the current version to the Updater
version.
Pre-Update Change Report: Reviews the current system configuration to ensure that the
Updater can be run successfully. The Pre-Update Change Report also details the files
that will be changed by the Updater.
Provide New License: This option processes a new license file for the system. It is used to
license additional capabilities or change the licensing of current capabilities.
Uninstall: This option removes Blackboard Learn capabilities.
Uninstall App Server Only: This option removes Blackboard Learn capabilities from a
dedicated App Server in a load-balanced installation. It does not remove the database or
shared file system. It does not remove any software from the other App servers.
WARNING! When providing a new license, downtime is required. This installation option will
perform a full upgrade, shutting down services.
The Installer and Updater cannot be used to return to an earlier release. Running the Installer of
an earlier version on a newer installation will not successfully convert the installation to the earlier
release.
The Installer and Updater does not install any other software, including prerequisite operating
systems and databases. For example, Blackboard Learn - Basic Edition clients must first install
Small-Scale Oracle, provided by Blackboard, before running the Installer and Updater. For more
information about Small-Scale Oracle, see the Small-Scale Oracle topics in Blackboard Learn
Help.
The Installer and Updater does not install supplemental tools such as OptiSERV or EnviSERV for
communicating with the Blackboard Transact and the Snapshot Tools for integration with other
information system on campus. These tools must be downloaded and installed separately.
Finally, the Installer and Updater does not allow for any advanced configuration such as setting
up LDAP Authentication, SSL, or Virtual Installation. For more information, see the Using
Blackboard Learn Authentication, About SSL and SSL Choice, and About Virtualizing the
Blackboard Reference Architecture topics in Blackboard Learn Help.
Database schema names have received a re-work for this latest version of Blackboard Learn.
When upgrading an existing instance, or creating a testing environment for an institution using the
legacy database schema names, please refer to the following table. Manual database schema
name changes on an existing schema should only be done with the assistance of Blackboard
support. Legacy environments should specify the legacy information within the database identifier
option in the installer when creating testing environments.
The activity_accumulator_cr procedure has been modified to insert new records into
the new table activity_accumulator_queue instead of directly into the
activity_accumulator table. The new table will be smaller in size, which reduces the
performance impact of activity_accumulator_cr, which runs for every user action. Use of
indexes on activity_accumulator_queue table should be avoided in the interest of
application performance.
A job has been scheduled via the Oracle DBMS_JOB interface to run a stored procedure
activity_accumulator_update which flushes the queue table every 10 minutes into the
actual activity_accumulator. The activity_accumulator_update copies data from the
queue table to activity_accumulator. The production table that holds the data permanently.
This job inserts data in 2000-record batches to the activity_accumulator (though it leaves
between 500-2000 records behind each time). Between the hours of 23:00 and 00:00 each night,
database time, the job moves a higher volume of data in order to clean up any missed records
from previously.
The PurgeAccumulator job is unchanged and still runs at 1:00 am every day to perform its
three functions of summarize (system tracking), synchronize (BBLEARN to BBLEARN_STATS), and
purge (BBLEARN).
Load-balanced configurations may include as many as six application servers. Also required are
a database server (or failover cluster), a file system server, and a Collaboration Tool server.
Select one of the existing application servers to also act as the Collaboration server. The
Collaboration server may not be spread across multiple application servers because all users
participating in a Collaboration session must share the same resources. A hardware load-
balancer is optional. Using a hardware load-balancer is the preferred method of load-balancing. A
network switch is used to handle communications from the client machines to the application
servers and the Collaboration server. A separate switch is used to handle a secure, private
connection between the application servers and the file system and database servers. The
database and file system must be on a secure, private network.
The diagram also shows integration with an LDAP server or servers to handle authentication and
an SIS system to share data with Blackboard Learn. Integrating these components with a load-
balanced configuration is not difficult, but does require each Web/application server to share the
same settings.
Finally, the diagram shows a Storage Area Network (SAN) device and a backup device. A SAN
device is not required but many institutions choose to use one. Regular, frequent data backup
and consistent recovery procedures are critical parts of any Blackboard Learn configuration. The
diagram shows a tape drive backup but any backup method may be used that meets the needs of
the institution.
Scaling out distributes the computing workload among multiple servers by clustering or load
balancing, with the ability to add servers to increase capacity. By distributing the workload,
processing resources are spread among multiple servers, which improves both performance and
the availability of the overall service.
Down time is reduced with a scale out approach because most single points of failure are
removed. If a server goes down, other servers pick up the load dynamically, allowing the
application to continue servicing clients.
For more information about configuring a Blackboard Learn environment to achieve the best
performance possible, see the Optimization topics in Blackboard Learn Help.
The About Hardware Sizing in a Dell Environment and About Hardware Sizing in a Sun
Microsystems Environment topics in Blackboard Learn Help provide detailed information about
choosing the appropriate hardware based on size, scalability, performance, and redundancy
needs. Read this guide before continuing.
Blackboard supports operating systems from three vendors for hosting Blackboard Learn:
For the exact versions of the databases that are supported, see "Supported Technologies" in the
Release Notes for the release that you are installing. It is critical that the operating system used
to host Blackboard Learn is a supported or compatible operating system. It is critical that the
operating system used to host Blackboard Learn is a supported or compatible operating system.
SPARC hardware is required for to install and run Blackboard Learn under Solaris operating
systems.
Choose a Database
This is an easy decision after selecting the operating system because Blackboard supports only
one database for each supported operating system. Blackboard supports Microsoft SQL Server,
Enterprise Edition, when Blackboard Learn is hosted on a Windows operating system (the
Standard Edition is compatible with Blackboard Learn). Blackboard supports an Oracle
database when Blackboard Learn is hosted on a Red Hat Enterprise Linux or Sun Solaris
operating system.
When Blackboard Learn - Basic Edition is hosted on a Red Hat Enterprise Linux or Sun Solaris
operating system, Blackboard provides a special version of Oracle called Small-Scale Oracle.
Small-Scale Oracle is the only database supported for Blackboard Learn - Basic Edition when
hosted on a Red Hat Enterprise Linux or Sun Solaris operating system. For more information
about Small-Scale Oracle, see the Small-Scale Oracle topics in Blackboard Learn Help.
When Blackboard Learn - Basic Edition is hosted on a Windows operating system, the supported
version of Microsoft SQL Server must be used.
For the exact versions of the databases that are supported, see "Supported Technologies" in the
Release Notes for the release that you are installing.
Read the About Hardware Sizing in a Dell Environment and About Hardware Sizing in a Sun
Microsystems Environment topics in Blackboard Learn Help to determine hardware requirements
for the installation. For the purposes of running the Installer, match the hardware to one of the
following models:
One server: This configuration hosts Blackboard Learn application software, file system,
and database on one machine. Keep in mind that a one server configuration is
appropriate for running a test system or Blackboard Learn - Basic Edition. Blackboard
Learn - Basic Edition can be run only on one server.
Two servers: This configuration hosts Blackboard Learn application software with the file
system on one machine and the database on another machine. This configuration is
appropriate for institutions with a smaller user base that do not need the performance or
redundancy of a load-balanced configuration.
Load-balanced: This configuration hosts the file system on one machine, the database on
another machine, and the application software is replicated on multiple machines to
handle more activity. This configuration offers the greatest scalability and redundancy.
Database Clustering
Some institutions may require database clustering as a redundancy to ensure that the system is
always available, even in the event of a database server crash.
For Windows, Blackboard supports installation on a Microsoft SQL Server Failover configuration.
For more information, see Set Up Database Clustering and Storage for Windows.
For UNIX, Blackboard offers support for Oracle RAC with all versions of Oracle supported by
Blackboard. For more information, see Set Up Database Clustering and Storage for UNIX.
In many instances, it is useful to store data, such as the files uploaded to a Course, on separate
storage hardware. For more information, see Set Up File System Storage for Windows or Set Up
File System Storage for UNIX. This is handled at the operating system level by pointing some
directories or all directories to a separate storage device. Likewise, it is possible to offload
storage of the database files to a separate hardware, such as a SAN.
Collaboration Server
Blackboard Learn includes features for synchronous communication such as a Chat Tool and a
Whiteboard Tool. These features are wrapped into the Collaboration Tool available within
Courses. The Collaboration Tool communications are handled by a dedicated service that
requires its own ports.
Select one of the existing application servers to also act as the Collaboration server. The
Collaboration server may not be spread across multiple application servers because all users
participating in a Collaboration session must share the same resources. A single server must be
configured to run the Collaboration server. This server must handle Collaboration sessions and
performance will be unaffected by other requests. The application servers are configured to
connect users to one server that handles all the Collaboration sessions.
During installation, it is possible to specify that a separate machine will handle all Collaboration
Tool communications. This requires that either an existing application server be dual-purposed, or
a dedicated server be configured to host the Collaboration server. Those institutions running
Blackboard Learn on just one or two servers, obviously would never opt to create a dedicated
Collaboration server, and instead dual-purpose the existing application server. For more
information, see Set Up a Collaboration Server for Windows in a Load-Balanced Configuration or
Set Up a Collaboration Server for UNIX in a Load-Balanced Configuration. With the exception of
that topic, all references to a Collaboration Server assume that your environment is using a single
existing application server that has been dual-purposed as the Collaboration server.
The decisions that define the host environment guide the installation process. The next step
before running the Installer is configuring the environment. The following table outlines the
configuration path to follow for each possible configuration:
Number of
Operating System and Database Servers Refer to Section
Microsoft Windows and SQL Server One Install on Windows on One or Two
Servers
Two Install on Windows on One or Two
Servers
Load-Balanced Install on Windows in a Load-Balanced
Configuration
Red Hat Enterprise Linux and Small- One Install on UNIX on One or Two Servers
Scale Oracle
Sun Solaris and Small-Scale Oracle One Install on UNIX on One or Two Servers
Red Hat Enterprise Linux and Oracle One Install on UNIX on One or Two Servers
Two Install on UNIX on One or Two Servers
Load-Balanced Install on UNIX in a Load-Balanced
Configuration
Sun Solaris and Oracle One Install on UNIX on One or Two Servers
Two Install on UNIX on One or Two Servers
Load-Balanced Install on UNIX in a Load-Balanced
Configuration
Before installing Blackboard Learn or making it available to users, it is important to define how it
will be used at the institution. Having a sound plan for how Blackboard Learn will be used helps
ensure that configuration and security decisions are aligned with the goals of the institution. Some
items to consider include:
These are just a few examples of the decisions that go into developing a learning model. Each
institution will have a unique approach appropriate for its users.
Creating a test environment is a critical step in the process. A test environment allows system
and database administrators to tune the software for maximum performance based on the needs
of the institution. Developers use the test environment to build System Extensions prior to rollout
as well as developing tools for integrating with other information systems at the institution.
Finally, a test environment helps resolve potential issues with hardware or software before rolling
out Blackboard Learn to users.
Having qualified, trained staff to support users is important to operating smoothly with little
interruptions to users. Define what level of support is required and when it should be available to
users. Some institutions may require 24/7 support while others can operate with less. After
training staff and defining support availability and expectations be sure to communicate this
information to users.
After the software is installed, configured, and tested and the support staff is trained, it is a good
idea to launch a pilot program. A pilot program lets a few users on the system to work with the
software in the context of the learning model. This is a good time to spot roadblocks or issues that
may impact users when the software is rolled out. Also, the pilot program participants (especially
the Instructors) can take a leadership role among their peers when the software is rolled out.
These users can train other users on the software and help them successfully adopt the learning
model.
Rollout
When Blackboard Learn is ready for users, it is important to communicate key information to
users. Make sure that the user base has access to training sessions, support, and other
resources to help them begin using the system.
Required Hardware
The About Hardware Sizing in a Dell Environment and About Hardware Sizing in a Sun
Microsystems Environment topics in Blackboard Learn Help detail several different hardware
configurations based on performance, cost, and redundancy. Make sure that the planned
hardware configuration meets the needs of the institution.
Required Software
For the exact versions of the operating systems, databases, and Java SE Developers Kit (JDK)
that are supported, see "Supported Technologies" in the Release Notes for the release that you
are installing. It is critical that the software used to host Blackboard Learn meets requirements.
If installing on multiple servers, download and install the JDK on each application server.
Make sure that the server or servers are dedicated to Blackboard Learn. Make sure that the
server is not using valuable space and resources running unnecessary applications.
Set JAVA_HOME
The correct version of the JDK must be installed on the application server and the JAVA_HOME
environment variable must be set. The JDK installer first installs the JDK, and then installs the
Java Runtime Environment (JRE). Ensure that these are installed to different locations and that
the JRE installer is not allowed to overwrite portions of the JDK.
WARNING! Make sure that the path to the JDK does not include any spaces. For example, do not
use C:\Program Files\Java\jdk1.6.0_18. Instead, use C:\Java\jdk1.6.0_18.
1. Make sure that the correct version of the JDK is installed on the application server.
2. Right-click Computer and select Properties.
3. Click Advanced System Properties.
4. Click Environment Variables.
5. In the system variables list, find JAVA_HOME and click Edit. If JAVA_HOME does not exist
in the system variables list, click New. A pop-up window will appear. The Variable name
should read JAVA_HOME.
6. Enter the full path to the JDK in the Variable value field. For example,
C:\Java\jdk1.6.0_18.
7. Click OK.
Note Click paths for Windows 2003 and SQL 2005 will vary slightly from the steps
presented here for Windows 2008 and SQL Server 2008.
Blackboard Learn will work only with the NTFS file system. It will not work correctly if the
Windows file system is FAT32. Follow the steps below to confirm that the disk is using the NTFS
file system.
If using Windows Server 2003, the following requirements must be met before beginning:
Install the Windows 2003 Resource Kit and the IIS 6.0 Resource Kit on each application
server.
Download the Windows Resource Kit and the IIS 6.0 Resource Kit from Microsoft at
http://download.microsoft.com.
Install the SQL Server Client Tools on each application server.
The Client Tools allow the application servers to communicate with the database. Without
the Client Tools, the Installer will fail. After installation, if the Client Tools are not available,
the application server will not be able to query the database or enter database
transactions.
There is no Windows 2008 Resource Kit software package available from Microsoft for download
at this time. The resource kit exists primarily as documentation for the Windows 2008 release.
There is no IIS 7 Resource Kit software package available from Microsoft for download at this
time. The resource kit exists primarily as documentation for the Windows 2008 release.
For more information, see Configuring Windows Server 2008 IIS 7 Roles and Features.
Create a domain user (for example, "blackboard") that will have access to the application server,
the file server, and the database server. This user must be part of the Administrators group
throughout the setup and installation. After this user is created, use it to log in to the servers.
When installing on one server, the application server, file system, and database are all run on one
machine.
When the installation is complete, you may remove the domain user from the Administrators
group as a security precaution. Remember to continue to use the domain user to run the
Blackboard services.
The SQL Server Agent must be running and set to Automatic startup for Blackboard Learn, where
instance is the name of the database instance (blank for a default instance).
Check the date and time on the system and make sure it is accurate and that the time zone is set
correctly. If installing on two servers, check that the time on the application server and database
server match. Remember that the servers may be in a different time zone than the users. The
server time zone should be the same as the time zone used by the majority of users, instead of
the physical location of the server. Blackboard Learn uses the server date and time to control the
availability of time-sensitive materials. It is important that users have a clear expectation of when
materials will be available and when assignments are due.
Windows clients connected to a Domain can check their time offset using the following command,
where domain_name is replaced with your Windows domain:
w32tm/monitor/domain:domain_name
Windows clients that are connected to a domain can force time synchronization using the
following command: w32tm/resync
Ports
Blackboard Learn requires TCP/IP ports to communicate. The following list details the required
ports and their default values. Make sure to configure server security and any firewalls to allow
communication on the required ports.
Web server port (default value: 80): This port handles communication between users and
the server.
Collaboration server TCP/IP port (default value: 8010): This port handles TCP
communication for the Collaboration server. By default, TCP communication connects
users to the Collaboration server.
Collaboration server HTTP port (default value: 8011): This port handles HTTP
communication for the Collaboration server. HTTP is a backup if TCP communication
fails.
Secure Web server HTTPS port (default value:443): This port handles SSL over HTTP
communication between the users and the server. SSL capability is usually configured
after the initial installation is complete.
WARNING! Do not use a firewall to redirect ports. The internal port configured on the server
must match the external port on the external firewall.
Network
Keep in mind the following when connecting Blackboard Learn to the network:
Do not use underscores in the machine name for the server or servers. Some versions of
Internet Explorer block cookies if the machine name includes an underscore.
Set up the DNS server to resolve server names.
Check with a network engineer to make sure that the network can handle the anticipated
load after Blackboard Learn is made available to users.
An SMTP server is available so that the Installer can connect to it.
An SMTP server has to remain available when the application is running in order to
deliver email notifications.
Database
Keep in mind the following when installing and configuring Microsoft SQL Server:
Install SQL Server at the drive level. For example, C:\SQL Server.
Use Mixed Mode Security Authentication.
Make sure SQL Server is installed using a local account.
Blackboard recommends using the default instance name. If the default instance name is
not used, the instance name must not include any underscores, spaces, or punctuation.
Use only alphanumeric characters.
If an instance other than the default is used, make sure that the instance is not case
sensitive.
The SQL Server Client Tools must be installed on the application server. This is not
necessary if Blackboard Learn is installed on just one server.
Blackboard Learn supports SQL Server failover. For more information, see Set Up
Database Clustering and Storage.
Windows Server 2008 uses IIS 7. Before installation of Blackboard Learn 9.1, IIS 7 needs to be
configured with specific Role Services and other settings.
If you manually backed up the applicationHost.config file, restoring this manual backup
and restarting IIS 7 will not fix errors generated by manually editing this file to configure IIS 7.
By default, IIS 7 will check every two minutes for changes to the configuration files and will
automatically create backups of them, maintaining a history of ten backups. Use the oldest of
these backups to restore IIS 7 to a working state.
%windir%\system32\inetsrv\appcmd.exe list
backup%windir%\system32\inetsrv\appcmd.exe restore backup
"CFGHISTORY_0000000021"
Once the configuration has been restored and verified through web browser access, then use the
appcmd utility to configure the necessary features of IIS 7 as described in the section above.
If this approach does not solve the problem with IIS 7 generating errors, remove and then reinstall
the IIS 7 Role.
If you need to reinstall the IIS 7 Role, you can use the
%BLACKBOARD%\tools\admin\WebsiteReinstall.bat command to re-establish the
Blackboard Web site within IIS.
1. Install the IIS 7 Role in Windows Server 2008 Server Manager and configure Role
Services:
a. Click Start, select Administrative Tools, and then select Server Manager.
b. Click Roles, and under the Roles Summary heading, click Add Roles.
c. From the list of displayed roles, select Web Server (IIS).
d. Click Next.
At a minimum, the following five (5) role services must be installed in addition to the
default role services:
Role Services > Web Server > Application Development > ISAPI Extensions
Role Services > Web Server > Application Development > ISAPI Filters
Role Services > Management Tools > IIS 6 Management Compatibility > IIS 6
Metabase Compatibility
Role Services > Management Tools > IIS 6 Management Compatibility > IIS 6 WMI
Compatibility
Role Services > Management Tools > IIS 6 Management Compatibility > IIS 6
Scripting Tools
Of the role services listed in this step, the following are will be of the most interest:
Role Services > Common HTTP Features > HTTP Redirection (to allow for HTTP
redirection, in the event that the site is renamed)
Role Services > Security > Windows Authentication (to allow for Active Directory
integrated authentication)
Role Services > Security > IP and Domain Restrictions (to allow for greater control of
web server access)
Role Services > Performance > Dynamic Content Compression (to allow for
enhanced performance)
e. Select Windows Process Activation Service (.NET Environment), and then
click Add Required Role services.
2. Disable the Default Web Site:
a. Click Start, select Administrative Tools, and then select Server Manager.
b. From the left menu, click the plus sign next to Roles to expand the tree.
c. Click the plus sign next to Web Server IIS, and then click Internet
Information Services (IIS) Manager.
d. Under the Connections heading, click the plus sign next to the
%HOSTNAME%, and then click the plus sign next to Sites.
e. Right-click Default Web Site and from the drop-down menu select Manage
Web Site, and then select Stop.
3. Back up the current IIS 7 configuration and verify.
%windir%\system32\inetsrv\appcmd.exe
add backup "Blackboard Pre-Change"
%windir%\system32\inetsrv\appcmd.exe list backup
4. Modify the IIS 7 configuration to permit double escaping within URLs (applies to all sites).
%windir%\system32\inetsrv\appcmd set config
/section:system.webServer/Security/requestFiltering -
allowDoubleEscaping:True
5. Modify the IIS 7 configuration to allow upload files greater than 20MB in size, specified in
bytes (applies to all sites).
%windir%\system32\inetsrv\appcmd set config -
section:requestFiltering -
requestLimits.maxAllowedContentLength:104857600
6. Back up the current IIS 7 configuration and verify.
%windir%\system32\inetsrv\appcmd.exe
add backup "Blackboard Post-Change Backup"
%windir%\system32\inetsrv\appcmd.exe list backup
7. Restart the IIS service.
a. Click Start, select Administrative Tools, and then select Server Manager.
b. From the left menu, click the plus sign next to Configuration and then click
Services.
c. From the list of services, right-click World Wide Web Publishing Service and
select Restart.
Blackboard Learn can be run using database clustering for redundancy. Database clustering
instantly transfers database requests to an identical server if the database server fails.
Blackboard Learn is designed to work with Microsoft SQL Server Failover clusters. SQL Server
Failover provides added fault tolerance to the database by using another database in the cluster
in the case of an error that causes the production database to fail.
A SQL Server Failover cluster is based on the same design as a Windows cluster. A group of
servers are joined to provide continual service in the event of an outage or failure.
When SQL Server is forced to shut down, another server steps in to handle requests.
The process for setting up a Microsoft SQL Server failover cluster is done at the operating system
and database level before installing Blackboard Learn.
Use four public IP addresses: node 1, node 2, Windows cluster server, and virtual SQL
server.
The local disk of each node must be attached to a separate SCSI controller. It should not
use the same one that is attached to the RAID system.
The RAID SCSI controller IDs of the two nodes must be different.
RAID SCSI BIOS must be set up to enable cluster (shared bus).
The names of the network cards cannot contain spaces or special characters.
Do not use the default instance name for installing SQL server on a virtual server.
MSDTC service must be running before starting SQL server setup.
For more information about installing and configuring a Microsoft SQL Server failover cluster, see
Microsoft TechNet at http://www.microsoft.com/technet/. While Blackboard supports SQL Server
failover with Blackboard Learn, Microsoft is the best resource for information about installing and
configuring a Microsoft SQL Server failover cluster.
Setting Up a Separate Storage Device for the Data Files and Log Files
The Installer will prompt for the directory where the database data files and log files should be
stored. Consult the Microsoft SQL Server documentation for information about storing these files
on a separate device. Keep in mind that the storage device should have a dedicated, high-
bandwidth connection to the database server.
Note Blackboard Learn - Basic Edition clients must use the local default location of
c:\blackboard\content.
All of the content files for Blackboard Learn, such as files uploaded to Courses and image files,
are stored by default in the blackboard\content directory. If the content management
capabilities have been licensed, the Content Collection has several content directories, each one
dedicated to one of the top-level directories. For example, the \library directory stores all the
files for the Library.
In a load-balanced configuration, this location must be accessible by all of the application servers.
The location can be a share on one of the application servers or on the database server, or it can
be a SAN (storage area network) or NAS (network-attached storage) on a separate file server.
These instructions detail how to set up the blackboard\content directory on a separate file
server. The same methods can be repeated to set up the content management directories on a
separate file server. The use of a separate storage device requires additional configuration of the
Blackboard services to allow them to run under the permission of a domain user.
1. Log in to the file server as a domain user (for example, domain\blackboard) with
administrative privileges. This is the user that runs the Web/application server. That is,
this must be the user that logs in to the application server and owns control of the
Blackboard services. In this example, the domain user is "blackboard."
2. Create a directory to store Blackboard Learn content files. For example,
C:\bb_content.
3. Right-click on the bb_content directory and select Properties.
4. From the Sharing tab, click Advanced Sharing.
5. Select Share this folder.
6. Click Permissions. The Permissions for bb_content window displays.
7. Set Permissions so that the Administrators and the domain user who will be running the
Blackboard services, such as "blackboard," have full control. No other users should have
access to this directory.
8. After setting permissions, click the Security tab, and then click Edit.
9. Set Security so that the Administrators and the domain user who will be running the
Blackboard services, such as "blackboard," have full control. No other users should have
access to this directory.
10. Click OK.
11. When prompted by the Installer for the location of the blackboard\content directory,
type \\FILESERVER\bb_content.
12. If the content management capabilities will be installed, the Installer will prompt for the
location of the individual Content Collection directories. When prompted, type the path to
\\FILESERVER\bb_content\storage followed by a subdirectory name for each
individual content management directory. For example, the \users directory should be
stored in \\FILESEVER\bb_content\storage\users. Alternatively, the Content
Collection files can be stored on a separate, dedicated, share directory.
If Blackboard Learn will only be installed on one server, that machine must pass the checklist for
both the application server and the database server.
Blackboard Basics
Review the following list to make sure that Blackboard has provided everything necessary to
begin installation.
A valid Blackboard Learn license file is accessible from the application servers. To receive
a license file, contact your Blackboard Client Representative.
The Installer has been downloaded to the application servers. To receive instructions for
downloading the Installer, contact your Blackboard Client Representative.
The Administrator has contact information for Blackboard Client Support and a login for
Behind the Blackboard at https://behind.blackboard.com.
Review the following list to make sure that the application server is prepared for installation.
the displayed availability of time-sensitive content and the actual availability of time-
sensitive content.
The Windows file system is set to NTFS. Blackboard Learn will not work with a FAT32 file
system.
The Installer can connect to the SMTP server.
Review the following list to make sure that the database server is prepared for installation.
Remember that if Blackboard Learn will only be installed on one server, the database server and
application server are configured on one machine.
Setup Type: Select the Full Installation option to install Blackboard Learn on one or two servers.
This option is also used when installing Blackboard Learn on the database and first application
server in a Load-Balanced configuration.
Note Blackboard Learn - Basic Edition clients must use the local default location.
For more information about the integration account, see the Editing the Integration Password
topic in Blackboard Learn Help.
The root_admin account is created even if your license does not include the use of additional
Virtual Installations. The root_admin account can be modified from the Edit Root Administrator
Profile page.
K-12
Higher Education
Continuing Education
Corporate
Professional Association
Hobby
City: ___________________________________________
The state, province, or territory where the institution is located.
State: ___________________________________________
The state, province, or territory where the institution is located.
Country: ___________________________________________
The Country where the institution is located.
To request a current license file for this release and your institution and instructions for
downloading the Installer, contact your Blackboard Client Representative.
Make sure that the system meets the supported software requirements and is properly configured
before running the Installer. To confirm that the system is ready for installation, see the Pre-
Installation Checklist.
1. Place both the Installer and the license file in a directory on the application server. The
Installer will automatically recognize the license file as long as it is named bb-
license.xml and placed in the same directory as the Installer. The following steps use
C:\bb_installer as an example.
2. Double-click the Installer. Alternatively, open a command line prompt and navigate to the
directory that contains the Installer.
3. Run the following command to launch the Installer graphical interface:
C:\bb_installer>java jar installer_file
To launch the Installer command line interface, run the following command:
C:\bb_installer>java jar installer_file -text
Remember that the rest of these steps assume that the graphical interface is being used.
23. After completing all of the fields on the page, click Next. The next page asks where to
store the database data files and the database log files.
24. Provide the location where the database data files (.mdf) will be stored. This directory
must be on the database server or on a storage device with a dedicated, high-bandwidth
connection to the database server. On a single server installation, the default value is
C:\blackboard\mssql\data\. Click Next to accept the default or click Browse to
provide a new value and then click Next.
25. Provide the location where the database log files (.ldf) will be stored. This directory must
be on the database server or on a storage device with a dedicated, high-bandwidth
connection to the database server. On a single server installation, the default value is
C:\blackboard\mssql\data\. Click Next to accept the default or click Browse to
provide a new value and then click Next.
26. After completing all of the fields on the page, click Next.
27. Optional step for Content Collection Users: Provide the storage directories for content
management:
/courses - The default value is blackboard_directory\storage\courses.
/institution - The default value is
blackboard_directory\storage\institution.
/library - The default value is blackboard_directory\storage\library.
/orgs - The default value is blackboard_directory\storage\orgs.
/users - The default value is blackboard_directory\storage\users.
28. After completing all of the fields on the page, click Next.
29. Provide the Collaboration server hostname. In a one or two server environment, the
default value is the application server. In a load-balanced environment, select one of the
existing application servers to also act as the Collaboration server. Though not typically
required, a separate server may be dedicated as the Collaboration server exclusively. For
more information, see Set Up a Collaboration Server. The Collaboration server runs
Virtual Classroom and chat sessions.
30. Provide the TCP port number for the Collaboration server. The Collaboration server uses
TCP/IP as the preferred communication method for performance reasons. The default
port number is 8010.
31. Provide the HTTP port number for the Collaboration server. The Collaboration server uses
HTTP as a backup method of communication if TCP/IP is not available. The default port
number is 8011.
32. After completing all of the fields on the page, click Next.
33. Provide the location of the SMTP server and click Next. The SMTP server is used to send
out email communications. Enter the hostname as machine_name.domain_name.
34. Provide the Blackboard Learn Administrator password. The Administrator account has full
privileges.
35. Provide the Blackboard Integration password. The integration user is used only to
facilitate Snapshot operations. This account cannot be used to log in through the GUI nor
does it appear in any lists of users in the user interface. To change the password for this
account, on the Administrator Panel, under Building Blocks, click Integration
Password.
36. Provide the Blackboard root administrator password. The root_admin account has full
administrative privileges including the management of Virtual Installations through the
Administrator Panel. When the root_admin account user views the Administrator Panel,
the Manage Virtual Installations link appears at the top of the panel. The root_admin
can log in to any Virtual Installation and access the Virtual Installation management
features from this link. While it is necessary to enter a password for this account, it is very
rare that a system with Virtual Installations will be run on one server or two servers.
37. After completing all of the fields on the page, click Next.
38. Provide the following information about the administrator and the institution:
Name and email address of the system administrator
Name of Institution
Type of Institution - The value must be one of the following: K-12, Higher
Education, Continuing Education, Corporate, Professional Association, or
Hobby
City, State, Country, and ZIP Code of the institution's address
39. After completing all of the fields on the page, click Next.
40. Select the Server Type. This is information is used for better management of centralized
services. Options include: Production, Staging, Test, and Development. Properly
categorize each server when running the installer.
41. Click Next.
42. Click Next again to install the software. If the Installer was launched from the command
line, do not close the command line window or any of the other windows that pop-up
during the installation.
If the Installer failed, check the Installer log and see Troubleshooting to diagnose and fix the
problem.
Next Steps
Make sure to remove the domain user from the Administrators group on each server. This is a
security step recommended by Microsoft that prevents the domain user, which is used to run
services, from acting as an Administrator.
If a separate storage device has been configured with a UNC path (\\server\share),make
sure configure the services with proper permissions.
Make sure that the hardware, software, and network are prepared before beginning to configure
and install Blackboard Learn in a load-balanced environment.
Required Hardware
The About Hardware Sizing in a Dell Environment and About Hardware Sizing in a Sun
Microsystems Environment topics in Blackboard Learn Help detail several different hardware
configurations based on performance, cost, and redundancy. Make sure that the planned
hardware configuration meets the needs of the institution.
Required Software
For the exact versions of the operating systems, databases, and Java SE Developers Kit (JDK)
that are supported, see "Supported Technologies" in the Release Notes for the release that you
are installing. It is critical that the software used to host Blackboard Learn meets requirements.
Make sure that the server or servers are dedicated to Blackboard Learn. Make sure that the
server is not using valuable space and resources running unnecessary applications.
Collaboration Server
Select one of the existing application servers to also act as the Collaboration server. Alternatively,
a separate server may be dedicated as the Collaboration server. For more information, see Set
Up a Collaboration Server. The Collaboration server may not be spread across multiple
application servers because all users participating in a Collaboration session must share the
same resources. A single server must be configured to run the Collaboration server. This server
must handle Collaboration sessions and performance will be unaffected by other requests. The
application servers are configured to connect users to one server that handles all the
Collaboration sessions.
Set aside one server as a dedicated file system server. The content files must be centralized so
that all files are available to users regardless of the application server handling the connection.
The application servers are configured to find the content files in a directory on the file system
server.
Set JAVA_HOME
The correct version of the JDK must be installed on the application server and the JAVA_HOME
environment variable must be set. The JDK installer first installs the JDK, then the Java Runtime
Environment (JRE). Ensure that these are installed to different locations and the JRE installer is
not allowed to overwrite portions of the JDK.
WARNING! Make sure that the path to the JDK does not include any spaces. For example,
do not use C:\Program Files\Java\jdk1.6.0_18. Instead, use C:\Java\jdk1.6.0_18.
1. Make sure that the correct version of the JDK is installed on the application server.
2. Right-click Computer and select Properties.
3. Click Advanced System Properties.
4. Click Environment Variables.
5. In the system variables list, find JAVA_HOME and click Edit. If JAVA_HOME does not exist
in the system variables list, click New. A pop-up window will appear. The Variable name
should read JAVA_HOME.
6. Enter the full path to the JDK in the Variable value field. For example,
C:\Java\jdk1.6.0_18.
7. Click OK.
Note Click paths for Windows 2003 and SQL 2005 will vary slightly from the steps presented
here for Windows 2008 and SQL Server 2008.
Blackboard Learn will work only with the NTFS file system. It will not work correctly if the
Windows file system is FAT32. Follow the steps below to confirm that the disk is using the NTFS
file system.
1. Double-click My Computer.
2. Right-click on the disk where Blackboard Learn will be installed.
3. Select Properties.
4. The File System field should show NTFS. If it shows FAT32, consult the operating system
documentation for instructions on converting the disk to a NTFS file system.
5. Repeat these steps on each application server, the database server, and the file system
server.
If using Windows Server 2003, the following requirements must be met before beginning:
Install the Windows 2003 Resource Kit and the IIS 6.0 Resource Kit on each application
server.
Download the Windows Resource Kit and the IIS 6.0 Resource Kit from Microsoft at
http://download.microsoft.com.
There is no Windows 2008 Resource Kit software package available from Microsoft for download
at this time. The resource kit exists primarily as documentation for the Windows 2008 release.
There is no IIS 7 Resource Kit software package available from Microsoft for download at this
time. The resource kit exists primarily as documentation for the Windows 2008 release.
For more information, see Configuring Windows Server 2008 IIS 7 Roles and Features.
Create a domain user (for example, blackboard) that will have access to the application servers,
the file server, and the database server. This user must be part of the Administrators group
throughout the setup and installation. After this user is created, use it to log in to the servers.
The domain user created in the steps above must be added to the IIS_IUSRS Group, where
domain_name is replaced with your Windows domain:
w32tm/monitor/domain:domain_name. If this association is not created, the website will not
display.
The domain user created in the steps above must be added to IIS security. Follow these steps to
configure IIS on each application server.
1. Log in as the domain user (for example, domain\blackboard) on the first application
server.
2. Right-click Computer and select Manage.
3. From the Server Manager, click Roles, click Web Server (IIS) and then click Internet
Information Services (IIS) Manager.
4. Stop the Default Web Site by expanding Sites, right-clicking on Default Web Site,
selecting Manage Web Site, and then selecting Stop.
5. Configure Directory Security by clicking the Features View button at the bottom of the
page and then double-clicking Authentication.
6. Right-click on Anonymous Authentication and select Edit. IUSR should appear in the
specific user field.
7. Configure the Application Pool by clicking Application Pools.
8. Right-click DefaultAppPool and select Advanced Settings.
9. Under the Process Model heading, in the Identity /NetworkService cell, click the ...
(ellipses) button.
10. Select Custom account and then click Set.
11. Enter the domain user name and password and then click OK.
12. Restart IIS so that the changes will take effect.
13. Repeat these steps for each application server.
The SQL Server Agent must be running and set to Automatic startup for Blackboard Learn where
%INSTANCE% is the name of the database instance (blank for a default instance).
Check the date and time on the system and make sure it is accurate and that the time zone is set
correctly. Check that the time on the application server and database server match. Remember
that the servers may be in a different time zone than users. Blackboard Learn uses the server
date and time to control the availability of time-sensitive materials. It is important that users have
a clear expectation of when materials will be available and when assignments are due.
Windows clients connected to a Domain can check their time offset using the following command
where domain_name is replaced with your Windows domain:
w32tm/monitor/domain:domain_name
Windows clients that are connected to a domain can force time synchronization using the
following command: w32tm/resync
Ports
Blackboard Learn requires ports to communicate. The list below details the required ports and
their default values. Make sure to configure server security and any firewalls to allow
communication on the required ports. All application servers must use the same port settings.
Web server port (default value: 80): This port handles communication between users and
the server.
Collaboration server TCP/IP port (default value: 8010): This port handles TCP
communication for the Collaboration server. By default, TCP communication connects
users to the Collaboration server.
Collaboration server HTTP port (default value: 8011): This port handles HTTP
communication for the Collaboration server. HTTP is a backup if TCP communication
fails.
Secure Web server HTTPS port (default value:443): This port handles SSL over HTTP
communication between the users and the server. SSL capability is usually configured
after the initial installation is complete.
WARNING! Do not use a firewall to redirect ports. The internal port configured on the server
must match the external port on the external firewall.
Network
Keep in mind the following when connecting Blackboard Learn to the network:
Do not use underscores in the machine name for the server or servers.
Set up the DNS server to resolve the hardware load-balancer. The hardware load-
balancer will then direct traffic to the application servers. Set up a separate DNS entry for
the dedicated Collaboration server.
Check with a network engineer to make sure that the network can handle the anticipated
load after Blackboard Learn is made available to users.
An SMTP server is available so that the Installer can connect to it.
An SMTP server has to remain available when the application is running in order to
deliver email notifications.
Database
Keep in mind the following when installing and configuring Microsoft SQL Server:
Install SQL Server at the drive level, for example, C:\SQL Server.
Use Mixed Mode Security Authentication.
Make sure SQL Server is installed using a local account.
Blackboard recommends using the default instance name. If the default instance name is
not used, the instance name must not include any underscores, spaces, or punctuation.
Use only alphanumeric characters.
If an instance other than the default is used, make sure that the instance is not case
sensitive.
The default password for the 'sa' account is a blank value.
The SQL Server Client Tools must be installed on each application server.
Blackboard Learn supports SQL Server failover. For more information, see Set Up
Database Clustering and Separate Storage.
Windows Server 2008 uses IIS 7. Before installation of Blackboard Learn 9.1, IIS 7 needs to be
configured with specific Role Services and other settings.
If you manually backed up the applicationHost.config file, restoring this manual backup
and restarting IIS 7 will not fix errors generated by manually editing this file to configure IIS 7.
By default, IIS 7 will check every two minutes for changes to the configuration files and will
automatically create backups of them, maintaining a history of ten backups. Use the oldest of
these backups to restore IIS 7 to a working state.
%windir%\system32\inetsrv\appcmd.exe list
backup%windir%\system32\inetsrv\appcmd.exe restore backup
"CFGHISTORY_0000000021"
Once the configuration has been restored and verified through web browser access, then use the
appcmd utility to configure the necessary features of IIS 7 as described in the section above.
If this approach does not solve the problem with IIS 7 generating errors, remove and then reinstall
the IIS 7 Role.
If you need to reinstall the IIS 7 Role, you can use the
%BLACKBOARD%\tools\admin\WebsiteReinstall.bat command to re-establish the
Blackboard Web site within IIS.
1. Install the IIS 7 Role in Windows Server 2008 Server Manager and configure Role
Services:
a. Click Start, select Administrative Tools, and then select Server Manager.
b. Click Roles, and under the Roles Summary heading, click Add Roles.
c. From the list of displayed roles, select Web Server (IIS).
d. Click Next.
At a minimum, the following five (5) role services must be installed in addition to the
default role services:
Role Services > Web Server > Application Development > ISAPI Extensions
Role Services > Web Server > Application Development > ISAPI Filters
Role Services > Management Tools > IIS 6 Management Compatibility > IIS 6
Metabase Compatibility
Role Services > Management Tools > IIS 6 Management Compatibility > IIS 6 WMI
Compatibility
Role Services > Management Tools > IIS 6 Management Compatibility > IIS 6
Scripting Tools
Of the role services listed in this step, the following are will be of the most interest:
Role Services > Common HTTP Features > HTTP Redirection (to allow for HTTP
redirection, in the event that the site is renamed)
Role Services > Security > Windows Authentication (to allow for Active Directory
integrated authentication)
Role Services > Security > IP and Domain Restrictions (to allow for greater control of
web server access)
Role Services > Performance > Dynamic Content Compression (to allow for
enhanced performance)
e. Select Windows Process Activation Service (.NET Environment), and then
click Add Required Role services.
2. Disable the Default Web Site:
a. Click Start, select Administrative Tools, and then select Server Manager.
b. From the left menu, click the plus sign next to Roles to expand the tree.
c. Click the plus sign next to Web Server IIS, and then click Internet
Information Services (IIS) Manager.
d. Under the Connections heading, click the plus sign next to the
%HOSTNAME%, and then click the plus sign next to Sites.
e. Right-click Default Web Site and from the drop-down menu select Manage
Web Site, and then select Stop.
3. Back up the current IIS 7 configuration and verify.
%windir%\system32\inetsrv\appcmd.exe add backup "Blackboard Pre-Change"
%windir%\system32\inetsrv\appcmd.exe list backup
4. Modify the IIS 7 configuration to permit double escaping within URLs (applies to all sites).
%windir%\system32\inetsrv\appcmd set config
/section:system.webServer/Security/requestFiltering -
allowDoubleEscaping:True
5. Modify the IIS 7 configuration to allow upload files greater than 20MB in size, specified in
bytes (applies to all sites).
%windir%\system32\inetsrv\appcmd set config -
section:requestFiltering -
requestLimits.maxAllowedContentLength:104857600
6. Back up the current IIS 7 configuration and verify.
%windir%\system32\inetsrv\appcmd.exe add backup "Blackboard Post-
Change Backup"
%windir%\system32\inetsrv\appcmd.exe list backup
7. Restart the IIS service.
a. Click Start, select Administrative Tools, and then select Server Manager.
b. From the left menu, click the plus sign next to Configuration and then click
Services.
c. From the list of services, right-click World Wide Web Publishing Service and
select Restart.
Blackboard Learn can be run using database clustering for redundancy. Database clustering
instantly transfers database requests to an identical server if the database server fails.
Blackboard Learn is designed to work with Microsoft SQL Server Failover clusters. SQL Server
Failover provides added fault tolerance to the database by using another database in the cluster
in the case of an error that causes the production database to fail.
A SQL Server Failover cluster is based on the same design as a Windows cluster. A group of
servers are joined to provide continual service in the event of an outage or failure.
When SQL Server is forced to shut down, another server steps in to handle requests.
The process for setting up a Microsoft SQL Server failover cluster is done at the operating system
and database level before installing Blackboard Learn.
Use four public IP addresses: node 1, node 2, Windows cluster server, and virtual SQL
server.
The local disk of each node must be attached to a separate SCSI controller. It should not
use the same one that is attached to the RAID system.
The RAID SCSI controller IDs of the two nodes must be different.
RAID SCSI BIOS must be set up to enable cluster (shared bus).
The names of the network cards cannot contain spaces or special characters.
Do not use the default instance name for installing SQL server on a virtual server.
MSDTC service must be running before starting SQL server setup.
For more information about installing and configuring a Microsoft SQL Server failover cluster, see
Microsoft TechNet at http://www.microsoft.com/technet/. While Blackboard supports SQL Server
failover with Blackboard Learn, Microsoft is the best resource for information about installing and
configuring a Microsoft SQL Server failover cluster.
Setting Up a Separate Storage Device for the Data Files and Log Files
The Installer will prompt for the directory where the database data files and log files should be
stored. Consult the Microsoft SQL Server documentation for information about storing these files
on a separate device. Keep in mind that the storage device should have a dedicated, high-
bandwidth connection to the database server.
Note Blackboard Learn - Basic Edition clients must use the local default location of
c:\blackboard\content.
All of the content files for Blackboard Learn, such as files uploaded to Courses and image files,
are stored by default in the blackboard\content directory. If the content management
capabilities have been licensed, the Content Collection has several content directories, each one
dedicated to one of the top-level directories. For example, the \library directory stores all the
files for the Library.
In a load-balanced configuration, this location must be accessible by all of the application servers.
The location can be a share on one of the application servers or on the database server, or it can
be a SAN (storage area network) or NAS (network-attached storage) on a separate file server.
These instructions detail how to set up the blackboard\content directory on a separate file
server. The same methods can be repeated to set up the content management directories on a
separate file server. The use of a separate storage device requires additional configuration of the
Blackboard services to allow them to run under the permission of a domain user.
1. Log in to the file server as a domain user (for example, domain\blackboard) with
administrative privileges. This is the user that runs the Web/application server. That is,
this must be the user that logs in to the application server and owns control of the
Blackboard services. In this example, the domain user is "blackboard."
2. Create a directory to store Blackboard Learn content files. For example,
C:\bb_content.
3. Right-click on the bb_content directory and select Properties.
4. From the Sharing tab, click Advanced Sharing.
5. Select Share this folder.
6. Click Permissions. The Permissions for bb_content window displays.
7. Set Permissions so that the Administrators and the domain user who will be running the
Blackboard services, such as "blackboard," have full control. No other users should have
access to this directory.
8. After setting permissions, click the Security tab, and then click Edit.
9. Set Security so that the Administrators and the domain user who will be running the
Blackboard services, such as "blackboard," have full control. No other users should have
access to this directory.
10. Click OK.
11. When prompted by the Installer for the location of the blackboard\content directory,
type \\FILESERVER\bb_content.
12. If the content management capabilities will be installed, the Installer will prompt for the
location of the individual Content Collection directories. When prompted, type the path to
\\FILESERVER\bb_content\storage followed by a subdirectory name for each
individual content management directory. For example, the \users directory should be
stored in \\FILESEVER\bb_content\storage\users. Alternatively, the Content
Collection files can be stored on a separate, dedicated, share directory.
Blackboard Basics
Review the following list to make sure that Blackboard has provided everything necessary to
begin installation.
A valid Blackboard Learn license file is accessible from the application servers. To receive
a license file, contact your Blackboard Client Representative.
The Installer has been downloaded to the application servers. To receive instructions for
downloading the Installer, contact your Blackboard Client Representative.
The Administrator has contact information for Blackboard Technical Support and a login
for Behind the Blackboard at https://behind.blackboard.com.
Review the following list to make sure that each application server is prepared for installation.
The server clock is synchronized with the other servers used in Blackboard Learn
configuration. If the server clocks are not synchronized, there may be differences between
the displayed availability of time-sensitive content and the actual availability of time-
sensitive content.
The Windows file system is set to NTFS. Blackboard Learn will not work with a FAT32 file
system.
The Installer can connect to the SMTP server.
If using a clustered Tomcat environment, the Server Groups and Ports have been
configured. This is especially important when upgrading an existing clustered Tomcat
environment.
Review the following list to make sure that the database server is prepared for installation:
If file system storage will be set up on a separate storage device, review the following list to make
sure that the file system server is prepared for installation.
The Administrator has a plan for backing up the application file system.
A directory to store the Blackboard content is configured and shared. Another directory for
content management content (available only if the content management capabilities have
been licensed) is configured and shared, if desired.
The domain user that will run the application services has full access to the shared
directories.
If the Collaboration server will be set up on a Separate Device, make sure that the Collaboration
server uses a different DNS name than that of the application servers.
Note Most of the values asked for by the Installer must be the same for each application server
and the Collaboration server. All ports and settings that point to the database server,
Collaboration server, and file system server must be the same for all.
Full Installation: Select this option to install the database and the first application server.
Appserver-only Installation Select this option when installing the second and all
subsequent application servers or when setting up the Collaboration server on a separate
device.
Note Blackboard Learn - Basic Edition clients must use the local default location.
3. The full computer name and the domain name both appear. The full computer name is the
application server Machine Name with the domain name appended
(webservermachinename.domain).
The port that the Web server will use for http connections with clients. The default value is 80.
For more information about the integration account, see the Editing the Integration Password
topic in Blackboard Learn Help.
The root_admin account is created even if your license does not include the use of additional
Virtual Installations. The root_admin account can be modified from the Edit Root Administrator
Profile page.
K-12
Higher Education
Continuing Education
Corporate
Professional Association
Hobby
City: ___________________________________________
The state, province, or territory where the institution is located.
State: ___________________________________________
The state, province, or territory where the institution is located.
Country: ___________________________________________
The Country where the institution is located.
To request a current license file for this release and your institution and instructions for
downloading the Installer, contact your Blackboard Client Representative.
Make sure that the system meets the supported software requirements and is properly configured
before running the Installer. To confirm that the system is ready for installation, see the Pre-
Installation Checklist.
1. Place both the Installer and the license file in a directory on the application server. The
Installer will automatically recognize the license file as long as it is named bb-
license.xml and placed in the same directory as the Installer. The following steps use
C:\bb_installer as an example.
2. Double-click the Installer. Alternatively, open a command line prompt and navigate to the
directory that contains the Installer.
3. Run the following command to launch the Installer graphical interface:
C:\bb_installer>java jar installer_file
To launch the Installer command line interface, run the following command:
C:\bb_installer>java jar installer_file -text
Remember that the rest of these steps assume that the graphical interface is being used.
23. After completing all of the fields on the page, click Next. The next page asks where to
store the database data files and the database log files.
24. Provide the location where the database data files (.mdf) will be stored. This directory
must be on the database server or on a storage device with a dedicated, high-bandwidth
connection to the database server. On a single server installation, the default value is
C:\blackboard\mssql\data\. Click Next to accept the default or click Browse to
provide a new value and then click Next.
25. Provide the location where the database log files (.ldf) will be stored. This directory
must be on the database server or on a storage device with a dedicated, high-bandwidth
connection to the database server. On a single server installation, the default value is
C:\blackboard\mssql\data\. Click Next to accept the default or click Browse to provide a
new value and then click Next.
26. After completing all of the fields on the page, click Next.
27. Optional step for Content Collection Users: Provide the storage directories for content
management:
/courses - The default value is blackboard_directory\storage\courses.
/institution - The default value is
blackboard_directory\storage\institution.
/library - The default value is blackboard_directory\storage\library.
/orgs - The default value is blackboard_directory\storage\orgs.
/users - The default value is blackboard_directory\storage\users.
28. After completing all of the fields on the page, click Next.
29. Provide the Collaboration server hostname. In a one or two server environment, the
default value is the application server. In a load-balanced environment, select one of the
existing application servers to also act as the Collaboration server. Though not typically
required, a separate server may be dedicated as the Collaboration server exclusively. For
more information, see Set Up a Collaboration Server. The Collaboration server runs
Virtual Classroom and chat sessions.
30. Provide the TCP port number for the Collaboration server. The Collaboration server uses
TCP/IP as the preferred communication method for performance reasons. The default
port number is 8010.
31. Provide the HTTP port number for the Collaboration server. The Collaboration server uses
HTTP as a backup method of communication if TCP/IP is not available. The default port
number is 8011.
32. After completing all of the fields on the page, click Next.
33. Provide the location of the SMTP server and click Next. The SMTP server is used to send
out email communications. Enter the hostname as machine_name.domain_name.
34. Provide the Blackboard Learn Administrator password. The Administrator account has full
privileges.
35. Provide the Blackboard Integration password. The integration user is used only to
facilitate Snapshot operations. This account cannot be used to log in through the GUI nor
does it appear in any lists of users in the user interface. To change the password for this
account, on the Administrator Panel, under Building Blocks, click Integration
Password.
36. Provide the Blackboard root administrator password.The root_admin account has full
administrative privileges including the management of Virtual Installations through the
Administrator Panel. When the root_admin account user views the Administrator Panel,
the Manage Virtual Installations link appears at the top of the panel. The root_admin can
log in to any Virtual Installation and access the Virtual Installation management features
from this link. While it is necessary to enter a password for this account, it is very rare that
a system with Virtual Installations will be run on one server or two servers.
37. After completing all of the fields on the page, click Next.
38. Provide the following information about the administrator and the institution:
Name and email address of the system administrator
Name of Institution
Type of Institution - The value must be one of the following: K-12, Higher
Education, Continuing Education, Corporate, Professional Association, or
Hobby
City, State, Country, and ZIP Code of the institution's address
39. After completing all of the fields on the page, click Next.
40. Select the Server Type. This is information is used for better management of centralized
services. Options include: Production, Staging, Test, and Development. Properly
categorize each server when running the installer.
41. Click Next.
42. Click Next again to install the software. If the Installer was launched from the command
line, do not close the command line window or any of the other windows that pop-up
during the installation.
If the Installer failed, check the Installer log and see Troubleshooting to diagnose and fix the
problem.
Next Steps
Make sure to remove the domain user from the Administrators group on each server. This is a
security step recommended by Microsoft that prevents the domain user, which is used to run
services, from acting as an Administrator.
If a separate storage device has been configured with a UNC path (\\server\share),make
sure configure the services with proper permissions.
The Installer will prompt for the same information as a Full Installation. Instead of creating the
database, however, the Installer will attempt to connect to the database.
When executing the Installer on the additional application servers, pay close attention to the
values of the ports and host names. Be sure that the hostname for the Web server matches the
load-balanced URL and is not set to the name of the individual server. Be sure that the
Collaboration tool (virtual chat, virtual classroom) ports are set properly. Remember that the
following settings must be the same across all application servers (and the Collaboration server):
When the installation is complete, each application server can be accessed individually and
tested separately. Complete tests should also be run from the load-balanced URL.
Customers can achieve similar performance in a virtual environment on the same physical server
with multiple virtual instances as with a bare metal configuration with many Tomcat cluster
instances. The difference in configurations is a smaller demand on the Apache or IIS web server
fronting the Tomcat instance(s). The option to deploy a 64-bit JVM with larger heap sizes has
suppressed the need for customers to run in a cluster option.
Blackboard recommends that customers consider a deployment approach consisting of larger 64-
bit JVMs that are distributed across physical servers with the option to virtualize the hardware to
take advantage of the CPU and Memory capacity of these systems.
However, new installations can optionally be configured to use a clustered Tomcat environment.
Existing clustered Tomcat environments performing an upgrade must use the following steps.
1. Go to blackboard_home\config.
2. Open the bb-config.properties file.
3. Search for the bbconfig.tomcat.cluster.enable variable.
4. Change the default value from FALSE to TRUE.
5. Go to blackboard_home\tools\admin.
6. Launch the Push Config Updates script by running the PushConfigUpdates.bat file.
7. Create a new ServerGroup in Blackboard Learn
a. Go to blackboard_home\tools\admin.
b. Create a ServerGroup with a specified port number by running the following
command:
ServerGroupManager.bat -c -n new_group_name -p new_port_number
8. Launch the Install Cluster script by running the InstallCluster.bat file. After running
the file, you will be prompted for the following information:
a. Cluster ID: Provide a unique ID, such as node1 or node2. It should not be a
cluster ID that is already assigned.
b. Server shutdown port: The default is 8005. Add 1000 to the default to make it
9005. If you already have 9005 in use, use 10005.
c. JK Connector port: The default is 8009. Add 1000 to the default to make it
9009.
d. Cluster Listener port: The default is 4000. Add 1000 to the default to make it
5000.
The cluster is now created.
9. Stop your server by running ServiceController.bat services.stop.
WARNING! Upgrading an environment with an existing tomcat cluster, the cluster will be
broken if the ServerGroup is not updated.
1. Go to blackboard_home\tools\admin.
2. Stop your server by running ServiceController.bat services.stop.
3. Launch the Remove Cluster script by running RemoveCluster.bat.
4. Specify the cluster to be deleted, when prompted.
1. Install an additional application server on a machine that is not configured as part of the
load-balanced server environment. This application server must have a hostname
separate from the multiple Web/app configuration host name. Finally, the Collaboration
server should be resolvable in the DNS so that it is accessible from the Internet.
2. For each application server, set the following property in the bb-config.properties
file to prevent the Collaboration server from running on the local host:
bbconfig.Collaborationserver.run.on.localhost=false
3. Run the following command:
blackboard\tools\admin\PushConfigUpdates.cmd
4. Start the bb-tomcat service on each application server. Do not start the bb-
Collaboration service. The bb-Collaboration service must always be stopped on
the application servers that are not acting as the Collaboration server.
5. Repeat steps 2 through 4 for all application servers.
6. Stop the bb-tomcat service on the Collaboration server.
Follow these steps to modify the IIS and Blackboard services on each application server.
1. Log on to the first application server as the domain user with administrative privileges.
2. Right-click Computer and select Manage.
3. Front the Server Manager, click Configuration, and then double-click Services.
4. Open Start > Programs > Administrative Tools > Services.
5. Configure the Blackboard Collaboration Service by right clicking BBLEARN-Collab,
and then selecting Properties.
6. Click the Log on tab.
7. Select This account.
8. Browse to and select the domain user.
9. Enter and confirm the password for the domain user.
10. Click OK.
11. Configure the Blackboard Learn Tomcat service by right-clicking BBLEARN-Tomcat, and
then selecting Properties.
12. Click the Log on tab.
13. Select This account.
14. Browse to and select the domain user.
15. Enter and confirm the password for the domain user.
16. Click OK.
17. Repeat these steps for each application server.
When PushConfigUpdates is run to modify configuration parameters, the above changes to the
services will need to be re-applied. To avoid this extra step, add the domain user and password
to the Blackboard configuration file, bb-config.properties.
The following parameters can be configured with the username (account) and password of the
domain user. These are found in the windows - platform configuration section of bb-
config.properties:
bbconfig.appserver.service.account.win
bbconfig.appserver.service.password.win
bbconfig.Collaborationserver.service.account.win
bbconfig.Collaborationserver.service.password.win
The user (account) name must be specified in the form {domainname}\\{username}, or if the
account belongs to the local computer, specify the name in the form .\\{username}.
Alternatively, it can be specified as {username}@{fqdn}.
If this section is not configured, repeat the steps in this section after running PushConfigUpdates.
IMPORTANT! After running any updates, ensure that these service settings are still correct.
When setting up a hardware load balancer, it is important that each application server maintains
user session affinity for the entire of the session. Session affinity must be based on the user's
cookie. In other words, after a user logs in and a session is created on a particular application
server, that server must handle all requests associated with that session until it is closed.
Test the system by going to a workstation other than any of the Blackboard servers. Open a Web
browser and go the URL of the shared hostname configured during load balancing setup.
Log File
The Installer creates a log file named bb_installer_log.txt. This file is found in the
blackboard\logs directory.
If the Installer fails, check the log file to help determine the problem. The log file includes a
considerable amount of information about the installation process. Each time the Installer is run,
the attempt is appended to the log file. Make sure to focus on the latest attempt, which will be last
in the log file.
Because of the amount of information in the log file, the problem may not be immediately
apparent. Try searching for the following strings at the bottom of the installation log: BUILD
FAILED or Root Cause. Look closely at the log file both above and below the search string
(BUILD FAILED or Root Cause) for the reason the installation failed.
If the log file does not help diagnose the problem, keep a copy of the file in case you need to
contact Blackboard Learn Technical Support by logging in to Behind the Blackboard at
https://behind.blackboard.com. Technical Support will use the log file to diagnose the problem.
Turn off all network card offload functionality (disable TCP Checksum Offload):
1. Right-Click My Computer > Properties > Hardware Tab > Device Manager.
2. Click Network Adapters and then right-click Broadcom BCM5708S NetXtreme II GigE
> Properties.
3. Click Advanced Tab > Property: Checksum Offload > Value: None.
4. Click Advanced Tab > Property: Large Send Offload > Value: Disable.
1. Right-click My Computer > Properties > Hardware Tab > Device Manager.
2. Click Network Adapters and then right-click Broadcom BCM5708S NetXtreme II GigE
> Properties.
3. Click Management Tab > Uncheck Allow the computer to turn off this device to save
power > OK.
4. Reboot the system.
3. At the command prompt, type Netsh int ip set chimney ENABLED, and then press
ENTER.
Note For more information, consult the Microsoft Knowledge Base article 912222.
1. Create a text file mycustom.properties and add the following line to it (substitute the
right value):
bbconfig.database.jreport.password=pAssw0rd
2. Run the Installer as follows (text in caps should be filled in as appropriately):
java -jar bb-as-PLATFORM-VERSION.jar -config mycustom.properties
The Oracle media and initiation must be installed and configured manually. Blackboard
Learn - Basic Edition clients must install Small-Scale Oracle, which is provided by
Blackboard, instead of Oracle 10g. For more information, see the Small-Scale Oracle
topics in Blackboard Learn Help.
3. (Optional) Set Up Database Clustering and Storage
4. (Optional) Set Up File System Storage
5. Complete the Pre-Installation Checklist
6. Complete the Pre-Installation Worksheet
7. Install the Blackboard Learn Application Server and Database Server
Required Hardware
The About Hardware Sizing in a Dell Environment and About Hardware Sizing in a Sun
Microsystems Environment topics in Blackboard Learn Help detail several different hardware
configurations based on performance, cost, and redundancy. Make sure that the planned
hardware configuration meets the needs of the institution.
SPARC hardware is required for to install and run Blackboard Learn under Solaris operating
systems.
Required Software
For the exact versions of the operating systems, databases, and Java SE Developers Kit (JDK)
that are supported, see "Supported Technologies" in the Release Notes for the release that you
are installing. It is critical that the software used to host Blackboard Learn meets requirements.
Make sure that the server or servers are dedicated to Blackboard Learn. Make sure that the
server is not using valuable space and resources running unnecessary applications.
The Installer requires a user with permissions on the directory where Blackboard Learn will be
installed. The UNIX user must be created prior to installation with the following parameters.
Check the date and time on the system and make sure it is accurate and that the time zone is set
correctly. If installing on two servers check that the time on the application server and database
server match. Remember that the servers may be in a different time zone than the users. The
server time zone should be the same as the time zone used by the majority of users, instead of
the physical location of the server. Blackboard Learn uses the server date and time to control the
availability of time-sensitive materials. It is important that users have a clear expectation of when
materials will be available and when assignments are due.
Ports
Blackboard Learn requires ports to communicate. The list below details the required ports and
their default values. Make sure to configure server security and any firewalls to allow
communication on the required ports.
Web server port (default value: 80): This port handles communication between users and
the server.
Collaboration server TCP/IP port (default value: 8010): This port handles TCP
communication for the Collaboration server. By default, TCP communication connects
users to the Collaboration server.
Collaboration server HTTP port (default value: 8011): This port handles HTTP
communication for the Collaboration server.
Web server SSL port (default: 443): Primary web application port when SSL is in use.
Collaboration server SSL port (default: 8443): Secure communication for the collaboration
server.
WARNING! Do not use a firewall to redirect ports. The internal port configured on the server
must match the external port on the external firewall.
Network
Keep in mind the following when connecting Blackboard Learn to the network:
Do not use underscores in the machine name for the server or servers. Internet Explorer 6
blocks cookies if the machine name includes an underscore.
Set up the DNS server to resolve server names.
Check with a network engineer to make sure that the network can handle the anticipated
load after Blackboard Learn is made available to users.
An SMTP server must be available so that the Installer can connect to it.
An SMTP server has to remain available when the application is running in order to
deliver email notifications.
After the Oracle media and database are installed, configuration changes will need to be made to
the Oracle instance before installing Blackboard Learn.
Oracle has made many changes in Release 10g to simplify administration responsibilities and
improve sophistication of use.
For more information about configuring Oracle in a Blackboard Learn environment to achieve the
best performance possible, see the Oracle topics in the Optimization section in Blackboard Learn
Help.
Prior to Oracle 10g (Release 2), the CONNECT role was granted eight privileges: create
session, create table, create view, create synonym, create database link,
create cluster, create sequence, and alter session. With the release of Oracle
10.2.0.1, only the create session privilege is granted to the CONNECT role. Oracle removed
the additional privileges granted to the CONNECT role in Oracle 10g (Release 2) to provide
additional security by enforcing a principle of least privileges.
Standard installations and upgrades require the CONNECT role to have the create session,
create table, create view, create synonym, create sequence, and alter
session privileges. Clustered installations and upgrades additionally require the CONNECT role
to have the create cluster privilege. The following script will grant all eight privileges for
installations and upgrades of Blackboard Learn on Oracle 10g (Release 2). The privileges are
only required during the installation or upgrade, and may be revoked at the time of completion.
SQL> @$ORACLE_HOME/rdbms/admin/rstrconn.sql
The parameter DB_BLOCK_SIZE specifies (in bytes) the size of the Oracle database blocks. This
parameter must be set to 8192. Prior installations may have been set to 4096, and must be
changed to 8192. Failure to set the Oracle database block size 8192 can cause an incorrect
installation of Blackboard Learn.
The national alternate character set value for Oracle is AL16UTF16 (also referred to as UTF16).
Administrators using Oracle should confirm that the national alternate character set is
AL16UTF16 before installing Blackboard Learn. The National Character Set value can be
determined by querying the v$ table using the following SQL command:
$ sqlplus / as sysdba
PARAMETER Value
--------------------------------------------- -----------
NLS_NCHAR_CHARACTERSET AL16UTF16
Oracle RAC
Blackboard offers support for Oracle RAC with all versions of Oracle supported by Blackboard.
For more information, see Supported Technologies in the Release Notes for the release that
you are installing. For information about running Blackboard Learn with RAC, see the Oracle RAC
Support on UNIX topic in Blackboard Learn Help.
Setup a Separate Storage Device for the Data Files and Log Files
The Installer will prompt for the directory where the database data files and log files should be
stored. For information about storing these files on a separate device, see the Oracle
documentation. Keep in mind that the storage device should have a dedicated, high-bandwidth
connection to the database server.
Note Blackboard Learn - Basic Edition clients must use the local default location of
/usr/local/blackboard/content.
All of the content files for Blackboard Learn, such as files uploaded to Courses and image files,
are stored in the blackboard/content directory. If the content management capabilities have been
licensed, the Content Collection has several content directories, each one dedicated to one of the
top-level directories. For example, the /library directory stores all the files for the Library.
In a load-balanced configuration, this location must be accessible by all of the application servers.
The location can be a share on one of the application servers or on the database server, or it can
be a SAN (storage area network) or NAS (network-attached storage) on a separate file server.
These instructions detail how to set up the blackboard/content directory on a separate file
server. The same methods can be repeated to set up the content management directories on a
separate file server.
1. Log in to the file system server and create a directory that will store the content files.
2. Log in to the application server and create a mount at
usr/local/blackboard/content that points directly to the content directory on the
file system server. Using a symbolic link may cause problems with permissions when
using building blocks.
If Blackboard Learn will be installed on only one server, the server must pass the checklist for
both the application server and the database server.
Blackboard Basics
Review the following list to make sure that Blackboard has provided everything necessary to
begin installation.
A valid Blackboard Learn license file has been downloaded and is accessible from the
application server. To receive a license file, contact your Blackboard Client
Representative.
The Installer has been downloaded to the application servers. To receive instructions for
downloading the Installer, contact your Blackboard Client Representative.
The Administrator has contact information for Blackboard Technical Support and a login
for Behind the Blackboard at https://behind.blackboard.com.
Review the following list to make sure that the application server is prepared for installation.
The bash shell is specified as the bbuser login shell and is also being used by the root
user for all Blackboard Learn tasks including installation.
The Installer can connect to the SMTP server.
Review the following list to make sure that the database server is prepared for installation.
Remember that if a one server configuration is used the database server and application server
are configured on one machine.
Setup Type: Select the Full Installation option to install Blackboard Learn on one or two servers.
This option is also used when installing Blackboard Learn on the database and first application
server in a Load-Balanced configuration.
Note Blackboard Learn - Basic Edition clients must use the local default location.
For more information about the integration account, see the Editing the Integration Password
topic in Blackboard Learn Help.
The root_admin account is created even if your license does not include the use of additional
Virtual Installations. The root_admin account can be modified from the Edit Root Administrator
Profile page.
K-12
Higher Education
Continuing Education
Corporate
Professional Association
Hobby
City: ___________________________________________
The state, province, or territory where the institution is located.
State: ___________________________________________
The state, province, or territory where the institution is located.
Country: ___________________________________________
The Country where the institution is located.
To request a current license file for this release and your institution and instructions for
downloading the Installer, contact your Blackboard Client Representative.
Make sure that the system meets the supported software requirements and is properly configured
before running the Installer. To confirm that the system is ready for installation, see Pre-
Installation Checklist.
Blackboard Learn must be installed as root. Service startup and shutdown must also be
performed as root.
The Installer is run on a two-server system: The instructions reference the application
server and the database server. When installing on one server, these machines are the
same.
The Installer is run using the command-line interface: The GUI Installer requires the same
inputs from the user. The only difference between the command-line and the GUI
interface is navigation. The GUI interface uses mouse-clicks instead of using keystrokes
to accept a value and continue. The command line places the default or anticipated value
in brackets. You may either enter a new value or simply press ENTER to select the value
in brackets.
The optional steps for installing the content management capabilities: These steps are
included for testing purposes. Blackboard recommends that the content management
capabilities be used only with Load-Balanced systems.
1. Place both the Installer and the license file in a directory on the application server. The
Installer will automatically recognize the license file if it is renamed bb-license.xml
and placed in the same directory as the Installer. The following steps use
/usr/local/bbinstaller/ as an example.
2. Open a command-line prompt and navigate to the directory that contains the Installer.
3. Execute the root user login profile:
./su -root
4. Run the following command to launch the Installer:
/usr/local/bbinstaller/java -jar bb-installer.jar
If Xwindows or a similar GUI is running, the Installer will launch in GUI mode. (The
following steps assume that the command line Installer is used). Use the -text option to
force text mode even if a GUI is running.
18. Provide the Oracle sys database administrator password. Provide a value and then press
ENTER.
19. Provide the Blackboard database user password. This database login is used by the
application to access the database. Provide a value and then press ENTER.
20. Provide the Blackboard database report password. This database login is used by the
application to access the reporting database. Enter a value and then press ENTER.
21. Optional Step for Content Collection Users: Provide the content management database
password and then press ENTER. This login is used by the application to access content
management database.
22. Provide the location for the database data directory and then press ENTER. The directory
that will store Blackboard Learn database data files. This directory will not store
application data or content. This directory must be in a directory where Oracle has
read/write/execute privileges. Make sure that the directory has space to accommodate
database growth. This directory must be created before installing Blackboard Learn.
23. Provide the location for the database index directory and then press ENTER. The
directory that will store Blackboard Learn database index files. This directory must be in a
directory where Oracle has read/write/execute privileges. If possible, this directory should
be separate from the data directory.
24. Optional Step for Content Collection Users: Provide the storage directories for the content
management storage locations and then press ENTER. For example, the default value is
/usr/local/blackboard/cms/courses.
25. Provide the path to the content management /institution directory. The default value
is /usr/local/blackboard/institution. Repeat for each of the four additional
locations: Institution, Library, Orgs, and Users.
26. Provide the Collaboration server hostname. In a one or two server environment, the
default value is the application server. In a load-balanced environment, select one of the
existing application servers to also act as the Collaboration server. Though not typically
required, a separate server may be dedicated as the Collaboration server exclusively. For
more information, see Set Up a Collaboration Server. The Collaboration server runs
Virtual Classroom and chat sessions. Press ENTER to accept the default or provide a
new value and then press ENTER.
27. Provide the TCP port number for the Collaboration server. The default port number is
8010. Press ENTER to accept the default or provide a new value and then press ENTER.
28. Provide the HTTP port number for the Collaboration server. The default port number is
8011. Press ENTER to accept the default or provide a new value and then press ENTER.
29. Provide the hostname of the SMTP server. The SMTP server is used to send out email
communications. Keep in mind that the hostname is the represented by
machine_name.domain_name. Provide a value and then press ENTER.
30. Provide the Blackboard Administrator password. The Administrator account has full
privileges. Provide a value and then press ENTER.
31. Provide the Blackboard Integration password. The integration user is used only to
facilitate Snapshot operations. This account cannot be used to log in through the GUI nor
does it appear in any lists of users in the user interface. To change the password for this
account, on the Administrator Panel, under Building Blocks, click Integration Password.
Provide a value and then press ENTER.
32. Provide the Blackboard root administrator password.The root_admin account has full
administrative privileges including the management of Virtual Installations through the
Administrator Panel. When the root_admin account user views the Administrator Panel,
the Manage Virtual Installations link appears at the top of the panel. The root_admin can
log in to any Virtual Installation and access the Virtual Installation management features
from this link. While it is necessary to enter a password for this account, it is very rare that
a system with Virtual Installations will be run on one server or two servers. Provide a
value and then press ENTER.
33. Follow the prompts to enter the System Administrator's contact information.
34. Enter the Server Type. This is information is used for better management of centralized
services. Options include: Production, Staging, Test, and Development. Properly
categorize each server when running the installer.
35. Press ENTER to install the software. Do not close the command line window during the
installation.
If the Installer failed, please check the Installer log and see Troubleshooting to diagnose and fix
the problem.
Make sure that the hardware, software, and network are prepared before beginning to configure
and install Blackboard Learn in a load-balanced environment.
Required Hardware
The About Hardware Sizing in a Dell Environment and About Hardware Sizing in a Sun
Microsystems Environment topics in Blackboard Learn Help detail several different hardware
configurations based on performance, cost, and redundancy. Read this document to make sure
that the planned hardware configuration meets the needs of the institution.
SPARC hardware is required for to install and run Blackboard Learn under Solaris operating
systems.
Required Software
For the exact versions of the operating systems, databases, and Java SE Developers Kit (JDK)
that are supported, see "Supported Technologies" in the Release Notes for the release that you
are installing. It is critical that the software used to host Blackboard Learn meets requirements.
Make sure that the server or servers are dedicated to Blackboard Learn. Make sure that the
server is not using valuable space and resources running unnecessary applications.
Collaboration Server
Select one of the existing application servers to also act as the Collaboration server. Optionally,
configure a separate Collaboration server. For more information, see Set Up a Collaboration
Server. The Collaboration server may not be spread across multiple application servers because
all users participating in a Collaboration session must share the same resources. A single server
must be configured to run the Collaboration server. This server must handle Collaboration
sessions and performance will be unaffected by other requests. The application servers are
configured to connect users to one server that handles all the Collaboration sessions.
Set aside one server as a dedicated file system server. The content files must be centralized so
that all files are available to users regardless of the application server handling the connection.
The application servers are configured to find the content files in a directory on the file system
server.
Load-Balancing Methods
Institutions can use the load-balancing method of their choice as long as it adheres to a few basic
principles:
The Installer requires a user with permissions on the directory where Blackboard Learn will be
installed. The UNIX user must be created prior to installation with the following parameters.
Check the date and time on the system and make sure it is accurate and that the time zone is set
correctly. If installing on two servers check that the time on the application server and database
server match. Remember that the servers may be in a different time zone than users. The server
time zone should be the same as the time zone used by the majority of users, instead of the
physical location of the server. Blackboard Learn uses the server date and time to control the
availability of time-sensitive materials. It is important that users have a clear expectation of when
materials will be available and when assignments are due.
Ports
Blackboard Learn requires ports to communicate. The list below details the required ports and
their default values. Make sure to configure server security and any firewalls to allow
communication on the required ports. The port values must be the same for each application
server.
Web server port (default value: 80): This port handles communication between users and
the server.
Collaboration server TCP/IP port (default value: 8010): This port handles TCP
communication for the Collaboration server. By default, TCP communication connects
users to the Collaboration server.
Collaboration server HTTP port (default value: 8011): This port handles HTTP
communication for the Collaboration server.
Web server SSL port (default: 443): Primary web application port when SSL is in use.
Collaboration server SSL port (default: 8443): Secure communication for the collaboration
server.
WARNING! Do not use a firewall to redirect ports. The internal port configured on the server
must match the external port on the external firewall.
Network
Keep in mind the following when connecting Blackboard Learn to the network:
Do not use underscores in the machine name for the server or servers. Some versions of
Internet Explorer block cookies if the machine name includes an underscore.
Set up the DNS server to resolve the hardware load-balancer. The hardware load-
balancer will then direct traffic to the application servers. Set up a separate DNS entry for
the Collaboration server.
Check with a network engineer to make sure that the network can handle the anticipated
load after Blackboard Learn is made available to users.
An SMTP server must be available so that the Installer can connect to it.
An SMTP server has to remain available when the application is running in order to
deliver email notifications.
After the Oracle media and database are installed, configuration changes will need to be made to
the Oracle instance before installing Blackboard Learn.
Oracle has made many changes in Release 10g to simplify administration responsibilities and
improve sophistication of use.
For more information about configuring Oracle in a Blackboard Learn environment to achieve the
best performance possible, see the Oracle topics in the Optimization section in Blackboard Learn
Help.
Prior to Oracle 10g (Release 2), the CONNECT role was granted eight privileges: create
session, create table, create view, create synonym, create database link,
create cluster, create sequence, and alter session. With the release of Oracle
10.2.0.1, only the create session privilege is granted to the CONNECT role. Oracle removed
the additional privileges granted to the CONNECT role in Oracle 10g (Release 2) to provide
additional security by enforcing a principle of least privileges.
Standard installations and upgrades require the CONNECT role to have the create session,
create table, create view, create synonym, create sequence, and alter
session privileges. Clustered installations and upgrades additionally require the CONNECT role
to have the create cluster privilege. The following script will grant all eight privileges for
installations and upgrades of Blackboard Learn on Oracle 10g (Release 2). The privileges are
only required during the installation or upgrade, and may be revoked at the time of completion.
SQL> @$ORACLE_HOME/rdbms/admin/rstrconn.sql
The parameter DB_BLOCK_SIZE specifies (in bytes) the size of the Oracle database blocks. This
parameter must be set to 8192. Prior installations may have been set to 4096, and must be
changed to 8192. Failure to set the Oracle database block size 8192 can cause an incorrect
installation of Blackboard Learn.
The national alternate character set value for Oracle is AL16UTF16 (also referred to as UTF16).
Administrators using Oracle should confirm that the national alternate character set is
AL16UTF16 before installing Blackboard Learn. The National Character Set value can be
determined by querying the v$ table using the following SQL command:
$ sqlplus / as sysdba
PARAMETER Value
--------------------------------------------- -----------
NLS_NCHAR_CHARACTERSET AL16UTF16
Oracle RAC
Blackboard offers support for Oracle RAC with all versions of Oracle supported by Blackboard.
For more information, see Supported Technologies in the Release Notes for the release that you
are installing. For information about running Blackboard Learn with RAC, see the Oracle
RAC Support on UNIX topic in Blackboard Learn Help.
Setup a Separate Storage Device for the Data Files and Log Files
The Installer will prompt for the directory where the database data files and log files should be
stored. For information about storing these files on a separate device, see the Oracle
documentation. Keep in mind that the storage device should have a dedicated, high-bandwidth
connection to the database server.
Note Blackboard Learn - Basic Edition clients must use the local default location of
/usr/local/blackboard/content.
All of the content files for Blackboard Learn, such as files uploaded to Courses and image files,
are stored in the blackboard/content directory. If the content management capabilities have been
licensed, the Content Collection has several content directories, each one dedicated to one of the
top-level directories. For example, the /library directory stores all the files for the Library.
In a load-balanced configuration, this location must be accessible by all of the application servers.
The location can be a share on one of the application servers or on the database server, or it can
be a SAN (storage area network) or NAS (network-attached storage) on a separate file server.
These instructions detail how to set up the blackboard/content directory on a separate file
server. The same methods can be repeated to set up the content management directories on a
separate file server.
1. Log in to the file system server and create a directory that will store the content files.
2. Log in to the application server and create a mount at
usr/local/blackboard/content that points directly to the content directory on the
file system server. Using a symbolic link may cause problems with permissions when
using building blocks.
Blackboard Basics
Review the following list to make sure that Blackboard has provided everything necessary to
begin installation.
A valid Blackboard Learn license file has been downloaded and is accessible from the
application server. To receive a license file, contact your Blackboard Client
Representative.
The Installer has been downloaded to the application servers. To receive instructions for
downloading the Installer, contact your Blackboard Client Representative.
The Administrator has contact information for Blackboard Technical Support and a login
for Behind the Blackboard at https://behind.blackboard.com.
Review the following list to make sure that each application server is prepared for installation.
Review the following list to make sure that the file system server is prepared for installation.
The Administrator has a plan for backing up the application file system.
A directory to store the Blackboard content is configured and shared. Another directory for
the content management content (available only if the content management capabilities
have been licensed) is configured and shared, if desired.
The domain user that will run the application services has full access to the shared
directories.
Review the following list to make sure that the Collaboration server is prepared for installation.
The Collaboration server uses a different DNS name than that of the application servers.
Review the following list to make sure that the database server is prepared for installation.
Remember that if a one server configuration is used, the database server and application server
are configured on one machine.
Note Most of the values required by the Installer must be the same for each application server
and for the Collaboration server. All ports and settings that point to the database server,
Collaboration server, and file system server must be the same for all.
Full Installation: Select this option to install the database and the first application server.
Appserver-only Installation Select this option when installing the second and all
subsequent application servers or when setting up the Collaboration server on a separate
device.
Note Blackboard Learn - Basic Edition clients must use the local default location.
For more information about the integration account, see the Editing the Integration Password
topic in Blackboard Learn Help.
The root_admin account is created even if your license does not include the use of additional
Virtual Installations. The root_admin account can be modified from the Edit Root Administrator
Profile page.
K-12
Higher Education
Continuing Education
Corporate
Professional Association
Hobby
City: ___________________________________________
The state, province, or territory where the institution is located.
State: ___________________________________________
The state, province, or territory where the institution is located.
Country: ___________________________________________
The Country where the institution is located.
To request a current license file for this release and your institution and instructions for
downloading the Installer, contact your Blackboard Client Representative.
Make sure that the system meets the supported software requirements and is properly configured
before running the Installer. To confirm that the system is ready for installation, see Pre-
Installation Checklist.
Blackboard Learn must be installed as root. Service startup and shutdown must also be
performed as root.
The Installer is run on a two-server system: The instructions reference the application
server and the database server. When installing on one server, these machines are the
same.
The Installer is run using the command-line interface: The GUI Installer requires the same
inputs from the user. The only difference between the command-line and the GUI
interface is navigation. The GUI interface uses mouse-clicks instead of using keystrokes
to accept a value and continue. The command line places the default or anticipated value
in brackets. You may either enter a new value or simply press ENTER to select the value
in brackets.
The optional steps for installing the content management capabilities: These steps are
included for testing purposes. Blackboard recommends that the content management
capabilities be used only with Load-Balanced systems.
1. Place both the Installer and the license file in a directory on the application server. The
Installer will automatically recognize the license file if it is renamed bb-license.xml
and placed in the same directory as the Installer. The following steps use
/usr/local/bbinstaller/ as an example.
2. Open a command-line prompt and navigate to the directory that contains the Installer.
3. Execute the root user login profile:
./su -root
4. Run the following command to launch the Installer:
/usr/local/bbinstaller/java -jar bb-installer.jar
If Xwindows or a similar GUI is running, the Installer will launch in GUI mode. (The
following steps assume that the command line Installer is used). Use the -text option to
force text mode even if a GUI is running.
18. Provide the Oracle sys database administrator password. Provide a value and then press
ENTER.
19. Provide the Blackboard database user password. This database login is used by the
application to access the database. Provide a value and then press ENTER.
20. Provide the Blackboard database report password. This database login is used by the
application to access the reporting database. Enter a value and then press ENTER.
21. Optional Step for Content Collection Users: Provide the content management database
password and then press ENTER. This login is used by the application to access content
management database.
22. Provide the location for the database data directory and then press ENTER. The directory
that will store Blackboard Learn database data files. This directory will not store
application data or content. This directory must be in a directory where Oracle has
read/write/execute privileges. Make sure that the directory has space to accommodate
database growth. This directory must be created before installing Blackboard Learn.
23. Provide the location for the database index directory and then press ENTER. The
directory that will store Blackboard Learn database index files. This directory must be in a
directory where Oracle has read/write/execute privileges. If possible, this directory should
be separate from the data directory.
24. Optional Step for Content Collection Users: Provide the storage directories for the content
management storage locations and then press ENTER. For example, the default value is
/usr/local/blackboard/cms/courses.
25. Provide the path to the content management /institution directory. The default value
is /usr/local/blackboard/institution. Repeat for each of the four additional
locations: Institution, Library, Orgs, and Users.
26. Provide the Collaboration server hostname. In a one or two server environment, the
default value is the application server. In a load-balanced environment, select one of the
existing application servers to also act as the Collaboration server. Though not typically
required, a separate server may be dedicated as the Collaboration server exclusively. For
more information, see Set Up a Collaboration Server. The Collaboration server runs
Virtual Classroom and chat sessions. Press ENTER to accept the default or provide a
new value and then press ENTER.
27. Provide the TCP port number for the Collaboration server. The default port number is
8010. Press ENTER to accept the default or provide a new value and then press ENTER.
28. Provide the HTTP port number for the Collaboration server. The default port number is
8011. Press ENTER to accept the default or provide a new value and then press ENTER.
29. Provide the hostname of the SMTP server. The SMTP server is used to send out email
communications. Keep in mind that the hostname is the represented by
machine_name.domain_name. Provide a value and then press ENTER.
30. Provide the Blackboard Administrator password. The Administrator account has full
privileges. Provide a value and then press ENTER.
31. Provide the Blackboard Integration password. The integration user is used only to
facilitate Snapshot operations. This account cannot be used to log in through the GUI nor
does it appear in any lists of users in the user interface. To change the password for this
account, on the Administrator Panel, under Building Blocks, click Integration Password.
Provide a value and then press ENTER.
32. Provide the Blackboard root administrator password.The root_admin account has full
administrative privileges including the management of Virtual Installations through the
Administrator Panel. When the root_admin account user views the Administrator Panel,
the Manage Virtual Installations link appears at the top of the panel. The root_admin can
log in to any Virtual Installation and access the Virtual Installation management features
from this link. While it is necessary to enter a password for this account, it is very rare that
a system with Virtual Installations will be run on one server or two servers. Provide a
value and then press ENTER.
33. Follow the prompts to enter the System Administrator's contact information.
34. Enter the Server Type. This is information is used for better management of centralized
services. Options include: Production, Staging, Test, and Development. Properly
categorize each server when running the installer.
35. Press ENTER to install the software. Do not close the command line window during the
installation.
If the Installer failed, please check the Installer log and see Troubleshooting to diagnose and fix
the problem.
The Installer will prompt for the same information as a Full Installation. Instead of creating the
database, however, the Installer will attempt to connect to the database.
Blackboard Learn must be installed as root. Service startup and shutdown must also be
performed as root.
Experienced administrators may choose to use the non-interactive Installer to setup the
second and subsequent application servers.
When executing the Installer on the additional application servers, pay close attention to the
values of the ports and host names. Be sure that the hostname for the Web server matches the
load-balanced URL and is not set to the name of the individual server. Be sure that the
Collaboration tool (virtual chat, virtual classroom) ports are set properly. Remember that the
following settings must be the same across all application servers (and the Collaboration server):
When the installation is complete, each application server can be accessed individually and
separately tested; complete tests should also be run from the load-balanced URL.
Customers can achieve similar performance in a virtual environment on the same physical server
with multiple virtual instances as with a bare metal configuration with many Tomcat cluster
instances. The difference in configurations is a smaller demand on the Apache or IIS web server
fronting the Tomcat instance(s). The option to deploy a 64-bit JVM with larger heap sizes has
suppressed the need for customers to run in a cluster option.
Blackboard recommends that customers consider a deployment approach consisting of larger 64-
bit JVMs that are distributed across physical servers with the option to virtualize the hardware to
take advantage of the CPU and Memory capacity of these systems.
However, new installations can optionally be configured to use a clustered Tomcat environment.
Existing clustered Tomcat environments performing an upgrade must use the following steps.
10. Run the jps command from JAVA_HOME to see the bootstrap processes. You should see
one Tomcat Process, and the number of Cluster Process IDs.
WARNING! Upgrading an environment with an existing tomcat cluster, the cluster will be
broken if the ServerGroup is not updated.
1. Go to blackboard_home/tools/admin.
2. Stop your server by issuing./ServiceController.sh services.stop .
3. Launch the Remove Cluster script by issuing ./RemoveCluster.sh.
4. Specify the cluster to be deleted when prompted.
5. Verify the cluster was successfully removed by running the jps command from
JAVA_HOME to see the bootstrap processes.
1. Install an additional application server on a machine that is not configured as part of the
load-balanced server environment. This application server must have a hostname
separate from the multiple Web/app configuration host name. Finally, the Collaboration
server should be resolvable in the DNS so that it is accessible from the Internet.
2. For each application server, set the following property in the bb-config.properties
file to prevent the Collaboration server from running on the local host.
bbconfig.Collaborationserver.run.on.localhost=false
3. Run the following command:
\blackboard\tools\admin\PushConfigUpdates.bat
4. Start the bb-tomcat and IIS services on each application server. Do not start the bb-
Collaboration service. The bb-Collaboration service must always be stopped on
the application servers that are not acting as the Collaboration server.
5. Repeat steps 2 through 4 for all application servers.
6. Stop the bb-tomcat service on the Collaboration server.
When setting up a hardware load balancer, it is important that each application server maintains
user session affinity for the entire of the session. Session affinity must be based on the user's
cookie. In other words, after a user logs in and a session is created on a particular application
server, that server must handle all requests associated with that session until it is closed.
Test the system by going to a workstation other than any of the Blackboard servers. Open a Web
browser and go the URL of the shared hostname configured during load balancing setup.
Log File
The Installer creates a log file named bb_installer_log.txt. This file is found in the
blackboard/logs directory.
If the Installer fails, check the log file to help determine the problem. The log file includes a
considerable amount of information about the installation process. Each time the Installer is run,
the attempt is appended to the log file. Make sure to focus on the latest attempt, which will be last
in the log file.
Because of the amount of information in the log file, the problem may not be immediately
apparent. Try searching for the following strings at the bottom of the installation log: BUILD
FAILED or Root Cause. Look closely at the log file both above and below the search string
(BUILD FAILED or Root Cause) for the reason the installation failed.
If the log file does not help diagnose the problem, keep a copy of the file in case you need to
contact Blackboard Technical Support by logging in to Behind the Blackboard at
https://behind.blackboard.com. Technical Support will use the log file to diagnose the problem.
Uninstall completely removes the application files, content files, and the database.
Uninstall App Server Only uninstalls only the application files, and leaves the content files
and database. Typically, Uninstall App Server Only is used as part of the process when
uninstalling a load-balanced system. However, it can be useful to uninstall the application
files and save the content files and databases for archiving.
Note Blackboard recommends as a best practice that instead of running an uninstall, you re-
image the application and database servers and then perform a fresh operating system
installation.
It is important to close all Blackboard Learn-related sessions that are connected to the Oracle
database. Follow these steps to disconnect related sessions:
1. Execute the root user login profile:
su - root
2. Stop all Blackboard Learn services.
3. Terminate database connections by shutting down and restarting Oracle Database
Server.
-or-
Issue the following SQL command to find connected sessions:
SQL>select process from v$session where schemaname IN
(BBADMIN,BB_BB60,BB_BB60_STATS);
Uninstalling a load-balanced system requires removing the application files from each application
server and the Collaboration server. After running the Uninstall option on one application server,
that application server, the file system, and the database will be removed. Use the Uninstall
Appserver option to remove the application files on the Collaboration server and the other
application servers.
WARNING! If the uninstall procedure fails, contact Blackboard Technical Support by logging
in to Behind the Blackboard at https://behind.blackboard.com.
4. To specify the directory where Blackboard is located, click Next to accept the default, or
enter a new value and then click Next. If Blackboard Learn is not found in the directory
provided, the Updater will attempt to install at the given location.
5. Select the Uninstall Blackboard Learn option and click Next.
6. A message displays explaining what will be uninstalled. Click Next to uninstall.