Configuration

 

 

This section describes how to configure the NetBorder Call Analyzer, and how to monitor its performance and results using log files 

Selecting a Mode of Operation

There are three modes of operation recommended when using the NetBorder Call Analyzer :

  • Initial mode: “Out-of-the-box”, the application is configured to give you the required flexibility and freedom for development purposes.

  • Data collection mode: Emphasis is placed on gathering high-quality, reliable and pertinent data.

  • Production mode: Many of the options associated with the previous two modes of operation are disabled, and the application is configured for optimum performance. 

     

Call progress analysis is carried out during each mode of operation, as required. For example, in data collection mode, you will want to collect NCA results on a wide array of calls to measure, troubleshoot and improve detection performance. Finally, in production mode, you will want to carry out CPA as efficiently as possible for large volumes of calls 

Below you will find some guidelines for the three modes of operation. Note that each mode is user-definable: the following are recommendations only. 

 

Initial Mode

“Out-of-the-box” the NetBorder Call Analyzer is configured as follows:

  • Used as an outbound proxy

  • Call logging is enabled.

  • Call Recording is not used. 

Data Collection Mode

Typically, data collection will be done in collaboration with NetBorder and can be used to measure, troubleshoot and improve the detection performance of a specific deployment. Specifically, in this mode you should:

   ● Ensure call logging is enabled 

   ●  Activate the following logger, and raise its logging level to INFO, so that CPA data collected may be simulated offline:log4cplus.logger.netborder.cpa=INFO

   ●  Enable Call Recording 

 

Production Mode 

Production mode is the mode to use for deployment. To go into production mode, you should:

  • Disable call logging 

  • If your application no longer requires call recording, disable it 

  • Set the netborder.sip.message logger to WARN level (log4cplus.logger.netborder.sip.message=WARN) in files call-analyzer- engine-logging.properties and call-analyzer-logging.properties. 


Selecting the Application Class

An Application Class is a pre-packaged set of call scenarios and related parameters and is used to quickly integrate NetBorder Call Analyzer with third-party components. The available Application Classes are: 

Name

Use

CallAnalyzerAsOutboundProxy   

SIP Dialer can set an outbound proxy. See Configuring NetBorder as an outbound proxy below 

CallAnalyzerGenesysOCS   

SIP Dialer is Genesys Outbound Server (OCS) or cannot set an outbound proxy. See Configuring NetBorder to be used with Genesys SIP Server (ie relay server) on page 59 

 

 

The Application Class is selected via the netborder.sip.ua.python.appClass of the [NETBORDER_INSTALLDIR]\config\ call-analyzer-service.properties file. Restart the NetBorder Call Analyzer service to activate changes. 

Application Classes comes with a set of associated call parameters. The parameters used for a given Application Class are read for the file named<Application Class> .call-properties.

For example, call properties for the CallAnalyzerAsOutboundProxy class are read from the \config\ CallAnalyzerAsOutboundProxy.call-propertiesfile. 


Configuring NCA as an Outbound Proxy

 

By default, or “out of the box”, the NetBorder Call Analyzer is configured to serve as an outbound proxy.

RFC 3261 defines an outbound proxy as "A proxy that receives requests from a client, even though it may not be the server resolved by the Request-URI. Typically, a UA is manually configured with an outbound proxy".

All outbound requests from the UAC or caller pass through the outbound proxy server. The proxy server evaluates them, and if allowed, re-establishes the requests on the outbound side to the UAS or callee. Likewise, responses or initial requests coming from the UAS go to the proxy server to be evaluated. The proxy then communicates with the UAC. In other words, all SIP requests and responses are sent through the outbound proxy; in this case, NetBorder. 

 

 

Configuring NetBorder to be used with Genesys SIP Server (ie relay server) 

Since Genesys SIP Server does not support setting an outbound proxy, NetBorder Call Analyzer can be configured in a special mode where it is used as a relay server to overcome that limitation. Other SIP-based dialers that does not support settings an outbound proxy can use that mode.

When NetBorder Call Analyzer is configured to use a relay server, incoming requests are mapped to a pre-determined IP address and port at real-time. For every initial SIP request, the user part and parameters of the Request-URI header are copied from the initial SIP request and sent on to the relay server; for example, to the IP address and port of a gateway.

Also, calls that are not meant to be analyzed (ie without ;cpd=on), will be redirected via a 302 SIP response to avoid taking resources on NetBorder Call Analyzer. 

 

To configure NetBorder Call Analyzer for Genesys SIP Server (i.e. as a relay server): 

● Using the text editor of your choice, open the file call-analyzer- service.properties located at:

  • [NETBORDER_INSTALLDIR]\config\ call-analyzer-service.properties where [NETBORDER_INSTALLDIR] is the root folder of the installation(for example, C:\Program Files\Sangoma NetBorder Platform 2.0\ ) .

  • Set the parameter netborder.sip.ua.python.appClass to cpa.CallAnalyzerGenesysOCS 

    ● Using the text editor of your choice, open the file CallAnalyzerGenesysOCS.call-properties located at:

    ● [NETBORDER_INSTALLDIR]\config\ CallAnalyzerGenesysOCS.call- properties .

     

    Set the appropriate values for the host and port values, save your changes and

    close the file.

    1. When your changes are complete, restart the NetBorder Cal lAnalyzer service.

    To use a relay server, the following parameters must be enabled: 
    ● app.nca.RelayServerHost
    ● app.nca.RelayServerPort

    These parameters must be configured in the .call-properties file. (ex: CallAnalyzerGenesysOCS.call-properties).

    The pertinent default content of the CallAnalyzerGenesysOCS.call-properties file is provided below. 

     


     

     

Configuring End Of Greeting Detection (EAMD) 

  • To enable this feature just simply change "app.nca.EndOfGreeting.enable=false" to "app.nca.EndOfGreeting.enable=true" in one of the files below.
     

  • To find out which call-properties file you are using open "call-analyzer-service.properties" and search for "netborder.sip.ua.python.appClass=". 

    • CallAnalyzerAsOutboundProxy.call-properties

    • CallAnalyzerGenesysOCS.call-properties

Return to Documentation Home I Return to Sangoma Support