Administrator's Guide-V5-20180613 - 1435
Administrator's Guide-V5-20180613 - 1435
6
Administrator's Guide
HVS-ID-AG-HMP-26, Issue 03
Edition Notice
© 2015-2018 Haivision. All rights reserved.
This edition and the products it describes contain proprietary and confidential information. No part
of this content may be copied, photocopied, reproduced, translated or reduced to any electronic or
machine-readable format without prior written permission of Haivision. If this content is distributed
with software that includes an end-user agreement, this content and the software described in it,
are furnished under license and may be used or copied only in accordance with the terms of that
license. Except as permitted by any such license, no part of this content may be reproduced, stored
in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical,
recording, or otherwise, without the prior written permission of Haivision Systems, Inc. Please note
that the content is protected under copyright law even if it is not distributed with software that
includes an end-user license agreement.
About Haivision
Founded in 2004, Haivision is now a market leader in enterprise video and video streaming
technologies. We help the world’s top organizations communicate, collaborate and educate.
Recognized as one of the most influential companies in video by Streaming Media and one of the
fastest growing companies by Deloitte’s Technology Fast 500, organizations big and small rely on
Haivision solutions to deliver video. Headquartered in Montreal, Canada, and Chicago, USA, we
support our global customers with regional offices located throughout the United States, Europe,
Asia and South America.
Trademarks
The Haivision logo, Haivision, and certain other marks are trademarks of Haivision. CoolSign is a
registered trademark licensed to Haivision Systems, Inc. All other brand or product names
identified in this document are trademarks or registered trademarks of their respective companies
or organizations.
Disclaimer
The information contained herein is subject to change without notice. Haivision assumes no
responsibility for any damages arising from the use of this content, including but not limited to, lost
revenue, lost data, claims by third parties, or other damages.
If you have comments or suggestions, please contact infodev@haivision.com.
Chapter 2: Introduction
Haivision Media Platform Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Product Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Product Editions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Multicast Support via Haivision Helper and Multicast Agent . . . . . . . . . . . . . . . . . . . . . . . 17
HMP-Media Gateway Pairing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
SRT (Secure Reliable Transport) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Appliance Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Physical Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
System Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
LED Status Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Chapter 7: Reporting
Viewing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Reports and Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Viewing System Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Appendix B: Warranties
Action Alerts
The following alerts are used to advise and counsel that special actions should be taken.
TIP
Indicates highlights, suggestions, or helpful hints.
NOTE
Indicates a note containing special instructions or information that may apply only in special cases.
IMPORTANT
Indicates an emphasized note. It provides information that you should be particularly aware of in order
to complete a task and that should not be disregarded. This alert is typically used to prevent loss of
data.
CAUTION
Indicates a potentially hazardous situation which, if not avoided, may result in damage to data or
equipment. It may also be used to alert against unsafe practices.
Obtaining Documentation
This document was generated from the Haivision InfoCenter. To ensure you are reading the most
up-to-date version of this content, access the documentation online at https://doc.haivision.com.
You may generate a PDF at any time of the current content. See the footer of the page for the date
it was generated.
The Modern player supports a Flash fallback mode for older browsers that do not support
HTML5 video.
The Modern player may require slightly more buffering time than the Legacy player, due to
differences in HLS vs. RTMP.
By default, new Distribution Policies include the Default Location so that authenticated users
in locations that are not specifically included in the Distribution Policy are still able to receive
the stream.
For systems upgraded to v2.6: All existing sessions will follow the existing Location
Topology (i.e., all sessions and events are distributed to all locations).
Replace the Haivision graphics (large shark and small brand) that appear on the signin
page.
Replace the Haivision banner graphic at top left of the Web Interface.
Replace the "favicon" application icon that certain browsers display in the tabs and
bookmarks.
Change the color of the top blue banner.
A WYSIWYG editor has been enabled for the content description field, with support for rich
text editing (bold, lists, inline images, etc.) and hyperlinks (open new browser tab/window).
See "Editing Information and Metadata" in the Haivision Media Platform User's Guide
(Chapter 2: "Getting Started").
NOTE
The intended audience for this guide is system integrators and administrators with administrative
privileges.
For information on options available to non-administrative users, such as browsing content, working
with sessions and videos, managing Portal content, and managing imports and exports, please refer
to the Haivision Media Platform User's Guide.
IMPORTANT
Because HMP capabilities vary by Edition (i.e., Workgroup, Site or Enterprise), some features
mentioned in this guide may not be available on your system. For more information, see Product
Editions (page 16).
Topics Discussed
Haivision Media Platform Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Product Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Product Editions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Multicast Support via Haivision Helper and Multicast Agent . . . . . . . . . . . . . . . . . . . . . 17
HMP-Media Gateway Pairing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
SRT (Secure Reliable Transport) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Appliance Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Physical Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
System Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
LED Status Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Product Features
Key Haivision Media Platform features include the following:
Broadcast live all hands and town hall meetings so employees can watch from remote
offices, off-site locations or on the road.
Live stream and record multiple HD sources simultaneously for multi-view, real-time
monitoring.
Deliver broadcast TV channels along with live internal content throughout your organization.
Share videos and pre-recorded content (Video-On-Demand) with authenticated viewers.
Permission-Based Authentication
Support for Active Directory, LDAP and SSO ensures that administrators can easily and securely
provision employees and set-top boxes with access to the designated content.
Security
Protect live and on-demand content from unauthorized viewing, copying, and redistribution with
glass-to-glass AES 128/256 encryption.
Metadata Tagging
Apply file-based and real-time metadata tags and keywords to make important content easy to find
and manage.
Hybrid/Cloud
On-premise, cloud and hybrid video distribution options fit your unique needs and network
infrastructure.
SRT
Haivision's SRT (Secure Reliable Transport) technology enables the delivery of encrypted, high
performance video over the public Internet.
Enterprise Integration
Easily publish live and on-demand video to third-party portals such as Microsoft Share Point.
Enterprise Edition
Broadcast and Record All Hands, Town Halls and Internal Live Events Across Multiple
Locations
The Haivision Media Platform Enterprise Edition enables you to securely distribute live and on-
demand broadcast-quality video, such as CEO all-hands, company events, HR updates, product
launches and IPTV to employees watching on any screen at headquarters, remote offices, and on
the road.
Site Edition
Distribute IPTV and Live Corporate Content to All Screens, Desktops and Devices in a
Single Location
The Haivision Media Platform Site Edition enables you to manage and deliver broadcast television
channels and other live content throughout your facility, including auditoriums, lobbies, break
rooms, and conference areas. The Site Edition is available in Base, Advanced, and Advanced VOD
versions, from 10 live channels/100 concurrent users maximum, to up to 500 live channels/500
concurrent users.
NOTE
Licensed features per Edition include the maximum number of sources/IPTV channels, maximum
number of concurrent recordings, and Video On Demand (VOD).
Haivision Media Platform Editions are expandable through licensing, for example, additional 2,500 user
/device license packs, or 5 recording channel packs. For detailed information, please refer to
Haivision's website at: http://www.haivision.com
With Multicast Support on systems running the Haivision Helper application, HMP delivers a
multicast agent to the user who receives a multicast Transport Stream and delivers a Web
standard stream to the user's local Web browser. This helps reduce overbandwidth consumption
on multicast enabled LANs.
Following is a description of the process by which the Helper launches the multicast agent and
enables multicast support:
1. Request to Watch Multicast Video: The end user clicks a link to a live video asset in their
browser (on the HMP Portal or embedded player).
NOTE
The remaining steps are invisible to users.
2. If the event is available as a multicast stream, Haivision Helper on the end user's PC/Mac
takes over. If the event is not multicast, or Haivision Helper is not available, the end user
receives standard unicast in the browser.
4. Multicast TS Video: The multicast agent joins the Multicast Group, and negotiates access
and encryption for the video.
5. RTMP Video: The multicast agent converts the stream from Multicast TS to Native Web
Video (RTMP is used for low latency), and the RTMP stream is delivered securely to the
local browser over local host (all within the user's PC/Mac).
NOTE
For the latest information, please refer to the Haivision Helper Installation Guide, available from the
Haivision Support Portal.
Appliance Options
Haivision Media Platform is available either as a 1U or 2U appliance (shown in the following
figures).
Haivision Media Platform 1U System
For more information, see the following section, Physical Description (page 21).
Physical Description
Haivision Media Platform servers come delivered as enterprise-ready, ultra-compact appliances
made for single-tier architectures. The following sections describe the interfaces and LED status
indicators.
NOTE
To install and connect to your Haivision Media Platform physical server or VMware server, please
refer to the Haivision Media Platform Quick Start Guide.
System Interface
Haivision Media Platform provides either two or four 1 Gb Ethernet (GbE) Network Interface Card
(NIC) ports for both traffic and management.
1U System LEDs
Indicator Icon Description
Front Panel
Power-On Power-on indicator lights when the system power is on. The Power button controls
the power supply output to the system.
LCD Panel Displays system ID, status information, and system error messages.
• LCD lights blue during normal system operation
• LCD lights amber when the system needs attention, and the LCD panel displays
an error code followed by descriptive text.
Front & Back Panel
System Can be used to locate a particular system within a rack. When one is pressed, the
Identification system status indicator on the back flashes until one of the buttons is pressed
Buttons again.
2U System LEDs
Indicator Icon Description
Front Panel
Power-On Power-on indicator lights when the system power is on. The Power button controls
the power supply output to the system.
IMPORTANT
Before proceeding, make sure that the appliance is set up correctly and all necessary network and A
/V connections are established.
For information on installing and connecting to your Haivision Media Platform physical or VMware
server, please refer to the Haivision Media Platform Quick Start Guide.
Topics Discussed
Accessing the HMP Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Navigating the Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Basic Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Editing Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Deleting Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Sharing Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1. Open a Web browser of your choice, such as Chrome, Firefox, Safari, Microsoft Edge, or
Internet Explorer (IE11).
2. Type the URL or IP address for HMP in the browser's address bar and press Enter.
NOTE
Haivision Media Platform ships with a default IP address of 10.5.1.3
3. If you see a Security Certificate warning, click Proceed anyway (or equivalent) to accept the
certificate and continue to the Sign-in screen.
4. On the Sign-in screen, type the Username and Password and click Sign In (or press Enter).
IMPORTANT
haiadmin is a special "system user" intended primarily for initial setup and system troubleshooting. It
is not intended for regular use because it has unrestricted access privileges that cannot be changed.
For day-to-day system control and administration, you are strongly advised to create a regular
(administrative) user with a secure password.
As a security measure, be sure to change the default password for the haiadmin account.
To change the current user password, click the user name on the banner (next to "Welcome").
Clicking on a recording in the list takes you to the Viewer for that recording.
TIP
To display a list of new Haivision Media Platform features, select What’s New from the
navigation drop-down menu. To adjust the brightness and contrast, or reset the Haivision
Media Platform browser cache, select User Preferences from the navigation drop-down
menu.
After successfully signing in, system integrators and administrators will need to go to the
Administration screen (see Configuring HMP (page 36).)
For an overview of the Web interface, including viewing and search options, see the
Haivision Media Platform User’s Guide.
Basic Actions
This section shows how to perform basic editing, deleting, and sharing tasks that recur throughout
HMP configuration and administration. These tasks may be applied to items such as feeds,
locations, and sources on the Administration screens.
Editing Items
To edit items:
Or you can check the checkbox next to one or more items (or check All) and select Edit
from the Actions drop-down menu (selectable when one or more items are checked).
NOTE
If you select multiple items, in some cases, the Edit menu option is not available, or the
Information pane contains only a limited subset of values such as the Description.
Selecting an item from the list opens the Information pane, such as the following Source
example.
TIP
When editing sessions (Content Library screen), you can also define Public Links. To do so,
click the Public Links tab. For details, see the Haivision Media Platform User’s Guide.
Deleting Items
To delete items:
1. Check the checkbox next to one or more items in the list (or check All).
3. Click Confirm (or where applicable, select Delete from the warning dialog).
Sharing Items
You can share items such as feeds, sources, videos, and sessions with other users or groups. You
can specify access permissions on a per-user or per-group basis. Sharing is defined on the Share
pane (by clicking the Share tab from the Information pane when setting up or editing an item).
For information on the default share permissions, see the Haivision Media Platform User's Guide
("Sharing Items"). For information on the adding and modifying share permissions, see Managing
Share Permissions (page 102).
To share items with a user or group:
1. Select an item in the list, or check the checkbox next to one or more items and select Edit
from the Actions drop-down menu.
2. On the Information pane, click the Share tab (as shown in the following Source example).
NOTE
Only users and groups that have been assigned roles appear in the autocomplete list.
The name is added to the Share list below, along with the selected permission.
5. Repeat for each user (or group) with whom you wish to share the item.
6. Click Save.
7. Click to return to the list.
From the Portal, viewers can browse feeds, search for items, and launch the video, session, or
source in a default viewer. For the Portal user workflow, see "Exploring the Web Interface" in the
Haivision Media Platform User's Guide.
From the Feeds pane, administrators can create, share, and manage Portal feeds, including
turning the Portal on and off.
Once the Portal is turned on, content managers can populate the feeds and promote items to
"Suggested" and "Featured" using the (Content Library) Feeds editor. For details, see "Managing
Feeds" in the Haivision Media Platform User's Guide.
1. On the Administration screen, click Configuration on the toolbar and then Feeds on the
sidebar.
The Feeds pane opens, displaying the list of defined feeds, if any (see following example).
2. To activate the Portal, toggle the Portal Access button to On.
The “Portal” option will be added to the navigation bar (next to Content Library).
3. To allow Feed permissions to take precedence over the Share Permissions assigned to
individual videos, sessions, or sources, toggle the Use Feed Permission button to On.
NOTE
By default, viewing permissions are enforced from the video asset itself, and users are
prevented from watching content that is not shared with them. However, the Use Feed
Permission toggle option allows administrators to reverse this.
This setting saves content managers from having to share all the individual items in feeds.
Instead they simply share the feed.
NOTE
See the note in the previous section re: Feed Permissions.
For details on populating the feeds using the (Content Library) Feeds editor, see “Managing Feeds”
in the Haivision Media Platform User’s Guide.
Managing Sources
A source is an incoming unicast or multicast video stream or IPTV channel that can be recorded or
viewed live. When setting up Haivision Media Platform, you need to define the streaming A/V
sources to be available for content creators and other users to view and capture.
When adding a source, you can assign a name, description, IP address and port, and protocol
type. By default, the source has an HMP receiver, but for multi-site live distribution, you can
associate the source with a Media Gateway receiver. When editing the source information, you can
add metadata as well as share the source with other users or groups.
The protocol types are UDP or SRT (Haivision's Secure Reliable Transport) streaming protocol.
With UDP, you can select multicast or unicast streaming. SRT optimizes streaming performance
across unpredictable networks, including the public Internet.
You can also configure the source to display EPG data on Haivision Play Set-Top Boxes from
Haivision servers.
1. On the Administration screen, click Configuration on the toolbar and then click Sources on
the sidebar.
The Sources list opens, displaying the list of defined sources for your platform (see following
example).
Configuring Sources
To add a source:
The fields vary depending on the Protocol Type selected and licensed features.
3. To configure the source for multi-site live distribution, select a Media Gateway from the
Receiver list of paired media gateways for your platform (if any, see Configuring HMP-Media
Gateway Pairings (page 64)).
4. To configure a source using the SRT streaming protocol, select SRT for the Type and then
fill in the additional fields. For details, see the "SRT Settings" heading in Source Settings
(page 44).
5. To enable the source for IPTV deployment, check the IPTV Channel checkbox.
6. To display EPG data on set-top boxes, toggle the EPG button to On and select the
Schedule. (EPG must be licensed on your system.)
To edit sources:
TIP
If you select multiple sources, you can only edit the Description field. To configure an SRT
source, see Configuring Secure Reliable Transport (SRT) Sources (page 46).
3. Click Save.
Metadata must be pre-defined on your system. See Configuring Metadata (page 69).
5. On the Source Metadata pane, select the applicable metadata and value(s) from the drop-
down list(s). See Source Settings (page 44).
NOTE
If you select multiple sources and the metadata has “mixed” (i.e., different) values, you will see
a warning across the top of the list and the metadata with mixed values will be displayed in red
(as shown in the following example).
CAUTION
Bulk edits cannot be undone. For information on bulk editing metadata, see "Editing
Information and Metadata" in the Haivision Media Platform User’s Guide.
7. Click Save.
8. To share sources, click the Share tab and follow the steps in Sharing Items (page 32).
Source Settings
The following table lists the Source configuration settings:
Source
Default Description/Values
Setting
Information
ID n/a HMP assigns a unique identifier (ID) to each source when it is defined.
NOTE: If you are using the HMP Command Line API, you will need to copy this
ID to add this source to a session.
Name date, Enter a name for the source. This name will be selectable on the Sources list
time when content creators define sessions.
Description n/a Enter a description for the source.
Receiver None To associate the source with a Media Gateway receiver for multi-site live
distribution, select a defined Media Gateway from the list (see Configuring Multi-
Site Live Distribution (page 66)).
NOTE: The default is the current HMP server.
Source
Default Description/Values
Setting
IP Address n/a Type in the IP address for the source
Port n/a Type in the port number for the source
Type UDP Select the protocol type, either:
UDP: User Datagram Protocol
SRT: Secure Reliable Transport (see the SRT Settings section of this table)
Multicast Enabled (Type must be UDP) Check this checkbox to indicate this is a multicast stream.
Stream
View Direct Disabled (Type must be UDP) Check this checkbox to specify that the Haivision Play Set-
Top Box use the configured Source URL directly and not use an HLS version of
the stream. If a multicast Source has View Direct enabled, the Web player starts
the Multicast Agent to receive the source directly on the client and flip to the
browser. If the Source is embedded in a session or does not have View Direct
enabled, the video should still flow through the normal multi-site live distribution
mechanism (which requires at least one Media Gateway).
IPTV Disabled Check this checkbox to specify that the Source should be used in IPTV
Channel workflows. It will then be added to the IPTV Channels list (see Configuring IPTV
Channels (page 48)) as well as in the Program Guide on Haivision Play Set-Top
Boxes. You can set up IPTV channels and assign access from here or from the
IPTV Channels pane.
EPG To enable EPG display on set-top boxes, toggle the EPG button to On. (EPG
must be licensed on your system.)
Schedule (EPG must be On) Select the schedule for the EPG display from the drop-down
list.
SRT Settings
Mode Caller Specifies the SRT Connection Mode:
Caller: HMP acts like a client and connects to a server listening and waiting
for an incoming call.
Listener: HMP acts like a server and listens & waits for clients to connect to
it.
Rendezvous: Allows calling and listening at the same time.
TIP: To simplify firewall traversal, Rendezvous Mode allows HMP and the
encoder to traverse a firewall without the need for IT to open a port.
NOTE: See the following section, Configuring Secure Reliable Transport (SRT)
Sources (page 46).
Latency n/a Specifies how long HMP will buffer received packets. The size of this buffer adds
up to the total latency. A minimum value must be 3 times the round-trip-time
(RTT).
Range = 20 - 8000 ms
NOTE: Latency is for the SRT protocol only and does not include the capture,
encoding, decoding and display processes of the endpoint devices.
Passphrase n/a (Optional, must match encoder passphrase) This parameter is required if the
stream is encrypted and is used to retrieve the cryptographic key protecting the
stream.
Range = 10-79 UTF8 characters
Statistics n/a Click to view the statistics for the SRT source. See SRT Source Statistics (page
46).
1. Make sure the encoder or Media Gateway and HMP are accessible from the public Internet
by appropriate configuration of any firewalls.
2. Set up the SRT stream on the encoder or Media Gateway and start the stream connection.
3. Using the Statistics page, monitor the link statistics to see if the link is oversubscribed (and
adjust the video encoder bitrate if it is).
For additional information required to set up and tune SRT streams, please see the SRT
Deployment Guide (available through Haivision's Support Portal at: https://support.haivision.com)
NOTE
Not all browsers can support the statistics graphics for SRT. You need an up-todate version of Firefox,
Chrome, Safari, or IE11 (or higher) to support the graphics in the SRT Statistics page.
TIP
For both the Delays and Bandwidth Used displays, you can select the inputs, such as the Buffer, RTT
and/or Latency, or the Receive Rate and/or Lost Rate over the time period.
NOTE
You do not need to save in order to test settings.
4. Click Add Destination. The new export destination will be added to the list.
Configuring Locations
When setting up Haivision Media Platform, depending on the Product Edition, administrators can
define additional site locations (for example, satellite offices). The purpose is to define networks on
which users reside in order to route users through the closest location.
Locations are typically used to set up HMP-Media Gateway pairings. The goal is to set up locations
to "push" video as close as possible to users (at remote locations), using standard network
definitions to identify where the user is and where the closest streaming device is (i.e., Media
Gateway).
For multi-site live distribution, you need to select the gateways that will deliver video to the location.
Each location can have up to three gateways.
NOTE
For more information on HMP-Media Gateway pairing, see Configuring HMP-Media Gateway Pairings
(page 64). For details on Media Gateways, please refer to the Media Gateway Administrator's Guide
as well as the Haivision website at: http://www.haivision.com
To view a listing of the incoming and outgoing links between the currently configured
locations, see Locations Topology (page 59).
To create Distribution Policies to manage live stream routes, see Locations Policies (page
61).
IMPORTANT
To configure browser-based multicast using Media Gateway, the Haivision Helper application must be
installed on each user's computer. For more information, see Multicast Support via Haivision Helper
and Multicast Agent (page 17).
Managing Locations
To view and manage locations:
1. On the Administration screen, click Configuration on the toolbar and then click Locations
on the sidebar.
The Locations pane opens, displaying the list of defined locations, if any (see following
example).
2. (If required) Check the checkbox under Mgt. Server Location to identify the location of the
HMP management server.
7. To enable encrypted multicast (AES) for the location, check the Multicast AES + FEC
checkbox.
8. To specify additional multicast addresses and subnet masks for the location, click
+Multicast Range.
9. To specify additional IP addresses and subnet masks for the location, click +Network.
TIP
Clicking Edit Links navigates to the Location Topology pane with the location selected.
When the Multicast Agent Diagnostic Tool is opened, it performs a single test launch of the
Multicast Agent and reports any failures due to bad HMP or user configuration, network issues, or
other problems. It launches the Multicast Agent the same way that the normal HMP player does,
but performs additional checks to help isolate problems with a multicast environment.
Location Settings
The following table lists the Location configuration settings:
Location
Default Description/Values
Setting
Mgt. n/a This identifies the location of the HMP management server. (The auto-generated
Server routes on the gateway assigned to this location will include a loopback destination
Location to HMP.)
Information
Name n/a Enter a name for the location. This name will be selectable on the Locations list.
Default Disabled Check the checkbox to select this location as the default. The default location's
Location Media Gateway will be used when a user whose IP is not in any of existing
location ranges accesses HMP. The default location is displayed in green text in
the Locations list.
Media none (Optional) Select a gateway that will deliver video to the location from the list of
Gateways paired Media Gateways (if available). See Configuring HMP-Media Gateway
Pairings (page 64).
Networking
Connection Any (Optional) Select the SRT mode to use between the locations on your network:
Mode Any
Caller
Listener
NOTE: This determines whether the location is always Caller or Listener in
relation to other locations. If there is a conflict, it goes to Rendezvous mode. If set
to “Any”, it defaults to Rendezvous mode.
Bandwidth (Optional) Enter the maximum bandwidth in Mbps) to control the rate of outbound
Limit traffic to this location.
HLS 10 (Optional) Enter the duration to balance lowlatency, tune-in time, and stream
Segment buffering (range = 1-15 seconds). In the case of HLS live, the duration must be no
Duration greater than15, or it will take too long for the playlist to become available and the
initial request will be forced to time out.
IP Address n/a In the first field, type in an IP address for the location. This is a unique IPv4
/Mask address in dotted-decimal format (xxx.xxx.xxx.xxx). To specify a subnet mask for
the location, type in a netmask in the second field, either in dotted-decimal format
(e.g., 255.255.0.0) or CIDR notation. A subnet mask is a 32-bit mask used to
divide an IP address into subnets and specify the network’s available hosts. You
can specify multiple IP addresses / subnet masks for a location.
Multicast n/a For multicast delivery, specify the multicast address and subnet mask for the
Address location. To disable multicast, leave the Multicast Address empty.
/Mask
Multicast disabled Check this checkbox to enable AES (Advanced Encryption Standard) and
AES+FEC Forward Error Correction.
TIP: Typically you might turn off encryption due to interoperability issues with non-
Haivision devices
Locations Topology
The Locations Topology pane provides administrators a listing of the currently configured Media
Gateway locations and shows the incoming and outgoing links between locations. This is designed
for large installations where sending streams from the source location directly to all other locations
is not appropriate or efficient.
By default, HMP automatically distributes sources from the primary HMP server. From the
Locations Topology pane, administrators can configure the incoming and outgoing links between
locations to control the flow of video from site to site. From here, you can add, as well as edit and
delete links.
To view and configure locations topology:
2. To filter the list by location, type the first few characters of the location name in the
Configure Location search field and then select the name from the auto-complete drop-down
list (if available). Or click Edit Location to open the Locations pane.
3. To explore the links to and from the current location, click a location hyperlink. In the
previous example, if you click Chicago under Outgoing Links from Montreal, the pane will
switch to Chicago for the Location and show the defined links, in this example, Incoming
links from Montreal and Austin, but no Outgoing links
TIP
Typically, if your gateways are scattered, this should be kept off, but if your gateways are in
one building, enable Multicast Routing.
NOTE
When editing a link, its direction and location selection cannot be modified; only Multicast
Routing can be edited.
Locations Policies
A new Version 2.6 feature called Distribution Policies provides administrators the option to set up
selective stream distribution. Each Distribution Policy contains a list of Media Gateway locations (e.
g., NYC, Chicago, Montreal) to which live sessions and scheduled events will be sent. Content
Creators who wish to limit the distribution of a session or live event to specific locations can simply
apply the appropriate Distribution Policy.
By default, new Distribution Policies include the Default Location so that authenticated users in
locations that are not specifically included in the Distribution Policy are still able to receive the
stream.
For each policy, the list shows the name, usage (i.e., the number of times the policy has
been selected for a session), the description, and selected locations.
TIP
It’s a good idea to provide a clear description of each policy to guide Content Creators as to
which policy to use for different scenarios.
5. To select a target location, type the first few characters of the location name in the field and
then select the name from the auto-complete drop-down list of available locations.
These policies are now available in the Sessions/Events Information pane for Content
Creators to select.
NOTE
An HMP can be paired with multiple Media Gateways, but a Media Gateway can only be paired with
one HMP.
NOTE
Media Gateway devices initiate outbound requests to HMP to avoid issues with firewall
transversal. By default, the HMP Pairing Passcode is “Disabled” as a security measure,
meaning that HMP is not accepting any pairing requests.
1. On the (HMP) Media Gateways pane, click Generate to generate the Pairing passcode.
TIP
You can filter the list by selecting either Connected, Offline, or Error.
You can also click the gateway IP or hostname (blue) link to open the Media Gateway Web
interface in a new tab.
On the (HMP) Edit Location Information pane, this gateway is now available for selection
from the list of paired Media Gateways. (See Step #5 on Managing Locations (page 53).)
NOTE
You can use the same Pairing passcode to set up multiple gateway pairings
5. On the (HMP) Media Gateways pane, click Disable to block any new connections.
1. Pair one or more Media Gateways with your HMP, following steps in the previous section
Configuring Paired Media Gateways (page 64). Any paired gateways will be listed on the
(HMP) Media Gateways list.
TIP
You can use the same pairing passcode while pairing multiple gateways. We recommend that
you disable the passcode after all gateways have been connected. It can always be turned
back on to add a new gateway to the network.
2. On HMP, create Locations, mapping each with a Media Gateway. For details, see
Configuring Locations (page 52). Your locations should represent a network where you
have a group of users that should receive their video from a particular paired gateway.
There can only be one gateway per location.
4. On HMP, create one or more Sources, selecting one of the paired Media Gateways for the
Receiver. For details, see Configuring Sources (page 40). For example, referring to the
following diagram, while creating a source with “MXE Source,” Media Gateway “MAIN”
should be selected as the receiver.
5. Create a Session with one of the configured Sources. Based either on the Schedule or
“Live” state, multi-site routes will automatically be created on all paired Media Gateways.
NOTE
A scheduled session will have active multi-site routes regardless of its “Live” state. All configured
gateways will receive live streams when a source is made available through a session.
For additional information, please refer to Multi-site Live Workflow in the Media Gateway User’s
Guide.
Configuring Metadata
Haivision Media Platform administrators can define metadata with selectable values to identify and
store custom metadata. For example, videos, sessions, and sources may be categorized by
surgical procedure, course title, geographical location, or patient ID number – whatever makes
sense in your environment.
This metadata can be assigned to videos, sessions, and sources. From the Content Library and
Portal, viewers can select metadata keys and values to filter the Videos, Sessions, or Sources list.
For details, see "Filtering Lists" in the Haivision Media Platform User's Guide.
NOTE
Viewers only see metadata assigned to videos for which they have access
To help you manage your metadata, you can organize metadata into groups, change the display
order of metadata keys within the group, and sort groups within the list of keys. (Note that metadata
cannot be sorted on mobile devices because they do not have the same drag and drop support as
desktop Web browsers.)
To view and configure metadata:
To define metadata:
NOTE
By default, users will be able to enter multiple values, but not custom (i.e., their own) values
when assigning metadata to videos, sessions, and sources.
To remove a value, mouse over the value and click the icon.
4. To use the Metadata for HotMarks, check the checkbox. Note that “HotMarks” will serve as
the group for the metadata.
-or-
In the Group field, type in the group for the metadata.
5. Check the checkboxes to modify the default settings for Multiple Values and Custom Values
as required. For more information see Metadata Settings (page 73).
6. When you have finished typing in the values, click Add Metadata. The new metadata key
will be added to the Metadata list.
TIP
If you select multiple metadata keys to edit, only the Group field is available.
IMPORTANT
Deleting a metadata key will also remove associated values on all videos, sessions, and
sources.
Metadata Settings
The following table lists the Metadata configuration settings:
Metadata
Default Description/Values
Setting
Key n/a The label for the metadata.
Related Topics
Haivision Media Platform supports KLV data parsing and display as a licensable option per system.
Administrators can create and upload a metadata dictionary file to customize and dynamically
display KLV metadata to provide context with associated video/audio streams.
To accommodate changes to the KLV dictionary, HMP accepts a library file which will translate the
KLV data being sent into human readable fields and units of measure. The library file is in JSON
format and complies with MISB RP 0602.2 and Standard 0604.1.
Administrators can also download and review the currently uploaded KLV dictionary.
On the Content Library screen, users can turn on/off the display of KLV data in a sidebar in the
multi-window viewer.
To manage KLV inputs:
2. To upload a dictionary, click Browse and select the dictionary file to load in the Open File
dialog box. For details on the dictionary file format, see KLV Dictionary Format (page 159).
A sample dictionary file is available on Haivision’s Support Portal at: https://support.haivision.
com
TIP
To select a different dictionary file, click Change. To remove the selection, click the icon.
The dictionary is now loaded. KLV metadata can now be displayed for videos, sessions and
sources.
4. To view the currently installed dictionary, click Download. You can then open the file in a
text editor to view the KLV dictionary
5. To remove the currently installed dictionary from your system, click Remove.
STB Administration
From the Administration screen, you can configure default settings to assign to new set-top boxes
registered in the Haivision Media Platform domain. You can also create tags for tagbased
configuration of devices.
When a new set-top box is registered as a device in an HMP domain, it is assigned the default
settings. This is useful to control settings such as the channel lineup, volume level, NTP server,
and Timezone, the first time the device boots up.
1. On the Administration screen, click Configuration on the toolbar and then click Set-Top
Boxes on the sidebar.
The Set-Top Boxes pane opens showing the device default settings (as shown in the
following example).
2. Enter or select the value(s) to serve as default device settings. See the following section,
Device Default Settings (page 78).
The changes take effect immediately and will apply to new STBs registered with the server.
Content Select the default content type for the device, either Channel, Videos, or Session. Then
select the channel, video, or session title from the drop-down list.
Offline To set the offline cleanup period, enter the number of days. Devices offline for more than the
Cleanup specified cleanup period will be removed from the Devices list.
To disable automatic cleanup, set to 0 (default).
Users and Type in the name(s) of defined users and groups to assign access to the STB content.
Groups
Device Tags
Values Type in one or more words or phrases to describe and manage the device. See the following
section, Tagging Devices (page 79).
Tagging Devices
Tag-based configuration facilitates online management of large installations of devices. It provides
a helpful way to sort, manage and schedule devices with a high degree of control over content
being sent to individual or groups of devices.
Tags are similar to, but more specific than groups and are generally used to describe and manage
devices with more granularity.
Tag-based configuration is also more powerful than groups because a single device can have more
than one tag.Tag-based configuration allows devices to essentially be in more than one group.
Once devices are tagged, you can filter by tags to view, edit or schedule only devices that share
selected tags. This is useful to narrow down and manage long lists of devices and also makes it
easier to locate devices in large installations. (See "Filter by Tags" in the Haivision Media Platform
User's Guide)
To add or delete tags:
2. To add a new tag, click in the Tags text box, type in the tag name, and press Enter.
3. To remove a tag, mouse over the name and click the icon.
4. Click Save Settings.
Keep in mind that the Save Settings button applies to both default settings and tags.
The newly created tags are now available to assign to devices and then to filter the
displayed list.
1. On the Administration screen, click Configuration on the toolbar and then click Stream
Outputs on the sidebar.
The Stream Outputs pane opens, displaying the list of defined stream outputs for your
system, if any (see following example).
Replace the Haivision graphics (large shark and small brand) that appear on the signin page
(as shown following).
Replace the "favicon" application icon that certain browsers display in the tabs and
bookmarks.
Replace the Haivision banner graphic (logo) at top left of the Web interface.
1. On the Administration screen, click Configuration on the toolbar and then click User
Interface on the sidebar. The User Interface pane opens (see following example).
2. To change the banner color, click the color box and select the new color (either directly from
the color picker or enter the color values).
TIP
To view the expected dimensions for an image, hover the cursor over the icon.
TIP
To revert to the default image or banner color, click Default.
5. To hide one of the Sign-In page graphics (large or small), check the Disable checkbox. To
show it again, choose a new graphic or click on Default.
NOTE
Unchecking the Disable checkbox does not re-enable the graphic.
6. To switch the interface color scheme between dark (default) and light, select from the drop-
down menu.
7. Click Save Settings.
Sign-in Haivision The top image on the Sign-in page. The width and height can be any dimension
Graphic shark up to a recommended maximum of 4000 x 4000 pixels.
(large) logo
NOTE: You can use this setting to create a full-screen image. However, large
images can slow down or prevent page load. Also, if the screen resolution is
smaller than the image, the image will be cut off. The image is centered
horizontally on the page.
Sign-in Haivision The lower image on the Sign-in page. The width and height can be any dimension
Graphic Media to fit the page. However, the image will be resized to 220 pixels wide (while
(small) Platform maintaining the aspect ratio). Also, a resized height greater than 400 pixels may
(text require the user to scroll. The image is centered horizontally on the page.
logo)
TIP: The Haivision graphic is a 235 x 16 pixel .PNG file.
Color Dark Switch interface between dark and light color schemes
Scheme black background with white text (default)
-or-
white background with black text.
NOTE
When editing Video information, users can override the Default Video Expiry on a pervideo basis.
For details, see "Editing Video Information" in the Haivision Media Platform User's Guide.
Maximum Recording Duration
Each recording session is limited to a maximum duration. HMP will stop recording once that
duration has been reached. You can define the maximum duration for all videos. The default is 24
hours.
Videos Inherit Permissions
A session's sharing permissions may now be passed on to any videos made from that session. The
objective is a workflow decision to help reduce the number of times a user must enter the sharing
dialog.
Administrators can enable or disable this setting (disabled by default). Permissions are copied at
the start of the recording. The recording creator is still granted "OWN" permissions on the new
video.
Non-Synchronized Source Recording
Administrators can now add the ability to create non-synchronized source recordings. This feature
is scheduled to be deprecated in a future release.
Configuring Video and Session Settings
To configure the video and session settings:
1. On the Administration screen, click Configuration on the toolbar and then click Videos
/Sessions on the sidebar. The Videos / Sessions pane opens (see following example).
IMPORTANT
Before proceeding, make sure that:
The appliance is set up correctly and all necessary network and A/V connections are
established. For information on installing and connecting to your Haivision Media Platform
server, please refer to the Haivision Media Platform Quick Start Guide.
Sources and (if applicable) Directory Authentication Services have been configured for your
system. See Managing Sources (page 39) and Managing Directory (Authentication) Services
(page 118).
Topics Discussed
Managing Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Assigning Roles to LDAP/AD Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Managing User Accounts (Non LDAP/AD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
User Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Managing Groups (LDAP/AD Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Assigning Roles to LDAP/AD Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Managing Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Adding Users and Groups to Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Editing Role Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Creating Custom Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Default Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Managing Share Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Haivision Media Platform allows you to display a list of users and assign roles to users. HMP uses
roles with pre-defined permissions to provide users or groups with controlled access to videos,
sessions, and sources. In order to successfully sign in, a user must be assigned a role.
If your system is not connected to a directory server, you may also add and modify user accounts
from HMP.
NOTE
Although the typical workflow in an LDAP/AD environment is to assign roles via Groups, assigning
roles from the Users list may be useful in some cases.
1. On the Administration screen, click Access Controls on the toolbar and then click Users on
the sidebar.
The Users list opens (shown in the following examples), displaying the list of defined users
for your platform.
2. In an LDAP/AD environment, you may browse through the list and assign roles to users.
See Assigning Roles to LDAP/AD Users (page 91).
NOTE
The default HMP users (non LDAP/AD) are creator and viewer.
In an LDAP/AD environment, you may browse through the Users list and assign roles to users.
To assign a role to a user:
1. Select the user by mousing over the user name in the Users list and click anywhere in the
row.
Or you can check the checkbox next to the user name and click Edit.
2. On the Edit User dialog, select the role for the user account. See the Role entry in User
Settings (page 93).
3. Click Save User. The new role will be displayed on the Users list.
2. On the Add User Information dialog, enter or select the value(s) to define the user. See User
Settings (page 93).
User Settings
The following table lists the configurable User settings on non-LDAP/AD systems:
User
Default Description/Values
Setting
Name n/a Enter a name for the user. This name will be displayed on the Users list.
Username n/a Enter a unique username. The user will use this name to sign into the HMP Web
interface.
NOTE: You cannot modify the username.
1. On the Administration screen, click Access Controls on the toolbar and then click Groups
on the sidebar.
The Groups list opens, displaying the list of defined groups for your platform (shown in the
following example, connected to an Active Directory server).
2. To assign roles to groups, see the following section, Assigning Roles to LDAP/AD Groups
(page 94).
3. Click Save Group. The new role will be displayed on the Groups list.
Managing Roles
Roles are used to confer permissions to users and groups. A user must be assigned a role in order
to sign in. Haivision Media Platform provides the following default roles.
Role Default Permissions
Administrator In charge of system
Content Creator Make sessions, record videos and manage feeds; no control over sources
Content Contributor Record videos with no other system responsibilities
Viewer View or interact with content with no other system responsibilities
Set-Top Box Same as Content Creator with Set-Top Box administration added
In addition, users may be assigned "share" permissions for content rights (videos, sessions and
sources) by administrators or other users. Share permissions may further qualify a user's
privileges.
HMP roles and share permissions are fully customizable (see Creating Custom Roles (page 98)
and Managing Share Permissions (page 102)).
When a user belongs to a group, the user's permissions are a combination of both.
TIP
The best practice is to assign a lower role to the group and then assign higher roles to individual users
as required.
1. On the Administration screen, click Access Controls on the toolbar and then click Roles on
the sidebar. The Roles list opens, as shown in the following example.
The Roles list displays the list of available roles and the number of users (and groups, if
applicable) assigned to each role. From here, you can add users to and remove users from
an existing role, and edit role permissions. You can also create new roles and delete roles.
To add users (and groups, if applicable) to a role, see the following section, Adding
Users and Groups to Roles (page 97).
1. Select the role by mousing over the role name in the Roles list and click anywhere in the
row.
4. Select the user or group from the list that appears. The selected user or group is now added
to the role (see following example).
TIP
To give a role full administrative privileges, toggle the Administrator Privileges button to On.
3. Click Save Role. The selected permissions will be applied to the role.
2. On the Add Role Information dialog, type in a name for the role.
TIP
Default Roles
IMPORTANT
Administrators may create additional roles as well as edit the permissions for the default roles.
Role permissions may be further qualified by "share" permissions. For example, a user with the
Viewer role might have been given "OWN" permissions on a video and can therefore edit and delete
it.
The following table is a matrix of the default roles (i.e., for system functions) available to assign to
HMP users and groups. In addition, where applicable, the table lists the default "share" permissions
for content rights (videos and sessions):
Tasks Roles
Administrator Content Creator Content Viewer Set-Top Box
Contributor
Videos
Delete Videos OWN OWN OWN
Export Videos
Import Videos
Mobile Offline
Viewing
Re-stream Videos
Sessions
Change Sources OWN OWN OWN
Share Sessions
View Sessions
Sources
Create Sources OWN OWN OWN
View Sources
Feeds
Change Content
View
Administration
Set-Top Box
NOTE
For the default share permissions, see “Sharing Items” in the Haivision Media Platform User’s Guide.
IMPORTANT
Once an asset is selected for a feed, the feed share permissions take precedence over the
permissions assigned to the asset. This means users may have access through feeds to assets that
they would not have access to otherwise. For more information, see Configuring Feeds and Activating
the Portal (page 37).
1. On the Administration screen, click Access Controls on the toolbar and then click Share
Permissions on the sidebar. The Share Permissions list opens, as shown in the following
example.
4. On the Share Permissions Information pane, check the permissions to assign to the share
permission.
1. On the Administration screen, click System Settings on the toolbar and then click API
Access on the sidebar.
The API Access pane opens, displaying the list of authorized devices (if any).
NOTE
Toggling this button activates all devices in the list.
5. Enter the IP address of the device that will be accessing the Command Line API.
6. Click Add Device. The new device will be added to the list of authorized devices.
NOTE
Further changes to the list of authorized devices will be applied automatically. You do not need
to restart HMP.
IMPORTANT
Changes to the number of backups to keep or the password, apply to immediate backups (Backup
Now), but are not saved until you click Save Settings. When you refresh the page, restore a backup,
or navigate away from the page, these changes are lost.
TIP
To back up files onto a Network File System (NFS) storage server, make sure NFS is set to On and
configured. See Managing Network Storage (page 135). Otherwise when NFS is Off or not available,
backups are written to the local server.
1. On the Administration screen, click System Settings on the toolbar and then click Backup
/Restore on the sidebar.
The Backup/Restore pane opens, as shown in the following example.
4. To schedule recurring backups, check the checkbox next to the days on which to repeat the
backup
5. To password-protect the generated backup .zip file, type in a passphrase in the Password
field. This password will be required to restore the backup.
IMPORTANT
If you lose your Backup password, that backup file cannot be restored.
Backing Up HMP
To back up HMP:
The generated backup file is a .zip file with the syntax shown in the following example:
“backup-1467139422.zip”.
1. On the Backup/Restore pane, click Browse and select the file to upload in the Open File
dialog. The backup file must be a .zip file with the syntax shown in the previous example.
1. On the Backup/Restore pane, select the backup file to restore from the Restore Backup
drop-down list.
5. Wait until the update is complete and HMP restarts. Once the appliance has restarted, the
browser will display the HMP Sign-in screen (depending on your Web browser and settings).
If not, reload the Sign-in screen.
6. If any changes have been made to the HMP configuration, such as sources, sessions, or
videos since the backup was made, the inconsistent items will be listed under Restore
Inconsistencies.
7. You can click the link (such as the video shown in the above example), to open the Content
Browser, view and optionally restore the change.
8. When you are satisfied with the restore, return to the Backup/Restore pane and click Clear
Log.
Restore
Upload Backup To upload a previously downloaded backup file, click Browse and select the .zip file.
File
Restore Select the backup to restore from the drop-down list of backup files.
Backup
Password If the backup is password-protected, type in the password for the file.
Managing Certificates
From the Certificates pane, you can generate an SSL private key and certificate signing request
(CSR). You can then import the signed certificate and trust chain returned by the Certification
Authority (CA).
The Certificates pane lists the Identity Certificates available on Haivision Media Platform. An
Identity Certificate identifies the device during the authentication process when trying to establish a
TLS connection in HTTPS session startup. Its Common Name or Alternate Subject Names must
match its IP address and/or its FQDN (Fully Qualified Domain Name) if DNS is used.
The default certificate is localhost.crt (self-signed).
To generate a Certificate Signing Request (CSR):
The Certificates pane also lists any certificate signing requests generated on HMP. The
active certificate is indicated with a blue check.
2. Click Generate
3. On the Generate Certificate or Private Key dialog, type in a name for the certificate.
4. Make sure the Type is Certificate Signing Request and fill in the remaining fields. See
Certificate Settings (page 116).
6. Click Generate
NOTE
The generated CSR file needs to be sent to a Certification Authority to be signed. The CSR
content can be viewed by clicking on the CSR name in the list; its content will be displayed in a
new window where it can be copied.You can import the signed certificate back later by clicking
on the Import button.
7. Returning to the Certificates list, click the link for the generated CSR to open the file in
another tab. Copy the contents (including both beginning and ending delimiters) and paste it
into your Certificate Authority (CA) application. The CA will return an intermediate certificate
(trust chain) and signed certificate (CRT).
TIP
Keep in mind that there is a difference between importing a new certificate (that was generated
externally) and importing a newly signed certificate whose request was previously generated
on HMP and exported for signing.
3. Type in the certificate name and fill in the remaining fields. See Certificate Settings (page
116).
4.
Haivision Media Platform 2.6 114 HVS-ID-AG-HMP-26, Issue 03
Administrator's Guide Generated on: 2018-06-13 14:35:39
4. If your certificate is encrypted, type in the password
5. Click Browse and select the CA-signed certificate (CRT) (returned from the certificate
request generated in the previous section).
6. Click Import. On the Certificates pane, the newly imported certificate will be added to the list
and should have a green status LED. Click in the Active column to activate the certificate
7. Click Reboot if you have changed the active certificate.
CAUTION
Clicking Generate will overwrite the current private key and render unusable any certificates
based on that key.
The new certificate is added to the Certificates list, and becomes the active certificate.
7. Click Reboot.
Certificate Settings
The following table lists the configurable Haivision Media Platform Certificate settings.
NOTE
Please contact your Network Administrator if you are unsure what to put in any of these fields or if you
are unsure whether the setting is required on your network.
Certificate
Description
Setting
Generate Certificate or Private Key
Name Type in a unique name under which the certificate will be stored on HMP as well as listed on
the Certificate pane
Type Select the Signature Type:
Self-signed: The certificate will be generated and signed by the system, and the name
will be added to the list of Identity Certificates.
[ req ]
req_extensions = v3_req
[ v3_req ]
# Extensions to add to a certificate request
subjectAltName = @alt_names
[ alt_names ]
DNS.1 = server1.example.com
DNS.2 = mail.example.com
DNS.3 = www.example.com
DNS.4 = www.sub.example.com
DNS.5 = mx.example.com
DNS.6 = support.example.com
Import Certificate
Type Select the certificate Type:
Certificates: (Identify/CA-chains/Bundles)
Private Key + Certificate Pair
Name Name of the certificate.
Format Select the file format for the Certificate (the formats differ in the way the file is encrypted):
Auto: detected from the file extension
der: Distinguish Encoding Rules
pkcs #7
pkcs #12
Password
IMPORTANT
If Haivision Media Platform is connected to an LDAP or Active Directory server, the Users and Groups
lists will be populated with information from the directory server. In an LDAP/AD environment, you
cannot add or modify users or groups directly from HMP.
LDAP and Active Directory are used for authentication purposes only. No HMP data is stored or
changed on these systems.
You can also integrate HMP with an Active Directory-based single sign-on (SSO) environment. For
details, see Integrating HMP with Single Sign-On (SSO) Environments (page 124).
1. On the Administration screen, click System Settings on the toolbar and then click Directory
Services on the sidebar. The Directory Services pane opens.
2.
Haivision Media Platform 2.6 118 HVS-ID-AG-HMP-26, Issue 03
Administrator's Guide Generated on: 2018-06-13 14:35:39
2. To connect to an LDAP or Active Directory server, toggle the Directory Services button to
On. The Directory Services configuration settings then become available, as shown in the
following example.
3. Under Authentication, select type of LDAP implementation for your system, either:
Active Directory: An implementation of LDAP directory services by Microsoft.
Open LDAP: An open source implementation of LDAP directory services.
4. For the server Connection, Query, and Data Mapping settings, enter or select the new value
(s) in the appropriate field(s). See Directory Service Settings (page 122).
NOTE
If you get the message “Anonymous Connection Succeeded,” this means that HMP has found
the server, but the Username and/or Password is most likely wrong.
If you get the message “Connection Test Succeeded,” this means that the server IP Address,
Port, Username and Password are correct. A list of the first 10 users and groups will be
displayed (as shown in the following example).
1. On the Directory Services pane, toggle the Directory Services button to Off.
2. Click Save Settings.
The LDAP or Active Directory information will be removed from HMP, and the Users and
Groups panes will return to the local account lists.
IMPORTANT: If the Base DN is wrong, HMP will not be able to access the
groups. When the connection test succeeds, you will see a list of the first
10 users and groups (see example in Connecting to a Directory Server
(page 118)).
User n/a The DN of the context (container) where your authentication system users
Context can be found. This setting should be provided by your AD/LDAP
administrator. For example: ou=people,dc=haivision,dc=com
IMPORTANT: If the User Context is wrong, users will not be able to sign in
correctly. For example, they may only have the anonymous privileges or
even a blank screen.
User sAMAccount The user attribute your directory system uses. OpenLDAP systems
Attribute Name normally use “cn” or “uid”, while Active Directory systems normally use “
sAMAccountName”.
Member memberOf The member attribute your directory system uses. OpenLDAP systems
Attribute normally use “member” or “memberUid”, while Active Directory systems
normally use “memberOf”.
Group (|(objectClass= Object class query for groups. The default will work with almost all directory
Object group) servers
Class (objectClass=
groupOfNames
))
User (objectClass= Object class query for users. The default will work with almost all directory
Object person) servers.
Class
Query 1000 Sets the size of a page for paged results. Paged results are typically
Page Size supported, but the supported page size may need to be configured for your
site. If the requested size is not supported by the LDAP server, a non-
paged query will be attempted. The default on most directory servers is
1000.
Data Mapping
Group cn These are the fields that HMP needs to read from the directory server. The
Name defaults should work on most systems. If your system uses different
attribute names, you need to configure them here.
Display displayName
Name
Email mail
User userPrincipal
Principal Name
Name
Single Sign-On
Single Off To configure Single Sign-on, see the following section, Integrating HMP
Sign-On with Single Sign-On (SSO) Environments (page 124).
WS-Fed and SAML2 work for Windows Server 2008+ / AD FS 2.0+ and Azure,
OAuth2 works for Windows Server 2012 R2 / AD FS 3.0+ and Azure.
With Azure AD, you must use a Windows Server with Azure AD Connect for Directory Services
configuration. The current HMP release does not support SSO for users created directly on Azure
AD, and must be able to query a traditional Active Directory system for user and group details after
being authorized by Azure AD.
When a user authenticates using single sign-on, HMP takes the User Principal Name (UPN) from
the token that it receives from the identity provider and creates a user session for the HMP user
with that associated UPN. For AD FS, the Relying Party Trust that HMP is configured to use should
pass through the UPN as a claim.
To integrate Haivision Media Platform with an SSO environment:
1. On the Directory Services pane, verify that the Directory Service button is toggled to On.
2. Scroll down the Directory Services pane and toggle the Single Sign-On button to On.
3. Select the Sign-In Protocol for your system, either: OAuth2, WS-Fed, or SAML2.
NOTE
Azure AD and AD FS 2.0+ support authentication using WS-Fed and SAML2.
Azure AD and AD FS 3.0+ (Windows Server 2012 R2) support authentication using OAuth2.
Managing Licenses
This section provides instructions to update your Haivision Media Platform license from the Web
interface.
NOTE
Any update (other than a maintenance release such as v2.x.x) requires a new license.
Haivision Media Platform is available in Editions to suit different applications. For information on
Editions, see Product Editions (page 16).
1. On the Administration screen, click System Settings on the toolbar and then click Licensing
on the sidebar.
The License pane opens, showing the installed license, including its expiry date and license
(Edition) features (see following example figure).
2. Click to copy the current product details (product name, version and MAC address) to the
clipboard.
3. Contact Haivision Technical Support with this information to request the license key.
4. Once you have the license key, paste the license string in the License text box.
5. Click Save Settings to load the license.
1. On the Administration screen, click System Settings on the toolbar and then click Network
on the sidebar.
The Network Configuration pane opens (shown in the following example).
2. Fill in the General section. For details, see Network Settings (page 133).
3. To enable SNMP alerts, toggle the SNMP button to On.
4. Under Interfaces, select the first interface, if not already selected (e.g., em1 as shown in the
above example).
5. In the Addressing field, select either DHCP or Static to enable or disable the Dynamic Host
Configuration Protocol for the interface.
NOTE
When DHCP is enabled, HMP will get an IP Address from a DHCP server on the network to
which it is connected. When it is disabled, you must manually enter the appliance’s IP Address
and Netmask.
6. Fill in the required fields. For details, see Network Settings (page 133).
7. To configure multiple network interfaces, select the next interface (e.g., em2) and repeat the
configuration.
8. To add a bond interface, click Add and fill in the fields, including the Bonding Mode.
TIP
Bond interfaces provide a method for aggregating multiple network interfaces into a single
logical bonded interface. The goal is to increase throughput and to ensure redundancy in case
one of the links should fail. See the "Bond Interface" in Network Settings (page 133).
9. To add one or more static routes, click +Route under Static Routes and fill in the fields.
10. Click Save Settings.
11. Click Reboot to restart the HMP server.
NOTE
Please contact your Network Administrator if you are unsure what to put in any of these fields or if you
are unsure whether the setting is required on your network.
When setting up Haivision Media Platform, you may (optionally) configure a range of network
storage settings.
1. On the Administration screen, click System Settings on the toolbar and then click Network
Storage on the sidebar.
The Network Storage pane opens.
2.
Haivision Media Platform 2.6 135 HVS-ID-AG-HMP-26, Issue 03
Administrator's Guide Generated on: 2018-06-13 14:35:39
2. To connect to an NFS server, toggle the NFS button to On.
NOTE
Files that have been “synced'” from a watch folder will not reappear if they have expired or been
removed from HMP (or otherwise made offline).
3. Select the folder type (either NFS or Local). The watch folder can either be on a separate
NFS mount, or Local to the /assets directory (which may itself be on a physical HMP drive
or on a separate NFS volume).
If you choose NFS, provide a Remote Host address and Remote Path.
4. Click Save Settings to save the connection.
5. Click Reboot to restart the HMP server.
TIP
To automatically import from a Makito X with Storage: The Makito X export manager will create a
folder named “recordings” on the Makito X-configured external storage (NFS or FTP). From HMP, you
need to configure the Watch Folder settings to point to this “recordings” folder to automatically import
videos.
Categories
Category values from an HMP XML file are added to an asset's metadata even when that category
does not exist on the importing system.
The HMP system from which the HMP XML file was exported may not have the same metadata
and metadata values as the system to which it is imported. After importing metadata values to a
system that does not have the corresponding metadata, the following behaviors can be observed:
The exported system's metadata and values do not show up on imported asset's Edit
Metadata pane.
The exported system's metadata values do show up on the REST API at /assets/:id
/metadata.
Editing the imported asset's metadata values through the Web interface works and does not
cause the imported XML metadata values to be deleted.
When metadata with the same label as the metadata from the imported XML is created, the
metadata and the selected values become visible on the imported asset's Edit Metadata
pane.
All metadata values from the imported XML will be preserved even when "Custom Values"
or "Multiple Values" is not enabled for metadata with the same name, and these values are
still preserved when editing values from the Edit Metadata Pane.
Other Metadata
HMP XML import does not check whether other metadata makes valid references on the new
system.
HotMarks
If the HotMark timestamp described in HMP XML is greater than the duration of the asset to which
it is imported, an error will be returned and the XML import will fail. However, if the asset does not
have a duration, the XML import will succeed. This can happen when the asset itself is still being
imported and no duration can be calculated yet. If the imported asset turns out to have a duration
less than the HotMark, then that HotMark timestamp will not be visible on the player, but will show
up on the /assets/:id/hotmarks API.
Managing Security
When setting up Haivision Media Platform, you may (optionally) configure a range of security
settings.
1. On the Administration screen, click System Settings on the toolbar and then click Security
on the sidebar.
Configuring a Watermark
Configuring a watermark creates a system-wide, static message to be displayed as an overlay on
all videos played back in the user's authenticated HMP Web browser. This feature supports content
protection and end user identification.
NOTE
By default, HLS access is disabled on desktop browsers when watermarking is enabled. However, as
of Release 2.5, Haivision Play Set-Top Boxes support watermarking HLS streams and VOD. See the
Watermark entry in Security Settings (page 147).
To configure a watermark:
FIPS compliance
NOTE
Streams from the source to Haivision Media Platform may be unencrypted, depending on
whether you are using UDP or SRT.
IMPORTANT
Changes to port numbers take effect immediately. Changing port numbers will affect ongoing
operations using the service at that port.
5. To configure a banner, type or copy in the desired banner text. Toggle the Advisory Notice
button to On.
NOTE
All settings except for Web Server require a reboot.
Security Settings
The following table lists the configurable Haivision Media Platform Security settings.
NOTE
Please contact your Network Administrator if you are unsure what to put in any of these fields or if you
are unsure whether the setting is required on your network.
Security
Description
Setting
Streaming Protocols
Protocol Choose whether HMP will use a plain or secure streaming protocol:
RTMPS: Select to enable secured RTMP. Real-Time Messaging Protocol (RTMP)
Secure encryption uses SSL (Secure Sockets Layer) certificates to encrypt the traffic
for the Web browser. HMP ships with a selfsigned SSL certificate which will work with
any configured server hostname. However, Web browsers do not consider this to be a
trusted certificate because it was not signed by a Certificate Authority.
When accessing the Web interface, users will see a security warning and may be
prompted for authorization each time they try to view a video. Some Web browsers
may reject the RTMPS connection completely.
IMPORTANT: Haivision recommends that site administrators install a signed SSL
certificate if they plan to use RTMPS streaming. Site administrators should generally
contact their Network Administrators for help getting SSL certificates.
RTMP: Select to enable standard RTMP.
IMPORTANT: Only security professionals who understand the cipher support and
requirements within their organization should change this setting.
Some of these settings are not supported by Haivision Play Set-Top Box or by Google
Chrome.
The default list has been verified for broad acceptance, and should typically only be
adjusted to mitigate new and critical vulnerabilities that may occur.
Lock (High Security (STIG) Environment must be Legacy) Type in the time period (in minutes)
Session allowed for inactivity before an HMP session is locked (on all interfaces, console, ssh, and
After Web).
Web Server
HTTP Port To configure the Web port for HMP:
HTTPS Port HTTP Port number (Default = 80)
HTTP Port number (Default = 80)
IMPORTANT: If you change the HTTP/HTTPS ports, any connected STBs will lose
connection and need to be redirected to the new HTTP port. This can be done manually
through the Settings on the STB. However, we recommend that you contact Haivision
Technical Support if you intend to change port settings and automatically migrate your
STBs.
SSL To specify which TLS (Transport Layer Security) versions are accepted, select from the
Protocols drop-down list: TLS v1, TLS v1.2, TLS v1.2.
SSL Ciphers To specify which SSL Ciphers are accepted, select from the drop-down list or type in
another cipher name:
Advisory When enabled, the banner will appear when users sign in (console, SSH and Web
Notice & interface) and remain on the screen until the administrator acknowledges the usage
Consent conditions and takes explicit actions for further access. The banner is typically an advisory
Banner /warning notice to be displayed before the Sign-in page.
To enable the banner (as shown in the text box), toggle the Advisory Notice button to On.
Type or copy the banner text into the text box.
NOTE
For major releases or when adding new features, you need to apply a valid license key before or after
the update. For more information, see Managing Licenses (page 128).
Please contact Haivision Technical Support to obtain a valid license key. Only customers under a
maintenance agreement can obtain an update package. If you install an update without a valid license
key, HMP will not function.
You cannot install system updates from a mobile device.
1. On the Administration screen, click System Settings on the toolbar and then click Update
on the sidebar.
The Update pane opens (see following example).
3. Click Upload to continue. The progress bar shows the progress of the upload.
4. Wait until the bundle has been uploaded and verified.
5. Click Update and then click Confirm.
The Reports pane lists user activity reports and system logs that you can download in .CSV file
format. See Reports and Logs (page 155).
To view the reports:
1. On the Administration screen, (if necessary) click Reporting on the toolbar and then click
Reports on the sidebar.
2. To change the time to keep the user activity data, type in the number of months in the Keep
User Activity field and click Save Settings.
NOTE
User activity data older than the specified time period will be automatically deleted by the
system.
3. To download an activity report or log to your local system, click the icon.
NOTE
Haivision recommends that you expand the VM disk when the Video Storage reaches 90% or more of
the available space.
1. On the Administration screen, (if necessary) click Reporting on the toolbar and then click
System Activity on the sidebar.
TIP
The color of the bars in the Disk Space graph change to orange when the space used on disk
reaches 75%, and then to red when it reaches 90%.
3. You can adjust the Refresh Rate (from 1 second to 30 minutes) and the Time Scale (from 5
minutes to 30 days past) for the graphs.
4. To fine-tune the Bandwidth usage graph, select the data to include: Input and/or Output
(playback).
5. To display an exact reading for the time and usage, you can mouse over the any of the
graph lines, as shown in the following example.
NOTE
A sample dictionary file is available from the Haivision Support Portal at: https://support.haivision.com
Topics Discussed
Dictionary Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Item - Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Item - Translation/Format/Suffix/Precision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Item - Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
64-bit Integer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Item - Translation
An item can be modified by a translation object. For example:
{
"type": "item",
"key": "25",
"format": "uint16",
"translation": {
"multiplier": 0.30365453574425879301136797131304,
"error": 2147483648, "addend": -900
},
"name": "Frame Center Elevation" }
If the raw value of item 25 (a 16-bit unsigned integer) is equal to 2147483648, then the decoded
value will be the string “error”. Otherwise, the decoded value will be the raw value multiplied by
0.30365453574425879301136797131304 and subtracted by 900.
Example:
"25": {
"value": 1000.88
}
You can also specify a key for the addend and that key's addend will be used. For example:
"addend": {
"key": "23"
},
Item - Translation/Format/Suffix/Precision
The displayValue attribute is formatted according to the format, suffix and precision attributes.
The second section shows what is sent to Haivision Media Platform based on the dictionary.
format:
{
"type": "item",
"key": "13",
"format": "int32",
"translation": {
"multiplier": 4.1909515877212172316951757444512e-8,
"addend": 0,
"error": 2147483648,
"format": "latitude"
},
"name": "Sensor Latitude"
}
{
"value": -34.84,
"displayValue": "034°50'24\" S",
"name": "Sensor Latitude"
}
The values attribute is a mapping between the raw value (a 8-bit unsigned integer) and a string. If
the raw value is 1, then the decoded value is the string “No icing Detected”.
{
name: "Icing detected"
value: "No icing detected"
}
The bits object is a mapping between each bit of the raw value and a string. If the raw value of item
47 (a 8-bit unsigned integer) is 3 (0000 0011). Then the decoded value is:
"47": {
"value": {
"1": {
"value": "on",
"name": "Laser Range"
},
"2": {
"value": "on",
"name": "Auto-Track"
},
"3": {
"value": "blk",
"name": "IR Polarity"
},
"4": {
"value": "off/no ice",
"name": "Icing detected"
},
"5": {
"value": "calc",
"name": "Slant Range"
},
"6": {
"value": "valid",
"name": "Image Invalid"
},
"7": null,
"8": null
}
}
64-bit Integer
64-bit integers are converted to a string because JavaScript doesn't support 64-bit integers.
APPLICABLE LAW
This Limited Warranty is governed by and construed under the laws of the Province of Quebec,
Canada.
This Limited Hardware Warranty may be subject to Haivision's change at any time without prior
notice.
1. DEFINITIONS
1.1 Entitlement. The collective set of applicable documents authorized by Haivision Systems, Inc.
or its affiliate Haivision (collectively "Haivision") evidencing your obligation to pay associated fees (if
any) for the license, associated Services, and the authorized scope of use of Licensed Software
under this Agreement.
5. INDEMNIFICATION
5.1 Indemnification by Haivision.
(a) Haivision shall indemnify and hold You harmless against any and all actions, claims, losses,
damages, liabilities, awards, costs and expenses (including reasonable attorneys' fees) ("Claims")
arising out of i) any accusation or purported violation of any third person's US and copyright,
trademark, patent rights or trade secrets, proprietary information on account of Your use of the
Licensed Software when used in accordance with the terms of this Agreement, or (ii) relating to or
arising out of any negligence or willful misconduct on the part of Haivision or any breach by
Haivision of the terms of this Agreement or any Maintenance and Support Agreement, or applicable
law. You shall promptly notify Haivision in writing of any such Claim and promptly tender the control
of the defense and settlement of any such Claim to Haivision. Haivision shall thereafter undertake
the defense of any such Claim using counsel of its choice. You shall cooperate with Haivision, in
defending or settling such Claim at the expense of Haivision; provided that Haivision shall not settle
any Claim against You which would require the payment of money by You without the prior written
6. OTHER PROVISIONS
6.1 Export and Other Restrictions. This Agreement, and all Your rights and Your obligations under
this Agreement, are subject to all applicable Canadian and U.S. Government laws and regulations
relating to exports including, but not limited to, the U.S. Department of Commerce Export
Administration Regulations and all administrative acts of the U.S. Government thereunder. In the
event the Licensed Software or the Hardware is exported from the United States or re-exported
from a foreign destination, You shall ensure that the distribution and export/re-export of the
Licensed Software or the Hardware is in compliance with all laws, regulations, orders, or other
restrictions of the U.S. Export Administration Regulations. You agree that neither it nor any of its
Affiliates will export/re-export any Licensed Software, Hardware, technical data, process, Products,
or service, directly or indirectly, to any country for which the Canadian government or United States
government (or any agency thereof) requires an export license, other governmental approval, or
letter of assurance, without first obtaining such license, approval or letter.