5. Installing Interact

This section provides detailed instructions for on-premises installation of Uniphore Interact on one or more nodes.

Interact Installation Workflow

Prepare the Interact Environment. First, verify that infrastructure applications requirements have been met, then prepare the Interact Server environment.
Configure Environment Variables. Create the required environment variables that point to the relevant folders on the Interact Server.
Copy Installation Package. Extract and copy files from the Interact release package to the relevant folders.
Configure Application Server. Configure endpoints and critical settings for the Interact Server by modifying various properties files.

Preparing the Interact Server Environment

Note: Before beginning installation, verify that your target server(s) meet all platform application prerequisites.

Create the following folders on each Interact server node:

Local Folder Name	Service/Platform
`c:\interact_home`, `/usr/interact_home`	Interact Root Folder
`c:\job_mgmt_home`, `/usr/job_mgmt_home`	Job Management Folder
`c:\rds_home`, `/usr/rds_home`	RDS Folder
`c:\jms_home`, `/usr/jms_home`	JMS Messaging Folder
`c:\deployment_home` `/usr/deployment_home`	Deployment Folder
`c:\snapshot_api_home`, `/usr/snapshot_api_home`	Snapshot API Folder
`c:\snapshot_consumer_home`, `/usr/snapshot_consumer_home`	Snapshot Consumer Folder
`c:\urpc_home`, `/usr/urpc_home`	URPC Folder
`c:\u_common_connector_home`, `/usr/u_common_connector_home`	URPC Common Connector Folder
`c:\uassist_home`, `/usr/uassist_home`	U-Assist Folder
`c:\uss_home`, `/usr/uss_home`	U-Self Serve Folder

Configuring Environment Variables

The following environment variables must be configured on each server node for Interact to run properly.

Note: Refer to your operating system documentation for detailed instructions on how to create or change an environment variable.

Environment Variable	Points to Local Folder	Service/Platform
`<JAVA_HOME>`	java	N/A
`<INTERACT_HOME>`	`interact_home`	Interact Server
`<CATALINA_HOME>`	tomcat	Tomcat
`<JOB_MGMT_HOME>`	`job_mgmt_home`	Job Management
`<RDS_HOME>`	`rds_home`	RDS
`<RDS_CLIENT_HOME>`	`rds_home`	RDS Client
`<JMS_HOME>`	`jms_home`	Messaging
`<BOT_INTEGRATIONS_HOME>`	`bot_integrations_home`	JBot
`<DEPLOYMENT_HOME>`	`deployment_home`	Deployment
`<DEPLOYMENT_CONSUMER_HOME>`	`deploymentconsumer_home`	Deployment Consumer
`<SNAPSHOT_API_HOME>`	`snapshot_api_home`	Snapshot API
`<SNAPSHOT_CONSUMER_HOME>`	`snapshot_consumer_home`	Snapshot Consumer
`<URPC_HOME>`	`urpc_home`	Uniphore Remote Procedure Call (RPC)
`<U_COMMON_CONNECTOR_HOME>`	`u-common-connector_home`	Uniphore Remote Procedure Call (RPC) Common Connector
`<UASSIST_HOME>`	`u-assist_home`	U-Assist
`<USS_HOME>`	`uss_home`	U-Self Serve

Optional Services

If you are installing any optional add-on services (e.g., RPA or BI services), you can choose to add any relevant environment variables also at this time. See complete instructions for all add-on components in the section Optional Add-On Installations.

Copying Installation Files

All files and components necessary for installing and running Uniphore Interact are provided in the distribution package as a .zip file.

The package contains the components for both core services, which are required in order for Interact to run, and optional add-on services, which are installed according to the current customer license.

Core Services (Required)

Unzip the installation package to a temporary, separate folder on your server(s). The following subfolders and their contents are extracted:
- bi_home
- bot_integrations_home
- custom_ip_home
- deploymentconsumer_home
- deployment_home
- interact_home
- jars
- jms_home
- job_mgmt_home
- jws_home
- rds_home
- rpa_home
- snapshot/snapshot_api_home
- snapshot/snapshot_consumer_home
- uassist_home
- uss_home
- u_common_connector_home
- upgrade_scripts
- urpc_home
- webapps
If they exist, delete any Interact-related .war files from the webapps sub-folder in your tomcat root folder. Then, copy the contents of the webapps sub-folder from the installation package to that same sub-folder of your tomcat root folder.
Copy all content from the interact_home folder of the installation package to your <INTERACT_HOME> folder.
Copy all content from the jars sub-folder to the lib sub-folder of your <CATALINA_HOME> folder. Any existing files should be overwritten.

Copy each of the .war files listed below from the specified sub-folder of the installation package to the webapps sub-folder of your tomcat root folder:

.war File	Sub-Folder in Installation Package
`deployment.war`	deployment
`deployment-consumer.war`	deploymentconsumer
`jobMgmt.war`	jobManagement
`messaging.war`	jms
`rds.war`	rds
`snapshot_api.war` `snapshot_consumer.war`	snapshot
`deployment.war`	deployment
`uassist.war`	uassist
`u_self_serve.war`	uss
`u_common_connector.war`	u_common_connector
`uRPC.war`	urpc

Add-On Services (Optional)

If desired, copy the content of each add-on package sub-folder to its appropriate sub-folder on the server. See complete instructions for all add-on components in the section Optional Add-On Installations .
Note: Add-on service components can be installed and configured on Interact at any time.

Configuring the Application Server

Set up the Apache Tomcat Application Server with the following steps:

Complete details are provided in each of the following sections.

Interact Configuration Files Overview ^{[Return to Top ↑]}

All required Interact services are configured and customized to the local environment using the properties files listed below.

Note: After updating properties in any of the following configuration files, you need to restart its Interact server instance in order for changes to take effect.

File Name	Description/Notes
Key files located in the `<INTERACT_HOME>` \conf folder:
`hazelcast.xml`	A configuration file for the Hazelcast distributed cache. For more information, click here.
`hazelcast-client.xml`	A configuration file for Hazelcast that controls how the applications connect to the distributed cache layer. For information about enabling a distributed cache in a clustered environment, click here.
`jis-app.properties`	Contains general settings for the Interact Server. For more information, click here.
`logstash.properties`	Contains settings for external UDP-based log handling tools (e.g., Logstash).
`mgmt-app.properties`	Contains scheduling settings for various server jobs. For more information, click here.
`mongo.properties`	Contains MongoDB connection settings. For a description of the properties, click here.
`mongo-report.properties`	Contains Interact reporting engine settings when the engine is connected to a MongoDB secondary node. For a description of the properties, click here.
`nlp.properties`	Contains settings for use with natural language processing (NLP) activities.
`rds_client.properties`	Contains client-side settings for raw data service (RDS) activities. For a description of the properties, click here.
`report-app.properties`	Contains settings for the Interact Server’s reporting engine. For more information, click here.
`short-url.properties`	Contains settings for use with Interact's URL shortener service. For more information, click here.
`twilio-utils.properties`	Contains settings for the Interact Server’s Twilio integration engine.
`voiceproxy-app.properties`	Contains settings for the voice proxy tool.
`voiceproxy-hazelcast.xml`	A configuration file for the Hazelcast distributed cache that contains voice-proxy information. For information about enabling a distributed cache in a clustered environment, click here.
Additional key files located in their respective \conf folders:
`job.mgmt.client.properties` `job.mgmt.mongo.properties` `job.mgmt.properties`	Contain all settings for the Interact Job Management service. For more information, click here.
`rds.properties`	Contains settings for raw data service (RDS) activities. For more information, click here.
`deployment.properties`	Contains settings for Interact Resource Deployment service activities. For more information, click here.
`messaging.properties`	Contains settings for Messaging service activities. For more information, click here.
`snapshotApi.properties`	Contains settings for Interact Snapshot service activities. For more information, click here.
`u_common_connector.properties`	Contains settings for Uniphore Common Connector activities. For more information, click here.
`u_self_serve.properties`	Contains settings for U-Self Serve service activities. For more information, click here.
`uassist.properties`	Contains settings for U-Assist service activities. For more information, click here.
`urpc.properties`	Contains settings for uRPC service activities. For more information, click here.

Note: For details on properties files used for configuring optional, add-on Interact services, click here.

Configure Tomcat Instances ^{[Return to Top ↑]}

Add the <INTERACT_HOME> environment variable to each Tomcat instance for loading on startup:
For Windows:
In the tomcat root folder, open the file /bin/setenv.bat and add:
```
Set INTERACT_HOME=[path name here]
```
For Linux:
In the tomcat root folder, open the file /bin/setenv.sh and add:
```
export INTERACT_HOME=[path name here]
```
Change the maximum heap size to an appropriate value, based on your needs. We recommend:
- Maximum heap size (Xmx setting) to 2 GB
- XX:MaxPermSize according to your needs (e.g., 512 MB)
Ensure that all required services have been copied to each Tomcat instance, as detailed here.
Allocate memory to the perm gen memory by passing the required options to the Java process. We recommend that the minimum memory allocation be 512 MB.

When using OpenJDK 11, pass the following option settings to the Java process:

set JAVA_OPTS="--add-modules java.se --add-exports java.base/jdk.internal.ref=ALL-UNNAMED
 --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.nio=ALL-UNNAMED
 --add-opens java.base/sun.nio.ch=ALL-UNNAMED --add-opens java.management/sun.management=ALL-UNNAMED
 --add-opens jdk.management/com.sun.management.internal=ALL-UNNAMED"

Configure MongoDB Connection Settings ^{[Return to Top ↑]}

The settings that specify the connections between Interact and the MongoDB database are maintained in the following files:

mongo.properties - contains the database connection settings used by Interact applications
mongo-report.properties - contains the database connection settings used by the Interact Reports component

In a clustered environment, verify that the properties set on each cluster node are identical.

Note: After updating any of the following properties, you need to restart the Interact Server in order for changes to take effect.

Property Name	Description/Notes
`mongo.host`	The host running MongoDB. In a replica set, this property should point to each of the nodes in the set. To set multiple replica-set nodes, separate the addresses with commas. For example: `mongo.host=10.10.0.10:27017,10.10.0.20:27017`
`mongo.database`	The name of the Uniphore Interact database. This property should always be set to: `mongo.database=System` (Ensure that 'System' is capitalized.)
`mongo.username` `mongo.password`	The MongoDB username and password. These properties are optional.
`mongo.auth`	Sets the authentication method used by the database. The following values are supported by the current MongoDB version: `LDAP`: Specifies LDAP Authentication. When authenticating with LDAP, you need to specify additional settings for MongoDB, as described here. `SCRAM_SHA_256`: Specifies Internal Authentication for MongoDB. Find details on SCRAM in MongoDB here.
`mongo.readSecondary`	Relevant for replica sets only. When set to true, the application will perform read operations from the secondary node (when possible). The recommended settings for each properties file are: mongo.properties: `false` mongo-report.properties: `true`

Configure Interact Server Endpoints ^{[Return to Top ↑]}

Interact Server endpoints and other general server settings are defined in the jis-app.properties file found in the <INTERACT_HOME> \conf folder.

Initially, all the settings in the file are commented using the # symbol. Using a text editor, open the file, uncomment all required properties, and ensure that the server IP and port values point to the required settings.

Properties that may need to be uncommented and configured are detailed in the following table.

Note: Anytime a change is made to an endpoint or setting in this file, you will need to restart the server(s) in order for the change to take affect.

Property	Description/Notes	Example
`server.endpoint` `.protocol`	The protocol used for accessing the server.	`HTTP or HTTPS`
`server.endpoint` `.host`	The host name or IP used to access the server. This property should be set to the machine name or IP running the server.	`localhost`
`server.endpoint` `.port`	The port used to access the server. This property should be set to the listening port of the server running Uniphore Interact.	`8080`
`server.admin` `.endpoint`	The full URL used by the administration module to connect to the Interact Server. When left empty, the admin module uses the host and port defined in the server.endpoint.host and server.endpoint.port. properties. In a clustered configuration, it is recommended to point the admin module to use localhost to access the local Interact Server, rather than going through the load balancer.	`http://localhost:8080/interact`
`server.admin` `.reportsEndpoint`	The full URL used by the administration module to connect to the Interact reporting application. When left empty, the admin module uses the host and port defined in the server.endpoint.host and server.endpoint.port. properties. In a clustered configuration, it is recommended to point the admin module to use localhost to access the local Interact Server, rather than going through the load balancer.	`http://localhost:8080/reports`
`system.user.name`	The username used for accessing the server. This property is necessary for proper performance of the Usage Dashboard and other internal jobs.	`admin@uniphore.com`
`reports.server.url`	The full URL path to the Uniphore Interact reporting application.	`http://localhost:8080/reports`
`admin.server.url`	The full URL path to the Uniphore Interact Admin Console. This property is used to access the Admin Console from the Web Designer.	`http://localhost:8080/admin/login`
`server.internal` `.admin.endpoint`	The full URL path used by the Admin Console to communicate with the Interact Server (necessary when operations such as sharing links and previewing Flows are required).	`http://localhost:8080`
`server.internal` `.designer.endpoint`	The full URL path used by the Web Designer to communicate with the Interact Server (necessary when operations such as internal authentication and Flow simulation are required).	`http://localhost:8080`
`license.support72` `.enabled`	Indicates whether version 7.2 licenses are supported. The default setting is true.
`jis.cache.tenants` `.duration`	The period of time for which account updates are cached by a server. The default setting is zero minutes.
`jis.cache.users` `.duration`	The period of time for which user updates are cached by a server. The default setting is zero minutes.
`jis.cache` `.tenant_settings` `.duration`	The period of time for which updates to account settings are cached by a server. The default setting is zero minutes.
`jis.cache.appkeys` `.duration`	The period of time for which application key updates are cached by a server. The default setting is zero minutes.
`jis.threadPool` `.users.enable`	Indicates whether a thread pool is used when updating the users database with last login times. The default setting is true.
`cti.enabled`	Indicates whether CTI capabilities should be available for the account. The default setting is false.

Configure the Raw Data Service (RDS) ^{[Return to Top ↑]}

Raw data service (RDS) settings are maintained in the following files:

rds.properties

Property Name	Description/Notes
`application.server.endpoint`	Set to the endpoint of your Interact server. For example: `application.server.endpoint=http://localhost:8080/interact`
`rds.map.reduce.accounts`	Add or uncomment this setting: `rds.map.reduce.accounts=0`
`rds.batch.time.limit`	Add or uncomment this setting: `rds.batch.time.limit=24`
`server.port`	Add or uncomment this setting: `server.port=8080`

rds_client.properties

Property Name	Description/Notes
`rds.server.endpoint`	Set to your RDS server address. For example: `rds.server.endpoint=http://localhost:8080/rds`

Property Name

Description/Notes

rds.server.endpoint

Set to your RDS server address. For example:

rds.server.endpoint=http://localhost:8080/rds

Configure the Job Management Service ^{[Return to Top ↑]}

Job Management settings are maintained in the following files:

job.mgmt.client.properties

Property Name	Description/Notes
`job.mgmt.server.url`	Set this to the Job Management server path. For example: `job.mgmt.server.url=http://localhost:8080/jobMgmt`

Property Name

Description/Notes

job.mgmt.server.url

Set this to the Job Management server path. For example:

job.mgmt.server.url=http://localhost:8080/jobMgmt

job.mgmt.mongo.properties

Property Name	Description/Notes
`job.mgmt.mongo.host`	The IP address(es) or hostname(s) and port(s) of the host(s) running MongoDB. For example: `job.mgmt.mongo.host=127.0.0.1:27017`
`job.mgmt.mongo.database`	The name of the Job Management database for Mongo. This property should be set to: `job.mgmt.mongo.database=JobMgmt`
`job.mgmt.mongo.username`	The MongoDB username.
`job.mgmt.mongo.password`	The MongoDB password.
`job.mgmt.mongo.auth`	Sets the authentication method used by the database. The following values are supported by MongoDB: `LDAP`: Specifies LDAP Authentication. When authenticating with LDAP, you need to specify additional settings for MongoDB, as described here. `SCRAM_SHA_256`: Specifies Internal Authentication for MongoDB. Find details on SCRAM in MongoDB here.
`job.mgmt.mongo.port`	Set this to the Job Management port assigned for MongoDB. For example: `job.mgmt.mongo.port=27017`

job.mgmt.properties

Property Name	Description/Notes
`spring.batch.job.enabled`	If the application runs independently of springboot, or if the application is deployed on Tomcat, set this value to false.
`quartz.properties.location`	Set this to the location of the Quartz Job Management file. For example: `quartz.properties.location=${JOB_MANAGEMENT_HOME}/conf/job.mgmt.quartz.properties`

Property Name

Description/Notes

spring.batch.job.enabled

If the application runs independently of springboot, or if the application is deployed on Tomcat, set this value to false.

quartz.properties.location

Set this to the location of the Quartz Job Management file. For example:

quartz.properties.location=${JOB_MANAGEMENT_HOME}/conf/job.mgmt.quartz.properties

Configure the Messaging Service (JMS) ^{[Return to Top ↑]}

Messaging Service (JMS) settings are maintained in the following file:

messaging.properties

Property Name

Description/Notes

application.server.endpoint

Set this to the endpoint of your Interact server. For example:

application.server.endpoint=http://localhost:8080/interact

server.port

Add or uncomment this setting:

server.port=9080

message.max.buffer.size

Add or uncomment this setting:

message.max.buffer.size=32768

Schedule Interact Server Jobs ^{[Return to Top ↑]}

Job scheduling settings are maintained in the mgmt-app.properties file. The schedule for each job is configured as a Cron expression.

To change the default schedule for a job, uncomment the relevant line and then change the Cron expression as required. Examples and other resources are provided in the mgmt-app.properties file.

Available job properties are:

Job Name	Description/Notes
`unverfied.tenant.notifcation`	Identifies new users who have not created a password within seven days of their account creation, and sends them a reminder email.
`zombie.tenant.user`	Identifies new users who have not created a password within 14 days of their account creation, and deletes these users from the system.
`unverfied.tenant.admin.notifcation`	Identifies new users who have not created a password within 11 days of their account creation, and sends a notification to the Primary Contact email of the relevant account.
`abandonedInstance.job`	Identifies unfinished Flows in the database, and marks them as abandoned.
`reportstats.job`	Aggregates the data in the Navigation database collection. This collection is used when displaying the Interact Usage Dashboard and when generating custom reports. For more information about the Navigation collection, see the section Navigation in the *Uniphore Interact Reporting* document.
`funnelReportAggregation.job.cron`	Aggregates the data in the FunnelReportsInstances database collection. This collection is used when generating Funnel reports.

Configure Resource Deployment Service ^{[Return to Top ↑]}

Deployment server and performance settings are maintained in the

U-Assist Service settings are maintained in the following files:

jis-app.properties
deployment.properties
deployment-consumer.properties

jis-app.properties

Property Name	Description/Notes
`deployment.server.endpoint`	Set this to the endpoint of the Deployment server. For example: `deployment.server.endpoint=http://localhost:9097/deployment`

Property Name

Description/Notes

deployment.server.endpoint

Set this to the endpoint of the Deployment server. For example:

deployment.server.endpoint=http://localhost:9097/deployment

deployment.properties

Properties that may need to be uncommented and configured are detailed in the following table.

Property Name

Description/Notes

application.server.endpoint

Set to the endpoint of your Interact server. For example:

application.server.endpoint=http://localhost:8080/interact

snapshot.server.endpoint

Set to the endpoint used by the Snapshot service. For example:

snapshot.server.endpoint=http://localhost:8080/snapshotApi

deployment.files.ttlSeconds.default

Configures the default period of time (in seconds) to be allowed for importing or exporting a file containing deployment resources. For example:

deployment.files.ttlSeconds.default=3600

sets the time period for 1 hour (i.e., 60 seconds * 60 minutes).

deployment.files.ttlSeconds.max

Configures the maximum period of time (in seconds) to be allowed for importing or exporting a file containing deployment resources. For example:

deployment.files.ttlSeconds.max=1209600

sets the time period for 2 weeks (i.e., 60 seconds * 60 minutes * 24 hours * 14 days).

deployment.interact.rest.template

.timeout.seconds

Configures a local server processing time limit for completing execution of a REST request. For example:

deployment.interact.rest.template.timeout

.seconds=30

deployment.cleanup.initDelay

.milliseconds

Configures the initial period of time (in milliseconds) to wait before performing a cleanup of cached deployment resources.

For example:

deployment.cleanup.initDelay.milliseconds=300000

deployment.cleanup.period

.milliseconds

Configures the regular period of time (in milliseconds) to wait before performing a cleanup of cached deployment resources.

For example:

deployment.cleanup.period.milliseconds=43200000

deployment.cleanup.ageToKeep.minutes

Configures the period of time (in minutes) to store a file containing deployment resources.

For example:

deployment.cleanup.ageToKeep.minutes=60

common.locking.ttl.minutes

Configures the period of time (in minutes) to prevent any other activity on an environment which is currently receiving an import file.

For example:

common.locking.ttl.minutes=60

deployment.snapshot.cache.TtlMinutes

Configures the period of time (in minutes) that a saved snapshot will be stored in cache.

For example:

deployment.snapshot.cache.TtlMinutes=15

deployment.export.request.cache.ttl.minutes

deployment.import.request.cache.ttl.minutes

Configures the period of time (in minutes) that an export or import request will be stored in cache.

For example:

deployment.export.request.cache.ttl.minutes=60

deployment.import.request.cache.ttl.minutes=60

deployment.queue.timeout.seconds

Configures the period of time (in seconds) to wait for the deployment consumer to pull a request from the queue.

For example:

deployment.queue.timeout.seconds=900

deployment.consumer.properties

Properties that may need to be uncommented and configured are detailed in the following table.

Property Name	Description/Notes
`mongo.gridfs.bucket`	The GridFs tables prefix used by MongoConnectionManager. This must be set to: `mongo.gridfs.bucket=deployment`
`application.server.endpoint`	Set to the endpoint of your Interact server. For example: `application.server.endpoint=http://localhost:8080/interact`
`snapshot.server.endpoint`	Set to the endpoint used by the Snapshot service. For example: `snapshot.server.endpoint=http://localhost:8080/snapshotApi`
`deployment.files.ttlSeconds.default`	Configures the default period of time (in seconds) to be allowed for importing or exporting a file containing deployment resources. For example: `deployment.files.ttlSeconds.default=3600` sets the time period for 1 hour (i.e., 60 seconds * 60 minutes).
`deployment.files.ttlSeconds.max`	Configures the maximum period of time (in seconds) to be allowed for importing or exporting a file containing deployment resources. For example: `deployment.files.ttlSeconds.max=1209600` sets the time period for 2 weeks (i.e., 60 seconds * 60 minutes * 24 hours * 14 days).
`deployment.interact.rest.template` `.timeout.seconds`	Configures a local server processing time limit for completing execution of a REST request. For example: `deployment.interact.rest.template.timeout` `.seconds=30`
`deployment.cleanup.initDelay` `.milliseconds`	Configures the initial period of time (in milliseconds) to wait before performing a cleanup of cached deployment resources. For example: `deployment.cleanup.initDelay.milliseconds=300000`
`deployment.cleanup.period` `.milliseconds`	Configures the regular period of time (in milliseconds) to wait before performing a cleanup of cached deployment resources. For example: `deployment.cleanup.period.milliseconds=43200000`
`deployment.cleanup.ageToKeep.minutes`	Configures the period of time (in minutes) to store a file containing deployment resources. For example: `deployment.cleanup.ageToKeep.minutes=60`
`common.locking.ttl.minutes`	Configures the period of time (in minutes) to prevent any other activity on an environment which is currently receiving an import file. For example: `common.locking.ttl.minutes=60`

Property Name

Description/Notes

mongo.gridfs.bucket

The GridFs tables prefix used by MongoConnectionManager.

This must be set to:

mongo.gridfs.bucket=deployment

application.server.endpoint

Set to the endpoint of your Interact server. For example:

application.server.endpoint=http://localhost:8080/interact

snapshot.server.endpoint

Set to the endpoint used by the Snapshot service. For example:

snapshot.server.endpoint=http://localhost:8080/snapshotApi

deployment.files.ttlSeconds.default

Configures the default period of time (in seconds) to be allowed for importing or exporting a file containing deployment resources. For example:

deployment.files.ttlSeconds.default=3600

sets the time period for 1 hour (i.e., 60 seconds * 60 minutes).

deployment.files.ttlSeconds.max

Configures the maximum period of time (in seconds) to be allowed for importing or exporting a file containing deployment resources. For example:

deployment.files.ttlSeconds.max=1209600

sets the time period for 2 weeks (i.e., 60 seconds * 60 minutes * 24 hours * 14 days).

deployment.interact.rest.template

.timeout.seconds

Configures a local server processing time limit for completing execution of a REST request. For example:

deployment.interact.rest.template.timeout

.seconds=30

deployment.cleanup.initDelay

.milliseconds

Configures the initial period of time (in milliseconds) to wait before performing a cleanup of cached deployment resources.

For example:

deployment.cleanup.initDelay.milliseconds=300000

deployment.cleanup.period

.milliseconds

Configures the regular period of time (in milliseconds) to wait before performing a cleanup of cached deployment resources.

For example:

deployment.cleanup.period.milliseconds=43200000

deployment.cleanup.ageToKeep.minutes

Configures the period of time (in minutes) to store a file containing deployment resources.

For example:

deployment.cleanup.ageToKeep.minutes=60

common.locking.ttl.minutes

Configures the period of time (in minutes) to prevent any other activity on an environment which is currently receiving an import file.

For example:

common.locking.ttl.minutes=60

Configure the Snapshot Service ^{[Return to Top ↑]}

Snapshot Service settings are maintained in the following files:

jis-app.properties
deployment.properties
snapshotApi.properties

jis-app.properties

Property Name	Description/Notes
`snapshot.server.endpoint`	Set this to the endpoint of your Snapshot API server. For example: `snapshot.server.endpoint=http://localhost:8080/snapshotApi`

Property Name

Description/Notes

snapshot.server.endpoint

Set this to the endpoint of your Snapshot API server. For example:

snapshot.server.endpoint=http://localhost:8080/snapshotApi

deployment.properties

Property Name	Description/Notes
`snapshot.server.endpoint`	Set this to the endpoint of your Snapshot API server. For example: `snapshot.server.endpoint=http://localhost:8080/snapshotApi`
`deployment.snapshot.cache.TtlMinutes`	Controls the period of time (in minutes) to wait before removing cached deployment data when creating a snapshot. For example: `deployment.snapshot.cache.TtlMinutes=15`

Property Name

Description/Notes

snapshot.server.endpoint

Set this to the endpoint of your Snapshot API server. For example:

snapshot.server.endpoint=http://localhost:8080/snapshotApi

deployment.snapshot.cache.TtlMinutes

Controls the period of time (in minutes) to wait before removing cached deployment data when creating a snapshot.

For example:

deployment.snapshot.cache.TtlMinutes=15

snapshotApi.properties

Property Name	Description/Notes
`server.port`	Add or uncomment this setting: `server.port=9099`
`application.server.endpoint`	Set this to the endpoint of your Interact server. For example: `application.server.endpoint=http://localhost:8080/interact`
`snapshot.queue.timeout.seconds`	Configures the period of time (in seconds) to wait for the snapshot consumer to pull a request from the queue. For example: `snapshot.queue.timeout.seconds=900`
`common.locking.ttl.minutes`	Configures the period of time (in minutes) to prevent any other activity on an environment which is currently receiving a snapshot file. For example: `common.locking.ttl.minutes=60`

Configure the U-Assist Service ^{[Return to Top ↑]}

U-Assist Service settings are maintained in the following files:

jis-app.properties
uassist.properties

jis-app.properties

Property Name	Description/Notes
`uassist.server.endpoint`	Set this to the endpoint of your U-Assist server. For example: `uassist.server.endpoint=http://localhost:8080/uassist`

Property Name

Description/Notes

uassist.server.endpoint

Set this to the endpoint of your U-Assist server. For example:

uassist.server.endpoint=http://localhost:8080/uassist

uassist.properties

Property Name

Description/Notes

application.server.endpoint

Set this to the endpoint of your Interact server. For example:

application.server.endpoint=http://localhost:8080/interact

server.port

Add or uncomment this setting:

server.port=10002

Configure the U-Self Serve Service ^{[Return to Top ↑]}

U-Self Serve Service settings are maintained in the following files:

jis-app.properties
u_self_serve.properties

jis-app.properties

Property Name	Description/Notes
`uss.server.endpoint`	Set this to the endpoint of your U-Self Serve server. For example: `uss.server.endpoint=http://localhost:10003/uss`

Property Name

Description/Notes

uss.server.endpoint

Set this to the endpoint of your U-Self Serve server. For example:

uss.server.endpoint=http://localhost:10003/uss

u_self_serve.properties

Property Name	Description/Notes
`server.port`	Add or uncomment this setting: `server.port=10003`
`application.server.endpoint`	Set this to the endpoint of your Interact server. For example: `application.server.endpoint=http://localhost:8080/interact`
`poll.initDelay.milliseconds` `poll.fixedDelay.milliseconds`	Configures the sampling time (in milliseconds) to determine if there is a request waiting. For example: `poll.initDelay.milliseconds=120000` `poll.fixedDelay.milliseconds=2000`
`auth0.endPoint.authentication` `auth0.clientId` `auth0.clientSecret` `auth0.audience` `auth0.grantType`	Configures the settings required for Auth0 customer identity access. For example: `auth0.endPoint.authentication=https://dev‑g28fpN6z.us.auth0.com` `auth0.clientId=5guPAgkyOcBgxGhZQIyCSDSrOwaROjvb` `auth0.clientSecret=[secret]` `auth0.audience=api.uniphore.com` `auth0.grantType=client_credentials`

Property Name

Description/Notes

server.port

Add or uncomment this setting:

server.port=10003

application.server.endpoint

Set this to the endpoint of your Interact server. For example:

application.server.endpoint=http://localhost:8080/interact

poll.initDelay.milliseconds

poll.fixedDelay.milliseconds

Configures the sampling time (in milliseconds) to determine if there is a request waiting.

For example:

poll.initDelay.milliseconds=120000

poll.fixedDelay.milliseconds=2000

auth0.endPoint.authentication

auth0.clientId

auth0.clientSecret

auth0.audience

auth0.grantType

Configures the settings required for Auth0 customer identity access.

For example:

auth0.endPoint.authentication=https://dev‑g28fpN6z.us.auth0.com

auth0.clientId=5guPAgkyOcBgxGhZQIyCSDSrOwaROjvb

auth0.clientSecret=[secret]

auth0.audience=api.uniphore.com

auth0.grantType=client_credentials

Configure the U-Self Serve Service ^{[Return to Top ↑]}

U-Self Serve Service settings are maintained in the following files:

jis-app.properties
u_self_serve.properties

jis-app.properties

Property Name	Description/Notes
`uss.server.endpoint`	Set this to the endpoint of your U-Self Serve server. For example: `uss.server.endpoint=http://localhost:10003/uss`

Property Name

Description/Notes

uss.server.endpoint

Set this to the endpoint of your U-Self Serve server. For example:

uss.server.endpoint=http://localhost:10003/uss

u_self_serve.properties

Property Name

Description/Notes

application.server.endpoint

Set this to the endpoint of your Interact server. For example:

application.server.endpoint=http://localhost:8080/interact

server.port

Add or uncomment this setting:

server.port=10003

poll.initDelay.milliseconds

poll.fixedDelay.milliseconds

Configures the sampling time (in milliseconds) to determine if there is a request waiting.

For example:

poll.initDelay.milliseconds=120000

poll.fixedDelay.milliseconds=2000

Configure the uRPC Service ^{[Return to Top ↑]}

uRPC Service settings are maintained in the following file:

urpc.properties

Property Name

Description/Notes

application.server.endpoint

Set this to the endpoint of your Interact server. For example:

application.server.endpoint=http://localhost:8080/interact

server.port

Add or uncomment this setting:

server.port=10011

grpc.server.port

Add or uncomment this setting:

grpc.server.port=10012

Configure the U-Common Connector Service ^{[Return to Top ↑]}

U-Common Connector Service settings are maintained in the following files:

jis-app.properties

Property Name	Description/Notes
`ucommonconnector.server.endpoint`	Set this to the endpoint of your U-Common Connector server. For example: `ucommonconnector.server.endpoint=http://localhost:8080/u_common_connector`

Property Name

Description/Notes

ucommonconnector.server.endpoint

Set this to the endpoint of your U-Common Connector server. For example:

ucommonconnector.server.endpoint=http://localhost:8080/u_common_connector

u_common_connector.properties

Property Name	Description/Notes
`application.server.endpoint`	Set this to the endpoint of your Interact server. For example: `application.server.endpoint=http://localhost:8080/interact`
`server.port`	Add or uncomment this setting: `server.port=10001`
`urpc.server.endpoint`	Add or uncomment this setting: `urpc.server.endpoint=10012`
`subscriptions.auto`	Add or uncomment this setting: `subscriptions.auto=false`

Configure Hazelcast Cache Settings ^{[Return to Top ↑]}

Interact uses Hazelcast to provide a distributed cache mechanism for sharing information across multiple nodes. Distributed cache settings are maintained in the following files:

hazelcast.xml
server.xml
context.xml

Note: For complete information about using Hazelcast, go to http://www.hazelcast.org

Ports Usage

Hazelcast is used by two core Interact services modules (interact.war and reports.war), therefore a running Hazelcast node is required for both.

To support this, during startup two separate instances of Hazelcast are started on each server. Each Hazelcast node attempts to use the port defined in the port section specified in the configuration file (e.g., 5701 ). If the port is already reserved by the other running node, it will be auto-incremented (e.g., 5702), for use by the second node.

To ensure a successful startup, the specified ports must be free and must be able to communicate with the cluster servers. (Alternatively, it is possible to configure a multicast address for cross-member communication.)

hazelcast.xml

Verify that the hazelcast.xml file exists (in <INTERACT_HOME> \conf folder on all cluster nodes.

Specify all cluster members in the file:

Insert the following parameter under the network node:
```
<port auto-increment="true">5701</port>
```

Set the value for the tcp-ip parameter and configure the cluster members:

<tcp-ip enabled="true"> <interface><member1 host></interface> <interface><member2 host></interface> <interface>>member3 host></interface>> ... </tcp-ip>&lt

Turn off symmetric encryption by adding the following parameter under the network node:
```
<symmetric-encryption enabled="false">
```

server.xml

Verify that the server.xml file exists in <CATALINA_HOME> \conf folder.

Open the file and verify that the following rows appear in the listeners section:

<!-- Starts Hazelcast node based on $JACADA_INTERACT/conf/hazelcast.xml --> <Listener className="com.jacada.is.hazelcast_bootstrap.StartupHandler" />

For more information about server.xml , go to http://tomcat.apache.org.

context.xml

To prevent server startup exceptions that may appear when loading a persistent session, open this file in the <CATALINA_HOME> \conf folder and add/uncomment the following line:

<Manager pathname="" />

After saving the file, empty the \work folder and restart the Tomcat server.

Configure Interact Log Settings ^{[Return to Top ↑]}

The settings that specify Interact logging activities are maintained in the following files:

jis-app.properties
logback.xml

In the jis-app.properties file found in the <INTERACT_HOME> \conf folder on each active cluster node, verify that the following properties are set to their default value ( false):
```
          database.logging=false logstash.logging=false
```
On each participating cluster server, open the file WEB-INF/classes/logback.xml and set the log value to the desired level. Note: You must set the log level for each relevant service, on each active cluster node.
Restart each active cluster node.

By default, server logs are written to the <INTERACT_HOME> /logs folder. The main module log file is as_rest.log.

For complete information about logback , see http://logback.qos.ch/.

Configure the URL Shortener ^{[Return to Top ↑]}

Interact provides an internal URL shortening service, which you can use to shorten URLs as required (for example, when sending access links to Flow users).

The settings that specify Interact URL shortening are maintained in the following files, found in the <INTERACT_HOME> \conf folder:

jis-app.properties
short-url.properties

In the jis-app.properties file, change or add the following properties:

Property	Description/Notes
`urlShortener.server.endpoint`	Specifies the local environment endpoint to the URL shortener.
`urlShortener.defaultService`	Specifies the name of the URL Shortener service that will be used.

For example:

          urlShortener.server.endpoint=http://localhost:8080/UrlShortener urlShortener.defaultService=urlShortener

In the short-url.properties file, specify the following:
Property
Description/Notes
urlPrefix
Specifies the path to the URL shortener.
tokenLength
Specifies the number of characters for the random string that is appended to the base URL.
For example:
```
          urlPrefix=http://localhost:8080/UrlShortener/ tokenLength=10
```

Property	Description/Notes
`urlPrefix`	Specifies the path to the URL shortener.
`tokenLength`	Specifies the number of characters for the random string that is appended to the base URL.

Note: In order for the URL Shortener to function, the Account Admin must activate the relevent URL Shortener checkbox on the General Settings page of the Admin Console.

Configure Interact Reporting ^{[Return to Top ↑]}

Interact generates reports that enable monitoring of Flow execution. Reports provide aggregated information to help reveal usage patterns for selected Flows during a specified timeframe. Reports are also used to provide data runtime required by other Interact components.

Note: For complete information about data collection and report creation, see the X-Platform Reporting section.

The reporting aggregation schedule and other parameters are configurable.

Interact Reporting settings are maintained in the following files, found in the <INTERACT_HOME> \conf folder:

jis-app.properties
report-app.properties

In the jis-app.properties file, change or add the following properties:

Property	Description/Notes
`reports.server.url`	Specifies the server URL that will be used by the reporting application. For example: `reports.server.url=https://<host>:<port>/reports` where: <host> and <port> specify the location of the Reporting application
`server.admin.reportsEndpoint`	Specifies the local environment endpoint for the reporting application. For example: `reports.server.url=https://<host>:<port>/reports` where: <host> and <port> specify the location of the Reporting application

Property

Description/Notes

reports.server.url

Specifies the server URL that will be used by the reporting application. For example:

reports.server.url=https://<host>:<port>/reports

where: <host> and <port> specify the location of the Reporting application

server.admin.reportsEndpoint

Specifies the local environment endpoint for the reporting application. For example:

reports.server.url=https://<host>:<port>/reports

where: <host> and <port> specify the location of the Reporting application

In the report-app.properties file, change or add the following properties, as needed:

Property	Description/Notes	Default Value
`job.run.interval`	Scheduled duration for performing aggregation in milliseconds.	`1800000`
`horizontal.mode.enabled`	Turns on the Hazelcast distributed cache.	`true`
`horizontal.mode.litemember`	Settings for the Hazelcast manager.	`false`
`horizontal.mode.nativeclient`		`false`
`horizontal.mode.run.local.node`		`true`
`database.logging`	Saves log messages to a separate database.	`false`
logstash.logging	Sends log messages to the UDP port.	`false`
`logstash.udp.host`	IP address of the UDP listener.	—
`logstash.udp.port`	Port of the UDP listener.	—

Restart the server.

In this section:

Uniphore Customer Portal

5. Installing Interact

Interact Installation Workflow

Preparing the Interact Server Environment

Configuring Environment Variables

Copying Installation Files

Configuring the Application Server

Search results