OXR-Admin Guide R2.3 Ed30
OXR-Admin Guide R2.3 Ed30
Legal notice
Alcatel, Lucent, Alcatel-Lucent and the Alcatel-Lucent logo are trademarks of Alcatel-Lucent.
All other trademarks are the property of their respective owners. The information presented is
subject to change without notice. Alcatel-Lucent assumes no responsibility for inaccuracies
contained herein.
Index Table
1 Scope ..................................................................................... 10
1.1 Overview ........................................................................................... 10
1.1.1 Purpose of this guide ............................................................................... 10
1.2 What's new ......................................................................................... 10
1.3 Known limitations / restrictions ............................................................... 10
3 Introduction ............................................................................. 13
3.1 Overview – The Product ......................................................................... 13
3.3 Applicability Statement ......................................................................... 13
3.4 Overview of this manual ........................................................................ 13
3.6 Customer Support ................................................................................. 14
5 System ................................................................................... 20
5.1 System Settings ................................................................................... 20
5.2 Recording Transfer Settings .................................................................... 21
5.3 PRS Settings ........................................................................................ 22
5.4 Recorder Settings ................................................................................. 23
5.4.1 Alert Email ........................................................................................... 23
5.4.2 Network Adaptor .................................................................................... 23
5.4.3 Enable Wrapup ...................................................................................... 23
5.4.4 Wrapup Initial Wait ................................................................................. 23
5.4.5 Date Format .......................................................................................... 24
5.4.6 Recording Type ...................................................................................... 24
5.4.7 Recording Beep ...................................................................................... 25
5.4.8 Beep Interval ......................................................................................... 25
5.4.9 Pause Recording ..................................................................................... 25
5.4.10 Delete Recorded Calls .............................................................................. 25
5.4.11 Encryption Password ................................................................................ 26
5.5 SNMP – Supervisor Settings ..................................................................... 27
5.6 SMTP Settings ..................................................................................... 28
5.7 Radius Server Settings ........................................................................... 28
5.8 Language Settings ................................................................................ 29
5.9 Reports Header Settings ........................................................................ 29
6 Nodes ..................................................................................... 30
10 Teams .................................................................................... 37
11 Extensions ............................................................................... 38
11.1 Find an Extension ................................................................................. 38
11.2 Add Extension ..................................................................................... 40
11.3 Other Links: ........................................................................................ 42
13 Agents .................................................................................... 53
13.1 Find an Agent ...................................................................................... 53
13.2 Add Agent / Group Admin User ................................................................. 54
13.2.1 Personal Information ............................................................................... 56
13.2.2 Screen Capture Information ....................................................................... 56
13.2.3 Agent Teams Info.................................................................................... 57
13.2.4 Agent Extension Info ................................................................................ 57
13.2.5 Security Groups ...................................................................................... 57
13.3 Importing Agents .................................................................................. 57
15 Traces .................................................................................... 64
17 Server .................................................................................... 68
19 Archiving ................................................................................ 84
19.1 My Jobs. ............................................................................................ 84
19.1.1 Search Jobs ........................................................................................... 84
19.1.2 Add Job ............................................................................................... 85
19.2 My Schedules ....................................................................................... 88
19.2.1 Search Schedule ..................................................................................... 88
19.2.2 Add Schedule ........................................................................................ 89
20 General .................................................................................. 91
20.1 Change Password ................................................................................. 91
20.2 OmniPCX Record Licensing ...................................................................... 92
20.3 Request License: .................................................................................. 94
20.4 Apply License: ..................................................................................... 97
20.5 Download ........................................................................................... 98
20.5.1 IP Attendant Client Utility ......................................................................... 98
20.5.2 Screen Capture Agent Utility...................................................................... 98
20.5.3 XVid .................................................................................................... 99
20.5.4 WinPcap 4.1.2 ....................................................................................... 99
20.5.5 VLC .................................................................................................... 99
25 Reports.................................................................................. 118
25.1 Report Options .................................................................................. 118
25.1.1 Report ................................................................................................ 118
25.1.2 Group ................................................................................................. 121
25.1.3 From .................................................................................................. 121
25.1.4 To ..................................................................................................... 121
25.1.5 Show Report ......................................................................................... 122
25.1.6 Sample Report View ............................................................................... 122
Document History
1 Scope
1.1 Overview
o Attendant calls DO NOT store a CLI or DDI as this is currently unavailable and
will therefore be displayed as „NA‟. The only information available for an
Attendant call is the „Device‟, which will be populated with the Agents
extension number.
o Silent Monitoring currently does not work with Auto Attendant Calls
4. Encryption is not currently supported for screen capture. Screen capture can still be
used but these audio/video files calls will not be encrypted.
5. Digital Signatures & Call Encryption are only available when the Encryption module
is installed
6. Voice Activity Detection (VAD) is NOT SUPPORTED by OmniPCX RECORD for IPDR
recording
11. The maximum number of channels that can be recorded simultaneously is currently
400
12. It is only possible to record IP handsets using either the IPDR-LINK or DR-LINK. It is
NOT possible to distribute recording of IP handsets across both interfaces.
13. Silent Monitoring currently supports a maximum of 5 concurrent sessions. Should the
maximum number of sessions be exceeded, a message will be displayed stating that
the number of requested sessions has exceeded the maximum allowed.
14. At no point should the Regional Settings of your OmniPCX RECORD server be
amended as this cause issues with the software.
15. Silent Monitoring can only monitor calls that are being recorded.
2 Glossary of Terms
CSTA Computer Supported Telephonic Application (CTI)
UC Unified Communications
3 Introduction
3.1 Overview – The Product
Voice recording has always been a sophisticated and a rather expensive application, until
now. OmniPCX Record for Enterprise companies is the first voice recording application from
Alcatel-Lucent. The software is supplied as a full Windows based application and has been
tightly integrated specifically for use with the Alcatel-Lucent‟s OXE platform.
There are a range of additional modules. The first is screen capture which captures what the
agent is doing on the PC and syncing it with the audio, there is also a silent monitor option
for Group Admin users to listen in to calls without being heard and last but not least a
quality monitor and coaching application so that after the call has ended, agent evaluation
programmes can be implemented and calls scored. There is also a multi-node license for
configurations which include one or more nodes.
Whilst providing the features and functions of a high-end voice recorder, the application is
also perfect for the small to medium-sized enterprise, because it is so intuitive and simple
to use and also because of its competitive pricing. It‟s as good at 20 users as it is at 400.
After installing the application as set out in this installation guide, the administrator can
then take over and start setting up which extensions are to be monitored and recorded. Each
of monitored extension consumes one user license. If the extension is not configured in the
system, then those extensions will not be recorded and are outside of the OmniPCX Record
application.
This manual is for OmniPCX Record release #2. If you are a first time user then you can
install the application and use it straight away. If you are running release #1 you will have to
follow an upgrade path, which is detailed later in this manual.
To start with the manual provides an overview to give the reader an idea of the way in
which the system works and architecture which is relevant to this.
All the activities are explained firstly in words and then with screenshots for reference.
This will help the reader visualise the system and better understand the logic.
A Table of Contents is provided at the beginning of this manual which includes hyperlinks.
This will enable the reader to jump to any section that is deemed relevant.
Sometimes we only show a small part of the overall screen. Used for illustration, this helps
to focus the reader on what is important
3.5 Licensing
This is explained in the body of this guide
4 Administration – Startup
To open the OmniPCX RECORD Administration Console, click on:
Start All Programs Alcatel Lucent OmniPCX Record OmniPCX Record Admin
Console
Once you activate this link, the resultant screen is displayed as below.
The relevant portion of this screen is magnified. This shows that this is the login screen.
You will have to key in Administrator‟s login Username and Password. By default, they are:
Username - admin
Password - admin
After keying them in, click the Login button. You will see the following screen:
This is the screen that you will work from which will allow you to navigate around the
application using the left vertical panel. If you need to expand the size of the work area,
simply click on either or both of highlighted areas in the image above
To start, we will be focusing our work on the section titled: Manage in the left panel. In
this section, you can go to required section by clicking on it. For every click, the main
page to the right will change to the corresponding display. Your task is to go through each
link and customize the application to your requirements. What follows should give you
everything you need to achieve this. We recommend that you work on these links, in the
following order.
o System
o Nodes
o PCM II Settings
o Storage Settings
o Call Flags
o Permissions
o Teams
o Extensions
o Agents
o Recording Filters
o Traces
o Decrypt Audit Log
o Server
After completing each section, click on the UPDATE button for that section. But please
note that for the changes to take effect, you must restart the system. You should make all
the changes with all the links before you restart the system, and not when you have
completed each section. This is simply too time consuming.
5 System
When you click on this link, a long page is displayed. It has nine different sections. They
are displayed in the order of the screenshot:
o System Settings
o Recordings Transfer Settings
o PRS Settings
o Recorder Settings
o SNMP - Supervisor Settings
o SMTP Settings
o Radius Server settings
o Language Settings
o Reports Header Settings
A screenshot of each section is given below and a separate explanation for each is written
underneath each item. Cumulatively they make up the long display described above.
At the bottom of each section, you will find the button. Once you update a
section, you must click on this button to save your entries. Clicking on this button does not
close the current screen, so you can click on this button and continue working on other
sections. For all changes made to take effect, you will need to restart the recording
service.
Server Role:
Primary is selected by default. If you wish, you can select the Secondary. When you
select it, the caption below will change accordingly from: Primary Database information
to Secondary Database Information.
Server Name:
The Server provides an arbitrary name for the OmniPCX RECORD Server.
Server Mode:
The Server mode depicts if the server is defined as a „Satellite‟ recorder, central „Master‟
recorder or neither. For more information on Server more, see Satellite Recording.
The Primary Server IP address that you gave during the installation is displayed here. You
do not need to change it. If, however, you do need to change it, then you can overwrite it
here.
This entry is optional and is only of use when you have “Recorder Warm
Standby/Redundancy”. If this is a single server solution then you can ignore it.
This will display as Primary or Secondary Database Information, based on the selection you
make in the Server Role field. This is optional. The fields here pertain to
Primary/Secondary Database Server and are self-explanatory.
Transfer Media: Specifies the method that will be used to upload the Satellite recordings.
Available options are as follows:
o FTP – uses „standard - FTP‟ to upload the recordings to the transfer location
o SECURE FTP – uses „Secure – FTPS‟ to upload the recordings to the transfer
location
o Uploads the recordings to a standard network location that is used for
transferring the Satellite recordings
FTP URL: “Only Available when Transfer Media is set to FTP or Secure FTP”, Specifies the FTP Server
Resource.
Network Path: “Only available when Transfer Media is set Network”, Specifies the Network folder used
for uploading the recordings.
Username: Contains the username required for accessing the chosen FTP server resource
Password: Contains the password required for accessing the chosen FTP server resource
Passive Mode: Specifies that „Passive Mode‟ should be used when accessing the chosen
FTP resource
Schedule Interval: Specifies the scheduled interval „In Minutes‟ for downloading satellite
recordings
Note: For a more detailed understanding of the „Recording Transfer Settings‟ refer to
Satellite Recording
This refers to the IP address of Alcatel-Lucent Presentation Server. This can be OTUC or
the XML API server. This is an optional extra for additional features.
Note: Use of “Record on Demand” with IP Touch Phones can only be implemented with a
presentation server which drives the IP phones. If no Presentation server is available
Record On demand should be accessed via the OmniPCX RECORD agent portal
In this box, the version of OXE PRS will display automatically. If you want to change it, you
can key it another version number. This application accepts version 5.0 and above only.
For your reference, it works as follow:
If, however, a wrapup start signal is received from the telephone system, Screen Capture
will NOT become available until a wrapup finished signal is received from the Telephone
system
Note: For information on configuring Wrapup on your telephone system, please refer to you
Alcatel-Lucent Business Partner.
o GSM610
o WAV
o MP3
The default value is: WAV. For the same recorded matter, each format will result is a
different file size. Normally, the better the quality of the recordings the more memory it
consumes. You can make your selection accordingly, based on your company preferences.
The following table provides information on the file size for different recording formats
with Video highlighted in red and italicised
o Off
o On
o On Call Start
The beep is often played to let people know that they are being recorded. The default
value is: Off. If this is selected no beep will be heard at any point. This means that there
will not be any audio alert for a call being recorded. Most often the beep selection will
depend on the country‟s legislation on the matter.
When Recording Beep is: On, a beep will be heard, during the calls that are recorded.
When Recording Beep is: On Call Start, a beep will only be heard at the beginning of the
call.
This means that every 1 hour, 50% of any stored calls will be deleted automatically. This
deletion service picks calls on a random basis. These values can be changed to suit your
requirements. The hour dropdown box provides values from 1 through 24 –and you can only
specify whole numbers or full hours.
This process happens as specified when this system is operational. At the end of each hour
the process runs. If, however, you close down the system and restart it, the deletion
process is immediately run for those calls which have not yet had the process applied to
them, irrespective of any other settings Your original settings will then take effect again
from the moment the recording server becomes active .
Suppose you have recorded 40 calls in one hour. At end of the hour, 50%, (that is 20 calls)
will be deleted. This deletion will be on a random basis. You now have 20 calls remaining.
These 20 calls having had the process applied to them will not be considered in the process
for a second time.
Now in the second hour, let‟s assume you have recorded 60 more calls, 50% of these calls
that is 30 calls will be deleted at random. This leaves 30 calls remaining. So, in total, you
have 20 + 30 calls = 50 calls. Again, these calls (50) already having been subject to the
process, will not be deleted during the next deletion process.
If you leave the box: Delete Recorded Calls empty, there will not be any deletion of calls.
Encrypt Recording
You only have two options: Enable and Disable. Select the one that is appropriate
IMPORTANT! Note: encryption is not currently supported for screen capture. Screen
capture can still be used but these calls will not be encrypted. Additionally, any calls that
were encrypted prior to changing the encryption password will no longer be accessible as
the same password is also used for decrypting recorded calls.
Note: As mentioned in the alert message earlier, the Recording Server will need to be
restarted before call encryption will take effect.
Essentially, SNMP agents expose management data on the managed systems (Slaves) as
variables (such as "free memory", "system name", "number of running processes", "default
route"). But the protocol also permits active management tasks, such as modifying and
applying a new configuration.
The agent (which is on the Slave) will send data without being asked, using TRAP protocol
operations to the managing system (Master). The monitoring operations are usually
performed on a regular basis.
The variables accessible via SNMP are organized into hierarchies. These hierarchies, and
other metadata (such as type and description of the variable), are described by
Management Information Bases (MIBs). If you have installed this application in C: drive,
then you can load the MIB file from the following location:
The SNMP protocol operates in the Application Layer of the Internet Protocol Suite (Layer 7
of the OSI model). Typically, SNMP uses UDP ports 161 for the agent and 162 for the
manager. The manager may send requests from any available source port, to port 161 in
the agent (destination port). The agent response will be returned to the source port. The
manager typically receives notifications (TRAPs and INFORMs) on port 162. The agent may
generate notifications from any available port.
OmniPCX Record broadcasts SNMP Alerts so that system various information such as low
disk space can be monitored using a SNMP client. To allow SNMP alerts to be received by
your SNMP client you need to provide the following information:
o Receiver IP(s)
This is IP address of the PC where your SNMP client is installed. You can
supply up to 2 Receiver IP addresses.
o Port Number
This is the port that you chosen to monitor from your SNMP client
o Community String
This is word shared with your SNMP client that prevent the SNMP messages
being intercepted by another SNMP client that may be on your network
Note: The SNMP Settings can be reset by clicking the „Reset Button‟
To allow calls to be sent via email from OmniPCX Record, you need to provide the
following information:
o SMTP Server
This is IP address or domain name of your SMTP server
o SMTP Username
This is the username used when sending emails from OmniPCX Record to
your SMTP server
o SMTP Password
This is the password used when sending emails from OmniPCX Record to your
SMTP server
Note: The SMTP Settings can be reset by clicking the „Reset Button‟
To activate this, you will have to key in the values for the following:
Then tick the check box: Allow Authentication, and click Update. This activates the
Radius Server authentication. You will get a message confirming this.
Now, when a user whose name is registered with the OmniPCX Record server tries to login,
he will be authenticated by the RADIUS Server and he will be allowed to login. If the user
is not available in the RADIUS server, then access will be denied. This restriction does not
apply to the Administrator.
Note: When the display language is change, you will be automatically logged out of the
system and will need to log in again in order for the changes to take effect.
To apply a logo, first select the Product that you wish to apply the logo to. This can be
either OmniPCX RECORD or Quality Monitor.
Next, click the „Browse‟ button and browse to the image of your choice. Once you have
located your chosen image, select it and then click „Open‟
Note: The Report Header Settings can be reset by clicking the „Reset Button‟
6 Nodes
OmniPCX RECORD version 2.1.x and higher includes the ability for “Multiple Nodes” to be
included as part of the OmniPCX RECORD recording process. To add a node, simply follow
the instructions given below:
First, select Nodes from the left menu panel. You are now presented with the following
screen:
SCREENSHOT – Nodes
o IPDR Logger Address, This setting offers the ability for multiple LAN addresses to be
associated with the OmniPCX RECORD server and to allow each LAN address to be
associated with a separate NODE.
This is necessary because when using IPDR & OmniPCX RECORD in conjunction with
an MSN module, the OPXR server „must‟ be connected to the same network as the
MSN module.
Sample Diagram:
Enter the IP address that is to be associated with the node you are providing.
Note: If the IPDR Logger Address is left „Blank‟, the OmniPCX RECORD default IP
address will be used to receive the IPDR logger traffic.
o Remote recorder for network DR Link – This option only applies in a networked DR
Link environment. In order to record via a remote Packetizer, first tick the box
and then from the drop down list select the Node where the Packetizer is
connected.
IMPORTANT: The Remote Node drop down list will NOT include Nodes that do not
have a Packetizer assigned to them.
o Description - In this field, enter a description for the Node, for example “Site 1”
Finally, once you have entered the details into each field, Click Save. You will now see
your new node added to the list of available nodes as shown below.
Note: When adding Nodes or modifying Node details, the OmniPCX RECORD server must
be restarted before the changes will take effect
7 PCM II Settings
The functionality of the PCM II Cards is to enable call recording from analogue & digital
phones. This is associated with the Packetizer that converts analogue and digital signals
into IP packets and sends them to Voice Recording System.
Under this link, the opening page is for searching existing entries. A link at the top right of
this page takes you to the page where you can add more PCM II Cards.
The filter Field Name provides you with following two choices:
o Packetizer IP
o Packetizer Port
o PBX IP
o begins with
o contains
o ends with
o is exactly
The Criteria you select here, acts as a qualifier for the entry that you give against Find.
Then select the number of results per page at right, and click on Find button to list the
results.
This is the place where you can add more PCM II Cards. Click on it and it will display the
screen shown below:
PBX IP * – In the first box select the appropriate PBX IP Address to which the Packetizer is
connected.
IMPORTANT: The PBX IP drop down list will NOT include the IP addresses of the Nodes that
already have a remote node assigned to them.
PCM II Physical Address – In the second box enter the shelf address of OXE (Crystal). In
the second, enter the Board address of OXE (Coupler).
Packetizer IP – The Packetizer IP address should be unique and will be supplied by your
network administrator.
Packetizer Port – This is the Port number of the Packetizer to be configured in the
OmniPCX Record configuration. The default port number for this is: 9000.
Once you have made these entries, click on the Save button to save your entries
Note: You must repeat the above process for each PCM II card that OmniPCX Record will
utilize for analogue & digital voice recording.
8 Storage Settings
Click on the link: Storage Settings, in order to open the following screen:
When you click on the drop down box against Select Drive, it will list all the available
drives on your hard disk. When you select any drive from this list, you can see the below
portion change accordingly, both in hard data and pictorially. Once you have reviewed the
data by drive you can then decide which drive(s) you wish to allocate to both the storage
and archiving of recordings.
Repository Storage Path refers to the location where completed recordings are stored
Processing Storage Path refers to the location where recordings in progress are stored
Archive Path refers to the place where the archiving server will store recorded calls so
they can be backed up.
Note: It is recommended that your Storage & Archive locations are NOT local to the
OmniPCX RECORD Server. This will help to prevent server issues if the disk space becomes
extremely low.
Note: The details below are provided for your information only and assume that the
application was installed in the default path. If the application path was amended during
the installation you will of course need to substitute the root folder name with the one
that was supplied during the installation of the OmniPCX RECORD product.
o Sub Folders
o Sub Folders
Note: Unless otherwise specified, the Repository & Processing storage paths are the same
by default when the system is installed.
Note: Live & Archive Storage locations for OmniPCX RECORD will support both local NTFS
HDD, SAN, NAS and shared network folders.
9 Call Flags
Call flags are additional and searchable custom fields that can be created for calls:
In this section, you can learn how to assign a tag to each of the coloured flags. These flags
will be used elsewhere in the application for adding additional and customised data. This
also makes it quick to identify by recognising the colour of each flag.
Against each coloured flag, key in the description that you want that flag to be.
10 Teams
When you click on the Teams link, it opens the following page.
In a large organization where call centre type services are offered, people may be
organized into teams, often it‟s by skill or product knowledge. Description of skills or
product knowledge can be assigned to teams here. Once you have added your teams, they
will be displayed for future retrieval.
To add a new team, key in the name of the team in the first box, and write its description
in the box below. Then click on Save to save this entry.
Once you have added a new entry, it is displayed at the bottom of the screen, under the
captions: Teams and Description – see screenshot above
Finally, at the right hand side of each entry, you can see the following icons:
When you click the icon, the entry is deleted. When you click the icon, the entry is
opened on the screen for editing.
11 Extensions
To begin with the table will be empty. As you search for more and more extensions, so the
table will fill up.
The filter Field Name provides you with following two choices:
o Extension
o Recording Interface
o Handset Type
o MAC Address
o PBX IP
o begins with
o contains
o ends with
o is exactly
The Criteria you select here, acts as a qualifier for the entry that you give against Find.
Then select the number of results per page at right, and click on Find button to list the
results. If you leave the Find box empty, all entries will be listed. You can find the list at
the lower part of the screen.
Under the captions Recording and Recording on Demand, you will find a Red or Green
colour icon.
At the right of each entry, you can see the following icons:
When you click the icon, that entry is deleted. When you click the icon, that entry
is opened on the screen for editing. see screenshot below:
When in edit mode for existing extensions, you cannot change the Extension, Recording
Interface, Handset Type or PBX Node.
Click on the link. It opens the following page, where you can add more Extensions:
Extension: You can simply key-in the extension number. It is a numeric entry. It does not
accept non-numeric values
Note: The extension number in case of CCD environment should be the agent number.
Recording Interface: In this dropdown box, you have three choices: IPDR, DR-LINK & IP
Attendant. If the extension is NOT IP, select DR-LINK. However, if it is IP then you could
elect to have either IPDR or DR-Link. In a mixed analogue/digital IP telephone environment
you will probably be using the DR-Link for both TDM and IP/SIP Handsets. Where the
environment is exclusively IP, then IPDR is definitely the most likely choice. You must
check this. Finally, if you are adding an Attendant Phone, choose IP Attendant.
Handset Type: Choose the appropriate Handset Type from the drop down list. Handset
types are as follows:
o IP
o Analogue
o Digital
o SIP
PBX Node: from this dropdown box, select the Node that the extension is associated with.
Enable Recording: When you check this box recording is enabled for this extension.
Enable Recording on Demand: If you check this box, the agent is given permission to
activate recording from the user interface or directly from the handset when configured.
This checkbox will only be enabled when „Enable Recording is checked‟. If you are using
this feature in conjunction with IP Touch phones 4028, 4038 or 4068, a message is
presented on the handset that enables the user to choose if he or she wishes to record the
entire call, or record it from this point onwards.
Note: There are three options to choose from. These include „Off‟, „Record Entire Call‟
and „Record from Now‟. Choosing the appropriate ROD option should be carefully
considered due to the following reasons:
1. When „off‟ is selected, ROD is disabled for the selected Agent and no options for
ROD will be made available during a call.
2. When the „Record Entire Call‟ option is granted to an agent, the Agent will also
have the ability to „Record from Now‟.
3. Because „Record Entire Call‟ captures the call from the very beginning, calls taken
by the agent will immediately consume a recording license when a call is
connected.
4. When the „Record from now‟ option is granted to an agent, the agent will NOT
have the ability to „Record Entire Call‟.
5. Because „Record from Now‟ begins to capture a call only when requested, calls
taken by the agent will only consume a recording license after the Record from
Now option is selected.
IMPORTANT: Record on Demand will be available but NOT function unless the system
filters Default action is set to „Ignore‟
Note: When using Record on Demand from an IP Touch Phone, you will have to install and
configure a Presentation Server (PRS). For more details on PRS, see section on
Presentation Server Configuration. If no Presentation Server is accessible, Record on
Demand can still be accessed from the Agent Portal, but not from the agents IP Touch
Phone.
Static License: OmniPCX RECORD licenses are issued dynamically when calls arrive that are
to be recorded. The Static License option enables you to specify that licensed license must
always be reserved for this extension. This means that should you exceed the total number
of available licenses, this extension will always be recorded
Note: If you are exceeding your maximum number of licenses on a regular basis, you should
consider reviewing the number of licenses you have purchased. This is an important
consideration when adding new extensions to the system as each new extension will
consume a license.
Now click the Add button. The extension is then listed in the lower part of the screen.
12 Permissions Groups
OmniPCX RECORD release 2.3 and higher includes the ability to configure system permission
groups that can be applied to agent profiles in order to restrict their access to specific
features & functionality.
By default the software comes pre-configured with 4 permission groups. These groups
mentioned (below) are static and cannot be modified or removed.
o Super Admin - Members of this group are provided with comprehensive access to
all system features and functionality
o Group Admin - Members of this group are permitted to access standard Agent
features but also have the added benefit of being able to silently monitor and
review other team member‟s calls.
o Agent - Members of this group are permitted to access standard Agent features
and can review their own calls only.
Note: A full list of the permissions that can be enabled and disabled can be found below.
Additionally, the state of each permission has also been provided for each of the default
groups mentioned above.
Agent
View Agents Enable/disable the ability to view
agents.
Create/Edit Enable/disable the ability to
Agents create/edit agents.
Delete Agents Enable/disable the ability to delete
agents.
Import Agents Enable/disable the ability to import
agents.
Export Agents Enable/disable the ability to export
agents.
Bypass radius Enable/disable the ability to bypass
authentication radius authentication.
Silent Enable/disable the ability to silently
monitoring of monitor supervised teams.
supervised
teams
Enable Pause Enable/disable the ability to pause
Action recording.
Enable Console Enable/disable the ability to access
the console.
Enable QM Enable/disable the ability to access
quality monitor.
Enable IOD Enable/disable the ability to ignore
on demand.
Enable Enable/disable the ability to manage
Permissions permissions.
Enable Enable/disable the ability to allow
Recording access to recording actions.
Action
Enable Enable/disable the ability to allow
Recording access to recording rules.
Rules
Scoring Enable/disable the ability to score
Allowed agents.
Search Call
Search all calls Enable/disable the ability to search
all calls.
Search my Enable/disable the ability to search
calls my calls.
Search my Enable/disable the ability to search
team calls my team calls.
View Notes Enable/disable the ability to view
notes.
Add Notes Enable/disable the ability to add
notes
Systems
traces.
Update Traces Enable/disable the ability to update
traces.
Audit Logs
View Audit Enable/disable the ability to view
Logs audit logs.
Job Schedules
View Job Enable/disable the ability to view job
Schedules schedules
Create/Edit Enable/disable the ability to
Job Schedules create/edit job schedules.
Delete Job Enable/disable the ability to delete
Schedules job schedules.
My Jobs
View My Job Enable/disable the ability to view my
jobs.
Create/Edit My Enable/disable the ability to
Job create/edit my jobs.
Delete My Job Enable/disable the ability to delete
my jobs.
Change Password
View Change Enable/disable the ability to change
Password password.
Licensing
View Licensing Enable/disable the ability to view
licensing.
Downloads
Questionnaire
Campaigns
Dashboard
Provide a Group Name & Description then Click „Add‟. Your new group will appear below
the list of default groups mentioned earlier.
To copy a permissions group, click the copy Icon that can be found to the right of the
required group. After clicking the Icon, a „Copy‟ of the group you selected will appear in
the list of groups.
In the example below, the Group Admin permissions group has been copied and a duplicate
entry can be seen highlighted in red.
To Change the name of a group group, click the Edit Icon that can be found to the right
of the group. The group name & description will appear at the top of the page and can be
modified accordingly.
To remove the group, click the Delete Icon that can be found to the right of the new
group.
The following screen appears which contains a list of permission sets. Each set contains
several permissions that can be modified according to requirements.
To modify the required permissions, first click the expand icon to the left of the
appropriate set. In the example below the „Agents Set‟ has been expanded:
You can now modify your chosen permissions by simply adding or removing a tick from the
check box next to each permission, see below:
Note: For detailed information on assigning a Permission Group to an agents, see section
titled „Agents‟
13 Agents
You will start with a blank form. As you start to populate the table once you have put in
data, you can further search for the desired Agent, by providing filters in the boxes
provided.
The filter: Field Name provides you with following five choices:
o First Name
o Last Name
o Username
o Extension
o Team
o begins with
o contains
o ends with
o is exactly
The Criteria you select here acts as a qualifier for the entry that you give against Find.
Then select the number of results per page on the right, and click on Find button to list
the results. If you leave the Find box blank, all entries are listed. You can find the list at
the lower part of the screen.
At the left of each entry, you can see a tick box: This can be used to delete multiple
Agents simultaneously by ticking the appropriate agents and then clicking the column
header icon followed by delete, as shown below
At the right of each entry, you can see the following icons:
When you click on the icon, that entry is deleted. When you click on the icon, that
entry is opened on the screen for editing.
Click on the Add Agent link. It opens the following page, where you can add more Agents:
o Agents are required to change their password and are prompted to do so upon
their „first‟ login
o Agents will receive notification 14 Days before their password is due to expire
o Several prohibited words cannot be used as the Agents password. These words
can be located in a text file placed in General folder at the following location
of the OmniPCX RECORD Server.
o Agent accounts are disabled after 6 failed login attempts or after 90 Days if
their password is not modified when prompted.
Enable Account:
In a CCD environment, the same PC can be used by multiple users at different times of the
day (Hot Desking). In the Windows Username box, enter the Agents Windows logon name.
Enable Video:
When the Agent is making a call, activities on his or her desktop can be recorded
concurrently, so that the audio and video match the call. Select Yes or No, to reflect
whether this agent can have this video recording facility
Note: If the screen capture server cannot access the Agents desktop, a notification email
will be sent to the email address specified under the system settings.
Important! Screen capture is a separate module and needs to be installed for the agent
settings will appear.
OmniPCX RECORD provides the ability to segregate Agents into teams. By doing this, the
application offers enhanced management of recorded calls, agent activities and generally
simplifies the agent configuration process. All the available teams are displayed in the box
on the left. You can assign the agent to the appropriate team by using the arrow buttons
to move the team to the box on the right.
The available extensions are displayed in the box on the left. You can make an extension
number available to an Agent by moving it to the box on the right using the arrow buttons.
When operating in a CCD environment extension numbers should be the agent number and
must also be included extensions list.
The chosen security group will depict what system features & Functionality the Agent can
access. The available security groups are displayed in the box on the left. To assign a
security group to an Agent, simply move it to the box on the right using the arrow buttons.
Note: For more detailed information on Security Groups, see section titled „Permission
Groups‟
Once done, save your entries using the Save button given at bottom right.
In the screenshot above, the sentence: “Click here to download sample file” is
hyperlinked. When you click on it, you can download a sample file format, which will help
you to ensure you provide the agent details correctly.
To import agents, you will have to provide the necessary importation in the form of a .CSV
file. Once you have populated the CSV file, click on the Browse button to open the file.
From here, locate and select your CSV file, then click on Import button to import the file.
Additionally, you can Export an Agent by clicking on the nearby link: Export agent.
14 Recording Filters
14.1 Default Setting
When you click on this link, you come to the following page:
Default Action:
In the dropdown box of this field, you have two options: Record and Ignore. The one you
choose becomes the default recording action for all calls that do not match a System
recording filter.
Recording Direction:
Note: As stated in the screenshot above, System Filters will take priority over other filters
and also Record on Demand. For example, if a User Filter is set to Ignore EXT 2001 and a
System filter is set to Record EXT 2001, the system filter will be applied, NOT the user
filter and the call will be recorded.
Recording Filter Set Name: Assign a name of your choice, which will best identify your
Filter Set.
Description: This is for you to provide a personal description, explaining what this filter
set is used for.
Call Direction: Specifies whether the rules created under this filter should apply to “Only
Inbound Calls”, “Only Outbound Calls” or to “Both”.
Day / Time: Specifies the Day(s) & Time(s) that the recording filter should be applied.
When a call is made or received, if the current Day/Time is outside of the period specified
in this field, the recording filter would be ignore and the rules will NOT be applied.
Available options are as follows:
Note: After selecting a Date/Time option, you will be presented with additional
options that will allow you to specify the appropriate details.
Team(s): Specifies which teams the recording filter applies to. If no teams are specified,
the rules within the filter set will apply to ALL teams. If, however, any teams are
specified, the rules within the filter set will apply to those teams only.
Note: After completing these two entries, you will have to click Save. Once saved, you get
a message to that effect. Only then can you proceed. If you proceed without saving the
filter set name and description, you will get error message when adding recording rules to
this set.
Rule Name: Give a Rule Name of your choice, which you can use to identify the rule.
o Number is exactly
o Number begins with
o Number ends with
o Number contains
o Number Length is Exactly
o Number Length is less than
o Number Length is Greater than
o Correlator Data is exactly
o Correlator Data begins with
o Correlator Data ends with
o Correlator Data contains
o All Calls
Note: Once done, you must click on the plus sign next to action in order to save your rule.
The successfully added rule will then displayed as shown below:
15 Traces
Please note: The more comprehensive the logging, the more CPU resource is used up by the
recorder. Please be careful when setting traces.
Here you can specify the technical information that will be generated and stored ready for
support purposes. When you click on this link, it displays the following screen:
SCREENSHOT – Traces
Note: Traces do not need to be on during normal daily activities. If you request support for
an issue you are experiencing, your support engineer will inform you which trace levels
need activating.
Under this folder header, you can find the log file folders listed. Those folders are named
by the date to which they pertain. It is in the format: dd-mm-yyyy (Date-Month-Year).
Below is a screenshot of a selection of folders:
Inside each folder, the Audit Log files pertaining to that date are stored. These files are
named in the following format:
AuditLog<serial number>.txt
AuditLog1.txt
The log files will tell you what activities happened on a given day. You cannot open the
log files directly as they are encrypted. Below is a screenshot of the file opened directly
through windows explorer:
As you can, see this log file is unreadable. To access the file it must be opened using the
“Decrypt Audit Log” facility provided by OmniPCX Record through the web interface.
To decrypt and view the contents of each log file, click on the link: “Decrypt Audit Log” in
the left side panel as shown below:
Note: The log files are located on the OMNIPCX Record server and therefore, in order to
open the log files, you must access the OmniPCX Record user interface directly from the
OmniPCX Record server.
Inside this, select the folder with the required date, and then the required file in this
folder. Once done, click on Decrypt button and the log file will be displayed as shown
below.
In this file, you can see the activities for OmniPCX Record on the selected day. In this,
each line indicates an activity. Each line consists of following components:
o ID Number
o Date of activity
o Time of activity
o Name of the person logged in (who had done these activities)
o Description of the activity
Restrictions:
17 Server
This screen displays the status of different OmniPCX Record servers. Using this screen, you
can either start or stop these servers. See screenshot below:
At the left, you will see an LED indicating the current state of the server. A Green traffic
light indicates that this server is running. A Red light indicates that it is stopped. You can
find the Start or Stop button to the right. You can click them to either start or stop the
respective servers.
Note: If you make any changes to OmniPCX Record Default settings, you will have to restart
the Recording Server.
Note: The Screen Capture Server Start & Stop options will not be available unless the
Screen Capture Module has been installed.
18 Search Calls
Over time there can be hundreds and thousands of calls made and the resultant database
of stored calls can become large. This makes finding a particular call very difficult. This is
the screen that you will need to use in order effect a search. By having so many filters
available, you should be able to narrow down the possible calls you are looking for better
and find the one call you need easily.
When you login, this is the default page that opens. But at any point of time, you can click
on the link – Search Calls –at the top of your OmniPCX Record menu in the left pane. When
you do so, the following page opens:
Select a Team:
This dropdown box lists the available teams. You can select the name of the team whose
call you are searching for. If you leave this as the default, results are shown from all
existing teams.
Time Zone:
In this dropdown box, world-wide time zones are listed for you to choose from. By default,
the time zone pertaining to your current location is displayed. The Time Zones listed in
the dropdown box are:
To make the task of specifying date and time easy, some predefined options are given in
this dropdown box. They are:
o Occuring Today
o Occuring Yesterday
o Occuring in past 1 Hour
o Occuring in past 4 Hours
o Occuring in past 7 Days
o Occuring in past 30 Days
o Occuring in past N Days
o User Specified
If you select: Occurring in past N Days, then one more field is added as given below, for
you to specify the value for the “N” value.
If you select the last item: User Specified, then the screen will change as given below, to
accommodate you detailed specifications:
In this newly visible portion, you can specify the from and to dates. For this purpose, you
can use the icon next to the entry box, which displays the calendar, or use the three
dropdown cells below to specify the date.
First Name:
This field allows you to include the Agent‟s first name as part of the filter criteria. To do
this, select the appropriate option from the drop down list and then enter the Agents first
name in the box that will appear to the right of the dropdown list.
Last Name:
This field allows you to include the Agent‟s last name as part of the filter criteria. To do
this, select the appropriate option from the drop down list and then enter the Agents last
name in the box that will appear to the right of the dropdown list.
Other Criteria:
o Archived calls
o Device hangup
o Screen capture calls
o No associated agent
o Call ID
o Correlator ID
o Device
o Call Direction
o Called By
o Called To
Note: The „Called To‟ field contains the OXE translated „Called Number‟.
Please refer to the relevant OXE programming guide for more detail on
number translation.”
o Duration
o Flag
o Notes
o Call Status
The way you use this facility is slightly different from others previously mentioned. You
can select either none, or one or more criteria. The method of using this is as follows:
4. The Entry box pertaining to the criterion you have clicked on Add is then displayed
below
5. Likewise, you can add several criteria for one search. The screenshot below shows an
example of multiple criteria that have been applied to the search
6. When you add a criterion, that criterion is removed from the dropdown box list
against Other Criteria.
7. At the right of each added entry box, you can find an “X” mark. When you click on it,
that entry box is removed, and the criterion to which it belongs, is added back to the
list against Other Criteria.
8. When you add a new criterion, (if required) you must provide details in the adjacent
box provided.
Order By:
The „Order by‟ option allows you to order the recordings that are returned by your search
criteria. There are several options for sorting the recordings and these are as followings:
o Call Date
o Device
o Call ID
o Called by
o Called to
Note: The „Called To‟ field contains the OXE translated „Called Number‟.
Please refer to the relevant OXE programming guide for more detail on
number translation.”
o Call Duration
o Agent Name
o Server
o Correlator ID
o Server ID
o Descending
o Ascending
Default value is: 10. Available choices: 10, 20, 30, 40, 50.
Show:
This value should be manually keyed in. The Default is 100%. This feature should be used
when the number of calls returned exceeds the available space to display it.
Once you have keyed in the details explained above, you can check how many entries the
search will return. To do this, click on the button: Count Results at the bottom of the
page. Immediately, to the right of that button, the total number of entries to be returned
will be displayed as shown below:
Select Columns:
Choose the information that you would like to display as part of every result row. To do
this, select the required field from the „Available‟ list box on the left and move the field to
the „Assigned‟ list box on the right by using the arrow buttons. All fields placed in the
„Assigned‟ list box will be displayed for every result row that is returned by the search
criteria.
Note: If you have no custom fields available and need to be able to search on them, you
will first need to make your custom fields searchable. To do this, review the section of this
document labelled: Custom Search Fields.
To view the actual results, click on the Search button. Below is a sample view of the
search results:
Note: The listed recordings can be re-sorted in Ascending or Descending order by clicking
on the column header
Call Details:
When a call is listed, it is presented with several details. These can be modified if
required. However, the following explains the default information that is displayed. (See
Below)
18.2.1 Play
The image below shows the OmniPCX RECORD Player. The player will be displayed
automatically when you select to play a call.
Icon: - This indicates an audio file. Clicking play on this icon will automatically display
the audio player as shown below.
Icon: - This icon represents a screen capture file. When you play it, the player will
display screen capture as shown below, and you will also be able to hear the recorded call:
If required, you can double click on the video area, and you get a full screen display as
shown below:
Note: To capture screen activities, you will need to install the Screen Capture Agent
Utility, which is included in the download section of the application. See the Download
section of this document for more information on the Screen Capture Client.
Note: If your selected call was placed on hold during recording, the screen capture
playback will appear blank during this period.
Note: IMPORANT, in order to playback video files from a PC, you will need to install the
XVid 3rd Party Component. This component is freely available and can be downloaded from
the appropriate website. A download link for the XVid component can be found in the
download section of the OmniPCX RECORD Portal
Player Controls
Note: This option is not supported for Encrypted calls. Encrypted calls can only be play one
at a time.
Note: A maximum of 10 calls can be downloaded together and encrypted files cannot be
downloaded using this option.
Warning! Calls downloaded using the above download options are automatically decrypted
and can therefore be played on any 3rd party media player that supports the file format.
In the window displayed above, you can provide the email address of the recipient,
followed by a personal message in the “body” field that will be included in the email.
Finally, if you tick the Attach Notes option, any notes that belong to the call you have
selected will also be attached to the email.
Note: The audio file of the selected entry is attached automatically and will be sent in the
format in which it was recorded.
This indicates that the mail was successfully sent to the SMTP server. From this server, the
mail will be sent to the specified recipient.
The third column for each entry refers to notes. For each recorded call you have the
facility to add your own notes to the call. There are 2 icon types that will be displayed in
this column, and these are as follows:
18.2.8 Notes
To add notes click on: Add Notes. This opens the following box.
Into this box, enter the required notes as shown above, then click Save
Once you have added a note to a call, you can view the notes, using the View Notes
option. When you click it, you will notice some additional details were included, namely:
o Date of entry
o Time of entry and the
o Name of the person who had created the entry.
Email Notes: Using this menu item you can email the notes of the selected call. When you
click on it, you will be asked to enter the destination email address. See below:
Once you have supplied a destination email address, click on Send. The text of this call
will automatically be attached to the email and sent.
Download Notes: This provision is for you to download the text of those notes and save
them to your local disk drive in text format.
When you click on this link, the download screen will appear shown below
18.3 My Searches
In the main page you will see the Save Search towards the bottom right. When the button
is pressed the following window appears:
Second, using the drop down, specify if you want the number of calls matching the criteria
to be displayed on the search bar. If yes, select „Display‟ otherwise, select „Hide‟.
Your Saved Search is now displayed under Search Calls (See Below). This will enable you to
view the results immediately, without having to rebuild the criteria.
To execute any of your saved searched, simply click on them. To remove a saved search,
click the “X” button to the right of the entry.
19 Archiving
Archiving provides the ability to filter a set of calls and move them to a location of your choice
so that you can then back them up using your company back up procedures. Archiving is not the
same as back-up. To set up an automated archiving procedure, you need to set up a job as
described below.
19.1 My Jobs.
To search for Jobs, you will have to provide for the filters required in this screen.
o Title
o Description
o Job Description
o begins with
o contains
o ends with
o is exactly
The above four fields act as prefixes and/or qualifiers for the entry you make in the next
field: Find. You can select the number of items per page by using the dropdown box at
right. Options available are: 10, 20, 30, 40 and 50 items per page.
You will have to provide the details in boxes above and click on the Save button to create
the job. These fields are explained below:
Job Title: Key in a name. This will be used for referring to this job in future
Job Description: This is for you to add notes for future reference.
Select a Team: In the dropdown box, all the existing teams are listed. Select the team
pertinent to the job. Default is: All Teams.
Call Date and Time: To make the task easier for you of specifying date and time, some
presets are given in this dropdown box. They are:
If you select any of the first 4 in the list, there will not be any change in the screen format.
If you select: Occurring in past N Days, then additional fields appear as given below,
where you to specify the value for “N”.
If you select the last item: User Specified, then the screen will also change as given
below, to accommodate your detailed specifications:
In this newly created portion, you can specify the „from and to dates‟. For this purpose
you can use the icon next to each entry box, which displays a calendar, or use the three
dropdown cells below to specify the date.
Other Criteria:
o First Name
o Last Name
o Device
o Call Direction
o Called By
o Called To
Note: The „Called To‟ field contains the OXE translated „Called Number‟.
Please refer to the relevant OXE programming guide for more detail on
number translation.”
o Duration
o Flag
The way you use this facility is different from others. You can select none, one or more
criteria using the following method:
5. You can add more than one criterion. See example as below:
6. When you add a criterion, that criterion is removed from the dropdown box list against
Other Criteria as each criterion can only be used once.
7. At the right of each added entry box, you can find an “X” mark. When you click on it,
that entry box is removed, and the criterion to which it belongs is added back to the list
against Other Criteria.
8. You need to provide details for each criterion that you add.
Once you have given the above details, click on the Save button to save the job. Once
you have successfully added a job, it is displayed as below at the bottom of the search
page:
The icons at right are for editing and deleting the search criteria, respectively.
19.2 My Schedules
To search of Job Schedules, you will need to provide for the filters required in this screen.
o Schedule Type
o Schedule Time
o Schedule Day
o begins with
o contains
o ends with
o is exactly
The above act as prefixes and qualifiers for the entry you make in the next field: Find.
You can select the number of items per page by using the dropdown box at right. Options
available are: 10, 20, 30, 40 and 50 items per page.
Schedule Type: In this dropdown box, the following items are available:
o Daily
o After Every
o Weekly
o Monthly
o Once
For each choice available you will need to provide the necessary details as shown below:
Jobs: The jobs box provides a list of the jobs that you have created using My Jobs as
explained above. You can check one or more job, and each job you check will be run at
the scheduled time.
The schedule is now listed at the bottom of the search page as shown below:
The icons at right are for editing and deleting the schedules, respectively.
20 General
The fields above are self explanatory. Give your existing Admin password first then supply
a new password. You must also re-enter the password to confirm it. Once done, click the
Update button. Your new password has now been changed.
Important! Licenses supplied for release 2.2 are not compatible with software release 2.3
and above. Therefore, if your OmniPCX RECORD solution has been upgraded you will need
to request the appropriate new license keys.
Note: If you are still in possession of your 2.2 PC Key, this can be used when requesting the
new 2.3 product licenses.
The PC KEY mentioned in the statement above refers to the coded key generated from the
OmniPCX RECORD server when the original product licenses were requested. It does not
refer to the license key that was returned to you to license the product. Supplying the PC
KEY can speed up the new license process, however, if you do not have the original PC KEY,
don‟t worry, it is likely that a new license can be supplied without the need for you to
supply it as all former license information is kept on file.
In order for the application to operate for all time, you will need a license. This page
enables you to generate a PC key which will be sent to your software vendor in order to
request a license. Once generated, you can apply it to the application for it to be released.
When you click on this link, the following page opens:
As you can see in the above screenshot, this page is divided into three parts –
o The next one enables you to apply the license to the application
Below, you can see the whole process of licensing by way of a Flow Chart:
As you can see in the above list, these licenses are Foundation Packs only, and each of
them has 10 units (Channels/Calls/Clients), except for IP Attendant Recording which has 5
units. You cannot apply for licenses below this number. The Foundation packs also include
the software server necessary to control the application. You cannot build any system
without the appropriate Foundation Pack(s)
To generate your required license, use the dropdown box and select the appropriate
choice, then click the Add button. This adds your selection to the request list (See below)
Note: You cannot add both IP and TDM Foundation Packs as you only require one of these
packs to activate the software.
Using the “additional” license options shown in the list above, you can request more
channels/seats than supplied with the foundation pack of your choice.
First, from the dropdown box select: TDM Recording additional Channels
You will notice that the license dropdown box now also contains options for TDM Recording
Additional Channels. Select TDM Recording Additional Channels and specify the quantity
you require „in this example we choose 15‟, then click Add.
You have now added 15 additional Licenses for TDM Recording, as shown below:
Now that you have chosen your Recording Licenses we can add the screen capture module.
To do this, select Screen Capture Foundation Pack (10 Clients), then click Add.
When you add this license to your list of required licenses, the dropdown box will change
again and will now include another entry: Screen Capture additional Agents. Using this
license you can add additional screen capture agents to the basic 10 agents which are
supplied with the Screen Capture foundation pack.
Note: While building your list of required licenses, you can cancel any license by clicking
on the „X‟ button to the right.
Finally, from the dropdown list you can also add any additional features that you want to
include as part of your license request. For example, if OmniPCX RECORD will be deployed
across multiple nodes, you will need to select the “Multiple Node Support” license and
“Click Add” to include as part of your requested license.
When finished, click on the “Request License” button (See Below) to complete the license
request process.
When you click the request license button your license file will be generated and the files
will be presented to you on screen (See Below).
To order licenses, please send the license request file to your software vendor.
if you are an Alcatel-Lucent Business Partner, please save the license file and either attach
it to the original order eSR or send it by email to: professional.services@alcatel-
lucent.com” where your request will be processed and a license key returned to you. You
will then need to apply this license key to the application as explained below.
Licenses are provided to you in the form of files, with the extension .LIC. Once you receive
your license key you will need to apply it as shown below.
First, use the Browse button given to locate and select the licenses file that you have been
sent and then click the Apply License button. Once the license is applied, details of
license are displayed in a list (See Example Below)
Warning! After applying a new license, the OmniPCX RECORD server must be physically
restarted for the changes to take effect.
Note: When applying a license to a multi-node solution, the license will be applied to the
first node on the „Nodes‟ configuration page.
20.5 Download
Note: For more information on installing the IP Attendant Client Utility – refer to section
“Installation - OmniPCX Console Recording Agent” in the OmniPCX RECORD Installation
Guide.
Note: The screen capture server records Agent screen activity by communicating directly
with the Screen Capture Agent utility. If the Screen Capture server is unable to access the
Agent Utility an email will be sent to the „System Alert Email‟ address.
Note: When wrapup is enabled, the screen capture server will continue to record Agent
Desktop activity after a call is disconnected. Wrapup will continue to record for a
predetermined period of time that is set by the administrator.
Note: For more information on installing the Screen Capture Agent Utility – refer to the
OmniPCX RECORD Installation Guide.
20.5.3 XVid
The XVid Component is required in order to playback video calls from your PC and is freely
available from http://www.xvid.org. To download the XVid component choose the
download link: XVid from the General pane as shown below:
20.5.5 VLC
Silent monitoring requires a third party component called VLC, if this component is not
installed, silent monitoring will not work as expected. This component is freely available
and can be downloaded from http://www.videolan.org. To install the VLC Component,
choose the download link: VLC from the General pane as shown below:
21 Virtualization
21.1 Overview
Unlike earlier versions of OmniPCX RECORD, the software can now be installed in a virtual
environment. When using the software in this manner, there should be no noticeable
differences in functionality, however, some limitations do apply (See Below)
21.2 Limitations
o The Solution will only support a maximum of 140 Units. For further information on
product units, please refer to the OmniPCX RECORD Hardware & Software
Specification document
22 Custom Fields
22.1 Overview
OmniPCX RECORD includes 10 custom fields that can be utilized by third party software to
include additional data for each recorded call. Custom fields are accessed and updated
using the OmniPCX RECORD Application Programmers Interface (API). For more information
on custom fields, see the OmniPCX RECORD API Guide.
Finally, when you have updated the appropriate fields and specified which fields should
be available for searching, “Click Update”
If for any reason the Primary Server fails, the Secondary server will start recording and
immediately becomes the Primary recording server. Later, when the “Original” Primary
Server is ready to come back on-line, it does so, but is now treated as the secondary /
backup server.
o The Primary & Secondary servers hold hands by using a virtual heartbeat. This allows
each server to know when the other is active or has failed. The heartbeat is checked
approximately every 5 seconds.
o Both the Primary & Secondary servers have identical configuration portals, however,
all configuration can only be made via the Primary server, except when identifying the
IP address & database details which are specific to each recording server.
o When configuration changes are made to the Primary server, „ALL‟ changes are
automatically synchronized to the Secondary Server.
o When the Primary server is active, the secondary server will be inactive, but all calls
recorded on the Primary server will be synchronized to the Secondary server so that
they are still available in the event of a Primary Server failure.
o If the Primary Server fails, the Secondary server becomes active and remains active
until it is stopped and the Primary recording server is restarted.
Note: As configuration changes can only be made via the Primary Server, it is
recommended the Primary Server is restarted at the earliest opportunity. In addition to
this, any configuration changes made via the Primary server while the Secondary Server
is active, will not take effect until the Primary server is brought back on line.
o During a failover from Primary to Secondary, the currently active calls will be lost.
o As with the Primary server, any calls recorded on the Secondary server will be
synchronized to the Primary server so that they are available when the Primary server
becomes active due to the secondary server failing or being stopped manually.
o It‟s worth noting that Primary & Secondary server synchronizations occur
approximately every 15 minutes and will therefore not be seen immediately
23.3 Prerequisites
1. Both OmniPCX RECORD Primary & Secondary severs have been installed and
configured.
2. It is recommended that the Primary and Secondary servers are on the same
network/VLAN. However, a multiple VLAN environment can be supported by OmniPCX
Record. Before installing in a multiple VLAN environment, you must first contact and
discuss your VLAN architecture with “[email protected]”. Failure
to do this may result in your configuration being unsupported
Note: The Secondary Server must have a separate IP Address to that of the Primary Server,
However, for details on accessing both OmniPCX Record servers using a single IP address,
see the following link on Microsoft Clustering.
http://technet.microsoft.com/en-gb/library/cc731844%28v=ws.10%29.aspx.
Please note that Microsoft clustering may not be available for all versions of Windows.
Now, in the box below the Primary Sever IP key in the IP address of the Secondary Server.
Once done, click Update. Once you click Update the system will check if the Server Name,
User Name and Password that you supplied are correct. If the details you supplied are
incorrect, an error message will be displayed and the details will NOT be updated.
First set the server role as Secondary. Then, in the next box key in the IP address of the
Primary Server.
Now, in the box below the Primary Sever IP key in the IP address of the Secondary Server.
Once done, click Update. Once you click Update the system will check if the Server Name,
User Name and Password that you supplied are correct. If the details you supplied are
incorrect, an error message will be displayed and the details will NOT be updated.
NOTE: When operating dual servers in Recorder Warm Standby mode, the servers are co-
ordinate activities using a virtual heartbeat and synchronization process. Details of these
can be found below:
All Secondary server settings except for the storage location details will be synchronized to
the Primary Server. Therefore, if you do not want to use the default location, you will
need to modify the Secondary Server Storage location as shown below:
You have now completed configuring both Primary and Secondary Servers.
Note: You will need to restart both the Primary and Secondary Servers for your
configurations to take effect. To do so, from the menu on the left, click on Server and you
will see the following page:
1. If the Primary server goes down, then the Secondary Server will start recording calls. It
will take approx 2 to 3 minutes for the Secondary Server to become functional. During
this period the following happen:
o The calls which are in progress during the switch over are lost.
o New calls which start after the secondary server take over will be recorded in
the Secondary server.
o The Secondary Server now becomes Active and will assume the responsibility for
recording the calls.
2. When the Primary Server becomes active again, it will start, but will now assume the role
of Secondary Server and remain passive.
Note: Should the new Primary server go down for any reasons, the above behaviour will repeat
itself and the Servers will again change roles.
Warning! Currently, ALL configurations must be made on the original Primary Server. Once a
change is made, the secondary server will be updated during the standard synchronization process.
No configuration amendments should be made using the Secondary OmniPCX RECORD server.
24 Satellite Recording
OmniPCX RECORD R2.3 onwards includes a new feature called Satellite Recording. This new
feature provides the ability to have a single central „Master‟ and multiple Satellite OmniPCX
RECORD servers.
The Satellite servers work in an identical manner to a standard OmniPCX RECORD server,
however, they also possess the ability to upload recordings to a specified location so that
the Central server can download and import them. This allows the recordings from All
Satellite servers and the Master server to be access from one central location.
Overview
o As mentioned Satellite Recording operates using two server types known as Master &
Satellite.
o Any one solution can consist of one Master Server and Multiple Satellite Servers.
o Each Satellite Server is configured with the appropriate FTP or Network Folder details
via „System Settings‟ in the Admin Portal. These details specify where recordings
should be uploaded to.
o The Master Server is configured with the appropriate FTP or Network Folder details via
„System Settings‟ in the Admin Portal. These details specify from where the Satellite
recordings can be downloaded & imported.
o Each satellite Server includes an upload utility that is run via the Windows Scheduler
service. The upload utility uses the configured FTP or Network Folder details to upload
the call recordings and their associated data which are contained in an XML File.
o The Master Server downloads the Satellite recordings & associated data using a
download service which is started & stopped under the „Server‟ section of the Admin
Portal. As with the Satellite server upload utility, the download service uses the FTP or
Network Folder details to access the calls & their associated data.
o When Satellite Recordings are reviewed via the Master OmniPCX RECORD Server, the
calls can be identified using a 'Server ID' which depicts where the call was recorded.
Note: Only Satellite „Primary‟ servers perform synchronization with the Master. Should the
secondary Server be active, satellite synchronization will not take place until the local
Satellite Primary server becomes active.
Note: Satellite Recordings uploaded to the Master Server can be identified using a 'Server
ID' which depicts where the call was recorded.
Note: Satellite Recordings uploaded to the Master Server are tagged on the Satellite Server
so that only new recordings are uploaded the next time the upload utility is activated.
Note: For the Satellite transfer process to operate via FTP, an FTP server is required. If
required, the OmniPCX RECORD server can be configured and used as the FTP server. For
more information, please refer to the OmniPCX RECORD installation guide.
Note: The downloader service is automatically stopped on OmniPCX RECORD servers configured as
„Satellite Servers‟.
Transfer Media: Specifies the method that will be used to upload the Satellite recordings.
Available options are as follows:
o FTP – uses „standard - FTP‟ to upload the recordings to the transfer location
o SECURE FTP – uses „Secure – FTPS‟ to upload the recordings to the transfer
location
o Uploads the recordings to a standard network location that is used for
transferring the Satellite recordings
FTP URL: (Only Available when Transfer Media is set to FTP or Secure FTP) Specifies the FTP Server
Resource. For example: „ftp://82.1.1.1‟ or „ftp://myftpserver.com‟
Network Path: (Only Available when Transfer Media is set Network) Specifies the Network folder used
for uploading the recordings. For example: „z:\transfer\recordings‟
Username: (FTP Transfer Only) contains the username required for accessing the chosen FTP
server resource
Password: (FTP Transfer Only) contains the password required for accessing the chosen FTP
server resource
Passive Mode: (FTP Transfer Only) specifies that „Passive Mode‟ should be used when accessing
the chosen FTP resource
Schedule Interval: (Master Server only – Not available for Satellite Servers)
IMPORTANT: Once the Satellite transfer settings have been configured, the transfer upload
utility must be scheduled to run using the Windows Scheduler Service. (See - Scheduling
Satellite transfers)
Transfer Media: Specifies the method that will be used to download the Satellite
recordings. Available options are as follows:
o FTP – uses „standard - FTP‟ to download the recordings from the transfer
location
o SECURE FTP – uses „Secure – FTPS‟ to download the recordings from the transfer
location
o Downloads the recordings from a standard network location that is used for
transferring the Satellite recordings
FTP URL: (Only Available when Transfer Media is set to FTP or Secure FTP) Specifies the FTP Server
Resource. For example: „ftp://82.1.1.1‟ or „ftp://myftpserver.com‟
Network Path: (Only Available when Transfer Media is set Network) Specifies the Network folder used
for downloading the recordings. For example: „z:\Transfer_recordings‟
Username: (FTP Transfer Only) contains the username required for accessing the chosen FTP
server resource
Password: (FTP Transfer Only) contains the password required for accessing the chosen FTP
server resource
Passive Mode: (FTP Transfer Only) specifies that „Passive Mode‟ should be used when accessing
the chosen FTP resource
Schedule Interval: Specifies the scheduled interval „In Minutes‟ for downloading satellite
recordings
IMPORTANT! Once the Master transfer settings have been configured, the „Transfer
Recording Server‟ must be started from the „Server‟ Section of the admin portal in order
for the transfer process to operate
However, it is likely that you will want the upload utility to transfer recordings on a scheduled
basis. To do this, add include the upload utility within under the Windows Scheduler as follows:
Start Control Panel System and Security Administrative Tools Task Scheduler.
You are presented with the following Screen:
From the actions menu to the right, click on Create a basic Task
You are now asked to provide a Name and description for your scheduled task:
Note: It is recommended that you provide a name & description that is appropriate to the
task that will be performed.
Enter a Name and Description for the Windows Task schedule and then Click Next
Next, you are now required to indicate when you would like the transfer task to be
performed.
Select a trigger that meets your requirement and then Click Next
Next, you are required to specify the settings for the task trigger you have selected. In our
example, we selected “Daily” and so we need to provide the start Date, Time and
recurrence details
Note: Each task trigger will require different information to be provided. The screen shot
below is based on a “Daily Trigger”. If you select a different trigger option from the
previous screen, the details below would reflect the trigger that you selected.
Next, you need to specify the type of action you would like to perform.
You now have to select the program that we want to run at the scheduled time. We want
to run the Satellite upload Utility. Use the browse button to locate the
“RecordUploadUtil.exe” in the location mentioned earlier.
You have now provided all of the necessary information to create your Windows Task
schedule and are presented with the following screen:
You have now created your Scheduled Task. The Satellite upload utility will now run on the
date/time you specified and will transfer recordings to the Transfer location that you
specified in the „Satellite - Recording Transfer Settings‟
25 Reports
OmniPCX RECORD R2.2 Onwards includes several reports that provide a wide range of
statistics. Each report can be viewed based on a date & time period that can be configured
prior to running the report. Additionally, some reports also include a graphical
representation of the statistics being viewed.
When you click on the Reports link, you are first presented with several options that allow
you to specify the type of report you want to view and the period that you want the report
to span, see below:
25.1.1 Report
In the dropdown box labelled “Report”, you have several reports to choose from.
Note: The statistics provided for each report are based on the reporting period specified
before the report is run.
o Recording - Provides general statistics related all calls recorded, details included
are as follows:
o Call Analysis - Provides statistics related to the call duration of the recorded
calls, details included are as follows:
25.1.2 Group
In the dropdown box labelled “Group”, you can choose how you want the results of your
report to be grouped. These are as follows:
o Hourly - This option will display the statistics in six minute intervals and will
group them hourly. Use this option if you want an in-depth breakdown of the
report results.
o Daily - This option will group and display the statistics daily. Use this option if
you want a thorough but more general breakdown of the report results.
o Weekly - This option will group and display the statistics weekly. Use this option
if you only want a summary breakdown of the report results.
o Monthly - This option will group and display the statistics monthly. Use this
option if you only want an overview of the report results.
25.1.3 From
The “From” option allows you to specify when you want the report statistics to Begin. To
do this, use the calendar icon to choose the appropriate “From” date, then use the drop
down boxes to specify the start time.
25.1.4 To
The “To” option allows you to specify when you want the report statistics to end. To do
this, use the calendar icon to choose the appropriate “To” date, then use the drop down
boxes to specify the end time.
26 Appendices
In the appendices section, you have the following information, detailed below with
appropriate titles, prefixed with their sub-section numbers. Each page number is
hyperlinked. You can click on the appropriate page number to move to that section.
1. Log on as admin on the Xml Api server (or UC), via its web interface; click on Services
in the menu to the left of the page. A configuration page is displayed.
2. In the list of services, locate the service whose entity type is Presentation Server and
click the icon in the Action column
4. Click Next. A second administration page, where IP-Touch applications are listed (if
they exist); is displayed.
5. Find a free Index in this list (this value must be higher than 0)
- “Index”: put here the free index value (higher than 0) you found before.
- “URL registration”: this is the address where the IPTouch application can be
reached on the OmniPCX Record Server. This address is like :
http://{SRV-HOST}/OmniPCXRecord/Phone_App/registration.aspx
where:
{SRV-HOST} must be replaced by the IP address or the hostname of the OmniPCX Record
Server.
http://10.130.158.97/OmniPCXRecord/Phone_App/registration.aspx
Be careful with the upper cases. Keep the other ones with their default value.
8. Click Create. You are brought back to the list of application page. Your new
application is added to the list
11. In the PRS list you can find the entry that you have newly created as below:
The following table provides a list of the available OmniPCX Record SNMP Traps.
Trap Recommen
Trap Name / Severity Message Description
ID ded Action
91301 PrimaryRecordingServiceDeActivated Primary Recording Check the
[Critical] Recording functionality Server
Service deactivated network
Deactivated on primary connection
server status - In
case of
forcibly
shutdown -
restart the
Server
Using the dropdown box select the appropriate Language and then click update. After
making the changes you will be logged out. When you log back in, OmniPCX RECORD will
now be displayed in your chosen language.
Available Languages
Language
English
Spanish
French
German
Italian
Portuguese
Note: When changing the Application Language, you must change both the Primary &
Secondary Server.
2. Backup the “Entire” folder, including “ALL” of its sub folders to a different
physical location such as another PC or External Hard drive.
o The OmniPCX RECORD Database. The OmniPCX RECORD Database resides in SQL
and should be backed up using the standard SQL backup procedures as explained
below:
2. Once you login to the application, you will see the following screen:
3. Under the Databases folder you will find the OmniPCX-Record database. Right
click on the database and select Properties from the drop down menu that
appears.
5. From the folder list in the left side panel, select Files and you will be presented
with the database file paths as shown in the screenshot above.
6. Using windows explorer, navigate to the file paths and locate the OmniPCX-
Record database files as shown below:
7. From this folder, backup the following two files to a different physical location
such as another PC or External Hard drive.
o OmniPCXRECORD.mdf
o OmniPCXRECORD_log.ldf
Note: If you get an error message while taking a backup of the database files, Stop
the SQL Server service and then retry. To stop the Server, close the properties
window, right click on the Server‟s name and click Stop as shown below. After you
have successfully copied the files, restart the SQL Server service.
IMPORTANT : Under the above location there are two files with the same name
“OXERecordServer.exe” , however, the file „type‟ for each file will be different.
The file that needs to be backed up has the file type “Config File”
o Services. During the backup procedure, it will NOT be necessary to stop/restart any
OmniPCX RECORD services.
o Backup Procedure. The information provided above is to assist in ensuring that the
correct data is backed up and aimed at preventing data loss in a server failure
situation. However, the methods used to backup the data are the responsibility of
the Administrator/Customer.
Providing all the necessary information is backed up as explained in the previous section,
OmniPCX RECORD can be fully restored by following the instructions given below:
IMPORTANT: Before you perform the actions outlined in this section, you must ensure that the
correct OmniPCX RECORD release “which you documented during the backup procedure
above” is re-installed as per the instructions given in the Installation Guide.
Note: The above path is the recommend location, although, if you prefer you can also
copy the database files to a folder of your choice
2. Next, open the “SQL Management Studio Express” utility, which can be found under
your SQL Installation on the Window Programs menu as shown below:
3. When the Management Studio Express utility opens, expand the Databases folder and
delete the existing OmniPCX RECORD Database as shown below:
4. Once the existing database has been deleted, right click Databases and Click Attach
as shown below:
Note: Before attaching the database backed up earlier, ensure that the existing
OmniPCX RECORD database has been removed
2. You are now presented with the “Attach Database” window as shown below, Click the
Add button highlighted in the image:
3. In the new window, select your original database “which you stored during the
backup procedure”, then Click OK:
4. The OmniPCX RECORD database details now appear in the attach database window.
Click OK as shown below:
5. Finally, your OmniPCX RECORD Database will now appear in the list of databases as
shown below:
Note: The Storage path folder can be found under “Storage Settings” within the
OmniPCX RECORD Administration portal, See below:
2. Remove “All” existing folders and sub folders from the storage path
3. Locate the folder containing the original recordings “which you stored during the
backup procedure”, and copy it along with all its sub folders back into the storage
path.
1. Open Windows explorer and copy the original OmniPCX RECORD configuration file
“which you stored during the backup procedure”, to the path provided below:
You have now successfully restored your OmniPCX RECORD solution to its original state
If the size of the OmniPCX RECORD database becomes too large, it may be necessary to migrate
the database to a remote PC. The instructions below provide the steps to be taken to achieve
this.
IMPORTANT: Before migrating the OmniPCX RECORD Database, you must first ensure SQL
Server is installed on the destination server and that the user has sufficient rights to
perform the necessary Database Backup and Restore tasks
3. Restore the OmniPCXRecord Database to the New SQL Server (See “Restoring the
OmniPCX RECORD Database”)
Note: The ‘SERVER-NAME’ should be set to the server name of the PC where the database is to
reside
The OmniPCX RECORD application services function using the local admin account. This is
supplied when the application is installed and by default is stored in plain text in the
applications web.config file.
Note: If you intend to modify the local user account you may also need to modify to the user
rights assigned to the application services. For more information see the OmniPCX RECORD Install
Guide on „Using an Alternative Windows Administrator User Account‟.
Now modify the following sections of the web.config file and substitute <NewAdminUser> &
<Password > with the appropriate credentials
{
<identity impersonate="true" userName="<NewAdminUser>" password="<Password>" />
}
Note: When modifying the web.config details ensure that the admin account details are
provided using the correct „CASE‟
The process described here is optional. Its purpose is to enable you to add a greater level
of security to the Windows Impersonation Account (also known as the Domain Account). By
default, the account's ID and Password, as configured in the web.config file, are stored in
clear text and is less secure than encrypted text.
Microsoft provides an ASP.NET Encryption Tool, which lets you encrypt the ID and password
values, making them more secure. You can download the encryption tool, along with
instructions on how to use it, from the following URL:
http://support.microsoft.com/default.aspx?scid=kb;en-us;329290
Before performing this procedure, you must back up the registry and implement a restore
procedure if a problem occurs. This is particularly important because securing the
Impersonation Account modifies the Windows registry.
1. Click Start > Run, type CMD in the Open field, and click OK.
2. Go to the folder into which you downloaded and unzipped the aspnet_setreg.exe file.
3. Type the following command, substituting the "domain\username" and "password" values
with the relevant values:
Press the Enter key. The following keys are created in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\saxt\identity\ASPNET_SETREG,userName
HKEY_LOCAL_MACHINE\SOFTWARE\saxt\identity\ASPNET_SETREG,password
Once the registry has been updated you must update the Identity element of
the web.config file. Using notepad or an alternative text file editor, open the web.config
file from the following location on your OmniPCX RECORD Server:
{
<identity impersonate="true"
userName="registry:HKLM\SOFTWARE\saxt\identity\ASPNET_SETREG,userName"
password="registry:HKLM\SOFTWARE\saxt\identity\ASPNET_SETREG,password"/>
}
Note: When modifying the web.config details ensure that the details are provided exactly
as specified above, including the „CASE‟
You must now grant read permissions to the Aspnet_wp.exe process account, which is
usually <machinename>\ASPNET, as follows:
1. Click Start > Run, type regedit in the Open box, and click OK.
2. Expand the “HKEY_LOCAL_MACHINE>SOFTWARE>SAXT>identity” or
“HKEY_LOCAL_MACHINE>SOFTWARE>Wow6432Node>SAXT>identity”
3. Right-click ASPNET_SETREG and select Permissions.
4. Click Add. In the dialog box that opens, add the object name based on the servers
operating system. For example, if the server is on Windows Server 2003 (which runs IIS
6.0), type
<machinename>\NetWorkService
5. Click OK.
6. On the Security tab, check on Read permission to the account in the step above, and
click OK.
7. Close the Registry Editor.
Note: The Web Client Session Timeout can only be modified from the server PC where OmniPCX
RECORD is installed.
Locate the “sessionstate timeout” as shown above. The value of the “sessionstate timeout”
parameter is given in minutes. The value in the example above is 300 and this equates to 5
minutes.
Change the value of the “session state timeout” accordingly and then save the file. The Web
Client Timeout has now been modified.
Note: The Web Client Session Timeout changes will not take effect until the client exits
OmniPCX RECORD and closes the browser.
www.alcatel-lucent.com/enterprise/services