Skip to end of metadata
Go to start of metadata

Further configuration of the softswitch is done through the VSM application. In order to start VSM we need first to go through its rather simple initial configuration which is stored in xml files located in VSM root web folder.

Firstly we have to set the VSM’s connection to voipswitch database in the Database.xml file. An example file is available here.

There are some more initial settings stored in the AppSettings.xml file.

Main settings

<add key="title" value=""/>
<add key="theme" value="Default"/>   <!-- Any directory name that is inside Content\themes\ -->
<add key="logLevel" value="INFO"/>   <!-- Available values: FATAL ERROR (default) WARN INFO -->

The Title is the name visible in the browser’s top bar. The theme parameters refers to the graphical appearance which is defined in css style files grouped in separate folders in Content\themes\  directory. Enter the name of one of the folders as the value of theme parameter in order to change the default style.

logLevel parameter can have the following values:

  • DEBUG (default option, the highest logging level)
  • INFO  
  • WARN


VSServices API

The VSServices is a collection of web API methods which are described further in a dedicated chapter. The VSM uses the API in some of its functions such as DIDs management (buying, cancelling DIDs). At this moment it suffices to know that the entries in the below section of the AppSettings.xml define the URL of the main VSServices API and optionally a different address for VSServices API which will be intended only for operations related to the DIDs management.

<add key="VSServicesUrl" value="" />
<add key="VSServicesDidApiUrl" value=""/> <!-- optional DID Service other than main VSServices -->



The below section contain the URL for the EMC (Enhanced Mobile Communication), the API which is used by the mobile and desktop softphones and the VUP.  Besides the URL you need to specify the mode of work which can be the RCS or RCS Generic (default).

  • Rcs – when set to the RCS the logins in the database are created as integers with auto increment enabled. Therefore the login cannot be chosen arbitrarily as it would lead to conflicts with the uniqueness of the login column in the database. When adding a new account from VSM it will connect to the EMC API which creates and returns the login’s value.
  • Generic type allows to create alphanumeric logins. The procedure of adding new record in clientsshared table in the voipswitch scheme is performed by VSM. When the account is added then the VSM calls the EMC API method which updates the user’s profile in the “api” scheme.

The VSM uses several methods exposed by the EMCI API. They are described in details here (todo)

DIDs settings

This section contains global parameters which will be used when the system creates a new entry in the routing plan for a DID number. They will be explained later in the Routing plan chapter. It is recommended to keep the default settings as they represent the most common configuration appropriate for almost all DIDs related retail services.

<add key="did_sip_signaling_media_proxy" value="false"/>
<add key="did_sip_signaling_proxy" value="false"/>
<add key="did_sip_independent_signaling_media_proxy" value="true"/>
<add key="did_pbx_allow_voipbox_send_media_before_connect" value="true"/>
<add key="did_set_dont_jump" value="false"/>
<add key="did_pbx_set_dont_jump" value="false"/>



<add key="NewPbx" value="true"/>         
<add key="EmailAsLogin" value="false" />  <!--            flag if email can be used as login -->

NewPbx  - by default set to true, only in the cases when the old, flash based version of the PBX portal is used this option must be set to false.

EmailAsLogin – the client’s email address will be converted to SIP login


Other settings

<add key="HtmlMailUploadPath" value=""/>                <!-- HTML - override upload path direcotry -->
<add key="AllowVoipboxScenarioImport" value="false" />  <!-- flag to allow Voipbox Scenario Import -->
<add key="CanShowClientPassword" value="true"/>
<add key="DashboardAutoRefreshInterval" value="60"/> <!-- Interval in seconds -->
<add key="NewClientCodecs" value=""/>
<add key="NewClientPrimaryCodec" value=""/>

HtmlMailUploadPath  - the path used for uploading HTML files with email templates e.g. voicemail notification, low balance notification.  If not defined, the /Content/uploads folder in the VSM’s directory will be used.

AllowVoipboxScenarioImport – when set to true the VSM will allow to import scenarios from a file. The import function is available from the VSM panel under Settings->System->Voipbox->Voipbox dialable scenario menu

CanShowClientPassword - when set to true it will show an additional option Show current password in the Change password dialogue window in the Clients panel.

DashboardAutoRefreshInterval - how often the dashboard screen should be refreshed

NewClientCodecs - default codecs set for a newly created account

NewClientPrimaryCodec - default primary codec set for a newly created account


<!-- CACHE -->
<add key="DisableCache" value="false"/>
<add key="cache_type" value="web" />
<add key="cache_distributed_servers" value="" />
<add key="cache_specific_data" value="MinPoolSize=10;MaxPoolSize=30" />
<add key="Enyim.Caching.Diagnostics.LogPath" value="" />
<!-- CACHE -->

DisableCache- It is recommended not to change the default setting which is false. Only for troubleshooting, when you want to make sure that the data saved in the database are reflected properly in the VSM you can disable the caching feature by setting the key to true.

<add key="InvoiceGeneratorAppPath" value=""/> <!--Ex. C:\inetpub\wwwroot\VSM\bin\VS.InvoiceGeneratorApp.exe -->
<add key="InvoiceGeneratorAppTempFilesPath" value=""/>

InvoiceGeneratorAppPath – change it only when moving the location of the VS.InvoiceGeneratorApp.exe application. The application comes with the VSM installation package and by default is located in VSM’s bin folder.

InvoiceGeneratorAppTempFilesPath – the folder for temporary files created during the invoice generation.

  • No labels