Morbit Studio Administrator Guide

Created by Tim Kefford, Modified on Wed, 26 Mar at 11:12 AM by Tim Kefford

User Guide for v5.4.3.0


TABLE OF CONTENTS

Introduction

Morbit studio is a platform for managing Unified Communications Devices, Microsoft Teams Users, display screens and network connected devices. 

To manage on-premise network connected devices, such a display screens, IP-based devices and Cisco or Poly Devices (running SIP or H.323), you are required to install some software we call the ‘morbit hub’. The morbit hub is a key component of the morbit platform. It acts as the bridge between your internal networks and equipment, to our cloud service.

If you are only setting up the MS Teams service, you can jump straight to that sections once you have completed points 1-3 in the Create your Organisation section.

Prerequisites for morbit hub 

For setting up the best experience, we would recommend that the morbit hub software is installed on a Windows computer on the same subnet as the Devices (or at least most of them). If you need to access other networks, then you can add them as ‘Manual Devices’. For the service to work, you just need IP line of sight to the devices from the hub.


Hub computer(s)

The Windows computer requires a minimum of the Microsoft .Net 4.7 Framework installed. Typically, this is already installed and the version can be identified using these instructions: https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed.


The hub software is currently only available as a Windows client. Minimum supported operating system versions are Windows 10 version 1607, and/or Windows Server 2016. We recommend that you run the hub from a server to enable maximum up-time for your hub and service. The installation of multiple hubs is supported as this allows for service resilience and accurate reporting.


You will need to be able to have Administrator level security rights to those systems for installation of the morbit hub.


Minimum specifications for a Hub computer

See this guide.


  Do not install the hub on a computer that is multihomed or uses a software VPN (either occasionally or always), as this will cause connectivity issues with our service.


Summary

Do:

  • Use a Windows computer (Windows 10 version 1607 and above, or Windows Server 2016 and above).
  • Have a minimum of Microsoft .Net 4.7 installed on the computer.
  • Install the hub(s) on the same subnet where the Devices are located (or most of them are). Where possible, install a hub per Device subnet.
  • Install hubs on computers that will be switched on 24/7
  • Have a valid morbit studio account provided to you

Do Not:

  • Do not install on a computer that is multihomed
  • Do not install on a computer that uses a software VPN (either occasionally or always)

Licensing

Morbit studio can be licensed in 2 ways. These are:

  • Microsoft Teams license – licensing for monitoring and reporting on a MS Teams tenant only.
  • Full License – provides access to all features.
  • Full License with Smart Building option - provides access to all features along with optional Smart Building components

Licensed features

Dashboard

FeatureMS TeamsFull LicenseFull License w/ Smart Building option
Unified Comms Devices CountYesYesYes
Unified Comms Device Alerts CountYesYesYes
Unified Comms Device Status Graph YesYesYes
Unified Comms Device Health GraphYesYesYes
MS Teams User CountYesYesYes
MS Teams User Alerts CountYesYesYes
Display Systems CountYesYesYes
Display Systems Alert CountYesYesYes
Display Systems Status GraphYesYesYes
Connected Devices CountYesYesYes
Connected Devices Alerts CountYesYesYes
Connected Devices Status GraphYesYesYes
Call Quality % ratingsYesYesYes
Call Activity GraphYesYesYes
Active Teams CallsYesYesYes
Recent Device ActivityYesYesYes
Organisation Filter ViewYesYesYes


System Setup

FeatureMS TeamsFull LicenseFull License w/ Smart Building option
Add Organisation(s)YesYesYes
Add BuildingsYesYesYes
Add RoomsYesYesYes
Add a remote Network
YesYes
Add a morbit Hub
YesYes
Integration to Neat PulseYesYesYes
SIP/H.323 Simulator Test
YesYes
Autodetect DevicesYesYesYes
Manually Add Devices
YesYes
Add a MS Teams TenantYesYesYes
MS Teams Connection TestYesYesYes
MS Teams Account FilterYesYesYes
Lock MS Teams Discovery optionsYesYesYes


Monitoring

FeatureMS TeamsFull LicenseFull License w/ Smart Building option
Device ListYesYesYes
Device Online/Offline StatusYesYesYes
Device Health Status AlertingYesYesYes
User Issue AlertingYesYesYes
API Access AlertingYesYesYes
Alerting via EmailYesYesYes
Incident and Recovery AlertingYesYesYes
Alerting via Web UIYesYesYes
Search and Filter DevicesYesYesYes
Device NameYesYesYes
Device Make and ModelYesYesYes
Device Serial NumberYesYesYes
Device Registration DetailsYesYesYes
View Installed Software VersionsYesYesYes
View Microsoft Device TypeYesYesYes
MS Teams UsersYesYesYes
User Presence StatusYesYesYes
Device Analysis ReportingYesYesYes
User Activity ReportingYesYesYes
Health and Peripheral AlertingYesYesYes
Environmental sensor data (Neat and Cisco devices)
YesYes
View Real Time Call Metrics
Yes*Yes
View Floor Plan of Live Room Usage

Yes
View System EventsYesYesYes
Custom Filter ViewYesYesYes
Export Data to CSVYesYesYes

* with SIP/H.323 Cisco and Poly devices


Management

FeatureMS TeamsFull LicenseFull License w/ Smart Building option
Device Configuration
YesYes
Remote Device Access
YesYes
Call Control
Yes*Yes 
Software UpgradesYesYesYes
Device Backups
YesYes
Restart DeviceYesYesYes
Remote SSH/Telnet
YesYes
Scheduled TasksYesYesYes
Add custom Notes on each DeviceYesYesYes

* For Cisco and Poly (SIP/H.323) devices and for MTR on Windows devices (using VNC or similar)


Asset Management

FeatureMS TeamsFull LicenseFull License w/ Smart Building option
Asset Explorer - view Assets by location
Yes
Yes
Yes
Asset Register - complete Asset list
Yes
Yes
Yes
 - Add non-networked assets
Yes
Yes
Yes
 - Add digital (software) assets
Yes
Yes
Yes
View Live Floor Plans of Room usage on a Wallboard

Yes


Call Data

FeatureMS TeamsFull LicenseFull License w/ Smart Building option
Per Device Detailed Call ListsYesYesYes
Per User Detailed Call ListsYesYesYes
Call Types – Call or ConferenceYesYesYes
Call Information and MetricsYesYesYes
Environment Sensor Data (Neat & Cisco)YesYesYes
Room People Count  (Neat & Cisco)YesYesYes
3-Tier Call Quality RatingsYesYesYes
Highlighted Call Issue DataYesYesYes
Export to CSVYesYesYes



Alerts

FeatureMS TeamsFull LicenseFull License w/ Smart Building option
View all AlertsYesYesYes


Reporting

FeatureMS TeamsFull LicenseFull License w/ Smart Building option
Call ListYesYesYes
Call UsageYesYesYes
Call DistributionYesYesYes
Call ProtocolsYesYesYes
Call QualityYesYesYes
Group ParticipantsYesYesYes
Registration UsageYesYesYes
Registration QualityYesYesYes
Client Operating SystemYesYesYes
Registration ActivityYesYesYes
Peripheral ListYesYesYes
Peripheral OverviewYesYesYes
SIP/H.323/Webex Device Usage
YesYes
SIP/H.323/Webex Device Quality
YesYes
SIP/H.323/Webex Active Devices
YesYes
Service ContractsYesYesYes
Automated Service Contract Expiry EmailsYesYesYes
Unified Multi-Vendor ReportingYesYesYes
Maximum Report Timeframes1 Year1 Year1 Year


Remote Connections

FeaturesMS TeamsFull LicenseFull License w/ Smart Building option
Remote access over RDP
YesYes
Remote access over HTTP(S)
YesYes
Remote access over SSH
YesYes
Remote access over Telnet
YesYes
Remote access over custom TCP ports
YesYes


Displays

FeatureMS Teams Full LicenseFull License w/ Smart Building option
Power On/Off
YesYes
Change Volume inc. Mute On/Off
YesYes
Change Source/Input
YesYes
Alerting for On/Off power states
YesYes
Add custom Notes on each DisplayYesYesYes


Connected Devices

FeatureMS Teams Full LicenseFull License w/ Smart Building option
Alerting for Off/On power states
YesYes
Device Categorisation
YesYes
SSH Access (where supported on device)
Yes
Yes 
Create and run macros for SSH commands
YesYes
Add custom Notes on each Device
YesYes


Smart Buildings

FeatureMS TeamsFull LicenseFull License w/ Smart Building option
Add/View MS Exchange Room Calendars to Rooms

Yes
View MS Exchange Calendar Free/Busy and Organiser Data

Yes
Create and Share Wallboards for Floor Plans and Rooms 

Yes
View Live Floor Plans of Room usage on a Wallboard
Yes
Support for 3rd Party Room Sensors

Yes


Service Provider Support

FeatureMS Teams Full LicenseFull License w/ Smart Building option
Manage 1-to-Many Customers/TenantsYesYesYes
Remote Access to Devices without VPNYesYesYes
Provide Access to CustomersYesYesYes
Limit account access to specified email domainsYesYesYes
Anonymisation of Call data (Internal and External)YesYesYes
Simple OnboardingYesYesYes
No Infrastructure needed for DeploymentYes


Setting up morbit studio

Create your organisation

  1. Login to the platform at https://studio.morbit.co.uk with the account provided to you
  2. Select System, then the Configuration menu item, then select ‘Add Organisation’ 
  3. Provide the name of your company (or the one you will be managing if you are a service provider), select the license Type and click ‘Save’. Where:
    1. Full License – allows all features
    2. MS Teams – allows for monitoring, management and reporting on MS Teams tenants only


 If you are setting up an MS Teams tenant only service, you can skip to those sections now.

Create a network

  1. Click the Company name entered, and this will load the organisation configuration panels.
  2. From the Networks & Hubs panel, click the button, and complete the details as prompted then click ‘Save’.The Contact for the network will receive alerts from the platform for scheduled tasks and notifications from the system. You can use comma separated values to assign multiple contact email addresses.
  3. If successful, you will see the network is created yet offline (noted bysymbol). Select the network by clicking it. You will load the Network Details screen (like this):

Install the morbit hub

  1. In the Network Details page, select the Hubs menu item on the left. You will load up the Hubs screen for the network.
  2. Select the button. The hub will download as an MSI installer. Run the install program on the computer where the hub is to be running from. For security purposes and avoidance of Windows Smart Screen blocking, the MSI installer is digitally signed using our extended validation certificate. 
  3. You will initially be presented with a welcome screen as shown below:
  4. Click Next to the install location screen. If you do not want the default location, please change it here to suit your needs. Click Next to proceed to the next install confirmation screen.
  5. Click Install if you are happy to proceed with the installation. Once completed, you will be presented with this screen.
  6. We recommend that you continue with the Launch the program option selected. Click Finish.

Pairing the morbit hub to your account

  1. If the hub window is not already showing, go to the system tray where you will find an animated morbit logo (). Right-click this logo and choose Open. 
  2. Return to the Hubs screen and click the  button.
  3. Give a Description to the Hub (suggestion: use the computer name for easy identification). You will need to copy the key from the morbit hub (by clicking the Copy to clipboard button).
  4. Once completed, click the Save button. After a few seconds, your hub status will now change to ONLINE.

Congratulations, your video Devices are now being monitored by morbit. You may repeat this process for any other subnets or offices that you require.

Enabling the Remote Connections feature

You must have a hub installed to configure and use this feature. See Create a network and Installing the morbit hub sections.

  1. In the System > Configuration screen, edit the Organisation you wish to enable remote connections for, and tick the box Enable Remote Connections. Click Save.
  2.  In the same Organisation menu, click the Network where the installed Hub is located, when the screen loads, click the Hubs menu.
  3. Now click the name of the Hub where the devices you wish to connect to are located. When that loads up, click the Remote Connections menu, then the Click to enable it button. You will then see this screen.
  4. Follow the instructions on that screen. Once completed, click the Test option at the top of the loaded box. If it was successful you will see this screen:
  5. You can now start Remote Connections to Unified Comms Devices and Connected Devices that you have on the network that the Hub was installed on.

Setting up a Microsoft Teams tenant

Instructions for this can be found in this online document here.


Setting up SIP/H.323 video devices - Cisco and Poly

SIP/H.323 video devices from Cisco and Poly are added in two ways in the platform. If they are on the same IP subnet as the hub, they will be detected automatically, identified, and monitored. Whereas when on a remote subnet to the hub, the Device will need to be manually added by IP address.

Automatically detected devices

Utilising the unique morbit device detection algorithms, Devices on the same subnet will be added automatically into the platform. They will be shown either in the Devices menu screen, or in the Devices menu option within the Network Details Screen.


By default, and without credentials, morbit studio will attempt to display the Device:

  • Name
  • Manufacturer
  • Model
  • Software Version
  • IP Address
  • Serial Number


Clicking onto the Device for the first time, you will be prompted for the Username and Password of the web interface credentials. Once supplied, the following additional details are available:

  • Registration information
  • Diagnostics warnings and errors
  • Configuration information
  • Call data and statistics, including real time data if Device is in a call
  • Hardware information
  • Analysis
  • Alerting
  • Firmware upgrades
  • Backups
  • Utilities

Manually added Devices

When a Device is on a remote subnet and does not get automatically added to the platform, it will need to be manually added in via IP address. This is known in the system as a “Manual Device”.


 Devices added in this manner MUST either have a static IP address or a DHCP reservation assigned to them.


To add a manual device, it must be added via the Networks Details page within the relevant organisation structure (found via System > Configuration > "Organisation Name" > Network Hubs. Clicking on the All Devices menu in the left pane will load up the currently listed Devices known about by the system. These will be a list of Devices and hub computers.


Clicking the button on the top menu, will load up the New Manual Device page:

Complete the details and click relevant manufacturer Device type. This will prompt you to insert your Username and Password for the web interface credentials (Cisco) or Telnet/SSH credentials (Poly). Click Save.


After a few moments, the newly added Device will appear in the Device listings.


Data privacy – call anonymisation

The platform allows you to anonymise the Caller names of 3rd party companies and internal staff. To enable this on an organisation, you must set this in the System > Configuration menu.


Navigate to the company you want to set this for in the Configuration screen, then select the edit icon. Clicking the Security tab will open up the anonymise options.

  • Anonymise External Users – All external call participants will show as ‘External User’.
  • Anonymise Internal Users – All internal Users not known to the solution (due to Discovery settings and filters) will show as ‘Internal User’. An example being an MTR-only deployment, where only the MTR names are shown.

 This feature only applies to MS Teams Calls only, and enabling or disabling this feature is only available to Morbit Studio Users with Full Access to the Organisation being changed.


morbit studio interface

The morbit studio interface is designed to help you get to the information you need without being exposed to a flood of unnecessary data. The experienced is designed to be consistent regardless of the Device manufacturer you are working with, although some subtle differences are acknowledged and detailed in the interface.

Home

The Home screen is the default entry page for the platform. It has been designed to give a quick summary of the estate being managed in a glance.

 

Unified Comms Device Status

This chart shows the information on current statuses of the Devices on the platform. These are described as:


StatusFurther Information

Online + RegisteredDevice is online and registered to a video service

Online + Not RegisteredDevice is online but not registered

Online + InaccessibleDevice is online but web/API credentials not working

OfflineDevice is offline and inaccessible


Unified Comms Device Health

This chart shows the diagnostic health information of the Devices on the platform. These are described as:


StatusFurther Information

No IssuesDevice is reporting no diagnostic issues

WarningsDevice is reporting warnings in its configuration or hardware

Non Urgent

Device is reporting minor issues or notifications that need attention


ErrorsDevice is reporting errors in its configuration or hardware

UnknownDevice diagnostics are not available


Display System Status

This chart shows the information on current statuses of the display systems on the platform. These are described as:


StatusFurther Information

On% of displays in an 'On' state

Standby% of displays in a 'Standby' state

Off% of displays in an 'Off' state


Connected Device Status

This chart shows the information on current statuses of the Connected Devices on the platform. . These are described as:


StatusFurther Information

On% of Connected Devices in an 'Online' state

Off% of Connected Devices in an 'Offline' state


Call Activity

Call activity displayed over the last 30 days. This information is based on the call duration and number of calls collated from each Device to form a Summary chart.

Active Teams Calls

The number of calls currently active in the MS Teams tenant. This value is based on the Users’ active presence statuses. For 100% accurate call data, see Call List reports after the meeting has completed.

The  icon indicates the person listed is presenting their screen.

 

Recent UC Device Activity

This screen displays the online and offline events from the Devices managed in the estate, where:

Device went offline
Device came online


Organisation Filter

Above the graphs is a drop-down list where you can filter the views to specific Organisations in your portal. Selecting a specific organisation (if multiple are configured) will set that for the view on all other pages where there is an Organisation filter. You can see when it’s activated as the filter box is highlighted green to indicate it. To reset the view, simply select All organisations again.


Quick Access

The Quick Access feature enables you to add shortcuts to your most frequently used sub-menu screens. 


Where ever you see the pin icon at the top right of a screen, you can click this to add a new link in the Quick Access menu. Clicking it again will remove it.


Asset Management

The Asset Management section brings a centralised register of all assets held in the system. This can be viewed either by country location, office building, or meeting room. Alternatively as a simple list view.


The main Asset Management menu has three sub-menus:

  • Asset Explorer - explore assets by physical location
  • Asset Register - view a list of all the combined assets and add non-networked assets (peripherals, furniture, etc)
  • Service Contracts - view service contracts and expiry dates assigned to assets

To build the sites and rooms to enable asset allocation to Buildings and Rooms, you'll need to follow the instructions in the section Buildings within the Organisation configuration section in the System settings.  


The icons used in Asset Management are for quick statuses of:

  • Service Contract support

Service Contract not expiring for more than 60 days

Service Contract expiring within 60 days
Service Contract expired
Service Contract unknown or no dates added
  • Online status
Device is online
Device is offline


Note: Asset Management features are based on devices being added into the platform. If you have not done this yet, complete those steps first.


Asset Explorer

Asset Explorer allows you to navigate the assets of an Organisation using their physical location. The structure is based on:


Company Name > Country >Building Name > Room Name

Simply expand the locations and view the data. Clicking any asset in the view will open up the standard device management screens associated to the device type.


Clicking a Building or a Room in the Explorer view allows you to manage it, including allocation, or de-allocation of assets.


Note: If you have not created Building or Rooms yet, please complete those steps first. See System > Configuration > Organisation.


Asset Register

The Asset Register is a complete list of all assets associated with the system. Assets listed here can be filtered by clicking the filter icon and selecting your view preferences or options.


Allocating Assets to Rooms

Click the '+' symbol at the end of the row of the asset you want to allocate. This will open up a list of rooms, simply click the 'Allocate' option against the room you want to assign the asset to.


Adding non-network connected assets

As well as supporting network attached assets, the system will also support non-network connected assets such as peripherals, furniture, accessories, or digital assets such as software licenses.


To add these, click the + Add Asset and complete the details as thoroughly as possible. Once added these will appear in the Asset Explorer view (if assigned to a Room) and in the Asset Register list.


Service Contracts

A report to show you the status of any service contracts that might be active against your Devices. This data can be exported via the Export button.


Smart Buildings

Note: This is an additional license and will only show in your Menu if enabled. Please contact your supplier to arrange for a demonstration or a license.


Utilising data from MS Teams, sensors and Exchange Calendar data for Rooms, we've created a unique solution to allow you to review live data of your meeting rooms. Information captured and displayed includes:

  • Free/Busy status of Rooms and who the meeting Organiser is
  • Recent Call Quality to ensure you are using a reliable video-enabled meeting room
  • Sensor data: (metrics captured varies by sensor manufacturer)
    • People Count
    • Temperature
    • Humidity
    • CO2
    • Air Pollutants (VOC and VOC Index)
    • Illumination (Lux)
  • Wallboards of the Floor Plans showing Meeting Room status including 'Now and Next' bookings 
  • Alerts to let you know if a room has a fault with its included equipment



Pre-requisites for feature

In order to deploy the Smart Buildings feature you will need to:

  1. Have it enabled on your account. If you have 'Smart Buildings' listed in your menu then you have this feature enabled, contact your supplier if not.
  2. Successfully added a 'MS Teams Tenant' to your service. Follow the instructions here to complete that if not.
  3. Added the 'Smart Buildings' additional MS Graph APIs. Further details can be found here
  4. Created your office Buildings, Floors and Rooms that match your real world office environment. Instructions are found here.
  5. (Optional) Add sensors from Neat and Cisco MTR devices. For Neat Pulse users, follow this guide. For Cisco Control Hub users, follow this guide.


Assigning Exchange Room Calendars to Rooms

Once the pre-requisites are completed, you will need to wait for the platform to synchronise the Room Calendars in your Microsoft 365 Exchange system. To follow this progress you can go to the Smart Buildings > Room Calendars menu and the right-hand pane will populate with the data.


Note: The only type of Calendars we import are ones that have been created as Room Resources within Microsoft Exchange. More information from Microsoft can be found here on how to set this up.


Method 1

In the Smart Buildings > Room Calendars screen, click on the '+' symbol at the end of the row of the Calendar you wish to allocate to a Room. When the screen loads, select the Room you want to assign it to. 


Method 2

Navigate to System > Configuration > <Your Organisation> > Buildings. Click the Office Building you want to assign the Calendar in, and click through to the Floors > Rooms to the Room you want to assign the Calendar into. Select the Room Calendar from the Calendar drop-down list and click Save


Repeat either method until you've assigned your required Calendars to Rooms.


Create a Floor Plan and allocate Rooms

  1. Navigate to System > Configuration > <Your Organisation> > Buildings
  2. Click the Office Building you want to add the floor plan in, and click through to the Floors section. 
  3. Select the Floor you want to add a floor plan to, then click the sub-menu Floor Plan.
  4. Select the Choose floor plan to upload button, and navigate to the location on your computer or network where the floor plan is saved. The file types supported are: png; jpg; jpeg. Click Upload.
  5. At the top-left of the floor plan will be a number of blue ringed circles. These represent the Rooms allocated to that Floor, and are assigned the initials of the Room. Drag and drop them onto the floor plan to the location where the Room is. 
  6. Repeat this process until all Rooms are assigned, then click Save Room Positions


Note: If you do not want a Room to appear in a floor plan, you can go into the properties of the Room via the Rooms sub-menu and de-select Show On Wallboard. Click Save.


Configuring the Wallboard

If you have any black bars down the side of the Floor Plan like this:

You can remove this by clicking the Background button, and using the colour selector, sampling the colour from the background you'd like:



To set the layout of the Legend and Free/Busy panels on the Wallboard, you can click into the Wallboard Config sub-menu. Select your preferred locations (or Hide them) and click Save.


Launching the Wallboard

Accessing the Wallboard doesn't require an account in the platform, and can see anonymously accessed if you know the URL.


To get the URL or to launch the Wallboard you can do it from a few locations.


Method 1

From within the Floor Plan sub-menu, click the Wallboard button at the top right. You can copy the URL and share it out as needed.


Method 2

Navigate to Smart Building > Floor Wallboards. From here you can filter the view via the Organisation, Country or Building. At the end of the rows of listed Floor Plans, you can choose to Launch the Wallboard to a new browser tab or Copy the Wallboard URL for sharing.


Method 3

Navigate to Asset Management > Asset Explorer. Expand the list to the Organisation, Country then Office Building. On the listed floors, you can click the Wallboard icon next to the floor number to launch the Wallboard in a new browser tab.


Devices > Unified Comms Devices – Cisco and Poly

Clicking the Devices > Unified Comms Devices menu will load the full list of all UC devices within the service. Filter options are available to drill-down the viewed list of Devices. Additional options provided here are:

  • Group Backup Task


You can choose to Backup all the Devices in the estate, or just a subset of Devices by using the filters to update what is shown.


To do choose your target Devices, load up the main Devices menu. Should you require it, using the filter views drill-down to the Device requirements that suits your needs. For example, use the ‘Networks’ filter or ‘Registration filter’ to narrow down the targets. Whatever is in the Devices view, when clicking  on the top menu will apply the task to.

When: You can apply the task immediately using Now or else Schedule Once or Schedule Recurring.

 Running on a recurring basis for all Devices allows you to set this up and know that all devices will be backed up according to your recurring schedule. Set it and forget it!

  • Group Upgrade Task – further information on this is detailed here
  • Group Restart Task – this will initiate a task to schedule a restart command to all the Devices in the current view. It applies to all Devices that are online with API access working at the time of the task running.
  • Export List – export the current viewed Devices to a CSV file

Summary icons

Provided next to the Name of the of Devices is a quick summary view of the status of the Device. These statuses are detailed as:

IconDescription
Device is online
Device is offline
Web/API credentials are correct
Web/API credentials are incorrect
Device is registered to a video service
Device is not registered to a video service
Registration status is unknown due to credentials issue
There are no diagnostic or health errors reported
There are warning diagnostic errors reported
There are error diagnostic errors reported
Diagnostic statuses are unknown due to credentials issue
Device is currently in an alert state and emails have been sent to configurated contacts
The Device is not in an alert state (or not configured to alert)


Device Details

Selecting any SIP-based Device from the list will load the Device Details screen. The top menu provides for the following features:

  • Release from Device Management – this will remove the device from the Device list, and it will only show in the Network > All Devices page. You would select this if you no longer wanted to manage the Device.
  • Schedule > Schedule Backup – further information on this is detailed here
  • Schedule > Schedule Upgrade – further information on this is detailed here
  • Schedule > Schedule Restart – this will initiate a task to schedule a restart command to this Device


Selecting a SIP-based Device will provide the following menu options:

Web/API credentials workingWeb/API credentials not working
GeneralGeneral (includes Username/Password box to resolve Web/API access credentials issue)
Remote Connections (if enabled)Call Activity
Real TimeAnalysis
Configuration*Alerts
Call ActivityUtilities
Analysis
Alerts
Backups
Upgrade*
Raw Data
Utilities

* = Not available on Cisco Webex registered Devices as these should be configured via a Webex Control Hub. This restriction is displayed in the General screen.


General

Provided here are Summary information items of the Device and some system control options.


The option to rename the Device to something other than the detected System Name (or initial manually added name) is provided by updating the Description box.


In this summary page, along with the Devices hardware details you can view the registrations details, current call status, and quick Device management controls.


To remotely restart a Device, simply click the Restart Device button, and confirm in the prompt window.

Information on Call Control and Support Contracts are detailed elsewhere in the document.


Remote Connections (if enabled)

Note: this feature is only listed if the device is on a network with the Remote Connections feature enabled on a Hub.


Depending on the device type, you can select the following connection protocols:

  • Remote Desktop Protocol (RDP)
  • HTTP or HTTPS
  • SSH
  • Telnet
  • Custom TCP Port


Real Time

When a call is in progress you can view the live statistics directly from the Device.

 


This information includes the following metrics:

  • Call rate (inbound/outbound)
  • Call duration
  • Video resolution (inbound/outbound/presentation)
  • Jitter (inbound/outbound)
  • Packet loss (inbound/outbound)
  • Remote call address
  • Codecs (audio/video/presentation)
  • Encryption level
  • Hardware information:
    • Ethernet Speed
    • Temperature
    • Temperature threshold

Configuration

For assistance in simplifying the management of Devices, in this screen you can configure the settings of the Device – regardless of Cisco or Poly as the manufacturer – as a unified experience where the most pertinent features required are available.


 

Configurable items available in this screen are:

Configuration Items
System NameTime ZonePhone Book IDH.323 Mode
SIP ModeLanguagePhone Book TypeH.323 Call Setup Mode
SIP Display NameDefault ProtocolPhone Book URLH.323 Gatekeeper Address
SIP User NameDefault Call RateSelect Phone BookH.323 Login Name
SIP PasswordEncryptionDomain NameH.323 Password
SIP URIAuto AnswerDNS (1 to 3)E164 Address
SIP Proxy (1 to 3)Auto Answer with MuteNTP ModeH.323 ID
Telnet ModeSSH ModeNTP Server (1 to 3)


After changing any items, simply click Save to apply the changes to the Device. You may change 1 or multiple items at a time - there is no restriction.

 

Call Activity

Recent calls to or from the Device are listed in this screen. The default date selection is for a 14-day window, but that is easily changed by altering the dates in the selection boxes.

 


Calls in this list are rated as: (Cisco only feature)

Perceived Call QualityPacket LossJitter
Good< 0.2%<10ms
OK0.2% <> 2.0%10-50ms
Bad>=2%>=50ms


You may export this call list to a CSV file by clicking the   button.


Clicking on a listed call will provide further data on that specific call including encryption levels and disconnect reasons. See example:


Analysis

The Analysis page provides a summary view of the Device over 3 timeframes – Last 24 Hours, Last 7 Days or Last Month. Selecting the buttons at the top will alter the view displayed, to the chosen timeframe.

The Analysis sections listed are:

  • Availability – how long has the Device been online (network), shown as a graph and percentage of timeframe selected.
  • Call Activity – how many calls have been made, and the combined duration of them during the timeframe selected.
  • Call Summary – a summary of the calls during the timeframe selected.
  • Call Quality – of the calls made, what are the ratio of Good, Ok and Bad calls with regards to rated quality.
  • Disconnect Reasons – of the calls made, what were the supplied call disconnect reasons: Good, Bad or Unknown.
  • Protocol Breakdown – which call protocols were used in the calls

 Features shown may vary due to data supplied from the Devices used.

Alerting

Enabling alerts on a Network is done via the Organisation menu, then selecting the Network of that organisation that you wish to enable. This will load up the Network Details screen. To turn on alerts for the Devices, ensure that the Devices Alerts selection box is ticked.


Next, in the Alert Notifications field, add the email addresses of the people or distribution lists that you want to have alerted when there is an issue. For multiple entries, separate the addresses by a comma. Click Save to finish.


To Disable alerts for a Network, simply uncheck the Devices Alerts selection box and click Save to finish.


On a Device, to enable email alerting for issues, the Alerting menu will provide you with the alert options available. The alerting items are only active when the Enable Alerts check box is ticked.


Once ticked the options to alert on are:

  • Offline Status Alerting – the Device is offline and uncontactable by the morbit hub (e.g., unit is switched off or network down)
  • API Status Alerting – the morbit hub is unable to connect to the Device API. This could be due to the credentials being incorrect or the access is disabled.
  • Registration Status Alerting – the device is reporting as unregistered to a video service.
  • Error Health Alerting – the Device is reporting errors in the device configuration.
  • Warning Health Alerting - the Device is reporting warnings in the device configuration.


Alerts can be sent out based on multiple criteria. They are customisable depending on requirements on a per Device basis.


Backups

To take a backup of a Device in its current configuration, then provide a label for the backup in the Label field and click Backup Now. After a couple of seconds, you should receive a confirmation message letting you know it was successful.


You may use any backups taken to restore a configuration back onto the Device. Simply select the backup required and choose Restore Now to apply it.


  A restore will not include the Device credentials for SIP or H.323 registrations. These will need to be applied via the Configuration screen once the Device is restarted from the restore process.


Upgrade – Cisco SIP-based devices only

You can remotely upgrade (or downgrade) the firmware of a Device in this menu. When appropriate firmware is made available to the platform (full details in Firmware section) you can initiate the process simply by clicking the Upgrade Now button.


Displayed in the screen is the current software version and the Is Latest Version is identified via a  icon.

Should you need to downgrade to a different version due to issues, then select the Upgrade Now button next to the software version you require.


 Please read your manufacturers documentation for compatibility when upgrading or downgrading software. Some software versions may not support roll-back.


Raw Data

Should it be necessary to get information not displayed in the morbit studio interface then there is an additional method to obtain that data via this menu. The raw system data of the Device is available by clicking the required information from the menu heading options.


Utilities

In the Utilities section, you will be able to SSH or Telnet to and PING the Device for troubleshooting purposes.


If the Web/API credentials allow it and SSH Mode or Telnet in Configuration is set to On, then you will automatically establish a session to the Device. Use this as you would any SSH/Telnet session to the system. Features not exposed to the morbit studio user interface may be configured via this access.


You can test a Device for connectivity or packet loss via the PING tool. Select the number of packets to send and click the Ping button. The interface will display a “Working” message whilst the test is being run.


Notes

You can use the Notes section to add any further details to the device that you might find helpful, such as support notes or specific settings that you need to record.


Making a Call

To initiate outbound calls from a Device, select the Device required from the Devices list and wait for it to load up the General screen. On the right side, add into the ‘Address’ field the remote address to call, select the protocol and call speed. Click the Call button to initiate the call. You can view the real time call data in the Real Time menu for the Device – see here for further information.


 This feature is only available when the Web/API credentials are valid and working.


Support Contract information

Should a Device be under a manufacturer maintenance contract, then to assist with managing the renewal of that, the expiry date can be assigned against a Device. In the General screen, under the hardware details of the Device, tick the Support Contract box. Select the expiry date and in the Support Reference put in the support contract number/identifier (or similar). Click Save.


In the Asset Management > Service Contracts report there will be an information about any upcoming contract expiries to allow for timely renewals.


Devices > Unified Comms Devices – Microsoft Teams Devices

Microsoft Teams devices are noted by MS Teams in the Platform column. Filter options are available to drill-down the viewed list of Devices.


Summary icons

Provided next to the Name of the of Devices is a quick summary view of the status of the device. These statuses are detailed as:

IconDescription
Device is online
Device is offline
API connection is working
API connection is not working, no live data is available.
Device is registered to the MS Teams service
Device is not registered to the MS Teams service
Registration status is unknown due to an issue
There are no health issues reported
There are warning health issues reported
There are error health issues reported
Health status is unknown
Device is currently in an alert state and emails have been sent to network contacts
The device is not in an alert state (or not configured to alert)


Microsoft Teams Device Details

Selecting any MS Teams device from the list will load the Microsoft Teams Device screen. The top menu provides for the following features:

  • Schedule > Schedule Restart – this will initiate a task to schedule a restart command to this device for a later time and date.
  • Tasks > Restart Device - this will initiate a restart command to this device.
  • Tasks > Upgrade Software - this will initiate a software upgrade command to this device. This is only valid when a software update is indicated in the Health menu.

Remote Commands may take up to 15 minutes to initiate as it is dependent on the device synchronising into the MS Teams platform. Progress can be checked in the device System Events menu.


General

The General screen is the default page opened. It contains information on the following asset data:

  • Device Type
  • Current User
  • Name
  • Registration video address
  • Health Status
  • Activity State
  • Manufacturer
  • Model
  • Serial number
  • Processor
  • Software Versions
    • Admin Agent Version
    • Teams Client Version
    • Partner Agent Version
    • Operating System Version
    • Firmware Version
    • Company Portal Version
  • Enrolment date
  • Last sync date and time


The supported Device Type that will be shown are:

  • Teams Room for Windows
  • Teams Room for Android
  • Surface Hub
  • Collaboration Bar
  • Teams Display
  • Teams Phones
  • SIP Device
  • Touch Console
  • Teams Panel


Environment Data (Neat devices only)

If you've enabled Neat Pulse integration with you devices, you will additionally be presented with local Environment data for that device:

  • Temperature (C)
  • Humidity (%)
  • Carbon Dioxide - CO2 (ppm)
  • Air Pollutants - VOC (ppb)
  • People Count
  • Illumination (lux)


The list of certified devices for Microsoft Teams can be found here: https://docs.microsoft.com/en-us/microsoftteams/rooms/requirements. The devices are all validated to conform to the requirements of the Microsoft Graph API, and as such adhere to a known standard. Features available depend on the Teams license purchased.


Additional sections are provided to show the device hardware info, and the versions of installed software. This information will vary by device type and make and model.


Should a device be under a manufacturer maintenance contract, then to assist with managing the renewal of that, the expiry date can be assigned against a device.


Support Contract information

Should a Device be under a manufacturer maintenance contract, then to assist with managing the renewal of that, the expiry date can be assigned against a Device. Tick the Support Contract box. Select the expiry date and in the Support Reference put in the support contract number/identifier (or similar). Click Save.


In the System > Service Contracts report there will be an information about any upcoming contract expiries to allow for timely renewals.


Remote Connections (if enabled)

Note: this feature is only listed if the device is on a network with the Remote Connections feature enabled on a Hub.


Depending on the device type, you can select the following connection protocols:

  • Remote Desktop Protocol (RDP)
  • HTTP or HTTPS
  • SSH
  • Telnet
  • Custom TCP Port


Health

The information displayed shows the systems, peripherals, software, and hardware that are important to the system functioning as intended. This displayed information varies by device type, but should an item fall outside of its intended usage, then it will show as an error. These errors can be then alerted on – see Alerting section.

 


Call Activity

The calls of the current logged in user will be listed in the Call Activity page. Using the date range selectors will show all inbound and outbound calls for that user. In the main page, the summary information of the call is provided (including a Call Quality rating).


Clicking a particular call will drill into the call metrics of each participant in the call shown.


Data collected from calls made on the MS Teams platform include:

  • Type – Peer-to-peer or group call
  • Participants
  • Media type – audio or video
  • Modalities
  • Duration
  • Protocol
  • Audio, Video and Screen Sharing Media – Streams:
    • Stream Direction
    • Video Jitter – Average and Maximum
    • Audio Jitter – Average and Maximum
    • Packet Loss – Average and Maximum
    • Round Trip Time – Average and Maximum
    • Average Video Frame Loss
    • Average Video Frame Rate
    • Average Video Packet Loss
    • Audio Network Jitter – Average and Maximum
    • Average Audio Degradation

This information is shown when clicking a listed call in either the Reports > ‘Call List’ or via the individual Teams User or Device ‘Call List’ screen.


Calls in this list are rated as:

Perceived Call QualityPacket LossJitter
Good< 0.2%<10ms
OK0.2% <> 2.0%10-50ms
Bad>=2%>=50ms


Analysis

The Analysis page provides a summary view of the Device over 3 timeframes – Last 24 Hours, Last 7 Days or Last Month. Selecting the buttons at the top will alter the view displayed, to the chosen timeframe.

 

The Analysis sections listed are:

  • Availability – how long has the Device been online (network), shown as a graph and percentage of timeframe selected.
  • Call Activity – how many calls have been made, and the combined duration of them during the timeframe selected.
  • Call Summary – a summary of the calls during the timeframe selected.
  • Call Quality – of the calls made, what are the ratio of Good, OK and Bad calls with regards to rated quality.
  • Daily Online Presence – the share of presence statuses daily (excluding Offline).
  • Online Presence – Total summary graph of the presence statuses.

Devices with Neat Pulse Integration

Additionally for Neat devices that registered to Neat Pulse, if integration has been set up you will see additional environmental data captured showing:

  • Temperature (C)
  • Humidity (%)
  • Carbon Dioxide - CO2 (ppm)
  • Air Pollutants - VOC (ppb)
  • People Count
  • Illumination (lux)


Presence

Presence status changes are recorded and shown in a timeline of events in the last week.


System Events

When a restart or a software update event is submitted, the status of the request will be listed in the System Events page. Any errors and error messages will also be displayed in the list.


Peripherals

Here you can see which devices have been plugged into the system and made calls. You can see the Platform and those connected Peripherals used. This included Type (Camera, Speaker and Webcam), the Device Name and the number of times it’s been used.


Alerting

When an issue is detected, alerts are generated by the platform. Alerts are indicated in the web interface and by emailing the support contact(s) listed for that MS Teams tenant (accessed via the Organisation menu).

The alerting items are:

  • Camera Health
  • Microphone Health
  • Speaker Health
  • HDMI and Display Health
  • Software Versions
  • Connectivity Health
  • Registration Status
  • Touch Panel Health
  • Call and Media Health and Statistics
  • System On/Off Status
  • Presence Status

 

Alerting items vary by device, with only Teams Rooms on Windows providing peripheral alerting. Since Teams Rooms on Android, IP Phones and Touch Consoles have fixed hardware you will not see the Peripherals listed in the Health screen as alert items.


Devices > Connected Devices

Connected Devices functionality is dependant on a Hub being deployed on the same network as the devices to be managed. If you have not done this, please do so following the steps within this guide.


A Connected Device is defined within this platform as a network connected IP-based device. So long as a Hub is installed and able to reach the device, it can be added to the system. The flexibility of this is that it allows any device to be monitored, and alerted for should it go offline.

Adding a Connected Device

In the Connected Devices screen, click the + Add Connected Devices button. The following screen will load:


Complete the fields displayed and ensure you select the correct Network (see Networks & Hubs for more information) for the device being added. Networks must have an Online status to appear in the drop-down list. Click Save when complete. 


The Hub will now try to detect the system to add it as a Connected Device. If it is unsuccessful, this is likely due to the Hub not being able to access the device. You should check the IP address given and the Hubs access to this IP address. If successful you will get this message:

Importing Connected Devices

To Import Connected Devices, click the Import Connected Devices button. This will load up a screen where you can upload a CSV file (commas and semi-colons both supported). Upload the Devices per Network only.


Clicking the Sample File will provide you with an example format with the correct column headings applied.


Connected Device Details

When clicking on a Connected Device from the list, you will load up the Connected Device Details screen. From here, you can edit information about the device, or add Support Contract details. The left pane provides further device options.


Remote Connection (if enabled)

Note: this feature is only listed if the device is on a network with the Remote Connections feature enabled on a Hub.


Depending on the device type, you can select the following connection protocols:

  • HTTP or HTTPS
  • Remote Desktop Protocol (RDP)
  • SSH
  • Custom TCP Port


Console

If the Connected Device has SSH enabled you may use this to connect to the device over SSH. Add in your Username and password and click Connect


Note: you should only use this for simple commands and queries and not file editing. If you need to do that, you should use the Remote Connections feature for SSH full functionality.


Macros

In Macros you can build command sets to run on a remote device to save time on rewriting regular instructions for devices. Use a new line for each command being issued. The command Results (output) can be all saved in the session, or just the last command, or simply ignored.


To execute the Macro, just open it up and click the Execute button.


Session Logs

All Console sessions and Macros that have been run are noted in the Session Logs. This does not include the content of those commands, only that a command was run, by who, and when. This is for the purpose of auditing access.


Analysis

The screen will show you device uptime over pre-defined time periods, including its online availability percentage.


Alerting

You can enable offline alerting by ticking the Enable Alerts check box. Alert History will also be displayed for review.


Notes

A free text field to add any notes of use for this Connected Device. This is viewable by anyone with access to this device.


Devices > Display Systems

Display Systems functionality is dependant on a Hub being deployed on the same network as the devices to be managed. If you have not done this, please do so following the steps within this guide.


Display Systems can either be considered as stand-alone display or connected to a video conferencing device - when this is the case we call this display a Linked Device


Adding a Display System

In the Display Systems screen, click the + Add Display System button. The following screen will load:


Complete the fields displayed and ensure you select the correct Network (see Networks & Hubs for more information) for the device being added. Networks must have an Online status to appear in the drop-down list. Click Save when complete. 


The Hub will now try to detect the system to add it as a Display System. If it is unsuccessful, this is likely due to the Hub not being able to access the device. You should check the IP address given and the Hubs access to this IP address.


Importing Display Systems

To Import Connected Devices, click the Import Display Systems button. This will load up a screen where you can upload a CSV file (commas and semi-colons both supported). Upload the Devices per Network only.


Clicking the Sample File will provide you with an example format with the correct column headings applied.


Display System Details

Clicking a Display System in the table will open up it up for remote management. From here you can:

  • Change Input Source
  • Change Volume levels
  • Mute and Unmute volume


Video Devices

Clicking on Link to Video Device will open up a list of (unlinked) UC Comms Devices. Select the UC device that the display is connect to by clicking the link icon. This will now pair the display and the UC Device.


Analysis

The screen will show you device uptime over pre-defined time periods, including its online availability percentage.


Alerting

You can enable offline alerting by ticking the Enable Alerts check box. Alert History will also be displayed for review.


Notes

A free text field to add any notes of use for this Display System. This is viewable by anyone with access to this device.


MS Teams Users

Any Microsoft 365 accounts that have a Microsoft Teams license assigned will be picked up and brought into the MS Teams Users screen (except for a Limited Scope Deployment).


In the MS Teams Users screens, a view of all the Users assigned to the platform is shown. Selective views can be applied per column or names filtered. Listed in the view are the following settings:

  • Display Name
  • User Principal Name (from Active Directory)
  • License Type
  • Organisation
  • Location
  • Country
  • Department

This list can be exported to CSV using the Export List button.


General

The General screen is the default page opened. It contains information on the following data:

  • Display Name
  • Job Title
  • Email Address
  • Department
  • Office Location
  • Country
  • Principle Name
  • Language
  • MS Teams License
  • Phone Enabled
  • Availability
  • Activity
  • Last Seen Online
  • User Profile picture (if added in Active Directory/Office)

 


Call List

The calls of the current logged in user will be listed in the Call List page. Using the date range selectors will show all inbound and outbound calls for that user. In the main page, the summary information of the call is provided (including a Call Quality rating).


Clicking a particular call will drill into the call metrics of each participant in the call shown.


Data collected from calls made on the MS Teams platform include:

  • Type – Peer-to-peer or group call
  • Participants
  • Media type – audio or video
  • Modalities
  • Duration
  • Protocol
  • Audio, Video and Screen Sharing Media – Streams:
    • Stream Direction
    • Video Jitter – Average and Maximum
    • Audio Jitter – Average and Maximum
    • Packet Loss – Average and Maximum
    • Round Trip Time – Average and Maximum
    • Average Video Frame Loss
    • Average Video Frame Rate
    • Average Video Packet Loss
    • Audio Network Jitter – Average and Maximum
    • Average Audio Degradation


This information is shown when clicking a listed call in either the Reports > ‘Call List’ or via the individual Teams User or Device ‘Call Activity’ screen.


Calls in this list are rated as:

Perceived Call QualityPacket LossJitter
Good< 0.2%<10ms
OK0.2% <> 2.0%10-50ms
Bad>=2%>=50ms


Caller Anonymisation

Settings are available to anonymise external and internal call participants. See ‘Data privacy – call anonymisation’ section of this document.


Analysis

The Analysis page provides a summary view of the user over 3 timeframes – Last 24 Hours, Last 7 Days or Last Month. Selecting the buttons at the top will alter the view displayed, to the chosen timeframe.

 


The Analysis sections listed are:

  • Availability – how long has the user been online (network), shown as a graph and percentage of timeframe selected.
  • Call Activity – how many calls have been made, and the combined duration of them during the timeframe selected.
  • Call Summary – a summary of the calls during the timeframe selected.
  • Call Quality – of the calls made, what are the ratio of Good, Ok and Bad calls with regards to rated quality.
  • Daily Online Presence – the share of presence statuses daily (excluding Offline).
  • Online Presence – Total summary graph of the presence statuses.

Peripherals

Reporting on the used peripherals and device operations systems used (platforms), can be viewed in the Peripherals section. The peripheral types displayed are:

  • Camera – manufacturer name and model
  • Microphone – manufacturer name and model
  • Speaker – manufacturer name and model


The recorded details are the first and last time they were used, plus the number of times used (usage).


The Platforms section shows how the service and peripherals are being used. The possible displayed platforms are:

  • Windows
  • macOS
  • iOS
  • Android
  • Web
  • IP Phone
  • Room System
  • Surface Hub
  • Holo Lens


The recorded details are the first and last time they were used, plus the number of times used (usage).


Alerting

When an issue is detected, alerts are generated by the platform. Alerts are indicated in the web interface and by emailing the support contact(s) listed for that MS Teams tenant (accessed via the System > Configuration > "Company Name" menu).

The alerting items for a user is:

  • Presence On/Off Status

 

 

 Consideration should be given to enabling this alerting. For example, if the user is logged into a laptop or mobile phone then energy saving methods may inadvertently put the user offline and trigger an alert event.


Alerts

A centralised view of all the alerts is available using the Alerts page. By default, the screen will open to show any existing alerts on the platform.

 

Using the column filters, further information can be provided.


To see all open and closed alerts over the current date range, change the Status filter to All.

 

Clicking each alert listed will open up the device shown, so that further information can be gathered, or actions can be taken.


Notes

Notes may be written against an issue to help those working on it know any actions that have been done, or for adding any additional 3rd party information such as the ticket number from another solution.


To add information to an alert, click the notes icon at the end of the row. Add in the details you want, then click Save to save and close the screen. Alerts with notes added show as this icon.


Reports

Reports are covered by 4 menu selections – Executive Reports, Call Reports, MS Teams Reports and SIP/H323 Reports. Executive Reports are provided to show high level statistics and analysis, Call Reports being focused on the call metrics and statistics, MS Teams Reports being specific to that platform. Finally SIP/H323 Reports provide device information for Cisco and Poly devices registered to (for example) Pexip or WebEx (Cisco only).


Reports > Executive Reports

These reports are designed to provide useful Summary data on services for roles such as Service Owners, Account Managers or Senior Management.


Reports > Executive Reports > Exec Call Summary

The Executive Call Summary Report provides a summary view of the all the calls that the system has processed over the last 30, 60, or 90 days.


In the "Most" and "Least" Used Unified Comms Devices, the Up and Down arrows indicate the change in ranking compared to the last time period displayed.

Reports > Executive Reports > Exec Alert Summary

The Executive Alert Summary Report provides a summary view of the all the alerts that the system has processed over the last 30, 60, or 90 days.

 

Reports > Executive Reports > Exec Hardware Summary

The Executive Hardware Summary Report provides a summary view of the all the hardware devices in the system over the last 30, 60, or 90 days. This additionally provides a view on the increase or decrease in licensed devices over the selected time period.

 


Reports > Call Reports

All Call Reports relate to a combined view of all video platforms enabled in the system. For example, WebEx and MS Teams in a single view.


Reports > Call Reports > Call List

Recent calls to or from all the Devices are listed in this screen. The default date selection is for a 14-day window, but that is easily changed by altering the dates in the selection boxes. Further filters are provided to enable you to drill-down into the data.

 


Calls in this list are rated as:

Perceived Call QualityPacket LossJitter
Good< 0.2%<10ms
OK0.2% <> 2.0%10-50ms
Bad>=2%>=50ms
UnknownNo data provided by service


For the Call Type column, a Peer-To-Peer call is when Participant A calls Participant B only. Whereas the definition of a Group Call is one where the call is hosted on the video service, and we receive call metrics for all participants from that service (rather than off the Devices). This is typically when a meeting is scheduled, or a peer-to-peer call adds a third participant into the meeting, it’s re-established on the hosting platform.


You may export this call list to a CSV file by clicking the   button.


Clicking on a listed call will provide further data on that specific call including encryption levels and disconnect reasons. See example:


Caller Anonymisation

Settings are available to anonymise external and internal call participants. See ‘Data privacy – call anonymisation’ section of this document.


Reports > Call Reports > Call Usage

A customisable view of the numbers of total calls made by the Devices and the total call duration, broken down by day. The report helps gain an understanding of video usage over time. Filters are provided to enable you to drill-down into the data.

Clicking the data in the chart will drill-down into the specific data of that data point in the chart.

 

Reports > Call Reports > Call Distribution

A customisable view of the most popular times of day that video calls are made. It can be used to help guide maintenance schedules. Filters are provided to enable you to drill-down into the data.


Reports > Call Reports > Call Protocols

A view of the call protocols that are in use on video calls. Filters are provided to enable you to drill-down into the data. This data can be exported via the Export button.


Unknown protocol is where the Device API does not provide the detail of the protocol in the call records.



Reports > Call Reports > Call Quality

A view of the call quality of the video calls in the timeframe. Calls in this view are rated as:

Perceived Call QualityPacket LossJitter
Good< 0.2%<10ms
OK0.2% <> 2.0%10-50ms
Bad>=2%>=50ms
UnknownNo data provided by service


Filters are provided to enable you to drill-down into the data and clicking the data in the chart will drill-down into the specific data of that data point in the chart. This data can be exported via the Export button.

 

Unknown quality is where the Device API or video platform does not provide the packet loss or jitter metrics in the call records.



Reports > Call Reports > Group Participants

A visual graph to report on the participant sizes of a group call and allowing for an understanding of the scale of calls being undertaken. This data can be exported via the Export button.

Shown in the example above, most calls here at either 2 or 3 participant calls.


Reports > MS Teams Reports > Registration Usage

View the user registrations being used on the MS Teams platform – and those that aren’t – offering a view into ways to save licenses with MS Teams.


This view can be switched between ‘Show number of Calls’ and ‘Show number of minutes’, and by ‘Call Quality type. Using the Devices and users filter allows for switching between Devices only, Users only, or Devices and users which is the default view. The data in view can be exported to a CSV file, via the Export button.


Reports > MS Teams Reports > Registration Quality

Whereas the Call Quality report shows the summary quality of a call, Registration Quality is the quality for each individual registration involved in a call. 


Example: A group call with 5 participants is rated as ‘Good’. Four participants had ‘Good’ rated calls and 1 participant had a ‘Bad’ rated call. This would still be classed as a ‘Good Call’. In the Registration Quality report, each registration (participant) is individually rated, rather than on the summary (weighted) rating.


A useful report for highlighting users where the call quality is typically a problem. This can help pro-actively highlight network or devices issues and reduce support-related incidents.

This view can be switched between ‘Show number of Calls’ and ‘Show number of minutes’. Using the Devices and users filter allows for switching between Devices only, Users only, or Devices and users which is the default view. The data in view can be exported to a CSV file, via the Export button.


Reports > MS Teams Reports > Registration Activity

A list view of the users on the platform, and their call volume and durations over a specified time range. This data can be exported via the Export button.


Reports > MS Teams Reports > Peripheral List

Reporting on the used User peripherals and device operating systems used (Platforms), can be viewed on the Peripherals List report. The peripheral types displayed are:

  • Camera – manufacturer name and model
  • Microphone – manufacturer name and model
  • Speaker – manufacturer name and model


The recorded details are the Users name, the first and last time the peripherals were used, plus the number of times used (usage).


The Platforms section shows how the service and peripherals are being used. The possible displayed Platforms are:

  • Windows
  • macOS
  • iOS
  • Android
  • Web
  • IP Phone
  • Room System
  • Surface Hub
  • Holo Lens

 


If you want to filter against specific devices, clicking the flag symbol next to the item in the Device Name column will allow you to monitor specific devices being used. These can then be filtered into a single view using the All Devices drop-down list and selecting Flagged Only. To unselect a device, simply click the highlighted flag to remove the selection.


This data can be exported via the Export button.


Reports > MS Teams Reports > Peripheral Overview

The Peripherals Overview is a simple way to review the total peripherals in use, by summarising them into device counts across Cameras, Microphones and Speakers. This data can be exported via the Export button.


Reports > MS Teams Reports > Client Operating Systems

Understanding the usage patterns of the different ways to communicate using the MS Teams software client provides useful business information. The Client Operating Systems reports splits out this information to show how the business is working on the MS Teams platform.


The software operating systems for viewing are:

  • Windows
  • macOS
  • iOS (iPhone and iPad)
  • IP Phone
  • Android (mobile OS, not Teams Room for Android)
  • Room System (MTR’s for Windows and Android)
  • Surface Hub
  • Web


Reports > SIP/H323 Reports > Device Usage

A view of the number of calls (inbound and outbound) and duration per Device of each one being monitored. Filters are provided to enable you to drill-down into the data. This data can be exported via the Export button.


Reports > SIP/H323 Reports > Device Quality

A view of the call quality of the video calls per Device in the timeframe. Calls in this view are rated as: (Cisco only feature).


Perceived Call QualityPacket LossJitter
Good< 0.2%<10ms
OK0.2% <> 2.0%10-50ms
Bad>=2%>=50ms


Filters are provided to enable you to drill-down into the data. This data can be exported via the Export button.

 

Unknown quality is where the Device API does not provide the packet loss or jitter metrics in the call records.



Reports > SIP/H323 Reports > Active Devices

A view of total call metrics (inbound and outbound) per Device. Filters are provided to enable you to drill-down into the data. This data can be exported via the Export button.


System

In this section you will find information on platform licensing information, system scheduled tasks and firmware (Cisco non-Teams enabled devices). If you are using the Service Contracts feature, the summary report is also available in this menu.


Configuration

To manage an Organisation, navigate to System > Configuration. You can review the Organisations added in the right window pane. The Organisation section defines the structure of your devices and user estate to enable easy and logical management.


Once an Organisation has been added (see Create your Organisation section), you are able to add additional Buildings and Networks & Hubs.


When hovering your mouse over a folder will display the following options where you can create, rename, or delete the folder structure:


Organisation LevelFolder Level
Add SubfolderAdd Subfolder
Edit OrganisationRename folder
Assign Permissionsn/a
Delete OrganisationDelete folder


These icons indicate the group a being:

Folder


Where a structure may look like this (as an example):

When clicking a folder on the left pane, the right pane will display Folders that are configured to that branch of the Organisation.


Buildings

To enable logical grouping of devices (assets) for an Organisation, you'll need to build out the company physical locations into addresses and rooms. We do this by creating Buildings. Once created, a Building will contain the location, number of floors and rooms within it. Additional information you may wish to include are also pictures and notes.


The benefit of creating Buildings and Rooms is for assigning assets within the Asset Management section of the platform.


Create a Building

Click the +New Building button at the top right of the Buildings section. Complete all the fields as necessary, and click Save. The newly created Building will reload and here you can add a picture of the building using the Picture menu. Repeat as necessary for your needs.


Floors

Once you have created a Building, you may add the floors contained within. Click the Floors menu within Building Details and then the + New Floor button. Add as many as you need. Floor zero represents the ground floor. Once finished, click Save and the Floors screen will reload. Repeat as necessary for your needs.


Rooms

Once you have created a Floor within a Building you can add Rooms to that Floor. Click floor number you want to assign Rooms to, and this will load the Rooms menu. Clicking the + New Room button once will load the Room Details screen. Enter the details of the room and add the people room capacity. You can add a picture of the room using the Picture menu. Repeat the Rooms creation steps as many times as necessary for your needs. 


Clicking the Save button will reload the room, and now allow you to assign (or remove) assets into it. To assign assets, click the Unallocated Assets menu. Selecting the '+' (plus) symbol at the end of the asset row will assign it to the room. Add all the assets you require, then click Close. To view the asset or to remove an asset from a room, you can load up the Room Assets menu. Removing an asset is done by click the '-' (minus) symbol at the end of the asset row. Click Close to close the screen.


Networks & Hubs

Setting up a new Network is described in the section Create a network.

When clicking a Network, you load up the Network Details screen. The screen contains the sections:

  • General – this contains the details of the network, the Name, Contact, location, and Alert options. All these fields can be updated at any time. Additionally, displayed are the ‘Last Detected’ and ‘Default Gateway’ as obtained from the hub(s) installed on that subnet.
  • Devices– the list of video Devices managed by the hub(s) on the network. Filter options are available to drill-down the viewed list of Devices. Additional options provided here are:
    • Group Processing > Group Backup Task – further information on this is detailed in Devices - Cisco and Poly.
    • Group Processing > Group Upgrade Task – further information on this is detailed in Devices - Cisco and Poly.
    • Group Processing > Group Restart Task – this will initiate a task to schedule a restart command to all the Devices in the current view. It applies to all Devices that are online with API access working at the time of the task running.
    • Export List – export the current viewed Devices to a CSV file for reporting or asset management purposes
  • All Devices – the list of video Devices and hubs on the network. Clicking a device in this screen will open the Device Details screen. Where required, select the Mark as Cisco Device or Mark as Poly Device buttons to identify the device as either a Cisco or Poly video Device (in the instance of the platform not identifying it). In the main screen, the option to Add Manual Device is included (further information here).
  • Hubs – this screen displays the current configured hubs on the network and the last time the contacted the platform (Last Detected). Hubs may be deleted from the service by clicking . Additionally, you may download and install new hubs to the network. Further information on that is found in Install the morbit hub and Pairing the morbit hub to your account.
  • Device Simulator– you can simulate a Device on this network to check for:
    • Protocol Connectivity – simulate a Device on the remote network. You can check for specific protocols or just test them all. If the results are a Success, then the outbound connectivity to the video service appears good. Should the results return a Failed then any firewalls between the Devices and video server should be checked.
    • DNS Checker – adding in the video service registration server and clicking Get Records will show the DNS records returned. This can be useful to see if local DNS servers are causing issues with video SRV records.

 The Device Simulator feature is dependent on the Hub hosting computers being in the same network subnet for Protocol Connectivity testing and/or having the same DNS records as the Devices.

Networks are removed by clicking , where you will receive a warning that, “Deleting this network will remove all devices, hubs, and any associated data. This cannot be undone”. If in doubt do not select this until you have taken any necessary data exports from the platform. As notified, there is no option to restore this without a full redeployment of the network and associated hubs.

IMPORTANT: When deleting a network or hub from the service, please remember to uninstall the morbit hub from the hub computer(s).


System Information

This section details how many of each licensing type you have in the system for billing purposes.


Remote Connections

This view allows you to audit the connections that have been made to remote devices using the Remote Connections feature. If you have not enabled this feature, you will not see any data in this page.



Tasks

The Tasks screen allows you to view all the tasks set up in the platform. Any group upgrades, group backups, or group restart jobs will appear here and can be managed from this interface, along with individual task events.


Clicking a listed task will provide further details about it and provide timing details of how long it took and which Devices it affected. Likewise, any jobs with a status of ‘Completed with errors’ can be viewed and investigated. For example, a Device might be switched off during a backup task would generate this error.

  

Cisco Firmware

To enable the deployment of new firmware to supported Devices, you can create a Package.


To deploy a new firmware package, click the button, and simply copy in the location of the firmware and click Save. The platform will recognise the file and identify the Devices that it works with automatically. All valid Devices will now have the option to upgrade to this version.


 This must be a HTTP/HTTPS location that is accessible to the Devices – it is not necessary for morbit studio to have access to the files.



Firmware deployment – individual or group

You can deploy the firmware per Device as described here. Alternatively, you can choose to deploy this out to all compatible Devices in the estate, or just a subset of Devices.


To do choose your target Devices, load up the main Devices menu. Should you require it, using the filter views drill-down to the Device requirements that suits your needs. For example, use the ‘Organisations’ filter or ‘Registration filter’ to narrow down the targets. Whatever is in the Devices view, when clicking Group Processing > Group Upgrade Task on the top menu will apply the task to.



If no filters have been applied, a message is displayed at the top of the screen informing that the upgrade task will apply to all Devices. The options are:

  • Target Package: Either Latest version is used, or you can use the drop-down to select a specific version of firmware.
  • When: You can apply the task immediately using Now or else Schedule Once or Schedule Recurring.
  • Notify Network Contacts: check this box to email the Network Contact that this work is taking place.


The advantage with using the option Latest Version is the system will deploy the latest firmware from the Packages in Firmware. It does not then require further thought as this will allow multiple firmware for different models to be deployed in a group job. The system will apply the correct software to the correct Devices. If deployed as a Scheduled Recurring task, then only new Packages need to be added in Firmware for the deployments to proceed and regular updates to be applied automatically.

Account

Clicking the Account menu at the top right, will open the Account Details page. This section allows you to:

  • General - Update your name details
  • Users – Add, Change, Disable or Delete users of the system
  • Security – Enable or disable multifactor authentication (MFA)
  • Password – change your password
  • MFA – set up your MFA login


The Security sub-menu is only available to Users with the Full Access permissions and the Security Administrator role assigned, whilst the MFA menu will only appear if MFA has been turned on in the Security settings.


Managing Users

To manage Users in the system , you need to be assigned the Security Administrator role. This is automatically assigned to the first account created the system. That User needs to assign the permission to new Users where appropriate.


Create a user

Note: This function requires the Security Administrator role.

Open the Users section and click the button. In the New User screen, add the details of the user. Full Access provides the user with unrestricted access to the platform. Click Save to complete the new account. The new user will receive an email inviting them to complete their sign up to the platform and set up a password.


Resetting passwords and MFA access

Note: This function requires the Security Administrator role.

Select the User account you need to reset, and click the Security tab. From here you can reset the password by inputting the new password and clicking Save

To reset the MFA, you can click the Reset MFA button.


Limited access role

A limited access role is enabled once the Full Access check box in the User Details screen is unchecked. This removes the following features:

  • Firmware – they can no longer view the Firmware menu or initiate upgrades or downgrades of a Device.
  • Tasks – the ability to create or schedule tasks is removed, as well as the Tasks menu.
  • Organisations – the user is not able to create any new organisations.


Assigning user access to specific organisations

Should you want to assign a user(s) to only specific organisations, then select the user to open the User Details screen. Go to the Access sub-menu and tick the organisations they should be able to access, then click Save.


Multifactor Authentication (MFA)

Global Settings

To turn on MFA, go to the Security sub-menu and tick the Enable MFA box:



Settings enabled with MFA are:

  • MFA Policy:
    • Enforced – requires all users to set up and use MFA to login.
    • Optional – users are given the option to set up MFA but are not required to enable it on their personal accounts.
  • MFA Do Not Ask Again – The number of days between prompting for the MFA code (per device). A value of zero days will require the MFA code every time the user logs in.


Per Organisation MFA

Navigate to the System > Configuration menu. In the listed root Organisations, click the icon to edit the entry.



In the Security tab, Settings enabled with MFA are:

  • MFA Setup:
    • Inherited – this setting will inherit the same setting as the Global account settings. Other settings do not apply in this section.
    • On - MFA is turned on, overriding the Global setting if switched off. Configure the remaining settings as required.
    • Off – MFA is turned off, overriding the Global setting if switched on. Other settings do not apply in this section.
  • MFA Policy:
    • Enforced – requires all users to set up and use MFA to login.
    • Optional – users are given the option to set up MFA but are not required to enable it on their personal accounts.
  • MFA Do Not Ask Again – The number of days between prompting for the MFA code (per device). A value of zero days will require the MFA code every time the user logs in.


Configuring Personal MFA authentication

To complete the following personal MFA configuration, you will need to download and install an MFA application on your mobile/tablet device. Either one of these apps is supported:


Once MFA is enabled for your user account, click the Account menu at the top right, and it will open the Account Details page. Click the MFA sub-menu, and this will load up the My Multi-Factor Authentication Set Up page.



Click the Generate New MFA Code button. This will generate a new authentication QR code. Using your authenticator app, add a new authentication using your device camera and scanning the QR code.


Once the authentication has been added, you MUST click the Update button shown to complete the enrolment:



You can now click Close.


 You can regenerate a new code at any time by following the above steps.


When you next login to the application you will be required to enter the 6-digit code generated within your authenticator application. If you do not have this available, you can get a code emailed to you as a backup:



Clicking the Send me a code by email instead link will send you the code to your registered morbit studio email address. Simply complete the rest of the process using the code sent on your email.


Demo Mode

At Morbit we take our responsibilities for how we handle your data very seriously. When demoing our solution, you need to make sure that you only show information you want people to see – typically your own data.

’Demo Mode’ allows you to easily switch On and Off the visibility of the Organisation data you have across your entire platform.


Setting up Demo Mode

  The follow examples are taken from our Lab environment and test data to help walk you through the settings.


Account Permissions

To be able to use Demo Mode, you need to have ‘Full Access’ rights to your company settings. To check this, go into your account settings and in the Users menu check for the ‘Full Access’ tick against your account:



Assigning the Company for Demo Mode

Go to the Organisation menu and next to the company you want to only show in demos, select the  icon to edit the settings:



Select the ‘Show in Demo Mode’ tick box and click Save:



You can repeat the same Company selection for more applicable companies should you want to show them in Demo Mode too.


Turning On and Off Demo Mode

To turn on and off the Demo Mode feature, simply click the button at the top right of the screen and confirm the requirement when prompted. The button will go green to signify it’s turned on .


Click the button again to turn Demo Mode off.


When in Demo Mode, all screens will show data and reports for the Company setup you’ve chosen.


Firewall Requirements

Studio

NameProtocol/PortDestination
HTTPSTCP/443studio.morbit.co.uk
HTTPSTCP/443engine.morbit.co.uk
HTTPSTCP/443updates.morbit.co.uk
HTTPSTCP/443morbit-files.s3.eu-west-1.amazonaws.com (Remote Connections setup)
HTTPSTCP/443directory.morbit.co.uk
HTTPSTCP/443directory.morbit.vc
LDAPTCP/389phonebook.morbit.co.uk


Phone Book service only

When only using the Phone Book service, depending on the Device manufacturers being serviced you will need the following outbound ports open:

Management of phone books

NameProtocol/PortDestination
HTTPSTCP/443studio.morbit.co.uk


Cisco devices

NameProtocol/PortDestination
HTTPSTCP/443directory.morbit.co.uk
HTTPSTCP/443directory.morbit.vc (alternative option)


Poly or LDAP-based devices

NameProtocol/PortDestination
LDAPTCP/389phonebook.morbit.co.uk


Microsoft Teams devices and users

NameProtocol/PortDestination
HTTPSTCP/443studio.morbit.co.uk
HTTPSTCP/443graph.microsoft.com


  IP addresses are not provided as this is a cloud hosted platform and IP’s may be subject to change without warning.


High-level design diagram – Cisco/Poly Devices, Connected Devices and Display Systems

 

High-level design diagram – MS Teams services


 Note: there is no direct access from morbit studio to your devices. All communications are done via the Microsoft Graph API (https://graph.microsoft.com).


Supported Devices

Cisco and Poly Device Management (SIP-based)

ProductVersionNotes

Cisco Webex Room series (Room, Room Kit)

CE9.15 and above
Cisco Webex Board SeriesCE9.15 and above

Cisco C series (C20, C40, C60, C90)

TC7.3.21All previous versions are deferred by Cisco

Cisco DX series (DX70, DX80)

CE9.x and above

Cisco EX series (EX60, EX90)

TC7.3.21All previous versions are deferred by Cisco

Cisco MX series (MX200, MX300, MX700, MX800)

TC7.3.21All previous versions are deferred by Cisco

Cisco SX series VTC systems (SX10, SX20, SX80)

TC7.3.21 and aboveAll previous versions are deferred by Cisco

Polycom RealPresence Group series 300/500/700

6.1.7.x or above
Poly Studio X Series 30/50/703.8.x or above
Poly G Series 75003.8.x or above


 We are unable to offer support on anything but a “best endeavours” basis where the Device firmware has been marked as deferred (or similar) by the manufacturer due to issues that are outside of our control.


Microsoft Teams Devices

The list of certified devices for Microsoft Teams can be found here: https://docs.microsoft.com/en-us/microsoftteams/rooms/requirements. The devices are all validated to conform to the requirements of the Microsoft Graph API, and as such adhere to a known standard. Some features available depend on the Microsoft Teams license purchased.


Display Systems

The platform supports displays from the professional Digital Signage ranges from Samsung and LG only.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article