Professional Documents
Culture Documents
System Administrator's Guide - Rev. A4
System Administrator's Guide - Rev. A4
Release 3.2
November 2009
385A0426-05 Rev. A4
®
Insight from Interactions TM
NICE Systems Ltd. shall bear no responsibility or liability to a client or to any other person or entity with
respect to liability, loss or damage caused or alleged to be caused directly or indirectly by any NICE product.
This includes, but is not limited to, any interruption of service, loss of business or anticipatory profits or
consequential damage resulting from the use or operation of any NICE products.
Information in this document is subject to change without notice and does not represent a commitment on
the part of NICE Systems Ltd. The systems described in this document are furnished under a license
agreement or nondisclosure agreement.
All information included in this document, such as text, graphics, photos, logos and images, is the exclusive
property of NICE Systems Ltd. and protected by United States and international copyright laws.
Permission is granted to view and photocopy (or print) materials from this document for personal,
non-commercial use only. Any other copying, distribution, retransmission or modification of the information
in this document, whether in electronic or hard copy form, without the express prior written permission of
NICE Systems Ltd., is strictly prohibited. In the event of any permitted copying, redistribution or
publication of copyrighted material, no changes in, or deletion of, author attribution, trademark legend or
copyright notice shall be made.
All contents of this document are: Copyright © 2009 NICE Systems Ltd. All rights reserved.
This product is covered by one or more of the following US patents:
5,185,780 5,216,744 5,274,738 5,289,368 5,325,292 5,339,203 5,396,371
5,446,603 5,457,782 5,819,005 5,911,134 5,937,029 6,044,355 6,115,746
6,122,665 6,192,346 6,246,752 6,249,570 6,252,946 6,252,947 6,311,194
6,330,025 6,542,602 6,564,368 6,615,193 6,694,374 6,728,345 6,775,372
6,785,369 6,785,370 6,856,343 6,865,604 6,871,229 6,880,004 6,937,706
6,959,079 6,965,886 6,970,829 7,010,106 7,010,109 7,058,589 7,085,728
7,152,018 7,203,655 7,240,328 7,305,082 7,333,445 7,346,186 7,383,199
7,386,105 7,392,160 7,436,887 7,474,633 7,532,744 7,545,803 7,546,173
7,573,421 7,577,246 7,581,001 7,587,454 7,599,475
360o View, ACTIMIZE, Actimize logo, Alpha, Customer Feedback, Dispatcher Assessment, Encorder,
eNiceLink, Executive Connect, Executive Insight, FAST, FAST alpha Blue, FAST alpha Silver, FAST
Video Security, Freedom, Freedom Connect, IEX, Interaction Capture Unit, Insight from Interactions,
Investigator, Last Message Replay, Mirra, My Universe, NICE, NICE logo, NICE Analyzer, NiceCall,
NiceCall Focus, NiceCLS, NICE Inform, NICE Learning, NiceLog, NICE Perform, NiceScreen, NICE
SmartCenter, NICE Storage Center, NiceTrack, NiceUniverse, NiceUniverse Compact, NiceVision,
NiceVision Alto, NiceVision Analytics, NiceVision ControlCenter, NiceVision Digital, NiceVision
Harmony, NiceVision Mobile, NiceVision Net, NiceVision NVSAT, NiceVision Pro, Performix, Playback
Organizer, Renaissance, Scenario Replay, ScreenSense, Tienna, TotalNet, TotalView, Universe, Wordnet
are trademarks and registered trademarks of NICE Systems Ltd. All other registered and unregistered
trademarks are the property of their respective owners.
Applications to register certain of these marks have been filed in certain countries, including Australia,
Brazil, the European Union, Israel, Japan, Mexico, Argentina and the United States. Some of such
registrations have matured to registrations.
385A0426-05 Rev. A4
For assistance contact your local supplier or nearest NICE Systems Customer Service Center:
EMEA Region: (Europe, Middle East, Africa)
Tel: +972-9-775-3800
Fax: +972-9-775-3000
email: support@nice.com
Israel:
Tel: 09-775-3333
Fax: 09-775-3000
email: support@nice.com
Feedback
2
Managing Licenses 33
Licensing Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
The Temporary License Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Updating a License and using the License Window . . . . . . . . . . . . . . . . . . . 37
Showing All Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Importing Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Using a License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3
Defining Database Servers 43
What is Database Server Configuration? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Which method of SQL Server Authentication is in use?. . . . . . . . . . . . . . . . 46
Defining a Database Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Managing Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Reserved Columns for Business Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Contents 5
4
Configuring TDM Loggers 69
Before You Define Your Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Defining a NiceLog Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Setting Up Predefined Selective Recording . . . . . . . . . . . . . . . . . . . . . . . . . 78
Integrating the Logger with Other Components . . . . . . . . . . . . . . . . . . . . . . 80
Configuring Audio Recording Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Guidelines for Configuring Audio Activity . . . . . . . . . . . . . . . . . . . . . . . . 88
Guidelines for Configuring Audio Parameters . . . . . . . . . . . . . . . . . . . . 92
Defining an Interaction Capture Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Defining a Playback Unit Logger for Retrieval . . . . . . . . . . . . . . . . . . . . . . . 95
Defining a Spare Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Modifying a Logger Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Deleting a Logger Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
5
Configuring VoIP Loggers 99
Defining and Configuring a VoIP Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Defining a New VoIP Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Integrating the Logger with Other Site Components . . . . . . . . . . . . . . . . . 105
Contents 6
6
Configuring the Network Embedded Logger 119
Procedure 1: Completing the Network Embedded Logger Definition . . . . 120
Procedure 2: Mapping Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Procedure 3: Viewing the Network Embedded Logger Configuration . . . . 129
Procedure 4: Editing Network Embedded Logger CTI Nodes . . . . . . . . . . . 131
Understanding CTI Node Parameters for the Network Embedded Logger . 131
Deleting CTI Sources from the Network Embedded Logger . . . . . . . . . . . 133
7
Configuring the NiceScreen Logger 135
Before You Define Your Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Defining a NiceScreen Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Modifying a Logger Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Deleting a NiceScreen Logger Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
8
Resiliency and N+1/1:1 143
What is N+1? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
General Guidelines for N+1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Defining an N+1/1:1 Chain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Viewing the Spare Logger in the System Administrator . . . . . . . . . . . . . . . 149
Managing an N+1/1:1 Chain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Updating a Logger Definition for a Member of an N+1/1:1 Chain . . . . . . . . 150
Adding a Logger to an N+1/1:1 Chain . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Removing a Logger from an N+1/1:1 Chain . . . . . . . . . . . . . . . . . . . . . . . 151
Deleting an N+1/1:1 Chain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Contents 7
10
Interactions Center Server Configuration 165
How Do I Define a CLS Server? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Defining a CLS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Selecting MPCMs used by the CLS Server . . . . . . . . . . . . . . . . . . . . . . . . 171
Mapping Business Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Defining Reporting Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Modifying Configuration Parameters for a Cluster . . . . . . . . . . . . . . . . . . . 175
Editing Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Defining a Schedule for Inserting Basic Recordings (TRS Functions) . . . 180
Modifying a CLS Server Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Deleting a CLS Server Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
11
Channel Mapping 183
What’s New in Release 3.2? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
NICE Perform Site Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
The ABC’s of Channel Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Selecting a Recording Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Importing Channel Mapping Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Channel Mapping Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Limitations for Dynamic Channel Mapping directly to a Switch . . . . . . . . . 193
Limitations for Screen Loggers Defined with Logger Sharing . . . . . . . . . . 194
Getting Started Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Workflow for Extension-Side Recording . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Workflow for Screen Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Contents 8
12
Defining CTI Integrations 203
CTI Integrations Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Where do I Begin? A Recommended Workflow . . . . . . . . . . . . . . . . . . . . . . 206
Information Required Before you Begin . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Configuring a Complete CTI Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Defining a Complete CTI Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Activating the Rejected Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Activating Device Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Customizing CTI Integrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Customization Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Defining a New CTI Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Defining Available Devices and Codes . . . . . . . . . . . . . . . . . . . . . . . . 255
Defining a New Connection Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Defining a New Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Defining a New Key Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Defining a New Media Provider Controller . . . . . . . . . . . . . . . . . . . . . . . . . 286
Specialized CTI Integration Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Mapping Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Defining Media Correlation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Defining Field Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Defining Rejected Devices and Trunks . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Defining Failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Managing CTI Integration Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Viewing a Summary and Accessing Components . . . . . . . . . . . . . . . . . . . 319
Contents 9
13
Allocating Channel and Port Licenses (License Manager) 345
Different Types of Channel Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Channel Allocations - What the Numbers Represent . . . . . . . . . . . . . . . . . 347
Allocating Licenses to Traders and Channels . . . . . . . . . . . . . . . . . . . . . . . 349
Allocating Redundant Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Clearing Trader and Channel Allocations . . . . . . . . . . . . . . . . . . . . . . . . . 351
Reviewing the Number of Ports assigned to each Telephony Service. . . . 352
Allocating Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Updating the Applications Server License to add Channels or Ports . . . . 355
14
Configuring the Applications 359
Defining the Applications in the System Administrator . . . . . . . . . . . . . . . 361
Customizing Application Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Defining Search Order and Locations for Storage Centers and Loggers . 369
What are Locations? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Recreating the Customer Experience - Defining CTI Analysis . . . . . . . . . . 376
Player Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Setting Player Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Contents 10
15
Configuring the Data Mart Server 407
What is the Data Mart? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Data Mart Installation Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Single Data Hub Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Architecture for Multi Data Hubs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Building the Data Mart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Verify the Data Mart Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Define the Data Mart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Install the NICE Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
Link the Databases to the NICE Domains . . . . . . . . . . . . . . . . . . . . . . . . . 418
Define Data Mart Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Customizing Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Modifying a Data Mart Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Creating a Customized Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Selecting Schedules for a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Monitoring SQL Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Viewing Synchronization Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
What are the Data Mart Domains? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
Contents 11
17
Content Analysis Server Configuration 437
Defining Content Analysis Configuration Parameters . . . . . . . . . . . . . . . . 438
Defining General Content Analysis Settings . . . . . . . . . . . . . . . . . . . . . . . 439
Defining Language Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Editing Language Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Defining a Word Search Content Analysis Server . . . . . . . . . . . . . . . . . . . . 447
Defining a Speech-to-Text Content Analysis Server . . . . . . . . . . . . . . . . . . 455
Deleting a Content Analysis Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Overriding Playback Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Defining a Storage Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
18
Deploying Secure Client Communication 469
What is NICE Perform Secure Client Communication Solution? . . . . . . . . 470
Certificate Deployment for Secure Client Communication . . . . . . . . . . . . . 471
Configuring Secure Client Communication in the System Administrator . 472
Testing Security Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
19
Configuring NICE Perform Components for Media Encryption 477
Verifying and Configuring the Cryptographic Database . . . . . . . . . . . . . . . 478
Configuring the Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Requirements for Applications Server Installation . . . . . . . . . . . . . . . . . . . 479
Configuring the Key Storage Manager Server . . . . . . . . . . . . . . . . . . . . . . 480
Defining KSM Synchronization Intervals . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Defining an IIS User Identity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Contents 12
20
Media Encryption Maintenance 497
Maintaining Master Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
Maintaining Database Master Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
Changing the Password of the Database Master Key . . . . . . . . . . . . . 498
Backing Up the Database Master Key . . . . . . . . . . . . . . . . . . . . . . . . . 499
Backing up the Database Master Key Encryption Password . . . . . . . . 500
Backing Up the Service Master Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Restoring Encryption Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Restoring the Service Master Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Restoring the Database Master Key . . . . . . . . . . . . . . . . . . . . . . . . . . 502
Re-encrypting the Database Master Key by a New Service Master Key . .
503
Backing Up and Restoring the Cryptographic Database . . . . . . . . . . . . . . 504
Backing Up the Transactional Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Restoring a Complete Database (Full Recovery Model) . . . . . . . . . . . . . . 505
Backing Up the Tail of the Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
Restoring the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
21
Playback to Extension and Dial Plan Configuration 509
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Contents 13
22
Customer Feedback Configuration 543
Defining Feedback Ports on a Telephony Services Server . . . . . . . . . . . . . 545
Initial Setup Procedures for Customer Feedback . . . . . . . . . . . . . . . . . . . . 553
Avaya Interfaces: Defining Routing Parameters . . . . . . . . . . . . . . . . . . . . 553
Defining General Parameters for Customer Feedback . . . . . . . . . . . . . . . 555
Defining a Retention Period for Voice Comments . . . . . . . . . . . . . . . . . . . 557
Configuring Customer Feedback Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Analog Interfaces: Configuring Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
H.323 Interfaces: Configuring Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
SIP Extension Interfaces: Configuring Ports . . . . . . . . . . . . . . . . . . . . . . . 565
SIP Trunk Interfaces: Configuring Ports . . . . . . . . . . . . . . . . . . . . . . . . . . 570
What are Extension Identifiers and When to use them . . . . . . . . . . . . . . . 573
Recording Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
Integrating Prerecorded Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
Listening to a Recorded Survey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
Contents 14
23
Configuring for System Streaming 591
Choosing a Stream Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 593
Scenario 1: Streaming Disabled at Local Site (Default configuration) . . . . 593
Scenario 2: Server at Player Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Scenario 3: Server at Logger Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Scenario 4: Server to Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Scenario 5: Server at Player Site for Remote Interactions Only . . . . . . . . 598
Scenario 6: Server to Server for Remote Interactions Only . . . . . . . . . . . . 600
Scenario 7: Server at Player Site for Local Interactions Only . . . . . . . . . . 601
Configuring System Streaming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Enabling Stream Server Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Configuring the Default Stream Server Definition . . . . . . . . . . . . . . . . . . . 605
Optional - Defining a New Stream Server . . . . . . . . . . . . . . . . . . . . . . . . . 606
Defining System Streaming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Disabling System Streaming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Viewing All Stream Server Configuration Information . . . . . . . . . . . . . . . . 610
Maintaining the Stream Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Modifying the Stream Server Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Deleting a Stream Server Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
24
Configuring for WMS Streaming 613
Configuring Windows Media Server Streaming . . . . . . . . . . . . . . . . . . . . . . 614
Contents 15
25
Configuring Screen Content Analysis 629
Defining the Screen Content Analysis Server . . . . . . . . . . . . . . . . . . . . . . . 630
26
Configuring Storage Center 633
Defining a Storage Center. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Procedure 1: Defining the Storage Center Server . . . . . . . . . . . . . . . . . . . 634
Procedure 2: Defining Storage Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
Procedure 3: Defining a Storage Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
Guidelines for Using the Storage Size Calculator . . . . . . . . . . . . . . . . 650
Viewing Storage Groups and Storage Units . . . . . . . . . . . . . . . . . . . . . . . 651
Procedure 4: Defining an ESM Device . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Defining EMC Centera as the ESM Device . . . . . . . . . . . . . . . . . . . . . 652
Defining TSM as the ESM Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
Defining NetApp Snaplock as the ESM Device . . . . . . . . . . . . . . . . . . 657
Modifying Storage Center Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Deleting a Storage Center Component . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Contents 16
28
Installing the Media Library 667
Configuring the Media Library Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Defining Media Library Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Deleting a Media Library Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
29
Configuring Playback Organizer (PBO) 675
Configuring the PBO Request Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
Configuring Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Configure the Approval Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Configure the Completion Comment Form . . . . . . . . . . . . . . . . . . . . . . . . 679
Configure the Approval Comment Form . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Configure the Rejection Comment Form . . . . . . . . . . . . . . . . . . . . . . . . . . 679
30
Network Management System (NMS) Configuration 681
Defining the NMS via System Administrator . . . . . . . . . . . . . . . . . . . . . . . . 683
Modifying the NMS Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Deleting the NMS Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
31
Defining VoIP Recording Gateway (VRG) 689
Guidelines for Defining VRG Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Where are the VRG Definitions Saved? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
General VRG Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
Defining a New VRG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
Tips for Configuring Interaction-Based Recording with VRG Redundancy . 706
Contents 17
32
Interfacing NICE Perform with Microsoft Active Directory 713
Active Directory in your NICE Perform System . . . . . . . . . . . . . . . . . . . . . . 714
Background Information about Active Directory . . . . . . . . . . . . . . . . . . . . . 714
Prerequisites for Active Directory Authentication . . . . . . . . . . . . . . . . . . . 716
Confirming the Existence of Trusted Domains . . . . . . . . . . . . . . . . . . . . . . 717
Switching to Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
Maintaining your Active Directory Environment . . . . . . . . . . . . . . . . . . . . . 725
Modifying Active Directory Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 725
About the SuperUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
Changing the Active Directory SuperUser . . . . . . . . . . . . . . . . . . . . . . 727
Adding a Domain to Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
Removing a Domain from Active Directory . . . . . . . . . . . . . . . . . . . . . . . . 728
Locating Users defined in a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Validating Users in Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Uploading a User Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Troubleshooting Active Directory in your NICE Perform System. . . . . . . . 731
Common Active Directory Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
A
Working with Multi Data Hubs 733
Multi Data Hub Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
Multi Data Hub Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
Procedure 1: Setting Up the Primary Data Hub . . . . . . . . . . . . . . . . . . . . . . 737
Procedure 2: Setting Up a Secondary Data Hub . . . . . . . . . . . . . . . . . . . . . 738
Procedure 3: Connecting the Data Hubs . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Procedure 4: Linking the Data Mart to a Secondary Data Hub . . . . . . . . . . 743
Procedure 5: Defining Replication Between Data Hubs . . . . . . . . . . . . . . . 745
Defining Replication with SQL Authentication . . . . . . . . . . . . . . . . . . . . . . 745
Defining Replication with Windows (NT) Authentication . . . . . . . . . . . . . . 748
Procedure 6: Completing the Multi Data Hub Definition . . . . . . . . . . . . . . . 751
Contents 18
C
CLS Configuration Parameters 757
TRS (Basic Recording) Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
CLS Monitor Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
SNMP Agent Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Dispatch Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Call Server Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Log Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
DB Server Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Recording Decisions Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
General Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
RCM Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
D
Enabling Display of NICE System Information in the Summary Page
775
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Common Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
Verifying the System Administrator User . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Adding the System Administrator User to Computers not in an Active
Directory Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
Installing WMI Windows Management Instrumentation . . . . . . . . . . . . . . . 783
Editing DCOM Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Setting Security Permissions through the WMI Control . . . . . . . . . . . . . . . 791
Contents 19
Contents 20
IMPORTANT
This guide provides instructions for full functionality of the NICE Perform System Administrator.
Availability of functions is dependant on your site license and configuration.
The System Administrator application is used to setup and define the different parts of your NICE
Perform system, enabling communication between each component. After installing a component
in your system, it must be defined using the System Administrator.
Most procedures are one-time procedures performed as part of the installation process for each
component. The site administrator retains permission to view settings and edit components as
necessary.
Installing hardware or software components does not make them a working part of your system.
Every component must be defined using the System Administrator.
Contents
IMPORTANT
This guide does not provide a workflow for setting up your NICE Perform system! Use this guide
as a reference guide for specific configuration procedures. For a system workflow, see the Site
Installation Workflow Guide.
Most procedures are one-time procedures performed as part of the installation process for each
component. The site administrator retains permission to view settings and edit components as
necessary.
Installing hardware or software components does not make them a working part of your system.
Every component must be defined using the System Administrator.
• Expand the Organization tree and click a component to display its details.
• In several branches, an Undo button appears next to the Save button . Use this
button at any time to undo changes made since your last save.
• When you select a branch in the Organization tree, a list of all it components appears in the
details pane. Double-click an entry to open its details.
Select
Logger
Servers
All Loggers
appear in the
details pane
Overview
The Summary page allows the user to save a file of, or print a list of, all current resources. This
feature enables the user to provide an accurate snapshot of the system’s current resources when
requesting Customer Support.
IMPORTANT
Changes that are made in the system configuration, such as adding a new component or
installing an update, are not automatically reflected in the Summary page. If there are recent
changes, you need to refresh the Summary page to see them. See Refreshing the Summary
Page on page 26.
NOTE:
• When you open the Summary page for the first time, click Refresh All to populate
the page.
Refreshing the Summary pages can take several minutes. This is because the
system has to gather information from each component.
• After updating a specific component, right-click the component and select Refresh
to update the Summary page.
In the Last Successful Update column, the time and date are updated.
NOTE:
If the component details are not refreshed, an Incomplete Data error message
appears. See below:
When this occurs, check the date in the Last Successful Update column to see which
components did not refresh. For each component, verify the following:
• DCOM and WMI permissions were set properly on the component’s machine.
• The component is accessible.
The Summary page is automatically updated at regular intervals.
General Tab
The General tab provides information about the entire Organization according to the following
components:
• Applications - Expand this item for more information. The Applications Suite is defined for
either Enterprise (Call Center) or Compliance.
Expanded
Applications Suite
• Number of Users indicates how many users in the Users Administrator application are
defined as system users. This number is determined using the following criteria:
• Users who are system users (including users who are both a system user and an agent)
• All default users that are system users
• Number of Agents indicates how many users in the Users Administrator application are
defined as agents. This number is determined using the following criteria:
• Users who are agents (including users who are both a system user and an agent)
• All default users that are agents
• Agents with more than one agent ID are only counted once.
Chapter 1: System Administrator Overview 27
• Deleted users in retention indicates system users who were deleted but are still within
the retention period (even if deleted users are not shown in the application).
• Deleted agents in retention indicates agents who were deleted but are still within the
retention period (even if deleted agents are not shown in the application).
• Licensing - Expand this item to view all purchased features that are included in the NICE
Perform license.
All installed Serial Numbers appear in the License Keys section.
Expanded License Keys
License
Serial Numbers
• NMS - The Network Management System (optional). The machine where the NMS is installed
and its current version. There is only one NMS per Organization.
• Data Hub - Expand this item to view a list of all Data Hubs in the Organization. Each Data
Hub is either a Master (Primary) or Secondary Data Hub.
Expanded
Data Hub
• Reporter - The machine where the Reporter is installed and its current version. There is only
one Reporter per Organization.
• Data Mart - The machine where the Data Mart is installed and its current version. There is
only one Data Mart per Organization.
In the Servers View tab, each Data Hub is listed separately. Each physical machine for each Data
Hub is itemized. Expand a machine to view a list of all components installed on that machine.
All components appearing in the Servers View also appear in the Components View.
In the Components View tab, each Data Hub is listed separately. Expand a component, to view a
list of each component of its type and the location of where it is installed.
All components appearing in the Components View also appear in the Servers View.
NOTE: For CTI components, Update and Update Pack information only appears under
the Connection Manager, even though the other components were updated as well.
Technician Mode will remain activated until you Log off, even if you open a different
application.
EXAMPLE:
Use business data fields for information such as Customer Name and Account Number.
EXAMPLE:
Your switch provides the Client Location. During driver setup, the Client Location is mapped to
Optional ID field 7. (Step 1)
Define a Reserved Column in the database called Other Location.(Step 2)
During CLS configuration, map Other Location to Optional ID field 7. (Step 3)
The Client Location from the switch now appears in the NICE Perform column called Other
Location. You can access this column throughout the NICE Perform system. (Step 4 and Step 5)
IMPORTANT
If Business Data fields are not mapped in the CLS definition (Step 3 above), the information is
still stored, but you will not be able to access it from other applications, such as the Business
Analyzer.
Some of the components in your system (hardware and/or software) require licenses. Each
component requires its own separate license. Licenses are obtained from NICE at the time of
purchase and are activated via the System Administrator.
Contents
Licensing Overview
Some of the components in your system (hardware and/or software) require licenses. Each
component requires its own separate license. Licenses are obtained from NICE at the time of
purchase. A license consists of a Serial Number and a License Key. You will need to assign or
update licenses in the following situations:
• When you add a new component that requires licensing.
• Each time you add a feature to an existing component that requires licensing.
Separate licenses are issued for each type of resource. Each license is valid for one resource.
EXAMPLE:
The Applications Suites requires an Applications license, each Logger requires its own Logger
license, each Telephony Service requires its own Telephony Services license, etc.
If you have four Loggers, you will require four separate Logger licenses.
When a license is assigned to a resource, the resource name that appears in the System
Administrator Organization tree, also appears in the license list.
There are two types of licenses:
• Permanent - This type of license does not expire. It needs to be updated only if additional
features are added to its component. If a new Permanent license is not immediately available
for the new features, the Permanent license can be extended temporarily to include the new
features using a Temporary license. A Temporary license added to a Permanent license cannot
be renewed. Logger licenses cannot be updated with a Temporary license.
• Temporary - Temporary licenses can be issued by NICE personnel during installation
procedures if a Permanent license is not yet available. Temporary licenses have the following
characteristics:
• A Temporary licence is valid for up to 30 days.
• The Temporary licence for each component can be renewed one time only.
• A Temporary licence that expands a Permanent license cannot be renewed.
• A Temporary license that is replaced with a Permanent license before the Temporary
license reaches expiration, can be used again for its remaining allotted days.
There are three ways to apply a license:
• Directly from the text file in which you received them. To do this, in the License window, click
From File. You then browse to the location of the license file. The Load License window
opens and displays only those licenses relevant to the component and currently available.
• From the Available Keys list in the License window. To do this, you must first import the
license file. Then, when you open a License window, only those licenses that are relevant to
the component and currently available will appear in the Available Keys list.
• Enter the Serial Number and License key directly into the License window.
The following license changes can be made in the Temporary License window:
• Temporary licences that are assigned to a resource can be extended. This applies only to
Temporary licences that have not yet been extended or that are not extending a Permanent
license.
• A Temporary license can be added to a Permanent license to allow a new feature.
• Invalid licenses can be replaced.
2. See Updating a License and using the License Window on page 37 for instructions on using
this window.
3. If you are updating the Applications license, log out of the Applications Suite and then log in
again to activate the new license. All other licenses are effective immediately
4. Click OK to close the Temporary License window.
IMPORTANT
When updating the Applications license, and adding or removing PBO, you must restart the
PlaybackAdministration service.
NOTE: To update the license for the Applications Suite, right-click the License
Manager branch and select Update License.
-or-
• Select a component in the Organization tree. Then from the Actions menu, select Update
License.
-or-
• In the Show License Keys window or the Temporary License window, right-click a row
and select Update License.
The location from where the License window is opened determines which type of license
is being updated.
Example: If you open the License window from the Storage Center Servers branch, only
Storage Center licenses will be available in the License window.
-or-
• Click From File. An Open window appears.
a. Browse to and open the TXT file that contains the license. The Load License Key
window appears. Only the licenses relevant for the resource and that are either
available or in use appear. If none of the licences meet with these criteria, a message
appears.
b. Select an available license. Then click Select. The Serial Number and License Key
automatically appear in the appropriate fields.
c. Click OK.
2. In the Components pane, from the Actions menu, select Show all Licenses
-or-
Right-click a Data Hub branch and select Show All Licenses.
The Show License Keys window appears.
Importing Licenses
As your NICE Perform system grows, you will acquire many NICE Perform licenses. Licenses can
be stored in separate text files as you receive them. When you need to assign a license, you will
have to locate the correct text file.
NICE Perform provides the option of importing license files into your NICE Perform system.
When licenses are imported, the Available Keys field in the License window selects the licenses
from the all the imported files that meet the following requirements:
• Relevant to the current component
• Currently unassigned and therefore available
All licenses (Temporary and Permanent) will only be activated from the time they are assigned,
not from when they are imported.
To import licenses:
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
In the Import License Keys window, the Resources Name column shows the Resource Type.
Temporary licenses show the allotted number of days in the Days Till Expiration column.
4. Click Import. This will import all of the licenses that are valid and render them ready for use.
Each license will only become active when you update the relevant license.
Each time you open a license window, only the licenses available for that component appear.
5. Click Close.
When you open a license window, all Serial Numbers for the relevant component will be
available in the Available Keys field.
Example: If the Import file has four keys for Telephony Services and three keys for NiceLog
Loggers, when you add a new Telephony Service, only the four Telephony Services keys will
appear in the Available keys list.
The first step to configure your system is to define the Database Servers. You must install each
database on an SQL Server prior to defining it in the System Administrator. After all the databases
are defined, create links between the interaction database and the databases that reside on other
servers.
NICE Perform supports the following types of SQL security authentication:
• Windows Authentication - The SQL Server is authenticated using the Windows Login.
• SQL Authentication - The user defines a password when installing the SQL Database Server.
Contents
Required Databases
Database Description
nice_admin The Administration database. Contains information such as all
user/agent details, administrative settings, and privileges.
Information from the Users Administrator and System
Administrator are stored in this database.
nice_audit Contains a record of actions in the system for use by the Audit
Trail in Business Analyzer. For example, agent login and report
requests.
nice_interactions The Interactions database. Stores identifying information about
each interaction. For example, Start time and agent ID. The
actual recordings are stored on the Loggers. This database must
link to all the other databases for Query searches.
nice_rule Contains information from the Rules Manager.
Database Description
nice_as_kpi* Optional database for use with My Universe.
nice_as_my_universe* Required for use with My Universe.
nice_as_text_analysis* Required for use with ClearSight.
nice_ca Contains Audio Analysis information. Required for use with
Business Analyzer.
nice_crypto Serves as a repository for encryption keys for the NICE Key
Storage Manager (KSM) application.
nice_cti_analysis Contains information from your switch used by Business
Analyzer and not included in the nice_interactions database.
nice_dw Required for use with Data Mart.
nice_ib Required for use with Playback Organizer.
nice_pbs_data Required for use with the Playback Server.
nice_qa Required for use with Coaching and Clips in the Business
Analyzer.
• SQL Authentication - The user defines a password when installing the SQL Database Server.
The Authentication Mode is displayed above the Database Server Name. It is disabled and is
for informative purposes only. The authentication method is determined during SQL Server
setup. However, the SQL Management Studio enables you to switch between SQL and
Windows Authentication even after installing the SQL Server. For details see the SQL Server
for NICE Perform Guide.
3. From the Actions menu, select New Database Server. The Add Database Server Wizard
starts.
4. Enter the Database Server Name and the Host Name of the computer where it is installed.
5. For environments with Windows (NT) authentication, the Windows Login ID is used. You do
not have to supply a password.
-or-
For environments with SQL authentication, in the Security Settings area, enter the nice sa
password and the nice password of the SQL server.
6. Click OK.
The General tab of the Database Server details appears.
8. Click Save .
9. If your site has an NMS installed, add the new Database Server to the NMS monitored list:
a. In the Organization tree, expand Network Management System and select an NMS.
Click the Monitored Server tab.
b. Move the new server from the Available Servers list to the Attached Servers list and
click Save .
10. For additional Database customization options, see Managing Databases on page 50.
Managing Databases
Once the databases are installed and defined, you can do the following optional customizations to
enhance your system’s performance:
• Create Business Data fields with customized information. For example, customer account
number. See Reserved Columns for Business Data on page 50.
• Increase speed when using customized columns as search criteria. See Indexing Reserved
Columns and Business Data Fields on page 54.
• Customize the column headings in other applications. See Changing Column Names - Using
Aliases on page 55.
• Lock/unlock data fields throughout the system. See Activating/Deactivating Data Columns
on page 57.
• For environments with SQL authentication, you can change SQL passwords. See Added
Security for SQL Server Authentication - Changing Passwords on page 58.
NOTE: The system is installed with data fields ready-for-use. Use this procedure only
when further customization is necessary.
The nice_interactions database contains information about each interaction. Each piece of
information is known as a column. For example, Start Date, Start Time, and Agent ID.
Reserved columns are fields that are customized for your site. They include:
• Information that is made available by the driver installed in your system. For example, client ID.
• Scorecard and Classification rule results. These columns are created automatically whenever a
new Scorecard or Classification rule is created in the Rules Manager.
• Business Data fields - procedures for creating these are described in this section.
Reserved columns that are used as search items can be given index properties to increase search
performance. This includes both reserved columns added in this section and reserved columns
created elsewhere. To index a reserved column, continue with Indexing Reserved Columns and
Business Data Fields on page 54.
For a description of the flow of Business Data, including examples, see Using Business Data
Fields on page 31.
Adding Reserved Columns on page 51 describes defining Reserved Columns.
Reserved columns that are used for Business Data fields require specific conditions as follows:
Business data fields were mapped during driver setup to Optional ID fields. Each Optional ID field
has a fixed size. The Reserved Columns you are now creating will be mapped to these same
Optional ID fields in order to receive the data they contain from the switch. Therefore, each
reserved column must be equal to or larger in size than the Optional ID field to which it will be
mapped.
Obtain a list of defined Optional ID fields and their contents. This will help you determine the type
and size of each reserved column that you are creating. For example, Optional ID field 8 contains
the Customer Name; Optional ID field 3 contains the Credit Card account number; etc.
IMPORTANT
• Some integrations have predefined Optional IDs assigned. Create Reserved Columns that
will be mapped to these fields during CLS configuration. See the relevant driver guide for
each switch for a list of predefined Optional IDs.
• If your site uses an Avaya TSAPI CTI Link, see NICE Perform Integration with Avaya
TSAPI for Supported Business Data Fields.
• Mapping Reserved columns to Optional IDs is described in Mapping Business Data
on page 172.
There are 32 Optional ID fields. The type and size of each field is as follows:
7, 8 Text 30
EXAMPLE:
(Business Data) You are creating a reserved column for the Customer Address received from the
switch. The length of the Customer Address is 60. During driver setup, the Customer Address is
mapped to an Optional ID field that is size 80.
Define a reserved column called Customer Address as text size 80.
b. In the Alias Name field, enter the name of the new field as it will appear in other
applications. Spaces and special symbols are allowed. This field cannot be named
“name” (the Alias “name” is already in use by the system).
c. In the Column Type drop-down list, select a format for the new field. Columns defined as
DateTime cannot be used for business data.
d. If you selected Text in the Column Type drop-down list, specify a Size.
The new column is added to the interaction database. If this is a frequently queried column,
you can increase query speed by adding a index to the column, continue with Indexing
Reserved Columns and Business Data Fields on page 54.
4. To complete Business Data Setup, See Mapping Business Data on page 172.
NOTE: The system is installed with the indexes ready-for-use. Use this procedure
only when further customization is necessary.
Columns that are queried frequently can be given index values to increase query speed. You can
index any reserved column (both those that you created manually and those provided by the
system).
2. Select the required column and click Indexes. The Index Wizard starts.
b. Enter an Index Name and select the desired columns for that index.
TIP: The order of the columns affects the efficiency of the index. Use the Down and Up
buttons to prioritize selected columns.
c. To save this index entry and create another one, click Save and repeat Step b.
-or-
To save this index and close this window, click OK.
NOTE: The system is installed with Alias Column Names ready-for-use. Use this
procedure only when further customization is necessary.
All documentation refers to the predefined column names. You can change the names of any
column as needed.
Each column can be identified by two different names:
• A user-friendly column name that is predefined in the system. It is called the Alias Column
Name. You can customize this name as needed.
• An internal column name which is a combination of the table name and data name. This name
cannot be changed.
Each database contains several tables with numerous fields (columns). To identify a column in
other applications such as the Business Analyzer or Playback Organizer, Rules Manager, and
Users Administrator, you would need to know the combination of its database, table name, and
internal column name. Internal column names are often duplicated between tables to unite bits of
information. The System Administrator comes with user-friendly column names for each field.
These user-friendly column names are known as Alias Column Names. Alias Column Names
appear as column headings in the Business Analyzer or Playback Organizer and wherever data
must be accessed directly by the user. You can customize the Alias Column Names by accessing
the Administrator database. The Columns tab is active for the Administration database only.
EXAMPLE:
Locate iAgentId in the Column Name column and define its Alias Column Name as
Agent ID. You will now see Agent ID wherever this field appears, such as in the Business
Analyzer or Playback Organizer and the Rules Manager.
To rename a Column:
1. In the Organization tree, select the Database Server on which the nice_admin database is
installed and click the Columns tab.
The Column Details appear.
4. Click Save .
The new Alias Column Name will appear in other applications such as in the column
headings of the Business Analyzer, Monitor, and Playback Organizer.
NOTE: In order for the columns to appear in the Business Analyzer, Monitor, and Playback
Organizer, they must also be selected in the relevant places in each application.
NOTE: The system is installed with the data fields ready-for-use. Use this procedure
only when further customization is necessary.
Each data field can be activated or deactivated separately for viewing, editing, and querying
ability. Activating and deactivating data columns is done by accessing the Administrator database.
The Columns tab is only accessible for the Administration database.
To view/edit/query a data column in other applications,
• The user must be given privileges to view/edit/query the data via the Users Administrator.
• The column must be appropriately selected in the application. For example, in the Business
Analyzer and Playback Organizer, you display columns using the Preferences window.
3. To allow view, edit, and query privileges to be granted for a column, select the appropriate
Viewable, Editable, and Queriable checkboxes.
4. Click Save .
IMPORTANT
This section is relevant only for systems using SQL authentication. See Which method of SQL
Server Authentication is in use? on page 46.
As a measure of added security, NICE Perform provides you with the ability to change the
passwords for your SQL server. There are two different levels of passwords.
nice sa login password - this password is of very high level and is for all SQL servers, at all sites.
In a Multi Data Hub environment, changing this password at one site automatically changes it for
all sites, provided that the System Administrator is running at the master site and at each secondary
site.
nice login password - this password can be changed separately for each SQL server. It is used to
access SQL database information.
These passwords are used internally. Changing them from time to time adds security to your
system. Both passwords are saved in each SQL server.
To change the nice sa login password, continue with Changing the nice sa Login Password
on page 58.
To change a nice login password for an individual SQL server, continue with Changing a NICE
Login Password for an Individual SQL Server on page 60.
IMPORTANT
• The nice sa password is identical for all SQL servers defined at your site. In a Multi Data
Hub environment, the nice sa login password is identical for all SQL servers at all sites.
• If you change the nice sa login password, save it in a safe place. If you add additional SQL
servers, or define another site, you will need to use this same nice sa login password.
3. From the Actions menu, select SQL Server Security. The SQL Server Security window for
nice sa Login appears.
4. Enter the new NICE sa Password (twice). Maximum password length is 14.
-or-
To use a blank password, select Blank Password.
IMPORTANT
Leaving the Password field empty is not the same as a blank password. If you want the
password to be all blanks, select the Blank Password checkbox!
5. Click OK.
The nice sa password is changed for all SQL servers defined across all sites of your NICE
Perform system.
6. Restart the System Administrator service.
7. In a Multi Data Hub environment, resubscribe the servers. See Defining Replication with
SQL Authentication on page 745.
IMPORTANT
At the end of this procedure, you will be instructed to recreate the links between the sites
in the Data Mart! This is relevant for both single-site and for Multi Data Hub environments.
Each SQL server has its own nice login password. This is in addition to the nice sa login password.
It is used internally to access the SQL server. Changing the passwords of SQL servers where your
databases reside provides additional security to your system and data.
1. Select a Server
2. From the Actions menu, select SQL Server Security. The SQL Server Security window for
Nice Login appears.
3. Enter the new NICE Password (twice). Maximum password length is 14.
-or-
To use a blank password, select Blank Password.
IMPORTANT
Leaving the Password field empty is not the same as a blank password. If you want the
password to be all blanks, select the Blank Password checkbox!
4. Click OK.
5. In the Organization tree, expand the Data Mart branch, select the Data Mart and then click the
Sites tab. In a Multi Data Hub environment, do this on the Master Site only.
NOTE: The Replication tab accessed in this procedure is active only on the Master
site and only for the Administrative database.
3. Select the servers where the password will be changed and click Uninstall. A message
window appears.
4. Click OK.
5. Return to Changing the nice sa Login Password on page 58.
3. Click Save .
WARNING
Uninstalling a component without deleting its definition can cause your NICE system to
malfunction.
Uninstalling a database server does not automatically remove its definition from your site. You
must delete the database server’s definition using the System Administrator.
It is recommended that you do this procedure before uninstalling the Database server so that you
do not temporarily leave invalid paths in your site configuration.
2. Click Delete .
If you want to change the backup location to a remote destination on the network, follow these
guidelines:
• The location can be a local drive, however if the server fails, the backup file will be lost and
the database cannot be restored. Therefore we recommend choosing a remote destination on
the network.
• When defining a remote destination on the network, the location path must follow UNC
conventions. Type the full path to the location. Do not use a mapped drive.
• The SQL Server and the SQL Server Agent Service must have read/write privileges to the
remote destination. In a domain environment, the SQL Server service must run under a
domain user account with proper access privileges to the remote destination. To verify that the
SQL Server has proper access privileges, run the test in the Backup Destination window.
2. To change a backup job schedule, select a backup job and click Edit Schedule .
Mark the day(s) and specify the time for the backup to run. Then click .
3. To change the destination of the backup files, select a backup job and click Edit Job
Destination . The Backup Destination window appears.
a. Select Disk/Network.
b. In the Location area, type the full path for the backup files. The location must be
accessible by the user running the SQL Server service.
c. If you are backing up to a remote destination, test the path: In the Test area, type the Login
ID and Password for the SQL server and click .
d. Click .
4. Click Save .
EXAMPLE:
You want to restore the nice_admin database.
One Full Backup and two Differential Backup jobs ran.
1. In the Enterprise Manager, open the Restore database window.
2. Mark the Full Backup job and the last Differential Backup job.
3. In the First backup to restore field, choose the Full Backup job.
2. To run a backup job, select a backup job and click Start Job . The backup job begins
running. When the job is complete, its final status appears in the Last Run Outcome column.
3. To stop a backup job that is currently running, select the backup job and click Stop Job .
To disable a backup job’s schedule, select a backup job and click . The backup
job will not run again until it is enabled.
4. To enable a backup job’s schedule, select a backup job and click . The backup
job will run according to its next scheduled time.
As part of your site configuration, after installing a Logger, each must be defined in the System
Administrator. These procedures are applicable for NiceLog Loggers, including Interaction
Capture Units, Playback Unit (retrieval) Loggers, and Spare Loggers.
Contents
2. Verify that your Logger is completely installed and running. Proceed to Defining a NiceLog
Logger on page 71.
IMPORTANT
The availability of options is determined by your specific Logger configuration. Features that are
not available are either disabled or will not be displayed in System Administrator.
Each Logger installed in your NICE Perform system must be defined using the System
Administrator.
The procedure for defining a new Logger includes the following:
• Naming the server and entering the IP address or Host Name of the Logger.
• Configuring Input Trunks.
• Configuring Input Channels.
• Defining Predefined Selective Recording.
• Configuring Global parameters that are not channel specific.
The Global parameters are described in the following table:
Automatic Determine what happens when the amount of available hard disk space on
Deletion a Logger falls below a certain level. The Logger can:
• (Default) Provide space for new audio by automatically deleting the
oldest recorded audio from the Logger after it has been archived.
-or-
• Stop recording new audio.
DTMF for When a call is placed on hold, the Logger stops recording and when the
Recording call is resumed, the Logger starts recording again. You define which
on Demand characters will be used to stop and start recording when using DTMF
(ROD) Recording On Demand with the telephone option. Stop and Start recording
parameters can also be based on tones from an Interactive Voice Response
(IVR) system.
DTMF codes are entered on the keypad by the agent.
Session Define the following Session Parameters:
Parameters
• How long of a period of silence is considered the end of a segment.
• The maximum length of a segment.
• How to handle a timeout.
DTMF DTMF numbers can be entered during the course of a phone call. For
Detection example, callers can enter their account numbers and other responses by
pressing telephone keys. Up to 48 DTMF digits can be saved with each
session. In cases where more than 48 DTMF digits are entered, select
whether to save the first 48 digits or the last 48 digits of the sequence.
Test Tones Define which time slots on each Logger are to be used for sending Test
tones. Test tones are continuously sent from the switch to the Logger in
order to check the Logger’s connections. This feature is available only
with an ISAC2 board.
Audio Define whether the Logger is using encryption for audio recordings.
Encryption
NOTE: After defining a Logger, add it to the CLS definition. If you have an NMS
Server installed at your site, add the Logger to the NMS monitored list.
1. Perform preliminary steps described in Before You Define Your Logger on page 70.
2. In the Organization tree, click the Logger Servers branch. Then from the Actions menu,
select New NiceLog.
TIP: To define other types of Loggers using these procedures, select the appropriate
Logger from the Actions menu.
The different branches serve as organizational folders only. Loggers that are defined
under the wrong branch (you selected the wrong Logger type), retain their own
attributes. For example, if you add a NiceLog Logger and enter the address of an
Interaction Capture Unit, the Logger definition will still be correct for an Interaction
Capture Unit, but the Logger will appear under the NiceLog branch.
The NiceLog Server License window appears.
• If your license key is on a file, click From File. The Licenses window appears.
Double-click
the relevant
licence
In the License Key list, locate and double-click your license key. The NiceLog Server
License window reappears with the relevant serial number and license key. Click OK.
• If your license key is not on file, enter the Serial Number and License Key for the
NiceLog Server and click OK.
Name Use a descriptive name. This name appears as the Logger name in the
Organization tree and is used for identifying the NiceLog Logger
elsewhere in the System Administrator.
Location Enter the Host Name or browse for the IP Address of the NiceLog
Logger.
The system connects with the Logger and the Logger Details appear in the General tab
displaying information in the Capacity and Advanced Configuration areas.
New NiceLog
Logger
added
4. Click the Global tab. The parameters that are not channel-specific appear.
5. To define Automatic Deletion (when the amount of available hard disk space on a Logger
falls below a certain level), select Delete oldest audio or Stop recording.
6. If you have DTMF Recording On Demand, enter codes for Start recording and Stop
recording.
The codes entered must be 2 digits with a pound sign (#) in the first, second, or third
position.
7. In the Session Parameters area, define how each session length is determined. Enter values,
in seconds, for each of the following:
Minimum Length Between Two segments of active audio are considered separate audio
Sessions segments if the specified number of seconds of silence is
detected between them.
Maximum Session Length The maximum number of seconds of active audio that can be
considered an audio segment.
Post Session Duration In case of a timeout (inactive audio), do not close the segment
until this amount of time has passed. If active audio resumes
within this timeframe, then continue with the same segment.
8. To define DTMF Detection, select Save first 48 digits or Save last 48 digits.
9. To define Media Encryption, in the Audio Encryption area, select Yes.
-or-
To turn off Media Encryption, in the Audio Encryption area, select No.
10. Click the Trunks tab and then move trunks between the Input Trunks Not Configured and
the Configured Input Trunks lists.
Test Tones
b. Select one or two time slots for each data line requiring test tones. Double-click a box to
select/clear it.
The numbers of the data lines directly corresponds to the numbers received from your
switch. Only time slots 0 and 62 can be used for test tones.
12. Click the Channels tab and then move channels between the Input Channels Not
Configured and the Configured Input Channels lists.
Click to
expand
Dataline connection
Trunk connection
NOTE: Dataline connections are created in the same manner. You enter
dataline/timeslot combinations instead of trunk/timeslot combinations.
3. To select input channels: In the trunk (or dataline) and timeslot columns, click a number and
a drop-down list appears. Select the trunk/timeslot (or dataline/timeslot) combination.
4. If summed audio is available, select a second trunk/timeslot combination in the Mate trunk
and timeslot columns.
5. Mark the checkbox in the Connected column for each assignment to complete the
connection.
IMPORTANT
If you do not mark the Connected checkbox, your settings will be saved, but there will not be a
connection to the input channel and the trunk/timeslot (or dataline/timeslot) combination will not
be validated.
Clicking Disconnect All clears the connected checkbox for all channels on all lists.
6. Click Save .
7. If you have not yet done so, continue with Integrating the Logger with Other Components
on page 80.
8. You can now define and map the audio recording channels. Proceed to Configuring Audio
Recording Channels on page 81.
Audio sources (such as telephones or microphones) are connected to input channels on the Logger.
Each input channel handles a single audio source. Audio sources are physically connected to input
channels via an audio input board on the Logger. This way each recording on the Logger contains
audio recorded from a single source.
IMPORTANT
Before you begin, familiarize yourself with which audio source is physically connected to which
input channel on the Logger. It is recommended to prepare a table of these connections when
connecting the audio cables to the NiceLog system.
Recording Channels Tree - Click a channel to define a name and/or view its details
TIP:
• To view a recording channel’s configuration settings, double-click the recording
channel.
• To switch to another recording channel’s configuration settings, click the channel in
the Recording Channels tree.
• To define a Channel name for a recording channel, open it’s configuration settings.
• To return to the Recording Channels list, click Recording Channels in the
Recording Channels tree.
2. Click Setup. The Input Channels Configuration Wizard starts.
4. Select one or more input channels to configure. Then click Next. The Select Features to
Configure window appears.
5. Mark the features that you want to configure for all the selected input channels. Then click
Next.
NOTE:
• Features that are not available for all selected channels cannot be selected.
• Features that you do not select will not appear, or will be disabled for the rest of
this wizard.
• Some features cause recording to stop for the selected input channels during
configuration. Recording resumes automatically when configuration is complete.
6. If you marked Activity Detection or Activity Statistics, the following step appears.
Complete the active areas as follows, then click Next.
EXAMPLE:
If you specify for an audio input channel, the Max. activity rate as 85% and the Max. rate period
as 2 hours, and Activity Detection detects that the channel is active 90% of the time during a two
hour period, the Activity Statistics alarm will activate.
8. If your marked Pre-Post Alarms or Warning Tones, the following step appears.
9. Click Next to start the configuration process. The confirmation window appears.
10. Click Yes. Depending on the features selected, recording stops on all selected input channels
that are currently recording or paused. Configuration begins.
When configuration is complete, recording restarts, to the same status (recording or paused),
on all stopped input channels and the final report appears.
TIP:
• To view configuration settings, in the Recording Channels list, double-click a
channel.
• To change configuration settings, in the Recording Channels list, click Setup.
Audio Activity is determined by the combined Audio Detection and Audio Statistics settings.
Audio activity determines the type of audio activity (i.e., Energy, VOX, etc.) that is recorded on
each channel.
To set audio activity, you will have to set the following parameters.
Activity Detection: Select Mode (what type of activity will be recorded) and Threshold (the
noise level at which activity is recognized). For details, see Guidelines for Configuring Activity
Detection on page 89.
Activity Statistics: Set minimum and maximum levels so that if the amount of activity reaches
below or above these levels, an Activity Statistics alarm is triggered. These levels are computed by
averaging the amount of activity over a period of time. They do not report a temporary change in
activity level, as these changes occur naturally between recording sessions. For details, see
Guidelines for Configuring Activity Statistics on page 91.
EXAMPLE:
If Activity Statistics alarm settings are set for 85% activity rate over a two hour period, and the
Activity Detection detects that the channel is active 90% of the time during a two hour period,
the Activity Statistics alarm is activated.
Activity detection is how you define what type of audio is recorded on the channel. Activity
detection is set separately for each channel so that you can select to record different types of audio
on different channels.
Only the defined active audio will be recorded on the Logger. By recording only one type of audio,
and not the periods of silence between active segments, you save hard disk space on the Logger
and archiving media space. Activity detection also enables efficient playback of audio, so that
silent segments can be skipped (compressed) and not reproduced during playback.
For each channel, you select a mode. All modes are described below.
For Energy and VOX audio, you will also define the threshold above which to recognize the
audio as active. The process for configuring and testing thresholds is described in Configuring
and Testing the Activity Detection Threshold on page 89.
Select from the following Modes:
Energy Based on average volume of the audio signal on the input channel. This
type of detector is supported in all system configurations and is
recommended for telephone inputs. The Energy detector, however, cannot
differentiate between line noise and voice signals with the same level.
External External trigger (such as a radio receiver’s squelch output) is connected to
the external activity detector input of the NiceLog Logger.
VOX (Optional) Recognizes the characteristics of human voice, and rejects all
other input audio so that only human voice is considered active.
On/Off Hook (Optional) For telephone inputs. Detects when the telephone is in use (OFF
hook) and not in use (ON hook). Audio on the input channel is recorded
only when the connected telephone is in use.
Energy, External Based on average volume of the audio signal on the input channel and is
connected to the external activity detector input of the NiceLog Logger.
None Disables Activity Detection for the selected audio input channel(s) so that
all audio input is recorded.
VOX and Energy require a threshold configuration. The threshold determines which audio is
considered active on the audio input channel and is based on the input volume of the audio relative
to the threshold.
Configuring this threshold must be done with great care, since it is critical to system performance
and reliability. Use the following Guidelines:
• A threshold level that is too low could cause silent audio segments to be recognized as active.
In this case, disk space is wasted, and silence compression during playback will not function.
• A threshold level that is too high could cause active segments to be considered silent. Since
silent segments are not recorded to the Logger’s hard disk when activity detection is enabled,
important audio data could be lost.
The following are the recommended activity detector threshold values:
For VOX (either a standard, HF or VHF detector), the recommended threshold is 50.
For Energy use the following table as a guideline.
Threshold 0 10 20 30 40 50 60 70 80 90 100
Vrms 0.07 0.2 0.5 1.5 4.1 11.5 32.5 91 250 720 2010
(in milliVolts)
It is also recommended that you perform a trial-and-error procedure to determine the optimal
threshold for the selected input channel(s).
NOTE: If you are configuring the threshold for multiple audio input channels with similar
input sources, monitor one of the audio input channels, and then for the remainder of this
procedure continue using only this audio input channel.
In Activity Statistics area you set minimum and maximum levels so that if the amount of activity
reaches below or above these levels, an Activity Statistics alarm is triggered. These levels are
computed by averaging the amount of activity over a period of time. They do not report a
temporary change in activity level, as these changes occur naturally between recording sessions.
For details, see Configuring and Testing the Activity Detection Threshold on page 89.
EXAMPLE:
If you specify for an audio input channel, the Max. activity rate as 85% and the Max. rate period
as 2 hours, and Activity Detection detects that the channel is active 90% of the time during a two
hour period, the Activity Statistics alarm will activate.
Max. activity rate (%) The maximum activity rate (1% to 99%) allowed for the channel. The
activity rate is the percentage of time that the channel is active.
Normally the maximum activity rate is 99%. This ensures that the
Activity Statistics alarm for the channel will only be activated if
active audio is detected 100% of the time during the Maximum
activity rate period.
Max. rate period (hrs) The reference period (1 to 72 hours) for the maximum rate check. If,
during the specified period, the activity rate on the selected audio
input channel is above the maximum rate, the Activity Statistics alarm
is activated (if enabled). Normally, a short period is appropriate (such
as one hour).
Min. activity rate (%) The minimum activity rate (1% to 99%) allowed for the channel. The
activity rate is the percentage of time that the channel is active.
Normally, the minimum activity rate is 0.1%. This ensures that the
Activity Statistics alarm for the channel will not be activated unless
no activity at all is detected during the Minimum activity rate period.
Min. rate period (hrs) The reference period (1 to 72 hours) for the Minimum Activity rate
check. If, during that period, the activity rate is below the minimum
rate, the Activity Statistics alarm is activated (if enabled). Normally, a
longer period is appropriate (such as 72 hours).
TIP:
• To view configuration settings, in the Recording Channels list, double-click a
channel.
• To change configuration settings, in the Recording Channels list, click Setup.
You can configure the following audio parameters for each channel:
• Session Creation Criteria - see Guidelines for Selecting Session Creation Criteria
on page 92.
• Compression Types - see Guidelines for Configuring Compression Types on page 93.
• Gain Control - see Guidelines for Configuring Gain Control on page 93.
Session Creation Criteria options are determined by the mode selected for activity detection on the
audio activity tab. See Guidelines for Configuring Activity Detection on page 89.
Available options for Session Creation Criteria is dependant on your Logger configuration.
Possible options for Session Creation Criteria are:
Activity Audio segments are defined by the level of activity on the telephone. For more
information, see Guidelines for Configuring Audio Activity on page 88.
API Opens a session on demand.
Idle
DTMF Creates sessions according to DTMF defined on the Audio Params tab.
On/Off Hook Creates sessions according to on/off hook activity.
The compression type is the rate at which audio is recorded on the audio input channel. This is
called the target compression. The compression types available are dependant upon site
configuration. Available compression types are:
The Gain Control allows you to specify an audio channel’s input level (gain) either automatically
or manually.
Select AGC to set Automatic Gain Control. This averages the volume level of the signal on the
audio input channel so that high and low volume audio from the source are recorded automatically
at the same volume level. For the best audio quality, input AGC should be specified when possible.
MGC (Manual Gain control) allows you to set the gain between the values of zero and 30 dB,
according to Logger configuration.
When configuring MGC, test recorded audio by playing a recording after configuring the input
level. Use the following guidelines:
• An input level that is set too low, causes the input audio to be recorded at a low volume,
emphasizing the background noise.
• An input level that is set too high, causes the audio input circuitry to operate above its nominal
limits (saturation), and the recorded signal is distorted.
NOTE: Input level configuration (AGC and MGC) has no effect on the activity detection
process.
4. Enter the Serial Number and License Key for the NiceLog Logger and click OK, or see
Managing Licenses on page 33. The Define NiceLog window appears.
TIP: The Browse button opens a window from which you can select a Logger.
At the bottom of this window is the following checkbox:
Mark this checkbox to display all responding Loggers (both defined and not defined).
Clear this checkbox to display only those responding Loggers that have not been
defined in the System Administrator.
5. Define the Logger as described below.
6. Click OK.
NICE Perform connects with the spare Logger and the Logger details appear with the General
tab displaying information in the Capacity and Advanced Configuration areas. Proceed to
Defining an N+1/1:1 Chain on page 146.
NOTE: The only fields of a Spare Logger definition that can be edited are the Logger
Name and Host Name/IP Address fields. This is because a Spare Logger is designed
to mimic the other Loggers in its chain.
2. In the Organization tree, select the Logger Servers branch and then select a Logger.
3. Modify the relevant fields. For details of available parameters, see Defining a NiceLog
Logger on page 71.
4. Click .
Uninstalling a Logger does not automatically remove its definition from your site. You must delete
the Logger’s definition using the System Administrator.
It is recommended that you do this procedure before uninstalling the Logger so that you do not
temporarily leave invalid paths in your site configuration.
2. In the Organization tree, select the Logger Servers branch and then select a Logger.
After you complete installing your Loggers, each must be defined in the System Administrator.
Contents
IMPORTANT
The availability of options is determined by your specific Logger configuration. Features that are
not available are either disabled or will not be displayed in System Administrator.
Automatic Determine what happens when the amount of available hard disk space
Deletion on a Logger falls below a certain level. The Logger can:
• (Default) Provide space for new audio by automatically deleting the
oldest recorded audio from the Logger after it has been archived.
or,
• Stop recording new audio.
Audio Define whether the Logger is using encryption for audio recordings.
Encryption
2. In the Organization tree, click the Logger Servers branch. Then from the Actions menu,
select New NiceLog.
The NiceLog Server License window appears.
• If your license key is on a file, click From File. The Licenses window appears.
Double-click
the relevant
licence
In the License Key list, locate and double-click your license key. The NiceLog Server
License window reappears with the relevant serial number and license key. Click OK.
• If your license key is not on file, enter the Serial Number and License Key for the
NiceLog Server and click OK.
4. Click OK.
NICE Perform connects with the Logger and the Logger Details appear in the General tab
displaying information in the Capacity and Advanced Configuration areas.
New NiceLog
Logger
added
5. Click the Global tab. The parameters that are not channel-specific appear.
6. To define Automatic Deletion (when the amount of available hard disk space on a Logger
falls below a certain level), select Delete oldest audio or Stop recording.
7. In the Session Parameters area, define how each session length is determined. Enter values,
in seconds, for each of the following:
Minimum Length Between Two segments of active audio are considered separate audio
Sessions segments if the specified number of seconds of silence is
detected between them.
Maximum Session Length The maximum number of seconds of active audio that can be
considered an audio segment.
Post Session Duration In case of a timeout (inactive audio), do not close the segment
until this amount of time has passed. If active audio resumes
within this timeframe, then continue with the same segment.
9. Click the Channels tab and then move channels between the Input Channels Not
Configured and the Configured Input Channels lists.
Audio sources (such as telephones or microphones) are connected to input channels on the Logger.
Each input channel handles a single audio source. Audio sources are physically connected to input
channels via an audio input board on the Logger. This way each recording on the Logger contains
audio recorded from a single source.
IMPORTANT
Before you begin, familiarize yourself with which audio source is physically connected to which
input channel on the Logger. It is recommended to prepare a table of these connections when
connecting the audio cables to the NiceLog system.
Recording Channels Tree - Click a channel to define a name and/or view its details
TIP:
• To view a recording channel’s configuration settings, double-click the recording
channel.
• To switch to another recording channel’s configuration settings, click the channel in
the Recording Channels tree.
• To define a Channel name for a recording channel, open it’s configuration settings.
• To return to the Recording Channels list, click Recording Channels in the
Recording Channels tree.
2. Click Setup. The Input Channels Configuration Wizard starts.
4. Select one or more input channels to configure. Then click Next. The Select Features to
Configure window appears.
5. Mark the features that you want to configure for all the selected input channels. Then click
Next.
NOTE:
• Features that are not available for all selected channels cannot be selected.
• Features that you do not select will not appear, or will be disabled for the rest of
this wizard.
• Some features cause recording to stop for the selected input channels during
configuration. Recording resumes automatically when configuration is complete.
6. If you marked Activity Statistics, the following step appears. Complete the active areas as
follows, then click Next.
• In the Activity Statistics area, mark Alarm enable to activate activity alarms. Set the
minimum and maximum activity rates and rate periods. For an explanation of Activity
Statistics and how the activity rate and rate period work together, refer to Guidelines for
Configuring Activity Statistics on page 113.
• The Activity Detection mode is automatically set to Energy. This mode and its threshold
cannot be changed.
EXAMPLE:
If you specify for an audio input channel, the Max. activity rate as 85% and the Max. rate period
as 2 hours, and Activity Detection detects that the channel is active 90% of the time during a two
hour period, the Activity Statistics alarm will activate.
7. If you marked Compression the following step appears. Complete the following information,
then click Next.
• In the Record Settings area, select a Compression Type and Record On Demand
Using DTMF option where applicable. For explanations of possible options, see
Guidelines for Configuring Compression Types on page 114.
8. Click Next to start the configuration process. The confirmation window appears.
9. Click Yes. Depending on the features selected, recording stops on all selected input channels
that are currently recording or paused. Configuration begins.
When configuration is complete, recording restarts, to the same status (recording or paused),
on all stopped input channels and the final report appears.
TIP:
• To view configuration settings, in the Recording Channels list, double-click a
channel.
• To change configuration settings, in the Recording Channels list, click Setup.
Audio Activity is determined by the combined Audio Detection and Audio Statistics settings.
Audio activity determines the type of audio activity that is recorded on each channel.
Activity Detection: Automatically set to Energy. This mode and its threshold cannot be changed.
Activity Statistics: Set minimum and maximum levels so that if the amount of activity reaches
below or above these levels, an Activity Statistics alarm is triggered. These levels are computed by
averaging the amount of activity over a period of time. They do not report a temporary change in
activity level, as these changes occur naturally between recording sessions. For details, see
Guidelines for Configuring Activity Statistics on page 113.
EXAMPLE:
If Activity Statistics alarm settings are set for 85% activity rate over a two hour period, and the
Activity Detection detects that the channel is active 90% of the time during a two hour period,
the Activity Statistics alarm is activated.
In Activity Statistics area you set minimum and maximum levels so that if the amount of activity
reaches below or above these levels, an Activity Statistics alarm is triggered. These levels are
computed by averaging the amount of activity over a period of time. They do not report a
temporary change in activity level, as these changes occur naturally between recording sessions.
EXAMPLE:
If you specify for an audio input channel, the Max. activity rate as 85% and the Max. rate period
as 2 hours, and Activity Detection detects that the channel is active 90% of the time during a two
hour period, the Activity Statistics alarm will activate.
Max. activity rate (%) The maximum activity rate (1% to 99%) allowed for the channel. The
activity rate is the percentage of time that the channel is active.
Normally the maximum activity rate is 99%. This ensures that the
Activity Statistics alarm for the channel will only be activated if
active audio is detected 100% of the time during the Maximum
activity rate period.
Max. rate period (hrs) The reference period (1 to 72 hours) for the maximum rate check. If,
during the specified period, the activity rate on the selected audio
input channel is above the maximum rate, the Activity Statistics alarm
is activated (if enabled). Normally, a short period is appropriate (such
as one hour).
Min. activity rate (%) The minimum activity rate (1% to 99%) allowed for the channel. The
activity rate is the percentage of time that the channel is active.
Normally, the minimum activity rate is 0.1%. This ensures that the
Activity Statistics alarm for the channel will not be activated unless
no activity at all is detected during the Minimum activity rate period.
Min. rate period (hrs) The reference period (1 to 72 hours) for the Minimum Activity rate
check. If, during that period, the activity rate is below the minimum
rate, the Activity Statistics alarm is activated (if enabled). Normally, a
longer period is appropriate (such as 72 hours).
TIP:
• To view configuration settings, in the Recording Channels list, double-click a
channel.
• To change configuration settings, in the Recording Channels list, click Setup.
You can configure the following audio parameters for each channel:
• Compression Types - see Guidelines for Configuring Compression Types on page 114.
The compression type is the rate at which audio is recorded on the audio input channel. This is
called the target compression. The compression types available are dependant upon site
configuration. Available compression types are:
4. Enter the Serial Number and License Key for the NiceLog Logger and click OK, or see
Managing Licenses on page 33. The Define NiceLog window appears.
TIP: The Browse button opens a window from which you can select a Logger.
At the bottom of this window is the following checkbox:
Mark this checkbox to display all responding Loggers (both defined and not defined).
Clear this checkbox to display only those responding Loggers that have not been
defined in the System Administrator.
5. Define the Logger as described below.
6. Click OK.
NICE Perform connects with the spare Logger and the Logger Details appear with the
General tab displaying information in the Capacity and Advanced Configuration areas.
NOTE: The only fields of a spare Logger definition that can be edited are the Logger
Name and Host Name/IP Address fields. This is because a spare Logger is designed
to mimic the other Loggers in its chain.
2. In the Organization tree, select the Logger Servers branch and then select a Logger.
3. Modify the relevant fields. For details of available parameters, see Defining and Configuring
a VoIP Logger on page 100.
4. Click .
Uninstalling a Logger does not automatically remove its definition from your site. You must delete
the Logger’s definition using the System Administrator.
It is recommended that you do this procedure before uninstalling the Logger so that you do not
temporarily leave invalid paths in your site configuration.
2. In the Organization tree, select the Logger Servers branch and then select a Logger.
Contents
• Total Active VoIP Channels by Device: Number of channels allocated by the Network
Embedded Logger license. See the Installer Checklist for this information.
• Source Side: Rx
• Static Mapping
Use the following procedure to define Channel Mapping.
3. In the Organization tree, navigate to Site > CLS Definitions > Channel Mapping > 1.
Channels Definition.
All Loggers that are attached to a CLS Server appear in the Channels Definition list.
4. Select the relevant Network Embedded Logger and click to expand its definition.
Select Active
Must remain
at zero
• Number of Total Active VoIP Channels by Device - Enter the number of channels
indicated in the Installer Checklist.
• Number of Selective Active Channels by Call - Must remain at zero.
7. Click Save to save the Channels definition. This saves changes, it does not apply them.
8. In the Organization tree, navigate to Site > CLS Definitions > Channel Mapping > 2.
Sources Definitions. Then select a switch and click to expand its definition.
All defined switches appear.
Import Edit
9. Select the relevant Physical Switch and click to expand its definition.
EXAMPLE:
You select to increment by Device Number. Each new source will have the next
sequential Device Number beginning with the value supplied in the Device Number
Details field. All of the devices will have the same Unique Device ID.
• Device Number Details - This is the actual extension number. Select Decimal or
Hexadecimal and then supply the first Device Number in the series.
and/or
Unique Device ID Details - This is the identification number of the physical device.
Select Decimal or Hexadecimal and then supply the first Unique Device ID in the series.
• Source Side - Select Rx (unsummed) - This means that input enters the Logger on two
separate sources. Note that only the Rx appears in the sources definition, Tx is not seen.
• Port Support - Select SinglePort or MultiPort.
The Amount of Active VoIP Devices window appears.
14. Enter the Number of Sources to create. The sources (Active VoIP Devices) will be
numbered consecutively. Then click Next.
EXAMPLE:
You select to increment by Device Number and define the following:
Device Number Details = 100
Number of sources = 3
Step = 1
Three sources are created as follows:
Device Number = 100
Device Number = 101
Device Number = 102
Note: The name field is filled only when sources are defined one-by-one. To add a name to a
source, double-click a row to open the Source Details window.
16. Click Save to save the Source definition. This saves changes, it does not apply them.
17. Confirm that the Logger is up and running.
18. In the Organization tree, navigate to Site > CLS Definitions > Channel Mapping > 3.
Static Mapping. Click the Attach tab.
The Attach Sources to Channels window appears.
19. Select the Physical Switch ID where the Sources are defined.
3 sources
6 channels
3 sets of
Rx and Tx
25. Click Save to save the Static Mapping definition. This saves changes, it does not apply
them.
WARNING
Update is very powerful! It affects your entire system. Only update when you have completed
all Channel Mapping configurations. Update can close open calls!
If you delete a configuration while recording is in progress, the Interactions Center
will stop recording and insert an exception in the database for all open calls.
26. In the Organization tree, select CLS Definitions > Channel Mapping.
NOTE:
If the icon appears with a red “X” , the CTI nodes are not defined.
3. Select the Network Embedded Logger whose parameters you want to view.
The parameters are displayed in the right pane.
If a spare Network Embedded Logger is configured, it has the same parameters as the primary
Network Embedded Logger.
Spare Logger
Labeled
Idle
Parameter Description
Port Range You can define up to five (5) ports per node.
• Lower Limit - keep the default value.
• Upper Limit
• When defining one port for this node, keep Lower Limit
and Upper Limit defaults.
• When defining multiple ports, enter the last port value in
the Upper Limit field.
Application Protocol The applications protocol that the PABX uses to signal the
endpoints (Stations). The options are:
• Skinny
• SIP
NOTE:
If the icon appears with a red “X” , the CTI nodes are not defined.
3. Select the Network Embedded Logger whose parameters you want to edit.
5. From the Protocol drop-down list, select Cisco Sip or Skinny, depending on the Application
Protocol of the site.
6. In the Source List area, select the node to edit and click Edit .
The Source window appears.
7. Edit CTI node parameters as described in Understanding CTI Node Parameters for the
Network Embedded Logger on page 131.
8. Click OK.
5. Click Save .
This chapter describes how to configure the NiceScreen Logger in the System Administrator.
Contents
• If your license key is on a file, click From File. The Licenses window appears.
In the License Key list, locate and double-click your license key. The NiceScreen Logger
Server License window reappears with the relevant serial number and license key. Click
OK.
-or-
• If your license key is not on file, type the Serial Number and License Key for the
NiceScreen Server and click OK.
The Define Screen Logger Server window appears.
Server Name Use a descriptive name. This name appears as the Logger name in the
Organization tree and is used for identifying the NiceScreen Logger
elsewhere in the System Administrator.
Host Name/IP Enter the computer name or IP address of the NiceScreen Logger.
Address
Port The port on the switch to which the NiceScreen Logger is connected. The
default port is automatically displayed. If you know that this port is already
in use, you can change the port.
6. You can change the log report level to receive more detailed reports:
a. Click the Global tab. The Log Configuration appears.
b. From the Report Mode menu, select Normal Mode or Verbose Mode.
Report Mode controls logging severity. Verbose Mode will generate logs in greater detail.
7. Click Save .
8. Add the new NiceScreen Logger to the NICE Interactions Center (CLS) definition:
a. In the Organization tree, expand CLS Definitions > CLS Servers and select a CLS
server.
b. Click the Loggers tab. The newly defined NiceScreen Logger is listed under Available
Loggers.
CLS
Server
NiceScreen
Logger
c. Select the Logger and click . Your NiceScreen Logger is now listed as an Attached
Logger.
d. Click Save .
9. Screen Loggers can be shared with up to six Interactions Centers that are installed on the same
Site. To attach a NiceScreen Logger to another Interactions Center:
a. In the Organization tree, select a different CLS server.
b. Click the Loggers tab and select Display shared Loggers that are attached to a
CLS.
NiceScreen Loggers that are shared with other CLSs are indicated by an asterisk *.
d. Click Save .
10. If you have an NMS Server installed at your site, add the new NiceScreen Logger to the NMS
monitored list:
a. In the Organization tree, expand Network Management System and select an NMS.
Click the Monitored Server tab.
b. Select the Associated Resource running NiceScreen Logger, select Monitor Server and
click Save .
11. Proceed to Workflow for Screen Recording on page 196.
2. In the Organization tree, select the Logger Servers branch and then select a Logger.
3. Modify the relevant fields. For details of available parameters, see Defining a NiceScreen
Logger on page 137.
4. Click .
Uninstalling a NiceScreen Logger does not automatically remove its definition from your site. You
must delete its definition using the System Administrator.
It is recommended that you do this procedure before uninstalling the NiceScreen Logger so that
you do not temporarily leave invalid paths in your site configuration.
2. In the Organization tree, select the Logger Servers branch and then select the NiceScreen
Logger you need to delete.
IMPORTANT
N+1: One chain is made up of several normal Loggers and 1 spare Logger.
1:1: One chain is made up of 1 normal Logger and 1 spare Logger.
Contents
What is N+1?
NICE Perform offers system reliability whereby continuous recording is ensured even in the event
of a failure. This is provided by creating an N+1 chain, comprised of normally functioning
Loggers and one spare Logger. During normal operation, the spare Logger constantly queries the
normally functioning Loggers in the chain, verifying whether or not they are functioning properly.
In the event that a Logger fails, the spare Logger assumes the identity of the failed Logger and
records its audio.
IMPORTANT
If a spare Logger assumes the identity of a Logger that failed to function due to being physically
disconnected, to resume normal operation, after reconnecting the cable, the Logger must be
restarted.
The example below illustrates an N+1 chain that comprises 4 normally functioning software-only
Loggers and one spare Logger. All Loggers communicate with one another via the LAN, WAN, or
a private network.
LAN/WAN/private network
NOTE: If two or more Loggers in a chain fail, the spare Logger will replace the Logger
that failed first. Recordings on the other failed Loggers will be lost.
The example below illustrates an N+1 chain comprised of four normally functioning Loggers and
one spare. All Loggers, including the spare, must be physically connected to one another via the
N+1 board.
NOTE: If two or more Loggers in a chain fail simultaneously, the spare Logger will
replace the Logger closest to it in the chain. Recordings on the other failed Loggers will
be lost.
IMPORTANT
Configuring N+1/1:1 resiliency involves:
1. Defining all normal and spare Loggers in System Administrator. Before defining the N+1/1:1
chain, make sure that you complete defining all Loggers at your site.
See Configuring VoIP Loggers on page 99.
2. Defining and N+1/1:1 chain (below).
4. From the Actions menu, select New chain. The Define Chain Information window appears.
5. In the Chain Name area, enter a name for the chain. This name is used to identify the chain in
the System Administrator.
6. The Spare ID list shows all spare Loggers whose chains are not yet defined. Select a spare
Logger. Then click . System Administrator confirms that all Loggers in the
chain are connected and running. This procedure might take a few minutes. The chain is
defined and displayed.
NOTE: If the chain is not created successfully, confirm that all Loggers in the chain are
installed properly and running. Then repeat this procedure.
The spare Logger is represented by a unique icon, so that it can be easily identified in the Loggers
branch.
The spare Logger icon appears as follows:
The current states of the Loggers in the N+1/1:1 chain, including the spare Logger, are displayed
in the General tab of the Logger definition.
Spare
Logger
Normal
Logger
NOTE: When adding or removing Loggers to or from a chain, you must delete the
chain, and then recreate it after changes have been made.
b. From the Actions menu, select Delete chain. The chain definition is deleted.
3. Install the new Logger at the site and define it in the Loggers branch of the System
Administrator. See Defining a NiceLog Logger on page 71.
NICE systems with NICE proprietary hardware only: Connect the new Logger physically to
the N+1 chain. See the relevant installation guide for specific configurations.
4. Recreate the chain, following the procedure in Defining an N+1/1:1 Chain on page 146.
The chain is recreated and now includes the new Logger.
TIP: To determine the current state of the spare Logger, locate its Logger definition. Its
current state appears in the General tab. Spare Loggers can be in either Idle or
Overriding state. See Viewing the Spare Logger in the System Administrator
on page 149.
b. From the Actions menu, select Delete chain. The chain is deleted.
3. NICE systems with NICE proprietary hardware only: Physically remove the Logger from the
chain.
4. Recreate the chain, following the procedure in Defining an N+1/1:1 Chain on page 146.
A new chain is created.
If necessary, you can now remove the Logger definition from the Loggers branch.
For each Logger in your site, you must configure its default automatic archiving assignment via
the System Administrator. In addition, if the Logger uses a Remote Tape Server (RTS), you must
define the RTS parameters via the System Administrator.
The archiving configuration and RTS definition are configured in the Logger’s Backup Server
branch of the System Administrator application.
Contents
NICE Perform provides three archiving schemes for your selection, as follows:
• Continuous - Audio on the hard disk is continuously backed up to the media loaded in the
device. When the media is full, it is ejected automatically and a trap message appears on the
NMS notifying the administrator that the media should be replaced.
If the Logger has two devices, you can define one of the following scenarios:
• If you set both devices for Continuous archiving, then archiving begins on one media.
When the media is full, archiving continues on the second media. Each time a media is
full, it is ejected automatically and a trap messages appears on the NMS prompting an
administrator to replace the media in the device.
• If you set one device for Continuous archiving, the second device can be dedicated to
retrieval. Retrieval is defined via the Backup Manager.
• Channeled Archiving - Each device is configured to backup audio previously recorded on
specific channels. All the channels in the Logger must be designated to one of the devices.
Mirroring - Two devices archive the same recorded audio from the Logger’s hard disk at the
same time. You must also define a mirroring timeout value, meaning the number of minutes
that one archiving device should wait for the other device in the event of archiving failure. If
the inactive archiving device does not resume archiving within the specified timeout period,
mirroring stops, and the active archiving device takes over.
After you select the archiving scheme, you must determine when archiving will begin and when it
will end.
• You can determine that archiving will begin automatically - meaning as soon as media is
inserted into the device, or you can determine that archiving will begin at a specific date/time.
• You can determine that archiving will end automatically - meaning as soon as the media is full,
or you can determine that archiving will end at a specific date/time.
If you define a Start Archiving Mode to begin at a specific date/time, the Finish Archiving
Mode automatically changes to 6 hours later of this start time.
After you select an archiving scheme, you must define your overwrite policy:
• You can define an expiration period for the media, meaning that this media cannot be
overwritten before the defined time period passes. You can specify 1-500 months or 15-240
days.
• Archived recordings can be overwritten immediately when different media is placed in the
device. (If you eject a media and then place the same media back in the device, the new
contents are appended. If you place a different media in the device, the media is overwritten.)
2. In the Organization tree, expand the site branch where the Logger is located. Navigate to
Logger Servers > NiceLog. A list of defined Loggers appears. Select a Logger for
configuration.
3. Expand the selected Logger and select Backup Server. Device Information appears in the
right pane.
6. In the Devices Default Assignment area, select the device/s that you are currently
configuring.
7. In the Automatic Archiving Scheme area, select one scheme. See What are the archiving
schemes? on page 154.
If you selected Mirroring, in the Mirroring Timeout field, enter the number of minutes that
one archiving device should wait for the other device in the event of archiving failure. If the
inactive archiving device does not resume archiving within the specified timeout period,
mirroring stops and the active archiving device takes over.
8. In the Start Archiving Mode area, define when archiving should begin, as follows:
• To begin archiving immediately after media is inserted into the device, select When the
media is inserted.
• To begin archiving at a specific date/time, select Periodically at. Then, enter a time and
select the days that this should occur.
NOTE:
• If you selected to begin archiving at a a specific date/time, the Finish Archiving
Mode automatically changes to 6 hours later of this start time.
• The start and finish time refers to the time on the actual Logger server and not the
Logger software.
9. In the Finish Archiving Mode area, define when archiving should end, as follows:
• To end archiving immediately after the media is full, select When the media gets full.
• To end archiving at a specific date/time, select Periodically at. Then, enter a time and
select the days that this should occur.
10. Click . Step 2 of the wizard appears.
11. For each device, select one of the following overwrite options:
• Overwrite always: Archived recordings can be overwritten immediately when a different
media is placed in the device.
If you eject a media and then place the same media back in the device, the new contents
are appended. If you place a different media in the device, the media is overwritten.
• Do not overwrite media for the next day/month period
Specify the number of months (1- 500) or days (15 - 240) that should pass before audio
can be overwritten.
12. Click . Step 3 of the wizard appears.
If the archiving scheme is Continuous, the configuration is complete. Click Finish.
If the archiving scheme is Channeled, you must assign all the channels to devices, as
described in Steps 13 - 16.
13. If you selected the Channeled scheme, the following window appears. All the channels must
be assigned to a device (Device 1 or Device 2).
Define the channels for Device 1. All channels must be assigned to a device (Device 1 or
Device 2)!
Select channels from the Available Input Channels list and click to move them to the
Input Channels to Setup list.
Define the channels for Device 2. All channels must be assigned to a device (Device 1 or
Device 2)!
The Available Input Channels list only shows the available channels - meaning those
channels that have not been assigned to Device 1.
Select channels from the Available Input Channels list and click to move them to the
Input Channels to Setup list.
2. In the Organization tree, expand the site branch where the Logger is located. Navigate to
Logger Servers > NiceLog. A list of defined Loggers appears. Select a Logger for
configuration.
3. Expand the selected Logger and select Backup Server. Device Info appears in the right pane.
showing the decks and their corresponding device information.
5. In the Device Index on RTS Machine field, enter the device number on the RTS.
6. In the IP Address field, enter the IP address of the computer where the RTS resides.
7. Click OK. A message appears notifying you that the Logger will restart.
8. Click OK. The RTS information appears in the Devices Info area (in the right pane).
The CLS Server is installed on your software server as part of the NICE Interactions Center. After
installation is complete, you define the CLS parameters via the System Administrator application.
For installation procedures, see the Interactions Center Installation Guide.
Contents
NOTE: After defining a Logger, add it to a CLS Server definition. If your site has an
NMS installed, add it to the NMS monitored list.
4. Click Next.
5. Enter the name of the CLS and click Next. The CLS name is used to identify the CLS in the
Organization tree and elsewhere in the applications. Use a logical name.
6. If you are not defining a Cluster, enter the IP Address or Host Name of the CLS Server.
Then click Next and proceed to Step 7.
IMPORTANT
DO NOT enter 127.0.0.1 or LocalHost.
-or-
If you are defining a Cluster, complete this window as follows:
a. In the IP Address or Host Name field, define the Cluster.
b. Select Cluster Redundancy Mode. Enter the Host Name or IP Address of the primary
and secondary nodes in the Cluster.
c. Click Next.
7. If you are not defining a Cluster, select Yes or No for each Total Recording option. Then
click Next.
-or-
If you are defining a Cluster, select Yes for All calls voice recording. Then click Next.
9. Review the summary. Then click Finish. The General tab of the CLS Details appears.
10. Click the Loggers tab. The Attach Loggers details appear.
Except for NiceScreen Loggers, each Logger can be attached to only one CLS Server. Loggers
that are already attached a CLS Server will not appear in the list of Available Loggers.
NiceScreen Loggers support Logger Sharing. This means that one NiceScreen Logger can be
used to record from up to six Interactions Centers. To configure your system for this, attach the
NiceScreen Logger to a CLS Server in each Interactions Center.
11. To display NiceScreen Loggers that are shared with other CLS Servers, select Display shared
Loggers that are attached to a CLS.NiceScreen Loggers that are shared are indicated by an
asterisk *. NiceScreen Loggers can only be shared with CLS Servers on the same Data Hub.
12. Select Loggers from the Available Loggers list and move them to the Attached Loggers
list.
14. If you defined a Cluster (see Step 6 on page 168), complete Modifying Configuration
Parameters for a Cluster on page 175 and then return to this procedure.
15. Integrate the CLS Server with the other components:
a. Define the new CLS Server with the switch. See the appropriate Integration Guide for
further assistance.
b. If your site has an NMS installed, add the new CLS Server to the NMS monitored list. See
the NMS Installation Guide for further instructions.
16. If you are using Business Data fields, continue with Mapping Business Data.
NOTE:
The Advanced tab is available only when there is more than one MPCM available for
the same CLS Server.
2. Select Use the MPCMs from the list. A list of MPCMs appears.
3. Select the MPCM(s) that you want the CLS Server to use.
NOTE:
• If you have selected Use all available MPCMs, and later another MPCM is added,
it is automatically available for use by the CLS Server.
• If you have selected Use the MPCMs from the list, and later another MPCM is
added, it is not automatically available for use by the CLS Server. You must return to
the Advanced tab and select the new MPCM.
IMPORTANT
Some integrations have default Optional ID fields. Map these fields as defined in the relevant
Integration guide.
2. Select an entry and click Edit . The Map Optional window appears. This is where you map
the reserved column to the Optional ID field. For special cases, see the Important note
immediately prior to this procedure.
3. In the New Optional ID field, select the number of the Optional ID field containing the
correct data and click OK.
EXAMPLE:
During driver setup, optional ID field 8 is defined for the Customer’s Name received from the
switch. You defined a reserved column called Customer Name as text size 32.
You open the Map Optional window for Customer Name. You can select from Optional ID fields
1 2, 7, 8, 13,14,15, and 16.
Select Optional ID field 8 because it contains the Customer’s Name from the switch.
4. Click Save .
5. If the CLS is running, restart the Call Server.
IMPORTANT
• Changing the default settings may effect system performance.
• Currently the Screen reporting level category is not available, although it appears on the
screen. Changing this field has no effect on the system.
EXAMPLE:
If you select Warning, then all Warning, Error, and Fatal messages will be reported. All Debug
and Information messages will not.
2. Open the CLS Server details and click the Report Level tab. The CLS Report Level details
appear.
Click to
expand
4. Select reporting levels for Files and Events. The drop-down list displays all levels in order of
severity.
5. Click Save .
8. Click Save .
9. Return to Step 14 on page 171.
WARNING
Editing CLS Configuration parameters can cause your system to malfunction and should only be
done by qualified personnel.
For a list of CLS configurations parameters, see CLS Configuration Parameters on page 757.
2. Open the CLS Server details and click the Configuration tab. The CLS Configuration details
appear.
Click to
expand
4. Double-click a parameter or select a parameter and click . The Change Parameter window
appears.
For a list of CLS configurations parameters, see CLS Configuration Parameters
on page 757.
6. Click Save .
4. Click Save .
3. Click Save .
Uninstalling a CLS Server does not automatically remove its definition from your site. You must
delete the CLS Server definition using the System Administrator.
It is recommended that you do this procedure before uninstalling the CLS Server so that you do not
temporarily leave invalid paths in your site configuration.
To record data sent from a switch or a workstation to a Logger, the Logger channels must be
defined and mapped to sources of data from a switch (interface) or a workstation. Channel
Mapping is the process of mapping between channels and sources.
Channel Mapping is customized for each Site, according to the interface installed and the types of
Loggers recording.
NICE Perform also provides the ability to import Channel Mapping definitions from an external
source. Files must be in XML format according to predefined specifications. Likewise, current
Channel Mapping definitions can be exported to an external XML file. Changes can be made and
the file reimported into NICE Perform.
This section provides a brief overview and workflow for Channel Mapping. For complete details
and troubleshooting, see the Channel Mapping Guide. The Channel Mapping Guide is available as
part of the NICE Perform Online Help.
Contents
Install NMS
NOTE:
See the Site Installation Workflow Guide for a detailed overview of the NICE Perform site
installation workflow.
IMPORTANT
While defining Channel Mapping, you can save your new definitions in the interface, by clicking
Save at any time. This does not save make the new definitions a working part of your system;
they are not saved in the Interactions Center! After completing all Channel Mapping
definitions, you must update the configuration. It is not necessary to restart the RCM.
Restarting the RCM does not update Channel Mapping!
Update is very powerful! It affects your entire system. Only update when you have completed
all Channel Mapping definitions.
During the Update process, Open calls are affected as follows:
• Open calls on channels whose mapping configuration was not changed will not be stopped.
• A channel that is detached from its source (Source A) and is attached to another source
(Source B), will stop recording Source A and start recording Source B.
• Recording of calls that involve a channel or source that is in a Channels Pool or Sources
Pool which is detached and reattached, even if no changes were made to either pool, will be
stopped.
For more information, see Saving and Updating Channel Mapping Configurations
on page 201.
IMPORTANT
Only Microsoft Excel 2003 or higher is supported for creating/editing XML files.
• Channels Pool - a group of same type channels from the same Logger used for dynamic
mapping.
• Dynamic mapping - allows you to map a pool of channels to a pool of sources. This is an
ideal scenario when you have more sources than available channels and not all sources need to
be recorded simultaneously.
• Static mapping - allows you to create a one-to-one relationship between channels and
sources.
VoIP Devices (Active and Passive) identify each device in one or both of the following ways:
• Device Number - This is the actual extension number.
• Unique Device ID - This is the identification number of the physical device. If the physical
device is replaced, you must recreate this definition for recording to continue.
Source Side
Source Side defines the type of audio input received by the Logger.
• Rx (unsummed) - Input enters the Logger on two separate sources. (Only the Rx appears in
the sources definition, Tx is not seen.)
• Summed - Input enters the Logger on one source. It is already combined.
Summation Support
Summation Support applies only to trunk-side and extension-side voice recording. It does not
apply to VoIP Loggers. For VoIP Loggers, see Speaker Separation Support. Summation Support is
defined as follows:
• Yes - CoPabx. The Logger has the capability to sum Rx and Tx input and record them on one
channel. The input source that will be mapped to the Logger’s channels is unsummed (Rx).
• No - The Logger cannot sum Rx and Tx input. This Logger should be mapped to a summed
input source. If it is mapped to unsummed input, then the Rx and Tx will be recorded on two
separate channels. This is also known as Speaker Separation Support.
Speaker Separation Support applies only to VoIP Loggers. For all other Loggers, see Summation
Support. Speaker Separation Support describes how the Logger processes the input it receives as
follows:
• Yes - The Logger was initialized, during Logger setup, to record Rx and Tx voice on two
separate channels.
• No - Only summed sources can be mapped. Each source is recorded on a separate channel.
For some Loggers, Speaker Separation Support is automatically defined. This field will be
read-only.
IMPORTANT
To ensure that the Logger channels are properly defined for Total Recording, the Interactions
Center must be completely and successfully initialized.
Port-Based Recording
NICE Perform supports port-based recording for Active and Passive VoIP devices. (VoIP
gateways always use MultiPort recording, therefore, this parameter appears only when defining
VoIP devices.) Port-based recording relates to Logger channel allocation during runtime for
interactions with the same IP address and with different ports.
There are two modes for port-based recording:
• SinglePort - This is a single-line situation. Only one channel will be used to record all ports
from the same IP address. If calls are received on more than one port, they will all be recorded
on the same channel. SinglePort VoIP Devices can be mapped statically or dynamically.
EXAMPLE:
Scenario: One telephone number is shared by several telephones (handsets). If you record
according to extension number, you cannot identify which handset is being recorded.
Solution: Use only the Unique Device ID (UID), not the extension number, for identification.
• MultiPort - This is a multi-line situation. Each port reporting a call from the CTI is mapped to
an available channel in a Channels Pool. If a call is received on a second port of the same IP
address, a different available channel from the same Channels Pools is used to record the
second call. Use MultiPort if each port of the device needs to be recorded on a separate
channel (This is the same behavior as mapping a Gateway Source). MultiPort VoIP Devices
can only be mapped dynamically.
EXAMPLE:
Scenario: One handset (one IP Address) can have several extension numbers (multi-line). If you
record according to the IP Address, you will not be able to identify which extension is being
recorded. If you record each extension to a different channel you are wasting resources since
only one extension can be in use at any given time.
Solution: Use a combination of UID (Unique Device ID) and extension number for
identification.
Limitations
The following limitations are currently in effect.
NOTE: In addition to the limitations listed below, see also:
• Limitations for Dynamic Channel Mapping directly to a Switch on page 193
• Limitations for Screen Loggers Defined with Logger Sharing on page 194
• The TRS does not receive real-time event notification from the CLS Monitor for configuration
updates. Since the TRS works offline, configuration changes are received only once every four
hours.
• If the Channel Mapping configuration is updated after the TRS started scanning channels, the
TRS will continue scanning the channels using the configuration it began with, not the updated
one.
• The TRS has a time stamp for each version. If Channel Mapping configurations from previous
versions are unavailable, metadata will not be added. (Previous versions added incorrect
metadata.)
VOX Driver
• The driver must be restarted to apply the new Channel Mapping configurations.
If you make changes to the Channel Mapping definitions and save them, but fail to update the
configuration, the following will happen:
• Your changes will not be in effect, since they were not updated in the Interactions Center.
• If you exit the System Administrator application and return to it, you will see the definitions
you saved, not what is currently active in the Interactions Center.
If you move a Logger from one Interactions Center to another, there is a specific procedure that
must be followed to ensure that the configuration is properly updated.
See the Channel Mapping Guide for details.
Only Microsoft Excel 2003 or higher is supported for creating/editing XML files.
• Digital Matrix configurations. It is supported only for Active VoIP and Passive VoIP
configurations.
• Media Provider Controller Manager, MPCM (FLM), environments. This is because the
Interactions Center must recognize all the sources reported from the MPCM.
• The following environments:
• Cisco Active Recording (requires an MPCM)
• Passive VoIP with VoIP Mappers (Avaya SAMS, RAS, etc.)
• Passive VoIP Gateway Recording
• Active VoIP Gateway Recording
• VoIP Recording Gateway (VRG)
• VoIP Recording Agent (VRA)
• All recording types involving a Media Provider Controller Manager (MPCM/FLM)
• In sites with Multitenancy where Device Numbers with a different organizational affinity are
recorded on different VoIP Loggers. The Device Numbers must be used to define sources.
• When there is a physical connection between a physical phone device and a VoIP Logger. The
Device Number is mandatory in this case.
• Sites where traffic is greater than 2000 calls in the background. Since the actual background
traffic of a VoIP Logger is approximately 2000 calls, recording must be split by the Network
(i.e. using VLAN mirroring) to different VoIP Loggers. Mapping a switch directly to a
Channels Pool will not be adequate. Sources Pools must be mapped to the Channels Pools.
• In environments where the Logger cannot record extensions that are not monitored.
• In environments where the Logger cannot record all possible extension types.
Example: Alcatel IP DR Link Loggers can record only Series 8 phones, meaning they cannot
record older IP phone, analog, or digital extensions.
Explanation: Mapping the Logger to a Switch requires that any extension (regardless of its
type) can be recorded by the Logger, even if it is not monitored by the Driver. When mapping
is according to Switch, all the extensions for this switch are considered to be mapped.
Therefore, mapping to a switch will only work if the Logger can record all types of extensions
and can record an extension even if it is not monitored by driver. If all extension types cannot
be recorded, then an attempt to record them will fail, therefore mapping by switch is not
recommended.
In this scenario, use a Sources Pool to map to the Channels Pool and not by Switch. This will
ensure that the extensions being recorded are also monitored.
WARNING
Update is very powerful! It affects your entire system. Only update when you have completed
all Channel Mapping configurations. Update can close open calls!
If you delete a configuration while recording is in progress, the Interactions Center
will stop recording and insert an exception in the database for all open calls.
While defining Channel Mapping, you can save your new definitions in the interface, by clicking
Save at any time. This does not make the new definitions a working part of your system; they are
not saved in the Interactions Center! After completing all Channel Mapping definitions, you
must update the configuration. It is not necessary to restart the RCM or any of the Interactions
Center’s modules. Restarting the RCM does not update Channel Mapping!
IMPORTANT
Some configurations require that you restart the RCM to complete the update process. For a
complete list, see Limitations on page 192.
Before updating the configuration, confirm that there are no open errors (Interactions Center,
Loggers, etc.).
NOTE: If a situation occurs where more than one user is updating Channel Mapping
configurations at the same time, only the changes made by the first person to click save
will be saved. The second person will have to refresh the screen to see the new
changes and then recreate his/her changes.
2. Click the Update Configuration button. You only need to click this once, for all changes to
apply, even though it appears in all steps.
-or-
a. In the Organization tree, select CLS Definitions > Channel Mapping.
b. Click Update Configuration.
3. Some configurations require that you restart the RCM to complete the update process. For a
complete list, see Limitations on page 192.
CTI Integrations connect NICE Perform Applications with the telephony system.
The CTI Integrations is composed of several components:
• The CTI Interface is the interface with the telephony system.
• The Connection Manager is responsible for the connectivity to the telephony system
through the CTI Interface.
• The Driver processes messages from the telephony system.
• (Optional) The Media Provider Controller passes the active recording requests to the
telephony system.
• (Optional) The Key Manager provides encryption keys for encrypted audio.
There are two ways to define a CTI Integration:
• The recommended method is to use the CTI Connection wizard, see Defining a Complete
CTI Connection on page 208.
• If you need a customized integration or you need to add an extra component, you can use the
individual component wizards, see Customizing CTI Integrations on page 241.
The Integration software is installed on the NICE Interactions Center. For installation procedures,
see the Interactions Center Installation Guide.
The procedures in this section are generic setup procedures. For specific Integration setup, see the
relevant guide.
TIP: The procedures in this section can be completed before the Integration
installation is complete.
Legend
Installation Workflow
Mandatory
installation
Mandatory
configuration
Your integration can vary according to site-specific requirements and specific integration needs.
Before beginning a configuration, see Information Required Before you Begin on page 207.
Before proceeding with Defining a Complete CTI Connection on page 208, have ready the
following information:
• The NICE Interactions Center IP address or Host name
• The telephony switch
• Integration parameters that need to be defined, their names and values. (This varies according
to your selected integration.)
• Devices
• Where relevant for your integration, the IP address or Host Name where the Media Provider
Controller is installed.
All definitions and connections defined in the wizard are available for editing after the wizard is
complete. See Editing CTI Integration Definitions on page 322 for instructions.
IMPORTANT
Information that is Integration-specific is not described in this section. For parameters specific to
your integration, see the relevant guide.
If you are instructed by NICE to configure Media Correlation, see Defining Media Correlation
on page 297.
4. Click Next. The Set New CTI Connection Wizard appears displaying the CLS Switch
section.
The number
of Stages
changes
dynamically
according to
the
integration
5. Click the Attach CTI to CLS Server drop-down list and select the relevant NICE Interactions
Center (CLS Server).
6. Click the Telephony Switch Type drop-down list and select the relevant telephony switch.
The telephony switch name appears in the Switch Name field.
Continue as follows:
• To define a new telephony switch, see Step 7 on page 210.
• To select an existing switch, see Step 8 on page 211.
7. To define a new telephony switch, do the following:
Click Advanced
to display
Agent Logon Mode
options
NOTE: It is recommended that you leave all three Agent Logon modes selected.
To enable non-standard CLS log-in options, in the Agent Logon Mode area, leave the
default checkboxes selected:
• To the same station again - allows agents to log in to the same workstation more
than once.
• To more than one station - allows agents to log in to more than one workstation.
• To a station another agent is logged into - allows more than one agent to log in to
one workstation.
d. Continue with Step 9 on page 211.
8. To use an existing telephony switch, do the following:
a. In the Telephony Switch and CTI Interface Type area, click the drop-down list and
select a telephony switch and CTI Interface.
Sample CTI
Interface
Type
Sections
NOTE: Different additional options appear according to your Interface, and if they are
available. Options that are not available for your interface are disabled.
Additional VoIP Mapping only becomes available if you select VoIP Mapping.
For some integrations, only three options may appear. See the specific Integration guide
for more information.
b. (Optional) If available and when relevant for your integration, select Active Recording.
The drop-down list becomes enabled. Click the Active Recording drop-down list and
select the relevant Active VoIP option.
c. (Optional) If available and when relevant for your integration, select VoIP Mapping.
The drop-down list becomes enabled. Click the VoIP Mapping drop-down list and select
the relevant VoIP Mapping option.
d. (Optional) If available and when relevant for your integration, select Additional VoIP
Mapping.
The drop-down list becomes enabled. Click the Additional VoIP Mapping drop-down
list and select the relevant Additional VoIP Mapping option.
Select the
options
relevant for
your
integration
10. Click Next. The Set New CTI Connection Wizard window appears displaying the Interface
Parameters section.
Sample CTI
Interface
Information
Sections
a. To see the complete list of parameters, clear the Show only required parameters
checkbox.
b. In the Interface Connection Details area, select each row and click or double-click
the row in the Parameter column. (Mandatory parameters appear in bold.) The Switch
Connection Parameter window opens.
Sample Switch
Connection
Parameter window
c. Enter a value and click . (Descriptions appear only for predefined parameters.)
d. Repeat for all parameters in the Parameter column.
11. If your integration requires additional Interface Parameter definitions, expand the Additional
Interface Parameters. The Additional Interface Parameters section often appears to be
blank.
a. To see the complete list of parameters, clear the Show only required parameters
checkbox.
To see all parameters, clear the Show only required parameters checkbox
The parameters that are available are determined by interface specific metadata on the
database. This metadata can be modified.
Chapter 12: Defining CTI Integrations 214
b. If you need to edit a parameter, select it and click or double-click its row. The Driver
Additional Parameter window opens.
Sample Driver
Additional
Parameter window
a. To see the complete list of parameters, clear the Show only required parameters
checkbox.
b. In the VoIP Mapping Interface Connection Details area, select the first row and click
or double-click it in the Parameter column.(Mandatory parameters appear in bold.)
The Switch Connection Parameter window opens.
Sample Switch
Connection
Parameter Value
window
To see all parameters, clear the Show only required parameters checkbox
• To see the complete list of parameters, clear the Show only required parameters
checkbox.
• If you need to edit a parameter, select it and click or double-click its row. The Edit
New Parameter window opens.
• Enter a value and click .
• Repeat for all parameters that need to be edited.
Chapter 12: Defining CTI Integrations 216
f. Continue as follows:
• If you did not select an additional Telephony switch - CTI Interface option,
continue with Step 16 on page 223.
• If you selected Additional VoIP Mapping, continue with Step 14 on page 217.
• If you selected Active Recording, continue with Step 15 on page 220.
14. Click Next.
If you selected Additional VoIP Mapping, the Additional VoIP Mapping window
appears.
Depending on the Additional VoIP Mapping selected, this window may appear blank.
a. To see the complete list of parameters, clear the Show only required parameters
checkbox.
b. In the VoIP Mapping Interface Connection Details area, select the relevant row and
click or double-click it in the Parameter column. The Switch Connection Parameter
window opens.
Sample Switch
Connection
Parameter Value
window
e. If your integration requires additional definitions, expand the VoIP Mapping Additional
Interface Parameters.
To see all parameters, clear the Show only required parameters checkbox
• To see the complete list of parameters, clear the Show only required parameters
checkbox.
• If you need to edit a parameter, select it and click or double-click its row. The Edit
New Parameter window opens.
• Enter a value and click .
• Repeat for all parameters that need to be edited.
f. Continue as follows:
• If you selected Active Recording, continue with Step 15 on page 220.
• If you did not select an additional Telephony switch - CTI Interface option,
continue with Step 16 on page 223.
b. Select the first row and click or double-click it in the Parameter column. (Mandatory
parameters appear in bold.) The Switch Connection Parameter window opens.
Sample Switch
Connection
Parameter
window
e. If your integration requires additional Active Recording definitions, expand the Active
Recording Additional Interface Parameters.
To see all parameters, clear the Show only required parameters checkbox
• To see the complete list of parameters, clear the Show only required parameters
checkbox.
• If you need to edit a parameter, select it and click or double-click its row. The
Driver Additional Parameter window opens.
Sample Driver
Additional
Parameter
window
Add
• Click Add . The Media Provider Controller that you have just defined is moved to
the Media Provider Controllers list.
Delete
h. To remove Media Provider Controllers: in the Media Provider Controllers list, select
the Media Provider Controller that you want to remove and click Delete . The
selected Media Provider Controller is removed from the list.
16. Click Next. The Set New CTI Wizard window appears displaying the Devices section.
Sample Switch
Devices
Configuration
Sections
To Do Procedure
5. Click OK.
To Do Procedure
Import devices from a file 1. In the Import from area, click File.
Import devices from the switch 1. In the Import from area, click Switch.
Edit devices 1. Select the device that you want to edit and click
. The Edit Available Devices window appears.
2. Edit the device information.
3. Click OK.
To Do Procedure
Export a list of devices to a file 1. Click . The Export Available Devices List
window appears.
2. Complete the information.
3. Click OK.
The Set New CTI Wizard window reappears displaying all the devices that you have added.
18. For certain integrations, there are additional parameters that may be configured. Expand the
relevant area.
Sample
additional
Switch Devices
Configuration
Areas
• This step varies according to the telephony switch integration being defined. See the
relevant CTI Integration guide for details.
19. Click Next. The Set New CTI Connection Wizard window appears displaying the Monitor
section with all the monitored devices.
IMPORTANT
By default, all available devices (that can be monitored) are monitored.
a. If there are devices that you do not want to monitor, from the Monitored Devices list,
select the device.
Select the
relevant
options for
your
integration
22. If you selected Business Data Fields Definition, the Set New CTI Connection Wizard
window appears displaying the Connection Manager General Information area.
a. Expand Business Data Fields Definition.
b. To add a business data field definition, click Add. The Business Data Field window
appears.
NOTE: If the field type is not an ECC array, the array index should be -1.
f. Click OK.
g. Repeat from Step b until you have added all necessary business data fields.
h. Leave the default settings for the Business Data Parsing.
23. If you selected Rejected Devices, the Set New CTI Connection Wizard window appears
displaying the Rejected Devices area. You can add both devices and trunks in this section.
IMPORTANT
Rejected Devices are activated only after you select it in the Driver configuration, see
Activating the Rejected Devices on page 238.
EXAMPLE:
To reject all trunks in Trunk Group 5, you need to enter - T5#*
To reject all trunks, you need to enter - T*#*
To reject trunk numbers 3 to 6 in trunk group 7, you need to enter - T7#3, T7#4, T7#5 and T7#6
To Do Procedure
Delete rejected devices • Select the device that you want to delete and click
.
To Do Procedure
Search for a rejected device 1. Select the device that you want to search for and
Deleting rejected devices • Select the devices or trunks that you want to delete
and click Delete.
Note: The devices and trunks are deleted with no
warning message.
25. If you selected Device Mapping, the Set New CTI Connection Wizard window appears
displaying the Device Mapping area.
Device Mapping is used with CTI Integrations that report one call on a station and another call
on a position - where both calls refer to the same device. Device Mapping enables you to map
one device to the other, e.g. you can map Position to Extension (or vice versa).
IMPORTANT
For detailed information regarding device mapping, see the relevant Integration guide.
IMPORTANT
Device Mapping is activated only after you select it in the Driver configuration, see Activating
Device Mapping on page 239.
To Do Procedure
To Do Procedure
Edit a mapped device 1. Select the mapped device that you want to edit and
click . The Edit Device Mapping window
appears.
2. Edit the device information.
3. Click OK.
Delete mapped devices • Select the mapped device that you want to delete
and click .
Search for a mapped device 1. Select the mapped device that you want to search
All mapped devices appear in the From Device and To Device list.
27. Click Next. The Set New CTI Connection Wizard window appears displaying the
Requirements area.
You now select a Connection Manager. You can either create a new one or select an existing
Connection Manager.
IMPORTANT
If no Connection Manager currently exists in your site, this window does not appear.
• Device Mapping, remember to activate it. See Activating Device Mapping on page 239.
NOTE: .
If you are instructed by NICE to configure:
• Media Correlation, see Defining Media Correlation on page 297
• Field Mapping, see Defining Field Mapping on page 303
• Failover, see Defining Failover on page 310
Select the
relevant CTI
Interface
3. Select the relevant CTI Interface and click or double-click the selected CTI
Interface.
Select
Rejected
Devices
Select the
relevant CTI
Interface
3. Select the relevant CTI Interface and click or double-click the selected CTI
Interface.
4. Expand Driver Real-time Plugins.
Select
Device
Mapping
This section describes how to define the following components that are defined in the CTI
Integrations branch:
• CTI Interfaces
• Drivers
• Connection Managers
Customization Workflow
Your integration can vary according to site-specific requirements and specific integration needs.
The icons below appear in a schematic view in the Diagram tab.
Legend:
Driver
Key Manager
Optional: Defining a New Key
Manager on page 280
Media Provider
Controller
IMPORTANT
Information that is Integration-specific is not described in this section. For parameters specific to
your integration, see the relevant Integration guide.
NOTE: If you are instructed by NICE to configure Media Correlation, see Defining
Media Correlation on page 297.
2. In the Organization tree, select CTI Integrations > CTI Interfaces. Then from the Actions
menu, select New CTI Interface.
a. From the Telephony switch drop-down list, select the relevant Telephone Switch.
b. From the CTI Interface drop-down list, select the relevant CTI Interface.
c. In the Name field, enter a meaningful Name.
d. You now need to select a telephony switch.
Each telephony switch can be defined with more than one CTI Interface.
Continue as follows:
• If the relevant telephony switch exists, continue with Step 4 on page 245.
• If the relevant telephony switch does not exist, continue with Step 5 on page 246.
4. If the relevant telephony switch exists: Click the Telephony Switch drop-down list and select
the relevant telephony switch.
5. If the relevant telephony switch does not exist: Click Create. The New Telephony Switch
window appears.
• To a station another agent is logged into - allows more than one agent to log in to
one workstation.
NOTE: It is recommended that you leave all three Agent Logon modes selected.
e. Click OK. The Telephony Switch Configuration window closes. The new telephony
switch appears in the Telephony switch field.
b. In the Interface Connection Details area, double-click each parameter in the Name
column. (Mandatory parameters are shown in red.) The Switch Connection Parameter
window opens.
Sample Switch
Connection
Parameter window
c. Enter a value and click OK. (Descriptions appear only for predefined parameters.)
d. Repeat for all parameters in the Name column.
e. To add additional Interface Connection details, click Apply. The Add New Parameter
window opens.
f. Enter a value and click OK.
7. To view the additional switch parameters, expand the Additional Switch Parameters. The
parameters that are available are determined by interface specific metadata on the database.
Sample
Additional Switch
Parameters
definitions
The parameters that are available are determined by interface specific metadata on the
database. This metadata can be modified.
a. When a full list of parameters is required, clear the Show only required parameters
checkbox.
b. To add parameters to the Additional Switch Parameters, click Add.
-or-
To edit a parameter, select it and click Edit or double-click the relevant parameter.
The Driver Additional Parameter window opens.
Sample Driver
Additional
Parameter window
c. If you added a new Additional Switch parameter, in the Name field, enter a name.
d. In the Value field, enter a value and click OK.
8. Click Next.
The step that appears varies according to the telephony switch being defined.
Continue as follows:
• In some telephony switch definitions, the Summary window appears. Continue with
Step 12 on page 254.
• In some integrations you need to Set Devices. The Set New CTI Interface Wizard
window appears displaying the Set Devices section. Continue with Step 9.
For general information about setting devices and the devices that you can set, as well as a
list of abbreviated device types, see Defining Available Devices and Codes on page 255.
9. To set devices, select the relevant procedure/s:
To Do Procedure
To Do Procedure
Import devices from a file 1. In the Import from area, click File.
Import devices from the switch 1. In the Import from area, click Switch.
Edit devices 1. Select the device that you want to edit and click
. The Edit Available Devices window appears.
2. Edit the device information.
3. Click OK.
To Do Procedure
Export a list of devices to a file 1. Click . The Export Available Devices List
window appears.
2. Complete the information.
3. Click OK.
The Set New CTI Wizard window reappears displaying all the devices that you have added.
10. For certain integrations, there are additional parameters that may be configured. Expand the
relevant area.
Sample Integration
definitions
• This step varies according to the telephony switch integration being defined. See the
relevant Integration guide for details.
Code Description
ACD ACD
AGT Agent
BTN Button
EXT Extension
HDS Handset
INT Intercom
IVR IVR
LINE Line
MIC Microphone
OP Operator
POS Position
RNJ RNJ
SPKR Speaker
TRNK Trunk
VDN VDN
Available devices are the devices defined on the switch. For example, Extension, Speaker, or
trunk. There are several ways to define Available Devices.
Chapter 12: Defining CTI Integrations 255
2. In the Organization tree, select CTI Integrations > Connection Managers. Then from the
Actions menu, select New Connection Manager.
General Connection
Manager
Connection
Manager for Media
Provider Controller
a. Enter a Name. This name is used to identify the Integration in the System Administrator
and other applications.
b. Accept the default Port or enter a different one.
c. Enter the Location where the Connection Manager is installed. This should be the NICE
Interactions Center.
Important: When entering a Host Name, the Host Name should NOT contain any
spaces.
TIP: When defining a Connection Manager for a Media Provider Controller, enter the
Location of the VoIP Logger where the Connection Manager and Media Provider
Controller are installed.
4. To customize the levels at which messages are reported, expand Reporting Level.
a. Select the desired row and click Edit or double-click it. The Set Reporting Level
window appears.
b. Select the checkboxes for the reporting levels you want to include and click OK.
NOTE: It is highly recommended that you do not change the settings of the default
reporting levels. Changing reporting levels should be done only by authorized
personnel and in conjunction with NICE Customer Support.
To edit a parameter, select it and click Edit or double-click the parameter. The CM
Additional Parameter window opens.
b. If you added a new Additional Switch parameter, in the Name field, enter a name.
c. In the Value field, enter a value and click OK.
d. Repeat for all other parameters that need to be added/edited.
6. Click Next. The Connection Manager Switches appear.
This is where you define the connection between the Connection Manager and CTI Interface.
7. Select a CTI Interface to connect to the Connection Manager. Double-click it or click the
arrow to move the CTI Interface to the Attached Interfaces list.
8. Select the interface in the Attached Interfaces list. The Connection Manager - Interface
Parameters relevant to the Connection Manager automatically appear.
You can attach more than one CTI Interface to connect to the Connection Manager. You can
only view the parameters of one interface at a time.
NOTE: To view the Connection Manager - Interface Parameters, you must select
a CTI Interface!
To edit a parameter, select it and click Edit or double-click the parameter. The CM
Additional Parameter window opens.
b. If you added a new CM Additional parameter, in the Name field, enter a name.
c. In the Value field, enter a value and click OK.
d. Repeat for all other parameters that need to be added/edited.
2. Select CTI Integrations > Drivers. Then from the Actions menu, select New Driver.
a. Enter a Name. This is used to identify the Driver in the System Administrator and other
applications.
b. Enter the Location where the Driver is installed, i.e. the NICE Interactions Center.
Important: When entering a Host Name, the Host Name should NOT contain any spaces.
4. Expand Attach CLS and select a NICE Interactions Center (CLS Server). In some
environments, you can select more than one NICE Interactions Center (CLS Server).
5. To customize the levels at which messages are reported, expand Driver Reporting Level.
a. Select the desired row and click Edit or double-click it. The Set Reporting Level
window appears.
b. Select the checkboxes for the reporting levels you want to include and click OK.
NOTE: It is highly recommended that you do not change the settings of the default
reporting levels. Changing reporting levels should be done only by authorized
personnel and in conjunction with NICE Customer Support.
6. To define additional parameters for the Driver, expand Additional Driver Parameters.
To edit a parameter, select it and click Edit or double-click the parameter. The
Additional Driver Parameter window opens.
b. If you added a new Additional Driver parameter, in the Name field, enter a name.
c. In the Value field, enter a value and click OK.
d. Repeat for all other parameters that need to be added/edited.
7. To define CTI Analysis, expand CtiAnalysis Parameters.
a. Select Check the box if using CTI Analysis. The CTI Analysis Parameters display.
-or-
To edit a parameter, select it and click Edit or double-click the parameter. The Driver
CTIA Parameter window opens.
c. If you added a new Driver CTIA parameter, in the Name field, enter a name.
d. In the Value field, enter a value and click OK.
e. Repeat for all other parameters that need to be added/edited.
8. Click Next. The Attach Connection Manager and Switches window appears.
9. If you need to define Driver - Interface parameters, continue with Step 10.
-or-
If you do not need to define Driver - Interface parameters, continue with Step 18
on page 279.
10. Select the relevant CTI Interface. The wizard automatically connects the Driver and the
Connection Manager.
The Driver - Interface Configuration window opens. The sections that appear are according to
the Driver definition.
12. To add the Driver Real-time Plugins monitoring, expand Driver Real-time Plugins.
Click the
arrows to
change
the order
NOTE: You should perform activation of Media Correlation and Field Mapping only
if you have been advised to do so by a NICE Solution Engineer.
f. Continue as follows:
• To add monitoring for devices, see Step 13.
• To add additional Driver Switch parameters, see Step 14 on page 271.
• To add Device Mapping, see Step 15 on page 272.
• To add Media Correlation, see Defining Media Correlation on page 297.
• To add Field Mapping, see Step 16 on page 274.
• To add Rejected Devices, see Step 17 on page 276.
• If no other configurations need to be made in the Driver - Interface Configuration
area, click OK.
13. (Optional) To add device monitoring, expand Monitor Devices.
a. To edit a parameter, select it and click Edit or double-click the parameter. The Driver
Additional Parameter window opens.
Sample Driver
Additional
Parameter
window
NOTE: You must have selected Device Mapping in the Driver Real-Time Plugins
area for this option to display, see Step 12 on page 269.
Device Mapping is used with CTI Integrations that report one call on a station and another call
on a position - where both calls refer to the same device. Device Mapping enables you to map
one device to the other e.g. you can map Position to Extension (or vice versa).
a. Add all devices that you want to map, click Add. The Device Mapping window appears.
IMPORTANT
For detailed information regarding device mapping, see the relevant Integration guide.
NOTE: You can import a text file with the devices already mapped to one another.
b. Enter the relevant device IDs and click OK. The Driver - Interface Configuration window
appears again.
c. In the Device Mapping area, verify that the devices are mapped correctly and click OK.
d. Continue as follows:
• To add Media Correlation, see Defining Media Correlation on page 297.
• To add Field Mapping, see Step 16 on page 274.
• To add Rejected Devices, see Step 17 on page 276.
• If no other configurations need to be made in the Driver - Interface Configuration
area, click OK.
NOTE: You should configure Field Mapping only if you have been advised to do so by
a NICE Solution Engineer.
Click Add
a. To add field mapping, click Add. The Create new field mapping window appears.
b. In the Define a source field area, from the Field Type drop-down list, select the relevant
field type. The relevant Define a source field area appears.
c. In the Field Name field, enter a name in the Field Name field or select the relevant field
name.
Note: If you select CAPI Field, you can only select fields that display in the Field Name
list.
• If you selected Dynamic length area: in the Starts from field, enter the relevant
expression from which the name starts.
Note: If the name appears at the beginning of a string, leave the Starts from field
blank.
In the Ends with field, enter the expression with which the name ends.
Note: If the name appears at the end of a string, leave the Ends with field blank.
If the name appears more than once, in the Appearance field enter which numbered
appearance you want to use.
Enter the expression from
which the name starts
e. In the Define a destination field area, from the Field Type drop-down list, select the
relevant field type.
f. In the Field Name field, enter a name in the Field Name field or select the relevant field
name.
Note: If you select CAPI Field, you can only select fields that display in the Field Name
list.
g. Click OK. The new Field Mapping appears in the Source list.
17. (Optional) To add rejected devices or trunks, expand Rejected Devices.
Rejected Devices is used with CTI Integrations where you need to reject (or filter) specific
devices or trunks. This is used in situations where you have two parallel integrations - for
example, a simple integration and a Dialer integration - and you have duplicate monitoring of
devices in both integrations. You can reject (filter out) the devices or trunks that are monitored
in the Dialer integration from the simple integration.
IMPORTANT
Activation of this Real-Time plugin only takes place after you select it in the Driver
configuration, see Step 12 on page 269.
EXAMPLE:
If you want to reject all trunks in Trunk Group 5, you need to enter - T5#*
If you want to reject all trunks, you need to enter - T*#*
If you want to reject trunk numbers 3 to 6 in trunk group 7, you need to enter - T7#3, T7#4, T7#5
and T7#6
To Do Procedure
To Do Procedure
Delete rejected devices • Select the device that you want to delete and click
.
Search for a rejected device 1. Select the device that you want to search for and
Deleting rejected devices • Select the devices or trunks that you want to delete
and click Delete.
Note: The devices and trunks are deleted with no
warning message.
2. In the Organization tree, select CTI Integrations > Key Managers. Then from the Actions,
menu, select New Key Managers.
a. Enter a Name for the Key Manager. This name is used to identify the Key Manager in the
System Administrator and other applications.
b. Accept the default Port or select a different one.
c. In the Key Manager’s Location area, enter the IP address or Host name where the Key
Manager is installed, i.e. the NICE Interactions Center.
Important: When entering a Host Name, the Host Name should NOT contain any spaces.
4. To customize the levels at which messages are reported, expand Key Manager Reporting
Level.
a. Select the desired row and click Edit or double-click it. The Set Reporting Level
window appears.
b. Select the checkboxes for the reporting levels you want to include and click OK.
NOTE: It is highly recommended that you do not change the settings of the default
reporting levels. Changing reporting levels should be done only by authorized
personnel and in conjunction with NICE Customer Support.
• Select the relevant CTI Interface. The Connection Manager is automatically selected
and the Key Manager is automatically attached to it.
6. To define additional parameters for the Key Manager, expand Additional Key Manager
Parameters.
-or-
To edit a parameter, select it and click Edit or double-click the parameter. The Key
Manager Parameter window opens.
a. If you added a new Key Manager parameter, in the Name field, enter a name.
b. In the Value field, enter a value and click OK.
c. Repeat for all other parameters that need to be added/edited.
8. Click Next. A Summary of the Key Manager definition appears.
9. Click Finish.
NOTE: It is recommended that each Media Provider has its own Connection Manager.
• Each Media Provider Controller can be connected to only one Connection Manager.
• Each Connection Manager can be connected to more than one Media Provider Controller (for
redundancy).
2. In the Organization tree, select CTI Integrations > Media Provider Controller. Then, from
the Actions menu, select New Media Provider Controller.
4. Select a Media Provider Controller type and click Next. The General Information step
appears.
IMPORTANT
When entering a Host Name, the Host Name should NOT contain any spaces.
In specific integrations, the Media Provider Controller’s Location is on the NICE Interactions
Center. See your Integrations Guide for detailed information.
7. To define additional parameters for the Media Provider Controller, expand Additional Media
Provider Controller Parameters.
8. To add parameters to the Additional Media Provider Controller Parameters, click Add.
-or-
To edit a parameter, select it and click Edit or double-click the parameter. The Key
Manager Parameter window opens.
a. If you added a new Media Provider Controller parameter, in the Name field, enter a name.
b. In the Value field, enter a value and click OK.
c. Repeat for all other parameters that need to be added/edited.
9. To customize the levels at which messages are reported, expand Media Provider Controller
Reporting Level.
a. Select the desired row and click Edit or double-click the parameter. The Set Reporting
Level window appears.
b. Select the checkboxes for the reporting levels you want to include and click OK.
NOTE: It is highly recommended that you do not change the settings of the default
reporting levels. Changing reporting levels should be done only by authorized
personnel and in conjunction with NICE Customer Support.
10. Click Next. A Summary of the Media Provider Controller definition appears.
Mapping Devices
Device Mapping is used with CTI Integrations that report one call on a station and another call on
a position - where both calls refer to the same device. Device Mapping enables you to map one
device to the other e.g. you can map Position to Extension (or vice versa).
IMPORTANT
For detailed information regarding device mapping, see the relevant Integration guide.
To map devices:
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
2. In the Organization tree, select Master Site > CTI Integrations > Drivers > the relevant
Driver.
a. Click the Interfaces tab.
Select
Device
Mapping
d. Select Device Mapping. The Device Mapping section appears in the Driver-Interface
Configuration window.
3. Expand Device Mapping.
NOTE: You must have selected Device Mapping in the Driver Real-Time Plugins
area for this option to display, see Step 12 on page 269.
To Do Procedure
Edit a mapped device 1. Select the mapped device that you want to edit and
click . The Edit Device Mapping window
appears.
2. Edit the device information.
3. Click OK.
To Do Procedure
Delete mapped devices • Select the mapped device that you want to delete
and click .
Search for a mapped device 1. Select the mapped device that you want to search
All mapped devices appear in the From Device and To Device list.
5. In the Device Mapping area, verify that the devices are mapped correctly and click OK.
5. In the Organization tree, select Master Site > CTI Integrations > Drivers > the Driver of
the Interface that supplies the Media Location e.g. SIP Trunk.
Select the
relevant CTI
Interface
Select Media
Correlation
IMPORTANT
Configuration of the parameters in the Media Correlation Plugin section should be done
ONLY on the interface that supplies the CTI information and NOT on the interface that supplies
the Media Location.
e. Click OK.
6. Click Save.
7. In the Organization tree, select Master Site > CTI Integrations > Drivers > the Driver that
supplies the CTI information.
a. Click the Interfaces tab.
Select the
relevant CTI
Interface
Select Media
Correlation
IMPORTANT
Configuration of the parameters in the Media Correlation Plugin section should be done
ONLY on the interface that supplies the CTI information and NOT on the interface that supplies
the Media Location.
Set the
parameters
9. Double-click the Media Location Switch ID. The Media Location Switch ID window
appears.
10. From the drop-down list, select the relevant Media Location and click OK.
The selected Media Location Interface appears in the Value field.
11. Double-click the CTI Switch ID. The CTI Switch ID window appears.
12. From the drop-down list, select the relevant CTI Interface and click OK.
The selected CTI Interface appears in the Value field.
13. Double-click Matching Mode. The Matching Mode window appears.
NOTE: Select All if you want all the Matches in the Match column to be met for the
Media Correlation to be successful.
Select One if it is enough that one of the Matches in the Match column is met for Media
Correlation to be successful.
The selected Matching Mode appears in the Value field.
Click Add
15. You can now add the Matches, click Add. The Match Values window appears.
a. From the Media Location Parameter drop-down list, select the relevant Media Location
parameter.
b. From the CTI Parameter drop-down list, select the relevant matching CTI parameter.
c. If there are business data fields that need to be matched:
• From the Business Data Field > Media Location Parameter drop-down list, select
the relevant Media Location parameter.
• From the Business Data Field > CTI Parameter drop-down list, select the relevant
matching CTI parameter.
d. Click OK.
Select Field
Mapping
d. Select Field Mapping. The Field Mapping section appears in the Driver-Interface
Configuration window.
3. Expand Field Mapping.
Click Add
a. To add field mapping, click Add. The Create New Field Mapping window appears.
b. In the Define a source field area, from the Field Type drop-down list, select the relevant
field type. The relevant Define a source field area appears.
c. In the Field Name field, enter a name in the Field Name field or select the relevant field
name.
NOTE: If you select CAPI Field, you can only select fields that display in the Field
Name list.
f. If you selected Dynamic length area: in the Starts from field, enter the relevant
expression from which the name starts.
NOTE: If the name appears at the beginning of a string, leave the Starts from field blank.
• In the Ends with field, enter the expression with which the name ends.
NOTE: If the name appears at the end of a string, leave the Ends with field blank.
• If the name appears more than once, in the Appearance field enter which numbered
appearance you want to use.
Enter the expression from
which the name starts
g. In the Define a destination field area, from the Field Type drop-down list, select the
relevant field type.
h. In the Field Name field, enter a name in the Field Name field or select the relevant field
name.
NOTE: If you select CAPI Field, you can only select fields that display in the Field
Name list. If you select Business Data, the Field Name that you enter here should be the
one that is defined in the Database Servers.
i. Click OK. The new Field Mapping appears in the Source list.
2. Select CTI Integrations > Drivers > Driver Name. The driver definitions appears.
Select the
relevant
CTI
Interface
4. Select the relevant CTI Interface and click Configure or double-click the selected CTI
Interface.
Click the
arrows to
change
the order
To Do Procedure
To Do Procedure
Delete rejected devices • Select the device that you want to delete and click
.
Search for a rejected device 1. Select the device that you want to search for and
Deleting rejected devices • Select the devices or trunks that you want to delete
and click Delete.
Note: The devices and trunks are deleted with no
warning message.
Defining Failover
Failover enables you to use an alternative interface for call records.
In this situation, you require one Connection Manager, one Driver, and two CTI Interfaces.
You connect to the primary CTI Interface and when it fails, your connection switches over to
another CTI Interface (i.e. the secondary CTI Interface). These interfaces can be different types,
for example Genesys and Cisco TAPI. See the diagram below.
NOTE: Failover occurs when you move from the primary CTI Interface to the secondary CTI
Interface. Failback occurs when you move from the secondary CTI Interface to the primary CTI
Interface.
IMPORTANT
Ensure that you have all relevant licenses for all recorded devices that require licensing on the
PABX side before they can be monitored by the integration.
For example if you have a site that wants to use failover for both Genesis and Avaya TSAPI, it is
important to remember that both require PABX licenses for monitoring purposes.
CTI Interface
CTI Driver Connection
Manager Genesys
Cisco PABX
CTI Interface
Cisco TAPI
WARNING
When failback is taking place, there is a possibility of CTI loss.
To configure Failover:
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
2. Configure your primary CTI Interface: Use the CTI Connection wizard to create your:
• Primary CTI Interface
• Connection Manager
• Driver
Chapter 12: Defining CTI Integrations 311
IMPORTANT
Configure all the devices that need to be monitored in the Available Devices area.
3. Configure your secondary CTI Interface, see Defining a New CTI Interface on page 243.
The example below uses Cisco TAPI as the secondary CTI Interface.
4. In the Available Device area, configure the same groups of devices that you configured in
Step 2, i.e. if you configured extensions in the primary CTI Interface, configure extensions in
the secondary CTI Interface. You should monitor any groups of devices that can be monitored.
IMPORTANT: If the secondary CTI Interface monitors all devices for example, Cisco Skinny,
there is no need to define devices here.
5. In the Organization Tree, navigate to the Connection Manager that you just created in the
CTI Connection wizard.
6. Click the Interfaces tab.
7. In the Attach CTI Interfaces area, from the Available Interfaces list, select the secondary
8. Click Save.
9. In the Organization Tree, navigate to the Driver that you created in the CTI Connection
wizard.
IMPORTANT
To enable Failover, at least two CTI Interfaces have to be connected to the same driver.
10. Select the secondary CTI Interface and click Configure. The Driver - Interface Configuration
window appears.
NOTE: You need to monitor the devices that you defined for the secondary CTI Interface in
Step 4 on page 313. If the secondary CTI Interface monitors all devices, then this step is not
necessary. ‘
12. In the Available Devices list, select all devices that you want to monitor. Click to move
them to the Monitored Devices list.
15. Click the Failback Mode drop-down list and select the relevant Failback mode.
NOTE: The recommended Failback mode is Manual.
16. To add Failover, in the Add a new Failover pair area, click the Interface drop-down list and
select the relevant primary CTI Interface.
a. Click the Alternative Interface drop-down list and select the relevant secondary CTI
Interface.
17. To verify the failover, in the Organization Tree, navigate to CTI Integrations and click the
Diagrams tab.
18. To save the failover configuration, in the Organization Tree, navigate to CTI Integrations
and click Apply.
NOTE: When you have finished configuring Failover, restart all the NICE Integration
services.
Double-click to
open
Double-click to
open
2. To access the complete details of a single component: In the Resources tab, double-click the
component
-or-
From the CTI Integrations branch, select the component.
The selected CTI component appears.
Driver
Key Manager
Media Provider
Controller
• Connection Manager
• Driver
• Key Manager
2. In the Organization tree, expand CTI Integrations. Then, select the appropriate branch.
-or-
In the Organization tree, select the CTI Integrations branch and then double-click a
component.
3. Edit parameters as required. See the following sections for details of available parameters:
• Defining a New CTI Interface on page 243
• Defining a New Connection Manager on page 256
• Defining a New Driver on page 263
• Defining a New Key Manager on page 280
• Defining a New Media Provider Controller on page 286
4. Click Save .
Driver
definition
4. Expand a section and see to Defining a New Driver on page 263 for details.
5. Click OK.
6. Select the CTI Integrations branch and click Apply. Do not restart NICE components or
services!
Apply
NOTE: If you use this delete option, all components of the integration will be deleted.
4. Click .
A message box appears asking if you want to delete the Connection and all its components.
5. Verify that you are deleting the correct integration and if you want to delete the integration
click Yes to delete all the listed components in the integration.
3. Click Delete
-or-
From the Actions menu, select Delete.
6. Click OK.
The Telephony Switch Configuration window closes.
2. In the Organization tree, navigate to Master Site > CTI Integrations. The Summary tab
appears.
3. In the Summary tab, expand the integration whose telephony switch or devices you want to
edit.
4. Click .
To Do Procedure
To Do Procedure
Import devices from a file 1. In the Import from area, click File.
Import devices from the switch 1. In the Import from area, click Switch.
Edit devices 1. Select the device that you want to edit and click
. The Edit Available Devices window appears.
2. Edit the device information.
3. Click OK.
To Do Procedure
Export a list of devices to a file 1. Click . The Export Available Devices List
window appears.
2. Complete the information.
3. Click OK.
The devices that you have added/edited/imported appear in the Available Devices section.
IMPORTANT
After completing this procedure, update the Channel Mapping definitions for any new devices
you have added. For details, see the Channel Mapping Guide.
10. If you need to edit the physical switch, click . The Edit Telephony Switch window appears.
All devices (extensions, handsets, etc.) must be monitored in order to be recorded. Some
integrations run only in a ‘monitor all’ mode where all devices are monitored at all times. Other
integrations support monitoring of only selected devices.
By default, all devices are monitored when the Driver is defined. This procedure is intended for
use as you add or remove extensions or other devices.
This procedure can be performed without interruption in the performance of your NICE
Perform system. You do not have to restart NICE components or services!
The following procedure describes how to add or modify a device to an Integration and then define
it for monitoring.
In order for a device to be monitored you must do the following:
1. Add it to the list of Available Devices
2. Add it to the list of Monitored Devices
IMPORTANT
After completing this procedure, update the Channel Mapping definitions for the new device. For
details, see the Channel Mapping Guide.
To add or modify the Available Devices and add them to list of Monitored Devices:
1. In the Organization tree, navigate to Master Site > CTI Integrations. The Summary tab
appears. Tabs vary according to the selected Integration.
2. In the Summary tab, expand the integration whose devices you want to add or modify.
3. Click .
The Edit CTI Integration wizard appears.
To Do Procedure
To Do Procedure
Add a range of devices 1. Click . The Available Devices Add Range window
appears.
2. In the Start at Device Number field, enter the
number of the first device.
3. In the Number of devices to add field, enter the
number of devices you want to add.
4. From the Device Type drop-down list, select a
device.
5. Click OK.
Import devices from a file 1. In the Import from area, click File.
Import devices from the switch 1. In the Import from area, click Switch.
To Do Procedure
Edit devices 1. Select the device that you want to edit and click
. The Edit Available Devices window appears.
2. Edit the device information.
3. Click OK.
The devices that you have added/edited/imported appear in the Available Devices section.
IMPORTANT
After completing this procedure, update the Channel Mapping definitions for any new devices
you have added. For details, see the Channel Mapping Guide.
9. Click Finish.
10. Click Save. Do not restart NICE components or services!
11. Click Apply.
12. For verification of the above processes, see the Driver’s Log files.
Sample Driver Log File:
13. Update the Channel Mapping definitions for the new devices. For details, see the Channel
Mapping Guide.
2. Select CTI Integrations > CTI Interfaces. Then from the Actions menu, select Remove
Unused Telephony Switches.
2. Expand the CTI Interface branch and select the relevant CTI branch.
Note: You can perform XML handling for any CTI Integration component.
• Switch Metadata
• Driver Metadata
• Media Provider Controller Metadata
• Key Manager Metadata
When you purchase your NICE Perform system, you purchase a specific amount of licenses for
recording channels and for IP ports. The licenses are purchased for your entire organization. Using
the License Manager, you allocate the following:
• Channel licenses to specific CLSs
Contents
Chapter 13: Allocating Channel and Port Licenses (License Manager) 345
EXAMPLE:
You have two sites, Site A and Site B.
Site A has 100 traders and two CLS’s. 10 of these traders each have turrets with an extra line. To
work non-stop, at full capacity, your license has 300 trader channels, 10 additional channels,
and 150 redundant channels.
You allocate 50 traders (150 trader channels) and 5 additional channels to each CLS at Site A.
You allocate 50 of the redundant channels to this site.
If one of the CLSs at Site A fails, the 50 redundant channels allocated to Site A will
automatically record on any active CLS at Site A. They do not get directly allocated to a CLS and
will not record from Site B. The 100 redundant channels not allocated to Site A will not record
for the CLS at Site A.
Chapter 13: Allocating Channel and Port Licenses (License Manager) 346
License
1 2 Information
3 4
5 6
Redundant
Channel
Allocation
Channel
Allocation
A B C D E
NOTE: Only those CLS’s with IP channel definitions will appear in the CLS License
Definitions list.
Traders Total - The number of traders according to your license. Each trader is automatically
allocated the amount of channels defined in your license. The default value in the license is three
channels per trader. The numbers appear as follows: Traders (Channels). For a description of
traders and channels, see Different Types of Channel Licenses on page 346.
Traders Free - The number of traders not yet defined to a CLS. This number is computed as
follows: - .
Additional Channels Total - The number of additional channels according to your license.
For a description of additional channels, see Different Types of Channel Licenses on page 346.
Additional Channels Free - The number of additional channels not yet defined to a CLS.
This number is computed as follows: - .
Redundant Channels Total - The number of redundant channels according to your license.
For a description of redundant channels, see Different Types of Channel Licenses on page 346.
Chapter 13: Allocating Channel and Port Licenses (License Manager) 347
Redundant Channels Free - The number of redundant channels not yet defined to a site.
- Total Redudant Channel Allocation
This number is computed as follows: .
Redundant Channels - The number of redundant channels allocated to each site.
Traders - The number of traders defined for this CLS. The number of channels automatically
allocated per trader is defined in your license. The default value in the license is three channels per
trader. If you require more channels per trader, allocate Additional Channels.
Maximum Channels - The maximum channel capacity of the CLS. This number is the sum of
the number of channels for all voice loggers configured to the CLS. The number of channels you
allocate to the CLS should not exceed this number.
Original Allocation - The number of traders channels plus the number of additional channels
allocated to the CLS. If this number exceeds the maximum channels, you are allocating more
channels than can possibly be used; The line for this CLS is indicated in red. This number is
computed as follows: *3+ . Where 3 is the default value for trader channels per trader. Your
actual value is defined in your license and might vary.
Chapter 13: Allocating Channel and Port Licenses (License Manager) 348
• The CLS is configured in the System Administrator. See Interactions Center Server
Configuration on page 165.
To allocate channels:
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
2. Open the License Manager: In the Organization tree, select the License Manager branch.
Chapter 13: Allocating Channel and Port Licenses (License Manager) 349
3. Select a CLS from the resource list and click Edit resource. The License Settings window
appears.
4. Enter the number of Traders defined to this CLS. The number of channels automatically
allocated per trader is defined in your license. The default value in the license is three channels
per trader.
5. Enter the number of Additional Channels allocated to this CLS.
6. Click OK.
Chapter 13: Allocating Channel and Port Licenses (License Manager) 350
2. Open the License Manager: In the Organization tree, click the License Manager branch.
3. In the Redundant Channels Definitions area, select a site from the resource list and click
Edit . The License Settings window appears.
The number of
redundant channels
not yet allocated
4. Enter the number of Redundant channels allocated to this site. Then click OK.
Chapter 13: Allocating Channel and Port Licenses (License Manager) 351
The Total number for each type of port available, according to your license, is shown. The
number of free ports, not yet assigned, is also displayed.
NOTE: Only those Telephony Service Servers defined as IP will appear in the PBS
License Definitions list.
Chapter 13: Allocating Channel and Port Licenses (License Manager) 352
Allocating Ports
Ports are allocated when the Playback Services Server was defined. Use this procedure to change
port allocations. If more ports are purchased and a new license acquired, you must update the
Applications license. See Updating the Applications Server License to add Channels or Ports
on page 355.
2. In the Organization tree, navigate to Playback > Telephony Services. Then right-click a
Telephone Service and select Update Configuration.
Chapter 13: Allocating Channel and Port Licenses (License Manager) 353
Chapter 13: Allocating Channel and Port Licenses (License Manager) 354
When you receive a new Applications Server License, you must update the license and then:
• Adjust the trader/channel allocations.
• Adjust the redundant channel allocations.
• Make the Port/Telephony Service allocations.
If you have already updated the Applications Server license via the Applications branch, you do
not need to update it again. Just readjust your allocations as necessary.
When updating an Applications Server license with a different number of traders or channels,
one of the following conditions will occur:
• The new license has more traders or channels than the previous license. In this case, you can
allocate the new traders or channels. See Allocating Licenses to Traders and Channels
on page 349.
• The new license has fewer traders or channels than the previous license. In this case, the
number of traders and channels allocated to each CLS is automatically reduced (A percentage
of traders/channels is removed from each CLS). You can readjust the allocations as needed.
See Allocating Licenses to Traders and Channels on page 349.
• The new license has the same number of traders and channels as the previous license. In this
case, you do not have to make any adjustments.
When updating an Applications Server license with a different number of ports, one of the
following conditions will occur:
• The new license has more ports than the previous license. In this case, you can allocate the
new ports to your Telephony Services. See Allocating Ports on page 353.
• The new license has fewer ports than the previous license. You can readjust the allocations as
needed. See Allocating Ports on page 353.
• The new license has the same number of ports as the previous license. In this case, you do not
have to make any adjustments.
To update a license:
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
Chapter 13: Allocating Channel and Port Licenses (License Manager) 355
2. In the Organization tree, right-click License Manager and select Import License Keys.
4. Click Import. This will import all licenses and render them ready for use. Each license will
only become active when you update the relevant license. Each time you open a license
window, only the relevant licenses will appear.
5. In the Organization tree, right-click License Manager and select Update License.
Chapter 13: Allocating Channel and Port Licenses (License Manager) 356
Chapter 13: Allocating Channel and Port Licenses (License Manager) 357
NICE Perform applications are installed on the NICE Perform Applications Server. For
installation procedures, see the Applications Suite Installation Guide. The System Administrator
must be configured to recognize all applications. Initial configuration procedures are provided as
part of the installation procedures.
Change the configuration settings the System Administrator for the applications in the following
instances:
• When additional applications, which were not included in the initial installation, are installed
• If the NICE Perform applications are uninstalled and then reinstalled on a different server
• To update your license for NICE Perform applications
Each application requires the name/IP address of the host computer and the HTTP port of the
host to which it is connected. These are assigned automatically. In some instances, a TCP port is
also defined. You can use the System Administrator to verify or change port assignments.
In some sites, there are several Applications Servers. The Primary Applications Server is the
server where the NICE Perform Applications Suite is installed. Secondary Applications Servers
can be added to the Primary Applications Server to enable load-balancing and facilitate optimal
resource utilization. A user logging in to the Applications Suite is unaware of which Applications
Server is being utilized. System Users are not assigned to any one Applications Server.
NOTE: If you have a Multi Data Hub environment, see Working with Multi Data
Hubs on page 733.
The System Administrator appears with a list of NICE components under the Site branch in
the Organization tree.
To add components in the System Administrator, you must work in Technician Mode.
2. From the Settings menu, select Technician Mode.
Figure 14-2 Technician Mode
3. In the Organization tree, expand Applications > Application Servers > Server. The
Application Server Services appear.
TIP: Some sites can have more than one Applications Server installed.
The Primary Applications Server can be identified by it’s larger icon. The Primary
Applications Server includes all of the Applications Services.
Each Secondary Applications Servers contains a subset of the services defined on the
Primary Applications Server.
You can edit Host Names and Port assignments for any of the Applications Servers
using this procedure.
NOTE: HTTP Ports are preassigned by default. They define which socket port is
assigned to each application on the Applications Server. If other applications are
running on the Applications Server, manually redefine these ports.
TCP Ports are defined during installation. If a TCP port is defined, you can change it if
required. You cannot add a TCP port to a definition.
• To use TCP ports, when they are defined, in place of the HTTP ports, on the
General tab of the Configurations > General branch, select Enable TCP mode.
4. To change the Host Name/IP Address of the NICE Perform Applications Suite:
a. In the System Administrator Host Name field, enter the new server name.
b. Select .
5. Click Save .
• Locate Settings - the order by which Loggers and the Storage Center are searched to find
interactions.
• Workstation Ports - In order for your client workstations and your servers to communicate,
the firewall for the ports on each workstation must be opened. You can open the firewall for all
ports, or specify a range of ports to be available for this use and open the firewall on only those
ports. The available range of ports is from 1024 to 5000. You must specify a range of at least
10 ports.
• Log Reporting Levels
2. In the Organization tree, expand Applications > Application Servers > Server. The
Application Server Services appear.
TIP: Some sites can have more than one Applications Server installed.
The Primary Applications Server can be identified by it’s larger icon. The Primary
Applications Server includes all of the Applications Services.
Each Secondary Applications Servers contains a subset of the services defined on the
Primary Applications Server.
You can edit Host Names and Port assignments for any of the Applications Servers
using this procedure.
NOTE: HTTP Ports are preassigned by default. They define which socket port is
assigned to each application on the Applications Server. If other applications are
running on the Applications Server, manually redefine these ports.
TCP Ports are defined during installation. If a TCP port is defined, you can change it if
required. You cannot add a TCP port to a definition.
• To use TCP ports, when they are defined, in place of the HTTP ports, on the
General tab of the Configurations > General branch, select Enable TCP mode.
3. To change the Host Name/IP Address of the NICE Perform Applications Suite:
a. In the System Administrator Host Name field, enter the new server name.
b. Select .
4. Click Save .
5. You can customize your configuration with the following steps (you can also return and
perform these customizations at any time).
-or-
You can skip customization for now, and continue with Step 12 on page 368.
6. Navigate to Applications > Configurations > General. The General tab is displayed.
7. In the General Settings area, you can change the following settings:
• Default Email Address - the email address from which all system generated emails are
sent. Such as, reports sent by email from the Reporter, Compliance Workflow notifications
(PBO requests), Trend Analytics notifications, and transcriptions or audio files of
interactions.
• Email for Error Reporting - the email address where all error and warning messages are
sent. If this contains an email address, a checkbox appears at the bottom of all error and
warning messages, giving the user the option to forward the message to this address. If this
field is left blank, the checkbox does not appear in the error and warning messages.
Option to send
an email
• Coaching Link Path - the location of files for linked attachments in coaching packages.
All files used as link attachments in coaching packages must be placed at this location.
This must be a shared folder. It can be located on any machine attached to your site.
8. To enable use of TCP ports in place of HTTP ports for application services, select the Enable
TCP mode checkbox.
NOTE: HTTP and TCP Port assignments appear in the Application Servers
Services definition.
9. To change the number of ports that must be opened on each workstation, scroll down and
expand the Workstation Settings area. Then select as follows:
• Random Ports - all ports on each workstation must be open.
• Specific Ports Range - select a range between 1024 and 5000 (the minimum range
is 11 ports. i.e., 2001 - 2011 inclusive).
The setting you select applies to all your workstations!
10. To change the Log Reporting Levels, click the Logs Level tab.
12. According to your system configuration, define one or more of the following.
PBO Requests defaults Configuring PBO Requests Default Settings on page 396
SmartCenter Configuring SmartCenter (TotalView and Performed)
on page 402
Secure Client Deploying Secure Client Communication on page 469
Communication
NOTE: Later, as part of your site setup, you may be installing an NMS (Network
Management System) for reporting trap messages. At that time, remember to add the
Applications to the NMS monitored list.
1. The order in which servers are searched. You can select one of the following:
Search Loggers only (No Storage Do not search the Storage Center (there is no
Center) Storage Center at this site).
Search Storage Center before First, search the Storage Center and then search
searching Source Logger the Loggers. If most of the interactions in your
query results are stored on a Storage Center, this
will produce faster results.
Search Storage Center after First, search the Logger where the interaction
searching Source Logger was recorded and then search the Storage Center.
Search Storage Center after First, search all the Loggers and then search the
searching all Loggers Storage Center.
Search Storage Center Only Search only the Storage Center and not the
Loggers.
2. The list of all the defined Storage Center servers in the site, and the order that they should be
searched.
The list of locations is defined in the Lists Editor. If you add a new location in this
window, it is automatically added to the central list in the Lists Editor and is available in
the Users Administrator.
If a Location was already added to the Locations branch, it will not appear in the Add New
Location window for selection.
b. If the Location appears in the list, select Select from list. Then select a location and click
OK.
-or-
If the Location does not appear in the list, select New Location name and enter the name
of the Location. The location is automatically be added to the central list in the Lists
Editor and becomes available in the Users Administrator. Click OK.
c. A branch for the location is added to the Locations branch. Select the location’s branch.
The General tab appears. Select the Locate Settings tab.
5. Select a Locate option: select the order in which servers are searched when a query runs. See
page 369 for a description.
6. If you selected an option with Storage Center, the Storage Center list appears.
Do the following:
a. Click Add. The Available Storage Centers window appears listing all defined Storage
Center servers that were not yet added the Locate Settings list.
b. Select one or several Storage Center servers and click OK. The servers appear in the list.
c. Define the search priority by moving the Storage Centers up/down in the list (using the
up/down arrow buttons).
7. If you selected Customized Order, the Loggers and Storage Centers list appears. When you
define a Customized Order, the previous Customized Order will be wiped clean. Only your
new list will remain. Do the following:
a. Click Choose Resources. The Custom Locate Order window appears.
b. From the Resource Tree, select a site. All of the site’s Loggers and Storage Centers
appear in the Available Items list. In the Available Items list, double-click Loggers
and/or Storage Centers to move them to the Selected Items list.
You can select Loggers and/or Storage Centers from more than one site.
c. Important! Each time you open the Custom Locate Order window, you must select the
entire list of Loggers/Storage Centers you want searched. Whatever appears in the
Selected Items list will be the final list. If there was a previously defined list, it will be
cleared.
d. Click OK. The Loggers and Storage Centers appear in the list.
e. Define the search priority by moving the Loggers and Storage Centers up/down in the list
(using the up/down arrow buttons).
8. Click Save .
When you are searching vast quantities of interactions, it is more efficient (quicker) to first search
the location where a majority of the interactions will be found.
Locate Settings determines the order in which Loggers and/or Storage Centers are searched.
They can be defined per site or per Location. If an agent is defined on a location which has a
Locate Settings defined, the Locate Settings of the Location takes precedence over the Locate
Settings defined for the site. For more information on locations, see Defining Search Order and
Locations for Storage Centers and Loggers on page 369.
EXAMPLE:
The Master Site is defined to search Storage Centers before Loggers.
Location London is defined to search Loggers before Storage Centers.
Agent Tom is defined on the Master Site and at the London Location. If you run a query for Agent
Tom’s interactions, the Loggers will be searched before the Storage Centers.
Agent Sue is defined on the Master Site and does not have a specific Location definition. If you
run a query for Agent Sue’s interactions, the Storage Centers will be searched before the
Loggers.
2. In the System Administrator: Under the Organization > Locations branch. Define Locate
Settings for the Location. You can also add a new Location to the Lists Editor by adding it
directly in the Locations branch. To define Locate Settings for a location, you add the Location
in the System Administrator.
3. In the Users Administrator: Assign user to the locations on the Details tab of the User
definition.
2. Navigate to Organization > Site > Applications > Configurations > Locate Settings.
The Locate Settings appear.
Collapse
3. Scroll down, or collapse the Locate Settings section to view the Other Settings section.
5. Click Save .
The Playback Administration service restarts.
NICE Perform provides the ability to globally define default settings for the Player. The Player can
be customized on each workstation. NICE Perform provides the option of forcing the default
settings on all Players. This will reset all Player settings to the original default settings. To reset
Player default settings, see Overriding Customized Player Settings on page 382.
IMPORTANT
The Player is not part of the Applications Suite. It must be installed separately on each
workstation where it will be used. Each time the Player is installed, it adopts the default settings
defined in the System Administrator. These settings can be customized on each workstation.
You can set global default settings in the System Administrator application.
For instructions on installing the Player, see the Workstation Setup Guide.
For instructions on using the Player, see the Player Guide.
2. In the Organization tree, expand the Site. Then click the Playback > Player Settings. The
default setting for the Player appear. They are divided into four tabbed pages.
b. Player Appearance - Determines whether all interactions selected for playback will be
played back in the same Player (Single Instance) or whether a different Player is launched
each time an interaction is selected for playback (Multiple Instances).
If multiple instances of the Player are opened and each is customized differently, then the
parameters that are saved for future sessions are those parameters defined in the last Player
window that was closed.
a. Buffer Duration and Monitor Buffer Duration - Define how much media (measured in
seconds) the Player collects during its Prepare cycle before the media is played back.
Lower values will shorten the Prepare cycle, but will also increase the number of breaks
during playback. Higher values will cause longer but fewer breaks during playback.
• Buffer Duration - This value applies when the Player is used to play back
interactions.
• Monitor Buffer Duration - This value applies when the Player is used to monitor live
interactions.
b. Max Reconnect Times - If the Player disconnects from the Logger, this is the maximum
number of times it will try to reconnect before declaring an error.
7. Click Save .
These are the settings that each Player will adopt during installation.
EXAMPLE:
The following are examples of when you might find it necessary to force the default settings on
all Players.
• Latency occurs on your network and you want to reinitialize the buffer duration for all
output.
• Temporarily disable all use of sound cards.
2. In the Organization tree, expand the Site. Then click the Playback > Player Settings. The
default setting for the Player appear. They are divided into four tabbed pages.
3. Click the Visualization, Network, or Output tab. Then select the Force Settings checkbox.
4. Click Save .
The next time each user logs in to the NICE Perform applications, their settings will be reset to
these defaults.
Configuring IP Phones
IP Phones provide several services. Availability of each service is according to your license. You
can configure IP Phone services in the System Administrator.
Use the System Administrator to configure the following services:
• Tag Current Call Service
• Last Calls Playback Service
• Email Last Calls Service
The Record On Demand (ROD) Service does not require configuration parameters in the
System Administrator.
NOTE: Before configuring the Tag Current Call Service, create a list of tags in the
Lists Editor as follows:
• Place the list in the User Defined Lists > Customized section.
• Define the List Type as Strings.
To use the Lists Editor, see the Lists Editor Guide.
2. In the Organization tree, expand Site > Applications > Configurations > IP Phone
Application. The Configuration tab is displayed.
3. To configure the Tag Current Call service, expand the Tag Call Settings area. The first time
you configure Tag Current Call, you create a column in the CLS database. This column cannot
be deleted and its name cannot be changed. It is automatically added to the database as a
reserved column. Proceed as follows:
a. The first time you configure Tag Current Call, click New. The Create Tag Column
window appears.
• Enter a Name for the column. This is the internal name of the column in the database,
it cannot contain spaces or special characters.
• Enter an Alias for the column. This is the name that is shown whenever the column is
referenced. This name can contain spaces and special symbols. This field cannot be
named “name” (the Alias “name” is already in use by the system).
• Click Apply. This creates the database column. The New button is now disabled.
TIP: To use the new column, you will have to do the following:
You will have to assign privileges to this new column in the Users Administrator. See the
Users Administrator Guide.
b. Use the Select List and Edit Items buttons to select a list of tags from the Lists Editor or
to modify its contents. You can select only from the lists in the User Defined Lists >
Customized section.
4. To configure Playback Last Calls service, expand the Query Settings area and the
Playback Settings area and do the following.
a. In the Query Settings area, specify the number of calls that will be displayed and the
period that will be searched. These settings also apply to the Email Last Calls service.
b. In the Playback Settings area, you can select to Skip Silence. Select this setting in a
Selective environment. In other environments, use this setting as needed.
c. Click the Advanced tab and in the Query Settings area, define the Maximum Timeout
when running a search. This setting also applies to the Email Last Calls service.
5. To configure the Email Last Calls service, expand the Email Settings area and define the
following.
a. Subject list - the list of subjects from which the user will select when sending an email
from an IP phone. This list can also be modified using the Lists Editor. The list is IP
Phone Lists > Email Subjects.
b. Save directory path - the folder location for storing audio files. Prior to emailing a call,
the selected call is first saved to this location. This folder must have full read/write share
privileges. It is recommended to define this folder on your local hard drive.
c. Mail server - the name of your email server.
d. Mail from address - the email address from which the email is sent.
e. See Step 4 to define Query Settings. These settings also apply to the Playback Last Calls
service.
f. Click the Advanced tab and define the following:
• Query Settings - Maximum Timeout when running a search. This setting also
applies to the Playback Last Calls service.
• Email Settings - Frequency at which stored audio files are deleted from the system.
This refers to the folder defined in the Save directory path field in item b of this
step.
IMPORTANT
• Ensure that the Mail from Address is not blocked by your email server.
8. Click Save .
2. Click .
The Preferences window opens.
Select forms
Set Preferences
per Business
Analyzer
module
To do this:
a. In the Agent area:
• In Evaluation Forms Tree, select the form(s) or form group(s) that can be used for
agent evaluations.
• The form(s) or form group(s) appear in Available Items.
• From Available Items, select the form(s) or form group(s), and using the arrows,
move them to Selected Items.
• To select a default agent evaluation form (optional), select one form from the
Selected Items list box and click .
• The form selected as the default form appears in bold text.
• To cancel a default selection, select the form again and click again.
b. In the Customer Experience area:
• In Evaluation Forms Tree, select the form(s) or form group(s) that can be used for
customer evaluations.
• The form(s) or form group(s) appear in Available Items.
• From Available Items, select the form(s) or form group(s), and using the arrows,
move them to Selected Items.
• To select a default agent evaluation form (optional), select one form from the
Selected Items list box and click .
• The form selected as the default form appears in bold text.
• To cancel a default selection, select the form again and click again.
4. Click the appropriate tab (per module). In the General Defaults area, for the current module,
determine the default query that will run and the default view of that query, when the user logs
into the Business Analyzer.
You can reset the values in the window at any time by clicking .
a. In the Default Query field, select whether a default query should run when the module
opens or not:
• Select None. The Results pane will remain empty when the module opens.
-or-
• Select the second radio button, expand the Queries tree and select a query. When a
user opens the module, the selected query will run automatically and the results will
appear in the Results pane.
b. In the Default View field, select Table or Graph to determine whether a table or a graph
appears when the module opens. (This is not applicable for all the modules.)
• If you selected Graph, select a graph from the drop-down list. The selected graph will
appear when the module opens.
c. Select the number of matching items that should be displayed in the Results pane after a
query runs.
You can reset the values in the window at any time to the default values by clicking .
5. Click the appropriate tab (per module). In the Table area, select which columns appear in the
Results pane. In the Interactions module, you must select columns for a segments query and
columns for a complete interactions query.
In the Available Columns list box, select the columns that will appear in the Results pane and
click Add. These columns are moved to the Selected Columns list box. Use the up/down
arrows to determine the order of the columns. (The names of the columns that appear in this
window may differ from site to site, depending on customer customization.)
a. In the Sort area, select the order in which the items appear, as follows:
• First, select the column by which the items will be sorted from the Sort By drop-down
list.
• Then, select the order in which the items appear (Ascending or Descending).
b. To display all items in groups under headings (based on the a column name), do the
following:
• Select the column by which items will be grouped from the Group By drop-down list.
• Then, select the order in which the group headings and items inside each group appear
(Ascending or Descending).
If you are sorting and grouping the items, the results will first be grouped by the
column name selected in the Group By field. Within each group, the items will be
sorted by the column name selected in the Sort By field.
c. In the Interactions module, repeat steps a-b for the Segments section and for the Complete
section.
6. To set the selection delay of the Details pane, click the Interactions/Evaluations tab.
a. Scroll to the Detailed Information area.
b. Select the Selection Delay checkbox and enter the number of seconds that the delay will
occur before the Details pane appears.
IMPORTANT
If you do not select the Selection Delay checkbox, the Details pane will not open at all!
7. Click the appropriate tab (per module). Scroll to the Quick Query Settings area.
The Available Filters list box displays a list of query criteria groups. The group names in the
list box correspond to the tabs in the Advanced Query window.
a. In the Available Filters list box, expand a group name to view query criteria topics.
b. To view the query criteria in a topic, select a topic from the Available Filters list box, and
click . If you move this topic to the Selected Filters list box, this criteria will
appear in the Quick Query pane.
c. Select the appropriate topic (not a high-level group name) and click Add to move it to the
Selected Filter list box.
d. In the Selected Filters list box, you can expand a query criteria topic to view a list of
criteria in that topic. If you do not want all the criteria in the topic to appear in the Quick
Query pane, you can select/clear the checkboxes for specific criteria.
e. In the Selected Filters list box, you can determine the order in which the query criteria
appears in the Quick Query pane by clicking the up/down arrow buttons.
You can reset the values in the window at any time by clicking .
The Quick Query pane in the Business Analyzer displays the selected criteria only.
Preferences Window Quick Query Pane in
the Business Analyzer
8. Click to save all your preferences settings, then close the Preferences window.
2. Click .
2. Click .
3. In the General Defaults area, for the current module, determine the default query that will
run and the default view of that query, when the user logs into the Playback Organizer.
You can reset the values in the window at any time by clicking .
a. In the Default Query field, select whether a default query should run when the module
opens or not:
• Select None. The Results pane will remain empty when the module opens.
-or-
• Select the second radio button, expand the Queries tree and select a query. When a
user opens the module, the selected query will run automatically and the results will
appear in the Results pane.
b. In the Display area, select how many items will appear after a query is run, as follows:
You can reset the values in the window at any time to the default values by clicking .
4. In the Table View area, select which columns appear in the Results pane.
In the Available Columns list box, select the columns that will appear in the Results pane and
click Add. These columns are moved to the Selected Columns list box. Use the up/down
arrows to determine the order of the columns. (The names of the columns that appear in this
window may differ from site to site, depending on customer customization.)
a. In the Sort area, select the order in which the items appear, as follows:
• First, select the column by which the items will be sorted from the Sort By drop-down
list.
• Then, select the order in which the items appear (Ascending or Descending).
b. To display all items in groups under headings (based on the a column name), do the
following:
• Select the column by which items will be grouped from the Group By drop-down list.
• Then, select the order in which the group headings and items inside each group appear
(Ascending or Descending).
If you are sorting and grouping the items, the results will first be grouped by the
column name selected in the Group By field. Within each group, the items will be
sorted by the column name selected in the Sort By field.
5. Scroll to the Quick Query Settings area.
The Available Filters list box displays a list of query criteria groups. The group names in the
list box correspond to the tabs in the Advanced Query window.
a. In the Available Filters list box, expand a group name to view query criteria topics.
b. To view the query criteria in a topic, select a topic from the Available Filters list box, and
click . If you move this topic to the Selected Filters list box, this criteria will
appear in the Quick Query pane.
c. Select the appropriate topic (not a high-level group name) and click Add to move it to the
Selected Filter list box.
d. In the Selected Filters list box, you can expand a query criteria topic to view a list of
criteria in that topic. If you do not want all the criteria in the topic to appear in the Quick
Query pane, you can select/clear the checkboxes for specific criteria.
e. In the Selected Filters list box, you can determine the order in which the query criteria
appears in the Quick Query pane by clicking the up/down arrow buttons.
You can reset the values in the window at any time by clicking .
Preferences Window
6. Click to save all your preferences settings, then close the Preferences window.
2. Click .
To configure SmartCenter:
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
2. In the Organization tree, expand Master Site > Applications > Configurations >
Smart Center.
3. In the TotalView area, Web Service Location field, paste the http:address location you
copied from the CoachingService .xml page. This allows access to the Coaching Web Service.
The Coaching Web Service handles the package schedule requests when you create a package,
if you choose to schedule it via TotalView.
NOTE: The IP address of the IEX Server location is provided by IEX TotalView.
This is the Web page that will be accessed when is clicked from the My Schedule
component of My Universe.
Example: http://100.123.123.10
To test the IP address, open an Internet Explorer window and copy the IP address into the
address area.
6. In the TotalView area, Adherence Calculation Method field, select the method for
calculating agent adherence to schedule from the drop-down list.
EXAMPLE:
An agent is scheduled to work 08:00 - 16:00 (480 min).
The agent arrived at 08:15 and worked until 16:15.
Breaks were taken according to schedule.
Total scheduled = 480.
MinutesInAdherence = 465.
Total out of adherence = 15 minutes late + 15 minutes from 16:00 - 16:15
Adherence = (465 / 480)*100 = 96.8%
Conformance = (465 / 465 +15 +15)*100 = 93.9%
7. In the TotalView Smart Sync FTP area, define the FTP site to which IEX TotalView exports
data for NICE Perform to retrieve as follows:
a. In the Location field, type the address of the FTP site, including the directory name, to
where Smart Sync will export the IEX files.
For example: 172.11.111.111/exports/sync/smartcenter
If the location is not in the correct format, an error message will appear.
b. Port - the port on the FTP site. The default is 21.
c. User and Password - the user ID and password for accessing the FTP site.
8. Click Validate FTP Address. If the FTP location is not in the correct format, or the folder
does not exist, or the user or password is incorrect, the connection will not be validated.
• If you configured the FTP address correctly, the following message appears:
• If the FTP address was not configured correctly, the following message appears:
Repeat Step 7a to redefine your FTP settings, until the Connection Validated! message
appears.
9. Click Save .
10. If you have a multi-site configuration, in the Organization tree, under Secondary Site,
select Applications > Configurations, and choose Smart Center.
11. Repeat steps 3 to 9 for every site.
IMPORTANT
Ensure that all SmartCenter Hot Fixes are installed!
The NICE Perform Data Mart provides a robust, open access interface to information contained in
the NICE Perform system without any concern over potential impacts on real-time performance.
The NICE Perform system enables organizations to capture, analyze and act on insights gained
from the full range of customer interactions. The NICE Perform Data Mart serves as a centralized
repository for this information, providing a single, unified data source for reporting and data
access.
In an environment with more than one Data Hub (a Multi Data Hub environment), one Data Mart
is configured on the Primary Data Hub for the entire organization. It consolidates data from the
individual Data Hubs’ local databases. Since data from all the Data Hubs are stored in one central
database, users can run queries and reports that span all the Data Hubs. This provides users with
valuable information as they can analyze and compare data across the organization. This approach
allows a unified view of information across the entire operation from any NICE Perform
workstation, and it allows personnel from one Data Hub to see what is going on at another.
IMPORTANT
In a Multi Data Hub environment, the Data Mart must be installed at the Primary Data Hub, and
never on the Secondary Data Hub.
Contents
TIP: To avoid unnecessary workload on the Data Mart, we recommend that you install
only the domains that are required for the Applications or Reporter packages at the
Data Hub.
The Administration domain must always be installed.
See Install the NICE Domains on page 416 for details.
In a Multi Data Hub environment, you must select which databases in each Data Hub should be
linked to the corresponding domains in the Data Mart. See Architecture for Multi Data Hubs
on page 411.
The Data Mart has three default schedules, as follows:
• Population Schedule: Determines when the domains in the Data Mart are populated with data
from the NICE databases. The default is every hour between 5:00 AM and 11:00 PM.
• Retention schedule: Determines when data which passed the Retention period is deleted. The
default is once a day at 1:00 AM.
The value for the Retention period states how long the data must remain in the Data Mart. The
default is 18 months.
• Reindex Schedule: Determines when the Data Mart rebuilds indexes for each domain. The
default is every Saturday at 2:00 AM.
You can modify a default schedule or create a new schedule for a specific domain via the System
Administrator application. See Customizing Schedules on page 422.
Workflow
When you build the Data Mart, you must follow these steps:
1. Verify that the nice_dw database resides on one SQL Server. See Verify the Data Mart
Installation on page 413.
2. Define a name for the Data Mart and select the SQL Server where the nice_dw database
resides. See Define the Data Mart on page 414.
3. Install NICE domains in the Data Mart. This builds the structure of the Data Mart. See Install
the NICE Domains on page 416.
4. Determine which databases will be linked to domains in the Data Mart. In a Multi Data Hub
environment, this step must be repeated per Data Hub. Link the Databases to the NICE
Domains on page 418.
5. (optional) To use NICE Perform’s Interaction Analytics feature, My Universe, or KPI, see
Multidimensional Database Configuration for Interactions Analytics and My Universe
on page 431.
Customization Options
After you build the Data Mart, you can customize it as follows:
• Modify SQL job properties. See Define Data Mart Properties on page 420.
• Modify the number of days the Transfer Log is retained. See Define Data Mart Properties
on page 420.
• Determine the displayed user name formats. See Define Data Mart Properties on page 420.
• Determine the SNMP thresholds. See Define Data Mart Properties on page 420.
• Modify a default schedule. See Modifying a Data Mart Schedule on page 423.
• Create a new schedule. See Creating a Customized Schedule on page 424.
2 The Data Mart is populated with data from the NICE databases at defined
schedules (based on the Population Schedule SQL jobs).
2
Applications NICE Databases Data Mart
Server Reporter
Database
1 1
Applications Applications
Server Server
NICE Databases NICE Databases
1 In each Data Hub, the Applications Server writes information to the NICE
databases.
2 The Data Mart is populated with data from the NICE databases from each Data
Hub at defined schedules (based on the Population Schedule SQL jobs).
NOTE: In a Financial Trading Floor environment, the nice_IB database may also be
installed.
IMPORTANT
After the Data Mart is defined and the domains are installed (see Install the NICE Domains
on page 416), it is strongly recommended that you do not delete the Data Mart database or the
Data Mart definition in System Administrator.
2. In the Organization tree, expand the Primary Data Hub branch and select the Data Marts
branch.
IMPORTANT
In a Multi Data Hub organization, this procedure must be completed using the Primary Data
Hub, not one of the Secondary Data Hubs!
3. From the Actions menu, select New Data Mart. The Add Data Mart Wizard starts.
6. Click OK. The Data Mart name appears below the Data Marts branch in the Organization tree.
The General tab of the Data Mart appears in the Details pane.
Reporter: QM Package QM
3. Click New > NICE Domains. The Install NICE Domains window appears.
4. Select the checkboxes for each domain that will be installed in the Data Mart. You must select
the Administration domain.
5. Click Install. The domains are installed one by one and the progress bar displays the
installation process.
6. Click Close when the installation is completed. The installed domains appear in the Domains
tab.
IMPORTANT
After the Data Mart is defined and the domains are installed (see Install the NICE Domains
on page 416), it is strongly recommended that you do not delete the Data Mart database or the
Data Mart definition in System Administrator.
In a Multi Data Hub environment, link the databases to their corresponding domains, one Data
Hub at a time.
The Administration and Rules domains can be linked to corresponding databases from one Data
Hub only (usually the Primary Data Hub). After you link these domains to databases in one Data
Hub, the system does not allow you to link the domains to databases in other Data Hubs.
All other domains can be linked to databases from all Data Hubs.
4. In the Domains area (the bottom area), select the databases that should be linked to the
corresponding Data Mart domains for the selected Data Hub.
5. Repeat this procedure for each Data Hub.
6. Click Save .
After the domains are linked, you can expand a Data Hub to view the domains that will be
populated.
TIP:
• To redefine the links, click Recreate Links and repeat this procedure again.
• If NICE passwords to a database were changed, click Recreate Links and repeat
this procedure again.
SQL Job The number of times a job will retry to run after a failure
The retry interval
The path to the job’s log file
Transfer Log Maximum number of days the data is retained. After this value passes,
the data is deleted.
In the Job Log File Path field, browse to the folder where the log file will be stored.
4. In the Transfer Log Properties area, enter the maximum number of days that the Transfer
Log will be retained. After this number of days pass, the data is deleted from the log.
5. In the SNMP Alert Properties area, enter the threshold for each alert. After this threshold is
exceeded, and your site has an NMS installed, a trap is sent to the NMS.
6. Click Save .
Customizing Schedules
The Data Mart provides three default schedules for the domains. These schedules reflect three
SQL jobs.
• Population schedule: Determines when the domains are populated with data from the
corresponding databases. The default is every hour between 5:00 AM and 11:00 PM.
• Retention schedule: Determines when data which passed the Retention value is deleted. The
default is once a day at 1:00 AM.
The Retention value states how long the data must remain in the Data Mart. The default is 18
months.
• Reindex schedule: Determines when the Data Mart rebuilds indexes for each domain. The
default is once a week - on Saturday at 2:00 PM.
These three schedules are applied to all domains except the Administration and Rules domain.
These domains require the Population schedule only.
You can customize a domain’s schedules in several ways:
• You can modify one of the default schedules. All the domains that are associated with the
schedule will be affected by the change. See Modifying a Data Mart Schedule on page 423.
IMPORTANT
Before modifying a Data Mart Population schedule, take into consideration potential implications.
For example, in an environment with a large volume of calls, decreasing the amount of times per
day that the schedule is run may cause a serious backlog. In this case, the Data Mart will not be
up to date and will cause reports to display data not up to date.
• You can create a customized schedule and apply the schedule to one or several domains. See
Creating a Customized Schedule on page 424 and Selecting Schedules for a Domain
on page 425.
IMPORTANT
The default retention schedule for each domain is 550 days (18 months). When configuring the
Data Mart for live Data Hubs that are older than 550 days, you must extend the retention value
for each domain (except the Administration and Rule domains) to a value that exceeds the
amount of time that data is currently stored in the databases.
After the jobs run and the data is merged, you can change the retention value back to a value
that matches the retention policy at the Data Hub.
For example, the database at your Data Hub already contains 3 years of data. Therefore,
change the retention value to a value greater than 1080 days.
See Selecting Schedules for a Domain on page 425.
To modify a schedule:
1. In the Data Marts branch, select the defined Data Mart.
2. Click the Schedules tab.
3. Double-click a schedule (or select a schedule and click Edit ). The Schedule Details
window appears.
4. In the Recurring Details area, define how often the action occurs.
If you select Daily: Define how often the action occurs.
If you select Weekly: Define how often the action occurs and the days of the week on which it
will occur.
If you select Monthly: Define how often the action occurs and on which days it will occur.
5. In the Daily Frequency area, define how often within a day the action occurs.
6. In the Duration area, define the start date and end date. You can select No end date to keep
the action open-ended.
7. Click OK.
Define as follows:
a. Name the schedule.
b. Define schedule properties. See Modifying a Data Mart Schedule on page 423.
c. Click OK.
4. To apply the schedule to a domain, see Selecting Schedules for a Domain on page 425.
IMPORTANT
When defining a Retention value for a domain, keep in mind:
• The Administration and Rules domain do not require a retention value. Enter 0 in the
Retention field.
• For all other domains, define a retention value greater than 0. If you enter 0 in the
Retention field, data is not retained in the domain at all!
• When configuring the Data Mart for live Data Hubs that are older than 550 days, you must
extend the retention value for each domain (except the Administration and Rule domains)
to a value that exceeds the amount of time that data is currently stored in the databases.
After the jobs run a sufficient number of times for the Data Mart to be up to date, you can
then change the retention value back to a value that matches the retention policy at the Data
Hub. See Viewing Synchronization Details on page 428 for further instructions.
2. In the Domains tab, double-click a domain (or select a domain and click Edit ). The
Domain Wizard window appears.
3. To create a new customized schedule, click New Schedule and create a new schedule. See
Creating a Customized Schedule on page 424.
4. In the Commands area, select a schedule from the drop-down list of schedules. This list
includes all new schedules.
5. To define a new Retention value, change the number of days in the field. This means
that each time the Retention job runs, it will delete data that is older than the Retention value.
For all domains other than Administration and Rules, define a retention value greater than 0.
If you enter 0 in the Retention field, data is not retained in the domain at all!
6. Click OK.
3. To view the job history of one SQL job, select the job. The job step details appear in the
History area.
To start/stop a job
• Select a job in the SQL Jobs area and click Start Job or Stop Job.
To enable/disable a job
• Select a job in the SQL Jobs area and click Enable or Disable.
The Synchronization Details area displays a list of each log with the following information:
• Link Name: The Data Hub from which the data was imported.
• Last Sync Value: The number/date of the last value that was imported.
3. To view detailed transfer data, double-click a log. The Transfer Data History area displays
transfer data for each row in a table.
Interactions Analytics and My Universe require additional databases. These databases are
multidimensional databases. Configuration procedures for these databases must come after the
Data Mart is configured. The multidimensional databases are:
• nice_as_text_analysis
• nice_as_my_universe
• nice_as_kpi
For complete database information, see the Databases Installation Guide.
Contents
Chapter 16: Multidimensional Database Configuration for Interactions Analytics and My Universe 431
Chapter 16: Multidimensional Database Configuration for Interactions Analytics and My Universe 432
3. Select your Data Mart Server. From the right-click menu select Add Analysis Server.
NOTE: You can change the Analysis Server name or location at any time.
Chapter 16: Multidimensional Database Configuration for Interactions Analytics and My Universe 433
5. Click OK.
The Analysis Server Identity window appears displaying the new Analysis Services database.
6. The Cubes area lists the cubes used in the multidimensional databases.
NOTE: The Last Process Date column will remain empty until the first time the
Analysis Services cubes are populated.
Chapter 16: Multidimensional Database Configuration for Interactions Analytics and My Universe 434
8. The SQL Jobs area lists the name(s) of the SQL job(s) that populate/repopulate the Analysis
Services cubes.
The functions of the buttons located in the SQL Jobs area are as follows:
Button Name Function
The SQL Job History area displays a list of the jobs that were previously run.
Schedule
Button
Chapter 16: Multidimensional Database Configuration for Interactions Analytics and My Universe 435
NOTE: The default settings for the SQL jobs are as follows:
• Process KPI Daily schedule - every day at 22:00 (10:00 PM).
• Process KPI Hourly schedule - every hour beginning at 06:30.
• Nice AS Process My Universe - every four hours beginning at 05:30 AM.
• Nice AS Process Text Analysis - every day at 02:00 AM.
Chapter 16: Multidimensional Database Configuration for Interactions Analytics and My Universe 436
The Content Analysis Server enables NICE Perform to automatically extract data from the Content
of any interaction, analyze it, and produce usable results for system users. These results provide
information for a better understanding of the interactions and their implications.
For all Content Analysis Servers you must define general Content Analysis settings and language
settings.
Configure the Content Analysis Server according to the engine installed. Supported engines are:
• Word Search
• Speech-to-Text
For more information about Interaction Analytics, see the Interaction Analytics Installation Guide.
NOTE:
• Content Analysis is installed as a service and operates at all times as long as the
server on which it is installed is running. If, for any reason, the server stops and
starts, Content Analysis will resume its operation as soon as the server restarts.
• Verify that the designated Content Analysis Servers have the same Windows OS
installation, with the same release and same service pack as the applications and
database servers.
Contents
Configuration
parameters
are identical
for all sites
The configuration parameters for Content Analysis are divided into two separate tabs.
In the General tab, you define Connectivity type and Playback Settings, such as search options for
Storage Centers. See Defining General Content Analysis Settings on page 439.
In the Language tab, you define which languages are supported. See Defining Language
Settings on page 440.
NOTE: In multi-site environment, configure the Content Analysis Server on the Master
Site.
2. In the Organization tree, select Site > Content Analysis > Configuration.
The General tab appears.
3. In the General Settings area, for Content Analysis Connectivity Type select the type of
audio input for Content Analysis.
Options are:
• Unsummed/Mixed
• Summed
Sites that are defined as having Summed connectivity, do not have the option for Talkover
or Emotion Detection.
NOTE: Summed or Unsummed/Mixed configuration is defined according to the
recording definition. If Emotion and Talk Analysis were purchased, then
Unsummed/Mixed configuration must be selected.
4. In the Playback Settings area, select both Use Content Analysis Server Playback and
Use CTI Analysis.
5. In the Locate Settings area, select Search Storage Center Only.
6. Click Save.
NOTE: To change any of the above recommended settings, see Overriding Playback
Settings on page 461.
NOTE: In a multi-site environment, configure the languages on the Master Site only.
The number of languages available are dependent on your NICE Perform license permissions.
Define languages for analysis available at your site.
2. In the Organization tree, select Master Site > Content Analysis > Configuration.
5. Click Next. The Language Selection window appears. displaying default language -
English (US).
English (US)
is the default
language
Clear
English (US)
Select Spanish
• If you require multiple languages, select the languages installed at your site. Then click
Next.
NOTE: You can select multiple languages only if your license permits more than one
language. Multiple language packs can only include the following languages:
• English (US)
• English (UK)
• French
• Spanish
• Spanish (North American)
• Spanish (South American)
Select
English (UK)
Select
English (US)
Select Spanish
7. Click Next.
NOTE: If you selected multiple languages, adjust the percentages to reflect the
expected percentage that each language will be accessed for load balancing. The
default equally divides the percentages of each language to the sum of 100. The total
percentages must be equal to 100.
For example, if there is more traffic in your site for English US, change the value of
English US to 60% and change the values for English UK and Spanish to 20% each.
Please consult with the Solution Engineer or Project Manager to define the correct
percentages.
8. Click Finish.
2. Select the Content Analysis Server. The Analysis Types area appears in the right pane.
3. Redefine the Analysis Settings:
• To redefine a Word Search server, see Defining a Word Search Content Analysis Server
on page 447.
• To redefine a Speech-to-Text Analysis server, see Defining a Speech-to-Text Content
Analysis Server on page 455.
5. Click Finish.
The Languages tab appears with the new settings.
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
3. Right-click the Content Analysis branch and select New Content Analysis Server.
The Content Analysis Server Wizard starts.
Name This name appears in the System Administrator tree and when
you define a Storage Area. Enter an easy to identify name for this
Content Analysis Server.
HTTP Port Leave the default value.
TCP Port Leave the default value.
Host Name Enter the Host Name
-or-
IMPORTANT
To set the Process Settings for sites other than the current site, you must coordinate with the
Solution Engineer.
Click to expand
NOTE: Playback Settings, for CTI Analysis and Locate Order, were defined for all
Content Analysis Servers in the Configurations branch, General tab. If you override
these settings, the settings you select here will be applied only to the Content Analysis
Server you are now defining. If you want to override the playback settings that were
previously defined in the Configuration tab, see Overriding Playback Settings
on page 461.
8. Scroll down to the Media Cache area. Media Cache is the folder where the audio files are
temporarily stored for fetching audio files for analysis.
9. Leave the default in the Folder Path field for the media cache.
NOTE: Make sure the Media Cache Folder Path you assign when configuring the
Content Analysis Server is identical to the Destination Folder you will assign when
installing the Content Analysis Server. The path should be: ...\Program Files\NICE
Systems\NICE ContentAnalysis\MediaCache.
10. Leave the default size of 5 GB, unless the Solution Engineer advises otherwise.
11. Click Next. The Analysis Settings window appears.
14. In the Number of Word Search Analysis Threads drop-down list, select the number of
word search threads. The number is dependant on the number of CPUs residing on the Content
Analysis Server. If you have a 2 Quad Core CPU, then select 5 (This is the default requirement
according to the Certified Servers document).
EXAMPLE:
If your have a 2 Quad Core CPUs, then select 5 from the Number of Word Search Analysis
Threads drop-down list.
The Task Manager below displays eight CPUs, five are used for word search analysis purposes,
and one is used for content analysis purposes. Since there are eight CPUs, in this case, select 5
to be used for the number of word search analysis threads.
15. If the Storage Area field does not appear, skip this step and proceed to Step 21.
NOTE: The Storage Area field does not always appear as it is language dependent.
16. Click New Storage Area. The Storage Manager wizard starts.
If you define a storage area, this Content Analysis Server will be the owner of that storage
area. The Storage Area owner checkbox will reflect this and be displayed as selected. This
checkbox is disabled. It is an information checkbox only.
NOTE: If the Content Analysis Server works in conjunction with a centralized Index
Storage, from the Storage Area, select the centralized storage area from the
drop-down list. Use of a centralized storage configuration must be in conjunction with
the Solution Engineer.
IMPORTANT
Once you define a Storage Area, it cannot be removed!
Name This name appears in the System Administrator tree and when
you select a Storage Area for a Content Analysis Server. Enter an
easy to identify name for this Storage Area.
Host Name Enter the Host Name.
-or-
Content Analysis Select the Content Analysis Server that will use this Storage
Server Area. This Content Analysis Server becomes the owner of this
Storage Area. The owner is responsible for the Storage Area
maintenance, including recycling and retention.
If you are defining the Storage Manager from the Content
Analysis Servers wizard, then the server that you are defining, is
the owner of the Storage Area.
Note: Only a Word Search Server can be a Storage Area owner.
Recycle Indexes Define how much space of the disk must be full to clean the disk
When Reaching space used for indexes. This is the responsibility of the Storage
Area owner.
20. Click Finish. The new Storage Area definition re-appears. Storage Area configuration is
complete!
22. Click Finish. The new Word Search Content Analysis Server definition appears.
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
3. Right-click the Content Analysis branch and select New Content Analysis Server.
The Content Analysis Server Wizard starts.
IMPORTANT
To set the Process Settings for sites other than the current site, you must coordinate with the
Solution Engineer.
Click to expand
NOTE: Playback Settings, for CTI Analysis and Locate Order, were defined for all
Content Analysis Servers in the Configurations branch, General tab. If you override
these settings, the settings you select here will be applied only to the Content Analysis
Server you are now defining. If you want to override the playback settings that were
previously defined in the Configuration tab, see Overriding Playback Settings
on page 461.
8. Scroll down to the Media Cache area. Media Cache is the folder where the audio files are
temporarily stored for fetching audio files for analysis.
9. Leave the default in the Folder Path field for the media cache.
NOTE: Make sure the Media Cache Folder Path you assign when configuring the
Content Analysis Server is identical to the Destination Folder you will assign when
installing the Content Analysis Server. The path should be: ...\Program Files\NICE
Systems\NICE ContentAnalysis\MediaCache.
10. Leave the default size of 5 GB, unless the Solution Engineer advises otherwise.
11. Click Next. The Analysis Settings window appears.
14. In the Number of Speech to Text Analysis Threads drop-down list, select 3. The number
is dependant on the number of CPUs residing on the Content Analysis Server.
2. Click Yes.
The Content Analysis Server definition is deleted!
• The settings in the Applications branch are specific for the Site under which they are defined.
• If you define settings on the Content Analysis > Configuration branch, these settings will
override the Applications branch settings for all the servers on all the sites in your
organization. This applies only to Content Analysis, not to other Storage Center operations.
• If you define settings on a specific Content Analysis server, these settings will override the
global Content Analysis settings for that specific Content Analysis server.
The table below describes different possibilities to override Playback settings.
If you want to change the Playback settings for the Content Analysis Server, perform the below
procedure:
• Search Loggers only Do not search the Storage Center (there is no Storage
(No Storage Center) Center at the site).
• Search Storage Center 1. Search the Logger where the interaction was
after searching Source recorded.
Logger 2. Search the Storage Center.
• Search Storage Center Only search the Storage Center and do not search the
Only Loggers.
3. Click Save.
If there are overrides on the Content Analysis server branch or on the Content Analysis Server
branch (all options are disabled), the default from the Applications branch will be used.
IMPORTANT
Once you define a Storage Area, it cannot be removed!
2. In the Organization tree, select Site > Content Analysis > Storage Manager.
3. Right-click the Storage Manager branch and select New Storage Area.
Name This name appears in the System Administrator tree and when
you select a Storage Area for a Content Analysis Server. Enter an
easy to identify name for this Storage Area.
Host Name Enter the Host Name.
-or-
Shared Folder Enter the folder name of phonetic indexing file system location.
Name For example, Index. When preparing the server, create this
folder as a shared folder on the server.
Content Analysis Select the Content Analysis Server that will use this Storage
Server Area. This Content Analysis Server becomes the owner of this
Storage Area. The owner is responsible for the Storage Area
maintenance, including recycling and retention.
If you are defining the Storage Manager from the Content
Analysis Servers wizard, then the server that you are defining, is
the owner of the Storage Area.
Note: Only a Word Search Server can be a Storage Area owner.
Recycle Indexes Define how much disk must be full to clean the disk space used
When Reaching for indexes. This is the responsibility of the Storage Area owner.
7. Click Finish.
8. Click Save .
Storage Area configuration is complete!
Although NICE Perform is installed on internal networks, due to security policies, there is an
increasing demand to secure the communication with the Applications Server.
NICE Perform Secure Client Communication can be utilized with NICE Perform solutions to
achieve secure communication with the Applications Server.
IMPORTANT
Before deploying Secure Client Communication, acquire and install certificates according to the
Digital Certificate Usage with NICE Perform Security Solutions Guide.
Contents
• Message objects used to carry the necessary data to invoke a remote method.
• Message sink objects used to process messages for remote method calls.
• Transport channel objects used to transfer the serialized messages from one process to
another.
The .NET Remoting channels send each message along a chain of channel sink objects prior to
sending or after receiving a message. The sink chain consists of sinks required for basic channel
functionality (i.e. formatter and transport sinks) and customized sinks which are optional.
NICE Perform Secure Communication Solution leverages .NET Remoting customized channel
sinks architecture to secure the transport and communication between the NICE servers and
clients.
IIS
on Applications Server
Stream Server
3. In the Organization tree, select Master > Applications > Configurations > General.
The General tab appears.
Figure 18-4 General Tab
Succeeded
Failed
• Key size - selecting a larger the key size will provide greater security, however the
overhead will cause slower performance.
• Session Lifetime - this is how often security refreshed. selecting a shorter time will
provide greater security, however the overhead will cause slower performance.
9. Click Save .
10. Restart NICE Services.
2. In the Organization tree, select Site > Applications > Configurations > General.
In a Multi Data Hub environment, you can test security from any site.
The General tab appears.
Failed
Contents
Chapter 19: Configuring NICE Perform Components for Media Encryption 477
IMPORTANT
If the nice_crypto database is not installed, complete the following steps. See the Databases
Installation Guide for help.
1. Install the nice_crypto database.
2. Configure the database in the System Administrator application. (Navigate to Databases,
select the SQL server, and select nice_crypto in the list of installed databases.
3. Install the latest Update Pack.
nice_crypto
Chapter 19: Configuring NICE Perform Components for Media Encryption 478
3. In the System Administrator application, navigate to the Databases branch, select the SQL
server, and verify that the nice_crypto database is selected.
4. From the Control Panel, select Add or Remove Programs, and verify that the latest Update
Pack is listed in the Currently Installed Programs list.
5. Verify that the SQL Server Certificate is installed. See Using Digital Certificates with NICE
Perform Security Solutions in a separate guide for help.
• In a Multi Data Hub environment, a CA (root) certificate is required for each of the KSMs in
the system.
• (To use a domain user to define the IIS user identity) Add a domain user to the Windows
Built-in IIS group. See Defining an IIS User Identity on page 485.
• Anonymous access from the IIS Web Site. See Enabling Anonymous Access from the IIS
Web Site on page 488.
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
2. In the Organization tree, expand the Master Site > Security > Media Encryption. The
General tab appears.
3. The first time you select Media Encryption, the KSM Configuration Status appears as Failed.
Chapter 19: Configuring NICE Perform Components for Media Encryption 480
NOTE: The status information reflects the results of the last test. The current status
might differ. To update the status, click the Test button. (The status can actually be
succeeded even though failed is displayed, in which case the KSM will work, and vice
versa.)
KSM Configuration Status reflects the certificate status of the workstation where you
are currently working (where the System Administrator application is open, not where
the NICE Perform Applications Suite is installed).
4. Right-click Media Encryption and select Media Encryption Wizard. The Media Encryption
Wizard starts.
Chapter 19: Configuring NICE Perform Components for Media Encryption 481
The IIS Certificate Status should be assigned. This certificate is installed and assigned on
the server where the NICE Perform Applications Suite is installed.
NOTE: A IIS Certificate Status of Non-Assigned indicates that the Application
Server does not have a certificate for IIS. Such a certificate should be installed now and
the Key Storage Manager Server Configuration procedure should be restarted.
6. The IIS User Identity is for internal use only. You can use the default username and password
(choose New User) or an Existing User that you defined.
a. New User - a new user is created. The new user definition overwrites the previous user
default. The new user is created with a default username and password. You do not need to
save this information.
The defaults are: Username: KSMuser Password: NiceUser1
-or-
b. Existing User - select the user from the Username drop-down list and type the correct
Password.
NOTE: The Username drop-down list does not include domain users but only those
users included in the IIS_WPG group. You need to add relevant domain users to the
IIS_WPG group in order to select them from the list.
First time
Subsequent runs
Chapter 19: Configuring NICE Perform Components for Media Encryption 482
a. The first time you run the Media Encryption Wizard, you define the Database Master Key
password. Type the New password twice.
-or-
b. If this is not the first run, you can change the password for the Database Master Key. To
change the password, mark Regenerate Database Master Key. Then type the New
password twice.
9. Save the new password in a safe place. You will need this password in the event that you
have to restore the Cryptographic Database.
10. Click Next.
The Summary window appears.
11. Click Finish. The Media Encryption setup is complete. The KSM Status and Configuration
details appear.
Chapter 19: Configuring NICE Perform Components for Media Encryption 483
2. In the Organization tree, expand Site > Security > Media Encryption. The General tab
appears.
3. In the KSM Synchronization Interval box, enter or scroll to the number of minutes between
KSM Synchronizations. (The maximum is 1440 minutes, or one day.)
4. Click Save .
The new synchronization interval becomes effective immediately!
Chapter 19: Configuring NICE Perform Components for Media Encryption 484
• ...\<location of applications>\KeyStorageManager\WebService\EncryptionBackupFiles
These permissions are:
• Read & Execute
• Read
• Write
You define these permissions on the Security tab of the folder. To access the Security tab, right-
click the folder, and select Properties. Then click the Security tab.
Chapter 19: Configuring NICE Perform Components for Media Encryption 485
Chapter 19: Configuring NICE Perform Components for Media Encryption 486
4. Click Add.
The Select Users, Computers, or Groups window appears.
5. In the Enter the object names to select area, enter the domain name and username in the
following syntax: domain name\username.
EXAMPLE:
If the domain name is NICE_SYSTEMS, and the username is sharonca, enter:
NICE_SYSTEMS\sharonca.
Chapter 19: Configuring NICE Perform Components for Media Encryption 487
In the Enter the object names to select area, the domain name and username changes to
display the username and email of the domain user.
7. Click OK.
Chapter 19: Configuring NICE Perform Components for Media Encryption 488
Requirements
The requirements for configuring Media Encryption are:
• A CA (root) certificate must be installed on the Logger.
• .NET Framework 2.0 and up must be installed.
• EFS is enabled and configured on the Logger.
• In the System Administrator, the Logger has a valid license key that includes encryption to the
Logger.
2. In the Organization tree, expand Master Site > Logger Servers > NiceLog.
Add the Logger that has an encryption key.
Click Save.
Chapter 19: Configuring NICE Perform Components for Media Encryption 489
3. Click the Global tab. In the Audio Encryption drop-down list, the default set up is
Disabled.
Chapter 19: Configuring NICE Perform Components for Media Encryption 490
NOTE: If you work with the Logger without restarting it, you will receive a Warning
message.
Chapter 19: Configuring NICE Perform Components for Media Encryption 491
3. Play back an interaction, and verify that the padlock appears in the Player.
Chapter 19: Configuring NICE Perform Components for Media Encryption 492
Chapter 19: Configuring NICE Perform Components for Media Encryption 493
Chapter 19: Configuring NICE Perform Components for Media Encryption 494
Chapter 19: Configuring NICE Perform Components for Media Encryption 495
NOTE: The files in the folder are encrypted according to the user who creates them.
Even though the Administrator marks the folder for encryption during the installation and
configuration of Audio Analysis, the audio files are created by the Audio Analysis Server,
and can be accessed only by the Audio Analysis service that created them.
IMPORTANT
If the connection between the Audio Analysis Server and the KSM is lost, all analyses will fail
since the audio cannot be decrypted.
When the connection is restored, the Audio Analysis Server resumes functioning. However, the
requests that failed when the connection to the KSM was lost are not analyzed automatically.
Chapter 19: Configuring NICE Perform Components for Media Encryption 496
Contents
IMPORTANT
The password is crucial for database restoration. It is very important to back up this password
and keep it in a safe place.
Creating this backup is the customer’s responsibility.
IMPORTANT
Remember to save the new password in a safe place! You will need this password in the event
that you have to restore the Cryptographic Database.
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
2. In the Organization tree, expand Site > Security > Media Encryption. Then from the
Actions menu, choose Regenerate DMK. The Database Master Key window appears.
EXAMPLE:
The following example selects the nice_crypto database and creates a backup of the
nice_crypto Database Master Key. Because this Database Master Key is not encrypted by the
Service Master Key, a password must be specified when it is opened.
USE nice_crypto;
OPEN MASTER KEY DECRYPTION BY PASSWORD = 'sfj5300osdVdgwdfkli7';
BACKUP MASTER KEY TO FILE = 'c:\temp\exportedmasterkey'
ENCRYPTION BY PASSWORD = 'sd092735kjn$&adsg';
GO
Note: If the nice_crypto database is already selected, there is no need to include the USE
nice_crypto; command.
IMPORTANT
The Service Master Key should be backed up and stored in a secure, off-site location, as anyone
who has access to the Service Master Key and the SQL Server can decrypt the media
encryption keys.
Creating this backup is the customer’s responsibility. It should be one of the first
administrative actions performed on the server.
EXAMPLE:
In the following example, the Service Master Key is backed up to a file.
BACKUP SERVICE MASTER KEY TO FILE =
'c:\temp_backups\keys\service_master_key' ENCRYPTION BY PASSWORD =
'3dH85Hhk003GHk2597gheij4';
WARNING The Service Master Key is the root of the SQL Server encryption hierarchy. The
Service Master Key directly or indirectly secures all other keys in the tree. If a dependent key
cannot be decrypted during a forced restore, data that is secured by that key will be lost.
EXAMPLE:
The following example is the command to restore the Service Master Key from a backup file.
RESTORE SERVICE MASTER KEY
FROM FILE = 'c:\temp_backups\keys\service_master_key'
DECRYPTION BY PASSWORD = '3dH85Hhk003GHk2597gheij4';
GO
EXAMPLE:
The following command can be used to restore the Database Master Key of the nice_crypto
database.
USE nice_crypto;
RESTORE MASTER KEY
FROM FILE = 'c:\backups\keys\nice_crypto_master_key'
DECRYPTION BY PASSWORD = '3dH85Hhk003#GHkf02597gheij04'
ENCRYPTION BY PASSWORD = '259087M#MyjkFkjhywiyedfgGDFD';
GO
EXAMPLE:
-- Create db master key and encryption password
OPEN MASTER KEY DECRYPTION BY PASSWORD = '<Nice_password>'
GO
alter master key drop encryption by service master key
GO
alter master key add encryption by service master key
GO
3. Click the Accessories tab, and select Systems Administrator in the dropdown list.
4. Select the database by expanding Master Site > Database Services, and select the database.
All backups are saved to the same file. This ensures that the restore operation is performed on the
latest backup of the log.
NOTE: After the log backup, the log is truncated, and the next backup is appended to
the last available backup file. When a full or differential database backup is performed,
all available log backups are deleted, as they are no longer necessary.
• If the nice_crypto database is off-line and does not start, try to perform a tail-log backup,
using the following command:
BACKUP LOG nice_crypto TO <backup_device> WITH CONTINUE_AFTER_ERROR
NOTE: Since no transactions can occur at this time, using WITH NORECOVERY is
optional.
To automatically back up the tail of the log using SQL Management Studio:
1. Open the SQL Management Studio by clicking Start and choosing Programs >Microsoft
SQL Server > SQL Server Management Studio.
2. Expand the SQL Server and Databases.
3. Right-click nice_crypto, and select Tasks > Back Up.
4. From the Backup type dropdown list, select Transaction Log, and click OK.
The backup operation takes place.
3. Make sure that the databases are in the following order, according to the Type column:
1. Full
2. Differential
3. Transaction Log
and make sure that all checkboxes are selected.
4. Click OK. The restore operation takes place.
IMPORTANT If the Cryptographic Database was backed up on one machine, and you want to
restore it on a different machine, you must re-encrypt the database master key. See Re-
encrypting the Database Master Key by a New Service Master Key on page 503 for details.
This section describes how to configure the Telephony Services Server for Playback to Extension
(Instant Callback).
IMPORTANT
In this context, Playback to Extension and Instant Callback are the same.
Contents
Overview........................................................................................................................510
Configuring a Telephony Services Server.................................................................. 511
Creating a New Telephony Services Server.............................................................512
Configuring Playback to Extension for the Analog/Digital Interface .........................517
Configuring Playback to Extension for the H.323 IP Interface .................................519
Configuring Playback to Extension for the SIP IP Interface .....................................523
Verifying Switch Extensions for Analog Playback to Extension..............................529
Modifying the Telephony Services Server Definition ................................................530
Verifying NICE Services ...............................................................................................531
Deleting a Telephony Services Server Definition ......................................................532
What is a Dial Plan? .....................................................................................................533
How to Select a Dial Plan.........................................................................................534
Defining a Dial Plan..................................................................................................535
Defining a Search Order for Telephony Services Servers ........................................542
Overview
IMPORTANT
Before configuring the Telephony Services Server, ensure that: the Interactions Center (CLS) is
installed, configured, and running, and that the switch is configured for Instant Callback.
The Telephony Services Server enables you to play back audio to your telephone extension.
You can have one or more Telephony Services Servers installed at your site. When you have more
than one Telephony Services Server, each user’s playback requests are handled by the Telephony
Services Server connected to the switch on which they are defined. Each Telephony Services
Server has a fixed number of ports available for this purpose.
To maximize playback resources you can define a Dial Plan. The Dial Plan enables requests for
playback to utilize the resources of other Telephony Services Servers. If you will be using the
Playback Last Calls IP Phone Application feature, you must define a Dial Plan. For a
description of dial plans and how to create them, refer to What is a Dial Plan? on page 533.
The Telephony Services Server is required for the following features/functionalities:
• Creating Clips (in the Business Analyzer application)
• Playing back and listening to interactions on a telephone extension using ROD, Business
Analyzer, Monitor, etc. This is called Playback to Extension or Instant Callback.
• Customer Feedback
NOTE:
• Playback to speakers or a sound card on a user workstation does not require a
Telephony Services Server.
• You can configure the Telephony Services Server before installing its software and
all configuration settings will be saved. However, in this case, during the
configuration procedure, an error message will display.
• To listen to audio on your telephone extension:
a. Open Player.
b. Select Settings > Select Output.
c. In the Select Output window, enter your extension number and click OK. When
playing back audio, your telephone rings. When you pick up the receiver, the
audio plays back.
IMPORTANT
• When defining the Telephony Services Server, make sure you have the correct Host Name
or IP Address of the machine on which the Telephony Services Server is installed. Do not
use localhost or 127.0.0.1 for the Telephony Services Server Host Name/IP Address. In
some sites, doing so prevents the Telephony Services Server from starting.
• Before configuring the Telephony Services Server, you must be fully familiar with the
Telephony Services Server configuration installed at your site.
• In a Multi Data Hub environment, the Telephony Services Server must be included in the
same data hub as the Interactions database. In this way, in the event that one data hub is
down, the Telephony Services Server can still play back interactions from its local site.
Analog Interface
Digital Interface
• The trunk is physically connected to the port on the HMP board by your switch technician.
• The Dialogic HMP board and software are installed correctly.
• Dialogic HMP software is configured correctly.
IP Interface
1. Naming the Telephony Services Server - define a name that will be used to identify the
Telephony Services Server throughout the System Administrator.
2. Defining the Telephony Services Server location - enter the IP address or host name of
the computer on which the Telephony Services Server is installed. Do not use localhost or
127.0.0.1 for this purpose!
3. Defining ports - configure the ports that are assigned to Playback to Extension.
For instructions on defining ports for Customer Feedback, see Customer Feedback
Configuration on page 543.
• If your licenses were imported, select the relevant license from the Available Keys list.
Click OK.
• If your license key is on a file, click From File. The Licenses window appears.
Double-click
the relevant
licences
In the License Key list, locate and double-click your license key. The Telephony Services
Server License window reappears with the relevant serial number and license key. Click
OK.
• If your license key is not on file, enter the Serial Number and License Key for the
Telephony Services Server. Click OK.
NOTE: If your server contains legacy boards, Telephony Services can be defined for
one interface only.
-or-
If your server is either HMP-based and/or contains DIVA boards (analog interface only),
select Dialogic HMP Based Boards. Then select the interfaces for which you need to
define ports.
5. Click .
System Administrator displays the number of available ports based on your license privileges.
6. Enter the number of ports you need to configure and click OK.
TIP: The available resources can be seen in the System Administrator Organization
tree, in the License Manager branch, Telephony Services tab.
Total number of ports
in the license
WARNING
Do not enter localhost or 127.0.0.1 as the Server Host Name or IP Address! This can prevent the
Telephony Services server from starting!
NOTE: If the default ports are already in use, you can change these port definitions.
c. Click Save .
10. Proceed to one of the following:
• To configure Playback to Extension for the analog/digital interface, proceed to
Configuring Playback to Extension for the Analog/Digital Interface on page 517.
• To configure Playback to Extension for the H.323 IP interface, proceed to Configuring
Playback to Extension for the H.323 IP Interface on page 519.
• To configure Playback to Extension for the SIP IP interface, proceed to Configuring
Playback to Extension for the SIP IP Interface on page 523.
• To configure Customer Feedback, see Customer Feedback Configuration on page 543.
The Ports tab appears displaying the number of ports that have been allocated for this
Telephony Services Server in Creating a New Telephony Services Server on page 512.
TIP:
• If your Telephony Services Server contains legacy Dialogic boards, the E1 digital
interface lists 30 ports, numbered 1-30; the T1 digital interface lists 24 ports,
numbered 1-24.
• To change the Telephony Services interface and/or number of assigned ports, do the
following:
a. In the Organization tree, right-click the new Telephony Services Server branch
that you just created and select Update Configuration. The Telephony
Services Configuration window appears.
b. Change the configuration as described in Creating a New Telephony Services
Server on page 512, steps 4-6.
3. In the Port column, click the first row. An arrow appears in the right side of the row.
4. Click the arrow and select a switch.
5. Click Save .
IMPORTANT
If the configuration has not been completed properly, a message appears stating that the
configuration is not complete. Fix the specified problem and click Save again.
c. Click Save .
4. In the Switch Addresses area, click . You can add several switches here.
IP switch
information
6. In the Organization tree, expand your new Telephony Services Server and select Instant
Callback.
The Ports tab appears displaying the number of ports that have been allocated for this
Telephony Services Server in Creating a New Telephony Services Server on page 512.
TIP: To change the Telephony Services interface and/or number of assigned ports, do
the following:
a. In the Organization tree, right-click the new Telephony Services Server branch that
you just created and select Update Configuration. The Telephony Services
Configuration window appears.
b. Change the configuration as described in Creating a New Telephony Services
Server on page 512, steps 4-6.
7. Define ports as described below:
a. In the Switch column, click the first row. An arrow appears in the right side of the row.
b. Click the arrow. A list of switches, previously created in the IP Configurations tab, is
displayed. Select a switch.
c. To define another port, in the Switch column, click the next row. Then click the row’s
arrow and select a switch. Repeat this step until all ports are defined.
d. Click Save . You will be prompted to restart the Telephony Services Server. Click
.
IMPORTANT
If the configuration has not been completed properly, a message appears stating that the
configuration is not complete. Fix the specified problem and click Save again.
The Telephony Services Server restarts and your settings are saved.
TIP: If you define the Telephony Services Server before installing its software,
although an error message appears, configuration settings are saved.
b. Select the server on which the Telephony Services Server is installed. Then select
Monitor Server.
c. Click Save .
NOTE: The Aspect configuration currently supports Customer Feedback only and not
Playback to Extension.
a. Click the Switch drop-down arrow and select the relevant physical switch.
b. Enter the IP address of the SIP proxy server.
c. In the Type field, leave the default setting.
d. Adjust the Codec Rate if necessary. The Codec type is fixed at G.711.
e. Skip the Extension Identifiers option. This option is relevant to Customer Feedback only.
f. To configure registered SIP extensions or endpoints, proceed to Step 6.
-or-
If you do not need to configure registered SIP extensions or endpoints, proceed to Step 7.
IMPORTANT
Prior to configuring the registered SIP extensions, consult with your switch technician to receive
all relevant parameters.
Parameter Description
Register for ICB If your switch is configured to use SIP endpoints for Playback to
(Playback to Extension/ Extension, select this option.
Instant Callback only)
SIP Authentication If your switch requires authentication for SIP registration, select
this option.
Use login as Extension To use the agent extension number as the login, select this option.
Realm Enter the protected domain name as configured in the SIP Proxy.
Example: nice.com
Default Password Enter the default authentication password used by all SIP endpoint
registrations.
Note: When necessary, this can be changed for individual ports.
7. Click OK.
The IP Configurations tab displays the new IP switch configuration information.
8. In the Organization tree, expand your new Telephony Services Server and select Instant
Callback.
The Ports tab appears displaying the number of ports that have been allocated for this
Telephony Services Server in Creating a New Telephony Services Server on page 512.
TIP:
• Each port corresponds to a SIP endpoint defined on the switch. When registration
requires authentication, the SIP endpoint definition also includes login and password
parameters.
• To change the Telephony Services interface and/or number of assigned ports, do the
following:
a. In the Organization tree, right-click the new Telephony Services Server branch
that you just created and select Update Configuration. The Telephony
Services Configuration window appears.
b. Change the configuration as described in Creating a New Telephony Services
Server on page 512, steps 4-6.
Parameter Description
Switch 1. In the Switch column, click the first row. An arrow appears in the
right side of the row.
2. Click the arrow. A list of switches, previously created in the IP
Configurations tab, is displayed. Select a switch.
3. To define another port, click the next row. Then click the row’s
arrow and select a switch. Repeat this step until all ports are
defined.
Note: Only switches configured in the IP Switch window appear
here.
SIP Reg Login Enter the SIP registration login provided by your switch technician.
(SIP Authentication
only)
SIP Reg Pass Enter the SIP registration password provided by your switch
(SIP Authentication technician.
only)
10. Click Save . You are prompted to restart the Telephony Services Server. Click
.
IMPORTANT
If the configuration has not been completed properly, a message appears stating that the
configuration is not complete. Fix the specified problem and click Save again.
The Telephony Services Server restarts and your settings are saved.
TIP: If you define the Telephony Services Server before installing its software,
although an error message appears, configuration settings are saved.
b. Select the server on which the Telephony Services Server is installed. Then select
Monitor Server.
c. Click Save .
2. Click Save . You are prompted to restart the Telephony Services Server. Click
.
WARNING
Deleting a component definition without uninstalling the component can cause your system to
malfunction.
Uninstalling the Telephony Services server does not automatically remove its definition from your
site. You must delete the Telephony Services server’s definition in System Administrator.
We recommend performing this procedure before uninstalling the Telephony Services Server. This
will eliminate the risk of leaving invalid paths in the site configuration.
NOTE: You can also delete a Telephony Services Server by right-clicking its name and
selecting Delete Telephony Services Server.
• If your site will be using the Playback Last Calls IP Phone Application, you must define a Dial
Plan.
• If you are creating a dial plan between a Source and a Destination on the same switch, you
usually will not need a prefix. However, if your site requires this, a prefix can be defined.
• Except for playback to workstation speakers, each time a user plays back an interaction, an
internal request for playback is made to the Telephony Services Server.
• Each time a clip recording is recorded, an internal request for playback is made to the
Telephony Services Server.
• Each Telephony Services Server has a fixed number of ports available for handling playback
requests.
• Each Telephony Services Server is defined, in the System Administrator, on a switch. Each
user is defined, in the Users Administrator, on a switch. A Telephony Services Server that is
defined on the same switch as a user is considered the user’s local Telephony Services
Server.
• A Telephony Services Server can be connected to more than one switch.
• When activating playback in the SIP playback environment, do not enter a phone number that
begins with the pound (#) key. In this scenario, Playback to Extension will fail to work.
A Dial Plan enables you to share resources and can perform playback across switches. You can
have one Telephony Services Server shared with several switches, or your site may have more than
one Telephony Services Server with several switches.
The preferred configuration is that each switch has its own Dial Plan with an empty prefix. The
empty prefix is a default setting.
How does the Dial Plan function? When all the ports on the switch of the local Telephony Services
Server are in use, a Dial Plan enables another switch to play back interactions in its place.
• You want to restrict all playback requests to using their local Telephony Services Server.
NOTE: Full functionality of the Telephony Services Server can be achieved without a
Dial Plan.
A Dial Plan gives you the added value of maximizing your resources when more than
one Telephony Services Server is installed.
• If a site has more than one Telephony Services Server but no Dial Plans are defined, when you
start playback, the user selects None as the Location in the Playback Select Output window. In
this case, the number in the Extension Number field must include all prefixes (unless it is an
extension on your local switch).
EXAMPLE:
You want the interaction played to a telephone at area code 222, to the telephone number 999
1234. You must dial 9 for an outside line. Enter 92229991234 in the Extension Number field.
If you want the interaction played to an internal extension (your own - 1234), enter just the
extension number (1234) in the Extension Number field.
IMPORTANT
Any time that an agent selects None as the Location, the Telephony Services Server dials the
extension number entered in the window. All defined dial plans will be ignored.
• Clip Recording - Enables recording clips that are attached to coaching packages. These
calls need to be recorded. If the call uses extension-side recording, the call is recorded
automatically and does not require a prefix. However, if the call uses trunk-side recording,
then the call requires an outside line. Define all trunk-side Clip Recording Dial Plans with
the prefix that is required to access an outside line, such as 9.
NOTE: When a user selects a location, the user is not aware which Telephony
Services Server is actually being used.
1. From Switch A to Switch A (from the switch back to itself - to call the user’s extension). This
is the basic dial plan and allows the user to enter only an extension number and his/her
location (Switch A).
2. From Switch B to Switch A (from another location to the local location - to enable use of
another Telephony Services Server). The user still enters only an extension and his/her
location (Switch B). The Dial Plan automatically supplies the rest.
NOTE: If you have one site, even if it has several switches and/or Telephony Services
Servers, defining this option has no relevance.
You can also define customized dial plans from your switch to a specific location, such as when an
agent or supervisor works off-site. See Defining a Playback to Telephone Dial Plan for a
User-Defined Switch on page 539.
EXAMPLE:
An agent on Switch A enters his/her extension number in a playback window. All ports on Switch
A are busy. An available port is found on Switch B. Switch B needs to dial the prefix 123 before
the extension that the agent entered. Create a dial plan from Switch B to Switch A with the
defined prefix 123.
Each time a clip created on Switch A is recorded on Switch B, the switch must dial 9. Create a
dial plan from Switch A to Switch B (coaching) with the defined prefix 9.
3. In the Instant Callback or the Clip Recordings area, click New. The Dial Plan Definition
window appears.
NOTE: You can mark more than one switch for each Telephony Services Server
Source. This can only be done when you create the dial plan and not when you edit it.
IMPORTANT
In a Clip Recording dial plan, if the call is a trunk-side recording, then the call requires an outside
line. Define all trunk-side Clip Recording Dial Plans to the prefix that is required to access an
outside line, such as 9.
Additionally, in the case of Clip Recordings the Prefix may consist of a prefix to dial an outside
line and an additional prefix to connect the switches, for example 9 123.
6. In the Prefix area, enter the desired Prefix for the dial-plan.
NOTE: If you have to dial for an outside line, in the Prefix area, in the Prefix field, enter
the relevant prefix.
7. Click OK.
The new dial plan appears in the relevant dial plan section.
8. Continue with Defining a Search Order for Telephony Services Servers on page 542.
4. In the Add user-defined switches area, enter a name for the user-defined switch in the
Switch Name field. Then click . The new user-defined switch appears in the list of
User-Defined switches.
5. Click OK.
The Dial Plan tab appears.
6. In the Instant Callback to User-Defined Switches area, click New. The Instant Callback to
User-Defined Switch window appears.
NOTE: You can mark more than one switch for each Telephony Services Server
Source. This can only be done when you create the dial plan and not when you edit it.
8. In the Destination area, click the Switch drop-down list and select the relevant user-defined
switch. All user-defined switches that you create display in this list.
9. In the Prefix area, enter the desired Prefix for the dial-plan.
10. Click OK.
The new dial plan appears in the Instant Callback to User-Defined Switches section.
11. Continue with Defining a Search Order for Telephony Services Servers on page 542.
2. Use the following guidelines to select the order by which an available Telephony Services
Server is located.
• Networking - the Telephony Services Servers at the agent’s location will be searched
first. Select this option if your site uses internal communications over the LAN. This will
reduce the amount of long distance calls made for playback.
• Telephony - the Telephony Services Servers closest to the media will be searched first.
Select this option if your site uses external communications.
3. Click Save .
WARNING
Some of these procedures restart your Telephony Services Server. This will interfere with any
functions in your system that are currently running and require the Telephony Services Server for
instant callback.
Functions that require the Telephony Services Server are: creating clips, playback to a telephone
extension, and using other active surveys.
Confirm that these functions are not currently required, or wait to proceed until a later time.
Contents
The number and types of ports available for Feedback is determined by the license you purchased.
The ports you purchased are available for distribution, by you, to all the Telephony Services
Servers on all the Data Hubs in your Organization.
You can see the total number of purchased ports, and the current distribution in the License
Manager window as follows:
• The total number of ports purchased according to your license. These ports are available
for distribution across all the Telephony Services Servers on all the Data Hubs in your
Organization.
• The number of ports currently allocated to each Telephony Services Server. This appears
in the License Definition list.
• The number of ports still available (free) for allocation to a Telephony Services Server.
TIP: To view the License Manger window:
a. Open the System Administrator.
b. Select Organization > License Manager.
Referring to the figure below, There are licenses for 100 IP Feedback ports. 15 of them are
allocated (5 to Telephony A and 10 to Telephony B). This leaves a remainder of 85 free ports.
Total number of ports Number of ports
in the license not yet allocated
If the Telephony Services Server is already defined in the System Administrator, and the correct
amount of ports are allocated to it for Customer Feedback, continue with Initial Setup
Procedures for Customer Feedback on page 553.
For complete information about Licenses, see Managing Licenses on page 33.
c. Define a license in one of the following ways:
• If your licenses were imported, select the relevant license from the Available Keys
list. Click OK.
• If the license key is in a file, click From File. The Licenses window appears.
In the License Key list, locate and double-click the license key. The Telephony
Services License window reappears with the relevant serial number and license key.
Click OK.
• If the license key is not on file, enter the Serial Number and License Key for the
Telephony Services Server. Click OK.
HMP - IP Ports
7. Enter the number of Feedback ports you want allocated to this server as follows:
• Enter the number of Dialogic Analog ports in the Analog field.
• Enter the number of Diva ports in the Analog field.
• Enter the number of HMP - IP ports in the HMP - IP field.
If necessary, you can change this number at a later date by repeating this procedure.
8. Click OK.
The new Telephony Services Server appears in the Organization tree with a Feedback branch.
If Instant Callback ports were defined, then an Instant Callback branch also appears.
Feedback branch
The General tab of the Telephony Services Server appears. You now define the Telephony
Services Server.
NOTE: If the default ports are already in use, you can change these port definitions.
Avaya Genesys 6
For a sample of the switch configuration, see the Customer Feedback Setup Guide.
If you have an Avaya environment integrated with Cisco Unified Contact Center Enterprise
(UCCE), see the Customer Feedback Setup Guide.
The following procedure describes how to map UCID Business Data columns using the System
Administrator. For an overview of Business Data columns, see Using Business Data Fields
on page 31.
TIP: The UCID (Universal Call ID) value is built from the following values:
• Node ID (similar to switch ID)
• Call ID (cyclic)
• Time Stamp (cyclic)
UCID Example
00001001411206342646
00141 - Call ID
1206342646 - Time Stamp - The time, in seconds, that has elapsed since system
initialization. This value reaches 9999999999 and then begins
again from 0 (zero).
4. In the New Optional ID field, select the appropriate value. See the following table for the
correct value. Then click OK.
Avaya Genesys 6
5. Click Save .
6. Continue with Defining General Parameters for Customer Feedback on page 555.
IMPORTANT
This procedure restarts your Telephony Services Server. Instant Callback (used to create Clips)
will be disabled while the Telephony Services Server restarts. Do this procedure while your
system is not in use.
2. Complete the following details. These settings apply to all surveys in your Data Hub.
Minimum Survey Weight - The minimum amount, in percentage and according to question
weight, of a survey that must be completed in order to be saved. This percentage is computed
according to question weight, not according to the number of questions in the survey. This has
no relation to the survey score.
Example: If you enter 60 in this field, all surveys with less than 60% of the survey completed,
according to question weight, will not be saved.
If a survey has three questions, one of which is 60% of the total score, and the other two are
20% each, the survey score will be saved even if only the first question is answered. If only the
last two questions are answered, the survey scored will not be saved and the survey score will
be n/a (because only 40% of the survey was completed).
Agent Transfer Timeout - Applies only to Manual Transfer. Agents must transfer the caller
to the survey using a blind transfer (the agent disconnects before the caller is connected to the
survey). If the agent transfers the caller using a consultation transfer, the survey will not begin
until the agent disconnects. This is to prevent the agent from hearing and participating in the
survey. Timeout is the maximum amount of time, in seconds, to wait between the agent
transferring the caller and disconnecting. If the agent does not disconnect during this time
period, the call will be dropped and the caller will be returned to the agent.
Default Survey - If the intended survey fails, reroute to and play this survey. If you select
Empty Survey, the caller will hear a few seconds of silence, and then be disconnected. Leave
this as Empty Survey while setting up your system. When you create a default survey, you can
change this to the correct survey. Do not select Prompt Recorder!
Monitor all open interactions for correlation
All interactions must be monitored in order to correlate with the corresponding surveys. This
option is selected and read-only for H.323 and SIP Trunk environments. For SIP Extension
environments, consult with technical support before selecting. If this option is selected (by
default or by your choice) you might have to define Extension Identifiers. See What are
Extension Identifiers and When to use them on page 573.
Agent to Survey Correlation after Transfer
If an interaction is transferred between agents, specify which agent should be associated with
this survey. Choices are:
First Agent - The survey is associated with the first agent who answered the interaction.
During playback, only the first segment is played.
Last Agent - The survey is associated with the last agent who handled the interaction.
During playback, only the last segment is played.
Not Applicable - The survey is not associated with any agent and is treated as a survey
which rates the general service of the contact center. Drill-down will not work for these
interactions. Each segment is associated with a different agent.
3. Click Save . Your settings are saved and the Telephony Services Server restarts
automatically.
4. Continue with Defining a Retention Period for Voice Comments on page 557.
3. Click Save .
4. Continue with Configuring Customer Feedback Ports on page 558.
• H.323 Interfaces - continue with H.323 Interfaces: Configuring Ports on page 561.
• SIP Extension Interfaces - continue with SIP Extension Interfaces: Configuring Ports
on page 565.
• SIP Trunk Interfaces - continue with SIP Trunk Interfaces: Configuring Ports
on page 570.
In some environments, you will require Extension Identifiers. See What are Extension
Identifiers and When to use them on page 573/
3. If the expected amount of ports do not appear, see Defining Feedback Ports on a Telephony
Services Server on page 545.
4. Select a port and do the following:
a. Click the Switch field and select a switch from the list.
b. In the Extension field, enter the extension number for the port. See Defining Surveys
Routed by DTMF Parameters on page 581.
IMPORTANT
In the following step you define the criteria for selecting a survey. Verify which options are
supported by your site configuration. If you select an option not supported, the definition will be
saved, however, the survey will not be loaded properly!
c. In the Survey Upload Type and Survey Upload Data columns, select as follows:
DTMF The survey loaded is selected according to the DTMF value. (In
previous versions, this was referred to as Avaya Automatic
Routing.)
CTI Information The survey loaded to the port is selected according to information
received from the switch. In the Survey Upload Data column,
select DNIS, VDN, or Phone Number. (In previous versions, DNIS
was referred to as Manual Transfer.)
Business Data The survey loaded to the port is selected according to a value in a
specific Business Data field. In the Survey Upload Data column,
select the Business Data Field.
Specific Survey The same, designated survey will always be loaded to this port. In
the Survey Upload Data column, select the survey.
Prompt Recorder The port will be used to record survey prompts.
New
3. In the Telephony Services IP Configuration area, select H.323. The Switches area reflects
the parameters necessary for H.323 definitions.
4. Make Call Timeout is relevant for Instant Callback only. Accept the default.
5. In the Switches area, click New. The IP Switch Definition window appears.
Extension Identifier
• Codec Rate - Select the same Codec Rate that is set in the switch.
• Extension Identifier - Required for correlation in some environments. See What are
Extension Identifiers and When to use them on page 573.
7. Click OK to close the IP Switch Definition window.
The IP Configurations tab displays the new IP switch configuration information.
9. Click Yes.
10. Expand the Telephony Services Server branch and select the Feedback branch.
12. If the expected amount of ports do not appear, see Defining Feedback Ports on a Telephony
Services Server on page 545.
13. In the Survey Upload Type and Survey Upload Data columns, select as follows:
DTMF The survey loaded is selected according to the DTMF value. (In previous
versions, this was referred to as Avaya Automatic Routing.)
CTI Information The survey loaded to the port is selected according to information
received from the switch. In the Survey Upload Data column, select
DNIS, VDN, or Phone Number. (In previous versions, DNIS was
referred to as Manual Transfer.)
Business Data The survey loaded to the port is selected according to a value in a
specific Business Data field. In the Survey Upload Data column, select
the Business Data Field.
Specific Survey The same, designated survey will always be loaded to this port. In the
Survey Upload Data column, select the survey.
IMPORTANT
Prior to configuring the registered SIP extensions or endpoints, consult with your switch
technician to receive all relevant parameters. You will need this information for Step 7.
New
3. In the Telephony Services IP Configuration area, select SIP Extension. The Switches
area reflects the parameters necessary for SIP Extension definitions.
4. Make Call Timeout is relevant for Instant Callback only. Accept the default.
5. In the Switches area, click New. The IP Switch Definition window appears.
Do not select
Register for ICB
Codec Rate Select the same Codec Rate that is set in the switch.
Extension Required for correlation in some environments. See What are Extension
Identifier Identifiers and When to use them on page 573.
Realm Enter the protected domain name as configured in the SIP Proxy.
Example: nice.com
Default Password Enter the default authentication password used by all SIP
endpoint registrations.
Note: When necessary, this can be changed for individual ports.
Confirm Password Enter the default authentication password again.
TIP: Each port corresponds to a SIP endpoint defined on the switch. When registration
requires authentication, the SIP endpoint definition also includes login and password
parameters.
13. If the expected amount of ports do not appear, see Defining Feedback Ports on a Telephony
Services Server on page 545.
14. For each SIP Extension port, do the following:
a. Click a new row and define the following:
Switch Click the Switch column and select a switch.
Note: Only switches configured in the IP Switch window appear.
SIP Reg ID Enter the SIP endpoint identifier.
SIP Reg Login Enter the SIP registration login provided by your switch technician.
SIP Reg Pass Enter the SIP registration password provided by your switch technician.
b. In the Extension column, enter the extension number for the port. See Verifying Switch
Extension Numbers on page 589.
c. In the Survey Upload Type and Survey Upload Data columns, select as follows:
DTMF The survey loaded is selected according to the DTMF value. (In
earlier versions, this was referred to as Avaya Automatic Routing.)
CTI Information The survey loaded to the port is selected according to information
received from the switch. In the Survey Upload Data column,
select DNIS, VDN, or Phone Number. (In previous versions, DNIS
was referred to as Manual Transfer.)
Business Data The survey loaded to the port is selected according to a value in a
specific Business Data field. In the Survey Upload Data column,
select the Business Data Field.
Specific Survey The same, designated survey will always be loaded to this port. In
the Survey Upload Data column, select the survey.
Prompt Recorder The port will be used to record survey prompts.
Enter the Login and Password values of your Aspect switch. Then click OK.
e. If the Monitor all open interactions for correlation option was not selected (see
Defining General Parameters for Customer Feedback on page 555), the Correlated
By column appears. Click the Correlated By field and select one of the following:
Compound ID
Call ID - Avaya Recommended
UCID - Avaya
For an overview, see the Customer Feedback Setup Guide.
15. Repeat Step 14 for each Port.
New
3. In the Telephony Services IP Configuration area, select SIP Trunk. The Switches area
reflects the parameters necessary for SIP Trunk definitions.
4. Make Call Timeout is relevant for Instant Callback only. Accept the default.
5. In the Switches area, click New. The IP Switch Definition window appears.
Extension Identifier
• Codec Rate - Select the same Codec Rate that is set in the switch.
• Extension Identifier - Required for correlation in some environments. See What are
Extension Identifiers and When to use them on page 573.
7. Click OK to close the IP Switch Definition window.
The IP Configurations tab displays the new IP switch configuration information.
9. Click Yes.
10. Expand the Telephony Services Server branch and select the Feedback branch.
12. If the expected amount of ports do not appear, see Defining Feedback Ports on a Telephony
Services Server on page 545.
13. In the Survey Upload Type and Survey Upload Data columns, select as follows:
DTMF The survey loaded is selected according to the DTMF value. (In
previous versions, this was referred to as Avaya Automatic Routing.)
CTI Information The survey loaded to the port is selected according to information
received from the switch. In the Survey Upload Data column,
select DNIS, VDN, or Phone Number. (In previous versions, DNIS
was referred to as Manual Transfer.)
Business Data The survey loaded to the port is selected according to a value in a
specific Business Data field. In the Survey Upload Data column,
select the Business Data Field.
Specific Survey The same, designated survey will always be loaded to this port. In
the Survey Upload Data column, select the survey.
Prompt Recorder The port will be used to record survey prompts.
Extension Identifiers are a way of extracting just the unique telephone number from a long
sequence of numbers and characters received from the CTI. The unique telephone number is
needed to correlate surveys with interactions.
Each CTI has its own system identifiers in addition to a unique number for each telephone.
In both of the following samples, the unique number is 45678.
123.123.123.20:1000,45678
TA:123.123.123.2:1000,TEL:45678,NAME:4567,4567
When the Interactions Center (CLS) stores an interaction, it first strips away all known prefixes
and suffixes, leaving just the unique telephone number with the interaction record.
When the Telephony Services Server receives a Customer Feedback survey from the CTI, it
receives the entire telephone number (prefixes, suffixes, and unique number).
In order for the Telephony Services Server to match surveys with interactions, the prefix and suffix
must be stripped away and the unique telephone number extracted.
Extension Identifiers are the known common prefixes and suffixes that the Telephony Services
Server can remove. Several known prefixes and suffixes are predefined in your system and you do
not have to redefine them.
The Extension Identifier you define must be a sequence of character that only appear once in the
string, allowing them to be easily identified as a stop point.
Examples:
• If the format received is 123.123.123.20:1000,45678, define the extension identifier
as :1000, to extract just 45678.
• If the format received is TA:123.123.123.2:1000,TEL:45678,NAME:4567,4567, define two
extension identifiers as TEL: and ,NAME to extract just 45678.
NICE Perform automatically extracts the unique number from several different known switches.
You do not need to define Extension Identifiers in these cases.
The following scenarios require Extension Identifiers:
• Whenever Monitor all open interactions for correlation is selected.
• Telephony Services that have more than one CTI. The CTI number must becomes the
Extension Identifier.
• Telephone numbers received in an unknown format. (From a switch whose format was not
predefined.)
2. Continue as follows:
If the number required is... Continue with... Example: To extract 12345 from...
in the middle of the string Step 5 on page 576 start string:12345:rest of string
3. If the unique number is at the end of the string, remove the beginning of the string as follows:
Example: Extract 12345 from “start string:12345”
a. Select Extension is at end of number.
b. In the String before extension field, enter the characters immediately before the unique
extension number. Be sure to enter punctuation marks. You do not have to enter the entire
string, just a unique section. Enter string:
c. Click Add Rule. The rule is added to the Rules Defined section.
• Click Test Rule. The stripped number appears in the Result Extension box.
c. Click Add Rule. The rule is added to the Rules Defined section.
• Click Test Rule. The stripped number appears in the Result Extension box.
d. Click Add Rule. The rule is added to the Rules Defined section.
• Click Test Rule. The extracted number appears in the Result Extension box.
Recording Prompts
Survey prompts can be recorded outside of your NICE Perform system at a recording studio or
other suitable facility. To use prerecorded prompts, see Integrating Prerecorded Prompts
on page 578.
All prompts must be saved on the Telephony Services Server where the Survey is saved. If your
recording is for longer than one minute, only the first minute of the recording will be heard.
TIP: You can listen to the recorded survey. However, this does not complete the
Feedback setup. To listen to the recorded survey, see with Listening to a Recorded
Survey on page 580.
Requirement Value
Channels 1 (mono)
Prerecorded prompts must be renamed according to the Customer Feedback naming conventions
and placed in the correct location on the Telephony Services Server. Prompt file names consist of
the Question ID. Question IDs are unique system-wide, therefore there will not be any duplicate
file names.
EXAMPLE:
The file name of the prompt for Question ID 101 will be 101.wav. For Question ID 102 it will be
102.wav, etc.
3. You can listen to the recorded survey. However, this does not complete the Feedback setup. To
listen to the recorded survey, see with Listening to a Recorded Survey on page 580.
4. Continue with Routing a Call to a Survey on page 581.
IMPORTANT
When you have completed listening to the survey, reassign the port-extension to its previous
state so that it can continue to be used for playing surveys.
The Ports tab appears displaying the number of ports that have been allocated for this
Telephony Services Server.
2. Select a row and in the Survey Upload Type column, select Specific Survey.
3. In the Survey Upload Data column, select the survey.
5. Click Yes.
6. From a telephone connected to your switch, dial the extension number of the row selected and
listen to the survey.
7. When you have completed listening to the survey, reassign the Survey Upload Type to its
previous state so that it can continue to be used for playing surveys.
8. Continue with Routing a Call to a Survey on page 581.
New
New
9. Repeat from Step 4 for each survey or CTI value you want to define.
Business Data parameters are defined in the System Administrator. For instructions on defining
Business Data, see Using Business Data Fields on page 31.
New
8. Click OK.
9. Repeat from Step 4 for each survey or CTI value you want to define.
7. Click Yes.
8. Continue with Adding the Telephony Services Server to the NMS on page 589.
2. In the Default Survey field, select your default survey. If you select No Survey, the caller will
hear a few seconds of silence, and then be disconnected.
Do not select Prompt Recorder!
4. Click Yes.
5. Continue with Adding the Telephony Services Server to the NMS on page 589.
4. Click Save .
WARNING
Some of these procedures restart your Telephony Services Server. This will interfere with any
functions in your system that are currently running and require the Telephony Services Server for
instant callback.
Functions that require the Telephony Services Server are: creating clips, playback to a telephone
extension, and using other active surveys.
Confirm that these functions are not currently required, or wait to proceed until a later time.
To add components in the System Administrator, you must work in Technician Mode.
2. From the Settings menu, select Technician Mode.
3. Select the Telephony Services Servers branch, then a Telephony Services Server, and then
Feedback.
4. Modify the relevant fields. Then click Save . You will be prompted to restart the
Telephony Services Server. Click Yes.
The Telephony Services Server restarts and your settings are saved.
Figure Show
OnlineOnly Show
StreamServer Show
TechOnly Show
UsersPrint Show
UsersOnline Show
StreamPrint Show
The NICE Stream Server is part of the NICE Perform Applications Suite installation.
The NICE Stream Server solution is used when your site has problems streaming media from the
logger. The NICE Stream Server enables you to stream any relevant media from either a Single
Data Hub or a Multi Data Hub, from either a local or remote location. You can stream anything
that can be played by the NICE Player.
The Stream Server branch is always available under the System Administrator tree. The
default Stream Server is defined automatically the first time you open the System Administrator.
IMPORTANT
The Stream Server will only function if you have enabled streaming at the site level.
Contents
NOTE:
• For the purpose of the information in this section, Storage Centers function in the
same way as Loggers.
• Choosing Disabled in Stream Server Availability connects the Player directly to a
Logger.
• When reviewing these diagrams, look at each scenario as if your site is where the
local site configuration is.
1.
1.
• In the Stream Server Availability area, leave the default setting of Stream Server status
Disabled.
2.
1.
• At the Local
site - Preferred
configuration:
-or-
-or-
Scenario 2:
• At the Local
site - configure
this when one or
more Loggers at
Remote site are -or-
not accessible:
• At the Remote
site:
2. 2.
1.
1.
When a user at a Local site plays a call from his/her Local site, the streaming is done through
his/her own site’s Stream Server.
When playing a call from a Remote site, the user connects to the remote site’s Stream Server,
which performs the streaming (Server at Logger site).
-or-
2. 3.
1.
When a user at a Local site plays a call from a Remote site, the streaming is done through his/her
own site’s Stream Server. This local site’s Stream Server connects directly to the remote site’s
Stream Server, which in turn connects to the Loggers (Server to Server).
• At the Local
site:
-or-
• At the Remote
site:
1. 1.
To set streaming for Server at Player site for Remote Interactions only:
Scenario 1:
• At the Local
site - Preferred
configuration:
Scenario 2:
• At the Local
site - configure
this when one or
more Loggers at
Remote site are
not accessible:
• At the Remote
site:
1. 1.
When a user at a Local site plays a call from a Remote site, the streaming is done through his/her
own site’s Stream Server, which connects directly to the remote site’s Stream Server, which in turn
connects to the Loggers. When playing a Local site call, the client connects directly to the Logger.
• At the Local
site:
• At the Remote
site:
2.
1.
1.
When a user at a Local site plays a call from his/her local site, the streaming is done through
his/her own site’s Stream Server (Server at the Player site). When playing a call from a Remote
site, the user connects directly to the Logger (no Stream Server is used).
To set streaming for Server at Player site for Local Interactions only:
• At the Local
site:
-or-
• At the Remote
site:
IMPORTANT
The Stream Server to function, you should first enable streaming in the site level.
NOTE: If you disable the Stream Server Availability, you disable all Stream Servers.
If you have problems streaming media from the logger, when you need to use the Stream Server
you can enable it.
2. Navigate to <your Site> > Playback > Stream Servers . The Stream Server Availability
area appears.
Click Enabled
6. Continue with Configuring the Default Stream Server Definition on page 605.
IMPORTANT
The default Stream Server does NOT support WMS Streaming. If you require WMS Streaming,
you should configure a new Stream Server, see Optional - Defining a New Stream Server
on page 606.
NOTE: In the General Information area, all the fields are automatically completed
with the default settings.
NOTE: If you need to configure additional Stream Servers, first complete the definition
of the default Stream Server (continue with Defining System Streaming on page 608)
and then define the new Stream Server. Follow the relevant Stream Server installation
checklist.
IMPORTANT
When defining the Stream Server, make sure you have the correct Host Name or IP Address
of where the Stream Server is installed. Do not use localhost or 127.0.0.1 for the Stream
Server Host Name/IP address. You will receive an error if you do this.
NOTE: If you are defining a Stream Server for the first time, you need to enable the
Stream Server status. See Enabling Stream Server Availability on page 603.
If you do not require additional Stream Servers, see Configuring the Default Stream Server
Definition on page 605.
Select New
Stream Server
2. From the Actions menu, select New Stream Server. The New Stream Server appears in the
General tab.
3. In the General Information area, in the Server Host Name/IP Address field, enter the new
Stream Server name.
IMPORTANT
The new Stream Server is automatically created with localhost in the Server Host Name/IP
Address field. Delete localhost and enter the correct Stream Server name and port
information.
Note: There is a limitation on the number of characters that can be used when defining the
Switch Name. You should use no more than 100 characters.
If this information is not correct and if you are using Windows Media Server streaming, you will
not be able to select a Publishing Point and the Stream Server will not be able to connect to the
Publishing Point.
4. Leave the default settings for the TCP Server Port and the HTTP Server Port fields.
5. In the Server Description field, enter a description for the new Stream Server.
6. Continue with Defining System Streaming on page 608.
• Local Interactions
Local interaction system streaming method can be enabled for either only local users or for all
users. The default setting is for local users only.
• Remote Interactions
There are two options available here:
Connect directly to media source: This is the default Remote Interactions system
streaming method. With this option, the client connects to the Stream Server and then connects
directly to the media source either Logger, Storage Center, or NiceScreen Logger.
Use remote stream server configuration
With this option, you can either connect directly or through another Stream Server if the other
site has a Stream Server defined with local interactions allowed for all users.
NOTE: To disable System Streaming, clear the Enable System Streaming checkbox.
4. Click Save .
5. You will be prompted to restart the Stream Server. Click .
6. Continue with Viewing All Stream Server Configuration Information on page 610.
2. System Streaming is enabled by default if you have enabled Stream Server Availability. To
disable System Streaming, clear the Enable System Streaming checkbox.
2. Expand Stream Servers. The Stream Servers area appears displaying all Stream Servers with
their Stream Server Name, Host Name/IP Address, and Streaming Method information.
Double-click the
selected Stream Server
to view detailed
information
3. To view further information regarding a specific Stream Server, double-click the relevant
Stream Server. The selected Stream Server appears.
4. To create a new Stream Server, see Optional - Defining a New Stream Server on page 606.
5. To modify a Stream Server, see Modifying the Stream Server Definition on page 611.
6. To delete a Stream Server, see Deleting a Stream Server Definition on page 612.
2. Right-click the Stream Server and click Delete Stream Server. A message appears asking if
you want to delete the selected Stream Server.
3. Click Yes. The Stream Server is deleted.
The NICE Stream Server is part of the NICE Perform Applications Suite installation.
The NICE Stream Server solution is used when your site has problems streaming media from the
logger. The NICE Stream Server enables you to stream any relevant media from either a Single
Data Hub or a Multi Data Hub, from either a local or remote location. You can stream anything
that can be played by the NICE Player.
The Stream Server branch is always available under the System Administrator tree. The
default Stream Server is defined automatically the first time you open the System Administrator.
You can install additional Stream Servers as needed at each site.
NOTE: You should set up Windows Media Services (WMS) BEFORE you configure the
WMS Stream Server.
IMPORTANT
The Stream Server will only function if you have enabled streaming at the site level.
Contents
In the Media Services Configuration, you select whether you want the system optimized for WAN
or LAN. For streaming through a WAN, this is the best solution.
You also select the relevant Control Protocol for your system.
The ASF File Configuration enables you to adjust the quality of the picture that you are streaming.
NOTE: By setting the Maximum Screen Settings towards More the quality of the
picture improves, however the streaming is slower. When setting the Maximum
Screen Settings towards Less, streaming is faster but the quality of the picture is
reduced.
IMPORTANT
You configure the Publishing Point in the WMS Administrator BEFORE you configure the WMS
streaming. To verify the necessary disk space required for the Publishing Point, see the latest
Design Considerations Guide.
NOTE: You can view the exact path of the Publishing Point folder in the Path field.
When you define the Publishing Point configuration, you can allow a Client Cache and/or a Server
Cache. Detailed information regarding the Client Cache and Server Cache configurations appear
below:
• Allowing Client Cache
Allowing Client Cache enables the user to save a copy of the streamed file to his/her own
computer. This option is controlled by the Stream Server and is by default not enabled. It
provides the user with better performance when playing the media, as the media will no longer
need to be streamed.
NOTE: There is a delay for a few seconds before this setting takes place.
NOTE: If you disable the Stream Server Availability, you disable all Stream Servers.
If you have problems streaming media from the logger, when you need to use the Stream Server
you can enable it.
Click Enabled
IMPORTANT
When defining the Stream Server, make sure you have the correct Host Name or IP Address
of where the Stream Server is installed. Do not use localhost or 127.0.0.1 for the Stream
Server Host Name/IP address. You will receive an error if you do this.
NOTE: If you are defining a Stream Server for the first time, you need to enable the
Stream Server status. See Enabling Stream Server Availability on page 617.
Select New
Stream Server
2. From the Actions menu, select New Stream Server. The New Stream Server appears in the
General tab.
3. In the General Information area, in the Server Host Name/IP Address field, enter the new
Stream Server name.
IMPORTANT
The new Stream Server is automatically created with localhost in the Server Host Name/IP
Address field. Delete localhost and enter the correct Stream Server name and port
information.
Note: There is a limitation on the number of characters that can be used when defining the
Switch Name. You should not use more than 100 characters.
If this information is not correct and if you are using Windows Media Server streaming, you will
not be able to select a Publishing Point and the Stream Server will not be able to connect to the
Publishing Point.
4. Leave the default settings for the TCP Server Port and the HTTP Server Port fields.
5. In the Server Description field, enter a description for the new Stream Server.
6. Continue with Enabling and Defining Windows Media Server Streaming on page 619.
Select to enable
WMS Streaming
Select the
relevant Control
Protocol
Select
Optimized for
WAN
2. In the Media Services Configuration area, from the Control Protocol drop-down list,
select the relevant protocol for your site. (RTSPT is the default setting.)
• If you are using Windows Media Server streaming through a WAN, leave the default
setting.
• If you are using Windows Media Server streaming through a LAN, select Optimized for
LAN.
3. In the ASF File Configuration area, adjust the Maximum Screen Settings slide according
to your requirements.
IMPORTANT
If no publishing points display, verify that you have configured the Publishing Point in the WMS
Administrator before you select the Location name.
4. In the Publishing Point Configuration area, click the Location Name drop-down list and
select the relevant publishing point. Once you have set the location name, the Publishing Point
path appears in the Path field.
Select the
Publishing Point
folder
If desired, select
Allow Client Cache
IMPORTANT
If the publishing points do not appear, verify that the name of the Stream Server and its port
information are correct.
5. In the Publishing Point area, select Allow Client Cache to enable a Client Cache.
6. In the Retention area, clear Allow Server Cache if you do not want a Server Cache.
Note: If the Allow Server Cache checkbox is cleared, then a new file is created each time a
playback request is made.
7. In the ASF file cleaning interval (minutes) field, enter the interval in minutes at which you
want the size of the Server Cache to be checked.
8. In the ASF file expiration period (minutes) field, enter the duration in minutes that you
want the streamed files to be kept.
Note: Files that are played infrequently are deleted before files that are played frequently.
9. In the Quote Size (MB) field, enter the size of the Server Cache.
10. Click Save . You will be prompted to restart the Stream Server. Click .
11. Continue with either:
• Optional: Defining Digital Rights Management (DRM) Configuration
-or-
• Configuring Users and Groups for WMS Streaming on page 624.
IMPORTANT
Before you can define the Digital Rights Management (DRM) configuration, you MUST have
installed and activated it. See the Stream Server Installation Guide.
Note: If you have not installed the DRM software, the Enable encryption checkbox is disabled.
If you have installed the DRM, but not activated the license, a message appears.
License is
installed but NOT
activated
After you activate the license and enable encryption, a message appears informing you that the
license is installed and activated. It also advises you regarding the number of days left for the
license. This message is updated on a daily basis. When the number of days for the license falls
below thirty, the message displays in red.
NOTE: If you enable encryption, both the Server and Client caches will be disabled.
Select Enable
encryption
1. In the Digital Rights Management (DRM) Configuration area, select the Enable
encryption checkbox. The number of days for activation display underneath.
If the Digital Rights Management software has not been installed, the Enable
encryption checkbox is disabled.
Enable encryption is
disabled
NOTE:
2. Repeat Step 1 for each Stream Server requiring encryption.
3. Continue with Configuring Users and Groups for WMS Streaming on page 624.
4. From the Available Items list, select the relevant group/user. Click the . The selected
group/user appears in the Selected Items list.
2. Expand Stream Servers. The Stream Servers area appears displaying all Stream Servers with
their Stream Server Name, Host Name/IP Address, and Streaming Method information.
Double-click the
selected Stream Server
to view detailed
information
3. To view further information regarding a specific Stream Server, double-click the relevant
Stream Server. The selected Stream Server appears.
4. To create a new Stream Server, see Defining a New Stream Server on page 617.
5. To modify a Stream Server, see Modifying the WMS Stream Server Definition on page 626.
6. To delete a Stream Server, see Deleting a Stream Server Definition on page 627.
3. Click Save . You will be prompted to restart the Stream Server. Click .
2. Right-click the Stream Server and click Delete Stream Server. A message appears asking if
you want to delete the selected Stream Server.
3. Click Yes. The Stream Server is deleted.
You must define the Screen Content Analysis Server parameters via the System Administrator
application. In a Multi Data Hub environment, a Screen Content Analysis Server must be defined
for each site in which Screen Content Analysis was installed.
Contents
Guidelines
2. In the Organization Tree, expand the appropriate site branch (Primary Data Hub or a
Secondary Data Hub) and select the Screen Content Analysis Servers branch.
3. From the Actions menu, select New Screen Content Analysis Server. The Screen Content
Analysis Server Definition appears.
e. Click Save .
Before the Storage Center server is installed in the site, you first define the Storage Center
parameters.
TIP: In the System Monitoring branch, you can view a list of all the Storage Center
servers that were defined. For each Storage Center and all the storage areas defined
for the Storage Center, you can view current status information and you can generate
a history report of the storage usage.
Contents
• Procedure 1: Defining the Define a logical name for the server and enter the IP address or
Storage Center Server host name. You can also define a specific location/size for the
on page 634 Retrieve Storage Unit, other than the default parameters.
• Procedure 3: Defining a Each Storage Group is comprised of one or more units. For each
Storage Unit on page 644 unit, define:
• a unit name and type.
• the storage location.
• the storage size and maximum threshold.
IMPORTANT
In the Applications > Configurations branch, you must configure the order in which all
storage media are searched when a query is run (Locate Order).
Each time you define a Storage Center Server, be sure to add the Storage Center to the list of all
the defined Storage Center servers in the site - in the appropriate order of priority.
IMPORTANT
If the Storage Center server has more than one active network interface card, the Storage
Center IP address defined in the System Administrator must be the primary network connection.
4. Enter the Serial Number and License Key and click OK. The Storage Center Server
Definition Wizard starts.
b. Select IP address or host name, and enter the IP address or the host name of the server.
IMPORTANT
The host name of the Storage Center server cannot exceed 26 characters.
IMPORTANT
Only advanced users should change default settings!
The default location and size of the Retrieve Storage Unit is displayed.
You can define a different location and size for the Retrieve Storage Unit.
After the Retrieve Storage Unit is created, its location and size cannot be modified!
8. Click Next. Step 4 appears showing a summary of the new Storage Center server definition.
9. Check that the values are correct and click Finish. The new Storage Center server name
appears below the Storage Center Servers branch. You can now define the Storage Groups
of the new Storage Center server.
10. If your site has an NMS installed, add the new Storage Center server to the NMS monitored
list:
a. In the Organization tree, expand Network Management System and select an NMS.
b. Click the Monitored Server tab.
c. Move the new server from the Available Servers list to the Attached Servers list and
click Save .
NOTE: When you create a new Storage Center server, two branches appear automatically
below the server name in the tree.
• ESM Devices: If your site includes an Enterprise Storage Manager, you must configure
the ESM parameters. See Procedure 4: Defining an ESM Device on page 652.
• Retrieve Group: This is the location where files are stored after they are retrieved from
an ESM. The Retrieve group cannot be modified.
These branches cannot be deleted.
Retention Guidelines
By default, there is no mandatory retention. We recommend setting the retention value to equal the
amount of days that the site is obligated to save interactions.
IMPORTANT
• The maximum retention period is seven years (based on the NICE database design). If you
want to set a longer retention period, Storage Center enables you to define a period longer
than seven years (you can enter a higher value in the Retention field). However, the NICE
database must be modified as well!
In these cases, please contact NICE Professional Services.
• (Extended Retention Only) EMC Centera is the only ESM device that supports Extended
Retention.
If you set a retention value for the group and the Storage Units in the group reach maximum
capacity before the retention period expires, a warning is generated and the files are not deleted.
NOTE: When you define a storage rule, you can define a value for Force Deletion,
meaning that files archived by a specific rule will be deleted after a certain number of days.
What happens if a conflict occurs between the group’s Retention value and a rule’s Force
Deletion value (such as the group’s Retention value is set to 100 days and the rule’s Force
Deletion value is set to 50 days)?
The Force Deletion value of the rule takes preference!
However, if Extended Retention is activated through the NICE Business Analyzer
application or the Interactions application, the Force Deletion value in the archiving rule is
extended. See the Storage Center Installation Guide.
The group Retention value is a more general definition; the archiving rule Force Deletion
value is specific to a group of archived files; Extended Retention delays the Force Deletion
in the archiving rule.
In addition to the Storage Groups that you create, Storage Center automatically creates a Retrieve
Storage Group (with a Retrieve Storage Unit) each time that a Storage Center Server is created.
This Storage Group serves as a local buffer when retrieving files from the ESM to the Storage
Center local disk.
The Retrieve Storage Group cannot be deleted. However, you can define a specific Retrieve
Storage Unit destination and the disk space allocated for this unit other than the default. This must
be defined in the Storage Server Definition Wizard and cannot be modified at a later time. See
Procedure 1: Defining the Storage Center Server on page 634.
When archiving for a rule begins, files are archived to the first Storage Unit in the group. When
this Storage Unit reaches capacity, the files are archived to the second Storage Unit in the group,
and so on.
When all the Storage Units are filled to capacity, the following occurs:
• First, the automatic deletion mechanism is triggered in the first Storage Unit.
• Then, files in this storage directory are deleted.
• Finally, new files are archived in the directory.
This pattern then continues for each Storage Unit in the group.
EXAMPLE:
You plan on defining a rule that archives all outgoing interactions that lasted more than five
minutes from agents in the Special Campaign group.
First, create a Storage Group named Special Campaign - Storage Partitions that consists of the
following Storage Units:
Storage_Unit1: \\sc_206154\disk1\archive (with 10 GB)
Storage_Unit2: \\sc_206164\disk2\archive (with 30 GB)
Storage_Unit3: \\sc_206174\disk3\archive (with 150 GB)
Later, when you define the rule you will associate the rule with the Storage Partitions group.
Leave the checkbox cleared if you do not want to set a retention value.
-or-
Select the checkbox and enter a retention value, meaning the number of days that files must
remain archived in this Storage Group.
TIP:
• We recommend setting the retention value to equal the amount of days that the
site is obligated to save interactions.
• If your site does not have an ESM device but the retention value of the Storage
Group cannot be set to seven years, set the retention value to the maximum
possible value. When configuring the Force Deletion value in the storage rule, do
not exceed this retention value. See Retention Guidelines on page 640 for more
information.
NOTE:
• If the Storage Units in the group reach maximum capacity before the retention
period expires, a warning is generated and the files are not deleted.
• If a Force Deletion value (for a storage rule) is set to delete files earlier than the
retention days, the Force Deletion takes precedence and files will be deleted.
5. Click Next. Step 4 appears showing a summary of the new Storage Group definition.
6. Check that the values are correct and click Finish. The New Storage Unit Definition Wizard
appears. Continue with Procedure 3: Defining a Storage Unit on page 644.
NOTE: The New Storage Unit wizard opens automatically at the end of the New Storage
Group wizard. You can also open this wizard independently.
IMPORTANT
If your Storage Center environment includes an ESM, do not use the same destination path as
defined in the Retrieve directory. This could lead to a loss of archived files!
The storage area on which the Storage Center will archive must not be located on the Storage
Center server’s local hard drive, but on an external NAS/SAN or CAS storage.
Directory Per Day Creates subdirectories under the defined directory path (for each day of
(default) the year).
Files are stored as follows:
Storage directory/computer name of the Storage Center server/tasks/day.
When the storage directory reaches its maximum threshold, the
automatic deletion mechanism is triggered. Files are deleted until the
total capacity of the storage directory is below the maximum threshold.
The maximum threshold is a percentage of the total directory size.
Multiple Directories Creates subdirectories under the defined directory path (based on the
destination type). Files are written to the subdirectories in a cyclic
manner: When one subdirectory reaches full capacity, files are written to
the next subdirectory.
The automatic deletion mechanism is triggered when a specified number
of subdirectories reach full capacity (maximum threshold). Files are
deleted until the (full-capacity) subdirectories are below the maximum
threshold. The maximum threshold value is defined as a percentage of
the total amount of subdirectories.
TIP: In most sites, the Directory Per Day storage type is used.
When should you select Multiple Directories?
Multiple Directories storage type should be used in sites with very high capacities -
more than 300,000 calls per day.
NOTE: The New Storage Unit Wizard also opens automatically after you finish the New
Storage Group wizard.
4. In the Storage Unit Destination Path field, enter a unique storage destination. Important:
The destination path of the Storage Unit must be excluded from anti-virus scans to avoid
playback, performance, and retention issues. See TN0564: Antivirus Certifications for NICE
Products for more information on setting up the anti-virus scan. .
NOTE: When defining the storage destination, keep the following in mind:
• Files are stored in the following path:
Storage directory/computer name of the Storage Center server/Tasks name.
• Enter the full network path (using //).
• The destination directory must be defined as shared with write permissions for the
Storage Center user (NiceSc).
• If your Storage Center environment includes an ESM, do not use the same
destination path as defined in the Retrieve directory. This could lead to a loss of
archived files!
• If you select to continue the wizard without validating the destination path, be sure
to verify manually that the path format is valid, the drive destinations exist and
there is enough free space in the physical location to accommodate the archived
files.
b. Enter the user name and password of the Storage Center service. (This is the user name
and password of the logged-in user who installed the Storage Center software.)
c. Click Validate.
The system validates the destination path of the new Storage Unit.
6. Click Next. Step 3 appears. If the path was valid, the Storage Unit Total Size automatically
displays half the size of the defined location. You can modify this value as needed.
Enter the attributes of the Storage Unit. (See Procedure 3: Defining a Storage Unit
on page 644.)
a. Select a storage type. See What Storage Types are Available? on page 644.
b. Enter the total size of the unit in Gigabytes. You can use the Expected Storage Size
Calculator to help you define the size of the unit, as described in Step 7.
c. Enter the maximum threshold as a percentage of the Storage Unit Total Size. When the
unit reaches the threshold, deletion occurs (unless the group retention period has not yet
lapsed).
7. To calculate the required amount of storage space, click the link at the bottom of the window.
The Expected Storage Size Calculator appears.
Use the calculator to assist you in determining the storage size needed. The value determined
by the calculator is a guideline only and you are not required to use this value. For detailed
instructions/guidelines, see See Guidelines for Using the Storage Size Calculator
on page 650.
9. Click Finish. The group and unit appear under the appropriate Storage Center server name in
the Organization Tree.
Storage Group
Storage Unit
b. Enter the expected number of interactions per day, the average interaction length, media
type and the compression type (for Voice media).
• After you define the expected number of interactions (by adding/deleting rows), you can
manipulate the retention value to see how it affects the storage size.
• When you are finished, click Close. The value in the Calculator is not entered into the Wizard
since it is an estimation tool only.
If you select a Storage Group name in the Organization Tree, you can view the number of Storage
Units defined for the group and the total amount of storage area for the group - based on the size of
each unit. A pie chart displays the size of each Storage Unit and the relative percentage of each
Storage Unit.
In the example below, the Storage Group has three Storage Units with a total storage size
of 55 GB.
If you select a Storage Unit name in the Organization Tree, you can view the unit details, including
the storage destination, storage size and maximum threshold.
NOTE: When you define archiving rules (via the Rules Manager), select the Move to ESM
checkbox to store the interactions locally and on the ESM Server. This field is
located in the Action Parameters tab in the Rules Manager.
The EMC Centera server can be accessed by four IP addresses, therefore you can define up to four
IP addresses for the EMC Centera server. (At a minimum, you must define one IP address.) The
Storage Center tries to connect to the EMC Centera server using the first IP address on the list. If
the Storage Center fails to connect to the EMC Centera server using this IP address, it tries to
connect with the next IP address on the list.
In addition, you can define a secondary EMC Centera server with four IP addresses. If the Storage
Center failed to connect to the primary EMC Centera with all the IP addresses defined for it, the
Storage Center tries to connect to the secondary EMC Centera server using the first IP address
defined for it. If the Storage Center fails to connect to the secondary EMC Center server using this
IP address, it tries to connect with the next IP address on the list.
2. From the Actions menu, select New ESM Device. The New ESM Device Wizard starts.
7. Click Finish. A message appears reminding you to restart the Storage Center in order to
activate the changes. Click OK.
8. Restart the Storage Center.
IMPORTANT
Verify that the TSM system administrator has installed and configured the TSM Administrator on
the TSM server and the TSM Client on the Storage Center machine. See the Storage Center
Installation Guide for prerequisites to integrating TSM with Storage Center.
In order to define TSM as an ESM device, you need the TSM Client and Administrator parameters
described in Step 5 on page 656 and Step 6 on page 657.
• DSMI config path Full path name of the TSM client user option file
• DSMI log path Error log location for the TSM client
• Administrator User Name Enter the Administrator login to the TSM server
• Client Node User Name Enter the name of the predefined node
8. Click Finish. A message appears reminding you to restart the Storage Center in order to
activate the changes. Click OK.
9. Restart the Storage Center.
7. In the Server IP Address area, enter the IP address of the NetApp server.
8. In the Volume area, enter the location of the directory defined in Step 1.
9. Click Next. Step 4 appears.
If you entered an invalid volume in the previous step, a message appears notifying you that the
specified location was not found.
10. Click Finish. A message appears reminding you to restart the Storage Center in order to
activate the changes. Click OK.
11. Restart the Storage Center.
NOTE: If you modify a storage destination, the files that are already archived to the
previous destination are not moved.
TIP: Some parameters cannot be modified. You must delete the component and then
define a new component.
A Storage Center Server name, IP address and number Select Update Storage
Server of Archive and Retrieve connections Center. The Update Storage
Center Server Definition
Wizard appears. See
Procedure 1: Defining the
Storage Center Server
on page 634
A Storage Unit The unit name and type. Click Update Storage Unit.
The storage location. The Update Storage
Definition Wizard appears.
The storage size and maximum
See Procedure 3: Defining a
threshold.
Storage Unit on page 644.
The file type.
4. If you modified the Storage Center IP address or connection parameters, restart the Storage
Center server.
IMPORTANT
You cannot delete a Storage Group if the group is defined in an active storage rule.
If you delete a Storage Center server from the Organization tree, you will delete all the definitions
for the Storage Center including its ESM and Storage Groups.
When you delete a component, its subcomponents are deleted as well.
In the System Monitoring branch of the System Administrator, you can view a list of all the
Storage Center servers that were defined. For each Storage Center and all the storage areas defined
for the Storage Center, you can view current status information and you can generate a history
report of the storage usage.
In this branch, you cannot modify definitions.
Contents
2. In the System Monitoring branch, click Storage Center Servers. A list of Storage Center
servers appears with their respective host names/IP address.
3. Double-click a Storage Center server to view its current status, meaning its capacity and the
amount of space currently used. See Viewing the Status of Storage Areas on page 665.
The Current Status area displays the capacity, used space and free space of the selected
storage area. In the example above, a Storage Group was selected.
If you selected a Storage Unit in the tree, the Current Status area displays the capacity, used
space and free space for the selected unit.
If you selected a Storage Group, the Current Status area reflects the combined capacity, used
space and free space of all the Storage Units in the group.
If you selected a Storage Center, the Current Status area reflects the combined capacity, used
space and free space of all the Storage Groups in the Storage Center.
4. To generate a history report of the capacity in the selected storage area, do the following:
a. From the History Period drop-down list, select the time period for the report.
b. Click . This task may take several minutes. A report appears displaying the
amount of space used in the storage area over the defined time period.
The Media Library organizes the DAT/AIT/MO/DVD archiving media at a site by assigning
sequential numbers to these cassettes. The Media Library printer prints labels automatically. These
labels provide important archiving information including the date the cassette was first used for
archiving, the Logger number (or spare Logger number), slot number, deck number and a
sequential archiving number.
The Media Library is installed via the Media Library Installation Wizard. After it is installed, it
must be configured via the System Administrator.
Contents
2. In the Organization tree, expand the site branch. Select the Media Library Servers branch.
3. From the Actions menu, select New Media Library.
The Media Library Server Definition Wizard starts.
5. Enter a logical name and IP address for the Media Library server.
6. Click Next. Step 3 appears.
Now, define the Media Library printer. See Defining Media Library Printers on page 670.
IMPORTANT
Only one local printer can be defined per Media Library.
6. Click Finish. The printer name appears below the Media Library Server in the tree.
7. Configure the new Media Library printer by associating Loggers with the printer. The printer
will print labels for the associated Loggers.
a. Select the Media Library printer in the tree and click the Loggers tab.
b. Select the Loggers for which the printer will be printing labels: In the Available Loggers
list box, select the Loggers that you want to associate with the printer. Move the Logger
names to the Selected Loggers list box.
TIP: Follow these guidelines:
Each Logger should be associated with one printer. If a Logger was already associated
with a printer, the Logger name does not appear in the list.
If a Logger is not associated with a printer, then a printer label will not be prepared
when media is ejected from this Logger and there will not be any mechanism to locate
offline media. If a Logger serves as a Playback Logger, it does not have to be
associated with a Media Library.
c. Click .
Configure the Playback Organizer (PBO) Request Wizard via System Administrator. You can
determine the following:
• which steps appear in the wizard
• which rows are enabled
• which rows are mandatory
Contents
2. In the Organization tree, navigate to Master Site > Applications > Configurations >
Playback Organizer.
The Request Wizard window, step 1 appears.
NOTE: You can enable a row, but keep it optional by clearing the mandatory checkbox.
EXAMPLE:
The Interactions Center and the applications are installed on host server Server1. The databases
are installed on host server Server2. You monitor just Server1. Trap messages for the
Interactions Center and the applications will be sent to the SNMP. Trap messages for the
databases will not be sent.
Before you begin this procedure, have the following information ready:
• The machine name of the server where the NMS is installed.
• Which host servers in your system that you want to monitor. When a host server is
monitored, all of the Agents that are defined on it are automatically monitored.
• How long file retention should be for the log files, or the recycling period.
Click to
Expand
All the host servers from all of the sites in your Organization are displayed.
Blue rows indicate that the server is being monitored. Gray rows indicate that the server is not
being monitored.
If you monitor a host server, all of the components that are defined on it will be monitored.
6. To see a list of the components on a host server, click to expand it’s definition.
TIP: In the Associated Resources list, use the scroll bar to see all the installed servers.
NOTE: All the Agents defined on the selected server will be monitored
b. In each Server Name / IP Address field, enter the IP address or server name of a cluster
node. You must identify both cluster nodes.
9. Click Save .
10. Click the Logging tab. The Logging details appear.
By default, a new log file is started each day at midnight and the old log file is saved for an
indefinite period of time. However, you can select to recycle the logs. See Step 11 for
recycling instructions, or proceed to Step 12.
11. In the Log Files area, define the recycling period. In the Logging Recycle period field enter
the number of days for recycling.
Log files are saved every day at midnight. The default is 0. Zero indicates that log files will not
be deleted and it is up to the user to ensure that adequate space is available.
TIP: If you plan to send log files by email, the recycling period cannot be defined as 1.
1 (one) indicates that log files are deleted every night and recycling occurs before the
email is sent. Thus the current day’s log file will be deleted and the log file that is sent will
be empty.
12. You can send each day’s log file to an email address. Log files are sent each day at midnight
and are sent in CSV format. To define an email address, in the Log Mail area:
a. Select Automatically send compressed log files at the end of each day.
b. In the SMTP Server field, enter the address of the SMTP server.
TIP: You can send an email to verify the SMTP server and email address. To send an
email, do the following:
Click Check e-mail.
The email message is sent. Verify with the recipient that it was received.
3. Click Save .
WARNING
Deleting a Component definition without uninstalling the component can cause your NICE
system to malfunction.
Uninstalling the NMS does not automatically remove its definition from your site. You must delete
the NMS’s definition using the System Administrator.
It is recommended that you do this procedure before uninstalling the NMS so that you do not
temporarily leave invalid paths in your site configuration.
The VoIP Recording Gateway (VRG) is an advanced system that filters and captures VoIP traffic
from the network and transmits it to one or more active recording NICE VoIP Loggers. The VoIP
Recording Gateway is designed to be deployed in remote branches and data centers where
interactions are to be recorded.
Using SIP technology, the VRG functions as a router, Forwarding Device (FD), or Media Provider
Controller (MPC), and forwards interactions to NICE VoIP Loggers that are physically located at
one or more central locations.
This chapter describes how to configure the VRG in System Administrator.
NOTE:
• Each VRG unit must be defined in System Administrator.
• Though the VRG can be configured regardless of whether it is online or offline, VRG
definitions can only be updated when it is online.
Contents
On each VRG, there are 8 Input ports, in 4 pairs. The pairs of input ports are numbered 1 - 4 (from
left to right). The input ports in each pair are designated as A and B. Each pair of input ports can
have either a copper interface (each pair of ports are positioned one above the other) or a fiber
interface (each pair of ports are positioned side-by-side). Although there are 16 input ports on the
VRG, only a maximum of 8 (4 pairs of 2) ports can be utilized by the VRG.
The input ports are identified as follows:
1A and 1B
2A and 2B
3A and 3B
4A and 4B
Copper interfaces support both Mirroring and Tapping connectivity modes. The Tapping mode
requires pairs of input ports. Thus in Tapping mode, you can have up to 4 pairs of input ports.
Mirroring mode allows up to 8 separate input ports. The connection speed can be 10, 100, or 1000
Mbps.
Fiber interfaces support only mirroring connectivity. Mirroring mode allows up to 8 separate input
ports. The connection speed is fixed at 1000 Mbps.
The following table summarizes the possible connectivity modes of a VRG.
The VRG has 2 Output ports, numbered 1 and 2. When both output ports are enabled, you define
an Output Policy. Output Policy can be Teaming or Both as follows:
• Teaming (Output Redundancy) - output is sent to one output port. The second output port is
used as a backup if the physical connection to the main one fails. You do not specify which
output port to use as the main output port.
• Both (Packet Duplication) - all output is sent to both output ports.
Example: Redundancy or Resiliency
NOTE: When both ports are used for transferring data (Both), network bandwidth is
doubled. This could slow down system operation.
When one output port is enabled, the Output Policy is defined as Single. You do not define
Advanced parameters.
One of the output ports acts as a Control port. This is in addition to its output port functions. The
control port communicates with remote machines, such as the SSH, Telnet, NTP servers, DNS
servers, System Administrator, MPCM (FLM), Registrars, Proxies, Loggers, and NMS. The
control port always operates in Teaming mode, regardless of the Output Policy.
Restart VRG
NOTE: The VRG configuration options are only available when the VRG is online.
Copies and updates information from the System Administrator to the VRG. Use this option when
you have completed changing the VRG definition in the System Administrator. Upload
Configuration to VRG overwrites information on the VRG. For these changes to take affect, restart
the VRG. This option automatically saves the changes to the System Administrator database.
Retrieves and copies the current VRG settings to the System Administrator. Download
Configuration from VRG overwrites the currently displayed information in the System
Administrator. Use this option before editing default definitions, or to set the System
Administrator to the VRG’s settings. This option will not save this information to the System
Administrator database; only displayed content is updated. To update the System Administrator
database, click Save.
Restart VRG
Restarts the VRG process and enables changes in the VRG. Use this option after using the Upload
Configuration to VRG option. This is not the same as restarting the VRG machine. The VRG
machine can only be restarted directly from the VRG.
Save
Saves the displayed information to the System Administrator database. Save does not update the
VRG.
Before you are ready to apply new settings to the VRG, you can create new VRG definitions in the
System Administrator according to the following sequence:
1. Open an existing VRG definition or create a new one.
2. Verify that the VRG is online, and click Download Configuration from VRG.
The current VRG settings will appear in the System Administrator.
3. In the System Administrator, edit VRG definitions.
4. To save the temporary definition in the System Administrator database, click Save.
Do not click Upload Configuration to VRG!
5. Continue editing VRG definitions, clicking Save as necessary.
Do not click Download Configuration from VRG again!
6. At any time, if you want to delete the edited definitions, if the VRG is online, click Download
Configuration from VRG.
The original VRG settings will redisplay.
7. When ready to apply new definitions to the VRG, if the VRG is online, click Upload
Configuration to VRG.
8. Restart the VRG.
The new definitions are applied to the VRG.
1. Verify that you are working in Technician mode: From the Settings menu, select Technician
Mode.
2. In the Organization tree, expand the site and select VoIP Recording Gateway. Then from the
Actions menu, select New VRG.
• If the current VRG is not part of a redundancy cluster, enter the IP address of the VRG.
-or-
If the current VRG is part of a redundancy cluster, enter the cluster’s public IP address.
Entering the cluster’s public IP address ensures that NICE Perform will interface with the
cluster only, and any switching that may occur between active and standby VRG units will
be transparent. Regardless of whether or not the current VRG is part of a cluster, this is the
IP address that is defined during initial VRG installation.
• Description (Optional) - Enter a description of the physical location of the VRG. Though
this is not a required field, this information is useful to other personnel.
• Set as Cluster (Optional) - If the current VRG is part of a redundancy cluster, regardless
of whether the current VRG is intended to function as an active or standby unit, select Set
as Cluster. Selecting this option will include the current VRG in the redundancy cluster.
TIP: When the current VRG is not part of a redundancy cluster and therefore, the
Redundant VRG option is cleared, the Private IP Address/Host Name field is disabled.
In the I/O Ports tab, you configure the input and output ports. When configuring the VRG for
the first time, default values appear.
For information on defining VRG input/output ports, see Guidelines for Defining VRG Ports
on page 690.
6. Define Input Ports as described below.
a. Double-click an input port.
-or-
• Speed (Copper only) Select 10, 100, or 1000 Mbps according to the Ethernet
links of the customer’s infrastructure.
Note: The VRG and the network switch do not support
negotiation. This Speed value must be configured to
match the network switch’s speed.
• Connectivity Mode Select Mirroring, Tapping, or Concatenating.
If you select Tapping, the input port’s mate is forced to
adopt the same configuration settings.
• External fiber tapping If your site uses an external fiber tapping unit, select this
unit (Fiber only) option.
c. Click .
7. To define additional input ports, repeat Step 6.
8. In the Output Ports area, select one or both output ports. If both output ports are selected,
from the Output Policy drop-down menu, select Teaming or Both.
NOTE: The Services default values provide the most secure configuration. Default
values are as follows:
• SSH (Secure Shell): Enabled
• Telnet (remote connections): Disabled
• NTP: Disabled
• Firewall: Enabled
• To add a new parameter, click Add and in the relevant window, define the new
parameter.
• To edit a parameter, select the parameter you need to edit, click Edit , and in the
relevant window edit the parameter.
• To delete a parameter, select the parameter you need to delete, and click Remove .
11. Select Services as necessary.
12. Click the SIP tab.
a. In the SIP Identification area, enter the Device Name and Domain according to the
following guidelines:
• The Domain is the VRG IP address or host name as configured on a DNS server.
• Use only alphabetic characters, numerical characters, or the underscore symbol.
• Do not use spaces, special characters, or begin the Device Name with a numerical
character.
The Device Name and Domain become the URI identification.
EXAMPLE:
Device name is abc and Domain is 123.100.100.10.
The URI identification becomes abc@123.100.100.10.
b. In the Media Provider Controller Managers (MPCMs) area, define a new SIP Media
c. Enter the MPCM URI specifying 5062 as its SIP port value.
The URI syntax is as follows:
MPCM Name@IP Address:Port Number
Example: MPCM@1.2.3.4:5062
d. Click OK.
The MPCM URI appears in the Media Provider Controllers (MPCM) area.
TIP:
The Advanced options are optional, and are only required for certain sites.
14. Expand Log Settings.
WARNING
Do not use Extensive Debug or Debug! Do not select Packet Processor Core!
These log levels generate very detailed log levels and must only be used by authorized
personnel or NICE Customer Services.
For this number of RTP Payloads... You can define up to this number of Pre-Filters...
1 50
2 25
3 16
4 12
5 10
b. To define a Custom RTP Payload, select the Custom checkbox. In the open field, enter
the code number of the custom compression type. To enter multiple compression types,
separate each code number with a comma (,).
NOTE: To use the Custom option, you must be familiar with the code number of the
compression type you need to add.
Example:
c. To add/edit/delete Pre-Filters, in the Subnets area, use the Add , Edit , and
Remove options.
16. Expand SIP Infrastructure.
The SIP Infrastructure options are only relevant to sites with SIP infrastructure!
Define parameters as described below:
• SIP Proxy IP Enter the IP address or host name of your SIP proxy.
Address/Host Name
• SIP Registrars
• To add a new SIP Registrar, click Add and in the SIP
Registrar window define the new SIP Registrar’s URI and
IP address.
• To edit a SIP Registrar URI or IP address, select the SIP
Registrar you need to edit, click Edit , and in the SIP
Registrar window, edit values.
• To delete a SIP Registrar, select the name you need to
delete, and click Remove .
Warning: Timings include high-level functions and must only be edited by authorized
personnel!
Define parameters as described below:
20. If the VRG is online, click Upload Configuration to VRG . When this is completed,
restart the VRG.
TIP:
• Upload Configuration from VRG uploads the current VRG settings to the
System Administrator. This will overwrite any changes made in System
Administrator.
4. Click Save .
5. To configure the second VRG unit in the cluster, repeat steps 1-4.
6. Proceed to Configuring the Check for Audio Delay CLS Parameter on page 708.
3. Expand the RCM row and double-click Check for Audio Delay.
The Parameter Value window appears.
Since you defined Check for Audio Delay as 6000 milliseconds and Keep Alive Timing as 2
seconds, the time value for Check for Audio Delay is now 3 times the time value for Keep
Alive Timing. These values will ensure smooth system operation in the event of a VRG
failover.
5. Click Save .
The Configuration Status area shows the last time the following operations were performed:
When the VRG is online, every few seconds, status information is updated automatically,
directly from the VRG. When the VRG is offline, the status details do not display values at all.
NOTE:
• Removing a defined VRG in System Administrator will not erase the actual VRG
configuration on the VRG unit.
• If your site is configured for VRG redundancy, and you need to upgrade your site
environment from NICE Perform Release 3.1 to 3.2, in System Administrator, you
must delete and redefine the VRG units. This is due to the fact that redundancy
operates differently in NICE Perform Release 3.2.
1. Verify that you are working in Technician mode: From the Settings menu, select Technician
Mode.
2. In the Organization tree, expand the site and select VoIP Recording Gateway.
3. Right-click the VRG unit you need to delete and select Delete VRG.
-or-
Select the VRG unit you need to delete and from the Actions menu select Delete VRG.
4. Click Save .
NICE Perform supports Active Directory Authentication utilizing Microsoft Active Directory.
Active Directory authentication enables users to log in to NICE Perform applications using their
Windows login name and password. Separate login names and passwords for NICE Perform are
not required. You can also define your environment for Single Sign-On, which enables users to
open NICE Perform applications without re-entering their Windows login name and password.
To use Active Directory authentication, each user must be defined in a Trusted Domain.
WARNING
Changing your environment to Active Directory is a one-time process and is irreversible.
Pay attention to all details because certain steps are irreversible!
For more information, see the NICE Perform Integration with MS Active Directory Guide.
Contents
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 714
NICE Perform detects a Trusted Domain automatically when the Applications Server is associated
with the Trusted Domain. This automatic detection is done through LDAP queries which extract
the trusted available domains in the current Active Directory Forest.
The Microsoft Windows Server 2000 and 2003 operating systems implement a default set of
authentication protocols, including Negotiate, Kerberos, NTLM, Schannel (secure channel), and
Digest, as part of an extensible architecture. These protocols enable authentication of users,
computers, and services. The authentication process, in turn, enables authorized users and services
to access resources in a secure manner. Active Directory is required for default NTLM and
Kerberos implementations.
NICE Perform authenticates its users using the SSPI (Security Support Provider Interface). SSPI
in Windows Server 2000 and 2003 provides a mechanism that carries authentication tokens over
the existing protocol, eliminating the need for communicating parties to specify a network
protocol for use during authentication. When two parties need to be authenticated so that they can
communicate, the requests for authentication are routed to the SSPI, which completes the
authentication process, regardless of the network protocol currently in use.
For more information, see the NICE Perform Integration with MS Active Directory Guide.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 715
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 716
IMPORTANT
Only Trusted Domains are detected, and you can only work with Trusted Domains, within or
outside the current Forest.
-or-
In the Users Administrator application, select the Organization branch and then click the
Domains tab.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 717
NICE Perform runs an LDAP query to retrieve the list of available Trusted Domains detected
in the entire Active Directory environment.
The Status column displays the Domain status. If a DNS name is not detected, an X appears
in the Status column for that domain.
A missing DNS Name indicates a domain that could not be detected. Trust was not properly
established. DNS names are used for display purposes only, not for establishing
authentication.
All domains must have a NetBIOS Name!
3. If a NetBIOS Name is missing, enter it manually. If a NetBIOS name is missing, users in that
domain will not be able to login. Use the following guidelines:
• NetBIOS Names are generally similar to the domain’s DNS name, but can be also be
completely different.
Example: A domain’s DNS name can be nice.com and it’s NetBIOS name
NICE_SYSTEMS.
• Maximum length is 15 characters
• Spaces are not allowed
• All alphanumeric characters are valid except for the following special characters:
\/:*?“;|
IMPORTANT
If a NetBIOS Name is missing, users in that domain will not be able to login, since as part of the
login process, Active Directory uses a combination of the user’s username and NetBios domain
name to establish authentication.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 718
5. To select the preferred display name for Domains, in the Settings area, select the required
format.
The selected format appears where Domain association is applicable, e.g. Login window,
Users Administrator application, etc.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 719
WARNING
Once a site is configured for Active Directory authentication, it cannot be switched back to NICE
Proprietary Authentication.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 720
4. In the General tab, click Switch. The Active Directory Wizard starts.
6. Click Next. All user names and domains for those users already defined in NICE Perform are
verified for uniqueness. Each user name must be unique in its domain (duplicate user names
are allowed on different domains). If a duplicate is found, an error message appears and the
procedure is stopped. User names and domains are not verified against Active Directory. To
verify individual users, see Validating Users in Active Directory on page 729.
7. If the Wizard does not pass this step, click Cancel and use the Users Administrator application
to make adjustments. Then start the Wizard again.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 721
8. If you do not see the correct Domains listed in the Domains Configuration window, click
Cancel and see Troubleshooting Active Directory in your NICE Perform System
on page 731.
9. Click Next. The Superuser Settings window appears.
10. A new user should have been previously defined in Active Directory as an administrative user.
This will be the User Name you use to log in to NICE Perform as the Superuser. Enter this
user’s Windows User Name and select the Domain. For more information, see About the
SuperUser on page 726. See note box below.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 722
For example, if you created a user called Super, then enter Super in the Windows User Name
field.
NOTE:
This user cannot be deleted from the system at any time!
Use a dedicated Domain user for the Superuser role.
Only valid Windows User Name and Domain are accepted in this step.
For a multi-site installation, this user will be used for all sites.
12. If you are defining Single Sign-On, select the checkbox to activate this option. (This option
can be added or removed at a later time.)
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 723
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 724
3. Make any necessary changes in the General or Domains tab. Then click Save.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 725
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 726
4. Click Save .
To add a domain:
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 727
4. If the domain does not appear, see Troubleshooting Active Directory in your NICE
Perform System on page 731.
To remove a domain:
1. Verify that you are in Technician mode: From the Settings menu, select Technician Mode.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 728
Click to
sort
2. In the Group Members list, double-click the Domain heading to sort the list according to
domains.
3. Scroll the list to view any remaining users in the domain you are removing. If you find users in
the domain, double-click their row to edit their definition and change their domain.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 729
An invalid user definition indicates that the Windows User Name/domain combination defined in
the Users Administrator is not found in Active Directory.
Invalid User
Valid User
The validation results are shown only while this view is displayed. If you switch views (open a
user definition) and return to this view, the validation results will not appear.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 730
Auto Detection does not • The NICE Perform • Confirm that the NICE
work Applications Server is not Perform Applications
‘Connection to LDAP server residing in a Trusted Server is residing in a
has failed’ error message Domain Trusted Domain
appears • LDAP is not running or is • Confirm that LDAP is
not running on port 389 running on port 389
User is defined in NICE • User definition in NICE • Review the user definition
Perform and in Active Perform or Active in the Users
Directory and cannot log in Directory is invalid Administrator
to NICE Perform
• Restriction such as • Confirm the user’s
account disabled is domain using the validate
applied in the Active button in the Users
Directory Administrator
• Review the user
properties in Active
Directory. Confirm that
the account is not
disabled
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 731
Term Definition
LDAP Lightweight Directory Access Protocol: Directory service protocol that runs on a
layer above the TCP/IP stack. It provides a mechanism used to connect to, search,
and modify Internet directories. The LDAP directory service is based on a client-server
model. The function of LDAP is to enable access to an existing directory. The data
model (data and namespace) of LDAP is similar to that of the X.500 OSI directory
service, but with lower resource requirements. The associated LDAP API simplifies
writing Internet directory service applications.
SSO Single Sign-On: Avoids prompting users for username and password in order to log
in to NICE Perform. Credentials are taken automatically from the active context and
users are authenticated again in the NICE Applications Server.
SSPI Security Support Provider Interface: Application Programming Interface (API) that
applications use to request security services from security service providers. In
Windows 2000, a security support provider is a dynamic link library that supports the
SSPI specification and provides one or more security support packages (SSP). Each
SSP supports one specific security protocol and implements the SSPI functions
according to that security protocol. Kerberos, NTLM, and SSL are examples of
security packages provided by the default security provider in Windows 2000.
SPN Service Principal Name: Name associated with the security principal user or groups
in whose security context the service executes. SPNs are used to support mutual
authentication between a client application and a service. An SPN is assembled from
information that a client knows about a service or information obtained from a trusted
third party, such as Active Directory. An SPN is associated with an account and an
account can have many SPNs. The basic syntax of an SPN is as follows:
<service type>/<instance name>:<port number>/<service name>
UPN User Logon Name: Typically an e-mail address. It is stored as part of the user's
account in Active Directory. The UPN is displayed in the Account tab for the user
account in Active Directory, Users and Computers.
If you are logged in under a Domain account, to view the UPN, use whoami /upn.
FQDN Fully Qualified Domain Name: Domain names consist of individual labels separated
by dots, for example, mydomain.microsoft.com. An FQDN uniquely identifies the
host's position within the DNS hierarchical tree by specifying a list of names separated
by dots on the path from the referenced host to the root.
Chapter 32: Interfacing NICE Perform with Microsoft Active Directory 732
NICE Perform enables you to define more than one Data Hub for your organization. An
organization with more than one Data Hub is referred to as a Multi Data Hub environment. An
organization with only one Data Hub is referred to as a Single Data Hub environment.
In a Multi Data Hub environment, one Data Hub is defined as the Primary Data Hub. All other
Data Hubs are defined as Secondary Data Hubs. Each Data Hub has its own set of servers
(database, applications, etc.).
This section provides the specific configurations required when defining the databases and
describes how to use the System Administrator application to establish a connection between Data
Hubs.
IMPORTANT
To perform these procedures, you will log in to the Primary Data Hub server. After these
procedures are complete, you can log in directly to a Secondary Data Hub.
Example: http://PrimaryServer/Nice
Logging in to a Data Hub means that the Data Hub’s server name appears in the URL.
EXAMPLE:
http://BlueServer/Nice means that you are logged in to the sever called BlueServer, where the
Applications were previously installed.
Contents
IMPORTANT
You will not be able to log in directly to the Secondary Data Hub until after it is defined in the
Primary Data Hub and you complete the procedure in Procedure 6: Completing the Multi Data
Hub Definition on page 751.
When you have completed setting up your Multi Data Hub, the Organization tree in the System
Administrator will appear as follows:
Collapsed Expanded
2. Install the NICE Perform Applications Suite at the Secondary Data Hub. For instructions,
see the Applications Suite Installation Guide and the Reporter and Data Mart Installation
Guide.
IMPORTANT
You cannot log in to the NICE Perform applications from the Secondary Data Hub at this
point! Logging in to the applications via the Secondary Data Hub is only possible after
completing Procedure 6: Completing the Multi Data Hub Definition on page 751.
3. You are now ready to configure your Multi Data Hub in the System Administrator. Continue
with Procedure 3: Connecting the Data Hubs on page 739.
5. In the Site Name field, enter a logical name for the Secondary Data Hub and a brief
Description. This name appears in the Organization tree and whenever the Data Hub needs to
be identified in other applications.
For NT authentication,
the Security Settings
area is disabled
6. Identify the Secondary Data Hub’s database. Enter the Name of its Administrative database
the Host Name of the computer where it is installed. Then click Next.
7. Review the Summary. Then click Finish. The new Data Hub is added to your Organization
tree.
8. Expand the Primary Data Hub branch, as shown below, and select Applications >
Application Servers > Server. Make a note of the Host Name and Ports for the Reporter
and the Reporter Scheduler. You will need this information for steps 10 and 11 on page 742.
If there is more than one Applications Server, select the Primary server.
9. Expand the Secondary Data Hub branch, as shown below, and select Applications >
Application Servers > Server.
10. In the System Administrator row, enter the Host Name of the Administrative database for the
a. Clear .
b. Change the Host Name and Port definitions for the Reporter and Reporter Scheduler
to match the Primary Data Hub’s assignment (see to Step 8 on page 741).
c. Click Save.
12. Expand the Secondary Data Hub branch and click the Database Servers branch. Define its
database server. See Defining a Database Server on page 47.
13. Continue with Procedure 4: Linking the Data Mart to a Secondary Data Hub on page 743.
Select a site
4. In the Domains area (the bottom area), select the databases that should be linked to the
corresponding Data Mart domains for the selected Data Hub.
5. Repeat this procedure for each Data Hub.
6. Click Save .
After the domains are linked, you can expand a Data Hub to view the domains that will be
populated.
TIP:
• To redefine the links, click Recreate Links and repeat this procedure again.
• If NICE passwords to a database were changed, click Recreate Links and repeat
this procedure again.
7. Continue with Procedure 5: Defining Replication Between Data Hubs on page 745.
3. Select all the databases installed on the Secondary Data Hub. Then click . The Push
button becomes enabled.
4. Click . The next step appears. (This window can also be opened by clicking
on the Replication tab.)
8. Click .
9. Return to the Replication tab. Confirm that all processes completed successfully. (The icon
indicates an error.)
10. Continue with Procedure 6: Completing the Multi Data Hub Definition on page 751.
TIP: If the Applications Suite and the database server are not on the same host, the
following message box appears. Click OK to close the message. Then continue.
2. In the SQL Server Connection area, select a Server. Then select Use Windows
Authentication and click .
Appendix A: Working with Multi Data Hubs 748
TIP: To remove some or all of the databases being replicated, click Remove.
4. Select all the databases installed on the Secondary Data Hub and click . The Push
button becomes enabled.
9. Click .
10. Continue with Procedure 6: Completing the Multi Data Hub Definition on page 751.
The tips in this section are provided to help you find quick solutions to some common situations
and tasks.
IMPORTANT
For some of these procedures, you must have permission to work in Technician Mode. See
Adding and Modifying Components in the System Administrator on page 30. You do not
need Technician Mode to view information.
Contents
EXAMPLE:
A server’s IP address is 100.10.10.123. It’s host name is Server123. It is in the domain Domain1.
You ping 100.10.10.123 or Server123 and get a response.
You must ping its fully qualified name: Server123.Domain1.com.
If you receive a failure after pinging the server, there is an internal communications problem with
your system.
4. Click Save .
For more information, see Configuring the Applications on page 359.
There are several CLS parameters that can be edited, if necessary, by a qualified installer to tweak
system performance. Most of these parameters are part of the Administration database. This
section contains details of the CLS parameters.
Contents
Is
Parameter Default Description
ReadOnly
MappingBackupFileLocation [CLS Install The location for saving and loading the False
Path] mapping backup file (should be modified
in cluster configurations only).
Is
Parameter Default Description
ReadOnly
MinWaitBeforeQuery op_MaxOp TRS will not resolve calls that are newer False
enCallDura than specified in this parameter.
tion The default value is the Call Server
parameter op_MaxOpenCallDuration
which is set to 5 hours.
Alternatively, this can be set to the Call
Server parameter
op_MaxSpeakerCallDuration.
Is
Parameter Default Description
ReadOnly
Port number 62062 The TCP/IP port to which the CLS Monitor False
listens. To avoid unpredictable results,
this port must be different from all other
ports in use on the Interactions Center
machine.
Reset Down Count Min 30 The number of minutes after which the False
module down counter resets.
Scheduler Port 62061 The TCP/IP port to which the Scheduler False
listens to allow the CLS Monitor to
connect.
Is
Parameter Default Description
ReadOnly
Session Controller Port 62064 The TCP/IP port to which the CLS Monitor False
listens for the session controller. To avoid
unpredictable results, this port must be
different from all other ports in use on the
Interactions Center machine.
Drivers End Port 62499 Defines the last port in a consecutive False
range of TCP/IP ports to which the CLS
Monitor listens. The value of this
parameter must be greater than Drivers
Port, which defines the start of the range.
The range of ports must be used
exclusively by the CLS Monitor. If not,
unpredictable results may occur.
Is
Parameter Default Description
ReadOnly
Port number 62059 The TCP/IP port to which the SNMP False
Agent listens.
Dispatch Parameters
The Dispatch configuration is read from the registry.
Is
Parameter Default Description
ReadOnly
CAPI Converter Location localhost The hostname or IP Address of the CAPI False
Converter machine.
CAPI Converter Port 62221 The port to which the CAPI Converter False
listens. This port must be different from
any other port on the CAPI Converter
machine. The possible values are 62221-
62320.
Is
Parameter Default Description
ReadOnly
CLS Server Remoting Port 62065 The Port to which the Call Server Keep False
Alive listens. This Port must be different
from any other port on the Interactions
Center machine.
host Port number 62051 The TCP/IP port to which the Call Server False
host listens. To avoid unpredictable
results, this port must be different from all
other ports in use on the Interactions
Center machine, including those used for
other copies of the driver.
Is
Parameter Default Description
ReadOnly
op_InsertUnmapped Yes If Yes, Call Server inserts calls that were False
not recorded or failed to record onto the
database.
Is
Parameter Default Description
ReadOnly
OverwriteEndCall false If True, overwrites the call data with the False
data received (if it exists) in the EndCall
command.
TCP Port 62050 The TCP/IP port to which the Call Server False
listens. To avoid unpredictable results,
this port must be different from all other
ports in use on the Interactions Center
machine.
Use Old CAPI Allowed False Allows the use of Start/Stop record False
commands by the old CAPI clients.
Log Parameters
Following is a list of Log parameters and their default values.
Is
Parameter Default Description
ReadOnly
MaxLogSizePerProcess 100 The maximum log size (in Mb) per False
process to keep. When reached older log
files are truncated.
DB Server Parameters
Following is a list of DB Server parameters and their default values.
Is
Parameter Default Description
ReadOnly
Port number 62055 The TCP/IP port to which the DB Server False
host listens. To avoid unpredictable
results, this port must be different from all
other ports that are in use on the
Interactions Center machine, including
those used for other copies of the driver.
RequestQueueSize 1000 The size of the request queue that buffers False
requests before the DB Server handles
them.
Is
Parameter Default Description
ReadOnly
Is
Parameter Default Description
ReadOnly
General Parameters
Following is a list of General parameters and their default values.
Is
Parameter Default Description
ReadOnly
RCM Parameters
Following is a list of RCM parameters and their default values.
Is
Parameter Default Description
ReadOnly
CheckForAudioDelayIPC 5000 For VoIP IPC environments, the period (in False
milliseconds) that RCM waits after starting
a call, before checking for audio
availability on the Logger.
Is
Parameter Default Description
ReadOnly
MappingBackupFileLocation [CLS The location for saving and loading the False
Install mapping backup file (should be modified
Path] in cluster configurations only).
Port number 62069 The TCP/IP port to which the RCM host False
listens. To avoid unpredictable results,
this port must be different to all other ports
in use on the CLS computer, including
those used for other copies of the driver.
Is
Parameter Default Description
ReadOnly
Contents
Overview........................................................................................................................776
Common Terms.............................................................................................................777
Verifying the System Administrator User...................................................................778
Adding the System Administrator User to Computers not in an Active Directory
Environment..................................................................................................................780
Installing WMI Windows Management Instrumentation............................................783
Editing DCOM Permissions .........................................................................................785
Setting Security Permissions through the WMI Control...........................................791
Appendix D: Enabling Display of NICE System Information in the Summary Page 775
Overview
The System Administrator includes a summary page that displays the NICE product version and
the installed Updates. See the System Administrator Guide for more information.
This summary page is generated by accessing the product information from the computers in the
NICE system. In order to access this product information, the System Administrator user needs to
be included in the DCOM and WMI security settings on each computer in the NICE system. The
System Administrator user is the user associated with the Nice SystemAdministrator service.
This association is defined when NICE Perform applications are installed on the Applications
Server. To verify the identity of this user, see Verifying the System Administrator User
on page 778.
In this appendix, we describe how to change the security settings to enable the System
Administrator user to access information on these computers.
Workflow
The workflow differs slightly depending on whether or not you are working in an Active Directory
environment.
1. Verifying the System Administrator User. To verify the identity of the System
Administrator user, you check which user is associated with the Nice SystemAdministrator
service.
2. (Not Active Directory Environment Only) Adding the System Administrator User to
Computers not in an Active Directory Environment. The System Administrator user needs
to be included on all computers in the NICE system. If you are not working in an Active
Directory environment, you need to add this user through the Control Panel, if necessary.
3. Installing WMI Windows Management Instrumentation. You install WMI in order to
access management information.
4. Editing DCOM Permissions. You edit the DCOM permissions to enable the remote launch
and remote activation of WMI queries.
5. Setting Security Permissions through the WMI Control. By means of the WMI Control,
you set security permissions that enable the System Administrator user to remotely access
NICE system information.
Appendix D: Enabling Display of NICE System Information in the Summary Page 776
Common Terms
Some common Microsoft terms used in this appendix are listed in the table below.
Term Meaning
WMI Namespace Each WMI namespace has a security descriptor, which allows each
namespace to have unique security settings that determine who has
access to the namespace data and methods.
Appendix D: Enabling Display of NICE System Information in the Summary Page 777
NOTE: In an Active Directory environment, verify that the domain name of the System
Administrator user is the same domain as that of the computer, or is a trusted domain.
Appendix D: Enabling Display of NICE System Information in the Summary Page 778
User Name
IMPORTANT
The System Administrator user cannot be Local System. The Local System user cannot be
granted the correct permissions for all the machines in the system. If the System Administrator
user is Local System, you need to change it to another user.
Appendix D: Enabling Display of NICE System Information in the Summary Page 779
IMPORTANT
Before starting this procedure, obtain the user name and password of the System Administrator
user. See Verifying the System Administrator User on page 778 to obtain the user name.
Appendix D: Enabling Display of NICE System Information in the Summary Page 780
4. Expand System Tools > Local Users and Groups > Users.
A list of existing local users appears in the right pane.
5. Verify that the System Administrator user appears in the list. If the user does not appear,
proceed to Step 6.
Appendix D: Enabling Display of NICE System Information in the Summary Page 781
• Password and Confirm Password: Enter the password for the System Administrator
user.
8. Clear the User must change password at next logon check box.
9. Click Create. The System Administrator user appears in the list in the left pane.
10. Proceed to Installing WMI Windows Management Instrumentation on page 783.
Appendix D: Enabling Display of NICE System Information in the Summary Page 782
Appendix D: Enabling Display of NICE System Information in the Summary Page 783
7. Click OK.
The Locate File window appears.
8. Browse to the i386 folder, and select the MSI.MF file.
9. Click Open.
The installation process begins.
Upon completion of installation, the Windows Components Wizard window reappears.
10. Select Finish.
Appendix D: Enabling Display of NICE System Information in the Summary Page 784
IMPORTANT
• Before you begin this procedure, you need the System Administrator user name.
• The System Administrator user cannot be Local System. The Local System user cannot be
granted the correct permissions for all the machines in the system. If the System
Administrator user is Local System, you need to change it to another user.
Appendix D: Enabling Display of NICE System Information in the Summary Page 785
Right-click
My Computer
Appendix D: Enabling Display of NICE System Information in the Summary Page 786
7. In the Group or user names area, verify that the name of the System Administrator user
appears, and proceed to Step 9.
8. If the name of the System Administrator user does not appear in the Groups or user names
area, complete the following steps:
a. Click Add.
Appendix D: Enabling Display of NICE System Information in the Summary Page 787
b. In the Enter the object names to select area, enter the name of the System
Administrator user.
c. Click Check Names.
The user name and domain name appear.
d. Click OK.
The Launch Permission window reappears.
9. In the Group or user names area, select the System Administrator user.
10. In the Permissions for <User> area, in the Allow column, select Remote Launch and
Remote Activation, and then click OK.
Appendix D: Enabling Display of NICE System Information in the Summary Page 788
12. In the Group or user names area, verify that the name of the System Administrator user
appears, and proceed to Step 14.
13. If the name of the System Administrator user does not appear in the Groups or user names
area, complete the following steps:
a. Click Add.
The Select Users, Computer, or Groups window appears.
b. In the Enter the object names to select area, enter the name of the System
Administrator user.
c. Click Check Names.
The user name and domain name appear.
d. Click OK.
The Access Permission window reappears.
14. In the Group or user names area, select the System Administrator user.
15. In the Permissions for <User> area, do the following:
Appendix D: Enabling Display of NICE System Information in the Summary Page 789
Appendix D: Enabling Display of NICE System Information in the Summary Page 790
3. Right-click the WMI Control (Local) icon, and then click Properties.
Appendix D: Enabling Display of NICE System Information in the Summary Page 791
5. Click Security.
Appendix D: Enabling Display of NICE System Information in the Summary Page 792
6. In the Group or user name area, verify that the name of the System Administrator user
appears, and proceed to Step 8.
7. If the name of the System Administrator user does not appear in the Groups or user names
area, complete the following steps:
a. Click Add.
The Select Users, Computer, or Groups window appears.
b. In the Enter the object names to select area, enter the name of the System
Administrator user.
c. Click Check Names.
The user name and domain name appear.
d. Click OK.
The Security for ROOT\DEFAULT window reappears.
8. In the Group or user names area, select the System Administrator user.
Appendix D: Enabling Display of NICE System Information in the Summary Page 793
9. In the Permissions for <User> area, in the Allow column, select Execute Methods and
Remote Enable.
11. Right-click the WMI Control (Local) icon, and then click Properties.
Appendix D: Enabling Display of NICE System Information in the Summary Page 794
Appendix D: Enabling Display of NICE System Information in the Summary Page 795
Index 797
Index 798
Index 799
Index 800
Index 801
Index 802