Below are prerequisites and instructions for installing IM-SSF, with details for entering licenses and activation, and details for the SIS and CDR resource adaptor entities.

Before you install …​

Before installing the IM-SSF, make sure you have:

  • CDR RA — The IM-SSF uses the OpenCloud CDR RA to write a Call Detail Record per trigger. You must download and install the CDR pack, if you do not already have it, before you install the IM-SSF module. To install, uncompress the install archive in your <rhino-home>.

Note The IM-SSF requires CDR RA v 2.2.0.
  • SIS for IN (supporting INAP and CAP) — The IM-SSF supports INAP and CAP. Before it can be installed, you need to create a SIS instance that supports these protocols. (What you use depends on the SIS features you use and have licenses for.) The IM-SSF install only needs the name of the SIS IN instance it should bind to.

Installing …​

To install IM-SSF:


Unzip the module archive from <sis-home> (after you have installed your SIS!)

$ cd sis/
$ unzip
OpenCloud SIS Module IM-SSF
  inflating: admin/lib/extensions/imssf-client-
  inflating: admin/remove-imssf-1.4.0.script
   creating: modules/imssf/
   creating: modules/imssf/1.4.0/
   creating: modules/imssf/1.4.0/install/
   creating: modules/imssf/1.4.0/install/etc/
   creating: modules/imssf/1.4.0/install/lib/
   creating: modules/imssf/1.4.0/install/units/
  inflating: modules/imssf/1.4.0/install/etc/
  inflating: modules/imssf/1.4.0/install/install-module.bat
  inflating: modules/imssf/1.4.0/install/lib/imssf-installer_1.4.0.0.jar
  inflating: modules/imssf/1.4.0/install/units/imssf-cfg-profile-
  inflating: modules/imssf/1.4.0/install/units/imssf-cs1-charging-parser-
  inflating: modules/imssf/1.4.0/install/units/imssf-csi-profile-
  inflating: modules/imssf/1.4.0/install/units/imssf-idp-builder-profile-
  inflating: modules/imssf/1.4.0/install/units/imssf-mng-ra-
  inflating: modules/imssf/1.4.0/install/units/imssf-translator-service-
  inflating: modules/imssf/1.4.0/install/units/imssf-ui-profile-
  inflating: modules/imssf/1.4.0/install/


Change into the module install directory (modules/imssf/1.4.0/install)

$ cd modules/imssf/1.4.0/install



$ ./
IM-SSF (version=1.4, release=00, build=20130129095952, revision=62832)
IM-SSF settings

IM-SSF license file to install
The IM-SSF 'right-to-use' license file.  A license may already be installed,
or you can install a license at a later point in time.  If no license is
present during install, however, the IM-SSF will need to be activated via the

IM-SSF license file to install []:
Tip In general, you can accept the default answers during installation (press RETURN). See also details for entering licenses and activation, and information for the IN and CDR resource adaptor entities.

Licenses and activation

The very first question during the IM-SSF installation asks you for a license file. If you have one, enter the path to it. If you don’t have a license file, or if you already have a valid license installed (perhaps as a part of your SIS license), then provide an empty response.

The installer will try to activate the IM-SSF at the end of the install process if it can. If it cannot, then it will print a message giving you some guidance.

Tip You can always install a license after the install process, and manually activate IM-SSF using the sis-console, with the activate-imssf command.

SIS instance

Below is an example of an IM-SSF installer question (and response) about the SIS IN instance. In the example, the SIS deployment being installed has been configured to support SIP and IN (entity name is sis-in). The SIS IN instance will be used for the outgoing connection to the external INAP and CAP-based SCPs.

SIS-IN instance
The SIS-IN instance the IM-SSF should use to connect to INAP and CAP SCPs

SIS-IN instance: sis-in
Finding SIS instances

If you cannot recall the names of the SIS instances in your install, use the listraentities command from the sis-console. In this install there are two SIS instances (resource adaptor entities): sis-in and sis-sip:

$ cd sis/
$ ./sis-console
Interactive Rhino Management Shell
Rhino management console, enter 'help' for a list of commands
[Rhino@localhost (#0)] listraentities

CDR resource adaptor entity

The IM-SSF will create its own CDR resource adaptor entity from the CDR RA that comes with the Rhino install the SIS is installed with. By default, this resource adaptor entity is configured using properties appropriate for functional testing (it writes one CDR file per session).

IMSSF CDR RA properties
CDR properties for the IMSSF CDRs.  The default properties are suitable for
functional testing.  Please refer to the OpenCloud CDR RA documentation for
configuration options

IMSSF CDR RA properties [MaxLines=1,Directory=cdr,FilenamePattern=imssf-cdr_%n_%t.log]:
Tip Please refer to the CDR RA documentation for configuration options you wish to use in a production setting.
Previous page Next page