FCSDK Installation Guide

YRP1-508, 3-4 Hikari-no-Oka Yokosuka-Shi, Kanagawa, 239-0847, Japan

tel.: + 81-(0) 46-821-3362 | cba-japan.com
This document contains confidential information that is proprietary to CBA. No part of its contents
may be used, disclosed or conveyed to any party, in any manner whatsoever, without prior
written permission from CBA.
© Copyright 2023 CBA.

All rights reserved.

Updated: 2023-03-14

Document version: 3.4.11.3

Java, JavaScript are registered trademarks of Oracle and/or its affiliates.

Mac®, iTunes and iPhone are trademarks of Apple Inc., registered in the U.S. and other
countries. iOS is a trademark or registered trademark of Cisco in the U.S. and other countries
and is used under license by Apple Inc.

Microsoft, Lync and Windows are either registered trademarks or trademarks of Microsoft
Corporation in the United States and/or other countries.

VMware is a registered trademark of VMware, Inc. in the United States and/or other jurisdictions

VP8 and Android are trademarks of Google Inc.

Contact Information

For technical support or other queries, contact CBA Support at:

support@cbaliveassist.com

For our worldwide corporate office address, see:

https://www.cba-japan.com (Japanese) https://www.cba-gbl.com (English)

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 2

Documentation Set
FCSDK Overview Guide

FCSDK Architecture Guide

FCSDK Installation Guide

FCSDK Administration Guide

FCSDK Developer Guide

Related Documentation

Fusion Application Server

FAS Architecture Guide

FAS Installation Guide

FAS Administration Guide

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 3

Contents
Introduction
Prerequisites
Planning your Deployment
Domain Naming Guidelines
Post Installation Tasks
Installation Tasks
System Requirements
CBA Components
Server Hardware
Operating Systems
Media Broker
Java
Network
Installing Fusion Client SDK
Installing as a Non-Root User
Installation Modes
Pack Descriptions
Installation using the Unattended Installer
Installer Properties
Multi-box Installations
Installing the iOS SDK
Installing the Android SDK
Rolling Back an SDK Upgrade
Installing the Media Broker
Media Broker Pre-requisites
Linux (Red Hat Based)
Installing Media Broker
Media Broker Unattended Installer
Post Installation
Create a Service
Start and Stop the Media Broker

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 4

 Rolling Back a Media Broker Upgrade
Log File Rotation
Native Log File Rotation
Java Log File Rotation
Manual Tests
LDAP Authentication
Validating your Installation
Option 1
Option 2
Configuring the Web Application ID on the Web Gateway
Configuring the Sample Application
Adding Users
Deploying the Sample Application
Testing the Installation

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 5

Introduction
The CBA Fusion Client SDK allows users to develop web applications which can:

Make and receive voice and video calls directly from a Web browser to telephones and
other browsers, without employing web plugins.

Share application events and data

To achieve this, Fusion Client SDK includes:

The Core SDK, which developers can use to develop browser-based applications

The iOS SDK, which developers can use to develop applications for iOS and OSX based
devices.

The Android SDK, which developers can use to develop applications for Android devices

Fusion Client SDK also includes components which allow the enterprise to deploy the
applications which they develop.

Prerequisites

Before you start the installation of Fusion Client SDK, ensure that you have a compatible
Operating System, and that you have a supported JDK installed. See the Fusion Client SDK
Release Notes for details of the supported operating systems and JDK versions.

It is important to read the FCSDK Architecture Guide before you start your installation.

This guide introduces the core concepts, terminology, and the different options for Fusion Client
SDK deployment topologies. This guide assumes you are already familiar with these options.

Planning your Deployment

The type of deployment you decide on depends on a number of considerations:

Service Continuity

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 6

How critical it is for active sessions to stay connected when a component in your communication
network fails?

Service Availability

How critical it is to be able to create sessions if a component in your communication network

fails?

Note: To ensure continuity in your service when a component fails, you will need a Highly
Available deployment of the Fusion Application Server. See the Fusion Application Server
documentation.

Which communication features you want to use internally.

Which communication features you want to offer externally.

For voice and video, you will need to know the details of the network’s SIP infrastructure.

Your budget.

The following logical diagram shows a sample installation offering external access via a
DMZ:

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 7

Note: The separate components in the diagram do not necessarily represent separate physical
components:

For detailed descriptions of each network component, please refer to the FCSDK Architecture
Guide.

Domain Naming Guidelines

Each Fusion Client SDK network component on a Fusion Application Server must have a
unique, DNS-resolvable, controlled domain. The controlled domains ensure that the Fusion
Application Server routes SIP messages to the correct component.

You must also configure the controlled domains on the DNS server, to ensure that they are
resolved to the Fusion Application Server IP address.

In an example deployment where the Web Gateway is hosted on a Fusion Application Server
with the IP address 192.123.45.67, the following settings may apply:

Network Component Controlled Domain DNS Resolution

Web Gateway wg.example.com wg.example.com -> 192.123.45.67

You define these controlled domains during the installation process. Ensure that you have
prepared the DNS resolution and any domain names you plan to use are not used elsewhere on
the Fusion Application Server.

Post Installation Tasks

After you have completed the installation procedures in this document, there are a number of
configuration tasks that you may need to perform before you can deploy applications developed
with Fusion Client SDK. For example:

Configure the Web Gateway

Add and configure Media Brokers

Each of these tasks is described in the Fusion Client SDK Administration Guide.

Installation Tasks

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 8

 Install Java on the Web Gateway and See the installation documentation for the
Media Broker boxes Java SE Development Kit

Install Fusion Application Server See FAS Installation Guide.

Run the Fusion Client SDK installer See the Installing Fusion Client SDK section

Install the Media Broker See the Installing the Media Broker section

Validate your installation See the Validating your Installation section

Develop your application using Fusion

See the FCSDK Developer Guide.
Client SDK

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 9

System Requirements

CBA Components

See the Fusion Client SDK Release Notes for information on compatible versions of Fusion
Application Server.

Server Hardware

Servers should have at least:

6GB of RAM

20GB free disk space

4 core 2.15 GHz CPU (4 x 2.15 = 8.6 GHz for a VM)

This is the minimum necessary for installing and running both FAS and FCSDK, together with a
single Media Broker, on the same host.

Operating Systems

Fusion Client SDK is supported on the same operating systems as Fusion Application Server.
See the Fusion Application Server Release Notes for details of the supported operating
systems.

Media Broker
Media Broker supports:

CentOS 7

64-bit x86 Red Hat Enterprise Linux Advanced Platform version 7

Java

Either Java SE Development Kit or Java SE Runtime Environment.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 10

See the FCSDK Release Notes for the supported versions.

Network

To support the transfer of RTP, Media Brokers need the following bandwidth:

Video calls need 1Mbit/s in each direction (upload and download)

Audio calls need approximately 100kbit/s in each direction; however, this depends on the
codec used

Failure to meet these requirements can result in degraded media quality, but enabling Call
Admission Control can prevent overloading of the Media Brokers (see the FCSDK
Administration Guide).

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 11

Installing Fusion Client SDK
You can install the complete Fusion Client SDK, including Media Broker and samples, or select
specific components by selecting different packs. Refer to the Pack Descriptions section for
information on the packs.

You can install Fusion Client SDK using the unattended installer. Using the unattended installer
allows you set your preferences once in a properties file, and to run the installer with that
properties file as many times as you require.

The FCSDK has a number of optional components. If you do not install an optional component
the first time, you can re-run the installer later with only the missing components selected.

Installing as a Non-Root User

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 and FCSDK systems are to run as.

This user can read and write log files, and start and stop the services (FAS and Media Broker).

os.admin is the user which the administrative tools run as.

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 will run as root. See the FCSDK installer’s advanced-install.properties file for details
of the permissions and groups needed for these users.

Note:

The FCSDK Web Gateway is installed to an existing instance of FAS, and FCSDK will use
the os.user and admin.user which FAS runs under. When installing a Media Broker,
however, the installed Media Broker will run using the os.user and admin.user defined in the

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 12

 FCSDK installation. For simplicity, we recommend using the same os.user and admin.user
for both FAS and the Media Broker.

Installation Modes

The installer can be run in the following modes:

Quick

This mode uses default values for most of the installation options, and is suitable for lightly
loaded development systems. It should not be used for production systems, as it includes the
deployment and configuration of the CBA sample application on the Gateway server.

Upgrade

This mode will upgrade existing FCSDK applications on the Fusion Application Server, while
also maintaining the applications’ configuration - you can also upgrade a Media Broker.

When upgrading FCSDK applications, we recommend that you first upgrade the Fusion
Application Server (as documented in the FAS Installation Guide), even if a newer version is
not required, as this will allow you to rollback the upgrade by switching to the old FAS instance
(which it will not delete).

Advanced

This is the most flexible installation mode, in which you can choose exactly which components
you wish to install.

Pack Descriptions

Pack Description

Web Gateway Installs all the components for the Web Gateway. This includes:

Runtime Administration REST Services

Administration Web
Administration Command Line Interface
UI

Deploys the modules of the core runtime functionality to the Fusion

Runtime Application Server (FAS). This will enable the core server feature
capabilities of the Fusion Client SDK (FCSDK).

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 13

 Deploys the administration REST services to the FAS. This will
Administration
enable administration features of the FCSDK and can be deployed
REST services
to the same FAS instance as the runtime or a separate one.

Deploys the Administration Web UI to the FAS. This will enable

administration of the FCSDK from a Web browser. The Web UI
Administration Web
uses the Administration REST Services, and can be deployed to the
UI
same FAS instance as the REST Services runtime, or to a separate
one.

Administration Installs the Administration CLI. This will enable non-graphical

Command Line administration of the FCSDK from the command line. The CLI uses
Interface the Administration REST services.

Deploys the sample applications to the FAS and installs the sample
Core SDK
source code and core JavaScript SDK to a local directory.

Installs the sample source code for the sample applications to a

Sample Source
local directory.

Installs the core JavaScript SDK to a local directory. This contains

JavaScript SDK
the JavaScript itself and API documentation.

Installs the services for the Media Broker and associated scripts. It
Fusion Media
will install the Media Broker to the selected directory; Media Broker
Broker
does not run on a FAS instance.

Deploy and
Deploys the sample application and configures it with two users.
Configure the
Configures the gateway for the sample application.
Sample Application

Installation using the Unattended Installer

Fusion Client SDK can be installed from the command-line by specifying the required
installation configuration in a properties file. Sample template properties files are bundled with
Fusion Client SDK. See the Installer Properties section for details of how to complete the
properties fields.

1. Extract the installation files from fusionweb-installer-3.x.x.zip into a temporary folder on the
install machine.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 14

 2. Edit the properties file as required. Three files are provided:

quick-install.properties

advanced-install.properties

upgrade-install.properties

The quick version only has those properties required for a quick install.

3. Run the installer as follows:

java -jar fusion_client_sdk_core_installer-3.x.x.jar -options <properties_file>

Where <properties file> is the file you edited in step 2.

You should type all commands on a single line.

Installer Properties

The following properties appear in the fusion_client_core_sdk_installer-3.x.x.advanced-

install.properties file. The quick and upgrade install.properties files contain a subset of these
properties.

Property Description

Set to:

●quick for a quick install

●advanced for an advanced install

installation.install.type
●upgrade to upgrade an existing installation

Note: This property is set to the correct value in each

of the properties files, and there is no reason to
change it; work with the appropriate properties file
instead.

accept.eula Set to accept, yes, or true to indicate that you accept

the End User License Agreement. This value is not

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 15

 set in any of the properties files, and must be set by
the user to indicate acceptance.

The directory in which the Fusion Client SDK will be

INSTALL_PATH
installed.

JDKPath The path to your JDK.

packs Which components to install:

● COMMON

Installs the common components. Both the Media

Broker and the Gateway need these, so they must
always be installed.

●GATEWAY

Installs all the components for the Web Gateway. This

includes:

・RUNTIME

・REST

・WEB_ADMIN

・CLI_ADMIN

●GATEWAY.RUNTIME

Deploys the modules of the core runtime functionality

to the Fusion Application Server (FAS). This
enables the core server feature capabilities of
FCSDK.

●GATEWAY.REST

Deploys the administration REST services to the FAS.

This enables administration features of the FCSDK; it

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 16

 can be deployed either to the same FAS instance as
the runtime, or to a separate one.

● GATEWAY.WEB_ADMIN

Deploys the Administration Web UI to the FAS. This

enables administration of the FCSDK from a web
browser. The Web UI uses the Administration REST
Services and can be deployed either to the same FAS
instance as the REST Services runtime, or to a
separate one.

● GATEWAY.CLI_ADMIN

Installs the Administration CLI. This enables

administration of the FCSDK from the command line.
The CLI also uses the Administration REST Services.

●CORE_SDK

Deploys the sample applications to the FAS and

installs the sample source code and core JavaScript
SDK to a local directory.

●CORE_SDK.SAMPLE.RUNTIME

Deploys the sample applications to the FAS.

●CORE_SDK.SAMPLE.SOURCE

Installs the sample source code for the sample

applications to a local directory.

●CORE_SDK.JAVASCRIPT

Installs the core JavaScript SDK to a local directory.

This contains the JavaScript itself and API
documentation.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 17

 ●MEDIABROKER

Installs the services for the Media Broker and

associated scripts to the selected directory; the Media
Broker is not deployed to a FAS instance. See the
Installing the Media Broker section for details.

●SAMPLE_APP

Deploys and configures the sample application.

Should not be used on a production system.

The directory where the Fusion Client SDK

Administration CLI is installed. Only relevant when
cli.dir
installing the GATEWAY.CLI_ADMIN pack, either
explicitly or as part of installing the GATEWAY pack.

Hostname or IP address of the FAS.

appserver.admin.address
Note: This is not set by default and needs to be set by
the user.

Port number of the FAS administrative service . Leave

appserver.admin.port as the default 9999 unless it has been explicitly
changed

appserver.admin.user The administration user name for the FAS.

The administration password for the FAS.

appserver.admin.password
Note: This is not set by default

Leave as the default main-server-group unless you

appserver.servergroup
have changed the server group names on the FAS.

The controlled domain for the FCSDK Gateway. Must

be DNS-resolvable.
gateway.controlled_domain
Note: This is not set by default, and must be set by
the user

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 18

 IP address or host name of the server running the
REST API. If not set, the CLI and Web UI will try to
connect to the REST service on the machine they are
rest.appserver.address
running on. You should set this if you have installed
either of the administration clients on a server
different from the Administrative REST service.

Port number of the REST API machine. The default is

rest.appserver.port
9999.

IP address or host name of the Runtime machine.

client_sdk.runtime.management_ Note: This and the following three properties need to

server.address be set if the Administration REST service is deployed
on a different server to the one that has the Runtime
on it.

client_sdk.runtime.management_ Port number of the Runtime machine. The default is

server.port 9999.

client_sdk.runtime.management_ The administration user name for the FAS. The

server.user default setting is administrator.

client_sdk.runtime.management The administration password for the FAS. The default

_server.password setting is administrator.

Note: Specify the user that should own and run the
application server files and processes, for example,
root.
os.user
Note: This is very important if installing as a non-root
user. See the Installing as a Non-Root User section
and the comments in the advanced properties file.

Specify the user that should administer the system.

See the Installing as a Non-Root User section.

os.admin
Note: This property is commented out in the
properties file, and must be uncommented before you
can set it.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 19

 The .tar.gz file containing the native libraries for the
Media Broker.
rtp_proxy_native.tarball.file
If this is left empty, then the installer searches for the
correct (OS specific) file in the current directory.

Indicates whether to ignore any problems found by

the OS checker. Setting this to yes or true bypasses
the checks . Any other value causes the installation to
fail if the installer finds problems.
oschecks.problems.ignore
Note: If you enable either this or the next setting, and
the installer finds any problems, you may be installing
to an unsupported configuration, or in a way which will
cause problems later.

Indicates whether to ignore any running FCSDK

processes. Setting this to yes or true bypasses the
running.processes.ignore
checks. Any other value causes the installation to fail
if the installer finds problems.

The password for the media broker keystore file

(keystore.jks) created during installation of the Media
rtp_proxy.keystore.password
Broker. If this is empty or missing, the installer creates
a keystore file with the default value, changeit.

In addition, the fusion_client_core_sdk_installer-3.3.9.upgrade-install.properties contains two

properties which are only relevant to an upgrade:

Property Description

gateway.admin.username You should use these if the existing system has an external
authentication system for the REST API. In most cases, these
gateway.admin.password can be ignored.

Multi-box Installations

If you are upgrading FCSDK on a multi-box FAS cluster, you should:

1. Stop all the slave nodes

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 20

 2. Run the unattended installer on the master node

3. Restart all the slave nodes

The master node copies its configuration, including the FCSDK and applications, to the slaves.

Installing the iOS SDK

To install the Fusion Client SDK for iOS, open fusion_client_ios_sdk-3.x.x.tar.gz on your Mac
and extract the contents to an appropriate area of your file system.

Note: If using a self-signed server certificate, please refer to the FCSDK Developer Guide for
instructions on how to correctly install the server and CA root certificates on your iOS or OSX
client.

Installing the Android SDK

To install the Fusion Client SDK for Android:

1. Open fusion_client_android_sdk-3.x.x.zip and extract the contents to a suitable directory.

2. Copy the contents of the libs directory to the libs folder of your project.

3. In the Project view, right click on the fusion-android-sdk.3.x.x.jar file, and select Add As
Library…:

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 21

(This enables you to import the classes into your project.)

4. Copy the contents of the res directory to the res directory of your project

The fusion-android-sdk.3.x.x.jar also contains src, docs, and assets folders - you probably do not
want to copy these to your project: the assets folder is empty, the docs folder contains the
JavaDocs for the SDK classes, and the src folder contains the source code for a sample
application.

For details on how to develop applications using the SDK, see the FCSDK Developer Guide.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 22

Rolling Back an SDK Upgrade

If you wish to roll back the upgrade of SDK applications on Fusion Application Server, follow
the rollback instructions in the FAS Installation Guide.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 23

Installing the Media Broker
Depending on your chosen architecture (see the FCSDK Architecture Guide), you may need to
install a Media Broker on one or more hosts other than the master FAS node. To do this, you will
need to run the installer, choosing only the Media Broker pack, on each of the servers which are
to host a Media Broker. (If you install the FCSDK and Media Broker together, either by choosing
a Quick Install or by choosing both the Fusion Media Broker and the Web Gateway packs, the
installer will install Media Broker to the host that it is running on. If the host that runs the installer
is the same one that runs the FAS, the Media Broker will be deployed to the same host as, but
will run in a separate JVM from, the FAS.)

You should configure DNS for each host running Media Broker, or put suitable entries in relevant
hosts files. Failure to do this can cause problems during call setup, and may result in no media.

Media Broker Pre-requisites

Media Broker may require certain dependencies to be installed, dependent upon the OS in use:

Linux (Red Hat Based)

Media Broker on a Red Hat based Linux OS has dependencies on the following packages:

libxml2

libpng

Please ensure these packages are installed, before attempting to install Media Broker

Installing Media Broker

1. Extract the installation files from fusionweb-installer-3.x.x.zip into a temporary folder on the
virtual machine.

2. Copy the native tarball to the same temporary directory as the extracted installer zip files.
This file will typically be named media-broker-native-….tar.gz

3. Run through unattended installer, ensuring that you only select the Media Broker installation
pack. See the Installing Fusion Client SDK section.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 24

Media Broker Unattended Installer

You can install the Media Broker unattended from the command-line by specifying the required
installation configuration in a properties file. A sample template properties file is bundled with
Fusion Client SDK.

To install just the media broker unattended:

1. Extract the installation files from fusionweb-installer-3.x.x.zip into a temporary folder on the
install machine.

2. Edit the advanced-install.properties file to:

Set accept.eula to true, yes, or accept.

Install only the MEDIABROKER and COMMON packs.

Set INSTALL_PATH, JDKPath, os.user, os.admin, and rtp_proxy_native.tarball.file, if

necessary.

See the Installer Properties section for details.

3. Run the following command (single line):

java -jar fusion\_client\_sdk\_core\_installer-3.x.x.jar -options advanced-

install.properties

Post Installation

Create a Service

If you run the installer as a non-root user, it cannot automatically create the services to start FAS
and the Media Broker. Perform the following steps to manually create the services:

1. Log on to the OS as root

2. Execute the service creation scripts, for example:

/opt/fusion/FAS-<fas-version>/resources/add-service.sh

/opt/fusion/FCSDK-3.x.x/resources/post-install.sh -s

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 25

where <fas-version> is the FAS version number (see the FCSDKRelease Notes for the FAS
version required by this release).

Start and Stop the Media Broker

To start the Media Broker:

service fusion_media_broker start

To stop the Media Broker:

service fusion_media_broker stop

To restart the Media Broker:

service fusion_media_broker restart

Note: If the installer creates the Media Broker service, it automatically starts it.

Rolling Back a Media Broker Upgrade

If you choose a new installation directory, the previous versions of the Media Broker and FCSDK
remain on the disk after an upgrade. To roll back to the previous installation:

1. Stop the Media Broker service

2. Edit the /etc/fcsdk.conf file, and change the RTPPROXY_HOME and FCSDK_HOME
properties to point to the previous installation.

3. Start the Media Broker service.

Log File Rotation

The Media Broker has a native log file (master.console.log) and a number of java log files (e.g.
proxy.log, stun.log, rest.log, etc.). It rotates its log files in order to preserve disk space without
deleting them before they can be examined or backed up. By default, log files rotate when they
reach a specific size, but you can configure the system to rotate at a specific time, such as daily
at midnight.

Native Log File Rotation

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 26

The native log rotation is managed by cron and logrotate, both of which are core unix utilities.
During installation of the Media Broker, it adds a cron job that runs logrotate every 5 minutes:

*/5 * * * * /usr/sbin/logrotate /opt/fusion/FCSDK/fusion_media_broker/logrotate.conf

The logrotate process is configured using the lograte.conf file in the Media Broker installation
directory (e.g. /opt/fusion/FCSDK/fusion_media_broker/logrotate.conf). By default it rotates the
log file if it is bigger than 50 MB in size, and stores the previous 10 log files before deleting older
logs:

/opt/fusion/FCSDK/fusion_media_broker/master.console.log {

copytruncate

size 50M

rotate 10

missingok

The documentation (man page) for logrotate explains how logrotate can be reconfigured. e.g.
size 50M could be replaced with daily.

Native logging level is managed through the GST_DEBUG environment variable, which is
typically set in the gst-env file in the native directory inside the Media Broker installation directory
(e.g. /opt/fusion/FCSDK/fusion_media_broker/native/gst-env).

Java Log File Rotation

You can configure Java logging using a standard log4j.properties file, located in the media broker
install directory. Most Java logging is directed to the DEBUG_LOG appender, which typically logs
to a proxy.log file with MaxFileSize of 20M, storing the 10 previous log files before deleting older
logs. You can configure other Log4j appenders (e.g. rest, stun, and console) similarly.

See the Log4j documentation for what options are available for reconfiguring Java logging, and
how to use them (e.g. the RollingFileAppender could be replaced by a
DailyRollingFileAppender).

Manual Tests

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 27

After installation, it may be helpful to perform some manual tests to test that the Media Broker
works correctly.

You can perform basic testing on the customized version of gstreamer used by Media Broker.
Commands (in this font) should be entered on a single line; the responses are shown like this.

1. Setup your environment to use the customized native libraries, by sourceing the Media
Broker native configuration file, e.g.:

source /opt/fusion/FCSDK/fusion_media_broker/native/setup-env.sh

You should see a message like:

Using installation in /opt/fusion/FCSDK/fusion_media_broker/native

2. Check that the environment is setup correctly:

echo $GST_PLUGIN_PATH

/opt/fusion/FCSDK/fusion_media_broker/native/lib/gstreamer-1.0

echo $LD_LIBRARY_PATH

/opt/fusion/FCSDK/fusion_media_broker/native/lib:/opt/fusion/FCSDK/fusion_media_broker/nativ
e/lib/intel64

3. Execute a simple test to ensure the VP8 parser has been installed correctly:

gst-inspect-1.0 vp8parse

Factory Details:

Rank primary (256)

Long-name VP8 parser

… <output snipped for brevity>

disable-passthrough : Force processing (disables passthrough)

flags: readable, writable

Boolean. Default: false

Ensure there are no errors.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 28

 4. To confirm that x264enc is working correctly, generate a test video file by executing the
following :

gst-launch-1.0 videotestsrc num-buffers=200 ! x264enc ! matroskamux ! filesink

location=”test.mka”

Setting pipeline to PAUSED …

Pipeline is PREROLLING …

Redistribute latency…

Pipeline is PREROLLED …

Setting pipeline to PLAYING …

New clock: GstSystemClock

Got EOS from element “pipeline0”.

Execution ended after 0:00:00.279604859

Setting pipeline to PAUSED …

Setting pipeline to READY …

Setting pipeline to NULL …

Freeing pipeline …

The above command will run for around one second. It will generate a test.mka file in the current
directory, that can then be played with an appropriate player:

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 29

 5. You can now check that both h264dec and vp8enc are working correctly by using the
test.mka file (created in the previous test) as an input:

gst-launch-1.0 filesrc location=”test.mka” ! matroskademux ! avdec_h264 ! vp8enc !

matroskamux ! filesink location=”test2.mka”

Setting pipeline to PAUSED …

Pipeline is PREROLLING …

Redistribute latency…

Redistribute latency…

Pipeline is PREROLLED …

Setting pipeline to PLAYING …

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 30

New clock: GstSystemClock

Got EOS from element “pipeline0”.

Execution ended after 0:00:05.178404941

Setting pipeline to PAUSED …

Setting pipeline to READY …

Setting pipeline to NULL …

Freeing pipeline …

This should generate a test2.mka file in the current directory. Again, as for the file in the previous
step, the file should be playable in a suitable player.

Note: If any of the above tests fail to execute correctly, you can turn on debugging as an aid in
diagnosing the problem. To turn on gstreamer debugging, you will need to set the GST_DEBUG
environment property (or provide gstreamer command debug arguments) accordingly:

GST_DEBUG=*:4 gst-inspect-1.0 vp8parse

0:00:00.000136537 8564 0x12aba00 INFO GST_INIT gst.c:502:init_pre: Initializing GStreamer

Core Library version 1.2.0

0:00:00.000263835 8564 0x12aba00 INFO GST_INIT gst.c:503:init_pre: Using library installed in

/var/lib/jenkins/workspace/fcsdk1.2_native_gstreamer/output/lib

0:00:00.000287884 8564 0x12aba00 INFO GST_INIT gst.c:513:init_pre: Linux kgibbs-media-

broker-test.cba.com 2.6.32-71.el6.x86_64 #1 SMP Fri May 20 03:51:51 BST 2011 x86_64

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 31

LDAP Authentication
You can configure authentication to use either the Local or LDAP mechanisms, or both together.
In the latter case, LDAP is tried first, and if that fails, authentication is attempted using the other
mechanism.

See the following guides for details of how to install and configure LDAP authentication:

FAS Installation Guide

FAS Administration Guide

FCSDK Administration Guide

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 32

Validating your Installation
Once the installation is complete, you have two options for validating the install. If you chose the
Sample Application pack (or ran a Quick install, in which case it’s selected automatically), you
can use the sample application to make a call between two users using a Chrome or Firefox
browser. If you have only installed the Web Gateway, you can install the sample application
independently, and set it up to have two AED users; it tests the installation using AED rather than
a voice and video call.

Option 1

If you chose the Sample Application pack during installation, the sample application is already
deployed and configured with two users. Navigate to https://<fas address>:8443/csdk-sample
(where <fas address> is the host name or IP address of the FAS server running FCSDK) and
use the following credentials:

Username Password

1001 123

1002 123

You should be able to make a call between these two users.

Option 2

If you did not choose the Sample Application pack during installation then you must follow the
following steps:

1. Configure the Web Application ID on the Web Gateway

2. Configure the sample application

3. Deploy the sample application and its configuration to the FAS

4. Test your installation by logging in to the sample application using two AED-only users.

Configuring the Web Application ID on the Web Gateway

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 33

The client application authenticates users by logging in to the Web Application. After
authenticating the user, the Web Application sends a request to the Web Gateway which creates
a session with the capabilities the user should have.

The Web Application ID is a unique text string which it includes in this message; it identifies the
Web Application to the Web Gateway, and confirms that the Web Application is allowed to create
sessions. The Fusion Client SDK Web Administration interface enables you to define the list of
Web Application IDs that the Web Gateway accepts. The same Web Application ID needs to be
configured on both the sample application and the Web Gateway. To add a Web Application ID
for the sample application to the Web Gateway:

1. Log in to the Fusion Client SDK web administration console at:

https://<fas address>:8443/web_plugin_framework/webcontroller/admin

where <fas address> is the IP address or host name of the FAS host on which FCSDK is
running, using the default login credentials:

Username: administrator

Password: administrator

2. Choose the Gateway tab, then the General Administration tab. The web admin console
displays the Gateway Administration page.

3. Click the Add button under Web Application IDs.

The Add Record dialog displays.

4. Enter the Web Application ID in the Key field (it should have at least 16 characters). For
example:

FUSIONCSDK-A8C1D

Click Submit. You should now see the Web Application ID you entered in the list of Web
Application IDs

5. Click Save at the bottom of the page

Note: The Web Application ID can be any text string of 16 characters or greater. The important
thing is that the same value is used both here and when configuring the sample application (see
the Configuring the Sample Application section), and that nothing else should use it.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 34

Configuring the Sample Application

The sample application takes its configuration from an XML file, named csdksample-db.xml,
which you must deploy to the Fusion Application Server. Before deploying the application and
the configuration file, you need to edit csdksample-db.xml to provide the correct configuration,
and to add users to the sample application:

1. Open csdksample-db.xml in a text editor. You can find a template for this file at <install-
dir>/Core_SDK/Sample_Source/csdksample-db-template.xml which you can rename to
csdksample-db.xml.

2. Navigate to the <config> section of the file:

<config>

<!– The webappId is a string of at least 16 characters and is passed to the Gateway to identify
this application instance. The Gateway also needs to contain this ID in its list of configured
application IDs –>

<webappId>FUSIONCSDK-A8C1D</webappId>

<!– The gwUrl is the URL that we connect to the Gateway on to manage sessions for the client.
This needs to have the correct hostname or IP address specified. To make a secure connection
change the scheme to be https and update the port as well. –>

<gwUrl>https://web\_gateway\_address:8443/gateway\</gwUrl>

<!– The externalgwUrl is the external URL that we connect to the Gateway on to manage
sessions for the client. This needs to have the correct hostname or IP address specified. To
make a secure connection change the scheme to be https and update the port as well. –>
<externalGwUrl>https://external\_web\_gateway\_address:8443/gateway\</externalGwUrl>

<!– This is the JSON configuration that is passed to the Client SDK libraries for their stun server
configuration. The following example is a single stun server <stunServers>[{“url”:
“stun:stun.l.google.com:19302”}]</stunServers> –>

<!– No Stun Servers would be configured as follows which is the default example. –>
<stunServers></stunServers>

<!– a list of Stun Servers would be configured as follows <stunServers>[{“url”:

“stun:stun.l.google.com:19302”},{“url”: “stun:otherstunserver:1234”}]</stunServers> –>

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 35

</config>

3. The Web Application ID must match the one configured on the Web Gateway (see the
Configuring the Web Application ID on the Web Gateway section). To set it here, enter the
unique text string, with a minimum of 16 characters, between the <webappID> tags.

4. Enter the URL of the Web Gateway between the <gwUrl> tags. This is the address the
sample Web Application can access the Gateway HTTP interface on to create sessions.

5. Enter the external URL of the Web Gateway between the <externalGwUrl> tags. This is the
address clients can access the Gateway HTTP interface on to create and manage calls.
This URL may well be the same as the <gwUrl> for internal or test systems.

6. If you are using one or more stun servers, enter the URLs between the <stunServers> tags,
in the format [{stun:stunserver_url1:port}, {stun:stunserver_url2:port}].

7. Save the file.

Adding Users

Each user can have access to a different function (for example, AED only, or Voice and Video
only), or a user can have access to a combination of functions. To test your installation using the
process described in the Testing the Installation section, you need to provision two AED users in
csdksample-db.xml. The template file already contains two such users, so there is no need to
edit this file further to test the install. If you need to do so, the rest of this section describes the
format of this file and how to add users to it.

The template csdksample-db.xml file supplied with Fusion Client SDK contains some example
users with different features enabled.

1. Open the csdksample-db.xml file in a text editor and add a new user element for each user
you want to add.

2. The user element can contain the following elements:

Element Required For… Description

User name to use to log into the

name All users
sample Web Application

Password to use to log into the sample

password All users
Web Application

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 36

 Set to true to enable the user to receive
inboundCallingEnabled voice and video
calls

This can be a single destination , for

outboundDestinationPattern voice and video example sip:bob@example.com, or can
be all to allow unrestricted calling.

The user in the SIP From header for

sipUser voice and video
voice and video

The host in the SIP From header for

sipDomain voice and video
voice and video

An optional display name for the SIP

sipDisplayName
user.

authUser voice and video User name for SIP authentication

Realm for SIP authentication, often the

authRealm voice and video
same as sipDomain

authPass voice and video Password for SIP authentication

Maximum size of message the user can

aedMaxMessageAndUpload AED
send, and of an individual data upload.

Total amount of data the user can have

aedMaxData AED
stored at any time.

Java regular expression for session IDs

aedSessionIdRegex AED whose sessions the user is allowed to
access.

Hex string containing data to be sent in

the SIP User-to-User header. This is
uuiData
useful only for voice and video, but is
not mandatory.

Add those elements needed for each user.

3. Save the updated file

Deploying the Sample Application

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 37

After configuring the sample application, you need to deploy it and its configuration file to the
Fusion Application Server in order to be able to log in and validate your installation.

Along with csdksample-db.xml, there is a war file called csdk-sample.war in

Core_SDK/Sample_Source; deploy both of these files to the Fusion Application Server:

1. Open a web browser and navigate to the FAS Management Console at:

https://<fas address>:9990

Where <fas address> is the IP address or host name of the FAS where FCSDK is installed.

2. When prompted for login information, enter the administrator login details. The default
details are:

Username: administrator

Password: administrator

The Management Console displays.

3. Click Manage Deployments, the Content Repository page displays.

4. To deploy csdk-sample.war, click Add. The Upload dialog displays.

5. Click Browse and navigate to the /Core_SDK/Sample_Source in the Fusion Client SDK
installation directory. Select csdk-sample.war and click Next.

6. To confirm your selection, click Save on the Verify Deployment Names dialog. The
Available Deployment Content list on the Content Repository page now shows csdk-
sample.war.

7. Repeat steps 4-6, selecting csdksample-db.xml.

The Available Deployment Content list on the Content Repository page now shows csdksample-
db.xml.

8. In the Available Deployment Content list, select csdk-sample.war and click Assign. The
Select Server Groups dialog displays.

9. Select main-server-group and ensure that Enable csdk-sample.war is selected. Click

Save.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 38

In the Available Deployment Content list, the entry in the Assignments column for csdk-
sample.war should now read 1.

10. Repeat steps 8 and 9 for csdksample-db.xml.

In the Available Deployment Content list, the entry in the Assignments column for csdksample-
db.xml should now read 1.

Testing the Installation

To validate that the installation has been successful, you need two AED users in the csdksample-
db.xml file. Use the user names and passwords from that file to log into the sample application at
https://<fas address>:8443/csdk-sample/. If you used the template file provided by CBA then the
credentials are as follows:

Username Password

aed 123

aed2 123

1. Once you have logged into two separate browser windows using the two sets of credentials
above, you will see in each browser a screen similar to that below:

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 39

 2. Click on the AED demo button and the AED Demo page should open:

3. Type a message in the type message here text box, then click Send. The message will
appear in the message window of both users. You can also experiment with moving the
sliders in the left hand pane, which will be replicated to the other user.

If the web page does not display, contact your web administrator to verify that the proxy or
firewall does not block HTTP traffic on port 8443.

To log in as a voice and video user requires further configuration of the network.

See the FCSDK Administration Guide for details of the required configuration.

To use the sample application on Chrome for Android, you must first enable WebRTC on the
browser:

1. Open Chrome for Android, and type the following address into the address field:

chrome://flags

2. Scroll down the page until you find Enable WebRTC, and click Enable for this setting.

This setting takes effect the next time you launch Chrome for Android; click Relaunch Now for
the change to take effect.

© 2023 CBA | All Rights Reserved | Unauthorized use prohibited. Page 40