Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Avaya Contact Recorder (ACR) creates audio files of calls that have occurred on your telephone system.  Providing the ACR recordings are no longer taking place, these recordings can be migrated to VFC using the ACR Import Source.

The ACR Import Source migrates both ACR-only and ACR+15.2 systems using the native ACR API.

Both encrypted and unencrypted ACR recordings can be migrated by the ACR Import Source.

...

Configuration Item

Description

NameName your Import Source. This name will identify the source across the system.
TypeSelect ACR
ACR Hostname or IP Address

Mandatory. Name of ACR CRS (Central Replay Server)

ACR Port

Mandatory. Port Number of ACR CRS (Central Replay Server)

TLS Certificate File or ThumbprintOptional certificate file / certificate thumbprint used for the ACR connection.
TLS Key File

Optional file system location where the certificate key is stored.

TLS Key Password

Specify the password for the file that contains the certificate keys.

TLS Trust List

Certificate chain (or Chain of Trust) is made up of a list of certificates that start from a server's certificate and terminate with the root certificate. If your server's certificate is to be trusted, its signature has to be traceable back to its root CA.

ACR API User

Mandatory. ACR user that must be created with API permission before this Import Source is used.

ACR API PasswordMandatory. ACR user password that is set the first time the Import Source is used. N.B. The ACR API user must not have a password set when it is created, instead the import source ACR API Password will be set and used automatically.
ACR Layout NameMandatory. ACR search layout name created before this Import Souce is used.
Lua CDR CustomisationOptional.  Lua script to be executed during VFC CDR creation from ACR call that allows filtering and control of the import.  See elsewhere on this page for more details.
ACR TimezoneMandatory. Set to the timezone of the ACR CRS, in case it is in a different timezone from the ingesting VFC server.
Maximum Recording Length (minutes)

Mandatory.  Maximum length of any single ACR recording to be ingested.  Recordings exceeding the maximum length may not be ingested or an alert generated.

While a larger batch size retrieves more records, it must not exceed the duration of the timeslot available for processing.

Recording Start TimestampMandatory. Start timestamp of the first ACR recording to be migrated.
Recording End TimestampMandatory. Timestamp of the last ACR recording to be migrated.

...

As historical recordings may include changes in field layout, data anomalies caused by software bugs and ultimately may not be required due to business re-organisation unit, embedded Lua scripting has been provided to control the migration process.

Use of a Lua script is optional, if not required, the Lua CDR Customisation field should be left empty.

For more information about Lua, please refer to https://www.lua.org/docs.html

Use of a Lua script is optional, if not required, the Lua CDR Customisation field should be left empty.  Otherwise, the following template is required:

function

Lua CDR Customisation requires the use of a template:

  • The srcValues table first item value is "xml" and the second item value is one record of the xml string returned by the ACR Layout query.  This query may return many records and the Lua Customisation script is called for each.
  • The dstValues table lists the fields which the Lua CDR Customisation Script may return.  Each value to be returned must replace the name of the field passed in the dstValues table.  
function compute_cdr(srcValues,dstValues)
return dstValues
end

Presently, the field names are hardcoded as follows to match the ACR Template, but they could be generic in the future.

inumIndex = 1
startedatIndex = 2
durationIndex = 3
udfsIndex = 4
otherpartiesIndex = 5
ownersIndex = 6
switchcallidIndex = 7
directionIndex = 8
skillsIndex = 9
agentsIndex = 10
servicesIndex = 11
srcNumberIndex = 12
dstNumberIndex = 13

In order to parse the xml string passed in field 2 of the srcValues table, it is advisable to use a Lua XML parsing library such as Xml2Lua https://github.com/manoelcampos/xml2lua

Access to xml2Lua is then possible using this line of Lua:

package.path = "C:/Program Files (x86)/Microsoft Visual Studio/2019/Professional/vcpkg/packages/lua_x64-windows-static/xml2lua161/?.lua"lib = require "DemoLib"

Xml may then be parsed within the Lua CDR Customisation script using the following pattern:

local xml2lua = require("xml2lua")
local handler = require("xmlhandler.tree")
handler=handler:new()

local parser = xml2lua.parser(handler)

parser:parse(srcValues[2xmlIndex])

local results = handler.root.results
if #results.result > 1 then
results = results.result
end

-- Iterate through the XML nodes/values
for i, p in pairs(results) do
local inum = p
for icm,cm in pairs(p.field) do

callMetadataName = cm._attr.inumname
dstValuescallMetadataValue = cm[1] = inum

--local skills = p.field[9][1]
skills = "Unknown"
otherParties = p.field[5][1]
parties = lib.Split(otherParties,",")
numberOfParties = #parties

srcNumber = "Unknown"
dstNumber = "Unknown"

-- <field name="otherparties">0000001(ACRTEST-1), 10000,9999</field>
-- <field name="otherparties">9999</field>

if (numberOfParties == 1) then
srcNumber = parties[1]
dstNumber = skills
elseif numberOfParties == 2 then
srcNumber = parties[1]
dstNumber = parties[2]
else
srcNumber = parties[2]
dstNumber = parties[3]
end

...

return dstValues

end

if (callMetadataName == "udfs") then
udfs = callMetadataValue
end


While testing the Lua CDR Customisation script, it is possible to write to a local log using the following Lua function or if preferred in a self-contained environment using https://studio.zerobrane.com/

function log(message)
file = io.open("C:/Program Files/Verba/work/cdrimport/luaCustomCDR.log", "a")

-- sets the default output file as test.lua
io.output(file)

-- appends a word test to the last line of the file
io.write(os.date("!%c") .. " - " .. message .. "\n")

-- closes the open file
io.close(file)
end


Separate libraries may be developed in their own file to aid readability and then referred to by the main Lua CDR Customisation Script, for example

lib = require "DemoLib"

File: "DemoLib.lua"

local demo_mod = {} -- The main table

function demo_mod.Split(s, sep)
local fields = {}
local sep = sep or " "
local pattern = string.format("([^%s]+)", sep)
string.gsub(s, pattern, function(c) fields[#fields + 1] = c end)
return fields
end

return demo_mod

Import Policy Configuration

...

Metadata Field

Description

Template

Available

Start DateStart date of the conversationStandardYes
Start TimeStart time on the conversationStandardYes
End DateEnd date of the conversationStandardYes
End TimeEnd time of the conversationStandardYes
DurationLength of the conversationStandardYes
UserName of the recorded userStandardYes
FromSubscriber / Third Party Phone numberStandardYes
From InfoUser / contact nameStandardYes
ToSubscriber / Third Party phone numberStandardYes
To InfoUser / contact nameStandardYes
DirectionDirection of the call from the system perspective, requires configuring internal number/domain patternsStandardYes
Direction (User)Direction of the call from the recorded user perspectiveStandardYes
From (Verba)Verba user name associated with the From NumberStandardYes
To (Verba)Verba user name associated with the To numberStandardYes
LocationHostname of the recording serverStandardYes
End CauseNormal, Hold, Transfer, Conference, Device Change, From Terminated, To TerminatedStandardNo
Audio CodecAudio codec of the recorded streamsStandardNo
Video codecVideo codec of the recorded streamsStandardNo
Platform Call IDUnique conversation identifier received from the recorded platformStandardYes
Silence RatioRatio of silence in the conversationStandardNo
Talkover RatioTalkover ratio of the conversationStandardNo
Longest SilenceLength of the longest silence present in the conversationStandardNo
User ID / Agent IDUser IDStandardYes
From DeviceDevice ID of the calling partyStandardNo
To DeviceDevice ID of the called partyStandardNo
Dialed NumberOriginal dialed numberStandardNo
From IPIP address associated with the calling partyStandardNo
To IPIP address associated with the called partyStandardNo
From Proxy IPIP address of the proxy server associated with the caller partyStandardNo
To Proxy IPIP address of the proxy server associated with the called partyStandardNo
Source PlatformACRStandardYes
Conversation TypeVoiceStandardYes
Forward ReasonForward reason for the conversation (e.g. forwarded, transferred, team call, delegated, etc.) StandardNo
Recording failedIndicates if the recording has failed and the metadata was imported during CDR reconciliationStandardNo
Media LengthLength of the media file related to the conversation in hhh:mm:ss formatStandardNo
Media ErrorShows the media processing errors during recordingStandardNo
Voice QualityOverall voice quality check score for the conversationStandardNo
Record TypeStandardStandardYes
2N SourceIn case of duplicate (2N) recording, records are marked as primary or secondaryStandardNo
UDFsAll standard ACR User Defined FieldsACRYes
AgentsCustomer custom metadataACRYes
ServicesCustomer custom metadataACRYes
SkillsCustomer custom metadataACRYes
Other PartiesCustomer custom metadataACRYes
FingerprintCustomer custom metadataACRYes

...