Environmental Requirements

This page outlines requirements for ports, service accounts, and antivirus software. See Server Requirements or PC Requirements for that relevant information.

Server Roles and Ports

The following tables list ports used by various services in NICE Uptivity based on what server they are likely to be on in your environment. 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 (referred to as Server Ports in the tables) to allow communication between Uptivity modules and services.

Depending on the applications used in your implementation, these ports may need to be opened on user workstations and network firewalls (referred to as PC Ports in the tables) to allow communication between system server(s) and end users.

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.

All Servers

Services that are on all servers in an environment.

Service

Server Ports

PC Ports

Transport / Direction

Description

Comet Daemon 6505 6505

Server: TCP / Inbound; TCP / Outbound

PC: TCP / Inbound & Outbound

Server: Listens for service status from client loaders and Web Server; client loader status messages to master.

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

1433 x TCP / Outbound SQL Connection
Logger Service 5638 x TCP / Inbound Log message listener
162 x UDP / Outbound SNMP Management messages
25 x TCP / Outbound SMTP messages
1433 x TCP / Outbound SQL Connection

Admin Server

Services specific to the primary Admin server.

You only need to set up the ports that are relevant to the services in your specific configuration. If you have questions about what services you have, contact your Uptivity representative or refer to your design document.

Service

Server Ports

PC Ports

Transport / Direction

Description

APA Real Time Client / Server 1911 x HTTP / RTServer to RTClient Application Server (secured); Used with version 6.3 and above.
1912 x HTTPS / RTServer to RTClient Application Server (secured); Used with version 6.3 and above.
1414 x TCP / RTServer to RTClient MQ; Used for RA Robot to Server.
1212 x TCP over SSL / RTServer to RTClient MQ; Used for RA Robot to Server.
3691 x HTTP / RTServer to RTClient Used for SVN.
3692 x HTTPS / RTServer to RTClient Used for SVN (secured).
18183 x HTTP / RTServer to RTClient Web Service Proxy; used when APA consumes third part web service via the RT Server.
API Server 5620 x 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 x 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 x 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 x TCP / Outbound SQL Connection
Archiver 445 x TCP / Outbound CIFS file operations
1433 x TCP / Outbound SQL Connection
CC_Analytics Manager 1433 x TCP / Outbound SQL Connection
5671 x TCP / Outbound RabbitMQ Connection
5672 x TCP / Outbound RabbitMQ Connection
CC_Analytics Manager (with CXoneInteraction Analytics) x x HTTPS Accomplishes HTTPS communication.

CXone Avaya CMS WFM Data Collector*

??? x ??? Integration-specific port usage. See the documentation from your telephony provider for ports they require.

CXone Cisco UCCE WFM Data Collector*

??? x ??? Integration-specific port usage. See the documentation from your telephony provider for ports they require.
CXone Cisco UCCX WFM Data Collector* ??? x ??? Integration-specific port usage. See the documentation from your telephony provider for ports they require.
CXone Media Bridge** 1433 x TCP / Outbound SQL Connection
5650 x TCP / Outbound Connection to Web Socket Server
9998 x TCP / Outbound Connection to nsproxy service on CX Media Bridge INI file. Should match the nsProxyServicePort value.
CXone SQL Data Adapter** 1433 x TCP / Outbound SQL and HTTPS connection
InfoBroker 50817 x TCP / Inbound Used to communicate with Cores andScreen Capture Server
Legacy Desktop Analytics (Fusion) Client x 5620 TCP / Outbound Fusion client API connection for sending function calls
Legacy Desktop Analytics (Fusion) Script Server 5634 x TCP / Inbound Listens for connections from Fusion clients
NICE Uptivity On-Demand 2007 x TCP / Inbound Listener for connections from NICE Uptivity On-Demand Clients
5620 x TCP / Outbound

Connection to API Service for recording control and event messages

1433 x TCP / Outbound SQL Connection
NICE Uptivity On-Demand Client x 2007 TCP / Outbound

Connection to On-Demand Server for recording control and event status messages

Post Interaction Manager (PIM) 1433 x TCP / Outbound SQL Connection
5671 x TCP / Outbound RabbitMQ Connection
5672 x TCP / Outbound RabbitMQ Connection
Report Scheduler 1433 x TCP / Outbound SQL Connection

Service Bus (RabbitMQ)

4369 x TCP / Inbound

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

5671 x TCP / Inbound

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

5672 x TCP / Inbound

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

15672 x TCP / Inbound

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

25672 x 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.

35672 - 35682 x 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).

Service Manager 1024 6505

Server: TCP / Inbound

PC: TCP / Inbound & Outbound

Server: Listens for authorization from the NICE Uptivity Web Portal.

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

SQL Data Adapter 1433 x TCP / Outbound SQL Connection
??? x TCP / Variable

Integration-specific port usage. See the documentation from your telephony provider for ports they require.

State Sourcing 1433 x TCP / Outbound SQL Connection
5671 x TCP / Outbound RabbitMQ Connection
5672 x TCP / Outbound RabbitMQ Connection
Performance Management 20010 x HTTP / 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.
30010 x 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.
Web Socket Server 5650 5650 TCP / Inbound

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

5630 x 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

Transcoder 2 445 x TCP / Outbound CIFS file operations
1433 x TCP / Outbound SQL Connection
Web Portal 80 x TCP / Inbound

HTTP services for NICE Uptivity Web Portal (default). If web-based NICE Uptivity On-Demandis also used, an additional port will be required for its Web Portal (for example, 8080).

* - Only needed if your configuration uses WFM Pro

** - Only needed if your configuration uses CXone WFO.

Audio Core Server

Services specific to the Audio Core server.

Service

Server Ports

PC Ports

Transport / Direction

Description

CTI Core

5685

x

TCP / Inbound

Inter-core communication

5685

x

TCP / Outbound

Inter-core communication

445

x

TCP / Outbound

CIFS file operations

6620

x

TCP / Inbound

API control message listener

1433

x

TCP / Outbound

SQL Connection

2013

x

HTTP / Inbound

Info Broker Listen Port

???

x

???

Integration-specific port usage. See the documentation from your telephony provider for ports they require.

Transcoder; Transcoder 2

445 x TCP / Outbound CIFS file operations
1433 x TCP / Outbound SQL Connection

Video Core Server

Services specific to the Video Core server.

Service

Server Ports

PC Ports

Transport / Direction

Description

Screen Capture Client x 5633 TCP / Outbound

Connection to On-Demand Server for recording control and event status messages

Screen Capture API (SCAPI) x 3113 HTTP / Outbound Connection from client to server for transfer of JPEG files and metadata. Used for video capture.
Screen Recording 5633 x TCP / Inbound

Listener for Screen Recording (SR) Client connections

445 x TCP / Outbound

CIFS file operations

1433 x TCP / Outbound

SQL Connection

2014 x TCP / Inbound

HTTP Listener

3113 x HTTP/Inbound Listener for Screen Recording (SR) Client connections and screen recording files
Transcoder 2 445 x TCP / Outbound CIFS file operations
1433 x TCP / Outbound SQL Connection

Uptivity Speech Analytics Server

Services specific to the Uptivity Speech Analytics server. For ports information about CXone Interaction Analytics, refer to the CXone help.

Service

Server Ports

PC Ports

Transport / Direction

Description

Speech Analytics 25002 x TCP / Inbound

Listens on the NICE Uptivity Speech Analytics server for connections from the Uptivity server.

Used for internal communication between Nexidia services. For information on other ports required for Nexidia, refer to your Nexidia documentation.

1433 x TCP / Outbound SQL Connection

Historical Transcoding Server

The Historical Transcoding Server is used for converting historical calls from their original file type to one that is playable in Uptivity 18.x and above. It contains the Service Bus (RabbitMQ) as well as Transcoder and Transcoder 2 exactly as they are used on their primary servers.

Service

Server Ports

PC Ports

Transport / Direction

Description

Service Bus (RabbitMQ)

4369 x TCP / Inbound

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

5671 x TCP / Inbound

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

5672 x TCP / Inbound

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

15672 x TCP / Inbound

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

25672 x 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.

35672 - 35682 x 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).

Transcoder; Transcoder 2

445 x TCP / Outbound CIFS file operations
1433 x TCP / Outbound SQL Connection

 

Survey Server

Services specific to the Survey server.

Service

Server Ports

PC Ports

Transport / Direction

Description

NICE Uptivity Survey 5060 x 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.

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

Transcoder 2 cc_transcoder_2.exe *.cca, *.vid, *.wav, *.vox, *.vox8, *.csa, *.ccp C:\temp\transcoder\jpg

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

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.