A SIS module is an optional feature that you can add to your SIS installation. It comes as a zip archive that you extract over the top of the SIS installation directory.

Note
Modules available with this SIS release
  • IM-SSF Module (SIP to IN Protocol Translation)

  • R-IM-SSF Module (IN to SIP Protocol Translation)

What is in a SIS module?

A SIS module typically includes:

  • a command-line extension library, which adds management commands to sis-console

  • an install directory, which contains deployable units, configuration files and an installer application.

Module directory structure

SIS module zip archives must be extracted from the SIS home. Each zip archive has the following structure:

File or directory Description
 admin/remove-<module-name>-<module-version>.script

a script to run from the command-line console that will remove the module

 admin/lib/extensions/

command-line console extension library

 modules/<module-name>/<module-version>/install/

the install directory

 modules/<module-name>/<module-version>/install/CHANGELOG

the change log

 modules/<module-name>/<module-version>/install/install-module.sh

a shell script that runs the installer application

 modules/<module-name>/<module-version>/install/units

all the deployable units

plus any other files and directories that the module install requires

Installing a module

To install a SIS module:

  1. Install the SIS if it hasn’t already been installed.

  2. Unzip the module archive from the SIS home (<rhino-home>/sis/<protocol>/<sis-version>/).

  3. Change into the module install directory (<rhino-home>/sis/<protocol>/<sis-version>/modules/<module-name>/<module-version>/install).

  4. Run module-install.sh (and answer the install questions).

Warning

The module install process also:

  • may include an option to install a license, unless that module’s functions are already covered by the overall SIS license.

  • tries to activate the module, after checking that the required functions are licensed.

Previous page Next page
SIS Version 3.2