LA Overview and Installation Guide
LA Overview and Installation Guide
Guide
Updated: 2022-06-22
Contact Information
For technical support or other queries, contact CBA Communications Support at:
As CBA Live Assist uses the FCSDK for the voice and video capabilities, you can integrate
CBA Live Assist with existing SIP infrastructures such as call centers, PBXs and MCUs.
When a consumer requests support they see a small moveable video window that directly links
them to the agent on the call center. The application does not need to be aware of this window,
as it floats above all other screen content.
The voice and video link exists for the duration of the support call.
Co-browsing
When a consumer requests support, their application view is shared with the agent. The
application does not need to do anything to cause this to happen, because the co-browsing API
works without interaction from the application. The co-browsing session exists for the duration of
the support call.
Document Push
An agent in a support session can push PDF and image documents to the consumer. Both the
agent and the consumer can interact with the shared document, and the consumer’s view of the
document is replicated on the agent’s console.
Acceptable document types are: PDF, and the image formats GIF, PNG, and JPG/JPEG.
Remote Control
When a consumer requests support, their desktop is shared with the agent. The agent can click
on this shared desktop to interact with the consumer’s application. This ability to remote control
Annotation
While a consumer is in a support session, their view is shared. The agent can use the annotation
tool to draw on their shared image of the consumer’s screen. CBA Live Assist transfers these
annotations to the consumer’s application, which draws them on the consumer’s screen so that
the consumer can see them.
Note: The consumer’s application does not need to be updated or aware of this annotation taking
place.
Oracle Java 8
CBA Live Assist depends on Fusion Application Server (FAS) and Fusion Client SDK
(FCSDK), which can either be installed using their own installers, or as part of the pre-packaged
CBA Trial Environment. CBA Live Assist must be deployed to the same FAS instance as
Fusion Client SDK.
See the CBA Live Assist Release Notes for information regarding which versions of FAS and
FCSDK are appropriate for this version of CBA Live Assist. For information regarding
requirements and installation process of these products, see their associated installation guides.
CBA Live Assist requires the presence of Oracle Java 8 JRE or JDK, which can be obtained
from Oracle:
http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html
Servers
System requirements for a CBA Live Assist server are the same as those for an FCSDK Web
Gateway server (see the FCSDK Installation Guide for the minimum requirement). A minimum
system is suitable for demonstration or development.
For production systems, the number and specifications of servers depends on how you expect to
use it. A sizing tool for servers or Virtual Machines is available from CaféX. It has the form of a
spreadsheet in which you can input the number and type of calls you want, and read off the
number of servers required.
Clients
For the latest information on third party platforms (OSs, web browsers, and hardware) supported
by CBA Live Assist, see the CBA Live Assist Release Notes.
Console Installation
You can install CBA Live Assist from the command line by specifying the installation
configuration in a properties file. Trial Environment and Production properties files are provided
with the installer. See the Installer Properties section for details of how to complete the properties
fields.
2. Edit the production-install.properties file, providing the required configuration values (see the
Installer Properties section).
Installer Properties
Property Description
The local path to install the CBA Live Assist SDK, including
INSTALL_PATH
the SDK files, documentation and license files.
Runtime
Administration WEB UI
Note: This only installs the CBA Live Assist plugin to the CLI;
When you install FAS and FCSDK as a non-root user, you have to specify at least one of two
non-root OS-level users in the installation properties file:
os.user is the user which the FAS, FCSDK, and CBA Live Assist systems run as.
This user can read and write log files, and start and stop the services (FAS and media broker).
This user can run the CLI and logcapture, view the audit logs, and perform administration duties
(for example, deploy files or make administration changes).
The first user (os.user) is mandatory, but is set to root in the FAS and FCSDK installation
properties file by default. If the installation properties file does not specify the second user
(os.admin), both installers assign os.admin’s responsibilities to os.user. Therefore, if you did not
change the defaults when you installed FAS and FCSDK, both the administration tools and the
system itself run as root. See the FCSDK Installation Guide and the FCSDK installer’s
advanced-install.properties file for details of the permissions and groups which these users need.
The CBA Live Assist installer must run as the os.admin user, because the CBA Live Assist
installer has no concept of users, and just administers the current system. If the FAS and FCSDK
https://<fas address>:8443/web_plugin_framework/webcontroller/assist/
After logging in, navigate to the CBA Live Assist tab and choose the General Administration
page:
You can configure the following parameters in the CBA Live Assist Settings section:
Setting Description
Anonymous
Consumer Enabled (default)
Access
Anonymous consumer use of CBA Live Assist is permitted; however,
a client application cannot specify a Correlation ID if Anonymous
Consumer Access is Enabled.
Disabled
Trusted
Note: The Trusted scenario may not be desirable, and this mode
should only be enabled in secure environments.
Enabled
Note: When using the Sample Agent Console supplied with CBA Live
Assist, you must set this to Enabled.
Note:
In the Trial Environment, the use of HTTPS typically leads to a warning message indicating
that the server certificate is invalid. This happens because the Trial Environment does not
use a fixed server name (with its DNS published), as it is designed to be able to run on a
We still recommend using HTTPS during application development, because it avoids having
to repeatedly click the Allow video button.
For HTTP, the port is typically 8080 instead of 8443; however, the person administering the
Fusion Application Server can change this, if required.
If you are using the Finesse Gadget, you can disable CBA Live Assist features which you do
not want agents to have access to. Scroll to the Agent Features section:
Uncheck the appropriate box to disable that feature for all agents. When a feature is disabled,
the corresponding toolbar button in the agent console is also disabled.
Feature Description
The agent can use the Zoom tool to expand a portion of the consumer’s
Zoom
screen.
Annotate The agent can enter Annotation mode and draw on the consumer’s screen.
The agent can use the Spotlight tool to highlight parts of the consumer’s
Spotlight
screen.
Document The agent can share documents and links with the consumer. A supervisor
Share must have made the documents and links available to the agent for sharing.
Note: These settings apply to agents created using anonymous agent access by the agent
session creation servlet at /assistserver/agent/; that includes agents using the sample web
application provided with CBA Live Assist, and agents using the Finesse gadget. For custom-
built agent Web Applications, and how they can control which features an agent has available,
see the CBA Live Assist Agent Console Developer Guide.
Event Description
AgentUse An agent joins the co-browse session using a supplied short code.
Note: Currently, MariaDB and Microsoft SQL Server are the only supported databases.
The database must contain a single table called event, with the following schema:
You can create the table by hand, but the most reliable way is to run the database update script,
found in the installer zip file, from the command line:
database updated
database updated
Note:
You must have sqlcmd (for SQL Server) or mysql (for MariaDB) on the server running the
upgrade script.
The SQL Server script sets the metadata column as VARCHAR(max), which gives it a size
of 2 GB. If you create the table by hand, 4096 characters should be ample.
You may need to grant permissions on the DBMS to the CBA Live Assist host or user, in
order to allow it to write entries to the database. See your RDBMS documentation for how to
do this.
To test that the table exists, start mysql, connect to the database, and run:
(or the equivalent using sqlcmd for SQL Server). If the script has successfully created the table,
the select statement selects an empty set, as above. If it has failed, the client displays an error.
When it logs an event, the event_action column shows the logged event (see the Event Logging
Configuration section). Currently, event_category and event_component only show CoBrowse
and LA respectively. The participant_id is a name which an agent or consumer can supply when
they create a session (see the CBA Live Assist Developers Guides for how to set it). If it is not
set when the session is created, the participant_id is empty.
You can also use the update-db.sh script to update and roll back the event logging database
schema.
or
or
1. Download a suitable JDBC driver for MariaDB or SQL Server. You can find these at:
https://mariadb.com/kb/en/mariadb/about-mariadb-connector-j/
https://docs.microsoft.com/en-us/sql/connect/jdbc/microsoft-jdbc-driver-for-sql-server
4. In the left hand menu, expand Domain and select Manage Deployments.
6. Click Add to display the Upload dialog and select the driver file:
7. Select the driver you have just deployed, and click Assign:
2. Select the ha profile from the Profiles drop down in the top left
5. Click Next:
6. Click Next:
7. Click Done.
8. Restart FAS.
11. Select the ha profile from the Profiles drop down in the top left.
Enter a suitable SQL statement to use for validating the connection in Check Valid Sql.
16. Click Enable under Available Datasources in the main JDBC Datasources page to re-enable
the datasource.
2. Run an SQL query using a suitable client to ensure that a record has been placed in the
database:
+—-+———————–+————–+—————-+—————–+————–+
———————————-+———————————————–+———————+
+—-+———————–+————–+—————-+—————–+————–+
———————————-+———————————————–+———————+
+—-+———————–+————–+—————-+—————–+————–+
———————————-+———————————————–+———————+
Note:
To use the Agent Console, CBA Live Assist must be configured to allow Anonymous
Agent Access - see the Fusion Live Assist Server Configuration section for details of how to
change this configuration.
To test co-browse only mode, configure CBA Live Assist for Trusted Consumer Access -
see the Fusion Live Assist Server Configuration section for details of how to change this
configuration.
Sample Applications
https://<fas address>:8443/assistsample/
Agent console:
https://<fas address>:8443/agent/console/
Note: If you are using Chrome on the same machine for both the consumer and the agent, make
sure that you open at least one of the tabs in Incognito mode.
1. In the sample application, click the CBA Live Assist icon in the top right.
The sample application should show a video window, and automatically call the agent using the
Fusion Client SDK.
3. Select the Drawing Tool ( ) on the agent desktop, and draw on the shared view.
The annotations should appear on the consumer side of the support call.
1. For both the consumer sample and agent console, append the following to the URL:
?cid=sharedid
For the sample only, also add the following to the URL:
&cobrowseOnly=true
Both pages should load, but the console should not start a voice and video call.
2. On the sample application, click the CBA Live Assist icon in the top right.
An agent window appears; place a call to the agent through the Fusion Client SDK. The agent
automatically accepts the call.
3. Select the Drawing Tool ( ) on the agent desktop, and draw on the shared view.
The annotations should appear on the consumer side of the support call.
Note:
You can specify both a destination and a correlation ID to the consumer sample application
using the following URL parameters:
destination=<address>&cid=<an_id>
To see the version of the CBA Live Assist server currently running, browse to the following
URL:
http://<fas address>:8080/assistserver/info/version.html
Configure a reverse proxy to expose the following CBA Live Assist URLs:
GET,
HTTP or POST, Servlet used to provide
/assistserver/consumer
HTTPS PUT, clients with a session.
DELETE
GET,
HTTP or POST,
/assistserver/session Session servlet.
HTTPS PUT,
DELETE
GET,
HTTP or POST, Servlet used to provide
/assistserver/agent
HTTPS PUT, agents with a session.
DELETE
HTTP or
/assistserver/sdk/web/* GET Web SDK assets.
HTTPS
Other URLs are used to configure the system, and you should restrict access to them. They
should not be visible, and the reverse proxy should be configured to block them. These URLs
are:
/web_plugin_
framework/ HTTP or CBA Live Assist configuration
GET
webcontroller/ HTTPS subsystem.
liveassist/