Sierra Video DashBoard Control System User Manual
Ross Video Limited
DashBoard Control System
User Manual
8351DR-004-03 • DashBoard Control System User Manual
• Ross Part Number: 8351DR-004-03
• Release Date: November 23, 2009. Printed in Canada.
The information contained in this manual is subject to change without notice or obligation.
Copyright
© 2009 Ross Video Limited. All rights reserved.
Contents of this publication may not be reproduced in any form without the written permission of
Ross Video Limited. Reproduction or reverse engineering of copyrighted software is prohibited.
Patents
This product is protected by the following US Patents: 4,205,346; 5,115,314; 5,280,346;
5,561,404; 7,034,886; 7,508,455. This product is protected by the following Canadian Patents:
2039277; 1237518; 1127289. Other patents pending.
Notice
The material in this manual is furnished for informational use only. It is subject to change without
notice and should not be construed as commitment by Ross Video Limited. Ross Video Limited
assumes no responsibility or liability for errors or inaccuracies that may appear in this manual.
Trademarks
• is a registered trademark of Ross Video Limited.
• Ross, ROSS, ROSS®, and MLE are registered trademarks of Ross Video Limited.
• DashBoard Control System™ is a trademark of Ross Video Limited.
• Java and all Java-based marks are trademarks or registered trademarks of Sun
Microsystems, Inc. in the United States and other countries. Ross Video Limited is
independent of Sun Microsystems, Inc.
• Apple® Mac OS®, Leopard®, and Snow Leopard™ are trademarks of Apple Computer,
Inc., registered in the U.S. and other countries.
• Microsoft®, Internet Explorer®, and Windows® are either registered trademarks or
trademarks of Microsoft Corporation in the U.S.A. and/or other countries.
• Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
• All other product names and any registered and unregistered trademarks mentioned in
this guide are used for identification purposes only and remain the exclusive property of
their respective owners.
Environmental Information
The equipment that you purchased required the extraction and use of natural resources for its
production. It may contain hazardous substances that could impact health and the environment.
To avoid the potential release of those substances into the environment and to diminish the need
for the extraction of natural resources, Ross Video encourages you to use the appropriate
take-back systems. These systems will reuse or recycle most of the materials from your
end-of-life equipment in an environmentally friendly and health conscious manner.
The crossed-out wheeled bin symbol invites you to use these systems.
If you need more information on the collection, reuse, and recycling systems, please contact your
local or regional waste administration.
You can also contact Ross Video for more information on the environmental performances of our
products.
Company Address
Ross Video Limited
8 John Street
Iroquois, Ontario
Canada, K0E 1K0
General Business Office: (+1) 613 • 652 • 4886
Technical Support: (+1) 613 • 652 • 4886
After Hours Emergency: (+1) 613 • 349 • 0006
E-mail (Technical Support): techsupport@rossvideo.com
E-mail (General Information): solutions@rossvideo.com
Website: http://www.rossvideo.com
Ross Video Incorporated
P.O. Box 880
Ogdensburg, New York
USA 13669-0880
Fax: (+1) 613 • 652 • 4425
Contents
Introduction 1
Overview ............................................................................................................... 1-1
Features.................................................................................................................. 1-2
Documentation Terms and Conventions ............................................................... 1-2
Installing DashBoard 2
Before You Begin ................................................................................................................2-2
System Requirements ............................................................................................ 2-2
Installing the DashBoard Control System Software ............................................................ 2-3
Creating a Backup of the Settings and Licensed Features .................................... 2-3
Installing on a Computer Running Microsoft® Windows® ................................. 2-3
Installing on a Computer Running Apple® Mac® OS® ...................................... 2-4
Installing on a Computer Running Linux® Fedora®............................................ 2-4
Removing DashBoard ........................................................................................... 2-5
Installing DashBoard Add-on Programs ............................................................... 2-5
Activating DashBoard Licensed Features............................................................................ 2-6
Activating DashBoard Licensed Features ............................................................. 2-6
Creating a Backup of your Licensed Features....................................................... 2-7
Restoring your Licensed Features ......................................................................... 2-7
Viewing Installation Details ................................................................................................ 2-8
DashBoard Installation Details Overview ............................................................. 2-8
Viewing Installation Details .................................................................................. 2-8
Viewing Error Logs............................................................................................... 2-9
Managing openGear Frames in DashBoard 3
Managing openGear Frames in DashBoard......................................................................... 3-2
Adding openGear Frames to DashBoard............................................................... 3-2
Re-naming an openGear Frame in the Tree View................................................. 3-3
Removing openGear Frames from a Tree View.................................................... 3-4
Using the DashBoard Interface 4
DashBoard Interface Overview ........................................................................................... 4-2
Status Indicators .................................................................................................... 4-3
DashBoard Basic Tree View................................................................................................ 4-4
Overview ............................................................................................................... 4-4
Using the Basic Tree View.................................................................................... 4-5
Using Custom Folders in the DB View ............................................................................... 4-6
Overview ............................................................................................................... 4-6
Using the DB View ............................................................................................... 4-8
The Device View Area ........................................................................................................ 4-9
Overview ............................................................................................................... 4-9
Using the Device View........................................................................................ 4-10
Using Layouts .................................................................................................................... 4-11
Overview ............................................................................................................. 4-11
DashBoard User Manual (Iss. 03) Contents • i
Managing Your Layouts ......................................................................................4-12
Deleting a Layout ................................................................................................4-12
Using DashBoard Help ......................................................................................................4-13
Configuring the DashBoard Help Display Options ............................................. 4-13
Importing openGear Help ....................................................................................4-14
Preferences .........................................................................................................................4-16
Secure Storage .....................................................................................................4-16
Web Browser .......................................................................................................4-16
DataSafe™ 5
DataSafe Overview ..............................................................................................................5-2
DataSafe Basics....................................................................................................................5-4
Saving a DataSafe File........................................................................................... 5-4
Restoring Configurations to Devices.....................................................................5-5
Notes on Saving and Restoring Parameters...........................................................5-6
Forcing DataSafe Updates ..................................................................................... 5-7
Configuring Devices 6
Configuring Devices in DashBoard ..................................................................................... 6-2
Configuring Devices in DashBoard.......................................................................6-2
Re-naming an openGear Slot in the Tree View.....................................................6-2
Automatic Discovery .............................................................................................6-3
Troubleshooting..................................................................................................... 6-4
Removing Offline Devices .................................................................................... 6-4
Upgrading Device Software.................................................................................................6-5
Upgrading Device Software ..................................................................................6-5
Troubleshooting the Software Upload Process......................................................6-6
ii • Contents DashBoard User Manual (Iss. 03)
Introduction
In This Chapter
This chapter contains the following sections:
• A Word of Thanks
• Overview
A Word of Thanks
Congratulations on choosing the DashBoard Control System™. DashBoard is part of a full line of
Digital Products within the openGear Terminal Equipment family of products, backed by Ross
Video's experience in engineering and design expertise since 1974.
You will be pleased at how DashBoard fits into your overall working environment. Equally
pleasing is the product quality, reliability and functionality. Thank you for joining the group of
worldwide satisfied Ross Video customers!
Should you have a question pertaining to the installation or operation of DashBoard, please
contact us at the numbers listed on the back cover of this manual. Our technical support staff is
always available for consultation, training, or service.
Overview
The DFR-8300 series frames offers remote control and monitoring with the combination of the
openGear Network Interface card and the DashBoard Control System™. This allows users to
remotely monitor and control parameters on openGear devices that support remote control.
The DashBoard Control System is built on Ethernet and TCP/IP technology, which allows remote
access across LAN architectures.
Monitoring
A network of openGear frames and cards can be monitored, allowing users to quickly isolate and
correct potential problems from a central monitoring station.
Control
DashBoard offers real-time control of openGear card parameters. Parameter types vary
depending on card functionality.
DashBoard User Manual (Iss. 03) Introduction • 1–1
DataSafe™
DataSafe enables you to backup and restore card parameters to and from a single file, copy
parameters from one card to a another card or even a group of cards via DashBoard. This feature
allows you to hot-swap cards while retaining configurations, and DashBoard is not required to
have the parameters on the new card updated. You can update a subset of devices instead of the
entire connected view or to replace a card and have the previous card settings automatically
loaded onto the new card. This feature is available for frames using the MFC-8310-N and
MFC-8320-N series cards only.
Software Upgrades
Most openGear cards can be upgraded, both software and firmware, in the field using DashBoard.
The upgrade utility verifies firmware and software upgrades against card hardware in the frame
and prevents accidental loading of incorrect files to the wrong hardware. DashBoard is designed
to allow for future feature plug-ins and upgrades to allow users the ability to customize control
and monitoring needs.
Features
The following features make DashBoard a unique system for your openGear requirements:
• DashBoard software and manual are available for download from the Ross Video website
• Store and upload configurations to multiple cards (using DataSafe)
• Customize views with the installation of the Advanced Tree View licensed feature
• Java™ based for installation in Microsoft Windows®, Mac® OS, and Linux® Fedora®
• Multiple openGear frames on a single control network
• Multiple DashBoard applications on a single control network
• Automatic discovery of frames and devices
• Software and firmware upgrades via ethernet
• Extensible plug-in architecture
Documentation Terms and Conventions
The following terms and conventions are used throughout this manual:
•“Frame” refers to any openGear frame within your video system.
• All references to the DFR-8300 series frame also includes all version of the 10-slot and
20-slot frames and any available options.
•“User” refers to the person who uses DashBoard.
•“Card” refers to openGear terminal devices within openGear frames, including all
components and switches.
•“Network Controller Card” refers to the MFC-8310-N series and MFC-8320-N series
cards unless otherwise noted.
•“System” refers to the mix of interconnected production and terminal equipment in your
environment.
•“Device” refers to an openGear frame or card listed in DashBoard.
•“Tree View” refers to the Basic Tree View and Advanced Tree View unless otherwise
noted.
•“DashBoard window” refers to the main DashBoard interface.
1–2 • Introduction DashBoard User Manual (Iss. 03)
• Navigation procedures in this manual assume that you are running Microsoft Windows®.
If you are running Mac® OS or Linux® Fedora®, the menus names and options may
differ.
• Some navigation procedures in this manual state the menu items, located on the main
DashBoard toolbar, you are to select followed by the “>” symbol.
•“Operating Tips” and “Note” boxes are used throughout this manual to provide
additional information.
DashBoard User Manual (Iss. 03) Introduction • 1–3
1–4 • Introduction DashBoard User Manual (Iss. 03)
Installing DashBoard
In This Chapter
This chapter provides instructions for installing the DashBoard Control System software.
The following topics are discussed:
• Before You Begin
• Installing the DashBoard Control System Software
• Activating DashBoard Licensed Features
• Viewing Installation Details
DashBoard User Manual (Iss. 03) Installing DashBoard • 2–1
Before You Begin
Before installing any software for your DashBoard Control System, ensure that you exit all other
programs currently running.
Note — Contact your I.T. Department if you experience communication issues with
DashBoard and are running anti-virus software. You may need to verify that there is
an exception in your firewall to allow DashBoard to receive UPD data via Port 427.
System Requirements
Refer to the following sections for information on the system requirements for DashBoard.
Microsoft® Windows® XP/XP64/Vista/Vista64 Systems
The following are the minimum requirements when installing DashBoard on a Microsoft®
Windows® system:
• Intel® Pentium 4, 1.6GHz (Intel® Core™ 2 Duo recommended)
• 1GB or more of RAM (2GB is recommended)
• 200MB available in HD space
• Microsoft® Internet Explorer® version 5 (minimum)
Apple Mac® OS X 10.5 (Leopard®) / 10.6 (Snow Leopard™) Systems
The following are the minimum requirements when installing DashBoard on a Mac® OS system:
• Intel® Core Duo processor
• 1GB or more of RAM (2GB is recommended)
• 200MB available HD space
• Java® 6 installed
• Mac® Safari®
Linux® Fedora® 9/10/11 Systems
The following are the minimum requirements when installing DashBoard on a Linux® system:
• Intel® Pentium 4, 1.6GHz (Intel® Core™ 2 Duo recommended)
• 1GB or more of RAM (2GB is recommended)
• 200MB available in HD space
• Version 2.2.1 GTK+ widget toolkit and associated libraries (GLib, Pango) are required
• Mozilla® 1.4GTK2 or higher
2–2 • Installing DashBoard DashBoard User Manual (Iss. 03)
Installing the DashBoard Control System Software
This section includes instructions on installing DashBoard to your computer. The DashBoard
software and user manual are available from the openGear website (www.opengear.tv).
Creating a Backup of the Settings and Licensed Features
Regular backups of your DashBoard settings is recommended, or if you want to create a backup
of your DashBoard settings and license files, before installing a new version of DashBoard.
• Microsoft® Windows® — DashBoard automatically uninstalls a previously installed
version, but not your settings.
› To create a back up your settings Microsoft® XP® and earlier, navigate to the
metadata folder located at c:\Program Files\DashBoard\ workspace and copy the
folder contents to a new location.
› If you are running Microsoft® Vista® or higher, the metadata folder is at:
c:\openGear\DashBoard\workspace. Copy the folder to a new location.
• Apple® Mac® OS® — DashBoard saves application information to the following
location on your computer: /Library/Application Support/openGear/DashBoard. To
create a backup of your settings, copy the workspace folder to a different location on
your system.
• Linux® Fedora® — DashBoard creates a workspace directory inside of the current
DashBoard directory when the application is launched. To create a backup copy of your
settings, copy the workspace directory to a different location on your system.
Installing on a Computer Running Microsoft® Windows®
Note that if you are running Microsoft® Vista® or higher, the DashBoard main folder is at:
c:\openGear\DashBoard while previous Microsoft operating systems will install DashBoard to
c:\Program Files\DashBoard.
Use the following procedure to install DashBoard on a computer running Microsoft Windows®:
Note — If you are upgrading your DashBoard Control System to software version
2.0, or higher, the Install Wizard automatically uninstalls any previous software
versions before proceeding.
1. Access the DashBoard software using one of the following methods:
• Navigate to the openGear website (www.opengear.tv) and download the current
software file.
• Load the DashBoard software CD into the DVD/CD ROM tray of your computer.
2. If you are accessing the software from a CD, the Installation Wizard automatically
runs. If the Wizard does not automatically run, you can also install the DashBoard
software, navigate to your DVD/CD ROM drive in the Navigation Pane, so that the CD
contents are displayed in the Main Window of Windows Explorer.
3. Launch DB3.0.0-Win-setup.exe to begin installing the DashBoard program onto your
computer.
4. Follow the prompts to complete the installation of DashBoard onto your computer.
This completes the procedure for installing DashBoard on a computer running Microsoft
Windows®.
DashBoard User Manual (Iss. 03) Installing DashBoard • 2–3
Installing on a Computer Running Apple® Mac® OS®
Use the following procedure to install DashBoard on a computer running Apple® Mac® OS®:
1. If you have a previous version of DashBoard installed, it is recommended that you
remove the DashBoard directory from the Applications folder before proceeding.
2. Access the DashBoard software using one of the following methods:
• Navigate to the openGear website (www.opengear.tv) and click the link to the
DashBoard installation program for Apple OS X. The DashBoard application is
automatically saved to your Downloads folder.
• Load the DashBoard software CD into the DVD/CD ROM tray of your computer
and navigate to the DashBoard *.zip file for Apple OS X.
3. Open a Finder on your desktop.
4. Navigate to the Applications directory.
5. Drag and drop the downloaded DashBoard folder into the Applications directory.
6. Double-click the *.zip file to extract the files.
This completes the procedure for installing DashBoard on a computer running Mac® OS®.
Installing on a Computer Running Linux® Fedora®
Use the following procedure to install DashBoard on a computer running Linux® Fedora®:
1. If you have a previous version of DashBoard installed and want to keep your settings,
remove all folders, except the workspace directory, from the DashBoard directory. Note
that the uninstall function of DashBoard may delete the directory that also contains your
user data.
2. Access the DashBoard software using one of the following methods:
• Navigate to the openGear website (www.opengear.tv) and click the link to the
DashBoard.tar.gz file for Linux.
• Load the DashBoard software CD into the DVD/CD ROM tray of your computer.
3. Extract the new DashBoard.tar.gz file to your system. Note that this file contains a
top-level directory called DashBoard.
4. To run DashBoard, click the DashBoard icon in the top level of the DashBoard program
folder. Note that if you run DashBoard from the command line, ensure that you switch to
the main DashBoard directory before launching DashBoard.
This completes the procedure for installing DashBoard on a computer running Linux® Fedora®.
Note — Dashboard creates a workspace directory where the application is
launched. This directory includes saved settings and licenses for optional features. To
provide consistent retrieval of saved settings and program features, Ross Video
recommends that you always launch Dashboard from within the same directory.
2–4 • Installing DashBoard DashBoard User Manual (Iss. 03)
Removing DashBoard
Ensure to create a backup for your settings and licensed features as outlined the section
“Creating a Backup of the Settings and Licensed Features” on page 2-3 if you wish to retain
your user data before removing DashBoard from your computer.
To remove DashBoard from a computer running Microsoft® Windows®:
• If you are using a computer running Microsoft® Windows®, use the Add/Remove
Software program located in the Windows® Control Panel.
• Do not delete the DashBoard directory, instead run the Add/Remove Software program.
Deleting the directory without running the Add/Remove Software program results in a
number of dead registry and start menu items on your system. You can delete the
directory to remove your user data after you run the Add/Remove Software program.
To remove DashBoard from a computer running Apple® OS X®:
• Remove your user data from the application support library directory.
• Delete the Dashboard folder from your computer.
To remove DashBoard from a computer running Linux® Fedora®:
• Ensure to create a backup for your settings and licensed features if you wish to retain
your user data.
• Delete the Dashboard folder from your computer.
Installing DashBoard Add-on Programs
This section briefly outlines how to install Add-on programs for DashBoard such as:
• openGear Extra Feature Pack — If you have an executable openGear Extra Feature
pack, and are running Microsoft® Windows®, use the following procedure to install your
feature pack. If you are not running Microsoft® Windows®, refer to the feature pack
documentation for installation details.
• Unicode Font Support Pack — This program installs an international character set for
DashBoard and provides access to fonts capable of displaying all Unicode characters.
This program is not available for systems running Apple Mac® OS®. This option may be
required if you are using an openGear device designed with fonts not supported by the
base Java font system. Consult your device documentation for requirements and details.
Use the following procedure to install a DashBoard Add-on program:
1. Navigate to the openGear website (www.opengear.tv) and download the required add-on
program for your system.
2. If you are running Microsoft® Windows®:
• Launch the Setup Wizard for your Add-on program by selecting the corresponding
*.exe file.
• Follow the prompts to complete the installation of the Add-on program.
3. If you are running Linux® Fedora®:
• Ensure you are in the main DashBoard directory before extracting the Add-on
program.
• Copy the required *.zip to the main DashBoard directory.
• Extract the *.zip file.
This completes the procedure for installing a DashBoard Add-on program.
DashBoard User Manual (Iss. 03) Installing DashBoard • 2–5
Activating DashBoard Licensed Features
This section outlines how to install software keys to access DashBoard features such as the DB
View. The required DashBoard software licenses must be purchased from your Ross Video sales
representative before activating DashBoard licensed features.
Operating Tip — DashBoard does not require that you install any of the optional
licensed features.
Activating DashBoard Licensed Features
Use the following procedure to install a software license for a DashBoard feature:
1. Launch the DashBoard software by selecting the DashBoard icon on your desktop.
2. Select the feature you wish to license as follows:
• From the main toolbar, select Window > Preferences.
•From the Preferences dialog box, select Licensed Features. A list of available
licenses is displayed in the Licensed Features dialog box and is organized into
subfolders. The Active subfolder includes those features currently installed on your
computer. The Available subfolder lists the new features you can install on your
computer.
3. From the Available subfolder, click the feature to license.
4. From the Licensed Features dialog box, click Install/Update License to open the
Enter License Key dialog box. The Enter License Key dialog box can include your
Request Code, and Hardware ID. You need this information when contacting Ross
Video Technical Support. To print the information in the dialog box, click Print.
Figure 2.1 Enter License Key Dialog Box
5. Contact Ross Video Technical Support using the contact information in the section,
“Company Address”. Ensure that you have the following information from the Enter
License Key dialog box: Request Code, Hardware ID, and Feature ID.
6. When you speak to our Technical Support representative, tell them your name, your
facility name, and the Request Code as listed on the Enter License Key dialog box.
7. If you received a license key, enter the License Key in the License Key field.
8. If you received a License file (*.keypack), click Install License Key Pack and follow
the on-screen instructions in the Install License Key Pack dialog box.
2–6 • Installing DashBoard DashBoard User Manual (Iss. 03)
9. Click Install to begin installing the key for the DashBoard software license. When the
installation is complete, the License Installed dialog box opens.
10. Click OK.
This completes the procedure for installing a software license for a DashBoard feature. For
information on updating installed licensed features, refer to the section “Updating DashBoard
Features” on page 7-4.
Creating a Backup of your Licensed Features
Use the following procedure to create a backup file of your licensed features:
1. From the main DashBoard toolbar, select Window > Preferences.
2. From the Preferences dialog box, select Licensed Features.
3. Click Create Backup to display the Save dialog box.
4. Navigate to the location you wish to save your backup file to.
5. Enter a name for your backup file in the File Name: field.
6. Click Save.
This completes the procedure for creating a backup file of your licensed features.
Restoring your Licensed Features
Use the following procedure to restore your licensed features from a backup file:
1. From the main DashBoard toolbar, select Window > Preferences.
2. From the Preferences dialog box, select Licensed Features.
3. Click Restore From Backup to display the Install License Key Pack dialog box.
4. Click Browse to navigate to the backup file you wish to use. The window below the
Key Pack: field lists the licensed features included in the selected backup file.
5. Click Install.
This completes the procedure for restoring your licensed features from a backup file.
DashBoard User Manual (Iss. 03) Installing DashBoard • 2–7
Loading...