Top

Information to Know Before you Start

  • The user must have as MSA that allows the use of Virtuo.
  • The Mediatrix unit must have access to:
    • a valid DNS
    • an NTP server, otherwise it will be impossible to validate the certificate date and therefore it will be rejected.
    • public internet
Top

Basic Concepts

Configuration Scripts Used by Virtuo

Carriers and service providers usually define a configuration that will apply to a large number of units in compliance with the network architecture. It is the command and the parameter values grouped in a text file that produce the configuration scripts.

Configuration scripts support all configuration parameters and can be created for a group of units or for a specific unit of the network. The configuration scripts used by Virtuo are the same as the ones used in DGW, i.e. the parameters, the structure, and the syntax are the same. For more details, refer to the Configuration Scripting Language Syntax published in the DGW Configurations Guides section of on the Media5 Documentation Portal.

Configuration Scripts used by Virtuo can also use custom fields created within the Virtuo EMS Web interface. For more details refer to the Mediatrix Unit Custom Fields section.

Top

Mediatrix Unit Custom Fields

Mediatrix unit custom fields created in Virtuo are tags/macros that provide an easy way to customise the configuration file of a unit. Custom fields are also used as keywords in the REST API.

Custom fields are automatically populated by Virtuo when the configuration file is generated. For example, the end-user can enter the specific SIP authentication credential and define the SIP trunk CallerName here and Virtuo will automatically populate the values in the configuration script file of the unit.

The Custom fields are also used as keywords in the REST API to allow a third party application to pass information to Virtuo which will populate the information to the configuration file of the unit.

In the Virtuo configuration file template, tags are quoted in the following format: 
${unit.custom_field.field_ID}
Top

Example of Custom Fields

If provisioning a new Mediatrix unit in Virtuo, custom fields for the SIP username and password can be created in Virtuo (Creating a Mediatrix Unit Custom Field). Once the custom fields created, a specific value can be entered for each unit that needs to be provisioned by Virtuo ( Configuring the Custom Fields of a Mediatrix Unit ). Virtuo will automatically take the value of the custom fields and place them in the template to build the configuration file of the unit with these new values.
Here are a few custom fields:
  • SipEp.UserAgent[EpId=PRI1].Username = "${unit.custom_field.sip_unit_auth_username}"
  • SipEp.UserAgent[EpId=PRI1].FriendlyName = ""
  • SipEp.UserAgent[EpId=PRI1].Register = "Enable"
  • # SipEp.Authentication.DeleteAllRows
  • SipEp.Authentication[Index=1].CriteriaSelection = "Unit"
  • SipEp.Authentication[Index=1].ValidateRealm = "Disable"
  • SipEp.Authentication[Index=1].Username = "${unit.custom_field.sip_unit_auth_username}"
  • SipEp.Authentication[Index=1].Password = "${unit.custom_field.sip_unit_auth_password}"
  • sipEp.RegistrationRefresh
Top

Basic Tasks

Top

Adding a Configuration File to the Virtuo EMS

Use this procedure if the configuration script you wish to use is not in the Configuration table (Configuration in the Settings section on the left hand side of screen),

Steps
  1. In the Virtuo EMS Web interface, from the Settings section located on the left hand side of the screen, click Configuration.
  2. In the Specific Configurations section, click Import Configuration.
  3. Browse to the location of the configuration file.
  4. Click Import.
Result
The uploaded configuration will appear in the section Specific Configurations of the Configurationpage. The configuration can now be associated with a group. The configuration can also be associated with a single unit as a specific configuration.

Top

Associating a Virtuo Configuration File with a Group

Steps
  1. In the Virtuo EMS Web interface, from the Settings section located on the left hand side of the screen, click Configuration.
  2. Click located on the same line as the provisioning group to which you wish to associate the configuration script.
  3. In the Group Details page, from the Configuration selection list, choose the appropriate Configuration file.
  4. Click Save Group.
Result
When a Mediatrix unit is associated with the group, the selected configuration script will be applied for provisioning.

Top

Associating a Mediatrix Unit to a Virtuo Group

Steps
  1. From the left hand side menu, under the Units section, click List.
  2. From the Find selection list located at the bottom of the Units table, select Serial Number.
  3. In the Find field, enter the serial number of the unit for which the group must be changed.
    Note: If the unit for which you wish to change the group does not appear in the Units list, then, if you purchased your unit directly from Media5, please contact technical support at tac@media5corp.com, otherwise contact your reseller.
  4. Select the Unit Provisioning tab.
  5. In the Unit Provisioning section, from the Provisioning Group selection list, select a group.
  6. Select the Active box.
  7. Click Save.
Result


Top

Virtuo Configuration Scripts

Creating a Mediatrix Unit Custom Field

Before you begin
You must have an access right with admin privileges.
Steps
  1. In the Virtuo EMS Web interface, click Customs Fields, located in the Units section located on the left hand side of the screen.
  2. In the Unit Custom Fields page, click Add.
  3. In the New Unit Custom Field page, complete the fields as required.
    Note: The Field ID provided here is the field ID to be used in the ${unit.custom_field.field_ID} syntax.
  4. Click Save.
Result
The custom field will be available for the units.
Top

Configuring the Custom Fields of a Mediatrix Unit

Before you begin
Custom fields must have been created first. Refer to Creating a Mediatrix Unit Custom Field.
Steps
  1. From the left hand side menu, under the Units section, click List.
  2. From the Find selection list located at the bottom of the Units table, select Serial Number.
  3. In the Find field, enter the serial number of the unit for which the custom fields need to be configured.
    Note: If the unit for which you wish to configure the custom fields does not appear in the Units list, then, if you purchased your unit directly from Media5, please contact technical support at tac@media5corp.com, otherwise contact your reseller.
  4. Under the Unit Details tb, under the Unit Custom Fields section, enter the value of the custom fields to be configured.
  5. Click Save.
Result


Top

Copyright Notice

Copyright © 2023 Media5 Corporation.

This document contains information that is proprietary to Media5 Corporation.

Media5 Corporation reserves all rights to this document as well as to the Intellectual Property of the document and the technology and know-how that it includes and represents.

This publication cannot be reproduced, neither in whole nor in part, in any form whatsoever, without written prior approval by Media5 Corporation.

Media5 Corporation reserves the right to revise this publication and make changes at any time and without the obligation to notify any person and/or entity of such revisions and/or changes.