Include Library
In this section:
Definition for Alternate Identifier
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Definition for Alternate Identifier|nopanel=true
The globally unique identifier (GUID) used by an external system, such as an LMS or LDAP, to identify the object. Entering an Alternate ID is optional, but allows you to use the external system's GUID (not the EchoSystem Identifier) when making API or other system calls.
The Alternate Identifier must be unique for each ESS object type. See API Documentation for further explanation.
Definition for EchoSystem ID
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Definition for EchoSystem ID|nopanel=true
The globally unique identifier (GUID) used by the EchoSystem Server (ESS) to identify the object. The ESS automatically assigns this ID to each object in the system. You may use this identifier when making API or other system calls. See API Documentation for further explanation.
Best Practice: Install Echo360 Software on a Dedicated Computer
Best Practice: Install Echo360 Software on a Dedicated Computer
Install the ESS and associated database (MySQL or Microsoft SQL Server) on a server dedicated to the EchoSystem.
Install Classroom Capture on a dedicated PC in the venue.
Capture Appliance Names
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Capture Appliance Names|nopanel=true
Classroom Devices
The EchoSystem SafeCapture HD (also called the SafeCapture HD, second generation capture appliance) was placed into service in June 2011. It is no longer in production.
The Echo360 PRO (also called the PRO, third generation capture appliance) was placed into service in December 2015. It is in active production.
Clasroom Capture is a Windows-only application suited for audio, video, and local screen capture from a dedicated podium or lectern PC inside the classroom.
The generic term "classroom device" refers to any of the appliances.
Best Practice Checklists
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Best Practice Checklists|nopanel=true
Best Practice
Refer to the Prerequisite Installation Checklist and Post-Installation Checklist documents during installation.
Why Use LTI?
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Why Use LTI?|nopanel=true
- LTI-Based publishing supports EchoCenter publishing, which is recommended instead of individual link publishing.
- LTI is a published standard. The information passed between the systems is secured and authorized, and can ultimately provide for viewing analytics through the ESS.
- LTI-Based publishing is dynamic, but traditional publishing is static. Static publishing means that if you change security settings or if you configure a publisher incorrectly, you must repost links to the learning management system (LMS). In dynamic publishing, by contrast, any changes made to the courses or sections are passed through automatically.
- LTI configuration on the ESS is simple. It requires only an LTI profile and an association between the ESS section and the LMS course via the Course IDs.
LTI Best Practice
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=LTI Best Practice|nopanel=true
Best Practice: Use a Text Editor
Configuring the LTI connection between the ESS and an LMS involves copying several items from the ESS to the LMS. These items must be exactly the same in both systems. To reduce errors, we recommend using copy/paste to transfer the information:
- Open Notepad or another editor.
- Copy the item from the ESS interface.
- Paste the item to the LMS.
Seeing Instructor View in LMS
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Seeing Instructor View in LMS|nopanel=true
The Instructor Must Be Properly Configured in the ESS to See the Instructor View
For instructors to be able to see the Instructor View of an EchoCenter page through the LMS, the following must be true for that user on the ESS:
- The Instructor must be configured as an Academic Staff user in the ESS.
- The Instructor must be configured as an Instructor on the section.
- The Instructor's user name and email address in the LMS must match the user name and email address in the ESS. For example an Instructor with the user name "instructor1" with the email address "instructor1@echo.com" in the ESS must also be "instructor1" in the LMS with the email address "instructor1@echo.com".
- The email address does not have to be valid (it can be a dummy address) but it does have to be unique to the user.
An Instructor not configured in this way sees the Student View of the EchoCenter.
Best Practice With Checklists
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=tip for checklists|nopanel=true
Best Practice: Print This Page
Print this page and mark off each item in the checklist as you complete it.
High-Level Description for Classroom Capture Software
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=High-Level Description for Classroom Capture Software|nopanel=true
Clasroom Capture is a Windows-only application suited for audio, video, and local screen capture from a dedicated podium or lectern PC inside the classroom.
Alternate Name for Classroom Capture Software
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Podium Capture and Capture Software|nopanel=true
Alternate name for Classroom Capture Software
As of EchoSystem 5.4, Classroom Capture has been incorporated as part of the Software Capture product for Windows, which also includes Personal Software Capture. In the documentation, it may be referred to as either Software Capture for the Classroom or Classroom Capture. In previous versions of EchoSystem, it is sometimes called EchoCapture Software, Software Capture, or Podium Capture.
Media Import tools and formats
Media Import Supports Stereo Audio Only
Media import does not support multi-channel audio.
Echo360 supports the file types listed below. These have been tested.
Echo360 will add support for additional tools and formats. If you use a format not listed here, you can attempt to ingest it. Other formats may work although they have not been tested. If the format you use fails to process correctly, please enter a support request.
Audio and Video / Audio and Screen
The following table lists the currently tested and supported combination audio and video file types.
Tool |
Video File Format |
Video Codec |
Audio Codec |
---|---|---|---|
Camtasia Studio 7 (PC) |
AVI |
CVID, TSCC |
PCM |
– |
FLV |
VP6F |
MP3 |
– |
M4V |
H.264 |
AAC |
– |
MP4 |
H.264, AVC1 |
AAC |
– |
MOV |
H.264, MPEG-4 (mp4v), DV |
AAC, MPEG-4 (mp4a) |
– |
WMV |
WMV9 |
WMA |
Apple QuickTime |
MOV |
H.264, MPEG-4 |
AAC |
– |
MP4 |
H.264, MPEG-4 |
AAC |
– |
M4V |
H.264 |
AAC |
Apple iMovie |
M4V |
H.264 |
AAC |
Adobe Premier |
AVI |
DV |
PCM |
– |
MOV |
H.264, CVID |
AAC, PCM |
Microsoft Expression Studio 4 |
WMV |
WMV9, VC1 |
WMA9 |
Flip Video - Mino HD |
MP4 |
H.264 |
AAC |
Logitech Web Cam Software (PC) |
WMV |
WMV2 |
WMA2 |
Cam Studio (PC) |
AVI |
CVID |
PCM |
Audio Only
The following table lists the currently tested and supported audio only file types.
Audio File Format |
Audio Codec |
---|---|
MP3 |
MP3 |
WMA |
WMA2 |
Best Practice - Establish a Temporary Storage Location
When you reprocess a file or edit media, the ESS makes a copy of the original file and stores it in the .tmp directory. The ESS takes this precaution so the original file can be recovered if the reprocess or edit operation fails. However, it is possible for the .tmp directory to become full. To avoid this possibility, we recommend that you (or your System Administrator) edit the wrapper.conf file to establish a temporary storage location when you install the server.
Add the Trusted System in the ESS
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Add the Trusted System|nopanel=true
- Log in to the ESS as an Administrator.
- Navigate to System > Trusted Systems.
- Click Add. The Add Trusted System page appears.
- 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.
- 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 (==).
- Click Done.
Add the Blackboard Publisher in the ESS
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Add the Blackboard Publisher in the ESS|nopanel=true
- Log in to the ESS as an administrator.
- Navigate to Configuration > Publishers.
- Click Add. The Add Publisher page appears.
- 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 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.
- If you want Blackboard Learning Management System Enterprise 7.3-9.1 to be your default publisher, select the Use by Default box.
- In the Connection Properties group, select the Use Seamless Login check box to enable the module.
- 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
https://ess.echostate.edu/Blackboard
Shared Secret
Enter the shared secret you (or the Blackboard administrator) created in the building block.
–
- 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.
- 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 Manage the EchoCenter for details on this feature.
- Publish Individual Links means that Blackboard will display Echoes in the default Blackboard format.
- Click Save to commit your edits.
- Publish a course to Blackboard to verify that the building block is correctly configured.
Add Blackboard to Each Section
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Add Blackboard to Each Section|nopanel=true
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.
- Get the Blackboard Course ID.
- In Blackboard, navigate to System Admin > Courses.
- Note the Course ID.
- In the ESS, navigate to the Section Details page.
- Scroll to the bottom of the page.
- Click Add Publisher.
- On the Add Publisher page:
- Select Blackboard as the publisher
- Enter the Course ID in the CMS ID field.
- Click Save.
Best Practice: Work With the LDAP Server Administrator
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Best Practice: Work With the LDAP Server Administrator|nopanel=true
Best Practice: Work With the LDAP Server Administrator
Invite the LDAP server Administrator to work with you when you create the 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.
Note to Use When You Refer to the Knowledge Base
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Note to Use When You Refer to the Knowledge Base|nopanel=true
Edit this standard text when making the reference to the KB. It is OK to use the complicated SalesForce URL in the URL to the article.
This KB (Knowledge Base) article explains the process of configuring the most recent version of Wowza Media Server in "external" mode, so that it will operate 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.
Classroom Capture Supported Inputs
- Audio (A)
- Audio/Video (A/V)
- Audio/Display (A/D)
- Audio/Display/Video (A/D/V)
- Audio/Video/Video (A/V/V)
Restart the ESS Service
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Restart the ESS|nopanel=true
You will have to restart the ESS service or daemon during the configuration process and at certain other times. Follow the instructions for your platform.
Expect to Wait
After a restart, you may have to wait for a few minutes before the EchoSystem Server becomes responsive.
Restart ESS on Windows
- From the Windows taskbar select Start > Programs > Administrative Tools > Services.
- The Services dialog opens. Select the EchoSystem Server service.
- Click Restart. The ESS service restarts on your local computer.
Restart ESS on Linux
- Open a terminal prompt.
- Type the restart command. Be sure to include the space between the file name and the restart command.
sudo /etc/init.d/echosystemserverd.sh restart
- Notice the status messages showing that the service stops and starts.
Best Practice: Implement EchoCenter Publishing
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=Best Practice: Implement EchoCenter Publishing|nopanel=true
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 pages for students and Instructors.
- For students: Access to discussions and course notes (bookmarks).
- For students and Instructors: Access to live webcasts (if offered by the section).
- For instructors: Most student features plus access to course statistics, engagement analytics, and Echo-specific heat maps.
LDAP Security Module
To add the text in this section to a page, copy the text below and surround it with curly brackets.
multi-excerpt-include:pageTitle=Include Library|name=LDAP Security Module|nopanel=true
Invite the LDAP Administrator to work with you or consult with the Administrator before you begin.
- Ask the LDAP Administrator how to configure these fields:
- LDAP URL.
- Manager DN. Some LDAP Administrators set up a special user name and password for LDAP testing.
- Manager Password.
- Base Group DN.
- User Name Attribute
- Base User DN.
- Discuss adding extra security to certain sections with the LDAP Administrator. If you decide to do so, ask the LDAP Administrator how to configure these fields:
- Required Extra User Attribute Value
- Extra User Attribute Name
- You may want to print the screenshot below and have the LDAP Administrator annotate it with the correct input data for each field.
How to Use the Multi-Excerpt Plugin
Doc on the multi-excerpt plugin: https://studio.plugins.atlassian.com/wiki/display/CMEP/Confluence+Multi-Excerpt+Plugin#ConfluenceMulti-ExcerptPlugin-Onthepagewithtextyouwishtohaveincludedelsewhere%3A