Flex portal documentation

Table of Contents

Monitoring room

The Monitoring Room allows you to build a customized view of the ongoing transmissions that interest you, while having a quick view of alarms and bandwidth usage over time.

Monitoring Room layout

  • Room switch: This control allows you to select what Monitoring Room to show, or create new rooms in which to customize the monitoring experience.
  • Stream thumbnail: Shows a picture extracted from the stream every 5 seconds. Clicking the thumbnail will open the Stream Viewer. See the Stream Viewer documentation for more information.
  • Trending enable switch: Click this to enable/disable the trending graph underneath the monitors. Disabling it will make space available for more monitors in the same screen.
  • Add new monitor: This icon brings a dialog in which you can select an ongoing transmission to add to your Room.
  • Page navigation: When the total number of devices in the Matrix Room exceeds the maximum amount that can be shown at any given time, the pagination buttons allow you to quickly change pages.
  • Bandwidth trending graph: Enabled by the Trending enable switch, shows the stream bandwidth as measured at the receiver device. Clicking the graph will open the historical data view
  • Connection name: Shows the name given to the ongoing transmission. The name can be edited by clicking on the label.
  • Device status indicator:
    • GREEN: All devices participating in the transmission are ONLINE
    • RED: One or more devices participating are OFFLINE, or otherwise not ready for transmission.
  • Alarm console: Pop-up alarm console, open by default. See the Alarm Console documentation for details on how to interact with it.

Adding a Monitor

To add a new monitor, click the inline-img Add new monitor button on the top right corner of the Monitoring Room. A dialog will open that shows all ongoing connections:

Select the connection you want to add and click the tick inline-img icon to the right. Next, you will have the opportunity to name your monitor:

Enter a name and click Save. The monitor is added to the room.

Opening Stream Viewer

To get more details and change settings of an ongoing transmission, you can open the Stream Viewer by clicking on any thumbnail. See the Stream Viewer documentation for more information.

Matrix room

The Matrix Room allows you to make connections between video sources and destinations. The Matrix is divided in two sections: sources to the left and possible destinations to the right.

  • Sources section: Display all available video sources
  • Destinations section: Display all available video destinations
  • Connection staging area: Allows you to prepare and execute a connection
  • Alarms tab: Shows the number of unacknowledged critical alarms and allows you to open the alarm console. See the Alarms documentation for more information about the alarm console.

On top of both sources/destination sections, a navigation panel shows as follows:

  • Available levels: Allows you to select the input/output level for the connection. See [Connection Levels] (#Connection Levels) below.
  • Available categories: Allows you to select the categories to show/hide at any given moment. See Device categories below.
  • Search box: Helps you quickly locate a device by searching text. See Searching below.
  • Page navigation: When the total number of devices in the Matrix Room exceeds the maximum amount that can be shown at any given time, the pagination buttons allow you to quickly change pages.

Monitor Thumbnail

Each source and destination is represented by means of an active Monitor Thumbnail. This Monitor Thumbnail allows you to control aspects of the device in the Matrix Room:

Monitor Thumbnail

  • Device Name: This label shows the device name as known throughout the system.
  • Device Status: Indicates the availability of the device:
    • Green circle: ONLINE. The device is reporting available to FlexO
    • Red circle: OFFLINE. The device is not reporting to FlexO. Connections can still be set up, and will take effect as soon as the device is online.
  • Lock/Unlock: Allows you to lock the device so that no changes can be made to it. When you lock a device you will be prompted to leave a message. This message will be shown to users attempting to unlock the device.
  • Play stream: Attempts to connect to a browser-playable stream. This stream is the exact same stream being transmitted so it has the same quality and bandwidth.
    • Note: Playing the stream can have unintended consequences since the destination device will be sending you the native stream. Make sure the destination device network has enough upload bandwidth to send you the stream, otherwise the ongoing transmission may experience issues.
  • Access device admin interface: This icon launches the device web administration interface, if available. You will be required to enter the device's credentials in order to access.
  • Device categories: Allows you to tag the device adding it to one or more categories.
  • Device contact information: Shows the device's current contact information. You can edit this information by accessing the device properties in Topology Manager, Network Nodes section.
  • Peer device: This label shows what destination/source device this device is connected to. In case there is more than one device, the number of devices will be shown and the list of devices can be obtained by hovering over the label with the mouse.

Connection Levels

A connection level is the input or output interface of the device (input for sources and output for destinations) that will be used for the connection.

Levels can be selected/filtered by clicking on the labels on the bar:

As of this version, The Matrix Room supports the following levels:

  • SDI, Serial Digital Interface
  • TSoIP, Transport Stream over IP
  • FILE, for playing back recordings.

At any given moment, only available levels for devices present in the Matrix Room are shown.

Device categories

Devices can be assigned or unassigned to an arbitrary number of categories. This allows you to filter out devices that you do not want to see in a particular moment.

Available categories are shown on top of the monitors, next to the levels:

Clicking on any category label filters out non-selected categories. Selected categories are highlighted in green:

You can toggle the selected categories on/off by clicking on the corresponding label.

At any given moment, only available categories for devices present in the Matrix Room are shown.

Special category labels

  • The All category button selects all categories
  • The None category button selects devices that do not belong to any category

Categorizing devices

To assign a device to a category, click on the Device categories button inline-img in its corresponding monitor. A dialog will pop up:

You can begin typing category names. As you type, if the category already exists elsewhere you can select it from the dropdown. Otherwise, you can create it by selecting the "Add new category". Remove categories by clicking the X icon next to the category name.

Selecting/deselecting categories or otherwise creating/assigning devices to categories does not affect ongoing transmissions.

Searching

The sources and destinations sections have a search box on top that as you type, dynamically filters out devices that do not match the text written, effectively locating the devices that do match:

Making a connection

To make a connection:

1.- Select a destination by clicking on a thumbnail monitor. The destination is highlighted in a red frame and the staging area shows the selected destination device on the destination side:

If you select a destination that is already connected, you will see that the corresponding source is also selected in red on the sources section.

2.- Select a video source. The selected source is highlighted in blue and added in the Preset box in the staging area:

3.- The TAKE button is now enabled. When you click it, a connection confirmation dialog will open:

The dialog shows the connection about to take place. The source on the left (blue) will be connected to the destination on the right (red). The blue arrow indicates it is a new connection.

Switching sources

If the destination was already connected the following dialog would be shown instead:

The source in red would be disconnected, whereas the source in blue would replace it.

Disconnecting

To disconnect a transmission, select the connected destination:

The current source is highlighted in red. Clicking the TAKE button will then switch the empty Preset into the current source, effectively ending the transmission.

Connection status

At any given time, Monitor Thumbnails in the Matrix Room can be in any of these states:

  • Offline: The device is either offline or can't reach FlexO for management. Connections can still be established and will take affect as soon as the device is online
  • Ready: The device is online but not participating in a transmission
  • Connecting: The device has just been assigned a new transmission and it is in the process of establishing a connection
  • Connected: The device is part of a transmission. Note that this status is not shown explicitly, but rather the status text indicates what device it is connected to.
  • Disconnecting: The device has been pulled out of a transmission.
  • Cannot obtain thumbnail: There is a technical / network connectivity issue that prevents FlexO from obtaining a thumbnail from the device.
  • No thumbnail yet: The device is connected and transmitting, however the decoder in the destination device has not had the time yet to produce the thumbnail. If this message shows for more than 15 seconds, this could potentially indicate a firewall issue on the receiving side. Troubleshoot firewall issues/port mapping using the Support Toolkit.

Support Toolkit

The support toolkit empowers you with an easy to use test suite that helps you troubleshoot connectivity issues and also ensure the devices are up.

Testing a device

To start the test suite on any given device, find the device in the list and click the inline-img wrench icon. This will automatically start the test checklist and report on the results.

You can run the tests again by clicking the Restart Tests button.

Stream Viewer

The Stream Viewer allows you to monitor, troubleshoot and configure in detail an ongoing transmission. This is your integrated dashboard to adjust transmission settings and ensure a particular connection is healthy.

Stream Viewer layout

  • Stream Preview: For an ongoing transmission, thumbnails are shown here updated every 5 seconds. Clicking on the thumbnail starts a monitoring stream.
  • Bandwidth monitoring graph: Here you can visualize the instant bandwidth received by the destination.
  • Bandwidth threshold slider: Use the slider to set the device bandwidth and also lay a threshold line on top of the graph. Useful to see if the received stream conforms to the intended stream bandwidth. To enable the slider, use the "toggle threshold" button.
  • Client device settings: Here you can configure device-specific settings, such as video source and bandwidth/quality
  • Client device network information: For devices with multiple network interfaces, this panel shows what interfaces are active and information about the speed and data consumption incurred.

Historical Stream Viewer

You can access the historical stream viewer by clicking on two different options:

  • 'Bandwith monitor graph' inside the 'Stream Viewer'
  • 'Bandwith trending graph' inside the 'Monitoring room'

  • Historical graph: For a selected stream, you can visualize up to seven days historical bitrate and events related to involved devices. The graph responses to 'scroll' events from computer mouse.
  • Bitrate value: Time and bitrate value are displayed when hovering the bitrate serie.
  • Alarm(s): Red bars stands for alarms happened on that time.
  • Interval Links: You can click on these quick links to select the time interval from the current time to the selected time.
  • Current interval: The interval time that is being displayed in the graph.
  • Statistics: Some bitrate statistics regarding the bitrate and the current time interval.
  • Events table: Here you can visualize the events happened in the selected time interval.
  • Events filter: You can filter the events by user or by event type.

Alarm console

The alarm console is a pop-up window that can be opened at any time from any screen in the Flex Portal. It shows recent alarm activity and allows you to quickly detect if an issue needs your attention.

The console also allows you to acknowledge/confirm alarms, meaning the issue is resolved and therefore the console should stop showing the alarm.

Alarm console layout

  • Clear console: Cleans the current console view. Note that alarms are only hidden from view, not really acknowledged/confirmed.
  • Text filter: Quickly searches for alarms that contain the typed text
  • Active alarms: Shows the alarms that are currently not acknowledged.
  • Masked alarms: Shows the alarms that have been masked.
  • Filters: Allows you to filter each column by the different values
  • Acknowledged alarms: Lists the alarms that have been acknowledged by a user.
  • Pin button: Pins the alarm console so that it does not auto-hide when clicking elsewhere.
  • Collapse button: Hides the alarm console
  • Alarm information panel: This panel appears when you click on an alarm to show more details on it.
  • Alarm acknowledgment button: Clicking this button will dismiss the alarm. You can provide a message explaining the reason the alarm can be dismissed. Acknowledged alarms are displayed in the Acknowledged alarms pane.

Acknowledging an alarm

To acknowledge an alarm, click on the alarm row, then click the confirm button on the Alarm information panel. A dialog will pop up:

Provide a reason for acknowledging the alarm and click "save". The alarm will then be cleared and visible in the Acknowledged alarms pane.