1. Select SIS package

The SIS-IN and SIS-SIP packages are completely independent from each other. SIS-IN does not depend on any SIP components and SIS-SIP does not depend on any CGIN components. Both SIS-IN and SIS-SIP may be installed side-by-side in Rhino for those requiring SIS services for both IN and SIP.

2. Install and start Rhino

Rhino (or the Rhino SDK) must be installed and running before anything else can be installed.

Note

The deployable units for both SIS and CGIN include a large number of generated classes. The default MetaspaceSize is 768m in Rhino which is highly above the peak Metaspace usage under load. It is not expected to get seemingly random JVM hangs caused by garbage collection thrashing, out of memory errors, or other related problems that can be attributed to the JVM having to load this quantity of classes.

If it does,

  • For Rhino, you need to edit the read-config-variables file in the ${RHINO_HOME}/etc/defaults directory and each ${RHINO_HOME}/node-XXX directory.

  • For the Rhino SDK, you need to edit the ${RHINO_HOME}/config/jvm_args file.

In each file, search for -XX:MaxMetaspaceSize and -XX:MetaspaceSize and set the value of this option to bigger value than 768m. Rhino (or the Rhino SDK) needs be to restarted for this change to take effect.

3. Install the CGIN Connectivity Pack for SIS-IN only

The SIS-IN 3.1.0 depends on the CGIN Connectivity Pack 3.0.0 — you must download and install it before using the SIS-IN package.

Warning

See the SIS Compatibility Guide for further information on using CGIN with the SIS.

Note that the 'trial' version of the SIS can only be used in conjunction with the 'trial' version of the CGIN Connectivity Pack. Similarly, the 'full' version of the SIS can only be used in conjunction with the 'full' version of the CGIN Connectivity Pack.

Typically, the CGIN Connectivity Pack will be extracted directly into the Rhino (or Rhino SDK) directory:

$ cd RhinoSDK
$ unzip ~/downloads/cgin-connectivity-full-3.0.0.0.zip
Archive:  ~/downloads/cgin-connectivity-full-3.0.0.0.zip
  creating: cgin-connectivity-full-3.0.0.0/
  creating: cgin-connectivity-full-3.0.0.0/du/
  creating: cgin-connectivity-full-3.0.0.0/examples/
  creating: cgin-connectivity-full-3.0.0.0/examples/META-INF/
  creating: cgin-connectivity-full-3.0.0.0/examples/src/
  ...
Tip The fourth digit of the CGIN Connectivity Pack version indicates the patch release version and may be different from the example shown above.

4. Unpack the SIS

Typically, the SIS should be extracted directly into the Rhino (or Rhino SDK) directory:

$ cd RhinoSDK
$ unzip ~/downloads/sis-in-full-3.0.0.0.zip
Archive:  ~/downloads/sis-in-full-3.0.0.0.zip
    creating: sis/
    creating: sis/in/3.0.0.0/
    creating: sis/in/3.0.0.0/admin/
    creating: sis/in/3.0.0.0/admin/common/
    creating: sis/in/3.0.0.0/admin/etc/
    creating: sis/in/3.0.0.0/admin/lib/
    creating: sis/in/3.0.0.0/admin/lib/extensions/
    ...
$ unzip ~/downloads/sis-easysip-full-3.0.0.0.zip
Archive:  ~/downloads/sis-easysip-full-3.0.0.0.zip
    creating: sis/
    creating: sis/sip/3.0.0.0/
    creating: sis/sip/3.0.0.0/admin/
    creating: sis/sip/3.0.0.0/admin/common/
    creating: sis/sip/3.0.0.0/admin/etc/
    creating: sis/sip/3.0.0.0/admin/lib/
    creating: sis/sip/3.0.0.0/admin/lib/extensions/
    ...
Tip The fourth digit of the SIS package version indicates the patch release version and may be different from the example shown above.

5. Configure the SIS

Initial SIS configuration may require modification of the following files:

Directory File What it should contain
 sis/<protocol>/{product-version}._x_/admin/etc
client.ant.properties

and

client.shell.properties

or in Windows:

client.windows.properties.bat

These files each define a property which specifies the path to the client directory of the Rhino (or Rhino SDK) install, as either an absolute or relative path. If relative, must be relative to the sis/<protocol>/3.1.0.x directory.

If the SIS was extracted into the top-level directory of the Rhino installation, as described in step 4 above, then this file will not need to be modified.

5.1 SIS-IN only

Directory File What it should contain
 sis/in/{product-version}._x_
 cgin-connectivity.properties

This file defines a property which specifies the path to the CGIN Connectivity Pack for the SIS, as either an absolute or relative path. If relative, must be relative to the sis/in/3.1.0.x directory.

The default value for the path is a relative path to the expected CGIN Connectivity Pack, extracted in the Rhino (or Rhino SDK) directory. For example, the full version of the standard SIS install has a default path value of ../../../cgin-connectivity-full-3.0.0.x. Note that the path separator character / used in this file will automatically be converted to the local platform path separator when this file is used by the SIS.

If both the CGIN Connectivity Pack and the SIS have been extracted into the same Rhino (or Rhino SDK) directory, then this configuration file only needs to be modified to append the fourth digit of the specific CGIN Connectivity Pack patch release being used. Otherwise, the entire path will need to be modified as necessary.

6. Install the SIS

6.1. SIS-IN

To install the SIS-IN into Rhino, run sis/in/3.1.0.x/admin/install-sis (or install-sis.bat in Windows).

The SIS installation prompts for the following parameters:

Parameter Description
 IN Config Profile Table

Name of the profile table to create, to store SIS IN configurations.
Defaults to sis-configs-in

 Rhino SIS license

File path to the Rhino license file to use with the SIS (if you have one).

The installer, after confirming values for each parameter, installs the required deployable units from the CGIN Connectivity Pack and the SIS, creates the SIS configuration profile tables, and installs the license file (if specified).

6.2. SIS-SIP

To install the SIS-SIP into Rhino, run sis/sip/3.1.0.x/admin/install-sis (or install-sis.bat in Windows).

The SIS installation prompts for the following parameters:

Parameter Description
 SIP Config Profile Table

Name of the profile table to create, to store SIS SIP configurations.
Defaults to sis-configs-sip

 Rhino SIS license

File path to the Rhino license file to use with the SIS (if you have one).

The installer, after confirming values for each parameter, installs the required deployable units, creates the SIS configuration profile tables, and installs the license file (if specified).

Example installation of SIS-IN

Below is an example of a SIS installation.

$ cd sis/in/3.0.0.0/admin
$ ./install-sis
SIS-IN Installer
================

General
=======
General settings

IN Config Profile Table
-----------------------
The name of the profile table used to store basic SIS instance configuration
information for IN.

IN Config Profile Table [sis-configs-in]:

Rhino SIS license
-----------------
A license may already be installed, or you may choose to install a license at
a later point in time.  If you do not want to install a license at this time
provide an empty response.  If no license is present at the time a SIS
instance is created, however, the SIS instance will need to be activated
manually via the console.

Rhino SIS license []:


*** Confirm settings ***

IN Config Profile Table:  sis-configs-in
Rhino SIS license:

Are these settings correct (y/n)? y

Using client base directory: .../client
Installing cgin-connectivity-full-3.0.0.0/du/oc-common-3.0.0.du.jar as file:cgin/oc-common-3.0.0.du.jar...
Installing cgin-connectivity-full-3.0.0.0/du/cgin-common-3.0.0.0.du.jar as file:cgin/cgin-common-3.0.0.0.du.jar...
Installing cgin-connectivity-full-3.0.0.0/du/in-datatypes-5.3.0.0.0.du.jar as file:cgin/in-datatypes-5.3.0.0.0.du.jar...
Installing cgin-connectivity-full-3.0.0.0/du/callcontrol-3.0.0.0.du.jar as file:cgin/callcontrol-3.0.0.0.du.jar...
Installing cgin-connectivity-full-3.0.0.0/du/map-3.0.0.0.du.jar as file:cgin/map-3.0.0.0.du.jar...
Installing cgin-connectivity-full-3.0.0.0/du/cap_v1-3.0.0.0.du.jar as file:cgin/cap_v1-3.0.0.0.du.jar...
Installing cgin-connectivity-full-3.0.0.0/du/cap_v2-3.0.0.0.du.jar as file:cgin/cap_v2-3.0.0.0.du.jar...
Installing cgin-connectivity-full-3.0.0.0/du/cap_v3-3.0.0.0.du.jar as file:cgin/cap_v3-3.0.0.0.du.jar...
Installing cgin-connectivity-full-3.0.0.0/du/cap_v4-3.0.0.0.du.jar as file:cgin/cap_v4-3.0.0.0.du.jar...
Installing cgin-connectivity-full-3.0.0.0/du/etsi_inap_cs1-3.0.0.0.du.jar as file:cgin/etsi_inap_cs1-3.0.0.0.du.jar...
Installing sis/in/3.0.0.0/du/jsip-library-1.2.du.jar as file:sip/jsip-library-1.2.du.jar...
Installing sis/in/3.0.0.0/du/sis-common-3.0.0.0.du.jar as file:sis/sis-common-3.0.0.0.du.jar...
Installing sis/in/3.0.0.0/du/sis-scs-ratype-3.0.0.0.du.jar as file:sis/sis-scs-ratype-3.0.0.0.du.jar...
Installing sis/in/3.0.0.0/du/sis-interceptors-ratype-3.0.0.0.du.jar as file:sis/sis-interceptors-ratype-3.0.0.0.du.jar...
Installing sis/in/3.0.0.0/du/sis-cap-ratype-3.0.0.0.du.jar as file:sis/sis-cap-ratype-3.0.0.0.du.jar...
Installing sis/in/3.0.0.0/du/cgin-message-utils-common-1.1.0.0.du.jar as file:sis/cgin-message-utils-common-1.1.0.0.du.jar...
Installing sis/in/3.0.0.0/du/cgin-message-utils-voice-ratype-3.0.0.0.du.jar as file:sis/cgin-message-utils-voice-ratype-3.0.0.0.du.jar...
Installing sis/in/3.0.0.0/du/cgin-message-utils-sms-ratype-3.0.0.0.du.jar as file:sis/cgin-message-utils-sms-ratype-3.0.0.0.du.jar...
Installing sis/in/3.0.0.0/du/sis-in-base-full-3.0.0.0.du.jar as file:sis/sis-in-base-full-3.0.0.0.du.jar...
Installing sis/in/3.0.0.0/du/sis-cgin-unified-ra-full-3.0.0.0.du.jar as file:sis/sis-cgin-unified-ra-full-3.0.0.0.du.jar...
Installing sis/in/3.0.0.0/du/easysip-ratype-1.2.0.du.jar as file:sip/easysip-ratype-1.2.0.du.jar...
Installing sis/in/3.0.0.0/du/sis-sip-base-full-3.0.0.0.du.jar as file:sis/sis-sip-base-full-3.0.0.0.du.jar...
Installing sis/in/3.0.0.0/du/sis-easysip-full-3.0.0.0.du.jar as file:sis/sis-easysip-full-3.0.0.0.du.jar...
Creating profile table sis-configs-in using ProfileSpecificationID[name=SIS-IN Configuration Profile,vendor=OpenCloud,version=3.0]...
Creating profile table sis-configs-sip using ProfileSpecificationID[name=SIS-SIP Configuration Profile,vendor=OpenCloud,version=3.0]...
Installation successfulInstallation successful

Next Steps:
- Create a SIS instance using create-sis-in-instance
- Use sis-console or Ant to install triggers and compositions into the SIS.
- Visit https://docs.rhino.metaswitch.com/ocdoc/go/product/sis-documentation for further documentation.
Previous page Next page
SIS Version 3.1.0