Uniphore Help Center Portal

[General]
DownstreamAPIVersion=0
RecordByDefault=1

[JetStream]
ServerURL=nats://u-capture.example.com:4222

[VoiceActivityDetection]
WindowSizeMS=10
UseShortTermEnergy=1
MinEnergy=0.000060
UseZeroCrossingRate=0
MinZeroCrossingRate=0.000001
MaxZeroCrossingRate=0.187400
UseActivityTriggering=0
MinActivityMS=20
ActivityEndHangTimeMS=5000

[Licence]
RecordPoolChannels=1000
PP0=4BFDSLVELC382EE4

[INSTALLED PPS]
# Library path of all installed PPs [PP0-PPn]
PP0=/usr/lib/libPP_Matcher.so

[Phones]
SegLengthSecs=9999999

Only configuration settings relevant to this Avaya Aura integration are listed here. For all other settings, leave these set to their default values.

[General]

[General]DownstreamAPIVersion

Controls the format of messages sent downstream to consuming applications, either:

[General]RecordByDefault

Set to 1 to enable or 0 to disable recording by default, for newly discovered devices. If not specified, the default value is 1 (enabled).

[JetStream]

[JetStream]ServerURL

The URL of the NATS server. In the most simple of cases, this will be the NATS server used by the Audio Connector.

[JetStream]Username

If the NATS server is configured for user based authentication, specify the username here. If not specified, no value is used.

[JetStream]Password

If the NATS server is configured for user based authentication, specify the password here. If a password is used, the NATS server should also be configured to use TLS to prevent the password from being sent over the network in the clear. If not specified, no value is used.

[JetStream]Token

If the NATS server is configured for token based authentication, specify the token here. If a token is used, the NATS server should also be configured to use TLS to prevent the token from being sent over the network in the clear. If not specified, no value is used.

[JetStream]TrustedCACertificatesFileName

If the NATS server is configured to use TLS, specify the trusted CA certificate chain here. This will be the CA certificate chain that was used to sign the server certificate. If not specified, no value is used.

[JetStream]ClientCertificateChainFilename

If the NATS server is configured to use TLS with mutual-authentication, specify the client certificate chain here. This will be the client certificate plus the CA certificate chain used to sign the client certificate. If not specified, no value is used.

[JetStream]ClientCertificateKeyFilename

If the NATS server is configured to use TLS with mutual-authentication, specify the client private key here. If not specified, no value is used.

[JetStream]SkipServerVerification

If the NATS server is configured to use TLS, disables verification of the server certificate. Not recommended. If not specified, the default value is 0.

[VoiceActivityDetection]

This section of the ini file is used to define the VAD settings. If the default configuration values don’t work for the customer, it’s recommended that you disable VAD, then record and export some example calls to WAV. These files can then be passed through a test tool that will allow the trial of different configuration values to ensure the correct parts of the call are identified as voice. The best fit configuration can then be applied to the Collector. Please contact the Uniphore Development Support Team for details.

[VoiceActivityDetection]WindowSizeMS

The size of the window, in milliseconds, on which to perform VAD. The default is 10 milliseconds – we don’t recommend any other value at present.

[VoiceActivityDetection]UseShortTermEnergy

Enables/disables use of the Short-Term Energy algorithm. By default, this is enabled (1).

[VoiceActivityDetection]MinEnergy

The minimum energy required for the window to be considered as voice activity. Expressed as a decimal value between zero and one. Zero being absolute silence and one being maximum loudness. The default is 0.000060. This may seem like a low value, but generally background noise will be lower than this.

[VoiceActivityDetection]UseZeroCrossingRate

Enables/disables use of the Zero Crossing Rate (ZCR) algorithm. Use of ZCR is only recommended if it’s required that tones on the channel do not trigger voice recording. If this is the case, ZCR should be used in conjunction with STE. By default, ZCR is disabled (0).

[VoiceActivityDetection]MinZeroCrossingRate

The minimum Zero Crossing Rate for the window to be considered as voice activity. The default is 0.000001. Human speech has a low ZCR, increasing this value may prevent voice from being detected. A lower limit is required because a ZCR of zero indicates that the sine wave is not crossing zero i.e. the waveform is flatline (silence).

[VoiceActivityDetection]MaxZeroCrossingRate

The maximum Zero Crossing Rate for the window to be considered as voice activity. The default is 0.187400.

[VoiceActivityDetection]UseActivityTriggering

Enables/disables use of activity triggering. By default this is disabled (0). If enabled (1), a voice recording will not be created until voice activity is detected on the channel. Likewise, the voice recording will be ended on cessation of voice activity on the channel. If disabled (0), voice recordings will be created and ended based on signaling as normal.

[VoiceActivityDetection]MinActivityMS

The minimum duration of voice activity, in milliseconds, that is required to invoke voice recording. The default is 20 milliseconds. This value must be a multiple of the window size and must be between 10 and 300 milliseconds.

[VoiceActivityDetection]ActivityEndHangTimeMS

The duration, in milliseconds, to continue the voice recording after voice activity has ceased. The default is 5000 milliseconds (5 seconds). This value must be a multiple of the window size. This prevents pauses in speech from causing excessive stopping and restarting of recording.

[Licence]

[Licence]RecordPoolChannels

Defines how many concurrent channels can be captured by the Collector. Calls over this value will be discarded. If not specified, the default value is 1000.

[Licence]PP<0…N>

One or more PP license codes that tell the Integration Adapter which PP(s) to load and what mode they should operate in. This will have been provided as part of the customer’s deployment information from Uniphore.

[Installed PPS]

[Installed PPS]PP<0…N>

The absolute path to one or more PP libraries. The order which PP libraries appear in this list affects the priority order when packets to be processed are passed to the PPs. This will have been provided as part of the customer’s deployment information from Uniphore.

[Phones]

DefaultRecordOnDemandState

Set to Recorded.

[Phones]SegLengthSecs

The maximum recording segment length in seconds. After this duration, recordings will be split. If not specified, the default value is 3600 (1 hour).

[Phones]DetectNewItems

Enable (1) or disable (0) the automatic detection (discovery) of new devices. The default is enabled (1). In general, leave this set to 1 (enabled) for initial system setup and device discovery – if the customer then wants to “lock down” their recordable devices, this can be changed to 0 (disabled).

[Capture]

[Capture]VLANTaggedTraffic

Enables (1) or disables (0) capture of VLAN tagged packets. If not specified, the default is 1 (enabled).

[Recording]

DelayRecordingStartUntilMediaIsReceived

Set to 1 to only delay the start of CTI calls until media is recieved.

[Recording]MaxPacketsInQueue

The maximum number of packets to queue for processing before discarding packets. If not specified, the default value is 65536.

[Recording]MaxPacketLength

The maximum packet length to process in bytes. If not specified, the default value is 9018 (18 bytes for the Ethernet header and FCS, plus a 9000 byte MTU).

[Recording]MediaFlushTimeoutMS

The maximum interval (in milliseconds) to flush media data to NATS Streaming. If not specified, the default value is 10000 (10 seconds). Realtime streaming solutions should set the value to 100.

[Recording]Triggers

Set the comma separated list for the priority of recording triggers, valid options are CTI, Activity, and Signalling.

Under normal operation, the first trigger listed is used – if the source of that trigger fails then the next working trigger source in the list is used to determine when to trigger recording.

[Recording]DelayedCallEndTimeoutMS

Determine how long (in milliseconds) to continue capturing each call after the call end signal has been received, this is to allow any remaining audio to be captured. If not specified, the default value is 1000 (1 second)

[Recording]Policy

Determine which calls should be recorded, either internal extension to extension calls (Internal), external calls (External), or both internal and external calls (All). If not specified, the default value is to record just external calls (External).

[CallSuppression]

[CallSuppression]MaxSuppressCount

The maximum number of times a given recording can be suppressed. If not specified, the default is 3 times (3).

[CallSuppression]MaxSuppressTime

The maximum length of time a given period of suppression will last. If not specified, the default is 15 seconds (15).

[CallSuppression]StopCapture

When call capture is suppressed, send (true) or do not send (false) a request that the audio feed from the 3rd party system be stopped. If not specified, the default is to send the request (true).

[CallSuppression]StopOnCallEnd

Determine if the suppression for a device is ended when the suppressed call on that device ends. If not specified, the default is false.

[CTIServer]

[CTIServer]MaxConnections

The maximum number of concurrent CTI Server connections to accept. If not specified, the default value is 20.

[STAN]ServerURL

Set to the URL of the NATS Streaming Server associated with this Collector.

[STAN]ClusterID

Defines the NATS Streaming cluster ID – must be set to stan-cluster.

[STAN]ClientID

A string that identifies this NATS Streaming client. The Collector ID is appended to this to ensure it is unique. If not specified, the default value is RedBox-IntegrationAdapter.

[STAN]ConnectionTimeoutMS

The duration in milliseconds to wait for a connection attempt to the NATS Streaming server to succeed before considering it as timed-out. If not specified, the default value is 15000 (15 seconds).

[STAN]RetryWaitMS

The duration in milliseconds to wait between attempts to connect to the NATS Streaming server. If not specified, the default value is 15000 (15 seconds).

[STAN]Username

If the NATS Streaming Server is configured for user based authentication, specify the username here. If not specified, no value is used.

[STAN]Password

If the NATS Streaming Server is configured for user based authentication, specify the password here. If a password is used, the NATS Streaming Server should also be configured to use TLS to prevent the password from being sent over the network in the clear. If not specified, no value is used.

[STAN]SkipServerVerification

If the NATS Streaming server is configured to use TLS, disables verification of the server certificate. Not recommended. If not specified, the default value is 0.

[STAN]CertificateChainFilename

If the NATS Streaming Server is configured to use TLS, specify the trusted CA certificate chain here. This will be the CA certificate chain that was used to sign the server certificate. If not specified, no value is used.

[STAN]ClientCertificateChainFilename

If the NATS Streaming Server is configured to use TLS, specify the client certificate chain here. This will be the client certificate plus the CA certificate chain used to sign the client certificate. If not specified, no value is used.

[STAN]ClientCertificateKeyFilename

If the NATS Streaming Server is configured to use TLS, specify the client private key here. If not specified, no value is used.

[STAN]Ciphers

If the NATS Streaming Server is configured to use TLS, this value can be used to restrict the allowed ciphers. If not specified, no value is used.

Depreciated NATS Streaming settings example:

[STAN]
ServerURL=nats://abcd.dev.mycompany.com:4222
ClusterID=stan-cluster
ClientID=RedBox-IntegrationAdapter-1
ConnectionTimeoutMS=15000
RetryWaitMS=15000
Username=
Password=
SkipServerVerification=0
CertificateChainFilename=
ClientCertificateChainFilename=
ClientCertificateKeyFilename=
Ciphers=

[STANChannels]
Alerts=RedBox.Collector.Alert
EventLogs=RedBox.Collector.EventLogs
ConfigRequests=RedBox.Collector.ConfigRequests
ConfigEvents=RedBox.Collector.ConfigEvents
Media=media
Metadata=metadata

TenantID=dcedc429-11a9-4408-84a7-c781363c62e1
TenantName=test
CollectorID=0f89817f-e324-48ca-bcb6-3d61f292755b
CollectorName=collector1

TenantId

Set to the unique identifier of the tenant associated with this Collector. If no tenants are defined, the default test tenant will be used dcedc429-11a9-4408-84a7-c781363c62e1

TenantName

The name of the tenant to which the Collector belongs (optional).

CollectorId

The unique identifier for this Collector. A UUID will be automatically generated and written to Identity.ini on first start.

CollectorName

The name of the Collector (optional).

[RTPCollectorSettings]
RecorderHost=localhost

[RTPCollectorSettings]RecorderHost

The hostname or IP address of the Integration Adapter. If not specified, defaults to localhost.

[MediaPorts]
Min=25000
Max=65535

[Suppression]
StartSequence=*123
StopSequence=#123

[SRTCP]
UseSRTCPWhenSRTP=1

[docker0]
Use=0
IPv4Address=10.0.2.15

[eth0]
Use=1
IPv4Address=10.0.2.42
IPv6Address=2001:db8::1234:5678

[MediaPorts]Min

The beginning of the media port range. Default is 25000.

[MediaPorts]Max

The end of the media port range. Default is 65535.

[Suppression]StartSequence

The sequence of DTMF digits required to start audio suppression on the current call. Default is empty (disables the feature).

[Suppression]StopSequence

The sequence of DTMF digits required to stop audio suppression on the current call. Default is empty (disables the feature). Should not be the same as the start sequence for obvious reasons.

[SRTCP]UseSRTCPWhenSRTP

Enables/disables the expectation that RTCP will also be encrypted when SRTP is being used for a given session. If not specified, defaults to 1 (enabled).

[<adapter-name>]

The RTP Collector discovers all available network adapters on start-up – they’re listed by their device name. The adapter’s IPv4 address is displayed for ease of identification. By default, all adapters are enabled for media traffic. Enable (Use=1, default) or disable (Use=0) adapters as needed.

It’s important that only adapters reachable by the telephony system are used. Adapters are load balanced, so sessions will be evenly distributed across all enabled adapters.

[<adapter name>]IPv4Address

Automatically populated with the IPv4 address of the given network adapter. Aids adapter identification. The RTP Collector does not read this value.

[<adapter name>]AdvertisedIPv4Address

Overrides the IPv4 address advertised for the given network adapter. This is useful when you need an ingress address that is not an address belonging to the RTP Collector itself. If not specified, then defaults to the adapter’s IPv4 address.

<?xml version="1.0"?>
<configuration>
  <configSections>
    <section name="recorder" type="RedBox.Config.RecorderConfig, RecorderShared"/>
    <section name="avaya" type="RedBox.AvayaActive.Config.AvayaActiveConfig, CTIServer_AvayaActive"/>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
    <section name="rtpCollectors" type="RedBox.RTPCollector.Client.ConfigSection, RedBox.RTPCollector.Client" />
  </configSections>

  <log4net>
    <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
      <file type="log4net.Util.PatternString" value="C:\LTR\Logs\CTIServer_AvayaActive.txt"/>
      <appendToFile value="true" />
      <rollingStyle value="Size" />
      <maxSizeRollBackups value="2" />
      <maximumFileSize value="15MB" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date %-5level [%thread] %logger: %message%newline" />
      </layout>
    </appender>

    <appender name="RollingEventAppender" type="log4net.Appender.RollingFileAppender">
      <file type="log4net.Util.PatternString" value="C:\LTR\Logs\CTIServer_AvayaActive_XML.txt" />
      <appendToFile value="true" />
      <rollingStyle value="Size" />
      <maxSizeRollBackups value="2" />
      <maximumFileSize value="15MB" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date: %message%newline" />
      </layout>
    </appender>

    <root>
      <level value="WARN" />
      <!-- Setting this to ALL will increate the logging level to max -->
      <appender-ref ref="RollingFileAppender" />
    </root>

    <!-- Note: to start event logging set the level value to "ALL", to disable event logging set the event value to "OFF"-->
    <logger name="EventLogger" additivity="false">
      <level value="OFF" />
      <appender-ref ref="RollingEventAppender" />
    </logger>
  </log4net>

  <!-- Recorder configuration -->
  <recorder>
    <recorders>
      <add logicalRecorderId="1">
        <add recorderIpAddress="127.0.0.1" />
      </add>
    </recorders>
  </recorder>

  <avaya>
    <dmcc
      aesAddress="172.16.254.6"
      dmccPort="4722"
      username="redbox1"
      password=""
      sessionDuration="180"
      sessionCleanupDelay="60"
      useSsl="true"
      serverName="aes-lab01"
      clientCertificateFile="C:\LTR\Config\redboxrecorder.p12"
      clientCertificatePassword=""
      />

    <device
      multiRegistrationModeIndependent="false"
      startRecordingOnDeliveredEvent="false"
      startRecordingOnDeliveredEventTimeout="60" >
      <codecs>
        <add id="g711A"/>
        <add id="g711U"/>
        <add id="g729"/>
      </codecs>
      <encryptionSuites>
        <add id="none"/>
      </encryptionSuites>
    </device>

    <switches>
      <add switchName="CM">
        <agentGroups>
          <!-- monitor ACD split 2020 -->
          <add extension="2020"/>
        </agentGroups>
        
        <!-- the mr section is only required if Multi-Registration is required -->
        <mr>
          <targetDevices stationPassword="1234"/>
        </mr>
        
        <!-- the ssc section is only required if Single Step Conferencing is required -->
        <ssc>
          <recordingDevices stationPassword="1234">
            <!-- add a single recording device -->
            <add extension="70000"/>
            
            <!-- add a range of recording devices -->
            <add first="70001" last="70005" />
          </recordingDevices>
        </ssc>
        
      </add>
    </switches>

  </avaya>

  <rtpCollectors>
    <add host="localhost" />
  </rtpCollectors>

</configuration>

<configuration>
    <configSections>
        <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
        <section name="sms" type="RedBox.Avaya.SMS.Config.SMSConfig, CTIServer_AvayaSMS"/>
        <section name="recorder" type="RedBox.Config.RecorderConfig, RecorderShared"/>
    </configSections>
    <log4net>
        <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
            <layout type="log4net.Layout.PatternLayout">
                <conversionPattern value="%utcdateZ %-5level [%thread] %logger: %message%newline"/>
            </layout>
        </appender>
        <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
            <file type="log4net.Util.PatternString" value="/var/redbox/logs/CTIServer_AvayaSMS.txt"/>
            <appendToFile value="true"/>
            <rollingStyle value="Size"/>
            <maxSizeRollBackups value="2"/>
            <maximumFileSize value="15MB"/>
            <layout type="log4net.Layout.PatternLayout">
                <conversionPattern value="%utcdateZ %-5level [%thread] %logger: %message%newline"/>
            </layout>
        </appender>
        <root>
            <level value="INFO"/>
            <appender-ref ref="ConsoleAppender"/>
            <appender-ref ref="RollingFileAppender"/>
        </root>
    </log4net>
    <sms pollingInterval="00:10:00" pp="PP_MATCHER">
        <aes>
            <add host="172.16.254.6" certificateValidation="false">
                <cm>
                    <add host="172.16.254.5" username="" password="" switchName="CM" recordMethod="MultiRegistration" enableWarningTones="false">
                      <ignoredStations>
                        <add extension="^700\d{2}$"/>
                      </ignoredStations>
                    </add>
                </cm>
            </add>
        </aes>
    </sms>
    <recorder>
        <recorders>
            <add logicalRecorderId="1">
                <add recorderIpAddress="localhost"/>
            </add>
        </recorders>
    </recorder>
</configuration>

For SMS, the connection to the AES uses HTTPS. This means that the root certificate authority/server certificate may need to be configured.

If the AES web server uses a publicly signed certificate, then no further configuration is required as the Avaya SMS CTI Server container image comes with public trusted root certificate authorities already installed. If the AES web server does not use a publicly signed certificate, then the container image must be extended to install either the root certificate authority responsible for signing the server certificate, or the server certificate itself.

The associated log configuration is performed within the associated CTI server config files:

To configure the main logging level and to enable/disable event logs, set the following in the appropriate config file.

level value

For the main logging level for the event logs, set the level value to “WARN” (warnings only) or “ALL” (warnings and errors). Up to three log files (15MB each) are used on a round-robin basis. To create full event logs (stored separately), change the following level value from “OFF” to “ALL”.

The associated log configuration files are:

To configure the logs, set the following in the ini files(s).

[RBRLogging]
LogLevel=Info

[FileAppender]
Enabled=1
MaxFileCount=10
MaxFileSizeMB=15

[RBRLogging]LogLevel

Sets the log level for this logging zone. If not specified, defaults to Warning. If an invalid value is specified, the default is used. Valid values are:

[FileAppender]Compress

Enables/disables log file compression for this logging zone. If not specified, defaults to 0. If enabled, the most recent log file will be compressed on rotation. If enabled on an established system, any pre-existing non-compressed log files will still be rotated but will not be compressed.

[FileAppender]Enabled

Enables/disables logging to file for this logging zone. If not specified, defaults to 1.

[FileAppender]MaxFileCount

The maximum number of log files to retain. If not specified, defaults to 6.

[FileAppender]MaxFileSizeMB

The maximum log file size (in MB) before the file is rotated. If not specified, defaults to 15.