Environmental Requirements

Server and Firewall Ports

The following table lists the ports used by various services in Uptivity. Some ports are used by more than one service (for example, any service that communicates with SQL uses TCP port 1433). Depending on the system design created by your Uptivity Sales Engineer, these ports may need to be opened on system server(s) and network firewalls to allow communication between Uptivity modules and services.

For information on enhanced security features in Uptivity, see Uptivity Security Overview.

Talk to your Uptivity installation team if you need to make adjustments due to port conflicts.

Process

Port

Transport

Direction

Description

API Server

5620

TCP

Inbound

Listener for connections and commands from internal (CTI CoreClosedThe software component that provides the PBX/ACD integration and makes call recording decisions based on customer-defined recording schedules., On-DemandClosedAllows authorized users to control recording of their interactions and screen activity, start and stop blackouts, and add information to the database call record., etc.) and third-party clients (default)

5621

TCP

Inbound

Listener for event notifications (such as call started, call stopped, and so forth) from internal (CTI Core, On-Demand, etc.) and third-party clients (default)

2012

TCP

Inbound

Listener HTTP APIClosedAn acronym for Application Program Interface. An API facilitates interaction between software components and specifies how they should interact. Interface

1433

TCP

Outbound

SQL Connection

Archiver

445

TCP

Outbound

CIFS file operations

1433

TCP

Outbound

SQL Connection

CTI Core

5685

TCP

Inbound

Inter-core communication

5685

TCP

Outbound

Inter-core communication

445

TCP

Outbound

CIFS file operations

5633

TCP

Outbound

Control messages to Screen Capture Server

6620

TCP

Inbound

API control message listener

1433

TCP

Outbound

SQL Connection

2013

HTTP

Inbound

Info Broker Listen Port

xxx

?

?

Integration Specific port usage (detailed in corresponding integration guide)

Comet

Daemon

6505

TCP

Inbound

Listens for service status from client loaders and Web Server

6505

TCP

Outbound

Client loader status messages to master

1433

TCP

Outbound

SQL Connection

RabbitMQ

4369

TCP

Inbound

Erlang Port Mapping Daemon (EPMD), a peer discovery service used by RabbitMQ nodes and CLI tools 1

5671

TCP

Inbound

Used by AMQP 0-9-1 and 1.0 clients with and without TLS2

5672

TCP

Inbound

Used by AMQP 0-9-1 and 1.0 clients with and without TLS3

15672

TCP

Inbound

HTTP API clients, RabbitMQ management UI, and the rabbitmqadmin command line tool4

25672

TCP

Inbound

Used for inter-node and CLI tools communication (Erlang distribution server port) and is allocated from a dynamic range (limited to a single port by default, computed as AMQP port + 20000). Unless external connections on these ports are really necessary (e.g. the cluster uses federation or CLI tools are used on machines outside the subnet), these ports should not be publicly exposed.5

35672 - 35682

TCP

Inbound

Used by CLI tools (Erlang distribution client ports) for communication with nodes and is allocated from a dynamic range (computed as server distribution port + 10000 through server distribution port + 10010).6

Info Broker

50817

TCP

Inbound

Used to communicate with Cores, Screen Capture Server

Logger

Service

5638

TCP

Inbound

Log message listener

162

UDP

Outbound

SNMP Management messages

25

TCP

Outbound

SMTP messages

1433

TCP

Outbound

SQL Connection

Service Manager

1024

TCP

Inbound

Listens for authorization from the Web Portal

TranscoderClosedAn Uptivity service that converts raw files recorded by the system into compressed, formatted files optimized for storage and playback.

445

TCP

Outbound

CIFS file operations

1433

TCP

Outbound

SQL Connection

WebSocket Server

5650

TCP

Inbound

Media Player operations

5630

TCP

Inbound

Used for Live MonitorClosedA feature that enables authorized users to listen to an agent's calls, view an agent's desktop, or both, in near-real time. Also shows whether a call is being recorded. and Screen Recording

Speech Analytics

25002

TCP

Inbound

Listens on the NICE Uptivity Speech Analytics server for connections from the Uptivity server
25022 TCP Inbound

Used for internal communication between Nexidia services.

For information on other ports required for Nexidia, refer to your Nexidia documentation.

1433

TCP

Outbound

SQL Connection

Desktop

Analytics

Script

Server

5634

TCP

Inbound

Listens for connections from Desktop Analytics clients

NICE Uptivity On-Demand

2007

TCP

Inbound

Listener for connections from On-Demand Clients

5620

TCP

Outbound

Connection to API Service for recording control and event messages

1433

TCP

Outbound

SQL Connection

Screen Recording

5633

TCP

Inbound

Listener for Screen Recording (SR) Client connections and SR to CTI Core communication

445

TCP

Outbound

CIFS file operations

1433

TCP

Outbound

SQL Connection

2014

TCP

Inbound

HTTP Listener

NICE Uptivity Web Portal

80

TCP

Inbound

HTTP services for NICE Uptivity Web Portal (default). If web-based NICE Uptivity On-Demandis also used, a second port will be required for its Web Portal (for example, 8080).
NICE Uptivity Performance Management 20010/30010 HTTP/HTTPS Inbound Required only for the Ticker feature. Used by the Metrics Access service to process requests from Ticker clients for data. These port numbers are configurable but these are the defaults and they are rarely changed.

NICE Uptivity Survey

5060

UDP/TCP

Inbound

SIP trunk listener from customer PBX. The CTI Core module also uses port 5060. If Survey and Core are on the same server, Survey must be configured to use a different port.

References

1, 2, 3, 4, 5, 6 "Networking and RabbitMQ".

PC and Firewall Ports

The following table lists the ports used by client applications in Uptivity. Depending on the applications used in your implementation, these ports may need to be opened on user workstations and network firewalls to allow communication between system server(s) and end users. Talk to your Uptivity installation team if you need to make adjustments due to port conflicts.

Process

Port

Transport

Direction

Description

CometDaemon

& Service

Manager

6505

TCP

Inbound & Outbound

Allows administrator access to Service Manager from client systems and receives messages from CometDaemon.
RabbitMQ

5671

 TCP Outbound Used by AMQP 0-9-1 and 1.0 clients with and without TLS
5672 TCP Inbound

Communication port receiving messages from clients
5672 TCP Outbound

Communication port used to send messages to clients

NICE Uptivity Desktop Analytics Client

5620

TCP

Outbound

Desktop Analytics client API connection for sending function calls

NICE Uptivity On-Demand Client

2007

TCP

Outbound

Connection to On-Demand Server for recording control and event status messages
Screen Capture API (SCAPI) 3113 HTTP Inbound Connection from client to server for transfer of JPEG files and metadata. Used for video capture.

Screen Capture Client

5633

TCP

Outbound

Connection to Screen Capture Server for video streaming and status messages
WebSocket Server 5650 TCP Inbound

Connection for HTML5 playback from the WebSocket Server. This value must match the HTML5CallListServerPort value in the web.config file.

Service Accounts

If your system topology includes multiple servers, a service account is required. This service account is typically a domain account that is used to run services and to share storage locations, facilitating cross-server communications. In practice, the disk locations where recorded voice files, screen files, or both, are to be stored is shared explicitly with the service account and the call recording and playback services are set to run using that account, allowing for read/write access to those locations.

The same service account can be used to run Uptivity reports using (SQL Server Reporting Services) in a multi-server environment. The account must have permission to access the server hosting the database that the SSRS reports use, as well as the server that hosts the SSRS reports (the .rdl files), if different.

The only permissions that the service account needs are those necessary to accomplish these tasks.

Antivirus Software

Antivirus exclusions should be configured in any system where antivirus scanning is installed. The guidelines below are provided to assist with ensuring the reliability and performance of your Uptivity system, while still providing for a secure environment. A lack of exclusions can cause system performance issues and possibly contribute to service outages.

These guidelines apply to both memory resident and on-demand scanning.

General Considerations

These exclusion guidelines are product-specific. For applications not specifically listed, it is often necessary to determine exclusions on a case-by-case basis. This section provides guidance in this area.

Files should typically be excluded based on the following criteria:

  • Locked Files — The files are permanently locked open by a legitimate server process. Examples of these are databases such as DHCP and SQL Server, as well as files such as the Windows Pagefile.
  • Large Files — The files are manipulated often by a legitimate server process and are typically large in size. Examples of these are copying CD/DVD images (.iso) and Virtual Machine Files (.vhd). In addition, operations may include offline maintenance on Virtual Machine Files and Exchange Server databases.
  • Temporary Files — A large number of temporary files are written to disk by a legitimate server process.

Exclusion Guidelines

The table below lists the recommended exclusions for each Uptivity service or application. Any paths or ports shown in this document are the installation defaults only. Actual paths or ports may vary depending on configuration options set during installation.

Service/Application

Process

File, Extension, or TCP/IP Port

Default Folder

Logger

cc_loggerservice.exe

*.log

C:\Program Files\CallCopy\Logs\

CTI Core

cc_cticore.exe

*.cca, *.wav, *.vox, *.vox8, *.xml

C:\default_rec

Transcoder

cc_Transcoder.exe

*.cca, *.vid, *.wav, *.vox, *.vox8, *.csa, *.ccp

C:\temp\Transcoder-temp

NICE Uptivity Speech Analytics

cc_analytics.exe

*.wav, *.idx

 

Screen Capture Server

cc_screencapserver.exe

*.vid

C:\temp\
Screen Capture API (SCAPI) ScreenCaptureApi.exe *.jpeg / .jpg C:\SCAPI
For 18.1.1 and later:
Transcoder 2 cc_transcoder_2.exe *.cca, *.vid, *.wav, *.vox, *.vox8, *.csa, *.ccp C:\temp\transcoder\jpg

Common File Types

Most antivirus products attempt to remove or quarantine file types that they cannot identify. The table below lists many of the common file types associated with Uptivity.

File Type

Description

.cca

Raw recorded audio that has not yet been transcoded; typically deleted after transcoding and compressed into .wav.

.ccp

Waveform that accompanies playback in the Web Player. Does NOT contain bookmarks – those are inserted at time of playback via stored database records. Blackouts are represented in the waveform as flat segments with no audio present.
.jpeg / .jpg Compressed digital image format. Used in Uptivity for NICE Uptivity Screen Recording.

.wav

Compressed audio format for playback.
.webm Transcoded audiovisual format. Serves as a container that holds audio and video files in one place. Yields smaller file sizes.

.xml

Used to store call metadata or API responses to clients.