Skip to main content

Uniphore Customer Portal

6. Optional Add On Installations

Each of the components in this section can be installed on any Interact node, as needed. The availability of specific services during runtime is determined by an account's license subscriptions.

For additional information, contact your Uniphore support representative.

Robotic Process Automation (RPA) Component Installation

The Robotic Process Automation (RPA) component can be installed and configured independently of the Interact installation at any time.

Add Environment Variable and RPA Files

  1. Create a new environment variable called <RPA_HOME> that points to the designated rpa_home folder on the target machine.

  2. Copy the rpa_home folder from the Interact installation package to the rpa_home folder on the target machine.

Configure RPA Properties

In the <RPA_HOME>\conf folder, make the following properties file changes:

mongo.properties

Property Name

Description/Notes

mongo.host

The IP address(es) or hostname(s) and port(s) of the host(s) running MongoDB.

In a replica set, this property should point to each of the nodes in the set. For example:

mongo.host=127.0.0.1:[port1],127.0.0.1:[port2]

mongo.database

The name of the Uniphore Interact database.

This property should always be set to mongo.database=System. (Verify 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 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.

rpa.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.

Note that the value for this setting will vary according to the environment. For example:

server.port=9096

rpa_client.properties

Property Name

Description/Notes

rpa.server.endpoint

Set this to your RPA server address. For example:

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

Running RPA

You can run the Interact RPA component either as a standalone server or on a Tomcat platform.

Note: For Avaya AES installations, ensure that the updated tsapi.pro .jar file resides in the tomcat /libfolder.

Running Independently (Standalone)

Start the RPA by running:

java -jar rpa.jar

Running via Tomcat (Windows Platform)

  1. Delete all unneeded files to ensures a clean installation:

    • Delete the tomcat \work folder.

    • Delete all log files from the tomcat \logs folder.

    • Delete all log files from <INTERACT_HOME> \logs folder.

  2. Copy the rpa.war file from the rpa_home folder in the Interact installation package to the tomcat \webapps folder on the target machine.

  3. Start Tomcat:

    • Open CMD with Administrator privileges.

    • Go to the \bin folder:

       <tomcat>\bin

    • Run the following command:

      startup.bat

    The RPA component will now start with Tomcat.

Business Information (BI) Component Installation

The Business Information (BI) component can be installed and configured independently of the Interact installation at any time.

Add Environment Variable and BI Files

  1. Create a new environment variable called <BI_HOME> that points to the designated bi_home folder on the target machine.

  2. Copy the bi_home folder from the Interact installation package to the bi_home folder on the target machine.

Configure BI Properties

In the <INTERACT_HOME> \conf folder, make the following properties file changes:

jis-app.properties

Property Name

Description/Notes

bi.server.endpoint

Use the following to specify the server and port of the host running BI.

[protocol]://[server_name]:[port]/bi

For example:

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

In the <BI_HOME> \conf folder, make the following properties file changes:

mongo.properties

Property Name

Description/Notes

mongo.host

The IP address(es) or hostname(s) and port(s) of the host(s) running MongoDB.

In a replica set, this property should point to each of the nodes in the set. For example:

mongo.host=127.0.0.1:[port1],127.0.0.1:[port2]

mongo.database

The name of the Uniphore Interact database.

This property should always be set to mongo.database=System. (Verify 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 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.

bi.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.

Note that the value for this setting will vary according to the environment. For example:

server.port=9096

botIntegrations.properties

Property Name

Description/Notes

server.port

Add or uncomment this setting.

Note that the value for this setting will vary according to the environment. For example:

server.port=9096

Running BI

You can run the Interact BI component either as a standalone server or on a Tomcat platform.

Running Independently (Standalone)

Start the BI by running:

java -jar bi.jar

Running via Tomcat (Windows Platform)

  1. Delete all unneeded files to ensures a clean installation:

    • Delete the tomcat \work folder.

    • Delete all log files from the tomcat \logs folder.

    • Delete all log files from <INTERACT_HOME> \logs folder.

  2. Copy the bi.war file from the bi_home folder in the Interact installation package to the tomcat \webapps folder on the target machine.

  3. Start Tomcat:

    • Open CMD with Administrator privileges.

    • Go to the \bin folder:

       <tomcat>\bin

    • Run the following command:

      startup.bat

    The BI component will now start with Tomcat.

Custom Authentication Component Setup

If your installation uses today's standard methods and protocols (e.g., LDAP) Uniphore Interact does not require any special configuration or setup procedures. You simply select the desired authentication method using the Interact Admin Console, as described here.

However, should your environment require customized authentication, Interact provides an external Authlink authorization server, supporting LDAP as well as other methods. This Custom Authentication component operates in strict accordance with Uniphore Interact security requirements.

The custom authentication flow uses four phases, as shown in the following diagram.

JIS_LDAP_LoginFlowDiagram.png

The component application receives authentication and authorization requests directly from Uniphore Interact clients, and passes them to the relevant server for verification. User credentials are never exposed to the Interact Server.

The Custom Authentication component can be installed and configured independently of the Interact installation at any time.

Add Environment Variable and AuthLink Files

  1. Create a new environment variable called <AUTHLINK_HOME> that points to the designated authlink_home folder on the target machine.

  2. Copy the authentication.properties file from the interact_home folder of the Interact installation package to the designated authlink_home folder on the target machine.

  3. Copy the authlink.war file from the webapps folder of the Interact installation package to the designated authlink_home folder on the target machine.

Configure Custom AuthLink Properties

Open the authentication.properties file located in the <AUTHLINK_HOME> folder and update/add the properties required for your custom authentication method.

For a detailed example of property changes needed for a custom LDAP-based authentication process, see Configuring AuthLink Authentication in the Uniphore Help Center.

Using the Custom AuthLink Service

Restart the Tomcat application server to use the new custom authentication settings with Interact.

Custom Integration Point (CIP) Component Setup

The Custom Integration Point (CIP) component can be installed and configured independently of the Interact installation at any time.

Note: Interact CIP functionality requires that nodeJS Version 12 or later be installed on the host Interact server. Only CIP code version V2 is supported.

For details on creating and using Interact Custom Integration Points, click here.

Add CIP Files

  1. Copy the custom_ip_home folder of the Interact installation package to the custom_ip_home folder on the target machine.

  2. Unzip the custom_ip_bundle.zip file to the custom_ip_home folder on the target machine.

Configure CIP Properties

The settings that specify CIP functionality are maintained in the jis-app.properties file, found in the <INTERACT_HOME> \conf folder:

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

    Property

    Description/Notes

    custom_ip.enabled=true

    Enables CIP functionality in the Admin Console.

    custom.ip.server.endpoint

    Specifies the local environment endpoint that will be used by the CIP.

    Use the following to specify:

    [protocol]://[server_name]:[port]/customIp

    The endpoint cannot be an address outside of the local network.

    For example:

     custom_ip.enabled=true custom.ip.server.endpoint=http://localhost:8080/customIp
Running the CIP Service

The bundled package that is provided with the CIP Service installs all components required for its execution during runtime, including the correct NodeJS version. Because of this, using the CIP Service does not invoke any external resources.

Note: The Interact CIP Service supports a maximum response payload of 20 MB.

You invoke the CIP Service using NodeJS, as detailed below.

Running the CIP Service

Run the service via NodeJS:

npm run start

Upon successful start, the CIP Service is available for used by Interact instantly, at any time.

Checking CIP Service Status

To view the health page for the CIP Service, run the following HTTP command:

http://localhost:[port]/customIP/health

where:

The default port value is 9099 . This value can be changed in the config.json file that resides in the custom_ip_home folder.

When the CIP Service is available, this command returns status OK.

Additional CIP Service Runtime Commands

You can invoke any of the following commands via NodeJS, according to your needs:

npm run [command]

where:

  • start invokes: node scriptRunner.js

  • deploy invokes: node_modules/forever/bin/forever start -m 1 -o out.log -e err.log -a scriptRunner.js

  • stop invokes: node_modules/forever/bin/forever stop scriptRunner.js

  • restart invokes: node_modules/forever/bin/forever restart scriptRunner.js

Jacada Workspace (JWS) Component Installation

The Jacada Workspace (JWS) component can be installed and configured independently of the Interact installation at any time.

Add Environment Variable and JWS Files

  1. Create a new environment variable called <JWS_HOME> that points to the designated jws_home folder on the target machine.

  2. Copy the jws_home folder from the Interact installation package to the jws_home folder on the target machine.

Configure JWS Properties

In the <JWS_HOME> \conf folder, make the following properties file changes:

mongo.properties

Property Name

Description/Notes

mongo.host

The IP address(es) or hostname(s) and port(s) of the host(s) running MongoDB.

In a replica set, this property should point to each of the nodes in the set. For example:

mongo.host=127.0.0.1:[port1],127.0.0.1:[port2]

mongo.database

The name of the Uniphore Interact database.

This property should always be set to mongo.database=System. (Verify 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 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.

jws.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

tsapi.pro (required for CTI operation with Avaya AES)

Note: This file is located in the <JWS_HOME> /classes folder. After making the required changes to this file, it should be compressed to a .jar file and added to the tomcat /lib folder.

Property Name

Description/Notes

[IP of AES machine]=[Port of AES machine]

Specify the IP address for the account AES server and the Port to be used. For example:

12.34.56.78=450

#debugLevel

#altTraceFile

Using debug level of JTAPI client and altTraceFile is optional. These lines can be commented.

Running JWS

You can run the Interact JWS component either as a standalone server or on a Tomcat platform.

Note: For Avaya AES installations, ensure that the updated tsapi.pro .jar file resides in the tomcat /libfolder.

Running Independently (Standalone)

Start the JWS by running:

java -jar jws.jar

Running via Tomcat (Windows Platform)

  1. Delete all unneeded files to ensures a clean installation:

    • Delete the tomcat \work folder.

    • Delete all log files from the tomcat \logs folder.

    • Delete all log files from <INTERACT_HOME> \logs folder.

  2. Copy the jws.war file from the jws_home folder in the Interact installation package to the tomcat \webapps folder on the target machine.

  3. Start Tomcat:

    • Open CMD with Administrator privileges.

    • Go to the \bin folder:

       <tomcat>\bin

    • Run the following command:

      startup.bat

    The JWS component will now start with Tomcat.

In this section: