Follow the steps below to create either the Root instance or an additional instance.
Launch the ELM Instance Management Tool (if it wasn’t already opened from the Installer) by entering its URL in your browser. The default URL is as follows:
- Log in to the Instance Management Tool using the credentials you defined during installation. The Create New Instance page will open.
Enter the Instance Name. Valid characters are all alphanumeric characters, underscores ( _ ) and hyphens ( - ). Maximum length is 64 characters.
If you are configuring the Root instance, you cannot edit the Instance Name.
(Optional) Select the bridges you wish to integrate with your ELM installation.
Select the database to be used with ELM:
If your Oracle database is version 11g, to select it choose Oracle 10g from the menu. If your Microsoft SQL Server database is version 2008, to select it choose Microsoft SQL Server 2005 from the menu.
If you select Microsoft SQL Server 2005, MySQL 5.0 or Oracle 10g, define the JDBC driver settings so ELM can connect to the database:
- JDBC Driver – The name of the JDBC driver used to connect to your database.
- JDBC User Id – The user ID required to connect to the database.
- JDBC Password – The password associated with the user name (above) required to connect to the database.
JDBC URL – The JDBC URL used to connect to your database.
If your institution requires UTF-8 character support, append the following parameter to the JDBC URL:
- JDBC Jar File – The .jar file that contains the database JDBC driver. Consult your database vendor for the most recent JDBC driver files.
Select the type of user authentication you intend to use.
- If you select Plain Text, passwords will be stored with no encryption in the database.
- If you select 3DES, passwords will be encrypted using the 3DES standard.
- If you select MD5, passwords will be encrypted using the MD5 standard.
- If you select LDAP, users (user names and passwords) will be authenticated against an LDAP server.
- If you select SHA, passwords will be encrypted using the SHA standard.
If you selected LDAP for user authentication, then this user is assumed to exist within the LDAP database and, other than the Admin Login Name field, the System Administrator Identification fields will not appear in the Instance Management Tool.
- Admin Login Name – The login name the Administrator will use to log in to ELM. Invalid characters are | # “ & < and >. Maximum length is 32 characters.
- First Name – The given name of the Administrator. Invalid characters are | # “ & < and >. Maximum length is 32 characters.
- Last Name – The surname of the Administrator. Invalid characters are | # “ & < and >. Maximum length is 32 characters.
Login Password – The Administrator’s password. Invalid characters are | # “ & < and >. Maximum length is 128 characters.
If you are editing existing Administrator identification information, to keep the existing password, leave this field blank.
- Email – The email address ELM will use to send/receive correspondence to/from the Administrator. It must conform to the format [local part]@ [domain part], where [local part] is mandatory and has a maximum of 64 characters and [domain part] is optional and has a maximum of 255 characters.
Configure the SMTP mail server.
- Mail Server – The name or IP address of the SMTP server used for sending out email invitations. This must be a valid mail server and a check will be performed.
- Server Port – The port number of the SMTP server used for sending out email invitations. Valid characters are integers between 1 and 65535.
- Uses TLS/SSL – Select this option if your mail server uses TLS/SSL to support encrypted data traffic.
- Requires Authentication – Select this option if you want ELM to send out email invitations through an SMTP server that requires authentication (username and password). Note: not all SMTP servers require this extra authentication.
If you selected Requires Authentication, user name and password fields will appear in the panel. Enter a User Name and Password for mail server authentication.
- User Name – The user name required for authentication through the SMTP mail server. Maximum length is 64 characters.
- Password – The password to be used with the SMTP mail server for the above user. Maximum length is 64 characters.
Identify the license to be used and, if desired, set up license partitioning. If you intend to partition the license be aware that only a portion of the license is available for use by this instance.
- License Key – The license key to be used. If only one license key is available, the name of the license key is displayed and the text box is a read only. If more than one license key is available, this field becomes a dropdown list containing the available license keys. Select one.
- Enable License Partitioning – If selected, this option enables license partitioning and only a portion of the license is available to this instance.
Enable Telephony Call Server – If selected, this option enables telephony for this instance. You will see this option only if you have already run the Telephony License installer.
If you selected Enable License Partitioning, the license partition size field will appear in the panel.
License Partition Size – The maximum number of licenses to allocate to this instance.
If you selected Enable Telephony Call Server, the Telephony License Key field will appear in the panel.
- Telephony License Key – The license key provided to you by Blackboard Collaborate. This field is pre-populated with the same key you used when installing the Telephony Call Server and the Telephony License. (For details about the Telephony Call Server and License, see the Telephony Call Server Installation and Configuration Guide. If more than one Telephony License has been installed, select one from the drop-down list.
Specify if you want the instance’s data backed up and, if so, how often and where. If you want ELM to perform backups automatically, keep the Enable Backup option selected and define the backup settings.
Enable Backup of Recording and Preload Files – If selected, recording and preload files will be included in backups (both manual and automatic).
This can dramatically increase the size of the backup file and the time it will take to perform a backup.
- Enable Automatic Backups – If selected, this option will automatically back up your instance data at the prescribed times (as defined by Days and Start Time) to the prescribed location (as defined by Use Default Location or Backup Files Folder).
- Days – The days on which you want backups automatically performed.
- Start Time – The time of day at which you want backups performed. Select the time from two drop-down lists: 24-hour clock list for the hour and 15 minute interval list for minutes. The default is 2:00 a.m. (0200).
Use Default Location – If selected, this option will back up files to the default location:
[Install Directory]/common/backups/[Instance Name]
If you de-selected Use Default Location, the Backup Files Folder field will appear in the panel.
Backup Files Folder – If not using the default location, this is the location where you wish to store the backup files. The system will automatically append
]to the end of the path. The folder must have a valid pathname for your operating system. Maximum length is 128 characters.
Note: You may not choose the root drive.
Backups are overwritten on a weekly basis. For each one of the days selected, you will see only one backup for that day.
Use Default Location – If selected, this option will store recordings in the default location:
[Install Directory]/manager/tomcat/webapps/[Instance Name]
If you de-selected Use Default Folder, the Recording Folder field will appear in the panel.
- Recordings Folder – If not using the default location, this is the location where you wish to store the recordings. The folder must have a valid pathname for your operating system. Maximum length is 128 characters.
Select the types of files that can be preloaded in a session.
The following extensions are supported by each type:
- Quicktime: .qt and .mov
- Shockwave Flash: .swf
- Blackboard Collaborate Whiteboard: .wbd and .wbp
- Blackboard Collaborate Plan: .elpx and .elp
- MPEG: .m4v, .mp4, .mpg, .mpeg, .mpe ad .mp3
- Windows Media: .wmv
- If you opted to use LDAP for user authentication, the Configure LDAP page will open.
- If you opted to configure your instance with a bridge (but not LDAP), the Configure Bridge page will open.
- If you are not configuring your instance with LDAP or a bridge, the Instance Summary page will open.
Review the summary information on the Instance Summary page. Click Create to save your configuration. To revise any of the values, click Previous and make the desired changes.
When you are creating the Root instance, there is no option to Cancel.
When the creation of your instance is complete, you will see a confirmation page. This page instructs you to copy the ELMDefault.tmpl file to the [Install Dir]/server/sessions directories of all the Blackboard Collaborate session servers you have installed on other machines.
Click Home to go to the Instances page.
There may be a short delay before you see the link for your new instance.
If you opted to use LDAP for user authentication during the configuration of a new instance, you will be presented with the LDAP configuration page. You will also see this page when you edit an existing LDAP instance or portions of the page when you upgrade an existing LDAP instance.
If you are running multiple authentication trees, contact Technical Support for assistance with LDAP configuration.
You can configure LDAP with multiple domains to enable users from multiple LDAP data stores to log in to ELM. While each domain administrator will maintain their own users, members from all domains will be able to log in to ELM using their local LDAP credentials.
It is important to note that LDAP domains are listed in the order that they will be searched to authenticate a user during the login process. If you have more than one Domain defined, you can move them up and down in the list.
You also can configure each LDAP domain with failover servers, where each domain has a primary, secondary, etc. server (identically structured and containing the same data). If the primary server fails, ELM will connect to the secondary server but will keep trying to reconnect back to the primary server. ELM will connect to the tertiary server only if it was unsuccessful in reconnecting with the primary server and the secondary server fails.
Finally, you need to configure the information required by ELM to communicate with an LDAP domain and map the attributes within the LDAP datastore with the fields in ELM. The mappings are a set of LDAP attribute names used to retrieve the set of users or lists defined in the LDAP datastore.
For security reasons, ELM does not write back or store any records in the LDAP datastore.
There are three basic steps involved in configuring LDAP:
- Configure a domain.
- Configure servers for the domain.
- Configure the attributes of each server.
See the steps below for detailed instructions.
Creating and Configuring Domains and Failover Servers
Domains is a list of the configured LDAP domains to which ELM will connect. An item in the list of Domains is populated with data you enter in the Display Name and Authenticated Access fields.
The Domain is pre-populated with template data to show you the type of information that is required in each field.
For the first Domain, replace the template values in the following fields with the values required to connect to your LDAP domain.
- Display Name – This is a user friendly name that will be displayed to users when they search for domains. Maximum length is 255 characters.
- Authenticated Access – If not selected, an anonymous bind is made to the LDAP server; otherwise, the credentials entered below (user name and password) will be used to bind to the LDAP server.
- User Name – If Authenticated Access is selected, the User Name in the LDAP store (that has privileges to query LDAP) that will be used by ELM to bind to this LDAP. This must be a fully qualified user name, including the DN. Maximum length is 255 characters.
- Password – If Authentication Access is selected, the password required for the above user to authenticate to the LDAP server. Maximum length is 255 characters.
Saving and validating a domain occurs whenever one of the following happens: click on Test, Add, Duplicate or Next or click on another domain in the list.
Define the primary server for your first Domain by replacing the template values in the following fields with the values required to connect to your LDAP server.
Servers is a list of the servers configured for the selected domain. An item in the list of Servers is populated with data you enter in the Host and Port fields.
- Host – The address of the selected LDAP server. The address can be in either an IP format (192.168.1.100) or DNS format (ldap.mycompany.com). Maximum length is 255 characters.
- Port – The port number on which the LDAP server listens. Value must be an integer between 1 and 65535 (inclusive).
- LDAP over TLS/SSL – If selected, a secured connection will be made to the LDAP server.
Reconnect Delay – The minimum time span to delay before trying to reconnect to a failed server after it fails and the connection has been made to the failover server. The format is a comma delimited list of values in the following form:
NN s[econds]|m[inutes]|h[ours], NN s[seconds]
“30 s, 1 m” will cause the first reconnection attempt after 30 seconds and the next attempt after another one minute. After that, ELM will continue to attempt reconnection every minute (the last value in the list).
For the last server defined (including if there is only one server), a Reconnect Delay value does not need to be defined since it will not be used by the system. The system will attempt a reconnection immediately (with no delay).
- (Optional) Click Test to test the connection to the server.
(Optional) Define and test additional failover servers:
The servers are listed in the order of primary, secondary, tertiary, etc. If the primary server fails, ELM will connect to the secondary server. If the secondary server also fails and the reconnection attempt to the primary server was unsuccessful, ELM will connect to the tertiary server – and so on.
Create another Server template by doing one of the following:
- Click Add to save your primary server values (Host, Port, LDAP over TLS/SSL and Reconnect Delay) and create a new Server template with the default values for adding an additional (failover) server.
- Select a server from the Server list and click on Duplicate to save your primary server values (Host, Port, LDAP over TLS/SSL and Reconnect Delay) and create a new Server template using the same values (as the selected Server) for adding an additional (failover) server
- Enter the server values and (optionally) test.
- (Optional) Reorder the servers by selecting a server and moving it up and down with the arrow buttons.
Configure the User Entity and Attribute Mappings. All mappings except User DN are mandatory.
- Base DN – The Distinguished Name (DN) to be used to identify the root node where users are defined. Searches for users will begin at this point and search all sub-branches.
- User DN – The Distinguished Name (DN) to be used to authenticate users in the LDAP datastore when they are logging in. If this value is undefined, the Base DN is used to authenticate users.
- Filter – An LDAP filter criteria that can be used to limit the set of results (type of objects) which are returned by the LDAP server.
- Exclude Users Without Role Attribute Value – If selected, objects defined in the LDAP datastore that do not have the role attribute will not be returned. If not selected, those objects that do not have a specific ELM role defined will be returned as Participants.
- Login Name/ID – The LDAP attribute ELM will use to validate a user.
- Role – The LDAP attribute ELM will use to determine the ELM role of the user. This can be a multi-valued field.
- First Name – The LDAP attribute ELM will use to determine the First Name of the user.
- Last Name – The LDAP attribute ELM will use to determine the Last Name of the user.
- Email – The LDAP attribute ELM will use to determine the email address of the user.
Configure the List Entity and Attribute Mappings. All mappings are mandatory.
- Base DN – The Distinguished Name (DN) to be used to identify the root node where lists (groups) are defined.
- Filter – An LDAP filter criteria that can be used to limit the set of results that come back from the LDAP server.
- Group ID – The LDAP attribute ELM will use to look up a group.
- Group Name – The LDAP attribute ELM will use to retrieve the name of the group to be displayed.
- Distinguished Name –The LDAP attribute ELM will use to identify this LDAP entity. This attribute is the fully qualified DN of this entity.
- Group Member –The LDAP attribute ELM will use to uniquely identify individual members of an LDAP group. This attribute defines the fully qualified DN of each member of the group.
- (Optional) Click on Test to test your domain configuration.
Define the User Role Value Mappings so ELM will be able to identify to which Blackboard Collaborate role a user belongs.
- LDAP Attribute Value – The value of the attribute that is to be mapped to a specific ELM role.
- The following are the ELM roles to which the LDAP Attribute Values are being added.
- System Administrator Role – The two main functions of System Administrators are to set configuration parameters (preferences) on the server and create new user accounts for Application Administrators. They have full permissions so can perform all ELM functions.
- Application Administrator Role – The two main functions of Application Administrators are to create users and create user lists. They can perform all functions within ELM except making backups, setting some General preferences (Help URL and User Registration), and viewing custom reports accessible to System Administrators only.
- Moderator Role – The two main functions of Moderators are to create Blackboard Collaborate sessions and facilitate Blackboard Collaborate sessions. Their permissions in the ELM application are generally limited to creating sessions, viewing some custom reports, joining sessions, playing recordings and updating their own user profile.
- Participant Role – The main function of Participants is to attend Blackboard Collaborate sessions. Their permissions in the ELM application are limited to joining sessions, playing recordings and updating their own user profile.
Save and validate your configuration.
- If you are configuring only one LDAP domain, click on Next to go to the next instance configuration page.
- If you want to create an additional domain, starting with the default template values, click on the Add button under the Domain list. This will save and validate the values you have entered for the current domain and, if the validation passes, will add a new domain template to the Domains list so you can create an additional domain.
- If you want to create an additional domain, starting with the values of an existing Domain, select the Domain you would like to duplicate and click on the Duplicate button under the Domain list. This will save the previously created domain and validate its values and, if the validation passes, will add a new domain template to the Domains list with the values of the duplicated domain.
(Optional) Reorder the domains by moving them up or down in the list using the arrow buttons.
LDAP domains are listed in the order that they will be searched to authenticate a user during login.
Removing Domains and Failover Servers
To remove the currently selected domain and its set of servers from the Domains list, click Remove below the Domains list.
Warning: removing an installed Domain invalidates any users associated with this domain who are invited to existing sessions. It will also free up the domain ID for reuse by newly created domains!
- To remove the currently selected server from the selected Domain, click Remove below the Servers list.
If you opted to integrate a Learning Management System (LMS) bridge with your ELM installation during the configuration of a new instance, you will be presented with the bridge configuration page.
The information required to configure a bridge will depend on which bridge is being configured.
You will also see this page when you upgrade an existing instance or edit an existing instance that is integrated with bridges.
- (Blackboard Collaborate Standard Bridge only) Provide a meaningful display name for your bridge in the Bridge Name field. For example, if this bridge is for Moodle 1.5, an appropriate name would be “Moodle” or “Moodle 1.5”.
- (Blackboard Collaborate Standard Bridge only) The Bridge Internal Name is the name used internally by ELM to identify the bridge. Do not change this field. Use the default value provided.
Configure the bridge Administrator account to be used exclusively by the ELM bridge to authenticate web service calls from the plug-in on the Blackboard server.
The bridge Administrator account fields cannot be edited (from the Instance Management Tool) once an instance has been created. So this step will not be available when editing an instance. You can edit the fields from within ELM – but do not edit the Admin Login Name.
Admin Login Name – The bridge Administrator login name to be used to authenticate the bridge calls to ELM. Invalid characters are | # “ & < and >. Maximum length is 32 characters.
If LDAP was chosen for user authentication, this user is assumed to exist within the LDAP datastore and you will need to supply the Admin Login Name that exists in the LDAP datastore. You will not see the following input fields.
- Create an account for this user – If selected, an account for this user will dynamically be created by the installation process and the user will be given the Participant role in ELM. The fields First Name, Last Name, Login Password or Email will become visible.
- First Name – The given name of the Admin user. Invalid characters are | # “ & < and >. Maximum length is 32 characters.
- Last Name – The surname of the user. Invalid characters are | # “ & < and >. Maximum length is 32 characters.
- Login Password – The password the user will use to log in to ELM. Invalid characters are | # “ & < and >. Maximum length is 128 characters.
- Email – The email address for the Admin user account. It must conform to the format [local part]@[domain part], where [local part] is mandatory and has a maximum of 64 characters and <domain part> is optional and has a maximum of 255 characters.
(Blackboard Vista/CE Bridge only) Configure the bridge server by defining the following:
- Server URL – The Blackboard Vista/CE Bridge server URL with which ELM will communicate to obtain information. Maximum length is 64 characters.
- Secret – The secret code that is shared between the Blackboard Vista/CE Bridge authentication module on the ELM server and the Blackboard Vista/CE server. This word must be alphanumeric and be the same as the secret specified during the configuration of the proxy tool on your Blackboard Vista/CE server. Maximum length is 64 characters.
- Institution Name – The Blackboard Vista/CE server institution name. The Blackboard Vista/CE Bridge will accept calls from this institution only. This is the full name of the institution as configured on the Blackboard Vista Server. Maximum length is 64 characters.
Follow the steps below to configure an existing instance.
Launch the ELM Instance Management Tool by entering its URL in your browser. The default URL is as follows:
Log in to the Instance Management Tool using the credentials you defined during installation.
If your instance is configured for teleconferencing, you will see a Telephony Whitelist tab in addition to the Instances and System Messages tabs. For instructions on creating a Telephony Whitelist, consult your Telephony Installation and Configuration Guide.
- From the Instances page, click the Edit link (in the Actions column) for the instance you wish to edit.
Edit the desired fields.
You will be able to edit all fields except Instance name, Database fields, Authentication Type and System Administrator Identification fields.
- Review the summary information on the Instance Summary page. If the values are correct, click Update to save your changes. To revise any of the editable fields, click Previous and make the desired changes. Click Cancel to keep your original values.