Blackboard_Academic_.. - Arizona State University

Blackboard_Academic_.. - Arizona State University
Administrator Manual
Release 8
December 2007
Blackboard K–12 Academic Suite
Administrator Manual
Publication Date: December 2007
Worldwide Headquarters
International Headquarters
Blackboard Inc.
Blackboard International B.V.
1899 L Street, NW, 5th Floor
Washington, DC 20036-3861 USA
Dam 27 2nd Floor
1012 JS Amsterdam
The Netherlands
800-424-9299 toll free US & Canada
+1-202-463-4860 telephone
+31 20 5206884 (NL) telephone
+1-202-463-4863 facsimile
+31 20 5206885 (NL) facsimile
www.blackboard.com
global.blackboard.com
Blackboard, the Blackboard logo, Blackboard Academic Suite Suite, Blackboard Learning System,
Blackboard Learning System ML, Blackboard Community System, Blackboard Transaction System, Building
Blocks, and Bringing Education Online are either registered trademarks or trademarks of Blackboard Inc. in
the United States and/or other countries. Microsoft and Windows are registered trademarks of Microsoft
Corporation in the United States and/or other countries. Java is a registered trademark of Sun
Microsystems, Inc. in the United States and/or other countries. Macromedia, Authorware and Shockwave
are either registered trademarks or trademarks of Macromedia, Inc. in the United States and/or other
countries. Real Player and Real Audio Movie are trademarks of RealNetworks in the United States and/or
other countries. Adobe and Acrobat Reader are either registered trademarks or trademarks of Adobe
Systems Incorporated in the United States and/or other countries. Macintosh and QuickTime are registered
trademarks of Apple Computer, Inc. in the United States and/or other countries. WebEQ is a trademark of
Design Science, Inc. in the United States and/or other countries. JSpell is a trademark of The Solution Café
in the United States and/or other countries. Other product and company names mentioned herein may be
the trademarks of their respective owners. U.S. Patent No. 6,988,138. Patents pending.
© 2007 Blackboard Inc. All rights reserved. Made and printed in the USA.
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.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 2
Blackboard K–12 Academic Suite
Administrator Manual
Table of Contents
Table of Contents........................................................................ 3
About the Blackboard K-12 Suite Administrator Manual ............................................. 12
Classes ..................................................................................... 13
Updating Class Properties............................................................ 14
List and Modify Classes .................................................................................... 15
Search for Classes .......................................................................................... 16
Add Users to Class.......................................................................................... 17
List and Modify Users in Class ............................................................................ 18
Remove Users from Class ................................................................................. 19
Class Properties ............................................................................................ 20
Categorize Classes ......................................................................................... 23
Class Access Statistics ..................................................................................... 24
Class Recycler............................................................................................... 25
Class Quotas Override ..................................................................................... 26
Creating Classes and Enrolling Users .............................................. 27
Create Class ................................................................................................. 28
Class Creation Wizard ..................................................................................... 30
Class Creation Wizard - Class Information ............................................................. 32
Class Creation Wizard - Class Materials................................................................. 33
Class Creation Wizard - Class Design .................................................................... 34
Class Creation Wizard - Class Menu ..................................................................... 35
Class Creation Wizard – Availability and Duration .................................................... 36
Class Creation Wizard – Class Enrollment .............................................................. 38
Create a Template ......................................................................................... 39
Batch Create Classes....................................................................................... 40
Batch Enroll Users.......................................................................................... 42
Class Utilities ........................................................................... 44
Remove Class ............................................................................................... 46
Copy Class ................................................................................................... 47
Copy Class Materials into a New Class .................................................................. 48
Copy Class Materials into an Existing Class............................................................. 50
Copy Class with Users (Exact Copy) ..................................................................... 53
Import Class ................................................................................................. 55
Export / Archive Manager................................................................................. 58
Export Class ................................................................................................. 59
Archive Class ................................................................................................ 62
Restore Class................................................................................................ 64
Batch Import/Export/Archive/Restore Class .......................................................... 66
Batch Copy .................................................................................................. 68
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 3
Blackboard K–12 Academic Suite
Administrator Manual
Adding File Types for Use with Class Content Items.................................................. 70
Class Configuration Options ......................................................... 72
Set Default Class Properties .............................................................................. 73
Set Default Class Menu .................................................................................... 75
Class Menu and Tool Panel Display Options ............................................................ 76
Add New Area—Content Area............................................................................. 77
Add New Area—Tool Area ................................................................................. 78
Add New Area—Link Area ................................................................................. 79
Class Tools................................................................................................... 80
Class Role Rename ......................................................................................... 82
Class Disk Quotas ........................................................................................... 83
Grade Center Calculations ................................................................................ 84
Set Class Images ............................................................................................ 85
Select Icon Themes ........................................................................................ 87
Class Catalog............................................................................ 88
Manage Catalog............................................................................................. 89
Add or Modify Category ................................................................................... 90
Class Catalog Options...................................................................................... 91
Users ....................................................................................... 92
Users Accounts ......................................................................... 93
List and Modify Users ...................................................................................... 94
Unavailable and Disabled Records....................................................................... 95
User Properties ............................................................................................. 96
Customize User Profile .................................................................................... 98
Change Password ..........................................................................................100
View Class Information for a User ......................................................................101
Class and Organization Roles ............................................................................102
Create User.................................................................................................106
Batch Create Users........................................................................................108
Parents......................................................................................................110
Remove Users from the System .........................................................................112
Batch Remove Users from the System .................................................................113
Admin User Accounts Created at Install ...............................................................114
Institution Roles ......................................................................116
About Institution Roles ...................................................................................117
Features of Institution Roles ............................................................................118
Planning Institution Roles ................................................................................119
Create an Institution Role ...............................................................................121
Assign Institution Roles to Users ........................................................................122
Assign Institution Roles through Snapshot.............................................................124
Remove an Institution Role ..............................................................................125
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 4
Blackboard K–12 Academic Suite
Administrator Manual
Apply Institution Roles to Portal Features ............................................................126
System Roles...........................................................................127
About System Roles .......................................................................................128
System Role Privileges....................................................................................129
Apply System Roles to a User............................................................................130
Community Areas ...................................................................... 131
Tabs .....................................................................................133
Manage Tabs ...............................................................................................135
Add Module Tab ...........................................................................................137
Add Tool Tab...............................................................................................138
Add Link Tab ...............................................................................................139
Tab Properties .............................................................................................140
Modify Tab..................................................................................................141
Menu Column Properties .................................................................................142
Manage Hot Links Content ...............................................................................143
Add and Modify Hot Link Content.......................................................................144
Manage Hot Spots .........................................................................................145
Default Content ...........................................................................................147
Default Layout .............................................................................................148
Preview by Institution Role ..............................................................................150
Services .....................................................................................................151
Add/Modify Services Folder .............................................................................152
Add Services Link..........................................................................................153
Manage Modules.......................................................................154
Manage Modules ...........................................................................................156
Create a New Module .....................................................................................157
Module Properties .........................................................................................158
Login Module ...............................................................................................160
Module Contents: Login Module ........................................................................161
Class Creation Module ....................................................................................162
Discussion Board Creation Module ......................................................................163
Tutorial Modules...........................................................................................164
What's New? Module ......................................................................................165
My Classes Module.........................................................................................166
Module Contents: Class List Modules ...................................................................167
Channel Module............................................................................................168
HTML Module...............................................................................................169
URL Module.................................................................................................170
Multi-Section Module .....................................................................................171
Add/Modify Section to a Multi-Section Module .......................................................172
Opinion Poll Module.......................................................................................173
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 5
Blackboard K–12 Academic Suite
Administrator Manual
Module Contents: Multiple Choice Module ...........................................................174
Image Module ..............................................................................................175
External Link Module .....................................................................................176
Add or Modify Link to an External Link Module.......................................................177
Export Module .............................................................................................178
Channels................................................................................179
Manage Channels ..........................................................................................180
Brands...................................................................................181
Branding ....................................................................................................182
Manage Brands .............................................................................................183
Add Brand/Modify Brand Properties....................................................................184
Modify Brand Contents ...................................................................................185
Branding Modules and Tabs with Direct Access.......................................................187
Tool Panel ..............................................................................188
Manage Tool Panel ........................................................................................189
Add/Modify Tool...........................................................................................190
Add or Modify a Tool Panel for an External Link .....................................................191
Community System Settings ........................................................192
Sponsorship or Hotlinks...................................................................................193
Manage Hot Links..........................................................................................194
Add or Modify a Hot Link Tool...........................................................................195
Add or Modify External Link .............................................................................196
Primary Site Sponsor......................................................................................197
Customize Module Theme................................................................................198
Set Frame Size .............................................................................................199
System Management ................................................................... 200
Authentication and Integration ....................................................201
Authentication Configuration ...........................................................................202
Manage Context Encryption Keys .......................................................................203
Download the Context Encryption Key.................................................................204
Create a Context Encryption Key .......................................................................205
Deciphering Encrypted Context .........................................................................206
Integration Password .....................................................................................209
Reports .................................................................................210
Standard System Reports.................................................................................211
View Report ................................................................................................212
Advanced System Reporting .............................................................................213
Advanced System Reporting: Sample Templates ....................................................215
Advanced System Reporting Database Attributes ....................................................216
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 6
Blackboard K–12 Academic Suite
Administrator Manual
Auto-Reporting Options ..................................................................................237
Send System Statistics to Blackboard ..................................................................238
System Information ..................................................................239
About System Information ...............................................................................240
Registration Information .................................................................................241
System Performance Settings ...........................................................................242
Logs......................................................................................243
About Logs..................................................................................................244
Send System Logs..........................................................................................245
Download Individual System Logs.......................................................................246
Manage Log Rotation......................................................................................247
Log Descriptions ...........................................................................................249
Cartridge Import Status ..................................................................................250
System Tasks Status.......................................................................................251
Designate Local Support Contact .......................................................................252
System Tools ............................................................................ 253
Building Blocks ........................................................................254
Installing and Uninstalling Building Blocks ............................................................255
Manage Building Blocks...................................................................................257
Examine Building Block...................................................................................258
Download Building Blocks ................................................................................259
Install Building Block .....................................................................................260
The Open Standards Content Player ...................................................................261
System-wide Announcements and Events .......................................263
Announcements............................................................................................264
Add or Modify an Announcement .......................................................................265
Institution Calendar.......................................................................................266
Add/Modify Calendar Event .............................................................................267
Calendar Quick Jump .....................................................................................268
Email ....................................................................................269
Send Email..................................................................................................270
Email Users .................................................................................................271
Messages................................................................................272
Enable or Disable File Attachments and Private Folders............................................273
Text Box Editor and Spell Check ..................................................274
Manage Text Box Editor ..................................................................................275
About Spell Check .........................................................................................277
Manage Spell Check .......................................................................................278
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 7
Blackboard K–12 Academic Suite
Administrator Manual
Download Word List.......................................................................................279
Upload Word List ..........................................................................................280
System Discussion Boards ...........................................................281
About System Discussion Boards ........................................................................282
Manage Topic Users .......................................................................................283
Tools.....................................................................................284
About Tools.................................................................................................285
Manage Tools...............................................................................................286
Adaptive Release ..........................................................................................287
Performance Dashboard..................................................................................288
Review Status ..............................................................................................289
Chalk Titles ............................................................................290
About Chalk Titles.........................................................................................291
Manage Chalk Titles.......................................................................................292
Language Packs .......................................................................293
About Language Packs ....................................................................................294
Language Pack Availability ..............................................................................295
Import a Language Pack..................................................................................296
Export a Language Pack ..................................................................................297
Copy a Language Pack ....................................................................................298
Remove a Language Pack ................................................................................299
Language Pack Editor.....................................................................................300
Modify Language Pack ....................................................................................301
Set a Class Language Pack ...............................................................................303
Language Packs and the Gateway Page................................................................304
Enable JIS Encoding for Email (Japanese Language Pack) ..........................................305
Right-To-Left Language Packs...........................................................................306
Creating a Language Pack...........................................................310
Language Pack Planning..................................................................................312
Prerequisites ...............................................................................................313
Getting Started ............................................................................................315
Text Bundles ...............................................................................................317
Update the Manifest ......................................................................................322
Edit Language Settings ...................................................................................324
Images.......................................................................................................327
Edit Images .................................................................................................341
Image Troubleshooting ...................................................................................344
User Manuals ...............................................................................................345
Blackboard Backpack ................................................................347
Blackboard Backpack Availability.......................................................................348
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 8
Blackboard K–12 Academic Suite
Administrator Manual
Configure Blackboard Backpack.........................................................................349
Add Download Control....................................................................................350
Security .................................................................................. 352
Security Options ......................................................................353
SSL Choice ..................................................................................................354
Shibboleth Integration....................................................................................355
Customize the Login and Gateway Pages ........................................359
Login Page Customization................................................................................360
Gateway Page Customization ...........................................................................362
System Settings ............................................................................................363
Gateway Options ..........................................................................................365
Domains.................................................................................367
Introduction to Domains .................................................................................368
Structuring a Flexible and Secure Administration Model Using Domains .........................370
Create Domains............................................................................................374
Define a Collection........................................................................................375
Setup Domain Administrators ...........................................................................378
Blackboard Content System .......................................................... 379
Content .................................................................................380
Manage Content ...........................................................................................381
Web Folders ................................................................................................383
Copy Files to the Content Collection...................................................................385
Managing the Removal of Users and Classes ..........................................................389
Orphaned Content.........................................................................................390
Organizing Content...................................................................392
Organize Content in Folders .............................................................................393
Organize Folder Permissions.............................................................................395
Tools for sharing and finding content..................................................................396
Organize Class Content...................................................................................398
Organize Institution Folders .............................................................................400
Managing the Library ................................................................402
Library Contents...........................................................................................403
Managing eReserves.......................................................................................404
Librarians ...................................................................................................406
Portfolios ...............................................................................408
About Portfolios ...........................................................................................409
Manage Portfolios .........................................................................................410
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 9
Blackboard K–12 Academic Suite
Administrator Manual
Personal Portfolio Templates ...........................................................................411
Basic Portfolio Templates................................................................................412
Custom Metadata .....................................................................413
Manage Custom Metadata Fields........................................................................414
Add Metadata Field .......................................................................................415
Custom Metadata Set Properties........................................................................416
Display Options........................................................................417
Content List Display Options ............................................................................418
Menu Display Options .....................................................................................419
Manage Shortcut View ....................................................................................420
Shortcut Properties .......................................................................................421
Manage Folder View ......................................................................................422
Folder View Properties ...................................................................................423
Blackboard Content System Settings .............................................425
Virtual Hard Drive Settings ..............................................................................426
Default Folder Settings ...................................................................................427
Manage Default Folder Settings: /courses and /organizations.....................................428
Manage Default Folder Settings /users................................................................429
Feature and Tool Availability ...........................................................................430
Privacy Settings............................................................................................433
Copy Settings ..............................................................................................434
e-Reserve Setting .........................................................................................436
Manage User Lists .........................................................................................438
Content Area Availability ................................................................................439
Technical Settings ....................................................................440
Log Settings ................................................................................................442
Performance Settings.....................................................................................444
Manage Document Stores ................................................................................445
Manage Document Stores Document Store Name ...................................................446
JDBC Settings ..............................................................................................447
Storage Location ..........................................................................................449
Temporary Storage Settings .............................................................................450
Deletion Audit Trail Report ..............................................................................451
Deletion Audit Trail Settings ............................................................................452
Global Schema Settings ..................................................................................453
Bandwidth Properties.....................................................................................454
Bandwidth Restrictions ...................................................................................455
Bandwidth Restrictions: /Directory Name ............................................................456
Bandwidth Settings .......................................................................................457
Authentication Properties ...............................................................................458
Full Text Search Settings.................................................................................459
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 10
Blackboard K–12 Academic Suite
Administrator Manual
Blackboard Content System Information ..............................................................461
Customizing the User Interface....................................................462
Tools and Actions..........................................................................................463
System Availability and Display Options ...............................................................464
Folder and Shortcut Views ...............................................................................465
Managing Operations on the Action Bar ...............................................................466
Factors to consider during customization .............................................................467
eCommerce.............................................................................. 468
eCommerce Administration ........................................................469
Introduction to eCommerce .............................................................................470
Install eCommerce Features.............................................................................471
Setup eCommerce.........................................................................................472
eCommerce Roles .........................................................................................475
Reconciliation..............................................................................................476
Payment Gateway Reports...............................................................................478
eCommerce Reports ......................................................................................479
eMarketplace ..........................................................................481
Introduction to the eMarketplace ......................................................................482
eMarketplace Administration............................................................................484
Building the eMarketplace ...............................................................................486
Manage Orders .............................................................................................489
MyAccounts ............................................................................491
Introduction to My Accounts.............................................................................492
MyAccounts Modules ......................................................................................493
MyAccounts Administration ..............................................................................495
Card Numbers ..............................................................................................497
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 11
Blackboard K–12 Academic Suite
Administrator Manual
About the Blackboard K-12 Suite Administrator Manual
Overview
The Blackboard K-12 Suite Administrator Manual details the tools and functions accessible
through the Blackboard K-12 Suite’s Administrator Panel. Other Blackboard K-12 Suite manuals
detail the education features that Teachers, Students, and a wide variety of other users access
through Blackboard K-12 Suite. The advanced integration and data management features
available with the Blackboard Learning System are documented in the Blackboard Learning
System Advanced Integration and the Blackboard Learning System Data Management Manual.
Manual Organization
The Blackboard K-12 Suite Administrator Manual begins by introducing the Blackboard K-12
Suite. The rest of the manual is dedicated to the features available through the Administrator
Panel.
Manual Conventions
To make this manual easier to use a number of conventions have been put in place.
S ym b o l
Descript ion
Bold type
A button or field name.
Courier font
Text that users should type.
Steps
Tasks users should perform.
Italics in a title
Additional information in a title that may not be included on the Web page.
[r]
Required field
Using this manual
This manual should be read as a reference guide. Do not read this manual from cover to cover.
Manual Updates
Please note that this manual is updated periodically. Check the Date of Last Revision at the
beginning of the manual to ensure that it is the most recent copy.
The HTML version is available by clicking Online Admin Manual from the Control Panel and at
http //www.blackboard.com/products/services/support. This site also includes the manual in PDF
format. To report any comments or suggestions regarding this manual, please contact Blackboard
Support.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 12
Blackboard K–12 Academic Suite
Administrator Manual
Classes
Overview
The Classes features include the tools and functions available to Administrators for creating and
overseeing individual Classes as well as setting parameters for all Classes.
In this part
The following sections include information about Classes.
©
Chapt er
Descript ion
Updating Class Properties
This section reviews the options for administering a Class.
Creating Classes and
Enrolling Users
This section reviews the tools for creating Classes and
enrolling users.
Class Utilities
This section reviews the tools for reusing Classes and
making incremental backups.
Class Configuration Options
This section reviews the settings that can be applied to all
Classes.
Class Catalog
This section reviews management of the Class Catalog.
2007 Blackboard Inc. Proprietary and Confidential.
Page 13
Blackboard K–12 Academic Suite
Administrator Manual
Updating Class Properties
Overview
Administrators can change the settings, enrollments, and availability of an individual Class. All of
the features available to an Administrator to manage an individual Class are described in this
chapter.
In this chapter
Updating Class Properties includes the following topics.
©
T op i c
Descript ion
List/Modify
Classes
This topic covers the List/Modify Classes page. Select a Class from this
page to modify the Class Properties.
Search for a
Class
This topic describes the search function.
Add Users to
Class
This topic covers the Add Users to Class page. Administrators can enroll
users in the Class or assign staff to the Class from this page.
List/Modify
Users in Class
This topic covers the List/Modify Users in Class page. This page lists all the
users participating in the Class. From this page an Administrator can make
changes to the user account including the user’s role in the Class.
Remove Users
from Class
This topic covers the Remove Users from Class page. Use this page to
unenroll users from a Class.
Class
Properties
This topic covers the Class Properties page. From this page an
Administrator can change the name and description of a Class.
Categorize
Classes
This topic covers the Categorize Classes page. Administrators assign
Classes to categories in the catalog.
Class Access
Statistics
This Topic covers the Class Access Statistics page. Administrators can
view how the Class is being used.
Class Recycler
This topic covers the Class Recycler page. Recycling a Class removes
enrollments and other areas so that the same Class may be taught to a
new group of Students.
Class Quotas
Override
This topic covers the Class Quotas Override page. Administrators can set a
disk space limit for the Class from this page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 14
Blackboard K–12 Academic Suite
Administrator Manual
List and Modify Classes
Overview
Administrators can view sorted lists of Classes and select a Class to modify from the Classes
page. The search options at the top of the page are used to create a list of Classes based on the
defined parameters. After creating a list of Classes, click on the Class Link to enter Classes or
click Manage to modify the settings.
Class records that are set to Unavailable are preceded by a circle symbol with a slash through it.
Also, the record will appear in gray text. To make a record available, click Properties to modify the
user record and change the availability setting.
Class records may also be disabled in the database through the Snapshot tool. Disabled Class
records are preceded by a circle symbol with an ‘x’ through it. Like unavailable records, disabled
records will appear in gray text. For more information on the properties of disabled records,
please see the Blackboard Learning System Advanced Integration and Data Management
Manual.
Find the List/Modify Classes page
Click Classes on the Administrator Panel.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 15
Blackboard K–12 Academic Suite
Administrator Manual
Search for Classes
Overview
Administrators can search using different variables to search for Classes.
Search for a Class
The following search options are available for Classes
•
Course ID: Searches for strings that appear in the Course ID.
•
Class Name: Searches for strings that appear in the Class Name.
•
Description: Searches for strings that appear in the description of the Class.
•
Teacher: Searches for strings that appear in the Username of the Teacher.
These search values can be combined with a search for Classes based on creation date.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 16
Blackboard K–12 Academic Suite
Administrator Manual
Add Users to Class
Overview
Administrators enroll users in a Class from the Add Users to Class page. User access to the
Class is dependent on the availability of the Class. To add a Teacher, add the user from this page
and then change their user role through the List/Modify Users in This Class page.
Note: If enrolling a large number of users or enrolling users into numerous
Classes, consider using the Batch Enroll Users tool.
Find this page
Follow the steps below to open the Add Users to Class page.
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Enrollments.
5.
Click Enrollment.
Add users
Enter the Username and the Class Role for the user to enroll.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 17
Blackboard K–12 Academic Suite
Administrator Manual
List and Modify Users in Class
Overview
Administrators view users that participate in a Class and update user information from the
Enrollments page. Click Properties for a user to modify a profile or Class Role. Change a user
password by clicking Password. Send an email to a user by clicking on the user’s email address
in the Email column.
Find this page
Follow these steps to open the List/Modify Users in Class page.
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Enrollments.
Available functions
To use the functions available on the Enrollments page, follow the table below.
©
To . . .
click . . .
send an email to
a user
On the user’s email address. The email program associated with the
browser will open.
edit a user profile,
including
changing a
password
The Username. The User Management options for the user will appear.
This link navigates to the User Management section of the Admin Panel.
It is not possible to return directly to the Enrollments page. Please see
the section on Users for more information.
Change the user's
role in the Class
Modify.
2007 Blackboard Inc. Proprietary and Confidential.
Page 18
Blackboard K–12 Academic Suite
Administrator Manual
Remove Users from Class
Overview
Remove users from a Class from the Remove Users from Class page. Removed users can only
be restored to the Class by enrolling them again. To restore a removed user, enroll the user in the
Class from the Add Users to Class page.
Find this page
Follow these steps to open the Remove Users From Class page.
1.
Click List/Modify Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Properties for a Class.
4.
Click Remove Users from this Class.
Removing users
Click the check box for each user to be removed, type ‘Yes’ in the field at the bottom of the page,
and then click Submit. The selected users will be removed from the Class.
Note: This feature will only remove users’ enrollments from a Class. It will not
remove users from the Blackboard K-12 Suite.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 19
Blackboard K–12 Academic Suite
Administrator Manual
Class Properties
Overview
Change basic Class information from the Class Properties page.
Note: The Course ID does not appear on the Class Properties page as a field
that can be modified. Changing the Course ID of a Class will render all content in
the Class inaccessible. If a Class ID must be changed, use the Class Copy
feature or Export and Import Class features to move the Class content to a new
Class with the desired Course ID. After verifying that all necessary information
has transferred to the new Class, archive and then remove the old Class from the
system to avoid confusion with the new Class.
Find this page
Follow these steps to open the Class Properties page.
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Class Properties.
Fields
The table below details the fields on the Class Properties page.
F i e ld
Descript ion
Class Title/Description
Class Name
Edit the name of the Class.
Description
Edit the description of the Class. The description will appear in the
catalog listing with the Class Name and Course ID. A summary and
enrollment instructions are typical items that appear in Class
descriptions.
Class Classification
Subject Area and
Discipline
Select a subject area and discipline from the lists by clicking on the
drop-down arrows. The Subject Area and Discipline associate the Class
with research information available from the Blackboard Resource
Center. This is a deprecated feature from Blackboard 5 and has been
removed from the Create Class functions. A default value is listed when
each Class is created. The default value for Subject Area and Discipline
may only be changed on the Class Properties page. These fields
should not be used as metadata to describe the Class and can be
safely ignored by most users.
Availability
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 20
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Available
Select either Yes or No to make the Class available to users. If the
Class is set to available, all users participating in the Class will have
access. If the Class is set to unavailable, access is determined by Class
Role. Only users with privileges to access the Control Panel may see
the contents of an Unavailable Class.
Available to
Guests
Click Yes to make the Class available to Guests.
Duration
Continuous
Select this option to make the Class always available.
Select Dates
Select this option to set the Class availability for specific dates. The
Class may also begin on a specific date and not have a specific end
date.
After the end date, the Class is no longer available for Students but is
otherwise unchanged.
Days from the date of
Enrollment
Select this option to place a time limit on a self-paced Class. The Class
will be available for that number of days from the time a Student enrolls.
Banner
Current Banner
Displays the banner that currently appears at the top of the Class.
New Banner
Image
Enter a file name or browse for an image file. This file will appear on the
Class.
Remove this
Banner
Click this check box to remove the banner image from the Class. No
banner will appear at the top of the Class.
Course Cartridge
Download Key
Add a Course Cartridge key to add content to the Class from a Course
Cartridge. Course Cartridges are learning content provided by
publishers.
Enrollment Options
Teacher / System
Administrator
Select this option to make Class enrollment Teacher or Admin led.
Select the check box to create a link for Students to email an enrollment
request to the Teacher. The link appears in the Class catalog.
Allow Students to
email enrollment
requests
Select this option to allow Students to enroll in a Class.
Start Date
Select this option to set an enrollment start date. If Self Enrollment is
selected this date is required.
End Date
Select this option to set an enrollment end date. If Self Enrollment is
selected this date is required.
Require Access
Code
Select this option to require an access code to enroll. Enter an access
code that must then be distributed to approved Students. This access
code will be required for Students to enroll in the Class.
Language Pack
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 21
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Language Pack
Select a Language Pack from the drop-down list. If a Language Pack is
not chosen for a Class the Class will display in the user’s preferred
Language Pack or, if the user has not set a preferred Language Pack,
in the system default Language Pack.
Enforce
Language Pack
Check Enforce Language Pack to force all users in the Class to view
the Class Language Pack.
Menu Design
©
Text
If Text is selected, the text color and the background color can be
changed. Text is the often the choice for accessibility reasons.
Buttons
If Buttons are selected, the shape, style and color of the buttons can
be changed.
2007 Blackboard Inc. Proprietary and Confidential.
Page 22
Blackboard K–12 Academic Suite
Administrator Manual
Categorize Classes
Overview
Attach and remove categories from the Class using the Categorize Classes page. Once a
category has been linked to a Class, the Class will appear under that category in the Class
Catalog.
Find this page
Follow these steps to open the Categorize Classes page.
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Categorize Class.
Select Categories
Use the multi-select box to move the categories that should be assigned to the Class to the rightside column. Click Submit when finished. For more information on Class Categories, please see
the Class Catalog chapter.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 23
Blackboard K–12 Academic Suite
Administrator Manual
Class Access Statistics
Overview
View usage information about a Class from the Class Access Statistics page. For reports on
system usage use the System Reports feature.
The Enable Event Tracking option must be set to Yes on the Auto-Reporting Options page before
Statistics will be recorded.
Note: The data set for any report is limited to 100,000 hits.
Find this page
Follow the steps below to open the Class Access Statistics page.
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Class Access Statistics.
Fields
The table below details the fields on the Class Access Statistics page.
F i e ld
Descript ion
Select Report Filter
Select Report
Select a section of the Class from the drop-down list. The report
generated will detail the usage of the selected section.
Time Period
Choose the Between the Following Dates option to view data for a
time period.
Users
Click All Users or Selected Users. If choosing Selected Users,
highlight the users to include in the report. To select multiple users,
hold down CONTROL and click on each Username.
Options
©
Do You Wish to
Refresh the Dataset
Click Yes to gather the most recent data for the report. Click No to
use data from the date and time listed.
What Information
do you Want to
Display
Click the check boxes to include particular data in the report.
2007 Blackboard Inc. Proprietary and Confidential.
Page 24
Blackboard K–12 Academic Suite
Administrator Manual
Class Recycler
Overview
The Recycle Class page is a useful tool to use when a Class ends and will be taught again to
another group of Students. The Recycle Class page allows Administrators to select information to
be deleted from a Class.
Example: Click in the box next to Grade Center and all the names of Students and their Grades
will be deleted from the Class. The Teacher will have a clean Grade Center to start the new
semester.
The Class Recycler will remove all users with a role of Student from the Class. Teaching
Assistants, Graders, and Class Builders will not be removed.
Recycle Class page
Follow these steps to open the Recycle Class page.
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Recycle Class.
Fields
The table below details the fields on the Recycle Class page.
F i e ld
Descript ion
Select Content Materials to Remove
Content Area
Select the check box for each Class Area that will be recycled. The
content in each area will be removed but the Class Area will remain a
part of the Class.
Select Other Class Materials to Remove
©
Announcements
Select Announcements to delete all Class Announcements.
Discussion Board
Select Discussion Board to delete the Discussion Topics.
Dropbox
Select Dropbox to delete any items in the Teacher’s Dropbox.
Grade Center
items
Select Grade Center to delete the Grade Center items for the Class.
Groups
Select Groups to delete groups.
Statistics
Select Statistics to delete information on Student usage.
Tests, Surveys, &
Pools
Select this check box to delete the assessments in the Class.
Users
Select Users check box to delete the Student enrollments from the
Class.
2007 Blackboard Inc. Proprietary and Confidential.
Page 25
Blackboard K–12 Academic Suite
Administrator Manual
Class Quotas Override
Overview
Change the disk quotas for a Class from the Class Quotas Override page. The quotas set on this
page will apply to the Class regardless of the default quota settings for the Blackboard system. To
change or set quotas for all Classes on the system, use the Quota tool.
Class Quotas Override page
Follow these steps to open the Class Quotas Override page.
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Class Quotas Override.
Fields
The table below details the fields on the Class Quotas Override page.
F i e ld
Descript ion
Control Class Disk Quotas
©
Override default Disk Quotas
for this Class
Click this check box to place restrictions on the size of the
Class.
Warn Teachers when Class
size exceeds
Enter an amount of disk space in Kilobytes. The Teacher
will receive a warning that the Class is approaching the
disk space limit.
Maximum Class disk Usage
Enter a disk space limit in Kilobytes.
Override default for
maximum size of a single file
upload to
Click this check box and enter a size limit in Kilobytes for
files uploaded to the Class.
2007 Blackboard Inc. Proprietary and Confidential.
Page 26
Blackboard K–12 Academic Suite
Administrator Manual
Creating Classes and Enrolling Users
Overview
This section covers the features for creating a Class and enrolling Students and assigning staff.
In this section
The following topics exist to help create Classes and enrolling users.
©
T op i c
Descript ion
Create Class
This topic covers the Create Class page. Administrators can create
a Class from this page.
Class Creation Wizard
This topic covers the Class Creation Wizard. Administrators can
use the wizard to create Classes instead of the Create Class page.
Class Creation Wizard:
Class Information
This topic covers the Class Information page in the Class Creation
Wizard.
Class Creation Wizard:
Class Materials
Class This topic covers the Class Materials page in the Class
Creation Wizard.
Class Creation Wizard:
Class Design
This topic covers the Class Design page in the Class Creation
Wizard.
Class Creation Wizard:
Class Menu
This topic covers the Class Menu page in the Class Creation
Wizard.
Class Creation Wizard:
Availability and
Duration
This topic covers the Availability and Duration page in the Class
Creation Wizard.
Class Creation Wizard:
Class Enrollment
This topic covers the Class Enrollment page in the Class Creation
Wizard.
Create a Template
This topic covers the Create a Template page. Administrators may
create templates for users who are creating Classes.
Batch Create Classes
This topic covers the Batch Create Classes page. Administrators
can create many Classes at once by uploading a batch file.
Batch Enroll Users
This topic covers the Batch Enroll Users page. Administrators can
enroll many Students and assign many staff into many different
Classes by uploading a batch file.
2007 Blackboard Inc. Proprietary and Confidential.
Page 27
Blackboard K–12 Academic Suite
Administrator Manual
Create Class
Overview
Create a Class from the Create Class page. If an Administrator disabled the Create Class
function for Teachers or requires Teachers to submit email requests for Class creation, this is the
only way new Classes can be created.
Note: Administrators can assign the Administrative User Role of Class Creator to
certain users. Users with these privileges can access the Create Class function
on the Administrator Panel. This is helpful if Teachers are not allowed to create
Classes and the Administrator cannot respond quickly to requests for new
Classes.
Find this page
Select Create Class from the drop-down list on the Classes page.
Fields
The table below details the fields on the Create Class page.
F i e ld
Descript ion
Class Information
Class Name
Enter a name for the Class.
Course ID
Enter a Class ID. The Course ID should not have any spaces or
characters other than numbers and letters, dash (-), underscore (_), and
period (.). Do not use special characters. Special characters include
%&#<>=+ as well as spaces. When creating attributes a good rule to
follow is only use alphanumeric characters, underscores, dots, and
dashes.
The Course ID must be unique and remain static. It cannot be modified.
Description
Enter a description of the Class. The description will appear in the
catalog listing. A summary and enrollment instructions should be
included in the description.
Class Design
Select
background
color for
navigation
Click Pick to select a color from the palette. The color selected will
appear as the background to the Class Menu.
Select highlight
color for
navigation
Click Pick to select a color from the palette. The color selected will
appear as the text color in the Class Menu.
Class Options
Guest Access
©
Click Yes to make the Class available to guests.
2007 Blackboard Inc. Proprietary and Confidential.
Page 28
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Available
Click Yes or No to control the Class availability.
Select Class
Catalog
Category
Select a Class Catalog category for the Class. The Class will be listed
under the selected categories.
Course
Cartridge
Enter a valid Access Key to download Class materials from a Course
Cartridge to the new Class.
Teacher
Enter the name of the Teacher for this Class. The Teacher named will be
able to customize the Class through the Class Control Panel. Clicking
New Teacher will bring up the Create New User page after clicking
Submit at the bottom of the page.
Class availability
The following table describes what type of access different user roles have to a Class that is
unavailable
©
C la ss R ol e
A c ces s w he n C las s is un a va i l ab l e
Students
The Class is not available to Students.
Teachers, Class Builders,
Teaching Assistants, and
Graders
Classes set to Unavailable will appear to the user. The
Class will be indicated as Unavailable, but will still be
accessible.
2007 Blackboard Inc. Proprietary and Confidential.
Page 29
Blackboard K–12 Academic Suite
Administrator Manual
Class Creation Wizard
Overview
The Class Creation Wizard enables users to create Classes through an easy workflow. The
Wizard consists of a series of pages that breaks up the numerous aspects of Class creation into a
sequence of manageable pieces. Teachers can use the wizard to complete the initial setup of a
Class in one easy-to–follow process.
Note: Organizations may not be created through this method.
Find this page
To open the Class Creation Wizard, select Class Creation Wizard from the drop down list on the
Classes page.
Wizard navigation
Users may use the links at the bottom of each Wizard page to navigate within the Wizard. These
links include options for Cancel, Back, Next, and Finish. All links may not be available on all
pages within the Wizard.
Wizard Progress Tracker
The Wizard Progress Tracker appears on the left side of each page in the Wizard and represents
the entire workflow of the Class Creation Wizard. Users can view where they are in the workflow
as they build a Class. There are no navigation options in the Wizard Progress Tracker.
Wizard steps
The Welcome page gives an overview of the different steps for creating a Class through the
Class Creation Wizard. Users may choose to skip some of these steps.
Note: If the user skips steps in the Wizard, these options will automatically be
set to the system defaults. These settings may be modified through the Class
Control Panel once the Class is created.
The following list includes all of the steps for creating a Class
©
S e ct io n
Descript ion
Class Information
Enter Class information, such as Class Name, Course ID, and a
description of the Class.
Class Materials
Select a template, Course Cartridge, or an existing Class to use as the
basis of the Class, or create a new Class.
2007 Blackboard Inc. Proprietary and Confidential.
Page 30
Blackboard K–12 Academic Suite
©
Administrator Manual
S e ct io n
Descript ion
Class Design
Design the buttons and text for the Class
Class Menu
Add or remove options that appear on the Class Menu.
Availability and
Duration
Select which users this Class will be available to.
Enrollment
Options
Select how users will be enrolled the Class.
2007 Blackboard Inc. Proprietary and Confidential.
Page 31
Blackboard K–12 Academic Suite
Administrator Manual
Class Creation Wizard - Class Information
Overview
The Class Creation Wizard consists of a series of pages that breaks up the numerous aspects of
Class creation into a sequence of manageable pieces. The user enters Class details, such as the
Title and Course ID on the Class Information page.
Fields
The table below details the fields on the Class Information page
F i e ld
Descript ion
Class Information
Class
Name
Enter a name for the Class.
Course ID
Enter a unique Course ID. The Course ID should not have any spaces or
characters other than numbers and letters, dash (-), underscore (_), and
period (.). Do not use special characters. Special characters include
%&#<>=+ as well as spaces. When creating attributes a good rule to follow is
only use alphanumeric characters, underscores, dots, and dashes.
Description
Enter a description of the Class. The description will appear in the listing with
the Class Name and ID. A summary and enrollment instructions should be
included in the description.
Note: If the user returns to this page after the Class has been created, he or she
will see a read-only view of this page. The data in these fields may not be
changed after the wizard is complete.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 32
Blackboard K–12 Academic Suite
Administrator Manual
Class Creation Wizard - Class Materials
Overview
The Class Creation Wizard consists of a series of pages that breaks up the numerous aspects of
Class creation into a sequence of manageable pieces. The Class Content page allows the user to
choose a template, an existing Class, or a Course Cartridge as the basis for the new Class.
Users may also choose to create an entirely new Class.
Fields
The table below details options on the Class Content page
©
F i e ld
Descript ion
Create an
entirely new
Class.
Select this option to create a Class that is not based on an existing Class,
template or Course Cartridge.
Create a Class
using a
Template
Select this option to create a Class using a Class Template in the system.
Template dropdown list
A list of Class Templates available in the Blackboard system. Select a
template to use for this Class. When a template is used, all of the Class
content in the template Class is copied to the new Class. The Teacher
may change Class settings and Class content in the destination Class
once they have completed the Wizard.
Create a Class
from an
existing Class
Select this option to create the Class by copying an existing Class.
Class dropdown list
A list of Classes in which the user is a Teacher, TA or Class Builder.
Select the Class to copy to create this new Class. Only the Class content
(not user data) will be copied from the existing Class into the new Class.
The Teacher may modify the Class content in the destination Class.
Create the
Class using a
Course
Cartridge
Select this option to create a Class using a Course Cartridge.
Course
Cartridge
Teacher
Download key
Enter the download key for the Course Cartridge.
2007 Blackboard Inc. Proprietary and Confidential.
Page 33
Blackboard K–12 Academic Suite
Administrator Manual
Class Creation Wizard - Class Design
Overview
The Class Creation Wizard consists of a series of pages that breaks up the numerous aspects of
Class creation into a sequence of manageable pieces. Teachers select the appearance of a
Class on the Class Design page.
Fields
The table below details the fields on the Class Design page.
F i e ld
Descript ion
Select a Navigation Style
Navigation
Style
Select Buttons to make the areas of the Class Menu appear in a button
format.
Select Text Navigation to make areas of the Class Menu appear in a text
format.
Select a Button Style
When the Button Navigation Style is chosen an additional set of functions must be defined. The
table below details the fields on the Select Style Properties section for buttons.
F i e ld
Descript ion
Select Style Properties
Button Type
Choose the Button Type from the drop-down list.
Button Shape
Click an option to choose the Button Shape.
Button Style
Use the drop-down list to select the color of the buttons.
Click Gallery of Buttons to view all of the button options.
Select Text Navigation Colors
When the Text Navigation Style is chosen an additional set of functions must be defined. The
table below details the fields on the Select Style Properties section for text.
F i e ld
Descript ion
Select Style Properties
©
Select background color for
navigation
Click Pick and select a background color for the
Class Menu.
Select a highlight color for the
navigation
Click Pick and select a color for the text in the Class
Menu.
2007 Blackboard Inc. Proprietary and Confidential.
Page 34
Blackboard K–12 Academic Suite
Administrator Manual
Class Creation Wizard - Class Menu
Overview
The Class Creation Wizard consists of a series of pages that breaks up the numerous aspects of
Class creation into a sequence of manageable pieces. The Class Menu page allows the user to
choose which options will appear in the Class Menu.
Functions
Is the user selected to create a new Class they may add and remove items on the Class Menu. If
the user selected an option to use a template, an existing Class or a Course Cartridge on the
Class Content page, he or she will be unable to modify the Class Menu. The Class Menu is
automatically copied from the existing Class, template or cartridge. Users can modify the Class
Menu after the Class is created from the Class Control Panel.
Adding a menu item creates a Content Area with a name specified by the user. New Content
Areas are automatically available to Students, and unavailable to Guests and Parents.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 35
Blackboard K–12 Academic Suite
Administrator Manual
Class Creation Wizard – Availability and Duration
Overview
The Class Creation Wizard consists of a series of pages that breaks up the numerous aspects of
Class creation into a sequence of manageable pieces. The Availability and Duration page is used
to control access to the Class and the Class duration.
Fields
The table below details options on the Availability and Duration page
F i e ld
Descript ion
Guest Access
Guest Access
Select either Yes or No to make the Class available to Guests.
Class Availability
Availability
Select either Yes or No to make the Class available to users. If the Class
is set to available, all users participating in the Class will have access. If
the Class is set to unavailable, access is determined by Class Role.
Classes that are unavailable will not appear in the Class Catalog.
Class Duration
Continuous
Select this option to make the Class continuously available. If this option
is selected the Class will always be available.
Select Dates
Select this option to set the Class availability for a specific number of
days. Use the drop down list to select the starting and ending dates of
the Class or click the calendar icon to select dates from the calendar
interface. The Class may also begin on a specific date and not have a
specific end date.
After the end date, the Class is no longer available for Students but is
otherwise unchanged. Students who attempt to login to the Class are told
that the Class has ended.
Days (from the
date of
enrollment)
Select this option to place a time limit on a self-paced Class. The Class
will be available for that number of days from the time a Student enrolls.
For example, if the number of days is set to 10, the Class will be
available for 10 days to each Student who enrolls.
Class Role availability
The following table describes what type of access different user roles have to a Class that is
unavailable
C la ss R ol e
©
A c ces s w he n C las s is un a va i l ab l e
2007 Blackboard Inc. Proprietary and Confidential.
Page 36
Blackboard K–12 Academic Suite
©
Administrator Manual
C la ss R ol e
A c ces s w he n C las s is un a va i l ab l e
Students
Classes set to Unavailable will not appear at all in the Student’s My
Classes module on the My Institution tab, or in the Student’s Class List
on the Classes tab. Students may not access a Class that is set to
unavailable.
Teachers
Classes set to Unavailable will appear in the Classes you are teaching
section of the My Classes module and in the Class List on the Classes
tab. The Class will be indicated as Unavailable, but will still be accessible
by the Teacher.
Class Builders
and Teaching
Assistants
Classes set to Unavailable will appear in the Classes in which you are
participating section of the My Classes module and in the Class List on
the Classes tab. The Class will be indicated as Unavailable. The Class is
still accessible by Class Builders and Teaching Assistants.
Graders
Classes set to Unavailable will appear in the Classes in which you are
participating section of the My Classes module and in the Class List on
the Classes tab. The Class will be indicated as Unavailable to others but
is accessible by Graders.
2007 Blackboard Inc. Proprietary and Confidential.
Page 37
Blackboard K–12 Academic Suite
Administrator Manual
Class Creation Wizard – Class Enrollment
Overview
The Class Creation Wizard consists of a series of pages that breaks up the numerous aspects of
Class creation into a sequence of manageable pieces. Teachers set the enrollment process for a
Class from the Class Enrollment page. Enrollment can also be limited to a set time and to those
Students that receive approval and are granted an access code.
Fields
The table below details the fields on the Class Enrollment page.
F i e ld
Descript ion
Select Enrollment Options
Teacher/Admin
Select this option to make Class enrollment Teacher and Administrator
led. Select the check box to create a link for Students to email an
enrollment request to the Teacher. The link appears in the Class
catalog.
Self Enrollment
Select this option to allow Students to enroll in a Class as determined
by the limits defined in the starting date, ending date, and access
code.
Select Enrollment Options
©
Start Date
Select this option to set an enrollment start date. Choose an
enrollment start date by clicking the drop-down arrow and selecting
date values or click the calendar icon to select a date from the
calendar interface. If Self Enrollment is selected this date is required.
End Date
Select this option to set an enrollment end date. Choose an enrollment
end date by clicking the drop-down arrows and selecting date values
or click the icon to select a date from the calendar interface. If Self
Enrollment is selected this date is required.
Require Access
Code to Enroll
Select this option to require an access code to enroll. Enter an access
code that will be distributed to approved Students. If selected, this
access code will be required for Students to enroll in the Class.
2007 Blackboard Inc. Proprietary and Confidential.
Page 38
Blackboard K–12 Academic Suite
Administrator Manual
Create a Template
Overview
Creating a template to use as the basis of other Classes is as simple as creating and designing a
Class. After creating and designing a Class, use the Template Options page to designate the
Class as a template. To apply a template when creating a Class, use the Class Creation Wizard
to generate the Class.
Find this page
Follow these steps to open the Template Options page.
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Class Template Options.
Fields
The fields on the Template Options page are detailed in the table below.
F i e ld
Descript ion
Select Template Option
©
Use this Class as a
Class Template
Select this option to enable this Class as Class Template when
using the Class Creation Wizard.
Do not use this Class
as a Class Template
Select this option to prevent the Class from appearing in the list of
templates when using the Class Creation Wizard. This option is the
default.
2007 Blackboard Inc. Proprietary and Confidential.
Page 39
Blackboard K–12 Academic Suite
Administrator Manual
Batch Create Classes
Overview
Add large numbers of Classes from the Batch Create Classes page. Using a batch file, Classes
are entered into the Blackboard system quickly and without having to go through the Create
Class page to add each Class.
Note: Verify that the fields are in the correct order for the current version. If
necessary, rearrange the fields before processing the batch file.
Find this page
Click Batch Create Classes from the drop down list on the Classes page.
Fields
The table below details the fields on the Batch Create Classes page.
F i e ld
Descript ion
File Upload
File
Location
Enter the location of the batch Class file. Click Browse to open up the file
directory then locate and select the file.
File
Delimiter
Select the file delimiter used in the batch Class file. If Automatic is selected,
the batch file will be analyzed and the delimiter determined based on the
frequency of the character in the file.
Default
Button
Style
Select a default button style from the drop-down list. This style will appear in
all Classes that do not have a button style in their record.
Creating a batch file of new Classes
Batch files are .delimited files holding large quantities of new Classes. Batch files cannot contain
any Class content other than one announcement.
Batch Class files must contain a Class ID and Class Name, and may also contain a Class
Description, Button Style, and Initial Announcement, appearing in the following format
“Course_ID”,”Class Name”,”Class Description”,”Button_Style”, ”announcement”, “announcement
title”
The following rules apply to batch Class files
©
•
Fields must be enclosed in double quotes. Example “Eng_201”
•
Each field must be separated with a delimiter. Commas, colons, or tabs may be used,
however, you may not use more than one as a delimiter in a batch file. Example
“Eng_201”,”English Literature”
2007 Blackboard Inc. Proprietary and Confidential.
Page 40
Blackboard K–12 Academic Suite
Administrator Manual
•
Each record must be separated by a hard return. Example “Eng_201”,”English
Literature””ENG_202”,“Transcendentalist Works”
•
Each batch file should not exceed 500 records due to time out restrictions associated
with most browsers.
•
Do not include blank lines between records. The blank line will be processed and return
an error.
When files are created for batch loading, regardless of language pack or computer operating
system, the following header fields must be in ASCII (American Standard Code for Information
Interchange) characters:
•
Any Boolean field (Y/N, T/F)
•
Any ID such as Course ID or Organization ID
•
Username
•
Email address
Header fields may contain any ASCII alphanumerical characters, underscores “_”, dots “.”, and
dashes “-”.
Headers fields cannot contain the following special characters: %, &, *, #, >, <, +, =
All data contained in these fields must also be in ASCII characters and the same rules for
acceptable characters apply.
Using special characters
The following special characters should never be used in an attribute such as a User Name,
password, database user, Course ID, and so forth.
%&#<>=+
These characters are only safe to use when adding content into a text box, such as adding the
description for a Class.
When creating attributes a good rule to follow is to only use alphanumeric characters,
underscores, dots, and dashes (do not use spaces!).
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 41
Blackboard K–12 Academic Suite
Administrator Manual
Batch Enroll Users
Overview
Enroll large numbers of users into Classes from the Batch Create Users page. A batch file for
adding users can add many users into many different Classes. If a Class Role is not assigned in
the batch file the default value is Student.
Note: If using a batch file created for a previous version of Blackboard K-12
Suite, verify that the fields are in the correct order for the current version. If
necessary, reformat the file so that the fields are in the correct order before
processing the batch enroll.
Find this page
Click Batch Enroll Users from the drop down list on the Classes page.
Fields
The table below details the fields on the Batch Enroll Users page.
F i e ld
Descript ion
File Upload
File Location
Enter the location of the batch user file.
Delimiter
Type of Your
File
Select the delimiter option to be used on the batch user file entered in the
File Location field. If Automatic is selected, the batch file will be analyzed
and the delimiter determined based on the frequency of that character in
the file.
Create batch file
Batch files are .txt files that hold large quantities of information to upload to the Blackboard
system. Note the following when creating a batch file
©
•
If quotation marks appear in a field, it is necessary to use an escape character so the
process knows that the next character does not mark the end of the field. The escape
character is a backslash (\). For example, "\"NICKNAME\"".
•
Fields must be enclosed in double quotes. Example “John”
•
Each field must be separated with a delimiter. Commas, colons, or tabs may be used,
however, you may not use more than one as a delimiter in a batch file. Example
“John”,”Smith”
•
Each record must be separated by a hard return. Example “John”,”Smith”
“Larry”,”Smith”
•
Each batch file should not exceed 500 records due to time out restrictions associated
with most browsers.
2007 Blackboard Inc. Proprietary and Confidential.
Page 42
Blackboard K–12 Academic Suite
Administrator Manual
•
Do not include blank lines between records. The blank line will be processed and return
an error.
When files are created for batch loading, regardless of language pack or computer operating
system, the following header fields must be in ASCII (American Standard Code for Information
Interchange) characters:
•
Any Boolean field (Y/N, T/F)
•
Any ID such as Course ID or Organization ID
•
Username
•
Email address
Header fields may contain any ASCII alphanumerical characters, underscores “_”, dots “.”, and
dashes “-”.
Headers fields cannot contain the following special characters: %, &, *, #, >, <, +, =
All data contained in these fields must also be in ASCII characters and the same rules for
acceptable characters apply.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 43
Blackboard K–12 Academic Suite
Administrator Manual
Class Utilities
Overview
This section reviews the features for deleting, moving, and backing up Classes.
In this section
Class Utilities includes the following topics.
©
T op i c
Descript ion
Remove Class
This topic covers the Remove Class page that Administrators
use to remove a Class.
Copy Class
This topic covers the Copy Class page used to add content from
one Class to another.
Copy Class Materials into
a New Class
This topic covers the Copy Class Materials (but not users) into a
New Class page. This page is used to create a new Class with
content from another Class.
Copy Class Materials into
an Existing Class
This topic covers the Copy Class Materials (but not users) into
an Existing Class page. This page is used to add content from
one Class into another.
Class Copy with Users
(Exact Copy)
This topic covers the Class Copy with Users (Exact Copy) page.
This page is used to create a duplicate Class including users
and enrollments.
Import Class
This topic covers the Import Class page used to add a package
containing an exported Class from this page.
Export / Archive Manager
This topic covers the Export / Archive Manager page. This page
is used to Export and Archive Classes, as well as to access
Class packages once they have been created through these
operations.
Export Class
This topic covers the Export Class page used to create a
package of Class content for use at a later time.
Archive Class
This topic covers the Archive Class page used to create an
incremental backup of a specific Class.
Restore Class
This topic covers the Restore Class page used to add a package
of an archived Class to the system from this page.
Batch
Import/Export/Archive/
Restore Class
This topic covers the command line tool for batch
import/export/archive/restore operations.
Batch Copy Class
This topic covers the command line tool for batch copying
Classes.
Adding File Types for Use
with Content Items
This topic covers the recognized file types for attachments to
Content Items and how Administrators can add additional
recognized file types.
2007 Blackboard Inc. Proprietary and Confidential.
Page 44
Blackboard K–12 Academic Suite
Administrator Manual
What is the difference between export, archive, copy, and recycle for a Class?
The Blackboard K-12 Suite includes several tools for reusing Classes and Class content. The
tools are:
©
•
Export/Import: Export takes Class content and puts it in a package that can be used in
another Class at a later date. One or more Class areas can be included in the package.
This is an effective means of reusing a Class or parts of a Class to teach another set of
Students next semester or for backing up content without keeping Student interactions.
•
Copy: Class Copy adds content from one Class to another. This is useful when teaching
the same Class during the same term to different sets of Students. Class Copy is the
best way to share content across multiple sections of the same Class.
•
Recycle: Recycling a Class removes User interactions with the Class while keeping the
content intact. This is useful when teaching the same Class to a new set of Students.
•
Archive/Restore: The Archive Class function creates a record of the Class including
User interactions. It is most useful for recalling Student performance or interactions at
later time. The archive package is saved as a .ZIP file that can be restored to the
Blackboard system at another time. In effect, Archive/Restore acts as a backup tool at
the individual Class level (although it is not a replacement for a fully formed, server-side
backup and restore process!).
2007 Blackboard Inc. Proprietary and Confidential.
Page 45
Blackboard K–12 Academic Suite
Administrator Manual
Remove Class
Overview
Classes can be removed from the Blackboard K-12 Suite through the Classes page. Classes that
are removed cannot be restored to the Blackboard K-12 Suite Blackboard Learning System
unless the Class was archived or exported prior to removing it.
Keep in mind that archiving a Class will preserve not only Class content but also user enrollments
and interactions with the Class. For information on archiving a Class prior to removing it from
Blackboard Learning System, see the Archive Class topic.
Remove a Class
Follow these steps to remove a Class:
©
1.
Click Classes on the Administrator Panel.
2.
Search for a Class or Classes.
3.
Select the Classes to be deleted. Classes that show a check in the box next to the Class
will be removed.
4.
Click Remove.
2007 Blackboard Inc. Proprietary and Confidential.
Page 46
Blackboard K–12 Academic Suite
Administrator Manual
Copy Class
Overview
Copy Class can be used in several different ways
•
Copy selected Class materials into a new Class to create a new section of the same
Class.
•
Copy selected Class materials into an existing Class to share content across several
Classes without having to recreate the content in each Class.
•
Copy just enrollments (or enrollments and selected content and tools) to easily move
users from one sequential Class to the next Class.
•
Create an exact copy of a Class, including enrollments and Student interactions.
Find this page
Click Classes on the Admin Panel. Select Copy Class from the drop down list and click Go.
Available functions
The following functions are accessible from the Copy Class page.
To . . .
click . . .
Copy some or all of the Class materials into a new
Class
Copy Class Materials into a New Class
Copy some or all of the Class materials into an
existing Class
Copy Class Materials into an Existing
Class
Make an exact copy of the Class including enrollments Copy Class with Users (Exact Copy)
Content Collection items
When a Class is copied, links to Content Collection items within the Class are included.
If options on the Copy Setting page are enabled, the permissions for Content Collection items
located in almost all Class areas will be automatically updated.
The one exception to this is Assessments. The permissions for Content Collection items linked to
in Tests, Surveys, and Questions Pools are not automatically updated. The Teacher must update
the permissions to these items manually through the Content Collection.
When the items that are linked to in the Class are viewed in the Content Collection, Read
permission will appear for All Class Users.
Note: The Copy Settings page is located in Administrator Panel > Settings
(under the Blackboard Content System section).
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 47
Blackboard K–12 Academic Suite
Administrator Manual
Copy Class Materials into a New Class
Overview
Copying Class materials into a new Class creates a Class in the Blackboard system and
populates it with content from a Class already on the system. The Class Menu specified in the
source Class will replace the default Class Menu in the new Class.
Find this page
Follow these steps to locate the Copy Class Materials into a New Class page.
1.
Click Classes from the Administrator Panel.
2.
Select Copy Class from the drop down list and click Go.
3.
Click Copy Class Materials into a New Class from the Copy Class page.
Source Course ID
Enter a Class ID for the source Class in the Source Course ID field.
Destination Course ID
Enter a Class ID for the new Class that will be created and populated with content from the
current Class. Please make sure that the new Course ID matches the naming convention used at
the Institution. Also, The Course ID should not have any spaces or characters other than
numbers and letters, dash (-), underscore (_), and period (.). The Course ID must be unique and
remain static. It cannot be modified.
Select Class materials
Select the check boxes for each Class area and tool in the Class that should be copied into the
new Class. The table below details what happens to each selectable option when the copy is
performed.
Note: A Class Copy operation cannot be completed if the user does not select
at least one of the following areas: Content, Teacher Information or Settings. If
none of these options is selected a warning will appear.
©
C la ss Mat e r ia l
B e ha vio r w hen co p ie d
Content
Copies Class materials, including uploaded files, Learning Units,
and links. Users may also select to include Class Information, Class
documents, Assignments, and External Links.
Announcements
All Announcements are copied to the new Class. This option must
be selected or the links in Announcements to Assessments will be
broken.
2007 Blackboard Inc. Proprietary and Confidential.
Page 48
Blackboard K–12 Academic Suite
Administrator Manual
C la ss Mat e r ia l
B e ha vio r w hen co p ie d
Tests, Surveys, and
Pools
All Assessments and Surveys, including questions and options for
deploying them are copied. All Pools are copied to the new Class.
Calendar
All Calendar events are copied to the new Class.
Collaboration
Sessions
Collaboration Sessions.
Class Settings
Some Class Settings will be copied. See Class Settings below for
more information.
Discussion Board
Discussion Board Topics, including the initial posts in each Topic,
are copied to the new Class.
Grade Center Items
and Settings
Items in the Grade Center, and their settings, such as type,
categories, and display options, are copied to the new Class.
Group Settings
Settings include the names of the Groups, the settings for tool
availability, and the Discussion Board Topic names.
Teacher Information
All Teacher Information is copied to the new Class.
Course Cartridge content
Copy Protected Cartridge content is only copied if the Course Cartridge Materials option is
selected. This option only appears if there is Copy Protected Cartridge content in the Class.
Class Settings
When Class Settings is selected, certain settings are copied to the new Class. These include the
following
•
Class Name
•
Class Description
•
Class Entry Point
•
Class Design
•
Class Banner
•
Tools settings that do not exist are added. Existing settings are not overwritten.
The following settings are not copied as part of this operation
©
•
Course ID
•
Class Availability
•
Guest Access
•
Parent Access
•
Class Duration
•
Enrollment Options
2007 Blackboard Inc. Proprietary and Confidential.
Page 49
Blackboard K–12 Academic Suite
Administrator Manual
Copy Class Materials into an Existing Class
Overview
The Copy Class Materials into an Existing Class page enables Teachers to copy content from
one Class into another they are teaching. Teachers can select areas, such as Announcements,
Teacher Information or Class areas to copy. Copy Class will add content to a Class, but it will not
remove existing content.
Find this page
Follow these steps to locate the Copy Class Materials into a New Class page.
1.
Click Classes from the Administrator Panel.
2.
Select Copy Class from the drop down list and click Go.
3.
Click Copy Class Materials into an Existing Class from the Copy Class page.
Destination Course ID
Enter a Class ID for the destination Class or click Browse to open a Search function in a
separate window.
Select Class materials
Select the check boxes for each Class area and tool in the Class that should be copied into the
existing Class. The table below details what happens to each selectable option when the copy is
performed.
Note: A Class Copy operation cannot be completed if the user does not select at
least one of the following areas: Content, Teacher Information or Settings. If
none of these options is selected a warning will appear.
©
C la ss Mat e r ia l
B e ha vio r w hen co p ie d
Content
Copies Class materials, including uploaded files, Learning Units,
and links. Users may also select to include Class Information, Class
documents, Assignments, and External Links.
Announcements
All Announcements are copied to the new Class. This option must
be selected or the links in Announcements to Assessments will be
broken.
Tests, Surveys, and
Pools
All Assessments and Surveys, including questions and options for
deploying them are copied. All Pools are copied to the new Class.
Calendar
All Calendar events are copied to the new Class.
Collaboration
Sessions
Collaboration Sessions.
2007 Blackboard Inc. Proprietary and Confidential.
Page 50
Blackboard K–12 Academic Suite
Administrator Manual
C la ss Mat e r ia l
B e ha vio r w hen co p ie d
Class Settings
Some Class Settings will be copied. See Class Settings below for
more information.
Discussion Board
Discussion Board Topics, including the initial posts in each Topic,
are copied to the new Class.
Grade Center Items
and Settings
Items in the Grade Center, and their settings, such as type,
categories, and display options, are copied to the new Class.
Group Settings
Settings include the names of the Groups, the settings for tool
availability, and the Discussion Board Topic names.
Teacher Information
All Teacher Information is copied to the new Class.
Class Settings
When Class Settings is selected, certain settings are copied to the existing Class. These include
the following
•
Class Entry Point
•
Class Design
•
Class Banner
•
Tools settings that do not exist are added. Existing settings are not overwritten.
The following settings are not copied as part of this operation
•
Course ID
•
Class Name
•
Class Description
•
Class Availability
•
Guest Access
•
Parent Access
•
Class Duration
•
Enrollment Options
Resolving Class Menu items
When copying content and tools from one Class to an existing Class, the Class Menu must
resolve itself in the destination Class. The table below describes the how Class Menu items are
resolved.
©
If . . .
then . . .
a Class area in the source Class does not
exist in the destination Class
the area will be added to the Class Menu in the
destination Class.
2007 Blackboard Inc. Proprietary and Confidential.
Page 51
Blackboard K–12 Academic Suite
Administrator Manual
If . . .
then . . .
the Class area in the source Class and
the Class area in the destination Class
have the same name and are of the same
type (for example, External Links,
Teacher Information, or content)
the content from the source Class will be added,
but will not replace, the content in the area
within the destination Class.
the Class area in the source Class and
the Class area in the destination Class
have the same name but are of different
types
the Class area from the source Class will be
added to the destination Class under a different
name. The new name will append an
incremental numeral to the name (for example,
Class Materials will become Class Materials1).
Links
Links to parts of a Class that are not included in the copy will break when the links appear in the
destination Class. For example, if there is a link to a Test in a Class area and Assessments are
not copied, the link to the test will break.
Course Cartridge content
The Course Cartridge Materials option is only successful if the source Class includes Copy
Protected cartridge content and the destination Class does not have a Cartridge ID. If this option
is selected, the Copy Protected cartridge content will be copied to the destination Class with the
Cartridge ID assigned. This option only appears if there is Copy Protected Cartridge content in
the source Class.
If the destination Class already has a Cartridge ID (meaning it already includes Copy Protected
cartridge content), neither the cartridge content nor the Cartridge ID may be copied from the
source Class to the destination Class. If the Course Cartridge Materials option is selected, the
copy operation will be successful, but a note in the receipt states that the Course Cartridge
Materials will not be copied.
If the source Class and the destination Class have the same Cartridge ID, the content may be
copied successfully.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 52
Blackboard K–12 Academic Suite
Administrator Manual
Copy Class with Users (Exact Copy)
Overview
Copy Class with Users performs a complete copy of the Class. This is the only Copy option that
copies user records, such as Grades and Discussion Board posts, to the new Class. This option
is useful if a Class is split into multiple sections. The Teacher may do an exact copy and then unenroll specific students to create two sections of the same Class.
Note: All Course Cartridge content is copied during a Copied Class with Users
operation.
Find this page
Follow these steps to locate the Copy Class with Users (Exact Copy).
1.
Click Classes from the Administrator Panel.
2.
Select Copy Class from the drop down list and click Go.
3.
Click Copy Class with Users (Exact Copy) from the Copy Class page.
Copy the Class
Enter the Course ID for the Source Class and the Destination Class and select Submit. The new
Class will contain all of the same content and all of the same user enrollments and staff
assignments as the source Class.
Please make sure that the new Course ID matches the naming convention used at the Institution.
Also, The Course ID should not have any spaces or characters other than numbers and letters,
dash (-), underscore (_), and period (.). The Course ID must be unique and remain static. It
cannot be modified.
Select Enrollments
If Enrollment is selected, the list of users in the Class will be copied.
User records in the Class will not be copied. This includes the following:
©
•
Grade Center Records
•
Discussion Board posts (including Groups Discussion Board posts)
•
Archived Discussion Board messages (including Groups Discussion Board posts)
•
Drop Box files
•
Assessment attempts
•
Assignment submissions
•
Class Statistics
•
Collaboration session logs
2007 Blackboard Inc. Proprietary and Confidential.
Page 53
Blackboard K–12 Academic Suite
•
Administrator Manual
User Home pages
•
The Electric Blackboard® entries
User records are only copied if the Copy Class with Users (Exact Copy) option is selected.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 54
Blackboard K–12 Academic Suite
Administrator Manual
Import Class
Overview
Import Class uploads an Export package of Class content. Export packages, created with the
Export Class feature, are .ZIP files that contain Class materials, but not user data or interactions.
Export packages are useful for storing content that may be used to teach the same Class to
different Students at a later time. To create a permanent record of a Class, use the Archive Class
and Restore Class features.
Never upload an Exported Class package that has been modified since it was created and
downloaded. Opening the .ZIP file and changing any of the files in the Exported Class package
will result in unstable and unpredictable behavior when the Class is imported.
Note: Class packages created for older versions may not be supported. Please
check the release notes for a list of supported versions.
Import Class page
1.
Click Classes from the Administrator Panel.
2.
Select Import Class from the drop down list and click Go.
Fields
The table below details the fields on the Import Class page.
F i e ld
Descript ion
Course ID
©
Destination
Course ID
Enter the Course ID of the Class to receive Class materials. If a Class ID
that does not exist on the system is entered, a new Class with this ID will
be created with the data and settings from the imported Class.
Packaged
Class
Either enter the path to the Class package or click Browse to search for
the Class package.
Select Class
Materials
Select the option for each Class area and tool in the Class that should be
imported. The Select Class materials section below details these options.
2007 Blackboard Inc. Proprietary and Confidential.
Page 55
Blackboard K–12 Academic Suite
Administrator Manual
Select Class materials
The table below details what happens to each selectable option when the import is performed.
C la ss Mat e r ia l
B e ha vio r w hen co p ie d
Content
Imports Class materials, including the following, from the package
•
Uploaded files
•
Learning Units
•
Links
•
Class Information
•
Class Documents
•
Assignments
•
External Links
•
Building Block content
Announcements
All Announcements are imported. If Assessment links appear in
Class areas, then this option must be selected, or the link to the
Assessment will be broken.
Tests, Surveys, and
Pools
All Assessments and Surveys, including questions and options for
deploying them are imported. All Pools are imported to the new
Class.
Calendar
All Calendar items are imported to the new Class.
Class Settings
Some Class Settings will be imported. See Class Setting below for
more information.
Discussion Board
Discussion Board Topics, including the initial message in the
Discussion Board, are imported.
Grade Center Items
and Settings
Items in the Grade Center, and their settings, such as type,
categories, and display options, are imported.
Group Settings
Settings include the names of the Groups, the settings for tool
availability, and the Discussion Board Topic names.
Teacher Information
All Teacher Information is imported.
Class Settings
When Class Settings is selected, certain settings are imported to the Class. These include the
following
•
Class Name
•
Class Description
•
Class Entry Point
•
Class Design
•
Class Banner
•
Tools settings that do not exist are added. Existing settings are not overwritten.
The following settings are not imported as part of this operation
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 56
Blackboard K–12 Academic Suite
•
Course ID
•
Class Availability
•
Guest Access
•
Parent Access
•
Class Duration
•
Enrollment Options
Administrator Manual
Resolving the Class Menu items
When importing a package, the Class Menu must resolve itself in the destination Class. The table
below describes the how Class Menu items are resolved.
If . . .
then . . .
a Class area in the package does not
exist in the destination Class
the area will be added to the Class Menu in the
destination Class.
the Class area in the package and the
Class area in the destination Class have
the same name and are of the same type
(for example, External Links, Teacher
Information, or content)
the content from the package will be added, but
will not replace, the content in the area within the
destination Class.
the Class area in the package and the
Class area in the destination Class have
the same name but are of different types
the Class area from the package will be added
to the destination Class under a different name.
The new name will append an incremental
numeral to the name (for example, Class
Materials will become Class Materials1).
Class Links
Links to parts of a Class that are not included in the export package will break when the links
appear in the destination Class. For example, if there is a link to a Test in a Class area and Tests,
Surveys and Pools are not exported, the link to the Test will break.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 57
Blackboard K–12 Academic Suite
Administrator Manual
Export / Archive Manager
Overview
The Export / Archive Manager page organizes all export and archive packages that are created
from the Class. When the Class is exported or archived, a link to the package appears on this
page. The Administrator may download the package to a local computer, and then use it in the
future for import or restore operations.
When a package is exported or archived, it does not appear on this page immediately. An email
is sent to the user once the system has created the package; the user may then open this page to
find the package and download it.
Note: It is recommended that packages be removed from this page once they
are downloaded. Each package counts against the Class quota; so keeping
packages on this page may result in limited space to add additional content to the
Class.
Find this page
Follow these steps to open the Export / Archive Manager page.
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Export / Archive Manager.
Functions
The following table details the functions available from the Export / Archive Manager page.
©
To . . .
click . . .
export a Class
Export in the Action Bar. The Export Class page appears.
archive a Class
Archive in the Action Bar. The Archive Class page appears.
download a Class
package
The link to the package in the File column. Save the .zip file to a
local computer.
view the log details
Log next to the package. The Log page appears.
view the package
creation details
Detailed Log next to the package. The Detailed Log page appears
explaining the different parts of the operation.
remove a Class
package
Remove next to the package.
2007 Blackboard Inc. Proprietary and Confidential.
Page 58
Blackboard K–12 Academic Suite
Administrator Manual
Export Class
Overview
The Export Class feature creates a package of the Class content that can later be imported into
Blackboard and used to teach another Class with the same content. It is important to note that,
unlike the Archive Class feature, Export Class packages do not include any user interactions with
the Class—it only includes the content of the Class. Therefore, Export Class is useful when Class
materials will be reused at a later time to teach a new set of Students. Archive Class is useful to
maintain a record of a Class after it has been taught.
Export packages are created as compressed .ZIP files and can be imported into the Blackboard
K-12 Suite in the same format. Do not unzip an Export package, remove files from the package,
or try to import a file contained with the package, otherwise the package will not be imported
correctly.
Export packages from older versions of the Blackboard K-12 Suite can be imported into
Blackboard K-12 Suite , but Blackboard K-12 Suite export files are not backward compatible with
previous versions.
Find this page
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Export / Archive Manager.
5.
Click Export in the Action Bar of the Export / Archive Manager page.
Note: An Export Class option is also available on the Classes page. If this option
is selected, enter the Course ID on the Export Class page that appears and click
Submit. Options appear to select the materials to include in the export package.
Once the package has been created, the Administrator must open the Manage
Exports page to download the Class package.
Fields
The table below details the fields on the Export Class page.
F i e ld
Descript ion
Select a Class
Source
Course ID
Enter the Course ID of the Class that will be exported.
Select Class Materials
Select Class
Materials
©
Select the option for each content area and tool in the Class that should be
exported. The Select Class materials section below details these options.
2007 Blackboard Inc. Proprietary and Confidential.
Page 59
Blackboard K–12 Academic Suite
Administrator Manual
Select Class materials
The table below details what happens to each selectable option when the export is performed.
C la ss Mat e r ia l
Be ha vio r w hen Expo rt ed
Content
Exports Class materials, including uploaded files, Learning Units,
and links. Users may also select to include Class Information, Class
documents, Assignments and External Links.
Announcements
All Announcements are exported. If Assessment links appear in
Class areas, then this option must be selected, or the link to the
Assessment will be broken.
Tests, Surveys, and
Pools
All Assessments and Surveys, including questions and options for
deploying them are imported. All Pools are exported to the new
Class.
Calendar
All Calendar items are exported to the new Class.
Class Settings
Some Class Settings will be exported. See Class Setting below for
more information.
Discussion Board
Discussion Board Topics, including the initial message in the
Discussion Board, are exported.
Grade Center Items
and Settings
Items in the Grade Center, and their settings, such as type,
categories, and display options, are exported.
Group Settings
Settings include the names of the Groups, the settings for tool
availability, and the Discussion Board Topic names.
Teacher Information
All Teacher Information is exported.
Class Settings
When Class Settings is selected, settings are exported. These include the following
©
•
Class Name
•
Class Description
•
Class Entry Point
•
Class Design
•
Class Banner
•
Blackboard Tools
•
Building Block Tools
•
Content Tools
•
Course ID
•
Class Availability
•
Guest Access
•
Parent Access
•
Class Duration
2007 Blackboard Inc. Proprietary and Confidential.
Page 60
Blackboard K–12 Academic Suite
•
Administrator Manual
Enrollment Options
Note: For information about which of these settings are included during an
import operation, see the Import Class topic.
IMS specifications
The Blackboard packaging format follows the IMS Content Packaging Specification with
extensions to support content types that are specific to the Blackboard K-12 Suite. Blackboard K12 Suite uses
•
IMS Content and Packaging Specification 1.1.2
•
IMS Metadata Specification 1.2.1
•
IMS Enterprise Specification 1.01
•
IMS Question and Test Interoperability Specification 1.2
Download the Class package
After the Export Class page is submitted, the system creates the Class package. When the
package is complete, the Administrator who initiated the operation receives an email. This email
includes a link to the log file contents of the package. After the email is received, Administrators
may open the Export / Archive Manager page in the application and download the Class package
to the local computer.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 61
Blackboard K–12 Academic Suite
Administrator Manual
Archive Class
Overview
Archive Class creates a permanent record of a Class including all the content and user
interactions. Unlike the Export Class feature, Archive Class is not useful when trying to create a
package of content to be used at a later time or with another Class. When an Archive package is
restored, not only is the content of the Class restored, but all of the user information and user
interactions are restored as well. The Class is fully restored to the state it was in when archived.
Course Cartridge content is archived during this operation, and may be restored.
Archived Classes are saved as .ZIP files with the following file naming structure:
ArchiveFile_Course_ID_date/time_stamp.ZIP. Once the package has been downloaded, do not
remove files from the package or unzip the package and try to restore individual files within the
package. The Class can only be restored if the package is intact. Modifying the .ZIP file and then
uploading the Archived Class package will result in unstable and unpredictable behavior in the
Restored Class.
Find this page
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Export / Archive Manager.
5.
Click Archive in the Action Bar on the Export / Archive Manager page.
Note: An Archive Class option is also available on the Classes page. If this
option is selected, enter the Course ID on the Archive Class page that appears
and click Submit. Once the package has been created, the Administrator must
open the Export / Archive Manager page to download the Class package.
Archiving a Class
There is only one field on the Archive Class page. Enter a valid Course ID in the Source Course
ID field. If the Course ID is not known, click Browse to look it up.
Follow these steps to search for a Class
©
1.
Select the Course ID, Teacher, or Title/Description option.
2.
In the text field, enter a Class ID, a Teacher name, or a string that appears in the Title or
Description of the Class. If this field is left blank, Classes will be filtered only by the date
created.
3.
Select the All Classes, Month, or Day option to define the list based on when Classes
were created (If Month is selected, Classes that are returned will have been created in
the previous 30 days. If Day is selected, Classes that are returned will have been created
in the last 24 hours).
4.
The search function will create a list of Classes according to the search criteria. Classes
will appear in a table format with each Class listed in a separate row.
2007 Blackboard Inc. Proprietary and Confidential.
Page 62
Blackboard K–12 Academic Suite
5.
Administrator Manual
Click Select in the same row as the desired Class. The Search window will close and the
selected Class will appear in the Source Course ID field on the Copy Class Materials into
a New Class page.
Download the Class package
After the Archive Class page is submitted the Blackboard system creates the Class package.
When the package is complete, the Administrator who initiated the operation receives an email.
This email includes a link to the log file contents of the package. After the email is received,
Administrators may open the Export / Archive Manager page in the Blackboard application and
download the Class package to the local computer.
IMS specifications
The Class packaging format follows the IMS Content Packaging Specification with extensions to
support content types that are specific to Blackboard K-12 Suite. The Blackboard K-12 Suite
uses:
©
•
IMS Content and Packaging Specification 1.1.2
•
IMS Metadata Specification 1.2.1
•
IMS Enterprise Specification 1.01
•
IMS Question and Test Interoperability Specification 1.2
2007 Blackboard Inc. Proprietary and Confidential.
Page 63
Blackboard K–12 Academic Suite
Administrator Manual
Restore Class
Overview
Restore Class handles the upload of archived packages into Blackboard. Use Restore Class to
return an archived Class to the same state it was in at the time it was archived. Class content
(including all Course Cartridges), user data, and user interactions are all included in the Archive
package.
When a Class is restored, the Settings and Class Menu specified in the Archive package will
replace the default Settings and Class Menu that are in effect for new Classes.
Archived packages are designed to provide a permanent record of a Class. To save Class
materials to teach another set of Students at a later time use the Export Class and Import Class
features.
Note: Do not upload an Archived Class package that has been modified since it
was created and downloaded. Opening the .ZIP file and changing any of the files
in the Archived Class package will result in unstable and unpredictable behavior
when the Class is restored.
Find this page
Select Restore Class from the drop down list on the Classes page.
Note: Class packages created for earlier versions may not be supported. Please
check the Release Notes for a list of supported versions.
Fields
The table below details the fields on the Restore Class page.
F i e ld
Descript ion
Course ID
Destination
Course ID
©
Enter a new Course ID for the Class to receive Class materials. A new
Class with this ID will be created with the data and settings from the
packaged Class. It is not possible to restore a Class using a Class ID that is
already in use.
Please make sure that the new Course ID matches the naming convention
used at the Institution. Also, The Course ID should not have any spaces or
characters other than numbers and letters, dash (-), underscore (_), and
period (.). The Course ID must be unique and remain static. It cannot be
modified.
2007 Blackboard Inc. Proprietary and Confidential.
Page 64
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Packaged
Class
Enter the file location of the archive package or browse for the file location.
Restored materials must be .ZIP archive files of Blackboard Learning
System Class materials. To create packaged Class materials, use the
Archive Class function.
Restoring User records
When performing a restore the Blackboard Learning System checks to see if users are in the
system by validating Usernames against email addresses. If the Username exists with the same
email address there is no need to create the user.
If a Username exists with a different email address than the one included in the archive package,
a new user will be created with a number appended to the Username.
Example: An archive package is uploaded with an account that has the Username bb_user. The
Restore process looks for users with this User name in the Blackboard system. If bb_user exists
in the system, the process then compares the email addresses. If the email address matches,
then a new user is not created. If the email addresses are different, then the process creates a
new user, bb_user1.
Note: As a security precaution, any users that are added during a restore are
created with only their primary System Role. Secondary System Roles are not
included.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 65
Blackboard K–12 Academic Suite
Administrator Manual
Batch Import/Export/Archive/Restore Class
Overview
The Blackboard K-12 Suite includes a tool for handling the import/export and archive/restore of a
number of Classes at once. The tool will process a batch file that includes the Course ID and the
name.
Creating a batch file
A batch file used with the batch_ImportExport tool only has two values in each row, the Course ID
and the full path to the .ZIP package. When running an Export or Archive action the .ZIP package
will be created using the specified path and file name. When running an Import or Restore action
on the specified path and file name, point to the .ZIP package associated with the destination
Course ID.
Below are examples of the contents of a batch file for use with batch_ImportExport tool. Files
should be saved as text (.txt) files.
Restore or Import
HIST101, C \course_archives\Archive_File_HIST101.zipHIST201, C
\course_archives\Archive_File_HIST201.zipHIST301, C
\course_archives\Archive_File_HIST301.zipHIST401, C
\course_archives\Archive_File_HIST401.zipHIST331, C
\course_archives\Archive_File_HIST331.zipRestore and Import batch files require the
exact path, including the name of the package.
Archive or Export
HIST101, C \course_archives\HIST201, C \course_archives\HIST301, C
\course_archives\HIST401, C \course_archives\Archive and Export batch files require
only the path to the directory where each package will be stored. Adding the package name will
result in an error.
Running the tool
The Batch tool for running Import/Export and Archive/Restore functions must be run from the
command line. The tool must be run from the Web/app server. The command syntax is shown
below.
Microsoft® Windows®
C:\Blackboard\apps\content-exchange\bin\batch_ImportExport.bat –f
<path_to_file> -l <delimiter> -t <operation> -n <virtual_hostname>
Note: Use cmd.exe to open a command line for running the tool. Running the
tool from command.exe will result in errors.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 66
Blackboard K–12 Academic Suite
Administrator Manual
UNIX
/usr/local/blackboard/apps/content-exchange/bin/batch_ImportExport.sh –f
<path_to_file> -l <delimiter> -t <operation> -n <virtual_hostname>The exact path
to the Blackboard directory may be different depending on where the Blackboard Learning System
was installed.
A rgu ment
Descript ion
<path_to_file>
Enter the full path to the batch file.
<delimiter>
One of the following
1 -- identifies comma (,) as the delimiter.
2 – identifies semicolon (;) as the delimiter.
3 – identifies TAB as the delimiter.
©
<operation>
One of the following
Import
Export
Restore
Archive
<virtual_hostname>
The name of the virtual installation that the tool will run against. If there
are no Virtual Installations, or if this argument is not given, the tool will
run against the default Virtual Installation.
2007 Blackboard Inc. Proprietary and Confidential.
Page 67
Blackboard K–12 Academic Suite
Administrator Manual
Batch Copy
Overview
This topic details how to use the command line tool to perform a batch copy operation. For
instructions on using Snapshot to perform a batch copy operation please see the Advanced
Integration and Data Management Manual.
By default, when a Batch Copy is performed an exact copy of the Class is created. If there is
existing content in the destination Class, this content will remain after the copy. The Class Menu
settings in the new Class will depend upon the areas of the Class copied.
Creating a batch file for the command line tool
The batch file follows exactly the same format as a Snapshot flat file. The first row defines the
attributes and the subsequent rows hold the data for each copy. The delimiter used in the file
must match the delimiter set in the snapshot.properties file. Finally, the file must be a text file
(.txt).
Example
EXTERNAL_COURSE_KEY|TEMPLATE_COURSE_KEYHIST101|TEMPLATE_COURSE_ID HIST102|TEMP
LATE_COURSE_IDHIST103|TEMPLATE_COURSE_ID2The EXTERNAL_COURSE_KEY is an
attribute used for advanced data management. If a Class is created through the Administrator
Panel, the EXTERNAL_COURSE_KEY is simply the Course ID.
If the destination Classes do not exist they must be created as part of the process or the copy will
fail. To create the destination Classes the COURSE_ID and COURSE_NAME attributes must be
added to the batch file.
Example
EXTERNAL_COURSE_KEY|COURSE_ID|COURSE_NAME|TEMPLATE_COURSE_KEYHIST101|HIST101|I
ntroduction to American History until
1865|TEMPLATE_COURSE_ID HIST102|HIST102|Introduction to American History from
1865|TEMPLATE_COURSE_IDHIST103|HIST103|Introduction to Central American
History|TEMPLATE_COURSE_ID2
Running the command line tool
The Batch tool for running Copy functions must be run from the command line. The tool must be
run from the Web/app server. The command syntax is shown below.
Windows
C:\Blackboard\tools\admin\BatchCourseCopy.cmd <path_to_file>UNIX
/usr/local/blackboard/tools/admin/BatchCourseCopy.sh <path_to_file>Please note
that the path to the Blackboard directory may be different based on where the Blackboard
Learning System was installed.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 68
Blackboard K–12 Academic Suite
Administrator Manual
Where <path_to_file> is the full path to the batch file that will be processed. Note that the
delimiter used in the batch file must be the same delimiter in the snapshot.properties file. The
default value is a pipe (|). Also, the command will only process a batch copy on the default Virtual
Installation. To perform a batch copy on another Virtual Installation the COPYINTO Snapshot
command must be run.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 69
Blackboard K–12 Academic Suite
Administrator Manual
Adding File Types for Use with Class Content Items
Overview
The Blackboard K-12 Suite recognizes several file types that can be attached to content items
and opened in the page or directly in an associated application. It is important to remember that
any type of file can be uploaded to a content item and made available to Students. If the file is not
of a type recognized by the Blackboard K-12 Suite, users can always download the file and open
it locally.
Administrators can make the Blackboard K-12 Suite recognize additional file types and
associated applications by adding MIME extensions to an XML file in the file system. This should
only be done by an experienced System Administrator.
Add a MIME extension
To add a MIME extension that associates a file type with an application, edit the following XML
file. The XML file includes a few sample extensions that can be used as a blueprint for creating
additional MIME extensions.
Windows
C:\blackboard\config\tomcat\web.xmlUNIX
/usr/local/blackboard/config/tomcat/web.xml
Recognized content attachments
The following file types are recognized by the Blackboard K-12 Suite. These files can be
displayed within a content item. Other file types can be added to a content item and opened using
the correct application on users’ computers.
©
Ext en sion
F i l e T yp e
P r og ra ms a ss oc iat ed w it h t he F i l e T yp e
.aam
Multimedia
Macromedia® Authorware® plug-in
Note that the .aam file is the starting point for a series of files
that must be enclosed in a .ZIP file.
.aiff
Audio
Audio program
.asf
Multimedia
Microsoft® .NET™ Show
.au
Audio
Real Audio Player™
.avi
Video
Video player (not Macintosh® compatible)
.doc
Text
Microsoft® Word® or other word processor
.exe
Executable
Executable file
.gif
Image
Graphics program or Web browser
.html, .htm
Web page
HTML editor or Web browser
.jpg, .jpeg
Image
Graphics program or Web browser
.jif
Image
Graphics program or Web browser
2007 Blackboard Inc. Proprietary and Confidential.
Page 70
Blackboard K–12 Academic Suite
©
Administrator Manual
Ext en sion
F i l e T yp e
P r og ra ms a ss oc iat ed w it h t he F i l e T yp e
.mp3
Audio
Audio program
.mpe
Audio/Video
Audio program
.mpg, .mpeg
Image
Graphics program or Web browser
.moov,
.movie
Movie
QuickTime® movie
.mov
Video
Movie or media player
.pdf
Text
Adobe® Acrobat® Reader®
.png
Image
Portable Network Graphics
.ppt, .pps
Slide show
Microsoft® PowerPoint® and PowerPoint Player®
.qt
Movie
QuickTime®
.ra
Audio
Real Audio Player™
.ram
Video
Real Audio Movie™
.rm
Audio
Audio program
.rtf
Text
Rich Text Format
.swf
Multimedia
Macromedia® Shockwave® plug-in
.tiff, .tif
Image
Graphics program or Web browser
.txt
Text
Text or HTML editor, word processor
.wav
Audio
Audio program
.wma
Audio
Audio program
.wmf
Graphic
Microsoft® Windows®
.wmv
Media/Audio
Microsoft® Windows®
.wpd
Text
WordPerfect® or other word processor
.xls
Spreadsheet
Microsoft® Excel®
.zip
Text
WinZip®
2007 Blackboard Inc. Proprietary and Confidential.
Page 71
Blackboard K–12 Academic Suite
Administrator Manual
Class Configuration Options
Overview
This section reviews the features that determine the appearance and behavior of all Classes.
In this section
Class Configuration Options includes the following topics.
©
T op i c
Descript ion
Set Default Course
Properties
This topic covers the Set Default Class Properties page.
Administrators can define the initial properties of each Class from
this page.
Set Default Class
Design
This topic covers the Set Default Class Design page.
Administrators can define the initial appearance of the Class Menu
from this page.
Set Default Class
Menu
This topic covers the Class Menu . Administrators can define the
content, tools, and links that appear in each Class’s Class Menu
from this page.
Class Menu and Tool
Panel Display Options
This topic covers the Class Menu that contains links to materials
and tools within the Class.
Add New Area Content Area
This topic covers the Add New Area—Content Area page.
Administrators can create a new content area to appear in each
Class’s Class Menu from this page.
Add New Area - Tool
Area
This topic covers the Add New Area—Tool Area page.
Administrators can assign a tool to appear in each Class’s Class
Menu from this page.
Add New Area - Link
Area
This topic covers the Add New Area—Link Area page.
Administrators can create a new link to appear in each Class’s
Class Menu from this page.
Class Tools
This topic covers the Class Tools page. Administrators can set the
initial availability of tools within all Classes from this page.
Class Role Rename
This topic covers the Class Role Rename page. The names of the
Class Roles can be changed from this page.
Class Disk Quotas
This topic covers the Class Disk Quotas page. Disk space limits
can be placed on all Classes from this page.
Grade Center
Calculations
This topic covers the Set Grade Center Defaults page, which
determines how ungraded Grade Center items are treated in
calculations.
Set Class Images
This topic covers the Set Class Images page. Administrators add
images to all Classes from this page.
Select Icon Themes
This topic covers the Select Icon Theme page. Administrators
determine the appearance of the icons in all Classes by selecting
an icon them from this page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 72
Blackboard K–12 Academic Suite
Administrator Manual
Set Default Class Properties
Overview
The options chosen on the Set Default Class Properties page control the availability, enrollment,
and duration settings of new Classes. While Classes are created with these options defined
according to the defaults, the Teacher or the Administrator can change these options at any time.
Find this page
Follow these steps to open the Set Default Class Properties page.
1.
Click Settings on the Administrator Panel.
2.
Click Set Default Class Properties from the Settings page.
Fields
The table below details the fields on the Set Default Class Properties page.
F i e ld
Descript ion
Default Settings
Available by
default
Click Yes to make Classes immediately available when they are created.
Allow Guests
by default
Click Yes to allow Guests to access to Classes.
Allow
Parents by
Default
Click Yes to allow Parents. This value is set to No when the Blackboard
Learning System is installed.
Default
Enrollment
Settings
Select a default enrollment from the following options
Teacher/Admin. The Teacher and the Administrator control
enrollment. Click the check box next to Allow interested Students to
email requests to Teacher and link to email the Teacher to request
enrollment will appear next to the Class in the Class Catalog.
Self-Enrollment. Students are allowed to enroll themselves in Classes.
An Enroll button will appear next to the Class in the Class Catalog.
To limit self-enrollment to a specified date range, click the check
boxes for a start date and an end date.
To require an access code, click the check box and enter a code.
Students must enter this code to enroll in a Class.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 73
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Default
Duration
Settings
Select a default Class duration from the following options:
Continuous. Classes do not have a start date or an end date.
Select Dates. Classes have a duration that matches the starting and
ending dates.
Days. Classes will be available for a number of days from the date of
creation. Enter the number of days in the field.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 74
Blackboard K–12 Academic Suite
Administrator Manual
Set Default Class Menu
Overview
The options chosen on the Set Default Class Menu page control the initial Class areas that are
available in new Classes. Class Areas are parts of a Class that hold content, tools, or links. Class
Areas will appear in new Classes in the order that they appear on the Set Default Class Menu
page. The italicized text that appears below the name of a Class Area describes whether the area
is a content item, link, or tool (and if so, which tool).
While Classes are created with these options defined according to the defaults the Teacher or the
Administrator can change these options for a Class at any time.
Note: All tools and content areas on the default Class Menu must have unique
names. For example, a tool with the menu name Address Book and a content
area with the Menu name Address Book may be created; two tools named
Address Book may not be added. Two links to the Address Book tool may be
created but they must have different Menu names.
This only applies to the default Class Menu; not to Class Menus for individual
Classes.
Find this page
Follow these steps to open the Set Default Class Menu page.
1.
Click Settings on the Administrator Panel.
2.
Click Set Default Class Menu from the Settings page.
Functions
The table below details the fields on the Set Default Class Menu page.
©
To . . .
click . . .
add a content area to
the list of default
areas
Add Content Area. The Add New Area—Content Area page will
appear. From this page, define a content area. The new Class Area
will appear at the bottom of the list of areas.
add a tool area
Add Tool Area. The Add New Area—Tool Area page will appear.
add an external link
Add External Link. The Add New Area—Link Area page will
appear.
remove a Class Area
from the list of default
areas
Remove. The selected Class Area will be removed from the list of
areas.
modify a Class Area
Modify. The Update Class Area Page will appear.
change the order of a
Class Area
From the drop-down lists in front of each Class Area, select a
number to position the areas in sequence.
2007 Blackboard Inc. Proprietary and Confidential.
Page 75
Blackboard K–12 Academic Suite
Administrator Manual
Class Menu and Tool Panel Display Options
About the Class Menu
The Class Menu appears on the left side of a Class and contains links to materials and tools
within the Class. The Administrator sets up the default view of the Class Menu. The Teacher can
customize the appearance of the Class Menu and the content and tools available to users. The
following two views are available:
•
Quick View – Displays top-level of Class materials in Class navigation. Links may be
displayed as buttons or text links.
•
Detail View – Displays Class materials as seen in the Class Map. This view expands to
show the hierarchy of Class navigation.
A Tools Panel appears as part of the Class Menu. This box may contain links to the Class Map,
Communication tools and/or Class Tools. Links to tools may also be added to the main part of the
Class Menu so they appear in the Detail View or the Class Map.
Set up Menu display options
The Administrator can make the Quick View and/or the Detail View available as the default. This
default applies to all new Classes; it does not affect Classes already in the Blackboard system.
Follow the steps below to change the default view in a Class:
1.
Select Settings under Blackboard Learning System on the Control Panel.
2.
Select Set Default Class Menu Display Options on the Settings page.
3.
Select a default view for the Class Menu.
Note: Teachers may change the Class Menu display options within their specific
Classes.
Set up Tool box display
The Tools Panel may be set to display a links to Class Tools, Communication tools, and/or the
Class Map. The display of the Tools Panel is managed separately for the Detail View and the
Quick View.
Follow the steps below to set up the Tools Panel display for the Quick View:
©
1.
Select Settings under Blackboard Learning System on the Control Panel
2.
Select Set Default Class Tool Panel Design on the Settings page.
3.
Select Quick View Display Options or Detail View Display Options on the Manage
Tool Panel page.
4.
Select which links to display in the box and enter a name to appear in the header. If no
options are selected, the Tools Panel does not appear in the Class Menu. If Header
Name is left blank, no header appears in the Tools panel. The background and text color
for the header may also be selected.
2007 Blackboard Inc. Proprietary and Confidential.
Page 76
Blackboard K–12 Academic Suite
Administrator Manual
Add New Area—Content Area
Overview
Content Areas are containers within a Class that are accessible from the Class Menu.
Adding a new Content Area through this page creates a blank Content Area that will appear in
each new Class. Note that the new Content Area is only a default. The Teacher of each Class
can choose to modify or remove the Content Area within each Class. To modify the new area or
to set its place within the Class Menu, use the Set Default Class Menu feature.
Find this page
Follow these steps to open the Add New Area—Content Area page.
1.
Click Settings on the Administrator Panel.
2.
Click Set Default Class Menu from the Settings page.
3.
Click Add Content Area in the Action Bar on the Set Default Class Menu page.
Fields
The following table details the fields on the Add New Area—Content Area page.
F i e ld
Descript ion
Set Area Properties
©
Area Type
This field is display only.
Area Name
Select a name for the area from the drop-down list or
enter a name in the text box.
Allow guest Access
Select this check box to permit Guests to view the area.
Allow Parent access
Select this check box to permit Parents to view the
area.
Make available for
Student/Participant users
Select this check box to make the new area available to
users when a Class is created.
2007 Blackboard Inc. Proprietary and Confidential.
Page 77
Blackboard K–12 Academic Suite
Administrator Manual
Add New Area—Tool Area
Overview
Tool Areas allow access to a tool directly through the Class Menu.
Adding a new Tool Area through this page creates an area that will access the selected tool in
each new Class. Note that the new Tool Area is only a default. The Teacher of each Class can
choose to modify or remove the Tool Area within each Class. To modify the new area or to set its
place within the Class Menu, use the Set Default Class Menu feature.
Find this page
Follow these steps to open the Add New Area—Tool Area page.
1.
Click Settings on the Administrator Panel.
2.
Click Set Default Class Menu from the Settings page.
3.
Click Add Tool Area in the Action Bar on the Set Default Class Menu page.
Fields
The following table details the fields on the Add New Area—Tool Area page.
F i e ld
Descript ion
Set Area Properties
Area Type
Select the tool accessible through the new area.
Area Name
Enter a name in the text box for the Tool Area. If a name is
not entered, the name of the tool selected in Area Type will
be the name of the Tool Area.
Make available for
Student/Participant users
Select this check box to make the new area available to users
when a Class is created.
Note: Guest and Parent permissions to access the tool are controlled through
the Class Tools feature.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 78
Blackboard K–12 Academic Suite
Administrator Manual
Add New Area—Link Area
Overview
Link areas create an access point to a URL in the Class Menu.
Adding a new Link Area through this page creates an Area that will access the defined URL in
each new Class. Note that the new Link Area is only a default. The Teacher of each Class can
choose to modify or remove the Link Area within each Class. To modify the new area or to set its
place within the Class Menu, use the Set Default Class Menu feature.
Find this page
Follow these steps to open the Add New Area—Link Area page.
1.
Click Settings on the Administrator Panel.
2.
Click Set Default Class Menu from the Settings page.
3.
Click Add Link Area in the Action Bar on the Set Default Class Menu page.
Fields
The following table details the fields on the Add New Area—Link Area page.
F i e ld
Descript ion
Set Area Properties
Area Type
This field is display only.
Area Name [r]
Enter a name for the link in the text box.
Target [r]
Enter the complete URL for the link. For example, http
//www.blackboard.com, not www.blackboard.com or
blackboard.com.
Launch in new window
Select this check box to open the destination URL in a new
browser window.
Allow guest Access
Select this check box to permit Guests to view the area.
Allow Parent access
Select this check box to permit Parents to view the area.
Make available for
Student/Participant users
Select this check box to make the new area available to
users when a Class is created.
Note: Guests and Parents have access to any link displayed in the Class Menu.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 79
Blackboard K–12 Academic Suite
Administrator Manual
Class Tools
Overview
The options chosen on the Class Tools page control the initial tools that are available in new
Classes. The Blackboard Learning System has a robust set of tools and the flexibility to add new
tools to the platform. A filter at the top of the Class Tools page sets the list of tools displayed to
show Blackboard Learning System tools and tools added through Building Blocks.
While Classes are created with these options defined according to the defaults, the Teacher or
the Administrator can change these options for a Class at any time.
Note: The Class Link Checker and Copy Files to CS tools only appear if the
Blackboard Content System is installed. Building Block Tools cannot be added to
Blackboard Learning System - Basic Edition.
Find this page
Follow these steps to open the Class Tools page.
1.
Click Settings on the Administrator Panel.
2.
Click Class Tools from the Settings page.
Functions
The table below details the functions available from the Class Tools page.
To . . .
click . . .
change the list of
tools displayed
The drop-down arrow in the Filter field and select a list of tools. The
options available are
Tools. The tool set provided by Blackboard Learning System.
Building Block Tools. Tools that have been integrated into the
Blackboard Learning System through a Building Block.
All Tools. Tools provided by the Blackboard Learning System
and tools that have been integrated through a Building Block.
©
enable a tool by
default
Click the check box in the Enabled column for each tool that should be
available in each new Class.
allow Guest access
to a tool by default
Click the check box in the Allow Guest column for each tool that
should be accessible by Guests. Tools that cannot be accessed by
Guests are marked “n/a”.
allow Parent
access to a tool by
default
Click the check box in the Allow Parent column for each tool that
should be accessible by Parents. Tools that cannot be accessed by
Parents are marked “n/a”.
2007 Blackboard Inc. Proprietary and Confidential.
Page 80
Blackboard K–12 Academic Suite
Administrator Manual
Disabling Announcements
If Announcements are disabled, any Announcements that Teachers have previously created will
be visible in their Classes. Teachers will not be able to delete these Announcements, because
this tool will no longer be available.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 81
Blackboard K–12 Academic Suite
Administrator Manual
Class Role Rename
Overview
The names of the Class Roles that are used to define privileges within a Class can be changed. It
is important to note that even if the name of role is changed the privileges for the role do not
change. Changing the role “Teacher” to “Content Manager” will not change what users with that
role can access.
To modify the privileges associated with each role use the User Privileges feature.
Find this page
Follow these steps to open the Class Rename page.
1.
Click Settings on the Administrator Panel.
2.
Click Class Role Rename from the Settings page.
Fields
For each role name, the default name is listed below the name as it appears in the system. To
change the name of the role edit the name as it appears in the Role Name field.
To change all the names back to their default values click the Check here to revert all fields to
default names check box and then click Submit.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 82
Blackboard K–12 Academic Suite
Administrator Manual
Class Disk Quotas
Overview
Quotas keep Classes from exceeding acceptable disk space limits and warn Teachers when a
Class is approaching the limit.
Administrators can grant additional disk space to individual Classes through the Class Quotas
Overrides page. This page is accessible by listing Classes and viewing the properties for a
specific Class.
Find this page
Follow these steps to open the Class Disk Quotas page.
1.
Click Settings on the Administrator Panel.
2.
Click Class Disk Quotas from the Settings page.
Fields
The table below details the fields on the Class Disk Quotas page.
F i e ld
Descript ion
Control Class Disk Quotas
©
Enable Disk Quotas
Click this check box to place restrictions on the size of
Classes.
Warn Teachers when
Class size exceeds
Enter an amount of disk space in Kilobytes. Teachers will
receive a warning that the Class is approaching the disk
space limit.
Maximum Class disk
Usage
Enter a disk space limit in Kilobytes.
Limit the maximum size of
a single file upload to
Enter a size limit, in Kilobytes, for files uploaded to Classes.
2007 Blackboard Inc. Proprietary and Confidential.
Page 83
Blackboard K–12 Academic Suite
Administrator Manual
Grade Center Calculations
About Grade Center Calculations
Current Grade Center calculations for Total and Weighted Total include item that have not been
scored. For example, picture a Class where the Grade is determined by two tests weighted
equally. Using the current Grade Center settings, a Student with a score of 90 percent on the first
test would have a weighted total of 45 percent (assuming that the second test has not been
taken). This shows that the Student has accumulated a score of at least 45 percent in the Class.
A new option to ignore ungraded items, or nulls, when calculating the total and weighted total
appears in Application Pack 3. In the example above, the Student's progress would be reported
as 90 percent.
Detailed information about the formulas used to calculate the Total and Weighted Total can be
found in the Blackboard K-12 Suite Teacher Manual.
Enable Grade Center Calculations to Ignore Ungraded Items
Once enabled, Grade Center totals and weighted totals may be calculated without ungraded
items. When this feature is enabled, it will appear in all new Classes. This feature will not be
enabled in existing Classes until it is turned on for each specific Class.
Follow these steps to enable Grade Center calculations to ignore ungraded items.
©
1.
Click Settings under the Blackboard Learning System area of the Admin Panel.
2.
Click Default Grade Center Settings.
3.
Select Yes or No for the Total and for the Weighted Total. Select Yes to ignore
ungraded items by default in new Classes. Teachers may change this setting to include
ungraded items from the Grade Center. Select No and ungraded items will be included
in calculations. If No is selected, Teachers cannot change the setting to ignore ungraded
items. When nulls are ignored, the Total and Weighted Total columns in the Grade
Center are renamed to Running Total and Running Weighted Total.
4.
Click Submit.
2007 Blackboard Inc. Proprietary and Confidential.
Page 84
Blackboard K–12 Academic Suite
Administrator Manual
Set Class Images
Overview
Administrators select images to appear in all Classes from the Set Class Images page. Two
images appear next to each other on the bottom of the Class and one image appears at the top of
the Class Menu on the left side of the main page.
Find this page
Follow these steps to open the Set Class Images page.
1.
Click Images and Icons on the Administrator Panel.
2.
Click Set Class Images from the Images and Icons page.
Fields
The table below details the fields on the Set Class Images page.
F i e ld
Descript ion
View/Select Class Images
Main Class Page/Primary Bottom Image
Current
Image
Displays the primary image that appears at the bottom of all Classes.
Banner
URL
Enter a URL that links to the primary image. A user clicking on the image will
access this URL. When adding a URL, do so as http //www.blackboard.com, not
www.blackboard.com or blackboard.com
Name of
Link
Name the link to the primary image.
Banner
Image
Enter the path of an image file or click Browse to find an image file on the
system. This image will become the primary image that appears at the bottom
of all Classes. The file must be in .GIF or .JPEG format.
Remove
Image
Click this check box to remove the primary image.
Main Class Page/Secondary Bottom Image
©
Current
Image
Displays the secondary image that appears at the bottom of all Classes.
Banner
URL
Enter a URL that links to the secondary image. A user clicking on the image will
access this URL. When adding a URL, do so as http //www.blackboard.com, not
www.blackboard.com or blackboard.com
Name of
Link
Name the link to the secondary image.
Banner
Image
Enter the path of an image file or click Browse to find an image file on the
system. This image will become the secondary image. The file must be in .GIF
or .JPEG format.
2007 Blackboard Inc. Proprietary and Confidential.
Page 85
Blackboard K–12 Academic Suite
F i e ld
Descript ion
Remove
Image
Click this check box to remove the secondary image.
Administrator Manual
Class Page/Class Menu Image
©
Current
Image
Displays the image that appears at the top of the Class Menu of all Classes.
Banner
URL
Enter a URL that links to the image. A user clicking on the image will access
this URL. When adding a URL, do so as http //www.blackboard.com, not
www.blackboard.com or blackboard.com
Name of
Link
Name of the link to the image.
Banner
Image
Enter the path of an image file or click Browse to find an image file on the
system. This image will become the image that appears at the top of the Class
Menu of all Classes. The file must be in .GIF or .JPEG format.
Remove
Image
Click this check box to remove the image from the top of the Class Menu.
2007 Blackboard Inc. Proprietary and Confidential.
Page 86
Blackboard K–12 Academic Suite
Administrator Manual
Select Icon Themes
Overview
Administrators select a theme for icons from the Select Icon Themes page. Selecting a theme will
add colorful icons to folders, documents, and other items within the Blackboard K-12 Suite. Icons
make it easy for users to navigate through the Blackboard K-12 Suite and quickly identify
important information.
Find this page
Follow these steps to open the Select Icon Themes page.
1.
Click Images and Icons on the Administrator Panel.
2.
Click Select Icon Themes from the Images and Icons page.
Function
Click on a sample to view all icons in that theme. Select a theme from the list by clicking on the
drop-down arrow. Click Submit to apply that theme across the Blackboard K-12 Suite. Changing
the icon theme changes the appearance of the icons throughout the system. New Classes will
also use the selected icon theme.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 87
Blackboard K–12 Academic Suite
Administrator Manual
Class Catalog
Overview
This section reviews the features that control the Class catalog.
In this section
Class Catalog contains the following topics.
©
T op i c
Descript ion
Manage
Catalog
This topic covers the Manage Class Catalog page. This page lists the
categories and subcategories that make up the catalog and provides options
for creating, changing, and removing categories.
Add or
Modify
Category
This topic covers the Create/Modify Category page. Administrators can
create or edit a category from these pages.
Class
Catalog
Options
This topic covers the Class Catalog Options page. Administrators can control
if the catalog appears to users or if an outside catalog will be used.
2007 Blackboard Inc. Proprietary and Confidential.
Page 88
Blackboard K–12 Academic Suite
Administrator Manual
Manage Catalog
Overview
Administrators add, modify and remove categories to the Class Catalog from the Manage Catalog
page. Categories can be added within categories to create a nested outline structure with main
categories and several deeper levels of subcategories. To view the categories nested within a
category, simply click the Category Name. This will open a new Manage Catalog page with that
Category as the head. For example, The first Manage Catalog page is titled Manage Catalog:
TOP. Clicking on the Category, Law School Classes will change the page title to Manage
Catalog: Law School Classes.
Find this page
Click Catalog on the Admin Panel to open the Manage Catalog page.
Functions
The table below details the functions available on the Manage Class Catalog page.
To . . .
click . . .
view and manage subcategories
the name of a category. If there are sub-categories, a new page
view will appear.
add a category
Add Category to add a category or sub-category to the Class
catalog. The category will be added at the current level.
modify a category
Modify to make changes to a category. When changing the
name of a category, the sub-categories beneath it remain the
same.
remove a category
Remove to delete that category from the Class Catalog. Any
category links to Classes will be removed.
Also, any sub-categories and category links to sub-categories
will be removed.
navigate to previous page
views in the category
hierarchy
the navigation links that appear beneath the Add Category
button. These links begin with Top, which will return to the page
view that lists the first level of categories.
Example
A category, History, has numerous sub-categories including American History, Ancient History,
and World History. Within the World History category, there are sub-categories including African,
Asian, and European History. To add a category on South American history, click on the History
category on the Manage Class Catalog page. Then click on the World History category. A
Manage Class Catalog page with the sub-categories of World History will appear. Click Add
Category to add the following category
History
>World History
>>South American History
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 89
Blackboard K–12 Academic Suite
Administrator Manual
Add or Modify Category
Overview
Class Categories are created and modified from the Add Category page or the Modify Category
page. Clicking Add in the action bar on the Manage Catalog page or Modify for an existing
category will load the Add/Modify Category page.
Categories require a name to be displayed to users and a name unique to the Blackboard
Learning System database called a Category ID. The Category ID allows for multiple categories
with the same name to exist in the database. For example, the sub-category Advanced Classes
could appear multiple times in the Catalog under different categories.
Find this page
Follow these steps to add a category.
1.
Click Catalog on the Admin Panel.
2.
At the top of the Manage Catalog page, click Add Category.
Fields
The table below details the fields on the Add/Modify Category page.
F i e ld
Descript ion
Create/Modify Category
©
Category
Display Name
Enter the name of the category as it should be displayed.
Category ID [r]
Enter an ID name for this category. The Category Mnemonic acts as a
unique identifier for categories. Do not use special characters in this
field. Special characters include %&#<>=+ as well as spaces. When
creating attributes a good rule to follow is only use alphanumeric
characters, underscores, dots, and dashes.
Once this field is set it should not be modified.
Display
Category on
TOP in Catalog
View
Check this box to display this category on the first page of the Catalog
as viewed by users.
Availability
Select Everyone or Selected Roles. If Selected Roles is chosen, use
the multi-select box to determine those roles that should be able to view
the category and associated Classes in the Catalog. Those Institution
Roles that appear in the right side column, Selected Roles, will be able
to view the category.
2007 Blackboard Inc. Proprietary and Confidential.
Page 90
Blackboard K–12 Academic Suite
Administrator Manual
Class Catalog Options
Overview
Administrators may select the default catalog or supply a link to an external Class catalog from
the Gateway Options page.
The default catalog groups Classes into folders and lists them along with buttons for users to
preview Classes or login if they are enrolled in a Class. An Administrator may incorporate a
different catalog via URL. Inserting an outside Class catalog will remove the Blackboard K-12
Suite default catalog and users will not be able to preview Classes or access Classes from the
default catalog.
The Class Catalog appears on the Classes tab. It can also be configured to appear on the
Gateway Page.
Find this page
Follow these steps to open the Class Catalog Options page.
1.
Click Gateway Options on the Administrator Panel.
2. The Class Catalog Options will appear at the top of the page.
Click one of the options to select the catalog. The options are
©
•
default catalog
•
an external Class catalog. Enter the full URL to direct users to an external catalog.
•
suppress the catalog. No catalog will be used on the Blackboard system.
2007 Blackboard Inc. Proprietary and Confidential.
Page 91
Blackboard K–12 Academic Suite
Administrator Manual
Users
Overview
This part of the manual reviews the user management features available on the Administrator
Panel. The features described in this section are used to create, manage, and remove users.
In this part
This part contains the following sections.
©
S e ct io n
Descript ion
Users
This section details the features used to update user accounts.
Institution
Roles
This section details the description, creation and management of Institution
Roles.
System Roles
This section details the features for managing the Administrator privileges
assigned to users.
2007 Blackboard Inc. Proprietary and Confidential.
Page 92
Blackboard K–12 Academic Suite
Administrator Manual
Users Accounts
Overview
This section describes the features used to update user accounts.
In this section
The User Accounts chapter includes the following topics.
©
T op i c
Descript ion
List/Modify Users
This topic covers the Users page. This search page creates a
list of users which can then be modified using several different
options.
Unavailable and Disabled
Records
This topic defines the unavailable and disabled states.
User Properties
This topic covers the User Properties page. From this page an
Administrator can change the attributes associated with the
user account.
Change Password for
User
This topic covers the Change Password for User page.
Administrators can set a password for a user account from this
page.
View Class or
Organization Information
for a User
This topic covers the Class Enrollments page and Organization
Enrollments page. This page lists all the Classes that a user
participates in.
Class Roles
This topic covers the Class Roles used to define user privileges
within a Class.
Create User
This topic explains how to add an individual user to the system.
Batch Create Users
This topic explains how to add multiple users to the system at
once.
Parents
This topic defines Parents and explains how to associate them
with users.
Remove Users from the
System
This topic covers deleting users.
Batch Remove Users from
the System
This topic covers deleting multiple users from the system at
once.
Admin User Accounts
Created at Install
This topic covers the Administrator accounts that are present
when the system is first installed.
2007 Blackboard Inc. Proprietary and Confidential.
Page 93
Blackboard K–12 Academic Suite
Administrator Manual
List and Modify Users
Overview
Administrators can view and update user information from the Users page. User profiles,
passwords, and Class Roles for specific Classes are updated by clicking the Manage button that
appears next to user information. In addition, the Administrator can send an email to a user by
clicking on the user’s email address in the Email column.
Search for users
The following search options are available:
©
•
User Information: Searches for a string of text that appears in the Username, First
Name, Last Name, or Email address. All users matching the criteria are returned. A list
of all users will be returned if there is no text in the search field.
•
Enrolled In: Searches for users based on the number of Classes or Organizations in
which they participate.
•
Last Login: Searches for Users based on the last time they logged in. Searches can be
performed for users that logged in last before, after, or equal to a date.
•
System Roles: Searches for users based on their assigned System Roles.
2007 Blackboard Inc. Proprietary and Confidential.
Page 94
Blackboard K–12 Academic Suite
Administrator Manual
Unavailable and Disabled Records
Overview
Records can have different states. It is important to understand the function of different states
when managing records.
User Records
User records or User Enrollment records that are set to Unavailable are preceded by a circle
symbol with a slash through it. Also, the record will appear in gray text with the exception of the
email address, which may still be clicked to send a message to the user. To make a record
available, click Properties to modify the record and change the availability setting.
With Blackboard K-12 Suite User records and User Enrollment records may also be disabled in
the database. Disabled users records are preceded by a circle symbol with an ‘x’ through it. Like
unavailable records, disabled records will appear in gray text with the exception of the email
address. For more information on the properties of disabled records, please see the Advanced
Integration and Data Management Manual.
Icons to denote a state of unavailable or disabled will appear next to the User Name if applicable
to the User record. If applicable to the User Enrollment record, the icon will appear next to the
User Role.
Change the Availability of a User Record
The availability of user records is set on the Users page. Follow these steps to set records to
available or unavailable.
©
1.
Open the Admin Panel.
2.
Click Users.
3.
Search for a set of users.
4.
Select the check box for each user that should be made available or unavailable.
5.
Click Available or Unavailable in the action bar at the top of the page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 95
Blackboard K–12 Academic Suite
Administrator Manual
User Properties
Overview
Updates to a user’s profile information are made from the User Properties page. The page opens
with some fields already populated with user data entered earlier.
Find this page
Follow these steps to open the User Properties page.
1.
Click Users on the Administrator Panel.
2.
Search for a user.
3.
Click Manage for a user.
4.
Click User Properties.
Fields
The table below details the fields on the User Properties page.
F i e ld
Descript ion
Personal Information
First Name [r]
Edit the user’s first name.
Middle Name
Edit the user’s middle name.
Last Name [r]
Edit the user’s last name.
Email
Edit the user’s email address.
Student ID
Edit the user’s Student ID as defined by the Institution.
Account Information
User Name
Display only.
Other Information
©
Gender
Edit the user’s gender.
Birthdate
Select the user’s birth date from the lists by clicking on the drop-down
arrow or click the calendar icon to select a date.
Education
Level
Edit the user’s education level.
Company
Edit the user’s company.
Job Title
Edit the user’s job title.
Department
Edit the user’s department.
Street 1
Edit the user’s address.
Street 2
Edit any additional address information.
2007 Blackboard Inc. Proprietary and Confidential.
Page 96
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
City
Edit the user’s city.
State/Province
Edit the user’s state or province.
ZIP/Postal
Code
Edit the user’s ZIP code or postal code.
Country
Edit the user’s country.
Web Site
Edit the URL of the user’s personal Web site. When entering a URL, be
sure to enter the URL completely, for example, http
//www.blackboard.com and not www.blackboard.com or blackboard.com.
Home Phone
Edit the home phone number of the user. The phone number will display
exactly as entered.
Work Phone
Edit the work phone number of the user. The phone number will display
exactly as entered.
Work Fax
Edit the fax number of the user. The fax number will display exactly as
entered.
Mobile Phone
Edit the mobile phone of the user. The phone number will display exactly
as entered.
Role
©
Institution
Role
Select Institution Roles. Institution Roles control what the user sees on the
portal. Tabs and modules can be constructed and configured to only
appear to different groups based on Institution Role (with Blackboard
Community System).
System Role
Select System Roles from the drop-down list. System Roles controls the
user’s access to administrative features. The privileges assigned to each
role can be set through the System Roles feature on the Administrator
Panel.
2007 Blackboard Inc. Proprietary and Confidential.
Page 97
Blackboard K–12 Academic Suite
Administrator Manual
Customize User Profile
Overview
Through the Customize User Profile page data fields for user accounts can be renamed and
configured as displayed and editable. The labels of the fields that store data can be changed and
the Administrator can select whether or not users can view and edit data for each field. Once
changes are made, they will appear within the user interface. For example, if the name of the
default Student ID field is changed to ‘Identification’ it will appear as ‘Identification’ everywhere. It
is not possible to change the Institution Role and System Role fields on this page. The only way
to change the names of these fields is to use the Language Pack Editor.
Often fields are not editable in Blackboard K-12 Suite because the data is owned by another
Institutional information system. Administrators can add a URL where users can update this data
that is owned by another information system. When Users access the Edit Personal Information
page the link with instructions will appear at the top of the page.
In other cases, not allowing users to update a field can help ensure business rules and workflows.
For example, some Institutions may decide to lock the Email field, especially if the Institution
assigns email addresses. This ensures that all users have a valid email account that will work
with features such as the Send Email communication tool.
The Customize User Profile page is not available with the Blackboard Learning System - Basic
Edition.
Find this page
Click Customize User Profile on the Administrator Panel.
Fields
The table below details the fields on the Customize User Profile page.
F i e ld
Descript ion
Link Information
Update Link
Select this check box to provide a link to another URL for updating
data that is not editable within the Blackboard K-12 Suite.
URL
Enter the URL to the location where Users can update profile
information. When entering a URL, be sure to enter the URL
completely, for example, http //www.blackboard.com and not
www.blackboard.com or blackboard.com.
Link Title
Enter a name for the link that will appear at the top of the Edit
Personal Information page.
Instructions
Enter instructions for using the link that will appear under the link on
the Edit Personal Information page.
Manage Data Fields
Item
©
Displays the data item. The default label for each item is the name of
the item. This field is display only.
2007 Blackboard Inc. Proprietary and Confidential.
Page 98
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Display
Click the check box to display the field. If the field is displayed it will
appear to users. Items that are grayed out may not be modified.
Editable
Click the check box to allow users to change the information stored in
the field. If the field is editable users may change this information from
the Personal Information tool. Items that are grayed out may not be
modified.
Label
Edit the title of the field. The field title will appear as it is entered
throughout the system. The default label is the name of the item as it
appears in the Item column.
Revert All to Defaults
Check here to
revert all fields to
default titles
©
Click the check box and the Label of all fields will revert to the default.
This will not change the Displayed or Editable field settings.
2007 Blackboard Inc. Proprietary and Confidential.
Page 99
Blackboard K–12 Academic Suite
Administrator Manual
Change Password
Overview
Administrators can update a user password from the Change Password for User page. A change
made to the password must be communicated to the user or the user will not be able to login.
Find this page
Follow the steps below to open the Change Password page.
1.
Click Users from the Administrator Panel.
2.
Search for a user.
3.
Click Manage for a user.
4.
Click Change Password.
Fields
The table below details the fields on the Change Password page.
F i e ld
Descript ion
Change Password
©
Password [r]
Enter a new password for the user.
Verify Password [r]
Enter the new password again to ensure that there were no errors.
2007 Blackboard Inc. Proprietary and Confidential.
Page 100
Blackboard K–12 Academic Suite
Administrator Manual
View Class Information for a User
Overview
The Class Enrollment page shows user enrollments. A link appears next to each Class to
navigate to the Modify User Properties page for that Class where the user's enrollment status
may be changed. Please note that changing a user's enrollment status requires the appropriate
privileges for the Class.
Find this page
Follow the steps below to open the View User and Class Information page.
©
1.
Click Users on the Administrator Panel.
2.
Search for a user.
3.
Click Manage.
4.
Click Class Enrollments.
2007 Blackboard Inc. Proprietary and Confidential.
Page 101
Blackboard K–12 Academic Suite
Administrator Manual
Class and Organization Roles
Overview
Class Roles control access to the content and tools within a Class. Each user is assigned a role
for each Class (or Organization) in which they participate. For example, a User with a role of
Teaching Assistant in one Class can have a role of Student in another Class. Teachers may use
these roles to delegate some of the responsibility for maintaining the Class.
The Class Role is set when a User is enrolled. It can also be modified after enrollment from the
Class Control Panel of the Class.
Class Roles include:
•
Class Builder
•
Grader
•
Guest
•
Teacher
•
Student
•
Teacher’s Assistant
•
Anonymous
Note: The Class Control Panel privileges associated with each Class Role can
be modified using the User Privileges feature. In addition, the names of the
Class Roles can be changed with the Class Role Rename feature.
Class Builder
The Class Builder role has access to most areas of the Class Control Panel. This role is
appropriate for a research assistant or to an assistant who has limited responsibilities, but should
not have access to Student Grades.
Note: If the Class is unavailable to Students, a Class Builder can still access the
Class. a Class Builder cannot remove a Teacher from a Class.
Class Builders have access to the following areas within the Class Control Panel
©
*Class Information
Settings
*Class Documents
Import Course Cartridge
*Assignments
Import Package
*External Links
*Resources
*Announcements
Class Copy
*Class Calendar
Export Class
*Teacher Information
List / Modify Users
2007 Blackboard Inc. Proprietary and Confidential.
Page 102
Blackboard K–12 Academic Suite
Administrator Manual
*Tasks
Create User
*Discussion Boards
Batch Create Users for Class
*Send Email
Enroll User
*Collaboration
Remove Users from the Class
*Digital Drop Box
*Manage Groups
Manage Class Menu
*Test Manager
Archive Class
*Survey Manager
Recycle Class
*Pool Manager
*Manage Tools
* Settings for areas with an asterisk (*) cannot be modified on the User Privileges page.
Note: All options within the available areas of the Class Control Panel may not
be available.
Grader
The Grader role has limited access to the Class Control Panel. Grader would assist the Teacher
in the creation, management, delivery, and grading of Assessments and Surveys. Grader may
also assist the Teacher with adding manual entries to the Online Grade Center.
Note: If a Class is unavailable to Students, the Class will appear in the My
Classes module and Class list for a user with the role of Grader, but the
Grader will not be able to enter the Class until the Class is available.
Graders have access to the following areas within the Class Control Panel
*Announcements
*Survey Manager
*Class Calendar
*Pool Manager
*Digital Drop Box
*Grade Center
List/Modify Users – may not modify content
*Grade Center Views
*Test Manager
*Class Statistics
* Settings for areas with an asterisk (*) cannot be modified on the User Privileges page.
Note: All options within the available areas of the Class Control Panel may
not be available.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 103
Blackboard K–12 Academic Suite
Administrator Manual
Guest and Anonymous Users
Users with the role of Guest or anonymous users have no access to the Class Control Panel. If
Guest access is enabled by the System Administrator, a Teacher can make areas within a Class
accessible to unauthenticated users or Guest users.
Visitors to the Blackboard K-12 Suite such as prospective Students, alumni or parents may be
given the role of Guest.
Anonymous users are those that access the system and have not been authenticated. Users can
only access the system without logging in when Direct Access is enabled.
Teacher
Teachers have access to all areas in the Class Control Panel. This role is generally given to the
person developing, teaching or facilitating the class. If a Class is unavailable to Students,
Teachers may still access it.
Administrators may modify access to the following areas on the User Privileges page
List / Modify Users
Create User
Class Copy
Recycle Class
Batch Create Users for Class
Import Course Cartridge
Remove Users from the Class
Enroll User
Settings
Export Class
Archive Class
Manage Class Menu
Student
Student is the default Class User Role. As user with the role of Student has no access to any
areas on the Class Control Panel.
Teacher’s Assistant
The Teacher’s Assistant has access to nearly everything in the Class Control Panel. If the Class
is unavailable to Students, Teaching Assistants may still access the Class.
Unlike the Teacher, the Teaching Assistant will not be listed in the Class Catalog listing for the
Class.
Note: Teaching Assistant cannot remove a Teacher from a Class.
Administrators may modify access to the following areas on the User Privileges page
©
List / Modify Users
Class Copy
Create User
Recycle Class
Batch Create Users for Class
Import Course Cartridge
2007 Blackboard Inc. Proprietary and Confidential.
Page 104
Blackboard K–12 Academic Suite
Remove Users from the Class
Enroll User
Settings
©
Administrator Manual
Export Class
Archive Class
Manage Class Menu
2007 Blackboard Inc. Proprietary and Confidential.
Page 105
Blackboard K–12 Academic Suite
Administrator Manual
Create User
Overview
Create user records from the Create Users page. Creating a Username and password allows a
user to login.
Find this page
Click + User on the User page.
Fields
The table below details the fields on the Create User page.
F i e ld
Descript ion
Personal Information
First Name [r]
Enter the new user’s first name. This field is required.
Middle Name
Enter the new user’s middle name.
Last Name [r]
Enter the new user’s last name. This field is required.
Email
Enter the new user’s email address. This field is required.
Student ID
Enter the new user’s Student ID as defined by the Institution.
Account Information
User Name [r]
Enter a user name for the new user. This field is required.
Password [r]
Enter a password for the user’s account. The password must be at least
one character and contain no spaces.
Verify
Password [r]
Enter the user’s password again to ensure accuracy.
Other Information
©
Gender
Enter the new user’s gender.
Birthday
Select the new user’s birthday from the drop-down lists.
Education
Level
Enter the new user’s education level.
Company
Enter the new user’s company.
Job Title
Enter the new user’s job title.
Department
Enter the new user’s department.
Street 1
Enter the new user’s address.
Street 2
Enter any additional address information.
City
Enter the new user’s city.
State/Province
Enter the new user’s state or province.
2007 Blackboard Inc. Proprietary and Confidential.
Page 106
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
ZIP/Postal
Code
Enter the new user’s ZIP code or postal code.
Country
Enter the new user’s country.
Web Site
Enter the URL of the user’s personal Web site. When entering a URL, be
sure to enter the URL completely, for example, http
//www.blackboard.com and not www.blackboard.com or
blackboard.com.
Home Phone
Enter the home phone number of the user. The phone number will display
exactly as entered.
Work Phone
Enter the work phone number of the user. The phone number will display
exactly as entered.
Work Fax
Enter the fax number of the user. The fax number will display exactly as
entered.
Mobile Phone
Enter the mobile phone of the user. The phone number will display
exactly as entered.
Role
©
Institution
Roles
Select Institution Roles. Institution Roles control what the user sees on
the portal. Tabs and modules can be constructed and configured to only
appear to different groups based on Institution Role (with Blackboard
Community System).
System Roles
Select System Roles from the drop-down list. System Roles controls the
user’s access to administrative features. The privileges assigned to each
role can be set through the System Roles feature on the Administrator
Panel.
2007 Blackboard Inc. Proprietary and Confidential.
Page 107
Blackboard K–12 Academic Suite
Administrator Manual
Batch Create Users
Overview
Numbers of users can be added from the Batch Create Users page. Using a batch file, users are
entered into the Blackboard K-12 Suite quickly and without having to go through the Create User
page to add each user.
Note: If using a batch file created for a previous version of Blackboard K-12
Suite, verify that the fields are in the correct order for the current version. If
necessary, reformat the file so that the fields are in the correct order before
processing the file.
Find this page
Click Batch Add on the User Page.
Fields
The table below details the fields on the Batch Create Users page. The file format is described on
the Batch Create Users page.
F i e ld
Descript ion
File Upload
File Location
Enter the location of the batch user file. Or, click Browse to open up the file
directory, then locate and select the file.
Delimiter
Type of Your
File
Select the delimiter option to be used on the batch user file entered in the
File Location field. If Automatic is selected, the batch file will be analyzed
and the delimiter determined based on the frequency of that character in
the file.
Batch files
Batch files are .txt files that hold large quantities of information to upload Note the following when
creating a batch file
©
•
Fields must be enclosed in double quotes. Example “John”
•
Each field must be separated with a delimiter. Commas, colons, or tabs may be used,
however, you may not use more than one as a delimiter in a batch file. Example
“John”,”Smith”
•
Each record must be separated by a hard return. Example “John”,”Smith”
“Larry”,”Smith”
•
Each batch file should not exceed 500 records due to time out restrictions associated
with most browsers.
•
Do not include blank lines between records. The blank line will be processed and return
an error.
2007 Blackboard Inc. Proprietary and Confidential.
Page 108
Blackboard K–12 Academic Suite
Administrator Manual
When files are created for batch loading, regardless of language pack or computer operating
system, the following header fields must be in ASCII (American Standard Code for Information
Interchange) characters:
•
Any Boolean field (Y/N, T/F)
•
Any ID such as Course ID or Organization ID
•
Username
•
Email address
Header fields may contain any ASCII alphanumerical characters, underscores “_”, dots “.”, and
dashes “-”.
Headers fields cannot contain the following special characters: %, &, *, #, >, <, +, =
All data contained in these fields must also be in ASCII characters and the same rules for
acceptable characters apply.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 109
Blackboard K–12 Academic Suite
Administrator Manual
Parents
Overview
Parents are user roles that are attached to other users. Parents can view the same content as
users but cannot modify or interact with content intended for the observed users. The Parent role
can be used to let parents of a Student or an academic advisor monitor progress. Each Parent
can be assigned multiple users so that a parent can observe all their children on the Blackboard
system or an advisor can view all their advisees on the system. Also, each Student can have
more than one Parent. The Teacher for each Class can limit what Parents can see.
Parents in the Blackboard system can be viewed and linked or unlinked from users from the
Manage User page.
Users must have their System Role set to Parent to appear in the list of available Parents. Be
aware that Parents are not able to enroll in Classes as Students.
Create a Parent
Create a Parent by creating a user and assigning the user the Primary Institution Role and
System Role of Parent. When these roles are set, the User will appear as a Parent when setting
Parent Associations.
Associate Parents with a User
Establishing an association between Parents and a user allows the Parents to view the same
Classes and content as the Student. Parents cannot interact with Classes or content on behalf of
the Student.
Follow these steps to associate Parents with a User.
1.
Open the Admin Panel.
2.
Click Users.
3.
Search for a User.
4.
Click Modify for a User.
5.
Click Parent Associations.
6.
Click Add in the action bar.
7.
Enter the Parent Usernames separated by a comma or click Browse to search for Parent
Usernames. Additional Parents can be added at any time using the Add function.
It is also possible to email Parents from the Parent Associations page. Click on an email address
to send an email.
To remove a Parent Association, select the Parent Associations to delete and then click Remove
in the action bar. This will not remove the Parent from the Blackboard system, it will only delete
the association between the user and the Parent.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 110
Blackboard K–12 Academic Suite
Administrator Manual
Parent Gateway
The Parent Gateway is a portal module that allows Parents to quickly switch between users they
are observing. For example, a parent with more than one child enrolled can use the Parent
Gateway to switch from following one child to following the other child. The Parent Gateway is
found in the list of modules and can be managed in the same way as other modules.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 111
Blackboard K–12 Academic Suite
Administrator Manual
Remove Users from the System
Overview
Remove users from the Blackboard system on the Users page. Removed users cannot be
restored to the Blackboard system. To replace a removed user, create a new profile for the user
and enroll the user in the appropriate Classes. A removed user that is recreated will not retain
any of the settings or data associated with the old user.
Removing users
Follow these steps to remove users.
1.
Search for users on the Users page.
2.
Click the check box for each user to be removed.
3.
Click Remove Users. The selected users will be removed from the Blackboard system.
Note: Removing users will also remove any Class data associated with the user
(including Grades!). If a user is created again, Class data will not reappear
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 112
Blackboard K–12 Academic Suite
Administrator Manual
Batch Remove Users from the System
Overview
Numbers of users can be removed from the Blackboard system through the Batch Remove Users
from the System page. Using a batch file, users are quickly removed from the Blackboard system.
Removed user records cannot be restored they must be recreated.
Note: If using a batch file created for a previous version of Blackboard K-12
Suite, verify that the fields are in the correct order for the current version.
Batch Remove Users page
Click Batch Remove Users on the User page.
Batch Remove Users fields
The table below details the fields on the Batch Remove Users from the System page.
F i e ld
Descript ion
File Upload
File Location
Enter the location of the batch user file. Or, click Browse to open up the file
directory, then locate and select the file.
Delimiter
Type of Your
File
Select the delimiter option to be used on the batch user file entered in the
File Location field. If Automatic is selected, the batch file will be analyzed
and the delimiter determined based on the frequency of that character in
the file.
Batch files
Batch files are .txt files that hold large quantities of information to upload Note the following when
creating a batch file
©
•
Fields must be enclosed in double quotes. Example “John”
•
Each field must be separated with a delimiter. Commas, colons, or tabs may be used,
however, you may not use more than one as a delimiter in a batch file. Example
“John”,”Smith”
•
Each record must be separated by a hard return. Example “John”,”Smith”
“Larry”,”Smith”
•
Each batch file should not exceed 500 records due to time out restrictions associated
with most browsers.
•
Do not include blank lines between records. The blank line will be processed and return
an error.
2007 Blackboard Inc. Proprietary and Confidential.
Page 113
Blackboard K–12 Academic Suite
Administrator Manual
Admin User Accounts Created at Install
Overview
When the Blackboard K-12 Suite is installed three User accounts with admin privileges are
created
•
Administrator
•
root_admin
•
integration
Administrator
The Administrator account has full Blackboard system Administrator privileges. This account, and
the root_admin account are the only two accounts that can login until more users are created.
The password for the Administrator account is set during the installation of the Blackboard K-12
Suite.
root_admin
The root_admin account has full administrative privileges including the management of virtual
installations through the Administrator Panel. When the root_admin account views the
Administrator Panel the Manage Virtual Installations link appears at the top of the panel. The
root_admin can login to any virtual installation and access the Virtual Installation management
features from this link.
The password for this account is set during installation.
Note: The root_admin account is created even if your license does not include
the use of any virtual installations. The root_admin account can be modified from
the Edit Root Administrator Profile page.
integration
The integration user is used only to facilitate Snapshot operations. This account cannot be used
to login through the GUI nor does it appear in any lists of users on the GUI. To change the
password for this account, use the Integration Password feature available on the Administrator
Panel.
The default password for the integration account is set at installation.
For more information on how the integration account is used during Snapshot processes, please
see the Blackboard K-12 Suite Advanced Integration and Data Management Manual.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 114
Blackboard K–12 Academic Suite
©
2007 Blackboard Inc. Proprietary and Confidential.
Administrator Manual
Page 115
Blackboard K–12 Academic Suite
Administrator Manual
Institution Roles
Overview
This section includes information on Institution Roles.
In this section
This section includes the following topics.
©
T op i c
Descript ion
About Institution Roles
This topic introduces the concept of Institution Roles.
Features of Institution Roles
This topic explains the attributes of Institution Roles and how
they are applied in the system.
Planning Institution Roles
This topic reviews how to create an implementation plan for
Institution Roles.
Create an Institution Role
This topic provides instructions for creating an Institution Role.
Assign Institution Roles to
Users
This topic provides instructions for defining users through
Institution Roles.
Assign Institution Roles
Through Snapshot
This topic explains how to use the Snapshot integration tools
to apply Institution Roles to users.
Remove an Institution Role
This topic provides instructions for removing an Institution
Role.
Apply Institution Roles to
Community Features
This topic explains how to use Institution Roles to control the
appearance and availability Community features.
2007 Blackboard Inc. Proprietary and Confidential.
Page 116
Blackboard K–12 Academic Suite
Administrator Manual
About Institution Roles
Overview
Institution Roles control access to information and services. Portal features such as tabs,
modules, and brands can be controlled through Institution Roles. Institution Roles are a part of
the Blackboard Community System that extends to features and functions in other systems, such
as the Blackboard Content System. The Virtual hard drive uses Institution Roles to determine file
access for specific user groups. Institution Roles make the Blackboard K-12 Suite a role-based
system where tools and content are defined for distinct groups of one, few, or many users.
Available with the Blackboard Community System
Institution Roles are available when licensing the Blackboard Community System. If the
Blackboard Community System is not licensed Institution Roles cannot be used to control create
role-based information and services.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 117
Blackboard K–12 Academic Suite
Administrator Manual
Features of Institution Roles
Overview
Each user is associated with one or more Institution Roles. Therefore each Institution Roles is
associated with a group of users.
For example, an Institution Role of CY_2008 groups all users that are in the 2008 class year.
Content can be created and presented to only this group of users. The following example shows
how two different users on two different campuses
Institution Roles are only one kind of role associated with users. Users are also associated with
an admin user role, and can be associated with Class and Organization Roles.
Role IDs and Role Labels
Roles are defined by a Role ID and a Role Label. The Role ID is a unique value to identify the
role. The Role ID is used when integrating with other systems using Snapshot or the APIs.
The Role Label is a more descriptive title for the role. The Role Label must also be unique. The
Role Label appears in the user interface. It is used when selecting Institution Roles for a user or
when applying content and tools to Institution Roles.
Removable and Non-Removable Institution Roles
Previous versions of the Blackboard K-12 Suite included a set of 20 Institution Roles. These roles
still appear as Non-Removable Institution Roles. This means that these roles cannot be deleted
and the Role ID for these roles cannot be changed (although the Role Labels can be changed).
Protecting these roles and their Role IDs ensures that existing Building Blocks, outside code
relying on the APIs, and other integrations that rely on these roles will continue to work.
Removable Institution Roles are Institution Roles created specifically for the school.
Primary Institution Role and Secondary Institution Roles
Each user is assigned a Primary Institution Role. The Primary Institution Role is required. Some
tools in the Blackboard Learning System and the Blackboard Content System can be defined
based on the Primary Institution Role.
Each user can be assigned many Secondary Institution Roles. Portal content, such as tabs and
modules, are presented to users based on all of the user's Institution Roles.
Primary and Secondary Institution Roles are distinctions applied to users. an Institution Role is
not set aside as primary or secondary until it is applied to a user. For example, the Institution Role
CY_2008 could be the Primary Role for one user and a Secondary Role for another user. A user
can have the same role appear as both the Primary Institution Role and as a Secondary
Institution Role.
Note: The default Primary Institution Role is the role with a Role ID of 'Student'.
This is a non-removable role so the Role ID cannot be changed. However, be
careful when changing the Role Label as this role will be the Primary Institution
Role of any user created without one. Further, if a user's Primary Institution Role
is removed from the system the user's new Primary Institution Role will be Role
ID = 'Student'.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 118
Blackboard K–12 Academic Suite
Administrator Manual
Planning Institution Roles
Overview
Implementing Institution Roles requires detailed planning to maximize benefits as well as avoid
inconsistencies and overlaps. One of the best places to start is with other systems on the campus
that store Student information. Applying the same model for organizing Student information to
Institution Roles ensures consistency with the school.
Design Approach
Using a design approach designs the content first and then decides who should have access.
Consider plotting out content such as Blackboard Content System content, brands, tabs, and
modules first. Create and apply roles that match the design and can incorporate new content and
future growth.
Define Types
Create Institution Roles in groupings. For example, use types such as campus, major, and class
year to define Institution Roles. In this example, a Student's Institution Roles may be
Designation:
STUDENT (Primary Institution Role)
Campus:
CAMPUS_CENTRAL
Major:
MAJOR_PHYSICS
Class Year:
CY_2008
Use a naming convention
Institution Roles are listed in alphabetical order. A naming convention based on the Institution
Role types ensures that Institution Roles are easy to find in the Blackboard system and are not
missed.
Consider the Campus type in the example above. If there are three campuses, Central, East, and
West, the Institution Roles that apply to each campus should appear together in the Blackboard
system. Name the Institution Roles CAMPUS_CENTRAL, CAMPUS_EAST, and
CAMPUS_WEST will ensure that the roles are easy to locate and applied correctly.
Create Users for testing
Create test users based on the Institution Roles model. The test Users can be used to quickly
preview the Blackboard system and adjust settings. For example, create a test User to see the
Blackboard system through the viewpoint of a prospective Student.
Note: It is important to create a test User for anonymous (unauthenticated) users
such as Guests. Changes to the Guest Institution Role can have serious
consequences as, in most cases, this Institution Role controls what users that
have not logged in can see ID = 'Student'.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 119
Blackboard K–12 Academic Suite
Administrator Manual
Example
The example below shows the planned effect of Institution Roles on two sample users.
User: Jane Smith
Role
S e r vi c e s
Campus – East
(primary)
East Branding
General Campus Announcements
Dept – East Campus
Chemistry
Chemistry Department News and Announcements
Chemistry Department instructional tools such as simulations and
interactive tutors
Function – Faculty
Administrative resources and forms
Portfolio publishing capabilities
Status – Active Fulltime Professor
Special events for full-time faculty
Job – Student
Advisor
Training resources and guidelines for advisors
Job – East Campus
Science Faculty
Science faculty content collection of reusable learning objects,
videos, and still imagery licensed by the department for teaching
100 MB of virtual hard drive space
User: Darrin Longhorn
©
Role
S e r vi c e s
Campus – West
(primary)
West Branding
General Campus Announcements
West Traffic Updates
Campus – East
General Campus Announcements
Dept – West Campus
Chemistry
(none)
Function – Faculty
Administrative resources and forms
Portfolio publishing capabilities
Status – Adjunct
Guidelines for Adjunct Faculty
Job – West Campus
Science Faculty
200 MB of virtual hard drive space
Job – East Campus
Science Faculty
Science faculty content collection of reusable learning objects,
videos, and still imagery licensed by the department for teaching
100 MB of virtual hard drive space
2007 Blackboard Inc. Proprietary and Confidential.
Page 120
Blackboard K–12 Academic Suite
Administrator Manual
Create an Institution Role
Overview
Make sure that an Institution Role matches the design model and naming convention for
Institution Roles used at the school. Roles that are created can be later removed, but better
results will come from detailed planning before creating any Institution Roles.
Create an Institution Role
Follow these steps to create an Institution Role.
1.
Develop a plan for handling Institution Roles. See Planning Institution Roles for tips.
2.
Login as a user with Administrator privileges.
3.
Open the Administrator Panel.
4.
Click Manage Institution Roles.
5.
Click Add Role.
6.
Enter a Role ID and a Role Label.
7.
Although optional, it is a good idea to add a Description of the role.
8.
Click Submit to finish. The Institution Role will now appear on the Manage Institution
Roles page. The Institution Role can be attached to users and used to define content.
Institution Role attributes
The table below explains the attributes that define Institution Roles.
©
F i e ld
Descript ion
Role ID
Identifies the Institution Role in the database and to external systems.
This field is required and must be unique. Use only alphanumeric characters.
Do not use spaces or special characters.
This field has a limit of 50 characters.
Role Label
Identifies the Institution Role within the user interface.
This field is required and must be unique.
This field has a limit of 50 characters.
Description
Provide usage notes or comments for administrators about the Institution
Role. Only users with administrative privileges see this description.
This field is not required. HTML code entered in this field will not be
recognized.
This field has a limit of 1000 characters.
2007 Blackboard Inc. Proprietary and Confidential.
Page 121
Blackboard K–12 Academic Suite
Administrator Manual
Assign Institution Roles to Users
Overview
Institution Roles can be assigned to users when the user is created or afterward by modifying the
user.
Setting an Institution Role requires Administrator privileges. When a Teacher creates a user
through a Class Control Panel the user is created with the default Primary Institution Role (Role
ID='Student').
Assign an Institution Role from the Administrator Panel
an Institution Role can be assigned when creating a user or when modifying an existing user.
Follow these steps to assign an Institution Role to a user.
1.
Login as a user with Administrator privileges.
2.
Open the Administrator Panel.
3.
Click User. Click Manage for a user and then User Properties.
4.
Enter user data or modify the other fields on the page as needed.
5.
Scroll down to the Roles and Availability heading.
6.
Select a Primary Institution Role. A Primary Institution Role is required for each user.
7.
Use the multi-select box to choose Secondary Institution Roles. Choose none, one, or
many Institution Roles. The table below describes how to use the multi-select box to
choose Institution Roles.
To . . .
click . . .
Select a Primary
Institution Role
Click on an Institution Role in the Available Roles column. Click the right
arrow next to the Primary Institution Role field to assign the highlighted
role as the Primary Institution Role.
Select
Secondary
Institution Roles
Click on an Institution Role in the Available Roles column. Hold down the
CTRL key to select multiple roles. Click the right arrow next to the
Secondary Institution Roles box to assign the highlighted roles as
Secondary Institution Roles.
Deselect a
Secondary
Institution Role
Click on an Institution Role in the Secondary Institution Roles box. Hold
down the CTRL key to select multiple roles. Click the left arrow to
remove the role.
Finish entering or modifying user data and click Submit.
Remove Institution Roles from a User
Removing an Institution Role from a user prevents that user from accessing content meant for
that role. The Primary Institution Role may be changed but it cannot be removed from the user
interface.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 122
Blackboard K–12 Academic Suite
Administrator Manual
Assign an Institution Role with the Batch Create Users process
The Batch Create Users process will add many users to the Blackboard system. Each record in
the batch file can contain a Primary Institution Role. The Primary Institution Role is included using
a mapped value within the database.
Follow these steps to locate the value for an Institution Role.
1.
Login as a user with administrative privileges.
2.
Open the Administrator Panel.
3.
Click Batch Create Users. Locate the hyperlink find in the instructions.
4.
Click Find to display a page that shows the Role ID and the matching Batch Value.
5. Use the Batch Value to set a Primary Institution Role for users during a batch process.
If a Primary Institution Role is not provided for a record, the user will be created with the default
Primary Institution Role of 'Student'.
It is not possible to attach Secondary Institution Roles to a user during the Batch Create process.
Secondary Institution Roles must be attached to the user after creation.
root_admin Institution Roles
The root_admin user has access to manage Virtual Installations. The User Properties for the
root_admin user are set from the Virtual Installation Administrator Panel. The Institution Roles for
the root_admin user must be set through the Administrator Panel for each Virtual Installation
because Institution Roles are not shared across Virtual Installations.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 123
Blackboard K–12 Academic Suite
Administrator Manual
Assign Institution Roles through Snapshot
Overview
Institution Roles can be attached to users through Snapshot and the APIs. For information on
using the APIs to assign Institution Roles please see the Administrative API specifications.
Snapshot Files
Snapshot User files include the INSTITUTION_ROLE element. This represents the Primary
Institution Role and is expressed as the Role ID.
Secondary Institution Roles are added through a new Snapshot file type, User Institution Role
Membership. Each record matches one User to one Institution Role. To match a user to multiple
Institution Roles requires multiple records in the file. The table below outlines the fields included
in a record in a Snapshot User Institution Role Membership file.
E l e me nt
Descript ion
EXTERNAL_PERSON_KEY
A unique identifier for a user at the Institution This ID is provided by the
Institution and is not displayed to users.
String. Max length 64
Not Null, External Key
ROLE_ID
Institution Role.
Passed as a string. Not null.
Commands
The following command line operations handle User Institution Role Membership files.
O pe rat ion
Descript ion
PORTAL_ROLE_MEM_MANUAL
Performs a smart update for Institution Roles.
PORTAL_ROLE_MEM_REMOVE
Removes all Institution Roles in the feed file.
PORTAL_ROLE_MEM_SNPSHT
To process a snapshot feed of Institution Roles.
DISABLE_PORTAL_ROLE_MEMBERSHIP
To disable all Institution Roles for a datasource.
PURGE_PORTAL_ROLE_MEMBERSHIP
To purge all Institution Roles entities for a datasource.
Purge only deletes disabled items.
For more information on running the Snapshot tool please see the Blackboard Learning System
Data Integration Manual.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 124
Blackboard K–12 Academic Suite
Administrator Manual
Remove an Institution Role
Overview
Removing an Institution Role also removes the link between users and that Institution Role. If the
removed role is the Primary Institution Role for a user, the Primary Institution Role for the user will
return to the default (Role ID='Student'). Any content set to display only to the removed role will
still exist in the Blackboard system but users will not be able to see it until the Institution Roles
associated with the content are updated.
Remove an Institution Role
Follow these steps to remove an Institution Role from the Blackboard system.
Note: Removing an Institution Role is permanent. To restore the role, recreate it
and reassign it to users. To avoid having to recreate and reassign the role
consider using Snapshot to disable the Institution Role rather than removing the
role.
©
1.
Login as a user with Administrator privileges.
2.
Open the Administrator Panel.
3.
Click Manage Institution Roles.
4.
Select the roles to remove.
5.
Click Remove Roles.
6.
A confirmation window appears. Click OK. The selected Institution Roles are no longer in
the Blackboard system.
2007 Blackboard Inc. Proprietary and Confidential.
Page 125
Blackboard K–12 Academic Suite
Administrator Manual
Apply Institution Roles to Portal Features
Overview
Institution Roles control what brands, tabs, and modules that users see.
Apply Institution Roles to a brand
Brands define the colors and images of the top frame including the tabs. Access to brands is
controlled by host name and Primary Institution Role. Host names determine the URL used to
access the Blackboard K-12 Suite.
For example, create two additional hostnames so that the Blackboard K-12 Suite can be
accessed from:
http //blackboard.yourinstitution.com
http //lawschool.yourinstitution.com
http //medicalschool.yourinstitution.com
Now, create separate brands for users based on the host name used to access the Blackboard
system. Users will see a different brand depending on the URL. Primary Institution Roles can be
applied to further customize brands so that a Student using http
//lawschool.yourinstitution.com will see a different brand than a Teacher or Prospective
Student.
Apply Institution Roles to a tab or module
Tabs or modules are configured to display to one, many, or all Institution Roles. Institution Roles
are applied to a tab or module from the Tab Properties page or the Module Tabs page.
The association between content and Institution Roles is defined distinctly for each role. For
example, If content is made available to the Campus_East and Student Institution Roles, the
content will be available to all users with an Institution Role of Campus East as well as all users
with an Institution Role of Students. Use the multi-select box to choose roles.
©
To . . .
click . . .
Select an
Institution Role
Click on an Institution Role in the Available Roles column. Hold down
the Control key to select multiple roles. Click the right arrow to move
the role to the Selected roles column.
Select all
Institution Roles
except those
highlighted
Click on the Institution Roles in the Available Roles column that should
not have access to the content. Click Invert. The highlighted roles are
no longer highlighted. Those roles that were not highlighted are now
highlighted. Click the right arrow to move the role to the Selected roles
column.
Invert works in both the Available Roles and the Selected Roles column.
Deselect an
Institution Role
Click on an Institution Role in the Selected Roles column. Click the left
arrow to remove the role from the Selected roles column.
2007 Blackboard Inc. Proprietary and Confidential.
Page 126
Blackboard K–12 Academic Suite
Administrator Manual
System Roles
Overview
This section details the features for managing the Administrator privileges assigned to users.
In this section
This Section includes the following topics.
©
T op i c
Descript ion
About System Roles
This topic introduces the concept of System Roles.
System Role Privileges
This topic explains how to define a System Role by attaching
privileges.
Apply System Roles to a
User
This topic explains how to assign System Roles to a user.
2007 Blackboard Inc. Proprietary and Confidential.
Page 127
Blackboard K–12 Academic Suite
Administrator Manual
About System Roles
Overview
System Roles enable administrative privileges. System Roles are assigned in two ways:
•
Attached to the user account at creation or through the Manage User page.
•
Assigned to a user with a domain to create a domain administrator.
In both instances, multiple System Roles can be assigned to the user. Multiple System Roles
grant the user the sum of their privileges. This makes it possible to create System Roles based
on tasks and flexibly apply privileges.
Note: Be very careful when assigning System Roles with administrative
privileges directly to a user account. Privileges granted to a user in this way apply
to the entire system. Applying a System Role to a user within a domain will only
allow that user privileges within the domain. Please see the topics on domains for
more information about applying System Roles within a domain.
System Administrator Role required
Only a user with full System Administrator privileges can assign privileges to System Roles.
How to Create a System Role
Follow these steps to create a System Role.
1.
Open the Administrator Panel.
2.
Click System Roles.
3.
Click Add System Role.
4.
Enter a Role Name and a Role ID. The Role Name appears in the user interface and the
Role ID is a unique identifier for the database. Once set, the Role ID cannot be changed.
5.
Enter a description for the System Role.
6. Click Submit.
It is also possible to create a new System Role by copying an existing System Role and changing
the Role Name and Role ID. Follow these steps to copy a System Role.
1.
Open the Administrator Panel.
2.
Click System Roles.
3.
Click Copy for a System Role.
4.
Enter a new Role Name and a new Role ID.
5.
Enter a new Description.
6.
Click Submit. A new System Role will now appear with the same privileges as the old
System Role.
The next step after creating a System Role is assigning privileges to the System Role.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 128
Blackboard K–12 Academic Suite
Administrator Manual
System Role Privileges
Overview
Hundreds of distinct actions can be enabled or disabled for a System Role. Remember that
System Roles are additive, so add only the minimum privileges for each role. One of the best
methods for modeling System Roles is to do so by task. Group like tasks into System Roles and
then apply the System Roles to users. This will make it easy to add and remove access to
administrative features as responsibilities change.
Privileges
There are three main areas in the interface where privileges are defined:
•
Administrator Panel: Grants access to functions on the Administrator Panel.
•
Control Panel: Grants access to functions on the Class or Organization Control Panel.
•
Tool Panel: Grants access to functions on the tool panel that appears on module tabs,
such as the My Institution Tab.
Privileges on the Manage Privileges page are defined by their access point in the interface. For
example the privilege to control modules appears as: Administrator Panel (Community System
– Management) > Modules
Some privileges are already grouped on the Manage Privileges page. These have only one check
box for all the enclosed privileges. For example, the privileges to add tabs appear as:
Administrator Panel (Community System – Management) > Tabs > Add Link
TabAdministrator Panel (Community System – Management) > Tabs > Add Module
TabAdministrator Panel (Community System – Management) > Tabs > Add Tool Tab
How to apply Privileges to a role
Follow these steps to apply or remove privileges from a System Role.
©
1.
Open the Administrator Panel.
2.
Click System Roles.
3.
Click Manage for a System Role. The Manage Privileges page will appear.
4.
Use the check boxes to select privileges. Click Enable Privileges or Disable Privileges
at the top of the page to add or remove the selected privileges from the System Role.
5.
Click OK.
2007 Blackboard Inc. Proprietary and Confidential.
Page 129
Blackboard K–12 Academic Suite
Administrator Manual
Apply System Roles to a User
Overview
System Roles are applied when a user is created. At creation, a primary System Role must be
selected. The default value is None. After a user is created, System Roles can be added or
removed from the User Properties page. Also, System Roles can be applied in domains. Applying
System Roles in a domain limits the user to using the privileges assigned in the System Role to
the data in the domain.
Assign a System Role from the Administrator Panel
Follow these steps to assign a System Role to a user.
©
1.
Open the Administrator Panel.
2.
Click User. Click Manage for a User and then click User Properties.
3.
Scroll down to the Roles heading.
4.
Select a primary System Role.
5.
Use the multi-select box to choose Secondary System Roles and click Submit.
T o…
C l ic k…
Select a Primary
System Role
Click on a System Role in the Available Roles column. Click the right
arrow next to the Primary System Role field to assign the highlighted role
as the Primary System Role.
Select
Secondary
System Roles
Click on a System Role in the Available Roles column. Hold down the
CTRL key to select multiple roles. Click the right arrow next to the
Secondary System Roles box to assign the highlighted roles as
Secondary System Roles.
Deselect a
Secondary
System Role
Click on a System Role in the Secondary System Roles box. Hold down
the CTRL key to select multiple roles. Click the left arrow to remove the
role.
2007 Blackboard Inc. Proprietary and Confidential.
Page 130
Blackboard K–12 Academic Suite
Administrator Manual
Community Areas
Overview
The Community areas consists of the tabs appearing in the header frame that link to the tabs and
the modules, links, images, and tools that make up the content of those tabs.
In this part
This part of the Blackboard K-12 Suite Administrator Manual includes the following sections.
S e ct io n
Descript ion
Tabs
This chapter details the tools for administering portal tabs, also
called tabs.
Modules
This chapter details the tools for administering modules.
Channels
This chapter details the tools for administering channels of
content for modules.
Brands
This chapter details the tools for administering brands on the
system.
Tool Panel
This chapter details the features for administering the Tool Panel.
Community System
Settings
This chapter details some of the settings for controlling the portal.
Tabs
The Blackboard Learning System and Blackboard Learning System - Basic Edition include basic
tabs. The Blackboard Community System includes basic tabs, advanced tabs, and tools for
building tabs for specific sets of users.
Blackboard Learning System includes several tabs as part of the portal. The basic tabs included
with Blackboard Learning System are
•
My Institution: This tab acts as a gateway to the portal and provides users with content
from within and outside the Blackboard Learning System environment.
•
Classes: An online area dedicated to learning. From this tab, users access the Web
sites for their Classes.
•
System Admin: Only accessible by users with Administrator privileges.
The Blackboard Community System also includes advanced tabs and the ability to create new
tabs. The advanced tabs and tab templates are
©
•
Community: An online area dedicated to clubs, Organizations, and other
extracurricular activities.
•
Services: Typically used to connect users to other Institutional offerings.
•
The Web: A tab that can be set to access a URL and display the content within the tab.
By default this tab is disabled.
2007 Blackboard Inc. Proprietary and Confidential.
Page 131
Blackboard K–12 Academic Suite
©
Administrator Manual
•
Module tab: Administrators can create additional tabs that include modules similar to
the My Institution tab.
•
Tool tab: Administrators can create additional tabs that point to a tool within the
Blackboard Learning System.
•
Link tab: Administrators can create additional tabs that point to a URL.
2007 Blackboard Inc. Proprietary and Confidential.
Page 132
Blackboard K–12 Academic Suite
Administrator Manual
Tabs
Overview
This section covers the features that control the availability and the content of the tabs.
Note: Most of the portal management features listed in this chapter are only
available when licensing the Blackboard Community System.
In this section
This section includes the following topics.
©
T op i c
Descript ion
Manage Tabs
This topic covers the Manage Tabs page. This page lists all the tabs in the
system and includes features for modifying content and making tabs
available.
Add Module
Tab
This topic covers the Add Module Tab page. Administrators can add a
custom module tab from this page.
Add Tool Tab
This topic covers the Add Tool Tab page. Administrators can add a custom
tool tab from this page.
Add Link Tab
This topic covers the Add Link Tab. Administrators can add a custom Link
tab from this page.
Tab Properties
This topic covers the Tab Properties page. This page includes controls for
the name and availability of each tab.
Modify Tab
This topic covers the Modify Tab page. This menu page includes links to
manage the content on the left side of tabs (except for tool and module
tabs). For specific tabs this page may include links to additional features.
Menu Column
Properties
This topic covers the Menu Column Properties page. This page controls
the names and availability of the sections that appear on the left side of
some tabs.
Manage Hot
Link Content
This topic covers the Manage Hot Link Content page. Administrators can
control the links that appear on the links section of the left side of a tab
from this page.
Add/Modify Hot
Link Content
This topic covers the Add and Modify Link pages. From these pages
Administrators can add or change a link that appears on the left side of a
content area.
Manage Hot
Spots Content
This topic covers the Manage Hot Spots Content page. Administrators can
add images to the left side of a tab from this page.
Default Content
This topic covers the Default Content page. Administrators can define
which modules may appear and which modules are required to appear on
the tab. This page is only available for the My Institution tab or custom
module areas.
2007 Blackboard Inc. Proprietary and Confidential.
Page 133
Blackboard K–12 Academic Suite
©
Administrator Manual
T op i c
Descript ion
Default Layout
This topic covers the Default Layout page. Administrators define the color
scheme for the modules on the tab as well as the default position of each
module.
Preview By
Institution Role
This topic covers the Preview By Institution Role page. This page displays
what a tab will look like to users with the selected Institution Role.
Services
This topic covers the Services page. This page contains the folders and
Services links that make up the Services tab.
Add/Modify
Services Folder
This topic covers the Add and Modify Services Folder pages.
Administrators can create or change a folder for the Services tab from this
page.
Add Services
Link
This topic covers the Add Services Link page. From this page
Administrators can add links to the Services tab.
2007 Blackboard Inc. Proprietary and Confidential.
Page 134
Blackboard K–12 Academic Suite
Administrator Manual
Manage Tabs
Overview
The tabs are organized through the Manage Tabs page. Tabs contain links to Classes and
Organizations, modules of content, user tools, and external links to additional services and
content.
Privileges can be applied to each Institution Role so that, for example, users with an Institution
Role of Alumni could have access to a completely different set of tabs than users with an
Institution Role of Staff or Faculty.
Note: When assigning the availability of tabs to user roles, it is important to
check that each user role has access to at least one available tab in the system.
Note: The advanced features on this page, such as adding a Tab, are only
available to those users that license the Blackboard Community System.
Find this page
Click Manage Tabs on the Administrator Panel.
Functions
The table below details the functions available on the Manage Tabs page.
©
To . . .
click . . .
change the order that
tabs appear (from left
to right in the header
frame)
The drop-down arrow next to a tab in the list. From the drop-down
list, select a number. The tab will appear in that position.
add a Module Tab
Module Tab in the action bar. The Add Module Tab page will
appear.
add a Tool Tab
Tool Tab in the action bar. The Add Tool Tab page will appear.
add a Link Tab
Link Tab in the action bar. The Add Link Tab page will appear.
modify a tab
Modify for a tab in the list. For the My Institution, Classes,
Community, Services tab, and any Module tabs created by the
Administrator, a Modify Tab page will appear. For all other tabs,
clicking Modify will immediately open the Tab Properties page.
remove a tab
Remove for a tab in the list. Removing a tab cannot be undone. To
prevent users from accessing a particular tab, modify the Institution
Roles that have privileges to view the tab from the Tab Properties
page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 135
Blackboard K–12 Academic Suite
©
Administrator Manual
To . . .
click . . .
preview a tab based
on user role
The drop-down arrow and select an Institution Role from the list in
the action bar. Click Preview and a new browser window will open
with the tabs as those users will see them.
2007 Blackboard Inc. Proprietary and Confidential.
Page 136
Blackboard K–12 Academic Suite
Administrator Manual
Add Module Tab
Overview
Modules are distinct packets of information with data generated from within the Blackboard K-12
Suite and from outside sources. Module tabs added by the Administrator function much the same
way as the My Institution tab. Multiple module tabs can be created with content for specific
Institution Roles. The Services tab, Community tab, and Classes tab also function as module
tabs.
Any Module Tab may be created with either one or two columns of modules, in addition to the
menu column, if any of the menus are enabled. Once a tab is created, the number of columns
cannot be modified.
Find this Page
Follow these steps to create a module tab.
1.
Select Manage Tabs in the Administrator Panel. The Manage Tabs page appears.
2.
Click Add Module Tab.
Fields
The table below details the entry fields on the Add Module Tab page.
©
F i e ld
Descript ion
Title
The title of the tab can be changed by editing the text that appears in this
field. The title will appear as the Tab name in the header frame.
Allow users to
personalize
the tab
This field only appears when changing the properties for the My Institution
Tab or a Module tab created by the Administrator. Selecting Yes allows
users to organize the modules on the tab and customize the appearance of
the modules.
Number of
Columns
Select either 1 or 2 to set the number of columns of modules.
System
Availability
Select either the Yes option or the No option. If Yes is selected, the tab will
be viewable by users. (The System Admin Tab is always available to the
Administrator.)
Available to
Select either Everyone or Specific Roles to make the tab available to all
users or only to users with specific roles. If Specific Roles is selected,
select the roles to which the tab should be made available using the multiselect box. To select one or more roles, select the roles in Available Roles
and use the arrows to move the roles to Selected Roles.
2007 Blackboard Inc. Proprietary and Confidential.
Page 137
Blackboard K–12 Academic Suite
Administrator Manual
Add Tool Tab
Overview
Tool tabs give access to a specific tool within Blackboard K-12 Suite. Multiple tool tabs can be
created to allow specific Institution Roles access to specific tools. For example, users with an
Institution Role of Student could be given access to a tab that displayed the My Grades tool. This
tab would most likely not be made available to users with an Institution Role of Alumni.
Find this page
Follow these steps to open the Add Tool Tab page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Tool Tab in the action bar at the top of the Manage Tabs page.
Fields
The table below details the fields on the Add Tool Tab page.
F i e ld
Descript ion
Enter Tab Information
Title [r]
Enter a title for the Tool tab. The title will appear as the Tab name in
the header frame.
Tool [r]
Select a Tool from the drop-down list. The tool selected will be
available through the tab.
Availability
©
System Availability
Select Yes to make the tab available to users.
Available to specific
Institution Roles
Select Everyone or Specific Roles. If Specific Roles is selected
click the check boxes to determine which Institution Roles have
privileges to view the tab.
2007 Blackboard Inc. Proprietary and Confidential.
Page 138
Blackboard K–12 Academic Suite
Administrator Manual
Add Link Tab
Overview
Link tabs display content from an outside Web page in a Blackboard Community System tab. Link
tabs can give direct access to other Institutional Web sites for specific Institution Roles or allow
users to access the Web site of an education partner.
Find this page
Follow these steps to open the Add Link Tab page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Link Tab in the action bar at the top of the Manage Tabs page.
Fields
The table below details the fields on the Add Link Tab page.
F i e ld
Descript ion
Enter Tab Information
Title [r]
Enter a title for the Link tab. The title will appear as the Tab name in
the header frame.
External Link [r]
Enter the full URL for a Web page (Example http
//www.blackboard.com). The Web page will be accessible through the
tab.
Availability
©
System Availability
Select Yes to make the tab available to users.
Available to
specific Institution
Roles
Select Everyone or Specific Roles. If Specific Roles is selected
click the check boxes to determine which Institution Roles have
privileges to view the tab.
2007 Blackboard Inc. Proprietary and Confidential.
Page 139
Blackboard K–12 Academic Suite
Administrator Manual
Tab Properties
Overview
The Tab Properties page is similar for each Tab. From this page, the name of the tab can be
changed, and the Institution Roles that can access the Tab are defined.
Find this page
Follow these steps to open the Tab Properties page for a specific tab.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for a tab.
3.
Click Tab Properties.
Fields
The table below details the fields on the Tab Properties page.
F i e ld
Descript ion
Enter Tab Information
Title [r]
The title of the tab can be changed by editing the text that appears in
this field. The title will appear as the Tab name in the header frame.
URL/Tool
If the tab is a Tool tab, this field will be display only and will list the tool
accessible through the tab. If the tab is a Link tab, change the URL by
editing the URL as it appears in the field.
Allow users to
personalize tab
This field only appears when changing the properties for a Module
tab. Selecting Yes allows users to organize the modules on the tab
and customize the appearance of the modules.
Number of
Columns
The number of columns on this tab appears; it may not be modified on
this page.
Availability
System Availability
Select Yes to make the tab available to users.
Available to
specific Institution
Roles
Select Everyone or Specific Roles. If Specific Roles is selected
click the check boxes to determine which Institution Roles have
privileges to view the tab.
Note: The Tab Properties page for the Classes tab includes an Allow Guest
field. If Yes is selected, Guest users have access to the Classes tab.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 140
Blackboard K–12 Academic Suite
Administrator Manual
Modify Tab
Overview
The Modify Tab menu page appears when changing the following tabs: My Institution, Classes,
Community, Services, or a module tab. The functions available for each tab are listed below.
Find this page
Follow these steps to open the Modify Tab page for a specific tab.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for one of the following tabs: My Institution, Classes, Communities,
Services, or any module tab created by the Administrator.
3.
The Modify Tab page will appear. The functions on this page will differ depending on the
Tab selected.
Menu pages
Menus appear for the tabs as listed below.
•
Tab Properties
•
Default Content
•
Default Layout
•
Preview Tab
•
Menu Column Properties
•
Manage Hot Link Content
•
Manage Hot Spots Content
A link to the Services page also appears when Modify is selected for the Services Tab.
Tool tabs and Link tabs do not have space in the tab for additional content. When modifying a
Tool tab or a Link tab the Tab Properties page includes all the configuration options.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 141
Blackboard K–12 Academic Suite
Administrator Manual
Menu Column Properties
Overview
The Menu Column appears on the My Institution Tab, Classes Tab, Community Tab, Services
Tab, and any module tabs. From the Menu Column Properties page, the name and availability of
different features can be configured; as well as the design for the menu. The following features
can appear on the left side of a tab
•
Tools: Blackboard Tools that are organized through the Tool Panel.
•
Hot Links: Links that are managed through the Manage Link Content page or the
Manage Off-Campus Content page.
•
Hot Spots: Images and links that are managed through the Manage Hot Spots page.
Find this page
Follow these steps to find the Menu Column Properties page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for one of the following tabs: My Institution, Classes, Communities,
Services, or any module tab created by the Administrator. The Modify Tab page will
appear. The functions on this page will differ depending on the Tab selected.
3.
Click Menu Column Properties.
Fields
The table below details the fields on the Left Side Tool Panel Properties page.
F i e ld
Descript ion
Enter Toolbar Properties
Tools Available
Select Yes to make the Tool Panel available.
Tools Name
Edit the name of the Tool Panel.
Hot Links Available
Select Yes to make the Hot Links area available.
Hot Links Name
Edit the name of the Hot Links area.
Hot Spots Available
Select Yes to make the Hot Spots area available.
Hot Spots Name
Edit the name of the Hot Spots area.
Customize Menu Column Theme
Select a design for the Menu column.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 142
Blackboard K–12 Academic Suite
Administrator Manual
Manage Hot Links Content
Overview
The Links that appear on the left side of a tab are managed from the Manage Hot Links page.
Find this page
Follow these steps to open a Manage Links page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for one of the following tabs: Classes, Communities, Services, or any
module tab created by the Administrator. The Modify Tab page will appear.
3.
Click Manage Hot Link Content.
Functions
The table below details the functions available on the Manage Hot Link Content page.
©
To . . .
click . . .
add a link
External Link in the action bar. The Add Link page will appear.
modify a link
Modify for a link in the list. The Modify Link page will appear.
remove a link
Remove for a link in the list. This action is irreversible.
change the
placement of a link
The drop-down arrow next to a link in the list. Select the numbered
position that the link should appear in sequence with the other links.
2007 Blackboard Inc. Proprietary and Confidential.
Page 143
Blackboard K–12 Academic Suite
Administrator Manual
Add and Modify Hot Link Content
Overview
Links for the left side of a tab are added and modified from the Add/Modify Add / Modify Hot Link
Content page view. Links can access educational partners, research tools, or any Web page
relevant to the Institution.
Find this page
Follow these steps to open the Add/Modify Links page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for one of the following tabs: My Institution, Classes, Communities,
Services, or any module tab created by the Administrator.
3.
Click Manage Hot Link Content.
4.
Click Add URL or Modify for an existing URL. A page view will appear with fields for
creating a link or modifying an existing one.
Fields
The table below details the fields on the Add/Modify Link page view.
F i e ld
Descript ion
URL Information
Name
Enter a name for the link. The name will appear in the Hot Links
box.
URL
Enter the URL for the link. When entering a URL, do so as http
//www.blackboard.com, not www.blackboard.com or
blackboard.com.
Description
Enter a description of the link. The description will appear below
the link name in the partnerships box.
Options
©
Do you want to make
the URL visible?
Click Yes to make the link available.
Launch in External
Window
Click Yes or No to determine if the link opens the Web site in an
external browser window.
Choose date
restrictions
Check Display After and Display Until then select the range of
dates that the folder will appear.
2007 Blackboard Inc. Proprietary and Confidential.
Page 144
Blackboard K–12 Academic Suite
Administrator Manual
Manage Hot Spots
Overview
Hot Spot Content can be used to display advertisements or other images relevant to the
Institution. Primary Hot Spot content appears as a header on the Community tab. Secondary Hot
Spot images appear below the Off-Campus Links in the Tool Panel on portal tabs. Hot Spot
images can be uploaded by the Administrator or the HTML option can be used to import outside
images and information.
Note: The data entered on this page for the Primary Hot Spots Content
automatically appears in the Primary Hot Spots module. This module may be
accessed through the Manage Modules page. The module content may only be
modified on the Manage Hot Spots page.
Find this page
Follow these steps to open a Manage Hot Spot page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for one of the following tabs: My Institution, Classes, Communities,
Services, or any module tab created by the Administrator.
3.
Click Manage Hot Spots.
Fields
The table below details the fields on the Manage Hot Spots page.
F i e ld
Descript ion
Modify Primary Hot Spots Content
None
Click this option to leave the primary Hot Spot on the left side of the tab blank.
Local
Image
and Link
Click this option to add a local image as the primary Hot Spot image.
Enter a file name or click Browse to search for an image file. This image will
appear as the primary sponsor if the Local Image and Link option is clicked.
Enter a URL. The URL will open in a separate browser when the image is
clicked. When entering a URL, be sure to enter the URL completely, for
example, http //www.blackboard.com and not www.blackboard.com or
blackboard.com.
HTML
Sometimes when using an ad server the company running the ad server will
provide HTML code to serve the ad. Post that HTML code in this box to display
the ads.
Modify Secondary Hot Spots Content
None
©
Click this option to leave the secondary Hot Spot on the left side of the tab
blank.
2007 Blackboard Inc. Proprietary and Confidential.
Page 145
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Image
Link
Click this option to add a local image as the secondary sponsor image.
Enter a file name or click Browse to search for an image file. This image will
appear as the secondary sponsor if the Image Link option is selected.
Enter a URL. The URL will open in a separate browser when the image is
clicked. When entering a URL, be sure to enter the URL completely, for
example, http //www.blackboard.com and not www.blackboard.com or
blackboard.com.
HTML
Sometimes when using an ad server the company running the ad server will
provide HTML code to serve the ad. Post that HTML code in this box to display
the ads.
Note: The Module Properties page for the Community Tab includes a third Hot
Spot Content section.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 146
Blackboard K–12 Academic Suite
Administrator Manual
Default Content
Overview
The modules are listed with check boxes in two columns DISPLAYED and REQUIRED.
Displayed modules will be available to users and required modules will always appear to users.
Users can determine whether or not the displayed modules appear on their view of the tab.
Required modules will always appear to users.
Find this page
Follow these steps to open the Default Content page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for the My Institution tab or a module tab created by the Administrator.
3.
Click Default Content from the Modify Tab page. The Default Content page will appear.
Functions
The table below details the functions available on the Default Content page.
©
To . . .
click . . .
assign a module to
appear on the tab
the check box in the Displayed column for modules that should
appear on the tab. A check mark in the box indicates that the
module will appear on the tab. Click the check box again to remove
a module from the tab.
require a module to
appear on the tab
the check box in the Required column for modules that should
appear on the tab. A check mark in the box indicates that the
module will always appear on the tab. Click the check box again to
set modules to not required.
organize module
placement and
appearance on the tab
Default Layout in the instructions at the top of the page. The
Default Layout page will appear.
2007 Blackboard Inc. Proprietary and Confidential.
Page 147
Blackboard K–12 Academic Suite
Administrator Manual
Default Layout
Overview
The appearance and Organization of modules on a tab is configured from the Default Layout
page. The Administrator can create additional module themes to change the appearance of
modules from the Customize Module Theme page.
Find this Page
Follow these steps to open the Default Layout page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify next to the My Institution Tab or a Module Tab.
3.
Click Default Layout from the Modify Tab page.
Fields
The table below details the fields on the Default Layout page.
F i e ld
Descript ion
Set Column Widths
Column
Widths
Select the width of each column in the tab. To use the Default values, select
Default. The Menu Column may be specified in pixels or percentages. The
default value for the Menu Column is 150 pixels. The Pixels and Percentages
option specifies the Menu Column in pixels and the other columns in
percentages. To specify the menu column in percentages, select Percentages
and enter the numeric value for each column’s width. The total value of all
percentages must be equal to or less than 100%.
Set Header
Header
Select a module to use as a header for the tab. If the tab should not have footer,
select No Header.
He ad er
W id ths
Select the width across which the selected header module should span. A
header can span across all columns or across the content columns only.
Set Content Layout
Column
1
The list contains all the modules that will appear in the left column of modules on
the tab. Re-order the tabs by selecting one and clicking the up arrow or down
arrow to change its position. To move a tab to the Column 2, click the right
arrow. To remove a module from the Column 1, click the X.
Column
2
The list contains all the modules that will appear in the right column of modules
on the tab. This panel only appears if the tab has two columns. Re-order the
tabs by selecting one and clicking the up arrow or down arrow to change its
position. To move a tab to the Column 1, click the left arrow. To remove a
module from the Column 2, click the X.
Set Footer
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 148
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Footer
Select a module to use as footer for the tab. If the tab should not have footer,
select No Footer.
Footer
Width
Select the width across which the selected footer module should span. A footer
can span across all columns or across the content columns only.
Set Module Theme
Select
Theme
©
Select one of the themes for displaying modules on the tab. Additional themes
can be created through the Customize Module Theme feature.
2007 Blackboard Inc. Proprietary and Confidential.
Page 149
Blackboard K–12 Academic Suite
Administrator Manual
Preview by Institution Role
Overview
Administrators can test how a tab appears for specific Institution Roles from the Preview by
Institution Role page. When a role is selected, the tab will appear in the page exactly as it will
appear to that role.
Find this page
Follow these steps to open the Preview by Institution Role page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for the My Institution tab or a module tab created by the Administrator.
3.
Click Preview By Institution Role from the Modify Tab page.
Functions
Select an Institution Role from the drop-down list and click Go. The tab view for that Institution
Role will appear on the page.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 150
Blackboard K–12 Academic Suite
Administrator Manual
Services
Overview
The Services tab displays links. Most often, these links point to other services offered at the
Institution. Service Links can be organized into folders and subfolders to create an outline of
Services.
Find this page
Follow these steps to open the Services page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for the Services tab.
3.
Click Services from the Modify Tab page.
Functions
The table below details the functions available on the Services page.
©
To . . .
click . . .
order the links
the drop-down arrow and select a number from the list for a link. The links
will appear in numerical order on the Services area or within the folder.
There is no limit on the number of links that can be displayed.
follow a link
the hyperlink of an external link to follow the link to a Web site.
add a link
Add External Link in the action bar. The Services Add link page will
appear.
modify a link
Modify for a particular link.
remove a link
Remove for a link to permanently remove it from the tab. This action is
irreversible.
add folder
Add Folder in the action bar. The Add Folder page will appear.
view links and
folders within a
folder
the folder name. A page view will appear with all the folders and links that
appear in that folder.
remove a folder
Remove for a folder to permanently remove it from the tab. This action is
irreversible and will also remove any links and folders that appear within
that folder.
modify a folder
Modify for a folder. The Modify Folder page will appear.
copy a folder
Copy for a folder. The Copy Folder page will appear.
2007 Blackboard Inc. Proprietary and Confidential.
Page 151
Blackboard K–12 Academic Suite
Administrator Manual
Add/Modify Services Folder
Overview
Services Folders can hold links to Services and other folders.
Folders may be added or modified by accessing the Add Folder page view or Modify Folder page
view. The fields on the Add Folder page and Modify Folder page are the same. The Add Folder
page opens with empty fields while the Modify Folder page opens with a folder already populated.
Find this page
Follow these steps to open the Add Services Folder or Modify Services Folder page.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for the Services tab.
3.
Click Services from the Modify Tab page.
4.
From the action bar, click Add Folder or click Modify for an existing Folder.
Fields
The table below details the fields on the Add/Modify page view.
F i e ld
Descript ion
Item Information
Name
Select a name that best describes the content of the
folder.
Or, specify your own name
Enter a customized name for the folder.
Choose Color of Name
Click Pick to select a text color for the folder name. The
default color is black.
Text
Enter a description of the folder.
Options
©
Choose date restrictions
Select the range of dates that the folder will appear.
Do you want to make the folder
available?
Select Yes to indicate that the item is available to Users.
2007 Blackboard Inc. Proprietary and Confidential.
Page 152
Blackboard K–12 Academic Suite
Administrator Manual
Add Services Link
Overview
Links are added to the Services tab from the Services-Add Link page view. Links may appear
directly on the tab or within a folder.
Find this page
Follow these steps to open the Add or Modify Services Link page view.
1.
Click Manage Tabs on the Administrator Panel.
2.
Click Modify for the Services tab.
3.
Click Services from the Modify Tab page.
4.
From the action bar, click Link. Or click Modify for a link that already exists.
Fields
The table below details the fields on the Add Services Link page view.
F i e ld
Descript ion
URL Information
Link Name
Enter a name for the link.
URL
Enter a URL for the link. Enter the full URL, for example http
//www.blackboard.com, not www.blackboard.com or
blackboard.com
Description
Enter a description of the link.
Options
©
Do you want to make
the URL visible?
Click Yes to display the URL as part of the link. The URL will
appear after the link name.
Launch item in
external window
Click Yes or No to open the link in an external window.
Choose data
restrictions
Check Display After and Display Until then select the range of
dates that the folder will appear.
2007 Blackboard Inc. Proprietary and Confidential.
Page 153
Blackboard K–12 Academic Suite
Administrator Manual
Manage Modules
Overview
This section describes the features for managing and creating portal modules.
In this section
The following topics cover managing modules.
©
T op i c
Descript ion
Manage Modules
This topic covers the Manage Modules page. Administrators
create, modify, and determine the availability of modules from this
page.
Create a New Module
This topic covers the procedure for creating a new module.
Module Properties
This topic explains how to change the general information and
availability for a module.
Login Module
This topic explains the Login Module.
Module Contents:
Login Module
This topic covers the Module Contents: Login Module page. This
page is used to build the Login module content.
Class Creation Module
This topic covers the Class Creation Module. It explains how to
build a module that allows other users to create Classes.
Discussion Board
Creation Module
This topic covers the Discussion Board Creation Module. It
explains how to build a module that allows other users to create
Institution Discussion Boards.
Tutorial Modules
This topic covers the Tutorial Modules. It describes how to make
modules that explain Blackboard features available to users.
What’s New? Module
This topic explains the What’s New Module.
Module Contents: My
Classes Module
This topic covers the My Classes module. It describes the default
values for this module.
Module Contents:
Classes List Module
This topic covers the Classes List module. It describes the default
values for this module.
Module Contents:
Channel Module
This topic covers the Module Contents: Channel Module page.
This page is used to build the module content.
Module Contents:
HTML Module
This topic covers the Module Contents: HTML Module page. This
page is used to build the module content.
Module Contents: URL
Module
This topic covers the Module Contents: URL Module page. This
page is used to build the module content.
Module Contents:
Multi-Section Module
This topic covers the Module Contents: Multi-Section Module
page. This page is used to build the module content.
Add/Modify Section to a
Multi-Section Module
This topic covers the Add and Modify Section to a Multi-Section
Module pages. Administrators can add or change sections of the
module from this page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 154
Blackboard K–12 Academic Suite
©
Administrator Manual
T op i c
Descript ion
Module Contents:
Opinion Poll Module
This topic covers the Module Contents Opinion Poll Module page.
This page is used to build the module content.
Module Contents:
Multiple Choice
Module
This topic covers the Module Contents Multiple Choice Module
page. This page is used to build the module content.
Module Contents:
Image Module
This topic covers the Module Contents Image Module page. This
page is used to build the module content.
Module Contents:
External Link Module
This topic covers the Module Contents External Link Module
page. This page is used to build the module content.
Add/Modify Link to an
External Link Module
This topic covers the Add and Modify Link to an External Link
Module pages. Administrators can add or edit the links that appear
in the module from this page.
Export Module
This topic covers the Export Module page. This page is used to
create a Building Block of modules that appear on the system.
2007 Blackboard Inc. Proprietary and Confidential.
Page 155
Blackboard K–12 Academic Suite
Administrator Manual
Manage Modules
Overview
Modules are packets of content that appear on the My Institution tab or customized Module tabs.
From the Manage Modules page an Administrator can add and modify modules as well as control
the content of modules.
To determine what modules will appear on a tab, use the Default Content page for a particular
content area.
Find this Page
Click Manage Modules on the Administrator Panel.
Functions
The following functions are available from the Manage Modules page.
To...
C l ic k . . .
add a module
Module in the action bar
remove a module
The checkbox for the module in the list, then Remove Selected
in the action bar.
modify a module
Properties for a module in the list.
customize the content of a
module
Contents for a module in the list. The appropriate Modify
Module page will appear.
view a module
The module name. The module will appear as users see it on a
tab.
Blackboard Content System Modules
If the Blackboard Content System is installed, an additional set of Portal Modules is available.
These include:
©
•
Content Collection: Class Content
•
Content Collection: Bookmarks
•
Content Collection: Institution Content
•
Content Collection: My Content
•
Content Collection: My Portfolios
•
Content Collection: Organization Content (This is only available with the Blackboard
Community System)
•
Content Collection: Search Blackboard Content System
•
Content Collection: Workflow Activities
2007 Blackboard Inc. Proprietary and Confidential.
Page 156
Blackboard K–12 Academic Suite
Administrator Manual
Create a New Module
Overview
Modules can only be created with the Blackboard Community System license. Several different
types of modules can be created from the Administrator Panel or Administrators can use Building
Blocks technology to create a completely new and customized module and add it to the
Blackboard Community System. Once modules are created they can be set to appear on the My
Institution tab or any other tab that accepts modules.
To create a module using Building Blocks technology, please refer to the Blackboard Building
Blocks Module Developer’s Guide or the Building Blocks Web site (http
//buildingblocks.blackboard.com).
Create a module
Follow the steps below to create a module from the Administrator Panel.
1.
Plan the module! Decide the type of module to create and what content will be contained
in the module, what Institution Roles should have access to the module, and who will
manage the content of the module.
2.
Go to the Administrator Panel.
3.
Click Manage Modules on the Administrator Panel.
4.
Click Add Module in the action bar at the top of the page.
5.
Enter a title, module type, and description.
6.
Select a setting for System Availability (is the module available system-wide?), Select
from module list (does the module appear to Users as a module they can add or
remove from Module Tabs?), and Allow Personalization (can Users modify the content
of the module?).
7.
Make the module available to Everyone or Specific Roles.
8.
Enter the usernames of any users that will be assigned to manage the content of the
module. If no users are entered, only users with Administrator privileges that include
managing the Portal will be able to manage the content of the module.
9.
Click Submit to create the module.
10. The Module Content page specific to the module type will open.
11. Define the content for the module or click Submit to add the content at another time.
From the Manage Module page, click Contents for a module to edit the content. If users
are assigned to manage the content of a module, they can edit the content from any
Module Tab where the module appears.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 157
Blackboard K–12 Academic Suite
Administrator Manual
Module Properties
Overview
Modules and module properties are set and updated through the Module Properties page. These
pages include the same fields for configuring modules. To modify the content of a module, click
Contents for a module listed on the Manage Modules page.
Note: After completing the Module Properties page and clicking Submit the
Modify Module page appears. Module content is controlled from this page. A
different page will appear depending on the type of module created.
Find this page
Follow these steps to open the Create Module or Edit Module page.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Add Module from the action bar or click Properties for a module in the list.
Fields
The following fields appear on the Module Properties page.
F i e ld
Descript ion
General Properties
Title [r]
Enter or modify a title for the module.
Module Type [r]
Select a module type from the drop-down list. Once selected, this
field cannot be modified.
Description
Enter or modify a description of the module. The description will
appear to users when they select modules to display on a Tab.
Allow users to
Personalize the
module
Select Yes or No to allow Users to change the content of the
module. A Pencil icon will appear in the top right corner of the
module. Clicking the icon takes a User to a page where they can edit
the module content. This option is not available for Blackboard
Learning System - Basic Edition clients.
Allow users to
detach the module
Select Yes or No to allow the module to be removed from the tab by
a user.
Availability
©
System Availability
Select Yes to make the module available.
Available for users
to select from
module list
Select Yes to allow users to select module from the module list. If No
is selected, but the module is selected as part of the Default
Content, the module will always be displayed to users. It will not
appear on the Content page where users may select modules.
2007 Blackboard Inc. Proprietary and Confidential.
Page 158
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Available to specific
Institution Roles
Select Everyone or Specific Roles. If Specific Roles is selected
click the check boxes to determine which Institution Roles have
privileges to view the tab.
Asynchronous
Loading
Check this box to allow the Module to load asynchronously. The user
will be returned to the Portal page regardless of whether or not this
Module has loaded.
Delegated
Administration
Enter the Usernames for all users that should have privileges to
modify and add module content. A comma should separate each
Username. The Users selected to administer a module will see a
Module Admin button on the Tab that will allow them to modify the
content of a Module.
Note: The option to Allow users to detach the module does not appear for
Content Collection modules.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 159
Blackboard K–12 Academic Suite
Administrator Manual
Login Module
Overview
Portal Direct Entry skips the Gateway and Login pages when users access the URL for the
Blackboard K-12 Suite. Instead, users are shown the first portal tab. When users access the
system through Portal Direct Entry, they are considered Guests until they log in. The Login
Module is a portal module that allows users to enter a User Name and Password to log in. This
module can be placed on any Module Tab to allow users to login to the system. For information
on how to add a module to a tab, please see Add Module Tab.
If the Administrator has allows users to create accounts and enabled Portal Direct Entry, a Create
Account link appears in the Login Module.
For more information on enabling Portal Direct Entry or account creation, please see the
Gateway Options topic.
Find this page
Follow these steps to open the Login Module page.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Properties for the Login Module.
Fields
The table below details the fields on the Login Module page.
F i e ld
Descript ion
Enter Tab Information
Title [r]
The title of the Login Module can be edited.
Module Type
Login Module is automatically displayed here.
Description
Enter a description for the Login Module. This description is not displayed to
users.
Availability
System
Availability
This is set to Yes by default if Portal Direct Entry is enabled. This option
may be set to No if Portal Direct Entry is enabled. If No is selected, the
Login Module is removed from all module pages and users must use the
icon at the top of the page to access the Login page.
The Login module cannot be enabled if Portal Direct Entry is not enabled.
Note: The module is no longer available to users once they have logged in.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 160
Blackboard K–12 Academic Suite
Administrator Manual
Module Contents: Login Module
Overview
The Login Module displays to users when Portal Direct Entry is enabled. Text for the Login
Module may be added from the Module Contents Login Module page. The text will appear in the
module along with the fields for entering a User Name and Password.
Find this page
Follow these steps to open the Login Module page
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for the Login Module.
Fields
Enter text to display to users in the Text field of the Login Module. Users may enter HTML in this
area. Users should not add <body> tags, <form> tags, or <form element> tags; entering these
tags will cause issues when the page is accessed by end users.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 161
Blackboard K–12 Academic Suite
Administrator Manual
Class Creation Module
Overview
The Class Creation Module allows Administrators to make Class creation functions available to
users, require users to request that a Class be created, or prevent users from creating Classes. If
users are allowed to create Classes, then the Class Creation Module will appear on the Classes
tab.
When using the Blackboard Community System, Administrators can make this module available
to users with specific Institution Roles, such as faculty members, on the Module Properties page.
Note: Blackboard recommends not allowing all users to create Classes for
security reasons. If all users are allowed to create Classes, Blackboard strongly
recommends prohibiting Teachers from modifying user information. Allowing all
users to create Classes and allowing the Class Teacher, which could be the
person who created the Class, to modify user information is a serious security
concern.
Fields
The table below details the fields on the Class Creation page.
F i e ld
Descript ion
Creation Options
©
Allow users to create
Classes
Click this option to make Class creation functions available to all
users. Blackboard recommends not allowing all users to create
Classes for security reasons.
Allow users to email
requests for Class
creation
Click this option and enter a valid email address in the field to
allow users to request that the Administrator create a Class.
2007 Blackboard Inc. Proprietary and Confidential.
Page 162
Blackboard K–12 Academic Suite
Administrator Manual
Discussion Board Creation Module
Overview
The Discussion Board Creation Module allows Administrators to make the creation of Institution
Discussion Boards available to users. If users are allowed to create Discussion Boards, then the
Discussion Board Creation Module will appear on the Community tab.
Note: Administrators can make this module available to users with specific
Institution Roles on the Properties page for the Discussion Board Creation
module.
Fields
The table below details the fields on the Discussion Board Creation page.
F i e ld
Descript ion
Creation Options
©
Allow users to create
Discussion Boards
Click this option to make Discussion Board creation
functions available to all users.
Allow users to email
requests for Discussion
Board creation
Click this option and enter a valid email address in the field
to allow users to request that the Administrator create a
Discussion Board.
2007 Blackboard Inc. Proprietary and Confidential.
Page 163
Blackboard K–12 Academic Suite
Administrator Manual
Tutorial Modules
Overview
Tutorial Modules contain links to short tutorials produced by Blackboard Product Marketing that
demonstrate the capabilities of the system. If these modules are enabled they appear on the My
Institution page default; however, they may be placed on any module tab.
Types of Tutorial Modules
There are three Tutorial modules available:
©
•
Quick Tutorial Modules - Links to tutorial that demonstrate the key features and
functions of the Blackboard K-12 Suite.
•
Quick Tutorial Catalog - Links to the Quick Tutorial Catalog where users can browse
the tutorials that are available.
•
Quick Tutorials - New Product Enhancements - Links to tutorials about new features
that are divided based on the Release and Application Pack in which they were made
available.
2007 Blackboard Inc. Proprietary and Confidential.
Page 164
Blackboard K–12 Academic Suite
Administrator Manual
What's New? Module
About the What's New? Module
The What's New? module that reports on additions and changes to Class content. It is only
available with the Blackboard Community System. The What's New? module displays the number
of new items for each content type and links to a details page for each Class. The module
displays items going back 7 days. The content types that are reported in the module are:
•
Assessments
•
Assignments
•
Content
The What's New? Module does not report to users when Adaptive Release content becomes
available. It only reports content that is made available across to all users in the Class.
The What's New? module will report changes once a day. Users will see updates the first time
they log in for the day. Any changes made after the user logs in will not be displayed in the
What's New? module until the next day unless the user clicks Refresh.
Users will only see updates for a Class if the Class is available and the user is a participant in the
Class. Keep in mind that if the Guest user is enrolled in any Classes the What's New? module will
report data on these Classes to anyone that accesses the system as Guest.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 165
Blackboard K–12 Academic Suite
Administrator Manual
My Classes Module
Overview
The My Classes module allows the Administrator to display different types of information about
Classes. This module is displayed by default on the My Institution tab. Like other modules, the
Administrator may display the module on any module tab.
Find this page
Follow these steps to open the Modify Module page for a My Classes Module.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for the My Classes module that appears in the list. The Modify My
Classes page will appear.
Fields
Select which information will be displayed within the My Class module. One or more options may
be selected. By default, Class Names and announcements are displayed.
Note: If the Allow users to personalize the module option is selected on the
Module Properties page for this module, users will be able to change the
information that appears when they view the module.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 166
Blackboard K–12 Academic Suite
Administrator Manual
Module Contents: Class List Modules
Overview
The Class List module allows the Administrator to display different types of information about
Classes. This module is displayed by default on the Classes tab. Like other modules, the
Administrator may add it to any module tab.
Find this page
Follow these steps to open the Modify Module page for a My Classes Module.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for the Class List module that appears in the list. The Modify Class List
page will appear.
Fields
Select which information will be displayed within the Class List module. One or more options may
be selected. By default, the Class Names, Announcements, and Teachers are displayed.
Note: If the Allow users to personalize the module option is selected on the
Module Properties page for this module, users will be able to change the
information that appears when they view the module.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 167
Blackboard K–12 Academic Suite
Administrator Manual
Channel Module
Overview
Channel modules stream content from an outside source into a Blackboard Community System
module. The module content is updated at intervals.
To add a channel to Blackboard, contact a channel provider. Channels are presented to users
through Channel Modules and administered through the Manage Channels feature.
Find this page
Follow these steps to open the Modify Module page for a Channel Module.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for a Channel Module that appears in the list. The Modify Module page
will appear with the Channel Module page view loaded.
Field
Select a channel from the drop-down list.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 168
Blackboard K–12 Academic Suite
Administrator Manual
HTML Module
Overview
HTML Modules display information according to HTML code.
Find this page
Follow these steps to open the Modify Module page for a HTML module.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for an HTML Module that appears in the list. The Customize Module page
will appear with the HTML Module page view loaded.
Field
Enter text in the box to display in the module. If HTML is selected then the text will display as
tagged. If Plain Text is selected then the text in the module will appear exactly as written.
The third row of the Visual Text Box Editor may be used to upload files to the module. If a file is
uploaded, it is stored in a folder created by the module on the server in the
\blackboard\content\modules folder. This folder is deleted if the module is removed from the
system. Uploaded files are not included if a module is exported.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 169
Blackboard K–12 Academic Suite
Administrator Manual
URL Module
Overview
URL modules display Web page content from outside of the system. From this page view, the
URL of the Web page is entered. The content from the URL will appear in the module. URL
Modules should be tested before making them available to ensure that the content will display
correctly in a module.
URL Modules differ from External Links Modules because they display the actual content of the
URL instead of a link to the URL.
Find this page
Follow these steps to open the Modify Module page for a URL Module.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for a URL Module that appears in the list. The Modify Module page will
appear with the URL Module page view loaded.
Fields
The table below details the fields on the Modify Module page for an URL Module.
F i e ld
Descript ion
Edit URL Information
©
URL
The URL entered here indicates the Web page that will populate inside the
module. The URL should be entered fully, for example, http
//www.blackboard.com, not blackboard.com.
Maximum
Hours Cached
Select the number of hours (or days) that the Web page remains cached.
Example: If set to 12 hours, the module content will be refreshed from the
URL every 12 hours.
Refresh Cache
on Submit
Check this box to refresh the cache immediately after clicking Submit. If
this box is not checked, the next refresh will occur at the next scheduled
refresh interval.
2007 Blackboard Inc. Proprietary and Confidential.
Page 170
Blackboard K–12 Academic Suite
Administrator Manual
Multi-Section Module
Overview
A Multi-Section module splits the module into sections and displays different content in each
section. From this page view, sections can be added, modified, or removed. The sections will
appear in the module according to the sequence they are listed on this page.
Find this page
Follow these steps to open the Modify Module page for a Multi-Section module.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for a Multi-Section module that appears in the list. The Modify Module
page will appear with the Multi-Section module page view loaded.
Functions
The table below details the available functions on the Multi-Section module page view of the
Customize Module page.
©
To . . .
click . . .
add a section to the
module
Section in the action bar.
modify a section of
the module
Modify for a section in the list.
remove a section of
the module
Remove for a section in the list. The section will be permanently
removed from the module.
set the position of
sections in the
module
a number from the drop-down list in front of a section. This number is
the position that the section will appear in sequence with the other
sections within the module.
2007 Blackboard Inc. Proprietary and Confidential.
Page 171
Blackboard K–12 Academic Suite
Administrator Manual
Add/Modify Section to a Multi-Section Module
Overview
A section is an area of a Multi-Section module dedicated to a piece of content. Content can
include HTML code, links, and images. Sections are arranged and managed from the Modify
Module page loaded with a Multi-Section module.
Find this page
Follow these steps to open the Add Section or Modify Section page view.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for a Multi-Section module that appears in the list.
3.
The Modify Module page will appear with a Multi-Section module loaded.
4.
Click Add Section or Modify for a section in the list.
Fields
The table below details the fields on the Add/Modify Section page view.
F i e ld
Descript ion
Edit Module Text
©
Title [r]
The title for the section. The title will appear at the top of the section.
Display By
Default
This module will automatically be displayed as the default setting.
HTML
Text that displays according to HTML code.
Link Name
Name of a link to another Web page. The name of the link will appear in the
section. Clicking on the link name in the section will open the Web page
identified in the Link URL field.
External Link
URL for the link. The URL must be entered completely. For example, http
//www.blackboard.com, not blackboard.com.
Image alt text
Enter the alt text that will appear to accessibility users for the image.
Image Link
Enter the URL to display an image.
ImageAlign
Select an alignment for the image from the drop-down list. This controls
where the image will appear in the section. The choices are left, center, and
right.
Image Border
Size
Select a border size, in pixels, from the drop-down list. The Image will
appear with a border this size surrounding it.
2007 Blackboard Inc. Proprietary and Confidential.
Page 172
Blackboard K–12 Academic Suite
Administrator Manual
Opinion Poll Module
Overview
Opinion Polls ask a question and give users a chance to enter a full response in a text box. The
module also displays some of the recent responses to the module. The Opinion Poll should not
be used to collect information from Users that should be saved. Opinions are added, posted to
the recent responses section of the module, and disappear as new responses are added.
Find this page
Follow these steps to open the Modify Module page with an Opinion Poll loaded.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for an Opinion Poll Module that appears in the list.
3.
The Modify Module page will appear with an Opinion Poll module loaded.
Fields
The table below details the fields on the Opinion Poll Module page view of the Modify Module
page.
F i e ld
Descript ion
Enter Opinion Poll
©
Question
Enter the question or text.
Allow Multiple
Votes
Allow users to enter multiple opinions on the matter.
Reset
Existing Poll
Remove opinions that have been entered. If Users are only allowed one
response, Users that have already responded will be able to respond again.
2007 Blackboard Inc. Proprietary and Confidential.
Page 173
Blackboard K–12 Academic Suite
Administrator Manual
Module Contents: Multiple Choice Module
Overview
The Multiple Choice module presents a question with multiple answers. Users will see the
question as well as options for selecting one of the answers. After users select an answer, they
will see the results of the poll to date within the module. The only way to see the results of a poll
is to vote.
Find this page
Follow these steps to open the Modify Module page with a Multiple Choice module loaded.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for a Multiple Choice Poll Module that appears in the list. The Modify
Module page will appear with a Multiple Choice module loaded.
Fields
The table below details the fields on the Modify Module page with a Multiple Choice module
loaded.
F i e ld
Descript ion
Enter Poll Question
©
Question
Enter the question.
Answer
Enter up to five possible answers to the poll question.
Reset
Existing Tally
Check this box to remove all votes that have been recorded. The tally for
each option will return to 0. Users that have already voted may vote again.
Feedback
Enter text that will appear once the users complete the question in the
module.
2007 Blackboard Inc. Proprietary and Confidential.
Page 174
Blackboard K–12 Academic Suite
Administrator Manual
Image Module
Overview
Image modules display a graphic in the module. From this page view, the URL of the image is
entered.
Find this page
Follow these steps to open the Modify Module page for an Image Module.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for an Image module that appears in the list. The Modify Module page will
appear with the Image module page view loaded.
Fields
The table below details the fields on the Modify Module page for an Image Module.
F i e ld
Descript ion
Edit Module Text
Image Link
[r]
©
URL for the link. The URL must be entered completely. For example, http
//www.blackboard.com, not blackboard.com.
Image alt text
Enter the alt text that will appear to accessibility users for the image.
ImageAlign
Select an alignment for the image from the drop-down list. This controls
where the image will appear in the section. The choices are left, center, and
right.
Image Border
Size
Select a border size, in pixels, from the drop-down list. The Image will
appear with a border this size.
2007 Blackboard Inc. Proprietary and Confidential.
Page 175
Blackboard K–12 Academic Suite
Administrator Manual
External Link Module
Overview
An External Link module can display several links to outside Web sites. From this page view,
links can be added, modified, or removed. The links will appear in the module according to the
sequence they are listed on this page.
Find this page
Follow these steps to open the Modify Module page for an External Link module.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for an External Links module that appears in the list. The Modify Module
page will appear with the External Link module page view loaded.
Functions
The table below details the available functions on the Modify Module page with an External Link
module loaded.
©
To . . .
click . . .
add a link to the
module
Add Link in the action bar.
modify a section of
the module
Modify for a section in the list.
remove a section of
the module
Remove for a section in the list. The link will be permanently removed
from the module.
set the position of
links in the module
a number from the drop-down list in front of a link. This number is the
position that the link will appear in sequence with the other link within
the module.
2007 Blackboard Inc. Proprietary and Confidential.
Page 176
Blackboard K–12 Academic Suite
Administrator Manual
Add or Modify Link to an External Link Module
Overview
External Links point to outside URLs. Links are arranged and managed from the Modify Module
page loaded with an External Link module.
Find this page
Follow these steps to open the Modify External Links page view.
1.
Click Manage Modules on the Administrator Panel.
2.
Click Contents for an External Links module that appears in the list.
3.
The Modify Module page will appear with an External Link module loaded.
4.
Click Add Link or Modify for a link in the list.
Fields
The table below details the fields on the Add/Modify Link page view.
F i e ld
Descript ion
Edit Link
External
Link [r]
URL for the link. The URL must be entered completely. For example, http
//www.blackboard.com, not blackboard.com.
Link Name
Name of a link to another Web page. The name of the link will appear as
entered. Clicking on the link name in the module will open the Web page
identified in the Link URL field.
[r]
Text Color
©
Click Pick to open the color palette. Click on a color to select it as the text
color for the links.
2007 Blackboard Inc. Proprietary and Confidential.
Page 177
Blackboard K–12 Academic Suite
Administrator Manual
Export Module
Overview
The Export Module page is used to create a Building Block of modules that can be downloaded
and applied. When a package is created it is created with the name given in the Name field as a
.WAR file. It can then be added as a Building Block.
Find this page
Click Export Modules on the Administrator Panel.
Fields
The table below details the fields on the Export Modules page.
F i e ld
Descript ion
Module Export Information
Name [r]
Enter the name of the Building Block.
Description
Enter a description of the Building Block.
Version
Select numbers from the drop-down list to generate the version number of
the Building Block.
Company
Name [r]
Enter the name of the company or Institution developing the Building Block.
Company
URL
Enter the URL for the company or Institution developing the Building Block.
When entering a URL, be sure to enter the URL completely, for example,
http //www.blackboard.com and not www.blackboard.com or
blackboard.com.
Company
Description
Enter a description for the company or Institution developing the Building
Block.
Choose Modules for Export
©
Export
Check this box for each module that will be included in the Building Block.
Removable
Check this box to allow Administrators to remove the module from the list of
available modules without removing the Building Block (and all the other
modules).
Modifiable
Check this box to allow users to modify the content of the module.
Detachable
Check this box if the module can be detached from a tab and viewed in a
separate window.
2007 Blackboard Inc. Proprietary and Confidential.
Page 178
Blackboard K–12 Academic Suite
Administrator Manual
Channels
Overview
This section describes the features for adding and administering the channels that supply content
to Channel Modules.
In this section
The following topics cover managing channels.
©
T op i c
Descript ion
Manage
Channels
This topic covers the Manage Channels page. Administrators can see all
the channels supplying content to modules and select options to control the
channels.
Add/Modify
Channel
This topic covers the Add Channel and Modify Channel pages. These
pages are used to create or change a connection to a channel.
2007 Blackboard Inc. Proprietary and Confidential.
Page 179
Blackboard K–12 Academic Suite
Administrator Manual
Manage Channels
Overview
Channels bring in real-time information from outside of the system for display through Channel
modules. News headlines, weather reports, sports scores, and similar data are the most common
data included in channels. Channels are usually RSS feeds from other Web sites.
Blackboard Community System only provides a means for posting channel information through
portal modules. To arrange for channel content, please contact a channel provider.
The Manage Channels page provides a list of channels that have been added to the system, as
well as a description for each. Multiple Channels may be given the same title, so the description
may be used to differentiate between them.
Find this page
Click Manage Channels on the Administrator Panel.
Functions
The table below details the functions on the Manage Channels page.
©
To . . .
click . . .
add a channel
Channel in the action bar. The Add Channel page will appear.
modify a channel
Modify for a channel in the list.
remove a channel
Remove for a channel in the list.
2007 Blackboard Inc. Proprietary and Confidential.
Page 180
Blackboard K–12 Academic Suite
Administrator Manual
Brands
Overview
This section describes the features for managing branding on the system.
In this chapter
The following topics cover brands.
©
T op i c
Descript ion
Branding
This topic provides an overview of branding.
Manage Brands
This topic explains the Manage Brands page. Administrators
create, remove and manage Brands from this page.
Add Brand / Modify
Brand Properties
This topic covers the Add Brand and Modify Brand pages.
Administrators create new brands and modify existing brands on
this pages.
Modify Brand Contents
This topic explains the Customize Brand page.
Branding Modules and
Tabs with Direct Access
This topic explains how to brand individual tabs and modules
when Portal Direct Entry is set up
2007 Blackboard Inc. Proprietary and Confidential.
Page 181
Blackboard K–12 Academic Suite
Administrator Manual
Branding
Overview
A brand is a distinct set of colors, names, and graphics for the system. Several different brands
can exist on the same Virtual Installation. Brands are displayed based on primary Institution Role.
Therefore, the system can appear differently to different sets of users while those users share the
same content.
Brands also use separate hostnames to help control appearance. This is important when Portal
Direct Entry is enabled because a brand can be presented to users before logging in.
Multiple brands are a function of the Blackboard Community System. Only one brand is available
for the system if the Blackboard Community System is not licensed.
What brand will a user see?
Brands are displayed based on hostnames and primary Institution Roles.
©
If . . .
then . . .
The user accesses the system from a branded hostname
and no role is required
display the brand associated
with the hostname.
The user accesses the system from a hostname, a role is
required, and the user has that role as their primary
Institution Role
display the brand associated
with the hostname and the role.
The user accesses the system from the default hostname
and the user's primary Institution Role has a brand
assigned
display the brand associated
with the role.
a brand and a role are undefined for the hostname and the
primary Institution Role
display the default brand.
2007 Blackboard Inc. Proprietary and Confidential.
Page 182
Blackboard K–12 Academic Suite
Administrator Manual
Manage Brands
Overview
The Manage Brands page lists the brands on the system. Each brand is listed along with the
hostname and required primary Institution Role for the brand.
Find this page
Click Manage Brands from the Administrator Panel.
Functions
The following functions are available on the Manage Brands page.
©
To . . .
click . . .
Sort brands
the carat at the top of a column. The list of brands will sort
alphabetically by the values in that column.
Add a brand
Add Brand from the Action bar.
Change the appearance of
a brand
Customize.
Change the properties that
define a brand
Properties.
Remove a brand
The check box for each brand to delete. Click Remove
Brands from the Action Bar.
2007 Blackboard Inc. Proprietary and Confidential.
Page 183
Blackboard K–12 Academic Suite
Administrator Manual
Add Brand/Modify Brand Properties
Overview
Properties define when users will see a certain brand. Properties must be defined when adding a
brand and can be changed at any time by clicking Properties from the Manage Brands page.
Find this page
Click Add Brand or click Properties for an existing brand to open this page.
Fields
The following fields are available on the Add Brand and Modify Brand Properties pages.
F i e ld
Descript ion
Brand Name
Brand Name
Enter a name for the brand. The name is used to organize brands, it does
not display to users.
Host Name
Host Name
Select an existing hostname for the brand. The host name is used to
access the system. For example, brand1.yourinistitution.com.
or specify a
new host
Enter a new hostname. Make sure that the hostname is resolved on the
network DNS server.
Availability
Institution
Role
©
Select a primary Institution Role for the brand. If no role is selected, the
brand will display to all users that use the brand's hostname to access the
system.
2007 Blackboard Inc. Proprietary and Confidential.
Page 184
Blackboard K–12 Academic Suite
Administrator Manual
Modify Brand Contents
Overview
Customizing the brand defines its appearance to users.
Find this page
Click Manage for a brand from the Manage Brands page.
Fields
The following fields appear on the Modify Brand Contents page.
F i e ld
Descript ion
Institution Image
Current
Image
Displays the banner image that appears in the top frame.
Banner Link
Enter a URL that links to the banner image. A user clicking on the image will
access this URL. When adding a URL, do so as http //www.blackboard.com,
not www.blackboard.com or blackboard.com
[r]
Name of
Link
Name the link to the Banner Image.
Banner
Image
Enter the path of an image file or Browse for an image file on the system.
This image will become the banner image on the top frame. The file must be
in .GIF or .JPEG format.
To replace a banner image add a new image, upload a blank image to
display no image at all, or select the revert check box and click Submit to
replace the image with the default image.
Institution Colors
Background
Color
Click Pick to open the color palette. Click on a color to select it as the
background color for the top frame.
Text Color
Click Pick to open the color palette. Click on a color to select it as the text
color for the links in the top frame. Choosing white text will make the text
stand out against darker backgrounds.
Current
Background
Displays the image that is used to wallpaper the top frame. If no image
appears, the background of the top frame is determined by the Background
Color.
Background
Image
Enter the full path to a file that will serve as the background for the top
frame.
Tabs
©
Tab Style
Select the shape of the tabs from the available options.
Tab
Alignment
Select the justification of the tabs across the top frames from the available
options.
2007 Blackboard Inc. Proprietary and Confidential.
Page 185
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Tab Color
Click Pick to open the color palette. Click on a color to select it as the color
for the tabs.
Tab Text
Color
Click Pick to open the color palette. Click on a color to select it as the text
color for the tabs. Choosing white text will make the text stand out against
darker colors.
Active Tab
Text Color
Click Pick to open the color palette. Click on a color to select it as the
background color for the tab that is currently visible.
Designate Home and Support Links and Icons
Home Link
[r]
Support Link
[r]
Icon Set
Enter a URL that links to the Home button in the top frame. Users clicking on
the Home button will be taken to this link. When adding a URL, do so as http
//www.blackboard.com, not www.blackboard.com or
blackboard.com
Enter a URL that links to the Help button in the top frame. Users clicking on
the Help button will be taken to this link. When entering a URL, be sure to
enter the URL completely, for example, http //www.blackboard.com and
not www.blackboard.com or blackboard.com.
Linking the Help button to the Support section of the Blackboard Web site
will give users quick access to discussions, FAQs, and User Manuals. The
URL for the Blackboard Support is http
//www.blackboard.com/products/services/support.htm
Click one of the options to select an icon set.
Choose Sponsorships or Hotlinks
Select what will appear in the upper right corner of the header frame. If Hot
Links is selected, the links can then be set from the Manage Hot Links
page. If Image/HTML is selected, configure the appearance of the upper
right corner from the Primary Site Sponsor page.
Set Top Frame Size
Click one of the following options to determine the size of the header frame
for the portal and for Class Web sites
Always Use Large Frame
Always Use Small Frame
Use Large Frame for Portal and Small Frame for Classes
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 186
Blackboard K–12 Academic Suite
Administrator Manual
Branding Modules and Tabs with Direct Access
Branding with Direct Access
Branding can be applied not only to the top frame but, when Direct Access is enabled, the initial
tabs and modules that appear to users can be set. Setting the content to appear is accomplished
by applying an Institution Role to the brand content. This role does not need to be the same
Institution Role used to create the brand. Keep in mind that Direct Access branding only works
when the brand is available to everyone (because users have not authenticated before viewing
the system through Direct Access).
Set Modules and Tabs for a Brand
Follow these steps to set modules and tabs for a brand.
©
1.
Create an Institution Role for the brand contents or choose an existing brand that can be
applied.
2.
Select the modules and tabs that appear for the chosen Institution Role.
3.
Click Manage Brands on the Administrator Panel.
4.
Click Manage for a brand. The Modify Brand Contents page will appear.
5.
Scroll to Section 7, Direct Access Tab and Module Content.
6.
Select an Institution Role. The tabs and modules available to that Institution Role will be
available to users that access that brand before users log in. After logging in, modules
and tabs will be presented based on users' Institution Roles.
2007 Blackboard Inc. Proprietary and Confidential.
Page 187
Blackboard K–12 Academic Suite
Administrator Manual
Tool Panel
Overview
This section describes the features for controlling the tool panel that appears on the left side of
some tabs.
In this section
The following topics cover the tool panel.
©
T op i c
Descript ion
Manage Tool
Panel
This topic covers the Manage Tool Panel page. This page lists the tools and
the order in which they appear on the Tool Panel.
Add/Modify
Tool
This topic covers the Add Tool page and the Modify Tool page. These
pages let the Administrator add and rename tools on the Tool Panel.
Add/Edit
External Link
This topic covers the Add External Link and Edit External Link pages.
Administrators can add links to the Tool Panel or modify a link that already
appears on the Tool Panel from these pages.
2007 Blackboard Inc. Proprietary and Confidential.
Page 188
Blackboard K–12 Academic Suite
Administrator Manual
Manage Tool Panel
Overview
The Tool Panel appears in the Left Side Tool Panel of tab. The left side of a tab can also include
links and sponsors. The Tool Panel can be renamed for each tab through the Manage Tabs
feature. The way tools appear within the Tool Panel is controlled from this page. Tools will appear
with the name as it appears on this page and in order from top to bottom as shown on this page.
The only exception is that tools that are marked disabled do not appear in the Tool Panel.
Besides tools, Administrators can also display external links in the Tool Panel.
Note: The settings that are configured for Class Tools are distinct from the Tool
Panel. Changes made to the Class Tools or to the Tool Panel will not impact the
other.
Find this page
Click Manage Tool Panel on the Administrator Panel.
Functions
The table below details the functions available from the Manage Tool Panel page.
©
To . . .
click . . .
add a tool
Add Tool in the action bar.
add an external link
Add External Link in the action bar.
modify a tool or link
Modify.
remove a tool or link
Remove. The tool or link will no longer appear on the tool panel.
2007 Blackboard Inc. Proprietary and Confidential.
Page 189
Blackboard K–12 Academic Suite
Administrator Manual
Add/Modify Tool
Overview
Tools are made available or unavailable the Tool Panel from the Add Tool or Modify Tool page.
Both pages contain the same fields for adding or modifying a Tool. The settings configured here
apply only to the tool as it appears on the Tool Panel.
Find this page
Follow these steps to open the Add Tool or Modify Tool page.
1.
Click Manage Tool Panel on the Administrator Panel.
2.
Click Tool from the action bar or Properties for a tool in the list.
Fields
The table below details the fields on the Add Tool page and the Modify Tool page.
F i e ld
Descript ion
Enter Information
©
Title [r]
Enter or change the title of a tool.
Tool [r]
Select a tool from the drop-down list. This field may not be changed once it is
set. On the Modify Tool page it appears as display only.
Available
Select Yes or No to make this tool available to users through the Tool Panel.
2007 Blackboard Inc. Proprietary and Confidential.
Page 190
Blackboard K–12 Academic Suite
Administrator Manual
Add or Modify a Tool Panel for an External Link
Overview
Links to other Web pages can be added to the Tool Panel through the Add External Link page.
External Links that are already a part of the Tool Panel can be updated through the Edit External
Link page. Both pages contain the same fields for adding or modifying an External Link.
Find this page
Follow these steps to open the Add External Link page or Edit External Link page.
1.
Click Manage Tool Panel on the Administrator Panel.
2.
Click External Link from the action bar or Modify for an External Link in the list.
Fields
The table below details the fields on the Add External Link page and the Edit External Link page.
F i e ld
Descript ion
Enter Information
©
Title [r]
Enter or change the title of the link.
External
Link [r]
Enter or change the URL for the link. When adding a URL, do so as http
//www.blackboard.com, not www.blackboard.com or
blackboard.com
Available
Select Yes or No to make this link available to users through the Tool Panel.
2007 Blackboard Inc. Proprietary and Confidential.
Page 191
Blackboard K–12 Academic Suite
Administrator Manual
Community System Settings
Overview
This chapter describes the features that control the portal settings for the system.
In this section
System Settings includes the following topics.
©
T op i c
Descript ion
Sponsorship or
Hotlinks
This topic covers the Sponsorship or Hotlinks page. From this page an
Administrator can select to use links on the right side of the top frame or a
sponsorship image.
Manage Hot
Links
This topic covers the Manage Hot Links page. This page includes all the
features necessary to manage the Hot Links that can be set to appear on
the right side of the top frame.
Add/Modify Hot
Link Tool
This topic covers the Add and Modify Hot Link Tool pages. Tools can be
added to the right side of the top frame as Hot Links.
Add/Edit
External Link
This topic covers the Add and Edit External Link pages. These pages are
used to manage the links that appear on the right side of the top frame as
Hot Links.
Primary Site
Sponsor
This topic covers the Primary Site Sponsor page. This page includes all
the features necessary to manage the sponsorship images that can be
set to appear on the right side of the top frame.
Customize
Module Theme
This topic covers the Customize Module Theme page. Administrators can
create customized color schemes to use with any tab that includes
modules.
Set Frame Size
This topic covers the Set Frame Size page. Administrators can define the
size of the top frame from this page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 192
Blackboard K–12 Academic Suite
Administrator Manual
Sponsorship or Hotlinks
Overview
The right side of the top frame can be set to display links or sponsorship images. Links can be set
to point to an external URL or to a Tool within the Blackboard Academic Suite. Sponsorships are
typically used to place advertisements but the images can be set to display content other than
sponsor information.
Find this page
Follow these steps to open the Sponsorship or Hotlinks page.
1.
Click Settings on the Administrator Panel.
2.
Click Sponsorship or Hotlinks.
Select sponsorships or links
Select what will appear in the upper right corner of the header frame. If Hot Links is selected, the
links can then be set from the Manage Hot Links page. If Image/HTML is selected, configure the
appearance of the upper right corner from the Primary Site Sponsor page.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 193
Blackboard K–12 Academic Suite
Administrator Manual
Manage Hot Links
Overview
Hot Links can appear in the top right corner of the header frame. Hot Links allow access to Tools
or External Links from the header frame. Hot Links will not appear on the header frame if the
Administrator selects to display sponsorships.
Find this page
Follow these steps to open the Manage Hot Links page.
1.
Click Settings on the Administrator Panel.
2.
Click Manage Hot Links from the Settings page.
Functions
The table below details the functions available from the Manage Hot Links page.
©
To . . .
click . . .
add a Tool to the Hot
Links
Add Tool in the action bar.
add an External Link to
the Hot links
Add External Link in the action bar.
modify a Tool or
External Link
Modify. The Modify Tool page or the Modify External Link page
will appear.
change the position of a
Tool or External Link
the drop-down arrow next to a Tool or External Link and select the
position that the item should appear in sequence with the other
Tools and External Links.
remove a Tool or
External Link from the
Hot Links
Remove. The tool or link will no longer appear on the top frame.
2007 Blackboard Inc. Proprietary and Confidential.
Page 194
Blackboard K–12 Academic Suite
Administrator Manual
Add or Modify a Hot Link Tool
Overview
Hot Link Tools are added or modified from the Add Tool or Modify Tool page. Both pages contain
the same fields for adding or modifying a Tool. The settings configured here apply only to the
Tool as it appears in the Hot Link section of the top frame. For example, if the Calendar is added
and given the name College Calendar it will still be called Calendar on the Tools Panel.
Find this page
Follow these steps to open the Add Tool page.
1.
Click Settings on the Administrator Panel.
2.
Click Manage Hot Links from the Settings page.
3.
Click Tool from the action bar or Modify for a tool in the list.
Fields
The table below details the fields on the Add Tool page and the Modify Tool page.
F i e ld
Descript ion
Enter Information
©
Title [r]
Enter or change the title of a tool.
Tool [r]
Select a tool from the drop-down list. This field may not be changed once it is
set.
Available
Select Yes to make this tool available to users on the top frame.
2007 Blackboard Inc. Proprietary and Confidential.
Page 195
Blackboard K–12 Academic Suite
Administrator Manual
Add or Modify External Link
Overview
Hot Link External Links are added or modified from the Add External Link or Modify External Link
page. Both pages contain the same fields for adding or modifying an External Link. Links added
here appear in the Hot Links area in the upper right corner of the top frame.
Find this page
Follow these steps to open the Add External Link or Modify External Link page.
1.
Click Settings on the Administrator Panel.
2.
Click Manage Hot Links from the Settings page.
3.
Click External Link from the action bar or Modify for an External Link in the list.
Fields
The table below details the fields on the Add External Link page and the Edit External Link page.
F i e ld
Descript ion
Enter Information
©
Title [r]
Enter or change the title of a link.
External
Link [r]
Enter or change the URL for the link. The URL must be entered fully. For
example, http //www.blackboard.com, not blackboard.com.
Available
Select Yes or No to make this link available to users through the top frame.
2007 Blackboard Inc. Proprietary and Confidential.
Page 196
Blackboard K–12 Academic Suite
Administrator Manual
Primary Site Sponsor
Overview
The Primary Site Sponsor defines an image that appears on the right side of the top frame. The
right side can also be used to display links to URLs or Tools. To switch between displaying a
sponsor image and displaying links see the Sponsorship or Hotlinks topic.
Find this page
Follow these steps to open the Primary Site Sponsor page.
1.
Click Settings on the Administrator Panel.
2.
Click Primary Site Sponsor from the Settings page.
Fields
The table below details the fields on the Primary Sponsor page.
F i e ld
Descript ion
Designate Primary Sponsorship Content
©
None
Click this option to leave the Primary Sponsorship Area blank.
Local Image
and Link
Click this option to add a local image as the Primary Site Sponsor image.
Upload Image
Enter a file name or click Browse to search for an image file.
Image Link
Enter a URL. The URL will open in a separate browser when the image is
clicked. The URL must be entered fully, for example
http //content.blackboard.com/images/picture.jpg.
Outsourced
HTML Code
Sometimes an ad server will provide HTML code to serve ads. Post that
HTML code in this box to display the ads.
2007 Blackboard Inc. Proprietary and Confidential.
Page 197
Blackboard K–12 Academic Suite
Administrator Manual
Customize Module Theme
Overview
Module Themes determine the colors of modules. A Module Theme configured here will be
selectable for a tab from the Default Layout page. When a theme is applied to a tab all the
modules in that tab use the same color scheme.
Find this page
Follow these steps to open the Customize Module Theme page.
1.
Click Settings on the Administrator Panel.
2.
Click Customize Module Theme from the Settings page.
Fields
The table below details the fields on the Customize Module Theme page.
F i e ld
Descript ion
Customize Module Theme
©
Label [r]
Enter a name for the module theme.
Ba ck gr ound
Color
Click Pick to open the color palette. Click on a color to select it as the
background color for modules.
Border Color
Click Pick to open the color palette. Click on a color to select it as the
color for the module border.
Title Background
Color
Click Pick to open the color palette. Click on a color to select it as the
color for the background of the module title bar.
Title Color
Click Pick to open the color palette. Click on a color to select it as the
color for the title text of the module.
Border Size
Select None, Thin, or Thick. The border for each module will appear
as selected.
2007 Blackboard Inc. Proprietary and Confidential.
Page 198
Blackboard K–12 Academic Suite
Administrator Manual
Set Frame Size
Overview
Setting the Frame Size is managed through Brands. Administrators can set the size of the
header frame as it appears on the portal and in Classes. Using the smaller frame will remove any
images or sponsorships from the header frame and create more space in the main frame for
content and tools.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 199
Blackboard K–12 Academic Suite
Administrator Manual
System Management
Overview
This part of the Blackboard K-12 Suite Administrator Manual details the technical system
administration features available on the Administrator Panel.
In this part
The following sections cover System Management.
©
S e ct io n
Descript ion
Authentication and
Integration
This section includes information on the Authentication and
Integration features available on the Administrator Panel.
Reports
This section details the features that generate usage statistics.
System Information
This section details the features that store information about the
system.
Logs
This section details the system logs.
2007 Blackboard Inc. Proprietary and Confidential.
Page 200
Blackboard K–12 Academic Suite
Administrator Manual
Authentication and Integration
Overview
This section describes the Authentication and Integration options on the Administrator Panel.
In this section
This section includes the following topics about Integration and Authentication.
©
T op i c
Descript ion
Authentication
Config
This topic covers the Authentication Config page. This page lists the
authentication options and details the settings configured for each
option.
Manage Context
Encryption Keys
This topic covers the Manage Context Encryption Keys page. This is
a menu page for creating or downloading a key to encrypt contentpassing from the Blackboard Learning System through a Building
Block.
Download the
Context Encryption
Key
This topic covers the Download Context Encryption Key page. From
this page a key can be downloaded and then shared with a URL to
secure content-passing.
Create a Context
Encryption Key
This topic covers the Create a Context Encryption Key page. Keys
are created for content-passing from this page.
Deciphering
Encrypted Context
This topic covers how to programmatically decipher encrypted content
on an outside URL.
Integration
Password
This topic covers the Integration Password page. Administrators can
set a password for the Integration account that handles Snapshot
tasks from client machines using SOAP.
2007 Blackboard Inc. Proprietary and Confidential.
Page 201
Blackboard K–12 Academic Suite
Administrator Manual
Authentication Configuration
Overview
View the authentication configuration of the Blackboard K-12 Suite from this page. For
information on editing the authentication configuration properties, please see the Server
Administration Manual.
Find this page
Click Authentication Config on the Administrator Panel to open the End-User Authentication
Configuration page.
View settings
Click List All to view the authentication settings for an Authentication Type. While it is possible to
view settings for all the different Authentication Types only one type may be enabled at a time.
The default Authentication Type is Blackboard Challenge-Response.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 202
Blackboard K–12 Academic Suite
Administrator Manual
Manage Context Encryption Keys
Overview
The context passing APIs allow the Blackboard K-12 Suite to pass data to URLs requiring that
data in a query string. To see an example of this type of URL, simply look at the URL for any
Class. The last part of the URL is url=/bin/common/course.pl?course_id=<unique_id> where the
<unique_id> is a variable. It is variables such as this that can be passed using the context
passing APIs.
Context passing is especially useful when implementing Building Blocks that require content from
Blackboard K-12 Suite to generate a URL. To protect the transfer of possibly sensitive data as
part of a context passing function, context encryption using Cryptix (Blowfish) can be used to
secure the data transfer instead of the standard Base64Encoding.
Find this page
Select Manage Context Encryption Keys on the Administrator Panel.
Enable the Manage Context Encryption page
The cryptix32.jar file must be downloaded and the Blackboard K-12 Suite configured before the
features on the Manage Context Encryption Keys page become available. Follow the steps below
1.
Download the cryptix32.jar file from the Cryptix Web site (http //www.cryptix.org)
2.
Put cryptix32.jar in blackboard/systemlib
3.
Create the directory blackboard/config/tomcat/classpath/cryptix-shared.classpath.bb. The
.bb file should contain the following @@[email protected]@/systemlib/cryptix32.jar
4.
Run blackboard/tools/admin/PushConfigUpdates.sh
5.
In the Administrator Panel, select Manage Context Encryption Keys.
Functions
The following functions are available from the Manage Context Encryption Keys page
©
To . . .
click . . .
create a new
key
Create New Context Encryption Key. A new key will be created and used
by the Blackboard K-12 Suite. For outside URLs to decipher contextpassed data the key must be downloaded and made accessible to the
outside URL.
Creating a new key will remove the existing key. Any existing contextpassing Building Blocks that rely on the key will not work until the new key
is made available.
download an
existing key
Download Existing Context Encryption Key. A key must be created
before it can be downloaded and shared.
2007 Blackboard Inc. Proprietary and Confidential.
Page 203
Blackboard K–12 Academic Suite
Administrator Manual
Download the Context Encryption Key
Overview
Once a context encryption key has been created, it must be downloaded and then made
accessible to the URL that will accept data passed from the Blackboard K-12 Suite.
Find this page
Follow these steps to open the Download Existing Context Encryption Key page.
1.
Click Manage Context Encryption Keys on the Administrator Panel.
2.
Click Download Existing Context Encryption Key.
Function
Click Submit to download the key. A Download window from the browser will appear. The context
key is always named blackboard.key.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 204
Blackboard K–12 Academic Suite
Administrator Manual
Create a Context Encryption Key
Overview
The only variable to consider when creating a context encryption key is the key length in bits.
Longer keys are more secure but also perform somewhat slower.
It is only possible to use one key with the Blackboard K-12 Suite at a time. If the context APIs are
used to tie in more than one URL the same key will be used to encrypt communication for all the
URLs.
Find this page
Follow these steps to open the Create New Context Encryption Key page.
1.
Click Manage Context Encryption Keys on the Administrator Panel.
2.
Click Create New Context Encryption Key.
Function
Select the key length from the drop-down list and click Submit to create a new key. If a key
already exists, creating a new key will overwrite the existing key. Any URLs relying on the old key
to decipher context passed from the Blackboard K-12 Suite will not work until the new key is
downloaded and made available to the URL.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 205
Blackboard K–12 Academic Suite
Administrator Manual
Deciphering Encrypted Context
Overview
To encrypt data during context passing the Blackboard K-12 Suite and the external URL must
have access to the same context encryption key. The key must be created from the Manage
Context Encryption Key feature available on the Administrator Panel. Once the key has been
created it must be downloaded and distributed to external servers that will accept context.
Code example
After downloading a context encryption key it must be made available to the URL that will receive
encrypted data through context-passing. The code example below shows how to
programmatically decipher encrypted context data on the external URL when it is passed.
The object indicated by the target URL (in this case, index.jsp) could decrypt the context as
follows (importing blackboard.client.decryption.*)
String context = request.getParameter("context");
//if isEncryptionEnabled = false, base 64 encoding will be used instead //of
encryptionboolean isEncryptionEnabled = true;ContextDecryptor bfd =
ContextDecryptorFactory.getContextDecryptor(isEncryptionEnabled ); // retrieve
the Blackboard encryption key as a File or InputStream File key = new File(
strKeyLocation ); // or InputStream key = // implementation detail…// to
simply decrypt the context string String decryptedContext = bfd.decrypt(
context, key );// or, to get a HashMap of all key-value pairsHashMap map =
bfd.parseEncryptedContext( context, key );// then search the HashMap for an
expected value, and continue.if (map.containsKey( “user” ){ // execute…}
Resolving multiple keys
The code example above is useful when there is a one-to-one relationship between the external
URL and the Blackboard K-12 Suite. For instances where an external URL is supporting a
Building Block for multiple instances of the Blackboard K-12 Suite the hostname of the instance
can be used to handle multiple keys.
In the example below, the key is found through association with the hostname for the instance or
Virtual Installation of the Blackboard K-12 Suite. In this case the hostname is
physics.yourinstitution.com. Since the client decryption code has the ability to pass in a
decryption key to the ContextDecryptor object, the client server must be able to map a hostname
to its appropriate key (usually accessed as a File, but can be an InputStream).
Building Block server developers can write a simple wrapper that
1.
Pulls the hostname off the request
2.
Looks up the encryption key file in the hostname-encryptionKey map
3. Passes the encryption key to the decrypt() method
Pseudocode wrapper, implemented by a client server utility object
/**
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 206
Blackboard K–12 Academic Suite
Administrator Manual
* Utility Pseudocode
*/
decryptByHostname( HttpServletRequest request)
{
// get context parameter from the request
String context = request.getParameter("context");
// determine if the context is encrypted
String strEncryptInd = request.getParameter("encrypt");
if ( (strEncryptInd != null) && (strEncryptInd.equalsIgnoreCase("y"))
)
{
isEncrypted = true;
}
// if isEncrypted, look up the key
key = null;
if (isEncrypted)
{
// get hostname from HttpUtils.getRequestURL().getHost();
// get key map, possibly stored as a property file in the
format
// physics.yourinstitution.com=
/key/file/location/physics_yourinstitution_com/key.sec
// get encryption key from map as either a File or an
InputStream,
null if
// depending on client implementation detail (key is passed as
// isEncrypted= false, and Base64Encoding is used instead)
}
ContextDecryptor decryptor =
ContextDecryptorFactory.getContextDecryptor(isEncrypted);
// then either return the values passed in the context as either
// a HashMap of key-value pairs
HashMap values = decryptor.parseEncryptedContext(context, key);
// or a String
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 207
Blackboard K–12 Academic Suite
Administrator Manual
String values = decryptor.decrypt(context, key);
return values;
}
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 208
Blackboard K–12 Academic Suite
Administrator Manual
Integration Password
Overview
The Integration User is a special User account that is used by Snapshot and the Data Integration
APIs to process operations from a client machine using Simple Object Access Protocol (SOAP).
This page allows the Administrator to change the password for the Integration user.
The Integration user does not have access to the Blackboard K-12 Suite through the user
interface nor can the Integration user be assigned to a Class or participate in the teaching and
learning environment in any way.
Find this page
Click Integration Password on the Administrator Panel.
Fields
The table below details the fields on the Integration Password page.
F i e ld
Descript ion
Modify Password
©
Old Password
Enter the old password.
New Password
Enter a new password for the Integration account.
Confirm New Password
Enter the new password again to confirm.
2007 Blackboard Inc. Proprietary and Confidential.
Page 209
Blackboard K–12 Academic Suite
Administrator Manual
Reports
Overview
This section describes the reporting features available to Administrators. There are two types of
reporting, Standard and Advanced. Standard System Reporting generates a defined set of
reports. Advanced System Reporting can be used to created customized reports.
In this section
This section includes the following topics.
©
T op i c
Descript ion
Standard System
Reports
This topic covers the Standard System Reports page. Administrators
input information used to generate access reports on this page.
View Report
This topic covers the View Report page. This page displays the
results of a report generated on the Standard System Reports page.
Advanced System
Reporting
This topic covers the Advanced System Reporting database and the
command line tools used to manage the data in the database.
Advanced System
Reporting Sample
Templates
This topic covers the Advanced System Reporting Sample Template
page. Administrators can download templates useful for generating
reports from the Advanced System Reporting database.
Auto-Reporting
Options
This topic covers the Auto-Reporting Options page. Administrators
can automatically have the system send reports on system
performance to Blackboard.
Send System
Statistics to
Blackboard
This topic covers the Send System Statistics to Blackboard page.
Administrators can use this feature to send information about the
system to Blackboard Technical Support.
2007 Blackboard Inc. Proprietary and Confidential.
Page 210
Blackboard K–12 Academic Suite
Administrator Manual
Standard System Reports
Overview
Administrators track system usage through System Reports. Standard System Reports provide
information on the number of Classes, users, overall usage, and cumulative hits. Reports may
also be exported and viewed as a text file or in a spreadsheet program.
The Enable Event Tracking option must be set to Yes on the Auto-Reporting Options page
before Statistics will be recorded.
Blackboard Learning System - Basic Edition: The database only stores data for the previous 180
days to prevent system slowdowns. Therefore, activity that occurred more than 180 days before
running the report will not be included in the report. To increase the number of days that data is
stored, please contact Blackboard Product Support.
Find this page
Follow these steps to open the Standard System Reports page.
1.
Click System Reports on the Administrator Panel.
2.
Click Standard System Reports.
Fields
The table below details the fields used to filter System Reports.
F i e ld
Descript ion
Select Report Filter
Select
Report
Select a type of data from the drop-down list to display a report. The options are
Overall Summary of Usage: Displays the average number of users,
Classes, and page views per month.
User Statistics: Displays the average number of total users, Students,
and Teachers per month and per day.
Class Statistics: Displays the average number of active Classes and
Organizations per month and per day.
Site Page Views: Displays the average number of page views and Class
page views per month and per day.
Time
period
©
Pick a start date and an end date for the range from the drop-down lists. Dates
can also be selected by clicking the icon to bring up the calendar interface.
2007 Blackboard Inc. Proprietary and Confidential.
Page 211
Blackboard K–12 Academic Suite
Administrator Manual
View Report
Overview
The results are displayed after selecting the filters and generating a report on the Standard
System Reports page. Included is a summary as well as graphs of all the data requested. The
report lists the total numbers as well as the number of active Users, Classes, or Organizations.
Active applies to the subset of the total that have been used during the date range. For example,
the total number of Users may be 2,000, but if the date range is only one day, perhaps only 750
Users logged in that day (considered active).
Note: When viewing reports that include hit statistics, a hit is tracked every time
a request is sent. For example, a Student logs in to Blackboard K-12 Suite (1 hit),
clicks the Classes tab (2 hits), clicks a Class Link (3 hits), accesses the
Communication area (4 hits), clicks Discussion Boards (5 hits), clicks a Topic (6
hits), and clicks a message to read (7 hits)d.
Find this page
Follow these steps to view a standard report.
1.
Click System Reports on the Administrator Panel.
2.
Click Standard System Reports from the System Reports menu page.
3.
Filter data to generate a report and click Submit.
Functions
The table below outlines the functions available when viewing a System Report.
©
To . . .
click . . .
view a different set of
reports
Change Filter to return to the Standard System Reports page.
print a set of reports
Print.
export a file containing
report data
Export Data. The data file can be opened in a text editor or a
spreadsheet application.
2007 Blackboard Inc. Proprietary and Confidential.
Page 212
Blackboard K–12 Academic Suite
Administrator Manual
Advanced System Reporting
Overview
Advanced System Reporting enables Institutions to do robust reporting to understand how their
system is being used. Data from predefined fields in a separate database is used to create and
tailor reports to meet specific needs. These reports assist in understanding and analyzing use of
the system and can report information such as when different types of users access the system,
how they use the system, and if the system improves Student performance. Librarians can
discover how Content System items are being used, including information such as how many
links exist to each item, from which courses, the frequency of access to those items and the last
date of access.
Function
Data is transferred nightly into a separate reporting database. The name of the database is the
name of the Virtual Installation appended with stats. The base Virtual Installation that appears in
all implementations of the Blackboard Learning System, bb_bb60, has the stats database
bb_bb60_stats to handle Advanced System Reporting.
Schedule the data transfer so that it occurs at a low-traffic time of the night and is properly
coordinated with Snapshot loading or other integration processes. Administrators have open
access to this database so that they can use the Crystal Reports® templates that Blackboard
provides to develop reports to suit their Institution’s needs.
Data
The data that is transferred to the statistics database is a sub-set of the data that is located on the
production database. It has a different schema from the data on the production database.
Administrators have open access to the statistics database to use for analysis and creating
reports.
Installation and Setup
Advanced System Reporting is set up automatically when the Blackboard K-12 Suite is installed.
The Enable Event Tracking option must be set to Yes on the Auto-Reporting Options page
before Statistics will be recorded.
Purging data in the databases
Every day an automatic process runs that synchronizes the data in the stats database with the
data in the main database and then deletes the statistical data from the main database that is
more than 180 days old. This process can be run at any time using the PurgeAccumulator tool.
The PurgeAccumulator tool can also be used to delete data from the statistics database.
Note: Administrators may modify the length of time that statistical data is kept in
the main database. This is changed by editing the days_to_keep value in the
config/bb-tasks.xml file.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 213
Blackboard K–12 Academic Suite
Administrator Manual
The PurgeAccumulator tool is installed as part of Blackboard Learning System. It is run from the
$blackboard/tools/admin directory.
Syntax :
PurgeAccumulator <command> <Virtual_Installation> <days_or_date>
©
A rgu ment
Descript ion
<command>
purge-live –Takes data from Blackboard database and syncs with
tables in the statistics database. After synching, it purges statistical
data in the main database that is older than the number of days or
date set.
purge-stats – goes to stats DB and purges all data older than the last
x days or older than a specific date.
<Virtual_Installation>
Enter the name of the main database (bbuid) of the Virtual Installation
to be purged.
<days_or_date>
The number of days (from the current date) that should not be
processed by the PurgeAccumulator tool. It is also possible to set a
date in yyyy-mm-dd format. Only data older than the date will be
purged.
2007 Blackboard Inc. Proprietary and Confidential.
Page 214
Blackboard K–12 Academic Suite
Administrator Manual
Advanced System Reporting: Sample Templates
Overview
The Blackboard K-12 Suite includes a set of Advanced System Reporting templates for use with
Crystal Reports. The templates require a license for Crystal Reports from Crystal Decisions, Inc.
Note: It is not necessary to use Crystal Reports to run Advanced System
Reports against the statistics database. Other reporting software programs may
also be used .
Find this page
Follow these steps to open the Advanced System Reporting Sample Templates page.
©
1.
Click System Reports on the Administrator Panel.
2.
Click Advanced System Reporting: Sample Templates from the System Reports
menu page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 215
Blackboard K–12 Academic Suite
Administrator Manual
Advanced System Reporting Database Attributes
This diagram details the shared rows in the reporting database tables. The relationship between
the tables is used to define and return customized data reports. For example, the
INTERNAL_HANDLE can be used to link the ACTIVITY_ACCUMULATOR table, the
NAVIGATION_ITEM table, and the APPLICATION table. A report could be constructed around
this relationship to show which items and tools users are accessing in a particular Class.
Attribute Definitions
The tables below detail the attributes in each database table. Each of the tables below includes
the following columns:
•
Attribute: The name of the attribute as it appears in the database.
•
Data Type: The format of the information stored in the attribute (date, varchar, etc.)
•
Null? Indicated whether or not null values are allowed. Y indicates that null values are
allowed for the attribute, N indicates that null values are not allowed for the attribute.
•
Description: Explains the information stored in the attribute and its importance.
ACTIVITY_ACCUMULATOR
Att r ibute
©
Data T ype
a nd
Co nst ra ints
Null? Descript ion
PK1
INT (4)
N
Unique identifier for each record. (Primary Key)
EVENT_TYPE
VARCHAR
(30)
N
Groups the event based on what occurred.
Please see the Event Type table below for
specific information on the possible values for
this field.
USER_PK1
INT (4)
Y
References the PK1 (Primary Key) attribute of
the USERS table.
COURSE_PK1
INT (4)
Y
References the PK1 (Primary Key) attribute of
the COURSE table.
GROUP_PK1
INT (4)
Y
References the PK1 (Primary Key) attribute of
the GROUP table.
FORUM_PK1
INT (4)
Y
References the PK1 (Primary Key) attribute of
the FORUM table.
2007 Blackboard Inc. Proprietary and Confidential.
Page 216
Blackboard K–12 Academic Suite
Att r ibute
©
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
INTERNAL_HANDLE
VARCHAR
(255)
Y
Internal system identifier for the event. This field
corresponds to the unique ID in the
NAVIGATION_ITEM table. Not all page requests
correspond to a navigation item, so this field may
often appear blank.
When reading the INTERNAL_HANDLE, the
prefix helps identify the path the user took to
access the page.
CP_ indicates that the user went through
the Class Control Panel to view the page.
PA_ is associated with portal
administrator functions
ADMIN_ refers to accesses through the
Administrator Control Panel
LIST_ indicates that the page was
requested after a search function
CUST_ refers to a Customization
interface, such as the Customize Login
Page
If this field is empty, check the CONTENT_PK1
field. If the page accessed displayed content, the
primary key for the piece of content will appear in
that field.
CONTENT_PK1
INT (4)
Y
References the PK1 (Primary Key) attribute of
the CONTENT table. This field is populated
when the EVENT_TYPE is
CONTENT_ACCESS.
2007 Blackboard Inc. Proprietary and Confidential.
Page 217
Blackboard K–12 Academic Suite
Att r ibute
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
DATA
NVARCHAR
(255)
Y
Data related to the event. This field provides
additional information on the event. Each event
uses this field, if at all, in different ways. In many
instances, the data included in this field is a
value that is easily deduced.
In some instances, the value in the data field is a
number, such as _1_1 or _29_1. These are
associated with an EVENT_TYPE of
TAB_ACCESS or MODULE_ACCESS. The first
number is an ID that references a tab or a
module (the second number can be ignored).
The ID number that refers to a tab can be found
in the user interface by scrolling over the tab.
The ID number appears as part of the URL in the
status bar.
The ID number that refers to a module can be
found in the same manner. Scroll over the
Maximize, Minimize, or Edit button associated
with a module. The ID number will appear as part
of the URL in the status bar. Please note that the
Detach Module button returns a different ID
number and should be ignored.
TIMESTAMP
DATETIME
(8)
Y
Date and time that the event occurred.
STATUS
NUMERIC (9)
Y
Shows success (1) and failure (0).
MESSAGES
NTEXT (16)
Y
Additional messages associated with the event.
SESSION_ID
INT (4)
Identifies the user session that initiated the
action. A session is simply a browser connection
to the system launched from an end-user
machine.
Event Types
The following table lists the possible event types stored in the ACTIVITY_ACCUMULATOR table.
The Page View column shows whether or not the activity counts as a page view when generating
statistics.
T yp e
©
Descript ion
Page
View ?
TAB_ACCESS
A browser request that causes a portal tab to change state. The
name of the tab will be returned.
Yes
MODULE_ACCESS
Triggered when a portal module is rendered. The name of the
module will be returned.
No
LOGIN_ATTEMPT
An attempt to authenticate to the system. Additional information
on the success is stored.
No
2007 Blackboard Inc. Proprietary and Confidential.
Page 218
Blackboard K–12 Academic Suite
T yp e
Administrator Manual
Descript ion
Page
View ?
LOGOUT
A user's session is voluntarily ended by accessing the logout
link.
No
SESSION_TIMEOUT
A user's session is involuntarily ended because no action was
taken in a specific window.
No
COURSE_ACCESS
Triggered when a Class frameset is loaded, or when a page is
accessed in a Class. The name of the navigation item will be
returned.
Yes
CONTENT_ACCESS
Triggered when content is displayed.
No
PAGE_ACCESS
Triggered when a page, other than a Class, Organization,
content, module, or tab is accessed on the system. The name of
the navigation item will be returned.
Yes
SESSION_INIT
Triggered when a session is initialized.
No
COURSE_ROLES
Att r ibute
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
PK1
INT (4)
N
Unique identifier for each record.
(Primary Key)
COURSE_ROLE
CHAR (1)
N
One character system identifier for a
Class Role.
B=Class Builder or Organization
Builder
G=Grader
P=Teacher or Organization Leader
S=Student or Organization Member
T=Teaching Assistant
U=Guest
©
NAME
NVARCHAR (50)
Y
Customized name of a Class Role.
DEFAULT_NAME
VARCHAR (50)
Y
Default name of a Class Role.
ORG_NAME
NVARCHAR (50)
Y
Customized name of an
Organization Role.
ORG_DEFAULT_NAME
VARCHAR (50)
Y
Default name of an Organization
Role.
2007 Blackboard Inc. Proprietary and Confidential.
Page 219
Blackboard K–12 Academic Suite
Administrator Manual
COURSE_USERS
Att r ibute
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
PK1
INT (4)
N
Unique identifier for each record.
(Primary Key)
CRSMAIN_PK1
INT (4)
N
References the PK1 (Primary Key)
attribute of the COURSE_MAIN table.
DATA_SRC_PK1
INT (4)
Y
References the PK1 (Primary Key)
attribute of the DATA_SOURCE table.
ROLE
CHAR (1)
Y
One character identifier of the users
Class Role.
B=Class Builder or Organization Builder
G=Grader
P=Teacher or Organization Leader
S=Student or Organization Member
T=Teaching Assistant
U=Guest
©
LINK_NAME_1
NVARCHAR
(100)
Y
Name of a link to a Web site listed on the
Users Student Homepage within the
Class.
LINK_URL_1
VARCHAR (100)
Y
Address of a link on the Users Student
Homepage.
LINK_DESC_1
NVARCHAR
(255)
Y
Description of a link on the Users Student
Homepage.
LINK_NAME_2
VARCHAR (100)
Y
Name of a link to a Web site listed on the
Users Student Homepage within the
Class.
LINK_URL_2
VARCHAR (100)
Y
Address of a link on the Users Student
Homepage.
LINK_DESC_2
NVARCHAR
(255)
Y
Description of a link on the Users Student
Homepage.
LINK_NAME_3
NVARCHAR
(100)
Y
Name of a link to a Web site listed on the
Users Student Homepage within the
Class.
LINK_URL_3
VARCHAR (100)
Y
Address of a link on the Users Student
Homepage.
LINK_DESC_3
NVARCHAR
(255)
Y
Description of a link on the Users Student
Homepage.
USERS_PK1
INT (4)
N
References the PK1 (Primary Key)
attribute of the USERS table.
2007 Blackboard Inc. Proprietary and Confidential.
Page 220
Blackboard K–12 Academic Suite
Att r ibute
Administrator Manual
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
PHOTO_LINK
VARCHAR (100)
Y
Link to a image that will display on the
Users Student Homepage.
INTRO
NTEXT (16)
Y
Message that will display on the Users
Student Homepage.
NOTE
NTEXT (16)
Y
Text box in the user interface filled out by
the user.
PINFO
NTEXT (16)
Y
Message that will display on the Users
Student Homepage, typically used to
display personal information.
CARTRIDGE_IND
CHAR (1)
Y or N
N
Determines whether or not the user can
access cartridge content in the Class.
AVAILABLE_IND
CHAR (1)
Y or N
N
Determines whether or not the user can
access the Class.
SOS_ID_PK2
INT (4)
N
Not in use.
ROW_STATUS
NUMERIC (5)
Y
Sets the value of the record to one of the
following:
Enabled: Normal access to the record.
Disabled: Record is visible in some areas
of the UI, but may not be changed or
accessed.
Deleted: Record is scheduled to be
removed.
ENROLLMENT_DATE
DATETIME (8)
Y
Date the User enrolled in the Class.
CRSMAIN_SOS_ID_PK2
INT (4)
Y
Not in use.
USERS_SOS_ID_PK2
INT (4)
Y
Not in use.
DTMODIFIED
DATETIME (8)
Y
The last date the record was modified.
SYSTEM_ROLES
Att r ibute
PK1
©
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
INT (4)
N
Unique identifier for each record. (Primary
Key)
2007 Blackboard Inc. Proprietary and Confidential.
Page 221
Blackboard K–12 Academic Suite
Att r ibute
SYSTEM_ROLE
Administrator Manual
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
CHAR (1)
N
One character identifier for each System
Role.
Z=System Administrator
A=User Administrator
C=Class Administrator
H=System Support
N=None
O=Parent
R=Support
U=Guest
NAME
NVARCHAR (64)
Y
The customized name of a System Role.
DEFAULT_NAME
VARCHAR (64)
Y
The name of a System Role as it appeared
before modification.
INSTITUTION_ROLES
Att r ibute
©
Data T ype
a nd
Co nst ra ints
Null? Descript ion
PK1
INT (4)
N
Unique identifier for each record. (Primary
Key)
ROLE_NAME
NVARCHAR
(50)
N
Name of an Institution Role as it appears
to users.
DESCRIPTION
NVARCHAR
(255)
Y
Description of the role.
ROLE_ID
NVARCHAR
(50)
N
The unique identifier of the role. This is
the key that is used to identify the role
during Snapshot and other data
management operations.
DATA_SRC_PK1
INT (4)
Y
References the PK1 (Primary Key)
attribute of the DATA_SOURCE table.
GUEST_IND
CHAR (1)
N
This indicates whether or not the role
serves as a Guest role for a particular
brand.
REMOVABLE_IND
CHAR (1)
N
This indicates whether or not the role may
be removed from the system. Some
Institution Roles are not removable to
ensure backward compatibility.
SELF_SELECTABLE_IND
CHAR (1)
N
This field is not currently used to store
data.
2007 Blackboard Inc. Proprietary and Confidential.
Page 222
Blackboard K–12 Academic Suite
Att r ibute
ROW_STATUS
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
INT (4)
N
Sets the value of the record to one of the
following:
Enabled: Normal access to the record.
Disabled: Record is visible in some areas
of the UI, but may not be changed or
accessed.
Deleted: Record is scheduled to be
removed.
USER_ROLES
Att r ibute
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
PK1
INT (4)
N
Unique identifier for each record.
(Primary Key)
USERS_PK1
INT (4)
N
The primary key that identifies a user
in the USERS table.
INSTITUTION_ROLES_PK1
INT (4)
N
The primary key that identifies an
Institution Role in the
INSTITUTION_ROLES table.
ROW_STATUS
NUMERIC (5)
Y
Sets the value of the record to one of
the following:
Enabled: Normal access to the record.
Disabled: Record is visible in some
areas of the UI, but may not be
changed or accessed.
Deleted: Record is scheduled to be
removed.
DATA_SRC_PK1
INT (4)
Y
References the PK1 (Primary Key)
attribute of the DATA_SOURCE table.
DTMODIFIED
DATETIME (8)
Y
The date the relationship between the
user and the Institution Role was last
modified.
APPLICATION
Applications are the tools and features that appear in the Blackboard Learning System.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 223
Blackboard K–12 Academic Suite
Att r ibute
©
Administrator Manual
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
PK1
INT (4)
N
Unique identifier for each record.
(Primary Key)
APPLICATION
VARCHAR (64)
N
Internal system identifier.
LARGE_ICON
VARCHAR (255)
Y
Location of the image to display with
the application if large icons are
used.
PLUGINS_PK1
INT (4)
Y
References the PK1 (Primary Key)
attribute of the PLUGINS table.
ENABLED_MASK
INT (4)
Y
Determines whether or not the tool is
enabled.
SSL_IND
CHAR (1)
Y or N
N
Displays whether or not SSL is
enabled for the application.
RELABEL_IND
CHAR (1)
Y or N
N
Displays whether or not the
application can be renamed.
LABEL
NVARCHAR
(255)
Y
Name of the application as it appears
in the user interface.
SMALL_ICON
VARCHAR (255)
Y
Location of the image to display with
the application if small icons are
used.
TYPE
VARCHAR (20)
Y
Defines the application as a Class
application, System (Portal)
application, or Shared application.
DESCRIPTION
NTEXT (16)
Y
A description of the application.
ALLOW_GUEST_MASK
INT (4)
Y
Determines whether or not Guests
can access.
ALLOW_OBSERVER_MASK
INT (4)
Y
Determines whether or not Parents
can access the application.
NAME
NVARCHAR (64)
Y
This field displays the name of the
function or tool.
CAN_RELABEL_IND
CHAR (1)
Y or N
Y
Determines whether or not the name
of the application can be changed by
a Teacher or Administrator.
CAN_ALLOW_GUEST_IND
CHAR (1)
Y or N
Y
Determines whether or not the
Teacher can control Guest access to
the feature or tool.
CAN_ALLOW_OBSERVER_IND
CHAR (1)
Y or N
Y
Determines whether or not the
Teacher can control Parent access
to the feature or tool.
CAN_CONFIGURE_IND
CHAR (1)
Y or N
Y
Signifies if the tool is configured
through an outside Web site. This
only applies to Building Blocks tools.
2007 Blackboard Inc. Proprietary and Confidential.
Page 224
Blackboard K–12 Academic Suite
Att r ibute
CONFIGURE_URL
Administrator Manual
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
VARCHAR
(1000)
Y
The URL used to configure the tool.
NAVIGATION_ITEM
Att r ibute
©
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
PK1
INT (4)
N
Unique identifier for each record. (Primary
Key)
APPLICATION
NVARCHAR (64)
Y
Application accessed through the navigation
item
INTERNAL_HANDLE
VARCHAR (255)
N
Unique identifier.
ENTITLEMENT_UID
VARCHAR (255)
Y
Defines the entitlement required to access
the item.
FAMILY
VARCHAR (255)
Y
Top level for groupings of navigation items.
HREF
VARCHAR (2550
Y
Address of the application in the file system.
ENABLED_MASK
INT (4)
Y
Determines if the item is enabled in a Class,
the system, or an Organization.
COMPONENT_TYPE
VARCHAR (20)
Y
Groups items under the Sub-Group heading.
NAVIGATION_TYPE
VARCHAR (20)
Y
Class or System Determines whether the
navigation item is available in Classes or
through the portal.
SRC
VARCHAR (255)
Y
Image or icon connected to the navigation
item.
LABEL
VARCHAR (255)
Y
Name of the navigation item as it appears
within the system.
DESCRIPTION
VARCHAR (3900)
Y
Description of the navigation item as it
appears in the system.
SUB_GROUP
VARCHAR (255)
Y
Groups navigation items under the Family
heading.
POSITION
INT (4)
Y
Order that the navigation item appears in the
system in relation to other items in the same
grouping.
LAUNCH_IND
CHAR (1)
Y or N
Y
Determines whether or not to launch the
application in a separate browser window.
REDIRECT_URL
VARCHAR (255)
Y
Some navigation items, such as the Lost
Password page, may be redirected. If
allowed, the redirected URL appears in this
field.
USER_LABEL
NVARCHAR
(255)
Y
Customized label.
2007 Blackboard Inc. Proprietary and Confidential.
Page 225
Blackboard K–12 Academic Suite
Att r ibute
VISIBLE_IND
Administrator Manual
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
CHAR (1)
Y
Determines whether or not the item is visible
to users.
USERS
Att r ibute
Data T ype
a nd
Co nst ra ints
Null? Descript ion
PK1
INT (4)
N
Unique identifier for each record.
(Primary Key)
CITY
NVARCHAR
(50)
Y
City of the users address.
DATA_SRC_PK1
INT (4)
Y
References the PK1 (Primary Key)
attribute of the DATA_SOURCE table.
SYSTEM_ROLE
CHAR (1)
N
One character identifier of the
Administrator Role assigned to the
User.
Z=System Administrator
A=User Administrator
C=Class Administrator
H=System Support
N=None
O=Parent
R=Support
U=Guest
©
SOS_ID_PK2
INT (4)
N
Not in use.
DTCREATED
DATETIME (8)
N
Date the user was created in the
system.
DTMODIFIED
DATETIME (8)
Y
Last date that the user record was
modified in the system.
2007 Blackboard Inc. Proprietary and Confidential.
Page 226
Blackboard K–12 Academic Suite
Att r ibute
ROW_STATUS
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
NUMERIC (5)
N
Sets the value of the record to one of
the following:
Enabled: Normal access to the record.
Disabled: Record is visible in some
areas of the UI, but may not be
changed or accessed.
Deleted: Record is scheduled to be
removed.
©
BATCH_UID
NVARCHAR
(64)
Y
Unique identifier within the database.
USER_ID
NVARCHAR
(50)
N
Username.
PASSWD
VARCHAR (32)
N
The user's password.
FIRSTNAME
NVARCHAR
(100)
N
The first name of the user.
MIDDLENAME
NVARCHAR
(100)
Y
The middle name of the user.
LASTNAME
NVARCHAR
(100)
N
The last name of the user.
GENDER
CHAR (1)
F or M
Y
The sex of the user.
EDUC_LEVEL
NUMERIC (5)
Y
Highest level of education achieved by
the user.
BIRTHDATE
DATETIME (8)
Y
The user's birthdate.
TITLE
NVARCHAR
(100)
Y
A title in the user's name (for example,
Mr. or Dr.).
STUDENT_ID
NVARCHAR
(100)
Y
Users Student ID as assigned by the
Institution. Uniqueness is not enforced
on this field, it is used to store
information only.
EMAIL
VARCHAR
(100)
Y
The Users email address.
JOB_TITLE
NVARCHAR
(100)
Y
The users job title.
DEPARTMENT
NVARCHAR
(100)
Y
Department, section, or area where the
User works.
COMPANY
NVARCHAR
(100)
Y
Company for which the user works.
2007 Blackboard Inc. Proprietary and Confidential.
Page 227
Blackboard K–12 Academic Suite
Att r ibute
©
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
STREET_1
NVARCHAR
(100)
Y
Street in the users address.
INSTITUTION_ROLES_PK1
INT (4)
N
References the PK1 (Primary Key)
attribute of the INSTITUTION_ROLES
table.
STREET_2
NVARCHAR
(100)
Y
Another line for Street in the users
address.
STATE
NVARCHAR
(50)
Y
State in the users address.
ZIP_CODE
NVARCHAR
(50)
Y
ZIP code in the Users address.
COUNTRY
NVARCHAR
(50)
Y
Country in the Users address.
B_PHONE_1
NVARCHAR
(50)
Y
The user's business phone number.
B_PHONE_2
NVARCHAR
(50)
Y
A second line for another business
phone number.
H_PHONE_1
NVARCHAR
(50)
Y
The Users home phone number.
H_PHONE_2
NVARCHAR
(50)
Y
A second line for another home phone
number.
M_PHONE
NVARCHAR
(50)
Y
The user's mobile phone number.
B_FAX
NVARCHAR
(50)
Y
The users business fax number.
H_FAX
NVARCHAR
(50)
Y
The users home fax number.
WEBPAGE
VARCHAR
(100)
Y
The URL for the Users Web page.
SETTINGS
NTEXT (16)
Y
text box with info about the user.
COMMERCE_ROLE
INT (4)
Y
This field relates to a Blackboard.com
value. It is only relevant in the context of
Blackboard.com.
CDROMDRIVE_PC
CHAR (1)
Y
One character identifying the drive of
the CD-ROM drive on the user's
personal computer.
CDROMDRIVE_MAC
NVARCHAR
(20)
Y
Name of the CD-ROM drive on the
users computer, if using an Apple
Macintosh.
2007 Blackboard Inc. Proprietary and Confidential.
Page 228
Blackboard K–12 Academic Suite
Att r ibute
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
PUBLIC_IND
CHAR (1)
Y or N
N
Determines whether or not the user's
personal information is displayed in the
User Directory.
ADDRESS_IND
CHAR (1)
Y or N
N
Determines if the user's home address
will be displayed in the User Directory.
PHONE_IND
CHAR (1)
Y or N
N
Determines if home phone, fax, or cell
phone numbers will be displayed in the
User Directory.
WORK_IND
CHAR (1)
Y or N
N
Determines if work contact information
(company, department, title, phone, and
fax) will be displayed in the User
Directory.
EMAIL_IND
CHAR (1)
Y or N
N
Determines if the users email address
will be displayed in the User Directory.
AVAILABLE_IND
CHAR (1)
Y or N
N
User account availability within the
system.
LAST_LOGIN_DATE
DATETIME (8)
Y
Last date that the user logged into the
system.
IM_TYPE
NVARCHAR
(64)
Y
This field is not used to store data.
IM_ACCOUNT
NVARCHAR
(64)
Y
This field is not used to store data.
CARD_NUMBER
VARCHAR
(100)
Y
The card number associated with the
user's Blackboard Transaction System
Campus Card.
COURSE_MAIN
Att r ibute
©
Data T ype
a nd
Co nst ra ints
Null? Descript ion
PK1
INT (1)
N
Unique identifier for each record. (Primary
Key)
BUTTONSTYLES_PK1
INT (4)
Y
References the PK1 (Primary Key) attribute
of the BUTTONSTYLES table.
CARTRIDGE_PK1
INT (4)
Y
References the PK1 (Primary Key) attribute
of the CARTRIDGE table.
CLASSIFICATIONS_PK1
INT (4)
Y
References the PK1 (Primary Key) attribute
of the CLASSIFICATIONS table.
2007 Blackboard Inc. Proprietary and Confidential.
Page 229
Blackboard K–12 Academic Suite
Att r ibute
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
DATA_SRC_PK1
INT (4)
Y
References the PK1 (Primary Key) attribute
of the DATA_SOURCE table.
SOS_ID_PK2
INT (4)
Y
Not in use.
DTCREATED
DATETIME (8)
N
Date the Class was created in the system.
DTMODIFIED
DATETIME (8)
Y
Last date that the Class was modified in the
system.
COURSE_NAME
NVARCHAR
(255)
N
Complete title of the Class.
COURSE_ID
VARCHAR
(50)
N
Short name used by the Institution to
uniquely identify the Class (for example,
math101 _F99).
COURSE_DESC
NTEXT(16)
Y
Complete description of the Class.
ROW_STATUS
NUMERIC (5)
Y
Sets the value of the record to one of the
following:
Enabled: Normal access to the record.
Disabled: Record is visible in some areas
of the UI, but may not be changed or
accessed.
Deleted: Record is scheduled to be
removed.
©
BATCH_UID
NVARCHAR
(64)
Y
Unique identifier.
ENROLL_OPTION
CHAR (1)
E,I, or S
Y
Establishes the enrollment policy for the
Class. The options are email request for
enrollment, self-enroll for Students to enroll
themselves, and Teacher-enroll to allow
Teachers to completely control enrollment.
2007 Blackboard Inc. Proprietary and Confidential.
Page 230
Blackboard K–12 Academic Suite
Att r ibute
DURATION
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
CHAR (1)
Y
Schedules enrollment window. Options are:
Continuous: The Class is always
accessible.
Range: The Class is accessible in the days
between one date and another. Either the
beginning date or the end date can be left
open-ended to make a Class accessible
from a certain date or until a certain date.
Fixed: The Class is accessible for a set
number of days.
©
PACE
CHAR (1)
S, or I
Y
Indicates if the Class is Teacher-led or selfpaced according to the Student.
SERVICE_LEVEL
CHAR (1)
Y
determines Class or Organization.
ABS_LIMIT
NUMERIC (9)
Y
Handles the disk quota absolute limit on
content. The content in the Class may not
exceed this limit. Expressed in bytes.
SOFT_LIMIT
NUMERIC (9)
Y
Handles the disk quota soft limit on content.
Teachers receive a warning email when
this limit is exceeded. Expressed in bytes.
UPLOAD_LIMIT
NUMERIC (9)
Y
Handles the disk quota limit on uploads.
Expressed in bytes.
START_DATE
DATETIME (8)
Y
Date on which access to the Class section
begins.
END_DATE
DATETIME (8)
Y
Date on which access to the Class ends.
ENROLL_START_DATE
DATETIME (8)
Y
Date that enrollment may begin.
ENROLL_END_DATE
DATETIME (8)
Y
Date that enrollment is no longer available
to Students.
DAYS_OF_USE
NUMERIC (5)
Y
Number of days that Students may access
the Class after enrollment. Useful for selfpaced learning.
FEE
NUMERIC (9)
Y
Fee for the Class.
ENROLL_ACCESS_CODE
NVARCHAR
(50)
Y
Password needed to enroll in the Class.
BANNER_URL
VARCHAR
(100)
Y
Link to an image that will display at the top
of the Class.
INSTITUTION_NAME
NVARCHAR
(255)
Y
The name of the Institution.
2007 Blackboard Inc. Proprietary and Confidential.
Page 231
Blackboard K–12 Academic Suite
Att r ibute
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
REG_LEVEL_IND
CHAR (1)
Y or N
N
This field is used for the Blackboard.com
service. It has not relevance outside of the
Blackboard.com site.
NAVIGATION_STYLE
VARCHAR
(20)
Y
Determines whether the Class Menu uses
buttons or text links.
TEXTCOLOR
VARCHAR
(20)
Y
Color used for text in the Class Menu.
BACKGROUND_COLOR
VARCHAR
(20)
Y
Color used for the background of the Class
Menu.
COLLAPSIBLE_IND
CHAR (1)
N
Determines whether or not the Class Menu
can be consolidated to show just the top
headings or expanded to show subheads.
ALLOW_GUEST_IND
CHAR (1)
Y or N
N
Allows guest access to the Class.
CATALOG_IND
CHAR (1)
Y or N
N
Establishes whether the Class or
Organization appears in catalog.
LOCKOUT_IND
CHAR (1)
Y or N
N
Indicates if access to the Class or
Organization has been restricted. If set to Y
access to the Class or Organization will be
restricted based on the END_DATE and
START_DATE.
DESC_PAGE_IND
CHAR (1)
Y or N
N
Determines whether or not to display
description information in the Class or
Organization catalog.
AVAILABLE_IND
CHAR (1)
Y or N
N
Establishes Class or Organization
availability.
ALLOW_OBSERVER_IND
CHAR (1)
Y or N
N
Determines whether or not Parents are
allowed in the Class.
LOWER_COURSE_ID
VARCHAR
(50)
Y
Lowercase version of Course ID used by
the system for searches (guarantee a find).
DATA_SOURCE
Att r ibute
©
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
PK1
INT (4)
N
Unique identifier for each record. (Primary Key)
DTMODIFIED
DATETIME (8)
Y
The date the data source was last modified.
2007 Blackboard Inc. Proprietary and Confidential.
Page 232
Blackboard K–12 Academic Suite
Att r ibute
ROW_STATUS
Administrator Manual
D a t a T yp e a nd
Co nst ra ints
Null? Descript ion
NUMERIC (5)
N
Sets the value of the record to one of the
following:
Enabled: Normal access to the record.
Disabled: Record is visible in some areas of
the UI, but may not be changed or accessed.
Deleted: Record is scheduled to be removed.
BATCH_UID
NVARCHAR (64)
Y
Unique identifier.
DESCRIPTION
NVARCHAR (128)
Y
Description of the data source.
SYSTEM_TRACKING
Att r ibute
©
Data T ype
a nd
Co nst ra ints
Null? Descript ion
PK1
INT (4)
N
Unique identifier for each record.
(Primary Key)
TIMESTAMP
DATETIME
(8)
Y
Date and time that the statistics were
gathered.
COURSES
NUMERIC (9)
Y
Total number of Classes in the system.
ACTIVECOURSES
NUMERIC (9)
Y
Total number of active Classes in the
system. An active Class is one that has
been accessed in the last 30 days.
CARTRIDGES
NUMERIC (9)
Y
Total number of Course Cartridges used
in the system.
ORGANIZATIONS
NUMERIC (9)
Y
Total number of Organizations in the
system.
ACTIVEORGANIZATIONS
NUMERIC (9)
Y
Total number of active Organizations in
the system.
ACTIVEUSERS
NUMERIC (9)
Y
Total number of active users in the
system. An active user has accessed
the system within the last 30 days.
Users disabled through the Snapshot
tool are still considered active if he or
she has accessed the Class in the last
30 days.
USERS
NUMERIC (9)
Y
Total number of users in the system.
USERS_Z
NUMERIC (9)
Y
Total number of users with an
Administrative User Role of Z (default
name: System Admin).
2007 Blackboard Inc. Proprietary and Confidential.
Page 233
Blackboard K–12 Academic Suite
Att r ibute
©
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
USERS_A
NUMERIC (9)
Y
Total number of users with an
Administrative User Role of A (default
name: User Administrator).
USERS_C
NUMERIC (9)
Y
Total number of users with an
Administrative User Role of C (default
name: Class Administrator).
USERS_H
NUMERIC (9)
Y
Total number of users with an
Administrative User Role of H (default
name: System Support).
USERS_N
NUMERIC (9)
Y
Total number of users with an
Administrative User Role of N (default
name: None).
USERS_O
NUMERIC (9)
Y
Total number of users with an
Administrative User Role of O (default
name: Parent).
USERS_R
NUMERIC (9)
Y
Total number of users with an
Administrative User Role of R (default
name: Support).
USERS_U
NUMERIC (9)
Y
Total number of users with an
Administrative User Role of U (default
name: Guest).
ACTIVE_COURSE_USERS
NUMERIC (9)
Y
Total number of active users (includes
enrollments as well as staff
assignments). Active Class users are
those enrolled users that have accessed
the Class in the past 30 days.
COURSE_USERS_B
NUMERIC (9)
Y
Total number of users with a Course
Role of B (default name: Course
Builder).
Class_USERS_G
NUMERIC (9)
Y
Total number of users with a Course
Role of G (default name: Grader).
Class_USERS_P
NUMERIC (9)
Y
Total number of users with a Course
Role of P (default name: Teacher).
Class_USERS_S
NUMERIC (9)
Y
Total number of users with a Course
Role of S (default name: Student).
Class_USERS_T
NUMERIC (9)
Y
Total number of users with a Course
Role of T (default name: Teachers
Assistant).
Class_USERS_U
NUMERIC (9)
Y
Total number of users with a Course
Role of U (default name: Guest).
INST_USERS_1
NUMERIC (9)
Y
Total number of users with an Institution
Role of 1 (default name: Student).
2007 Blackboard Inc. Proprietary and Confidential.
Page 234
Blackboard K–12 Academic Suite
©
Administrator Manual
Att r ibute
Data T ype
a nd
Co nst ra ints
Null? Descript ion
INST_USERS_2
NUMERIC (9)
Y
Total number of users with an Institution
Role of 2 (default name: Faculty).
INST_USERS_3
NUMERIC (9)
Y
Total number of users with an Institution
Role of 3 (default name: Staff).
INST_USERS_4
NUMERIC (9)
Y
Total number of users with an Institution
Role of 4 (default name: Alumni).
INST_USERS_5
NUMERIC (9)
Y
Total number of users with an Institution
Role of 5 (default name: Prospective
Student).
INST_USERS_6
NUMERIC (9)
Y
Total number of users with an Institution
Role of 6 (default name: Guest).
INST_USERS_7
NUMERIC (9)
Y
Total number of users with an Institution
Role of 7 (default name: Other).
INST_USERS_8
NUMERIC (9)
Y
Total number of users with an Institution
Role of 8 (default name: Parent).
INST_USERS_9
NUMERIC (9)
Y
Total number of users with an Institution
Role of 9 (default name: Role 9).
INST_USERS_10
NUMERIC (9)
Y
Total number of users with an Institution
Role of 10 (default name: Role 10).
INST_USERS_11
NUMERIC (9)
Y
Total number of users with an Institution
Role of 11 (default name: Role 11).
INST_USERS_12
NUMERIC (9)
Y
Total number of users with an Institution
Role of 12 (default name: Role 12).
INST_USERS_13
NUMERIC (9)
Y
Total number of users with an Institution
Role of 13 (default name: Role 13).
INST_USERS_14
NUMERIC (9)
Y
Total number of users with an Institution
Role of 14 (default name: Role 14).
INST_USERS_15
NUMERIC (9)
Y
Total number of users with an Institution
Role of 15 (default name: Role 15).
INST_USERS_16
NUMERIC (9)
Y
Total number of users with an Institution
Role of 16 (default name: Role 16).
INST_USERS_17
NUMERIC (9)
Y
Total number of users with an Institution
Role of 17 (default name: Role 17).
INST_USERS_18
NUMERIC (9)
Y
Total number of users with an Institution
Role of 18 (default name: Role 18).
INST_USERS_19
NUMERIC (9)
Y
Total number of users with an Institution
Role of 19 (default name: Role 19).
INST_USERS_20
NUMERIC (9)
Y
Total number of users with an Institution
Role of 20 (default name: Role 20).
2007 Blackboard Inc. Proprietary and Confidential.
Page 235
Blackboard K–12 Academic Suite
Att r ibute
©
Administrator Manual
Data T ype
a nd
Co nst ra ints
Null? Descript ion
PAGE_VIEWS
NUMERIC (9)
Y
Total number of page views to date. A
page view is any request for a page that
occurs outside of a course or
Organization.
SESSIONS
NUMERIC (9)
Y
Number of open sessions.
Class_PAGE_VIEWS
NUMERIC (9)
Y
Total number of course page views to
date. A course page view is a request
for a page that occurs within a course or
an Organization.
SYSTEMEXTENSIONS
NUMERIC (9)
Y
Total number of Building Blocks.
LOGIN_ATTEMPTS_SUCCESS
NUMERIC (9)
Y
Total number of successful login
attempts.
LOGIN_ATTEMPTS_FAILURE
NUMERIC (9)
Y
Total number of failed login attempts.
2007 Blackboard Inc. Proprietary and Confidential.
Page 236
Blackboard K–12 Academic Suite
Administrator Manual
Auto-Reporting Options
Overview
Auto-reporting sends system updates to a secure Blackboard server automatically. Blackboard
Support uses this information to assist the Administrator in maintaining Blackboard K-12 Suite. In
addition, Administrators can disable the event tracking that generates reports on activity in the
Blackboard K-12 Suite from this page.
Find this page
Follow these steps to open the Auto-Reporting Options page.
1.
Click System Reports on the Administrator Panel.
2.
Click Auto-Reporting Options from the System Reports menu page.
Fields
Click Yes in the Enable Auto-Reporting field to automatically send system data updates to a
secure Blackboard K-12 Suite server. The benefits of auto-reporting are
•
Assist in capacity planning with Blackboard K-12 Suite for future growth
•
Notification from Blackboard Learning System when a patch or upgrade is available
•
Assist system maintenance with the help of Blackboard Support staff
Note: If Auto-Reporting is disabled no data will still be sent to the Blackboard
database.
In the Enable Event Tracking field, Yes is the default selection. Select No to disable tracking
and reporting of user actions through System Reporting and Advanced System Reporting.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 237
Blackboard K–12 Academic Suite
Administrator Manual
Send System Statistics to Blackboard
Overview
Email system statistics to Blackboard from the Send System Statistics to Blackboard page.
Blackboard Support staff use system statistics to help troubleshoot problems.
Find this page
Follow these steps to open the Send System Statistics to Blackboard page.
1.
Click System Reports on the Administrator Panel.
2.
Click Send System Statisticsto Blackboard from the System Reports menu page.
Fields
The table below details the fields on the Send System Statistics to Blackboard page.
F i e ld
Descript ion
Edit Statistics Message
©
To
Displays the email address at Blackboard that will receive system statistics. This
field is display only.
From
Displays the email address of the Administrator. This field is display only.
Subject
Displays a subject for the message. This field populates with a default subject
that can be changed before sending.
Message
Enter a message to Blackboard to send along with the attached statistics.
2007 Blackboard Inc. Proprietary and Confidential.
Page 238
Blackboard K–12 Academic Suite
Administrator Manual
System Information
Overview
This section details the pages that display information about the system, license, and Institution.
In this section
This section includes the following topics.
©
T op i c
Descript ion
System Information
This topic covers the System Information page. This page lists details
about licensing and the versions of installed Blackboard K-12 Suite
components.
Registration
Information
This topic covers the Registration Information page. Administrators can
view and change information about the Institution from this page.
System
Performance
Settings
This topic covers the System Performance Settings page.
Administrators can view the current performance settings from this
page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 239
Blackboard K–12 Academic Suite
Administrator Manual
About System Information
Overview
The System Information page displays the date Blackboard K-12 Suite was installed, the last date
Blackboard K-12 Suite was updated, and the current version of installed components. This
information is useful in determining if the system is running the latest patch or upgrade release.
Find this page
Follow these steps to open the System Information page.
©
1.
Click System Config Info on the Administrator Panel.
2.
Click System Information from the System Config Info page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 240
Blackboard K–12 Academic Suite
Administrator Manual
Registration Information
Overview
Administrators view and modify the registration information provided at installation through the
Registration Information page. Click Submit after making any changes to send updated
registration information to Blackboard.
Find this page
Follow these steps to open the Registration Information page.
1.
Click System Config Info on the Administrator Panel.
2.
Click Registration Information from the System Config Info page.
Fields
The table below details the fields on the Registration Information page.
F i e ld
Descript ion
View/Modify Registration Information
©
Name
Displays the name of the Institution.
City
Displays the city of the Institution.
State
Displays the state of the Institution.
ZIP Code
Displays the ZIP Code of the Institution.
Country
Displays the country of the Institution.
Institution Type
Displays the Institution type.
2007 Blackboard Inc. Proprietary and Confidential.
Page 241
Blackboard K–12 Academic Suite
Administrator Manual
System Performance Settings
Overview
The System Performance Settings page displays the server settings that determine performance.
Performance settings can be tuned by editing a properties file and running a command line tool.
Find this page
Follow these steps to open the System Performance Settings page.
1.
Click System Config Info on the Administrator Panel.
2.
Click System Performance Settings.
Settings
Each setting is listed with its value. This information can be critical when troubleshooting
performance issues. Click on a setting to display a short definition.
Change settings
Edit the bbconfig.properties file and run the PushConfigUpdates command to make changes to
performance settings. More information on running this command can be found in the Blackboard
K-12 Suite Setup Guide.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 242
Blackboard K–12 Academic Suite
Administrator Manual
Logs
Overview
This section details the features on the Administrator Panel that allow Administrators to manage
the log files.
In this section
The Logs chapter includes the following topics.
©
T op i c
Descript ion
About Logs
This topic covers the logs page. This page is a menu page with links
to the features used to manage logs.
Send System Logs
This topic covers the Send System Logs page. Administrators can
send an email of selected logs.
Download Individual
System Logs
This topic covers the Download Individual System Logs page.
Selected logs can be downloaded from this page.
Manage Log
Rotation
This topic covers the Manage Log Rotation page. Administrators can
manually rotate logs as well as determine when logs are automatically
rotated.
Log Descriptions
Lists the different system logs and describes the information recorded
in each log.
Cartridge Import
Status
This topic covers the Cartridge Download Status page. Administrators
can view and manage current Course Cartridge downloads from this
page.
System Tasks
Status
This topic covers the System Tasks Status page. Administrators can
view the status of Classes that have been copied from this page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 243
Blackboard K–12 Academic Suite
Administrator Manual
About Logs
Overview
The Blackboard K-12 Suite generates a number of logs to help system Administrators with
performance tuning, troubleshooting, and tracking. The Logs features are a quick way to manage
logs through the interface. It is also possible to manage logs at the operating system level or
through a third party tool.
Find this page
Click Logs on the Administrator Panel.
Functions
The following functions are available through the Logs page.
To . . .
click . . .
email log files
Send System Logs. The Send System Logs page will appear.
download log files
Download Individual System Logs. The Download Individual
System Logs page will appear.
configure log rotation
Manage Log Rotation. The Manage Log Rotation page will
appear.
check on Course
Cartridge import
Cartridge Import Status. The Cartridge Import Status page will
appear.
Check Class Copy status
System Tasks Status. The System Tasks Status page will
appear.
Blackboard K-12 Suite logs
All logs are stored in the logs directory under the top-level blackboard directory. Within the logs
directory there are folders that store logs as well as an archive folder for logs that have been
compressed and stored as a means of managing the size of the log files.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 244
Blackboard K–12 Academic Suite
Administrator Manual
Send System Logs
Overview
The Send System Logs feature is a quick way for an Administrator to view a log without having to
access the application file system on the Web/application server. The logs are emailed to the
Administrator from this page.
Find this page
Follow these steps to open the Send System Logs page.
1.
Click Logs on the Administrator Panel.
2.
Click Send System Logs.
Fields
The following table details the fields on the Send System Logs page.
F i e ld
Descript ion
Recipients
To
Click this check box to send the logs to the system Administrator.
Enter Message Details
From
This field is display only.
Subject
This field will automatically populate but can be changed by the sender.
Message
This field will populate with the name of the server. The sender can add a
message to the System Administrator.
Set Message Options
Send Copy of
Message to self
Click this check box to send a copy of the logs to the email address
associated with your account.
Add Attachments
©
Current Log
Files
Select the current log file or files to send to the Administrator. To select
more than one log, hold down the Control key. The size of each log file is
displayed following the name of the log.
Archive of Old
Logs
Select the archived log file or files to send to the Administrator. To select
more than one .ZIP package, hold down the Control key. The size of
each log file is displayed following the name of the log.
2007 Blackboard Inc. Proprietary and Confidential.
Page 245
Blackboard K–12 Academic Suite
Administrator Manual
Download Individual System Logs
Overview
System Logs can be downloaded and saved to another location. Downloading a log will not
remove the log. The downloaded log is a static file, it will not be updated with system events.
System events will continue to be written to the original log.
Find this page
Follow these steps to open the Download Individual System Logs.
1.
Click Logs on the Administrator Panel.
2.
Click Download Individual System Logs.
Download a log
The logs that are available for download are listed as links. Logs that contain passwords or other
sensitive information are marked with a red asterisk. For most browsers, clicking on the link to a
log will open a download window. If it does not download try right-clicking on a log and selecting
Save target as . . . from the menu.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 246
Blackboard K–12 Academic Suite
Administrator Manual
Manage Log Rotation
Overview
The Manage Log Rotation tool creates an archive file of all logs. The entries that are sent to the
archive are set on this page. Once the logs have been rotated, the logs will consume less space.
Please note that the archive files must be moved or deleted manually or they will remain on the
Web/application server indefinitely.
Note: There is a command line tool available for manually rotating logs.
Find this page
Follow these steps to open the Manage Log Rotation page.
1.
Click Logs on the Administrator Panel.
2.
Click Manage Log Rotation.
Fields
The table below details the fields on the Manage Log Rotation page.
F i e ld
Descript ion
Configure Log Rotation Behavior
©
Set Frequency of
System Log
Rotation
Select a number of days between log rotations from the drop-down list.
Logs will be rotated and archives created at intervals based on the
number of days set.
If logs are manually rotated from the command line it will not interrupt
the regular intervals. However, the logs that were rotated manually will
not be included in the archive files created at the regularly scheduled
rotation.
For example, if the log rotation is set at 30 days and the logs are
manually rotated after 15 days, only the last 15 days of logs will be
included in the archives at the next scheduled log rotation.
Set Time of Day
for System Log
Rotation
Set the time of day that the logs will be rotated. The time is determined
based on the server clock. If the server is in a different time zone be
sure to take that into account when selecting a time for the rotation to
occur.
2007 Blackboard Inc. Proprietary and Confidential.
Page 247
Blackboard K–12 Academic Suite
Administrator Manual
Manual log rotation
The RotateLogs tool processes a log rotation outside the scheduled log rotations configured
through the Manage Log Rotation page. The tool stops all necessary services and starts the
services after the rotation is finished.
Windows:
\Blackboard\tools\admin\RotateLogs.bat
UNIX:
/blackboard/tools/admin/RotateLogs.sh
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 248
Blackboard K–12 Academic Suite
Administrator Manual
Log Descriptions
Overview
The log files that appear within the user interface are also accessible within the file system. It
should be noted that the user interface provides a more descriptive title than the names in the file
system. Also, when opening logs downloaded from the user interface, it may be necessary to
open them in Excel or a similar program—sometimes the text runs together and individual entries
are difficult to discern.
Log Descriptions
The table below lists the logs as they appear in the file system, the user interface, and a
description of each.
F i l e S ys t e m
U s er I nt e rfa ce
Descript ion
collab-server
DATE_Collaboration
Server_BYTES
Logs events associated with the
Collaboration Service.
contentexchange
DATE_Content Exchange
Tool_BYTES
Logs events and errors with Class
import/export/archive/restore/copy
httpd
perlex
Logs events from the Web server (IIS or
Apache).
DATE_Perl App
Server_BYTES
snapshot
Logs snapshot events.
system-info
DATE_System
Information_BYTES
Lists hardware and software information
and settings.
update-tools
DATE_System
Update_BYTES
Logs events associated with system
updates.
bb-services-log
DATE_Blackboard Services
(Daemons)_BYTES
Logs services exceptions, including
authentication exceptions.
isapi_redirect.log
DATE_Session
Manager_BYTES
Logs session exceptions.
jasper.log
©
Logs events associated with the Perl
engine.
This log will include additional events
written by the Tomcat Java App Server if
the verbosity is set high.
servlet.log
DATE_servlet.log_BYTES
Logs Java servlet events.
tomcat-jvmstderr.txt
DATE_Java App Server stderr_BYTES
Logs Java App server exceptions.
tomcat-jvmstdout.txt
DATE_Java App Server stdout_BYTES
Logs Java App server output.
2007 Blackboard Inc. Proprietary and Confidential.
Page 249
Blackboard K–12 Academic Suite
Administrator Manual
Cartridge Import Status
Overview
Administrators can troubleshoot Course Cartridge downloads from the Cartridge Import Status
page. Downloads that do not complete correctly can be removed from the system or restarted.
Find this page
Follow these steps to open the Cartridge Import Status page.
1.
Click Logs on the Administrator Panel.
2.
Click Cartridge Import Status.
Functions
The table below details the functions available on the Cartridge Download Status page.
©
To . . .
click . . .
Remove a Cartridge Download that is in
progress or has failed to complete
Remove. Any Cartridge content that was
added to the Class will be deleted.
Reset a download that has failed to
complete
Reset. The download will begin again.
2007 Blackboard Inc. Proprietary and Confidential.
Page 250
Blackboard K–12 Academic Suite
Administrator Manual
System Tasks Status
Overview
The System Tasks Status page lists attempts to copy a Class or Class materials in a table. Each
attempt is a row with the following attributes (columns)
•
Title: Shows the destination (target) Course ID and the source Course ID separated by
a pipe (|).
•
Type: Class Copy is displayed.
•
Status: Displays the current state of the attempt. The options for this area include
Waiting, Complete and Running.
Reports may be sorted by clicking the carats at the top of each column. For example, to sort
completed copies from those that are still in process, click the carat above the Status column.
Administrators may view details of an attempt from this page. Reports on completed attempts
may be deleted if they are no longer needed.
Note: A status of Complete does not mean that the operation was successful;
only that it has finished. Administrators must open the Details of the Task to
ensure it was completed successfully.
Find this page
Follow these steps to locate the System Tasks Status page.
1.
Click Logs from the Administrator Panel.
2.
Click System Tasks Status from the Logs page.
View a status report
Click Details to view the report of a specific copy attempt. The report will show
•
Title: Target Class and source Class separated by a pipe delimiter
•
Type: The action attempted.
•
Status: Complete or in progress.
•
User: The User Name that initiated the copy operation.
•
Start Date: Date and time the copy operation was initiated.
•
End Date: Date and time the copy operation completed.
•
Results: Successful or unsuccessful.
Delete status reports
Mark the check box next to a report to select it for deletion. Click Delete Tasks in the action bar to
remove the selected reports from the list. Tasks are only deleted through this option; they will not
be purged after a specific amount of time.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 251
Blackboard K–12 Academic Suite
Administrator Manual
Designate Local Support Contact
Overview
Administrators enter a support contact for Teachers and Students from the Designate Local
Support Contact page. The email address provided by the Administrator will be linked to the
Support button in Class and Organizations. Teachers and Students will submit questions and
requests through this button.
Find this page
Select Designate Local Support Contact on the Administrator Panel.
Field
Enter an email address in the Email Address field. This address will be the Institution support
contact for Teachers and Students. The Support button in Class and Organizations will be linked
to this address.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 252
Blackboard K–12 Academic Suite
Administrator Manual
System Tools
Overview
This part describes the tools available to Administrators to communicate with users on the
system.
In this part
This part includes the following sections.
©
S e c t io n s
Descript ion
Building Blocks
This section includes information on installing and managing
Building Blocks.
System-wide
Announcements and
Events
This section details the features for creating and managing
Announcements and Calendar Events for all users.
Email
This section details the email features that allow the
Administrator to communicate with all users or specific sets of
users.
Messages
This section details the features that allows users to include
attachments with messages.
Text Box Editor and Spell
Check
This section details how to manage features for entering text.
Manage Tools
This section details the features for enabling and disabling
tools.
Chalk Titles
This section details the feature for using Chalk Title on the
system.
Language Packs
This section details using language packs in the system and
importing Classes from Blackboard Learning System - ML.
Creating a Language Pack
This section explains how to create a new language page.
Blackboard Backpack
This section covers configuration and rules for Blackboard
Backpack.
2007 Blackboard Inc. Proprietary and Confidential.
Page 253
Blackboard K–12 Academic Suite
Administrator Manual
Building Blocks
Overview
This section reviews the features for installing and managing Building Blocks from the
Administrator Panel. Building Blocks are an easy and secure way to extend the Blackboard K-12
Suite. Just a few of the ways Building Blocks can be used are custom portal modules, new
content tools, and new user tools.
Building Blocks must be created by the Institution or downloaded before they can be installed. To
download a Building Block contact the vendor or visit the Blackboard Building Blocks catalog on
the Web at http //buildingblocks.blackboard.com.
In this section
This section includes the following topics.
©
T op i c
Descript ion
Installing and
Uninstalling Building
Blocks
This topic has step by step instructions for installing and
uninstalling Building Blocks.
Manage Building Blocks
This topic covers the Manage Building Blocks page.
Administrators view and control the Building Blocks on the system
from this page.
Examine Building Block
This topic covers the Examine Building Block page. This page
describes the Building Block and its components.
Download Building
Blocks
This topic covers the Download Building Blocks page. This page
links Administrators to the Blackboard Building Blocks catalog.
Install Building Block
This topic covers the Install Building Block page. Administrators
install downloaded Building Blocks from this page.
The Open Standards
Content Player
This topic explains how to enable the Open Standards Content
Player which supports SCORM.
2007 Blackboard Inc. Proprietary and Confidential.
Page 254
Blackboard K–12 Academic Suite
Administrator Manual
Installing and Uninstalling Building Blocks
Overview
This topic includes step by step instructions for installing a Building Block and for uninstalling a
Building Block. In some cases, installing a new version of a Building Block may require the
existing version to be uninstalled before installing the new version. If overwriting the Building
Block does not work, try this method.
Note: Building Block vendors may occasionally update their Building Blocks.
Follow instructions from the vendor to run an update. Be aware that an update
will uninstall the old version of the Building Block and replace it with the new
version.
Step by step instructions
Follow these steps to install a Building Block.
1.
Click Manage Building Blocks from the Administrator Panel. The Manage Building
Blocks page will open.
2.
Click InstallBuilding Block. The Install Building Block page will open.
3.
Click Browse and locate the Building Block .war file. The path to the Building Block
should appear in the field. This file may also be a .zip file.
Note: Building Blocks can be created using Building Blocks technology or
acquired from third-party vendors. Blackboard maintains a catalog of Building
Blocks at http //buildingblocks.blackboard.com.
4.
Click Submit to upload the .war file to the Blackboard K-12 Suite.
5.
Click OK to return to the Manage Building Blocks page.
6.
Find the Building Block within the list of installed Building Blocks. The status of the
Building Block should be Inactive.
7.
To enable the Building Block select Available from the drop-down list. When the Building
Block is first made available the list of permissions required by the Building Block is
displayed. This is a security feature to protect the Blackboard K-12 Suite from dangerous
content. If you are concerned about the permissions given to a Building Block, contact
the vendor and ask about the permissions before changing the Building Block status from
Inactive.
8.
Click OK to make the Building Block available and allow it the listed permissions. The
system will display a confirmation message that the Building Block is enabled.
9.
Click OK to return to the Manage Building Blocks page. The Building Block should now
have a status of Available.
Uninstalling a Building Block
Follow these steps to completely remove a Building Block from the Blackboard K-12 Suite.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 255
Blackboard K–12 Academic Suite
Administrator Manual
Note: It is also possible to disable a Building Block. Disabling will keep the
Building Block in the Blackboard K-12 Suite but the Building Block will not be
available to users. This may be preferable to complete removal if the Building
Block will be used again in the future.
1.
Click Manage Building Blocks from the Administrator Panel.
2.
Find the Building Block to remove from the list.
3.
Click Remove for the Building Block. A message will appear to confirm the removal of the
Building Block.
4.
Click OK to complete the removal of the Building Block.
5.
Click OK to return to the Manage Building Blocks page. The Building Block should no
longer appear on this page.
What Happens to Building Block Content?
Content Tools that are added as Building Blocks allow Teachers to create different types of
content and display it to users. When these content tools are removed or made unavailable, it
restricts the ability for users to access this content.
Within a Class, the links to content items created with a Building Block will not appear to Students
when the Building Block is removed or made unavailable. Teachers will see the links to the
content but will not be able to open or view the content. The content will become available again if
the Building Block is once again made available.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 256
Blackboard K–12 Academic Suite
Administrator Manual
Manage Building Blocks
Overview
System Administrators can configure or remove installed Building Blocks from the Manage
Building Blocks page.
Find this page
Click Manage Building Blocks on the Administrator Panel.
Functions
This table details the functions available on the Manage Building Blocks page.
To . . .
click . . .
make changes to the
Building Block
Properties. The Properties page will appear. Make any changes to
the configuration of the Building Block. The properties are specific to
each Building Block and may contain items such as license files,
external resources, or global settings. This button will only appear if
the Building Block is configurable.
remove the Building
Block
Remove. This action is irreversible.
make the Building
Block unavailable/
available
The drop-down list in the Availability column and select Inactive,
Available, or Unavailable.
By default, all Building Blocks are first installed as Inactive.
Set the default
availability within
Classes for a
Building Block tool
The drop-down list in the Class/Org default column. This option
determines whether or not the tool is available by default within
Classes and Organizations.
examine details
about the Building
Block
View Components. The Examine Building Block page will appear.
download a Building
Block
Download Extension. The Blackboard Building Block Catalog will
open.
install a Building
Block
Install Extension.
Building Block status
Building Blocks can have a status of:
©
•
Inactive: This is the default state. In this state the Building Block is registered but
cannot execute any code, including configuration scripts.
•
Available: The Building Block is available to users.
•
Unavailable: The Building Block is registered, can execute code, but is not available to
users.
2007 Blackboard Inc. Proprietary and Confidential.
Page 257
Blackboard K–12 Academic Suite
Administrator Manual
Examine Building Block
Overview
The Examine Building Block page displays information about the Building Block and lists the
components that make up the Building Block. The information includes a description of the
Building Block , the version number and vendor information. The languages the Building Block is
available in is also included, as well as, the default language in which it will appear.
Find this page
Follow these steps to open the Examine Building Block page.
©
1.
Click Manage Building Blocks on the Administrator Panel.
2.
Click View Components for one of the Building Blocks in the list.
2007 Blackboard Inc. Proprietary and Confidential.
Page 258
Blackboard K–12 Academic Suite
Administrator Manual
Download Building Blocks
Overview
The Download Building Blocks link opens the Blackboard Building Blocks Catalog (http
//buildingblocks.blackboard.com). Building Blocks can be downloaded from the catalog to a
computer and then added to Blackboard K-12 Suite. Downloading a Building Block will not install
it! To install a Building Block once it has been downloaded, use the Install Extension feature.
Make sure that the Building Block is designed for your version of the Blackboard K-12 Suite.
Find this page
Follow these steps to open the Download Building Blocks page.
©
1.
Click Manage Building Blocks on the Administrator Panel.
2.
Click DownloadBuilding Blocks.
2007 Blackboard Inc. Proprietary and Confidential.
Page 259
Blackboard K–12 Academic Suite
Administrator Manual
Install Building Block
Overview
System Administrators can install a variety of Building Blocks to the Blackboard K-12 Suite from
the Install Building Blocks page. Before a Building Block can be installed it must be downloaded
or created.
Building Blocks can be acquired from third party vendors or through the Building Blocks Catalog
at http //buildingblocks.blackboard.com.
Find this page
Follow these steps to open the Install Building Block page.
1.
Click Manage Building Blocks on the Administrator Panel.
2.
Click Install Building Block.
Install a Building Block
The steps below detail how to install a Building Block through this page.
©
1.
Click the Browse button and select the Building Block to install.
2.
Click Submit.
3.
A message appears stating that the Building Block has been successfully installed. After
a Building Block is installed the status of the Building Block must be changed on the
Manage Building Blocks page before the Building Block can be used.
2007 Blackboard Inc. Proprietary and Confidential.
Page 260
Blackboard K–12 Academic Suite
Administrator Manual
The Open Standards Content Player
About the Content Player Building Block
The Open Standards Content Player Building Block ships with the product and must be made
available by the Administrator. Blackboard Learning System supports SCORM 2004 to the
Content Player, and installs automatically.
C o nte nt P la ye r
V e rs io n
B la ck boa rd Vers ion
C o nte nt Typ e s P l a ye d
2004.2.1
Blackboard Learning System
7.x
SCORM 1.2, IMS, NLN, SCORM
2004
Older versions of the Building Block can be downloaded from the Building Blocks Web site.
Note: The Content Player Building Block, like all Building Blocks, will not work
with the Blackboard Learning System - Basic Edition-.
Using the Content Player in a Class
The Open Standards Content Player Building Block uploads content that conforms to SCORM,
IMS, or NLN standards to a Class. Teachers see IMS, SCORM, and NLN as additional Content
Types for adding content.
When adding SCORM, IMS, or NLN data, the Teacher can choose to add a Grade Center Item,
as well as select from other standard content item options. When a user interacts with a package,
the attempt is shown in the Grade Center. Additional attempt data such as total viewing time and
completion status are also recorded to assist the Teacher in grading.
From the users’ perspective, IMS, SCORM, or NLN Content Items are seamlessly presented with
other Class content, and can even be added to a Learning Unit.
Supported Standards
The Open Standards Content Player Building Block supports the SCORM standard and the IMS
standard for Web content, as well as NLN Content, which conforms to SCORM and IMS.
IMS Content
The Open Standards Content Player Building Block supports content that conforms to the IMS
Content and Packaging 1.1.2 standard with the webcontent attribute.
Further information about the standard can be found at:
http://www.imsproject.org/content/packaging/index.cfm
SCORM Content
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 261
Blackboard K–12 Academic Suite
Administrator Manual
The Open Standards Content Player Building Block supports content that conforms to the
SCORM 1.2 standard and the SCORM 2004 standard. The Teacher does not need to determine
ahead of time whether the content is designed as 1.2 or 2004 compliant. The Content Player will
make this determination to play the content.
Further information about the standard can be found at: http://www.adlnet.org
NLN Content
The Open Standards Content Player Building Block supports NLN content, which conforms to
SCORM and IMS standards. The United Kingdom NLN Materials Team is responsible for
commissioning and developing e-learning materials for the NLN, and offers advice on best
practices in integrating the NLN materials into teaching and learning schemes.
Further information about the standard can be found at: http://www.nln.ac.uk/
Making the SCORM, NLN, and IMS Content Types Available
Depending on the needs of an Institution, one or all three of these Content Types can be made
available for Teachers to use in their Classes. Regardless of which Content Type is turned on,
the Building Block will do the work of determining the type of package and playing the content
properly.
Deciding which Content Type to expose in the dropdown of the Action Bar relates largely to what
term the Teachers and Class Builders use for standards-based content. For example, If users at
an Institution are more generally aware of SCORM content than NLN content, that corresponding
Content Type can be turned on and the other two turned off.
Making the Building Block Available on the Blackboard Learning System
When updating the Blackboard Learning System, the latest version of the Content Player Building
Block will automatically install. The new version of the Content Player allows the playing and
modification of all content previously added. Grade Center items will still be manageable from the
Grade Center. No new Grade Center items can be added for the previously added content.
In Blackboard Learning System, the Open Standards Content Player Building Block is
automatically updated to the latest version. The Administrator must set the Building Block to
Available.
Follow these steps to make the Content Player Building Block available:
©
1.
Login to the Blackboard Learning System with Administrator privileges.
2.
Click Manage Building Blocks on the Administrator Panel.
3.
Find the Content Player Building Block in the list of installed Building Blocks. It will be
named the Blackboard Content Player.
4.
Select Available from the drop-down list.
5.
A confirmation page will appear that displays all the permissions that will be granted to
the Content Player Building Block. This is a security feature to protect Blackboard
systems from dangerous content. Select OK to make Building Block available.
6.
The SCORM Content Type, IMS Content Type and NLN Content Type can be managed
like other Content Types from the Manage Tools link on the Administrator Panel.
2007 Blackboard Inc. Proprietary and Confidential.
Page 262
Blackboard K–12 Academic Suite
Administrator Manual
System-wide Announcements and Events
Overview
This section reviews the Announcements and Calendar features available to Administrators.
Administrators use these tools to communicate with all users on the system.
In this section
System-wide Announcements and Events contains the following topics.
©
T op i c
Descript ion
Announcements
This topic covers the Announcements page. Administrators can view
Announcements from this page as well as add Announcements or
make changes to an existing Announcement.
Add/Modify
Announcements
This topic covers the Add and Modify Announcements pages.
Announcements can be posted for all users or existing
Announcements modified from these pages.
Institution Calendar
This topic covers the Institution Calendar page. Administrators can
view Calendar Events from this page as well as add Calendar Events
or make changes to an existing Calendar Event.
Add/Modify
Calendar Event
This topic covers the Add and Modify Calendar Event pages. Calendar
Events can be posted for all users or existing Calendar Events
modified from these pages.
Calendar Quick
Jump
This topic covers the Calendar Quick Jump page. This page is used to
navigate to a specific date and time in the Calendar.
2007 Blackboard Inc. Proprietary and Confidential.
Page 263
Blackboard K–12 Academic Suite
Administrator Manual
Announcements
Overview
Administrators add, modify, and delete important messages from the Institution on the
Announcements page. Messages posted from the Announcements function on the Administrator
Panel will appear in:
•
The Announcements section of every Class and Organization
•
The My Announcements portal module
•
The Announcements tool in the portal Tool Panel
Find this page
Click Announcements on the Administrator Panel.
Functions
To use the functions available on the Announcements page, follow the table below.
©
To . . .
click . . .
add an
announcement
Add Announcement.
modify an
announcement
Modify next to an announcement.
remove an
announcement
Remove next to a specific announcement. A confirmation window will
appear. This action is irreversible.
2007 Blackboard Inc. Proprietary and Confidential.
Page 264
Blackboard K–12 Academic Suite
Administrator Manual
Add or Modify an Announcement
Overview
The pages for adding and modifying an Announcement contain the same fields and functions.
The page for adding an Announcement opens with empty fields while the page for modifying an
Announcement opens with the fields populated with information on a specific Announcement.
Find this page
Follow these steps to open the Add Announcement or Modify Announcement page.
1.
Click Announcements on the Administrator Panel.
2.
Click Add Announcement or Modify next to an announcement on the Announcement
page.
Fields
The table below details the fields on the Add Announcement or Modify Announcement page.
F i e ld
D is p la y
Announcement Information
Subject [r]
Enter a subject for the message.
Message
Enter the body of the announcement.
Options
Permanent
Announcement
Select Yes to create a permanent Announcement. This Announcement
is automatically displayed after the time and date it is created. There is
no end date for this Announcement unless the Display Until option is
selected.
Choose date
restrictions
Select Display After to make the Announcement available on a certain
date. Click the drop-down arrow and select time values.
Select Display Until to stop displaying the Announcement after a
certain time. Click the drop-down arrow and select time values.
Announcement Display
The following is the order in which Announcements are displayed in the My Announcements
module on the My Institution tab
©
•
Permanent System Announcements are displayed first.
•
System Announcements that fall into the display range appear next. For example, an
Announcement created in the last week is displayed on the View Last 7 Days tab.
•
Permanent Class and Organization Announcements display next.
•
Class and Organization Announcements that fall into the display range are listed last.
•
Within each of the above categories, Announcements are displayed in order of creation.
2007 Blackboard Inc. Proprietary and Confidential.
Page 265
Blackboard K–12 Academic Suite
Administrator Manual
Institution Calendar
Overview
Administrators manage Institution events through the Institution Calendar. Upcoming and past
events can be viewed daily, weekly, or monthly. An event posted to the Institution Calendar will
display in all Calendars system-wide.
Find this page
Click Institution Calendar on the Administrator Panel.
Functions
To use the functions available on the Institution Calendar page, follow the table below.
©
To . . .
click . . .
create an event and
add it to the calendar
Add Event.
view events for a
specific date and time
Quick Jump to access the Quick Jump page. From here, select a
date and time and the calendar will immediately display events for
that time.
view events by day,
week, or month
the appropriate tab to view events for the current day, current week,
current month, or current year.
view previous or
future events
the arrows to the left of the current day, week, month, or year. Click
on the arrows to the right to view future events.
view event details
a calendar event.
modify an event
Modify. The Modify Event page will appear.
remove an event
Remove for an event to remove it from the calendar. This action is
irreversible.
2007 Blackboard Inc. Proprietary and Confidential.
Page 266
Blackboard K–12 Academic Suite
Administrator Manual
Add/Modify Calendar Event
Overview
The Add or Modify Calendar Event pages contain the same fields and functions almost the same
way. The Add Calendar Event page opens with empty fields while the Modify Calendar Event
page opens with the fields populated with information on a specific event.
Find this page
Follow these steps to open the Add Calendar Event or Modify Calendar Event page.
1.
Click Institution Calendar on the Administrator Panel.
2.
Click Add Event or Modify next to an event on the Institution Calendar page.
Fields
The table below details the fields on the Add Calendar Event page and Modify Calendar Event
page.
F i e ld
Descript ion
Event Information
Event Title
Enter the title of the event.
Description
Enter a description of the event.
Event Time
©
Event Date
Select the date of the event from the drop-down lists or click the icon to
select a date from the calendar interface.
Event Start
Time
Select the time the event will begin from the drop-down lists.
Event End
Time
Select the time the event will end from the drop-down lists.
2007 Blackboard Inc. Proprietary and Confidential.
Page 267
Blackboard K–12 Academic Suite
Administrator Manual
Calendar Quick Jump
Overview
The Calendar Quick Jump page allows Administrators to quickly access a portion of the
Calendar. Quick Jump is useful when looking for events planned for months in advance of the
current date.
Find this page
Follow these steps to open the Calendar Quick Jump page.
1.
Click Institution Calendar on the Administrator Panel.
2.
Click Quick Jump on the Institution Calendar page.
Fields
The table below details the fields on the Calendar Quick Jump page.
F i e ld
Descript ion
Calendar Quick Jump
©
Date
Select the date to jump to from the drop-down lists or click the icon to select a
date from the calendar interface.
Type of
view
Select to view Calendar Events for the month, week, or day for the date chosen
in the Date field.
2007 Blackboard Inc. Proprietary and Confidential.
Page 268
Blackboard K–12 Academic Suite
Administrator Manual
Email
Overview
The Blackboard K-12 Suite includes an email function for Administrators to quickly email sets of
users.
In this section
Email includes the following topics.
©
T op i c
Descript ion
Send
Email
This topic covers the Send Email page. This is a menu page with links to pages
where Administrators can compose messages to sets of users.
Email
Users
This topic covers the Email Users pages. Administrators can compose messages
to different sets of users from these pages.
2007 Blackboard Inc. Proprietary and Confidential.
Page 269
Blackboard K–12 Academic Suite
Administrator Manual
Send Email
Overview
Administrators send email to users through the Send Email page. From this page, an
Administrator can send an email to all Teachers, all Students, or all users.
Find this page
Click Send Email on the Administrator Panel.
Functions
Click a link on this page to compose and send an email to the appropriate set of users.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 270
Blackboard K–12 Academic Suite
Administrator Manual
Email Users
Overview
The Administrator selects email recipients by clicking on a link to all Teachers, all Students, or all
users. Once the recipients are determined, all messages are created using the Compose Email
pages.
Find this page
Follow these steps to open the Send Email page.
1.
Click Send Email on the Administrator Panel.
2.
Click All Teachers, All Students, or All Users from the Send E-mail page.
Fields
The table below details the fields available on the Compose Email pages.
F i e ld
Descript ion
Enter Message Details
©
To
Displays the group of users to receive the message.
From
Displays the address of the sender.
Subject
Enter a subject for the email message.
Message
Enter the text of the message.
2007 Blackboard Inc. Proprietary and Confidential.
Page 271
Blackboard K–12 Academic Suite
Administrator Manual
Messages
Overview
The Messages feature gives each Class a private and secure system for communication that
functions similar to email. Keep in mind that Messages cannot be sent or received outside of the
users in the Class.
Messages are usually accessed through the Communications area of a Class. Although, as with
most features, the Teacher can restrict access or change the layout of the Class Menu so that
Messages are accessible directly.
In this section
Messages includes the following topics.
©
T op i c
Descript ion
Enable and Disable File
Attachments and Private
Folders
This topic covers the Messages Tool Options page.
Administrators set the availability of file attachments and
personal folders from this page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 272
Blackboard K–12 Academic Suite
Administrator Manual
Enable or Disable File Attachments and Private Folders
Overview
Administrators can choose to allow or not allow users to include file attachments with messages
and to allow or not allow users to create personal folders. Disabling these functions may help
save disk space and prevent Users from using Messages to store content. By default, Users may
not add file attachments to messages and users may not create personal folders.
Find this page
Follow these steps to access the Messaging Tool Options page.
1.
Open the Administrator Panel.
2.
Click Messages under the Tools section.
3.
Click Messaging Tool Options.
Fields
F i e ld
Descript ion
Messaging Tool Options
©
Allow File
Attachments
Select the check box to allow users to attach files to messages.
Allow Personal
Folders
Select the check box to allow users to create personal folders for
storing messages.
2007 Blackboard Inc. Proprietary and Confidential.
Page 273
Blackboard K–12 Academic Suite
Administrator Manual
Text Box Editor and Spell Check
Overview
The Blackboard K-12 Suite includes a Text Box Editor with advanced functions that enables
users to create professional content. Tools within the Text Box Editor include WebEQ, MathML,
and Spell Check. In addition to the standard Spell Check Dictionary, Administrators may upload
and manage supplemental word lists for each Virtual Installation.
In this section
Text Box Editor and Spell Check includes the following topics.
©
T op i c
Descript ion
Manage Text
Box Editor
This topic covers the Text Box Editor. This page allows Administrators to
manage the Text Box Editor and Text Box Editor Tools.
About Spell
Check
This topic explains the details of the Spell Check feature.
Manage Spell
Check
This topic covers the options available within Spell Check.
Download
Wordlist
This topic covers downloading a word list for Spell Check to the system.
Upload Wordlist
This topic covers uploading a word list for Spell Check to the system.
2007 Blackboard Inc. Proprietary and Confidential.
Page 274
Blackboard K–12 Academic Suite
Administrator Manual
Manage Text Box Editor
Overview
The Text Box Editor allows users to create professional, vibrant content wherever users can
create blocks of text. Text is entered through a simple editor in the Blackboard K-12 Suite that
nonetheless contains several powerful options including :
•
Text Box Editor - Allows users to create content with a simple editor that resembles a
word processor. Advanced file upload tools are also available.
•
Smart Text - Automatically recognizes a link entered in the text box. Smart text
recognizes the ENTER key as a paragraph tag and accepts HTML tags as well. Smart
Text will also prompt to load images if an image source text is used when adding smart
text as part of a content item. This option is only available if the WYSIWYG features in
the Text Box Editor are not enabled.
•
Plain Text – This option displays text as it is written in the text area. This option is only
available if the WYSIWYG features in the Text Box Editor are not enabled.
•
HTML – This option displays text as coded by the user using HTML tags.
•
JavaScript -- JavaScript can be entered into the Visual Text Box Editor.
•
Spellcheck – This Spell Check feature is available in most areas where users may enter
blocks of text. It includes a full English dictionary, a supplemental word list configured by
the Administrator, and custom word lists that are stored as a cookie on a user’s local
machine.
•
WebEQ Equation Editor - The Math and Science Notation Tool (WebEQ™ Equation
Editor) is a general purpose equation editor designed for working with equations. It
enables users to use mathematical and scientific notation throughout the Blackboard K12 Suite.
•
MathMLEquation Editor - The MathML Equation Editor functions in the same way as
the WebEQ Equation Editor. Instead of opening with the symbol buttons, a blank text
box will appear where users can enter XML.
Administrators manage the availability of Text Box Editor features through the Manage Text Box
Editor page.
Note: The Text Box Editor run in lite mode on the Safari 2.0 Web Browser. Lite
mode runs without displaying access to those features that are not supported on
the Safari browser. Macintosh users that wish to use the full version of the Text
Box Editor may use the Firefox Web browser. More information on lite mode is
included in the User Manual and the Teacher Manual to help users decide which
browser to use.
Find this page
Click Text Box Editor on the Administrator Panel.
Fields
The table below details the fields on the Manage Text Box Editor page.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 275
Blackboard K–12 Academic Suite
F i e ld
Administrator Manual
Descript ion
Enable/Disable Text Box Editor
Set the availability of the Text Box Editor for users by selecting the option Visual Text Box
Editor Available. If the Text Box Editor is disabled, Users will have limited features for adding
content to the Text Box. Options for Plain Text, HTML, and Smart Text will be available.
Select Require Users to opt-in and users must individually turn on the Visual Text Box Editor
to use it. This option is useful if some users are using older Web browsers that do not support
the Visual Text Box Editor. The Visual Text Box Editor will only display to those users that turn
it on under Personal Settings.
Enable/Disable Text Box Editor Tools
©
Enable Spell Check
Set the availability of Spell Check for users by selecting Enable or
Disable.
Enable WebEQ
Set the availability of WebEQ for users by selecting Enable or
Disable.
Enable MathML
Set the availability of MathML for users by selecting Enable or
Disable.
2007 Blackboard Inc. Proprietary and Confidential.
Page 276
Blackboard K–12 Academic Suite
Administrator Manual
About Spell Check
Overview
The Blackboard K-12 Suite includes a robust Spell Check feature supported by a full English
dictionary, a supplemental word list for each Virtual Installation, and custom word lists that are
stored as a cookie on a user’s local machine. The spell check feature is available wherever users
can enter blocks of text. It is also available as a module with the Blackboard Community System.
Word lists
Misspelled words are determined by the following three sources
•
Spell Check Dictionary: A full English dictionary of words that will not be flagged for
correction. The dictionary is also the only source for suggestions when a misspelled
word is found. This dictionary cannot be modified.
•
Virtual Installation Supplemental Word List: A list of additional terms added by the
System Administrator that do not appear in the default dictionary. For example, a
medical school might wish to upload a list of medical terms so they are not flagged as
incorrect terms for their users. This word list can be modified from the Administrator
Panel.
•
Personal Word List: This word list is stored as a cookie on each user’s local
machine. Words are added to this list using the Learn feature within Spell Check. Like
the supplemental word list, the words on each personal word list are not flagged for
correction and are not included as a suggestion for errors.
Note: Extensive supplemental and personal word lists may slow performance of
the Spell Check tool.
Personal word list and cookies
The personal word list is stored as a cookie on the user’s local machine. The cookie is not user or
Virtual Installation specific. Therefore, a user’s word list will be available to them whenever they
are using Spell Check with the Blackboard K-12 Suite, as long as they are on the same local
machine. Also, if another user logs onto the same machine, that user will have the same personal
word list stored on that machine applied when running spell check. Since word lists are cookiebased, users are unable to transport them. Word lists cannot be disabled on a computer.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 277
Blackboard K–12 Academic Suite
Administrator Manual
Manage Spell Check
Overview
The Blackboard K-12 Suite includes a spell check feature available to users in most areas where
blocks of text can be entered. The list of words that are not flagged for correction can be
expanded with a supplemental word list for each Virtual Installation. From the Spell Check page,
the supplemental word list for the Virtual Installation may be uploaded, modified, and then
downloaded to change the list of words.
Access to this feature is initially granted to users with the following Sys Admin roles
•
System Administrator
•
System Support
•
Class Admin
Find this page
Click Spell Check on the Administrator Panel.
Functions
The table below details the available functions on the Spell Check page.
©
To . . .
click . . .
upload a modified
supplemental word list
for use in the Virtual
Installation
Upload Word List. The Upload Word List page will appear. From
this page a new or modified supplemental word list can be
uploaded to replace the word list currently in use. Note that, by
default, there is no supplemental word list. A word list must be
created and uploaded to begin.
download the
supplemental word list
for modification
Download Word List. The Download Word List page will appear.
From this page the supplemental word list can be downloaded.
The supplemental word list will still be in use until a new version is
uploaded to replace it. This option only appears on the page if a
word list has been uploaded.
2007 Blackboard Inc. Proprietary and Confidential.
Page 278
Blackboard K–12 Academic Suite
Administrator Manual
Download Word List
Overview
The Download Word List page displays a link that, when clicked, will begin downloading the
supplemental word list to the local machine. The supplemental word list includes additional words
that should not be flagged for correction when using the Spell Check feature in the current Virtual
Installation. A word list must be created and uploaded before the option to download the word list
appears.
Note: No matter what the name of the supplemental word list file is when it is
uploaded it will always be changed to dictionaryLocal.txt and stored in a folder for
that Virtual Installation. Therefore, the downloaded supplemental word list file will
always be dictionaryLocal.txt.
Find this page
Follow these steps to open the Download Word List page.
1.
Click Spell Check on the Administrator Panel.
2.
Click Download Word List.
Modify the supplemental word list
After the supplemental word list has been downloaded, simply open it then add and replace
words to modify the list. The list appears in a standard text file with each word separated by a
hard return.
Keep in mind that the supplemental word list is a list of words that will not be flagged for
correction by the spell checker. In addition to the supplemental word list, spell check also checks
words against a robust English dictionary, and words that individual users have added to their
personal word lists. Personal word lists are only available on a users’ local machine.
Note: Only words that appear in the Spell Check dictionary will be listed as
suggestions when a possible error is encountered. Words in the supplemental
word list will not be offered as suggestions.
For information on uploading a modified supplemental word list please see the Upload Word List
topic.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 279
Blackboard K–12 Academic Suite
Administrator Manual
Upload Word List
Overview
The Upload Word List page adds a new word list or replaces the supplemental word list currently
used by the system with a new list. Each Virtual Installation may have a separate Word List. For
information on downloading and modifying the supplemental word list, please see the Download
Word List topic.
Note: The name of the supplemental word list will be changed to
dictionaryLocal.txt when uploaded.
Find this page
Follow these steps to open the Upload Word List page.
1.
Click Spell Check on the Administrator Panel.
2.
Click Upload Word List.
Upload a word list
Enter the full path to a new supplemental word list or click Browse to search the file system for
the new supplemental word list. A supplemental word list must be a .txt file with each word
separated by a hard return.
Note: Word lists may not be removed from the system. To ‘remove’ a word list,
an Administrator must upload an empty word list to overwrite the supplemental
word list on the system. The empty file must contain a space to be uploaded
properly.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 280
Blackboard K–12 Academic Suite
Administrator Manual
System Discussion Boards
Overview
This section explains how to use Discussion Boards on the Community tab.
In this section
This section includes the following topics.
©
T op i c
Descript ion
About System Discussion
Boards
This topic covers general information about Discussion
Boards.
Manage Forum Users
This topic explains how to manage Topic users.
2007 Blackboard Inc. Proprietary and Confidential.
Page 281
Blackboard K–12 Academic Suite
Administrator Manual
About System Discussion Boards
About System Discussion Boards
Institution wide Discussion Boards, called System Discussion Boards, may be created in the
Blackboard K-12 Suite. These Discussion Boards are not Classer Organization specific, but are
used for general campus events and information. System Discussion Boards may also be
accessed by all users at the Institution.
System Discussion Boards appear by default on the Community tab, but the System Discussion
Board module may be added to any tab.
Unlike a Class, which has one overall Discussion Board, Administrators may create multiple
System Discussion Boards. Each Discussion Board may include multiple Topics. For example,
one Discussion Board may be created for Transportation, which includes Topics on Public
Transportation and Ride Sharing. Another Discussion Board may be created for Roommate
Searches, with Topics devoted to on or off-campus housing.
Manage System Discussion Boards
System Discussion Boards may be added, removed and managed through Discussion Boards on
the Administrator Panel. Detailed steps for Discussion Board operations may be found in the
Blackboard K-12 Suite Teacher Manual.
Information on managing users in System Discussion Boards is located in the Manage Topic
Users topic.
The availability of the Discussion Board is managed on the Manage Tools page.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 282
Blackboard K–12 Academic Suite
Administrator Manual
Manage Topic Users
About Topic Users
Each Topic in a System Discussion Board may be made available to some or all users at an
Institution. The Administrator controls user access through the Manage Topic Users page. This
page lists only those users who are not participants in the Topic - such as users with the roles of
Manager, Moderator, Reader or Blocked. This is different from a Class Discussion Board, which
lists all users in the class, regardless of Topic Role status.
Detailed instructions on Topic Roles are located in the Blackboard K-12 Suite Teacher Manual.
Change a Participant's role
Follow the steps below to give a participant a non-participant role (for example, that of Moderator,
Manager, or Reader):
1.
Select Add in the Action Bar on the Manage Topic Users page. The Add User page
appears.
2.
Click Browse to select the user.
3.
Select the role for this user and select Submit.
4.
The user will not appear on the Manage Topic User page
Change a non-Participant's role
Follow the steps below to give a user a participant role. Please note that Participants do not
appear on the Manage Topic User page:
©
1.
Select the checkbox next to the user or users whose role you are changing.
2.
Select the Change to Participant option in the Action Bar.
3.
These users are removed from the Manage Topic Users page. (Only users with nonParticipant roles appear on the Manage Topic Users page for System Discussion
Boards.)
2007 Blackboard Inc. Proprietary and Confidential.
Page 283
Blackboard K–12 Academic Suite
Administrator Manual
Tools
Overview
This section details the features on the Administrator Panel that allow Administrators to manage
tools.
In this chapter
This section includes the following topics.
©
T op i c
Descript ion
About Tools
This topic describes Tool Linking.
Manage Tools
This topic covers the Manage Tools page. Administrators set the
availability of tools on this page.
Performance
Dashboard
This topic explains how to enable the Performance Dashboard.
Review Status
This topic explains how to enable Review Status.
Adaptive Release
This topic explains how to enable Adaptive Release of content.
2007 Blackboard Inc. Proprietary and Confidential.
Page 284
Blackboard K–12 Academic Suite
Administrator Manual
About Tools
Overview
The Manage Tools page lists all tools. This page handles availability of tools to authenticated
users, Guests, and Parents. To set a tool as a default in all Classes or to display a tab to certain
Institution Roles, continue to use the same processes as before.
Tool Linking in Classes
Tools can go anywhere in a Class that content can. Tools such as Discussion Board Topics and
Virtual Classroom sessions can exist in the same folder as content such as slideshows, files, and
Assessments. Adding tools to folders creates a seamless experience for users because all
materials related to a certain subject matter can be accessed from the same location.
Links can be created to the following tools
•
Groups
•
Discussion Board Topics
•
Chat sessions
•
Virtual Classroom sessions
Note: Tool linking is turned on in the system by the Administrator through the
Manage Tools page.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 285
Blackboard K–12 Academic Suite
Administrator Manual
Manage Tools
Overview
The Manage Tools page lists each tool in the system. Each row shows the availability of the tool
to authenticated users, Guests, and Observers.
•
Checkmark: The tool is available to the user type.
•
Circle with a slash: The tool can never be available to the user type.
•
Empty: If there is no mark in a column for a tool, that tool is not available to the user
type. Click Modify for a tool to make it available.
Also listed for each tool is the type of tool
•
Content Type: Items that can be displayed in a Class (or Organization).
•
Class Tool: A tool that may be used in a Class.
•
Organization Tool: A tool that may be used in an Organization. Organization Tools are
only available when the Blackboard Community System is licensed.
•
System Tool: System-wide tools such as tabs.
Note: Use the Manage Tabs page to control access to tabs based on Institution
Role. This feature is only available with the Blackboard Community System
Find this page
Click Manage Tools from the Administrator Panel to open the Manage Tools page.
Modify Tool
Click Modify for a tool to open the Modify Tool page. Select Yes or No to make the tool available
to each different type of user: authenticated users, Guests, and Parents. If the option does not
exist to set availability for a type of user, that type of user cannot access the tool.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 286
Blackboard K–12 Academic Suite
Administrator Manual
Adaptive Release
About Adaptive Release
Adaptive Release of Content provides controls to release content to users based on a set of rules
provided by the Teacher. The rules may be related to availability, date and time, individual users
and user groups (such as Class Groups), scores or attempts on any Grade Center item, or review
status of another item in the Class.
If the Adaptive Release is enabled by the System Administrator, it is available in all Classes.
Enable Adaptive Release
When Adaptive Release is enabled, it is available to Teachers to use within their Classes. Follow
the steps below to enable Adaptive Release:
1.
Select Manage Tools under Admin Tools in the Administrator Panel.
2.
Locate the Adaptive Release Class Tool using the navigation options at the bottom of the
page.
3.
Select Modify next to Adaptive Release Class Tool. The Modify Tool Availability page
appears.
4.
Set Tool Availability to Yes and click Submit.
Disable Review Status
If Adaptive Release is disabled, all data is saved. Content will be available based on availability
and date; Adaptive Release Rules will be ignores. If Adaptive Release is made available again,
all rules associated with items will appear and be unchanged.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 287
Blackboard K–12 Academic Suite
Administrator Manual
Performance Dashboard
About the Performance Dashboard
The Performance Dashboard tool provides Teachers with a window into all types of user activity
in a Class or Organization. All users enrolled in the Class are listed, with pertinent information
about that user’s progress and activity in the Class.
Enable the Performance Dashboard
If the Performance Dashboard is enabled by the System Administrator, it is on by default in all
Classes. Follow the steps below to enable the Performance Dashboard:
©
1.
Select Manage Tools under Admin Tools in the Administrator Panel.
2.
Locate the Performance Dashboard Class Tool using the navigation options at the
bottom of the page.
3.
Select Modify next to Performance Dashboard. The Modify Tool Availability page
appears.
4.
Set Tool Availability to Yes and click Submit.
2007 Blackboard Inc. Proprietary and Confidential.
Page 288
Blackboard K–12 Academic Suite
Administrator Manual
Review Status
About Review Status
The Review Status tool allows the Teacher to track user review of specific content items. Once
the Teacher enables the tool for an item, each Student tracks their progress. A Needs Review
button appears on the item when the user opens it. After reviewing the item, the Student selects
this button to mark it Reviewed.
If the Review Status tool is enabled by the System Administrator, it is on by default in all Classes.
Enable Review Status
When Review Status is enabled, it is available to Teachers to use within their Classes. Follow the
steps below to enable Review Status:
1.
Select Manage Tools under Admin Tools in the Administrator Panel.
2.
Locate the Review Status Class Tool using the navigation options at the bottom of the
page.
3.
Select Modify next to Review Status Class Tool. The Modify Tool Availability page
appears.
4. Set Tool Availability to Yes and click Submit.
If Review Status is disabled, all data is saved. If the tool is made available again, all user entries
will appear and be unchanged.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 289
Blackboard K–12 Academic Suite
Administrator Manual
Chalk Titles
Overview
This section explains Chalk Titles and how the Administrator manages them.
In this section
This section includes the following topics.
©
T op i c
Descript ion
About Chalk
Titles
This topic describes Chalk Titles and how to troubleshoot them.
Manage Chalk
Titles
This topic covers the Manage Chalk Titles page. It explains the functions
available with Chalk Titles.
2007 Blackboard Inc. Proprietary and Confidential.
Page 290
Blackboard K–12 Academic Suite
Administrator Manual
About Chalk Titles
About Chalk Titles
Chalk Titles are Course Cartridges that are integrated with external applications and content from
publishers. Chalk Titles include both content and tools. The ability to support Chalk Titles is new
with Application Pack 2. Tools included in a Chalk Title connect to an outside source to run each
tool.
Chalk Titles are installed in the same way as other Course Cartridges. Like other Course
Cartridges, Chalk Titles require a download key and Student access keys.
Important features in Chalk Titles include
•
Integration with the Class: Chalk Titles link Classes to applications running on the
publisher's servers. These applications are often popular tools that are familiar to
Teachers. Please contact the publisher for more information about the applications
included with a Chalk Title.
•
Single Sign-on: Users that are logged into the Class are logged into the publisher
applications linked to the Class. Users pass between the Class and the publisher
application seamlessly.
•
Roster synchronization: Users enrolled in the Class are automatically enrolled in the
publisher application.
•
Grade passing: Grades from the publisher application are passed to the Class.
Chalk Title tools appear in the Tools area of the Control Panel after a Chalk Title is added to a
Class. Teachers can restrict availability to Chalk Title tools in the same way that they can restrict
availability to other tools.
The System Administrator may restrict the availability of Chalk Title tools in all Classes. By
default, Teachers can use Chalk Title tools in Classes.
Chalk Title Tools can synch with the Grade Center in a Class to report Student performance.
Note that Student attempts are stored on the server that runs the tool, not within the Class.
Therefore, Student attempts are not included when the Class is archived. The reported Grade is
the only recorded information about a Student attempt.
Chalk Title tools will not work if a Class that contains Chalk Title tools is exported or archived and
later added to a system that does not support Chalk Titles.
Troubleshooting
Use the logs available from the Manage Chalk Titles page to troubleshoot installation problems.
Problems accessing a Chalk Title took may be a problem with the publisher's server or a problem
with an access key. If it appears that a problem is related to a Chalk Title tool, please contact the
publisher for assistance.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 291
Blackboard K–12 Academic Suite
Administrator Manual
Manage Chalk Titles
Overview
The Manage Chalk Titles page lists the following information about each Chalk Title in a table
•
Chalk Title: The name of the Cartridge.
•
Version: The version of the Cartridge. The version is determined by the publisher.
•
Vendor: The publisher.
•
Status: State of the Chalk Title in the system Installed, importing, incomplete, or error.
The page also includes options for managing each Chalk Title.
Find this page
Click Manage Chalk Titles from the Administrator Panel to open the Manage Chalk Titles page.
Functions
The following functions appear on the Manage Chalk Title page.
©
To . . .
click . . .
View more details
about a Chalk Title
Properties. The Examine Chalk Title page will appear. This page
lists all the Classes that are using the Chalk Title. This page also lists
the tools from the Chalk Title that are in use.
View the log of a
failed Chalk Title
installation
View Log. This link only appears when a Chalk Title fails to install.
The log may provide details that will help identify the problem.
Retry Chalk Title
installation
Retry. The Chalk Title will attempt to install again.
2007 Blackboard Inc. Proprietary and Confidential.
Page 292
Blackboard K–12 Academic Suite
Administrator Manual
Language Packs
Overview
This section explains Language Packs and how the Administrator manages them.
In this section
This section includes the following topics.
©
T op i c
Descript ion
About Language Packs
This topic describes Language Packs and gives an overview
of how they are managed.
Language Pack Availability
This topic explains how to set the availability of language
packs on the system.
Import Language Pack
This topic explains how to import a language pack.
Export Language Pack
This topic explains how to export a language pack from the
system to a local directory.
Copy Language Pack
This topic explains how make a copy of a language pack.
Remove Language Pack
This topic explains how to remove a language pack from the
system.
Language Pack Editor
This topic explains the features available in the Language
Pack Editor.
Modify Language Pack
This topic explains how to use the Language Pack Editor to
modify a text bundle.
Set Class Language Packs
This topic explains how to set a language pack for a Class.
Language Packs and the
Gateway page
This topic explains users may select a language pack from the
Gateway page.
Enable JIS Encoding for
Email
This topic explains how to set the email encoding to JIS, a
widely used standard in Japan.
Right-To-Left Language
Packs
This topic explains how the Blackboard K-12 Suite functions
with Right-To-Left language packs.
2007 Blackboard Inc. Proprietary and Confidential.
Page 293
Blackboard K–12 Academic Suite
Administrator Manual
About Language Packs
About Language Packs
Language Packs present the Blackboard K-12 Suite using language and cultural norms matched
to various international audiences. Language Packs are selected at the system level, the Class or
Organization level, and finally at the user level.
At the system level, the Administrator defines one Language Pack as the system default. This is
the Language Pack that appears when no other language preferences are specified at the Class
level or at the user level. The Administrator controls which Language Packs are available for
users and which Language Packs are available for Teachers to use in their Classes. Keep in
mind that the Blackboard Learning System - Basic Edition is limited to the United States English
and one other Language Pack.
At the Class level, the Teacher can set a Language Pack and enforce it. Enforcing a Language
Pack means that all users will see that Language Pack. If the Language Pack is not enforced,
and a user has a preferred Language Pack associated with their account, the user’s Language
Pack will override the Class Language Pack.
At the user level, individuals may select their preferred Language Pack.
Note: Customized names, such as changing the name of a Tab, Tool, Role, or
Content Area, are not changed with the Language Pack. These values stay the
same through all Language Packs.
Managing Language Packs
Administrators have options to copy, remove, import, and export Language Packs from the
Manage Language Packs page. The Language Pack Editor must be made available on the
Manage Tools page for copy, export, and modify options to be enabled.
Multiple Language Packs may also be stored on the system, with one or more made available to
users at any given time. United States English (en_US) is always available. The availability of
Language Packs for the system, Classes, and users is also set from this page. This page is
accessed from the Administrator Panel.
Note: The options to Modify, Copy, and Export Language Packs are not
available to Blackboard Learning System - Basic Edition clients.
Tip: It is very important that users read the section Creating a Language Pack
before performing copy and import operations. This chapter explains, in detail,
how a Language Pack may be created.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 294
Blackboard K–12 Academic Suite
Administrator Manual
Language Pack Availability
About Language Pack Availability
Language packs can be made available on the system, Class, and user level. For example, the
system language may be English, but a French teacher may decide to display their Class in
French to users. The Administrator can set the availability of each Language Pack for each of
these levels.
The current settings for each Language Pack are displayed on the Manage Language Pack page.
The Administrator can easily view the availability of each Language Pack on the system, Class,
and user level.
Note: When using the Blackboard Learning System - Basic Edition only
American English and one other Language Pack may installed at any given time.
Set the Availability of a Language Pack
Follow these steps to allow or prevent users to apply a Language Pack as well as set a Language
Pack as the system default.
©
1.
Click Manage Language Packs under Administrator Tools on the Administrator Panel.
2.
Click Manage for a Language Pack to change its settings.
3.
Select Yes or No for Available. This controls whether or not the Language Pack is
available in the system. If No is selected, the other options on this page become inactive.
4.
Select Yes or No for Available as a Class Language Pack. If Yes is selected, Teachers
may use the Language Pack in a Class.
5.
Select Yes or No for Available as an Organization Language Pack. If Yes is selected,
Organization Leaders may use the Language Pack in an Organization.
6.
Select Yes or No for Available as a User Language Pack. If Yes is selected, Users can
select the Language Pack as their preferred Language Pack when logging in by changing
their Personal Information settings.
7.
Select Default to make this Language Pack the system default. Only one language can
be selected as the system default. United States English will always be available for
users to select.
2007 Blackboard Inc. Proprietary and Confidential.
Page 295
Blackboard K–12 Academic Suite
Administrator Manual
Import a Language Pack
About importing a Language Pack
Administrators may import Language Packs into the system from their local machine. These
Language Packs may have come from the Language Packs Catalog, be shared directly with the
Administrator, or have been a Language Pack created by the Institution.
After a Language Pack is imported, the Administrator must make it available before it may be
used on the system, in a Class, or by a user. See the Language Pack Availability topic for
additional information.
Import a Language Pack
Follow these steps to import a Language Pack
©
1.
Click Manage Language Packs under Administrator Tools on the Administrator Panel.
2.
Click Import in the Action Bar. The Import Language Pack page appears.
3.
Click Browse to search for a Language Pack on the local system or a shared directory.
4.
Administrators may use the Name and Code already assigned in the imported Language
Pack or create their own. Either select the Use imported name and code option or enter
a new Name and Code on the fields below. An identifier may be added to the Name
value; this should be added in parentheses. For example, if the Language Pack is for a
specific region the name may be Spanish (Region1).The Code value should conform to
the internet standard for country and language codes, using the language code, followed
by the country code. For example, then code for English is en_US. The internet
standards are known as ISO639 / RFC1766 (to identify the language) and ISO3166 to
identify the country. There is also an option to include a subtag, or identifier, after the
country code. This subtag must be alphanumeric and may include up to 15 characters. It
is used only to differentiate Language Packs beyond country and language, and will only
display to the Administrator and translator. For example, if two Spanish Language Packs
are created using different colloquial styles, the locale values may be es_ES_Region1
and es_ES_Region2.
5.
Read and accept the legal disclaimer; then click Submit.
2007 Blackboard Inc. Proprietary and Confidential.
Page 296
Blackboard K–12 Academic Suite
Administrator Manual
Export a Language Pack
About exporting a Language Pack
Administrators may export Language Packs from the Blackboard system to the local machine.
The Language Pack is packaged in a ZIP file that includes two top level items, the manifest file
and the code name directory.
Exported Language Packs may be added to the Language Packs Catalog or be used as a base
to create additional Language Packs. See the Create a Language Pack Chapter for additional
information on creating a new Language Pack from an exported Language Pack.
Export a Language Pack
Follow these steps to export a Language Pack
1.
Click Manage Language Packs under Administrator Tools on the Administrator Panel.
2.
Click Export next to the appropriate Language pack.
3.
Click Save in the pop-up window that appears, and save the ZIP file to the correct
location.
Note: After making modifications to the files, save the files
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 297
Blackboard K–12 Academic Suite
Administrator Manual
Copy a Language Pack
About copying a Language Pack
Language packs may be copied to produce an exact replica of an existing Language Pack. Once
a copy is created, the Administrator may use the Language Pack Editor to make changes to the
text bundles. Copy is a good option to choose if you would like to create a slightly different
version of an existing Language Pack, since the manifest is created automatically and the
Language Pack Editor can be used. For example, the copy operation would allow the
Administrator to modify some specific terminology within the Language Pack.
Note: A text bundle is a file that consists of a set of related text strings. For
example, an announcements.properties file includes text strings related to the
announcements feature.
Images and Help documentation cannot be modified within a copy of a Language Pack; the
Language Pack must be exported to modify images. See the Create a Language Pack Chapter
for additional information.
Copy a Language Pack
Follow these steps to copy a Language Pack
©
1.
Click Manage Language Packs under Administrator Tools on the Administrator Panel.
2.
Click Copy next to the appropriate Language pack.
3.
Enter a Name and Code for the Language Pack. The Name value should represent the
language used in the Language Pack. The Code value should conform to the internet
standard for country and language codes, using the language code, followed by the
country code. For example, then code for English is en_US. The internet standards are
known as ISO639 / RFC1766 (to identify the language) and ISO3166 to identify the
country. There is also an option to include a subtag, or identifier, after the country code.
This subtag must be alphanumeric and may include up to 15 characters. It is used only to
differentiate Language Packs beyond country and language, and will only display to the
Administrator and translator. For example, if two Spanish Language Packs are created
using different colloquial styles, the locale values may be es_ES_Region1 and
es_ES_Region2.
2007 Blackboard Inc. Proprietary and Confidential.
Page 298
Blackboard K–12 Academic Suite
Administrator Manual
Remove a Language Pack
About removing a Language Pack
The Administrator may remove imported or copied Language Packs from the system. Blackboard
supported Language Packs (those included in the application) may not be removed.
Language packs must be set to unavailable when they are removed; if a Language Pack is
available on the system, Class, or user level, it cannot be removed.
Remove a Language Pack
Follow these steps to remove a Language Pack
©
1.
Click Manage Language Packs under Administrator Tools on the Administrator Panel.
2.
Select the check boxes next to the appropriate Language packs.
3.
Click Remove in the Action Bar.
2007 Blackboard Inc. Proprietary and Confidential.
Page 299
Blackboard K–12 Academic Suite
Administrator Manual
Language Pack Editor
About the Language Pack Editor
The Language Pack Editor is a simple tool used for editing text bundles in a Language Pack.
Users may edit any Language Packs that have been imported or copied. Supported Blackboard
Language Packs may not be edited. However, they may be copied and / or used as the reference
language when creating a new Language Pack.
The Language Pack Editor allows users to view the text bundles against a reference language
and translate the copied Language Pack text string by text string. For example, if a user who
speaks French and Gaelic would like to create a Gaelic Language Pack, the user can choose
French, or any other language on the system, as the reference language when creating the
Gaelic Language Pack.
Note: It is very important that users read the Editing Properties Files topic in the
Create a Language Pack Chapter before creating or modifying a Language Pack.
Viewing the Language Pack Editor
When a text bundle is opened in the Language Pack Editor, two columns appear; the Reference
Language and the New Language. All of the code that appears in the text bundle is displayed in
the Reference Language on the left. The content of this column is not editable, and does not
change as the text bundle is translated. The editable part of the text string, also called the text
message, appears in New Language on the right. All changes to the text bundle are made in the
New Language column.
Users decide whether or not comments are displayed in the Reference Language. Comments are
notes within a text bundle that provide additional information about a text string or group of text
strings. They may provide some context for how the text string is used in the application, which
may be helpful to translators.
The language of the text in the New Language column corresponds to the Language Pack that is
being edited. The system default language is the automatic default for the Reference Language
column; however the user may change this at any time.
For example, an Administrator would like to create a new Language Pack that is similar to the
French Language Pack. The Administrator copies the French Language Pack, and then opens it
in the Language Pack Editor. The content in the Reference Language column automatically
appears in the system default language; the content in the New Language column appears in
French. The Administrator may change the Reference Language to French, or any other
language in the system, in the Action Bar at the top of the page.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 300
Blackboard K–12 Academic Suite
Administrator Manual
Modify Language Pack
About modifying a Language Pack
Only copied and imported Language Packs may be modified in the Language Pack Editor. The
Editor allows the user to select and edit one text bundle at a time. When a text bundle is opened
in the Language Pack Editor, the original text appears alongside the editable text. The original
text remains on the page as a reference once the text string is translated, so users may always
refer back to it. Supported Blackboard Language Packs may be copied; however, they may not
be edited.
Note: A text bundle is a file that consists of a set of related text strings. For
example, an announcements.properties file includes text strings related to the
announcements feature.
To ensure consistency across releases, the Blackboard K-12 Suite Updater will compare the
existing en_US language pack against the version that is being installed. The differences are
noted and output in a file called bundle_diff.txt. This file is added to the blackboard/backups//
directory. Use this file to review the text differences between releases and make updates to any
custom Language Packs.
Note: Only copied and imported Language Packs may be modified in the
Language Pack Editor. Therefore, the Modify button will only appear for copied
or imported Language Packs.
Modify a text bundle
Follow the steps below to modify a text bundle:
©
1.
Select Manage Language Packs on the Administrator Panel.
2.
Select Modify next to a Language Pack. The Modify Language Pack page appears. This
includes a list of all text bundles in the Language Pack that may be modified.
3.
Click Edit next to a file name; the Modify page for the specific text bundle opens.
4.
Use Toggle Comments in the Action Bar to choose whether or not to display comments
included in the text bundle. If turned on, these comments appear in the Reference
Language column and provide descriptive information about the text strings.
5.
Use the Reference Language drop-down list to select a different Reference Language.
The system default automatically appears, but translators may change this at any time.
6.
Translate the text that appears in the New Language column. This text appears in the
language of the Language Pack that was selected in Step 3. The text that appears in this
column is exactly what will appear in the modified Language Pack.
7.
Click Save. All content in the New Language column is saved. Any comments or keys
that do not appear in this area are removed. For example, if a translator had previously
exported the Language Pack, added comments to some of the files, and imported it,
2007 Blackboard Inc. Proprietary and Confidential.
Page 301
Blackboard K–12 Academic Suite
Administrator Manual
these additional comments are removed when the file is saved in the Language Pack
Editor.
Search a text bundle
If the user is making small modifications to an existing Language Pack, the search feature may
be helpful. This feature allows the user to select all of the text bundles for a specific word or
phrase. For example, to create a Language Pack that changes the term 'Class' to 'section', use
this feature to find all of the places where the term must be changed.
Follow the steps below to search a text bundle:
©
1.
Select Manage Language Packs on the Administrator Panel.
2.
Select Modify next to a Language Pack. The Modify Language Pack page appears.
3.
Enter the appropriate term in the Search file contents for field and click Enter.
4.
A list of all of the text bundles that include text strings where this word or phrase appears
is displayed.
5.
Select Edit next to a bundle to modify the file and change the appropriate term. See the
instructions above for modifying a text bundle.
2007 Blackboard Inc. Proprietary and Confidential.
Page 302
Blackboard K–12 Academic Suite
Administrator Manual
Set a Class Language Pack
Class Language Packs
It is possible for the Administrator to set a Language Pack for a Class through the Class
Properties. This allows users to view a Class in a language separate from their system
Language Pack.
Class Language Packs
Follow the steps below to set a Language Pack for a Class:
1.
Click Classes from the Administrator Panel.
2.
Search for a Class.
3.
Click Manage for a Class.
4.
Click Class Properties.
5.
Select a Language Pack from the drop-down list. Check Enforce Language Pack to
force all users in the Class to view the Class Language Pack.
6. Click Submit.
If a Language Pack is not chosen for a Class the Class will display in the user’s preferred
Language Pack or, if the user has not set a preferred Language Pack, in the system default
Language Pack.
Note: If a Class Language Pack is selected, the Control Panel appears mostly in
the Class Language Pack (there are a few areas that use the user Language
Pack or the system Language Pack). This means that when the Administrator
accesses the Properties for a Class, the page appears in the selected Class
Language Pack.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 303
Blackboard K–12 Academic Suite
Administrator Manual
Language Packs and the Gateway Page
About the Gateway Page and Language Packs
The Gateway page includes a welcome message as well as an interface for picking a Language
Pack (not to mention buttons for logging in and viewing the catalog).
Impact of Language Packs on the Gateway Page Welcome Message
The standard welcome message included with the Blackboard K-12 Suite will change to match
the user’s chosen Language Pack. The message will not change if it has been customized by
replacing the default message with an HTML snippet created by the Institution.
If Direct Access is used to bypass the Gateway page, unauthenticated users will see a Language
Pack module that is used to select a Language Pack. If the Administrator does not allow Users a
choice of Language Packs, this module will not appear.
Choose a Language Pack
Links to available Language Packs appear at the bottom of the Gateway page. If only one
Language Pack is made available to users, no options are displayed in this area.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 304
Blackboard K–12 Academic Suite
Administrator Manual
Enable JIS Encoding for Email (Japanese Language Pack)
Overview
The Japanese Language Pack uses UTF-8 encoding for email by default. Some devices,
particularly cell phones and other mobile communication tools, have difficulty displaying
Japanese characters encoded with UTF-8. In Japan, this problem is resolved with the use of the
widely accepted JIS character encoding.
The Blackboard K-12 Suite can be configured to send emails using JIS encoding by adding a
property to the bb-config.properties file. After this property is set, emails sent while the Japanese
Language Pack is active will use JIS encoding. Please remember that a Language Pack is active
if it is the user's preferred Language Pack, the enforced Language Pack in a Class, or the default
Language Pack when no other Language Pack is specified.
Enable JIS Encoding
Follow these steps to enable JIS encoding when using the Japanese Language Pack.
©
1.
Open the bb-config.properties file. This file can be found in the blackboard/config
directory.
2.
Add the following property:bbconfig.email.encoding.locale.ja_JP=iso-2022-jp
3.
Save the file and run the PushConfigUpdates command.
2007 Blackboard Inc. Proprietary and Confidential.
Page 305
Blackboard K–12 Academic Suite
Administrator Manual
Right-To-Left Language Packs
Overview
To accurately display languages that are oriented from right to left such as Arabic languages, the
Blackboard K-12 Suite can be configured to be used from right to left. Right-to-left orientation
affects the entire Blackboard K-12 Suite, including most all features and tools in the Blackboard
Learning System, the Community System and the Blackboard Content System. Exceptions are
listed below. Right-to-left language support includes all Teacher and Administrator functionality.
Right-to-left functionality is automatically applied when an existing right-to-left language pack is
applied to the Blackboard K-12 Suite.
Exceptions for right to left language support
Some sub-systems and functions within the Blackboard K-12 Suite are not part of right-to-left text
orientation. These include:
•
The Visual Text Box Editor will not spell check for right-to-left text.
•
Functional changes to Class Statistics cannot be made using right-to-left text orientation.
•
Right-to-left language support cannot be enabled in the Collaboration Tools, including
Virtual Classroom and Chat.
•
External services that feed information to or from the Blackboard K-12 Suite such as
RSS will not be engineered to appear from right to left.
•
Any data that is entered as mixed orientation, some text formatted from left to right and
some formatted from right to left in the same file.
•
Blackboard Backpack does not support right-to-left viewing.
Installing right to left languages on Windows XP Professional
Windows XP has built-in support for most languages, including Arabic. To configure the operating
system to type in the appropriate language, the language must be installed and the keyboard set
to type in that language. Both tasks are accomplished using the Windows Control Panel. See
Windows help for more detailed information.
Importing and exporting data in a right to left environment
Blackboard right to left support ensures that import and export functionality including Snapshot,
Batch, and CSV will preserve data integrity during these operations in the right to left local; for
example, the data is stored correctly to the database or exported in the correct order. How flat
files are formatted for these operations is dependent on the operating system of the Blackboard
server and the language pack of the Blackboard application. However, some file formatting rules
apply regardless of language or operating system, see below.
When files are created for batch loading, the following header fields must be in ASCII (American
Standard Code for Information Interchange) characters:
©
•
Any Boolean field (Y/N, T/F)
•
Any ID such as Course ID or Organization ID
2007 Blackboard Inc. Proprietary and Confidential.
Page 306
Blackboard K–12 Academic Suite
•
Administrator Manual
Username
•
Email address
Header fields may contain alphanumerical characters, underscores “_”, dots “.”, and dashes “-”.
Headers fields cannot contain the following special characters:
%, &, *, #, >, <, +, =
All data contained in these fields must also be in ASCII characters and the same rules for
acceptable characters apply.
Here are some examples of headers for batch files formatted right to left:
©
B a t ch F i le T yp e
Sa mple F ile H ea der
Batch Add
Classes
left to right
Course ID*,Course Name*,Course Description,Button Style/Color, Initial
Announcement, Announcement Title
Batch Add
Classes
right to left in
English
Announcement Title, Initial Announcement, Button Style/Color, Course
Description, Course Name*,Course ID*
Batch Add
Classes
right to left in
Arabic
Course ID* ، ‫ * ةيبيردتلا ةرودلا مسا‬، ‫ةيبيردتلا ةرودلا فصو‬، Button
Style/Color ، ‫يساسأ نالعإ‬، ‫نالعإلا ناونع‬
Batch Add
Organizations left
to right
Organization ID*,Organization Name*,Organization Description,Button
Style/Color, Initial Announcement,Announcement Title
Batch Add
Organizations
right to left in
English
Announcement Title,Initial Announcement,Button Style/Color,Course
Description, Organization Name*,Organization ID*
Batch Add
Organizations
right to left in
Arabic
Organization ID* ، ‫ * تامولعملا لدابت ةقلح مسا‬، ‫لدابت ةقلح فصو‬
‫ تامولعملا‬، Button Style/Color ، ‫يساسأ نالعإ‬، ‫نالعإلا ناونع‬
Batch Add Users
left to right
Username*,Last Name*,First Name*,Email, Password*,Student ID,
Middle Name, Job Title, Department, Company, Street 1,Street
2,City,State/Province,Zip/Postal Code, Country, Work Phone, Home
Phone, Work Fax, Mobile Phone,Website,Primary Institution Role,
System Availability
Batch Add Users
right to left in
English
,Province/State, City, Street 2, Street 1,Company,Department,Job
Title,Middle Name, Student ID, Password*, Email, First Name*, Last
Name*, Username*
System Availability,Primary Institution Role, Website, Mobile Phone,
Work Fax, Home Phone, Work Phone, Country, Zip/Postal Code
2007 Blackboard Inc. Proprietary and Confidential.
Page 307
Blackboard K–12 Academic Suite
©
Administrator Manual
B a t ch F i le T yp e
Sa mple F ile H ea der
Batch Add Users
right to left in
Arabic
Username* ، ‫ * ةلئاعلا مسا‬، , ‫لوألا مسالا‬Student ID,
Password*,Email, * , ‫طسوألا مسالا‬, ‫يفيظولا ىمسملا‬, ‫مسقلا‬, ‫ةكرشلا‬,
‫ عراشلا‬1 , ‫ عراشلا‬2, ‫ةنيدملا‬, ‫ ةظفاحملا‬/ ‫ميلقإلا‬, ‫يديربلا زمرلا‬, ‫دلبلا‬,
Work Phone ,Home Phone ,Work Fax ,Mobile
Phone ,Website ,Primary Institution Role ،System Availability
Batch Create and
Enroll Users left to
right
Username*,Last Name*,First Name*,Email, Password*,Course
Role*,Student ID, Middle Name, Job Title, Department, Company,
Street 1,Street 2,City,State/Province,Zip/Postal Code, Country, Work
Phone, Home Phone, Work Fax, Mobile Phone, Website, Course
Availability
Batch Create and
Enroll Users right
to left in English
City,Street 2,Street 1,Company,Department,Job Title ,Middle
Name,Student ID,Course Role*,Password*,Email,First Name*,Last
Name*,Username*
Course Availability,Website,Mobile Phone,Work Fax,Home Phone,Work
Phone,Country,Zip/Postal Code,Province,State
Batch Create and
Enroll Users right
to left in Arabic
Username* ، ‫ * ةلئاعلا مسا‬، , ‫لوألا مسالا‬Student ID,Course
Role*,Password*,Email*, , ‫طسوألا مسالا‬, ‫يفيظولا ىمسملا‬, ‫مسقلا‬, ‫ةكرشلا‬,
‫ عراشلا‬1 , ‫ عراشلا‬2, ‫ةنيدملا‬, ‫ ةظفاحملا‬/ ‫ميلقإلا‬, ‫يديربلا زمرلا‬, ‫دلبلا‬,Work
Phone ,Home Phone ,Work Fax ,Mobile Phone Website, ,Course
Availability
Batch Enroll
Organization
Users left to right
Organization ID*,Username*,Organization Role,System
Availability,Organization Availability
Batch Enroll
Organization
Users right to left
in English
Organization Availability,System Availability,Organization
Role*,Username,Organization ID*
Batch Enroll
Organization
Users right to left
in Arabic
Organization ID* ،Username* ،Organization Role ،System
Availability ،Organization Availability
Batch Enroll Users
left to right
Course ID*,Username*,Course Role,System Availability,Course
Availability
Batch Enroll Users
right to left in
English
Course Availability,System Availability,Course Role,Username*,Course
ID*
Batch Enroll Users
right to left in
Arabic
Course ID* ،Username* ،Course Role ،System Availability ،Course
Availability
Batch Remove
Users left to right
Username*,Last Name,First Name,Email,Password,Student ID,Middle
Name,Job Title,Department,Company,Street 1,Street
2,City,State/Province,Zip/Postal Code,Country,Work Phone,Home
Phone,Work Fax,Mobile Phone,Website
2007 Blackboard Inc. Proprietary and Confidential.
Page 308
Blackboard K–12 Academic Suite
Administrator Manual
B a t ch F i le T yp e
Sa mple F ile H ea der
Batch Remove
right to left in
English
,Province/State,City,Street 2,Street 1,Company,Department,Job
Title,Middle Name,Student ID,Password,Email,First Name,Last
Name,Username*
Website,Mobile Phone,Work Fax,Home Phone,Work
Phone,Country,Zip/Postal Code
Batch Remove
right to left in
Arabic
Username* ، ‫ةلئاعلا مسا‬
، , ‫ لوألا مسالا‬Student ID ,Email,
Password, , ‫طسوألا مسالا‬, ‫يفيظولا ىمسملا‬, ‫مسقلا‬, ‫ةكرشلا‬, ‫ عراشلا‬1 ,
‫ عراشلا‬2, ‫ةنيدملا‬, ‫ ةظفاحملا‬/ ‫ميلقإلا‬, ‫يديربلا زمرلا‬, ‫دلبلا‬,
Work Phone ,Home Phone Work,Fax, ,Mobile Phone ,Website
Red stars (* or ) indicate mandatory fields.
Note: When uploading records from left to right, any fields containing both English
and Arabic data will have the order flipped. The same order of data will be displayed
from right to left. Flipping the order of the data affects the order of the words, not the
letters that make up the words.
When formatting feed files for Snapshot, use a Tab delimiter. Do not use a pipe ( | ) delimiter
because it interferes with the formatting of the feed file in a right to left environment. Be sure to
set the Snapshot properties file to use a tab delimiter as well. For all the rules for formatting feed
files for Snapshot, see the Blackboard K-12 Suite Advanced Integration and Data Management
Guide available from Behind the Blackboard.
Viewing data in a right to left environment
Blackboard is not responsible for how imported and exported data will be displayed to the user
when it is viewed using third party applications that are not configured to view right to left
languages or do not support right to left languages. For example, if the user decided to view an
exported Arabic spreadsheet in Microsoft Excel and the Arabic language pack has been installed,
then Microsoft Excel will automatically reorder the text and the columns from right to left.
However, if the data is viewed in the file of another application, it may not have right to left
support.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 309
Blackboard K–12 Academic Suite
Administrator Manual
Creating a Language Pack
Overview
This chapter explains the process for creating a fully internationalized, or translated, Language
Pack. A Language Pack presents the Blackboard K-12 Suite using language and cultural norms
that match a specific audience. When a Language Pack is created, it may be installed on
Blackboard and used to present the entire application in a new language.
A Language Pack is made up of files that include all of the text and images that appear in the
Blackboard K-12 Suite. Files that include settings information, such as date and time format, are
also included.
Administrators have the option to use Blackboard’s Language Pack Editor to translate text
bundles. The Language Pack Editor is a simple tool used for editing bundles in a Language Pack.
The tool’s user interface displays the text within a bundle in the language selected by the user to
allow for easier translation. For additional information, please see the Language Pack Editor
topic.
When creating a completely new Language Pack, as opposed to making customizations or
dialect modifications to an existing Language Pack, a number of extra steps are necessary.
Modifications to image text and help documentation may be desired for a full translation.
This chapter explains the process of creating a new Language Pack from start to finish, including
the different workflow options available to users.
Note: Blackboard has made the Language Packs Catalog available to clients for
delivering Language Packs. Clients may post and download new Language
Packs to and from the Language Packs Catalog. The Catalog also includes the
Blackboard SDK and information necessary to maintaining a Language Pack.
This includes the image template directory, help manuals, and files that explain
changes made to the product for new releases.
In this section
This section includes the following topics:
©
S e ct io n
Descript ion
Planning
Outlines the steps and offers a checklist for creating a Language Pack.
Prerequisites
Explains software and skills necessary to create a Language Pack;
along with other introductory material.
Getting Started
Explains the two methods that may be used to begin the process.
Text bundles
Describes the process and tips for editing text bundles.
Update the
Manifest
Explains which changes should be made to the manifest.
Edit Language
Settings
Describes how specific properties files should be translated.
Images
Explains the resources needed for creating images.
Edit Images
Outlines the steps for creating new images.
2007 Blackboard Inc. Proprietary and Confidential.
Page 310
Blackboard K–12 Academic Suite
©
Administrator Manual
S e ct io n
Descript ion
Image
Troubleshooting
Explains common situations that may arise and explains how to
workaround them.
User Manuals
Describes the Blackboard manuals and explains how to include them
in a Language Pack.
2007 Blackboard Inc. Proprietary and Confidential.
Page 311
Blackboard K–12 Academic Suite
Administrator Manual
Language Pack Planning
Overview
This checklist presents an overview of the process for creating a Language Pack that can be
used with the Blackboard K-12 Suite. It is very important that users review the process and plan
the necessary time and resources before creating a Language Pack. Maintenance needs should
also be considered. Whenever a new version of the Blackboard application is installed, Language
Pack translations will need to be updated. This does not apply to Blackboard supported
Language Packs; these are maintained by Blackboard.
Please note that Blackboard Content System files are included in the Language Pack directory,
regardless of whether or not the Institution has a license for this application. While these files
appear in the Language Pack, the Institution’s license determines the visibility of this product
once the Language Pack is installed. If the Language Pack will be shared with other Institutions,
the translators may wish to translate these text bundles for those Institutions that use this product.
Checklist
The following is an overview of the steps for creating a Language Pack.
©
•
Read the Creating a Language Pack chapter thoroughly. Efficient planning and
execution requires a full understanding of the process. This chapter includes information
critical to the success of a Language Pack.
•
Plan resources and time allocations before creating a Language Pack. Also, check that
all of the necessary software is available. See the Prerequisites topic in this chapter for
additional information.
•
Copy, import or export an existing Language Pack. This is done through the
Administrator Panel in the Blackboard K-12 Suite. See the Getting Started topic for
additional information.
•
Review the Manifest for changes. This step is only necessary if the Language Pack is
exported from Blackboard K-12 Suite
•
Edit text bundles in the Blackboard Language Pack Editor, or in the text editor of your
choice. See the Text bundles topic for additional information.
•
Edit properties files in the Language Pack. There are certain properties files that
require specific background information before they are edited. These files are related to
the settings, and date/time information. See the Edit Language Settings topic for
additional information.
•
Edit image files in the Language Pack. This process allows the user to create images
appropriate for their locale. See the Images topic for additional information.
•
Translate manuals and redirect the links within the application to point to them. See the
User Manuals topic for additional information.
2007 Blackboard Inc. Proprietary and Confidential.
Page 312
Blackboard K–12 Academic Suite
Administrator Manual
Prerequisites
Overview
The following information is important to review before creating a Language Pack.
Preferred Technical Skills
Aside from administrator knowledge of the Blackboard K-12 Suite, creating a Language Pack
requires some specific technical skills. These include the following:
•
Administrator access to the Blackboard K-12 Suite
•
Experience installing software
•
Ability to use text and image editors
•
Experience editing images
These skills may be divided among multiple people. For example, a Blackboard Administrator
must complete all functions that take place through the UI, such as copying and importing
Language Packs. A separate translator may work on the Language Pack once it is sitting outside
of the Blackboard K-12 Suite. This person must have experience with text and image editors.
Note: Users must be a Blackboard Administrator to access the Language Pack
Editor.
Hardware and Software Requirements
The creation of a completely new Language Pack requires that translators have access to some
specific software. This includes:
For editing text strings, one of the following
•
The Blackboard Language Pack Editor
•
Microsoft© Word 2002 or higher
•
Text editors, such as Notepad
•
Native-to-ASCII converter – this tool is only required for translators creating Language
Packs with multi byte characters outside of the Language Pack Editor.
For editing images:
•
Adobe© Photoshop 6.0 or higher
For editing documentation, one of the following:
•
Macromedia© RoboHelp X5 or higher
•
Microsoft© Word 2002 or higher
A test environment of the Blackboard K-12 Suite should be set up for translators. This allows
them to view changes that are made as the Language Pack is created. For example, work on
editing text bundles can be checked so that the new text appears correctly in the UI and images
that are altered may be viewed to make sure no formatting errors were introduced.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 313
Blackboard K–12 Academic Suite
Administrator Manual
Maintenance Requirements
It is important to consider and plan for ongoing maintenance when making the decision to create
a Language Pack. Once a Language Pack is created it must be maintained with future
Blackboard releases; this requires both a time and resource commitment.
As Blackboard releases upgrades, information will be published in the Language Packs Catalog.
This will include information on text bundles and images that have been added, modified, and
removed. A list of new and removed text bundles will be provided, as well as, a list of text strings
that have been added, removed or modified. New user manuals will also be posted.
Glossary of terms
Language packs consist of a number of components. These are defined below:
©
T er m
De f in it i on
Image
A picture that appears in the UI, such as a button or an icon. Image files for all
images in the application are included in the Language Pack directory.
Language
settings
Data included in properties files that affect the entire system. For example, the
format for dates and punctuation. A number of files within the Language Pack
contain this information.
Manifest
An xml file, named bb-lp-manifest.xml, which appears in the top-level of a
Language Pack directory. It includes important metadata, or information, about
the overall Language Pack.
Text
bundle
A file that consists of a set of related text strings. For example, an
announcements.properties file includes text strings related to the
announcements feature. Each text bundles include keys and text strings. Keys
signify the name and location of the text string and appear to the left of the
equal (=) character.
Text string
Text strings are the actual strings of text in a text bundle that must be
translated. Each text string appears to the right of a key after the equal (=)
character.
2007 Blackboard Inc. Proprietary and Confidential.
Page 314
Blackboard K–12 Academic Suite
Administrator Manual
Getting Started
Overview
All new Language Packs are created by editing and altering an existing one. A number of
different workflows are available to complete this process. The workflow chosen depends on the
skill level of the translator and the extent of the translation they would like to create. This topic
explains these workflows and the pros and cons for each.
For additional information on using the Language Pack Editor, please see the Chapter 10 –
Language Packs.
Import and modify a Language Pack
This process is appropriate for users who would like to make translate some or all of the text in an
existing Language Pack. It is not an appropriate solution for users who would like to translate
images. Importing an existing Language Pack has some benefits since it makes changes to the
new manifest automatically and it allows the translator to use the Blackboard Language Pack
Editor for editing text bundles and properties files.
Follow the steps below to import a Language Pack:
1.
Select Manage Language Packs on the Administrator Panel.
2.
Select Import in the Action Bar.
3.
Complete the Import Language Pack page. See Import Language Pack for additional
information.
4.
Once the Language Pack has been imported, use the Language Pack Editor to translate
the text bundles.
Copy and modify a Language Pack
Similar to import, copying an existing Language Pack makes changes to the new manifest
automatically and allows the translator to use the Blackboard Language Pack Editor for editing
text bundles and properties files. This option is not an appropriate solution for users who would
like to translate images in the Language Pack.
Follow the steps below to copy an existing Language Pack:
1.
Select Manage Language Packs on the Administrator Panel.
2.
Select Copy next to an existing Language Pack.
3.
Complete the Copy page. See the Copy Language Pack for additional information.
4.
After the copy is complete, use the Language Pack Editor to modify the text bundles.
Export and modify a Language Pack
Users may export an existing Language Pack and go through all of the steps manually to create a
new Language Pack. If this method is used, the user must update the manifest. Some translators
may want to update the manifest, to change information about the vendor, release number, and
other metadata regarding the Language Pack that isn’t accessed through the automated process.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 315
Blackboard K–12 Academic Suite
Administrator Manual
This is a good solution for users who would like to create a complete Language Pack or for users
who would like to use a specific text editor for translating text bundles. Once the Language Pack
is exported the images may be translated and any text editor may be used.
Follow the steps below to export a Language Pack:
1.
Select Manage Language Packs on the Administrator Panel.
2.
Select Export next to an existing Language Pack. This will be the copied language,
meaning that the user will work off of it to create the new Language Pack. For example, if
a user speaks both English and French, and he or she is creating a French Language
Pack, exporting the English Language Pack as the copied language would make sense.
When the exported package is opened, two top level items appear. The manifest file and
the locale name directory. The locale name directory contains all of the images and text
bundles. The manifest file includes metadata about the Language pack, such as the
name, vendor information, and release number.
Warning: The structure of this file must be preserved. Do not rearrange or
reorder any files within the directory.
3.
After completing the translating the text bundles and image filed (if desired), the
Administrator imports the new Language Pack through the Administrator Panel.
Tip: Translators may use a combination of the above methods if they would like
to use the Language Pack Editor, but also translate the images in a Language
Pack and access the manifest after it has been properly created. Copy the
Language Pack on the Manage Language Packs page. Use the Language Pack
Editor to translate the text bundles in the copied Language Pack. Next, export the
copied Language Pack to a local system. Translate the images, review the
manifest, and then import the complete Language Pack back into the system.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 316
Blackboard K–12 Academic Suite
Administrator Manual
Text Bundles
Overview
Editing text bundles is a large part of creating a new Language Pack. The localization process
extracts all text strings in the system into text bundles, which represent a logical grouping of the
text strings by location, topic or subsystem. The editing process involves translating all of these
text bundles into the appropriate language. This topic includes information on the software
needed for this process, as well as tips and troubleshooting techniques.
It is important to note that there is not always a one to one relationship between the pages in the
UI and the text strings in a properties file. For example, a single properties file may contain text
strings that appear on multiple pages in the system.
The information in text strings may include page or section headers, instructional text on page,
error messaging, or text that appears within images.
Text Editors
If a copy of the Language Pack was made through the UI, the Language Pack Editor may be
used to modify text bundles. If the Language Pack was exported, users may use a text editor of
their choosing, as the Language Pack Editor is only available when working from the
Administrator Panel. Any text editor of choice may be used, including Notepad.
Note: It is helpful to turn off word wrap in the text editor, as this makes viewing
the separation between text strings easier.
Keys and Text Strings
The text bundles include keys and text strings. Keys signify the name and location of the text
string and appear to the left of the equal (=) character. Text strings are the actual strings of text
that must be translated. These appear to the right of the equal characters.
Do not add or remove keys or text strings, this will result in an incomplete UI or broken and partial
strings.
Warning: Do not change the keys. It is very important that the keys in the
text bundles are not touched. If the keys are changed and the application
cannot find the correctly translated text string, English appears on the page
as the fallback language.
HTML in text bundles
Very little HTML is embedded in the text bundles of the Language Pack and Blackboard
recommends not adding additional HTML during the translation process. There are a limited
number of HTML tag that are acceptable, these are below:
•
©
Anchor a link - <A> </A>
2007 Blackboard Inc. Proprietary and Confidential.
Page 317
Blackboard K–12 Academic Suite
•
Bold text - <B> </B>
•
Copyright - &copy;
•
Apostrophe - &rsquo;
•
Trademark - &trade;
Administrator Manual
Note: Adding additional style formatting to text strings (for example, adding bold
and italics) is not recommended. If style formatting is needed, simple HTML
should be used. Do not remove any HTML that appears in the original text
strings.
Parameters and variables
Parameterized text, also known as placeholder, appears in brackets {} within text bundles, for
example as {number or text variable}. Do not change or remove the text that appears within a {}
when working with text bundles; this will result in the loss of dynamic information necessary for
the translation to appear correctly. The following are some types of information that appears as
variables:
•
Date / Time
•
Product
•
Class / Organization
•
Role names
•
Administrator
•
Text specific to the context of the text bundle, such as the names of content types
Note: It is possible to move the entire placeholder (the brackets and text within
them) to another location within the text string. Do not change the text within the
brackets.
Placeholders for variables may also appear as @[email protected] within text bundles. Do not modify these
placeholders. These variables indicate database fields that should be used in the specific text
string.
Comments
Comments are included in some of the text bundles; this information does not appear in the
application UI. Comments are information about the text bundle that may be useful for developers
and translators. Comments begin with a number character (#) and do not need to be translated
Line breaks
Line breaks in text strings appear as \ or \\. In general, it is recommended that translators not
remove or modify these characters as this will effect how text appears in the UI. Simply adding a
hard return will not be recognized as a line break.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 318
Blackboard K–12 Academic Suite
Administrator Manual
Note: Some languages, such as those using multi byte characters, may require
that line breaks are added or modified so that text appears appropriately in the
UI.
Escaping whitespace
In some areas of the UI, whitespace, or a number of blank spaces, appears before or after a text
string. Whitespace at the beginning or end of a text string is indicated by a colon and must be
escaped with a backslash. For example, the following adds additional whitespace to the
beginning of a text string:
=\
:\ This is a text string.
When this line of text appears in the UI, blank spaces appear before “This”, the first word of the
sentence. Whitespace within a text string does not have to be escaped; the system recognizes
space characters embedded within the text string.
Separator characters
Colons (:) and hyphens (-) are used frequently in the text strings to separate parts of the text. In
many text strings they appear as part of the sentence or text, and may be translated accordingly.
These characters also appear in some text bundles and are used as separators for labels. The
following explains how these specific text strings should be translated:
In the common.properties file:
1.
common.text.colon={text}: Adjust the spacing around the colon or substitute a
different separator for the colon. Do not modify the text enclosed in the curly
brackets.
2.
separator.colon=: Adjust the spacing around the colon or substitute a different
separator for the colon.
3.
separator.hyphen=- Adjust the spacing around the hyphen or substitute a
different separator for the hyphen.
In the PerlStrings.properties file:
•
txt_colon={0.text}: Adjust the spacing around the hyphen or substitute a different
separator for the hyphen. Do not modify the text enclosed in the curly brackets.
There are several instances where identical text strings appear, one with a colon and one without.
To maintain consistency, and avoid user confusion, the translation for the two strings should be
identical; just add the colon (or separator) to the one where it is appropriate.
Do not translate list
Some terms and phrases within the text bundles should not be translated or altered in any way. In
many cases, these terms have legal and trademark implications
In addition to the terms below, the copyright and patent footer on the Login page should not be
translated or modified. This text reads “Copyright © 1997-2004 Blackboard Inc. Patents Pending.
All rights reserved.”
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 319
Blackboard K–12 Academic Suite
Administrator Manual
Note: Third party terminology should never be translated. If the translator needs
to make changes to any third party terminology, contact the specific company.
D o N ot Tran s lat e Te rms
©
Bb
Blackboard Content System
Menu
Kerberos
Bb One
Blackboard Content System
Tab
Mac
Behind the Blackboard
Course Cartridge
Microsoft IIS
Blackboard
Course Cartridge Catalog
Microsoft Internet
Explorer
Blackboard K-12 Suite
Coursesite
Microsoft Service
Packs
Blackboard Backpack
Dublin Core Metadata
Microsoft SQL Server
Blackboard Commerce Suite
e-Reserves
Microsoft Windows
Blackboard Community System
e-Reserves Folder
Netscape
Blackboard Content Collection
IMS Content Packaging
NLN
Blackboard Content System
IMS Metadata
Oracle
Blackboard Learning System
My Blackboard
Pentium
Blackboard Learning System - Basic
Edition
NLN Content
Red Hat Linux
Blackboard Learning System – ML
Play with Blocks
SCO
Blackboard Portal System
Powered by Blackboard
SCORM
Blackboard Product Support
SCORM Content
sendmail
Blackboard Resource Center
The Electric Blackboard®
Sun
Blackboard Transaction System
ActiveState Perl
Sun Solaris
Blackboard.com
AICC
Tomcat
Bringing Education Online
Apache
UNIX
Building Blocks
Dell
VA Linux
Chalk
Horizon Live
WebEQ
Chalk Title
IMS
Winzip
ChalkBox
IP Address
Chalkware
Java
Blackboard Content System
Java™ Developer’s Kit
(JDK™)
2007 Blackboard Inc. Proprietary and Confidential.
Page 320
Blackboard K–12 Academic Suite
Administrator Manual
Saving and encoding files
This section does not apply to translators working in the Language Pack Editor.
After a text bundle has been translated, it must be saved so the changes appear in the new
Language Pack. This is done simply as a save operation to save the new file over the old one.
The encoding for these files should be ANSI if the file only contains Unicode characters.
Note for translators using multi byte characters: If a file contains multi
byte characters, these characters must be escaped. The easiest way to do this is
to create a UTF-8 file and run a Native-to-ASCII converter. This tool, available in
the Java™ Development Kit, converts a file that has native-encoded characters
(characters which are non-Latin-1 and non-Unicode) to one with Unicodeencoded characters. Files must be saved as ANSI before importing the
Language Pack into Blackboard.
Precautions for using the Language Pack Editor
If the Language Pack Editor is used for translating bundles, only the keys of the text bundles that
match the current Blackboard version will be kept,. This also affects upgrades. When a text
bundle is opened in the Language Pack Editor, any keys that do not match the keys of the
Blackboard version being used, are removed once the page is submitted; this makes it easier for
translators to update bundles from one version to the next when using the Language Pack Editor
Additionally, if the translator adds comments to a bundle when working in another text editor,
these comments are lost when a bundle is saved using the Language Pack Editor.
Testing text bundles
It is strongly recommended that the translator test the new text bundles before the Language
Pack is made available on the system. This can be done by setting up a test server. Check the
text in the UI that has been revised and confirm that no problems have been introduced and the
translations make sense.
Language pack defaults
If keys and text strings are removed from a bundle, the system automatically defaults to English
for these strings of text. When a user views the UI after the Language Pack is installed, English
appears in place of the removed string. This only occurs if both the key and text string are
removed; if the text string is deleted, but the key remains, a blank area appears in place of the
text when viewed in the system.
If text strings in a bundle are left unmodified, they automatically appear in the copied language
when viewed in the system. For example, if the translator exports a French Language Pack and
uses it to create a Spanish Language Pack, any unmodified strings will appear in French.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 321
Blackboard K–12 Academic Suite
Administrator Manual
Update the Manifest
Overview
The manifest file, named bb-lp-manifest.xml, includes important metadata, or information about
the overall Language Pack. This includes the name of the Language Pack, information about the
language, the version of Blackboard the Language Pack was created for, the URLs for the
documentation, and vendor information.
Note: Users who decide to export a Language Pack must update the manifest
file manually. If the Copy operation is used to create a new Language Pack, the
system will update the manifest automatically; translators may skip this section.
Manifest Updates
The following changes should be made to the text strings in the manifest:
©
Ke y
Descript ion
Name value
Enter the name of the Language Pack; this should reflect the name of the
Locale value. An identifier may be added to the name in parentheses. For
example, if the Language Pack is for a specific region the name may be
Spanish (Region1). This value is displayed to users in the application when
they select the Language Pack.
Locale
value
This value must correspond with the top level directory name, otherwise
the Language Pack will not import properly. It should conform to the
internet standard for country and language codes, using the language code,
followed by the country code. For example, then code for English is en_US.
Information about the standard ISO 3166 country codes and the ISO 639
language codes is available on the internet.
There is also an option to include a subtag after the country code. This subtag
must be alphanumeric and may include up to 16 characters. It is used only to
differentiate Language Packs for the translator; it is not used by the system.
For example, if two Spanish Language Packs are created using different
colloquial styles, the locale values may be es_ES_Spanish1 and
es_ES_Spanish2.
This value is called the Code on the Manage Language Packs page in the UI.
Description
value
Enter a short description for this Language Pack.
Version
value
Enter the version information for this Language Pack. This value reflects the
Language Pack; not the Blackboard version.
bbversion
value
Enter the version of the Blackboard K-12 Suite which this Language Pack was
created for.
Id value
Enter the ID for the vendor or Institution creating the Language Pack.
Name value
Enter the name of the vendor or Institution.
Url value
Enter the URL for the vendor or Institution.
2007 Blackboard Inc. Proprietary and Confidential.
Page 322
Blackboard K–12 Academic Suite
©
Ke y
Descript ion
Description
value
Enter a description of the vendor or Institution.
2007 Blackboard Inc. Proprietary and Confidential.
Administrator Manual
Page 323
Blackboard K–12 Academic Suite
Administrator Manual
Edit Language Settings
Overview
Some of the properties files contain language settings, which is delicate data that affects the
entire system. These files require specific modifications when a new Language Pack is created.
This topic explains how these files affect the system and which information should be modified.
LocaleSettings.properties file
The LocaleSettings.properties file contains time and calendar information that needs to be
localized. This means that they need to be modified to reflect the customs of the target users.
There are also parts of this file that should not be altered; these sections are noted by comments
in the files.
The following explains the keys and text strings in this file that require updates:
©
Ke y
Descript ion
LOCALE_SETTINGS.DATE_ORDER.00519
Arrange the letters in the correct order for
the date display. Do not translate, only
these values will be recognized by the
application.
LOCALE_SETTINGS.TIME_ORDER.00519
Arrange the text in the correct order for the
time display. Do not translate, only these
values will be recognized by the application.
LOCALE_SETTINGS.DAY_FULL.02098
Translate the days of the week. Do not alter
the order that the text appears.
LOCALE_SETTINGS.MONTH_SHORT.00520
Translate the abbreviation for each month.
Do not alter the order that the text appears.
LOCALE_SETTINGS.MONTH_FULL.02100
Translate the full names of the months. Do
not alter the order that the text appears.
LOCALE_SETTINGS.AM_PM.00522
Translate AM and PM. Do not alter the
order of the text.
number_format.decimal_point
Replace the period character (.) with the
appropriate character for a decimal point.
number_format.thousands_sep
Replace the comma character (,) with the
appropriate character to indicate
thousands.
number_format.exponent
Replace the eE characters with the
appropriate character for an exponent.
LOCALE_SETTINGS.DAY_SHORT.02097
Translate the abbreviations for each day.
Do not alter the order that the text appears.
LOCALE_SETTINGS.24HR_SUPPORT.03208
Enter 1 if 24 hour product support is
available; enter 0 if it is not.
LOCALE_SETTINGS.date_display_pattern
Arrange the characters in the pattern
displayed to users to indicate a date.
2007 Blackboard Inc. Proprietary and Confidential.
Page 324
Blackboard K–12 Academic Suite
Administrator Manual
Ke y
Descript ion
LOCALE_SETTINGS.internal_date_format
Arrange the characters in the pattern the
system should use to display a date.
DateSettings.properties file
The DateSettings.properties file contains information about how the date is displayed in different
areas of the application. The file is organized by format for specific types of information, for
example the format for Announcements and the format for timestamp are included. For each
format, arrange the values in the area in the appropriate pattern for the display.
For example, the values for the abbreviated date display format are:
%b = month abbreviation
%d = day of month
%Y = 4 digit year
The key for this information is BBI18N.06659.
To create a date format for a month abbreviation, day, year pattern (for example, Jan 1, 2005) the
key and text string appear as follows:
BBI18N.06659=%d %b %Y
There are two keys at the top of this file that must be translated. They are explained below:
Ke y
Descript ion
BBI18N.LANG_NAME
Enter the name of the language for this Language Pack.
BBI18N.WINDOWS_LOCALE
Enter the country code recognized by Windows.
The section of the file that includes all of the keys for time information should also be translated.
These keys all begin with BBI18N.TIME.
js_calendar.properties file
The js_calendar.properties file contains calendar information related to months, days and the
abbreviations for these.
The following explains the keys and text strings in this file that require updates:
©
Ke y
Descript ion
month.long
Keys that begin with this string are used to define the full names
of the 12 months. Translate these text strings into the
appropriate months.
month.short
Keys that begin with this string are used to define the
abbreviated names of the 12 months. Translate these text strings
into the appropriate month abbreviations.
2007 Blackboard Inc. Proprietary and Confidential.
Page 325
Blackboard K–12 Academic Suite
©
Administrator Manual
Ke y
Descript ion
day.long
Keys that begin with this string are used to define the
abbreviated names of the seven days of the week. Translate
these text strings into the appropriate days.
day.short
Keys that begin with this string are used to define the
abbreviated names of the seven days of the week. Translate
these text strings into the appropriate day abbreviations.
format.full
Arrange the values in the appropriate pattern for the date format
that includes the long day. For example, a Sunday Mar. 3, 2004
format equals the following pattern: {6} {3}. {2}, {0}
The following is a key to the values:
{0} – year, for example 2004
{1} – numerical month, for example March equals 3
{2} – numerical day
{3} – abbreviated month, for example Mar.
{4} – long month, for example March
{5} – abbreviated day, for example Mon.
{6} – long day, for example Monday
format.full_abr
Arrange the values in the appropriate pattern for the date format
that includes the abbreviated day. See the format.full field for a
key to the values.
format.month_year
Arrange the values in the appropriate pattern for the date format
that includes only the month and year. See the format.full field for
a key to the values.
picker.title
Translate the text string ‘Calendar: Select Date’
picker.today
Translate the text string ‘Today is:’
picker.alt.previous_month
Translate the text string ‘Previous month’
picker.alt.next_month
Translate the text string ‘Next month’
2007 Blackboard Inc. Proprietary and Confidential.
Page 326
Blackboard K–12 Academic Suite
Administrator Manual
Images
Overview
Translators may need to create images that match the new Language Pack. Not all the images
used in Blackboard must be translated, only those with text on them. To translate the text found
on images, an image editor and templates are used to create images which display the
appropriate language. These new images are then saved to the proper directory in the Language
Pack.
Note: The Language Pack must be exported before any changes are made to
image files. Translators who are copying a Language Pack and using the
Language Pack Editor will not be able to modify image files.
File types and Image editors
Blackboard provides Adobe Photoshop (PSD) files for translators to use during image creation.
These files are actually image templates that are edited and saved in the Language Pack
directory. Blackboard recommends using Adobe Photoshop for editing the image files. These
files may be saved as either .gif or .jpg files to be used within the Blackboard application.
Image Template table
The Image Template table includes information about images and image templates.
Images are stored in the /blackboard/content/images-ltr for most languages and the
/blackboard/content/images-rtl for right to left languages. When creating a right to left language
pack, images will be pulled from the images-rtl directory.
The columns included in this table are explained below:
•
File name The name of the image file.
•
Directory path The path to the image file within the Language Pack directory.
•
Text The exact text that appears within the image. This text may be translated to suit the
Language Pack.
•
Template The template that corresponds to the specific image. This is the template
used when translating and modifying an image for a Language Pack. Please note that a
single template may correspond with multiple images.
Note: Image templates may be downloaded from the Language Packs Catalog.
©
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
cancel_off.gif
/collab/images/cancel_off.gif
Cancel
FormButtonOff_20_69_1
3.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 327
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
cancel_on.gif
/collab/images/cancel_on.gif
Cancel
FormButtonClick_20_69_
13.psd
closewindow_cli
ck.gif
/collab/images/closewindow_
click.gif
Close
Window
FormButtonOff_20_110_
13.psd
closewindow_off
.gif
/collab/images/closewindow_
off.gif
Close
Window
FormButtonClick_20_110
_13.psd
display_doc.gif
/collab/images/display_doc.gif
Display
IconArrowAfterText.psd
insert_off.gif
/collab/images/insert_off.gif
Insert
IconArrowBeforeText_50.
psd
inserteq_off.gif
/collab/images/inserteq_off.gif
Insert
Equation
IconArrowBeforeText_12
5.psd
ok_off.gif
/collab/images/ok_off.gif
OK
FormButtonOff_20_69_1
3.psd
ok_on.gif
/collab/images/ok_on.gif
OK
FormButtonClick_20_69_
13.psd
submit_click.gif
/collab/images/submit_click.gi
f
Submit
FormButtonOff_20_69_1
3.psd
submit_off.gif
/collab/images/submit_off.gif
Submit
FormButtonClick_20_69_
13.psd
vc_breakouts_of
f.gif
/collab/images/vc_breakouts_
off.gif
Breakouts
IconArrowBeforeText_75.
psd
vc_clear_off.gif
/collab/images/vc_clear_off.gi
f
Clear
IconClearBeforeText.psd
vc_compose_off
.gif
/collab/images/vc_compose_
off.gif
Compose
IconComposeBeforeText.
psd
vc_controls_off.
gif
/collab/images/vc_controls_of
f.gif
Controls
IconControlsBeforeText.p
sd
vc_end_off.gif
/collab/images/vc_end_off.gif
End
IconEndBeforeText.psd
vc_expel_user.g
if
/collab/images/vc_expel_user
.gif
Expel
User
IconEndBeforeText.psd
vc_private_mes
sage.gif
/collab/images/vc_private_me
ssage.gif
Private
Message
IconArrowBeforeText_12
5.psd
vc_send_off.gif
/collab/images/vc_send_off.gi
f
Send
IconArrowBeforeText_50.
psd
vc_user_info.gif
/collab/images/vc_user_info.g
if
User Info
IconUserInfoBeforeText.p
sd
vc_view_off.gif
/collab/images/vc_view_off.gif
View
IconViewBeforeText.psd
go.gif
/images/ci/actionbar/go.gif
Go
GoSquare.psd
add_off.gif
/images/ci/formbtns/add_off.gi
f
Add
FormButtonOff_20_69_1
3.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 328
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
addanotherrole_
off.gif
/images/ci/formbtns/addanoth
errole_off.gif
Add
Another
Role
FormButtonOff_20_110_
13.psd
addanotherterm
_off.gif
/images/ci/formbtns/addanoth
erterm_off.gif
Add
Another
Term
FormButtonOff_20_110_
13.psd
back_off.gif
/images/ci/formbtns/back_off.
gif
Back
FormButtonOff_20_69_1
3.psd
browse_off.gif
/images/ci/formbtns/browse_o
ff.gif
Browse
FormButtonOff_20_69_1
3.psd
calculate_off.gif
/images/ci/formbtns/calculate
_off.gif
Calculate
FormButtonOff_20_69_1
3.psd
cancel_click.gif
/images/ci/formbtns/cancel_cli
ck.gif
Cancel
FormButtonClick_20_69_
13.psd
cancel_off.gif
/images/ci/formbtns/cancel_of
f.gif
Cancel
FormButtonOff_20_69_1
3.psd
clear_off.gif
/images/ci/formbtns/clear_off.
gif
Clear
FormButtonOff_20_69_1
3.psd
closewindow_off
.gif
/images/ci/formbtns/closewind
ow_off.gif
Close
Window
FormButtonOff_20_110_
13.psd
continue_disabl
ed.gif
/images/ci/formbtns/continue_
off.gif
Continue
FormButtonOff_20_69_1
3.psd
continue_off.gif
/images/ci/formbtns/continue_
disabled.gif
Continue
FormButtonOff_20_69_1
3disabled.psd
delete_off.gif
/images/ci/formbtns/delete_off
.gif
Delete
FormButtonOff_20_69_1
3.psd
download_off.gif
/images/ci/formbtns/download
_off.gif
Download
FormButtonOff_20_69_1
3.psd
genaddanother_
off.gif
/images/ci/formbtns/genadda
nother_off.gif
Add
Another
FormButtonOff_20_110_
13.psd
gotomessages_
off.gif
/images/ci/formbtns/gotomess
age_off.gif
Go to
Message
FormButtonOff_20_110_
13.psd
import_off.gif
/images/ci/formbtns/import_of
f.gif
Import
FormButtonOff_20_69_1
3.psd
login_off.gif
/images/ci/formbtns/login_off.
gif
Login
FormButtonOff_20_69_1
3.psd
modify_off.gif
/images/ci/formbtns/modify_of
f.gif
Modify
FormButtonOff_20_69_1
3.psd
next_off.gif
/images/ci/formbtns/next_off.g
if
Next
FormButtonOff_20_69_1
3.psd
ok_click.gif
/images/ci/formbtns/ok_click.g
if
OK
FormButtonClick_20_69_
13.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 329
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
ok_off.gif
/images/ci/formbtns/ok_off.gif
OK
FormButtonOff_20_69_1
3.psd
preview_off.gif
/images/ci/formbtns/preview_
off.gif
Preview
FormButtonOff_20_69_1
3.psd
previous_off.gif
/images/ci/formbtns/previous_
off.gif
Previous
FormButtonOff_20_69_1
3.psd
reset_off.gif
/images/ci/formbtns/return_off
.gif
Return
FormButtonOff_20_69_1
3.psd
return_off.gif
/images/ci/formbtns/reset_off.
gif
Reset
FormButtonOff_20_69_1
3.psd
save_off.gif
/images/ci/formbtns/save_off.
gif
Save
FormButtonOff_20_69_1
3.psd
search_off.gif
/images/ci/formbtns/search_of
f.gif
Search
FormButtonOff_20_69_1
3.psd
submit_click.gif
/images/ci/formbtns/submit_cl
ick.gif
Submit
FormButtonClick_20_69_
13.psd
submit_off.gif
/images/ci/formbtns/submit_of
f.gif
Submit
FormButtonOff_20_69_1
3.psd
wait_off.gif
/images/ci/formbtns/wait_off.g
if
Wait
FormButtonOff_20_69_1
3.psd
options-hide.gif
/images/ci/headers/optionshide.gif
HIDE
OPTIONS
HideOptions.psd
options-show.gif
/images/ci/headers/optionsshow.gif
SHOW
OPTIONS
ShowOptions.psd
0.gif
/images/ci/icons/0.gif
0
StepNumber.psd
1.gif
/images/ci/icons/1.gif
1
StepNumber.psd
2.gif
/images/ci/icons/2.gif
2
StepNumber.psd
3.gif
/images/ci/icons/3.gif
3
StepNumber.psd
4.gif
/images/ci/icons/4.gif
4
StepNumber.psd
5.gif
/images/ci/icons/5.gif
5
StepNumber.psd
6.gif
/images/ci/icons/6.gif
6
StepNumber.psd
7.gif
/images/ci/icons/7.gif
7
StepNumber.psd
8.gif
/images/ci/icons/8.gif
8
StepNumber.psd
9.gif
/images/ci/icons/9.gif
9
StepNumber.psd
10.gif
/images/ci/icons/10.gif
10
StepNumber.psd
discussion_colle
ct.gif
/images/ci/icons/discussion_c
ollect.gif
COLLECT
DiscussionCollect.psd
discussion_dese
lect.gif
/images/ci/icons/discussion_d
eselect.gif
DESELEC
T
DiscussionDeselect.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 330
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
discussion_inver
t.gif
/images/ci/icons/discussion_i
nvert.gif
INVERT
DiscussionInvert.psd
discussion_lock.
gif
/images/ci/icons/discussion_l
ock.gif
LOCK
DiscussionLock.psd
discussion_read
.gif
/images/ci/icons/discussion_r
ead.gif
READ
DiscussionRead.psd
discussion_rem
ove.gif
/images/ci/icons/discussion_r
emove.gif
REMOVE
DiscussionRemove.psd
discussion_sele
ct.gif
/images/ci/icons/discussion_s
elect.gif
SELECT
ALL
DiscussionSelectAll.psd
discussion_unlic
k.gif
/images/ci/icons/discussion_u
nlock.gif
UNLOCK
DiscussionUnLock.psd
discussion_unre
ad.gif
/images/ci/icons/discussion_u
nread.gif
UNREAD
DiscussionUnRead.psd
discussion_unse
lect.gif
/images/ci/icons/discussion_u
nselect.gif
UNSELEC
T
DiscussionUnSelect
add_off.gif
/images/ci/listbtns/add_off.gif
Add
ListButtonOff_16_50_6ch
ar.psd
add_on.gif
/images/ci/listbtns/add_on.gif
Add
ListButtonOn_16_50_6ch
ar.psd
add_up_off.gif
/images/ci/listbtns/add_up_off
.gif
Add
AddUpOff.psd
addanotherfile_
off.gif
/images/ci/listbtns/addanother
file_off.gif
Add
Another
File
ListButtonOff_16_90_14c
har.psd
addcategory_off
.gif
/images/ci/listbtns/addcategor
y_off.gif
Add
Category
ListButtonOff_16_90_14c
har.psd
addcategory_on
.gif
/images/ci/listbtns/addcategor
y_on.gif
Add
Category
ListButtonOn_16_90_14c
har.psd
addfile_off.gif
/images/ci/listbtns/addfile_off.
gif
Add File
ListButtonOff_16_50_6ch
ar.psd
addfile_on.gif
/images/ci/listbtns/addfile_on.
gif
Add File
ListButtonOn_16_50_6ch
ar.psd
addimagefile_off
.gif
/images/ci/listbtns/addimagefil
e_off.gif
Add
Image /
File
ListButtonOff_16_90_14c
har.psd
addimagefile_on
.gif
/images/ci/listbtns/addimagefil
e_on.gif
Add
Image /
File
ListButtonOn_16_90_14c
har.psd
addobserver_off
.gif
/images/ci/listbtns/addobserv
er_off.gif
Add
Parent
ListButtonOff_16_90_14c
har.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 331
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
addquestion_off.
gif
/images/ci/listbtns/addquestio
n_off.gif
Add
Question
ListButtonOff_16_90_14c
har.psd
addquestion_on.
gif
/images/ci/listbtns/addquestio
n_on.gif
Add
Question
ListButtonOn_16_90_14c
har.psd
addtolibrary_off.
gif
/images/ci/listbtns/addtolibrar
y_off.gif
Add to
Library
ListButtonOff_16_90_14c
har.psd
addtolibrary_on.
gif
/images/ci/listbtns/addtolibrar
y_on.gif
Add to
Library
ListButtonOn_16_90_14c
har.psd
approve_off.gif
/images/ci/listbtns/approve_of
f.gif
Approve
ListButtonOff_16_50_6ch
ar.psd
approve_on.gif
/images/ci/listbtns/approve_o
n.gif
Approve
ListButtonOn_16_50_6ch
ar.psd
archives_off.gif
/images/ci/listbtns/archives_of
f.gif
Archives
ListButtonOff_16_50_6ch
ar.psd
browse_off.gif
/images/ci/listbtns/browse_off.
gif
Browse
ListButtonOff_16_50_6ch
ar.psd
categorize_off.gi
f
/images/ci/listbtns/categorize_
off.gif
Categoriz
e
ListButtonOff_16_90_14c
har.psd
categorymanag
er_off.gif
/images/ci/listbtns/categorym
anager_off.gif
Category
Manager
ListButtonOff_16_90_14c
har.psd
clearattempt_off
.gif
/images/ci/listbtns/clearattem
pt_off.gif
Clear
Attempt
ListButtonOff_16_90_14c
har.psd
configure_off.gif
/images/ci/listbtns/configure_
off.gif
Configure
ListButtonOff_16_50_6ch
ar.psd
contents_off.gif
/images/ci/listbtns/contents_of
f.gif
Contents
ListButtonOff_16_50_6ch
ar.psd
copy_off.gif
/images/ci/listbtns/copy_off.gif
Copy
ListButtonOff_16_50_6ch
ar.psd
courses_off.gif
/images/ci/listbtns/courses_off
.gif
Classes
ListButtonOff_16_50_6ch
ar.psd
create_off.gif
/images/ci/listbtns/create_off.
gif
Create
ListButtonOff_16_50_6ch
ar.psd
describe_off.gif
/images/ci/listbtns/describe_of
f.gif
Describe
ListButtonOff_16_50_6ch
ar.psd
downlaod_off.gif
/images/ci/listbtns/download_
off.gif
Download
ListButtonOff_16_50_6ch
ar.psd
enroll_off.gif
/images/ci/listbtns/enroll_off.gi
f
Enroll
ListButtonOff_16_50_6ch
ar.psd
entry_coursecat
elog.gif
/images/ci/listbtns/entry_cour
secatalog.gif
Class
Catalog
Entry.psd
entry_createacc
ount.gif
/images/ci/listbtns/entry_creat
eaccount.gif
Create
Account
Entry.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 332
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
entry_login.gif
/images/ci/listbtns/entry_login.
gif
Login
Entry.psd
export_off.gif
/images/ci/listbtns/export_off.
gif
Export
ListButtonOff_16_50_6ch
ar.psd
grades_off.gif
/images/ci/listbtns/grades_off.
gif
Grades
ListButtonOff_16_50_6ch
ar.psd
grades_on.gif
/images/ci/listbtns/grades_on.
gif
Grades
ListButtonOn_16_50_6ch
ar.psd
join_off.gif
/images/ci/listbtns/join_off.gif
Join
ListButtonOff_16_50_6ch
ar.psd
layout_off.gif
/images/ci/listbtns/layout_off.g
if
Layout
ListButtonOff_16_50_6ch
ar.psd
listall_off.gif
/images/ci/listbtns/listall_off.gi
f
List All
ListButtonOff_16_50_6ch
ar.psd
login_off.gif
/images/ci/listbtns/login_off.gif
Login
ListButtonOff_16_50_6ch
ar.psd
manage_off.gif
/images/ci/listbtns/manage_of
f.gif
Manage
ListButtonOff_16_50_6ch
ar.psd
modify_off.gif
/images/ci/listbtns/modify_off.
gif
Modify
ListButtonOff_16_50_6ch
ar.psd
modify_on.gif
/images/ci/listbtns/modify_on.
gif
Modify
ListButtonOn_16_50_6ch
ar.psd
moduladmin_off.
gif
/images/ci/listbtns/modulead
min_off.gif
Module
Admin
ListButtonOff_16_90_14c
har.psd
ok_off.gif
/images/ci/listbtns/ok_off.gif
OK
FormButtonOff_20_69_1
3.psd
password_off.gif
/images/ci/listbtns/password_
off.gif
Password
ListButtonOff_16_50_6ch
ar.psd
preview_off.gif
/images/ci/listbtns/preview_off
.gif
Preview
ListButtonOff_16_50_6ch
ar.psd
properties_off.gi
f
/images/ci/listbtns/properties_
off.gif
Properties
ListButtonOff_16_90_14c
har.psd
recordings_off.gi
f
/images/ci/listbtns/recordings
_off.gif
Recording
s
ListButtonOff_16_90_14c
har.psd
remove_off.gif
/images/ci/listbtns/remove_off
.gif
Remove
ListButtonOff_16_50_6ch
ar.psd
remove_on.gif
/images/ci/listbtns/remove_on
.gif
Remove
ListButtonOn_16_50_6ch
ar.psd
rename_off.gif
/images/ci/listbtns/rename_off
.gif
Rename
ListButtonOff_16_50_6ch
ar.psd
reply_off.gif
/images/ci/listbtns/reply_off.gif
Reply
ListButtonOff_16_50_6ch
ar.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 333
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
request_off.gif
/images/ci/listbtns/request_off
.gif
Request
ListButtonOff_16_50_6ch
ar.psd
reset_off.gif
/images/ci/listbtns/reset_off.gi
f
Reset
ListButtonOff_16_50_6ch
ar.psd
search_off.gif
/images/ci/listbtns/search_off.
gif
Search
ListButtonOff_16_50_6ch
ar.psd
select_off.gif
/images/ci/listbtns/select_off.g
if
Select
ListButtonOff_16_50_6ch
ar.psd
tracking_off.gif
/images/ci/listbtns/tracking_off
.gif
Tracking
ListButtonOff_16_50_6ch
ar.psd
update_off.gif
/images/ci/listbtns/update_off.
gif
Update
ListButtonOff_16_50_6ch
ar.psd
view_off.gif
/images/ci/listbtns/view_off.gif
View
ListButtonOff_16_50_6ch
ar.psd
header_institutio
n.gif
/images/ci/logos/header_instit
ution.gif
Your
Institution
University
HeaderInstitution.gif
advanced_0.gif
/images/ci/misc/advanced_0.
gif
ADVANC
ED
Advanced_0.psd
advanced_1.gif
/images/ci/misc/advanced_1.
gif
ADVANC
ED
Advanced_1.psd
az_0.gif
/images/ci/misc/az_0.gif
STARTS
WITH
StartsWith_0.psd
az_1.gif
/images/ci/misc/az_1.gif
STARTS
WITH
StartsWith_1.psd
button_nav.jpg
/images/ci/misc/button_nav.jp
g
"Announce
ments,
Class
Information
, Teacher
Information
, Class
Document
s,
Assignmen
ts,
Communic
ation"
ButtonNav.psd
go.gif
/images/ci/misc/go.gif
GO!
GoRound.psd
go_btn_off.gif
/images/ci/misc/go_btn_off.gif
GO
GoSquare.psd
list_0.gif
/images/ci/misc/list_0.gif
LIST ALL
ListAll_0.psd
list_1.gif
/images/ci/misc/list_1.gif
LIST ALL
ListAll_1.psd
search_0.gif
/images/ci/misc/search_0.gif
SEARCH
Search_0.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 334
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
search_1.gif
/images/ci/misc/search_1.gif
SEARCH
Search_1.psd
search_btn_off.
gif
/images/ci/misc/text_nav.jpg
"Announce
ments,
Class
Information
, Teacher
Information
, Class
Document
s,
Assignmen
ts,
Communic
ation"
TextNav.psd
text_nav.jpg
/images/ci/misc/search_btn_o
ff.gif
Search
SearchSmall.psd
view30_0.gif
/images/ci/misc/view30_0.gif
VIEW
LAST 30
DAYS
ViewTab_24_115_Gray.p
sd
view30_1.gif
/images/ci/misc/view30_1.gif
VIEW
LAST 30
DAYS
ViewTab_24_115_White.
psd
view7_0.gif
/images/ci/misc/view7_0.gif
VIEW
LAST 7
DAYS
ViewTab_24_115_Gray.p
sd
view7_1.gif
/images/ci/misc/view7_1.gif
VIEW
LAST 7
DAYS
ViewTab_24_115_White.
psd
viewall_0.gif
/images/ci/misc/viewall_0.gif
VIEW ALL
ViewTab_24_115_Gray.p
sd
viewall_1.gif
/images/ci/misc/viewall_1.gif
VIEW ALL
ViewTab_24_115_White.
psd
viewday_0.gif
/images/ci/misc/viewday_0.gif
VIEW
DAY
ViewTab_24_115_Gray.p
sd
viewday_1.gif
/images/ci/misc/viewday_1.gif
VIEW
DAY
ViewTab_24_115_White.
psd
viewmonth_0.gif
/images/ci/misc/viewmonth_0.
gif
VIEW
MONTH
ViewTab_24_115_Gray.p
sd
viewmonth_1.gif
/images/ci/misc/viewmonth_1.
gif
VIEW
MONTH
ViewTab_24_115_White.
psd
viewtoday_0.gif
/images/ci/misc/viewtoday_0.
gif
VIEW
TODAY
ViewTab_24_115_Gray.p
sd
viewtoday_1.gif
/images/ci/misc/viewtoday_1.
gif
VIEW
TODAY
ViewTab_24_115_White.
psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 335
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
viewweek_0.gif
/images/ci/misc/viewweek_0.
gif
VIEW
WEEK
ViewTab_24_115_Gray.p
sd
viewweek_1.gif
/images/ci/misc/viewweek_1.
gif
VIEW
WEEK
ViewTab_24_115_White.
psd
viewyear_0.gif
/images/ci/misc/viewyear_0.gi
f
VIEW
YEAR
ViewTab_24_115_Gray.p
sd
viewyear_1.gif
/images/ci/misc/viewyear_1.gi
f
VIEW
YEAR
ViewTab_24_115_White.
psd
announceadd_o
ff.gif
/images/ci/toolbtns/announce
add_off.gif
Add
Announce
ment
AddAnnouncementButton
.psd
archiveadd_off.g
if
/images/ci/toolbtns/archivead
d_off.gif
Add
Archive
AddArchiveButton.psd
archivesearch_o
ff.gif
/images/ci/toolbtns/archivese
arch_off.gif
Search
Archive
SearchArchiveButton.psd
assessmentcop
y_add.gif
/images/ci/toolbtns/assessme
ntcopy_add.gif
Copy
Assessme
nt
CopyAssessmentButton.
psd
assessmentmod
ify_off.gif
/images/ci/toolbtns/assessme
ntmodify_off.gif
Modify
Assessme
nt
ModifyAssessmentButton
.psd
categoryadd_off
.gif
/images/ci/toolbtns/categorya
dd_off.gif
Add
Category
AddCategoryButtonBig.p
sd
contactadd_off.g
if
/images/ci/toolbtns/contactad
d_off.gif
Add
Contact
AddContactButton.psd
dataexprot_off.g
if
/images/ci/toolbtns/dataexport
_off.gif
Export
Data
ExportDataButtonBig.psd
discussionadd_
off.gif
/images/ci/toolbtns/discussion
add_off.gif
Discussio
n Board
DiscussionBoardButton.p
sd
emailcompose_
off.gif
/images/ci/toolbtns/emailcom
pose_off.gif
Compose
E-mail
ComposeEmailButton.ps
d
emaillogout_off.
gif
/images/ci/toolbtns/emaillogo
ut_off.gif
E-mail
Logout
EmailLogoutButton.psd
emailpreference
s_off.gif
/images/ci/toolbtns/emailprefe
rences_off.gif
E-mail
Preference
s
EmailPreferencesButton.
psd
fileadd_off.gif
/images/ci/toolbtns/fileadd_off
.gif
Add File
Add FileButton.psd
filesend_off.gif
/images/ci/toolbtns/filesend_o
ff.gif
Send File
SendFileButton.psd
filterchange_off.
gif
/images/ci/toolbtns/filterchang
e_off.gif
Change
Filter
ChangeFilterButton.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 336
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
folderadd
/images/ci/toolbtns/folderadd_
off.gif
Add
Folder
AddFolderButton.psd
forumadd_off.gif
/images/ci/toolbtns/forumadd_
off.gif
Add Topic
AddForumButton.psd
forumsearch_off
.gif
/images/ci/toolbtns/forumsear
ch_off.gif
Search
Topic
SearchForumButton.psd
groupadd_off.gif
/images/ci/toolbtns/groupadd_
off.gif
Add
Group
AddGroupButton.psd
itemadd_off.gif
/images/ci/toolbtns/itemadd_o
ff.gif
Add Item
AddItemButton.psd
lessonremove_o
ff.gif
/images/ci/toolbtns/lessonrem
ove_off.gif
Remove
Lesson
RemoveLessonButtonBig
.psd
print_off.gif
/images/ci/toolbtns/print_off.gi
f
Print
PrintButton.psd
profilecreate_off
.gif
/images/ci/toolbtns/profilecrea
te_off.gif
Create
Profile
CreateProfileButtonBig.p
sd
taskadd_off.gif
/images/ci/toolbtns/taskadd_o
ff.gif
Add Task
AddTaskButton.psd
threadadd_off.gi
f
/images/ci/toolbtns/threadadd
_off.gif
Add New
Thread
AddNewThreadButton.ps
d
threadremove_o
ff.gif
/images/ci/toolbtns/threadrem
ove_off.gif
Remove
Thread
RemoveThreadButton.ps
d
epi_edit.gif
/images/console/icons/epi_edi
t.gif
Edit
EditSmall.psd
header_institutio
n.gif
/images/console/logos/header
_institution.gif
Your
Institution
University
HeaderInstitution.gif
portal_tabs.gif
/images/console/misc/portal_t
abs.gif
active tab;
tab
PortalTabs.psd
db-addAdmin.gif
/images/db/db-addAdmin.gif
MODERA
TE
LightGrayButton.psd
db-archives.gif
/images/db/db-archives.gif
Archives
Archives.psd
db-back.gif
/images/db/db-back.gif
Back
Back.psd
dbbacktoarchives.
gif
/images/db/dbbacktoarchives.gif
Back to
Archives
BackToArchives.psd
dbbacktoforums.gif
/images/db/dbbacktoforums.gif
Back to
Topic View
BackToForumView.psd
db-backtolist.gif
/images/db/db-backtolist.gif
Back to
List
BackToList.psd
db-blockuser.gif
/images/db/db-blockuser.gif
BLOCK
LightGrayButton.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 337
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
db-cancel.gif
/images/db/db-cancel.gif
CANCEL
LightGrayButton.psd
db-closeall.gif
/images/db/db-closeall.gif
COLLAPS
E ALL
CollapseAll.psd
db-collect.gif
/images/db/db-collect.gif
Collect
WhiteButton.psd
db-config.gif
/images/db/db-config.gif
Config
WhiteButton.psd
dbcreatearchive.gif
/images/db/dbcreatearchive.gif
ADD
ARCHIVE
LightGrayButton.psd
dbcreateforum.gif
/images/db/db-createforum.gif
ADD
FORUM
LightGrayButton.psd
db-down.gif
/images/db/db-down.gif
Follow
PlainButton.psd
db-edit.gif
/images/db/db-edit.gif
Edit
Edit.psd
dbhideoptions.gif
/images/db/db-hideoptions.gif
HIDE
OPTIONS
HideOptions_Folder.psd
db-load.gif
/images/db/db-load.gif
Go to
Message
FormButtonOff_20_110_
13.psd
db-lock.gif
/images/db/db-lock.gif
Lock
WhiteButton.psd
db-lockededit.gif
/images/db/db-lockededit.gif
Edit
LockedEdit.psd
dblockedremove.gi
f
/images/db/dblockedremove.gif
Remove
LockedRemove.psd
dblockedresponse.
gif
/images/db/dblockedresponse.gif
Respond
LockedResponse.psd
db-markread.gif
/images/db/db-markread.gif
Mark
Read
WhiteButton.psd
dbmarkunread.gif
/images/db/db-markunread.gif
Mark
Unread
WhiteButton.psd
db-modify.gif
/images/db/db-modify.gif
Modify
LightGrayButton.psd
db-newonly.gif
/images/db/db-newonly.gif
New-Only
VIEW
PlainBorderTopBottom.ps
d
dbnewthread.gif
/images/db/db-newthread.gif
Start New
Thread
StartNewThread.psd
db-next.gif
/images/db/db-next-off.gif
Next
Message
NextMessage.psd
db-next-off.gif
/images/db/db-next.gif
Next
Message
NextMessage2.psd
db-openall.gif
/images/db/db-openall.gif
EXPAND
ALL
ExpandAll.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 338
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
db-opennew.gif
/images/db/db-opennew.gif
VIEW
UNREAD
MESSAGE
S
ViewUnreadMessages.ps
d
db-opennow.gif
/images/db/db-openown.gif
Open to
Own Msgs
PlainBorderTopBottom.ps
d
dboptionremove.gif
/images/db/dboptionremove.gif
Remove
WhiteButton.psd
db-page-first.gif
/images/db/db-page-first.gif
First
FirstPage.psd
db-page-last.gif
/images/db/db-page-last.gif
Last
LastPage.psd
db-page-next.gif
/images/db/db-page-next.gif
Next
NextPage.psd
db-page-prev.gif
/images/db/db-page-prev.gif
Prev
PrevPage.psd
dbpostmessage.gif
/images/db/dbpostmessage.gif
Publish
PlainButton.psd
db-prev.gif
/images/db/db-prev-off.gif
Previous
Message
PreviousMessage.psd
db-preview.gif
/images/db/db-prev.gif
Previous
Message
PreviousMessage2.psd
db-prev-off.gif
/images/db/db-preview.gif
PREVIEW
LightGrayButton.psd
db-publish.gif
/images/db/db-publish.gif
Publish
Publish.psd
db-remAdmin.gif
/images/db/db-remAdmin.gif
NORMAL
LightGrayButton.psd
db-remove.gif
/images/db/db-remove.gif
REMOVE
LightGrayButton.psd
db-respond.gif
/images/db/db-respond.gif
REPLY
LightGrayButton.psd
db-save.gif
/images/db/db-save.gif
SUBMIT
LightGraySubmit.psd
db-search.gif
/images/db/db-search-go.gif
SEARCH
Search.psd
db-search-go.gif
/images/db/db-search.gif
Search
LightGrayButton.psd
dbsearchmail.gif
/images/db/db-searchsmall.gif
SEARCH
Search_Q.psd
db-selectall.gif
/images/db/db-selectall.gif
Select All
WhiteButton.psd
dbselectinvert.gif
/images/db/db-selectinvert.gif
Invert
WhiteButton.psd
dbshowoptions.gif
/images/db/dbshowoptions.gif
SHOW
OPTIONS
ShowOptions_Folder.psd
db-skipdn.gif
/images/db/db-skipdn.gif
Skip
SkipDown.psd
db-skipup.gif
/images/db/db-skipup.gif
Skip
SkipUp.psd
db-standard.gif
/images/db/db-standard.gif
VIEW ALL
MESSAGE
S
ViewMessages.psd
2007 Blackboard Inc. Proprietary and Confidential.
Page 339
Blackboard K–12 Academic Suite
©
Administrator Manual
F i l e N a me
D irect or y Pat h
T ext
T e mp la t e
db-threaded.gif
/images/db/db-threaded.gif
Threaded
View
PlainBorderTopBottom.ps
d
dbunblockuser.gif
/images/db/db-unblockuser.gif
UNBLOC
K
LightGrayButton.psd
db-unlock.gif
/images/db/db-unlock.gif
UNLOCK
WhiteButton.psd
db-unselect.gif
/images/db/db-unselectall.gif
Unselect
All
WhiteButton.psd
db-up.gif
/images/db/db-up.gif
Back
PlainButton.psd
s2.gif
/images/db/s2.gif
New
New.psd
s3.gif
/images/db/s3.gif
New
NewLock.psd
tiny_back.gif
/images/db/tiny_back.gif
Back
Back.psd
picker.gif
/images/swatches/picker.gif
Pick
ListButtonOff_16_80_12c
harPicker
2007 Blackboard Inc. Proprietary and Confidential.
Page 340
Blackboard K–12 Academic Suite
Administrator Manual
Edit Images
Overview
There is a specific process translators must use to edit and save images. This process includes
the following steps:
•
edit the image using a template
•
resize the image (only if necessary)
•
save the image in the correct format and to the correct location
This section assumes that all work is being done in Adobe Photoshop.
Create an Image
Follow the steps below to create an image from a template:
1.
Select an image to translate.
2.
Choose the corresponding template from the Image Template table.
3.
Open the template in Adobe Photoshop.
4.
Use the Text Tool to select the text in the image that will be translated.
5.
Enter the correct text (writing over the text that appears in the template).
6.
If the translated text fits on the template, resizing is not necessary; move on to the Saving
Images section. If the translated text does not fit on the template, see the section below,
Resizing Images.
Resizing Image
Resizing images may cause issues with inconsistency and rendering; therefore, images should
only be resized if the translated text does not fit on the template. Some templates also have
larger sizes to accommodate longer strings of text.
If resizing is necessary, try to keep the size of images that are changed consistent. This is more
user-friendly and avoids layout issues in the UI. It is important that translators use the process
documented below to resize images. Do not resize images by directly changing the Image Size
Setting or by using the Scale tool to drag the image and create a larger size.
Some images cannot be resized; these images are noted in the Image Template table. If an
image cannot be resized, use one of the following workarounds:
•
Use a shorter term or phrase when translating the text
•
Change the size of the font to allow the text to fit on the image
Follow the steps below to resize an image:
Note: If possible, only change the width of the image to accommodate the text;
only adjust the height if it is necessary.
1.
©
Open the image in Adobe Photoshop.
2007 Blackboard Inc. Proprietary and Confidential.
Page 341
Blackboard K–12 Academic Suite
Administrator Manual
2.
Click Image in the Action Bar, and then select Canvas Size. This opens the Canvas Size
panel.
3.
Select Pixels for the Width and Height options.
4.
Make the canvas large enough to fit the text by increasing the values for Width and
Height. Close the Canvas Size panel.
5.
Check that the layer with the image background is selected as the working layer.
6.
Use the Move tool to move the image to the left side of the canvas.
7.
Use the Marquee tool to select the right half of the image.
8.
Use the Move tool to move the selected half of the image to the right side of the canvas.
9.
Use the Marquee tool to select a portion of the image from the middle of the right half of
the image. Check that the selection goes from the top to the bottom of the image and is
only a few pixels wide.
10. Select the Move tool again. In the Action Bar select Edit > Transform > Scale. This will
allow you to scale the selected portion of the image.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 342
Blackboard K–12 Academic Suite
Administrator Manual
11. Select the left anchor on the selected area and drag it to the left until it meets the left half
of the image.
12. Commit the scale and deselect the image.
13. Reposition the text layer over the image.
Saving Images
The final step in translating an image is saving it to the correct location, with the correct file name.
Follow the steps below to save an image:
1.
Note the file type of the image; this information is included in the Image Template table.
2.
In the Adobe Photoshop Action Bar, select File > Save for Web.
3.
Choose the correct file format from the Optimized File Format drop-down list. All files
are either JPEG or GIF.
4.
Optimize the file using the following guidelines: JPEG – Set Quality to 60 and Blur to
0.GIF – Set Colors to 64 and check the Transparency option.
5.
Click Save.
6.
In the Language Pack, find for the location of the image file. This information is stored in
the Image Template table.
7.
Either select the file name in the Save window or re-enter the existing file name. The file
name and extension are case sensitive and must exactly match the name of the existing
file.
8.
Click Save in the Save window.
9.
A text string appears asking if you would like to replace the existing file. Click Replace to
overwrite the existing file with the translated one.
10. Close the template.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 343
Blackboard K–12 Academic Suite
Administrator Manual
Image Troubleshooting
Overview
Translators may run into several different scenarios when translating images. These scenarios,
and steps for remedying them, are outlined in this topic.
Troubleshooting scenarios
Scenario #1
Issue: An image file is saved as the wrong name. If this happens, the Blackboard application
points to the original, non-translated version of the image.
Solution: Resave the image file, replacing the original one. Match the file name exactly to that of
the original file.
Scenario #2
Issue: An image file is saved with the wrong format or extension. If this happens, the Blackboard
application points to the original, non-translated version of the image.
Solution: Resave the image file in the correct format.
Scenario #3
Issue: An image file is accidentally deleted. If this happens, the Blackboard application cannot
find the image and a broken image indicator appears in the UI.
Solution: Recreate the image file using the Image Template. Save the new image with the
appropriate file name to the correct location in the directory.
Untranslated Browse button
The Browse button is used throughout the application to allow users to search for files. The text
that appears on this button is not controlled by Blackboard, but rather by the operating system or
browser. Users will find that the text on this image does not always appear in that of the
Language Pack, but may appear in the language associated with their operating system or
browser.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 344
Blackboard K–12 Academic Suite
Administrator Manual
User Manuals
Overview
Blackboard provides a ZIP file of the user manuals that may be translated when creating a new
Language Pack. This ZIP file is available in the Language Packs Catalog. As with the rest of the
application, the user manuals require maintenance when the system is upgraded.
These ZIP files include both Macromedia© RoboHelp files and Microsoft© Word files.
Translators may use Macromedia© RoboHelp, or any other authoring tool, to translate these
manuals.
Note: A separate agreement in the Learning Pack Catalog must be accepted to
gain access to the user manuals.
User manuals
Blackboard provides four user manuals that are accessed from within the system. They are as
follows:
•
User Manual – Available from the Class Menu. Explains the Blackboard Learning
System and Blackboard Community System functionality from the user’s perspective.
•
Blackboard Content System User Manual – Available from the Blackboard Content
System menu. Explains the Blackboard Content System functionality from the user’s
perspective.
•
Teacher Manual – Available from the Control Panel. Explains all features and
functionality available within a Class or Organization.
•
Administrator Manual – Available from the Administrator Panel. Explains how to manage
the Blackboard K-12 Suite using the Administrator Panel.
Redirecting links to the user manuals
The Language Pack creator hosts the user manuals on a server, where they may be accessed by
users through links in the application. The URLs that point to these documents are updated in the
documentation.properties file. If new URLs are not added to this file, the links within the
application will point to the user manuals included with the copied or imported Language Pack.
The following table explains the keys that appear in the documentation.properties file and the
information that should be entered in the text string:
©
Ke y
Descript ion
documentation.href.online_admin
Enter the URL for the Blackboard K-12 Suite
Administrator Manual.
documentation.href.cp_online_manual
Enter the URL for the Blackboard K-12 Suite
Teacher Manual.
2007 Blackboard Inc. Proprietary and Confidential.
Page 345
Blackboard K–12 Academic Suite
©
Administrator Manual
Ke y
Descript ion
documentation.href.student_manual
Enter the URL for the Blackboard K-12 Suite User
Manual.
documentation.href.cs_manual
Enter the URL for the Blackboard Content System
User Manual.
2007 Blackboard Inc. Proprietary and Confidential.
Page 346
Blackboard K–12 Academic Suite
Administrator Manual
Blackboard Backpack
Overview
This section covers the Blackboard Backpack tool.
In this section
The following topics cover the Blackboard Backpack.
©
T op i c
Descript ion
Blackboard Backpack
Availability
This topic covers how to make the Blackboard Backpack
available for users.
Configure Blackboard
Backpack
This topic covers how to configure Blackboard Backpack
features.
Add Download Control
This topic covers the Add Download Control function.
2007 Blackboard Inc. Proprietary and Confidential.
Page 347
Blackboard K–12 Academic Suite
Administrator Manual
Blackboard Backpack Availability
Overview
Administrators can manage the availability of Blackboard Backpack from the Blackboard
Backpack Availability page. The availability of Blackboard Backpack links and the Blackboard
Backpack synchronization tool may be managed separately.
Find this page
Follow these steps to access the Blackboard Backpack Availability page.
1.
Open the Administrator Panel.
2.
Click Blackboard Backpack under Tools and Utilities.
3.
Click Blackboard Backpack Availability..
Fields
F i e ld
Descript ion
Blackboard Backpack Links Availability
Display
Blackboard
Backpack
Links
Select Yes to display links and buttons in the application to download the
Blackboard Backpack. If enabled, links appear on the Login page and the
Login module and buttons appear on the Login page and the Gateway
page. This option does not enable and disable the Blackboard Backpack
module. The module may be enabled or disabled from Manage Modules.
Blackboard Backpack Tool Availability
Enable
Blackboard
Backpack
©
Select Yes to make the synchronization tool available to users. This tools
allows them to synchronize their Blackboard Backpack with the Blackboard
application.
2007 Blackboard Inc. Proprietary and Confidential.
Page 348
Blackboard K–12 Academic Suite
Administrator Manual
Configure Blackboard Backpack
Overview
The Configure Blackboard Backpack page allows Administrators to control synchronization. From
this page, Administrators can add Download Controls. A Download Control allows the
Administrator to control download traffic during peak hours, ensuring that the Institution’s
Blackboard server is not clogged with download requests when it is most used. Administrators
may create multiple Download Controls, as long as the time period for each Download Control
does not overlap. For example, the Administrator may not create a control that limits file
downloads on Mondays from 8am to 5pm, and then create another control that limits file
downloads on Mondays from 4pm to 8pm.
Find this page
Follow these steps to access the Configure Blackboard Backpack page.
1.
Open the Administrator Panel.
2.
Click Blackboard Backpack under Tools and Utilities.
3.
Click Configure Blackboard Backpack..
Functions
The following functions appear on the Configure Blackboard Backpack page.
©
To . . .
click . . .
add a download control
Add Download Control. The Add Download Control page
appears.
clear the current Download
Controls
Reset All. All Download Controls are removed.
remove a Download Control
Remove next to the appropriate Download Control.
2007 Blackboard Inc. Proprietary and Confidential.
Page 349
Blackboard K–12 Academic Suite
Administrator Manual
Add Download Control
Overview
A Download Control allows the Administrator to control download traffic during peak hours for the
Blackboard Backpack synchronization tool This ensures that the Institution’s Blackboard server is
not clogged with download requests when it is most used.
This page refers to files and packets. A file refers to the content downloaded from Blackboard
during a synchronization. Each file is divided into packets by the system; for example, if the
packet size is set to 10 Kb, a 100Kb file is divided into 10 packets. This ensures a smooth
synchronization and prevents the Blackboard server from becoming overburdened.
Find this page
Follow these steps to access the Add Download Control page.
1.
Open the Administrator Panel.
2.
Click Blackboard Backpack under Tools and Utilities.
3.
Click Configure Blackboard Backpack..
4.
Click Add Download Control.
Fields
F i e ld
Descript ion
General Properties
Title [r]
Enter a name for the Download Control
Day of Week
[r]
Use the drop-down list to select the day of the week this Download Control
will be enforced.
Start Time [r]
Select the time of day the Download Control begins.
End Time [r]
Select the time of day the Download Control ends.
Maximum File Size
File size
(KB)[r]
Enter the maximum size file that can be automatically download. If a file
exceeds this limit, the user is prompted and asked whether or not the file
should be downloaded. The default is -1; this indicates a unlimited size.
Time Between files
File Wait
(seconds)[r]
Enter the number of seconds the synchronization tool waits between files.
This helps to ensure the server is not overloaded. The default is 5 seconds.
Maximum Packet Size
Packet Size
(Kb)[r]
Enter the maximum size of a packet in kilobytes. The default is 1024 kb ( ~1
Mb).
Time Between packets
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 350
Blackboard K–12 Academic Suite
©
Administrator Manual
F i e ld
Descript ion
Packet Wait
(ms)[r]
Enter the amount of time, in milliseconds, that the server waits between
downloading packets. The default is 200 milliseconds.
2007 Blackboard Inc. Proprietary and Confidential.
Page 351
Blackboard K–12 Academic Suite
Administrator Manual
Security
Overview
This part of the Blackboard K-12 Suite Administrator Manual details the security features on the
Administrator Panel. There are also several topics in this part of the manual that detail
administrative tasks and features that are used outside of the Administrator Panel.
This part includes the following sections.
©
S e ct io n
Descript ion
Security Options
This section details the features for securing connections that pass
sensitive data to and from the Blackboard K-12 Suite.
Customize the Login
and Gateway Pages
This section details the tools and the process for customizing the
appearance and available functions of the Login and Gateway
pages.
Domains
This section explains how to delegate administration of Classes,
users, modules, tabs, and brands.
2007 Blackboard Inc. Proprietary and Confidential.
Page 352
Blackboard K–12 Academic Suite
Administrator Manual
Security Options
Overview
This section describes the SSL feature available on the Administrator Panel and explains how to
integrate the system with Shibboleth.
In this section
Security includes the following topics.
©
T op i c
Descript ion
SSL Choice
This topic covers the SSL Choice page. Before making any changes to the
SSL Choice settings the Administrator must configure the IIS or Apache™
Web server for SSL.
Shibboleth
Integration
This topic explains how to set up Shibboleth with the Blackboard K-12
Suite,
2007 Blackboard Inc. Proprietary and Confidential.
Page 353
Blackboard K–12 Academic Suite
Administrator Manual
SSL Choice
Overview
If IIS (Windows) or Apache (UNIX) is configured to support SSL, then the communication
between users and the Blackboard K-12 Suite can be configured using the SSL Choice feature.
SSL Choice allows Administrators to determine if none, all, or some of the Blackboard K-12 Suite
is secured with SSL.
SSL Choice is not available with the Blackboard Learning System - Basic Edition.
Note: If the SSL Choice is set to use SSL before SSL is configured in IIS or
Apache the Blackboard K-12 Suite will not be accessible! To ensure that users
can always login, configure IIS or Apache for SSL prior to changing the security
options on the SSL Choice page. Please see the Blackboard K-12 Suite Setup
Guide for your operating system to learn how to install and configure SSL.
If planning on using SSL, Blackboard recommends enforcing SSL on the entire system. This
ensures that all proprietary data is secured. If the choice option is chosen, it is important to
update SSL settings whenever a new tool is enabled or a Building Block added.
Find this page
Select SSL Choice on the Administrator Panel.
Fields
The table below details the fields on the SSL Choice page.
F i e ld
Descript ion
Entire System
Disable SSL
System-wide
Select this option and SSL will not be used to secure any of the
communication between users and the Blackboard K-12 Suite.
Enable SSL
System-wide
Select this option and SSL will be used to secure all of the
communication between users and the Blackboard K-12 Suite.
Enable SSL for
the following
areas
Select this option to determine which areas of the Blackboard K-12
Suite will be secured through SSL. Select the different areas from the
check boxes on this page.
System Specific Areas
Select the check box for each area that should be secured using SSL.
Blackboard Tools
Select the check box for each tool, tab, or Class content area that should be secured using
SSL.
Building Block Tools
Select the check box for each Building Block that should be secured using SSL.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 354
Blackboard K–12 Academic Suite
Administrator Manual
Shibboleth Integration
Overview
The Shibboleth initiative is developing an open, standards-based solution to meet the needs for
organizations to exchange information about their users in a secure, and privacy-preserving
manner. This document offers a brief overview of Shibboleth and explains how it is installed on
the Blackboard K-12 Suite.
Shibboleth allows organizations to exchange information about users securely and privately.
Shibboleth is designed to provide a way for a person using a web browser (for example, Internet
Explorer or Netscape Navigator,) accessing a target site to be authorized to access a target site
using information housed at the user's security domain. This permits users to access controlled
information securely from anywhere without additional passwords, or needlessly compromising
privacy. For example, if a Student is taking classes at two universities, and both schools use
Shibboleth, the Student may have a single user name and password to access information at
both universities’ Web sites.
Shibboleth is fully supported as a custom authentication option for the Blackboard K-12 Suite on
UNIX operating systems. Due to the experimental nature of the underlying Shibboleth
technologies, and limited operational expertise available for Shibboleth, Blackboard recommends
customers consider running a restricted, pilot implementation on a test or development server
before making this feature generally available on their system.
Note: The Blackboard Backpack client application does not support Shibboleth
authentication.
Installing Shibboleth
The following section explains how to install Shibboleth and how to set up Shibboleth with the
Blackboard K-12 Suite. These instructions only apply to setting up the Blackboard K-12 Suite as a
Shibboleth target.
Note: Shibboleth has only been tested with the Blackboard K-12 Suites on UNIX
Operating Systems.
Part I – Installation
©
1.
Install Blackboard K-12 Suite and enable OpenSSL.
2.
Configure SSL for Blackboard Learning System. Save the certificate files under
blackboard/apps/httpd/conf/certs/. These are formatted as .cer, .crt and .key.
3.
Download the correct Shibboleth package for the operating system and install it. The
package is located at http //shibboleth.internet2.edu/.
4.
Follow the Shibboleth v1.1 instructions to install the package. Check that the most current
libraries are installed. The Shibboleth directions contain detailed instructions for updating
2007 Blackboard Inc. Proprietary and Confidential.
Page 355
Blackboard K–12 Academic Suite
Administrator Manual
libraries. The Institution needs a signed CA certificate, for example, from Verisign. This is
the same certificate used for SSL.
Part II – Configure Shibboleth and Blackboard Learning System
1.
Edit the blackboard/apps/httpd/conf/httpd.conf to include the
/opt/shibboleth/etc/shibboleth/apache.config file. This step must be repeated when
PushConfigUpdates is run. PushConfigUpdates may overwrite this setting.
2.
Add the following to apache.config in the Shibboleth file system. This instructs
Shibboleth to protect all files beginning with ‘/webapps’. The apache.confing and.ini files
are located in /opt/shibboleth/etc/shibboleth
<Location /webapps>
AuthType shibboleth
require affiliation ~ ^m[email protected]+$
# This rule below accepts any valid principal name passed from the
Origin.
require user ~ ^.+$
</Location>
3.
The value of the “require” directive is dependent on the Attribute Acceptance and
Attribute Release Policies for the Target and Origin, respectively. Check with the
Shibboleth federation administration for details on what attributes will be released to your
Target.
4.
Add the following custom attributes to apache.config ShibMapAttribute urn mace dir
attribute-def eduPersonPrincipalName Shib-EP-BBUSER-NAMEIf you configure AJP13
as the Apache/Tomcat protocol, you may omit this value. Edit the Blackboard Tomcat
server.xml to use AJP13 as the connector protocol. This should be done using the
Ajp13Connector configuration. The AJP12 protocol readers in Tomcat have a bug that
prevents REMOTE_USER from being properly propagated to Tomcat from Apache.
Additionally, the Coyote connectors have not been tested with Shibboleth. For example
(make sure you’ve disabled any other listeners that may be listening on the same port)
<Connector className="org.apache.ajp.tomcat4.Ajp13Connector"
port="8009"
minProcessors="50"
maxProcessors="100"
tomcatAuthentication="false"/>
5.
Edit /opt/shibboleth/etc/shibboleth/shibboleth.ini file to point to the correct WAYF server.
Shibboleth should default to the correct location wayfURL = http
//servername.blackboard.com 8080/shibboleth/HS
Point to the location of the certificate file, the key file, calist and the password (omit the line
breaks after the ‘=’)
certfile= /usr/local/blackboard/apps/httpd/conf/certs/server.crt
keyfile= /usr/local/blackboard/apps/httpd/conf/certs/server.key
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 356
Blackboard K–12 Academic Suite
Administrator Manual
calist=/usr/local/blackboard/apps/httpd/conf/certs/qa-b64.cer
keypass=‘password’
6.
Add PEM-encoded HS certificate to the trust.xml file in /opt/shibboleth/etc/shibboleth.
This certificate is the one created as the signing certificate of the origin.
<KeyAuthority>
<ds: KeyInfo>
<ds: X509Data>
<ds: X509Certificate>
Add PEM-encoded HS here
.
.
</ds: X509Certificate>
</ds: X509Data>
</ds: KeyInfo>
<Subject>qamigl2.qa.dc.blackboard.com</Subject>
</KeyAuthority>
7.
Change the authentication type in Blackboard the Blackboard bb-config.properties
file. bbconfig.auth.type=shib
8.
Uncomment all the Shibboleth Authentication Properties in the Blackboard
authentication.properties file.
9.
Edit site.xml file under /opt/shibboleth/etc/shibboleth to point to a valid origin server. See
example below.
<OriginSite Name="qamigl2.qa.dc.blackboard.com">
<Alias>Blackboard QA Testing Origin</Alias>
<Contact Type="technical" Name="John Doe" Email="[email protected]"/>
<HandleServiceLocation="http://qamigl2.qa.dc.blackboard.com
8080/shibboleth/HS" Name="qamigl2.qa.dc.blackboard.com"/>
<Domain>qa.dc.blackboard.com</Domain>
</OriginSite>
10. Start the shar executable on the Shibboleth server /opt/shibboleth/bin/shar -f
11. Restart the Blackboard web services
/usr/local/blackboard/tools/admin/ServiceController.sh services.restart
Certificates and keys
The following information explains certificates that are needed for Shibboleth.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 357
Blackboard K–12 Academic Suite
Administrator Manual
•
The certificate must be signed by an authority.
•
If a Test Certificate is used, then the Administrator must coordinate with representatives
from Shibboleth to be added to the trusted list of Institutions (this is referred to as In
Queue)
User Login
Users of a system that participates in Shibboleth will go through the following steps to login
©
1.
Click Login on the Blackboard Learning System Login page.
2.
Choose the Institution from the drop-down list.
3.
Enter login and password information and click Login.
4.
Users may enter the URL for another Institution that participates in Shibboleth and enter
that school’s Web site.
2007 Blackboard Inc. Proprietary and Confidential.
Page 358
Blackboard K–12 Academic Suite
Administrator Manual
Customize the Login and Gateway Pages
Overview
This section describes the tools for customizing the appearance and available features on the
Login and Gateway pages.
In this section
Customize the Login and Gateway Pages includes the following topics.
©
T op i c
Descript ion
Login Page
Customization
This topic covers the Login Page Customization page and the process
for customizing a Login page.
Gateway Page
Customization
This topic covers the process for customizing the appearance of the
Gateway page.
System Settings
This topic covers the System Settings page. This page includes
settings for managing the features on the Login page.
Gateway Options
This topic covers the Gateway Options page. This page includes
settings for managing the features that appear on the Gateway page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 359
Blackboard K–12 Academic Suite
Administrator Manual
Login Page Customization
Overview
Administrators can download Login Page Templates supplied with Blackboard K-12 Suite and
configure them for their system. If a Login Page Template breaks, or is not appropriate for the
Institution, the default Login page can be restored so that users can access the system with
minimal interruption.
Find this page
Click Customize Login Page on the Administrator Panel.
Functions
The following functions are accessible through the Login Page Customization page
To . . .
click . . .
download a
template for the
Login page
Download Login Page Template. The template download will begin.
upload a
customized Login
page
Upload Customized Login Page. The Upload Customized Login page
will appear. From this page the path to a customized Login page is
entered. The customized Login page is then uploaded and set as the
Login page.
reset the Login
page to the
default
Reset to Default Login Page. The Login page will be set to the default.
Create a customized Login page
Follow these steps to create a customized Login page.
©
1.
Go to the Administrator Panel.
2.
Click Customize Login Page on the Administrator Panel.
3.
Click Download Login Page Template.
4.
A download window Web browser will appear. If a download window does not appear,
right-click on Download Login Page Template and choose the Save Target As. . .
option.
5.
The “login” file will be saved to the directory.
6.
Open the “login” file with a text editor.
7.
The colors, appearance of text, and the text itself can be edited. It is also possible to
create a link to an image.
8.
Save the “login” file with the same file name.
9.
Login into Blackboard Learning System and go to the Administrator Panel.
2007 Blackboard Inc. Proprietary and Confidential.
Page 360
Blackboard K–12 Academic Suite
Administrator Manual
10. Click Customize Login Page on the Administrator Panel.
11. Click Upload Customized Login Page.
12. Enter the path to the new “login” file in the File field. If you do not know the exact path,
click Browse to search for the file.
13. Logout and test the new Login page.
14. If the page fails and you are unable to login in, enter the following address in your Web
browser to bring up the default login page: http
//domain_name.host_name/webapps/login?action=default_login. After logging in, return
to Customize Login Page and click the link to restore the default Login page. This will
allow users to once again login.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 361
Blackboard K–12 Academic Suite
Administrator Manual
Gateway Page Customization
Overview
The Gateway page is the first page that users see when accessing the Blackboard K-12 Suite
(unless the Administrator opts to use Portal Direct Entry). The Gateway page includes the
following buttons
•
Login: Directs the user to the Login page.
•
Class Catalog: Directs the user to the Class Catalog. This button may be disabled by
the Administrator.
•
Create Account: Directs the user to the Create Account page. This button may be
turned off by the Administrator. This button should be turned off unless the Administrator
wants anyone with access to the URL to create accounts.
•
Download Bbackpack: Directs user to Bbackpack, where this application may be
downloaded by users. This button may be disabled by the Administrator.
The Gateway page also includes a default welcome message and image from Blackboard Inc.
Note: The Gateway page must be customized by editing the gateway.bb file in
the branding directory for each Virtual Installation
Customize the buttons on the Gateway page
To customize the buttons on the Gateway page please see Gateway Options.
Customize the welcome message and image
The welcome message and image can be customized by replacing an HTML fragment in the file
system. It is possible for each Virtual Installation to have its own customized welcome message
and image. Follow the steps below to replace the HTML fragment that generates the welcome
message and image with one customized for the Institution.
©
1.
Access the URL for the Virtual Installation and verify that the Gateway page appears.
2.
Within the blackboard file system change directories to /content/vi/vi_ID/branding. Where
vi_ID is the name of the Virtual Installation.
3.
Save a copy of the gateway.bb file so that it can be restored to the default.
4.
Edit or replace the gateway.bb file with another HTML fragment.
5.
Access the URL for the Virtual Installation and verify that the welcome message and
image appear as desired.
2007 Blackboard Inc. Proprietary and Confidential.
Page 362
Blackboard K–12 Academic Suite
Administrator Manual
System Settings
Overview
The System Settings page controls the availability of two features: Allow Guest Access and
Forgotten Password.
Allowing Guest Access will enable anyone to access the system. If Guest Access is allowed in
Classes and Organizations, then these users may view the portions of any Classes or
Organizations that are not secured against Guest access by the Teacher or Leader. Guests will
see the portal content available to the Institution Role of Guest and have system access as the
Administrative User Role of Guest.
Note: It is also possible to create users with an Administrative User Role of
Guest. By doing so, the Administrator can control Guest access by requiring all
Guests to obtain that Username and password for a Guest account
The Forgotten Password feature enables a link on the Login page that will direct Users to a page
where the password for their account can be requested. The password will be sent to the email
address associated with the User account. It is also possible to set the link to another URL. This
is useful if using an Authentication method other than the default Blackboard K-12 Suite
challenge and response. For example, if LDAP is configured as the Authentication method then
the link can be directed to a page connected to the LDAP server. The URL can be configured on
the Gateway Options page.
Find this page
Click System Settings on the Administrator Panel.
Fields
The table below details the fields on the Integration Password page.
F i e ld
Descript ion
Guest Access
Allow Guest
Access
Select Allow and users who do not have an account (nonauthenticated users) may access the system, such as portal areas.
Select Do Not Allow and users without an account will not have any
access to the system.
Allow Guest
Access to Classes
Select Allow and users who do not have user accounts (nonauthenticated users) may access Classes on the system. If Do Not
Allow is selected, Teachers will not be able to make areas in their
Classes available to Guests.
Allow Guest
Access to
Organizations
Select Allow and users who do not have user accounts (nonauthenticated users) may access Organizations. If Do Not Allow is
selected, Leaders will not be able to make areas in their Organizations
available to Guests.
Forgotten Password
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 363
Blackboard K–12 Academic Suite
F i e ld
Administrator Manual
Descript ion
Select Allow under Forgotten Password to enable the link that allows users to request that
the password for the account.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 364
Blackboard K–12 Academic Suite
Administrator Manual
Gateway Options
Overview
Several of the buttons and options on the Gateway Page and the Login page can be customized.
The Gateway page is the first page users typically see when accessing Blackboard K-12 Suite. It
can include buttons for creating an account and allowing anyone to browse the Catalog.
For security and data integrity reasons, it is not recommended that users be allowed to create
accounts.
The Gateway page can be bypassed completely and site visitors will be taken directly to the
portal as a Guest. Users can then login using the Login button in the header frame. The Gateway
Options page also includes an option for changing the URL that handles User requests for lost
passwords.
Find this page
Click Gateway Options on the Administrator Panel.
Fields
The table below details the fields on the Gateway Options page.
F i e ld
Descript ion
Enable Class Catalog on Gateway
Class Catalog
on Gateway
Select Enable to display a button that links to the Class Catalog on the
Gateway page.
Enable New User Account Creation on Gateway
User Account
Generation on
Gateway
Select Enable to display a button on the Gateway page that lets visitors
create a User account. The User account is created with a Institution Role
of Student and an Admin User Role of None.
Set URL for Forgotten Password
URL for
Forgotten
Password
If using an authentication system other than the standard Blackboard
Learning System challenge-response, the URL to a page where users can
request a forgotten password can be set here. When entering a URL, be
sure to enter the URL completely, for example, http
//www.blackboard.com and not www.blackboard.com or blackboard.com.
Enable Direct Access
Direct Access
©
Select Enable to skip the Gateway page entirely and send site visitors
directly to the portal as guests. Users can login using the button in the
header frame. If this setting is changed from Enable to Disable, please
restart the server to avoid experiencing errors.
The Login Module may only be enabled if Portal Direct Entry is enabled.
2007 Blackboard Inc. Proprietary and Confidential.
Page 365
Blackboard K–12 Academic Suite
Administrator Manual
Note: Portal Direct Entry is only available to users with the Blackboard
Community System.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 366
Blackboard K–12 Academic Suite
Administrator Manual
Domains
Overview
This section details the features for managing the Administrator privileges assigned to users.
In this section
This section includes the following topics.
©
T op i c
Descript ion
Introduction to Domains
This topic provides an overview of Domains.
Structuring a Flexible and Secure
Administration Model using
Domains
This topic covers the decisions that an Administrator
must make when setting up Domains.
Create Domains
This topic explains how to create a new Domain.
Define a Collection
This topic explains how to define a Collection within a
Domain.
Setup Domain Administrators
This topic explains how to apply System Roles to
users within a Domain to define Domain Administrator
privileges.
2007 Blackboard Inc. Proprietary and Confidential.
Page 367
Blackboard K–12 Academic Suite
Administrator Manual
Introduction to Domains
Overview
Domains offer a customizable, flexible, and secure system administration model. Domains gather
Classes,Organizations, users, tabs, and modules into defined sets called collections. Each
domain can have one or many collections. Once established, administration of a domain is
controlled by assigning System Roles to users that only apply to that domain.
For example, administration of all the users in the Law School can be assigned to Law School
staff and administration of all the users in the Business School can be assigned to Business
School staff.
The above example is a simple one. Since privileges, at the feature and function level, can be
used to define unlimited System Roles, there is a limitless variety to how System Roles are
applied to domains. The flexibility of domains means that planning the administration model is a
critical step. Please contact your account manager for information about engaging Blackboard
Global Services with assistance in planning and implementing an administration model.
What domains can do
The following lists some of the goals that can be accomplished with domains:
•
Organize users, Classes, Organizations, tabs, and modules into groupings.
•
Delegate administration of users, Classes,Organizations, tabs, and modules.
•
Assign different administrative responsibilities to different staff members within a
domain.
•
Control Domain Administrators' access to specific features within a domain by defining
privileges.
What domains are not designed to do
The following lists some of the restrictions on domains:
©
•
Domains require Blackboard Community System features to organize and manage data.
Domains are only available with the Blackboard Community System.
•
Domains are designed to be flexible and do not adhere to any hierarchy within the
system. Domains can be defined to overlap or even nest, but that structure is applied.
The domains do not have a relationship within the system.
•
New items, such as Classes and users, which meet the constraints of a domain are
included in the domain when created. Domain administrators may not control the default
attributes of items at creation. For example, a Domain Administrator cannot require that
all new Classes created in the domain adhere to specific default values.
•
Domains are designed to manage collections of Classes, Organizations, users,
modules, and tabs. Domains can include one collection or many. For example, a domain
may only include Classes or a domain may include Classes, tabs, and users. Domains
are not used to manage other items in the system such as Tools and Building Blocks.
2007 Blackboard Inc. Proprietary and Confidential.
Page 368
Blackboard K–12 Academic Suite
Administrator Manual
Terminology
The following is a list of terms and definitions required to understand Domains:
Domain: A grouping of data defined for the purpose of delegating administrative responsibilities
to other staff members.
Collection: A set of data, defined by variables or selected individually, that appears in a domain.
System Role: A role that grants administrative privileges. When applied in a domain, the
privileges are only valid when working with data in the domain. System Administrators can define
an unlimited number of System Roles and assign privileges to hundreds of administrative
functions through each System Role. Each user may have multiple System Roles assigned.
Category: A variable that defines and groups Classes. Classes may be assigned multiple
categories. Categories are a logical means of assigning Classes to a collection.
Institution Role: A variable that defines and groups users. Users may be assigned multiple
Institution Roles. Institution Roles are a logical means of assigning users to a collection.
Institution Roles control what is presented to users.
Availability: Determines access. Classes that are unavailable are only accessible by certain
users. Likewise, a user that is unavailable may not access the system.
Enabled: A flag set by Snapshot. Data is often disabled to mark it for archive or deletion.
Datasource Key: A variable assigned to data added to the system through Snapshot. When
Snapshot is used to integrate with other information systems, Datasource keys can be used to
define collections based on the source of the record.
Default Domain
Every system has at least one domain. This domain includes all the Classes, Organizations,
users, tabs, and modules on the system and is referred to as the default domain. Users with a
System Role of System Administrator have full privileges over the default domain (the entire
system).
This concept is important when assigning System Roles. System Roles can be applied within a
domain to grant privileges restricted to the items that exist in that domain. Or, System Roles can
be applied directly to a user, granting privileges in the default domain (the entire system).
Domain Administration
Administration of domains is assigned by combining a user record with System Roles within the
domain. Each domain administrator can be assigned any number of System Roles. The privileges
included in these roles are additive, so they can be combined to create several different models
of domain administrators. The same user can be an administrator in multiple domains.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 369
Blackboard K–12 Academic Suite
Administrator Manual
Structuring a Flexible and Secure Administration Model Using
Domains
Overview
The most important part of using Domains is developing an Administration model that matches
the organizational needs of the Institution. This topic walks through the process of thinking about
the administrative needs of the Institution. Included are questions to ask at each stage and a
small example.
Remember that this is a tool to help you start thinking about your administration model. The
flexibility of domains and unlimited System Roles create the opportunity for unique solutions to
match each Institution.
What are the groupings on Campus that require Domain Management?
The first step in setting up a delegated administration model is to define the groups at the
Institution that can be supported by delegated administrators with privileges limited to that
domain. Because domains can include any combination of users, Classes, Organizations, tabs,
and modules the structure of the different domains is limitless. Some Institutions may choose to
use domains to separate management of users between Students, faculty, alumni, and staff. The
same Institutions can use domains to separate management of Classes between academic
departments. The same Institutions can even apply both models, and allow the academic
department domain administrators control over users in their respective departments. Further,
each department could be divided into separate domains. One domain could be used to manage
the tab and module content while another domain managed Classes and still another domain
handled users.
The flexibility of domains demands clear goals and organization before creating the domains and
assigning administrative privileges. Otherwise, it is likely that domains will be created as needed
and result in a system that is difficult to define and oversee. Consider the following questions
when defining the groups on campus that require domains:
©
•
How is the Institution organized and managed? Does it make sense to create domains
for each functional group? Consider this question beyond just academic departments
and think about the groups on campus that support the learning mission.
•
How are Institution Roles used to define users within Blackboard systems? For example,
are users organized by major, location, year of study, or other variables?
•
How are individuals at the Institution managed? Are the different sets of users managed
by different functional groups? For example, is there an alumni office that handles
alumni relations? Is the admissions department responsible for prospective Students?
•
Who is responsible for the content that appears in tabs and modules? What Institution
Roles are used to define who can view content?
•
Are there different information systems responsible for shared data with the Blackboard
systems?
2007 Blackboard Inc. Proprietary and Confidential.
Page 370
Blackboard K–12 Academic Suite
Administrator Manual
It is very likely that the groupings on campus will have subgroupings that also require delegated
administration. Subgroupings cannot be nested as domains within a domain, but this is not a
barrier to creating a hierarchical structure of domains. Because domains are made up of
collections, and a unit, such as a Class or user, can appear in multiple collections, it is easy to
define domains that consist of a subgroup of another domain. To maintain the proper
organization, develop a naming convention for domains that incorporates the larger domains. For
example, the School of Liberal Arts will likely have several subdomains for academic
departments. The domains could follow this naming convention:
SLA – School of Liberal Arts
SLA_HISTORY – History department, School of Liberal Arts
SLA_ANTHRO – Anthropology department, School of Liberal Arts
SLA_LANGUAGES – Languages department, School of Liberal Arts
SLA_LANGUAGES_FRENCH – French Classes, Language department, School of Liberal Arts
How is each domain defined?
Each domain is defined by assigning criteria to create sets of users, Classes, Organizations, tabs,
and modules. Each set is called a collection. A domain can include one or many collections. Once
the domain structure is defined, items, such as users and Classes, are grouped into collections
within the domain. Adding the collections is a process of defining the collection in such a way to
encompass every item that should be included. When new items, such as a user or a Class, are
added to the system, they automatically become a part of any domain for which they meet the
collection criteria. For this reason, it is important when defining a collection to use the criteria and
the rules to determine the items that fall into the collection to ensure that new items are added to
the collection when created. There is an option to add items individually. The ability to add items
individually is useful for defining domains that are limited and static, ensuring that no other items
become a part of the domain.
It is much easier to define domains after first setting up a model for Institution Roles and a model
for Class and Organization Categories. These variables are completely customizable and serve
as the most flexible and accurate way of defining collections within a domain. Those Institutions
that are using Snapshot to populate the Blackboard database with data from other systems can
also use data source keys to define collections.
Finally, there is no relationship between the Users in a domain and the Classes and
Organizations. That is, Users enrolled in a Class are not automatically included in the domain.
Within a domain, enrollments are controlled by Classes. Thus, a domain administrator with
privileges to modify users may not change users' enrollments in a Class. However, a domain
administrator with privileges to modify Class enrollments may include or exclude users from a
Class.
When defining collections, consider the following:
Classes and Organizations: What categories can be used to define the Classes and Organizations in
this domain?
©
•
Alternatively or in addition to categories, what data source keys can be used to define
the Classes and Organizations in this domain?
•
Should the domain include unavailable Classes and Organizations? Should the domain
include disabled Classes and Organizations? This is an important consideration as
unavailable and disabled status is often used to mark Classes and Organizations that
are complete and scheduled for archive.
2007 Blackboard Inc. Proprietary and Confidential.
Page 371
Blackboard K–12 Academic Suite
Administrator Manual
•
Should the Classes and Organizations in the domain be limited by Enrollment Options,
for example, Classes in which Students can enroll themselves?
•
Class and Organization categories must be added individually, even if the category is
nested in a category that is already included in the domain.
Users:
•
What Institution Roles can be used to define the users in this domain?
•
Alternatively or in addition to Institution Roles, what data source keys can be used to
define the users in this domain?
•
Users may also be defined by System Role, however, customized System Roles are
more likely to be based on privileges and thus are not usually a good model for defining
the users in a domain. System Role is most useful as an attribute when using the Guest
or Parent role.
•
Should the domain include unavailable Users? Should the domain include disabled
Users? This is an important consideration as unavailable and disabled status is often
used to mark User records for archive or removal.
•
Should the Users in the domain be limited by Privacy Options? Users that opt out of the
User Directory can be excluded from a domain.
Tabs and Modules:
•
Should the domain include unavailable Tabs and Modules? This is a way to allow users
to create tabs and modules but not modify them once they are published. Alternatively, a
domain can include only available materials. In this case, the unavailable materials that
are in production cannot be modified by the domain administrators.
•
Tabs and modules can be individually selected for inclusion in a domain.
For example, consider populating the SLA_LANGUAGES domain with a collection of Classes and
users that includes all the Classes offered in the department and all the users that work in the
department or list Languages as their major of study. In this case, the Classes collection may be
defined as:
Categories: LANG, LANG_FR, LANG_DE, LANG_ES, LANG_JP, LANG_NLAvailability:
IgnoreEnabled: Enabled Only
The user collection may be defined as:
Institution Roles: DEPT_LANG, MAJOR_LANGAvailability: Available OnlyEnabled: Enabled Only
What Admin Tasks are Required for Domain Administrators?
After the collections are defined it is possible to confidently assign appropriate privileges to
System Roles. Domain Administrators are granted privileges based on a System Role that is
applied to that domain only. Essentially, the user and the System Role (or System Roles) are
combined to create a delegated administrator for the domain with the privileges defined by the
System Roles. That combination of user and System Roles only applies in that domain.
System Roles can be created for each domain, but it is more efficient to create System Roles
based on like privileges that can be applied to an administrator in each domain. Because System
Roles are additive in the domain, it is possible to create a System Role model based entirely on
tasks and then use a combination of those tasks to grant individualized privileges to specific
delegated administrators.
When creating System Roles, consider the following:
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 372
Blackboard K–12 Academic Suite
Administrator Manual
•
What administrative tasks will be used by domain administrators?
•
What privileges are needed to accomplish these tasks?
•
How can those privileges be grouped so that each set of privileges accomplishes a goal
or goals? Are there any privileges that are not always applicable in the set?
•
How should System Roles be named? The naming convention should be easily
recognizable and define the set of privileges.
For example, a System Role named USER_MANAGER is created with full privileges to manager
user accounts. This System Role can then be used in each domain to grant a domain
administrator the ability to administer all user accounts in the domain. Another System Role,
USER_PASSWORD may be granted to a domain administrator to allow that user to change
users' password, but not modify any other details about the user record.
In the SLA_LANGUAGE domain, the Department Head may be given the role
USER_MANAGER, while an assistant is assigned the USER_PASSWORD System Role in the
domain to respond to requests to replace a lost password.
Remember that System Roles are additive. If a user has the System Role of
USER_PASSWORD, and is given another System Role that includes the capability to modify
some aspect of user accounts, both System Roles apply. That is, the user has the sum of all the
privileges of all the System Roles the user is assigned. Further, if the user has System Roles with
administrative privileges assigned on the default domain, those privileges apply in all domains
and for all data in the system.
Who are the Users Assigned to Administer the Domain?
Domains are not limited to one administrator with one System Role. Rather, each domain can
have an unlimited number of administrators with an unlimited number of System Roles. In a
domain, different administrators are assigned different responsibilities and tasks.
Consider the following when assigning users as domain administrators:
•
What aspects of the domain require a domain administrator?
•
Are there specific System Roles that grant privileges to accomplish these tasks without
introducing additional unnecessary or potentially risky privileges? If not, consider
revising the construction of System Roles or creating a new System Role to cover the
exceptional case.
•
How do the required tasks form the responsibilities for domain administrators? Is one
admin required to manage users while another is assigned Classes?
•
Who should be assigned to the different domain administrator positions?
Once the individuals who will serve as domain administrators and the System Roles that will grant
appropriate privileges are identified, the last step is to put that information together within the
domain. For example:
Domain: SLA_LANGUAGEUser: Department HeadSystem Roles: USER_MANAGER,
COURSE_MANAGER, MODULE_CREATE, MODULE_MODIFY
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 373
Blackboard K–12 Academic Suite
Administrator Manual
Create Domains
Overview
Creating a domain adds a new domain to the system. After creation, the domain must be
populated with collections and domain administrators must be assigned.
Domains that are only visible on the Administrator Panel. Even then, only the System
Administrator can see the list of domains. Domains are invisible to users within the system, since
they are an administrative management tool. Administrators within the Domain are also unaware
of the domain. Administrators within the Domain simply access features and functions on the
Administrator Panel. The domain controls what data can be managed by the domain
administrator.
It is important to understand the difference between the Domain Name and the Domain ID. The
Domain ID is a unique identifier within the system. The Domain Name is the name of the domain
as it appears to the System Administrator.
How to create a domain
Follow these steps to create a domain.
©
1.
Open the Administrator Panel.
2.
Click Domains.
3.
Click Add Domain.
4.
Enter a Domain Name and a Domain ID. The Domain Name is the readable name that
appears in the user interface. The Domain ID is a permanent, unique identifier assigned
to the domain in the database. Once set, the Domain ID cannot be changed.
5.
Enter a Description for the domain.
6.
Click Submit. The Domain now appears in the list of domains on the Domains page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 374
Blackboard K–12 Academic Suite
Administrator Manual
Define a Collection
Overview
Collections are sets of data. Domains may include one or many of the following collections:
•
Classes
•
Organizations
•
Users
•
Tabs
•
Modules
Each domain can include one or many collections.
After a collection is defined, newly created items in the system will be added to the domain if they
match the collection criteria. For example, if a Class is created with the LANG category, that
Class will appear in a collection that includes all Classes with the LANG category.
It is possible to create collections that are closed to new items. Either select each item individually
for inclusion in the domain using the controls on the Modify Criteria page or use Snapshot to add
the data to the system with a unique data source (and then define the collection to include only
those items with that data source).
Collection Criteria
The table below details the variables used to define each collection. The criteria all work in
concert to determine which items are included in the domain. If the criteria for the Class collection
includes Category LANG and Availability set to Yes, only those Classes that have the LANG
category and are available to users will be included in the collection. The option for selecting
specific items is independent of the other criteria. Thus, a Class that does not have the LANG
category and/or is not available may be added to the collection by specifically identifying it as part
of the collection. Remember that specifying more criteria makes the domain narrower in scope.
C r ite r ia
Descript ion
Class and Organization
©
Category
Choose to include Classes that fall into certain categories. Categories are
assigned to describe and group like Classes. Classes appear in the Class
Catalog based on Category. If Class categories are organized and applied
consistently, Category is a logical and useful means for determining which
Classes belong in a collection.
Availability
Choose to include Available or Unavailable Classes. If Ignore is selected, the
Availability of the Class will not be considered as a criteria for inclusion in the
collection.
Enabled
Choose to include Enabled or Disabled Classes. This refers to the status of
the Class record in the database. Snapshot makes it possible to disable
records but continue to store them in the database. If Ignore is selected, the
status of the Class will not be considered.
Enrollment
Options
Choose to include Classes based on the method of enrollment.
2007 Blackboard Inc. Proprietary and Confidential.
Page 375
Blackboard K–12 Academic Suite
Administrator Manual
C r ite r ia
Descript ion
Data Source
Choose to include Classes based on the data source key. Data source keys
are applied to any data that is added to the system using Snapshot.
Specific
Classes
Select individual Classes to appear in the collection.
User
Institution
Role
Choose to include users that are assigned specific Institution Roles.
Availability
Choose to include Available or Unavailable users. If Ignore is selected, the
Availability of the user will not be considered as a criteria for inclusion in the
collection.
Enabled
Choose to include Enabled or Disabled users. This refers to the status of the
user record in the database. Snapshot makes it possible to disable records
but continue to store them in the database. If Ignore is selected, the status of
the Class will not be considered.
Privacy
Options
Choose to include users based on their Privacy Settings. Users that elect not
to appear in the User Directory can be included or excluded from the
collection.
Data Source
Choose to include users based on the data source key. Data source keys are
applied to any data that is added to the system using Snapshot.
Specific
Users
Select individual users to appear in the collection.
Tab
System
Availability
Choose to include Available or Unavailable tabs. If Ignore is selected, the
Availability of the tab will not be considered as a criteria for inclusion in the
collection.
Specific
Tabs
Select individual tabs to appear in the collection.
Module
System
Availability
Choose to include Available or Unavailable modules. If Ignore is selected,
the Availability of the module will not be considered as a criteria for inclusion
in the collection.
Specific
Modules
Select individual modules to appear in the collection.
How to populate a collection
Follow these steps to create a collection.
©
1.
Open the Administrator Panel.
2.
Click Domains. A list of domains should appear. If there are no domains, click
Add Domain to create one before defining the collections within the domain.
3.
Click Manage for a domain in the list.
4.
Click Manage Collections.
2007 Blackboard Inc. Proprietary and Confidential.
Page 376
Blackboard K–12 Academic Suite
©
Administrator Manual
5.
Click Modify for the collection to populate. Click directly on a collection to view
the items it contains.
6.
Set the criteria to define a collection. The options for each collection are listed in
the table above.
7.
Click Submit.
2007 Blackboard Inc. Proprietary and Confidential.
Page 377
Blackboard K–12 Academic Suite
Administrator Manual
Setup Domain Administrators
Overview
Domain administrators are created by combining a user with System Roles within the domain.
System Roles are roles that define administrative privileges. A user can have several System
Roles applied within a domain. When a user has several System Roles, all the privileges in each
role are applied. If one System Role allows an action, but another System Role does not allow the
same action, the user will be able to perform the action.
Warning: System Roles attached to user records in the default domain
apply to all domains. The default domain is the entire set of data in the
system. System Roles may be attached to users on the Modify User page or
when users are created. System Roles added in this way apply to the
default domain.
How to add Domain Administrators to a Domain
Follow these steps to add a domain administrator to a domain.
©
1.
Open the Administrator Panel.
2.
Click Domains. A list of domains should appear. If there are no domains, click Add
Domain to create one before defining the collections within the domain.
3.
Click Manage for a domain in the list.
4.
Click Manage Administrators. The Manage Administrators page lists out all the domain
administrators and their System Roles. Clicking on a System Role will open the Manage
Privileges page for that System Role. Be careful when modifying privileges, the changes
will be applied system wide to any user who has that System Role in any domain.
5.
Click Add Administrator.
6.
Enter the Username for the new domain administrator.
7.
Assign the System Roles that will apply in the domain.
8.
Click Submit.
2007 Blackboard Inc. Proprietary and Confidential.
Page 378
Blackboard K–12 Academic Suite
Administrator Manual
Blackboard Content System
Overview
The Blackboard Content System is a file repository with several sophisticated features for working
with content. It is fully integrated with the Blackboard Learning System and the Blackboard
Community System—making use of a similar interface as well as creating repositories for
Blackboard Learning System Classes and users.
This chapter reviews how to manage the Blackboard Content System through the Administrator
Panel.
In this part
This part includes the following sections.
©
S e c t io n s
Descript ion
Content
This chapter reviews how content is managed within the Content
Collection.
Organizing Content
This chapter explains the best way to organize folders,
permissions, and content for Classes and the Institution.
Managing the Library
This chapter explains the role of librarians and how eReserves
are managed.
Portfolios
This chapter reviews the tools available for creating and
managing Portfolios.
Learning Objects
Catalog
This chapter reviews options for managing the Learning Objects
Catalog.
Custom Metadata
This chapter reviews how Custom Metadata is created.
Display Options
This chapter reviews the options available for displaying the
Content Collection menu and Content list.
Blackboard Content
System Settings
This chapter reviews the options available for managing the
Content Collection menu and tools.
Technical Settings
This chapter reviews the technical settings in the Blackboard
Content System.
Customizing the User
Interface
This chapter describes how the Administrator can modify the UI
to suit the needs of the Institution.
2007 Blackboard Inc. Proprietary and Confidential.
Page 379
Blackboard K–12 Academic Suite
Administrator Manual
Content
Overview
This section explains the how content is managed within the Blackboard Content System.
In this section
Content includes the following topics.
T op i c
Descript ion
Manage Content
This topic explains how content is organized and managed by
Administrators.
Web Folders
This topic explains how Web Folders operate within the Content
Collection.
Copy Files to CS
This topic explains how Administrators may copy items from the
Blackboard Learning System to the Content Collection.
Removing Users
and Classes
This topic explains how to manage the removal of users and Classes
from the Content Collection.
Orphaned Content
©
This topic explains how to search for and manage orphaned content.
2007 Blackboard Inc. Proprietary and Confidential.
Page 380
Blackboard K–12 Academic Suite
Administrator Manual
Manage Content
Overview
Administrators can manage all content in the Content Collection through Manage Content in the
Administrator Panel or through the Content Collection tab. Administrators are automatically
granted Manage permissions to all files and folders; this allows them to perform any action on all
files and folders. These actions include
•
Move, copy, rename, and delete all files and folders
•
Create files and folders in all directories
•
Manage all files and folders. This includes modifying locks, quotas and permissions.
•
Search all files and folders
Details information about using and managing content may be found in the Blackboard Content
System User Manual.
Accessing Content Collection folders
All personal folders appear when the Administrator opens the Users, Classes, e-Reserves, or
Organizations folders. For example, when Classes is opened, only folders for Classes in which
the Administrator is enrolled or in which he or she is the Teacher will appear.
Administrators may access and manage ALL Users, Classes, e-Reserves and Organizations
folders in the Content Collection. All folders and files may be opened through the Find Folder,
Search and Go To Location tools.
When the library or Institution Folders are opened, all folders that are available in the Content
Collection appear.
Creating Class and User folders
When a new Class or user is added to the Blackboard Learning System, corresponding folders in
the users or Classes folders in the Content Collection are not automatically created. A personal
folder in users is automatically created the first time the user enters the Content Collection. a
Class folder in Classes is automatically created when the Teacher enters the Content Collection.
Students in a Class will not see a Class folder unless the Teacher or Administrator grants them
permissions to do so.
An Administrator will not be able to locate a user’s home folder (for example, /users/Student) or a
Class folder (for example, /courses/courseId) until the user has entered the Content Collection at
least one time. When the user first enters, the Content Collection generates all appropriate
folders for the user.
Additional Notes
Administrators should keep the following in mind while managing content:
©
•
Administrators may assign Workflow tasks through the Administrator Panel. Tasks must
be modified and tracked through the Content Collection Tab.
•
Administrators may modify the quota of Class folders. A quota should only be set for
these folders to manage hardware limits. If possible, leave this field blank.
2007 Blackboard Inc. Proprietary and Confidential.
Page 381
Blackboard K–12 Academic Suite
•
©
Administrator Manual
Take care when granting permissions to areas of the Content Collection, as all folders
and items inherit permissions from the parent folder. For example, if permissions were
granted in the /courses directory, these permissions would also exist for everything in
the /courses directory.
2007 Blackboard Inc. Proprietary and Confidential.
Page 382
Blackboard K–12 Academic Suite
Administrator Manual
Web Folders
Overview
The WebDAV Internet standard is used for sharing files via the Internet regardless of platform
(Windows, Macintosh, Linux, Sun Solaris, and so forth). In the Blackboard Content System, Web
Folders allows users to access content from the Content Collection as if it were it any other
network drive or folder.
Administrators can configure settings and locking options for files on the Web Folders page.
Locks enable users to ‘lock’ an item; when an item is locked it can be viewed by others, but
cannot be modified (even if the others have Write permission to modify the item). Administrators
can enable locks on the Tool Settings page. The Web Folders page allows Administrators to set
the length of time for locks.
Note on authentication and Web Folders: Web Folders require
compatibility with basic or digest authentication schemes. Microsoft®.NET
Passport, Kerberos, and other distributed authentication mechanisms may be
incompatible with direct access to Web Folders. Institutions using one of these
authentication types may be able to take advantage of Web folders by first
authenticating with the Blackboard Learning System, and then launching the Web
Folder from within the user interface.
Find this page
Follow these steps to open the Web Folders page.
1.
Open the Administrator Panel.
2.
Select Web Folders under Blackboard Content System
Fields
The following fields are available on the Web Folders page.
F i e ld
Descript ion
General WebDAV Settings
Web Folders
Available
Select Yes or No to determine if Web Folders will be available to users.
WebDAV Lock Options
©
Maximum
lifetime of a
lock
Enter in seconds the maximum length of time granted for a lock. The lock
expires after the maximum lifetime is reached, which ensures that files do
not remain locked indefinitely.
Minimum
lifetime of a
lock
Enter in seconds the minimum amount of time granted for a lock.
2007 Blackboard Inc. Proprietary and Confidential.
Page 383
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Lock timeout
delay
Enter in seconds the length of time for the grace period between the time
a lock expires and when it times out. During this grace period clients may
refresh the lock. This grace period is designed for clients who may not
request early enough that a lock be refreshed. For example, clients with
inaccurate clocks or clients who do not take into account network latency.
Default value is 10 seconds.
Unique string
for tokens
Enter a unique string to be used for the WebDAV RFC token. Enter a
string that will be different from that used by any other WebDAV server. A
good unique string would be a GUID or a URL with a domain name
owned by the company operating the WebDAV site. The system will base
a unique lock token upon this string.
WebDAV Compression Options
©
Allow
compression
Some WebDAV clients prefer to receive compressed files. Compressing
files over WebDAV reduces bandwidth requirements, but increases CPU
usage. If your server generally has free CPU resources but your network
is constrained, select Yes to enable WebDAV compression.
Minimum size
file to
compress
Enter the minimum size of a file to compress. All files smaller than this
value will not be compressed, even if
compression is requested. Not compressing very small, and often
commonly used files, reduces CPU requirements.
Maximum size
file to
compress
Enter the maximum size of a file that may be compressed. All files larger
than this value will not be compressed, even if compression is requested.
Compressing very large files is generally very resource intensive.
Mime types
available for
compression
Enter the extensions for files that will automatically be compressed if
requested by the client. Files with extensions appearing in this field will
only be compressed if they are of type "application/octet-stream".
Allow Chunk
transferencoding
Chunk transfer encoding allows data to be sent in a series of Chunk
transfer encoding allows data to be sent in a series of chunks to reduce
the strain on the server strain when sending a large amount of data.
Select Yes or No to allow chunk transfer-encoding. If Yes is selected, the
Blackboard Content System will make partial responses when the client
supports transfer-encoding.
2007 Blackboard Inc. Proprietary and Confidential.
Page 384
Blackboard K–12 Academic Suite
Administrator Manual
Copy Files to the Content Collection
Overview
The Copy Files to CS tool enables Administrators to copy content from a Class in the Blackboard
Learning System to a folder in the Content Collection. For example, if a Teacher has added files
to a Class, these files may be copied to the Content Collection using this tool. Items that are
added to the Content Collection may be used in new Classes, shared with other users, and
added to Portfolios.
This tool is meant for adding new content to the Content Collection; it does not detect Content
Collection items that have been added to a Class or make any changes to the Class.
Find this page
Follow these steps to open the Copy Files to CS page.
1.
Open the Administrator Panel.
2.
Select Copy Files to CS under Classes. The Copy Files to CS page will appear.
Fields
The fields below appear on the Copy Links to CS page.
F i e ld
Descript ion
Select a Class
Source
Course ID
Enter a Class ID or click Browse to search for a Class. Files will be copied
from this source Class to the Content Collection.
Select Destination (appears after Submit selected for Source Class)
Content
Areas
Select the check boxes for those areas that will be copied. In each area
selected, attached files will be copied to the Content Collection.
The Administrator may copy content to any folder in the Content Collection.
Select
Destination
This field defaults to the location of the Class folder in Class Content in the
Content Collection. The path to a different folder may be entered.
Run tool multiple times
The Copy Files to CS tool may be run on the same Class multiple times. This may be helpful in
the following situations
©
•
Too much or too little content was selected to copy and a clean copy is needed.
•
If files were copied at the beginning of the term, the process may need to be run at the
end of the term to copy additional files that have been uploaded.
2007 Blackboard Inc. Proprietary and Confidential.
Page 385
Blackboard K–12 Academic Suite
Administrator Manual
Each time this tool is run, a new set of folders appears in the Content Collection. If the content is
copied to the same area, for example Class Content, the Copied Content folder is appended with
the number of the copy. For example, the folder created after the tool is run a second time is
named ‘Course ID’ Copied Content (2).
Types of content that may be copied
The Copy Files to CS tool copies files that have been attached to Class Content Areas. These
files are originally added the Class through the File to Attach option available on specific pages in
the application or the third row action buttons in the Text Box Editor.
The Copy Files to CS tool copies items attached to the following:
•
Content folders
•
Content items
•
Class Links
•
Assignments
•
Instructions
•
External links
•
Learning units
Note: All attachments associated with unprotected Course Cartridges are
copied; protected cartridge content will not be copied.
Types of content that are not copied
Attachments added to the following areas of a Class are NOT added to the Content Collection
through the Copy files to CS tool
•
Attachments added to any Assessment areas (this includes Tests, Surveys and
Question Pools)
•
Attachments added to Discussion Board messages, including Group Discussion Board
messages
•
Files uploaded to the Digital Drop Box by Teachers
•
Items added to the Grade Assignment page by the Teacher are not copied. These items
include comments for a specific user and are sent when the Assignment is graded.
(Items added to the Add Assignment page by a Teacher are copied)
Student files added to a Class are also not copied, this includes
©
•
Files uploaded to the Digital Drop Box by users
•
Files uploaded by users to Assignments
2007 Blackboard Inc. Proprietary and Confidential.
Page 386
Blackboard K–12 Academic Suite
Administrator Manual
File Structure in the Blackboard Content System
All files copied to the Content Collection are stored in the destination folder selected on the Select
Areas to Extract page. All of the content from the Class is stored in a folder with the following
naming convention: ‘Course ID’ Copied Content. The structure of files within Copied Content will
mimic the structure of the files in the Class.
Example: The copy from History100 included Class Documents and Class Information.
Class Documents folder contained:
•
A Class item with the file Class Outline.doc attached
•
A Class folder named Chapter One (no items attached to the folder)
•
In the Chapter One folder - a Class item with the file WeekOne.doc attached
Class Information folder contained:
•
A Class item with the file Class Overview.doc attached
The structure of files within the Content Collection will be as follows
>History 100 folder
>History100 Copied Content folder
>Class Documents folder
>Class Outline.doc
>Chapter One folder
>WeekOne.doc
>Class Information folder
>Class Overview.doc
Copying special file attachments
There are a few cases where copied content receives special treatment in the Content Collection
©
•
Content uploaded to the Blackboard Learning System as package files (for example, zip
files) where the user selected to unpackage this file are copied to the Content
Collection in the zip file format with the unpackaged items under a folder with the
following format: dir_fileattachmentname.fileextension. For example, a file called
“unzipme.zip” is unpackaged at the root of the Class Information folder. The Content
Collection will have both the unpackage.zip file at the root of the Class Information folder
and also dir_unzipme.zip that contains the contents of the original file.
•
All files uploaded through the Text Box Editor are copied to individual subfolders named
embedded(unique#). This is also true for files uploaded through the Text field when the
Text Box Editor is not available.
•
When an HTML file that contains references to images is uploaded, the user is prompted
to upload the images. These are “missing images”. Missing images are copied to a
folder with the following format: dir_fileattachmentname.fileextension.
2007 Blackboard Inc. Proprietary and Confidential.
Page 387
Blackboard K–12 Academic Suite
Administrator Manual
•
All files uploaded through the Text Box Editor are copied to individual subfolders named
embedded(unique#). This is also true for files uploaded through the Text field when the
Text Box Editor is not available.
•
When an HTML file that contains references to images is uploaded, the user is
prompted to upload the images. These are “missing images”. Missing images are copied
to a folder with the following format: dir_fileattachmentname.fileextension.
Extracting files with the same name
The Content Collection does not allow a folder to contain multiple files with the same name; this
type of duplication is permitted within Classes in the Blackboard Learning System.
When files and folders with the same name are copied to the same folder in the Content
Collection, the names will be appended with a number. For example, if two files named Class
Outline.doc are copied to the same folder, they will appear as Class Outline.doc and Class
Outline1.doc.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 388
Blackboard K–12 Academic Suite
Administrator Manual
Managing the Removal of Users and Classes
Overview
It is important that Administrators clean up the Blackboard Content System on a regular basis,
such as at the end of each semester. As Classes, Organizations and users are removed from the
Blackboard Learning System, the Administrator must remove them from the Blackboard Content
System.
Removing Classes
When a Class is removed from the Blackboard Learning System (Administrator Panel > Remove
Class), the Administrator must remove it from the Blackboard Content System. Classes that are
removed no longer appear in the Blackboard Content System; however, they are not removed.
The Administrator may search for the Class and it will display in the search results. Users who
have permissions to the Class folder (aside from Class User permissions) may also search for
and locate the Class.
If a new Class is created in the Blackboard Learning System with the same Course ID as the
Class that was deleted, issues will arise if the Class was not removed from the Blackboard
Content System. The Class will not be created in the Blackboard Content System, because it
already exists.
Follow the steps below to remove a Class from the Blackboard Content System
1.
Select Manage Content on the Administrator Panel.
2.
Select Search Content and search for the Class folder.
3.
Select the check box next to the Class folder on the Search Results page and select
Remove.
Removing users
When a user is removed from the Blackboard Learning System (Administrator Panel > Remove
Users from System), the user is not automatically removed from the Blackboard Content System.
The user’s folder will no longer appear, but it may be searched and located. The Administrator
must remove the user from the Blackboard Content System so issues do not arise.
If the user is not removed from the Blackboard Content System and a user with the same
username is added to the Blackboard Learning System, a folder with this username will appear in
the Blackboard Content System. However, this will be the folder for the original user, with all of
the original contents and permissions intact.
Follow the steps below to remove a user from the Blackboard Content System
©
1.
Select Manage Content on the Administrator Panel.
2.
Select Search Content and search for the user’s folder.
3.
Select the check box next to the user on the Search Results page and select Remove.
2007 Blackboard Inc. Proprietary and Confidential.
Page 389
Blackboard K–12 Academic Suite
Administrator Manual
Orphaned Content
Overview
Content is considered orphaned when the user that owns the content no longer has a valid
system account or if a Class or Organization is removed from the system but content related to
that Class or Organization still appears in the Content Collection. Orphaned content does not
include content owned by disabled or inactive users.
Finding Content Orphaned by Users
Follow these steps to identify content orphaned by users:
1.
Open the Admin Panel.
2.
Click Administrator Search under the Blackboard Content System heading.
3.
Click Content Orphaned by Owner.
4.
A list of all content orphaned by users will appear.
Managing Content Orphaned by Users
The table below details the options for managing content orphaned by Users.
O pt io n
Descript ion
Export
Use this option to download the selected files and folders as a .ZIP package.
Move
Use this option to move the selected files and folders to a new location in the
Content Collection.
Remove
Use this option to delete the content from the system.
Change
Owner
Use this option to change the owner of the content and move it to a new
location.
Finding Content Orphaned by Location
Follow these steps to identify content orphaned by the removal of a Class or Organization:
1.
Open the Admin Panel.
2.
Click Administrator Search under the Blackboard Content System heading.
3.
Click Content Orphaned by Location.
4.
A list of all content orphaned by location will appear.
Managing Content Orphaned by Location
The table below details the options for managing content orphaned by location.
©
O pt io n
Descript ion
Export
Use this option to download the selected files and folders as a .ZIP package.
2007 Blackboard Inc. Proprietary and Confidential.
Page 390
Blackboard K–12 Academic Suite
©
Administrator Manual
O pt io n
Descript ion
Move
Use this option to move the selected files and folders to a new location in the
Content Collection.
Remove
Use this option to delete the content from the system.
Change
Owner
Use this option to change the owner of the content and move it to a new
location.
2007 Blackboard Inc. Proprietary and Confidential.
Page 391
Blackboard K–12 Academic Suite
Administrator Manual
Organizing Content
About organizing and managing content
The Content Collection allows users to store, share, and publish content within personal user
folders, Class folders and Institution Folders. This document explains how to organize and
manage content in ways that are beneficial to them and to other users in the system.
In this section
This section includes information on the following topics
©
T op i c
Descript ion
Organize content in folders
Describes how content is organized within folders.
Organize folder permissions
Explains how folder permissions are managed
Tools for sharing and finding
content
Describes tools available for searching and sharing content.
Organize Class content
Explains how to organize content and permissions for
Classes.
Organize Institution Folders
Explains how to organize content and permissions in the
Institution Folder.
2007 Blackboard Inc. Proprietary and Confidential.
Page 392
Blackboard K–12 Academic Suite
Administrator Manual
Organize Content in Folders
About Organizing Content
Before adding any content to the Content Collection, users should plan out how they will manage
their content. This will allow them to organize content in a way which best meets their individual
needs. Similarly, if Administrators design the folder structure according to the Institution’s needs,
more effective planning, training and messaging can be applied.
Files in the Content Collection are organized in a tree structure of nested folders up to, and
including, the content area level. This means that each folder may contain other subfolders and
files. The term “items” refers to files and folders.
A folder stores both files and other folders. Folders are automatically available to the user who
added the folder but must be shared if other users are to view the folder and its contents. It is
important to remember that all folders are contained within other folders up to the root (/) folder.
Root folders are folders in which all other folders are placed. Content areas, such as Users,
Classes, Institution, and Library, are simply folders stored under the root folder.
Note: The system does not allow subfolders with the same name in a single
parent folder. For example, two folders named Group Projects may not be
created in the top-level of the username folder. The system also does not allow
files with the same name to exist in a folder. The system is case-sensitive,
however, so as long as files and folders have different capitalizations, the
characters can be the same. For example, Group Project and Group project
folders can be created in the same parent folder.
Private content space and Public content space
Creating separate folders for personal content (private space) and folders that are available to
other users (public space) is very helpful. This method allows the user to have certain folders
available only to them, where they can store personal content. For example, one personal folder
may contain papers and projects that are in progress, while another contains professional content
that is not ready to be shared, such as resumes and cover letters for jobs. Additional permissions
for these personal folders are not granted to anyone else.
When a document is ready to be shared, it may be copied or moved to a public folder. For
example, if a Teacher is working on a Class document he or she can create the draft in a
personal folder, and then move it to a shared folder when it is complete. The shared folder is
shared with all users enrolled in the class (public space that is set to be available to only Class
members), and allows for collaboration.
Creating a private folder
A private folder is created in the same way as other folders in the Content Collection, through the
Add Folder option. The permissions granted on the folder determine whether or not it is private.
©
•
In the username folder, a private folder is a subfolder that is not shared with any other
users. A user may create a subfolder in his or her username folder and not grant any
other users permissions to it.
•
In a Class folder, a private folder may be specifically for the Teacher, or it may also be
accessible by users with other Class Roles. For example, a private subfolder may be
2007 Blackboard Inc. Proprietary and Confidential.
Page 393
Blackboard K–12 Academic Suite
Administrator Manual
created with permissions granted to the Teacher, Teaching Assistant, and Class Builder.
This folder would not be available to any Students enrolled in the Class.
Creating a Public folder
Similar to private folders, public folders are created in the same way as other folders, using the
Add Folder option. The permissions granted on a folder determine whether or not it becomes to
multiple users and groups of users. Any user with Manage Permissions may share the item with a
wider audience.
©
•
In a username folder, a public folder may be created and shared with a group of users
collaborating on a project.
•
In a Class folder, a public folder may be created and shared with all users enrolled in the
Class. This folder would include Class information or articles that the whole class needs
to read.
2007 Blackboard Inc. Proprietary and Confidential.
Page 394
Blackboard K–12 Academic Suite
Administrator Manual
Organize Folder Permissions
Organizing folders
It is helpful if users organize folders in a way that allows them to manage permissions by folder,
rather than by file. For example, create a folder that contains all files used in a group project. This
way the entire folder may be shared with the group members, rather than trying to manage
permissions on separate items stored in different folders.
Only Read permission should be added to a top-level folder, for example the username folder.
Anytime a Permission is added or changed on the top-level folder, check any subfolders or files
designated as Private and verify that additional permissions have not inadvertently been added
that would expose protected information.
Sharing Folders
When adding folders and files to the Content Collection, keep in mind which users and user lists
the content will be shared with. Try to create folders in which all items are to be shared with the
same users. When items shared with the same users are spread out among different folders, it
may become very difficult to manage. For example, if the user plans on creating documents that
will be applicable to all users at the Institution, they should create a folder that will be shared with
All System Users, then add the specific items to this folder.
Sharing files
Files are automatically available to the user that added the file but must be shared if other users
are to view the item.
Files inherit permissions from the folder they reside in. This means that if a file is added to a
folder that already has Read and Write permission for certain users or user lists, the those same
users will also have Read and Write permission on the newly added file.
Overwrite Option on Folders
When modifying or adding permissions to a parent folder, the user has the option to force all files
and subfolders to inherit these permissions. For example, if the Read and Write permissions are
added to the folder, and an item within the folder has Read, Write, and Remove permissions,
Remove permissions would be removed from the file. All subfolders and files within the parent
folder would be granted Read and Write permissions.
If this option is not selected, the files and subfolders are automatically granted any additional
permission given to the parent folder, but existing permissions are not removed. For example, if
Read, Write and Manage permissions are added to the folder, and an item within the folder has
Read, Write, and Remove permissions, the permissions for the file would remain Read, Write and
Remove, and Manage would be added.
After modifying permissions on a folder, the user may modify the permissions on an item, but
these will be overwritten the next time permissions on the parent folder are modified. This is one
reason storing items with the same purpose and audience in a single folder makes managing
permissions much easier.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 395
Blackboard K–12 Academic Suite
Administrator Manual
Tools for sharing and finding content
About Tools for sharing and finding content
A number of tools are available to facilitate sharing content and searching for content that has
been shared. These options are dependent on the level of the folder shared, for example granting
permission on a top-level folder versus a subfolder. Remember that when a folder is shared,
permissions are granted to all content in the folder.
Find Folder
The Find Folder option allows users to search for top-level folders they have permissions to, for
example if another user has granted him or her Read permission on a username folder. When a
user is granted permissions to a top-level folder, the Find Folder option allows the user to locate
the folder and add it to his or her Content Collection menu, making is easy to access the folder on
a regular basis.
Users may decide to share a top-level folder with another user, and then adjust the permissions
on the content within, limiting the content this user may access. For example, grant the user Read
permission on the username folder. Then open the folder and remove Read permission for the
content this user should not view. The user may still use the Find Folder option, but they will only
view specific content in the folder.
Search
Search allows users to locate all files and folders that have been shared with them. When a
search is performed only those items to which a user has permissions will be returned. If
permissions are granted on a nested folder (and not the top-level folder) the user may search for
the folder and bookmark it; the Find Folder option may not be used on nested folders.
Go To Location
Go to Location allows users to go directly to a specific folder that has been shared with them in
the Content Collection. This time-saver allows users to enter the path to open a folder and
Bookmark the location at the same time.
Bookmarks
Bookmarks enable quick access to frequently used content a without having to navigate through
several folders. Bookmarks can be organized into folders and subfolders as needed by the user.
This tool is helpful when permissions are granted on a nested folder, since the Find Folder tool
may not be used.
Workflow Activities
If a user is expected to take action or respond to an item, it is helpful to send a Workflow Activity
with the item. When a Workflow Activity is created users are selected to share the item with and
permissions are granted. An option may also be selected to send an email to these users stating
that this item has been shared with them and that a Workflow Activity is attached to it.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 396
Blackboard K–12 Academic Suite
Administrator Manual
Passes
Passes may be used to share a file with a user for a specific amount of time. This is especially
useful for sharing files with users who do not have system accounts. When a pass is created, the
user decides whether to grant Read or Read and Write permission to the file with the pass. When
the time allotted for the pass is over, the user will no longer be able to access the file.
Portfolios
Portfolios allow users to collect and organize files into custom Web pages. These Portfolios can
then be presented to individuals and groups of users. It is important that users consider the
permissions granted to files that are linked to in a Portfolio. If another user has permissions (other
than Read) to a file that is linked to a Portfolio, the file may be modified or removed, resulting in
issues for the Portfolio users.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 397
Blackboard K–12 Academic Suite
Administrator Manual
Organize Class Content
Organize Class content
Administrators often consider whether or not to make the Classes folder in the Content Collection
available to Teachers, content designers and/or Students.
Uses for the Classes and Organizations folders
The Classes and Organizations folders can be used in several ways
•
As a sandbox for Teachers, Teaching Assistants and Class Builders to create and share
documentation amongst themselves, which may be linked to from inside the Class for
sharing with the Class members.
•
As a space for Students to directly access or collaborate on some of the Class content.
•
To provide workspace and access to documents for broad user groups, such as all the
Teachers who are teaching in a department or all Teachers who are interested in a
specific research topic.
Using the /courses or /organizations folders as a Sandbox
The Class folder may be used as a sandbox for each Class’s Teachers, Teaching Assistants and
Class Builders to create and share documentation. Additional permissions do not have to be
applied, because these roles already have default Full permission for their Classes.
Once content is created in the Class folder, it may be linked to from inside the Class for sharing
with the Class members.
Allowing Students selective access to Class or Organization Folders
Teachers may want Students to have access to the Class folder to collaborate on group projects
or write to collective documentation. For this to happen, permission should be extended to
Students in the Class on the top-level Class folder (named using the Course ID). Sub-folders may
be made selectively unavailable by removing Student permission to these ‘private’ folders.
Providing storage, workspace and access for content collections
Realistically, many Institutions will have groups of users who are not members of the same
Classes or Organizations who should have access to the same content.
To enable this, the System Administrator could create a Class ID or Organization ID for a nonexistent Class, for example ‘BotanyLevel1’, and then enroll all users who will interact with content
for that topic as Teachers, Class Builders or Students in the Class.
The following is an example of how this Class may be set up
©
•
Give content managers and the role of Teacher in the Class to grant them Manage
permission to all content. This will allow them to link to the material from their Classes.
•
Give content creators the role of Class Builder in a Class and grant them Write
permission to all content (remove the default Manage permission for Class Builders, or
create a new portal role with only Read and Write access on the Class folder).
2007 Blackboard Inc. Proprietary and Confidential.
Page 398
Blackboard K–12 Academic Suite
Administrator Manual
•
If content consumers (Teachers) will link to the material directly from their Classes, they
must be Teachers in the Class. Otherwise, they only need Read access to view the
material, and can first copy the material into their own Class folders before linking to it.
Make the Class unavailable to ensure that it can be accessed from the Content Collection
/courses area, but cannot be accessed from e-Reserves or from the Class catalog or Classes
portal modules.
As long as the Course ID is not deleted, the Class folder will appear in the Content Collection.
This model allows content to be accessible beyond the timeline of an individual Class.
Folder Creation in the Class Content Area
The Class and Organization Folders use existing IDs (Course IDs and Organization IDs) to create
subfolders. For example, if a Class in the Blackboard Learning System has a Class ID of
Biology100, the Class folder in the Content Collection is automatically named Biology100. Folders
cannot be manually added to the Classes or Organizations top level folders, but subfolders may
be added using Add Folder once inside the specific Class or Organization Folder.
Default Access to the Class Content Area
Administrators should consider who has access to Classes folders. By default, the system is set
up to give Full permission to the Teacher, Teaching Assistants and Class Builders. This also
means that the folder is generated the first time one of these users clicks on the Content
Collection tab.
These default role designations may be modified on the Administrator Panel > Settings > Default
Folder Creation Settings > /courses Management page. Selecting additional Class Roles grants
Full permissions to those users. If users such as Students should only have Read access in an
area, the permission must be modified on the Manage Permission folder for that individual Class
after the Class folder has been generated.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 399
Blackboard K–12 Academic Suite
Administrator Manual
Organize Institution Folders
Organize the Institution Folder
There are two main areas found in the Institution Folder, one for Institution Content and one for
library content.
In addition or as an alternative to serve the needs of members in a broader context than just a
single Class or Organization for storage and access to Class content. Folders can be created for
whole departments, for library branches, or for any group of users that exists in the Institution’s
setting.
In addition to using the Class Content area, the Institution area can be used to serve the needs of
users in a broader context than just a single Class or Organization. Folders can be created for
whole departments, for library branches, or for any group of users that exists in the Institution’s
setting.
Setting up this area involves creating subfolders, then setting permission on those folders to
control access to them. The Institution area gives All System Users Read permission to the
Institution Folder. This permission is extended to all subfolders under the Institution Folder. After
creating a subfolder, use the Manage Permission page to manage access to it.
A typical use case would be to create subfolders in the Institution or Library folders, remove All
System Users Read access to the subfolder, and grant specific permission on the subfolder so
that only a specific group of users sees the folder, and a smaller subset of those users can write
to, remove items from, or manage the subfolders. Specific examples are discussed below.
The eReserves subfolder in the Library folder has separate rules and uses associated with it.
Please see Additional Documentation below for specific eReserve information.
Master Class content in the Institution Folder
The temporary nature of Class folders makes it beneficial to put content that is public in nature
and could be useful to many Teachers in a centralized place. In this way, folders for types of
content can be created, such as the Biology folder, the French folder, and the Algebra folder.
The following is an example of how the permissions would be set up
©
1.
Remove All System Users Read access on the subfolders.
2.
Grant full permissions (Read, Write, Remove and Manage) to any users or user group
who should manage this area. Users with Manage permission would create additional
subfolders, assign permissions, and set folder properties.
3.
Think about which users or groups of users will be creating the content for a subfolder,
and assign Read and Write access to them.
4.
Give Read access to Teachers or Class Builders who might want to use the content.
Teachers will not directly link to this content from their Class, because they do not have
Manage permission on the files. Instead, they could copy the file into their Class or user
folder and link to it there if needed.
2007 Blackboard Inc. Proprietary and Confidential.
Page 400
Blackboard K–12 Academic Suite
Administrator Manual
Library content in the Library folder
Similar to the example above, the Library folder can be used to set up subfolders for the Law
Library and the Medical Library, for example, and then grant the librarians of those Institutions
additional permissions. One or more librarian who manages the folder would have Manage
access, and other librarians may have Read, Write and possibly also Remove permissions.
Faculty, staff and Students who should see the content in a specific folder would be granted Read
permission based on a user list or an Institution Role. Remember to remove All User Accounts
Read access from folders considered protected or private for a certain subset of the Institution
community.
Private and public folders
The Administrator may choose to create private and public subfolders within the Institution area.
•
Private Folders – Access to a private folder is limited to one or a few users. For
example, a folder may be created to which only the librarians have access. They may
use this area to manage documents about library processes and procedures.
•
Public Folder – Content in public folders is usually made available to a large number of
users. For example, a folder including all of the schedules for athletic teams may be
created and shared with All System Accounts.
Note: The Administrator may decide to retain the Institution area as a public
information area and not store protected content in this area
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 401
Blackboard K–12 Academic Suite
Administrator Manual
Managing the Library
About the Library
Administrators are responsible for enabling and managing areas within the Library in the Content
Collection. This document explains the role of Administrators in the Library, and provides details
for managing Library permissions and availability.
In this section
This section includes information on the following topics
©
T op i c
Descript ion
Library Contents
Explains the Library folder and contents.
Managing
eReserves
Explains how to enable eReserves and manage this area
Librarians
Describes the features available to Librarians and how to create
Librarians.
2007 Blackboard Inc. Proprietary and Confidential.
Page 402
Blackboard K–12 Academic Suite
Administrator Manual
Library Contents
About the Library
The Library is used to post eReserves, electronic manuscripts, and other Institution resources. It
allows integration with the Blackboard Learning System, making it a powerful way to share and
distribute library materials.
The two main areas within the Library are Library Content and eReserves. Additional areas may
also be added to the Library to meet specific Institution needs by adding subfolders in this area.
What is Library Content?
Library Content is a folder within the Library that can be organized according to the Institution’s
specific needs. This area is intended for content that may be shared across the entire Institution.
By default, all system users automatically have read access to all items in Library Content.
What are eReserves?
eReserves is an area within the Library that contains materials for which access must be
controlled, such as documents with copyrights. The Administrator must enable eReserves before
this area is available in the system. eReserves are only available for Classes; eReserves are not
available for Organizations.
This section of the Library is automatically organized by Class; each Class in the Blackboard
Learning System has a corresponding folder in eReserves. Additional folders may not be added
to eReserves. Folders and items in the top-level eReserves folder cannot be manipulated; for
example, a Class folder may not be moved, deleted or renamed.
Note: By default, only the Administrator has permission to manage the folders in
the Library. The Administrator must grant permissions to other users who will be
managing and organizing the Library. Permissions may be granted to top-level
folders or only to certain subfolders. Any user who has Manage permission on
the top level folder can grant permissions for folders within it.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 403
Blackboard K–12 Academic Suite
Administrator Manual
Managing eReserves
About eReserves
The Administrator must enable eReserves before it is available to any users. Once eReserves is
enabled, a Class folder for each Class will be created within this area. Follow the steps below to
enable eReserves:
1.
Select eReserves on the System Administrator Panel. The Manage eReserves page will
appear.
2.
Select Yes on the Manage eReserves page.
What happens if eReserves is enabled after the Content Collection has been in
use?
The Administrator may enable eReserves at any time; even after users have actively been using
the Content Collection for some time. If eReserves is enabled after the Content Collection has
been in use, Class folders within eReserves will be generated the first time the Teacher,
Teacher’s Assistant, or Class Builder accesses the Content Collection.
What happens if eReserves is disabled?
If the eReserves function is disabled by the Administrator, folders for new Classes will not be
created within eReserves. Existing content will not be removed from eReserve, but the
eReserves area will no longer appear under the Library in the left-side navigation area. The
Search and Go To Location features may be used to find content in eReserves.
If the eReserves function is re-enabled, Class folders that had not appeared (while it was
disabled) will appear the first time the Teacher, Teacher’s Assistant, or Class Builder accesses
the Content Collection.
How are eReserve Class Folders created?
The Administrator can use the create-course-directory command line tool to create directories for
Classes in the Content Collection and corresponding folders in eReserves. This tool is especially
helpful if the Administrator wishes to activate the eReserve folders in advance of the Teacher,
Teacher’s Assistant, or Class Builder accessing the Content Collection. A sample use case for
this would be to allow librarians to upload materials before a semester begins.
Note: The Class must already exist in the Blackboard Learning System before
running this Command Line Tool.
The following is the syntax for this command
create-course-directory <Course ID>
The following is an example of the syntax to create a Class directory for history100
create-course-directory history100
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 404
Blackboard K–12 Academic Suite
Administrator Manual
Automatic folder creation by Teachers
If the Administrator does not generate the eReserve Class directory by using the Command Line
Tool, Class folders within eReserves are automatically generated the first time the Teacher,
Teaching Assistant or Class Builder accesses the Content Collection. At this point, all users
enrolled in the Class would be able to see the Class folder in eReserves.
Note: When the Teacher, Teacher’s Assistant, or Class Builder accesses the
Content Collection, all Classes where they hold these roles are generated in the
/courses folder and in the /eReserves/courses folder simultaneously.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 405
Blackboard K–12 Academic Suite
Administrator Manual
Librarians
About librarians
Librarians are responsible for managing content within one or more areas of the Library in the
Content Collection; these users are granted read, write, manage, and remove permissions to an
area(s) of the Library. Initially, no librarians exist in the system. Users may be granted librarian
permissions by the Administrator.
Note: Any combination of permissions may be granted to a user that is
considered a librarian. A user needs Read and Write permissions in this area to
add files, Manage to set permissions and file settings, and Remove to delete
items.
How is a librarian created?
Administrators may grant users permissions to be a librarian. A librarian may add permissions for
others within the area(s) of the Library he or she has Manage permission. As the Administrator,
you may decide to grant a single user librarian permissions for the entire Library. This librarian
could then be responsible for creating other librarians and overseeing the management of all
content in the Library.
To create a librarian with permissions to the Library area, follow the steps below
1.
Select Manage Content on the System Administrator Panel.
2.
Open the Content Collection Tab, and select Library Content.
3.
Select Modify next to the library folder. The Modify: library page will appear.
4.
Select Permissions; the Manage Permissions: library page will appear.
5.
Select Add Users. The Add User: library page will appear.
6.
Complete the Add User library page with the following information
F i e ld
Descript ion
Choose User(s) [r]
Enter the name of the user who will have librarian permissions to the entire Library. This user
must have an account in the Blackboard Learning System. The Browse option may be used to
locate the user more easily.
Set Permissions
Permissions [r]
A librarian has full permissions to content within his or her
area. Check each box including Read, Write, Remove, and
Manage.
Folder Options
Apply to this folder, files
within this folder, and all
sub-folders and their files [r]
©
Select this button; the librarian will have the same
permissions to the Library and all the items and subfolders
nested within the Library.
2007 Blackboard Inc. Proprietary and Confidential.
Page 406
Blackboard K–12 Academic Suite
©
Administrator Manual
F i e ld
Descript ion
Overwrite any existing
permissions for this user list
Select this check box only if the user had any previous
permissions to the Library or an area within the Library.
This will overwrite past permissions with the new
permissions selected on this page.
Apply to this folder only
Do not select this option. If this button is selected, the
librarian would only have permissions to the items in this
folder. The librarian would not have privileges to any
subfolders added to this area.
2007 Blackboard Inc. Proprietary and Confidential.
Page 407
Blackboard K–12 Academic Suite
Administrator Manual
Portfolios
Overview
This section explains the Portfolio features in the Content Collection.
In this chapter
The Portfolios section includes the following topics.
©
T op i c
Descript ion
About Portfolios
This topic covers Portfolio Templates. Administrators may add, create
and remove Portfolio templates.
Manage Portfolios
This topic explains how Administrators manage Portfolios for all users
on the system.
Personal Portfolio
Templates
This topic explains how to create Personal Portfolio Templates.
Basic Portfolio
Templates
This topic explains how to create Basic Portfolio Templates.
Add a Basic
Portfolio Template
This topic explains how to add a Basic Portfolio Template.
Portfolio Settings
This topic covers Portfolio Settings. Administrators can make Portfolios
available to all users on the system or to select Institution Roles.
2007 Blackboard Inc. Proprietary and Confidential.
Page 408
Blackboard K–12 Academic Suite
Administrator Manual
About Portfolios
Overview
Portfolios are an invaluable tool in academic and professional development, providing a powerful
medium for users to efficiently collect and organize artifacts representative of work completed
over time. Portfolios offer a means to demonstrate formative and/or summative progress and
achievement. Portfolio authors are empowered with tools to effectively present their information in
a cohesive, personalized format.
Portfolio Types
There are three types of portfolios available in the system:
Personal Portfolios: Personal Portfolios feature more robust tools for authors to give them
greater flexibility for personalizing a Portfolio’s style. Users are able to customize colors, fonts,
background images and overall content layout beyond the classic frame-based presentation
available with Basic Portfolios. With Personal Portfolios, authors collect one or many independent
entities called Personal Artifacts which comprise the actual content presented in the Portfolio.
Within the Portfolio, Artifacts are organized through placement on Portfolio Pages. Artifacts can
be created as part of or independent of the Portfolio authoring process. Authored Artifacts can be
reused in other Portfolios.
Administrators have the ability to define whole Portfolio templates that govern settings that apply
to the entire authored Portfolio. Templates can control all aspects of the Portfolio style and overall
layout; template designers have the flexibility to define whether certain template settings are
restricted (and cannot be altered).
Outcomes Portfolios: Outcomes Portfolios and Personal Portfolios function similarly. Outcomes
Portfolios are integrated with the Blackboard Outcomes System and can be used with that system
to form a standardized workflow for the review of Portfolios. Outcomes Portfolios are always
generated from a template to ensure consistency across each Portfolio. Outcomes Portfolios are
only available with the Blackboard Outcomes System. For more information, please see the
Blackboard Outcomes System Reference Manual.
Basic Portfolios: Basic Portfolios serve as a simple tool for quickly creating Portfolios. Basic
Portfolios have a simpler design and do not use Artifacts, so it is more difficult to reuse content
between portfolios. Administrators may turn off Basic Portfolios. Basic Portfolio features and
functions are covered in a separate chapter.
My Portfolios
The My Portfolios page is the launching point for viewing, creating, and reviewing Portfolios. The
My Portfolios page is accessible from the left-hand navigation controls within the Content
Collection tab or from the My Portfolios portal module which may appear on other tabs.
The My Portfolios page includes a search function to locate a specific portfolio. The list of
portfolios includes information on the Portfolio Type, its availability, and links to read comments
and manage the portfolio settings.
To view a portfolio from the My Portfolios page, click on the Portfolio name.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 409
Blackboard K–12 Academic Suite
Administrator Manual
Manage Portfolios
Overview
Administrators can modify Portfolio settings from the Administrator Panel. The controls for
Portfolios allow Administrators to define guidelines for Portfolio usage so that users can create
like Portfolios for comparison. As well, the Administrator can determine which types of Portfolios
are available on the system.
Modify Portfolio Settings
Follow the steps below to modify the Portfolio Settings.
1.
From the Admin Panel, click Portfolios in the Blackboard Content System area.
2.
Click Portfolio Settings.
3.
Set the Availability of Portfolios on the system. Portfolios can be turned on and off
system-wide for all users or for users with specific roles.
4.
Set the availability of Personal Portfolios.
5.
Set the Availability of Basic Portfolios and the availability of the Portfolio Wizard for
creating Basic Portfolios.
6.
Click Submit.
Manage User Portfolios
Administrators can view and manage the Portfolios for users. Follow these steps to quickly open
the My Portfolios page for a specific user.
©
1.
From the Admin Panel, click Portfolios in the Blackboard Content System area.
2.
Click Manage Portfolios.
3.
Enter or Browse for a Username.
4.
Click Submit.
5.
The user’s My Portfolios page will appear. The Administrator may manage the user’s
Portfolios.
2007 Blackboard Inc. Proprietary and Confidential.
Page 410
Blackboard K–12 Academic Suite
Administrator Manual
Personal Portfolio Templates
Overview
Administrators can define templates for Personal Portfolios. Personal Portfolio templates define
the structure and appearance of Personal Portfolios, leaving it to users to populate the Portfolio
with appropriate Artifacts. Templates are useful for applying a standard structure to ensure that
user Portfolios meet the educational goals for the Portfolio.
Users can select a template when creating a Personal Portfolio.
Create a Personal Portfolio Template
Follow these steps to create a Personal Portfolio Template.
1.
From the Admin Panel, click Portfolios in the Blackboard Content System area.
2.
Click Personal Portfolio Templates.
3.
Click Add Template.
4.
Enter a name for the Template. This name will appear as a choice for templates when
users create a Personal Portfolio.
5.
Enter a Title for the Portfolio. The title will appear at the top of the Portfolio.
6.
Define the template settings and availability.
7.
Click Submit. The Template is created.
8.
Find the template in the list of templates and click Modify.
9.
Options for modifying the Template properties, defining the Portfolio Styles, and defining
the Portfolio Pages will appear. When defining the Portfolio Style or Pages, the
Administrator can determine user's ability to modify or add to those settings.
10. Finish defining the template using these options.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 411
Blackboard K–12 Academic Suite
Administrator Manual
Basic Portfolio Templates
Overview
Templates are used in Portfolios to create custom Web pages. The Administrator may create a
series of templates that users can then choose to use when creating a Portfolio. A number of
templates are included in the Blackboard Content System; these may also be modified by the
Administrator to suit the needs of the Institution.
Note: Existing Portfolio pages will not be changed when a template is modified,
removed, or made unavailable.
Find this page
Follow these steps to open the Portfolio Templates page.
1.
Open the Administrator Panel.
2.
Select Portfolio Templates under Blackboard Content System.
Function
The following functions are available on the Portfolio Templates page.
©
To . . .
click . . .
add a template
Add Template. The Add Portfolio Template page will appear.
remove a
template
the check box next to each template that should be removed then click
Remove in the action bar. The template will be removed from the system.
make changes
to a template
Modify next to the template. The Modify Template page will appear.
Administrators modify the template and availability from this page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 412
Blackboard K–12 Academic Suite
Administrator Manual
Custom Metadata
Overview
This section explains the custom metadata features in the Blackboard Content System.
In this section
This section includes the following topics.
©
T op i c
Descript ion
Manage Custom
Metadata
This topic covers the Manage Custom Metadata Fields page.
Administrators create and modify custom metadata from this page.
Add Metadata Field
This topic covers the Add Metadata Field. Administrators may add
metadata field from this page.
Custom Metadata
Set Properties
This topic covers the Custom Metadata Set Properties page.
Administrators may modify the custom metadata properties from this
page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 413
Blackboard K–12 Academic Suite
Administrator Manual
Manage Custom Metadata Fields
Overview
Metadata is descriptive information about an item in the Content Collection. Metadata can be
used in searches within the Content Collection or to ensure that an item is interoperable with
other systems. Administrators may create, modify and manage custom metadata fields for their
Institution on the Custom Metadata page. Custom Metadata fields appear in the metadata options
for each item that is added to the Content Collection.
Find this page
Follow these steps to open the Manage Custom Metadata Fields page.
1.
Open the Administrator Panel.
2.
Select Custom Metadata under Blackboard Content System.
3.
Select Manage Custom Metadata Fields.
Function
The following functions are available on the Manage Custom Metadata Fields page.
©
To . . .
click . . .
add a metadata field
Add Field. The Add Metadata Field page will appear.
remove a field
the check box next to each field that should be removed then click
Remove in the action bar. The field will be removed from the
system.
make changes to a
custom metadata field
Modify next to the field. The Modify Metadata Field page will
appear.
2007 Blackboard Inc. Proprietary and Confidential.
Page 414
Blackboard K–12 Academic Suite
Administrator Manual
Add Metadata Field
Overview
Administrators create custom metadata fields for their Institution on the Add Metadata Field page.
These fields appear in the metadata options for each item that is added to the Content Collection.
Find this page
Follow these steps to open the Add Metadata Field page.
1.
Open the Administrator Panel.
2.
Select Custom Metadata under Blackboard Content System.
3.
Select Add Field.
Fields
The following fields are available on the Add Metadata Field page.
F i e ld
Descript ion
Define Metadata Field
Display
Name [r]
Enter a name for the metadata field. The Display Name is shown to end users.
Key Name
Enter a unique identifier. This identifier is separate from the display name of the
field so that the Administrator can use a more technical or non-intuitive name
that will not change and can be mapped to field names in other systems.
This identifier cannot begin with an integer, for example, “1abc” would be
invalid. Integers may be used within or at the end of the identifier.
[r]
Removing Custom Metadata
If an Administrator removes a Custom Metadata field that users have populated, the field and
values will no longer appear. If this same metadata field is re-added to the system, the values that
had been previously added by users will re-appear.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 415
Blackboard K–12 Academic Suite
Administrator Manual
Custom Metadata Set Properties
Overview
Administrators change the properties for the Institution’s Custom Metadata on the Custom
Metadata Properties page.
Find this page
Follow these steps to open the Custom Metadata Set Properties page.
1.
Open the Administrator Panel.
2.
Select Custom Metadata under Blackboard Content System.
3.
Select Custom Metadata Set Properties.
Fields
The following fields are available on the Custom Metadata Set Properties page.
F i e ld
Descript ion
Custom Metadata Display Name
Display
Name [r]
Enter a name for Custom Metadata. This name will appear to users in place
of the “Custom Metadata” title.
Namespace
Namespaces are used to prevent collisions among sets of metadata. The
namespace for the system should reflect the name of the Institution or
Blackboard installation to keep it from colliding or being confused with
custom metadata on other systems.
[r]
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 416
Blackboard K–12 Academic Suite
Administrator Manual
Display Options
Overview
This section explains the Display option features in the Blackboard Content System.
In this section
Display Options includes the following topics.
©
T op i c
Descript ion
Content List
Display Options
This topic covers the Content List Display Options page. Administrators
customize the actions and columns available to users from this page.
Menu Display
Options
This topic covers the Menu Display Options page. Administrators
customize the left-side menu in the Blackboard Content System view
from this page.
Manage Shortcut
View
This topic covers the Manage Shortcut View page. Administrators
manage the names and availability of options in the Shortcut View from
this page.
Shortcut
Properties
This topic covers the Shortcut Properties page. Administrators manage
the display of the Shortcut View from this page.
Manage Folder
View
This topic covers the Manage Folder View page. Administrators manage
the names and availability of options in the Folder View from this page.
Folder View
Properties
This topic covers the Folder Properties page. Administrators manage the
display of the Folder View from this page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 417
Blackboard K–12 Academic Suite
Administrator Manual
Content List Display Options
Overview
Administrators may set which actions can be performed on the Content List page by users. For
example, the option to copy items may be made available, or hidden from the Content List page.
Administrators may also set which columns appear on the page.
Find this page
Follow these steps to open the Content List Display Options page.
1.
Open the Administrator Panel.
2.
Select Display Options under Blackboard Content System.
3.
Select Content List Display Options.
Fields
The following fields are available on the Content List Display Options page.
F i e ld
Descript ion
Display Actions
Click Yes or No to select which items will appear in the Action Bar. Actions that do not appear
are hidden; they are not disabled.
Display Columns
Click Yes or No to select which columns will be displayed in the Content List.
Quota Information
Select Yes or No to determine if quota information for the files will appear.
Set Default Items per Page
Select the number of items that will be displayed on the page before the user must page to the
next window to view additional records.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 418
Blackboard K–12 Academic Suite
Administrator Manual
Menu Display Options
Overview
Administrators may customize the presentation of the left-hand navigation menu to users. For
example, they can allow users to view the menu in only the Shortcut View or the Folder View.
They may also select a default view if both options are available.
Find this page
Follow these steps to open the Menu Display Options page.
1.
Open the Administrator Panel.
2.
Select Display Options under Blackboard Content System.
3.
Select Menu Display Options.
Fields
The following fields are available on the Menu Display Options page.
F i e ld
Descript ion
Menu Display Options
Content
Collection
Menu View
Select the menu view that will be available to users.
Folder View Options
Display Expand
All/Collapse All
icons
Select Yes for the Expand/Collapse icons to display to users. These icons
are only displayed in the Folder View of the menu. Select No and the
Expand/Collapse icons will be hidden.
Display Refresh
Select Yes and the Refresh option will be available to users. This option
is only displayed in the Folder View. Selecting this option enables users
to update the left-side navigation menu to display any changes that have
been made to the menu. Select No and the Refresh option will not be
available to users.
User Preference
If the Administrator selects to enable both the Folder and Shortcut view, the user’s preference will
override the default set by the Administrator. For example, if the User selects the Shortcut view,
the Shortcut view will appear, even if the Administrator has set the default to the Folder view.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 419
Blackboard K–12 Academic Suite
Administrator Manual
Manage Shortcut View
Overview
The Manage Shortcut View page is used to control the appearance of the Shortcut View in the
Content Collection Menu. The Shortcut View includes icons that open the content areas in the
main panel. Changes to the Shortcut view will NOT impact the Folder view of the Content
Collection.
Find this page
Follow these steps to open the Manage Shortcut View page.
1.
Open the Administrator Panel.
2.
Select Display Options under Blackboard Content System.
3.
Select Manage Shortcut View.
Function
Click the Manage link for an area to edit the shortcut name or change the availability for that
area.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 420
Blackboard K–12 Academic Suite
Administrator Manual
Shortcut Properties
Overview
The icons that appear in the shortcut view can be renamed and toggled on and off.
Find this page
Follow these steps to open the Shortcut Properties page.
1.
Open the Administrator Panel.
2.
Select Display Options under Blackboard Content System.
3.
Select Manage Shortcut View.
4.
Click Manage for a content area.
Fields
The following fields are available on the Shortcut Properties page.
F i e ld
Descript ion
Shortcut Name
Shortcut Name [r]
Edit the name of the content area. The current name will display in
this field.
Shortcut Availability
Select Yes or No to display a shortcut to the content area. If No is selected this area will not
appear on the left-side navigation menu. This area is hidden, not disabled, in the system.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 421
Blackboard K–12 Academic Suite
Administrator Manual
Manage Folder View
Overview
The Manage Folder View page is used to control the appearance of the Folder view in the
Content Collection Menu. The Folder view displays a tree of the folders in each area of the
Content Collection. Users may expand and collapse folders and subfolders, as well as access
Tools and Portfolios. Changes to the Folder view will NOT impact the Shortcut view of the
Content Collection.
Find this page
Follow these steps to open the Manage Folder View page.
1.
Open the Administrator Panel.
2.
Select Display Options under Blackboard Content System.
3.
Select Manage Folder View.
Function
Click the Manage link for an area to edit the name, style or change the availability.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 422
Blackboard K–12 Academic Suite
Administrator Manual
Folder View Properties
Overview
The names of areas that appear in the Folder View may be changed on the Folder View
Properties page. The Administrator may also change the color of the header areas and the area
availability.
Find this page
Follow these steps to open the Folder View Properties page.
1.
Open the Administrator Panel.
2.
Select Display Options under Blackboard Content System.
3.
Select Manage Folder View.
4.
Click Manage for a content area.
Fields
The following fields are available on the Folder View Properties page.
F i e ld
Descript ion
Shortcut Name
Name [r]
Edit the name of the content area. The current name will display
in this field.
Header Color
Background Color
Click Pick to open a palette. Move the mouse around the color
field to see the different color variations. Single-click to select
the color that appears.
Alternatively, the hexadecimal RGB value can be entered in the
text field. Entering the code allows a perfect match to a color.
For example, a Portfolio color scheme can be created to match
a school’s colors.
The color selected will be used as the background for the
headers in the folder view.
Text Color
Click Pick to open a palette. Move the mouse around the color
field to see the different color variations. Single-click to select
the color that appears.
Alternatively, the hexadecimal RGB value can be entered in the
text field. Entering the code allows a perfect match to a color.
The color selected will be used as the text for header name in
the folder view. Please make sure to select a text color that
contrasts with the background color for easy viewing.
Content Area Options
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 423
Blackboard K–12 Academic Suite
©
Administrator Manual
F i e ld
Descript ion
Display the /folder name
Content Area in the
Content Menu
Select Yes or No to display the folder in the Content Menu. If No
is selected the area will not appear on the left-side navigation
menu. This area is hidden, not disabled, in the system.
2007 Blackboard Inc. Proprietary and Confidential.
Page 424
Blackboard K–12 Academic Suite
Administrator Manual
Blackboard Content System Settings
Overview
This section explains the Setting options in the Blackboard Content System.
In this section
Blackboard Content System Settings includes the following topics.
©
T op i c
Descript ion
Virtual Hard Drive
This topic covers the Virtual Hard Drive page. Administrators
select the availability of the Virtual Hard Drive for users.
Default Folder Settings
This topic covers the Default Folder Settings page.
Administrators select which folders are created by default in a
user’s Blackboard Content System.
Manage System Creation
of Folders /courses and
/organizations
This topic covers the Manage System Creation of
Folders:/courses and /organizations page. Administrators
manage the creation of default folders in /courses and
/organizations from this page.
Manage System Creation
of Folders /users
This topic covers the Manage System Creation of Folders:
/users page. Administrators manage the creation of default
folders in /users from this page.
Feature and Tool
Availability
This topic covers the Enable/Disable Features and Tools page.
Administrators may turn features and tools on and off in the
system.
Privacy Settings
This topic covers the Privacy Settings page. Administrators
determine which user information may be made available in the
user directory.
Copy Settings
This topic covers the Copy Settings page. Administrators select
if permission updates to Content Collection items after a Class
Copy are automatic.
e-Reserve Setting
This topic covers the e-Reserve Setting page. Administrators
select the availability of e-Reserves in the system.
2007 Blackboard Inc. Proprietary and Confidential.
Page 425
Blackboard K–12 Academic Suite
Administrator Manual
Virtual Hard Drive Settings
Overview
When a user enters the Content Collection for the first time, a folder with his or her name may
automatically be created in the user's directory. Administrators choose which roles these folders
are created for on the Virtual Hard Drive page. For example, the Administrator may choose to
have the system create folders for Teachers but not for Students. Users are given full
permissions to their folders; this includes read, write, remove, and manage permissions.
Note: Administrators may select the default quota for these folders on the
Default Folder Settings: /users page.
Find this page
Select Virtual Hard Drive under Blackboard Content System on the Administrator Panel.
Fields
The following fields appear on the Virtual Hard Drive page
F i e ld
Descript ion
Virtual Hard Drive Availability
System
Availability
Select Yes to enable the system to automatically create folders for users in
the users’ directory.
Roles
Folders in the users’ directory are automatically created for users with roles
that appear in the Selected Roles box. Select roles in the Available Roles
box and use the arrows to move these roles to the Selected Roles box.
Changing system availability
Changing the System Availability may have adverse affects on users accessing their files and
folders in My Content. If this option is originally set to Yes, then changed to No after users have
added items to their user folders, the content will no longer appear. The content will not be
removed from the system, but users will be unable to access it. If the System Availability is then
returned to Yes, the content will once again appear to users.
Removing Institution Roles
If the Administrator removes an Institution Role from the system, the folder creation settings for
that user group will be lost.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 426
Blackboard K–12 Academic Suite
Administrator Manual
Default Folder Settings
Overview
The Default Folder Settings page displays the top-level folders, or directories, in the Content
Collection. From this page, Administrators may manage the quotas and permissions for folders
created by default within the top-level folders.
Find this page
Follow these steps to open the Default Folder Settings page.
1.
Open the Administrator Panel.
2.
Select Settings under Blackboard Content System. The Settings page will appear.
3.
Select Default Folder Settings.
Function
The following functions are available on the Default Folder Settings page.
©
To . . .
click . . .
set permissions and quotas for
folders in the /courses directory
Manage next to the /coursesdirectory. The Default
Folder Settings: /courses will appear.
set permissions and quotas for
folders in the /courses directory
Manage next to the /organizations directory. The
Default Folder Settings: /organizations will appear.
create folders and set quotas for
user folders
Manage next to the /users directory. The Default
Folder Settings: /users will appear.
2007 Blackboard Inc. Proprietary and Confidential.
Page 427
Blackboard K–12 Academic Suite
Administrator Manual
Manage Default Folder Settings: /courses and /organizations
Overview
This page allows Administrators to set up permissions and quotas for folders that are created by
default in the Content Collection. For example, when a user enters the Content Collection for the
first time, folders matching the Course IDs for the Classes the user is enrolled in will automatically
be created.
Find this page
Follow these steps to open the Default Folder Settings: /courses or /organizations page.
1.
Open the Administrator Panel.
2.
elect Settings under Blackboard Content System. The Settings page will appear.
3.
Select Default Folder Settings. The Default Folder Settings page will appear.
4.
Select Manage next to the /courses folder.
Fields
The Default Folder Settings: /courses or /organizations page includes the following fields.
F i e ld
Descript ion
Default Role Settings
Roles with
Full
Permissions
Select the user roles that will have full permissions to access the folders
created in this area of their Content Collection. Full permissions include
Read/Write/Remove/Manage privileges.
Default Quota
Default Quota
©
Set a default quota for the folders created within the top-level folders for
Classes or Organizations. Enter ‘-1’ if there should be no quota.
The quota cannot be changed for existing folders. If a quota is changed,
only newly created folders will have the new quota size. Administrators may
change the quota for existing folders on an individual basis. This option is
found on the Properties page for each folder.
2007 Blackboard Inc. Proprietary and Confidential.
Page 428
Blackboard K–12 Academic Suite
Administrator Manual
Manage Default Folder Settings /users
Overview
When users with specific roles enter the Content Collection for the first time, a folder with their
name is automatically created in the user's directory. The Default Folder Settings /users page
allows Administrators to select the default quota for these folders on the basis of role. Different
quotas may be assigned to different roles. Users are given full permissions to their folder; this
includes read, write, remove, and manage permissions.
Note: The Virtual Hard Drive page allows Administrators to select which roles
have folders automatically created for them in the user's directory.
Find this page
Follow these steps to open the Default Folder Settings /users page.
1.
Open the Administrator Panel.
2.
Select Settings under Blackboard Content System. The Settings page will appear.
3.
Select Default Folder Settings. The Default Folder Settings page will appear.
4.
Select Manage next to the /users folder.
Fields
Set a Default Quota for each type of role. For example, Student folders may be set to 20 MB, but
Faculty folders may have a quota of 25MB. If a user has multiple Institution Roles assigned to
them, the quota for his or her user folder is derived from the highest quota assigned to any of
these roles. For example, if one of the roles has a quota of 25MB and another has a quota of
35MB, the user would be assigned 35MB.
Note: The default quota cannot be changed for existing folders. If a quota is
changed, only folders created for new users in that role will have the new quota
size. For example, if the quota for Teachers is changed, the folder size for
existing Teachers will not change. Folders for new Teachers will have the new
quota.
Administrators may change the quota for existing folders on an individual basis.
This option is found on the Properties page for the user folder.
Removing Institution Roles
If the Administrator removes an Institution Role from the system, the quota settings for that user
group will be lost.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 429
Blackboard K–12 Academic Suite
Administrator Manual
Feature and Tool Availability
Overview
Administrators can manage which features and tools within the Blackboard Content System are
available to users on the Feature and Tool Availability page.
Find this page
Follow these steps to open the Feature and Tool Availability page.
1.
Open the Administrator Panel.
2.
Select Settings under Blackboard Content System. The Settings page will appear.
3.
Select Feature and Tool Availability.
Fields
The following fields are available on the Feature and Tool Availability page.
F i e ld
Descript ion
Enable / Disable Blackboard Content System
Blackboard
Content System
Available
Select Yes to make the Blackboard Content System available to Users.
Select No and the Blackboard Content System will not be available on the
system. If No is selected, neither the Blackboard Content System tab nor
links to Blackboard Content System Tools will appear in the system.
Enable / Disable Content Features
Content Passes
Available
Select Yes or No to make content passes available on the system.
Versions
Available
Select Yes or No to make versioning available on the system.
Locks Available
Select Yes or No to make locks available on the system.
Content
Comment
Available
Select Yes or No to make comments available on the system.
Content
Tracking
Available
Select Yes or No to make content tracking available on the system.
Content
Metadata
Available
Select Yes or No to make content metadata available on the system.
Enable/Disable Tools
Workflow
Activities
Available
©
Select Yes or No to allow users to set up Workflow Activities.
2007 Blackboard Inc. Proprietary and Confidential.
Page 430
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Bookmarks
Available
Select Yes or No to make Bookmarks available to users.
Search
Available
Select Yes or No to allow users to conduct searches in the system.
Go to Location
Available
Select Yes or No to allow users to go directly to a specific location in the
system.
Help Available
Select Yes or No to make Help available in the Blackboard Content
System.
Blackboard Content System Item Integration
Blackboard
Content System
Item Available
Select Yes to make items stored in the Content Collection may available
for use in other areas of the Blackboard K-12 Suite, such as Classes,
Organizations and Tabs. If No is selected, the ability to browse to the
Blackboard Content System from other areas of the system will be
disabled. See Integrate Content Collection Items into the Blackboard
K-12 Suite for additional Information.
Local File
System Storage
Available
Select Yes and when user attaches a local file it will be stored in the local
file system storage. Select No and when users attach a local the file will
be saved to the Blackboard Content System. See Local File System
Storage Available for additional information.
Save to location
This is the default system location for uploaded files added through an
HTML module or the Blackboard Outcomes System; this is used when
local file storage is turned off and for reusable objects.
Reusable Object Availability
Reusable Object
Available
Select Yes to allow users to create Reusable Objects from the Learning
Objects Catalog or from the Content Area action bar in Courses and
Organizations.
Select No disallow the creation of Reusable Objects.
Reusable Object
Discovery
Available
Select Yes to enable the creation and discovery of Reusable Objects from
the Learning Objects Catalog or from the Content Creation Area action
bar in Courses and Organizations.
Select No to disable the discovery of Reusable Objects by using the
Discover Content action bar in any location in the system.
Integrate Content Collection Items into the Blackboard K-12 Suite
Items stored in the Content Collection may be made available for use in other areas of the
Blackboard K-12 Suite, such as Classes, Organizations and Tabs. When Content Collection Item
Integration is available, the Blackboard K-12 Suite is able to access, attach and link to items
stored in the Content Collection. This feature fully employs the Content Collection’s storage and
reuse potential.
Follow the steps below to make this feature available:
©
1.
Open the Administrator Panel.
2.
Select Settings under Blackboard Content System.
2007 Blackboard Inc. Proprietary and Confidential.
Page 431
Blackboard K–12 Academic Suite
3.
Administrator Manual
Select Feature and Tool Availability.
4.
Select Yes for Content Collection Item Integration Available. If this option is set to No, the
user is only allowed to attach files from their local computer
When integration is allowed, users may browse and link to Content Collection items (when the
appropriate permission exists) from certain areas of a Class, such as the Add Item page, the Add
Class Outline page, or the third row of the Text Box Editors. The name of this feature is Link to
Content Collection. If the Content Collection item is updated, the user will get the newest
document each time the link is accessed.
In other areas of the Class, such as Assignment submission, the File Upload Question Type, or
the Import Question Pool page, users will be able to browse the Content Collection and select a
file to copy (when the appropriate permission exists). The name of this feature is Copy file from
Content Collection. In these cases, the file is attached to the Class and no relationship to the
Content Collection item is retained. This feature is used in cases where the file must be submitted
to the Grade Center, or because it is a zipped file which must be unzipped before it can be used
in the new context.
Local File Storage Available
Local File System Storage includes item upload from the third row of the Text Box Editor, the Add
Item page, and other Class pages. Users can still upload files from their local system but the files
will be stored in the Content System not in the embedded / local file storage.
The best practice is to store all items that are used in the institution in a centralized location.
Differences between Tool Availability and Display Options
Feature and tool availability is managed separately from the availability of actions performed on
content. Administrators manage which features and tools are available from the Feature and Tool
Availability page. The Display Options page, also available from the Administrator Panel, allows
Administrators to select which actions may be performed on content. For example, the Search
tool is made available through Features and Tools, but the ability to copy content is made
available through Display Options. Display Options also manage which information about content
is made available to users, such as size and permission information.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 432
Blackboard K–12 Academic Suite
Administrator Manual
Privacy Settings
Overview
The Privacy Settings page determines if users' Privacy Settings are respected during a Search of
the Content Collection. Users have the option of choosing whether or not their user information is
made public in the User Directory of the Blackboard Learning System. The Privacy Settings page
allows Administrators to determine whether these privacy settings chosen by users will be
respected during user searches of the Content Collection
Find this page
Follow these steps to open the Privacy Settings page.
1.
Open the Administrator Panel.
2.
Select Settings under Blackboard Content System. The Settings page will appear.
3.
Select Privacy Settings.
Choose privacy settings
Select Yes or No to determine if the privacy settings user’s set for the User Directory will be
respected.
If Yes is selected, users who choose not to be listed in the User Directory will not appear during
user searches in the Content Collection. If No is selected, users who choose not to be listed in
the User Directory will appear during user searches in the Content Collection.
If a username does not appear during a user search in the Content Collection, check the settings
on this page and also the settings that the user selected in Personal Information in of the
Blackboard Learning System.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 433
Blackboard K–12 Academic Suite
Administrator Manual
Copy Settings
Overview
The Copy Settings page allows the Administrator to enable options that automatically update
permissions to Content Collection items linked to in a Class after a Class Copy operation.
Links to Content Collection items in a Class are copied during a Class Copy operation. Because
links to Content Collection items are copied and not physical files, all users must have permission
within the Content Collection to view these files. If this tool is not enabled, users in the new Class
will not have the appropriate permission.
Note: The permissions for links to Content Collection items within Assessments
(Tests, Surveys, and Questions Pools) are not automatically updated. The
Teacher must update the permissions to these items manually through the
Content Collection.
Find this page
Follow these steps to open the Copy Settings page.
1.
Open the Administrator Panel.
2.
Select Settings under Blackboard Content System.
3.
Select Copy Settings.
Fields
The fields below appear on the Copy Settings page.
©
F i e ld
Descript ion
Update permissions for
Content Collection items and
folders
All users enrolled in a copied Class automatically receive
Read permission to Content Collection items linked to in
the Class. This does not include e-Reserve items that are
linked to in the Class.
Update permissions for
Content Collection items and
folders, including e-Reserves
All users enrolled in a copied Class automatically receive
Read permission to Content Collection items linked to in
the Class. This includes e-Reserve items that are linked to
in the Class.
Do not update permissions
Permissions to items linked to in a Class are not updated
after a Class Copy. Users who are not enrolled in the
source Class will not have permission to view these items.
2007 Blackboard Inc. Proprietary and Confidential.
Page 434
Blackboard K–12 Academic Suite
Administrator Manual
Item permissions in the Content Collection
When a Content Collection item is copied through Class Copy and the permissions are
automatically updated, the new permissions are visible for the item in the Content Collection.
When the Content Collection item is viewed in the Content Collection, Read permission will
appear for All Class Users.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 435
Blackboard K–12 Academic Suite
Administrator Manual
e-Reserve Setting
Overview
e-Reserves allow librarians to make content available to users throughout the system. Content
may be made available in the Library Content folder, or placed into a Class folder within eReserves. Administrators may enable or disable the creation of e-Reserve folders from the
Manage e-Reserves page. All users, except Guests and Parents, may view the content in the eReserves folders, but only the librarian may add or modify content.
Find this page
Follow these steps to open the e-Reserve Setting page.
1.
Open the Administrator Panel.
2.
Select e-Reserves under Blackboard Content System.
Field
Select Yes to enable the creation of e-Reserve folders for each Class in the Blackboard Learning
System. Select No and e-Reserve folders will not be automatically created. If No is selected and
e-Reserves is enabled at a later date, Class folders within e-Reserves for Classes added while eReserves was disabled, will be automatically generated by the Teacher, Teaching Assistant, or
Class Builder.
Create e-Reserve Directory
The create-course-directory command line tool creates a directory for a Class with a given
Course ID and assigns appropriate permissions for that Class and roles. This command line tool
will also initialize the e-Reserve directory for a Class. e-Reserves must be enabled in the system
for this to be successful. See the Blackboard Content System Setup Guide for additional
information.
If the Administrator does not generate the e-Reserve directory, Class folders within e-Reserves
are automatically generated when the Teacher, Teaching Assistant or Class Builder selects the eReserves folder in the file system. For example, if the Teacher for a history class would like to
create an e-Reserve folder, he or she would click the e-Reserve folder. A folder with the Course
ID of the history class will automatically appear in the e-Reserves area.
Librarian Role
Administrators must create librarians to manage the content of e-Reserves. A librarian is a user
who has full permissions to folders in e-Reserves. Librarians are the only users who may add and
modify content in this area; all other users, with the exception of Guests and Parents, have read
access to this area. Teachers may also add items from e-Reserves to their Classes.
Follow the steps below to create a librarian (multiple librarians may be created)
©
1.
Check that e-Reserves has been enabled through the Administrator Panel.
2.
Select Manage Content from the Administrator Panel.
3.
Select library in the file system.
2007 Blackboard Inc. Proprietary and Confidential.
Page 436
Blackboard K–12 Academic Suite
Administrator Manual
4.
Select Modify next to e-Reserves. The Modify e-Reserves page will appear.
5.
Select Permissions. The Manage Permissions e-Reserves Setting page will appear.
6.
Select Add User. The Add User e-Reserves page will appear.
7.
Complete the page. Enter the Username of the librarian in the Username field. Select all
options (Read, Write, Remove, and Manage) in the Permissions field. Click Submit.
Note: Librarians may access e-Reserve folders using the Find Folder option.
Class folders within e-Reserves automatically appear in the librarian’s file system
if the librarian is enrolled in the Class.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 437
Blackboard K–12 Academic Suite
Administrator Manual
Manage User Lists
Overview
User Lists are used to share content. When a user selects to share a content item or a folder,
they can share the content with individual users or groups of users called a User List. The
administrator can make User Lists available to all users, to no users at all, or to users with
selected Institution Roles.
Find this page
Follow these steps to open the Manage User Lists page.
1.
Open the Administrator Panel.
2.
Click Settings under Blackboard Content System.
3.
Click Manage User Lists.
Manage User Lists
The Manage User Lists page displays all the User Lists in the system. Click Modify to set the
availability for a particular User List. For each list, the System Availability can be set. If the User
List is Available, use of the list can be restricted to specific Institution Roles.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 438
Blackboard K–12 Academic Suite
Administrator Manual
Content Area Availability
Overview
Administrators may remove access to Content Areas if they are not in use at the Institution. For
example, if an Institution does not use the Organizations Content Area within the Content
Collection, this area may be set to Unavailable. Users will not be able to view the content in the
Content Area. In fact, the Content Area will no longer appear in the left-hand navigation area
within the Content Collection.
Find this page
Follow these steps to open the Content Area Availability page.
1.
Open the Administrator Panel.
2.
Click Settings under Blackboard Content System.
3.
Click Blackboard Content System Availability.
Content Area Availability Settings
The ability for users to add content to a Content Area and the ability for users to view a Content
Area are customizable for each Content Area.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 439
Blackboard K–12 Academic Suite
Administrator Manual
Technical Settings
Overview
This section explains the Technical Setting options in the Blackboard Content System.
In this section
Technical Settings includes the following topics.
©
T op i c
Descript ion
Log Settings
This topic covers the Log Settings page. Administrators select
general log settings and enable tracing for specific logs from this
page.
Manage Performance
Settings
This topic covers the Manage Performance Settings page.
Administrators set up caching for the Blackboard Content
System from this page.
Manage Document Stores
This topic covers the Manage Document Stores page.
Administrators view the Document Store information from this
page.
Manage Document Store
Document Store Name
This topic covers the Manage Document Stores: Document
Store Name page. Links to areas for managing the settings for
Document Stores appear on this page.
JDBC Settings
This topic covers the JDBC Settings page. Administrators set
values for JBDBC connections from this page.
Storage Location
This topic covers the Storage Location page. Administrators
enter the storage location for Blackboard Content System files
from this page.
Temporary Storage
Settings
This topic covers the Temporary Storage Settings page.
Administrators enter the temporary storage location for
Blackboard Content System files from this page.
Deletion Audit Trail
Report
This topic covers the Deletion Audit Trail Report page.
Administrators enter the path and dates for the audit trail report
from this page.
Deletion Audit Trail
Settings
This topic covers the Deletion Audit Trail Settings page.
Administrators enter the amount of time to save the audit trail
from this page.
Global Schema Settings
This topic covers the Global Schema Settings page.
Administrators enter connection information for the Global
Schema from this page.
Bandwidth Properties
This topic covers the Bandwidth Properties page. Links to areas
for managing bandwidth appear on this page.
Bandwidth Restrictions
This topic covers the Bandwidth Restrictions page. Information
about bandwidth for the different directories appears on this
page.
2007 Blackboard Inc. Proprietary and Confidential.
Page 440
Blackboard K–12 Academic Suite
©
Administrator Manual
T op i c
Descript ion
Bandwidth Restrictions
/directory name
This topic covers the Bandwidth Restrictions /directory name
page. Administrators set the amount of bandwidth for a directory
from this page.
Bandwidth Settings
This topic covers the Bandwidth Settings page. Administrators
manage bandwidth for the Blackboard Content System from this
page.
Authentication Properties
This topic covers the Authentication Properties page.
Administrators may allow persistent cookies for the Blackboard
Content System from this page.
Full Text Search Settings
This topic covers the Full Text Search Settings page.
Administrators set up the time and duration for the system
rebuild of full text searches from this page.
System Information
This topic covers the System Information page. This page
displays information about the installation, such as build version
and installation date.
2007 Blackboard Inc. Proprietary and Confidential.
Page 441
Blackboard K–12 Academic Suite
Administrator Manual
Log Settings
Overview
Error and information messages related to the system are generated in the default Tomcat logs.
The Log Settings page is used to generate additional information if there is a problem with the
system and debugging is necessary; this information is used by Blackboard Product Support to
remedy the situation.
Note: Administrators DO NOT need to restart Tomcat after enabling log events.
Find this page
Follow these steps to open the Log Setting page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Log Settings.
Blackboard Content System logs
All Blackboard Content System logs are stored in the logs directory under the top-level
blackboard directory. Within the logs directory there are folders that store logs as well as an
archive folder for logs that have been compressed and stored as a means of managing the size
of the log files.
Fields
The following fields are available on the Log Settings page.
F i e ld
Descript ion
General Log Settings
©
Log events to file
Select Yes to log events in the Blackboard Content System to
the Log file. Select No and events will not be logged.
Path/name of Log File
Displays the path to the log file. This field cannot be modified.
Maximum Log File Size
(0 for unlimited)
Set the maximum size for a log file.
Number of Saved Log
Files (0 for unlimited)
Set the maximum number of logs that are saved.
Log Informational
Message
Select Yes or No to log information messages for debugging or
statistical information purposes. Fatal messages are logged
regardless of this setting.
2007 Blackboard Inc. Proprietary and Confidential.
Page 442
Blackboard K–12 Academic Suite
F i e ld
Administrator Manual
Descript ion
Log Tracing Settings
The log file will automatically include general details for all areas of the Blackboard Content
System. Fields that are set to Yes for tracing on this page will include additional details in the
log. These options should remain on No, unless the system requires debugging.
Turning these options on may result in a significant decrease in system performance.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 443
Blackboard K–12 Academic Suite
Administrator Manual
Performance Settings
Overview
The Manage Performance Settings page allows Administrators to specify caching options for files
and queries. These settings may improve performance for users in the Blackboard Content
System.
Find this page
Follow these steps to open the Performance Setting page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Performance Settings.
Fields
The following fields are available on the Performance Settings page.
F i e ld
Descript ion
Performance Settings
©
File cache
size
Enter the size of the cache in megabytes. Caching files in memory improves
performance by reducing the number of read operations from disk. The
default setting of 1 MB allows for caching of small, commonly used files. This
setting can be increased if desired, but not above 10 MB.
Query
statement
cache
enabled
Select Yes to enable the system to cache query statements. This improves
performance if the same query statements are used multiple times. Select
No and query statements will not be cached. The default setting is Yes.
Enabling query statement caching significantly improves performance, but
consumes a small amount of additional memory.
2007 Blackboard Inc. Proprietary and Confidential.
Page 444
Blackboard K–12 Academic Suite
Administrator Manual
Manage Document Stores
Overview
The Manage Document Stores page displays the locations and details of Document Stores in the
system. Each top level directory in the Blackboard Content System, such as /users and /courses,
is associated with a Document store. Administrators can manage the configuration settings of
each document store, including the following
•
JDBC Settings
•
Storage and Temporary Storage location and settings
•
Deletion Audit Trail Settings and Reports
Find this page
Follow these steps to open the Manage Performance Setting page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Document Stores.
Function
Select Manage next to a Document Store to access the Manage Document Store page. This
page includes links to areas that allow the Administrator to modify settings and locations related
to Document Stores.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 445
Blackboard K–12 Academic Suite
Administrator Manual
Manage Document Stores Document Store Name
Overview
Administrators’ may customize the settings for the Document Store and modify the file storage
locations from the Manage Document Store page. The Document Store is the top-level directories
that contain the files in the Blackboard Content System.
Find this page
Follow these steps to open the Manage Document Store page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Document Stores. The Manage Document Stores page will appear.
4.
Select Manage next to one of the Document Stores.
Available functions
The following functions are accessible through the Manage Document Store page
©
To . . .
click . . .
set the JDBC properties
JDBC Settings. The JDBC Settings page will
appear.
change the location of the Document Store
Storage Location. The Storage Location page
will appear.
set up the temporary storage location for
the Document Store
Temporary Storage Location. The Temporary
Storage Location page will appear.
generate a report of items that have been
deleted from the Document Store
Deletion Audit Trail Report. The Deletion
Audit Trial Report page will appear.
set the number of days deleted items will
be tracked
Deletion Audit Trail Settings. The Audit Trail
Settings page will appear.
2007 Blackboard Inc. Proprietary and Confidential.
Page 446
Blackboard K–12 Academic Suite
Administrator Manual
JDBC Settings
Overview
Administrators may customize the Java Database Connectivity (JDBC) settings for each
Document Store. JDBC is a java standard that allows for java applications such as the
Blackboard Content System to connect to databases. The Blackboard Content System reads
information from, and writes to the database using groups connections, also referred to as “pools”
of connections. An item, or connection in a pool, allows a java thread to use database resources.
Each request for data from end users usually consumes one item from the pool. However, there
is not a one-to-one relationship between user requests and number of required connections.
When the request is completed, the connection is freed up for another user.
If there are more database requests than available connections, the requests wait in a queue until
a database connection is available.
Heavy usage of the Blackboard Content System typically requires increasing the maximum
connection pool size. This would allow the database to process more requests simultaneously.
However, making the maximum pool size too large may degrade the performance of the
database because of the additional CPU and memory requirements. Decreasing the maximum
pool size reduces the load on the database, but if it is too small, user requests might take longer
to process because they would wait longer in a queue until connections are freed.
Institution may have unique usage patterns for each Document Store. For example, if users
heavily use Virtual Hard Drive but do not use the Classes area, consider increasing the maximum
connections for the /users Document Store, and decreasing this setting for the /courses
Document Store.
Find this page
Follow these steps to open the JDBC Settings page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Document Stores. The Manage Document Store page will open.
4.
Select Manage next to one of the Document Stores.
5.
Select JDBC Settings.
Fields
The following fields are available on the JDBC Settings page.
F i e ld
Descript ion
JDBC Settings
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 447
Blackboard K–12 Academic Suite
©
Administrator Manual
F i e ld
Descript ion
Connection
Expiration
Occasionally, a connection will remain open but unusable. This is
sometimes referred to a “hung java connection”. Automatically expiring all
open connections ensures that hung connections eventually close. Enter
the number of minutes a database connection will remain open before the
system automatically closes it. New connections are created when
needed, up to the Maximum Connections setting (below).
Maximum
Connections
Enter the maximum number of connections that can exist in the
connection pool. If this number is too high, performance may decrease
because the database server consumes more resources. If it is too low,
requests may take longer to process because they might wait in a queue
until a connection becomes available.
Minimum
Connections
Enter a minimum for the size of the database connection pool.
Dead
Connection
Timeout Period
Enter the number of seconds before a ‘dead’ connection will time out and
be removed from the pool. A dead connection is one that is not sending
any activity between the database and the Blackboard Content System.
2007 Blackboard Inc. Proprietary and Confidential.
Page 448
Blackboard K–12 Academic Suite
Administrator Manual
Storage Location
Overview
To change the physical location of the Blackboard Content System storage directories, follow
these steps:
1.
Enter the location of the Blackboard Content System files for the Document Store in the
bb-config.properties file.
2. Run PushConfigUpdates.
Please see the Server Administration Guide for detailed information on running
PushConfigUpdates.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 449
Blackboard K–12 Academic Suite
Administrator Manual
Temporary Storage Settings
Overview
Administrators have the option of setting up a temporary storage location for the Document Store.
This duplicate set of data may be used for disaster recovery. In this scenario, a combination of
the database backup and this temporary file location, will enable the Administrator to keep the
system almost completely up to date in the event of a disaster. This backup location can be set
up in either the database or in an external storage location; it cannot be the same as the main
storage location.
Find this page
Follow these steps to open the Temporary Storage Settings page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Document Stores. The Manage Document Store page will open.
4.
Select Manage next to one of the Document Stores.
5.
Select Temporary Storage Settings.
Fields
The following fields are available on the Temporary Storage Settings page.
F i e ld
Descript ion
Temporary Storage Location
Temporary
Storage
Location
Enter the path to the temporary storage location.
Temporary Storage Settings
Temporary
Storage Period
Select Never and files will remain in the temporary location indefinitely.
Select the Delete in x days option and to keep files in the temporary
storage location for a specific period of time.
Recovering deleted items
If a user removes an item from the Blackboard Content System the item will be stored in the
temporary storage location for the selected temporary storage period. The Administrator can use
the deletion audit trail report to find the exact path to the item in the temporary storage location.
Once the item is located, the Administrator may email it to the user.
If the amount of time in the temporary storage period has passed, the Administrator must search
for the item in a database backup.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 450
Blackboard K–12 Academic Suite
Administrator Manual
Deletion Audit Trail Report
Overview
This page allows the Administrator to generate a report of data that has been deleted by users
from a specific sub-directory in the Blackboard Content System. This data is used in selective file
recovery; it enables the Administrator to retrieve a single file that was deleted from the
Blackboard Content System from a backup. This data is only available for as long as it is stored in
the Audit Trail Settings.
Find this page
Follow these steps to open the Deletion Audit Trail Report page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Document Stores. The Manage Document Store page will open.
4.
Select Manage next to one of the directories.
5.
Select Deletion Audit Trail Report.
Fields
The following fields are available on the Deletion Audit Trail Report page.
F i e ld
Descript ion
Audit Trial Report
©
Top-Level Directory
name
The top-level directory name appears here.
Sub-Directory Path
Enter the path to the sub-directory from which to generate a
report.
From Date
Enter the date on which the report should begin. Use the
MM/DD/YY format.
To Date
Enter the date on which the report should end. Use the
MM/DD/YY format.
2007 Blackboard Inc. Proprietary and Confidential.
Page 451
Blackboard K–12 Academic Suite
Administrator Manual
Deletion Audit Trail Settings
Overview
When using the external storage location, files that have been deleted by users can still be
retrieved from backups by the Administrator. The delete audit trail provides the Administrator with
the file system location and file name of the deleted file. The Audit Trail Settings page is used to
set the number of days the audit trail will be available. Once this amount of time has passed, the
audit trail for the deleted file will no longer be available. This small log is stored in the database;
the lifetime may be set fairly high without affecting system performance.
Find this page
Follow these steps to open the Audit Trial Settings page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Document Stores. The Manage Document Store page will open.
4.
Select Manage next to one of the directories.
5.
Select Deletion Audit Trail Settings.
Field
Enter the number of days the audit trail will exist after a file is deleted. If zero is entered the audit
trail will never be stored.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 452
Blackboard K–12 Academic Suite
Administrator Manual
Global Schema Settings
Overview
The Global Schema is the structure of the Blackboard Content System database. It is a database
that is separate from the document store databases, and controls connections and information to
each of the document stores. The Global Schema Settings page allows the Administrator to
modify the settings for database connection times and the size of the connection pool.
Please refer to the JDBC Settings section for a description of connection pools. The Global
Schema requires its own pool of connections, and consumes significantly less connections than
each document store.
Find this page
Follow these steps to open the Global Schema Settings page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Global Schema Settings.
Fields
The following fields are available on the Global Schema Settings page.
F i e ld
Descript ion
Global Schema Settings
©
Dead
connection
timeout
Enter the number of seconds before a ‘dead’ connection will time out and
be removed from the pool. A dead connection is one that is not sending any
activity between the database and the Blackboard Content System.
Live
connection
expiration
Occasionally, a connection will remain open but unusable. This is
sometimes referred to a “hung java connection”, and although the
connection is not useable, it is not a dead connection. Automatically
expiring all live open connections ensures that hung connections eventually
close. Enter the number of minutes a database connection will remain open
before the system automatically closes it. New connections are created
dynamically when needed, up to the Maximum Connections setting (below).
Maximum
size of
connection
pool
Enter the maximum number of connections that can exist in the connection
pool. If this number is too high, performance may decrease because the
database server consumes more resources. If it is too low, requests may
take longer to process because they might wait in a queue until a
connection becomes available.
Minimum size
of connection
pool
Enter the minimum size of the connection pool. Because the number of
connections to the Global Schema is typically small, the default of 2 is
adequate for most Institutions.
2007 Blackboard Inc. Proprietary and Confidential.
Page 453
Blackboard K–12 Academic Suite
Administrator Manual
Bandwidth Properties
Overview
Administrators’ set restrictions on bandwidth and configure the bandwidth settings from the
Bandwidth Properties page.
Find this page
Follow these steps to open the Bandwidth Properties page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Bandwidth Properties.
Available functions
The following functions are accessible through the Bandwidth Properties page
©
To . . .
click . . .
set bandwidth restrictions for the toplevel folders
Bandwidth Restrictions. The Bandwidth
Restrictions page will appear.
configure bandwidth settings
Bandwidth Settings. The Bandwidth Settings page
will appear.
2007 Blackboard Inc. Proprietary and Confidential.
Page 454
Blackboard K–12 Academic Suite
Administrator Manual
Bandwidth Restrictions
Overview
Administrators view the bandwidth limits for each directory, and the amounts of bandwidth used
on the Bandwidth Restrictions page. Bandwidth is the amount of data that can be transmitted in a
specific amount of time, for example bytes per second. Setting a bandwidth for each directory
helps manage performance on the system.
Find this page
Follow these steps to open the Bandwidth Settings page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Bandwidth Properties. The Bandwidth Properties page will open.
4.
Select Bandwidth Restrictions.
Available Function
Select Manage next to one of the Directory Names. The Bandwidth Restriction page for that
directory will appear, allowing the Administrator to change the amount of bandwidth for that
directory.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 455
Blackboard K–12 Academic Suite
Administrator Manual
Bandwidth Restrictions: /Directory Name
Overview
Administrators designate the amount of bandwidth available to a directory from the Bandwidth
Restrictions: /directory name page.
Find this page
Follow these steps to open the Bandwidth Restrictions page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Bandwidth Properties. The Bandwidth Properties page will open.
4.
Select Bandwidth Restrictions.
5.
Select Manage next to one of the Directory Names.
Field
Set the amount of bandwidth in MBs that is available to this directory.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 456
Blackboard K–12 Academic Suite
Administrator Manual
Bandwidth Settings
Overview
Administrators set up bandwidth settings and checks on the Bandwidth Settings page.
Find this page
Follow these steps to open the Bandwidth Settings page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Bandwidth Properties. The Bandwidth Properties page will open.
4.
Select Bandwidth Settings.
Fields
The following fields are available on the Bandwidth Settings page.
F i e ld
Descript ion
Bandwidth Settings
©
Check bandwidth
limits
Use the drop-down list to limit the amount of bandwidth allowed for
each user or session.
Default
bandwidth quota
Enter a bandwidth quota granted to each user account. This is only
applied if the bandwidth has been limited in the Check Bandwidth
limits field.
Time over which
to apply
bandwidth quota
Define the period of time over which a bandwidth quota is measured.
For example, if this is set to 1 hour and the Default bandwidth quota is
100MB, a 100MB file could only be downloaded or uploaded once over
the course of 1 hour.
2007 Blackboard Inc. Proprietary and Confidential.
Page 457
Blackboard K–12 Academic Suite
Administrator Manual
Authentication Properties
Overview
Using persistent cookies increases the usability of WebDAV; users are not asked to authenticate
multiple times when persistent cookies are used. If persistent cookies are not allowed users may
have to authenticate multiple times when accessing content in Web folders.
Note: If persistent cookies are used, users must select the Logout button to end
their session. Simply closing the browser window will not end the session .
Find this page
Follow these steps to open the Authentication Options page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Authentication Properties.
Fields
Select Yes to enable persistent cookies. Select No and persistent cookies will not be enabled in
the system.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 458
Blackboard K–12 Academic Suite
Administrator Manual
Full Text Search Settings
Overview
The full text search index creates an index of all terms in the documents and file names within the
Blackboard Content System. When a search is performed, the system queries this index to find
results. This method enhances system performance in that the search query uses a stored set of
data, rather than querying all active data on the system for each search request.
Administrators set the time and the duration for the system to rebuild the Full Text Search index
on the Full Text Search page. If a rebuild is not complete within the duration set, the index will
begin rebuilding next time from the point it left off. For best results, Administrators should always
try to allow the system to completely rebuild the search indexes.
Note: Full Text Search does not index text from encrypted .pdf documents.
Find this page
Follow these steps to open the Full Text Settings page.
1.
Open the Administrator Panel.
2.
Select Technical Settings under Blackboard Content System. The Technical Settings
page will appear.
3.
Click Full Text Search Settings.
Fields
The following fields are available on the Full Text Settings page.
F i e ld
Descript ion
Full Text Settings
©
Hour of Day
Select the time for the system to begin rebuilding the Full Text Search
indexes.
Duration to
Rebuild
Select Until Completion and the system will completely rebuild the search
indexes. Select a specific amount of time and the system will rebuild the
search indexes for the allotted time. It is recommended that this value is set
to a minimum of one hour. The search indexes may not be fully rebuilt when
the system stops.
Status of
Last Rebuild
Displays the status of the last attempt of the system to rebuild the search
indexes.
Last Started
Displays the time the last rebuild of the search indexes began.
2007 Blackboard Inc. Proprietary and Confidential.
Page 459
Blackboard K–12 Academic Suite
©
Administrator Manual
F i e ld
Descript ion
Last
Finished
Displays the time the last rebuild of the search indexes finished.
Immediate
Update
If Yes is selected, the full text index will be updated as files are added or
modified. Select No, and the index will be updated when the Full Text
Search index is rebuilt during the next periodic index. Turning this option on
may impact performance. If the value in this field is changed, Tomcat must
be restarted for the new setting to take effect.
2007 Blackboard Inc. Proprietary and Confidential.
Page 460
Blackboard K–12 Academic Suite
Administrator Manual
Blackboard Content System Information
Overview
The System Information page displays information about the Blackboard Content System, such
as the build version and installation date.
Find this page
Follow these steps to open the System Information page.
1.
Open the Administrator Panel.
2.
Select System Information under Blackboard Content System.
Field
The information on this page is display only; none of the data may be modified.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 461
Blackboard K–12 Academic Suite
Administrator Manual
Customizing the User Interface
About Customizing the User Interface
This section is intended for Administrators to use while considering the setup and design of the
user interface for the Blackboard Content System. Before referencing this document, users
should be able to identify areas and tools of the Blackboard Content System. These include, but
are not limited to, the following
•
Content areas, such as My Content and Class Content
•
Tools, such as Portfolios and the Learning Objects Catalog
•
Actions that can be performed on an item, appearing in the action bar of the Content List
In this section
Customizing the User Interface includes the following topics.
©
T op i c
Descript ion
Tools and Actions
Describes available tools and actions and how they may be
customized.
System Availability versus
Display Options
Explains the difference between making tools available and
displaying them in the application.
Managing the Folder and
Shortcut views
Describes how to make manage the different Content Collection
Menu views.
Managing operations on
the action bar
Describes how to modify the action bar to suit the users' needs.
Factors to consider during
customization
Explains things that should be taken into account, such as
Institution regulations, when customizing the user interface.
2007 Blackboard Inc. Proprietary and Confidential.
Page 462
Blackboard K–12 Academic Suite
Administrator Manual
Tools and Actions
About Tools and Actions
Each type of activity in the Blackboard Content System is considered an action or a tool. An
action is performed on an item stored in the Blackboard Content System, such as Copy, Move, or
Remove. A tool is an operation or series of actions, and is displayed in the Content Collection
Menu (the left frame of the browser). Examples of tools include Portfolios and the Learning
Objects Catalog.
Customizing tools and actions
Tools and actions may be customized and controlled system-wide. This table lists tools and
actions, their locations in the Blackboard Content System, and how their appearance may be
customized.
©
T oo l or
A c t io n
D is p la y L o c at io n
Cu sto miz e D is p la y O p t io ns
e-Reserves
Sub-folder of Library
under section with
default name Institution
Content
Rename Shortcut
Learning
Objects
Catalog
Toolbox in the Content
Collection Menu
Rename shortcut and tool; Choose color of
header and text
Portfolios
Toolbox in the Content
Collection Menu
Rename shortcut and tool; Choose color of
header and text
Virtual Hard
Drive
First area in the
Content Collection
Menu, called My
Content by default
Rename shortcut and tool; Choose color of
header and text
Action bar
buttons (ten
operations)
Action bar above the
Content List
Choose to display each button including Web
Folders, Add Item, Add Folder, Copy, Move,
Remove, Workflows, Email Items, Bookmark
Items, and Download Items
2007 Blackboard Inc. Proprietary and Confidential.
Page 463
Blackboard K–12 Academic Suite
Administrator Manual
System Availability and Display Options
About System Availability and Display Options
All of the tools and actions in the Blackboard Content System may be made available or
unavailable system-wide. Administrators also control which users see the tool and the
appearance of the tool (such as font and color).
Manage System Availability and Display Options
System availability of a tool is controlled from the tool link in the Blackboard Content System area
on the Administrator Panel. Administrators using the Blackboard Community System may make
tools available to everyone on the system or only to users with specific Institution Roles. The
Display Options page allows Administrators to control whether a tool appears on the Content
Collection Menu. Administrators may also customize the appearance of a tool on the menu. The
following table explains these concepts
©
Wh at is t his ?
How is it ma nag ed ?
System
Availability
Make the tool available or
unavailable for the entire
system.
Each tool has its own link in the Blackboard
Content System area of the Administrator
Panel
Display
Options
Choose to hide or display a
tool or item and select its
appearance
Administrator Panel > Display Options
(In Blackboard Content System area)
2007 Blackboard Inc. Proprietary and Confidential.
Page 464
Blackboard K–12 Academic Suite
Administrator Manual
Folder and Shortcut Views
Managing the Folder and Shortcut views
There are a variety of tools available in the Blackboard Content System; each of these tools is
represented on both the Shortcut View and the Folder View. The Folder View displays more
information at a glance, while the Shortcut View provides only high level options. Both the
Shortcut and Folder Views allow the Administrator to customize the label for each tool. The
Folder View also allows the Administrator to customize the color of the header and label for each
tool.
Tip: Full Text Search does not index text from encrypted .pdf documents.
Manage Content List Display Options
Follow the steps below to manage the display of actions on the Action Bar
©
1.
Select Display Options in the Blackboard Content System area of the Administrator
Panel.
2.
Select Content List Display Options.
3.
Select Yes for each action that should display in the Action Bar.
2007 Blackboard Inc. Proprietary and Confidential.
Page 465
Blackboard K–12 Academic Suite
Administrator Manual
Managing Operations on the Action Bar
Manage the Action Bar
The Administrator may customize which actions are displayed on the Content List. Actions that
may be performed on items in the list appear in the Action Bar. Examples include Web Folder,
Copy, Remove, and Workflow Activities. Web Folders is a tool and an action item. The display of
this button on the action bar is selected on the Content List Display Options page, but system
availability of the tool is handled from the Web Folders link in the Administrator Panel.
Tip: If Web Folders are made unavailable on the system, it is good practice to
remove that action item from user view on the action bar .
Select Content Collection Menu options
Follow the steps below to change the name of a tool in the Shortcut View
1.
Select Display Options in the Blackboard Content System area of the Administrator
Panel.
2.
Select Manage Shortcut View.
3.
Click Manage next to the tool. The Properties page for the tool appears.
4. Enter the new name for the tool in the Shortcut Name field.
Follow the steps below to change the name of a tool in the Folder View
1.
Select Display Options in the Blackboard Content System area of the Administrator
Panel.
2.
Select Manage Folder View.
3.
Click Manage next to the tool. The Properties page for the tool appears.
4. Enter the new name for the tool in the Header Name field.
Follow the steps below to change the color of a tool in the Folder View
©
1.
Select Display Options in the Blackboard Content System area of the Administrator
Panel.
2.
Select Manage Folder View.
3.
Click Manage next to the tool. The Properties page for the tool appears.
4.
Select the colors of the background and text in the Header Color section.
2007 Blackboard Inc. Proprietary and Confidential.
Page 466
Blackboard K–12 Academic Suite
Administrator Manual
Factors to consider during customization
Factors to consider during customization
To determine the best display options for the Blackboard Content System, consider the user
interface elements from the perspective of the affected user groups and Institution standards.
Institution Color
Most Institutions have an established identity that includes a set of colors. The Blackboard K-12
Suite allows for color customization throughout, including the Content Collection Menu. It is
recommended to make color selections for all tools at one time, even if you plan on rolling out the
use of some tools later. This will make color selection a one-time task.
Tip: Highly contrasting colors make text easier to read. If an Institution’s colors
are not easy to read against one another, consider using black or white with the
colors.
Tools
Consider policy decisions that may affect the use of certain tools on the system. Portal clients
may consider making tools available to particular Institution Roles based on policy decisions and
rollout plans for the system.
Regulations
Consider any regulations that your Institution has placed on file-sharing, use of certain types of
files due to copyright laws, or hard drive space and availability. Discuss these regulations with
interested parties prior to setting up the Blackboard Content System.
Terminology
When displaying a tool for use, consider any Institution naming conventions that may be
appropriate. For example, if the Institution uses the term Section instead of Class, an appropriate
name for that area may be Class Content; if the Institution has been growing its Learning Objects
Catalog by another name, use that name for the toolbox header and shortcut label.
Teacher, Class Builder, Librarian, Catalog Manager, Learner Access
When setting the availability of tools, consider users who may need to access the tool before it is
ready for consumption by general system users. For example, when rolling out the Portfolio tool,
you may choose to only provide access to a pilot group of users, such as Professors (this option
is only available in the Blackboard Community System).
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 467
Blackboard K–12 Academic Suite
Administrator Manual
eCommerce
Overview
This part of the Administrator Manual covers managing the eCommerce features, specifically, the
eMarketplace and MyAccounts.
In this Part
This part contains the following sections.
©
S e c t io n s
Descript ion
eCommerce
Administration
Explains how to set up and configure the system to support the
eCommerce features.
eMarketplace
Explains how to manage and use the eMarketplace.
MyAccounts
Explains how to manage and use MyAccounts.
2007 Blackboard Inc. Proprietary and Confidential.
Page 468
Blackboard K–12 Academic Suite
Administrator Manual
eCommerce Administration
Overview
This section includes information on setting up and configuring the system to support the
eCommerce features.
In this section
This section contains the following topics.
©
T op i c
Descript ion
Introduction to
eCommerce
Describes the eCommerce features and how they work.
Install eCommerce
Explains how to install the hardware and software components
required for eCommerce.
Setup eCommerce
Explains how to configure the Blackboard Community System to
communicate with the Blackboard Transaction System and the
Payment Gateway.
eCommerce Roles
Reviews the new System Admin Roles associated with the
eCommerce features.
Reconciliation
Describes the reconciliation process.
Payment Gateway
Reports
Introduces the reporting tools available on the Payment Gateway.
2007 Blackboard Inc. Proprietary and Confidential.
Page 469
Blackboard K–12 Academic Suite
Administrator Manual
Introduction to eCommerce
About eCommerce
eCommerce is a technology that establishes a connection between the Blackboard Community
System and the Blackboard Transaction System and enables the eMarketplace, MyAccounts,
and Payment Gateway eCommerce features.
The eMarketplace enables users to purchase goods and services from the Institution and from
outside vendors.
MyAccounts enables users to manage their card account at the Institution from the Blackboard
Community System.
These features will allow administrators to set up a connection between the Blackboard
Community System™ and the Blackboard Transaction System™, and between the Bb
Community System and the Payment Gateway. The Payment Gateway enables credit card
processing for eMarketplace purchases and deposits into the Bb Transaction System accounts
via MyAccounts.
Keep in mind that the transactions generated through eCommerce must be reconciled. For more
information on reconciling transactions, see Reconciliation. Work with the appropriate finance
and technology groups at the Institution to ensure that transactions are completed.
eCommerce Features
The following features are added as a part of eCommerce.
©
•
The Transaction System Settings establishes a connection from the Bb Community
System to the BbTransaction System—UNIX Edition or Windows Edition.
•
The Payment Gateway is a credit card processing service powered by Clear
Commerce®. Contact Blackboard to create a client account on the Payment Gateway
prior to installation.
•
Once an account is setup on the Payment Gateway for an Institution, the Payment
Gateway Settings will allow the Administrator to specify the connection information as
well as card verification settings.
•
The Payment Gateway Reports feature provides a link to login to the external Payment
Gateway site. This site provides a number of reports on credit card transactions. The
Payment Gateway Reports are used on a regular basis for reconciliation of credit card
payments with MyAccounts and eMarketplace transactions.
•
The Manage Payment Methods function allows Administrators to enable and disable
the use of credit cards in the system. There is a fixed list of credit cards that clients may
select for use with the eMarketplace and MyAccounts. For each of these credit cards,
the Administrator may set up a convenience fee, which is either a fixed dollar amount or
a percentage of the transaction and is added to each credit card transaction that
deposits money into the Institution’s card office account.
2007 Blackboard Inc. Proprietary and Confidential.
Page 470
Blackboard K–12 Academic Suite
Administrator Manual
Install eCommerce Features
Installation Process
The eCommerce features are installed with the Blackboard Community System. Before using the
eCommerce features, some additional software must be installed to enable communication
between the Blackboard Community System and the Blackboard Transaction System. When
using the Blackboard Transaction System—UNIX Edition, a Lantronix device must also be set up
and installed. Please see the Setup Guide or Release notes for detailed information on installing
or updating the eCommerce features.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 471
Blackboard K–12 Academic Suite
Administrator Manual
Setup eCommerce
Managing eCommerce
Initial setup of eCommerce on the Bb Community System includes the following processes:
•
Configure Transaction System Settings
•
Configure Payment Gateway Settings
•
Configure Credit Card Options
These tasks will typically be done by the eCommerce Administrator, a new system role created to
allow privileges to users responsible for the administration of the eMarketplace and MyAccounts.
The eCommerce Administrator system role is available when Application Pack 3 is installed with
a Blackboard Community System license. The System Administrator also has access to these
features.
The eCommerce Administrator must work with the Blackboard Transaction System Administrator
to ensure a smooth integration. Make sure that all of the necessary prerequisites for eCommerce
are met before continuing.
The initial eCommerce Setup is configured with assistance from Blackboard. Please contact your
Blackboard Account Manager to arrange for the installation and configuration of eCommerce
features.
Configure Transaction System Settings
Follow these steps to establish a connection to the Blackboard Transaction System.
1.
Contact the Blackboard Transaction System Administrator and ask for the required
connection information. See the table below for specific information about each required
field. Ask the Blackboard Transaction System Administrator to create a Point of Sale
(POS) for the eMarketplace.
2.
Click Manage eCommerce from the Admin Panel.
3.
Click Transaction System Settings.
4.
Select the System Type.
5.
Complete the OptiServ Settings if connecting to a UNIX version of the Blackboard
Transaction System. Use the table below as a guide.
F i e ld
Descript ion
Server
The server name that hosts the OptiServ component. In most configurations, the
OptiServ component is installed on the Blackboard Community System server.
Port
The port used to communicate with the OptiServ component.
Key
The key used for Twofish encrypted communication with the Optiserv component.
This is a string representing a 128-bit hexadecimal number. Once set, the key
should not be changed. Changing the key will invalidate all existing card numbers
as the key is used to encrypt and decrypt card numbers.
The Key must be 16 characters.
6.
©
Enter the Network Configuration Properties. Use the table below as a guide.
2007 Blackboard Inc. Proprietary and Confidential.
Page 472
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Institution Name
The name of the Institution.
Card Description
A description of the card. For example, "My University Card."
Offline Message
A message that will display to users when the Blackboard Community
System cannot connect to the Blackboard Transaction System.
Transaction
System Host
Name
Fully qualified domain name or IP address of the Transaction System
Server. This value must not include a protocol.
TCP/IP Port
The port on the Transaction System server over which the two systems
will communicate. For UNIX, the default value is 2345. For Windows,
the default value is 3784.
Secret Key
28-bit Rijindael encryption key used to secure communications
between the systems.
Number of Retry
Failures
The number of attempts to connect to the Transaction System before
reporting an error.
Retry Timeout
Amount of time, in seconds, to wait while trying to connect to the
Transaction System before retrying. Set a value between 0 and 120.
Cardholder
Identifier
Attribute used to identify cardholders.
Card Number
Verification
Attributes used to confirm the identity of the card holder. Options
include the external person key or the Student ID. Further, First Name
and Last Name can be used for verification.
Guest Deposit
Identifier
The attribute Guests use to find an account. Options are: Card
Number, Student ID, and eMail. Guests are able to make deposits into
a User's account using the Guest Deposit module.
7.
Click Submit.
Configure Payment Gateway Settings
Follow these steps to configure the Payment Gateway.
©
1.
Contact Blackboard to create a Payment Gateway account. Blackboard will provide you
with the account information necessary to establish a connection.
2.
Click Manage eCommerce on the Admin Panel.
3.
Click Payment Gateway.
4.
Click Payment Gateway Settings.
5.
Fill out the fields. In most cases, the connection information for the Payment Gateway will
be supplied by your Account Manager at Blackboard. Use the table below as a guide
when filling out the fields.
F i e ld
Descript ion
Server Host
Host name of the Payment Gateway.
Server Port
Port on the Payment Gateway server.
Username
Username for logging into the Payment Gateway.
2007 Blackboard Inc. Proprietary and Confidential.
Page 473
Blackboard K–12 Academic Suite
Administrator Manual
F i e ld
Descript ion
Password
Password for logging into the Payment Gateway.
Customer
Email
Email address at the Institution that will receive messages from the Payment
Gateway.
Client ID
The Institution's ID at the Payment Gateway.
Card
Verification
Determines if a CV value is required to validate credit card transactions. The
CV value is a 3 or 4 digit number that appears on the credit card but is not a
part of the credit card number.
Mode
Select an option for testing. When the e-Commerce functions are ready for
users, change this setting to Production.
6.
Click Submit.
Configure Credit Card Options
Follow these steps to configure a brand of credit card for use in the system.
©
1.
Click Manage eCommerce on the Admin Panel.
2.
Click Payment Gateway.
3.
Click Manage Payment Methods.
4.
Click Modify for one of the listed credit card brands.
5.
Select Yes to make the credit card Available as a purchasing option.
6.
Select a Convenience Fee. The fee only applies to deposits through MyAccounts. The
options are None, Percentage, or Flat Rate.
7.
Click Submit.
2007 Blackboard Inc. Proprietary and Confidential.
Page 474
Blackboard K–12 Academic Suite
Administrator Manual
eCommerce Roles
About e-Commerce Roles
e-Commerce introduces several new features that require some updates to roles within the
system. Specifically, new administration roles are used to manage e-Commerce features and
existing user roles are expanded by the addition of new features.
eCommerce Admin Roles
The table below details the new Admin roles associated with eCommerce.
Role
Descript ion
eCommerce Admin
Privileges to manage all aspects of the eCommerce features.
eMarketplace Admin
Privileges to manage categories, vendors, products, and orders in
the eMarketplace.
Card Office
Administrator
Privileges to manage card-related activities.
User Roles and eCommerce
The table below details how different users interact with the eCommerce features.
©
Role
Descript ion
User
Users may purchase items from the eMarketplace Tab and manage their card
account from the MyAccounts module.
Guest
Guests may make a deposit in a user's card account using the Guest Deposit
module.
Vendor
Vendors have access to manage their own products directly from the eMarketplace
tab. Vendor is not an actual role, rather, it is a designation assigned by the
Administrator that allows a user to offer products for sale.
2007 Blackboard Inc. Proprietary and Confidential.
Page 475
Blackboard K–12 Academic Suite
Administrator Manual
Reconciliation
About Reconciliation
Reconciliation is the process of verifying that all funds are processed correctly. Reconciliation is a
manual process that requires a financial administrator at the Institution to review transactions and
make payments to the appropriate vendors.
Reconciling transactions regularly will ensure successful business practices. Daily reconciliation
will ensure that the process does not grow too cumbersome.
Reconcile Campus Card Purchases and Deposits
Products ordered from the eMarketplace and paid for with a card issued by the Institution and are
automatically debited from the Blackboard Transaction System. Reconciliation verifies that
transactions were handled properly.
Remember that Vendors should be paid after orders are fulfilled!
The steps below outline a sample process that may be followed to reconcile purchases made with
an Institution card.
1.
Create an email folder and an email rule to separate and store all incoming messages
that include "Deposit Confirmation" in the Subject. MyAccounts will generate an email
when a deposit is successfully made.
2.
Print and total the email messages for a date range.
3.
Login to the Blackboard Community System.
4.
Click Manage Orders from the Admin Panel.
5.
View Orders where the fulfillment date occurs during the date range. Narrow down the list
by sorting where Payment Type is Campus Card and Status is Fulfilled.
6.
Print the list of orders.
7.
Login to the Blackboard Transaction System. Create and run a report showing deposits
and Campus Card orders.
8.
Compare the totals on the Transaction System report to the Deposit Confirmations and
fulfilled orders.
9.
Keep a record of these daily totals to reconcile with your bank statements at the end of
the month.
Reconcile Purchases Made with a Credit Card
Credit card transactions are processed through the Payment Gateway. The Payment Gateway
interacts with the credit card company to obtain pre-authorization and debit funds when the order
has been fulfilled. Funds are paid to the Institution. It is the responsibility of the Institution to then
pay vendors.
The steps below outline a sample process that may be followed to reconcile credit card
transactions.
©
1.
Login to the Blackboard Community System.
2.
Click Manage eCommerce on the Admin Panel.
2007 Blackboard Inc. Proprietary and Confidential.
Page 476
Blackboard K–12 Academic Suite
Administrator Manual
3.
Click Payment Gateway Reports.
4.
Login to the Payment Gateway.
5.
Generate a report of transactions for a date range with a Transaction State of Shipped
and a Transaction Result of Approved.
6.
Return to the Blackboard Community System Admin Panel.
7.
Click Manage Orders from the Admin Panel.
8.
View Orders where the fulfillment date occurs during the date range. Narrow down the list
by sorting where Payment Type is Credit Card and Status is Fulfilled.
9.
Print the list of orders.
10. Compare the fulfilled orders and completed transactions. At this time, make payments to
vendors for fulfilled orders.
11. Keep a record of these daily totals to reconcile with your bank statements at the end of
the month.
The Payment Gateway includes a help system powered by ClearCommerce with detailed
information on generating reports. Click Help anywhere in the Payment Gateway to access the
help system.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 477
Blackboard K–12 Academic Suite
Administrator Manual
Payment Gateway Reports
About Payment Gateway Reports
Payment Gateway Reports include valuable information for reconciling credit card transactions. It
is possible to generate reports on Orders based on date, status, approval, and even customer ID
or item ID.
Note: The Payment Gateway only manages credit card transactions. For reports
on transactions using a Campus Card, use the Blackboard Transaction System.
Additional Payment Gateway Features
Administrators are provided with the Payment Gateway login information during the Payment
Gateway setup process. The username and password entered in the Payment Gateway Settings
page are also used by the Administrator to login to the Payment Gateway. Administrators logging
into the Payment Gateway will find several additional features for managing credit card
transactions. Please consult the Payment Gateway help system for information on these features.
Please be aware modifications to the Risk Management features may result in the rejection of
some valid orders. Be careful when making any changes to these settings. Please see the help
system embedded in the Payment Gateway for more information.
View Reports from the Payment Gateway
Follow these steps to view reports.
©
1.
Click Manage eCommerce on the Admin Panel.
2.
Click Payment Gateway.
3.
Click Payment Gateway Reports. This link will only be active if the Payment Gateway is
properly configured.
4.
The page will be redirected to an authentication page for the Payment Gateway, which is
powered by ClearCommerce.
5.
Login to the Payment Gateway.
6.
Click the Orders tab.
7.
Click Orders.
8.
Select a date range and any other variables to create a report.
2007 Blackboard Inc. Proprietary and Confidential.
Page 478
Blackboard K–12 Academic Suite
Administrator Manual
eCommerce Reports
Overview
The eCommerce feature includes a set of reports for Administrators and Vendors. Reports are
viewable from the Admin Panel and the Vendor Tools module or can be extracted in tab-delimited
format for viewing in other applications such as spreadsheets.
These reports are useful when determining how much sales tax or convenience fees have been
collected and when reconciling purchases.
Access eMarketplace Reports
Follow these steps to access an eCommerce report:
1.
Click eCommerce on the Admin Panel.
2.
Click Reports.
3.
A page listing the reports available will appear. Click on a link to create a report.
eMarketplace Reports
eMarketplace reports include the following options:
•
Sales History: This report lists order details and the taxes collected for each order
listed in the report.
•
Total Sales: This report lists vendor details, the total products offered, and total sales in
units and dollars for each vendor listed in the report.
•
Product Movement: This report lists product details, the number of units sold, and the
total sales for each product listed in the report.
Follow these steps to generate a report:
©
1.
Click eCommerce on the Admin Panel.
2.
Click Reports.
3.
Click eMarketplace Reports.
4.
A page will appear with settings to configure the report.
5.
Select the type of report from the drop-down list. Select Sales History, Total Sales, or
Product Movement.
6.
Select a date range.
7.
Use the multi-select box to choose a Vendor or Vendors to include the report. Only
transactions involving those selected vendors will be included.
8.
Click Submit.
9.
The report will appear. The report may be sorted by clicking on the column heads and
Print and Export buttons appear in the action bar. Exported reports will be tab-delimited
files.
2007 Blackboard Inc. Proprietary and Confidential.
Page 479
Blackboard K–12 Academic Suite
Administrator Manual
MyAccounts Report
The MyAccounts report lists the total deposits and convenience fees collected for each account.
Follow these steps to generate a report:
©
1.
Click eCommerce on the Admin Panel.
2.
Click Reports.
3.
Click MyAccounts Report.
4.
A page will appear with settings to configure the report.
5.
Use the multi-select box to choose accounts to include the report. Only transactions
involving those accounts will be included.
6.
Select a date range.
7.
Click Submit.
8.
The report will appear. The report may be sorted by clicking on the column heads and
Print and Export buttons appear in the action bar. Exported reports will be tab-delimited
files.
2007 Blackboard Inc. Proprietary and Confidential.
Page 480
Blackboard K–12 Academic Suite
Administrator Manual
eMarketplace
Overview
This section includes information on managing the eMarketplace.
In this section
This section contains the following topics.
©
T op i c
Descript ion
Introduction to the
eMarketplace
Explains what the eMarketplace does and how users interact
with it.
eMarketplace Administration
Reviews how to enable and manage the eMarketplace.
Building the eMarketplace
Provides instructions for creating categories, vendors, and
products.
Manage Orders
Describes how to manage orders.
2007 Blackboard Inc. Proprietary and Confidential.
Page 481
Blackboard K–12 Academic Suite
Administrator Manual
Introduction to the eMarketplace
About the eMarketplace
The eMarketplace provides a mechanism to display and sell items to users. It appears as a Tab
to users.
Products are organized into nested categories and the entire list of products is searchable.
Products can include hard goods, services, even enrollment in Classes and Organizations. The
eMarketplace is fully integrated with the Blackboard K-12 Suite. In addition to enrollments, some
typical services that may be offered for purchase include transcripts, tickets to events, or even
parking and dining services.
Users access the store through the eMarketplace tab. Users are able to make purchases using a
credit card or their Campus Card. The eMarketplace deploys fraud protection rules for credit card
purchases through the payment gateway.
Purchasing Process
The steps below outline the purchasing process when using a Campus Card:
1.
User logs in and accesses the eMarketplace tab.
2.
The user selects products for purchase. Selected items are placed in the shopping cart.
3.
The user checks out and provides payment information. If a Campus Card is used for
purchase, availability of funds is confirmed. Funds are not debited until the order is
fulfilled.
4.
A notification email is sent to the Vendor.
5.
The Vendor fulfills the order by sending the products to the user and by indicating in the
Manage Orders page that the order is fulfilled. At this time, the post-authorization takes
place.
6.
Once the order is fulfilled, the Institution pays the Vendor with funds from the merchant
bank.
7.
The transaction is reconciled by comparing a report on fulfilled orders, a report from the
Transaction System regarding debits and deposits from Campus Card accounts, and the
statement from the merchant bank.
The steps below outline the purchasing process when using a credit card:
©
1.
User logs in and accesses the eMarketplace tab.
2.
The user selects products for purchase. Selected items are placed in the shopping cart.
3.
The user checks out and provides payment information. If a credit card is used for
purchase, the Payment Gateway first pre-authorizes the payment. Pre-authorization
confirms that the purchase will be paid for by the issuing bank or credit card company.
4.
A notification email is sent to the Vendor.
5.
The Vendor fulfills the order by sending the products to the user.
6.
Once the order is fulfilled, the purchase is authorized. Funds are deposited with the
merchant bank. The Institution pays the Vendor with funds from the merchant bank.
7.
The transaction is reconciled by comparing a report on fulfilled orders, a report from the
Payment Gateway, and the statement from the merchant bank.
2007 Blackboard Inc. Proprietary and Confidential.
Page 482
Blackboard K–12 Academic Suite
Administrator Manual
Purchasing Items and Services
Each available item in the eMarketplace has an Add to Cart button. Some items also require the
user to enter additional information. For example, the user may need to enter a size and color if
purchasing a t-shirt from the store. When a user decides to purchase a product, they must first
enter any required information and then click the “Add to Cart” button. The item is then added to
the Shopping Cart, an abbreviated version of which is displayed in the left, menu column of the
eMarketplace.
When the user has selected all of the items for purchase, the user must click the Checkout button
in the menu column Shopping Cart. This will direct the user to the full Shopping Cart page. On
this page, the user can update the quantities of each item, remove items from the cart, continue
shopping, or proceed to the Checkout screen. The user enters their billing information on the
Checkout page. Once Checkout is completed, the user may view and confirm their order details
one last time on the Order Confirmation page, which also includes the sales tax, if applicable.
Once the final confirmation takes place, a pre-authorization transaction is initiated. If the user’s
credit card or Campus Card account has sufficient funds for the transaction, the order is placed
and the user receives a confirmation e-mail for the order. The order is then ready for processing.
Processing Orders
When a user places an order in the eMarketplace, the order is automatically divided up into
multiple orders by Vendor of each product and by product type.
Class and Organization products are automatically fulfilled when the order is placed, so all of
these products within the purchase are separated into one order. The payment for this order is
processed immediately. If the transfer of funds is successful, the user is automatically enrolled in
each of the Classes and Organizations within the order.
Other types of products require manual fulfillment by either a Vendor or an eMarketplace Admin.
All of these product types within the order are divided up by Vendor. This is done to ensure that
each vendor can see and access orders for their products only. When the order is placed, a preauthorization transaction takes place. This ensures that the funds are available for the purchase.
If a credit card is being used, a temporary freeze is placed on the pre-authorized funds.
Vendors will check their orders on a regular basis and receive email notification of each order.
When one of their products is ordered, it will appear in the Orders page accessible by the Vendor
from any page in the actual marketplace. The Vendor will click on the Process button for the order
to view all of the items included in the order. Each item will have a Fulfill button.
There is also a Cancel button for each item. When the item is cancelled, if it is the last item
remaining in the order, the post-authorization takes place at that time. If there are remaining items
to be fulfilled, then the item is marked as cancelled and the rest of the order remains open.
When each purchased item is ready for shipment, the Vendor will click Fulfill. When the last item
in the order is fulfilled, a post-authorization transaction will be initiated. If this transaction is
successful, the Vendor will receive a success receipt. Otherwise, the Vendor will receive a failure
receipt. Also, the user who placed the order will receive an e-mail notification that the order has
been fulfilled. Since it is possible for a post-authorization transaction to fail, Vendors should not
ship order items until a successful post-authorization has taken place.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 483
Blackboard K–12 Academic Suite
Administrator Manual
eMarketplace Administration
Managing the eMarketplace
Administrators may manage the eMarketplace but will probably assign the Admin role of
eMarketplace Admin to another user. An eMarketplace Admin can manage categories, products,
vendors, and orders in the eMarketplace. Aside from managing the eMarketplace, an
eMarketplace Admin would likely be responsible for some of the fulfillment tasks and all
reconciliation tasks.
The eMarketplace Admin is responsible for maintaining the content and Organization of the
eMarketplace. This is done through the Manage Categories and Manage Products pages. The
top level of the eMarketplace can contain other Categories or product items. The Administrator
will generally set up a series of top-level Categories that represent the main categories of
products contained within the eMarketplace. Each of these Categories may contain any number
of nested Categories, each of which can in turn contain more nested Categories, and so on.
Categories can be given a name and label, and can be made available or unavailable at any time.
Additionally, the eMarketplace Admin can create a header to be displayed at the top of the
Category page in the marketplace.
Each Category can also contain any number of product items. These are managed separately on
the Manage Products page. Products have a number of configurable features. In addition to
providing a name, description, image, and price for each product, Administrators can place a
product in any number of categories, delegate a product to a Vendor, set the availability of a
product, and designate the number of items available in inventory or the number of available
enrollments, if the product is a Class or Organization product.
A eMarketplace Admin will typically set up the Categories during the initial setup of the store.
Additional Categories may be added as more campus entities take advantage of the
eMarketplace. Products may be added to the store and removed from the store throughout the
year.
Vendors are responsible for managing their products in the store and fulfilling orders. Vendors do
not have access to the Administrator Panel, however they do have an area in the eMarketplace
that gives them access to the Manage Orders and Manage Products administrative functions.
Vendors only have privileges for their own products.
Keep in mind that any user can be designated as a Vendor by the Administrator. Vendors are
entities created in the eMarketplace and are not actual roles.
Taxing Products
Sales tax laws governing e-Commerce are complicated and subject to change. For this reason,
the sales tax for each item is configurable. A default tax rate can be set when configuring the eMarketplace. Sales tax should be applied in accordance with local, state, and Federal law.
Configure the eMarketplace
Follow these steps to configure the eMarketplace.
©
1.
Click Manage eCommerce from the Admin Panel.
2.
Click eMarketplace Settings.
2007 Blackboard Inc. Proprietary and Confidential.
Page 484
Blackboard K–12 Academic Suite
Administrator Manual
3.
Enter an eMarketplace Name. This name will also act as the top-level category in the
eMarketplace.
4.
Add a description for the eMarketplace. This will act as the header for the --Top-category.
5.
Enter an eMarketplace Email. This is the email account that will send out messages on
behalf of the eMarketplace.
6.
Enter a Default Tax Rate. This field is required. The value entered here appears in the
Tax Rate field for all products, although the Tax Rate can be changed for individual
products.
7. Click Submit.
The eMarketplace appears as a Tab in the Blackboard Community System. Enable and modify
the eMarketplace Tab just like any other Tab. The tab can be made available to particular
Institution Roles.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 485
Blackboard K–12 Academic Suite
Administrator Manual
Building the eMarketplace
Add or Modify an eMarketplace Category
Follow these steps to add or modify an eMarketplace Category.
1.
Click Manage eCommerce from the Admin Panel.
2.
Click Manage eMarketplace Categories.
3.
Click Add Category or click Modify for an existing category.
4.
Enter a Category Name and a Category Label. The Category Name is a unique ID that
identifies the category for administrative purposes. The Category Label is shown to
users in the eMarketplace.
5.
Enter a Description for the category.
6.
Categories may be nested inside other categories. If applicable, select a Parent
Category from the drop-down list.
7.
Select Yes to make the category Available in the eMarketplace.
8.
Click Submit. The Manage eMarketplace Categories page will appear.
9.
If appropriate, click the number in the Items in Category column to view the Manage
Products page for a category. Products are added and assigned categories from this
page.
Subcategories that are marked as available will not be shown if a parent category is unavailable.
Making a parent category available will not make unavailable subcategories available.
Remove Categories from the eMarketplace
Follow these steps to remove categories from the eMarketplace.
1.
Click Manage eCommerce from the Admin Panel.
2.
Click Manage eMarketplace Categories.
3.
Select the categories to remove.
4.
Click Remove Categories.
5.
The categories will be removed from the eMarketplace. Removing a category will also
remove any nested categories. Any products that not associated with a category after the
categories are deleted will be found under the parent category None.
Add or Modify a Product
Follow these steps to add or modify a product.
©
1.
Click Manage eCommerce from the Admin Panel.
2.
Click Manage Products.
3.
Click Add Product, Add Class Product, Add Organization Product, or Modify for an
existing product.
4.
If the Product is a Class or Organization, a field will appear to add the Course ID or
Organization ID. This value is required.
2007 Blackboard Inc. Proprietary and Confidential.
Page 486
Blackboard K–12 Academic Suite
Administrator Manual
5.
Enter a Product Name and a Product ID. The Product Name is required. The Product
ID is not required but may be useful for storing information such as a Universal Product
Code (UPC).
6.
Select Categories for the product. The product will appear under the Selected
Categories in the eMarketplace. If no categories are selected, the product will not appear
in the eMarketplace.
7.
Select a Vendor from the drop-down list.
8.
Enter a Description of the product.
9.
Select Yes if Buyer's Input is required to complete the order. Buyer's Input can be used
to specify a size or color. Include details on the required input in the Special
Instructions field. When users purchase the item, they will be asked to supply the
required information.
10. Click Browse to locate and upload an image of the product. The image should be 94 x
128 pixels. This may be left blank, although images are helpful to users.
11. Select Yes or No for User-Defined Price. If Yes is selected, users will determine how
much they pay for the product or service. This is useful when processing donations or
similar situations where the price is variable.
12. Enter a Price. (Only if User-Defined Price is set to No.)
13. Select Yes if the item is Tax Exempt. If the item is not tax exempt, the Tax Rate will
default to the value specified by the administrator in the eMarketplace Settings. Select No
and enter a Tax Rate to change the amount of tax withheld for the item.
14. Select Yes to make the product Available. Availability can be controlled by setting
Available Dates.
15. Enter a number in the Items in Inventory field to track the quantity in stock. When this
number reaches zero, the Order button will no longer appear next to the product. When
stock is replenished, update this value and the Order button will appear again. Leave this
field blank and the Order button will always appear.
16. Click Submit.
Classes and Organizations can be added as products to allow Users to pay for a class and enroll
through the eMarketplace. This is particularly useful for distance-learning Classes. When adding
a Class or Organization as a product, use Available Enrollments or Available Memberships to
limit enrollment to a set number of users.
Remove Products
Follow these steps to remove a product. When removing a product, keep in mind that outstanding
orders will remain in the system but the product will no longer appear in the eMarketplace.
1.
Click Manage eCommerce from the Admin Panel.
2.
Click Manage Products.
3.
Select products and click Remove.
Add or Modify a Vendor
Follow these steps to add or modify a vendor to the eMarketplace.
1.
©
Create a User account and assign the appropriate administrative privileges for the
vendor.
2007 Blackboard Inc. Proprietary and Confidential.
Page 487
Blackboard K–12 Academic Suite
Administrator Manual
2.
Click Manage eCommerce from the Admin Panel.
3.
Click Manage Vendors.
4.
Click Add Vendor or Modify for an existing vendor.
5.
Enter a Name for the vendor. This Name will appear in the eMarketplace.
6.
Enter a short Description of the vendor. This description is only viewed on this page.
Enter an Email Address for the vendor. Email notifications will be sent to this email
address when a product offered by the vendor is purchased. Enter a Phone Number for
the vendor.
7.
Enter the Username for the vendor or click Browse to search and then select a
Username.
8.
Click Submit.
Remove a Vendor
Follow these steps to remove a vendor from the eMarketplace. A vendor cannot be removed if
there are any open orders associated with the vendor.
©
1.
Click Manage eCommerce from the Admin Panel.
2.
Click Manage Vendors.
3.
Select the vendors to remove.
4.
Click Remove Vendor.
2007 Blackboard Inc. Proprietary and Confidential.
Page 488
Blackboard K–12 Academic Suite
Administrator Manual
Manage Orders
About Manage Orders
Manage Orders is a tool for Vendors and Administrators to fulfill or reject product orders.
Administrators may access Manage Orders from the Admin Panel. Vendors are shown a link on
the eMarketplace to Manage Orders.
Search for an Order
The Manage Orders page includes several options for locating an order. Keep in mind that
Vendors can only view orders for products that they sell. From the Manage Orders page, the
following display options are available:
•
All Open Orders
•
All Fulfilled Orders
•
All Partially Fulfilled Orders
•
Orders in Past Week
•
Orders in Past Month
•
Orders in Past Year
When the search is returned only those orders matching the display option will be shown.
From the Manage Orders page, the following search options are available:
•
Order Number
•
Buyer's Username
•
Product ID
•
Product Name
•
Vendor
•
Order ID
•
Authorization Code
The search will return orders that match the search string for the specified option.
The list of orders returned from a search will include an option to View fulfilled orders and
canceled orders or Process unfulfilled orders or partially fulfilled orders.
Process an Order
Follow these steps to process an order.
©
1.
Open the Manage Orders page from the eMarketplace tab or the Admin Panel.
2.
Find the order using the search function or selecting the Display All Open Orders filter
option.
3.
Click Process.
2007 Blackboard Inc. Proprietary and Confidential.
Page 489
Blackboard K–12 Academic Suite
4.
Administrator Manual
The Process Order page will appear. This page shows the Buyer Information as well
as the Order Information. Each product ordered is shown.
5.
Click Fulfill after preparing the product for shipping. Make sure that payment is
authorized before shipping! If a product is unavailable or for some other reason will not
be fulfilled, click Cancel.
If not all items are shipped at the same time, the order is partially fulfilled. When all items are
shipped or canceled, the order is fulfilled.
Remove an Order
Completed orders may be removed from the system. Orders should be removed based on the
Vendor's business and the Institution's business rules. Be sure to keep orders as long as
necessary to properly record any information needed for accounting.
Follow these steps to remove orders.
©
1.
Open the Manage Orders page from the e-Marketplace tab or the Admin Panel.
2.
Find the orders to remove using the search function or selecting the Display All Fulfilled
Orders filter option.
3.
Check the box for each order to remove.
4.
Click Remove.
2007 Blackboard Inc. Proprietary and Confidential.
Page 490
Blackboard K–12 Academic Suite
Administrator Manual
MyAccounts
Overview
This section includes information on managing MyAccounts.
In this chapter
This section contains the following topics.
©
T op i c
Descript ion
Introduction to
MyAccounts
Explains MyAccounts and how users interact with it.
MyAccounts Modules
Provides information on defining and deploying the MyAccounts
module.
MyAccounts
Administration
Describes how to manage MyAccounts.
Card Numbers
Explains the Card Number attribute.
2007 Blackboard Inc. Proprietary and Confidential.
Page 491
Blackboard K–12 Academic Suite
Administrator Manual
Introduction to My Accounts
About MyAccounts
MyAccounts is a tool for users to manage the funds on their campus card.
MyAccounts Features
The MyAccounts adds the following functionalities to the Community System:
©
•
The Manage Card Accounts functionality retrieves accounts from the Blackboard
Transaction System and allows Administrators to configure settings for each account.
Configurable settings include setting up deposit minimums, maximums, and increments,
as well as enabling or disabling all users to view their account balances, view their
transaction history, and deposit funds into accounts. These settings apply to the viewing
and making transactions through MyAccounts only. These settings do not change any
Transaction System settings.
•
The MyAccounts Module gives end users access to information about their card
accounts, and allows them to make deposits into their accounts.
•
The Modify MyAccounts Module feature allows Administrators to modify the contents
of the MyAccounts module, including a header and footer and the availability, name and
description for account functions within the module. Users also have access to a limited
version of this feature, which allows them to enable or disable the display of account
functions within the module.
•
The Guest Deposit feature allows other system users and guest users to make deposits
into a user’s card account. The Guest Deposit feature includes a Guest Deposit module
and an actual deposit page. With this feature, a user does not have to give out
Blackboard login information to allow a non-Blackboard user, such as a parent, to make
a deposit into the user’s account.
•
The Reg-E Formatted Statement function allows users to view statements, similar to
bank statements, for their card accounts. The Reg-E Formatted Statement Settings
feature allows the Administrator to configure Reg-E Formatted reports, specifically the
number of statements created per month and the header, footer, and contact information
that should be printed on the statements. The Account Statements account function in
the MyAccounts module allows users to view these statements.
2007 Blackboard Inc. Proprietary and Confidential.
Page 492
Blackboard K–12 Academic Suite
Administrator Manual
MyAccounts Modules
About the MyAccounts Module
The MyAccounts module can provide any of the following account functions, if enabled by the
either the Community System or Card Office Administrator and also enabled by user (Users have
limited control over the modules that appear on Tabs):
•
View Account Balances: This function displays the balances of each card account
directly on the My Accounts module. It provides a quick way for users to check their
account balances. As with all account functions, users can disable this feature to prevent
anyone from viewing their account balances.
•
View Transaction History: Allows end users to view their past card transactions,
including both debits and deposits. Depending on the length of time designated in the Bb
Transaction System for storage of transaction information prior to archiving, this section
can show anywhere from a few days to a few months worth of transactions. Users can
filter transactions by various criteria, including date range and account.
•
View Account Statements: Allows end users to view and print Reg-E Formatted
statements. These statements may not be fully compliant with Regulation E, which
governs the implementation of statements for online financial transactions, but they do
contain all of the information required by this regulation.
•
Deposit Funds: Allows end users to deposit funds directly into card accounts in the
Transaction System.
•
Report Lost or Stolen Card: This account function is available only with the Blackboard
Transaction System – UNIX Edition. If available, this feature allows users to report their
card lost or stolen, placing a freeze on any usage of the card. Users must contact their
Card Office to obtain and activate a new card.
•
Suspend Card: This account function is available to both Unix and Windows editions of
the Blackboard Transaction System. It allows users to temporarily suspend usage of
their card, if for example, they are unable to locate their card but believe they will find it.
Since there is generally a fee associated with obtaining a new campus card, this feature
is commonly used to give the user time to locate their card without risking fraudulent
usage of the lost card. Note that suspending a card does not prevent deposits from
being made to the account.
•
E-mail Notifications: This function allows users to request e-mail notifications when a
new account statement is available or when each of their account balances drop below
certain levels.
End users will use the MyAccounts functionalities on a regular basis. Typically, cardholders make
only 1-2 deposits into their card accounts outside of the initial deposit per semester. The
Lost/Stolen Card and Suspend Card functions will also be used on a more limited basis. The
account functions that allow users to monitor their account transactions, namely Transaction
History and Account Statements, will be used on a more regular basis.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 493
Blackboard K–12 Academic Suite
Administrator Manual
About the Guest Deposit Module
The Guest Deposit module contains three form fields: First Name, Last Name, and one other
identifier field. The third identifier field is determined by the Guest Deposit Identifier setting in the
Transaction System Settings administrative page. This setting allows the administrator to select a
value, such as the Card Number or Student ID, which the system should use to identify the
account into which a guest deposit should be made. If Student ID is selected, for example, the
depositor must enter the account user’s First Name, Last Name, and Student ID, in the Guest
Deposit Module before proceeding with the deposit.
Upon submitting the form fields in the Guest Deposit Module, the user’s account information is
retrieved and the depositor is directed to the Guest Deposit page. On this page, the depositor
must only select the user’s account into which the deposit should be made, and enter the billing
information and the amount of the deposit to be made into the account. Currently, only credit
cards are accepted as payment methods for a deposit into a card account. If the credit card
transaction is authorized, funds are automatically transferred.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 494
Blackboard K–12 Academic Suite
Administrator Manual
MyAccounts Administration
Managing the MyAccounts features
These administrative features will be used primarily by the Card Office Administrator, however the
eCommerce Administrator and System Administrator will also have access to all of these
features. Student, faculty, and other types of users with Campus Card accounts will use the
MyAccounts Module and its related functions. Guest users will primarily use the Guest Deposit
Module functions, however any logged-in Portal user can also make a Guest Deposit into any
other user’s account.
These features will be available to Bb Community System users only. The administrative features
of MyAccounts are located in the new Manage eCommerce section of the Community System
Management area of the Administrator Panel. The MyAccounts module will appear either in a
module tab—likely the My Institution tab—or as the sole module in a MyAccounts tab.
Guest Deposit modules will also appear in module tabs, however this particular module will
generally be used in tabs for which Direct Access is enabled.
Manage Accounts
Accounts, or Funds, are storage areas for user funds. For example, an Institution may set up a
Dining Account, Laundry Account, Vending Machine Account, and Bookstore Account. User
funds spent on different purchases are drawn from the separate Accounts.
Accounts are synched automatically with information from the Blackboard Transaction System.
Administrators may set rules regarding deposits and access to viewing account information.
Modify Account Attributes
Follow these steps to change the account attributes within the Blackboard Community System.
©
1.
Click Manage eCommerce from the Admin Panel.
2.
Click Manage Card Accounts.
3.
Click Modify for an account.
4.
Enter a Minimum Deposit amount and a Maximum Deposit amount. The default values
are $1.00 and $9999.99.
5.
Enter a Deposit Increment. User deposits must be divisible by this amount. For
example, an increment of $20.00 will allow deposits of $40.00 and $60.00 but not a
deposit of $50.00.
6.
Select Deposit Funds to allow users to add funds to this account through the
MyAccounts module.
7.
Select View Balance to allow users to view the balance on this account through the
MyAccounts module.
8.
Select Query History to allow users to view transaction history from the MyAccounts
module.
9.
Click Submit to finalize changes.
2007 Blackboard Inc. Proprietary and Confidential.
Page 495
Blackboard K–12 Academic Suite
Administrator Manual
Setup the MyAccounts Module
The MyAccounts module properties are configured just like other modules. The Contents of the
MyAccounts module can be customized to rename or remove functions of the module. Follow
these steps to edit the contents of the MyAccounts module.
1.
Click Manage Modules from the Admin Panel.
2.
Locate and modify the MyAccounts module or add a new module of the MyAccounts
type.
3.
Click Contents. The Modify MyAccounts page will appear showing a table appears listing
all the functions of the module.
4.
Click Modify for a function.
5.
Change the Title and Description of the function.
6.
Select the checkbox to make the function Available.
7. Click Submit.
Follow these steps to change the module header and footer.
1.
Click Header and Footer from the Modify Online Card Office page.
2.
Enter a new header and footer.
3.
Click Submit.
Setup Regulation-E Formatted Statements
Follow these steps to define the information that appears on Regulation-E Formatted statements.
©
1.
Click Manage eCommerce on the Admin Panel.
2.
Click Reg-E Formatted Statement Configuration.
3.
Fill out the required Contact Information. An option also appears to include a note on
the statement.
4.
Select the Number of Statements and the Starting Day of Report. The number of
statements sets the number of statements available to users. For example, if 2 is
selected, users will be able to view the last two available monthly statements.
5.
Click Submit.
2007 Blackboard Inc. Proprietary and Confidential.
Page 496
Blackboard K–12 Academic Suite
Administrator Manual
Card Numbers
About Card Numbers
Card numbers identify the campus card and enable purchases and deposits. The card number is
stored as part of the user account in the Blackboard Community System. The card number in the
Blackboard Community System must match the card number in the Blackboard Transaction
System.
Cards are stored in an encrypted state for security purposes. Keep in mind that an unencrypted
card number is a security risk. Also, since the systems decrypt each card number before use, an
unencrypted card number will be decrypted into an form unusable form by the system.
Card numbers are first generated in the Blackboard Transaction System. Once the card number
has been generated, it must be added to the Blackboard Community System by modifying the
User Properties.
Management of card accounts is done through the Blackboard Transaction System. Please
consult the Blackboard Transaction System documentation for more information about managing
accounts.
Add a Card Number to a User Through the Personal Information Tool
Users may add a card number to their account by editing their Personal Information. The card
number is entered into the field unencrypted and the system encrypts the file. Administrators may
also enter card numbers in the same way by editing the User Properties. This is a lengthy
process that can be done very quickly through the Snapshot tool.
Add a Card Number to a Group of Users Through the Snapshot Tool
Snapshot is used to upload data into the Blackboard Community System. A feed file is generated
with data from another campus information system and added to the Blackboard Community
System. In this case, the data is generated from the Blackboard Transaction System.
Please consult the Blackboard Transaction System documentation for more information on
generating an output file of users and card numbers.
To accommodate the eMarketplace, two important additions have been made to the standard
Snapshot process.
•
A new data field for users is now available. The new field is card_number in flat files and
<x_bb_cardnumber> in XML files. This data field should store the card number in either
its encrypted or unencrypted format.
•
A new property for the snapshot.properties file is now available. The new property is
encrypt.card.number. If the property is set to Y, the card numbers will be encrypted upon
import. If the property is set to N, the card number are assumed to already be encrypted
using the key shared by the Blackboard Transaction System and the Blackboard
Community System.
Also be aware that the Student ID and the External Person Key may also be used as the
Cardholder identifier.
For detailed information about using Snapshot please see the Blackboard K-12 Suite Advanced
Data Integration Manual.
©
2007 Blackboard Inc. Proprietary and Confidential.
Page 497
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement