Académique Documents
Professionnel Documents
Culture Documents
Page 1 of 16
Dashboard > Academic Suite Knowledgebase > … > Installation and Upgrade Troubleshooting Guide > Installation
Introduction
This guide is intended to assist in understanding the Blackboard installation and upgrade process and to help troubleshoot common issues.
not an exhaustive reference for known issues, however it should be considered the primary source for technical and troubleshooting
documentation for the installer. This is an early release of the guide to gain feedback and provide a preview of this new Knowledge Base
resource.
The Blackboard Installer is used for all installation and upgrade activities and is capable of new installations or upgrades and functions the s
way whether installing Application Packs, Service Packs or Hotfixes. The installer is guaranteed to establish a known state for both
and database, however the installer cannot rollback to an earlier version in the event of an upgrade failure.
Failures during installations and upgrades are typically non-fatal as the installer architecture allows a failed installation to be reattempted onc
condition causing the failure is corrected. This guide details a troubleshooting methodology which explains how to collect and
about the failure. It also demonstrates how to determine the nature of the failure and assist in determining the root cause.
This guide was written primarily to support Blackboard Learn Release 9 and later. However much of the information is applicable to Release
and 8 and further reading links provide legacy and background information where possible.
Prerequisites
Conventions
Indicates a link to a topic for further information
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kno... Page 2 of 16
Contributors
Feedback
If you have comments or suggestions for this guide, please contact Danny Thomas.
Collect
Log Files
The installer outputs several files which contain information necessary to determine the cause of any failure. These paths are relative to blac
Filename
bb-installer-log.txt Primary Blackboard Installer log. When the installer executes, this files temporarily resides in the same direc
Upon completion (success or failure) it is appended to the existing file of the name name in blackboard/logs.
This preserves detailed upgrade history and should be retained to assist Client Support with any issues enc
update-tools/update-tool- Various updater tools log their output here, so is crucial to any installation issue
log.txt
update-tools/schema-log.txt SQL statement trace information about the statements ran while installing/updating the Blackboard schema
update-tools/sqlerror-log.txt Detailed SQL errors and exceptions raised during the schema update
bb-installer.properties The properties provided to the installer for new installations or determined from config/bb-config.properties a
This can be used to examine failures to detect the correct parameters, and it is used as the basis for buildin
blackboard-license.xml In an interactive installation, a license file must be supplied, but for an upgrade the existing license at
for the upgrade is selected.
If this is a new installation or a license update, you may need to review and provide this file to Client Suppor
Further Reading
For legacy Release 7 Installer information see Running the Blackboard Release 7 Installer-Updater
Analyze
If an installation or upgrade fails, determining the cause begins with an analysis of the bb-installer-log.txt to discover which phase o
which have a series of component steps. This section of the article discusses each of these phases, how to identify them in the installer log
installer log to understand the installation process as bb-services-log extracts are provided to act as milestones.
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kno... Page 3 of 16
• Installer Launch
• Pre-installation steps
• Client installation steps
• Ant-based tasks
• Java Exceptions
Due to limitations of the layout, the cause links below will open the document individually. View the entire cause section by clicking the appro
Failures during installations and upgrades are non-fatal as the installer architecture allows a failed installation to be reattempted on
completely remove the application and should never be used in the event of an upgrade failure.
Installer Launch
A successful installer launch will result in a version banner being output and you will be prompted to choose an installation type. No changes
type.
Timestamps have been omitted to improve readability throughout the rest of this section, however as the bb-installer-log.txt
the log file and searching for the last occurrence for the version you were attempting to install, ensuring the date and time stamp matches th
A failure to output this banner indicates a fundamental problem with Java or the Installer. Problems with the environment configuration may
Pre-installation steps
The following pre-installation steps are performed before the core application installation steps are performed:
impl.services.webserver.stop:
[IIS] Stopping IIS service...
[IIS] The IIS Admin Service service is not started.
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kno... Page 4 of 16
BUILD FAILED
C:\blackboard\system\tooldefs\install\ServiceController\tool-common.xml:48: The following error occu
C:\blackboard\system\tooldefs\install\ServiceController\tool-impl.xml:47: exec returned: 2
See Ant-based tasks for further details of how to analyze Ant-based task failures.
See Validation Failures for common failure cases and root causes.
These files are backed up to a dated/timestamped sub-directory of blackboard/backups and will be listed in the installer log:
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kno... Page 5 of 16
This step copies the bb-config.properties file generated earlier to content/loadbalancing/bb-config.properties. This file
This step creates the Blackboard directory structure. On Linux and Solaris environment, it also:
• Unzips the Oracle client and adds TNS names list as it's used as part of the installation process
• Creates file system links, selected Blackboard installation directory to /usr/local/blackboard, apps/tomcat/logs
• Sets file ownership to bbuser, chown blackboard, chown content - excludes content/vi/bb_bb60/courses for performance reasons, set
At this step key configuration files are created with replaced files in /backups/templates/yyyy-mm-dd-hh.mm.ss directories.
process the application classpath files, copying key JAR files to the apps/tomcat/common/lib directory.
For Windows clients the ISAPI plugin files are also copied at this step.
An additional check to ensure that the web server is still stopped. Failures here should be non-fatal to the installer.
This step is responsible for creating the Blackboard database and updating the schema ('database' is used generically in this context,
database creation and update process ensures that the database meets a defined schema, with the important exception that non
the main VI databases. Progress of these steps can be followed by looking for the following start and completion milestones:
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kno... Page 6 of 16
Failures during the database creation/update process will almost always be accompanied by an error from the database server relating to a
should indicate the cause, however update-tools/sqlerror-log.txt and update-tools/schema-log.txt will contain further
The following phases performed for each database schema update. These examples are from an upgrade, however hew installations have t
create these objects.
The scripts here perform tasks that require logic more advanced than basic schema and data structure changes.
Internationalization
Tables are checked to determine if they need to be internationalized. This is a legacy part of the Release 6 to 7 upgrade process,
Table Schema
Table columns are checked for consistency with the schema definitions. If the column data type or default value differs, the table is altered. C
Constraints
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kno... Page 7 of 16
Procedures
At this stage additional SQL scripts and ran and data templates are defined. The data templates provide the default values to be stored
This step primarily performs Windows Service installation. It installs or updated the IIS website, removes and reinstalls Tomcat and
Server service.
Xythos installation and upgrade steps are performed and the license is applied to the product. Xythos is the technology underpinning the con
This step performs UNIX file system ownership operations for the newly installed files ensuring that bbuser has appropriate permissions to th
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kno... Page 8 of 16
Installation Complete
The installation will complete with a BUILD SUCCEEDED or BUILD FAILED message. If you see the former, the installation was successful
BUILD FAILED
Total time: 8 minutes 8 seconds
Ant-based Tasks
Blackboard tools such as the ServiceController, PurgeAccumulator and client installation are implemented as Ant tasks. Failures of Ant
name of the task step that is currently running and any output provided by that step. For instance, a failure in a task to stop IIS on Windows
impl.services.webserver.stop:
[IIS] Stopping IIS service...
[IIS] The IIS Admin Service service is not started.
[IIS] More help is available by typing NET HELPMSG 3521.
BUILD FAILED
C:\blackboard\system\tooldefs\install\ServiceController\tool-common.xml:48: The following error occu
C:\blackboard\system\tooldefs\install\ServiceController\tool-impl.xml:47: exec returned: 2
Many failures will be obvious based on the command output before the BUILD FAILED message, for instance here we attempted to stop th
additional information will be logged to update-tool-log.txt. The information about exactly where the task failed follows the
being where the problem occurred.
It's possible to find more information about what the tool was doing at the time of the failure by looking closer at the line that failed:
This tells us the error occurred in system\tooldefs\install\ServiceController\tool-impl.xml, line 47 and we were attemptin
impl.xml line 47 is indeed the closing line for an exec task (line numbers added for reference):
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kno... Page 9 of 16
The command we're attempting to run is attempting to run is net stop iisadmin /Y, though the condition indicates that it shouldn't be a
ServiceController failures during installations are non-fatal, they don't cause the installer to be terminated.
Not all Ant failures will be straight forward however. Many tasks rely on Java classes to perform their work and will return exceptions with a J
worthwhile searching the Knowledge Base for the line where the failure occurred or messages returned by the tool itself before looking into t
See Java Exceptions for information on how to read a Java stack trace.
Further Reading
Apache Ant User Manual
Java Exceptions
When an error occurs within Java code an exception is raised. Under some circumstances the installer will catch and handle these
valuable as a troubleshooting aid, it will be logged. The output of an exception has two key parts, the exception itself with any
A failure to connect to a Microsoft SQL Server database due to the server being unavailable or a network configuration problem might cause
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kn... Page 10 of 16
For those unfamiliar with Java or the Blackboard product, stack traces can be daunting, though it's a simple task to glean some useful inform
very first thing listed in the stack trace com.inet.tds.Tds4SQLException. Following the exception, is the error message returned with t
connect.
The TDS Driver has simplified things by including the detail of the cause of the exception in the error message, but that isn't always the case
trace. Where multiple nested blocks exist, the very last one shows the root exception and message, in this case java.net.ConnectExcep
This exception makes it clear that the host actively refused the connection. Further details of standard Java exceptions can be found in
indicate the problem.
java.net.ConnectException
Signals that an error occurred while attempting to connect a socket to a remote address and port. Typically, the connection was
Those more experienced with Java applications might look at the call stack itself to understand more about what the application was attemp
was attempting to run a database statement to validate certain settings at the beginning of the installation process. As with Ant
Knowledge Base.
Cause
Common causes of installation and upgrade failures fall into the following categories. Some of the categories might not be clear without an u
problem relates to.
• Launch Failures
• Validator Failures
• Properties Files
• Obsolete Files
• File System Failures
• Configuration Files
• Database Upgrade Failures
• Service Configuration Failures
• Service Start Failures
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kn... Page 11 of 16
Launch Failures
Problems with the Operating System, Java or the Installer file itself can cause problems when launching the installer.
Actions
• Avoid running with double-click on Windows. The version of Java associated with JAR files may differ from the one required
• You may be using the JRE instead of the JDK. The Windows installer for Java includes both the JDK and a separate client JRE install
installation and do not accidentally overwrite the JDK by choosing the same path.
• Check the version of Java that is on the path at the location you're installing Blackboard from:
• Ensure you're using a supported version of the JDK given the version of Blackboard. Check Supported Technologies on the
A JAR file is simply a zip file with a manifest meta-inf\Manifest.mf describing the Java class to be executed by default. When launchin
Actions
• Check the file with the jar utility or zip utility of your choice
• Attempt to download the file again. Use a download manager if connectivity is unreliable
• Verify the md5sum of the installer with Client Support
Further Reading
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kn... Page 12 of 16
Validator Failures
Property validators ensure that key installer properties are correct including TCP/IP port availability, hostname resolution, database connect
All property validators are run sequentially so depending on the cause of the failures, you may have several errors listed. Typically the first v
This indicates that the database host port was not connectible, so causes additional failures when attempting to check the system user and
the later errors. Failed values are typically logged, however to confirm exactly which values were checked during the validation process in
Port Validation
The port validator performs connectivity checks against configured TCP/IP port values. Before performing the connectivity checks, the hostn
connectivity checks for the following properties:
bbconfig.database.bbadmin.machine.portnumber 1433 for SQL Server, 1521 Oracle Checks host bbconfig.database.bbadmin.machine.fu
Port validator failures are not accompanied by exceptions, so in the event of a failure it's necessary to isolate the cause based on the
specifically related to SQL Server will throw exceptions, for instance:
Unable to connect to the database. Check the database configuration settings and passwords.
Validation failed for bbconfig.database.bbadmin.machine.systemuserpassword ("mysystempassword")
com.inet.tds.Tds4SQLException: [TDS Driver]java.net.ConnectException: Connection refused: connect
at com.inet.tds.aa.a(Unknown Source)
at com.inet.tds.TdsDriver.connect(Unknown Source)
at blackboard.db.schema.impl.DirectDataSource.getConnection(DirectDataSource.java:52)
..
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kn... Page 13 of 16
Example Failures
Actions
Further Reading
Property Purpose
bbconfig.database.bbadmin.db.password bbadmin user password, applies only to 'Upgrade and Convert' option
bbconfig.cs.db.systemuser.pass Oracle SYSTEM user or SQL Server SA user password, Content System insta
Example Failures
Unable to connect to the database. Check the database configuration settings and passwords.
Validation failed for bbconfig.database.bbadmin.machine.systemuserpassword ("mysystempassword")
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kn... Page 14 of 16
Actions - Oracle
• Check the failed login using Management Studio for SQL Server on the database host, ensure that you test the SQL Server Authentic
• Create a DSN using Administrative Tools\Data Sources (ODBC) on the application server and test the failed login
• View the SQL Server Logs in Management Studio under Management\SQL Server Logs, SQL Server login failures will return a gener
does not indicate the cause. The event in the logs will include the actual error state indicating the cause of the login failure.
8 Password mismatch
9 Invalid password
Further Reading
Understanding "login failed" (Error 18456) error messages in SQL Server 2005
Properties Files
• During the update of authentication.properties, only two LDAP servers properties will be preserved and Custom
Obsolete Files
This process doesn't typically cause problems at install time, however side-effects of this step include missing custom authentication compo
Actions
Refer to Client files disappeared after updating Blackboard for information on how this process works and how to prevent it
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kn... Page 15 of 16
Further Reading
Installation error - Arg list too long
Configuration Files
BUILD FAILED
/usr/local/blackboard/system/tooldefs/install/CoreClientInstall/production-installer.xml:77: The fol
/usr/local/blackboard/system/tooldefs/install/CoreClientInstall/tool.xml:170: The following error oc
/usr/local/blackboard/config/tomcat/build.xml:181: java.io.FileNotFoundException: Specified file doe
Actions
• Update the appropriate .classpath and .classpath.bb file to remove the entry or restore the file to it's previous location
Further Reading
Refer to Client files disappeared after updating Blackboard for information on obsolete file removal
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011
Installation and Upgrade Troubleshooting Guide (Printable, PDF) - Academic Suite Kn... Page 16 of 16
Reference
Copyright © 1997-2010. Blackboard Inc. All rights reserved. Blackboard, the Blackboard logo, BbWorld, Blackboard Learn, Blackboard Transact, Blackbo
ED are trademarks or registered trademarks of Blackboard Inc. or its subsidiaries in the United States and/or other countries. U.S. Patent Numbers: 6,988
http://kb.blackboard.com/display/KB/Installation+and+Upgrade+Troubleshooting+Guide+... 2/8/2011