Browse
 
Tools
Rss Categories

settings.xml

Reference Number: AA-02247 Views: 112 0 Rating/ Voters

When working with the CTI Service, you also need to configure the settings.xml file, located in the installation folder.

This file controls IP addresses and ports relating to CTI Manger connectivity. This XML document should be updated to reflect the configuration of your system.

<?xml version="1.0" encoding="utf-8"?>
<Settings>
    <add key="listenIP" value="127.0.0.1" />
    <add key="listenPort" value="2002" />
    <add key="AAPMIP" value="127.0.0.1" />
    <add key="AAPMPort" value="2001" />
    <add key="AAPMPassiveRecordingIP" value="127.0.0.1" />
    <add key="AAPMPassiveRecordingPort" value="15001" />
    <add key="AAPMV1" value="false" />
    <add key="writeAudioDataToDisk" value="false" />
   
    ...
   
</settings>


Some of these values may need to be modified, based on your system configuration, however it is likely that many of these settings will not need to be changed when CTI Service is running on the same machine as the AASVR and AAREC components.

All the settings that are not explained below can be taken as default and can be changed later if needed. Most of these settings are related to VTassure configurations, so they need to be set only in case the CTIManager will be using VTassure.



listenIP/listenPort

Description: This is the IP/port of the listening host, it should be the same value as outgoing_host/outgoing_port  value from aarec. So we basically do not need to update these settings since aarec configurations can be all taken as default, and they are matching the ones in settings.xml

Possible Values:

Default Value: 127.0.0.1 | 2002


AAPMIP/AAPMPort

Description: This is the IP/port of the incoming host, it should be the same value as incoming_host/incoming_port value from aarec.cfg. So we basically do not need to update it since aarec configurations can be all taken as default.

Possible Values:

Default Value: 127.0.0.1 | 2001


AAPMPassiveRecordingIP/AAPMPassiveRecordnigPort

Description: This is the IP/port of the passive host, it should be the same value as passive_host/passive_port value from aasvr.cfg.

Possible Values:

Default Value: 127.0.0.1 | 15001


LicenseServerIP

Description: This is the IP of the server where the license should be already set.

Possible Values: a valid IP address.

Default Value: Needs to be set by the customer.


webServiceBaseAddress

Description: This is the web service base address it is a required configuration.

Possible Values:

Default Value: Needs to be set by the customer.


restServiceBaseAddress

Description: This is the rest service base address it is a required configuration.

Possible Values:

Default Value: Needs to be set by the customer.


tempOutPutDir/logOutPutDir

Description: This is the paths for the temp folder and the logs folder, both are required to get proper logging.

Possible Values:

INSTALLATION_FOLDER/CTIManager/Logs

INSTALLATION_FOLDER/CTIManager/Temp

Default Value: Needs to be set by the customer.


CTIManagerRestUser/CTIManagerRestPass

Description: This  is the user that should be using CTIManager rest service.

Possible Values:

Default Value: Needs to be set by the customer.


VTassureUser/VTassurePass

Description: VTassure VB Service user/Password

Possible Values: String

Default Value: N/A


VTassureProfile/VTassureConfig

Description: VTassure Enrollment/Verification Configurations for Passive Verifier

Possible Values: String

Default Value: N/A


logDebug

Description: Additional logs are written for debug purposes

Possible Values: true / false

Default Value: false


stackTraceOutput

Description: Additional logs are written for trace purposes

Possible Values: true / false

Default Value: false


sessionTimeoutInSeconds

Description: close idle session after this amount of seconds

Possible Values: int

Default Value: 600 seconds


useReportApiForLiveScoreInfo

Description: It will add verification score information when calling the method GetOperationStatus

Possible Values: true / false

Default Value: false


useJsonRestResponse

Description: It provides responses API responses in Json when true, xml when false

Possible Values: true / false

Default Value: true


AAPMheaderEqValue

Description: When reading the SIP header it identifies the value as the value after the configured separator. e.g. in "Transport: UDP" the value of Transport would be UDP if the configured separator is colon (:)

Possible Values: N/A

Default Value: ":" (colon)


setPassiveSettingsInDb

Description: is no longer maintained

Possible Values: -

Default Value: -


numSecondsOfSpeechForAccept

Description: used in the VB method "GetOperationStatus" for display purposes. It should match the values configured in VTAssure ->  Passive Verification Configuration -> Property "RequiredSpeechLength"

Possible Values: integer

Default Value: N/A


numSecondsOfSpeechForReject

Description: used in the VB method "GetOperationStatus" for display purposes. It should match the values configured in VTAssure ->  Passive Verification Configuration -> Property "RequiredSpeechLength"

Possible Values: integer

Default Value: N/A


numSecondsOfSpeechForEnrollment

Description: used in the VB method "GetOperationStatus" for display purposes. It should match the values configured in VTAssure ->  Passive Enrollment Configuration (Profile) -> Property "RequiredSpeechLength"

Possible Values: integer

Default Value: N/A


rejectionThreshold

Description: used in the VB method "GetOperationStatus" for display purposes. It should match the values configured in VTAssure ->  Passive Verification Configuration -> Property "FailureThreshold"

Possible Values: integer

Default Value: N/A


acceptanceThreshold

Description: used in the VB method "GetOperationStatus" for display purposes. It should match the values configured in VTAssure ->  Passive Verification Configuration -> Property "SuccessThreshold"

Possible Values: integer

Default Value: N/A


customSIPheaders

Description: in case the SIP header contains a custom header, this can be identified and added in the response when calling the VB method GetCallList. Several custom headers can be configured (comma separated), e.g. "SH_X-Genesys-CallUUID,SH_User-Agent,SH_Call-ID", but only one can be displayed by calling the GetCallList.

Possible Values: String

Default Value: N/A


callIDHeaderName

Description: in case the SIP header contains a custom header, this can be identified and added in the response when calling the VB method GetCallList. this property defines the name of the custom header to be shown by calling the GetCallList.

Possible Values: String

Default Value: N/A


AAPMV1

Description: AAPM is the communication protocol between AAREC and CTIManager. If set to false it will use the version Protocol version 2. AAPM protocol version 1 does not support passive recording

Possible Values: true / false

Default Value: false