interoute one bridge management and reporting portal: user ... · interoute one bridge management...

Interoute One Bridge Management and Reporting Portal: User Guide

© Interoute Communications Limited Private and Confidential


Version History

Version Date Changes

6.0 12 December 2016 Changed MyServices headings

5.0 27 October 2016 Added Call Zone

4.0 18 September 2015 Added profiles description

3.0 11 September 2015 Added email support

2.0 28 April 2015 Added profiles support

1.0 9 June 2014 Initial commit

All quotes, offers or proposals are (i) made based on Interoute’s standard terms and conditions (ii) subject to contract, survey and availability; and (iii) only valid for a period of 30 days from the date of this message.

Copyright Statement © Interoute 13 December 2016

This document contains information proprietary to Interoute.

Nothing within this document may be construed as an offer to supply goods or services except where explicitly stated. All sales are subject to contract.

Interoute is a trading name of Interoute Communications Limited, registered in England number 04472687, registered address 25 Canada Square, Canary Wharf, London E14 5LQ, UK.



Contents

1 Introduction .............................................................................................................. 4

1.1 Prerequisites ................................................................................................................................ 4

1.2 Access to the portal ..................................................................................................................... 4

2 Interoute One Bridge Module .................................................................................... 6

2.1 Overview ..................................................................................................................................... 6

2.2 Summary ..................................................................................................................................... 6

2.3 Virtual Meeting Rooms Management ......................................................................................... 7

2.4 Active Calls .................................................................................................................................. 8

2.5 Batch Create VMRs .................................................................................................................... 10

2.6 Batch Edit VMRs ........................................................................................................................ 11

2.7 Reports ...................................................................................................................................... 13

2.7.1 VMR Usage Reports .......................................................................................................... 14 2.7.2 CDRs Download ................................................................................................................. 16

2.8 Information................................................................................................................................ 17

Appendix A .................................................................................................................... 18

Conferencing Layouts ............................................................................................................................. 18

Profiles .................................................................................................................................................... 19

Using Non-Standard ASCII characters ..................................................................................................... 20



1 Introduction

This user guide serves to describe the Interoute One Bridge Management and Reporting Portal. The portal is designed to be used by the IT or Video administrators of customers subscribed to the Interoute One Bridge services. The aim of this portal is to assist administrators with self-service Virtual Meeting Rooms (VMR) management and internal reporting.

1.1 Prerequisites The customer will need to be subscribed to our Interoute One Bridge services and have a valid login to the MyServices portal.

1.2 Access to the portal The portal can be accessed 24/7 via Interoute’s Customer Portal, MyServices (http://myservices.interoute.com).

Upon logging in, a video “tile” showing the current active ports is available in the portal for Interoute

One Bridge customers. If no video tile is shown, use the to add the Interoute One Bridge – Active Ports tile to your dashboard. You can also add the Interoute One Bridge – Active VMR tile to your dashboard if you want to monitor the active calls.

http://myservices.interoute.com/



Click on the title on the tile will bring up an “overlay” of the management and reporting portal. Each of the tabs will be described in details in this document.

The Interoute One Bridge overlay can also be accessed via the menu, under Products -> Communications -> Interoute One Bridge, as shown below:



2 Interoute One Bridge Module

2.1 Overview The Interoute One Bridge tile consists of seven tabs. These are:

Summary – Near real-time ports usage report incorporating a list of VMRs that have been in continuous use longer than a period of time specified by the user (configurable to anytime between 5-24 hours), with the option to disconnect all participants in a VMR.

Virtual Meeting Rooms – A searchable and sortable list of the customer’s VMRs (including name, uniform resource identifier (URI), Call ID, Passcode, Billing code, Number of emails assigned to the VMR, Profile, Leader Passcode, Participant Passcode, default layout and persistent chat option), with the option to create, edit and delete individual VMRs.

Active Calls – A searchable and sortable list of currently active calls, showing the number of participants in each VMR, with the option to disconnect all participants in an active VMR.

o Participants can be managed in real-time down to participant level.

Batch Create VMRs – Batch upload VMRs via a Comma-Separated values (CSV) file.

Batch Edit VMRs – Batch edit existing VMRs via a CSV file.

Reports - Reports are generated from the Call Detail Records (CDR) to show the breakdown of VMR usage. Reports with a specific timeframe and billing code will be generated, with the option to download the CDRs.

Information – Information about Interoute One Bridge configured for this account, including the ports purchased, burst allowance, domain, VMR dial-in prefix, a list of Telephone Access Numbers and a link to the Online Help Guide.

Each of these tabs is described in details in the following sections.

2.2 Summary The summary tab shows the near real-time ports usage in form of a speedometer graph. Ports are consumed as follows1:

Ports Consumed per Call

Call Type2

2 Video – above 720p30 to 1080p30

1 Video – above 480p30 to 720p30

1/2 Video – up to and including 480p30

1/5 Audio only

1 Interoute may change the definitions of ports without notice 2 Only “single camera video” calling is supported currently. In the future Interoute may support multi-camera calling in which case the ports consumed will be multiplied by the number of cameras’ video that the video endpoint is using in the call.



Ports Consumed per Call

Call Type2

0 Content sharing

0 Chat/Instant Messaging

The number of ports purchased, including the contracted burst limit is shown clearly in the speedometer graph. If the pointer is in the red zone, this indicates that a burst is occurring.

A list of VMRs that have been in continuous use for more than a specified period (configurable to be any time between 5-24 hours), along with the current call duration and number of participants is shown in the Summary Tab as well. Any of these calls can be terminated using the icon.

2.3 Virtual Meeting Rooms Management The Virtual Meeting Rooms management tab allows the user to manage their VMRs in real-time. A searchable and sortable list of the customer’s VMRs are shown, details including the VMR’s name, URI, Call ID, Passcode, billing code (if applicable), default layout (one of: All equal, Speaker Only, Telepresence, and Stacked – see Conferencing Layouts for layout descriptions), Persistent Chat, Profile (Audio Broadcast Mode, Audio Leader/Participant Mode, Video Broadcast Mode, Video Leader/Participant Mode – see Profiles for profiles descriptions), Leader Passcode, and Participant Passcode.

From the Virtual Meeting Room tab, the administrator can perform the following actions:

Create a new VMR

o Click on the button will bring up a pop up window, allowing you to enter the details for the new VMR to be created: Name*, URI*, Call ID,



Passcode, Emails (maximum of 10 allowed, each separated by a space), Profile, Leader Passcode, Participant Passcode, Billing code, default layout, and Persistent chat. Those marked with * are mandatory fields. The URI should contain a-z, 0-9, ., - and _ characters only. For the Call ID, ensure you use your E.164 prefix, e.g. 999233266 given to you. Example configuration is shown below:

Select and edit individual VMRs using the button

Select and delete individual VMRs using the button

2.4 Active Calls The Active Calls tab shows a near-real-time searchable and sortable list of VMRs (along with the number of participants) that are currently in use.

The drilled down participants information for this VMR can be viewed using the icon. Technical details of the participants’ connections are shown, including:

The name of the participant



Current call duration Outgoing/incoming media details

Encrypted/unencrypted media (if encrypted, is shown in the Status column)

Whether the participant is presenting content ( is shown in the Status column if the participant is presenting content)

Current layout (one of All equal, Speaker only, Telepresence or Stacked)

Audio mute status ( for muted audio or for unmuted audio)

Video mute status ( for muted video or for unmuted video)

The latter three settings may be controlled directly from the portal in real-time using the icons.

Moreover, participant can be disconnected from the call using the icon.

The following actions can be applied to multiple participants by selecting the participants you wish to make changes to and using the bulk action button:

Mute/unmute audio

Mute/unmute video

Change layout of conference

Disconnect participants



2.5 Batch Create VMRs VMRs can be created in batch via CSV upload from the Batch Create VMRs tab:

1. Download a CSV upload template using the download button, which will contain the following headings (Note: Please do not edit or remove the first row of the CSV file, and do not delete/reorder any of the columns):

Virtual Meeting Room Name * (mandatory field)

Virtual Meeting Room URI * (mandatory field; should not contain @domain name, and only a-z, 0-9, ., _ and – characters are accepted)

Virtual Meeting Room dial-in number (digits only)

PIN (digits only; PIN length depends on your Interoute One Bridge settings, please talk to your Account Manager for details)

Billing code

Email (maximum of 10 email addresses allowed. E-mail addresses must be separated by a space. The first email address will be treated as the primary email, any subsequent emails will be treated as additional emails e.g. delegation)

Default layout (use one of the following: “allEqual” for All Equal layout, “speakerOnly” for Speaker only layout, “telepresence” for Telepresence layout, or “stacked” for Stacked layout)

Persistent chat (default is no), put yes if required

Audio Broadcast Mode

Audio Leader/Participant Mode

Video Broadcast Mode

Video Leader/Participant Mode

Leader PIN (digits only; PIN length depends on your Interoute One Bridge settings, please talk to your Account Manager for details)

Participant PIN (digits only; PIN length depends on your Interoute One Bridge settings, please talk to your Account Manager for details)

2. (Optional) Select the “Check this box to auto-generate PIN’s if not specified” checkbox if you would like to have a random 4-digit PIN assign to the VMRs that do not have PINs specified already.

3. Choose the file to be uploaded via the “Choose File” button. 4. Click “Process Batch” to start the batch create process.



If your VMR name and billing code contain non-standard ASCII characters, please refer to the Using Non-Standard ASCII characters section for creating meeting rooms with non-standard ASCII characters.

A popup will show after the CSV file has been processed, informing the user of the outcome of the batch create process. Examples of popups are shown below:

A table of the VMRs that failed to create will be displayed, along with the error messages:

2.6 Batch Edit VMRs A list of VMRs and their details can be downloaded as a CSV file and then modified in batch via the Batch Edit VMRs tab:



1. Download a list of existing VMRs in a CSV format using the download button. The list of VMRs details will include the following (Note: Please do not edit or remove the first row of the CSV file, and do not delete/reorder any of the columns):

Virtual Meeting Room ID * (Do not edit the values in this column)

Virtual Meeting Room Name * (mandatory field)

Virtual Meeting Room URI * (mandatory field; should not contain @domain name, and only a-z, 0-9, ., _ and – characters are accepted)

Virtual Meeting Room dial-in number (digits only)

PIN (digits only; currently PIN with 4 digits are supported)

Billing code

Email (maximum of 10 email addresses allowed. E-mail addresses must be separated by a space. The first email address will be treated as the primary email, any subsequent emails will be treated as additional emails e.g. delegation)

Default layout (use one of the following: “allEqual” for All Equal layout, “speakerOnly” for Speaker only layout, “telepresence” for Telepresence layout, or “stacked” for Stacked layout)

Persistent chat (default is no), put yes if required

Audio Broadcast Mode

Audio Leader/Participant Mode

Video Broadcast Mode

Video Leader/Participant Mode

Leader PIN (digits only; PIN length depends on your Interoute One Bridge settings, please talk to your Account Manager for details)

Participant PIN (digits only; PIN length depends on your Interoute One Bridge settings, please talk to your Account Manager for details)

Delete Virtual Meeting Room (Put “Yes” if you wish to delete the VMR from the system)

Edit Virtual Meeting Room (Put “Yes” if you wish to modify the details of the VMR on this row)

2. (Optional) Select the “Check this box to auto-generate PIN’s if not specified” checkbox if you would like to have a random 4-digit PIN assign to the VMRs that do not have PINs specified already.

3. Choose the file to be uploaded via the “Choose File” button. 4. Click “Process Batch” to start the batch edit process.



If your VMR name and billing code contain non-standard ASCII characters, please refer to the Using Non-Standard ASCII characters section for creating meeting rooms with non-standard ASCII characters.

A popup will show after the CSV file has been processed, informing the user the outcome of the batch edit process. Examples of popups are shown below:

A table of the VMRs that failed to edit will be displayed, along with the error messages:

2.7 Reports Reports are generated from the Call Detail Records (CDR) to show the breakdown of VMR usage. Reports with a specific timeframe and billing code will be generated, with the option to download the CDRs. Reports can be generated with daily or monthly results. Note that if the selected period of time exceeds six months, monthly reports will be used.



Each generated report can be downloaded as:

JPEG/PNG image

SVG vector image format

PDF

2.7.1 VMR Usage Reports The following reports are available:

Daily/Monthly concurrent port usage over a specific period of time. This graph also shows the purchased ports and burst allowance.

Daily/Monthly accumulated usage in hours of all VMRs over a specified period of time. This graph can be zoomed into to give a more detailed view if required.

Call duration (in hours) by VMR, users can select to show the top 5-25 results:



The maximum number of participants in a VMR, users can select to show the top 5-25 results:

The frequencies each VMR is used, user can select to show the top 5-25 results:

The breakdown of the types of calls: number of calls made in Full HD, HD, SD, audio only and non-established3 calls:

3 Any calls that do not progress further than the VMR lobby are categorised as non-established. The VMR lobby is a waiting area when there are no other participants in the VMR, or when a PIN entry is required to enter the VMR.



2.7.2 CDRs Download CDRs can be downloaded via the Download CDR button as a CSV file. The following information will be included:

Call Leg ID

Call Start timestamp

Call Stop timestamp

Remote Party4

Call direction

Encryption

Device type5

Duration (in seconds)

Received Audio Codec

Transmitted Audio Codec

Received Video Codec

Transmitted Video Codec

Resolution6

Virtual Meeting Room Name

Billing Code

Call Zone7

4 “Soft-client guest” will be shown if the remote party was connected via WebRTC or guest account via the soft client. If available, the display name entered by the user will be displayed as well. 5 One of Lync, WebRTC or Other, which includes video endpoints, telephone, soft client etc 6 Whether it is Full HD, HD, SD or Audio only 7 Call Zone is the country (in ISO 3166-2 format) of the Interoute One Bridge platform that the participant’s call leg connected to



2.8 Information The information tab contains useful information about the Interoute One Bridge account:

A link to Online Help Guide

Ports purchased

Burst allowed

Domain

VMR number prefix

Telephone access numbers



Appendix A

Conferencing Layouts The following layouts are supported and configurable per virtual meeting room and per participant.

Layout Description Example

All Equal

All participants are given an equal area of the screen. This layout shows up to the 25 most recent participants.

Stacked

The active speaker is given the main area of the screen and all other participants are shown underneath the speaking participant. This layout shows up to the 7 most recent participants.

Telepresence

The active speaker is given the main area of the screen and all other participants are shown overlaid at the bottom of the screen. This layout shows up to the 7 most recent participants.

Speaker Only

A layout where the active speaker is given the entire area of the screen with no other participants shown. This layout shows only the active speaker.



Profiles Each virtual meeting room can be configured with a profile that determines what features/actions are available. The profiles available are listed in the table below.

Profile Name

Feature/Action

Default (No Profile)

Audio Broadcast

Mode

Audio Leader/Partici

pant Mode

Video Broadcast

Mode

Video Leader/Partici

pant Mode

Leader Passcode

No Yes, mandatory Yes, mandatory Yes, mandatory Yes, mandatory

Participant Passcode

No Yes, mandatory Yes, mandatory Yes, mandatory Yes, mandatory

Leader and Participants

share Passcode

Yes, Passcode is optional

No No No No

Can send Audio

Yes Leader(s) only Yes Leader(s) only Yes

Can send Video

Yes No No Leader(s) only Yes

Can share content

Yes Leader(s) only Yes Leader(s) only Yes

Can view content

Yes Yes Yes Yes Yes

Joining tone No No Yes No Yes

Leaving tone No No Yes No No

Wait in lobby No Participants will be held in lobby

until at least one leader joins

Participants will be held in lobby






When (last) leader leaves

N/A Participants will be

disconnected after 5 minutes

Participants will be






Video layout Yes, configurable per virtual

meeting room and per

participant

N/A N/A Participants: Speaker Only

Leader(s); All

Equal

Yes, configurable per virtual

meeting room and per

participant



Using Non-Standard ASCII characters Non-standard ASCII can be used in the Virtual Meeting Room name and the Billing code. These can be entered directly via the web portal when creating or editing a VMR.

Microsoft Excel does not cope well with the export of non-standard ASCII characters into CSV format. Therefore, when using the batch create/edit VMRs via CSV upload, it is recommended to download Notepad++ and using the following method instead:

1. Open the CSV file in Notepad++ 2. From the menu bar, select Encoding -> Encode in UTF-8 without BOM 3. Use non-standard ASCII characters where appropriate 4. Save file 5. Upload via the web portal

interoute one bridge management and reporting portal: user ... · interoute one bridge management...

Documents