CCT Open Interfaces SDK

OI RefClient

1.      Overview of the Open Interface Reference Client. 1

Description of Tutorial 1

2.      The Purpose of the OI Reference Client. 2

3.      The Folder Structure. 2

The OI_RefClient folder. 2

The Project folder. 3

4.    How to Configure and Run the OI Reference Client. 3

Prerequisites to running the RefClient. 3

Running the RefClient. 3

Running the RefClient with user-defined Notification Port. 4

Running the RefClient in HTTPS mode. 5

5.   How to Import the OI reference client into Eclipse. 14

6.   How to run the OI Reference Client from Eclipse. 17

 

 

 

1.            Overview of the Open Interface Reference Client

Description of Tutorial

This document will provide an overview of the Open Interface Reference Client. It will detail:

o    The Purpose of the OI Reference Client

o    The Folder structure

o    How to Configure and Run the OI Reference Client

o    How to Import the OI Reference Client into Eclipse

o    How to Run the OI Reference Client

 

 

 

2.            The Purpose of the OI Reference Client

 

The purpose of the OI Reference Client is to provide our customers with a sample Java Swing application used to demonstrate the use of web services to interact with CCT.

Client uses web services to

o    Invoke functionality on CCT

o    Receive notifications/events from CCT.

 

 

 

3.            The Folder Structure

There are two folders located at OI_RefClient

1.      OI_RefClient folder

2.      Project folder

 

The OI_RefClient folder

The OI_RefClient folder contains RefClient.bat file that runs the OI Reference Client program.

 

The Project folder

The Project folder contains a zip file that can be imported into Eclipse.

 

 

4.    How to Configure and Run the OI Reference Client

 

This section will demonstrate how to run the OI reference client using the RefClient.bat file

 

Prerequisites to running the RefClient

JRE 8.x installed as default

Run "java -version" at the command prompt to verify this

Running the RefClient

Navigate to where the installation is and run RefClient.bat at the command prompt as follows:

\RefClient\RefClient.bat

 Running the RefClient with user-defined Notification Port

As mentioned above, the receipt of events from CCT is facilitated through web services, i.e. the RefClient publishes a web service which is called by the server when an event fires that the Client has registered/subscribed for.

 

The publication of the Notification service occurs on startup, even before any login has taken place. By default the application will automatically acquire an unused port to publish the notification service on.

 

However, there exists the option for the client to specify a particular port by supplying the port number as a parameter to the RefClient.bat file as follows:

 

D:\RefClient>RefClient.bat 1234

...where 1234 is the port number supplied as a parameter

 

 

 

Please note that if you don’t run this on the machine where the Avaya Aura Contact Center is installed the bat RefClient.bat will not pick up the registry key located at

 

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Nortel\Communication Control Toolkit\JreVersion

 

If this happens, the RefClient.bat will get the JRE version from the PATH environment variable.

 

 

 

This will result in the following web service being published (For this example assume client's IP is "192.168.1.35")

o    http://192.168.1.35:1234/SOAOICCT/services/NotificationConsumer

 

 

Running the RefClient in HTTPS mode

The purpose of this section is to explain how to configure the SOA OI RefClient to use TLS.

 

There is a section in the document "Avaya Aura® Contact Center SIP Commissioning (NN44400-511)" named "Certificate Authority" which describes the process of configuring a standalone certificate authority and generating certificates.

 

There is also a section in the document "Avaya Aura® Contact CenterCommissioning (NN44400-312)" named "Communication Control Toolkit Web service configuration" which describes the process of configuring the server side of the Web services to use TLS.

 

The following assumes the reader has already configured the Web services with the correct certificate.

 

Prerequisites:

1.      Knowledge of how to configure the Web services to use TLS

2.      An exported root certificate of the Certificate Authority

 

Step 1: Configure the CCT server to use TLS security. Save a copy of the trusted CA certificate.

 

 

 

Step 2: Copy the trusted CA certificate to the folder \OI_RefClient\config.soa.client\

 

 

 

 

 

Step 3: Make sure the file trustedCA.keystore is present in the folder \OI_RefClient\config.soa.client\

 

 

 

Step 4: Open the command prompt and cd to the folder \OI_RefClient\config.soa.client\

 

 

 

Step 5: Execute the following command "keytool -import -alias root1 -keystore trustedCA.keystore -file <name of the root certificate>".

 

 

 

Step 6: Enter 123123 as the passphrase.

 

 

 

Step 7: Enter "yes" to confirm adding the root certificate to the trusted certificates. If "keytool" is not recognised as a command find it in <JRE folder>\bin and run with the full path. 

 

 

 

Step 8: Run the SOA OI RefClient

 

 

 

Step 9: Check that there are two files in the directory \OI_RefClient\config.soa.client\

a.      SecureClient.cxf

b.      SecureClient.cxf_https

 

 

 

Step 10: Go to Preferences --> Server. Enter the name of the server you are connecting to (not the IP, the root certificate is bound to the name) and switch to https. The ref client will exit after the change is made

 

 

 

Step 11: After that there are two files in the folder \OI_RefClient\config.soa.client\

a.      SecureClient.cxf - SecureClient.cxf has been renamed to SecureClient.cxf_http

b.      SecureClient.cxf_http - SecureClient.cxf_https has been renamed to SecureClient.cxf

 

The ref client renames these files automatically depending on the mode used http or https.

 

 

 

Step 12: In order to make the SOA OI RefClient accept not only connections with a trusted certificate but also from specific computers only (where the Web services are hosted) the file SecureClient.cxf needs to be edited. Find the section  <http:conduit name="*.http-conduit"> If you want to be able to connect to any host change it to <http:conduit name=".*"> If you want to make sure you are connected to the right server you can place a restriction on the name of the server you are connecting to. In order to do that put the regular expression pattern in the name of the conduit for example <http:conduit name="https://server1/.*"> - with this conduit the client will connect not only to the server with a trusted certificate but also with the name "server1". Please note that it is not enough for the pattern to contain the actual link the pattern must match the link. If you want to be able to connect to two or more servers please add a conduit for every server. Now the SOA OI RefClient is ready to connect over TLS

 

 

 

 

5.   How to Import the OI reference client into Eclipse

Step 1: Open Eclipse and go to import an Existing Project into your Workspace.

 

Step 2: Select the archive file SOAOI_RefClient

 

Step 3: Click the finish button and the project will be imported to your Workspace

 

 

 

6.   How to run the OI Reference Client from Eclipse

Step 1: Locate the main class com.nortel.rc.gui.SOARefClient

 

Step 2: Run as Java Application. This will launch the OI Reference Client

 

 

Step 3: Update the Server Preferences

 

Step 4: Enter in the server address and the port that the OI Web Services are listening to and click ok.  Please note that if you changed any initial value, when you click OK the SOA Reference Client will restart. When you load up the SOA reference again, the server values will be updated.

 

Step 5: Go to Session -> Login to CCT

 

 

Step 6: Enter in the appropriate details

 

Step 7: Press Connect and you will log in