Echo360 is continually updating the documentation.

Echo360 is continually updating the documentation.
EchoSystem 5 Documentation
Administration Guide
February 10, 2012
Echo360 is continually updating the documentation. This manual is a snapshot as of the date above. Check the Echo360 documentation wiki for
the most current version: http://confluence.echo360.com/display/5/EchoSystem+5+Welcome+and+FAQs
______________
©2012 Echo360. All rights reserved. Echo360® and the Echo360 logo are registered trademarks of Echo360, Inc. All other trademarks are
property of their respective owners.
EchoSystem 5 Documentation
Administration Guide
In this section:
Overview
Who Should Read This Document?
Training Modules
Overview
This document guides EchoSystem administrative staff in using the EchoSystem to automate lecture and
instructional capture.
Who Should Read This Document?
This document is intended for the personnel responsible for administering the EchoSystem on a day-to-day basis. It
may also be useful for other systems administration personnel associated with management of the related system
components. Academic Staff should read the Academic Staff Guide.
EchoSystem Administrators
Personnel responsible for every day functioning of the EchoSystem and lecture capture.
Need to consider
The EchoSystem quickly becomes a critical system in the institutional technology landscape. As
deployments grow more classrooms are captured and more students review instructional materials. It is
important to be competent with EchoSystem operations such as:
EchoSystem Configuration
Capture Device and Media Processor Management
Workflow Configuration
Capture Schedules
System Monitoring
System Administrators
Personnel responsible for other institutional systems with which EchoSystem will integrate. Blackboard or
other CMS/LMS/VLE systems are examples of these types of systems. Authentication and scheduling
systems are another example.
Need to consider
EchoSystem integration
EchoSystem APIs
Training Modules
Training modules are provided throughout the document. These can be viewed using a standard web browser
and/or Apple QuickTime.
Trusted Systems
Page 2
EchoSystem 5 Documentation
In this section:
Add the Trusted System in the ESS
Add the Trusted System in the ESS
1. Log in to the ESS as an administrator.
2. Navigate to System > Trusted Systems.
3. Click Add. The Add Trusted System page appears.
4. Complete the required fields:
System Name. We recommend the name of the system being integrated, such as "Blackboard" or
"Moodle".
Description. We recommend the URL of the system being integrated.
Consumer Key. We recommend a simple string, such as your initials, for the Consumer Key.
5. Click Save to commit your edits and reveal your Consumer Secret.
Record the Consumer Key and Consumer Secret.
Make a note of the Consumer Key and copy the Consumer Secret value from the Trusted
Systems page into a text editor. Make sure you copy the equals signs (==) at the end of
the Consumer Secret. Do not copy the extra character of white space that follows the
equals signs (==).
6. Click Done.
Manage System Indexes
In this section:
Overview
Procedure
Page 3
EchoSystem 5 Documentation
Overview
The system indexes are used when you search or filter lists of items on an ESS page, such as the Courses page
shown below:
You might be asked to regenerate a system index while talking with a Technical Support engineer.
The table below shows the index to regenerate for particular types of content.
Regenerate this index
To re-index this content and keyword search for the
page
AdHocCapture
Ad hoc captures listed on the Echoes > Ad Hoc
Captures page.
Capture
Captures listed on the Monitor > Captures page.
Course
Courses listed on the Schedule > Courses page. The
Course search parameter appears on the Schedules >
Schedule page.
Person
Users listed on the Configuration > Users page. The
Person search parameter appears on the Schedules >
Courses page.
Presentation
Echoes listed on the Echoes > Echoes page.
Room
Rooms listed on the Configuration > Rooms page.
The Room search parameter appears on the Configur
ation > Devices page.
Schedule Rule
Schedules listed on the Schedule > Schedules page.
Procedure
1. Navigate to System > System Indexes.
2. Do one of the following:
Click on the button next to the specific index you want to regenerate. The table in the Overview shows
Page 4
EchoSystem 5 Documentation
2.
which index to regenerate for specific search parameters.
Click on the Reindex All on Next ESS Restart button at the bottom of the page to regenerate every
index.
3. Restart the ESS at a time that minimizes disruption and delay.
Security Modules
In this section:
Overview
Create the Security Module
Overview
You can implement any of three different types of security:
Allow All, the default security module, requires no authentication.
LDAP integrates the ESS with an existing LDAP security system. Add the security module first, then see this
KB (Knowledge Base) article for details on configuring the ESS for LDAP.
Accessing the Knowledge Base
You will need a customer portal login to access the Knowledge Base. Contact Technical
Support if you need a login.
Best Practice: Work with the LDAP Server Administrator
Invite the LDAP server Administrator to work with you when you create an LDAP security
module. The layout of LDAP directories differs substantially among institutions and
Echo360 can offer only general guidelines on configuration. The LDAP server
Administrator can help you with the correct configuration.
Seamless Only allows trusted systems to pass the ESS an authentication token which it can verify. This
means users are not forced to enter login credentials. You can use this security method with two publishers,
Blackboard and Moodle:
Blackboard Learning Management System Enterprise 7.3-9.1 - Individual Link Publishing
Moodle - EchoCenter Publishing
Create the Security Module
Follow these steps to create the security module.
1. Log in as an Administrator.
2. Navigate to the System > Security page of the ESS.
3. Click the Add button. The Add Security Module page appears as shown in the figure below.
Page 5
EchoSystem 5 Documentation
4.
5.
6.
7.
In the Name field, enter a name for the new module. You can also enter a description of its function.
Select the parent or child organization from the Organization list.
Select the module type from the drop-down list. The page expands to show additional fields.
Select a security target. The security target is the type of information protected, either content or system.
Content means that a user must log in against the criteria before viewing the presentation
Application means that a user must log in against the criteria before accessing the ESS administration
interface
Content and Application Targets
If you specify a content security target here, deploy the module as a content
security module. If you specify an application security target here, deploy the
module as an application security module.
8. Specify the realm. In most cases, you can leave the value as the default. Change it only if both of the
following are true:
You have two different users with the same login name (say ajones, an engineering student, and
ajones, a pre-med student)
You use both LDAP and the seamless only security module to authenticate users
In this case, you create two different security modules (one for LDAP, one for the seamless only
security module) and populate the Realm field differently for each module. In one module the Realm
field could be "LDAP", in the other module, it could be "seamless". The Realm field differentiates the
two users. Engineer Jones can participate in discussions, place bookmarks, and so on. Doctor Jones
can do the same. If the Realm field did not differentiate them, their bookmarks and postings could be
confused, and they would be counted as one person, not two, in student usage statistics.
9. If you want this security module to be inherited by all new sections by default, select the Default Module? bo
x.
10. Do one of the following:
Click Save.
If you are configuring an LDAP security module, see this KB (Knowledge Base) article.
Page 6
EchoSystem 5 Documentation
Accessing the Knowledge Base
You will need a customer portal login to access the Knowledge Base. Contact Tech
nical Support if you need a login.
Notify Students
In this section:
Overview
Procedure
Overview
After an event of any kind (scheduled or ad hoc) has been captured and processed, you, the System Administrator,
must still notify students of the new recording. This is still true if the event is a one-time special event such as a
graduation or speech, and the people to be notified are alumni or other interested parties, not just students.
You do this in different ways, as shown in the procedure below.
Procedure
If you use...
Then
Email Publishing
If the recording is an on-demand recording, students
automatically receive an email with a link to it.
If the recording is a one-time event, you have two
options. Both assume that you have created a section
for the one-time event.
Find the recording on the Echo Details page (Echoe
s > Echoes). Copy the URL into an email you send.
Add the Email Publisher to the section. In this case,
you will have to create an email alias or distribution
list because you can only specify one recipient per
publisher.
The EchoCenter
The link appears on the student's EchoCenter page.
See Manage the EchoCenter.
A learning management system (LMS) that has an
EchoCenter integration
The link appears on the EchoCenter page within the
LMS. See Publishing for a list of all publishers. Only
some publishers support an EchoCenter integration.
Page 7
EchoSystem 5 Documentation
An LMS that does not have an EchoCenter integration
The link appears on the LMS page for the course.
Publishing
In this section:
Add a Publisher
Edit a Publisher
Remove a Publisher
Add a Publisher
The process for adding a publisher is specific to each publisher. See the following pages for information about each
publisher.
Blackboard Learning Management Systems
TWEN
Moodle Learning System
iTunes U
RSS Feeds
ANGEL Learning Management Suite
Closed Captioning and Transcript Publisher
Echo360 Search Indexing
Email Publisher
Edit a Publisher
1.
2.
3.
4.
5.
Log in as an Administrator.
Navigate to Configuration > Publishers.
Hover over the publisher you want to edit.
Select edit.
Modify the fields as needed. The fields differ by publisher. See the following pages for information about each
publisher.
Blackboard Learning Management Systems
TWEN
Moodle Learning System
iTunes U
RSS Feeds
ANGEL Learning Management Suite
Closed Captioning and Transcript Publisher
Echo360 Search Indexing
Email Publisher
Remove a Publisher
A publisher is usually applied to a specific section or Echo. See the links above for instructions on applying a
publisher to a section.
You can delete a publisher that has failed. If the publisher has never failed, and it is still applied to a section or Echo,
you cannot delete it.
Blackboard Learning Management Systems
Page 8
EchoSystem 5 Documentation
Overview
You can publish to Blackboard, the learning management system. Publishing means that when an Echo is available,
Blackboard does the following.
Creates a new announcement for the course with capture name, date and time information.
Creates a detailed link (including capture name, date, and time) to the Echo in a content area for the course.
If a Class Capture content area is available, the link is posted there. If a Class Capture content area is not
available, the link is posted to Course Documents.
Adds the Echo360 icon to all announcements and links, so students can easily identify Echoes.
EchoSystem supports the following Blackboard versions.
Blackboard Learning Management System Enterprise, versions 7.3 through 9.1. For any of these versions:
Install and configure the Blackboard Building Block.
Enable seamless login.
See Blackboard Learning Management System Enterprise 7.3-9.1 - Individual Link Publishing for
instructions on both processes.
Blackboard Learning System Vista 4 and CE. Add the publisher and enroll trusted users. See Blackboard
Learning System, Vista 4 and CE 6 - Individual Link Publishing.
Blackboard Learning Management System Enterprise 7.3-9.1 - Individual Link Publishing
In this section:
Overview
Install the Building Block
Configure the Blackboard Building Block
Enable Seamless Login
Before You Begin
Add the Trusted System in the ESS
Add the Blackboard Publisher in the ESS
Configure the Blackboard Building Block for Seamless Login
Add Blackboard to Each Section
Overview
EchoSystem supports Blackboard Learning System Enterprise, versions 7.3 through 9.1.
If you have been using the building block for some time and have run into issues after upgrading to Blackboard 9.1,
use these instructions to delete the old building block and install the new one.
Enabling Blackboard as an EchoSystem publisher consists of the following phases:
1.
2.
3.
4.
5.
Install the Blackboard building block.
Configure the Blackboard building block.
Add Blackboard as a publisher.
Enable seamless login.
Add Blackboard to each section. After you enable Blackboard as a publisher, specify it as the publisher for
each section. This ensures that Echoes for each section publish to Blackboard.
Automated posting of Echo links into Blackboard is accomplished by the HTTP POST mechanism and the
Blackboard Building Block. The Blackboard Building Block is installed on the Blackboard server.
Page 9
EchoSystem 5 Documentation
Install the Building Block
The screen shots in this section are from version 9.1.
1. If you have an older version of the Building Block installed, delete it.
2. Download the Blackboard Building Block from the Echo360 customer support portal. Store the downloaded
file in an easy-to-access location.
Remember this location.
You will need to know this location later.
3. Log in to Blackboard as a user with system administration privileges.
4. Navigate to the System Admin tab as shown in the figure below.
5. Click the Building Blocks link.
6. Select Installed Tools.
7. Click the Upload Building Blocks button.
8. Browse for the Building Block. The file name is standard-4.0.x.war where x indicates the last element of the
release number.
9. Click Submit.
Page 10
EchoSystem 5 Documentation
10. Click OK.
11. Notice that the building block ("EchoSystem Content Creator") is listed, as shown in the figure below, but
when first installed, is shown as Inactive.
12. Select the Available option from the list.
Configure the Blackboard Building Block
1. On the Building Blocks page, find the EchoSystem Content Creator item.
2. Click the Settings button. The Configure Echo Content Creator page appears.
3. Configure the first two setting groups, as shown in the figure below.
Page 11
Field Name
Description
Shared Secret
The integration uses a dedicated shared secret
configured in the building block instead of the
administrator user password. The shared secret, set
by the Blackboard administrator, allows Blackboard
and the EchoSystem Server (ESS) to establish a
handshake. The shared secret values on the
EchoSystem server and the Blackboard Building
Block must match. In the ESS, navigate to Configu
ration > Publishers and edit the Blackboard
publisher.
EchoSystem 5 Documentation
Allow Pre Version 4.0 Authentication
Mechanism?
Check this box only if:
You are running different EchoSystem Servers
that point to the same instance of BlackBoard
At least one of the EchoSystem Servers has
release 3.0, update 5 or earlier installed
Checking this box allows variant EchoSystem
Servers to send updates to a single BlackBoard
instance.
When this box is checked, you cannot use the
seamless security module or trusted systems.
Check User for Course Membership
If checked, Blackboard will verify that the student is
enrolled in the course before allowing access.
Enabling this option offers additional access control.
Consumer Key
Enter the Consumer Key you established when you
added the trusted system.
Consumer Secret
Enter the Consumer Secret you established when
you added the trusted system.
Realm
In most cases, you can leave this field at the default
value. Change it only if you are in the particular
circumstances described in Create the Security
Module.
4. Configure the next two settings groups, as shown below.
Field Name
Page 12
Description
EchoSystem 5 Documentation
Default Content Area
The content area for posting EchoSystem links. If a
default content area does not exist, the building
block uses the Alternate Content Area value.
Alternate Content Area
The content area for posting EchoSystem links. This
content area is used if a default content area does
not exist.
Place content in a subfolder within content
area?
You can place content in a subfolder within the
content area. Subfolders are only supported when
posting content to the default content area.
If so, enter subfolder name
Subfolder name.
Add announcement each time a class capture is
posted?
If checked, an announcement is posted when an
Echo is posted.
Make newly posted content available by default?
If checked, the EchoSystem content link is available
in the UI. Links can be made available later through
the course control panel.
Allow Blackboard to track views of new custom
content?
If checked, view statistics are enabled for the Echo
classroom content link. Links can be tracked later
through the course control panel.
Content Available Limit
If checked, the EchoSystem content link is available
in the UI. Links can be made available later through
the course control panel.
Include Echo System Section Identifier
We recommend checking this box. Doing so
displays the section identifier on the Blackboard
course page.
Display
Select from the drop-down list. The course list page
can open in the Blackboard course page or in a new
tab in the browser.
5. Click Submit.
6. Look for a message indicating success.
Enable Seamless Login
You can authenticate students seamlessly before allowing them to view content published in Blackboard.
"Seamlessly" means that once a student has authenticated against Blackboard, that authentication is transparently
("seamlessly") passed to the ESS. The ESS validates that the student has been authenticated by Blackboard and
does not ask the student for credentials a second time.
To enable seamless login, follow these phases:
1. Enable the trusted system in the ESS.
2. Enable the publisher in the ESS.
3.
Page 13
EchoSystem 5 Documentation
3. Configure the Blackboard Building Block.
Seamless Login is Optional
Echoes are published to Blackboard whether or not you enable seamless login.
Before You Begin
Ensure that:
You are using a supported version of Blackboard. Seamless login is supported for Blackboard Learning
System Enterprise, versions 7.3 through 9.1.
You have installed the latest EchoSystem Building Block on your Blackboard server.
You have enabled the Blackboard publisher in the EchoSystem.
Add the Trusted System in the ESS
Be sure to record the Consumer Key and Consumer Secret. You will need both of these items when you configure
the Blackboard Building Block.
1. Log in to the ESS as an administrator.
2. Navigate to System > Trusted Systems.
3. Click Add. The Add Trusted System page appears.
4. Complete the required fields:
System Name. We recommend the name of the system being integrated, such as "Blackboard" or
"Moodle".
Description. We recommend the URL of the system being integrated.
Consumer Key. We recommend a simple string, such as your initials, for the Consumer Key.
5. Click Save to commit your edits and reveal your Consumer Secret.
Page 14
5.
EchoSystem 5 Documentation
Record the Consumer Key and Consumer Secret.
Make a note of the Consumer Key and copy the Consumer Secret value from the Trusted
Systems page into a text editor. Make sure you copy the equals signs (==) at the end of
the Consumer Secret. Do not copy the extra character of white space that follows the
equals signs (==).
6. Click Done.
Add the Blackboard Publisher in the ESS
1. Log in to the ESS as an administrator.
2. Navigate to Configuration > Publishers.
3. Click Add. The Add Publisher page appears.
4. Enter a name and description for the publisher.
5. Select the parent or child organization to which this publisher belongs.
6. From the Publisher Type list, select Blackboard Learning Management System Enterprise 7.3-9.1. The
page expands to include a section on Publisher Configuration that is specific to this version of Blackboard.
Page 15
EchoSystem 5 Documentation
7. If you want Blackboard Learning Management System Enterprise 7.3-9.1 to be your default publisher, select
the Use by Default box.
8. In the Connection Properties group, select the Use Seamless Login check box to enable the module.
9. Populate the other fields in the Connection Properties group, as described in the following table:
Field Name
Description
Example
User Name
Enter the Echo360 Blackboard
user name
Echo360user
URL
The URL of the Blackboard
Learning Management System
Enterprise server
Shared Secret
Enter the shared secret you (or
the Blackboard administrator)
created in the building block.
https://ess.ech
ostate.edu/Blac
kboard
–
10. If you are publishing individual links, check or clear check boxes as desired in the Publish Individual Links
Options group. Post EchoPlayer means that you will post a rich media version viewable in the EchoPlayer
(student player). If you are publishing to the EchoCenter (EchoCenter publishing), ignore this settings group.
11. In the Publishing Mode group, select either Publish EchoCenter or Publish Individual Links.
Publish EchoCenter means that Blackboard will display Echoes on the EchoCenter page. See Manag
e the EchoCenter for details on this feature.
Publish Individual Links means that Blackboard will display Echoes in the default Blackboard format.
12. Click Save to commit your edits.
13. Publish a course to Blackboard to verify that the building block is correctly configured.
Configure the Blackboard Building Block for Seamless Login
Page 16
EchoSystem 5 Documentation
1.
2.
3.
4.
5.
6.
Log in to Blackboard as an administrator.
Navigate to System Admin > Building Blocks.
Select Installed Tools.
In the list, find the Echo360 Building Block named EchoSystem Content Creator.
Click the Settings button.
In section 2, edit the Consumer Secret field, entering the same value you entered in the ESS by pasting the
Consumer Secret value from the text editor. Make sure you do not copy the extra blank character you may
have at the end of the Consumer Secret string.
7. Click Submit.
Add Blackboard to Each Section
After you enable Blackboard as a publisher, specify it as the publisher for each section. This ensures that Echoes for
each section publish to Blackboard.
1. Get the Blackboard Course ID.
a. In Blackboard, navigate to System Admin > Courses.
b. Note the Course ID.
2.
3.
4.
5.
Page 17
In the ESS, navigate to the Section Details page.
Scroll to the bottom of the page.
Click Add Publisher.
On the Add Publisher page:
a. Select Blackboard as the publisher
b. Enter the Course ID in the CMS ID field.
EchoSystem 5 Documentation
6. Click Save.
Blackboard Learning Management System Enterprise 9.1 - EchoCenter Publishing
In this section:
Overview
Verify that the ecp Trusted System Exists
Add the Blackboard Publisher in the ESS
Review the EchoCenter Settings on the Section
Add Blackboard to Each Section
Test the EchoCenter Link on the Blackboard Page
Overview
You may already publish individual links and supplemental materials to Blackboard ("individual link publishing"). You
can publish EchoCenter pages to Blackboard also ("EchoCenter publishing"). In EchoCenter publishing, the
EchoCenter page appears on the Blackboard page for the section.
You can support both publishing methods. Some sections can publish via individual link publishing, others can use
EchoCenter publishing. To do this, you will need to create two publishing instances, one for individual link publishing
and one for EchoCenter publishing.
If you decide to enable EchoCenter publishing in Blackboard, you must decide if you want to enable standard
EchoCenter publishing or Collaboration Service EchoCenter publishing. Standard EchoCenter publishing requires
only that you have Blackboard Learning System Enterprise version 9.1 installed. To enable Collaboration Service
EchoCenter publishing in Blackboard, you must:
Have Blackboard Learning System Enterprise version 9.1 installed
Have enabled seamless login with LDAP or have enabled the seamless security module
Have subscribed to the Collaboration and Statistics Service
Enabling EchoCenter publishing consists of these required phases. Some of these phases are also required for
Page 18
EchoSystem 5 Documentation
individual link publishing.
1.
2.
3.
4.
5.
6.
7.
Install the Building Block.
Configure the Blackboard Building Block.
Verify that the ecp trusted system exists in the ESS.
Add the Blackboard publisher in the ESS.
Review the EchoCenter settings on the section.
Add Blackboard to each section.
Test the EchoCenter link on the Blackboard page.
Who can do this?
System Administrator
Admin of Parent Organization
Verify that the ecp Trusted System Exists
You must have the ecp trusted system installed.
1. Navigate to System > Trusted Systems.
2. Look for a trusted system called ecp.
Add the Blackboard Publisher in the ESS
1. Log in to the ESS as an administrator.
2. Navigate to Configuration > Publishers.
3. Click Add. The Add Publisher page appears.
4. Enter a name and description for the publisher.
5. Select the parent or child organization to which this publisher belongs.
6. From the Publisher Type list, select Blackboard Learning Management System Enterprise 7.3-9.1. The
Page 19
EchoSystem 5 Documentation
6.
page expands to include a section on Publisher Configuration that is specific to this version of Blackboard.
7. If you want Blackboard Learning Management System Enterprise 7.3-9.1 to be your default publisher, select
the Use by Default box.
8. In the Connection Properties group, select the Use Seamless Login check box to enable the module.
9. Populate the other fields in the Connection Properties group, as described in the following table:
Field Name
Description
Example
User Name
Enter the Echo360 Blackboard
user name
Echo360user
URL
The URL of the Blackboard
Learning Management System
Enterprise server
Shared Secret
Enter the shared secret you (or
the Blackboard administrator)
created in the building block.
https://ess.ech
ostate.edu/Blac
kboard
–
10. If you are publishing individual links, check or clear check boxes as desired in the Publish Individual Links
Options group. Post EchoPlayer means that you will post a rich media version viewable in the EchoPlayer
(student player). If you are publishing to the EchoCenter (EchoCenter publishing), ignore this settings group.
11. In the Publishing Mode group, select either Publish EchoCenter or Publish Individual Links.
Publish EchoCenter means that Blackboard will display Echoes on the EchoCenter page. See Manag
e the EchoCenter for details on this feature.
Publish Individual Links means that Blackboard will display Echoes in the default Blackboard format.
12. Click Save to commit your edits.
13. Publish a course to Blackboard to verify that the building block is correctly configured.
Page 20
EchoSystem 5 Documentation
Review the EchoCenter Settings on the Section
You may wish to modify some EchoCenter settings in the Section configuration details.
Add Blackboard to Each Section
After you enable Blackboard as a publisher, specify it as the publisher for each section. This ensures that Echoes for
each section publish to Blackboard.
1. Get the Blackboard Course ID.
a. In Blackboard, navigate to System Admin > Courses.
b. Note the Course ID.
2.
3.
4.
5.
In the ESS, navigate to the Section Details page.
Scroll to the bottom of the page.
Click Add Publisher.
On the Add Publisher page:
a. Select Blackboard as the publisher
b. Enter the Course ID in the CMS ID field.
6. Click Save.
Test the EchoCenter Link on the Blackboard Page
1. In Blackboard, navigate to the course page for the section.
2. Verify that you see the EchoCenter link, as shown in the figure below.
Page 21
2.
EchoSystem 5 Documentation
3. Click on the link. You should see the EchoCenter page. Depending on how you configured the Displaysetting
on the Blackboard Building Block, you will see the EchoCenter page either:
Embedded in the Blackboard interface, or
In a new browser tab
Blackboard Learning System, Vista 4 and CE 6 - Individual Link Publishing
In this section:
Overview
Add the Blackboard Learning System (Vista 4 and CE 6) Publisher
Create and Enroll the Trusted User
Add Blackboard CE/Vista to Each Section
Overview
Enabling Blackboard as an EchoSystem publisher for the Learning System CE and Vista versions consists of the
following phases:
1. Add the publisher in the ESS.
2. Create and enroll the trusted user in the Learning System CE or Vista server.
3. Add Blackboard to each section. After you enable Blackboard as a publisher, specify it as the publisher for
each section. This ensures that Echoes for each section publish to Blackboard.
No Powerlink is needed for this integration.
Add the Blackboard Learning System (Vista 4 and CE 6) Publisher
1. Log in to the ESS as a System Administrator.
2. Select Configuration > Publishers.
3. Click Add. The Add Publisher page appears as shown in the figure below.
Page 22
EchoSystem 5 Documentation
4. Enter a name and description for the publisher.
5. Select the parent or child organization to which this publisher belongs.
6. From the Publisher Type list, select Blackboard Learning System (Vista 4 and CE 6). The page expands to
include a section on Publisher Configuration that is specific to Blackboard Learning System (Vista 4 and CE
6), as shown in the figure below.
7. If you want Blackboard Learning System (Vista 4 and CE 6) to be your default publisher, select the Use by
Default box.
8. Complete the fields as described in the following table:
Page 23
Field Name
Description
URL
Enter the base URL for the CE/Vista server, such as
http://vista.university.edu
INST
Enter the name of the CE/Vista institution where
you will publish Echoes. The name must be entered
exactly as it is in CE/Vista, including capitalization
and spacing.
Trusted User
Create a user account that will be used for the
integration with CE/Vista.
Password
Enter a password for the trusted user account.
EchoSystem 5 Documentation
9. By default you will post Podcast, Vodcast, and EchoPlayer versions of your Echo to Blackboard Learning
System Vista 4 and CE 6. Post EchoPlayer means that you will post a rich media version viewable in the
EchoPlayer (student player). Change these if necessary by clearing the checkboxes.
10. Click Connect to Blackboard to verify that a connection can be established. If it cannot be established, you
receive a detailed error message.
11. Click Save.
Create and Enroll the Trusted User
1. Log in to the CE/Vista server as an administrator.
2. Create a new user account for the trusted user created in the ESS.
User Name and Password Must Match
The user account must have the same user name and password as specified in the ESS.
3. For every CE/Vista section to be integrated with the EchoSystem, enroll the trusted user as a section level
designer.
4. Links to the Echoes appear in the calendar in the section for the day the lecture was recorded. Only links are
placed in CE/Vista. No files are placed in the calendar.
Learning Context ID (LCID)
For every CE/Vista section to be integrated with the EchoSystem, you need the LCID.
CE/Vista automatically generates the LCID.
Add Blackboard CE/Vista to Each Section
After you enable Blackboard CE/Vista as a publisher, you have to specify it as the publisher for each section. This
ensures that Echoes for each section publish to Blackboard CE/Vista.
Follow these steps.
1. Enter the LCID from Blackboard CE/Vista in the CMS ID field.
Page 24
EchoSystem 5 Documentation
2. Click Save.
TWEN
In this section:
Overview
Add the TWEN Publisher
Overview
The West Education Network® (TWEN) is an online extension of the law school classroom at http://lawschool.westla
w.com, the virtual law school community. Using TWEN, you can create and manage courses online, access and
post course materials on document pages, create assignments that your students can receive and submit, organize
and participate in class forums and live discussions, administer online quizzes, exchange e-mails with other
professors and students, and more.
Add the TWEN Publisher
1. Log in as an Administrator.
2. Select Configuration > Publishers.
3. Click Add. The Add Publisher page appears as shown in the figure below.
Page 25
EchoSystem 5 Documentation
4. Enter a name and description for the publisher.
5. Select the parent or child organization to which this publisher belongs.
6. From the Publisher Type list, select TWEN. The page expands to include a section on Publisher
Configuration that is specific to TWEN, as shown in the figure below.
7. If you want TWEN to be your default publisher, select the Use by Default box.
8. Enter the URL for the TWEN Calendar Web Service. By default, this is http://lawschool.westlaw.com/servi
ces/calendar.asmx/EventCreatePasswordExpanded.
9. Enter your TWEN password. You can get this from your TWEN account manager.
10. By default you will post Podcast, Vodcast, and EchoPlayer versions of your Echo to TWEN. Change these if
Page 26
EchoSystem 5 Documentation
10.
necessary by clearing the check boxes.
11. Click Connect to TWEN to verify that a connection can be established. If it cannot be established, you
receive a detailed error message.
Moodle Learning System
In this section:
Overview
Overview
You can publish to Moodle, the open source learning management system, allowing students and Instructors to view
materials via the Moodle calendar.
Two publishing methods are supported:
Individual Link Publishing means that users see just Echoes and additional materials on the Moodle
calendar. This publishing method has been supported since EchoSystem 2.3. See Moodle - Individual Link
Publishing for details.
EchoCenter Publishing means that users see the EchoCenter page. This newer publishing method has
been supported since EchoSystem 4.0. See Moodle - EchoCenter Publishing for details.
Best Practice: Implement EchoCenter Publishing
EchoCenter publishing means that users see a course list page, called an EchoCenter
page, not just individual Echoes and additional materials. The EchoCenter page offers:
A convenient, intuitive dashboard that groups all materials (Echoes, Media Imports,
and Personal Capture recordings) together by date and lecture.
An organization that matches the syllabus and the mental model of students and
Academic Staff.
If your license includes the Collaboration and Statistics Service and you implement
EchoCenter publishing, you can also offer:
Different views to students and Academic Staff
Discussions in the EchoPlayer and EchoCenter page
Bookmarks in the EchoPlayer
Charts and student usage data in the EchoCenter page
Moodle - EchoCenter Publishing
In this section:
Overview
Install the Moodle Plugin (Moodle)
Add a Trusted System (EchoSystem)
Configure the Administration Settings (Moodle)
Map Moodle Courses to EchoSystem Sections (Moodle and EchoSystem)
Add the EchoCenter Block to the Course (Moodle)
Collaboration Service Only - Review Permissions Assigned to Roles in Moodle
Test EchoCenter Publishing for a Section (Moodle and EchoSystem)
Troubleshooting
Page 27
EchoSystem 5 Documentation
Overview
How EchoCenter Publishing Benefits Students and Academic Staff
EchoCenter publishing allows Academic Staff to create a link to the EchoCenter page in their Moodle course.
Students and Academic Staff will see the link in the Moodle course page, as shown in the figure below.
To open the EchoCenter, they click on the block. The EchoCenter page is displayed within the Moodle page layout,
as shown in the figure below.
Page 28
EchoSystem 5 Documentation
To open the EchoCenter in a new window, users click the Open in new window icon at the top right of their course
page.
Access is seamless. No further authentication is required.
If you subscribe to the Collaboration and Statistics Service you can offer additional functionality, including different
EchoCenter pages for students and Academic Staff. Users will see the correct page for their role after the plugin is
installed. No further configuration is required, though you may want to review and adjust the permissions assigned
to roles in Moodle.
Requirements
These instructions assume that:
You have EchoSystem 4.0 or higher installed. If you have EchoSystem 4.0, you must have the
4.0.2011-09-02.1 upgrade (or a later upgrade) installed.
You have Moodle versions 1.9.x through 2.3.2 installed. Later versions may work, but the latest tested
version is 2.3.2.
You have PHP version 4.3.0 or later installed on the Moodle server.
You have the following PHP modules installed on the Moodle server:
Curl
Hash
Openssl
The server running the EchoSystem can contact the server running Moodle.
Page 29
EchoSystem 5 Documentation
You are a Moodle Administrator.
Procedure
When you enable EchoCenter publishing, you are, essentially, setting up a link between Moodle and the ESS. To
establish this link you:
1. Set up a trusted system (following the OAuth standard) between Moodle and the ESS. You do this
establishing the trusted system in the ESS and giving Moodle the Consumer Secret and Consumer Key. This
trusted system allows the ESS to accept communication from Moodle.
2. Associate ESS sections and Moodle courses. You do this by establishing a Moodle Course Field that will
be compared to the ESS External System Id field.
Follow these phases:
1.
2.
3.
4.
5.
6.
Install the Moodle Plugin (Moodle).
Add a Trusted System (EchoSystem)
Configure the Administration Settings (Moodle).
Map Moodle Courses to EchoSystem Sections (Moodle and EchoSystem).
Add the EchoCenter Block to the Course (Moodle).
Collaboration Service Only - Review Permissions Assigned to Roles in Moodle. If you do not have Collaborati
on Service, skip this step.
7. Test EchoCenter Publishing for a Section (Moodle and EchoSystem).
Moodle 2.0
The screen shots are from Moodle 2.0.
Install the Moodle Plugin (Moodle)
1. Download the plugin from the Echo360 customer support portal.
2. Expand the zipped file.
3. Copy the blocks from the correct folder in the zip package to the blocks folder in your Moodle installation.
Moodle 1.9:
Copy moodle19/blocks/echo360_configuration to <moodle installation
dir>/blocks/echo360_configuration
Copy moodle19/blocks/echo360_echocenter to <moodle installation
dir>/blocks/echo360_echocenter
Moodle 2.0:
Copy moodle20/blocks/echo360_configuration to <moodle installation
dir>/moodle/blocks/echo360_configuration
Copy moodle20/blocks/echo360_echocenter to <moodle installation
dir>/moodle/blocks/echo360_echocenter
4. Install the new blocks.
a. Log into Moodle as an Administrator.
b. Navigate to Site administration > Notifications.
Page 30
EchoSystem 5 Documentation
5. Notice the dialog boxes shown in the figures below. You will see these only once, right after you install the
plugin.
Page 31
EchoSystem 5 Documentation
Add a Trusted System (EchoSystem)
Who can do this?
System Administrator
Create a trusted system in EchoSystem so the Echo360 Moodle plugin can communicate with your EchoSystem
Server (ESS).
Be sure to record the Consumer Key and Consumer Secret. You will need both of these items when you configure
the administration settings in Moodle.
1. Log in to the ESS as an administrator.
2. Navigate to System > Trusted Systems.
Page 32
2.
EchoSystem 5 Documentation
3. Click Add. The Add Trusted System page appears.
4. Complete the required fields:
System Name. We recommend the name of the system being integrated, such as "Blackboard" or
"Moodle".
Description. We recommend the URL of the system being integrated.
Consumer Key. We recommend a simple string, such as your initials, for the Consumer Key.
5. Click Save to commit your edits and reveal your Consumer Secret.
Record the Consumer Key and Consumer Secret.
Make a note of the Consumer Key and copy the Consumer Secret value from the Trusted
Systems page into a text editor. Make sure you copy the equals signs (==) at the end of
the Consumer Secret. Do not copy the extra character of white space that follows the
equals signs (==).
6. Click Done.
Configure the Administration Settings (Moodle)
The Moodle plugin can be configured from within Moodle.
1. Log in to Moodle as an Administrator.
2. Navigate to the Echo360 configuration page by doing one of the following:
Choose Echo360 Configuration from the navigation menu on the left (Site administration > Plugins
> Blocks), as shown in the figure below.
Page 33
EchoSystem 5 Documentation
Click on the Settings link in the Manage blocks page in the same table row as the Echo360
Configuration block, as shown in the figure below.
3. Notice that the Echo360 Configuration page appears as shown in the figure below.
Page 34
EchoSystem 5 Documentation
3.
4. Configure the building block.
a. EchoSystem URL
i. Enter the URL to your EchoSystem presentations.
ii. To find it, go to the ESS and navigate to System > System Settings.
iii. Find the Echo Base URL field.The Echo Base URL typically looks like this: http://yourhost:80
80/ess.
iv. Copy all of the URL except for the trailing ess.
v. The EchoSystem URL you enter should look like this: http://yourhost:8080/.
vi. If you enter the URL with the trailing ess, you will not be able to view EchoCenter content
through Moodle.
b. Trusted System Consumer Key. You entered this value when you created the trusted system. You
should have made a note of it. Enter the value.
c. Trusted System Consumer Secret. The EchoSystem generated this value when you created the
trusted system. You should have copied it into a text editor. Copy it from the text editor.
Best Practice: Watch Out for the Trailing Space
Be sure not to copy the trailing space from the text editor into the ESS.
d. Security Realm. In most cases, you can leave the value as the default. Change it only if both of the
following are true:
You have two different users with the same login name (say ajones, an engineering student,
and ajones, a pre-med student)
Page 35
EchoSystem 5 Documentation
You use both LDAP and the seamless only security module to authenticate users
In this case, you create two different security modules (one for LDAP, one for the seamless only
security module) and populate the Realm field differently for each module. In one module the
Realm field could be "LDAP", in the other module, it could be "seamless". The Realm field
differentiates the two users. Engineer Jones can participate in discussions, place bookmarks,
and so on. Doctor Jones can do the same. If the Realm field did not differentiate them, their
bookmarks and postings could be confused, and they would be counted as one person, not two,
in student usage statistics.
e. Moodle Course Field. This is the Moodle field that is used to map a Moodle course to an EchoSystem
section. You can enter any of several Moodle fields: Course Full Name, Course Short Name, Cours
e ID Number. In this example, we use the Course ID Number.
Map Moodle Courses to EchoSystem Sections (Moodle and EchoSystem)
Overview
When a user clicks on the EchoCenter block, the block must determine which section in EchoSystem to show to the
student. It does this by comparing the value in the field specified in the Moodle Course Field with the value in the
ESS's External System Id field.
Say, for example, you specified Course ID Number as the Moodle Course Field when configuring the
administration settings.
1.
2.
3.
4.
Moodle looks for the value in that field. Say that the value is Course1.
Moodle passes this value to the ESS.
The ESS looks at the External System Id fields for each section.
When it finds a section that has Course1 in the External System Id field, it shows the user the EchoCenter
page for that section.
In this phase, you populate the External System Id field.
Populate the ESS External System Id Field for a Section
This procedure assumes that you specified Course ID Number as the Moodle Course Field when you configured
the administration settings.
This procedure shows how to populate the External System Id field for a single section. You must populate the Exte
rnal System Id field for each section.
Best Practice: Use .CSV Import for Sections
You can quickly populate the External System Id field for all sections by importing this field
(and, if you wish, many others) from a spreadsheet into ESS. For a general description of the
import feature, see Export and Import Objects. For further details, see CSV Import Format for
Sections.
1. In Moodle, navigate to the Edit Course Settings page for the section (Home > Courses > EC-Demo > Edit
Course Settings). This example uses EC-Demo as the course.
2. Note the value of the Course ID Number field.
Page 36
EchoSystem 5 Documentation
3. In ESS, navigate to the Section Details page.
a. Navigate to Schedule > Courses. The Courses page appears.
b. Click the course link. The Course Details page appears.
c. Click the section link. The Section Details page appears.
4. Click Edit.
5. In the EchoCenter group, enter the Course ID Number field value in the External System Id field. It is Cours
e1 in the example figure shown below.
6. Click Save.
Add the EchoCenter Block to the Course (Moodle)
You can take either of two approaches to this phase:
Alter the default layout for a course
Train instructors to add the EchoCenter block
Alter the Default Layout for a Course
See the Moodle documentation for details on altering the default layout for a course.
A simple example would be to add a line to the config.php page for your Moodle installation:
Page 37
EchoSystem 5 Documentation
$CFG->defaultblocks_topics =
'participants,admin:echo360_echocenter,messa
ges,online_users';
This would change the default block layout for topics format courses to People and Administration on the left, and
Echo360 EchoCenter, Messages and online users on the right.
Train Academic Staff to Add the EchoCenter Block
You can train Academic Staff to follow this simple procedure or do the operation yourself.
1. In Moodle, make sure you are in Edit mode. You should see a "Turn editing off" button like that shown in the
following figure:
2. In the Add a block menu, choose the Echo360 EchoCenter block, as shown in the figure below.
Collaboration Service Only - Review Permissions Assigned to Roles in Moodle
If you do not have Collaboration Services, skip this step.
If you subscribe to the Collaboration and Statistics service, student and Instructors see different versions of the
EchoCenter page. They will continue to see the correct version of the EchoCenter page after you install the plugin
without any further configuration on your part. The plugin:
1. Adds two new permissions, View EchoCenter as EchoSystem Instructor and View EchoCenter as
Student
2. Adds these permissions appropriately to the Student, Teacher, Editing Teacher, and Manager (Admin in
Moodle 1.9) roles
Page 38
EchoSystem 5 Documentation
Users with these Moodle roles see the Instructor version:
Editing Teacher
Manager (Admin in Moodle 1.9)
Users with these Moodle roles see the student version:
Student
Teacher
Editing Teacher
Manager (Admin in Moodle 1.9)
You can see the EchoCenter permissions if you edit the roles.
The student role shows that the Instructor permission is not set but the student capability is allowed, as
shown in the following figure:
The teacher role shows that both permissions are allowed, as shown in the following figure:
You may wish to configure Moodle roles to add or remove these permissions.
Test EchoCenter Publishing for a Section (Moodle and EchoSystem)
1.
2.
3.
4.
5.
In Moodle, navigate to a section that has EchoCenter enabled.
Look for the EchoCenter link.
Click on the link.
You should see the EchoCenter page.
If you do not, check Troubleshooting for common errors.
Troubleshooting
Most errors occur when entering data into the Echo360 Configuration page.
EchoSystem URL is wrong. Make sure that the Echo Base URL has been copied correctly from the ESS
page (System > System Settings) to the Moodle plugin. Include the final slash but do not include the ess.
See Configure the Administration Settings (Moodle).
Consumer Secret is wrong. Make sure you do not copy the trailing space when you paste the Consumer
Secret from the text editor to the Moodle plugin. See Configure the Administration Settings (Moodle).
Values mismatch. The value in the External System Id in the ESS does not match the value specified in the
Moodle Course Field. See Map Moodle Courses to EchoSystem Sections (Moodle and EchoSystem) .
You may also discuss this plugin on the Moodle contributed code forum.
Moodle - Individual Link Publishing
Page 39
EchoSystem 5 Documentation
In this section:
Overview
Install the Moodle Calendar Patch
Configure Moodle
Add the Moodle Publisher to the ESS
Add Moodle to Each Section
Example: San Francisco State University (SFSU)
Overview
You can publish to Moodle, the open source learning management system. "Publishing" means that Echoes are
available to students via the Moodle calendar.
Enabling Moodle as an EchoSystem publisher consists of these phases:
1.
2.
3.
4.
Install a Moodle calendar patch provided by Echo360
Configure Moodle
Add the Moodle Publisher to the ESS
Add Moodle to each section
These instructions assume that:
You already have Moodle installed.
The server running the EchoSystem can contact the server running Moodle.
You are using Moodle versions 1.8.x through 1.9.x.
You are using the default Apache and Moodle paths. If your configuration does not use the default paths,
adapt the path names appropriately.
If you are running Windows, you already have GNU installed and can navigate to c:\Program
Files\GnuWin32\.
The patch file, named moodle-1.8.2-1.9.7.patch, is located in the Supporting_Components folder in your ESS
installation directory. This patch includes changes allowing publishing on Moodle version 1.9.7. You can install this
patch even if you installed another patch earlier. You do not need to uninstall the old patch.
Install the Moodle Calendar Patch
For Linux Operating Systems
These instructions assume that your Moodle installation is located in /var/www/html/moodle.
1.
2.
3.
4.
5.
Navigate to the Supporting_Components folder in your ESS installation directory.
Locate the file labeled moodle-1.8.2-1.9.7.patch.
Copy it to your Moodle server program directory (typically C:\Program Files\Echo360\Server).
Stop the Apache service.
Execute these commands from the terminal prompt.
cd /var/www/html/moodle
patch \-p1 < echosystem_moodle_patch_1.8.2-1.9.7.patch
6. Look for output like that shown in Output After a Successful Patch Installation.
7. Restart the Apache service. The patch has been applied successfully.
Page 40
EchoSystem 5 Documentation
For Windows Operating Systems
1.
2.
3.
4.
5.
Navigate to the Supporting_Components folder in your ESS installation directory.
Locate the file labeled moodle-1.8.2-1.9.7.patch.
Copy it to your Moodle server program directory (typically C:\Program Files\Echo360\Server).
Stop the IIS service.
Execute this command from the command prompt.
c:\Program Files\GnuWin32\bin\patch.exe" \--binary \-p1 <
\[pathToPatchFile\]\echosystem_moodle_patch_1.8.2-1.9.7.patch
6. Look for output like that shown in Output After a Successful Patch Installation.
7. Restart the IIS service. The patch has been applied successfully.
Output After a Successful Patch Installation
After you install the moodle-1.8.2-1.9.7.patch, you see output like this:
(Stripping trailing CRs from patch.)patching
file admin/mnet/adminlib.php
(Stripping trailing CRs from patch.)
patching file calendar/mnet/calendar.php
(Stripping trailing CRs from patch.)
patching file course/mnet/course.php
(Stripping trailing CRs from patch.)
patching file lang/en_utf8/calendar.php
(Stripping trailing CRs from patch.)
patching file lang/en_utf8/calend_mnet.php
(Stripping trailing CRs from patch.)
patching file lang/en_utf8/course_mnet.php
(Stripping trailing CRs from patch.)
patching file mnet/peer.php
(Stripping trailing CRs from patch.)
patching file mnet/remote_client.php
(Stripping trailing CRs from patch.)
patching file mnet/xmlrpc/server.php
Page 41
EchoSystem 5 Documentation
Configure Moodle
Moodle configuration consists of the following phases:
1.
2.
3.
4.
Enable Moodle authentication.
Enable network communication.
Generate a self-signed certificate.
Enable services.
Enable Moodle Authentication
1. Log in to the Moodle web interface.
2. Navigate to Users > Authentication > Manage Authentication.
3. Enable Moodle Network Authentication by clicking the eye icon, shown in the below figure.
Enable Network Communication
1. Choose the new Moodle Network Authentication option that appears on the left-hand pane.
2. Set RPC negotiation timeout to 60. Auto add remote users is not used by the EchoSystem, so it can be
set to your preferred value. These options are shown in the figure below.
3. Navigate to Courses > Enrollments and enable the Moodle Networking option, as shown in the figure below.
4. Click Save Changes.
5. Navigate to Security > Site Policies and enable the Allow EMBED and OBJECT tags option, as shown in
the figure below.
6. Navigate to Network > Settings. Set Networking to On and click Save as shown in the below figure.
7. Navigate to Networking > XML-RPC hosts.
Page 42
7.
EchoSystem 5 Documentation
8. Enter the IP address (not the hostname) of the EchoSystem Server, using CIDR notation at the end of the
address (example: - /32), as shown in the above figure. Click Save.
9. Use the Test an address function at the bottom of the page to verify the ESS IP address is trusted.
10. Navigate to Networking > Peers.
11. Ensure that Register all hosts is not selected, as shown in the figure above.
12. In the Add a new host section at the bottom of the page, add the EchoSystem Server as a Moodle Peer.
Enter the URL to the EchoSystem Server, including the protocol and the port number (example: https://ess.e
chostate.edu:8443/).
13. Click Add host. The Review host details page appears. Ignore the error regarding the retrieval of the public
key. You will enter the public key soon.
14. Enter EchoSystem (or any other name) in the Site field. The Hostname field should be populated with the
URL entered on the previous page, as shown in the figure below.
Page 43
EchoSystem 5 Documentation
Generate a Self-Signed Certificate
Moodle requires a self-signed certificate for the EchoSystem Server host even though Moodle is not actually
contacting the ESS. These steps take place on the EchoSystem Server itself.
1. Install OpenSSL for your operating system.
a. For Mac and Linux operating systems, do the following:
i. Open Terminal and run the following command:
openssl req -new -days 3650 -x509 -nodes -keyout /dev/null
b. For Windows operating systems
i. Download and install OpenSSL for Windows. Navigate to this address: http://www.slproweb.co
m/products/Win32OpenSSL.html.
ii. Open the command prompt and navigate to C:\Program Files\OpenSSL-Win32\bin .
iii. Run the following command:
openssl req -new -days 3650 -x509 -nodes -keyout NUL
2. Enter information regarding the certificate request. Press Enter to accept the default values for all fields
except the Common Name (CN). This is the only required field.
3. When prompted for the Common Name, enter the URL to the EchoSystem Server, including the protocol and
the port number (example: https://ess.echostate.edu:8443/).
Page 44
EchoSystem 5 Documentation
4. After all information has been entered, a new self-signed certificate is generated. Copy and paste the entire
certificate into the Public Key field.
5. Click Save changes.
Enable Services
1. Notice that the ESS has returned you to the Review Host Details screen. Click the Services tab.
2. Select the Publish and Subscribe checkboxes for both the Calendar Service and the Course Service, as
shown in the figure below.
Page 45
EchoSystem 5 Documentation
3. Click Save changes.
You may need to log out and back into the Moodle web interface before these options
appear.
Add the Moodle Publisher to the ESS
1. Navigate from the Moodle web interface to the EchoSystem server.
2. Select Configuration > Publishers.
3. Click Add. The Add Publisher page appears, as shown in the figure below.
4. Enter a name and description for the publisher.
5. Select the parent or child organization to which this publisher belongs.
6. From the Publisher Type list, select Moodle Learning System. The page expands to include a section on
Publisher Configuration that is specific to Moodle.
Page 46
EchoSystem 5 Documentation
7. If you want Moodle to be your default publisher, select the Use by Default box.
8. In the Application URL field, enter the URL of the Moodle Learning System server (example: https://ess.ech
ostate.edu/moodle).
9. By default you will post Podcast, Vodcast, and EchoPlayer versions of your Echo to Moodle. Post
EchoPlayer means that you will post a rich media version viewable in the EchoPlayer (student player).
Change these if necessary by clearing the checkboxes.
10. Click Test Settings to verify that a connection can be established. If it cannot be established, you receive a
detailed error message.
11. Click Save.
Add Moodle to Each Section
After you enable Moodle as a publisher, specify it as the publisher for each section. This ensures that Echoes for
each section publish to Moodle.
1. In Moodle, find the course's Short name, as shown in the figure below.
2. In the ESS, navigate to the Section Details page for the section.
3.
Page 47
EchoSystem 5 Documentation
3. Scroll to the bottom of the page.
4. Click Add Publisher as shown in the figure below.
5. On the Add Publisher page:
a. Select the publisher from the list.
b. In the Course ID field, enter the Moodle Short name.
c. Click Save.
Example: San Francisco State University (SFSU)
SFSU created a custom publisher for Moodle using Echo360's Open Publisher SDK.
The custom publisher is described on LectureCapture.com
The plug-in is available on SourceForge
iTunes U
In this section:
Overview
Add an iTunes U Publisher
Troubleshooting: If Posting Fails
Overview
iTunes U is a course management system from Apple Computer, Inc. that you can integrate with EchoSystem
Server (ESS). Once integrated, iTunes U becomes a publisher of your Echoes, which means that ESS automatically
Page 48
EchoSystem 5 Documentation
uploads Standard Podcast (MP3 audio) and Vodcast (M4V) files to your iTunes U site. The audio files become
content that is visible in a defined tab in iTunes U.
ESS automatically uploads content to an existing iTunes U repository. It can also serve RSS feeds created in ESS
to iTunes U. The integration process described here does not describe how to design, configure, or administer
iTunes U sites. For this information, refer to the iTunes U Administrator's Guide.
Disclaimer
Apple supports iTunes U only in North America. If you are outside North America, manually link
to RSS.
Before adding an iTunes U publisher, you must have the iTunes U account information that Apple provided to the
institution. You can get the account information from the iTunes U administrator or system administrator. Along with
the account, you must have access to the iTunes U site using iTunes.
Add an iTunes U Publisher
1. Log in as an Administrator.
2. Select Configuration > Publishers.
3. Click Add. The Add Publisher page appears as shown in the figure below.
4. Enter a name and description for the publisher.
5. Select the parent or child organization to which this publisher belongs.
6. From the Publisher Type list, select iTunes U. The page expands to include a section on Publisher
Configuration that is specific to iTunes U.
Page 49
EchoSystem 5 Documentation
7. If you want iTunes U to be your default publisher, select the Use by Default check box.
8. Enter your account information in the iTunes U Site URL, Shared Secret, and Credentials fields. This
information is required and you cannot publish without it. If you do not have it, consult your System
Administrator.
9. Enter your user name, e-mail address, display name, and User ID. You can publish to iTunes U without this
information but providing it customizes your iTunes U page.
10. If you want to publish a Podcast or Vodcast, check those boxes.
11. Test your settings by clicking Connect to iTunes U. If the settings are not correct, a message appears
detailing the problem. Correct any necessary information.
12. Click Save to save the new publisher.
Troubleshooting: If Posting Fails
When the ESS and iTunes U time servers are out of sync by more than 60 seconds, postings fail.
You will see publishing error messages in the ESS log that look like a configuration issue:
PublishingException while publishing
presentation
Page 50
EchoSystem 5 Documentation
[51d31848-26e7-4246-aa18-b43249884c04] to
LMI iTunes: An unknown error occurred while
trying to upload to iTunes U. Please check
the 'ess.log' file for more details.
com.echo360.ess.publish.PublishingException:
An unknown error occurred while trying to
upload to iTunes U. Please check the
'ess.log' file for more details.
at
com.echo360.ess.plugins.itunesu.ItunesuUploa
der.validateUploadUrl(ItunesuUploader.java:1
49) ~[na:na]
at
com.echo360.ess.plugins.itunesu.ItunesuUploa
der.uploadMediaToItunes(ItunesuUploader.java
:71) ~[na:na]
at
com.echo360.ess.plugins.itunesu.iTunesuPubli
shingPlugin.publish(iTunesuPublishingPlugin.
java:37) ~[na:na]
at
sun.reflect.NativeMethodAccessorImpl.invoke0
(Native Method) ~[na:1.6.0_24]
at
sun.reflect.NativeMethodAccessorImpl.invoke(
NativeMethodAccessorImpl.java:39)
~[na:1.6.0_24]
at
sun.reflect.DelegatingMethodAccessorImpl.inv
oke(DelegatingMethodAccessorImpl.java:25)
~[na:1.6.0_24]
Page 51
EchoSystem 5 Documentation
at
java.lang.reflect.Method.invoke(Method.java:
597) ~[na:1.6.0_24]
at
com.echo360.ess.service.impl.PublisherServic
eImpl$1.run(PublisherServiceImpl.java:227)
~[ess-lib-4.0.14-SNAPSHOT.jar:4.0.14-SNAPSHO
Page 52
EchoSystem 5 Documentation
T]
at java.lang.Thread.run(Thread.java:662)
~[na:1.6.0_24] Posting Will Fail
To avoid this error, ensure that the ESS machine is synchronized to a non-Windows NTP server such as the Echo
NTP server.
RSS Feeds
In this section:
Overview
Create the Publisher Module
Instantiate the Publisher Module
Overview
You can configure an EchoSystem Server (ESS) so it creates an RSS feed automatically when an Echo is ready for
distribution.
Configuration consists of these phases:
1. Creating the publisher module. The publisher module, which is the main component, defines how the
publisher behaves when it is invoked. It appears at the system configuration level.
2. Instantiating the publisher module for each section. Operating components ("instances") determine which
Echoes invoke the publisher. They appear at the section and Echo levels. A section or Echo that makes use
of a publisher module instantiates it.
Create the Publisher Module
1.
2.
3.
4.
Log in as an Administrator.
Navigate to Configuration > Publishers.
Click the Add button.
In the Name field, give your module a recognizable identifier. You can add an optional description.
Remember the Publisher Module Name
You will need this name when instantiating the Publisher Module.
5. Enable the Use by Default option if you wish all new sections created to instantiate this publisher module.
This means that new sections are automatically publicized via RSS feeds. You still have to instantiate the
publisher module for existing sections.
6. Choose the RSS Feeds item from the Publisher Type combo box.
7. In the Enclosure Metadata section, choose the descriptive information that will appear with each entry in the
generated RSS feed.
8. In the Publisher Configuration section, choose which products (Podcast and Vodcast) will generate feeds.
9. The Title Template field is the name of the RSS feed. It appears as the feed identifier in the Web browser or
feed reader.
10. The built-in variables %course, %section, and %term expand to the actual values for the course, section,
and/or term instantiating the publisher module where they appear.
11. The Publish for all Sections in Course and Term option limits the scope of the publisher module. If
Page 53
EchoSystem 5 Documentation
11.
disabled, the generated feed will contain only Echoes from the section instantiating the module. If enabled,
the generated feed contains all Echoes from the entire course of the section instantiating the module. In this
case, the %section title variable does not function.
12. Click Save.
Instantiate the Publisher Module
1. Log in as an Administrator.
2. Navigate to Schedule > Courses.
3. Click the name of a course containing a section to be published. The Course Details page appears, listing the
course's sections at the bottom of the page as shown in the figure below.
4. Point your mouse to the section you want to publish.
5. Click the edit button. The Edit Section page appears.
6. Near the bottom of the page, click Add Publisher in the Configured Publishers area.
7. In the box that appears, select the publisher module name you created earlier, as shown in the figure below.
8. Select the Allow iTunes Subscription box if you want to allow iTunes users to receive the RSS feed from
within the iTunes application.
iTunes U publishing is different.
Allowing iTunes users to receive RSS feeds is different from publishing to iTunes U. See i
Tunes U.
9. Click Save.
10. On the Edit Section page, click Save again.
11. To immediately use the URIs produced by the publisher, click the title of any Echo, instantiating it from the
Echoes list in your ESS. The URIs for the chosen products are listed at the top of the page. If you configured
other publishers (Moodle, Blackboard, and so on) these publishers advertise the presentation URIs in their
publications.
ANGEL Learning Management Suite
Page 54
EchoSystem 5 Documentation
In this section:
Overview
Modify ANGEL Settings
Configure the ESS
Overview
The EchoSystem supports automatic publication of links to courses within the ANGEL Learning Management Suite
(ANGEL).
To create this functionality, you must:
1. Modify ANGEL settings
2. Configure the EchoSystem Server (ESS).
Modify ANGEL Settings
Some ANGEL settings must be modified. Others are optional, but recommended. Follow these steps.
1. Modify the required settings:
Create or specify an ANGEL Admin User for the EchoSystem Server. You will need the username and
password when configuring the ESS ANGEL Publisher.
If you use the API_ACCESS Environment Variable on your ANGEL server, add the SECTION_SEARCH
and SECTION_ITEM_CREATE items.
Add the COURSE_ID for each ANGEL course you will be publishing to.
2. Modify the optional settings:
Add the Admin user you just specified to the API_USER environment variable. This means the ANGEL
Admin user is restricted from interactive login. The user can only log in and use the API
programmatically.
The API_ACCESS Environment Variable can be used to limit the Admin user to just the two specific
API function calls required: SECTION_SEARCH and SECTION_ITEM_CREATE.
Enable the LOG_API_CALLS Environment Variable to log all of the API calls.
Configure the ESS
Configuring the ESS consists of two phases:
Configuring the publisher.
Configuring the schedules. The specific process you use varies, depending on whether you are applying the
publisher to existing Echoes, existing schedules, or new schedules.
Configure the Publisher
1.
2.
3.
4.
5.
6.
Page 55
Log in the ESS UI.
Navigate to Configuration > Publishers.
Click Add. The Add Publisher page appears, as shown in the figure below.
Enter a name and description.
Select a parent or child organization from the list.
From the Publisher Type list, select Angel Learning System. The page expands to show the configuration
settings for ANGEL Learning System.
EchoSystem 5 Documentation
7. If you want ANGEL to be your default publisher, select the Use by Default box.
8. Fill in the required fields and the optional field if desired:
Name: The Publisher name. It will appear elsewhere in the application.
Application URL: The URL for the ANGEL application.
Rich Folder Name: The folder inside each ANGEL course where the rich media content links will be
posted. The publisher creates this folder if it does not exist in ANGEL.
Download Folder Name (optional): The folder inside each ANGEL course where the download links
(Podcast and Vodcast) will be posted if specified. If you do not specify a download folder name, links
are posted in the Rich Media Folder. The publisher will create this folder if it does not exist in ANGEL.
Angel API Username: The user name of the ANGEL user, which has been granted ANGEL API
access.
Angel API Password: The password for the above user.
9. If you want to post a vodcast, a podcast, or rich media of your Echo to ANGEL, click the respective boxes.
10. Test the settings by clicking the Connect to Angel button. If the connection attempt is unsuccessful, verify
each of the settings.
11. Click Save.
Configure the Schedule
The ANGEL publisher can be applied to existing Echoes, existing schedules or new schedules.
For Existing Echoes (Presentations)
1.
2.
3.
4.
5.
6.
Page 56
Navigate to the Echoes page
Hover over the Echo to publish.
Click the edit link.
Click the Add New button in the Presentation Publishing Settings section.
Select the ANGEL publisher created above.
EchoSystem 5 Documentation
6. Enter the unique Course ID for the course content you are publishing. This is the COURSE_ID you created
when you modified ANGEL settings.
7. Save the publisher and the Echo.
For Existing Schedules
1.
2.
3.
4.
Navigate to the schedule.
Click the Add New button in the Publisher section.
Select the ANGEL publisher created above.
Enter the unique Course ID for the course content you are publishing. This is the COURSE_ID you created
when you modified ANGEL settings.
5. Save the schedule.
For New Schedules
If you selected the Use by Default option when configuring the publisher, follow these steps.
1. Click the ANGEL publisher name link in the schedule and add the Course ID when prompted.
2. Save the schedule.
If you wish to publish content from a certain schedule to multiple courses within ANGEL, add the same publisher to
the schedule and type in the Course ID for the additional course.
Closed Captioning and Transcript Publisher
In this section:
Add the Closed Captioning and Transcript Publisher
Add the Closed Captioning and Transcript Publisher
1. Log in as an Administrator.
2. Select Configuration > Publishers.
3. Click Add. The Add Publisher page appears as shown in the figure below.
4. Enter a name and description for the publisher.
5. Select the parent or child organization to which this publisher belongs.
6. From the Publisher Type list, select Closed Captioning and Transcript. The page expands to include a
section on Publisher Configuration that is specific to Closed Captioning and Transcript, as shown in the figure
below.
Page 57
6. 5 Documentation
EchoSystem
7. If you want Closed Captioning and Transcript to be your default publisher, select the Use by Default box.
8. In the SFTP Server field, enter the URL to the Secure File Transfer Protocol (SFTP) server that you will use
to transfer files.
9. In the Account Name field, enter the name of the account used to access the SFTP server.
10. In the Private Key field, enter the private key for the account.
11. Click Test Settings to verify that a connection can be established. If it cannot be established, you receive a
detailed error message.
12. Click Save.
Echo360 Search Indexing
In this section:
Add the Echo360 Search Indexing Publisher
Add the Echo360 Search Indexing Publisher
1. Log in as an Administrator.
2. Select Configuration > Publishers.
3. Click Add. The Add Publisher page appears as shown in the figure below.
4.
5.
6.
7.
8.
Enter a name and description for the publisher.
Select the parent or child organization to which this publisher belongs.
From the Publisher Type list, select Echo360 Search Indexing.
If you want Echo360 Search Indexing to be your default publisher, select the Use by Default box.
Click Save.
Email Publisher
Page 58
EchoSystem 5 Documentation
In this section:
Add the Email Publisher
Add the Email Publisher
Only Echoes with an Available status can be published to the Email Publisher. See Inactive Echo Settings for details
on making Echoes available.
1. Log in as an Administrator.
2. Select Configuration > Publishers.
3. Click Add. The Add Publisher page appears as shown in the figure below.
4. Enter a name and description for the publisher.
5. Select the parent or child organization to which this publisher belongs.
6. From the Publisher Type list, select Email Publisher. The page expands to include a section on Publisher
Configuration that is specific to the Email Publisher, as shown in the figure below.
Page 59
EchoSystem 5 Documentation
7.
8.
9.
10.
If you want use Email as your default publisher, select the Use by Default check box.
In the SMTP Host box, enter the URL of your mail server.
In the Port box, enter the port on the mail server that emails from the EchoSystem should use.
In the To Address and From Address, enter the email address that emails from the EchoSystem should be
sent to and from.
11. Select the Send to Presenters? box to notify Academic Staff who are serving as presenters by email that
their Echo is ready to view. This allows Academic Staff to review an Echo before releasing it to the public.
Email notifications
When this option is selected, this email becomes the first in a series of two that Academic
Staff receive after publishing an Echo. This one, the first, notifies Academic Staff that the
Echo has completed processing. The second lets them know that the Echo is available for
students to view.
12. By default, the Enable TLS box is selected. Transport Layer Security (TLS) encrypts the emails.
13. By default you will post Podcast, Vodcast, and EchoPlayer versions of your Echo to the Email Publisher. Post
EchoPlayer means that you will post a rich media version viewable in the EchoPlayer (student player).
Change these if necessary by clearing the check boxes.
14. Click Test Settings. If the settings are not correct, a message appears detailing the problem. Correct any
necessary information.
15. If the SMTP host requires authentication, select the Requires Authentication box and then enter the
server's user name and password.
16. Click Save to save the new publisher.
Manage Schedules
In this section:
What is Scheduling?
Who Does Scheduling?
Schedule Terminology
Page 60
EchoSystem 5 Documentation
What is Scheduling?
Scheduling automates lecture capture. When you (a Scheduler or System Administrator) schedule a course, you tell
the EchoSystem to capture every lecture given in a particular classroom (such as "Room 729") at a particular time
(such as "8-9:15 am, Monday, Wednesday, Friday"), for a particular term (such as "Autumn 2010").
When a course is scheduled in the EchoSystem Server (ESS), the Academic Staff member serving as the presenter
(Instructor, Teaching Assistant, Student Presenter, or Guest Presenter) need only arrive at the classroom and begin
teaching. The lecture is automatically captured, processed, and posted for student review without any further
administration.
Who Does Scheduling?
The EchoSystem includes two different user roles, either of which can schedule captures:
The Admin role has unrestricted rights. An Admin can perform any function in the EchoSystem, including
scheduling.
The Scheduler role has more authority than one of the Academic Staff roles, but less authority than the
Admin role. This role may be assigned to junior staff. In general, the Scheduler can:
Create and modify schedules
Edit presentation metadata (such as the Description)
More specifically, the Scheduler can:
Log in to the ESS UI.
Configure Scheduler Alerts settings.
View all presentations in the Echoes tab.
Edit presentation metadata (such as the Description).
Change presentation states. However, the Scheduler cannot permanently delete an Echo.
View and modify any schedules.
View the Monitor tab and see the following sub-tabs:
Summary
Captures
Processing Tasks
Alerts
Support
The Scheduler cannot:
Log in to the capture device user interface or Personal Capture. The Scheduler is not assigned to sections as
Academic Staff are.
View or modify the Configuration tab.
View or modify Notifier settings or non-Scheduler Alert settings.
Change course content.
Roles are additive. This means that a Scheduler who is also a Academic Staff member may perform both roles.
Schedule Terminology
The terms listed in the table below are commonly used when discussing scheduling.
Term
Page 61
Description
EchoSystem 5 Documentation
Recurring Event Schedule
A recurring event schedule enables captures on
several different dates and times over the course of a
term. Say, for example, that during the autumn term,
section 001 of ECON101 meets on Mondays,
Wednesdays and Fridays in room 600 at 10 am. You
could create a recurring schedule that would capture all
class meetings without further administration from you.
Single Event Schedule
A single event schedule enables a single capture at a
specified date and time. For example, if a guest lecturer
is presenting in a large lecture hall, you can schedule a
single event to capture the lecture.
Draft Schedule
Draft schedules are saved but not activated. You can
begin work on creating a schedule, save it as a draft,
and return later to complete it. All schedules (including
copied schedules) are draft until activated.
Active Schedule
An active schedule is applied to the room for capture.
All required information must be set before a schedule
can be activated.
Completed Schedule
A completed schedule is one where the last scheduled
capture time is in the past. If you create a schedule to
capture all classes from August 1 to December 15, that
schedule becomes a completed schedule on December
16. This is so even if the last capture did not occur.
Activate a Draft Schedule
In this section:
Overview
Activate a Draft
Overview
Saving a draft lets you keep a schedule without activating it. Say, for example, that you know the dates and times for
the course but not the room. You can enter the parameters you know, save the schedule as a draft, then enter just
the room later.
The draft schedule (on both the listing page and detail page) shows the status of each required field. In the
screenshot shown in the figure below, you see that the room parameter has not been completed.
Activate a Draft
You can activate a draft schedule any time if all required schedule data has been entered. If all data has been
Page 62
EchoSystem 5 Documentation
entered, you see a series of green check marks next to the schedule title.
1.
2.
3.
4.
5.
Navigate to Schedule > Schedules.
At the bottom of the page, click the Draft tab.
Click the schedule you want to activate. The Schedule Details page appears.
Review the settings. Make sure you have entered all required data.
Click Activate.
Best Practice: Confirm the Assigned Product Group
If the product group assigned to a schedule specifies that a particular capture device be
used, and the device is not installed in the specified room, you will see a warning
message. Before activating the schedule, we recommend that you confirm that the device
in the room can support the assigned product group. See Configure Product Groups.
Create a New Schedule
In this section:
Overview
Before You Begin
Create a New Schedule
Overview
You can create two different types of schedules:
You might, for example, create a schedule for section 001 of ECON101, which meets on Mondays,
Wednesdays and Fridays in room 600 at 10 am during the autumn term.
A single event schedule enables a single capture at a specified date and time with an assigned capture
device (a capture appliance or Classroom Capture Software). You might create such a schedule for a guest
lecturer, keynote speaker, or commencement address.
This section explains how to create both types of schedules.
Remember to Activate the Schedule
When you first create a schedule, it is in draft status. It does not become active until you press
the Activate button.
Before You Begin
Before you create a schedule, make sure you have defined the entities you will specify when you create the
schedule. These are:
Terms (Schedule > Terms)
Sections (Schedule > Courses > Course Details)
Date and Time
Rooms (Configuration > Rooms)
Presenter (inherited from section)
Product Groups (inherited from product groups)
When you create the schedule, you can set or modify these entities:
Page 63
EchoSystem 5 Documentation
Schedule- or course-specific exclusions dates
Display input resolution (inherited from room)
Echo defaults (inherited from the parent or child organization)
Create a New Schedule
1.
2.
3.
4.
5.
In the EchoSystem server application, navigate to Schedule > Schedules.
Select the term from the list.
Select the course from the list.
Select the section from the list.
Click Add New. This opens the Add New Schedule page, as shown in the figure below.
6. Review and complete the Course/Description, Room, Date and Time, Exclusions, Presenters, Product
Groups, and Echo Defaults options.
7. Click Save.
8. Saving the schedule opens the Schedule Details page, as shown in the figure below.
Remember to Activate the Schedule
Although you have saved the schedule, it is still in draft status. It does not become active
until you press the Activate button.
9. Verify that you have entered all the information required. You should see a series of green check marks at the
top of the page.
10. Press Activate to move the schedule from draft to active status.
Page 64
EchoSystem 5 Documentation
Course / Description
The following figure shows the Course/Description scheduling options. Below the figure is a table that describes the
settings available.
Page 65
EchoSystem 5 Documentation
Option
Description
Inherited From
Course
The full course name according to
the EchoSystem Server (ESS). ESS
constructs a course name from the
defined course name, the course
identifier, the section, and the term.
Course
Title
The course title, set to the ESS
course name by default. It is
displayed in the EchoPlayer during
student review.
Course
Description
An optional description for the
course that can be displayed in the
EchoPlayer during student review.
Course
Room
The following figure shows the Room settings. Below the figure is a table that describes the settings available.
Option
Description
Inherited From
Campus (filter)
Select the appropriate campus.
Only buildings on that campus are
listed in the Building list.
N/A
Building (filter)
Select the appropriate building.
Only rooms in that building are
listed in the Room list.
N/A
Room
Select the appropriate room.
N/A
Page 66
EchoSystem 5 Documentation
Display input resolution
Defines the display resolution for
the VGA source (podium computer,
laptop, document camera, etc.).
This setting only applies to rooms
with capture appliances. Setting the
display resolution ensures the
highest quality VGA capture. See
the Deployment Guide for a list of
supported VGA input resolutions.
Room
Date and Time - Recurring Event
The following figure shows the Date and Time scheduling options for a Recurring Event. Below the figure is a table
that describes the settings available.
Option
Description
Inherited From
Start Date
The start date for the recurring
capture. Typically, the first day of
the term.
N/A
End Date
The end date for the recurring
capture. Typically, the last day of
the term.
N/A
Days
Days of week to capture. Select all
relevant days.
N/A
Start Time
The start time of the capture.
Typically, the class start time.
N/A
Duration
The duration of the capture.
Typically, the class duration.
Parent Organization > Child
Organization > Schedule
Date and Time - Single Event
The following figure shows the Date and Time scheduling options for a Single Event. Below the figure is a table that
describes the settings available.
Page 67
EchoSystem 5 Documentation
Option
Description
Inherited From
Start Date
The date of the capture.
N/A
Start Time
The start time of the capture.
Typically, the class start time.
N/A
Duration
The duration of the capture.
Typically, the class duration.
Parent Organization > Child
Organization > Schedule
Exclusions
The following figure shows the scheduling Exclusions options. Below the figure is a table that describes the settings
available.
Option
Description
Inherited From
Excluded Dates (from and to)
Specific dates or a date range that
should not be captured. These
might be the exam dates for the
course. These dates, with the term
exclusion dates, determine which
class sessions are not captured.
N/A
Presenters
The following figure shows the Presenters section of the scheduling page. Below the figure is a table describing the
information.
Page 68
EchoSystem 5 Documentation
Option
Description
Inherited From
Selected Presenter(s)
Presenters for the capture.
Typically, the Academic Staff
member presenting the course.
Section
If the staff selected is not correct,
select Staff members from each of
the list boxes and use the select an
d deselect arrows to move Staff to
the appropriate list.
Echo Defaults
The following figure shows the information displayed in the Echo Defaults section of the Schedule Details page.
Below the figure is a table describing the information.
Option
Definition
Inherited From
Echoes Initially Unavailable?
If checked, Echoes are NOT
available as soon as processed.
You might check this box:
Section
If Echoes must be approved or
edited before student review
To ensure that Echoes are
released at specific times, such
as a week before exams
Product Groups
The following figure shows the scheduling Product Groups options. Below the figure is a table that describes the
settings available.
The table below describes the options configured in the Product Groups section of the Schedule Details page.
Option
Page 69
Definition
Inherited From
EchoSystem 5 Documentation
Product Group
The products and output qualities
that are captured.The specific
choices you make for each product
(Podcast, Vodcast, and
EchoPlayer) must coordinate with
each other. See Configure Product
Groups for details.
Section
Manage Existing Schedules
In this section:
Overview
Sort Schedules
Filter and Search Schedules
Copy a Schedule
Delete Schedules
Overview
After you have created a few schedules you may want to:
Sort schedules by title, presenter, room or status
Filter and search schedules
Copy a schedule
Delete draft or completed schedules
All of these tasks are done from the Schedules tab. Select Schedule > Schedules.
Sort Schedules
The Schedules List view organizes schedules into active, draft, and completed groups by tabs. Within each tab,
schedules are listed in a table with sortable columns. You can sort schedules by various parameters, such as title or
presenter. The figure below shows the Active tab of the Schedules List view.
Some schedules have additional management options. Hover your cursor on the schedule row to make the hover
menu appear.
Filter and Search Schedules
Use the Filter By and Keyword Search controls to display only the schedules of interest. The filter or search is
specific to the selected tab. This means that if, for example, you are viewing the Active schedules and search for the
course "ECON101", only schedules in the Active tab with that keyword will be displayed.
To see all schedules with a particular keyword or parameter value, select the All tab.
Page 70
EchoSystem 5 Documentation
Copy a Schedule
Copying a schedule is a convenient time-saver when a course's schedule is the same for two terms.
You can copy active schedules only. When you copy a schedule, the section and schedule data are copied into a
new term.
1. Create a new term (Schedule > Terms). You will copy the section and schedule into this new term.
2. Set this term to be the default Term (Configuration > Organizations).
3. Navigate to Schedule > Schedules. Find the schedule you want to copy, using a filter or keyword search as
necessary.
4. Hover your mouse over the schedule you want to copy. Notice that a copy button appears below the schedule
name, as shown in the figure below.
5.
6.
7.
8.
9.
10.
Click Copy.
The edit schedule page displays. Edit the schedule data if necessary.
Scroll to the bottom of the page and click Save.
The schedule is saved as a draft.
Notice that the new term ("Spring" for example) appears next to the course name and title.
Click Activate.
Delete Schedules
You can delete draft and completed schedules. Active schedules cannot be deleted.
Workaround: To Delete an Active Schedule
If you are sure you want to delete an active schedule, edit the schedule so the End Date of the
schedule is today.
If no recording is scheduled for today, the status will change to completed. You can delete
a completed schedule.
If a recording is scheduled for today, try again tomorrow.
1. Navigate to Schedule > Schedules.
2. Select either the Draft or Completed tab.
3. Do one of the following:
To permanently delete only one schedule, hover over the schedule and click delete.
To permanently delete one or multiple schedules, select the box to the left of each schedule and select
Delete selected from the Actions list at the bottom of the page.
4. Notice that, in either case, a confirmation message appears.
Monitor the System and Set Alerts
Page 71
EchoSystem 5 Documentation
In this section:
User Roles and Monitoring
Monitor Overall Processing Status
Monitor Capture Processing Status
Monitor Capture Status
Monitor Processing Tasks
Monitor Personal Capture Devices
Receive Alerts
Receive Email Notifiers
View and Set Alerts
Receive Technical Support
View Log Files
User Roles and Monitoring
If you implemented delegated administration, you created child organizations and user roles that are specific to the
child organizations. You might have an Administrator or Scheduler for the child organizations. You might also have
Academic Staff for the child organizations.
The tabs visible to you and the information in the tabs depends on your role and on your organization, as detailed in
the table below.
If you are:
You:
The System Administrator
See every tab and all information on the tabs. As the
System Administrator you are, by definition, associated
with the parent organization
An Administrator for the parent organization
See every tab and, in each tab, information on tasks
related to all organizations
An Administrator for a child organization
See every tab and, in each tab, information on tasks
related to your organization
A Scheduler (for either the parent or a child
organization)
See only the Summary and Processing Tasks tabs
See only events from your organization. You can see
all events for your organization, even if you did not
schedule them yourself.
See the capture and section details links
Cannot change priorities or delete jobs on the
Processing tab
Academic Staff
Monitor Overall Processing Status
Page 72
Cannot see the Monitor tab
EchoSystem 5 Documentation
What You See Depends on Who You Are
Your user role and organizational affiliation affect the information shown to you, as explained in U
ser Roles and Monitoring.
You can find statistics about the overall health of the EchoSystem Server (ESS) on the Summary page. Statistics
include the number of system alerts, the status of each active device and media processor, and the system status.
All monitoring activities on this tab are done at the system level, meaning you can monitor all capture operations on
a given day.
You can also monitor the status of the audio, display, and video signals associated with each capture. A legend is
listed next to the Source header of the page explains the meaning of each color for the signal status.
Monitor a Single Capture
You can also monitor a single device-specific configuration or device-specific configuration or
capture in the Ad Hoc interface. You may want to do this, for example, if you noticed a problem
with a capture on the Summary page but could not resolve the problem without more detail. The
Ad Hoc interface provides a way for you to get more information about the problem from the
capture device itself. To reach the Ad Hoc interface, navigate to Configuration > Devices, then
click the link in the device listing to reach the Device Details page. Click the IP address of the
device. The Ad Hoc interface appears. Click the Monitor tab to watch a visual representation of
the capture.
1. Navigate to Monitor > Summary. The Summary tab appears, as shown in the figure below.
2. Review the System Alerts, Capture Stations, Media Processors, and System Status information at the top of
the page.
3. Click any number in the summary statistics to link to detailed information about it. For example, clicking the
number of registered capture stations opens the Devices page within the Configuration tab, where you can
view, edit, upgrade, or retire those capture stations.
Monitor Capture Processing Status
What You See Depends on Who You Are
Your user role and organizational affiliation affect the information shown to you, as explained in U
ser Roles and Monitoring.
1. Navigate to Monitor > Summary. The Summary tab appears.
2. View the Recent Captures area below the summary statistics. All recent captures appear on one of four tabs:
Scheduled, Capturing, Processing, or Completed, as defined in the table below.
Capture State
Page 73
Definition
EchoSystem 5 Documentation
Scheduled
A capture that has been scheduled for later today.
Capturing
A lecture that is currently being captured.
Processing
A capture or media import that is being processed
and packaged for use.
Completed
A capture that has completed processing and has
been published to the selected publisher(s).
3. Find the capture you want to monitor. You can do that in either of the following ways.
Search for a capture that meets the search criteria you enter.
Browse the captures by state by clicking the relevant tab as described in the table above.
4. Review the status of the capture. The following table explains each element of the capture's status.
Status Element
Definition
Time
Start and end time of the capture
Course
The Course Identifier associated with a course in
the system
Room
Physical location where the capture occurs
Capture Status
Displays the status of the capture of the lecture or
external media import. Options are Waiting, Uploadi
ng Files, Capturing, Succeeded, Failed, and Missed
.
A capture that is Failed or Missed will be listed for
seven days, then deleted.
Missed Captures
A missed capture is a scheduled
capture that did not start
capturing. A capture might be
missed if there is not a device in
the room, if the scheduled
capture was not transmitted to
the device in time for the capture
to actually start, or a power
outage occurred. The system
administrator can troubleshoot a
missed capture by monitoring
the device and confirming that it
is licensed.
Page 74
EchoSystem 5 Documentation
Source
Shows the status of the video, display, and audio
signals associated with the capture. The following
image explains the color coding of the signal status.
The source signal graph only
shows the status of the latest
60-minute block of the capture,
in one-minute intervals.
Processing Status
Displays the status of the processing of the capture,
which involves packaging the capture into a form
that a student, for example, can experience.
Options are Succeeded, Failed, License Expired, or
Cancelled.
About the Succeeded Status
It is possible for a capture's
processing status to display Suc
ceeded even when the source
signal graph shows areas of
problems with a source signal.
The processing status
complements the source signal
graph. Succeeded indicates that
some signal was successfully
captured. Problems in the
source signal highlight portions
of the captured media that may
not have captured the desired
content. For example, if the
Audio Signal shows as Not
Present, perhaps because the
microphone was unplugged, the
capture's processing status
would show as Succeeded but
the captured media may have an
audio dropout.
Progress
Page 75
Displays the percent complete of the processing
step.
EchoSystem 5 Documentation
Elapsed
Time in hours, seconds, and minutes since
processing began.
Publishing
If the capture is scheduled to be published, this field
shows the name of each publisher (such as RSS or
Email) and its status: Success (
), Retry (
Alerts
), and Failure (
), Pending (
).
Number of times this capture has raised a
publishing alert.
Sort the list of captures
You can sort the list of captures for a selected capture state tab by clicking the column
name.
Monitor Capture Status
What You See Depends on Who You Are
Your user role and organizational affiliation affect the information shown to you, as explained in U
ser Roles and Monitoring.
View the status of all captures, including Echoes (lecture captures) and external media imports, on the Captures tab.
Click any capture name to view its details.
1. Navigate to Monitor > Captures.
2. Find the Echo or media import. You have several choices for finding a capture. Options include the following.
Click the All tab and search for a capture by entering a term in the Keyword Search box and then
clicking Search.
Click the All tab and filter the list of all captures by Date, Course, Presenter, or Room. Select one of
these options from the Filter list, optionally enter a date, and then click Search.
Filter the list of all captures by clicking the Scheduled, Capturing, Processing, or Completed tab.
Each tab corresponds to a capture state. A list of only those captures in the selected state appear.
Page 76
EchoSystem 5 Documentation
Sort the List of Captures
You can sort the list of captures for a selected capture state tab by clicking the
column name.
3. Check the status of the capture by viewing the summary in the capture list. Click the capture name to view
the detailed status about the capture, including its history as reported in the system log and full log.
View Capture Details
You can click the name of a capture in the list of captures on the Captures page and the Processing Tasks page to
get details about that capture, as well as access to a full log of the capture's processing activity.
1. Navigate to Monitor > Captures.
2. Click the name of the capture in the Title column. The Capture Details page appears, as shown in the figure
below.
The following table explains the information on this page.
Page 77
Field
Description
ID
The unique identifier for the capture. Click this link
to view the processing log in a new browser
window.
Title
The capture title that the system or the user
provided
Room
Complete location of capture including campus,
building and room
Start Time
The time when the capture began
EchoSystem 5 Documentation
Presenter
The name(s) of the presenter(s) that the user
provided
Presentation ID(s)
The unique identifier of the processed echo. Click
this link to view details about this echo.
Section
Term, Course and Section IDs
Status
This capture status
Duration
The length in time of the capture
Task ID
The unique identifier for the processing task
Task Created
The time when the processing task began
3. For additional details about this capture, view one of the logs. Click the System Log button to view the details
about the processing of this specific capture. Click the Full Log button to view the complete history of the
capture from the time it was scheduled to the time publishing is complete. Both logs open in a new browser
window.
Sort the List of Captures
You can sort the list of captures for a selected capture state tab by clicking the column
name.
Monitor Processing Tasks
What You See Depends on Who You Are
Your user role and organizational affiliation affect the information shown to you, as explained in U
ser Roles and Monitoring.
On the Processing page you can see the captures currently being processed and in the queue for processing. In
addition to viewing the details of the task in either list, you can prioritize (raise or lower the priority in the list) or
cancel the tasks for the ESS in the Queued to be Processed list.
Click any task to view its details, including its history as captured in the system log and full log.
Navigate to Monitor > Processing Tasks. The Processing Tasks page appears. You can do the following on
this page.
View information about each capture that is being processed or in the queue for processing. The
following table explains this information.
Page 78
Field
Description
Title
Name of the capture being processed or in the
queue for processing
EchoSystem 5 Documentation
Processor
The MAC of the media processor assigned the
processing task
Pri.
Priority of the capture that is determined by the
user. The default, which you may change, is Nor
mal. Options are Low, Normal, and High. Note
that you can raise or lower the priority of a
capture by hovering your mouse over a capture
to highlight it, then clicking raise or lower, as
shown in the following figure.
Click cancel to cancel the processing of this
task.
Task Created
The date and time when the recording of the
capture ended and processing began.
Next Retry
If the media processors are busy or the media
files are uploading, the system enters a time in
this field. The default is ASAP.
Capture Start
The date and time when the recording of the
capture began.
Duration
The length of time of the capture that is in the
queue to be processed.
Room
The room where the capture was recorded
Click the capture title to view details about that capture.
Change the priority or cancel the processing task. To do so, hover your mouse over a capture to
highlight it. Click the raise button to increase the priority of the processing task, the lower button to
decrease its priority. Click the cancel button to remove it from the list and either stop all processing
tasks in progress or remove those tasks from the processing queue.
Sort the List of Processing Tasks
You can sort the list of processing tasks by clicking the column name.
Monitor Personal Capture Devices
What You See Depends on Who You Are
Your user role and organizational affiliation affect the information shown to you, as explained in U
ser Roles and Monitoring.
Page 79
EchoSystem 5 Documentation
This tab lists computers with Personal Capture that have connected to the ESS.
Navigate to Monitor > Personal Capture. The Personal Capture Devices page appears as shown in the below
figure.
The following table explains the fields.
Field
Description
Last IP Address
The IP address of the computer that connected to the
ESS. The Last Publish Request By field shows that
the last request was made by Lam Vu, so this is
probably the IP address of Lam Vu's personal
computer.
Platform
The computing platform of the personal computer when
it last connected to the ESS. This is probably the
computing platform of Lam Vu's personal computer.
O/S Details
The operating system of the personal computer when it
last connected to the ESS. This is probably the
computing platform of Lam Vu's personal computer.
Software Version
The version of Personal Capture installed on the
personal computer when it last connected to the ESS.
This is probably the version of Personal Capture
installed on Lam Vu's personal computer.
Last Publish Request Time
The date and time of the last publishing request
received by the ESS from this personal computer.
Last Publish Request By
The person who made the most recent publish request
from this personal computer.
Sort the List of Devices
You can sort the list of personal capture devices by clicking the column name.
Page 80
EchoSystem 5 Documentation
Receive Alerts
What You See Depends on Who You Are
Your user role and organizational affiliation affect the information shown to you, as explained in U
ser Roles and Monitoring.
You can receive alerts that apply to ESS as a whole or to a specific capture. They show if something out of the
ordinary has happened on your EchoSystem. For example, if the capture was not licensed or your ESS is out of disk
space, you may receive an alert.
You can view a record of all of the alerts that your capture and processing tasks have triggered. This information
helps you decide when you might need to reprocess an Echo.
Navigate to Monitor > Alerts. The Alerts page appears. You can do the following on this page.
View the alerts that have been triggered by capture and processing tasks. The following table explains
the available status information.
Field
Description
Alert Time
The time the alert was triggered
Triggering Event
The event that caused the alert to be sent
Time Relative to Trigger
How soon after the triggering event that the ESS
sent the alert
Relates To
Name of the ESS capture or processing task
that triggered the alert
No. of Notifications Sent
Number of emails sent to the ESS administrator
about this alert
Receive Email Notifiers
What You See Depends on Who You Are
Your user role and organizational affiliation affect the information shown to you, as explained in U
ser Roles and Monitoring.
You can set up EchoSystem to send a notifier e-mail if a system alert occurs. Receiving these notifications helps
you address potential problems quickly, thereby maintaining system up time. You can view these emails as well as
add, edit, and delete them.
These notifier emails are sent through a SMTP server to all registered addresses for certain user roles (Scheduler,
Academic Staff, Admin, A/V Technician, and Server Administrator).
View Email Notifiers
Navigate to Monitor > Notifiers. The Notifiers page appears.
Page 81
EchoSystem 5 Documentation
View all email notifications that ESS has sent. The following table explains the information provided
about these emails.
Field
Description
Name
Name of the email notifier
Description
Additional information about the email notifier
Notifier Type
How the notifier was sent. Email is currently the
only option.
Add Email Notifiers
1. Navigate to Monitor > Notifiers. The Notifiers page appears.
2. Click Add. The Add Notifier page appears, as shown in the following figure.
3.
4.
5.
6.
Enter a name for the notifier.
Optionally, enter additional information about the notifier.
Select a notifier type from the list. Email is currently the only option.
Click Save.
Edit Email Notifiers
You may need to edit your email notifiers if you modify your email system; for example, by adding security to the
system or changing your email server.
1.
2.
3.
4.
5.
Navigate to Monitor > Notifiers. The Notifiers page appears.
Highlight a notifier. Two buttons appear.
Click edit.
Make changes to the notifier as desired.
Click Save.
Delete Email Notifiers
If the email notifier has sent an alert (even just once) it cannot be deleted.
Page 82
EchoSystem 5 Documentation
Otherwise, follow these steps.
1. Navigate to Monitor > Notifiers.
2. Hover over the notifier to be deleted.
3. Click delete.
4. Confirm that you want to delete the notifier.
5. Notice the message confirming deletion at the top of the page.
View and Set Alerts
What You See Depends on Who You Are
Your user role and organizational affiliation affect the information shown to you, as explained in U
ser Roles and Monitoring.
You can view all alerts configured and specify which alerts selected users should receive. When the administrator
configures an alert, he or she subscribes to it on behalf of a selected user role. For example, when triggering events
occur, an alert about them is sent only to people with selected roles such as A/V Technician, Server Administrator,
and Academic Staff.
The notifier email simply contains the outgoing SMTP server information.
View Alert Settings
Navigate to Monitor > Alert Settings. The Alert Settings page appears, showing all alert settings for all user
roles.
Page 83
EchoSystem 5 Documentation
Set Alerts to Receive
1.
Page 84
EchoSystem 5 Documentation
1. Navigate to Monitor > Alert Settings. The Alert Settings page appears, showing all alert settings for all user
roles.
2. From the Role list, select the user role to which you want to send a new alert.
3. Select one or more triggering events for which you want to generate an alert to people with this user role.
4. Click Save.
Receive Technical Support
What You See Depends on Who You Are
Your user role and organizational affiliation affect the information shown to you, as explained in U
ser Roles and Monitoring.
When you need support, navigate to Monitor > Support and share the details there about your ESS to support
personnel. You can even upload this information directly to support personnel by clicking the Upload button at the
top of the page. Click the logs at the bottom of the page to get details about all recent capture and processing tasks.
Page 85
EchoSystem 5 Documentation
Page 86
EchoSystem 5 Documentation
View Log Files
What You See Depends on Who You Are
Your user role and organizational affiliation affect the information shown to you, as explained in U
ser Roles and Monitoring.
Overview
Log files (except for the ess-installer.log) show detailed daily operations by component. You might be asked to
send a log file to Technical Support or to look at one while talking with a Technical Support engineer.
The ess log files (such as ess.20111020.log) show all server-side activity required to make a capture
available. Current ESS tasks are shown as active. This file is often used when diagnosing publisher issues.
If you are diagnosing issues with a Blackboard integration, consult this KB (Knowledge Base) article fo
r a discussion of log file messages and what they mean.
If you see random HTTP 500 errors in an ess log file, consult this KB (Knowledge Base) article.
Accessing the Knowledge Base
You will need a customer portal login to access the Knowledge Base. Contact Tech
nical Support if you need a login.
The request log files (such as request.20111020.log) show every http request being made to the web
server. These are typically called "web server access logs". You might view these files with Echo360
Technical Support to discover spurious requests from the server.
The wrapper log files (such as wrapper.20111020.log) show interaction between the ESS and operating
system (Windows, Linux, Mac OS). You might view these files with Echo360 Technical Support when the
Java virtual machine (JVS) fails to start.
The jetty log files (such as jetty.20111016.log) show errors specific to the web server (the Jetty server) as
opposed to those that relate to the ESS. You might view these files with Echo360 Technical Support when
either the ESS or EchoCenter fails to start.
Procedure
1. Navigate to Monitor > Support.
2. Scroll down to the Log Files section of the page.
Page 87
EchoSystem 5 Documentation
3. Click on the desired log file. The file opens in a new tab. The example below shows an ESS log file.
System Configuration
In this section:
Overview
Overview
Page 88
EchoSystem 5 Documentation
EchoSystem configuration is done when first installing the system or when preparing for a new term. Some
configuration tasks are also done during the normal operation of the system. Common configuration tasks apply to
the EchoSystem Server (ESS) itself, supporting server infrastructure, devices and scheduling. All of these tasks are
driven through the ESS user interface.
You manage most UI-based system configuration tasks on the System tab and the Configuration tab. The topics in
this section discuss each of these pages in detail. They also provide guidelines for some common configuration
tasks.
Configure System Settings
In this section:
Overview
System Settings
Save Changes
Overview
The system settings page opens automatically after a fresh installation and first-time login.
If you need to return to this page later, select System > System Settings. Click Edit to make changes.
System Settings
You can set the following system defaults on the System Settings page.
Identification Settings
Application Settings
Intake Settings
Active Echo Settings
Inactive Echo Settings
Streaming Settings
Application Security
Academic Staff Upload Settings
Room Settings
Server Network Settings
Details on these settings are provided in the sections that follow.
Identification Settings
The table below provides a description for the Identification Settings option.
Setting
Page 89
Description
EchoSystem 5 Documentation
Customer Identifier (Root Organization)
This is the unique licensing identification number
provided to your institution by Echo360 Sales as part of
your system purchase. It is used to assign licenses to
your EchoSystem (ESS).
Application Settings
The table below provides descriptions for the Application Settings options.
Setting
Description
Application Base URL
The base URL for accessing the ESS application, used
by various components. It must be a secure (HTTPS)
address. We strongly recommend that it:
Be a Fully Qualified Domain Name (FQDN)
Use a host name that is different from the host name
in the Echo Base URL
You may also enter an IP address, but this is not
recommended.
Echo Base URL
The base URL for accessing presentations (Echoes
and supplemental materials) and RSS feeds. We
strongly recommend that it:
Be a Fully Qualified Domain Name (FQDN)
Use a host name that is different from from the host
name in the Application Base URL
You may also enter an IP address, but this is not
recommended.
By default, the ESS is configured to use a standard
HTTP address and port 8080.
Intake Settings
Presentations are transferred by capture devices to an incoming FTP directory. The ESS provides a native SFTP
server application supporting both SFTP with and without encryption. The ESS uses the Internal SFTP server by
default. If you are configuring the system with an external FTP server you can do so with these properties.
Page 90
EchoSystem 5 Documentation
The table below provides descriptions for the Intake Settings options.
Setting
Description
FTP Server
Select Internal to use the SFTP server installed with
the ESS or select External to use an external
FTP/SFTP server. If External FTP Server is selected,
then a valid FTP Username and FTP Password are
required; if you use the internal SFTP server, then
these fields are automatically populated.
Generally, if you are considering an external FTP/SFTP
server, you should have already decided to use a NAS
or SAN storage facility for content, which provides
better system performance.
If you are intending to use an external FTP/SFTP
server, you must:
Set up an account that the capture devices will use to
log in.
Give the account read and write access to the
directory that will store the content.
Appropriately configure the settings below with these
account and directory settings.
Page 91
EchoSystem 5 Documentation
FTP Protocol
If you selected Internal for the FTP server field, select S
FTP or SFTP w/o Encryption for this field.
If you selected External for the FTP server field, select
FTP, SFTP or SFTP w/o Encryption for this field.
Select FTP if you are using an external FTP server for
file transfers across your network. If you selected the
bundled (internal) intake setting, you must select either
SFTP or SFTP w/o Encryption. FTP does not encrypt
data, so it is the fastest of the three protocol options.
However, it is not as secure as SFTP and does not
ensure data integrity as SFTP w/o Encryption does.
Select SFTP to transmit encrypted files. This option
ensures that files are secure. However, it can
dramatically slow the data transfer rate between the
appliance and the ESS if the appliance captures
consecutive presentations.
The data transfer rate slows because encrypting files
creates additional "work" for the capture appliance.
Say, for example, that the capture appliance is busy
encrypting and transferring one presentation, but must
also capture a second presentation at the same time.
Both presentations will be captured, encrypted, and
transferred, but the transfer rate for the first
presentation could drop by 90 percent, from 1 mbps to
100 kbps. The presentation will become available to
students eventually, but later than it would have been
otherwise.
Select SFTP w/o Encryption when you want to ensure
data integrity but do not require data encryption.
Although SFTP is normally encrypted, this setting
programmatically disables the encryption feature.
Because this option does not encrypt data, the
appliance can transfer a presentation at 1 mbps or
faster, even if it is capturing consecutive presentations.
FTP User Name
The username for the FTP/SFTP server.
FTP Password
The password for the FTP/SFTP server.
FTP Folder
The absolute directory path (from the ESS application's
perspective) where the FTP server receives data and
the ESS should look for new capture uploads.
Page 92
EchoSystem 5 Documentation
FTP Host
The host name of the FTP server, which by default is
the ESS host. This can be a Fully Qualified Domain
Name (FQDN) or an IP address. FQDN is
recommended. This value will be provided to capture
devices and media processors that are handling
content, and care should be taken that any FQDN that
is provided is one that the media processor or capture
device can resolve to an IP address via DNS.
FTP Port
The port number of the FTP server. When configured
for the internal SFTP server, the default port is 8022. If
the server is external, the typical port settings are:
FTP: 21. Alternate: 8021
SFTP: 22. Alternate: 8022
FTP Path
If you selected External for the FTP server field, this
field appears. FTP Path is the virtual FTP/SFTP path to
the directory that matches the FTP folder location.
Example: Say that the FTP folder is /echo/upload. If the
SFTP path to get to that folder is:
sftp://echoupload.university.edu/echo/upload, then
the FTP Path is /echo/upload
sftp://echoupload.university.edu/upload, then the
FTP Path is /upload
Active Echo Settings
Active Echoes are available for student review. These settings define where active Echoes reside and how the
HTML files for the presentations are served. Both the URL and directory must point to the same physical location. All
paths (absolute, UNC or mapped drives) must be valid, and the base directories must already exist.
The table below provides descriptions for the Active Echo Settings options.
Setting
Page 93
Description
EchoSystem 5 Documentation
Web Server
Select Internal or External from the list. The ESS uses
Jetty as the internal web server application. The Interna
l web server is selected by default. You have the option
of serving active Echoes from an external server by
selecting External and setting the Content URL to the
URL on the external web server.
Internal/External Content URL
This URL is used to serve links to the HTML files for
the presentations. The protocol, hostname and post
must be the same as that configured for the Echo Base
URL. The name of this field is relative to the web server
you selected.
Content Folder
This directory contains the presentation files, including
Flash SWF, thumbnails, audio, and HTML files. The
Flash FLV files are placed in the Flash folder if the Flas
h Folder setting is configured, or in this folder if it is not.
Presentation content in this location is available.
Best Practice: Configure the
Flash Folder Setting
We recommend that you configure
the Flash Folder setting to give
users the best playback experience.
Inactive Echo Settings
Inactive Echoes are not available for student review. These settings define the location for the three types of inactive
Echoes. All paths (absolute, UNC or mapped drives) must be valid, and the base directories must already exist.
The table below provides descriptions for the Inactive Echo Settings options.
Setting
Description
Unavailable Folder
ESS moves presentations into this directory when the
user makes them unavailable. Unavailable
presentations are typically ones that are not viewable
by users, but are stored on a locally available media
such as a NAS. They are presentations that can quickly
be made available again, such as presentations that
are taken off-line for editing.
Page 94
EchoSystem 5 Documentation
Archived Folder
ESS moves presentations into this directory when the
user archives them.
Best Practice: Archive Content
Externally
Archive content to an external
location (possibly tape or other
off-line media) so it does not
consume critical ESS storage
space.
Deleted Folder
ESS moves presentations into this directory when the
user deletes them. They remain here until permanently
deleted from the system or reinstated (undeleted)
through the ESS.
Streaming Settings
The audio and video content is streamed during Echo playback. Streaming settings include the base directory where
ESS stores all of the streaming audio and video files for presentations (FLV files) and the URL where the
EchoPlayer accesses the streaming content. Both the directory and URL must point to the same physical location.
The table below provides descriptions for the Streaming Settings options.
Setting
Description
Flash Streaming
Select the streaming server from the list that will be
used to stream presentation playback content.
Licensing EchoSystem includes an unlimited license for
Wowza Flash Streaming Server (Wowza Media Server)
and uses this option by default. Other Flash Media
Servers may be used by selecting External Flash
Server.
Page 95
EchoSystem 5 Documentation
Internal Wowza URL / External Flash URL
The label on this property changes on the Flash
Streaming selection. This setting defines the Base URL
for the Flash application. When using the Internal
Wowza Server, the URL uses the hostname of the
ESS. In this case, ESS configures Wowza with the URL
defined here. When using External Flash Server, the
URL may utilize a different host. External flash servers
must be configured manually.
Example: rtmp://ess.echostate.edu/echo/_definst_
Application and Instance Names
Must be Specified
The most recent versions of
Adobe's Flash Player require that
both the application and the
instance name be specified. For
most External Flash Server installati
ons, the definst parameter is
required at the end of the standard
streaming server URL, as shown in
the example above. ESS configures
Wowza appropriately.
Flash Folder
The path of the directory where the flash streaming
content is going to be stored. This may be a Windows
UNC path, a Windows mapped drive, or a Unix-style
path. If you use a external storage such as a SAN for
this content, then the ESS service or daemon needs
both read and write access to this directory. The Flash
streaming server requires read access only.
Real Media URL
This setting is only used with Apreso Classroom
capture stations configured to capture video using
Real. Required if specifying a Real Media Streaming
Directory. Enter the Base URL to the Real Media
Server mount point.
Example: rtsp://realserver.institution.edu/echo
Real Media Folder
Page 96
This setting is only used with Apreso Classroom
capture stations configured to capture video using
Real. Enter the absolute path of the directory where the
Real Media streaming content is stored.
EchoSystem 5 Documentation
Apreso Flash URL
The ESS supports presentations created by the legacy
Anystream Apreso Classroom 1.3.10 system.
This is the Flash base URL specific to content created
by the Apreso Classroom capture stations. The
Apreso-created content needs slightly differently
settings to produced optimized playback and therefore
uses a separate Flash application. When using the
internal Wowza Server, the host name must be the
same as that defined for the Internal Wowza Server.
When using external flash servers this may be unique.
Windows Media URL
This setting is only used with Apreso Classroom
capture stations configured to capture video using
Windows Media. Required if specifying a Windows
Media Streaming Directory. Enter the Base URL to the
Windows Media Publish Point.
Example:
mms://windowsmedia-server.institution.edu/echo
Windows Media Folder
This setting is only used with Apreso Classroom
capture stations configured to capture video using
Windows Media. Enter the absolute path of the
directory where the Windows Media streaming content
is stored.
Use table below as a quick guide to the options you can configure based on your capture configuration:
Capture Device / Products Created
Streaming Settings
EchoSystem SafeCapture HD, EchoSystem Capture
Appliance, Classroom Capture or Personal Capture
- creating podcast/vodcast content.
Leave these settings as default. Generating a podcast
does not generate any streaming content.
EchoSystem SafeCapture HD, EchoSystem Capture
Appliance, Classroom Capture or Personal Capture
- creating EchoPlayer content.
Specify the Flash Folder and either Internal Wowza
URL or External Flash URL. You may leave the other
settings blank.
Application Security
Page 97
EchoSystem 5 Documentation
Use the options in the following table to manage staff and instructor logins to the ESS application (UI) and Instructor
logins to ad hoc and Personal Capture.
Setting
Definition
Inheritance
Security Module
The module used to manage user
authentication to the ESS. You can
add and edit security modules on
the System > Security tab. See LD
AP Authentication if you do not
want to use the internal ESS
database.
N/A
Enable Fallback to Internal ESS
Database
Applies if you are using the LDAP
security module. If Yes, the ESS
database will be checked if LDAP
authentication fails.
N/A
Users with the System
Administrator, parent organization
Admin, or child organization
Admin roles will always be
checked against the ESS
database when LDAP fails.
By entering Yes, you ensure that
users with other roles (Scheduler,
Instructor) will be checked
against the ESS database when
LDAP fails.
Page 98
EchoSystem 5 Documentation
Allow ESS users to login to view
content
This setting applies if you have colla
boration services. If you do, we
recommend that this setting be Yes.
When Yes, the ESS checks the
local database to grant Instructors
and Teaching Assistants
moderation privileges.
N/A
Enter Yes when LDAP or seamless
login is used to secure the section.
Academic Staff Upload Settings
The table below provides descriptions for the Academic Staff Upload Settings options.
These settings relate to the media import feature. See Import Other Media for Academic Staff for details on this
feature. See Upload Settings for details on a related default.
Setting
Definition
Inheritance
May Upload External Media
The default value (Yes) means that
academic staff (if defined as
Instructor for the section) can
upload external media.
System > Academic Staff
May Configure Products
The default value (Yes) means that
academic staff (if defined as
Instructor for the section) can
change which products are
produced when uploading external
media.
System > Academic Staff
Room Settings
The table below provides descriptions for the Room Settings options.
Setting
Page 99
Description
EchoSystem 5 Documentation
Time Zone
The time zone where the parent organization is.
Video Standard
The standard used by the device in the room when it
captures video. Options include NTSC and PAL, both
of which are standard analog color television encoding
systems.
Server Network Settings
The table below provides a description of the Server Network Settings options.
Setting
Description
Time Server
Enter the NTP server addresses that the ESS should
use to synchronize its time with the time signatures of
connected devices. The EchoSystem requires at least
two distinct time sources. No two Time Server fields
should reference the same NTP server.
Save Changes
When you have entered your settings, click Save. You will be reminded that you need to restart the EchoSystem
Server and Wowza for the changes to take effect. See Manage Services for instructions.
Advanced Configuration Options
In this section:
Overview
Overview
EchoSystem is a modular system, so certain native services can be installed and configured to run externally from
the EchoSystem Server (ESS) application and computer. The section shows how to configure these external
services. The following services can be served from an external application or system:
ESS Database
Adobe FMS 3 Flash Streaming Server
External Wowza Media Server
External FTP
Configure the Flash Streaming Server
Page 100
EchoSystem 5 Documentation
In this section:
Overview
Overview
The EchoSystem Server (ESS) supports both internal and external configurations of a media server.
Internal Configurations. The ESS is distributed with a version of the Wowza Flash Streaming Server (Wowza
Media Server) that, by default, is installed with ESS and runs concurrent with it on the same physical host. This is an
internal configuration.
External Configurations. The ESS also supports a variety of Flash streaming solutions, including Adobe Flash
Media Streaming Server (Adobe Flash Media Server) and vanilla distributions of the Wowza server. These are
external configurations. This KB (Knowledge Base) article explains the process of configuring the Wowza Media
Server in external mode, ensuring that it operates compatibly with the ESS while running on a separate machine.
Accessing the Knowledge Base
You will need a customer portal login to access the Knowledge Base. Contact Technical Support
if you need a login.
You may want to use a dedicated server to stream the Flash content that the ESS produces. This spreads the
bandwidth load across multiple nodes.
Flash Streaming - Adobe FMS 3
In this section:
Overview
Prepare for Installation
Co-locate the Flash Content
Configure the Streaming Application
Configure ESS
Overview
The EchoSystem Server (ESS) is distributed with a version of Wowza Flash Streaming Server (Wowza Media
Server) that, by default, is installed with ESS and runs concurrent with it on the same physical host. We call this an
internal configuration.
Some system and network administrators may find it advantageous to use a dedicated server solely for the purpose
of streaming the Flash content that the ESS produces. This spreads the bandwidth load across multiple nodes or
separately manages streaming content from the EchoSystem and other sources from a central location. The ESS
supports a variety of such Flash streaming solutions, including Adobe Flash Media Streaming Server and vanilla
distributions of the Wowza server. This topic explains how to prepare Adobe Flash Media Server 3 (FMS or FMS 3)
to work with ESS in an "external" configuration.
Prepare for Installation
The first step is to determine whether your FMS will be installed on the same machine as your ESS, as this will
determine if there is a need to co-locate your Flash content; i.e., to place it in a file system remote to the ESS via a
network share so that the FMS can access it locally. If everything - the ESS, the FMS, and the Flash content - are
planned to exist on the same physical device (or with the content located on a mounted SAN volume), then you can
Page 101
EchoSystem 5 Documentation
skip the following section. Simply make a note of your Flash Folder (this is configured in the System Settings page
of your ESS) so that you can point FMS to it later on.
Co-locate the Flash Content
In order for the Flash server to find and stream Flash content, that content needs to be stored in a drive
letter-addressable (i.e., logically local) location either physically attached to your FMS host or on the network as a
SAN volume. We do not recommend storing the content on a location that is logically remote to the Flash server,
such as a NAS or UNC-addressable location, since this will generate unnecessary network traffic that could be
detrimental to the performance of the streaming server.
The ESS will need to transfer the Flash content over the network to the location you have chosen for the content
storage. This requires that we make this location accessible via a network share. If you are using a common SAN
volume for all of your content, you can skip the following steps, making sure that the Flash Folder parameter under
the streaming settings heading of your ESS system settings page matches the location where you want your Flash
server to be looking for its content files.
The following instructions assume that FMS 3 is installed on a Windows server; if you are using a Linux distribution,
please refer to the instructions specific to your network file sharing solution (e.g., Samba) to set up a network share.
1. Using Windows Explorer on your FMS machine, navigate to the folder where the root of your Flash content
will be stored; i.e., D:\echo\flash
2. Right-click the folder, and select Properties.
3. Under the Sharing tab, click the radio button labeled Share this folder. Give it a unique, recognizable share
name. This will be the path element to which you will refer later on in the UNC path that defines the share
(e.g., if you specify "flash," it will be something like \\hostname\flash). Leave the user limit set to "Maximum
allowed."
4. Click the Permissions button. You will see the Share Permissions tab. Here we will set the permissions for
access to the folder at the share level.
5. Click Add.
6. If you are on an Active Directory managed domain, add the name of the Computer account for the system
that is running your ESS. Otherwise, you will have to configure your ESS to run as a separate, privileged user
in its Windows service settings, under the Log On tab of its properties dialog, and add that same user account
on this machine.
7. You may click Check Names to verify the group and/or accounts that you have entered into the list. This may
require you to authenticate. When you are satisfied that the information is correct, click OK.
8. Select the account name you specified in step 6 from the "Group or user names:" list.
9. Check the box under the "Allow" column for each of the permissions you wish to give to the selected account.
We strongly recommend that you allow "Full Control" to the user and/or computer accounts representing your
ESS; otherwise, the ESS may not be able to place content here.
10. Click OK to commit the changes.
11. Select the Security tab. Here we will set the permissions for access to the folder at the file system level.
12. Repeat steps 5 through 9, using the same group and/or accounts that you did for the share-level permissions.
13. Click Apply and OK to commit the changes.
14. Optionally, but as a recommended step, log in to the machine running your ESS (and, if you have specified
one, as the user account running ESS) and attempt to connect to the share you just created using its UNC
path. You should be able to view, create, delete, and rename files.
Configure the Streaming Application
Adobe FMS 3 relies on virtual servers, called "applications," to serve the right kind of content based on the
document root given in URL requests. FMS 3 is installed with a set of default applications that reside in its program
files folder. In order for FMS to work with content from your EchoSystem, we must create a new application based
on the default Video-on-Demand (called "vod") application. We will call this application "echo."
Page 102
EchoSystem 5 Documentation
1.
2.
3.
4.
5.
Using Windows Explorer, navigate to the folder where the program files for Adobe FMS 3 are installed.
Enter the "applications" folder.
Create a copy of the "vod" folder and call it echo.
Enter the echo folder.
Open the Application.xml file in Wordpad for editing.
Line 5 contains a <Streams> directive that is currently set to /;${VOD_DIR}.
Change this to read /;${ECHO_DIR}.
6. Save and close the file.
7. Return to the conf subfolder under the FMS program files root.
8. Open the fms.ini file in Wordpad for editing.
Find the location in the file where the variable "VOD_DIR" is defined.
Add a new line, defining a new variable, "ECHO_DIR", using the same format as the other variable, to reflect
the path you set up as the share in the section above.
Adobe FMS 3 is now configured to serve content from the location that you have set up for holding your Flash
content. Start the service; if you have started it already, restart it to commit the configuration changes. At this point,
the FMS service should be already configured to launch on startup by default .
Configure ESS
All of the infrastructure should now be in place for your external FMS. The final step involves configuring three
entries in your ESS system configuration to recognize these changes.
1.
2.
3.
4.
Log in to your ESS and navigate to the System > System Settings page.
Click the Edit button at the bottom of the page.
Scroll down to the Streaming Settings heading.
For the "Flash Streaming" parameter, select External Flash Server. Do this even if the FMS is located on the
same host as the ESS.
5. For the "External Flash URL" parameter, compose a URL consisting of the RTMP protocol, the FQDN of your
FMS server, the application name (echo), and a _definst_ pointer, as follows:
rtmp://fqdn.of.fms.server/echo/_definst_
The path elements of this URL do not map to path elements on the storage volume; here,
"echo" is the name of an application and not the name of the folder in which the content is
stored, and "_definst" is a virtual pointer. If your URL contains more elements than the
example shown here, or your ECHO_DIR folder contains additional subfolders above the
content, FMS will not be able to locate the content.
6. For the "Flash Folder" parameter, type the UNC path (or the drive letter path, if using a SAN volume) of your
Flash content folder, which was configured on the Systems Setting page (System > System Settings). This
should point to the same location you defined as the variable "ECHO_DIR" in the application configuration.
7. Click the Save button at the bottom of the page.
Your ESS is now configured to call the external FMS when providing content to viewers. You may be prompted to
restart ESS in order for the changes to take effect; check that no capture or processing tasks are currently running,
then do so.
Using External FTP for ESS File Transfers
Page 103
EchoSystem 5 Documentation
In this section:
Overview
Configure the FTP Server
A Word on Firewalls
Configure the ESS
Overview
In a default EchoSystem installation, devices exchange capture data with the EchoSystem Server (ESS) via an
internal secure file transfer protocol (SFTP) server that listens on port 8022. While the standard method may be
comfortable for most circumstances, SFTP carries a substantial amount of compression and encryption overhead
that can cause transfer bottlenecks on large-scale installations.
The ESS provides the option to use an external FTP server for handling these file transfers rather than its internal
SFTP facility. This creates two advantages:
The transfer speeds available are much higher
A dedicated service can be used for back-end content transfers, consolidating back-end file transfer
resources away from the ESS
SFTP Without Data Encryption
It is possible to use the internal SFTP server without data encryption to achieve substantially
faster transfer speeds from capture devices. This is handled by the FTP Protocol option. See Co
nfigure the ESS.
Configure the FTP Server
Although any FTP server can be used, this article will describe the procedure for setting up the FTP server built in to
the Internet Information Services (IIS) suite for Windows Server 2003, which is recommended for use alongside the
ESS especially in situations where simple transfer speed is desired.
1. If the IIS FTP server is not installed, from the Windows, Control Panel, select Add or Remove Programs >
Windows Components Wizard. You may need a Windows installation CD if these components are not
available. At a minimum, check the following tree of components:
Application Server
Internet Information Services (IIS)
File Transfer Protocol (FTP) Service; Internet Information Services Manager
2. In the Windows Control Panel, select Administrative Tools > Internet Information Services (IIS) Manager.
Using the navigation pane on the left, expand the local computer entry and FTP Sites folder to expose the
list of sites. You may use the default FTP site, or create a new one from scratch.
3. Right-click your FTP site and click Properties. The following tabs contain configuration options of interest:
FTP Site: This contains basic connection parameters for the FTP server.
If your server has multiple network interfaces, you can use the "IP address" field to specify which one
the FTP will listen on, allowing you to segregate internal and external network traffic.
As a security measure, you may wish to force the FTP server to use a non-default TCP port as well, or
limit the number of concurrent connections.
Security Accounts: Anonymous access is enabled or disabled here. By default, it is enabled; we
strongly recommend against this. Clear the option, read the warning that Windows produces, and
select Yes to continue. We will set up security in the next step.
Home Directory: Best practice standards recommend that the path given here should be part of the
ESS content upload file system hierarchy. An ideal selection would be something like
Page 104
EchoSystem 5 Documentation
D:\echo360\upload\ext (as opposed to "int," which is the default). If the FTP server is remote to the
ESS, you can also specify a shared location on the ESS server where you would like the FTP server to
look for its files. In either case, be sure to enable both read and write permissions.
Directory Security: At a network administrator's discretion, you can restrict access to this FTP service
to specific IP address ranges. Be sure, however, that you do not inadvertently lock out actual devices
on your EchoSystem network from reaching the service to upload their content.
4. In the Windows Control Panel, select Administrative Tools > Computer Management. Using the navigation
pane on the left, select System Tools\Local Users and Groups\Users to see a list of all users on the local
system.
You will need to either create or repurpose a user that will control access to the FTP service from your
appliances. Make a note of the user name and password that you choose for later steps.
In the user properties, be sure that "User must change password at next logon" is not enabled, and
enable at least "Password never expires."
5. In Windows Explorer, navigate to the folder that you specified for the home directory of the FTP server in step
3 (e.g., D:\echo360\upload\ext).
Right click on the folder itself and click Properties.
Click the Security tab.
Click Add under the name list.
Enter the name of the user you selected in Step 4, and click OK.
In the "Group or user names" list, click the user you just added.
In the permissions list, give Allow permissions for at least the Modify action. We recommend giving full
control.
Click the Advanced button.
Under the Permissions tab, enable both check-boxes for inheriting and replacing permissions to all
child objects.
Click OK to both dialog boxes to save your changes and close.
6. As an optional test of the new configuration, open a command prompt window.
Execute the following command: ftp localhost (or the IP address you configured).
When prompted, enter the user name and password for the account you selected in step 4.
Execute the following commands: ls, mkdir test, and rmdir test.
If all of the above succeeded, you have confirmed that the FTP server is online and that the user
account you selected has all the necessary permissions.
A Word on Firewalls
In testing, we have found that when using IIS as an FTP server, a firewall may not always automatically open the
ports necessary for successful active-mode FTP connections; even when manually configuring exceptions for the
FTP control and data ports (21 and 20, respectively), FTP in active mode uses other random ports for its data
connections. However, if you must use a firewall, adding an application-based exception (the software must be able
to support this; Windows Firewall does, for instance) rather than opening port ranges is the most effective method of
allowing access. If you are using IIS, the application to clear with the firewall is called inetinfo.exe for Windows
Internet Information Services. It may also be necessary under such circumstances to set a long session timeout
value to prevent the control port from being closed during long file transfers.
Best Practice: Locate the FTP Server Inside the Secure Portion of the Network
If the FTP server is inside the secure portion of your network, no firewall is needed on the
connections between client devices and the FTP server. This avoids connectivity and speed
issues when moving essential files within your EchoSystem installation.
Configure the ESS
Page 105
EchoSystem 5 Documentation
Make Sure the Processing Queue is Empty
Do not make changes to these settings if you have any tasks in your processing queue. Ignoring
this warning could cause captures to be lost!
1. In the ESS administration interface, select System > System Settings.
2. Click the Edit button at the bottom of the page.
3. Under the Intake Settingsheading, update the following configuration items:
FTP Server: External
FTP Protocol: FTP
FTP User Name: as configured on the FTP server. See Configure the FTP Server.
FTP Password: as configured on the FTP server. See Configure the FTP Server.
FTP Folder: the FTP home folder, as configured on the FTP server. See Configure the FTP Server.
FTP Host: the FQDN of the FTP server for the address on which it is listening.
FTP Port: the TCP port, as configured on the FTP server. See Configure the FTP Server.
FTP Path: empty (unless you are using one common FTP server with multiple subdirectories for
multiple applications)
Default Processor Path to FTP Folder: empty (unless you have followed the procedure in the article
"Using UNC Paths for Processor Data Transfer")
4. Click the Save button at the bottom of the page.
This restarts all of your capture appliances.
5. As an optional test of the new configuration, click the green Test Settings button, which is under the Intake
Settings heading. You should see a success message if all went well.
Using UNC Paths for Windows Media Processor Data Transfer
In this section:
Overview
Define the Intake Directory
Set Up the Intake Directory Share
Overview
In a default EchoSystem installation, devices exchange capture data with the EchoSystem Server (ESS) via an
internal secure file transfer protocol (SFTP) server that listens on port 8022. While the standard method may be
comfortable for most circumstances, SFTP carries a substantial amount of compression and encryption overhead
that can cause transfer bottlenecks on large-scale installations.
Many institutions prefer to implement a centralized, network-based storage solution that relies on universal naming
convention (UNC) paths, thereby eliminating unnecessary file transfer operations. The EchoSystem Media
Processor devices on your network can be configured to access these UNC shares, thereby accessing capture
content directly. The result is a dramatic speedup of processing tasks.
Page 106
EchoSystem 5 Documentation
Do Not Refer to Mapped Drives
It is important that you never use mapped drives when configuring storage locations for use with
ESS. If configured incorrectly, these are not persistent across restarts, and the local system
account running the EchoSystem NT services may not have access to the mapped drives in the
first place. If you are using a SAN with system mounted volumes, the use of such a drive letter is
acceptable; otherwise, you are likely to run into errors if you use this feature of Windows. When
in doubt, always use a UNC path for networked storage.
Define the Intake Directory
The intake folder, specified in your ESS System Settings as the FTP Directory, is where capture content is
temporarily stored before being copied to, or in the case of network shares, read by the media processor devices on
your network. Regardless of where the directory is located, this folder is the one that you will configure your media
processor devices to access via a network share. Your ESS will receive and store capture content from your capture
appliances and Classroom Capture devices at this location.
Before continuing, define the FTP Directory field under the Intake Settings heading in your ESS System Settings,
then save your changes. For now, it is important that the field labeled "Default Processor Path to FTP Directory"
should be left blank.
Set Up the Intake Directory Share
These instructions assume that all the media processor devices you want to configure are Windows systems
assigned to an Active Directory controlled domain. Since the EchoSystem media processor runs as an NT service,
we will use computer accounts for authentication to the network share and for read-write permissions to the shared
folder itself.
Before continuing, you may find the share permissions easier to manage if all of the computer accounts for your
media processor devices are added to a group, especially if you have several of them. If you only have one or two
media processors, do not intend to increase your number of media processors, and/or would like to manage the
permissions for each of them directly, skip the following subsection.
Adding Computers to a Security Group
Begin by logging on to your domain controller and accessing the Active Directory Users and Computers console.
1. In the Active Directory Users and Computers console, expand your domain from the list on the left.
2. Right-click Groups, then move your mouse to Add and click Group.
3. Add the information for this group. Remember that this is the group to which your all of your Media Processor
devices should belong. You can call the group anything you like, but it should bear a name that is easy to
recognize. Your network administrator probably has a naming scheme to follow. Review the information and
click Finish when you are satisfied.
4. Select Computers from the console list under your domain. This will show an index of all the computer
accounts on your domain in the right-hand pane.
5. Right-click the computer account for one of your media processor devices and select Properties.
6. Click the Member Of tab, and then click Add.
7. In the Select Groups dialog box, specify the group that you just created. Click OK to add the specified group
to the list. Your media processor devices may be members of more than one group.
8. Select OK to finish.
9. Repeat steps 5 through 8 for all of the media processor devices on your domain.
Sharing and Security
Page 107
EchoSystem 5 Documentation
Creating the share itself is usually a simple process but there are two places where your security settings need to be
established: at the share level and at the file system level. You will need to log on to the system in which the folder
you want to share physically resides (typically the machine running ESS itself) to make these changes.
1. Using Windows Explorer, navigate to the folder you defined as the FTP Directory in ESS earlier on.
2. Right-click the folder, and select Properties
3. Under the "Sharing" tab, click the radio button labeled "Share this folder." Give it a unique, recognizable share
name. This will be the path element to which you will refer later on in the UNC path that defines the share
(e.g., if you specify "int," it will be something like \\.host\int). Leave the user limit set to "Maximum allowed."
4. Click the Permissions button. You will see the Share Permissions tab. Here we will set the permissions for
access to the folder at the share level.
5. Click Add.
6. Enter the canonical name of the group you created for your media processor devices in the previous
subsection. If you are not using groups for permissions management, search for or enter the names of the
computer accounts of each Media Processor device.
7. You may click Check Names to verify the group and/or accounts that you have entered into the list. This may
require you to authenticate. When you are satisfied that the information is correct, click OK.
8. Select the group or one of the user names you specified in step 6 from the "Group or user names:" list.
9. Check the box under the Allow column for each of the permissions you want to give to the selected account.
We strongly recommend that you allow Full Control to the group and/or computer accounts representing your
Media Processor devices.
10. Click OK to commit the changes.
11. Select the Security tab. Here we will set the permissions for access to the folder at the file system level.
12. Repeat steps 5 through 9, using the same group and/or accounts that you did for the share-level permissions.
13. Click Apply and OK to commit the changes.
14. Optionally, but as a recommended step, log in to one of the Media Processor devices and attempt to connect
to the share you just created using its UNC path. You should be able to view, create, delete, and rename
files.
Define the Default Media Processor Path to FTP Directory
Specify where the share is.
1. Open the ESS System Settings page.
2. Under the Intake Settings heading, specify the full UNC path to the network share you configured in the
previous section.
3. Click Save.
4. Click the green Test Config button to determine whether the settings are successful.
5. Restart the ESS service using the Services console in your Administrative Tools.
Congratulations. If all of the above succeeded, your Media Processor devices will access their files directly from the
network share, reducing transfer overhead to a minimum and greatly speeding up the turnaround time for your
Echoes.
Server Configuration for Presenters
In this section:
Overview
Add a Presenter
License Presenters
Assign Presenters to Sections
Page 108
EchoSystem 5 Documentation
Overview
You typically assign the Academic Staff role to faculty, then apply one of the presenter roles to the faculty member
when you add the faculty member's sections.
Doing so allows Academic Staff to publish Echoes.
Presenters can also use Personal Capture and Media Import.
Add a Presenter
Before you can make a person a presenter, you must add them to EchoSystem as an Academic Staff user. You
then give that Academic Staff user a presenter role when you add their section. Presenter roles include Instructor,
Student Presenter, Teaching Assistant, and Guest Presenter.
License Presenters
If you are licensing presenters for Personal Capture, there are two options: site license or license packs. If you
purchased a:
Site license, no further licensing configuration is required. Presenters are automatically granted the ability to
capture and publish.
License pack, assign licenses to presenters who will use Personal Capture.
If you are licensing presenters to import other media, assign Media Import licenses to presenters.
1. Navigate to System > Licensing.
2. Review the list of available licenses, as shown in the figure below.
3. Click Presenter Assignments. The Assign Presenter Licenses page appears, showing the presenter you
created in the previous section.
4. From the License list, select a license, as shown in the figure below. Check boxes appear next to each
presenter.
Page 109
EchoSystem 5 Documentation
5. Check the box for each Academic Staff member you want to assign the license, as shown in the figure below.
6. Click Save. The presenter is now licensed.
Assign Presenters to Sections
To publish Personal Capture recordings, the presenter must be assigned to a section.
1. In the EchoSystem server application, navigate to Schedule > Courses.
2. Click on the course that contains the section to be assigned.
3. On the Course Details page, click on the edit button for the presenter's section, as shown in the figure below.
Page 110
EchoSystem 5 Documentation
4. On the Edit Section page, select the presenter from the Available list and click the Select arrow to move the
presenter to the Selected list, as shown in the figure below.
5. Save the changes.
Manage Licenses
Page 111
EchoSystem 5 Documentation
In this section:
Overview
Download and Update Licenses
License Presenters for Personal Capture
License Venues
Overview
The EchoSystem supports several different types of licenses. Two of these, the Personal Capture license, and the
Venue license, must be assigned.
Personal Capture licenses are assigned to presenters. This license allows a presenter (typically an
Academic Staff member) to prepare presentations on a personal PC or laptop.
Venue licenses are assigned to locations, typically a classroom. They allow a venue to capture lectures. You
may purchase a site license (which is automatically applied to all venues) or an individual license (which must
be assigned to a specific venue).
The EchoSelect license supports either one or two channel encoding.
Licensing the EchoSystem involves these processes, which typically occur during installation:
1. Downloading and updating licenses. You download licenses from the Echo360 license control server (LCS).
2. Assigning Personal Capture licenses to presenters.
3. If you purchased individual venue licenses (and not a site license): Assigning individual licenses to venues.
Who Can Do This?
System Administrator
License Manager
Download and Update Licenses
Licensing EchoSystem is required to begin capturing lectures. Licensing applies to capture devices, Personal
Capture users and the Wowza Media Server. For detailed information about license options, contact Echo360
Technical Support.
1. You should have received a Customer Identifier from Echo360. You must enter this identifier on the System
Settings page before attempting to license the system. Additionally, the ESS must have outbound Internet
access.
2. Log in to EchoSystem Server (ESS) using the default Administrator account: ess@echo360.com
3. Navigate to System > Licensing.
4. Click Update. If licensing is successful, you see a screen similar to the example shown in the figure below.
Page 112
EchoSystem 5 Documentation
License Presenters for Personal Capture
Faculty or staff members must have been added to EchoSystem as Academic Staff users before they can publish
recordings created via Personal Capture. You give the Academic Staff user a presenter role when you add their
section. Presenter roles include Instructor, Student Presenter, Teaching Assistant, and Guest Presenter.
See Personal Capture for details on the Personal Capture application.
There are two licensing options for Personal Capture: site licenses or license packs. If you have purchased a site
license, then there are no further licensing configuration steps required, as all of your Presenters are automatically
granted the ability to capture and publish. If you purchased a license pack, you need to assign licenses to
Presenters who are using Personal Capture.
1.
2.
3.
4.
5.
Log in to the ESS.
Navigate to System > Licensing.
Click Presenter Assignments.
Select the appropriate license from the menu.
Select the check box for each Presenter you want to license.
6. Click Save. Presenters are now licensed.
License Venues
There are two options for licensing capture appliances and Classroom Capture in venues: site license or individual
license. If you purchased a site license, there are no further licensing configuration steps required: all venues are
automatically granted the ability to capture. If you purchased individual capture licenses, you must assign those
licenses to the venues where the captures will occur (typically classrooms, auditoriums, or lecture halls).
1. In the ESS application, navigate to System > Licensing.
2. Click the Room Assignments button. The Assign Room Licenses page appears. In the license drop-down
Page 113
EchoSystem 5 Documentation
2.
list, All is selected.
3. Notice that the total number of licenses, the number of licenses assigned, and the number of licenses
available are listed.
4. If necessary, scroll to the right so you can see the entire drop-down list.
5. Select the appropriate license from the drop-down list.
6. Notice that:
Venues with that license are checked
The numbers of licenses change to show the total, assigned, and available numbers for the particular
license
7. Select the check box for each venue you want to license.
8. Click Save. The selected venues are now licensed.
Configure Product Groups
In this section:
Overview
About Default Product Groups
Assign a Product Group to a Section or Schedule
Add a Custom Product Group
View Product Group Details
Edit a Product Group
Copy a Product Group
Filter the List of Product Groups
Delete a Product Group
Page 114
EchoSystem 5 Documentation
Overview
Product groups simplify scheduling because they are ready-made "bundles" of products and output qualities.
Product groups simplify the scheduling process because they allow a Scheduler to choose a ready-made product
group instead of specifying individual products. You can make the process even easier for the Scheduler by giving a
product group a "friendly name" that suggests its function:
"Use for math classes"
"Use for special events in Everest Hall"
"Use for med school procedure demonstrations"
You may have up to three different types of product groups:
Default product groups. After you install or upgrade to EchoSystem 5, you will see the default product
groups.
System-generated product groups. If you upgrade to EchoSystem 5 from an earlier release, you may have
additional product groups. These have the term "Upgraded product group" in their names. During the upgrade
process, the EchoSystem Server (ESS) analyzes your existing schedules and prepares additional product
groups that support the products you have requested most often.
Custom product groups. You, as the System Administrator or Organization Administrator, may decide to
create custom product groups.
A product group owned by the parent organization is automatically shared with all child organizations. A product
group owned by a child organization cannot be shared with other child organizations.
About Default Product Groups
Default product groups are included with a new or upgraded installation.
The Product Groups page, shown in the below figure, identifies capture appliances and applications
supported by a particular product group.
The descriptions discuss products supported, bandwidth, quality, and typical use cases.
Assign a Product Group to a Section or Schedule
Page 115
EchoSystem 5 Documentation
When you add or edit a section or schedule, you assign a product group. When you do this:
Review the product group details.
Consider what device is in the room when assigning the product group. If the room has Classroom Capture
but no other device, for example, you could have these issues:
You will not be able to capture all of the inputs requested by the product group. Say, for example, that
the product group included video but there is no video camera attached to the podium PC. In this
instance video would not be captured.
The captures might not be at the quality requested by the product group. Say, for example, that your
product group requested the highest quality video, but the room only had the EchoSystem Capture
Appliance. This appliance cannot capture the highest quality video.
Add a Custom Product Group
Keeping custom product groups to a minimum makes it easier to manage your EchoSystem. Before creating a
custom product group, review the existing product groups to see if one is sufficient. Consider:
The content (audio, video, display) you want to capture
The quality (high, medium, low) you want to capture
The products you want to support
The devices that support those products
If you determine that a custom product group is needed, you can add a new group or copy and edit an existing
group.
1. Navigate to Configuration > Product Groups. The Product Groups page appears.
2. Click Add. The Add New Product Group page appears.
3. Complete the Product Group Information section.
a. Enter a name for the new product group. You might want to specify a "friendly name" ("Use for math
classes") that will help a Scheduler choose the product group for particular sections or schedules.
b. Optionally, enter a description. You might want to include details that will help a Scheduler choose the
product group for particular sections or schedules ("Use for classes in Room 767").
c. Select the parent or child organization to which this product group belongs.
d. Review the Estimated Storage information.
4. In the Product Details section, select the Podcast, Vodcast, and EchoPlayer options from the drop-down lists.
a. The drop-down lists only show options that are compatible with the capture device and each other.
b. Review the suggested use cases and storage/bandwidth estimates for the output option and quality
you selected.
Page 116
EchoSystem 5 Documentation
Best Practice: Compare These Estimates to Your Own Experience
The storage/bandwidth estimates shown are derived from a test environment. We
recommend that you compare these estimates with your own experience.
5. Complete the Device And Use Case Compatibility section.
6. Click Save.
View Product Group Details
1. Navigate to Configuration > Product Groups.
2. Select a product group by clicking it. The Product Group Details page appears as shown in the figure below.
Edit a Product Group
You can edit any field except Organization.
1. Navigate to Configuration > Product Groups.
2. Hover over the product group that you want to edit and click edit. The Edit Product Group page appears as
shown in the figure below.
Page 117
EchoSystem 5 Documentation
3. Edit the product group fields. You can edit any field except Organization. In this example, we edit the product
group to create a low bandwidth version. Notice that the storage/bandwidth estimates have changed as
shown in the figure below.
4. Click Save. The Product Group Details page appears.
5. Click Done to return to the Product Groups page. You can also begin to add, copy, or edit a product group by
clicking the relevant button at the bottom of the page.
Copy a Product Group
You might want to create a custom product group by copying an existing product group and editing a few fields.
Page 118
EchoSystem 5 Documentation
1.
2.
3.
4.
5.
Navigate to Configuration > Product Groups.
Hover over the product group you want to edit and click copy. The Add New Product Group page appears.
Edit the product group's name, description, or products.
Click Save. The Product Group Details page appears.
Click Done to return to the Product Groups page. You can also begin to add, copy, or edit a product group by
clicking the relevant button at the bottom of the page.
Filter the List of Product Groups
1. Navigate to Configuration > Product Groups.
2. At the top of the page, select the organization whose product groups you want included in the filtered list.
3. Click Search. Only those product groups matching the filter you selected appear. The example shown in the
figure below shows product groups belonging to the Echo360 organization.
4. To see the unfiltered list, click Clear.
Delete a Product Group
You can delete any product group.
1. Navigate to Configuration > Product Groups.
2. Hover over the product group you want to delete and click delete. A confirmation message appears.
3. Click Yes. The Product Groups page appears with a delete confirmation message at the top.
Manage the Branding Files Repository
Page 119
EchoSystem 5 Documentation
In this section:
Overview
Upload a Branding File
Edit a Branding File
Overview
The EchoSystem Server (ESS) allows institutions to brand (with logos, art, and messaging) the EchoPlayer that
students use to review and interact with content. Please take a moment to upload your branding assets to this
repository. Only assets within this repository can be used to customize the EchoPlayer. Once uploaded, you can
choose which assets to use as branding elements by customizing the organization default settings.
Upload a Branding File
1. Verify that the file you want to use is a supported size and format. Refer to the following table for supported
sizes and formats. You cannot scale an image in the EchoSystem Server (ESS). Use a graphics design
program such as Adobe PhotoShop to design and scale the image.
File
Supported Sizes and Formats
Player Banner Background Image
Use .png or .jpg files. The image must be 2 pixels
wide by 62 pixels high.
This image is layered below the logo image, the
metadata text, and the title. Choose an image and
color that will contrast well with these elements.
Player Logo Image
Use .png or .jpg files. The image must be 2-250
pixels wide and no more than 62 pixels high.
We recommend padding the image with 10 pixels of
transparency on both ends.
This image is layered above the background image.
You may need to adjust the logo or background
image.
Animated .gif files are not supported.
Intro and outro clips
Use a standard .mov or .mp4 file that is 5-60
seconds long. The file must contain both audio and
video tracks.
The image size must be 640x480 pixels.
Page 120
EchoSystem 5 Documentation
Watermark
The watermark appears in the lower right corner of
both the video pane and the display (VGA) pane.
You can use any .png files except 16 bit channel
.png files and grayscale alpha channel .png files.
The watermark should be 1024x256 pixels or
smaller.
The image is scaled so the width is 10 percent the
width of the pane. The height is scaled to the width,
preserving the aspect ratio.
If you are using Adobe PhotoShop, we recommend
saving in PNG-24 format, checking the
Transparency option, and checking the "convert to
sRGB" option.
2. Navigate to Schedule > Branding.
3. Click Add. The Add Branding File page appears as shown in the figure below.
4. Enter a name.
5. Select the parent organization or child organization from the list.
6. Click the radio button for the branding file type. Note the technical requirements for that type below the row of
radio buttons.
7. Click the Upload File field.
8. Browse to the file location on your computer and click Open.
9. Notice that the file begins to upload. While it is uploading, the Upload File field shows you how much has
uploaded.
10. When the file has uploaded, click Save.
11. To verify that the file loaded successfully:
a. Navigate to Configuration > Organizations.
b. Select the organization to which you added the branding file. Click Edit.
c. Scroll to the Branding section of the page.
d. Notice whether or not the branding file you uploaded appears on the page.
Page 121
EchoSystem 5 Documentation
Edit a Branding File
Overview
You can navigate to the branding files list, hover the cursor over a particular file, and click the edit button, as shown
in the screenshot below:
However, the "edit" button does not allow you to make changes to the appearance of the branding file. You can use
the edit button to:
Edit the name of the file. You might do this when the file has a somewhat generic name ("logo") and you are
about to add another logo file. You might want to rename "logo" to "logo for arts and sciences" then add
another file called "logo for med school".
Replace the current file with a different file. You might do this when the logo has changed and another group
has supplied you with the new logo file.
To change the branding file itself, open the file in an appropriate media editor (this will differ depending on the file
type), make changes, and re-upload the changed file.
Procedure
1.
2.
3.
4.
5.
6.
Navigate to Schedule > Branding.
Hover over the file to be edited.
Click edit.
In the Verify Certificate dialog box, click Trust.
In the applet is requesting dialog box, click Allow.
On the Edit Branding File page, do one or both of the following:
a. Edit the name field.
b. Click the Upload a file... button, then follow the same procedure described in Upload a Branding File.
7. Click Save.
8. If you edited the file name, you will see the new name on the Branding File Details page. If you uploaded a
new file, you may notice that the file size is different.
Page 122
EchoSystem 5 Documentation
Defaults and Inheritance
In this section:
Overview
Concepts and Rules
Where Do Defaults Come From?
Inheritance
Inheritance When You Change an Object's Organization
Organization Default Settings
Overview
Defaults streamline device management and capture workflow because they:
Allow you to define settings shared among various objects at a global level
Pass the setting values down to the related objects, such as devices, sections, and schedules
Passing these settings down is referred to as inheritance. Because objects inherit settings from the defaults, you do
not have to set them manually. This simplifies tasks such adding a new device or creating a new schedule.
Best Practice: Set the Defaults at Installation
Set the defaults during installation or when upgrading to get the full benefit of this efficiency.
Concepts and Rules
As you work with defaults, understand these concepts.
Defaults. The settings for a particular object before you customize the settings.
Inheritance. The setting of one object is automatically given to a related object further down the inheritance
chain.
Inheritance Chain. The inheritance levels for an object.
Override. Changing a default setting.
Object. An entity created and managed by EchoSystem, such as a room or section.
These rules also apply:
Any default setting can be changed on an object's settings page.
Changes to a setting in the parent organization apply to all existing objects, except that:
If you override a default setting for an object, changes to that setting up the inheritance chain will not change
the overridden value.
Where Do Defaults Come From?
Defaults are set in different ways, depending on the object.
Device defaults are set on the Device Defaults page (Configuration > Device Defaults). These are
inherited directly by the devices, not via a parent or child organization. See Manage Device Defaults for
details on each setting. These settings can be changed (see About Devices) and the new defaults will be
passed down to new devices.
System defaults are set on the System Settings page (System > System Settings).
Organization defaults are set on the parent organization. These settings can be changed (see Manage
Page 123
EchoSystem 5 Documentation
Organizations) and the new defaults will be passed down from the parent to the child organization.
If you used EchoSystem before EchoSystem 4.0
These defaults replace the global defaults in earlier releases.
Inheritance
If your EchoSystem Server (ESS) has a hierarchy of parent and child organizations, the inheritance chain has four
levels for most objects:
Level 1: Parent organization.
Level 2: Child organizations. Child organizations inherit properties from the parent organization. Example: the
law school inherits the Product Group settings from the parent organization.
Level 3: Objects or sections inherit properties from the child organization. Example: A section inherits the
Product Group settings from the child organization.
Level 4: Schedules inherit properties from sections. Example: a schedule inherits the Product Group settings
from the section.
If you do not implement delegated administration (and therefore do not have a parent-child hierarchy), the chain has
three levels: Level 2, the child organization level, is eliminated. Objects or sections inherit settings directly from the
parent organization.
This inheritance chain does not apply to devices, which inherit their settings directly from the device default settings.
For the most part, system settings are not inherited. One exception is the Academic Staff Upload Properties, which
are set at a system level (System > System Settings), then inherited by individual Academic Staff.
Inheritance When You Change an Object's Organization
When you change an object's organization, the object's properties may not inherit as expected.
An object's properties will be handled in these ways:
No customization rule. If the object's properties have not been customized, it has the default values of its
parent. When you move the object to a new organization it inherits the default properties of its new parent.
No Customization Example
Room 667 was owned by Echo360 University. The Administrator of Echo360 University
did not change the Admin User Name for the Ad Hoc Interface (capture appliance) from
the default value. It is Admin. Now you move Room 667, giving ownership to the
engineering school. The engineering school has also preserved the default value of this
setting. After moving, the value remains Admin.
Customization rule. If the object has a customized property, the customized property is preserved when the
object is moved to a new organization.
Page 124
EchoSystem 5 Documentation
Customization Example
Room 667 was owned by the law school, which customized the Admin User Name to Jud
ge. Now you move Room 667, making it part of the engineering school. The Admin User
name remains Judge. If the engineering school has a different Admin User Name (Admin
, Design), you will have to change the Admin User Name for Room 667 in the ESS
interface, by navigating to the room details page for Room 667.
The customization rule does not apply if you specify the value of a property on a spreadsheet and import the
property using the export/import method: the value on the spreadsheet overrides any other value.
Organization Default Settings
The parent organization is automatically created with particular default settings. You can change those settings and
child organizations will inherit the new default settings. See Manage Organizations.
The individual settings are:
Organization Details
Schedule Settings
Media Settings
Echo Defaults
Branding
EchoCenter
EchoPlayer
Product Groups
Security Settings
Support
Upload Settings
Details on these settings are provided in the sections that follow.
Organization Details
The table below provides definitions for the Organization Details options.
Setting
Definition
Inheritance
Short Name
Name of the organization as it
appears in the user interface
N/A
Full Name
Use this field to include a full
description of the organization
N/A
Page 125
EchoSystem 5 Documentation
Schedule Settings
The table below provides definitions and inheritance information for the Schedule Settings options.
Setting
Definition
Inheritance
Term
The default term used when
creating new schedules and the
term in which to copy schedules
Parent Organization > Child
Organization > Schedule
Time Zone
The default time zone used when
creating captures within new
schedules
Parent Organization > Child
Organization > Schedule
Duration
The default duration used when
creating captures within new
schedules
Parent Organization > Child
Organization > Schedule
Default Publishers
The default publishers used for
sections (new and existing) and
schedules (new and existing)
Parent Organization > Child
Organization > Schedule
Media Settings
The table below provides definitions and inheritance information for the Media Settings options.
Setting
Definition
Inheritance
Delete Original Media?
A check box value enabling or
disabling the feature and the Days
to Keep Originals field.
N/A
Page 126
EchoSystem 5 Documentation
Days to Keep Originals
How long original (raw media) files
are kept before being automatically
deleted.
Parent Organization > Child
Organization > Section
Display Media Links on Playback
If checked, links appear in the
EchoPlayer that allow a student to
download Podcasts or Vodcasts.
Downloaded files can be distributed
by the student. If unchecked, a
student must stream the files.
Parent Organization > Child
Organization > Section
Echo Defaults
The table below provides definitions and inheritance information for the Echo Defaults options.
Setting
Definition
Inheritance
Echoes Initially Unavailable?
A check box value defining if the
default state of a new Echo
(presentation) should be
"Unavailable". This is typically used
for workflows requiring approval or
editing of presentations before
student review or for workflows
favoring presentation release at
specified times, such as a week
before exams.
Parent Organization > Child
Organization > Schedule
Branding
Students viewing Echoes in the EchoPlayer will see your institution's logo or other branding assets, as shown in the
figure below:
Page 127
EchoSystem 5 Documentation
In some cases, you will need to upload an image or video clip file to the branding repository before selecting it from
a drop-down list. See Manage the Branding Files Repository.
After you establish the branding items described below, they are automatically applied to new Echoes.
Existing Echoes displayed in the EchoPlayer product will have the Player Banner Background Image and Copyright
Text applied after you establish these branding items.
Existing Echoes displayed in the Podcast product must be reprocessed (presentation by presentation) to apply any
brand item.
If a brand item does not appear in an existing Echo, reprocess the Echo. Press the Reprocess Media button at the
bottom of the Echo Details page.
The table below provides definitions and inheritance information for the Branding options.
Setting
Page 128
Description
Inheritance
EchoSystem 5 Documentation
Copyright Text
Copyright text appears on the
loading screen in the EchoPlayer
and Podcast products.
Parent Organization > Child
Organization > Section
Enter the copyright text. There is no
character limit, but we recommend
two to three short paragraphs. Line
breaks, capital letters, spaces, and
other formatting is respected.
The color of the copyright text
changes to coordinate with the
EchoPlayer theme chosen. The text
is white if the dark theme is chosen,
black if the light theme is chosen.
Player Metadata Font Color
Metadata appears in the upper left
corner of the EchoPlayer, next to
the logo. It includes the date, time,
room, and Presenter.
The Player Banner Background
Image is layered below this text.
Choose a color that contrasts well
with the background image.
Metadata is in smaller and lighter
weight type above the class title.
Type the HTML number for the
metadata font color. To find the
HTML number, we recommend the
site http://kuler.adobe.com/. You
could specify one of your
institution's characteristic colors.
Page 129
Parent Organization > Child
Organization > Section
EchoSystem 5 Documentation
Player Title Font Color
The class title appears in the upper
left corner of the EchoPlayer
window, next to the logo. It is in
larger and heavier weight type
under the metadata.
Parent Organization > Child
Organization > Section
The Player Banner Background
Image is layered below this text.
Choose a color that contrasts well
with the background image.
Type the HTML number for the
color.To find the HTML number, we
recommend the site http://kuler.ado
be.com/. You could specify one of
your institution's characteristic
colors.
Player Banner Background Image
The banner background appears in
the upper portion of the EchoPlayer
window.
Parent Organization > Child
Organization > Section
Select the desired image from the
drop-down list. To see details about
available branding files, navigate to
Schedule > Branding.
If the file you want to use is not
available, upload the image to the
branding repository so you can
select it. See Manage the Branding
Files Repository.
You could upload an image of your
institution or department.
Player Logo Image
The logo appears in the upper-left
corner of the EchoPlayer window.
Select the desired image from the
drop-down list. To see details about
available branding files, navigate to
Schedule > Branding.
If the file you want to use is not
available, upload the image to the
branding repository so you can
select it. See Manage the Branding
Files Repository.
Page 130
Parent Organization > Child
Organization > Section
EchoSystem 5 Documentation
Player Logo Hover Text
Enter the text to display when the
student hovers a cursor on the
EchoPlayer logo image. If the logo
links to your institution's home
page, your hover text might be "Go
to <my_institution's> home page."
Parent Organization > Child
Organization > Section
Player Logo Click URL
You can make the EchoPlayer logo
image a hyperlink by entering a
URL in this field. When the student
clicks on the logo a new browser
window opens with this URL. You
might, for example, link to your
institution's homepage.
Parent Organization > Child
Organization > Section
Intro Clip
An intro (also called "bumper") is a
movie or clip that plays before the
captured content. You can use this
to promote your institution or
department.
Parent Organization > Child
Organization > Section
An intro appears in the Podcast,
Vodcast, and EchoPlayer products.
Select the desired file from the
drop-down list. To see details about
available branding files, navigate to
Schedule > Branding.
If the file you want to use is not
available, upload the image to the
branding repository so you can
select it. See Manage the Branding
Files Repository.
Outro Clip
An outro is a movie or clip that
plays after the captured content.
An outro appears in the Podcast
and Vodcast products.
Select the desired file from the
drop-down list. To see details about
available branding files, navigate to
Schedule > Branding.
If the file you want to use is not
available, upload the image to the
branding repository so you can
select it. See Manage the Branding
Files Repository.
Page 131
Parent Organization > Child
Organization > Section
EchoSystem 5 Documentation
Watermark Image
A watermark is an image file (such
as a logo) that appears in the lower
right corner of both the video pane
and the content (VGA) pane.
Parent Organization > Child
Organization > Section
Select the desired file from the
drop-down list. To see details about
available branding files, navigate to
Schedule > Branding.
If the file you want to use is not
available, upload the image to the
branding repository so you can
select it. See Manage the Branding
Files Repository.
EchoCenter
Use these settings to enable/disable the EchoCenter page and customize both the appearance and functionality, as
shown in the figure below.
Page 132
EchoSystem 5 Documentation
The table below provides definitions and inheritance information for the EchoCenter options.
Setting
Definition
Inheritance
Disable at end of Term?
The EchoCenter page for the
course will be disabled when the
term ends.
Parent Organization > Child
Organization > Section
Show podcast link?
If yes, the EchoCenter page
displays Podcast download.
Parent Organization > Child
Organization > Section
Show vodcast link?
If yes, the EchoCenter page
displays Vodcast download.
Parent Organization > Child
Organization > Section
Show EchoPlayer link?
If yes, the EchoCenter page
displays a link to view the
EchoPlayer.
Parent Organization > Child
Organization > Section
Heading for scheduled captures
(singular)
Defines the heading on the
EchoCenter page. Individual
Echoes are shown under this
heading. The default is Lecture but
some organizations prefer Capture,
Class Meeting, or other terms.
Parent Organization > Child
Organization > Section
Heading for scheduled captures
(plural)
Defines the heading on the
EchoCenter page. Individual
Echoes are shown under this
heading. The default is Lectures bu
t some organizations prefer Captur
es, Class Meetings, or other terms.
Parent Organization > Child
Organization > Section
Heading for other uploaded
content (singular)
Defines the heading on the
EchoCenter page. Additional course
content, uploaded via Media Import
is shown under this heading. The
default is Supplemental but some
organizations prefer Imported
Media, Additional Content, or
other terms.
Parent Organization > Child
Organization > Section
Heading for other uploaded
content (plural)
Defines the heading on the
EchoCenter page. Additional course
content, uploaded via Media Import
is shown under this heading. The
default is Supplementals but some
organizations prefer Imported
Media, Additional Content, or
other terms.
Parent Organization > Child
Organization > Section
Page 133
EchoSystem 5 Documentation
EchoPlayer
The table below provides definitions and inheritance information for the EchoPlayer options.
Setting
Definition
Inheritance
Bookmarks
Check to enable the Bookmarks
application in the EchoPlayer. You
must subscribe to Collaboration and
Statistics Service to enable this
application.
Parent Organization > Child
Organization > Section
Discussions
Check to enable the Discussions
application in the EchoPlayer. You
must subscribe to Collaboration and
Statistics Service to enable this
application.
Parent Organization > Child
Organization > Section
Usage Data
Check to enable Student Usage
Data in the EchoPlayer. You must
subscribe to Collaboration and
Statistics Service to enable this
application.
Parent Organization > Child
Organization > Section
Feedback
Check to enable the Feedback
application in the EchoPlayer.
Parent Organization > Child
Organization > Section
Sharing
Check to enable the Sharing
application in the EchoPlayer.
Parent Organization > Child
Organization > Section
Product Groups
The table below provides definitions and inheritance information for the Product Group options.
Setting
Page 134
Definition
Inheritance
EchoSystem 5 Documentation
Product Group
The product group specified here is
inherited by sections. You can
change the value either here in the
organization or on the section.
Parent Organization > Child
Organization > Section
Security Settings
This setting allows you to implement either the standard or Collaboration Service versions of the EchoCenter pages.
The table below provides definitions and inheritance information for the Security Settings options.
Setting
Definition
Inheritance
Security Module
Specify the security module the
ESS should use to check a user's
credentials when accessing
EchoCenter, EchoPlayer and
downloadable content. Security
modules may have custom names.
Parent Organization > Child
Organization > Section
To implement the standard
version of the EchoCenter, select
Allow All.
To implement the Collaboration
Service version of the
EchoCenter, select either the LD
AP or seamless login modules.
If you are using Blackboard Learn
as a publisher, users may or may
not be asked for credentials when
they launch an Echo from within
Blackboard.
Users are not asked if you select
Seamless Login or Allow All.
Users are asked if you select LD
AP.
Users can only access Echoes
via Blackboard if you select
seamless only.
Support
We recommend that you provide instructions on the specifics of your playback products, directing students to your
institution's website and help desk. The help link is visible on the student's EchoPlayer during playback (in the
browser).
Page 135
EchoSystem 5 Documentation
The table below provides definitions and inheritance information for the Support options.
Section
Description
Inheritance
Support URL Text
Defines text to be displayed when
the student rests their cursor on the
help link displayed in the
EchoPlayer. Example: "Online
help."
Parent Organization > Child Orga
nization > Section
Support Phone
Defines a phone number for
technical support that students can
call with questions or problems on
the EchoPlayer. This number
appears in the Help tab of the
EchoPlayer.
Parent Organization > Child Orga
nization > Section
Support URL
Defines an URL to your help page
or help system URL in this field. A
link to this help page will be
displayed in the Help tab of the
EchoPlayer.
Parent Organization > Child Orga
nization > Section
Upload Settings
The table below provides definitions and inheritance information for the Upload Settings options.
These settings relate to the Media Import feature. See Import Other Media for Academic Staff for details on this
feature.
Setting
Enforce section upload quotas
Page 136
Definition
Inheritance
Parent Organization > Child Orga
nization > Section
EchoSystem 5 Documentation
If set to the default value (No),
Presenters may import as many
other media files as they wish and
those files can be of any size.
Set Section
Quotas to
Ration Storage
Space.
Page 137
EchoSystem 5 Documentation
Storage is
shared among
scheduled
recordings,
imported media
files, and
Personal
Capture
recordings. Use
the section
upload quotas to
limit the amount
of total storage
given to other
media files and
Personal
Capture
recordings.
Example: At the
start of the year,
the amount of
free space
available is 2 Tb
(terabytes). The
amount of
storage that will
be used by
scheduled
recordings is
estimated to be
1.6 Tb (100
hours/week x
400Mb/hour x 40
weeks/year =
1.6 Tb). This
leaves 400 Gb in
remaining
storage. Say
that you have
100 sections
where
Presenters may
import external
media files or
Personal
Capture
recordings. The
section quota
should be 4 Gb
(400 Gb/100 = 4
Gb).
Page 138
EchoSystem 5 Documentation
Section upload quota (MB)
This setting is enforced only if the E
nforce section upload quotas sett
ing is Yes.
Parent Organization > Child Orga
nization > Section
If set to the default value (0),
Presenters cannot import external
media files.
When setting this value, consider
the amount of storage you have
available and the needs of
Presenters. This value is the total a
mount of content the Presenter can
upload using the Media Import
feature during the entire term.
Manage Rooms
In this section:
Overview
Add Rooms
Room Configuration Options
License Rooms
Assign the Capture Appliance to the Room
Assign Classroom Capture to the Room
Retire a Room
Delete a Room
Reinstate a Room
Overview
Rooms are a critical concept for the ESS. Rooms or other lecture venues must be Licensed (Venue License
Assignment) and contain a capture device (Device Room Assignment) in order to schedule or perform an Ad Hoc
capture. Each room is contained in a building which, in turn, is contained in a campus. We use the following
terminology.
Concept
Applies To
Description
Campus(es)
Buildings
Rooms
Campus defines the physical
campus on which buildings and
classrooms exist. They are the top
tier in room structure.
Building(s)
Rooms
Buildings define the physical
building in which the classrooms
exist. They are the second tier in
the room structure.
Page 139
EchoSystem 5 Documentation
Rooms
Capture Appliances
Classroom Capture
Rooms are the physical classroom
or lab in which lectures are
occurring and are captured. Rooms
are scheduled for capture.
Device Room Assignment
Capture Appliances
Classroom Capture
EchoSystem devices are assigned
to rooms for scheduling.
Room or Venue License
Assignment
Venues/Rooms with capture
appliances
Venues/Rooms with Classroom
Capture
Specific venues that are licensed
for capture, typically classrooms,
auditoriums, or other lecture
locations.
Room Settings
Rooms with capture appliances
Rooms with Classroom Capture
The settings for a room.
All rooms may be viewed on the Configuration > Rooms tab. You can filter the list by Campus, Building, or
Keyword to quickly find a specific room. You can also add new rooms, import or export rooms (via a CSV file), or
retire rooms.
Add Rooms
Rooms are the physical locations in which capture is occurring. They are defined within a structure of campuses and
buildings. Capture devices are assigned to rooms and rooms are scheduled for capture.
1. In the EchoSystem Server (ESS) application, navigate to Configuration > Rooms.
2. Click the Add button. The Add New Room screen opens.
3. If necessary, add a campus.
a. Click the Add link next to the campus list to open the Add New Campus dialog.
b. Add the name of your campus
c. Select a Time Zone from the list. This is the time zone where the campus is.
d. Click Save.
e. If you have capture rooms across multiple campuses, create each of these campuses using the same
steps.
4. Select the appropriate campus.
5. If necessary, add a building.
6. Select the appropriate building.
7. In the Room Details section:
a. Enter the name of the room or lecture hall where the capture appliance is installed, or its identifying
number
b. Select the organization that owns the room from the drop-down list. If you are the System
Administrator or Admin of the parent organization, you will see all rooms. If you are the Admin of a
Page 140
EchoSystem 5 Documentation
child organization, you will see only the rooms owned by your organization. In the example shown, the
room is owned by a child organization, CLP.
8.
9.
10.
11.
Configure the other settings on this page. See Room Configuration Options for details.
Click Save.
On the Room screen, the new entry is visible as a line item in the Room table.
Repeat this operation for each room.
You may sometimes want to add many rooms all at once or to change properties of many rooms. You can do this
efficiently by using the export and import feature with a spreadsheet program such as Excel. See Export and Import
Objects.
Room Configuration Options
Room Location
The following figure shows the Room Location configuration settings. Below the figure is a table that describes the
settings available.
Setting
Description
Inherited From...
Campus
The campus in which the capture
room resides
N/A
Building
The building in which the capture
room resides
N/A
Room Details
The following figure shows the Room Details configuration settings. Below the figure is a table that describes the
settings available.
Page 141
EchoSystem 5 Documentation
Setting
Description
Inherited From...
Name
The room name or identifier
N/A
Organization
The parent organization or child
organization that owns the room
N/A
Ad Hoc Interface [Capture Appliance]
The following figure shows the Ad Hoc Interface configuration settings for the Capture Appliance. Below the figure is
a table that describes the settings available.
Setting
Description
Inherited From...
Admin User Name/Password
Defines the default username and
password to access the advanced
tabs (http://{hostname}/advanced)
in the Ad Hoc interface for the
room. Applied when a capture
appliance is assigned to the room.
Device Defaults
Generic User Name/Password
Defines the default username and
password to access the basic Ad
Hoc interface for the room. These
credentials allow for basic ad hoc
captures and monitoring. Applied
when a capture appliance is
assigned to the room.
Device Defaults
Ad Hoc Interface [Classroom Capture]
The following figure shows the Ad Hoc Interface configuration settings for Classroom Capture. Below the figure is a
table that describes the settings available.
Page 142
EchoSystem 5 Documentation
Setting
Description
Inherited From...
Admin User Name/Password
Defines the default username and
password to access the advanced
tabs (http://{hostname}/advanced)
in the Ad Hoc interface for the
room. Applied when a Classroom
Capture device is assigned to the
room.
Device Defaults
Generic User Name/Password
Defines the default username and
password to access the basic Ad
Hoc interface for the room. These
credentials allow for basic ad hoc
captures and monitoring. Applied
when a Classroom Capture device
is assigned to the room.
Device Defaults
License Rooms
Classrooms, auditoriums, lecture halls or other venues can be licensed individually or as a group.
See License Venues on the Manage Licenses page for details.
Assign the Capture Appliance to the Room
1.
2.
3.
4.
Log in to the ESS.
Navigate to Configuration > Devices.
Mouse over the line item of the capture appliance to be assigned to the room.
Click Edit from the hover menu. The Edit Device screen opens.
5.
6.
7.
8.
Select the campus, building and room from the Current Room Assignment section.
Click Save. The device summary appears.
Click Done. The Device Details screen shows the capture appliance and room assignment.
Repeat this operation for each capture appliance and associated room.
The capture appliance is now enabled and assigned a licensed room location. Your EchoSystem is now installed
and ready to capture lectures. See EchoSystem Capture in the Classroom for additional information and links to
related documentation.
Assign Classroom Capture to the Room
1.
Page 143
EchoSystem 5 Documentation
1.
2.
3.
4.
5.
Log in to the ESS.
Navigate to Configuration > Devices.
Mouse over the line item of the device to be assigned a room.
Click Edit from the hover menu. The Edit Device screen opens.
Select the campus, building and room from the Current Room Assignment section.
6. Click Save. The device summary appears.
7. Click Done. The Device Details screen shows the capture appliance and room assignment.
8. Repeat this operation for each Classroom Capture device and associated room.
The Classroom Capture software is now enabled and assigned a licensed room location. Your EchoSystem is now
installed and ready to capture lectures. See EchoSystem Capture in the Classroom for additional information and
links to related documentation.
Retire a Room
You can retire a room that is not currently active. You cannot retire a room that is still associated with a course, a
section, or a schedule. Those rooms are considered active and cannot be retired.
To retire rooms, you must have the role of Administrator of either the parent or child organization or System
Administrator of the parent organization.
After you retire a room, you cannot associate the room with a course, a section, or a schedule. Retiring a room does
not delete the room permanently. You can reinstate a retired room later.
1. Navigate to Configuration > Rooms.
2. On the Active tab, select the room(s) you want to retire.
To retire one room at a time, hover your mouse over the room's name and click retire, as shown in the
figure below.
To retire one or more rooms, select the box to the left of each room listed and select Retire Selected f
rom the Actions box at the bottom of the page, as shown in the figure below.
In either case, a confirmation message appears.
3. Click Yes to confirm the retirement of the room(s). The selected rooms move to the Retired tab.
Delete a Room
Deleting a room removes that room permanently from the ESS. To delete rooms, you must have the role of
Administrator of either the parent or child organization or System Administrator of the parent organization. You
cannot delete rooms that are associated with an ongoing course, section or schedule. To delete those rooms, you
Page 144
EchoSystem 5 Documentation
must remove the association between the room and the course, section, or schedule first.
You must retire a room before you can delete it.
1. Navigate to Configuration > Rooms.
2. Retire the room or rooms.
3. Select the Retired tab, as shown in the figure below.
4. Select the room(s) you want to delete.
To permanently delete one room at a time, hover your mouse over the room's name and click delete,
as shown in the figure below.
To permanently delete one or more rooms, select the box to the left of each room's name and select D
elete permanently from the Actions box at the bottom of the page, as shown in the figure below.
In either case, a confirmation message appears.
5. Click Yes to confirm the deletion of the room(s).
Reinstate a Room
1. Navigate to Configuration > Users.
2. Select the Retired tab.
3. Select the room you want to reinstate.
To reinstate one room at a time, hover your mouse over that room's name to display the available
buttons, and click reinstate.
To reinstate one or more rooms, select the box to the left of each room's name, and select Reinstate
selected from the Actions list at the bottom of the page, as shown in the figure below.
Page 145
EchoSystem 5 Documentation
4. Notice that the selected room is moved to the Active tab and is again available for use.
Uninstall the ESS
In this section:
Overview
Uninstall from Windows Server 2008
Uninstall from Mac OS X
Uninstall from Linux
Uninstall from Windows Server 2003
Overview
The EchoSystem server (ESS) has an automated installation program. The uninstaller that is also provided with the
product is the preferred means of removing and cleaning up the EchoSystem server. To uninstall the ESS, follow the
appropriate procedure below for your operating system.
Uninstall from Windows Server 2008
Stop the Service
1.
2.
3.
4.
From the Windows taskbar, select Start > Programs > Administrative Tools > Services.
The Services dialog box opens. Select the EchoSystem Server service.
Click Stop. The EchoSystem server service stops on your local computer.
Stop the media processor if it is installed on this server.
Uninstall the Application
1. From the Windows Control Panel, open the Programs and Features dialog box. Right-click the EchoSystem
Server. Click Uninstall/Change.
2. Confirm the removal when prompted.
3. In Windows Explorer, navigate to C:\Program Files.
4. Delete the Echo360 folder.
5. Confirm the deletion when prompted.
6. In Windows Explorer, navigate to the C: drive.
7. Delete the Echo360 folder.
8. Confirm the deletion when prompted.
Uninstall from Mac OS X
Stop the Service
1. Open the terminal prompt window (Applications > Utilities > Terminal).
2. Type the stop command:
Page 146
EchoSystem 5 Documentation
2.
sudo /usr/local/echo360/server/bin/echosystemserverd.sh stop
Remove the Application
1.
2.
3.
4.
5.
6.
7.
Navigate to Places > Applications.
Click echo360.
Click server.
Click uninstall_EchoSystemServer.
Click EchoSystemServer_uninstall.
Enter your password.
Confirm the uninstallation when prompted.
Uninstall from Linux
Stop the Service
Stop the ESS service by going to the terminal prompt, then type in the stop command:
sudo
/usr/local/echo360/server/bin/echosystemserv
erd.sh stop
Remove the Application
To uninstall the application, follow these steps:
1. Deregister the service from the init.d system
2. Remove the application directories
Deregister the Service
Deregister the service with the following commands. If you are using an external media server, then skip the Wowza
commands.
sudo
sudo
sudo
sudo
Page 147
chkconfig
chkconfig
chkconfig
chkconfig
echosystemserverd off
--del echosystemserverd
WowzaMediaServer off
--del WowzaMediaServer
EchoSystem 5 Documentation
Remove the Application Directories
Remove the application directories from the system using the following commands: (these are the default
directories; you may have installed in other locations)
sudo
sudo
sudo
sudo
rm
rm
rm
rm
-r /usr/local/echo360
-r /var/local/echo360
/var/.com.zerog.registry.xml
/usr/local/WowzaMediaServer
The ESS is now uninstalled.
Uninstall from Windows Server 2003
Stop the Service
1.
2.
3.
4.
From the Windows taskbar, select Start > Programs > Administrative Tools > Services.
The Services dialog box opens. Select the EchoSystem server service.
Click Stop. The EchoSystem server service stops on your local computer.
Stop the media processor if it is installed on this server.
Uninstall the Application
1. From the Windows Control Panel, open the Add/Remove dialog box. Select the EchoSystem Server. Click R
emove.
2. Confirm the removal when prompted.
3. In Windows Explorer, navigate to C:\Program Files.
4. Delete the Echo360 folder.
5. Confirm the deletion when prompted.
6. In Windows Explorer, navigate to the C: drive.
7. Delete the Echo360 folder.
8. Confirm the deletion when prompted.
Localize EchoSystem Components
In this section:
Overview
EchoSystem Server UI
EchoPlayer
EchoSystem Editor
Device Ad Hoc UI
Overview
Most EchoSystem components can be localized. This document explains the process of performing localization and
also working with Echo360 to include translations in our development cycle. Echo360 is committed to serving our
international partners.
Page 148
EchoSystem 5 Documentation
Echo360 ships a localized release two to three weeks after each major release. This localized release
includes localizations for all supported components in Japanese, German, Spanish and Arabic.
Echo360 provides the English and differential files for each major release to our reseller community for
additional translations.
Echo360 bundles reseller translations into the released version of the EchoSystem and provides additional
localization releases.
The following components can be localized:
EchoSystem Server UI
Device Ad Hoc UI
EchoPlayer
EchoSystem Editor
EchoSystem Server UI
1. Contact Echo360 to obtain the master EchoSystem Server (ESS) English language file - messages.propertie
s.
2. Make a copy of the messages.properties file and add the language code to the file name. For example, the
language code for Spanish is "es". The Spanish translation file is named messages_es.properties.
3. Translate the text appearing after the equal sign ( = ) for each simple token. Translate the text appearing after
the number sign ( # ) for multi-select tokens. Follow these examples:
Simple Token Value
154.column-term-start-date=Start Date
In this example, "154.column-term-start-date=" is the token and "Start Date" is the text to be translated.
Multi-Select Token Value
154.invalid-comparable-date=Must be {0,choice,0#after|1#the same as or after|2#before|3#the same as
or before|4#the same as|5#different from} the date in {1}.
In this example "154.invalid-comparable-date=" is the token. The text to be translated following the
equal sign ( = ) is "Must be" and after the number signs ( # ). In this case "after", "the same as or after",
"before", "the same as or before", "the same as" and "different from" need to be translated.
4. Submit the localized file to Echo360.
5. Echo360 will have your translations up on a hosted system two to three days after file submission for you to
test.
6. If you need make changes based on test results, apply them to the language file and contact Echo360 when
translation is completed.
7. Echo360 provides a new ESS installer or patch to support your localization.
Testing Translations
EchoSystem Server translations cannot be tested on site until Echo360 has bundled the
language file in an installer or patch.
EchoPlayer
Localization
1. Contact Echo360 to obtain the master EchoPlayer English language files - en.js and en.xml.
2. Make a copy of each file and rename them based on the language code. For example, the language code for
Spanish is "es". The Spanish translations files are named es.js and es.xml.
3. Translate the text appearing within the XML text id attributes from the en.xml file. Follow these examples.
Page 149
EchoSystem 5 Documentation
3.
XML Text ID
<text id="402">Please wait while we load the Echo...</text>
In this example "<text id="402">" and "</text>" define the XML attribute and "Please wait while we
load the Echo..." is the text to be translated.
4. Translate the text appearing after the equal sign ( = ) and between the quotes ( "" ) for each token in the en.js
file. Follow these examples.
Token Value
var id_303 = "High Speed Version";
In this example "var id_303 = " is the token and "High Speed Version" is the text to be translated.
5. Submit the localized files to Echo360.
6. Echo360 will have your translations up on a hosted system two to three days after file submission for you to
test. You may prefer to do your own testing on site. Refer to the On-Site Testing instructions below.
7. If you need make changes based on test results, apply them to the language file and contact Echo360 when
translation is completed.
8. Echo360 will provide a new ESS installer or patch to support your localization.
On-Site Testing
Testing for EchoPlayer localization can be done on-site with these steps:
1.
2.
3.
4.
5.
On the ESS file system, navigate to the content\templates\1f80f82f-91ba-408a-9a23-c74d701fe3f1 directory.
Open the echo_files directory.
Copy the files in this directory to a temporary location. You will use this copy for the rest of the steps.
Copy the translated files from the steps above, for example es.js and es.xml, into the language directory.
Edit the languages.xml file and add an entry for your language locale.
<?xml version="1.0" encoding="utf-8"?>
<languages>
<language locale="en" uri="language/en.xml"/>
<language locale="es" uri="language/es.xml"/>
</languages>
6. Edit the languages.js file and add an entry for your language locale.
addLanguage( "en", "language/en.js" );
addLanguage( "es", "language/es.js" );
7. Save these files.
8. Make a zip file from the copied files in the temporary location and name it template_1.zip. It is important that
the zip file contain all of the files copied from the echo_files directory including the new language files. It is
also important that these files are at the root of the zip file and not in a directory in the zip file.
9. Open the ESS file system and navigate to the server directory. Create a directory called templates.
10. Copy the template_1.zip file into this directory.
11.
Page 150
EchoSystem 5 Documentation
11. Open the ESS UI and edit the System Settings page. Immediately save the page.
12. The new template with the translations will not be used to serve the EchoPlayer. Set your browser locale
accordingly to test the translation.
EchoSystem Editor
Localization
1. Contact Echo360 to obtain the master EchoPlayer English language files - en.js and en.xml
2. Make a copy of each file and rename them based on the language code. For example, the language code for
Spanish is "es". The Spanish translations files are named es.js and es.xml.
3. Translate the text appearing within the XML text id attributes from the en.xml file. Follow these examples.
XML Text ID
<text id="206">Modify this segment</text>
In this example "<text id="206">" and "</text>" define the XML attribute and "Modify this segment"
is the text to be translated.
4. Translate the text appearing after the equal sign ( = ) and between the quotes ( "" ) for each token in the en.js
file. Follow these examples.
Token Value
var id_203 = "Description";
In this example "var id_203 = " is the token and "Description" is the text to be translated.
5. Submit the localized files to Echo360.
6. Echo360 will have your translations up on a hosted system two to three days after file submission for you to
test. You may prefer to do your own testing on site. Refer to the On-Site Testing instructions above.
7. If you need make changes based on test results, apply them to the language file and contact Echo360 when
translation is completed.
8. Echo360 will provide a new ESS installer or patch to support your localization.
On-Site Testing
Testing for EchoPlayer localization can be done on-site with these steps:
1.
2.
3.
4.
5.
On the ESS file system, navigate to the content\templates\78e79024-2c08-4cfa-bb00-cf3a70fbcb15 directory.
Open the editor_files directory.
Copy the files in this directory to a temporary location. You will use this copy for the rest of the steps.
Copy the translated files from the steps above, for example es.js and es.xml, into the language directory.
Edit the languages.xml file and add an entry for your language locale.
<?xml version="1.0" encoding="utf-8"?>
<languages>
<language locale="en" uri="language/en.xml"/>
<language locale="es" uri="language/es.xml"/>
</languages>
6. Edit the languages.js file and add an entry for your language locale.
Page 151
EchoSystem
6. 5 Documentation
addLanguage( "en", "language/en.js" );
addLanguage( "es", "language/es.js" );
7. Save these files.
8. Make a zip file from the copied files in the temporary location and name it editor_1.zip. It is important that the
zip file contain all of the files copied from the echo_files directory including the new language files. It is also
important that these files are at the root of the zip file and not in a directory in the zip file.
9. Open the ESS file system and navigate to the server directory. Create a directory called templates.
10. Copy the editor_1.zip file into this directory.
11. Open the ESS UI and edit the System Settings page. Immediately save the page.
12. The new template with the translations will not be used to serve the EchoPlayer. Set your browser locale
accordingly to test the translation.
Device Ad Hoc UI
1. Contact Echo360 to obtain the master Ad Hoc English language file - language.js.
2. Make a copy of the language.js file and add the language code to the file name. For example, the language
code for Spanish is "es". The Spanish translation file is named language_es.js.
3. Translate the text appearing after the equal sign ( = ) and between the quotes ( "" ) for each token in the lang
uage.js file. Follow these examples.
Token Value
var id_053 = "Start Capture";
In this example "var id_053 =" is the token and "Start Capture" is the text to be translated.
4. Submit the localized files to Echo360.
5. Echo360 will have your translations up on a hosted system two to three days after file submission for you to
test. You may prefer to do your own testing on site. Refer to the On-Site Testing instructions above.
6. If you need make changes based on test results, apply them to the language file and contact Echo360 when
translation is completed.
7. Echo360 will provide a new device patch to support your localization.
Device Ad Hoc UI translations cannot be tested on site until Echo360 has bundled the
language file in an installer or patch.
Support Uploads
In this section:
Upload Process
Logging
Cached Files
Other
Upload Process
1. Immediately after the user presses the button, an empty "transfer.started" file is uploaded. If this file cannot
be successfully uploaded, no support upload will be performed, but the files that would be uploaded are still
created in the staging area. If the user presses the button and the folder and file are not created within a few
Page 152
1.
EchoSystem 5 Documentation
seconds you know the upload will not work.
2. The upload is now broken into several files instead of just one big one. Each file is created in a staging area
and regardless of whether they can actually be uploaded, the files are created and remain in the staging area
until the next support upload is performed.
3. The staging area is under <ESS_HOME>/.tmp/.supportUpload. Whenever a new support upload is initiated,
the staging area is cleaned out prior to new staged support upload files being created there.
4. A directory is created in the staging area that is named the same as the directory where files are uploaded on
sftpupload.echo360.com.
5. The upload files are created one by one and are uploaded as they are created:
config.zip contains the contents of the <ESS_HOME>/etc dir and the wowza configuration dir (if
applicable).
sysInfo.zip contains various system information, such as Java system properties, environment
variables, a summary of the relevant file systems, and a file that shows the number of records in each
of the database tables.
Zip files are created that contain log files covering three day periods. The first,
logs_00-03_daysAgo.zip, contains the log files with a last modified time from now until three days ago.
The second, logs_03-06_daysAgo.zip, contains the log files with a last modified time from three to six
days ago. Zip files are created and named following this pattern. The oldest file,
logs-27-30_daysAgo.zip, contains the log files with a last modified time from 27 to 30 days ago.
database.zip - contains the derby database (if applicable).
6. The log file archives will only be produced if there are logs from those days. Also, there is a 200 MB limit, so
as soon as the cumulative size of the log archives exceeds that limit, no more will be produced.
7. If the database is Derby, the database.zip file will be produced, but it will only be uploaded if the zip is no
larger than 300 MB. If it is larger, it will need to be uploaded manually.
8. Files (like log files, files in etc, database files) now retain their last modified date when extracted from the zip.
9. If all of the files upload successfully, an empty "transfer.complete" file is uploaded as before.
10. No longer allow multiple overlapping simultaneous uploads at the same time. Give user a message that one
is already in progress if they keep hitting the button before the first one is finished.
Logging
1. There is a new "jetty.log" file that logs some jetty-specific stuff, especially during startup. This will be very
useful troubleshooting cases where the EchoSystem Server (ESS) will not start up correctly. It should no
longer be necessary to start the ESS from the command prompt in these cases. In fact, most logging is no
longer directed to stdout/stderr so will not appear in the console when starting from a command prompt.
2. wrapper.log is now capturing stdout/stderr from the java virtual machine. This will allow it to capture thread
dumps and other debugging information that can be provided by the JVM.
3. The logging configuration file (<ESS_HOME>/etc/logging.cfg.xml) can now be changed on a running system
and the changes will be picked up without restarting the ESS
4. Logging should now resume soon after correcting a problem that prevents logging, such as interruption of an
NFS share or a permissions issue. Until now, when logging stopped due to such an issue, an ESS restarted
was required to get it going again.
5. The request.log file entries are now in the local time zone of the ESS machine like all of the other logs,
instead of GMT. The naming pattern of the request log files is now consistent with the other logs.
6. The active log files are now named using the same pattern as the rolled-over log files, so the name will no
longer change when it gets rolled over. This was previously the case with the wrapper log file and now
applies to all of the log files.
Cached Files
1. The <ESS_HOME>/cache dir, where the device software files are cached, has been moved to
<ESS_HOME>/.tmp/.deviceFileCache.
2. The place where the device software jar file is unzipped (staged) was previously in a temporary folder under
the system temp dir, but has now been moved to <ESS_HOME>/.tmp/.deviceFileStaging.
3.
Page 153
EchoSystem 5 Documentation
3. The place where plugins are staged during run time was previously in a temporary folder under the system
temp dir, but has now been moved to <ESS_HOME>/.tmp/.deviceFileStaging
Other
1. The name of the executable jar for command line utilities has changed from "ess-lib-util.jar" to
"ess-command.jar". For example, to run a database script, you will now do this:
2. <ESS_HOME>/etc/wrapper.conf no longer is required to have numbered entries be in strict numerical order
without gaps. In the past, when adding Java Additional Parameters, for instance, you had to number them
consecutively. This is no longer needed and the default wrapper.conf now has these parameters organized
into logical groups.
3. JConsole is now included with the Java Runtime Environment installed with the ESS and the MBean support
for monitoring Jetty is configured by default. New installations as of 2.6 include the lines needed to enable
monitoring with JConsole commented out in the Java Additional Parameters section of jre/bin/java
-Xmx1024m -jar lib/ess-command.jar ExecuteScript --script somescript.sql <ESS_HOME> /etc/wrapper.conf.
For new installations, monitoring with JConsole merely requires uncommenting three lines from wrapper.conf,
restarting the ESS, and starting JConsole (<ESS_HOME>/bin/jconsole).
Manage the EchoSystem Server Database
This section includes the following topics.
Migrate an External MySQL Database
Migrate the ESS to a New Server
Migrate an External MySQL Database
In this section:
Overview
Solution
Overview
Migrating an external MySQL database from one host to another can be accomplished using the mysqldump utility
distributed with MySQL. This article outlines the usage of this tool for migrating the EchoSystem Server (ESS)
database. For detailed information on this utility, as well as information on using it to migrate a database between
different MySQL versions, see the documentation on the MySQL website for the appropriate MySQL version.
Solution
The path to the mysqldump utility depends on the operating system version. This command should only be executed
when a short downtime can be tolerated for the ESS. Once the utility is located, execute the following command to
dump the database to a text file containing SQL commands which will recreate the tables and data:
mysqldump -u [username] -p -B [database_name] > ess_db_backup.sql
This command creates a text file, ess_db_backup.sql, in the current working directory. The username parameter
specifies the MySQL account, which should be used to access the database, while the database_nameparamete
r specifies the database upon which to operate. Consult your installation notes for these parameters. Copy this file
to the location of the new MySQL database, then run the following command to recreate the database.
mysql -u [username] -p < ess_db_backup.sql > output.tab
Page 154
EchoSystem 5 Documentation
Examine the file output.tab for any errors.
Migrate the ESS to a New Server
In this section:
Overview
Addressing
Run the ESS Installer
Transfer the ESS Database
Configure Paths and Transferring Content
Configure Devices
Overview
The EchoSystem Server (ESS) architecture allows for simple migration from one server to another as your
deployment model changes. This page explains how to migrate the ESS, while preserving your settings, schedules,
and content.
ESS on Windows in Default Locations
This article assumes that the ESS is installed on a Windows system in the default locations.
System paths for Linux or OS X use a different format and will vary from the paths described in
this article.
Addressing
According to best-practice recommendations, the ESS uses fully-qualified domain names (FQDNs) in its
configuration when URLs are required. This requires accurate name resolution to be available on your network to all
devices. An advantage of this is that the FQDN of your ESS can be preserved during migration. We recommend that
you update the DNS record of the host name for your old ESS host to point to the new one so that any existing
content links from external locations are not broken.
Run the ESS Installer
The ESS installer is available from the customer support area of our website. We always recommend using the
latest version of the installer so that your system is operating with the most recent features and stability updates.
At this point, we are only creating a brand-new installation on the target machine. This will create the necessary
folder structures, program files, and registrations with the host operating system so that an ESS can run. We will
migrate the database and content after we have confirmed a successful installation.
When the installer has finished running, it automatically starts the ESS service if you are running Windows. It will not
start the Wowza Flash Streaming Server (Wowza Media Server) automatically. If your paths have changed, it is
important that you do not start Wowza until updating them in the ESS configuration during the next stage of the
migration. At this point, you may attempt to log in to the ESS with the temporary default user name and password.
Do not bother to configure it; rather, verify that it is running. We will overwrite its configuration with your original
database in the next step.
Transfer the ESS Database
The first step is to verify that both the ESS and Wowza Media Server services are stopped. If you are running the
ESS on Windows, execute the following from the command line:
Page 155
EchoSystem 5 Documentation
net stop echosystemserver
net stop wowzamediaserver
Linux users should use the service management tools that are available with each particular distribution.
Once the services have stopped, make the copy of your ESS database that the new machine will use. Doing this
preserves your settings, schedules, and all of your content indexes.
By default, the ESS database is installed in C:\Program Files\Echo360\Server (/usr/local/echo360/server on
Linux-like operating systems). Copy the entire "db" and "etc" folders to their new locations on the new machine.
Be sure to preserve relative path structures and to back up (make copies of) the brand-new "db"
and "etc" folders before overwriting them with the files from your original ESS in case the
migration is unsuccessful.
After you have made the copy and the database is in place, start the ESS service again.
Configure Paths and Transferring Content
Once the service has started, log in to the ESS as usual (your user name and password will have been preserved if
you correctly transferred the database) to verify and, if necessary, change the folder entries for all of the content in
your System Settings.
While doing this, you will be setting the paths for your content storage. These paths should be defined before the
content is copied from its location on the old ESS to its storage location on the new one. Once these are defined,
simply copy the content folders to where you have configured the ESS to look for them. If you have been using a
SAN for the storage of your active content, you may not need to copy any files. In this case, just make sure the path
is accurate.
Configure Devices
Even if the URL to your ESS has not changed, you may still need to reinitialize your devices (this is necessary if
your devices have an "Overdue" status).
DHCP Assumed
These steps assume you are using DHCP. If you are using static IP address configurations for
your appliances, please substitute the device specific config.xml file (retrievable from each
individual device page) for the generic file in these steps.
1. Click the Configuration tab.
2. At the bottom of the page, click Download generic device configuration. This will offer a file called
device.xml. Save this in an accessible location.
3. For Appliances, copy the device.xml file to the top level of a USB drive. Visit each appliance and insert the
drive in any of the USB ports. It is not necessary to restart the appliance before or after receiving the flash
drive; however, if you are powering on the appliance for the first time, please wait until the amber light turns
off before inserting the drive. You will see a blinking light; after it stops, you can remove the drive again.
4. For Media Processors and Classroom Capture, copy the device.xml file to the following location and overwrite
the previous instance:
C:\Documents and Settings\All Users\Application Data\Echo360\client\config\
(On some systems, the first few elements of this path may be different or begin with a different drive letter.)
5.
Page 156
EchoSystem 5 Documentation
5. The devices re-initialize with your new ESS on their next periodic updates.
Collaboration and Statistics Service
In this section:
Overview
Licensing
Configuration
Disable or Enable All Features
Disable or Enable the Discussions Feature
Overview
What is the Collaboration and Statistics Service?
The Collaboration and Statistics Service (also called the "Collaboration Service") offers these features:
Discussions. A student (or an instructor) viewing an Echo can click the Discussions button, shown below, and
begin a discussion with the instructor and other students. Discussions can also be launched from the EchoCenter.
Discussions can be enabled or disabled for a section using the Discussions check box in the EchoPlayer portion of
the Section configuration page.
Bookmarks. A student (or an instructor) viewing an Echo can click the Bookmarks button, shown below, to mark
certain points in an Echo, allowing him to quickly navigate to a particular point.
Student Usage statistics. These appear as charts and usage data on the number of users who have viewed a
particular Echo or participated in a discussion. Instructors (but not students) see usage statistics on the EchoCenter
page, as shown in the figure below.
Page 157
EchoSystem 5 Documentation
Server Hosted by Echo360
The Collaboration and Statistics Service relies on the EchoSystem Server (ESS) or the EchoPlayer sending and
receiving data from a server hosted by Echo360. Data is sent with SSL encryption. Only course information and
statistical data required to support these features are stored on the server. No Echoes, raw media files, or identifying
information about the student are stored there. For further details on Echo 360's privacy policy, see http://echo360.c
om/echo360-online-privacy-policy/.
Licensing
If you purchased any of the following licenses, the Collaboration and Statistics Service is automatically registered
and enabled during ESS installation:
The Collaboration and Statistics Service license (sometimes called the "HEMS" license).
At least five recurring EchoSelect licenses. The Collaboration and Statistics Service license is included in this
purchase.
Configuration
Once the ESS is installed:
You must modify the firewall to allow port 443 (TCP outbound)
You may want to follow the instructions in the Disable or Enable All Features section below to ensure that the
Collaboration and Statistics services are enabled. These features are enabled by default.
You may also want to follow the instructions in the Disable or Enable the Discussions Feature section below.
Disable or Enable All Features
Page 158
EchoSystem 5 Documentation
Who can do this?
System Administrator
1. Navigate to System > Hosted Services.
2. Click on Collaboration and Statistics as shown in the below figure. The Hosted Service Details for the
Collaboration and Statistics Service page appears.
3. Find the Disable button at the bottom of the page. A Disable button indicates that collaboration features are
enabled. Click this button if you want to disable all collaboration and statistics features.
4. Notice the message at the top of the page confirming that the features are disabled. Also notice that the
Disable button has changed to an Enable button.
5. If the Collaboration and Statistics features are disabled, you will find an Enable button at the bottom of the
page instead. Click Enable to enable all collaboration and statistics features.
6. Notice the message at the top of the page confirming that the features are enabled, and that the button is
now a Disable button.
Disable or Enable the Discussions Feature
Who can do this?
System Administrator
Parent organization Administrator
Child organization Administrator (for the child organization)
Scheduler (for the section)
When the Collaboration and Statistics Service was set up, the following features were enabled:
Bookmarks
Student Usage statistics
Discussions
The Bookmarks and Student Usage statistics features are automatically enabled. You cannot disable either except
by disabling all collaboration features. The Discussions feature (which is enabled by default), is different. It can be
enabled or disabled for an organization, for a course, or for a section.
The following procedure shows how to configure Discussions for a section.
1. Navigate to the section details page.
a.
Page 159
EchoSystem 5 Documentation
1.
a. Navigate to Schedule > Courses.
b. Click on the course link.
c. Click on the section link. The section details page appears.
2. Click Edit.
3. Find the EchoPlayer settings group, shown in the figure below.
4. Check or uncheck the box for Discussions.
5. Click Save.
Personal Capture
In this section:
Overview
High-Level Procedure - Install and Enable Personal Capture
Overview
Personal Capture (formerly called "EchoCapture Personal" or "PCAP"), is a stand-alone application that runs on
Windows and Mac laptops, tablets, and desktop computers. It is designed primarily for Academic Staff users.
Academic Staff can use it to record audio, local screen and webcam video for all podcast and EchoPlayer products,
then publish the recordings to a specific section.
High-Level Procedure - Install and Enable Personal Capture
An Academic Staff user and System Administrator should work together to install and enable Personal Capture.
Some phases can only be done by a System Administrator. Others can be done by either the System Administrator
or the Academic Staff user, as shown in the following table.
Phase
Who can perform
Verify that the target computer supports Personal
Capture. See Recommended Hardware and Software.
Academic Staff user and/or System Administrator
Verify that the web camera is supported.
Academic Staff user and/or System Administrator
Install Personal Capture on the computer (laptop, tablet
or desktop).
Academic Staff user and/or System Administrator
Configure Personal Capture.
Academic Staff user and/or System Administrator
Page 160
EchoSystem 5 Documentation
Establish a user account for the Academic Staff user.
System Administrator
Assign the Academic Staff user to sections.
System Administrator
License the Academic Staff user for Personal Capture.
System Administrator
Learn how to make and post-process recordings
Academic Staff user AND System Administrators
System Administrators should review Personal Capture for System Administrators for further details.
Academic Staff users should review Personal Capture for Academic Staff for further details.
Personal Capture for System Administrators
In this section:
Capture Options
Package Options
Operating Systems
Recommended Hardware and Software
Deployment Considerations
Software Updates
Managing Personal Capture
Capture Options
Personal Capture has three capture options:
Audio. Internal, 1/8" input or USB microphone
Local screen. Screen displays with 4:3 aspect ratio provide the highest quality capture.
Web camera (webcam) video capture (internal and USB webcams). FireWire webcams are supported on a
limited basis for the initial release of Personal Capture. You receive additional FireWire webcam support
with Personal Capture updates.
DV cameras, video capture cards and VGA capture cards are not supported.
Package Options
Personal Capture has these packaging options producing viewable media for students:
Podcast - MP3 audio
Vodcast - M4V audio and motion display
Audio Rich Media - Flash-based audio and display (browser)
EchoPlayer - Flash-based audio, video and display (browser)
Operating Systems
See supported technologies for existing customers or new customers.
Recommended Hardware and Software
The table below provides hardware and software recommendations for the use of Personal Capture. We
Page 161
EchoSystem 5 Documentation
recommend that you use these because our tests showed them to be fully functional. You may certainly use other
devices, which may or may not be fully functional.
Intel Atom-based netbook computers are not currently powerful enough for Windows Media encoding. Personal
Capture for Windows is not supported on netbook computers.
OS
Windows. See Supported
Technologies.
Macintosh. See Supporte
d Technologies.
Hardware for audio and
display capture
Hardware for audio,
display, and webcam
video capture
Software
Single Core 2.0 GHz
processor
2 GB RAM
10/100 network
interface
20 GB free hard disk
space
Internal audio device or
USB port for audio
capture
Color quality: Highest
(32 bit)
Dual Core 1.8 GHz
processor
2 GB RAM
10/100 network
interface
20 GB free hard disk
space
Internal audio device or
USB port for audio
capture
Color quality: Highest
(32 bit)
Windows 7.
Intel Single Core 1.8
GHz processor
2 GB RAM
10/100 network
interface
20 GB free hard disk
space
Internal audio device or
USB port for audio
capture
Color quality: millions
Intel Dual Core 1.8 GHz
processor
2 GB RAM
10/100 network
interface
20 GB free hard disk
space
Internal audio device or
USB port for audio
capture
Color quality: millions
QuickTime 7.5.5 or later
(installed with OS X)
.NET
and
Windo
ws
Media
Encod
er
Install
ation
.NET
and
Windo
ws
Media
Encod
er are
installe
d by
the Pe
rsonal
Captur
e
installe
r.
Personal Capture has been tested on the web cameras listed in Supported Web Cameras. Echo360 recommends
standardizing on these web cameras as much as possible.
Page 162
EchoSystem 5 Documentation
Deployment Considerations
Networking
Personal Capture runs on the Windows or Mac platform and as such depends on the operating system network
support. It must be able to resolve the hostname of the EchoSystem Server (ESS).
Automated Installation and Imaging
Personal Capture for Windows is only provided as an EXE at this time. This may be deployed in an automated
installation, but also requires installation of Microsoft .NET Framework 2.0 and Windows Media Encoder 9 Series
with the image.
Personal Capture for Mac OS X is only provided as a DMG at this time. The application can be bundled as a PKG
for automated installations.
Licensing
Personal Capture is licensed on a per user basis.
Software Updates
Software updates are managed by the ESS. The Personal Capture application checks for software updates every
time it is opened (provided a network connection is available). If a newer version is found, click one of the following:
OK to download and install the update, Cancel to defer update for another time (Windows), Install to download and
install the update, or Not right now to defer update for another time (Mac). After the update has been installed, the
application is restarted and ready for use.
Managing Personal Capture
The Personal Capture application is managed differently than the other capture devices. The most notable
differences are:
Personal Capture is not registered with the ESS as a device.
Personal Capture licenses are applied to academic staff rather than rooms.
Personal Capture recordings and uploads are initiated by the academic staff user rather than automatically
through a schedule.
Supported Web Cameras
In this section:
Overview
Tested Webcams
Overview
Personal Capture (previously called EchoCapture Personal or PCAP) uses Windows Media Encoder (WME) to
recognize integrated web cameras (webcams) on laptops. WME does not recognize some webcams. When this
happens, Personal Capture does not function.
Page 163
EchoSystem 5 Documentation
Best Practice: Use a Tested Webcam
Use one of the tested webcams listed below. You can be sure that they work with Personal
Capture.
Echo360 continues to add support for additional webcams. You can attempt to use a webcam not listed. It may
work, even if it has not been tested. If the webcam fails, please enter a support request.
Best Practice: Use Current Drivers and the "Driver Only" Installation Method
To ensure the best possible captures and interoperability with WME, always use the most current
drivers for your webcam. You can find these drivers on the the website of your PC or laptop
manufacturer. You can also have the operating system of your computer search for current
drivers.
In most cases, webcam vendors allow for a "driver-only" installation of the camera software. We
recommend using this installation method if possible. Sometimes, the software included with the
webcam can interfere with the Personal Capture connection to the webcam. In some cases, the
"driver-only" method is the only supported method.
Ensure that there are no other software applications accessing the webcam while Personal Capture is running.
Tested Webcams
Windows
Most webcams with Windows XP/Vista driver support work with Personal Capture. Echo360 has tested the following
webcams:
Vendor
Model
Notes
Logitech
Quickcam Orbit AF
–
Logitech
Quickcam Pro 9000
–
Logitech
Quickcam Pro for Notebooks
–
Logitech
Quickcam Pro 5000
–
Logitech
Quickcam Pro 3000
–
Logitech
Quickcam Pro 4000
Does not work on Dell OptiPlex or
Toshiba DynaBook Satellite
systems
Microsoft
LifeCam VX-7000
Driver-only installation only
Winbook
WB-6120 WebCam
–
Page 164
EchoSystem 5 Documentation
HP
HP integrated camera
HP Mediasmart Webcam Software
Vendor
Model
Notes
Apple
Built-In iSight Camera (MacBook
and MacBook Pro)
Verified to work with MacBook and
MacBook Pro. May work with iMac
but has not been tested.
Logitech
QuickCam Vision Pro
USB camera
Blue
Eyeball Camera
USB camera
Macintosh
Install Personal Capture
In this section:
Overview
Download the Installer
Windows
Macintosh
Overview
To install EchoSystem Personal Capture, follow these phases:
1. Download the correct installer for your operating system
2. Launch the installer
Download the Installer
Download the Personal Capture (previously called EchoCapture Personal or PCAP) installer from the EchoSystem
Server (ESS) web interface.
1. Log in to the ESS.
2. Navigate to the Downloads tab. The Software Installer Downloads page appears as shown in the figure
below.
3. Download the installer by clicking the appropriate platform link.
The Windows link is for both Windows XP and Windows 7
The installer must be run locally
Save the file to the target computer
Page 165
EchoSystem 5 Documentation
Windows
Install on Windows
1. Double-click the saved installer file. The installation file uncompresses and runs automatically. The
installation file name is EchoSystemPersonalCaptureFor Windows32_(version).exe.
2. The installer detects if Microsoft .NET Framework 2.0 Service Pack 2 and Windows Media Encoder 9 Series
are installed on the machine. These applications are required for Personal Capture to function. If they were
detected as installed, you proceed directly to Personal Capture installation (step 4). Click Next to continue.
3. Microsoft .NET Framework 2.0 Service Pack 2 (plus related components) and Windows Media Encoder 9
Series are downloaded from the Microsoft website and installed. You may also need to restart the computer
during this step.
4. Once third-party software installation is complete, program information appears. Read through and click Next
to continue.
5. You are asked to confirm where setup should install files for the application. This is set to C:\Program
Files\EchoCapture Personal by default, but can be changed to another hard drive and/or directory if required.
Click Next.
6. Select the location where you would like to create a new program shortcut. This is added to the Program
Folder as EchoCapture Personal by default. Desktop and Quick Launch Toolbar shortcuts are also installed
at this time. Click Next.
7. The application is installed. Once complete, click Finish to run the application.
Uninstall from Windows
To remove Personal Capture from your computer:
1. Go to Start > Programs > All Programs > EchoCapture Personal.
2. Click the Uninstall EchoCapture Personal icon.
Macintosh
Install on Mac OS X
1. Double-click the saved installer file. The installation disk image (.dmg) is uncompressed and mounted
automatically. The installation file name is EchoSystemPersonalCaptureFor Mac_(version).jar.
2. Drag the Echo360 Personal Capture icon onto the Applications folder icon shortcut. Personal Capture is
installed to the Applications folder.
3. Optional: Open the Applications folder and drag the Echo360 Personal Capture icon onto the Dock to create
Page 166
EchoSystem 5 Documentation
3.
a shortcut.
Uninstall from Mac OS X
To remove Personal Capture, delete it from the Applications folder.
Configure Personal Capture
In this section:
Configure Personal Capture
Select the Recording Devices
Configure the Recording Devices
Configure Personal Capture
Configure Personal Capture(previously called EchoCapture Personal or PCAP) the first time you run the application.
Navigate to the appropriate menu, either Tools > Options... (Windows) or Echo360 Personal Capture > Preferenc
es... (Mac).
Set General Configuration
1. Select General.
2. Enter the Default presenter name. This name will be attached to recordings by default, but you can customize
the name later.
3. Enter the Recordings folder. Recordings will be stored in this folder. The default locations are:
Windows: C:\Documents & Settings\<username>\Local Settings\Application Data\Echo360\Personal
Capture\Recordings
Mac: /Users/<user>/Documents/Echo360/Personal Capture/Recordings/
To change the storage location, click Browse... (or Change...) and navigate to the desired directory.
4. Check or clear the Show welcome screen at startupbox.
If you check the box, you see the Welcome Screen at startup:
Page 167
4.
EchoSystem 5 Documentation
If you clear the box, you see the My Recordings screen at startup:
Set Server Configuration
Consult Your System Administrator
Your System Administrator should provide the information needed for this section.
1.
2.
3.
4.
Click Server.
Enter the Hostname / IP Address of the EchoSystem Server (ESS).
Select the connection protocol (HTTP or HTTPS).
Click Test connection. If you do not see The server settings are correct, contact your System
Administrator.
5. Click OK.
Page 168
EchoSystem 5 Documentation
Select the Recording Devices
1. Navigate to either the Welcome Screen or the My Recordings screen.
2. Click Start Recording.
3. Check the Enabled box for the devices you want to use. Although the audio device check box is grayed, it is
selected by default. Your voice will be recorded.
Configure the Recording Devices
A recording device may be grayed out (indicating that it is not available) or you may want to change the capture
source.
Follow these steps.
1. Click Configure.
2. You should see a list of devices that are plugged in and activated, such as a microphone, webcam, or
secondary monitor.
3. Configure the audio, screen, and video devices as desired.
4. When selecting video quality:
Page 169
EchoSystem 5 Documentation
4.
Select Actual Size (Lower Framerate) to optimize for on-screen (PowerPoint) presentations and web
browsing
Select Smaller Size (Higher Framerate) to optimize for webcam and video recording.
5. Click Save.
Manage the EchoCenter
In this section:
Overview
Enable EchoCenter Pages in the ESS
Enable EchoCenter Pages in Other Publishers
Train Academic Staff to Use the EchoCenter Page
Overview
What is EchoCenter?
EchoCenter is an alternative to publishing individual links of Echoes and supplemental materials. Although this
method ("individual link publishing") is still supported, you can also create an EchoCenter page (a course list page)
for each section:
This web-based page is a convenient, intuitive dashboard.
All materials (Echoes, media imports, and Personal Capture recordings) are grouped together by date and
lecture. This organization matches the syllabus and the mental model of students and Instructors.
Every section has its own EchoCenter page.
If you use RSS feeds with integrations, consider using an EchoCenter page instead. It provides a much better
interface for students and instructors. You should still use RSS feeds for podcasting and iTunes U.
You can use any of three methods to enable EchoCenter pages:
ESS method. Configure the EchoCenter functionality within the EchoSystem Server (ESS). See Enable
EchoCenter Pages in the ESS.
Integrated publishers method. You may already publish individual links and supplemental materials to
Blackboard or Moodle ("individual link publishing"). You can publish EchoCenter pages to Blackboard and
Moodle also ("EchoCenter publishing"). In EchoCenter publishing, the EchoCenter page appears on the
Blackboard or Moodle page for the section. See:
Blackboard Learning Management System Enterprise 9.1 - EchoCenter Publishing
Moodle - EchoCenter Publishing
Other publishers method. If you already publish to another learning management or course management
system (such as Angel), you can still embed EchoCenter page URLs in that LMS. See Enable EchoCenter
Pages in Other Publishers.
Standard and Collaboration Service Versions
You can deploy either the standard or Collaboration Service versions of EchoCenter pages. The Collaboration
Service version:
Offers different views to students and Instructors
Supports discussions in the EchoPlayer and EchoCenter page
Supports bookmarks in the EchoPlayer
Supports charts and student usage data in the EchoCenter page
Page 170
EchoSystem 5 Documentation
To deploy the Collaboration Service version, you must:
Subscribe to the Collaboration Service.
Support either LDAP Authentication or seamless login to authenticate credentials. Seamless login is
supported for two publishers, Blackboard and Moodle.
For Blackboard, see Blackboard Learning Management System Enterprise (7.3-9.1)
For Moodle, see Moodle - EchoCenter Publishing
The Standard EchoCenter Page
When a user's credentials are not authenticated, the user sees the standard EchoCenter page, as shown in the
figure below:
The standard EchoCenter page includes items such as the branding logo, a control that lets you expand or contract
the amount of data shown, lecture lists arranged and expandable by week, the duration (length) of each Echo listed,
Echoes and supplemental media, and scheduled lectures.
This EchoCenter page does not include charts, discussions, or student usage data.
Collaboration Service EchoCenter Pages
When a user's credentials are authenticated, there are two different views of the EchoCenter page:
The student view is visible to students, Student Presenters, and Guest Presenters
The Instructor view is visible to Instructors, Administrators, and Teaching Assistants
The student view of a Collaboration Service page looks like the figure shown below;
Page 171
EchoSystem 5 Documentation
Students can see Echoes, link for supplemental materials and discussions for a section. They do not see charts and
student usage data. From this page, students can:
Launch the Echo (in the EchoPlayer).
Download the Podcast or Vodcast.
View supplemental materials (Media Imports or Personal Capture recordings).
Collaborate with other students and the Instructor by participating in a discussion.
The Instructor view looks like the figure shown below:
Page 172
EchoSystem 5 Documentation
The Instructor view offers all the functionality of the student view. In addition, the Instructor view allows you to:
See student usage charts, usage data, and discussion statistics. This gives Instructors insight into how
students are learning course material.
Find specific topics within the lecture where there is a significant discussion, class-wide disagreement, or
confusion.
Participate in discussions. The discussions list is organized by lecture, and shows activity over the last seven
days.
Use Media Imports or Personal Capture to upload additional relevant material.
See EchoCenter for Academic Staff for details on the Instructor view.
Enable EchoCenter Pages in the ESS
Enabling EchoCenter pages consists of one required phase and two optional phases.
1. Required: Configure the EchoCenter in the parent or child organization. This is done by the System
Administrator, the parent organization Administrator, or a child organization Administrator. See EchoCenter.
If you configure the parent organization, settings are inherited by child organizations and sections
If you configure a child organization, settings are inherited by sections
2. Optional: Customize some aspects of the EchoCenter page by configuring settings in each section. This can
be done by an administrator or a Scheduler. You can customize all sections or just some. You can do these
customizations when you add the section.
3. Optional: Train Instructors to customize the descriptions for individual Echoes.
Required - Configure the EchoCenter and Other Settings in the Parent or Child Organization
1. Display the Organization Details page for either the parent or child organization.
a. Navigate to Configuration > Organizations.
b. Select the organization.
2.
Page 173
EchoSystem 5 Documentation
2. Configure EchoCenter settings. These settings control many aspects of the appearance of the EchoCenter
page.
3. Implement either standard or Collaboration Service EchoCenter pages by configuring the Security Module s
etting in the Security Settings group, as shown in the figure below.
a. To implement standard EchoCenter pages, select Allow All.
b. To implement Collaboration Service EchoCenter pages, select either LDAP or seamless login.
4. Optionally, add a logo. The logo that appears on the EchoCenter page is specified in the Player Logo Image
setting in the Branding group.
5. Click Save to close the Organization Details page.
6. After you complete this configuration, EchoCenter pages will appear automatically for each section.
You, the System or Organization Administrator, will see the URL for each EchoCenter page on the
Section Details page, as shown in the following figure:
These URLs are different from the URLs for individual Echoes, which appear on the Echo Details
pages.
7. Deploy the URLs to students and faculty using any of these methods:
If you use Blackboard Learn as a publisher and have enabled EchoCenter publishing, URLs appear on
the Blackboard pages.
If you use another publisher, you can enable EchoCenter pages by manually copy pasting or
embedding URLs on the EchoCenter pages.
If you send notifications via e-mail, continue to use that method. The EchoCenter page links are
included in the emails.
Optional - Configure Settings in Each Section
You can customize all sections or just some. This customization can be done when you add the section.
1. Display the Section Details page for the section.
a. Navigate to Schedule > Courses.
b. Click on the course name to display the Course Details page.
c. Click on the section name to display the Section Details page.
2. Except for the External System Id fields, all of the EchoCenter settings shown for the section are inherited
from the organization. Customize them for the section as necessary. See EchoCenter settings for the
organization for details on each setting.
3. The External System Id fields (the last two EchoCenter settings) are not inherited from the organization.
They appear only here, on the section page. You may want to customize these fields. See External System
IDs.
4. Click Done to close the Section Details page.
5.
Page 174
EchoSystem 5 Documentation
5. Enter a description for the Echoes. The text will appear underneath each Echo posted to the EchoCenter
page.
a. Navigate to Schedule > Schedules and edit the schedule for the section.
b. In the Course/Description area, enter a description, as shown in the figure below.
c. Click Save to close the Schedule page.
d. After the next scheduled capture occurs, check the description for the Echo. It should reflect the
changes you made.
Optional - Train Instructors to Customize Descriptions for Specific Echoes
You may have added a description for the section in the section's schedule. This description appears underneath
each Echo posted to the EchoCenter page.
Instructors may want to customize descriptions for specific Echoes. Demonstrate this procedure.
1. Log in as an Instructor.
2. Navigate to Echoes > Echoes.
3. Edit a sample Echo.
4. In the Description field, enter the text you want to display.
5. Click Save.
6. Wait 15-20 minutes.
7. Navigate to the EchoCenter page for the course.
8.
Page 175
EchoSystem 5 Documentation
8. Notice that the description for that specific Echo shows the text you entered, as shown in the figure below.
Enable EchoCenter Pages in Other Publishers
If you use a learning management system (LMS) that supports EchoCenter publishing, such as Blackboard or Moodl
e, use that method to enable EchoCenter pages.
EchoCenter Publishing Required with BlackBoard
You cannot use the copy-paste method described in this section to embed EchoCenter codes to
a BlackBoard page. You can use this method with Moodle, though we recommend using EchoC
enter publishing instead.
If you use an LMS other than BlackBoard or Moodle, you can still add EchoCenter page URLs on your LMS course
page using either of two methods:
The copy-paste method
The mass export method
Copy-Paste URLs and Embed Codes
You can copy-paste:
Just the URL
The URL with embed code that formats it for a course page
Do this once per section per academic term.
1. Navigate to the section details page.
a. Navigate to Schedule > Courses.
b. Click on the course link.
c. Click on the section link. The section details page appears, shown in the figure below.
2. Do one of the following:
Copy just the URL
Copy all of the text in the Embed Code field
3.
Page 176
EchoSystem 5 Documentation
3. Paste either the URL or the embed code in your LMS page for the section.
The Mass Export Method
You can use this method to export the URLs, but not the embed code.
See Example-Post EchoCenter Page URLs to an LMS.
Train Academic Staff to Use the EchoCenter Page
You will need to show Academic Staff how to:
1. Access their EchoCenter pages. Academic Staff receive EchoCenter links in different ways, depending on
your configuration. You can:
Include the link in the email announcing that media is ready to view
Integrate the EchoCenter to Blackboard or Moodle. See Blackboard Learning Management System
Enterprise 9.1 - EchoCenter Publishing or Moodle - EchoCenter Publishing.
Show Academic Staff how to find their sections in the ESS user interface. Clicking on the section
opens the EchoCenter page.
2. Understand the information on an EchoCenter page.
If you implemented Collaboration Service EchoCenter pages, Academic Staff members can click on an
embedded help button. They will see the instructions shown on the EchoCenter for Academic Staff pag
e.
If you did not implement the Collaboration and Statistics Service, you may want to post the EchoCente
r for Academic Staff page in an easily accessible location and urge Academic Staff to review it.
Delegate Administration
In this section:
Overview
About Hierarchies
Organizational Ownership
User Roles and Rights
Licensing
Overview
This page describes delegated administration and discusses relevant concepts. Review this page carefully before
deciding if you should implement delegated administration. See Implement Delegated Administration for
detailed implementation procedures.
You can create a two-level hierarchy that allows you to create individual organizations such as a school within your
university. You can then delegate some aspects of EchoSystem administration to the school. With delegated
administration, an individual school can create users, schedule rooms, and manage sections. It can also define its
own policies on such subjects as frequency of capture, the need for confidence monitoring, retention policies, and
many other topics. However, an individual school may not have the resources to perform system administration
operations, such as configuring the streaming server, configuring the web server, or configuring the file transfer
server. These can be handled by a university-level IT department that supports each individual school.
Page 177
EchoSystem 5 Documentation
Delegated Administration is Optional
You do not have to delegate administration. Delegating allows individual schools or departments
to customize the EchoSystem for their needs. If this customization is not of interest, do not create
individual organizations. All objects will be owned and managed by the parent organization.
About Hierarchies
A typical hierarchy mirrors the organizations in your institution that use EchoSystem, as demonstrated in the
diagram below:
This example hierarchy consists of one parent organization (your university) and three child organizations (the
law school, the medical school, and the business school). You can have only one parent organization but any
number of child organizations.
The parent organization need not be the university. If you want a more granular organization, you could have a
hierarchy like that shown in the following diagram, where the parent organization is the Engineering school, with
three child organizations representing the different disciplines (electrical, mechanical and civil):
You can create only one, two-level hierarchy per EchoSystem Server (ESS). You cannot create both of the
hierarchies illustrated above in a single ESS.
To add the organizations that create hierarchy, see Manage Organizations.
When you create a hierarchy, three other concepts become important:
Organizational ownership
Inheritance
User roles and rights
Organizational Ownership
Page 178
EchoSystem 5 Documentation
Objects are entities within the EchoSystem. With the addition of hierarchy, it is possible for organizations to own
objects. Owning an object means having the ability to schedule it, use it, or share it with another organization. Both
the parent organization and the child organizations can own objects and, in a typical configuration, both do.
However, certain objects can only be owned by the parent organization.
Some objects can have shared ownership:
When an object is shared, organizations other than the owner can schedule or use the object.
Only the owner can modify the properties of the shared object.
Objects owned by the parent organization are automatically shared with all child organizations.
Child organizations can own objects but cannot share them. Only the parent organization can share objects.
Rooms and courses are commonly shared:
Rooms. You might share a room when two different child organizations (say, the Engineering School and the
School of Arts and Sciences) use a room and want to be able to schedule courses for it. It is good practice for
the parent organization to own the room and share it.
Terms. If the term is the same among organizations it is good practice for the parent organization to own the
term and share it.
Courses, by contrast, are commonly owned by a single organization, so that school only can customize the course
and other schools cannot manage it.
The table below gives ownership details for all objects.
Object
Can be owned (and
shared) by parent
organization?
Can be owned by
child organization?
Can be batch
moved to another
Organization?
Comments
room
Yes
Yes
No
Rooms and capture
devices depend on
each other to
function. A room
and the device
assigned to a room
must be owned by
the same
organization. The
move operation will
check some
dependencies
before completing.
term
Yes
Yes
No
A term can be
owned by a child
organization but
cannot be moved to
another child
organization.
Page 179
EchoSystem 5 Documentation
device
Yes
Yes
Yes
Rooms and capture
devices depend on
each other to
function. A room
and the device
assigned to a room
must be owned by
the same
organization.
Devices can be
assigned to any
organization at
registration time.
The move operation
will check some
dependencies
before completing.
You can move many
devices at once by e
xporting or importing
rooms.
content security
module
Page 180
Yes
Yes
No
A content security
module can be
owned by a child
organization but
cannot be moved to
another child
organization.
EchoSystem 5 Documentation
media processor
Yes
Yes
No
Initially, all media
processors are
owned by the parent
organization.
Media processors
owned by the parent
organization share
the load for all child
organizations.
A media processor
owned by the child
organization
handles jobs only for
that child
organization.
A child organization
Admin can change
job priorities only for
media processors
owned by the child
organization.
publisher
Yes
Yes
No
A publisher can be
owned by a child
organization but
cannot be moved to
another child
organization.
course
Yes
Yes
Yes
Courses own
sections. If you
move a course from
one organization to
another, all related
sections move with
the course. When a
section moves,
certain other objects
move with it. See
the description of se
ction in this table for
details.
Page 181
EchoSystem 5 Documentation
branding asset
Yes
Yes
No
A branding asset
can be owned by a
child organization
but cannot be
moved to another
child organization.
section
Yes
Yes
Yes
Sections own
certain other
objects: schedules,
capture records, and
Echoes. When a
section moved to a
new organization, all
of these objects
move with it.
A capture record is
the unique record
for the specific
capture. It appears
in the Monitor tab
when the capture is
running and in the
logs after the
capture completes.
You can move many
sections to a new
organization at once
by exporting or
importing sections.
schedule
Yes
Yes
Yes
Echo
Yes
Yes
Yes
Page 182
Schedules are
owned by a section
and move with the
section. If you move
a section from one
organization to
another (from child
to child, from parent
to child, from child to
parent), the
schedule for the
section moves with
the section.
EchoSystem 5 Documentation
Echoes are owned
by a section. If you
move the section to
a different
organization,
Echoes move with
the section.
C
o
n
t
e
n
t
S
e
c
u
r
it
y
M
a
y
C
h
a
n
g
e
If
t
h
e
n
e
w
o
r
g
a
n
i
z
a
ti
o
n
h
a
s
Page 183
EchoSystem 5 Documentation
a
d
if
f
e
r
e
n
t
s
e
c
u
ri
t
y
m
o
d
u
l
e
,
u
s
e
r
s
m
a
y
n
o
t
b
e
a
b
l
e
t
o
a
c
c
e
s
s
E
c
h
o
e
Page 184
EchoSystem 5 Documentation
s
a
ft
e
r
a
m
o
v
e
.
A
ft
e
r
m
o
v
i
n
g
E
c
h
o
e
s
t
o
a
n
e
w
o
r
g
a
n
i
z
a
ti
o
n
,
c
h
e
c
k
t
h
e
Page 185
EchoSystem 5 Documentation
s
e
c
u
ri
t
y
m
o
d
u
l
e
t
o
e
n
s
u
r
e
t
h
a
t
t
h
e
r
e
q
u
ir
e
d
c
r
e
d
e
n
ti
a
l
s
h
a
v
e
n
't
c
h
Page 186
EchoSystem 5 Documentation
a
n
g
Page 187
EchoSystem 5 Documentation
e
d
.
campus
Yes
No
No
A campus cannot be
owned by a child
organization but the
child organization
Administrator can
add or edit a
campus when
adding a room.
building
Yes
No
No
A building cannot be
owned by a child
organization but the
child organization
Administrator can
add or edit a
building when
adding a room.
application security
module
Yes
No
No
The application
security module
supports querying
multiple LDAP
servers and trees.
See LDAP
Authentication.
license
Yes
No
No
All licenses are
owned by the parent
organization. Both
parent and child
organization
Administrators can
assign licenses to
venues and users.
We recommend that
Administrators
coordinate their
efforts to ensure
proper license
assignment.
trusted system
Page 188
Yes
No
No
--
EchoSystem 5 Documentation
user
Yes
No
Yes
All user objects are
owned by the parent
organization and
assigned access
rights to both parent
and child
organizations
through roles.
You can assign
many roles at once
by exporting or
importing users.
User Roles and Rights
When you create a hierarchy with a parent organization and child organizations, certain roles are associated with an
organization. Others are associated with a section. This distinction is important because organization roles are
defined on the User page in the ESS (Configuration > Users) but section roles are defined on the Section page ( S
chedules > Courses).
Rights "flow down". This means that the Admin at the parent organization level can make configuration choices for
any child organization. Say, for example, that the Admin at the parent organization has specified that the Days to
Keep Originals setting is 120 days. However, the business school is running short on storage space and the Admin
for the business school is on vacation. The parent organization Admin can change this setting for the business
school. The business school is lower in the hierarchy, so the parent organization Admin has access rights.
For details on the different roles and instructions on adding users, see Manage Users.
Licensing
A license is an object and, like all objects, a license owned by the parent organization is automatically shared with
child organizations. This means that any existing course, venue, or user can be assigned a license because it can
use the parent organization license.
On upgrade, all licenses are owned by the parent organization.
A license can be purchased by a child organization and used only for that child organization, but the license will
always be owned by the parent organization. Parent organization licenses are still shared and can still be used by a
child organization that has purchased its own license.
See Manage Licenses for details.
Implement Delegated Administration
Page 189
EchoSystem 5 Documentation
In this section:
Overview
Plan the Organizational Hierarchy
Plan Organizational Ownership
Plan User Roles
Add Child Organizations
Reassign Ownership of Objects
Reassign User Roles
Overview
Who can do this?
System Administrator
Admin of Parent Organization
You can follow this process to implement delegated administration in either of these circumstances:
New install. You are installing the EchoSystem Server (ESS) for the first time. You will be able to skip some
steps.
Upgrade. You have an existing ESS and are upgrading to a release that supports delegated administration.
Delegated administration is supported in EchoSystem 4.0 and later.
The implementation process described here assumed you have already:
1. Reviewed the relevant documentation.
2. Gained a thorough understanding of the concepts underlying delegated administration: organizations,
hierarchy, inheritance, object ownership.
3. Decided that you want to implement delegated administration.
4. Set up a test system.
5. Installed a release that supports delegated administration on that test system. Delegated administration is
supported in EchoSystem 4.0 and later.
6. Attended any training classes available or held discussions with Echo360 engineers.
Implementing delegated administration consists of these steps:
1.
2.
3.
4.
5.
6.
Plan the organizational hierarchy.
Plan organizational ownership.
Plan user roles.
Add child organizations.
Reassign ownership of objects. New installs can skip this step.
Reassign user roles New installs can skip this step.
Best Practices
1. Complete all of the planning steps before you begin implementation.
2. Create delegated administration on a test system and verify it before moving to a
production system.
Plan the Organizational Hierarchy
Delegated administration allows you to create a two-level hierarchy consisting of a parent organization and as many
child organizations as you like.
Page 190
EchoSystem 5 Documentation
List the child organizations you intend to create, such as:
Law School
Medical School
Business School
See About Hierarchies for discussion and examples.
Plan Organizational Ownership
The advantage of delegated administration is that child organizations can own objects (such as rooms, devices,
publishers, courses, or sections), configuring them and managing them as they like.
When you install EchoSystem 5 to an existing ESS installation, all objects are owned by the parent organization. In
this step, you list specific objects and decide which should be owned by child organizations. See Organizational
Ownership for details. Consider these guidelines:
Some objects can only be owned by the parent organization
Some objects can be owned by either the parent organization or a child organization
Some objects can be shared
See Organizational Ownership for discussion and examples.
Plan User Roles
If you install EchoSystem 5 to an existing ESS installation, you will find that:
Some users will be automatically reassigned to new roles
You will want to adjust the role assignments for other users, taking advantage of the new roles available
You will need to add some users to a section
As you review user roles, consider making adjustments such as these:
Add Organization Administrators. Existing System Administrators will remain System Administrators. You
may want to reassign some of these users to either the parent organization Administrator or child
organization Administrator role.
Reassign some Instructors to an auxiliary role. After the installation, users who had been Presenters will
have the Academic Staff role and the Instructor role for their sections. You may want to reassign some
Instructors to the Teaching Assistant or Guest Presenter roles.
Assign Instructors to a section. Former Presenters will become Instructors, but you may need to assign
them to sections.
Appoint a License Manager. You may want to assign a staff member the new role of License Manager. It is
typical for an organization Administrator to also have the role of License Manager.
See Manage Users for discussion and examples.
Add Child Organizations
See Add a Child Organization.
Reassign Ownership of Objects
New installs can skip this step.
Follow this order to ensure a smooth process.
Page 191
EchoSystem 5 Documentation
1. Reassign courses. You can reassign many courses to a child organization efficiently by using the export and
import feature. See Export and Import Objects. You do not need to reassign sections, schedules, and
Echoes. These reassignments occur automatically when you reassign the course.
2. Reassign rooms. If you have only a few rooms to reassign to new organizations, you can edit the room
details. If you have many rooms to reassign, use the export and import feature. The devices associated with a
room are automatically reassigned when you reassign the room.
3. Reassign devices. You can reassign devices in two ways. First, when you reassign a room, the device
associated with the room is also reassigned. Second, if a device is not associated with a room, you can
associate it by editing the Current Room Assignment setting.
4. Reassign security modules. A security module is typically shared, but you can reassign it by editing the
security module details. Navigate to System > Security and edit the security module.
5. Reassign media processors. Edit the media processor details. Navigate to Configuration > Devices and
edit the media processor.
6. Reassign publishers. Edit the publisher details. Navigate to Configuration > Publishers and edit the
publisher.
Reassign User Roles
New installs can skip this step.
Organizational user roles can be reassigned efficiently by using the export and import features with a spreadsheet
program such as Excel. See Export and Import Objects. You can use this feature to assign the Academic Staff role.
After you assign the Academic Staff role to a user, you will probably want to assign a section role (Instructor, Guest
Presenter, Student Presenter, Teaching Assistant). These roles must be assigned role by role. See People and
Section Roles.
Manage Organizations
In this section:
Overview
Edit the Parent Organization
Add a Child Organization
Edit a Child Organization
Delete a Child Organization
Overview
Since EchoSystem 4.0, you have had the ability to implement a hierarchy of parent and child organizations
("delegated administration"). The parent organization, typically the university, is established automatically when you
install EchoSystem 4.0 or higher.
If you are upgrading to the current release from EchoSystem 4.0 or later, you should have already adjusted
your configuration to work with delegated administration.
If you are upgrading to the current release from EchoSystem 3.0 or earlier, see Delegate Administration for
background on this feature. Even if you decide not to implement it, see the "Roles and Privileges" section of
the EchoSystem 4.0.2011-06-28.1 Release Notes for instructions on adjusting your configuration to work with
delegated administration.
You can also establish child organizations, which are often component schools such as the School of Nursing. Once
you have child organizations, they can own rooms, devices, and other objects.
Child organizations initially inherit all of the settings of the parent but you can customize those settings.
Page 192
EchoSystem 5 Documentation
Customization allows an individual school to define its own policies on such subjects as frequency of capture, the
need for confidence monitoring, retention policies, and many other topics.
You can have two hierarchical levels: parent and child. You can have only one parent but any number of child
organizations.
You Cannot Delete the Parent Organization.
If you are the System Administrator or the Admin of the parent organization, you can edit the
parent organization's details or add a child organization to it. You cannot delete it.
Edit the Parent Organization
Who can do this?
System Administrator
Admin of Parent Organization
The parent organization's settings are specified automatically when it is created, but they can be edited. These
customized settings become the default settings for child organizations.
1. Navigate to Configuration > Organizations. The Organizations page appears.
2. Select the parent organization. Buttons appear in the highlighted row. The parent organization is selected in
the example below.
3. Click edit. The Edit Organization – Parent Name page appears.
4. Modify settings. See Organization Default Settings for details.
Add a Child Organization
Who can do this?
System Administrator
Admin of Parent Organization
1. Navigate to Configuration > Organizations. The Organizations page appears as shown in the figure below.
Page 193
EchoSystem 5 Documentation
2. Click Add. The Add Organization page appears, as shown in the figure below, showing the settings inherited
from the parent organization.
Page 194
EchoSystem 5 Documentation
Page 195
EchoSystem 5 Documentation
3. Review the settings, which are inherited from the parent organization.
4. As needed, customize the settings. For example, if you wanted to display the child organization's logo in the
EchoPlayer, you would change the Player Logo Image setting. You might also customize the Player Logo
Hover Text and Player Logo Click URL settings. See Organization Default Settings for details.
5. Click Save.
Edit a Child Organization
Who can do this?
System Administrator
Admin of Parent Organization
Admin of Child Organization (that is being edited)
1. Navigate to Configuration > Organizations. The Organizations page appears.
2. Select an organization to edit. Buttons appear in the highlighted row, as shown in the figure below.
Page 196
EchoSystem 5 Documentation
3. Click edit. The Edit Organization – Parent Name / Child Name page appears.
4. Review the settings, which are inherited from the parent organization.
5. As needed, customize the settings. For example, if you wanted to display the child organization's logo in the
EchoPlayer, you would change the Player Logo Image setting. You might also customize the Player Logo
Hover Text and Player Logo Click URL settings. See Organization Default Settings for details.
6. Click Save.
Delete a Child Organization
Who can do this?
System Administrator
Administrator of Parent Organization
Administrator of Child Organization (that is being deleted)
1. Navigate to Configuration > Organizations. The Organizations page appears.
2. Select an organization to delete. Edit and delete buttons appear in the highlighted row. You can only delete
organizations that are not associated with rooms, courses, and other entities. To delete an organization, you
must delete those entities first.
3. Click delete. A confirmation dialog box appears.
4. Confirm that you want to delete the child organization by clicking Yes. The child organization is removed from
your EchoSystem Server (ESS).
LDAP Authentication
In this section:
Overview
Directory Systems Supported
Network Requirements
Enable LDAP Authentication
Overview
LDAP (Lightweight Directory Access Protocol) allows you to use a single central source to authenticate user
credentials. You can integrate the EchoSystem with LDAP so all users are authenticated. These users might be:
Page 197
EchoSystem 5 Documentation
System users who access the EchoSystem Server (ESS)
Content creators who access ad-hoc capture or Personal Capture
Students who review content already created
The distinction between system users and content users is important because, though you create a single security
module, it exists as two instances:
As the system instance, it authenticates users logging in to the administration interface
As the content instance, it authenticates Academic Staff and students logging in to either create or review
content
The security module supports:
Automatic searches of sub-trees. The EchoSystem searches up to three different LDAP authentication
trees and any number of sub-trees within each tree.
Multiple tree failover up to three trees. If the EchoSystem does not find the user's credentials in the first
tree searched, it searches two more trees.
Fallback to the ESS database. If the user's credentials are not found in any of the LDAP trees, the
EchoSystem searches its internal database. If the user's credentials are still not found, the EchoSystem
refuses access.
Security over SSL. SSL, the Secure Sockets Layer protocol, provides transport security that prevents an
interloper from reading traffic.
Directory Systems Supported
The EchoSystem LDAP feature is compatible with the following directory systems:
OpenLDAP 2.3
Microsoft Active Directory & AD Lightweight Directory Service
Mac OS X Open Directory
LDAP and Ad-Hoc Interface
Disabling HTTPS for either the appliance or Classroom Capture ad-hoc interface passes LDAP
credentials in clear text.
Network Requirements
LDAP communications use port 389 for insecure transport and port 636 for secure transport over SSL/TLS.
Enable LDAP Authentication
Overview
Enabling LDAP authentication consists of three phases.
1. Create the security module
2. Test the security module
3. Deploy the security module
There are two types of security modules:
The LDAP security module, which is more common, is for general use. This section concerns the LDAP
security module.
Page 198
EchoSystem 5 Documentation
The seamless security module used with the seamless login (trusted system) restricts access to Echo content
in an external system such as the Blackboard Learning System and Moodle.
For details on implementing in Blackboard, see Blackboard Learning Management System Enterprise
(7.3-9.1).
A trusted system (seamless login) must be implemented for the Moodle 2.x integration. (It is optional
for Moodle 1.9.x.) See Moodle - EchoCenter Publishing for details.
One part of creating the security module is configuring the tree definition fields. These fields determine how the ESS
connects to the LDAP directory and what criteria are considered when a user provides credentials. The ESS
searches up to three different trees, which can reside on the same or different LDAP servers.
Create the Security Module
See Create the Security Module.
Test the Security Module
Each security module contains a section to test your configuration based on a specific user's credentials. Follow
these steps.
1. In the ESS, navigate to System > Security.
2. Click on the label of the module you would like to test.
3. Repeat the following steps for each user to be tested:
a. Enter a user name in the User Name field.
b. Enter that user's password in the Password field.
c. Click Test LDAP Configuration.
d. Look for a success message.
Deploy the Security Module
After you create and test a security module, deploy it.
When deployed as a content security module, a student must log in against the LDAP criteria before viewing
the presentation.
When deployed as a application security module, users must log in against the LDAP criteria before
accessing the ESS administration interface.
Content and application security modules are deployed differently because they affect different parts of the system.
Deploy a Content Security Module
Follow these steps.
1.
2.
3.
4.
5.
6.
7.
8.
Log in as an Administrator.
Navigate to the Schedule > Courses page.
Click on the name of a course containing a section where the content security module should be deployed.
Point to the section.
Click the edit button that appears.
In the Security Settings section, select the content security module from the Security Module box.
Notice that additional fields appear with names similar to those on the module configuration page.
Complete these optional section-level overrides to allow or disallow access based on the section an Echo
belongs to.
9. Save the section.
Page 199
EchoSystem 5 Documentation
Deploy an Application Security Module
When you deploy an application security module, you can enable fallback to the ESS database and also allow ESS
users to log in to view content.
Follow these steps.
1.
2.
3.
4.
Log in as an Administrator.
Navigate to System > System Settings.
In the Application Security section, select the application security module from the Security Module box.
Optionally, select Enable Fallback to Internal ESS Database and Allow ESS users to login to view
content. See Application Security.
5. Click Save.
Export and Import Objects
In this section:
Overview
Import Objects from Another System to the ESS
General Procedure-Export Objects
General Procedure-Edit the Spreadsheet
General Procedure-Import Objects
Example-Move Courses to a New Organization
Example-Add New Rooms
Example-Edit Existing Users
Example-Post EchoCenter Page URLs to an LMS
Overview
The export/import feature lets you export the properties for certain objects to a spreadsheet, edit those properties,
and import them. This is an efficient way to:
Add many objects all at once
Change properties of many objects all at once
Extract the properties of many objects to a spreadsheet for further manipulation
You might use this feature when:
Your institution has built a new, fully equipped lecture hall. You need to add many new rooms. This is an ad
d many operation.
You have added organizations to allow delegated administration. Many objects (courses, sections, rooms,
users) that had been owned by the parent organization (the university) should now be owned by a particular
child organization, such as the law school. This is an edit many operation.
You want to post the EchoCenter URL of many sections to your learning management system (LMS), but use
an LMS that is not integrated with the EchoSystem Server (ESS). You can extract the URLs to a spreadsheet
then copy-paste them to your LMS. This is an extract operation.
You can do these operations efficiently by using the export and import features with a spreadsheet program such as
Excel. You can add or edit certain properties for:
Courses
Sections
Rooms
Users
Page 200
EchoSystem 5 Documentation
You must logged in as a System Administrator or the Administrator of the parent organization to use this feature.
When you export or import objects, all objects of that type (all courses, all sections, all rooms) are exported. Export
cannot be limited by organization. That is why only System Administrators or parent organization Administrators (but
not child organization Administrators) can use this feature.
The basic steps are the same for all operations.
1. Export existing objects. Do this even if you are doing an add many operation because it gives you a
properly formatted spreadsheet.
2. Edit the spreadsheet.
3. Import the spreadsheet.
Import Objects from Another System to the ESS
You may want to import many records from another system into the ESS. In this case, you need to know the proper
format for the.csv file so you can format the file from the other system properly.
For
See
Courses
CSV Import Format for Courses
Sections
CSV Import Format for Sections
Rooms
CSV Import Format for Rooms
Users
CSV Import Format for Users
General Procedure-Export Objects
This procedure shows how to export users. Adapt this process to export other objects: courses, sections, or rooms.
1.
2.
3.
4.
Navigate to Configuration > Users.
Scroll to the bottom of the page.
Click Export.
The user records are exported to a spreadsheet named person-<num>.csv. If you have a spreadsheet
program installed, it opens automatically.
General Procedure-Edit the Spreadsheet
1. Follow these best practices to reduce the possibility of errors:
Adjust the cell margins so you can easily see the content of each cell.
Sort the spreadsheet so the relevant cells display at the top of the page.
For add many operations: clear the existing data cells, but preserve row 1, the heading cells.
2. Enter and edit data.
If you change an object's organization, see Inheritance When You Change an Object's Organization.
In the example shown below, David Goodwin, who had been Academic Staff for the university,
becomes Academic Staff for the engineering school and a Scheduler for CLP. Gilda Good, who had
been a Scheduler for the university, becomes a Scheduler for the engineering school.
3. Save the edited spreadsheet.
Page 201
EchoSystem 5 Documentation
General Procedure-Import Objects
This procedure shows how to import users. Adapt this process to import courses, sections, or rooms.
This procedure assumes you have already exported objects and edited the spreadsheet. You must have a properly
configured spreadsheet to import.
1.
2.
3.
4.
5.
6.
7.
Navigate to Configuration > Users.
Scroll to the bottom of the page.
Click Import. The Import Users screen appears.
Review the help text. Make sure your import file is properly configured.
Click Browse.
Select the import file.
Click Import. The file is imported and processed. Results of the import appear in the field at the bottom of the
screen.
8. Review the results.
9. Notice in the example below that two users were not updated because the import file was not properly
configured.
10. Scroll to the bottom of the results field to review the summary. In the figure below, notice that the two users
edited in the procedure above, David Goodwin and Gilda Good, were updated.
11. Decide if you need to edit the import file and re-import. You may want to copy the results to an editor
(Notepad, TextEdit) or make notes about edits required.
12. Click Done.
13. If you like, check one or two user profiles to see the effect of the imports. The below example shows the user
profiles for David Goodwin and Gilda Good.
Example-Move Courses to a New Organization
Page 202
EchoSystem 5 Documentation
In this example, you move a course to another organization. Sections, schedules, and Echoes associated with the
course move to the other organization.
This example follows the general procedures outlined above.
1. Export the courses.
a. Navigate to Schedule > Courses.
b. Scroll to the bottom of the page.
c. Click Export Courses.
d. The course records are exported to a spreadsheet named course-<num>.csv, as shown in the
example below. If you have a spreadsheet program installed, it opens automatically.
2. Edit the spreadsheet. See General Procedure-Edit the Spreadsheet for details and best practices.
You can change the course name, Identifier, and Organization.
In the example shown below, Blended Learning is moved from Echo360, the parent organization, to
the School of Arts and Sciences. The Identifier changes from ECH101 to EDU201.
3. Import the edited spreadsheet, adapting the general procedure on importing.
Example-Add New Rooms
When you move a room to another organization:
Devices associated with the room move to the other organization
If a schedule is associated with the room, the schedule is no longer accessible to the originating organization
after the change. The import fails for that room. To avoid this failure, remove the room from the schedule
before moving the room.
This example shows how to add new rooms. For each room, you specify:
Campus
Building
Room
Organization
This example follows the general procedures outlined above.
1. Export the rooms.
a. Navigate to Configuration > Rooms.
b. Scroll to the bottom of the page.
c. Click Export.
d. The room records are exported to a spreadsheet named room-<num>.csv. If you have a spreadsheet
program installed, it opens automatically.
2. Edit the spreadsheet. See General Procedure-Edit the Spreadsheet for details and best practices. The
example below shows an edited spreadsheet ready to be imported.
Page 203
2. 5 Documentation
EchoSystem
3. Import the edited spreadsheet, adapting the general procedure on importing.
Example-Edit Existing Users
This example shows how to edit existing users. When you export and import users you can edit:
Last name.
First name.
E-mail address.
User name.
Password. Passwords are only required for new administrative users, users who require an updated
password, or for organizations not using LDAP. In most cases, you can leave the field blank.
Organization.
Role. If a user is assigned two roles, you can change either or both roles. If a user is not assigned a role, you
can add up to two roles.
You can add or change organization roles via import/export, but not section roles. You can, for example, add an
individual to the organization in the Academic Staff role, but you cannot make her an Instructor for a particular
section. To make someone an Instructor, you edit the People and Section Roles setting for the section.
To export and import users, follow the general procedures above.
1. Export users.
2. Edit the spreadsheet. See General Procedure-Edit the Spreadsheet for details and best practices.
3. Import users.
Example-Post EchoCenter Page URLs to an LMS
You do not need to export section properties in order to move a section to a new organization. The section moves
with the course when you move the course.
You might, however, want to use export and import to post EchoCenter URLs to your LMS.
You do not have to use this method if your LMS is Blackboard Learn or Moodle. You can configure either of these
learning management systems so EchoCenter URLs post automatically. However, if you are using another LMS,
you must copy the URL from the section details page, shown in the below figure, and paste it to the LMS course
page.
This can be tedious if you have many URLs to post. You may prefer the method described here: exporting the URLs
to a spreadsheet and then copy-pasting to the LMS course page from the spreadsheet.
1. Export the sections.
a. Navigate to Schedule > Courses.
b.
Page 204
1. 5 Documentation
EchoSystem
b. Scroll to the bottom of the page.
c. Click Export Sections.
d. All sections for all courses are exported to a spreadsheet named section-<num>.csv. If you have a
spreadsheet program installed, it opens automatically.
2. Copy-paste the URLs from the spreadsheet to the LMS.
CSV Import Format for Courses
In this section:
Format
Special Field Descriptions
CSV Example
Format
Importing users into the EchoSystem Server (ESS) requires that you create a file called COURSE.CSV that should
have the following attributes:
There is one course record per line of the file
The first line of the file should have the column names, as shown in the examples below
Each record value is separated by a comma
The column headers and field values are as follows:
column name
Course Name
Identifier
Organization
field value
UTF-8 ascii 128 chars
UTF-8 ascii 50 chars
see below
Special Field Descriptions
Organization names are comprised of two components:
Organization name
Suborganization name (if applicable)
They are separated by a sequence of "<space><forward slash><space>" like this: " / "
A valid organization would look like these examples:
Organization / suborganization
University
University / math-department
University / nursing-school
CSV Example
Following is an example of the format for this file:
Page 205
EchoSystem 5 Documentation
Course Name,Identifier,Organization
Collaboration - Playground I,CTC120,echo360
/ Area52
lmi- 5 min Tests,lmi-5min,echo360 / LMI
Calculus I,MTH120,echo360 / echoEngage
lmi-10 min Testing,lmi-ht,echo360 / LMI
First Course,lmi-fc,echo360 / LMI
Course C: adhoc test,CRS103.A,echo360
ddddd,aa,echo360
Calculus II,MTH220,echo360
Course A: pcap test,CRS101.P,echo360
JBell Test Course,JB101,echo360
aptus course,ASLPL,echo360 / aptus
aptus - Test Course 1,ATC100,echo360 / aptus
Area51 - EchoCenter Test,ECT100,echo360 /
Area51
Area51 - Scheduled Cap Test 1,SCT100,echo360
/ Area51
Course D: scap test,CRS104.S,echo360
qqqqqq,qqqqqqqqqq,echo360 / echoEngage
Collaboration - Playground II,CPG200,echo360
/ Area52
???? 1,125487,echo360 / LMI
CSV Import Format for Sections
In this section:
Required Configuration
Format
CSV Example
Required Configuration
Page 206
EchoSystem 5 Documentation
Before you can import sections into the EchoSystem Server (ESS), you must have courses already defined. The first
required field of the sections import is the unique course identifier, and these match to a pre-existing course.
The "email" fields in SECTION.CSV must match one of the pre-existing users in the ESS. Users who are specified
in the email fields of SECTION.CSV but do not have the Academic Staff role in the section's organization will be
assigned the role.
Format
Importing sections into the EchoSystem Server requires that you create a file called SECTION.CSV that should
have the following attributes:
There is one user record per line of the file
The first line of the file should have the column names, as shown in the examples below
Each record value is separated by a comma
The column headers and field values are listed in the below table:
column name
Value
Description
Course-ID
UTF-8 ascii, N chars
The unique IDs defined in the ESS
for the Courses (which must
pre-exist). The easiest way to get
this data is to export the
COURSE.CSV file, or to create your
own COURSE.CSV and import that
immediately before this
SECTION.CSV file.
Section-Name
UTF-8 ascii, 128 chars
The plain-text name that you want
to show to users in the ESS and in
recordings.
Term-Name
UTF-8 ascii, N chars
Must match a pre-existing term
name
Section-URL
UTF-8 ascii, N chars
Must be blank. Will be ignored if not
blank.
External-System-ID1
UTF-8 ascii, 2048 chars, optional
The unique identifier for this section
in your LMS. EchoSystem will use
this to publish presentation links to
the correct section.
External-System-ID2
UTF-8 ascii, 2048 chars, optional
A second unique identifier for this
section in your LMS. EchoSystem
will use this to publish presentation
links to the correct section.
Page 207
EchoSystem 5 Documentation
Email-Instructor1
UTF-8 ascii, N chars
A pre-existing User that will be
associated with this section as an
instructor.
Email-Instructor2
UTF-8 ascii, N chars, optional
A pre-existing User that will be
associated with this section as an
instructor.
Email-Teaching-Assistant1
UTF-8 ascii, N chars, optional
A pre-existing User that will be
associated with this section as a
Teaching Assistant.
Email-Teaching-Assistant2
UTF-8 ascii, N chars, optional
A pre-existing User that will be
associated with this section as a
Teaching Assistant.
Email-Guest-Presenter1
UTF-8 ascii, N chars, optional
A pre-existing User that will be
associated with this section as a
Guest Presenter.
Email-Guest-Presenter2
UTF-8 ascii, N chars, optional
A pre-existing User that will be
associated with this section as a
Guest Presenter.
Email-Student-Presenter1
UTF-8 ascii, N chars, optional
A pre-existing User that will be
associated with this section as a
Student Presenter.
Email-Student-Presenter2
UTF-8 ascii, N chars, optional
A pre-existing User that will be
associated with this section as a
Student Presenter.
CSV Example
Following is an example of the format for this file:
Course-ID,Section-Name,Term-Name,Section-URL
,External-System-ID1,External-System-ID2,Ema
il-Instructor1,Email-Instructor2,Email-Teach
ing-Assistant1,Email-Teaching-Assistant2,Ema
il-Guest-Presenter1,Email-Guest-Presenter2,E
mail-Student-Presenter1,Email-Student-Presen
ter2
ASLPL,Aptus section,aptus
Page 208
EchoSystem 5 Documentation
term,http://server.compute-1.university.edu:
8080/ess/portal/section/00da449e-39ef-4b63-9
5dc-393736b91638,,,uday@echo360.com,,babu@ec
ho360.com,,pavan@echo360.com,echo.instructor
@echo360.com,naveen@echo.com,
ASLPL,Apt section,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/0dba4d4e-ec9d-4995
-ab91-a90bfd902745,,,uday@echo360.com,,babu@
echo360.com,,pavan@echo360.com,echo.instruct
or@echo360.com,naveen@echo360.com,
aa,aaa,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/23df82f0-492c-49a1
-9b4b-63f6c4fc0578,,,,,,,,,,
lmi-fc,222-???? ????,LMI - Summer
2011,http://server.compute-1.university.edu:
8080/ess/portal/section/267e4c74-b9a1-479a-8
3c8-f09e9440a07d,,,arabic.instructor@tpingle
.org,,tpingle@echo360.com,,,,,
ASLPL,section,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/2f50783e-8ccc-46f3
-9908-d5a1c3400896,,,uday@echo360.com,,babu@
echo360.com,,pavan@echo360.com,echo.instruct
or@echo360.com,naveen@echo360.com,
CTC120,EET120.001,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/31c60304-10d6-4426
-9873-25a52de239ce,,,echo.instructor@echo360
.com,,,,,,,
Page 209
EchoSystem 5 Documentation
CRS104.S,CRS104.S.001,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/CRS104.S.001,CRS10
4.S.001,,echo.instructor@echo360.com,,echo.a
ssistant@echo360.com,,echo.presenter@echo360
.com,,echo.student@echo360.com,
125487,ss,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/3f9b8d01-8e30-4b68
-a623-8751e0f1df78,,,echo.assistant@echo360.
com,,,,,,,
lmi-ht,111-allowall,LMI - Summer
2011,http://server.compute-1.university.edu:
8080/ess/portal/section/4209d56a-e0ab-468e-b
325-a66ecb1e8d85,,,tpingle@echo360.com,,,,,,
,
lmi-5min,222,LMI - Summer
2011,http://server.compute-1.university.edu:
8080/ess/portal/section/4649348c-fab5-4361-b
837-2a56b60b6bc6,,,tpingle@echo360.com,,,,,,
,
lmi-5min,111-allowall,lmi2-Summer2011,http:/
/server.compute-1.university.edu:8080/ess/po
rtal/section/511ef7c8-9888-4cd3-bf15-5dbd997
e8816,,,tpingle@echo360.com,,,,,,,
ATC100,ATC100.001,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/7ef11cb8-0b9b-40d4
-b53c-14c165048866,,,echo.instructor@echo360
.com,,,,echo.presenter@echo360.com,,,
JB101,JBell Section,echo.Summer
Page 210
EchoSystem 5 Documentation
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/91d81766-8857-427f
-8251-928ddd440294,,,echo.instructor@echo360
.com,,,,,,,
SCT100,SCT100.001,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/SCT100.001,,SCT100
.001,ns.instructor@echo360.com,,echo.assista
nt@echo360.com,,,,,
CRS104.S,CRS104.S.002,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/CRS104.S.002,CRS10
4.S.002,,echo.instructor@echo360.com,,,,echo
.presenter@echo360.com,,echo.student@echo360
.com,
CRS103.A,CRS103.A.001,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/aff0c7b3-ecad-4efe
-90f9-c62f8e6d2cc0,,,echo.instructor@echo360
.com,,,,,,,
SCT100,SCT100.001.2,Area51.Summer
2011,http://server.compute-1.university.edu:
8080/ess/portal/section/SCT100.001,,SCT100.0
01,ns.instructor@echo360.com,,echo.assistant
@echo360.com,,,,,
ECT100,ECT100.001,Area51.Summer
2011,http://server.compute-1.university.edu:
8080/ess/portal/section/ECT100.001,ECT100.00
1,,ns.instructor@echo360.com,,,,echo.present
er@echo360.com,,echo.student@echo360.com,
ATC100,ATC100.001,aptus
Page 211
EchoSystem 5 Documentation
term,http://server.compute-1.university.edu:
8080/ess/portal/section/cd414b3a-b3dd-4ddb-b
e73-2ab0bb27cf5f,,,echo.instructor@echo360.c
om,,,,echo.presenter@echo360.com,,,
lmi-ht,111-allowall,lmi2-Summer2011,http://s
erver.compute-1.university.edu:8080/ess/port
al/section/cda30770-f1df-4045-b9ab-66f04cf7a
610,,,lingle@echo360.com,,,,,,,
SCT100,SCT100.002,Area51.Summer
2011,http://server.compute-1.university.edu:
8080/ess/portal/section/SCT100.002,SCT100.00
2,,ns.instructor@echo360.com,,,,,,,
ECT100,ECT100.001,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/ECT100.001,ECT100.
001,,ns.instructor@echo360.com,,,,echo.prese
nter@echo360.com,,echo.student@echo360.com,
CRS101.P,CRS101.P.001,echo.Summer
2011.1,http://server.compute-1.university.ed
u:8080/ess/portal/section/e0c9b6f5-4b46-4a61
-bfaf-ab4f781f6281,,,echo.instructor@echo360
.com,,,,,,,
CPG200,CPG200.001,Area52.Summer 2011
,http://server.compute-1.university.edu:8080
/ess/portal/section/CPG200.001,CPG200.001,,e
cho.instructor@echo360.com,,echo.assistant@e
cho360.com,,,,,
lmi-fc,111-russian,LMI - Summer
2011,http://server.compute-1.university.edu:
Page 212
EchoSystem 5 Documentation
8080/ess/portal/section/ee7fd91b-4b7d-4558-a
db3-58059fcc5bcf,,,russian_instructor@ingle.
org,,tpingle@echo360.com,,,,,
CSV Import Format for Rooms
In this section:
Format
Special Field Descriptions
CSV Example
Format
Importing users into the EchoSystem Server (ESS) requires that you create a file called ROOM.CSV that should
have the following attributes:
There is one room record per line of the file
The first line of the file should have the column names, as shown in the examples below
Each record value is separated by a comma
The column headers and field values are as follows:
column name
Campus-Name
Building-Name
Room-Name
Organization
field value
UTF-8 ascii 50
chars
UTF-8 ascii 50
chars
UTF-8 ascii 50
chars
see below
Special Field Descriptions
A new campus will be created if there is no pre-existing campus identified by "Campus-Name".
A new building will be created if there is no pre-existing building identified by "Building-Name".
Organization names are comprised of two components:
Organization name
Suborganization name (if applicable)
They are separated by a sequence of "<space><forward slash><space>" like this: " / "
A valid organization would look like these examples:
Organization / suborganization
University
University / math-department
University / nursing-school
CSV Example
Page 213
EchoSystem 5 Documentation
Following is an example of the format for this file:
Campus-Name,Building-Name,Room-Name,Organiza
tion
university.Campus,university.Building,univer
sity.Appliance (lv's cube),echo360 /
university
university.Campus,university.Building,univer
sity room,echo360 / university
university.Campus,university.Building,Room
with appliance,echo360 / university
area51.Campus,area51.Building,Arabic2,echo36
0
area51.Campus,area51.Building,area51.Applian
ce(ns' cube),echo360 / Area51
area51.Campus,area51.Building,area51.Softwar
e (ns' cube),echo360 / Area51
echo.Campus,echo.Building,Bell Test
Room,echo360
echo.Campus,echo.Building,echo.Appliance@jr'
sCubedd,echo360
echo.Campus,echo.Building,echo.Appliance@ns'
Cube,echo360
echo.Campus,echo.Building,echo.SafeCaptureHD
@poland,echo360
echo.Campus,LMI Building of Domination,Room
of Ultimate Learning,echo360 / LMI
echoEngage.Campus,echoEngage.Building,echoEn
gage.Room 1,echo360 / echoEngage
CSV Import Format for Users
Page 214
EchoSystem 5 Documentation
In this section:
Format
Special Field Descriptions
CSV Example
Format
Importing users into the EchoSystem Server (ESS) requires that you create a file called PERSON.CSV that should
have the following attributes:
There is one user record per line of the file
The first line of the file should have the column names, as shown in the examples below
Each record value is separated by a comma
The column headers and field values are as follows:
column
name
Last-Na
me
First-Na
me
Email
User-Na
me
Passwor
d
Organiz
ation-Rol
e-Name
1
Organiz
ation-Rol
e-Name
2
(optional
)
Organiz
ation-Rol
e-Name
3
(optional
)
Organiz
ation-Rol
e-Name
4
(optional
)
field
value
UTF-8
ascii 50
chars
UTF-8
ascii 50
chars
UTF-8
ascii 128
chars
UTF-8
ascii 50
chars
UTF-8
ascii any
number
of chars
see
below
see
below
see
below
see
below
Special Field Descriptions
The Password field is applicable only for a new user and cannot be set/updated for existing users.
Organization role names are comprised of two components, separated by a semicolon:
Organization name and sub organization name (if applicable), separated by a sequence of "<space><forward
slash><space>" like this: " / "
The role value, selected from the following list:
role-name-system-admin (or system-admin)
role-name-academic-staff (or academic-staff)
role-name-admin (or admin)
role-name-av-technician (or av-technician)
role-name-license-manager (or license-manager)
role-name-scheduler (or scheduler)
A valid Organization-Role-Name would look like these examples:
Organization / suborganization;role-name-system-admin
University/department;role-name-academic-staff
You must have one organization role name assigned to each user. Additional organization role names may be
Page 215
EchoSystem 5 Documentation
provided, but are not required. If user has only one organization role, then you do not need to include the additional
commas to "space out" the blank columns.
CSV Example
Following is an example of the format for this file:
Last-Name,First-Name,Email,User-Name,Passwor
d,Organization-Role-Name1,Organization-RoleName2,Organization-Role-Name3,Organization-R
ole-Name4
User,Default,ess@echo360.com,ess@echo360.com
,,echo360;role-name-system-admin
Test,Presenter,testpresenter@echo360.com,tpi
ngle,,echo360 /
LMI;role-name-academic-staff,echo360;role-na
me-system-admin
Begin,Kevin,kb@echo360.com,kb,,echo360 /
echoEngage;role-name-academic-staff
????
????,arabic,arabic.instructor@tpingle.org,,,
echo360 / LMI;role-name-academic-staff
testing,AR_test,ok@test.com,,,echo360 /
Area51;role-name-av-technician
translation,org.admin,org.admin.t@echo360.co
m,org.admin.t,,echo360 /
Area51;role-name-admin
staff,echo,echo.staff@echo360.com,echo.staff
,,echo360;role-name-academic-staff
Tomohiro2L,Tomohiro2F,ulyssesrecords@echo.co
m,tomohiro2,,echo360 /
Area51;role-name-av-technician
????
Page 216
EchoSystem 5 Documentation
????,arabic,arabic1.instructor@tpingle.org,,
,echo360 / LMI;role-name-academic-staff
??????????,Russian,russian_instructor@tpingl
e.org,,,echo360 /
LMI;role-name-academic-staff
kumar,Pavan,pavan@echo360.com,pavan,,echo360
/ apt;role-name-academic-staff
??????,????,ar@ar.com,ar,,echo360 /
LMI;role-name-admin
tomohiro3L_LicenseMng,tomohiro3F_LicenseMng,
somekindofemailaddress@somekindofemailaddres
s.com,tomohiro3,,echo360;role-name-license-m
anager
instructor,ns,ns.instructor@echo360.com,ns.i
nstructor,,echo360 /
Area51;role-name-academic-staff
dd,dd,dd@dd.com,,,echo360 /
LMI;role-name-admin
kumar,Naveen,naveen@echo360.com,naveen,,echo
360 / apt;role-name-academic-staff
pujari,Anup,anup@echo360.com,anup,,echo360 /
apt;role-name-academic-staff
mani,Babu,babu@echo360.com,babu,,echo360 /
apt;role-name-academic-staff
Rajaput,Uday,uday@echo360.com,uday,,echo360
/ apt;role-name-academic-staff
nayak,Tarun,tarun@echo360.com,tarun,,echo360
/ apt;role-name-av-technician
kumar,Mohan,mohan@echo360.com,mohan,,echo360
/ apt;role-name-scheduler
B.,Ramakreeshna,rama@echo360.com,rama,,echo3
Page 217
EchoSystem 5 Documentation
60 / apt;role-name-admin
instructor,echo,echo.instructor@echo360.com,
echo.instructor,,echo360;role-name-academicstaff,echo360 /
aptus;role-name-academic-staff,echo360 /
Area52;role-name-academic-staff,echo360 /
echoEngage;role-name-academic-staff
translation,sys.admin,sysadmin.t@echo360.com
,sys.admin.t,,echo360;role-name-system-admin
presenter,echo,echo.presenter@echo360.com,ec
ho.presenter,,echo360;role-name-academic-sta
ff,echo360 /
aptus;role-name-academic-staff,echo360 /
Area51;role-name-academic-staff
admin,echo,echo.admin@echo360.com,echo.admin
,,echo360;role-name-admin,echo360;role-namelicense-manager
Page 218
EchoSystem 5 Documentation
student,echo,echo.student@echo360.com,echo.s
tudent,,echo360;role-name-academic-staff,ech
o360 / Area51;role-name-academic-staff
Manage Users
In this section:
Overview
If You Have Delegated Administration
Add a User
View User Details
Retire a User
Delete a User
Reinstate a User
Export and Import Users
Overview
As the administrator, you will want to add users and assign roles to them. Any administrator (System Administrator,
parent organization Administrator, or child organization Administrator) can add users.
EchoSystem comes configured with several user roles, each with a unique set of rights, as described below.
Role names are part of the EchoSystem Server UI, and so can be localized.
System Roles
The root roles described in the table below are associated with the parent organization.
Role
Description
Academic Staff
This is an identifying role only. After assigning this role,
you must assign a section role.
You might use this role for someone who addressed
the entire university. After assigning this role, you can
also assign the Guest Presenter role for the section. In
this way you can specify the correct level of hierarchy
(the parent organization) and give the presenter access
to his presentation at the section level.
Use this role at the parent organization level if you have
academic staff that:
Are not associated with a child organization
Should be associated with a section
Page 219
EchoSystem 5 Documentation
License Manager
This role assigns licenses to rooms. If you have parent
or child organization Administrators, you might want to
assign this role to those Administrators. When they
have both the Admin role and the License Manager
role, they can license rooms belonging to their
organizations. If the parent and child Administrators do
not have this role, the System Administrator must
license every room.
System Administrator
The System Administrator can do everything in the
EchoSystem Server (ESS), to either the parent or any
child organization.
Organization Roles
The roles described in the below table are associated with either a parent or child organization. When the role is
associated with the parent organization, the user can perform that role for the parent organization or any child
organization. When the role is associated with a child organization, the user can affect only objects owned by the
child organization.
Role
Description
Administrator
The parent organization Administrator can do
everything except system configuration (the System
Settings page). Configuration choices apply to the
entire institution and are inherited by the child
organizations. More specifically, the Administrator can:
Create and manage child organizations
Manage and create objects (courses, rooms) in child
organizations
Manage all user accounts and roles except the
System Administrator
Perform all monitoring tasks for both parent and child
organizations
The child organization Administrator can:
Set defaults for the child organization
Create objects owned by the child organization
Access shared objects from the parent organization
Perform all monitoring tasks for the child organization
Page 220
EchoSystem 5 Documentation
A/V Technician
The A/V Technician can:
Register devices and assign devices (Configuration
> Devices) to rooms
Configure properties set at the device level (Configu
ration > Device Configuration) or room level (Confi
guration > Rooms)
View (but not edit) Echoes in all available formats
(Podcast, Vodcast, EchoPlayer)
View the Monitor tab
View capture details and logs
Scheduler
The Scheduler can perform all schedule-related tasks
for the parent organization or any child organization.
More specifically, the Scheduler can:
Create terms, courses, and sections
View the Monitor Summary and Processing Tasks
tabs, seeing information for both the parent and child
organizations
Schedule captures for the parent organization or any
child organization
Section Roles
If you assign the Academic Staff role to a user, you will also apply one of the following section roles to the user when
you add the section.
Guest Presenter
Instructor
Student Presenter
Teaching Assistant
These particular roles, described in the below table, are assigned on the section level to allow flexibility. For
example, a particular individual might be a Guest Presenter for a particular section in the business school, but an
Instructor for a different section in the math department.
Role
Description
Guest Presenter
The Guest Presenter gives a single (or a few) lectures
to a particular section. These lectures are usually
captured via the ad hoc interface. The Guest Presenter
can:
Can view Echoes for which he or she was the
presenter
Can participate in discussions in the EchoPlayer
Cannot edit, reprocess or change the state of an
Echo
Page 221
EchoSystem 5 Documentation
Instructor
The Instructor is the course owner. This role is similar
to the Presenter role in 3.0 and earlier versions. The
Instructor:
Manages the details of a course or section and the
Echoes associated with it.
Can edit, reprocess, change state and permanently
delete Echoes
Is listed in metadata as the person who presented
the materials in the ESS and EchoPlayer data
Can import external media and Personal Capture
presentations for their sections
Can see viewing statistics in the EchoCenter and can
see hot spots in the EchoPlayer
Can participate in and moderate discussions (delete
posts and replies) in the EchoPlayer
Student Presenter
This role is primarily for students who prepare Personal
Capture presentations as class assignments. The
Student Presenter can do these tasks for his section:
Prepare presentations in the Personal Capture
application, then log in to the ESS to publish them
Log in to the ad hoc interface and prepare captures
Log in to the ESS and view only all Echoes
A Student Presenter:
Cannot import external media
Cannot edit any presentations, even presentations
he himself published
Does not appear in schedules
Must be granted access if LDAP or trusted system
security is applied to the section
Teaching Assistant (TA)
The Teaching Assistant (TA) has rights similar to an
Instructor's but:
Cannot permanently delete an Echo.
Is not listed as the presenter. To allow this person to
be listed as the presenter for certain Echoes, assign
the Guest Presenter role.
If You Have Delegated Administration
This table below provides some common scenarios and answers some frequently asked questions about managing
users in an organization with delegated administration.
Scenario
Page 222
Solution
EchoSystem 5 Documentation
We manage all schedules centrally at my institution but
I want user roles and other objects to be managed by
department. What should I do?
Give users who manage schedules the Scheduler role
at the parent organization. This allows them to
schedule courses and rooms for all child organizations.
We have a designated administrator for each
organization in our hierarchy. We want that person to
manage everything for those organizations. What
should we do?
Give these users two roles for their respective
organizations: the organization Administrator role and
the License Manager role. In the Administrator role,
they can then create objects and users and assign
more granular roles accordingly. In the License
Manager role, they can assign licenses from the license
page. Child organization Administrators can do this
because licenses are automatically shared, even
though they are owned by the parent organization.
Add a User
This procedure explains how to add a single user through the user interface. You can also add many users all at
once (or change their attributes) using the import/export method.
1. Navigate to Configuration > Users.
2. Click Add. The Add New User screen appears, as shown in the table below.
Page 223
EchoSystem 5 Documentation
3.
4.
5.
6.
Page 224
In the User Details section, enter the user's first and last names and e-mail address.
If desired, check the Block Alerts? box to prevent this user from receiving monitoring alerts via email.
Set the user's local time zone.
Specify the organization and role using the drop-down lists as shown in the below figure.
See the Overview for a description of each role.
EchoSystem 5 Documentation
Click Add >> to add the role.
Some users have multiple roles. Repeat this step for each role.
Best Practice: Make a Note
When you assign the Academic Staff role, you will also need to assign this user a
section role (such as Instructor) when you add the section. You may want to make
a note about that now.
7. In the User Account section, enter a user name and password and then confirm the password. If you are
using LDAP to authenticate users, the System Administrator role requires a user name and password but
other user roles do not.
8. Review the Academic Staff Upload Settings, customizing them as desired. These settings are inherited from
the system settings.
Settings Apply Only to Academic Staff
Academic Staff Upload Settings only apply to the Academic Staff user role. If you are
adding a user who does not have the Academic Staff user role, leave these fields blank.
9. Click Save.
Page 225
EchoSystem 5 Documentation
View User Details
When you view user details, you see all the settings (User Details, Organization Roles, User Account, Academic
Staff Upload Settings) you configured when you added the user, plus some additional settings, as shown and
described below.
Personal Capture Licenses lists the Personal Capture license associated with the user.
If your institution purchased a site license, Presenters are automatically granted a Personal Capture license,
as shown above.
If your institution purchased individual Personal Capture licenses, you can glance at this user details page to
see if a user has a license assigned and how many licenses are available. To assign or deassign a license,
Page 226
EchoSystem 5 Documentation
follow these steps and refer to the screenshot below:
1. Click the Edit button at the bottom of the page to edit the user
2. Check or uncheck the box next to the user name
3. Save the user record
Active Schedules lists active schedules associated with the user. You cannot edit this setting.
Retire a User
You can retire a user who is not currently active (associated with an active schedule). Retiring a user temporarily
removes the user's privileges but does not delete the user permanently. You can reinstate a retired user.
You cannot retire:
A user who is associated with an active schedule
Yourself as a user when you are logged in
To retire users, you must have the role of Administrator of either parent or child organization or System
Administrator of the parent organization.
1. Navigate to Configuration > Users.
2. On the Active tab, select the user(s) you want to retire.
To retire only one user, hover your mouse over that user's name and click retire, as shown in the
figure below.
To retire more than one user, select the box to the left of each user's name and select Retire Selected
from the Actions box at the bottom of the page, as shown in the figure below.
In either case, a confirmation message appears.
3. Click Yes to confirm the retirement of the user(s). The selected users move to the Retired tab.
Delete a User
Deleting a user removes that user permanently from the ESS. To delete users, you must have the role of
Administrator of either parent or child organization or System Administrator of the parent organization. You cannot
delete Academic Staff users (Instructor, Student Presenter, Teaching Assistant, and Guest Presenter) that are
associated with an Echo or ongoing section. To delete those users, you must delete the Echo or ongoing section
first.
You must retire a user before you can delete it.
1. Navigate to Configuration > Users.
2. Retire the user or users.
3.
Page 227
EchoSystem 5 Documentation
3. Select the Retired tab, as shown in the figure below.
4. Select the user(s) you want to delete.
To permanently delete only one user, hover your mouse over that user's name and click delete, as
shown in the figure below.
To permanently delete multiple users, select the box to the left of each user's name and select Delete
permanently from the Actions box at the bottom of the page, as shown in the figure below.
In either case, a confirmation message appears.
5. Click Yes to confirm the deletion of the user(s).
Reinstate a User
1.
2.
3.
4.
Navigate to Configuration > Users.
Select the Retired tab.
Select the box to the left of the user you want to reinstate. You may select more than one.
From the Actions list at the bottom of the page, select Reinstate selected, as shown in the figure below. The
selected user is moved to the Active tab.
Export and Import Users
You may sometimes want to add many users all at once or to change properties of many users. You can do this
efficiently by using the export and import features with a spreadsheet program such as Excel.
For general information on the export and import function, see Export and Import Objects.
Page 228
EchoSystem 5 Documentation
For details on the exact format required to export and import users, see CSV Import Format for Users.
Ad Hoc Capture
In this section:
Overview
Server Configuration for Ad Hoc Capture
Run an Automated Ad Hoc Capture
Run a Basic Ad Hoc Capture
Overview
Ad hoc captures are not scheduled through the EchoSystem Server user interface (ESS UI) but rather started and
controlled through the Ad Hoc web interface, accessed through the capture device or the Classroom Capture
system tray dialog box. There are two options for ad hoc capture:
Automated ad hoc capture. In this case, the Academic Staff member logs in to the capture device using an
ESS user account. The Academic Staff member can choose from a list of assigned sections to start the
capture. This method completely automates the rest of the workflow after capture by applying the settings
defined for the section. For example, if the section is set to create Podcast, Vodcast, and EchoPlayer
products, and to publish to Blackboard, the automated ad hoc capture assumes those settings.
Basic ad hoc capture. Basic ad hoc captures are similar to automated ad hoc captures but are missing
several key details of the capture. This requires manual processing (to supply the missing details) within the
ESS UI after the capture is complete. This option is available to Academic Staff members if they do not have
a section assigned or if they choose to capture instruction not related to a specific section. Basic ad hoc
captures can also be run as the generic user. The generic user is a shared log in to the capture device.
Academic Staff can create Ad Hoc captures through the system tray access feature of Classroom Capture. You may
want to receive alerts about new Ad Hoc captures being available for processing, if you do not already receive such
alerts. See View and Set Alerts.
Ad Hoc Captures with "Curtains"
In rare situations, ad hoc captures result in Echoes with with black bands on either side of the
display area ("curtains"). This may occur if:
You are using the EchoSystem SafeCapture HD
It is set to capture with the widescreen aspect ratio
See When Using the Widescreen Aspect Ratio on the Display Input.
Server Configuration for Ad Hoc Capture
All venues (rooms) must have a capture device, such as a capture appliance or Classroom
Capture that is properly licensed in order to perform ad hoc captures. See License Venues.
Automated Ad Hoc Capture
The automated ad hoc capture workflow is driven by an association of Academic Staff members to sections. This
association is done in the ESS UI. These steps assume you have created sections and Academic Staff.
The Academic Staff member must have a section assignment to run automated ad hoc captures. There are also
Page 229
EchoSystem 5 Documentation
several other settings applied to sections to drive the ESS processing and publishing automation. This section is
specific to Academic Staff member and section assignment. For details on the other settings, see Manage Terms,
Courses, and Sections.
1.
2.
3.
4.
In the EchoSystem server application, navigate to Configuration > Schedule.
Click the Course containing the section to assign.
Edit the desired Section.
From the Available list, select the desired Presenter from the Available list, then click the Select arrow to
move the Presenter to the Selected list, as shown in the figure below.
Who Can be a Presenter?
The Presenter must be assigned to the section and must be one of these Academic Staff
roles:
Instructor
Teaching Assistant
Student Presenter
5. Save the changes.
Basic Ad Hoc Capture
To run a basic ad hoc capture, use the generic user name and password to log in to the capture device via the ESS
UI. The generic user is a shared log in to the capture device.
To specify the authentication settings for all capture devices:
1. Navigate to System > Device Defaults.
2. Click Edit.
3. In the Local Web User Interface section, set the Generic User Name/Password. You can now use this
information to log in to any capture device in any venue.
You can override this user name and password for a capture device in a single room as follows.
1. Navigate to Configuration > Rooms.
2.
Page 230
EchoSystem 5 Documentation
2. Click the edit button in the row corresponding with the room you want to edit. The Edit Room page appears.
3. In the Local Web User Interface section for the capture device type(s) you have licensed, edit the Generic
User Name/Password.
Run an Automated Ad Hoc Capture
Automated ad hoc captures can be run either from an EchoSystem capture appliance or from a podium PC with
Classroom Capture software installed. The instructions below apply to running an automated ad hoc capture from an
EchoSystem capture appliance. See Start an Ad Hoc Capture for instructions on creating an ad hoc capture from
the Classroom Capture system tray dialog.
The capture device must be online with the ESS for automated ad hoc captures to function.
Who can do this?
The user must be assigned to the section and must be one of these Academic Staff roles:
Instructor
Teaching Assistant
Student Presenter
1. Browse to the ad hoc interface URL for the device. The URL protocol and port are defined by the device
configuration. See About Devices for details. In most cases the URL is based on IP address as in this
example:
https://192.168.77.110:8443
2. Log in with the user name and password for the Academic Staff user, as shown in the first figure below. For
example: jsmith.
3. Click Ad Hoc Capture on the capture page.
4. Enter a title and duration for the capture.
5. Select the appropriate section to capture. The capture source options (audio, video, display) are automatically
selected based on the product settings for the section. For example, if you set the section to create vodcast,
then audio and display are captured. If you set the section to create EchoPlayer, then audio, video, and
display are captured.
6. Click Start Ad Hoc Capture. The capture stops automatically when the capture duration is complete. The
ESS processes the capture according to the settings for the section.
Page 231
EchoSystem 5 Documentation
Run a Basic Ad Hoc Capture
Basic ad hoc captures can be run either from an EchoSystem capture appliance or from a podium PC with
Classroom Capture software installed. The instructions below apply to running a basic ad hoc capture from an
EchoSystem capture appliance device. See Start an Ad Hoc Capture for instructions on creating an ad hoc capture
from the Classroom Capture system tray dialog box.
In the Capture Device Ad Hoc UI
1. Browse to the ad hoc interface URL for the device. The URL protocol and port are defined by the device
configuration. See About Devices for details. In most cases the URL is based on the IP address. For
example:
https://192.168.77.110:8443
2.
3.
4.
5.
6.
Page 232
Log in with the generic user, as shown in the first figure below. For example: Instructor.
Click Ad Hoc Capture on the capture page.
Enter a description and duration for the capture.
Select the appropriate capture source option. For example: display-audio-video
Click Start Ad Hoc Capture. The capture stops automatically when the capture is complete and has been
uploaded to the ESS.
EchoSystem 5 Documentation
In the ESS UI
1. In the EchoSystem server application, navigate to Echoes > Ad Hoc Captures.
2. Mouse over the ad hoc capture and click the process link.
3. Select the section from the menu in the Process Ad Hoc Capture page, as shown in the figure below. Filter to
the section listing in the Term and Course menus.
4. Click Next.
5. The default settings are loaded from the parent or child organization's defaults, which are inherited by the
section. Modify these settings if needed.
6. Click Process. The ad hoc capture is processed according to the settings.
Upgrade to EchoSystem 5
Page 233
EchoSystem 5 Documentation
Supported Upgrade Paths
Upgrade Options
High-Level Procedure
Back up the ESS Application
Back up the Database
Stop the ESS Service
Stop Wowza
Supported Upgrade Paths
Upgrading to EchoSystem 5 is only supported from existing 3.0 or 4.0 installations. If your EchoSystem has not yet
been upgraded to at least EchoSystem 3.0 you will need to do so before proceeding with the upgrade to
EchoSystem 5. Upgrade instructions for 3.0 can be requested from Echo360 Technical Support.
Best Practice: Make Backup Copies
We strongly recommend that you make backup copies of the EchoSystem Server (ESS)
application and database before upgrading. The installer will make a backup copy of the
application but it is always best to make your own as well.
Upgrade Options
The process of upgrading the ESS may be handled in two ways, depending on whether you are doing an in-place
upgrade or a server migration.
In-place Upgrades. The EchoSystem installation program recognizes the existing ESS release installed on
the host computer, and will upgrade all of the components of the system. This is the most common upgrade
option and the only one covered in this guide.
Server Migrations. This is the upgrade procedure if you are moving the EchoSystem to a new server at the
same time that you upgrade the EchoSystem. If you are planning on migrating servers at the time of your
upgrade, contact Echo360 Technical Support.
High-Level Procedure
Follow these steps.
1.
2.
3.
4.
5.
Back up the ESS application
Back up the database
Download the upgrade package from the customer portal
Upgrade the EchoSystem Server (ESS)
Upgrade Devices
Back up the ESS Application
The ESS application is located on the ESS file system in the installation path. The paths below assume the default
base installation path.
Follow these steps to back up the application.
1. Stop the EchoSystem Server (ESS) and Wowza Flash Streaming Server (Wowza Media Server) service or
daemon. See Stop the ESS Service and Stop Wowza.
2.
Page 234
EchoSystem 5 Documentation
2. Create a backup directory on the same or different computer.
3. Browse to the application directory.
4. Copy all directories in server to the backup location.
The default locations for the ESS are listed here. Your deployment may differ based on the paths chosen at the time
of your installation.
Windows: C:\Program Files\Echo360\Server
Linux: /usr/local/echo360/server
Mac OS: /Applications/echo360/server
If You Have Modified Profiles
If you have modified capture or processing profiles, contact Echo360 Technical Support for
assistance.
Back up the Database
Database Backup (Derby)
If using the internal Derby database, the database is located on the ESS file system in the installation path. The
paths below assume the default base installation path. To back up the database:
1.
2.
3.
4.
Stop the EchoSystem Server service or daemon.
Create a backup directory on the same or different computer.
Browse to the database directory.
Copy the db directory to the backup location.
The default locations for the integrated Derby database are listed here. Your deployment may differ based on the
paths chosen at the time of your installation.
Windows: C:\Program Files\Echo360\Server\db
Linux: /usr/local/echo360/server/db
Mac OS: /Applications/echo360/server/db
Database Backup (others)
If using a third-party database, refer to the vendor documentation for backup procedures. You must manually back
up your database. This will not happen as part of the install process.
Stop the ESS Service
Overview
Stopping the ESS service or daemon is required during the configuration process and at other times when certain
system changes are made. Follow these platform-specific instructions to stop the ESS.
Stop ESS on Windows
1. From the Windows taskbar select Start > Programs > Administrative Tools > Services.
2. The Services dialog box opens. Select the EchoSystem Server service.
3. Click Stop. The ESS service will be stopped on your local computer by the Service Control.
Page 235
EchoSystem 5 Documentation
Stop ESS on Linux
1. Open a terminal prompt.
2. From the terminal prompt, type in the stop command. The command is:
sudo /etc/init.d/echosystemserverd stop
Include the Space
Be sure to include the space between the file name and the stop command. You may be
prompted to enter your password to authorize this action.
You see a status message when the service stops.
Stop ESS on Mac OS X
1. Open a terminal prompt.
2. From the terminal prompt, type in the stop command. Using the default installation path, the command is:
sudo /Applications/echo360/server/bin/echosystemserverd.sh stop
You see a status message when the service stops.
Stop Wowza
Stop Wowza on Windows
1. From the Windows taskbar, select Start > Programs > Administrative Tools > Services.
2. The Services dialog box opens. Select the Wowza Media Server service.
3. Click Stop. The Wowza service stops on your local computer.
Stop Wowza on Linux
1. Open a terminal prompt.
2. From the terminal prompt, type in the stop command. The command is:
sudo /etc/init.d/WowzaMediaServer stop
You see a status message when the service stops.
Stop Wowza on Mac OS
1. Open a terminal prompt.
2. From the terminal prompt, type in the stop command. The command is:
Page 236
EchoSystem 5 Documentation
sudo launchctl unload
/Library/LaunchDaemons/com.wowza.WowzaMediaServer.plist
You see a status message when the service stops.
Upgrade the EchoSystem Server (ESS)
In this section:
Overview
Download the Software
Prepare the MySQL Database
Install the Upgrade
Check for Retired Devices
Report Upgrade Problems
Overview
Existing XP Devices No Longer Capture
With this ESS release, Classroom Capture is supported for Windows 7 only. This means that
capture devices that worked with Windows XP (and the earlier release of Classroom Capture) ca
nnot be used with this release. If you have devices that are not supported by Windows 7 they
will be automatically retired by the ESS.
Upgrading the ESS consists of these phases:
1.
2.
3.
4.
5.
Verify that the ESS is on a machine with a supported OS. See Supported Technologies.
Download the software.
Prepare the MySQL database if you use MySQL.
Install the upgrade.
Check for retired devices. If you have venues with retired devices, you must install supported devices in those
venues and verify that capture schedules point to those new devices.
6. Report upgrade problems if you encounter them.
7. If you have venues with Classroom Capture (sometimes called EchoCapture software, Software Capture, or
Podium Capture), continue by upgrading the software on podium PCs in those venues. See Install Classroom
Capture Software.
Download the Software
The installation software is provided through a compressed file downloaded from the Echo360 customer support
portal. Save it to a directory location on the hard drive of the machine where the EchoSystem Server (ESS) will be
run.
Prepare the MySQL Database
If you do not use the MySQL database you can skip this section.
The ESS installer handles all necessary database interactions during the upgrade process, but you must:
1.
Page 237
EchoSystem 5 Documentation
1. Ensure that you are using a supported version of MySQL. See Supported Technologies.
2. Convert the Latin-1 character set to the UTF-8 character set. See Convert Latin-1 to UTF-8.
3. Check the collations of the database and tables. You may need to change the collation of the database. See
Check Database and Table Collations.
4. If you expect to have captures of three hours or longer: Increase the max_packet_size parameter in the my.
cnf file. See Increase the max_packet_size Parameter.
Convert Latin-1 to UTF-8
The default MySQL configuration uses the Latin-1 character set, but the ESS requires its database to use the UTF-8
character set. The ESS upgrade process fails if the database uses the Latin-1 character set.
This KB (Knowledge Base) article explains how to convert the Latin-1 character set to the UTF-8 character set.
Accessing the Knowledge Base
You will need a customer portal login to access the Knowledge Base. Contact Technical Support
if you need a login.
Check Database and Table Collations
The ESS allows you to choose the UTF-8 compatible collation you use. Therefore, to respect your choice, the ESS
does not specify a collation when it creates tables during a new install or during an upgrade. It uses the default
collation for the database. If the default collation is changed without converting the existing tables, this can cause a
problem during upgrade when new tables are created with a different collation. This occurs most often when the
ESS database is dumped and loaded into a new server that has a different default collation.
You must determine if the collations for the database and tables match. If they do not, you must change the default
collation for the database to match the collation of the existing tables.
Follow these steps.
1. Check the collation for several existing tables. Type this command:
show full columns from <database_name>.<table_name>;
2. Check the default collation for the database. Type this command:
use <database_name>;
show variables like 'collation_database';
3. If the collations do not match, change the default collation for the database to match the collation of the
existing tables. Type this command:
alter database <database_name> collate 'some_collation_name'
Increase the max_packet_size Parameter
Page 238
EchoSystem 5 Documentation
Each capture event creates and stores in the database an xml specification that includes all the necessary
information and links to supporting images and media. Long captures, which have large sets of thumbnail images,
can create very large specifications. The default limit for BLOBS within MySQL is 1 MB. This may be too small for
captures of three hours or longer. If you expect to capture events longer than three hours, increase the max_packet
_size parameter in the my.cnf file.
Capture events that create specifications larger than the max_packet_size are captured and processed, but they do
not appear in the list of presentations.
Follow these steps.
1. Stop MySQL. Consult the MySQL documentation for instructions.
2. Locate the my.cnf file on your system.
3. Open it in an editor.
4. Modify the max_packet_size parameter, changing it from 1 MB to 2 MB. After editing, the line in the file
should look like this:
max_allowed_packet = 2M
5. Save the my.cnf file.
6. Restart MySQL.
Install the Upgrade
Windows
There are two versions of the Windows installer available for download from the Echo360 Customer Support web
site, supporting either 32-bit or 64-bit distributions. The upgrade process is similar for either version, as described
below. You must be a user with administrator rights to perform the upgrade. These instructions assume that you
used the default directories for the installation of your original ESS, and that you are not changing the location. If you
are changing the installed location, even if you are not changing the host server, contact Echo360 Technical Support
for assistance.
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
Navigate to Administrative Tools > Services.
Select the EchoSystem Server service.
Click Stop.
Select the Wowza Media Server service.
Click Stop.
Back up the ESS database and application. See Upgrade to EchoSystem 5.
Extract the zip file downloaded from the Echo360 website. Navigate to the expanded directory and
double-click the installer executable.
Follow the instructions on the screen to install the upgrade.
Look for a warning about Windows XP devices.
Continue with the upgrade or cancel. If you continue, be sure to check for retired devices.
Start the ESS service. If you upgraded to EchoSystem 5, the ESS upgrades the Wowza Media Server to
version 3 (Wowza Media Server 3).
Start the Wowza Media Server service.
Linux
There are two versions of the Linux installer available for download from the Echo360 Customer Support web site,
Page 239
EchoSystem 5 Documentation
supporting either 32-bit or 64-bit distributions. The upgrade process is identical for either version, as described
below. You must be a user with root privileges or use the sudo command, which requires your password, to perform
upgrade. These instructions assume that you used the default directories for the installation of your original ESS,
and that you are not changing the location. If you are changing the installed location, even if you are not changing
the host server, contact Echo360 Technical Support for assistance.
1. Stop the EchoSystem Server service (daemon). From the terminal prompt, type:
sudo /etc/init.d/echosystemserverd stop
2. Stop the Wowza Media Server service (daemon). From the terminal prompt, type:
sudo /etc/init.d/WowzaMediaServer stop
3.
4.
5.
6.
Back up the ESS database and application. See Upgrade to EchoSystem 5.
Download the EchoSystem 5 installer from Echo360. Both 32- and 64-bit versions are available for download.
Extract the tar.gz file and navigate to the expanded directory.
The installer binary file may need the right permissions set to run as an executable. From the terminal
prompt, type:
sudo chmod +x <installer_name>.bin
7. Launch the binary file. From the terminal prompt, type:
./<installer_name>.bin
8.
9.
10.
11.
Follow the instructions on the screen.
Look for a warning about Windows XP devices.
Continue with the upgrade or cancel. If you continue, be sure to check for retired devices.
Start the ESS service. If you upgraded to EchoSystem 5, the ESS upgrades the Wowza Media Server to
version 3 (Wowza Media Server 3).
12. Start the Wowza Media Server service.
Mac OS
There is only one version of the Mac OS X installer available for download from the Echo360 Customer Support web
site, supporting Intel based 64-bit distributions. You use the sudo command, which requires an administrator
password, to perform the upgrade. These instructions assume that you used the default directories for the
installation of your original ESS, and that you are not changing the location. If you are changing the installed
location, even if you are not changing the host server, contact Echo360 Technical Support for assistance.
Page 240
EchoSystem 5 Documentation
Check Java Version
Mac OS X installation requires the latest Java version. Check installed Java versions in Applicat
ions > Utilities > Java > Java Preferences and then select Software Update to install if
needed.
1. Stop the EchoSystem Server service (daemon). From the terminal prompt, type:
sudo /Applications/echo360/server/bin/echosystemserverd.sh stop
2. Stop the Wowza Media Server service (daemon). From the terminal prompt, type:
sudo launchctl unload
/Library/LaunchDaemons/com.wowza.WowzaMediaServer.plist
3.
4.
5.
6.
7.
Back up the ESS database and application. See Upgrade to EchoSystem 5.
Download the EchoSystem 5 installer from Echo360.
Extract the zip file downloaded from the Echo360 website and navigate to the expanded directory.
Extract the installer zip file.
Launch the installer. From the terminal prompt, type:
cd <installer_name>.app/Contents/MacOS
sudo ./echosystemServerInstall_2_6
8.
9.
10.
11.
Follow the instructions on the screen.
Look for a warning about Windows XP devices.
Continue with the upgrade or cancel. If you continue, be sure to check for retired devices.
Start the ESS service. If you upgraded to EchoSystem 5, the ESS upgrades the Wowza Media Server to
version 3 (Wowza Media Server 3).
12. Start the Wowza Media Server service.
Check for Retired Devices
With this ESS release, Classroom Capture is supported for Windows 7 only. This means that capture devices that
worked with Windows XP (and the earlier release of Classroom Capture) cannot be used with this release. If you
have devices that are not supported by Windows 7 they will be automatically retired by the ESS.
Follow these steps to identify devices that have been automatically retired during the ESS upgrade.
1. Navigate to Configuration > Devices.
2. Click the Retired tab.
Page 241
EchoSystem 5 Documentation
3. Look for the text Unsupported Operating System in the Capture Status and Log Upload Status fields. This
indicates that the device was retired because it is not supported by Windows 7.
Report Upgrade Problems
If the upgrade procedure produces any error or failure messages the installer reverts back to the earlier instance. In
this event, contact Echo360 Technical Support for assistance.
Upgrade Devices
In this section:
Registered Devices
Registered Devices
The EchoSystem Server (ESS) automatically manages the Echo software (binaries) for EchoSystem devices,
including capture appliances, Classroom Capture software, and media processors. Upgrading to a major release
also upgrades all devices to the latest revision. This ensures device compatibility with the upgraded ESS.
After a successful ESS upgrade, there are no further procedures to upgrade devices. They are automatically
updated by the ESS and return to normal function shortly after upgrade.
If your original installation had a media processor running on the same server as the ESS, this an ideal time to move
the media processor to another location. Follow these steps.
1. Install the media processor on the new server.
2. Register the media processor with the ESS.
3. Uninstall the media processor software from the ESS computer.
EchoSystem Server Basics
In this section:
Access the User Interface
Server UI Navigation
Page Types
Download Installers
Manage Services
Page 242
EchoSystem 5 Documentation
Access the User Interface
The EchoSystem Server UI (ESS UI) is a secured web based interface accessible from any standard web browser.
The EchoSystem administrator configures the web interface after installation.
The default address for the UI is:
https://ess.institution.edu:8443
where ess.institution.edu is the host name of the EchoSystem server.
The ESS UI requires authentication. The default user name for the UI is ess@echo360.com and the default
password is password. See Change the Admin Password for instructions on changing this password.
Server UI Navigation
The ESS UI uses a tab and subtab approach to navigation. At the top of the interface there are seven tabs ( Echoes,
Downloads, Schedule, Monitor, Reports, Configuration, System). During some operations you may also see what is
referred to as a breadcrumb, identified in the figure below, which simplifies navigation to screens beyond a subtab.
There are three other navigational items displayed at all times: Help, Logout and Username (i.e.
ess@echo360.com). The Help link takes you to this documentation. The Logout link ends your UI session. The User
name link takes you to the change password screen, as identified in the figure below. The image below shows each
of these navigation items.
Page Types
The UI also provides the ability to both view and edit properties for certain items. These pages are referred to as sho
Page 243
EchoSystem 5 Documentation
w pages and edit pages. Show pages provide a listing of the properties for an item. Edit pages allow the user to set
or modify properties and then save them. For example, the show page for a Blackboard publisher displays the
information entered for the publisher, while the edit page allows you to edit that information.
Show Page Example
The following figure is an example of a Show page.
Edit Page Example
The following figure is an example of an Edit page.
Download Installers
Installers for the EchoSystem components listed below can be downloaded from the Echo360 website:
Classroom Capture
Personal Capture
Processor (media processor)
Follow these steps.
1. Navigate to Downloads > Downloads.
2.
Page 244
EchoSystem 5 Documentation
2. Click on the link for the installer you need.
3. Installer instructions differ by component. Follow the on-screen instructions.
Manage Services
The ESS and Wowza Flash Streaming Server (Wowza Media Server) run as services or daemons. Managing these
services is specific to the platform on which they are running. Starting, stopping and restarting these services are
referred to throughout this document. The ESS UI also indicates when service restarts are required. Refer to this
section whenever service management is required.
ESS Service
Follow these instructions to start the ESS specific to each supported platform.
Start ESS on Windows
1. From the Windows taskbar select Start > Programs > Administrative Tools > Services. The Services
dialog opens.
2. Select the EchoSystem Server service.
3. Click Start. The ESS service starts on your local computer.
Stop ESS on Windows
1. From the Windows taskbar select Start > Programs > Administrative Tools > Services. The Services
dialog opens.
2. Select the EchoSystem Server service.
3. Click Stop. The ESS service stops on your local computer.
Restart ESS on Windows
1. From the Windows taskbar select Start > Programs > Administrative Tools > Services. The Services
dialog opens.
2. Select the EchoSystem Server service.
3. Click Restart. The ESS service restarts on your local computer.
Start ESS on Linux
1. Open a terminal prompt.
2. Type in the start command. The command is:
Page 245
EchoSystem 5 Documentation
2.
sudo /etc/init.d/echosystemserverd.sh start
Note that there is a space between the file name and the start command.
Status messages show you when the service starts.
Stop ESS on Linux
1. Open a terminal prompt.
2. Type the stop command. The command is:
sudo /etc/init.d/echosystemserverd.sh stop
Note that there is a space between the file name and the stop command.
Status messages show when the service stops.
Restart ESS on Linux
1. Open a terminal prompt.
2. Type in the restart command. The command is:
sudo /etc/init.d/echosystemserverd.sh restart
Note that there is a space between the file name and the restart command.
Status messages show when the service stops and then starts.
Start ESS on Mac OS X
1. Open a terminal prompt.
2. Type the start command. The command is:
sudo /Applications/echo360/server/bin/echosystemserverd.sh start
Status messages show when the service starts.
Stop ESS on Mac OS X
1. Open a terminal prompt.
2. From the terminal prompt, type in the stop command. The command is:
Page 246
2.
EchoSystem 5 Documentation
sudo /Applications/echo360/server/bin/echosystemserverd.sh stop
Status messages show when the service stops.
Restart ESS on Mac OS X
1. Open a terminal prompt.
2. From the terminal prompt, type in the restart command. The command is:
sudo /Applications/echo360/server/bin/echosystemserverd.sh stop
sudo /Applications/echo360/server/bin/echosystemserverd.sh start
Status messages show when the service stops and then starts.
Wowza Service
Start Wowza on Windows
1. From the Windows taskbar select Start > Programs > Administrative Tools > Services. The Services
dialog opens.
2. Select the Wowza Media Server service.
3. Click Start. The Wowza service starts on your local computer.
Stop Wowza on Windows
1. From the Windows taskbar, select Start > Programs > Administrative Tools > Services. The Services
dialog opens.
2. Select the Wowza Media Server service.
3. Click Stop. The Wowza service stops on your local computer.
Restart Wowza on Windows
1. From the Windows taskbar, select Start > Programs > Administrative Tools > Services. The Services
dialog opens.
2. Select the Wowza Media Server service.
3. Click Restart. The Wowza service restarts on your local computer.
Start Wowza on Linux
1. Open a terminal prompt.
2. From the terminal prompt, type in the start command. The command is:
sudo /etc/init.d/WowzaMediaServer start
Status messages show when the service starts.
Stop Wowza on Linux
1. Open a terminal prompt.
2.
Page 247
EchoSystem 5 Documentation
2. From the terminal prompt, type in the stop command. The command is:
sudo /etc/init.d/WowzaMediaServer stop
Status messages show when the service stops.
Restart Wowza on Linux
1. Open a terminal prompt.
2. From the terminal prompt, type in the restart command. The command is:
sudo /etc/init.d/WowzaMediaServer restart
Status messages show when the service stops and then starts.
Start Wowza on Mac OS
1. Open a terminal prompt.
2. Type the start command. The command is:
sudo launchctl load
/Library/LaunchDaemons/com.wowza.WowzaMediaServer.plist
Status messages show when the service starts.
Stop Wowza on Mac OS
1. Open a terminal prompt.
2. Type the stop command. The command is:
sudo launchctl unload
/Library/LaunchDaemons/com.wowza.WowzaMediaServer.plist
Status messages show when the service stops.
Restart Wowza on Mac OS
1. Open a terminal prompt.
2. Type the restart commands. The commands are:
sudo launchctl unload
/Library/LaunchDaemons/com.wowza.WowzaMediaServer.plist
sudo launchctl load
/Library/LaunchDaemons/com.wowza.WowzaMediaServer.plist
Page 248
EchoSystem 5 Documentation
Status messages show when the service stops and then starts.
Manage Terms, Courses, and Sections
In this section:
Overview
Training Module
Terms
Courses
Sections
Overview
Terms, courses, and sections are created and managed in the EchoSystem Server (ESS) UI, Schedule tab.
Courses and sections provide the structure in which to enable various EchoSystem features and therefore are
foundational to using EchoSystem. Features enabled based on a course or section include:
Scheduling captures
Running ad hoc captures
Uploading Personal Capture recordings
Assigning publishers
Applying presentation security
Implementing media retention policies
Training Module
This link below opens the training module, which walks you through the basics of course and section management:
Course and Section Management
Terms
About Terms
Terms define a date range associated with an academic term, semester, trimester, etc. In any given term there may
be multiple offerings of the same course, so the EchoSystem assigns sections to a term. For example, an
Introduction to Economics (ECON101) course has three offerings during the Fall 2009 term. Each of these offerings
is defined as a section such as 001, 002 and 003.
Term dates are primarily used when scheduling recurring captures for a section. The dates will be used by default in
the scheduling interface. While academic term dates are likely to be specifically defined, within EchoSystem they are
not hard date rules, but rather used as a convenience during scheduling. In other words, captures for a section
associated with a term can occur outside the defined date range.
Most academic terms include holidays when classes do not meet and exam days when no lecture is presented.
These days can be marked as excluded when creating a term. These dates are known as exclusion dates. When
scheduling recurring captures, these dates will be excluded and captures will not occur on those days.
Add Terms
1. Navigate to Schedule > Terms. The Terms page appears.
2. Click Add. The Add New Term page appears as shown in the figure below.
Page 249
EchoSystem 5 Documentation
2.
3.
4.
5.
6.
Enter the term name.
Select the parent organization or child organization from the list.
Enter the start date, end date, and exclusion date ranges.
Click Save.
Edit at Any Time
You can edit a term at any time by hovering your mouse over the term on the Terms page and
clicking the edit link.
Courses
About Courses
The word "course" has different meanings at different institutions. Echo360 recognizes that the meaning given to
"course" may not suit every institution, particularly those outside the U.S.
The EchoSystem defines a course as an academic subject being taught and captured over a period of time, such as
a term, and then taught and captured again during a different period of time or term. For example, a course name
might be "Introduction to Economics" with an identifier of "ECON101". Courses defined in the EchoSystem are really
more of a container for sections. Sections are the actual offerings of the course during a particular term. The
EchoSystem schedules capture for the sections associated with a course, not courses themselves.
Add a Course
1. Navigate to Schedule > Courses.
2. Click Add. The Add New Course page appears as shown in the figure below.
Page 250
2.
EchoSystem 5 Documentation
3. Enter the course name and identifier.
4. Select the parent organization or child organization from the list.
5. Click Save.
Edit at Any Time
You can edit a course at any time by hovering your mouse over the course on the Courses page
and clicking the edit link.
You may sometimes want to add many courses all at once or to change properties of many courses. You can do this
efficiently by using the export and import features with a spreadsheet program such as Excel.
Delete a Course
You cannot delete a course that has sections, schedules, or captures associated with it. There is no delete button,
as shown in the figure below.
Otherwise, follow these steps.
1. Navigate to Schedule > Courses.
2. Hover over the course to be deleted.
3. Click delete.
4. Confirm that you want to delete the course.
5. Notice the message confirming deletion at the top of the page.
Sections
About Sections
Sections define the offering of a course and are associated with a term. The word "section" is also more applicable
Page 251
EchoSystem 5 Documentation
to institutions in the U.S. You may think of them as "modules" or "offerings" or even as a substitute for "courses".
The important thing to understand is that sections are the actual items being scheduled for capture. You need at
least one section per course and can have as many sections as you need for that course. Each section is
associated with a term. Using our "Introduction to Economics" course example, Introduction to Economics
(ECON101) is the course name. This course has three offerings during the Fall 2009 term and four offerings during
the Spring 2010 term. Each offering is created as a section within the course and assigned to the appropriate term.
Captures are then based on a section.
Browsers set with UK or ANZ locale may display the word "module" instead of "section".
Add a Section
1.
2.
3.
4.
5.
6.
Navigate to Schedule > Courses. The Courses page appears.
Click a course link. The Course Details page appears.
In the Sections area of the page, click the Add button. The Add New Section page appears.
Configure the new section by reviewing the configuration details below.
To add additional or to configure default publishers for the course's section, click the Add Publishers button.
Click Save.
Edit at Any Time
You can edit a section at any time by hovering your mouse over the section on the Section page
and clicking the edit link.
You may sometimes want to add many sections all at once or to change properties of many sections. You can do
this efficiently by using the export and import features with a spreadsheet program such as Excel.
Delete a Section
You cannot delete a section that has schedules or captures associated with it. Although you will see a delete button,
when you click the button you see an error message and the section is not deleted, as shown in the figure below.
Otherwise, follow these steps.
1. Navigate to the course details page.
a. Navigate to Schedule > Courses.
b. Click on the course link.
2. Hover over the section to be deleted.
Page 252
2.
EchoSystem 5 Documentation
3. Click delete.
4. Confirm that you want to delete the section.
5. Notice the message confirming deletion at the top of the page.
Section Configuration Options
You can configure sections to enable automation and streamline the user interface. Most settings are inherited from
the organization. See Organization Default Settings.
The sections that follow provide details on each of the Section Configuration options available.
Section Information
The figure below shows the Section Information configuration options. Below the figure is a table that describes the
settings available.
Setting
Description
Inherited From
Name
Defines the name of the section.
N/A
Term
Defines the associated academic
term for the section.
Parent Organization > Child
Organization
People and Section Roles
The figure below shows the People and Section Roles configuration options. Below the figure is a table that
describes the settings available.
Page 253
EchoSystem 5 Documentation
Setting
Description
Inherited From
Person
Lists all users with the Academic
Staff role for the organization. You
must add users to the organization
first as Academic Staff before you
can assign that user a section role.
The person you select here can
publish recordings to this section
from Personal Capture and select
this section for Ad Hoc captures.
N/A
Section Role
Lists all options for persons
assigned to this section. Options
are Instructor, Student Presenter,
Teaching Assistant, and Guest
Presenter.
N/A
Click Add >> to add the combination of person and section role you selected to the section.
Media Settings
Setting
Definition
Inheritance
Delete Original Media?
See Media Settings for the
organization.
Parent Organization > Child
Organization > Section
Days to Keep Originals
See Media Settings for the
organization.
Parent Organization > Child
Organization > Section
Page 254
EchoSystem 5 Documentation
Display Media Links on Playback
See Media Settings for the
organization.
Parent Organization > Child
Organization > Section
Echo Defaults
The figure below shows the Echo Defaults configuration options. Below the figure is a table that describes the
settings available.
Setting
Definition
Inherited From ...
Echoes Initially Unavailable?
See Echo Defaults settings for the
organization.
Parent Organization > Child
Organization
Branding
All branding settings are inherited from the organization. See Branding settings for the organization for descriptions
of the settings.
EchoCenter
Most EchoCenter settings are inherited from the organization. Settings that are specific to the section are described
here. See Manage the EchoCenter for details on the EchoCenter.
The figure below shows the Echo Center configuration options. Below the figure is a table that describes the settings
available.
Setting
Definition
Inherited From
Disable at end of Term?
See EchoCenter settings for the
organization.
Parent Organization > Child
Organization
Page 255
EchoSystem 5 Documentation
Show podcast link?
See EchoCenter settings for the
organization.
Parent Organization > Child
Organization
Show vodcast link?
See EchoCenter settings for the
organization.
Parent Organization > Child
Organization
Show rich media link?
See EchoCenter settings for the
organization.
Parent Organization > Child
Organization
Heading for scheduled captures
(singular)
See EchoCenter settings for the
organization.
Parent Organization > Child
Organization
Heading for scheduled captures
(plural)
See EchoCenter settings for the
organization.
Parent Organization > Child
Organization
Heading for other uploaded
content (singular)
See EchoCenter settings for the
organization.
Parent Organization > Child
Organization
Heading for other uploaded
content (plural)
See EchoCenter settings for the
organization.
Parent Organization > Child
Organization
External System Id
External System Id fields (the last
two EchoCenter settings) are not in
herited from the organization. They
appear only here, on the section
page.
N/A
If you have a learning management
system (LMS), you can populate
this field with the LMS ID for the
course. The LMS ID will show as
the latter part of the URL.
A typical URL might be:
"http://<your_ess_name>/ess/portal
/section/f3421485-0201-4a23-adcc3d131e7b0b5d".
A customized URL is shorter and
more intuitive:
"http://<your_ess_name>/ess/portal
/section/<MoodleID>".
You may use more than one LMS.
In that case, you can use one
External System Id field for one
LMS (for example, Moodle) and the
other External System Id field for
another LMS (for example, Angel).
Page 256
EchoSystem 5 Documentation
EchoPlayer
All EchoPlayer settings are inherited from the organization. See EchoPlayer settings for the organization for details
about the settings.
Product Groups
The Product Groups setting is inherited from the organization. See Product Groups settings for the organization for
details about the settings.
Security Settings
The Security Setting is inherited from the organization. See Security Settings for the organization for details about
the settings.
Support
The Support settings are inherited from the organization. See Support settings for the organization for details about
the settings.
Tree 1
The Tree 1 setting only appears if you selected LDAP Security as the module type for the section. The section
inherits the Tree 1 settings from the LDAP security module.
The following figure shows the Tree 1 configuration options.
Upload Settings
All upload settings are inherited from the organization. See Upload Settings for the organization for details about the
settings.
Configured Publishers
Assigning publishers to a section requires a separate step when creating the section. You can do either of these
actions:
On the Add New Section page, click Add Publishers to save the section, or
On the Edit Section page, save the section and then click Add Publisher.
Page 257
EchoSystem 5 Documentation
Publishers are inherited by the section from those you add to the ESS, but each requires additional configuration so
the Echo is published to the correct section. The table below provides links to the sections of the documentation that
provide the necessary information.
To add this publisher to a section...
See
Blackboard
Add Blackboard to Each Section
Blackboard CE/Vista
Add Blackboard CE/Vista to Each Section
Moodle
Add Moodle to Each Section
After you add a publisher to a section, the publisher is listed, as shown in the following figure.
The table below provides definitions for the settings appearing for Configured Publishers.
Setting
Definition
Inherited From
Name
This column displays the name and
configuration information for the
publisher.
N/A
Publisher Type
This column displays the publisher
type for the selected publisher.
N/A
Configuration Complete?
This column displays the status of
the configuration. It reads "Yes" if
the section specific information for
the publisher is entered and "No" if
this information is not yet entered.
Mouse over the publisher and click
the edit link to set the section
specific information for the
publisher.
N/A
Add Publisher
This button opens the Add
Publisher page.
N/A
Page 258
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

advertising