SIS REM Module User Guide

This document provides instructions for using the SIS REM Module to manage a SIS with the Rhino Element Manager.

Topics

This document includes the following topics:

About the SIS REM Module — what the SIS REM Module is and how to install it
Selecting a SIS instance — getting started with the SIS REM Module, and selecting a SIS instance to manage
Managing Components — using the SIS REM Module to manage macros, compositions, triggers, service references, external platforms, extension references, network interfaces, and network routes
Managing Subscriptions — using the SIS REM Module to manage address subscriptions and service key subscriptions
Managing Configuration — using the SIS REM Module to manage SIS configuration settings common to all components, and trigger address tracing.

Audience

This document is for system administrators, developers, and operators interested in using a web-based GUI to monitor, configure, or manage instances of a Service Interaction SLEE (SIS).

This document assumes a basic knowledge of core concepts about SIS, JAIN SLEE, and Java Management Extensions (JMX).

Scope

This document covers installing, running, configuring, and using the SIS REM Module with the Rhino Element Manager.

This document does not focus on…

the SIS generally — see the SIS Overview and Concepts
commands and operations, with links to javadocs, for administering the SIS — see the SIS Administration Guide
the Rhino Element Manager generally — see the Rhino Element Manager (REM) User Guide.

About the SIS REM Module

The SIS REM Module lets you use the Rhino Element Manager to manage a SIS.

Installing SIS REM Module

To install SIS REM Module, please see Installing REM Plugins in the REM user guide.

Once installed, SIS REM module adds a SIS option to the Management menu in the Rhino Management area of REM.

Running SIS REM Module

To run the SIS REM module:

Select SIS from the Management menu.
Select a SIS instance in REM
Select procedures to manage components, subscriptions, or configuration.

Selecting a SIS Instance

To select a SIS in REM (with the SIS REM module), from the REM dashboard:

1

From the menu bar at the top of the REM dashboard, select Management ▶ SIS.

A list of running SIS Instances displays.

2

Click to select a SIS instance.

Links display to manage the selected instance.

3

To select different instance to manage:

Click SIS Instance List.

The list of SIS Instances redisplays (see above).
Click to select another instance.

Links display to manage that instance (see above).

4

To reload the selected instance:

Click Reload.

REM SIS Module reloads that instance.

Changes to SIS components, such as installing, uninstalling or activating components, do not take effect immediately. The SIS must explicitly reload its components to apply any changes.

If the SIS instance is ACTIVE, some changes to configuration properties won’t take effect until you deactivate and reactivate the SIS instance.

Managing Components

You can use the SIS REM Module to manage these components in a SIS instance:

macros
compositions
triggers
service references
external platforms
extension references
network interfaces
network routes

Macros (SIS REM)

You can use the SIS REM module to view, remove, install, or replace macros.

What are SIS macros?

A macro is an expression that can be reused multiple times in other SIS macros, triggers, and compositions.

For details, see Managing Macros in the SIS Administration Guide.

To manage macros:

1

From the SIS instance page, select Macros.

A list of Macros installed for the selected instance displays.

2

To…

Do this:

View a macro

Click it.
That macro’s dependencies, dependents, and XML display.

To display a dependent or dependency, click it.
To expand the XML window, click (show full).

Remove the selected macro

Click Remove.
SIS REM module prompts you to confirm removing.
Click OK.
SIS REM module removes the macro from the selected SIS instance.

You can’t remove a macro that has dependents.

Install a new macro

Click Install.
A Choose File button displays.
Click the Choose File button.
An Open dialog box displays.

Navigate to and select the XML file for the macro you want to install.

The XML file must adhere to the SIS Macro XML schema defined for the SIS version.

The SIS REM module installs the macro. If that SIS instance already has a macro with the same identity, the SIS REM module asks whether you want to replace the existing XML.

Changes to SIS macros do not take effect immediately. The SIS must explicitly reload its components to apply any changes.

Compositions (SIS REM)

You can use the SIS REM module to view, configure, remove, install, or replace compositions.

What are SIS compositions?

A composition describes the services to be invoked for a particular call and the order the services should be invoked.

For details, see Managing Compositions in the SIS Administration Guide.

To manage compositions:

1

From the SIS instance page, select Compositions.

A list of Compositions installed in the selected instance displays.

2

To…

Do this:

View a composition

Click it.
That composition’s details display (see Configurable Options in the SIS Administration Guide).

composition

To display a dependent or dependency, click it.
To expand the XML window, click (show full).

Remove the selected composition

Click Remove.
SIS REM module prompts you to confirm removing.
Click OK.
SIS REM module removes the composition from the selected SIS instance.

You can’t remove a composition that has dependents.

Configure the selected composition

Click Edit.
An Edit Composition dialog box displays.
image::managing-components/editComposition.png[]
Make any changes to the composition details, and click Save.
SIS REM module saves your changes.

Install a new composition

Click Install.
A Choose File button displays.
Click the Choose File button.
An Open dialog box displays.

Navigate to and select the XML file for the composition you want to install.

The XML file must adhere to the SIS Composition XML schema defined for the SIS version.

The SIS REM module installs the composition. If that SIS instance already has a composition with the same identity, the SIS REM module asks whether you want to replace the existing XML.

Changes to SIS compositions do not take effect immediately. The SIS must explicitly reload its components to apply any changes.

Triggers (SIS REM)

You can use the SIS REM module to view, remove, activate, deactivate, install, or replace triggers.

What are SIS triggers?

A trigger is used to select a composition for execution for each call received by the SIS.

For details, see Managing Triggers in the SIS Administration Guide.

To manage triggers:

1

From the SIS instance page, select Triggers.

A list of Triggers installed for the selected instance displays.

2

To…

Do this:

View a trigger

Click it.
That trigger’s dependencies and XML display.

To display a dependency, click it.
To expand the XML window, click (show full).

Remove the selected trigger

Click Remove.
SIS REM module prompts you to confirm removing.
Click OK.
SIS REM module removes the trigger from the selected SIS instance.

You can’t remove a trigger when it’s active.

Activate or deactivate a trigger

Click activate or deactivate .
The SIS REM module changes the state of that trigger.

Install a new trigger

Click Install.
A Choose File button displays.
Click the Choose File button.
An Open dialog box displays.

Navigate to and select the XML file for the trigger you want to install.

The XML file must adhere to the SIS Trigger XML schema defined for the SIS version.

The SIS REM module installs the trigger. If that SIS instance already has a trigger with the same identity, the SIS REM module asks whether you want to replace the existing XML.

Changes to SIS triggers do not take effect immediately. The SIS must explicitly reload its components to apply any changes.

Service References (SIS REM)

You can use the SIS REM module to view, remove, configure, or create service references.

What are SIS service references?

A service reference identifies a service that can be invoked from a composition. Services may be either:

local — JAIN SLEE services deployed in the same Rhino instance; identified to the SIS by their SLEE service-component identifiers
external — services running on other network nodes; represented in the SIS by an external platform definition.

For details, see Managing Service References in the SIS Administration Guide.

To manage service references:

1

From the SIS instance page, select Service Refs.

A list of Service Refs installed for the selected instance displays.

2

To…

Do this:

View a service reference

Click it.
That service reference’s details display.

To display a dependant or dependency, click it.

Remove the selected service reference

Click Remove.
SIS REM module prompts you to confirm removing.
Click OK.
SIS REM module removes the service reference from the selected SIS instance.

You can’t remove a service reference that has dependants.

Configure a service reference

Click Edit.
An Edit Service Ref dialog box displays.
Change the Default Timeout or Static Charging Priority, and click Save.
The SIS REM module saves your changes.

Create a new service reference

Click Create.
Service reference creation entry fields display.
Specify whether it’s local or external.
Enter a name for it.
Select an existing service or external platform.
Click Add.
The SIS REM module adds the service reference. If that SIS instance already has a service reference with the same identity, the SIS REM module asks whether you want to replace it.

Changes to SIS service references do not take effect immediately. The SIS must explicitly reload its components to apply any changes.

External Platforms (SIS REM)

You can use the SIS REM module to view, remove, configure, activate, deactivate, repair, or create external platforms.

What are SIS external platforms?

An external platform definition describes the properties of an external service usable in a SIS composition. It includes:

a name, used as a unique identifier for the external platform definition
zero or more IN SCCP addresses, providing the network address of IN nodes where the service can be found
zero or more SIP URI addresses, providing the network address of IP nodes where the service can be found
an address selection mode (round-robin, load-share, or active-standby), which indicates how multiple addresses should be used by the SIS.

For details, see Managing External Platforms in the SIS Administration Guide.

To manage external platforms:

1

From the SIS instance page, select External Platforms.

A list of External Platforms installed for the selected instance displays.

2

To…

Do this:

View an external platform

Click it.
That external platform’s details display.
To display a dependent, click it.

Remove the external platform

Click Remove.
SIS REM module prompts you to confirm removing.
Click OK.
SIS REM module removes the external platform from the selected SIS instance.

You can’t remove a external platform that has dependents.

Configure the selected external platform

Click Edit.
An Edit External Platform dialog box displays.
Change the configuration, and click Save.
The SIS REM module saves your changes.

Add an address for the selected external platform

Click Add Address.
An Add External Address dialog box displays.
Enter the Position and Address, and click Add.
The SIS REM module adds the address.

Activate or deactivate an address

Click activate or deactivate .
The SIS REM module changes the state of that address.

Manually repair a failed address

Click Repair.
The SIS REM module clears any alarms that the SIS raised when the address failed.

Remove an inactive address

Click Remove
SIS REM module prompts you to confirm removing.
Click OK.
SIS REM module removes the address from the selected external platform.

You can’t remove an external platform address when it’s active.

Create a new external platform

Click Create.
External platform creation entry fields display.
Enter a name for it.
Select a external address selection mode.
Click Add.

The SIS REM module adds the external platform, and makes it available for service references.

Changes to SIS external platforms do not take effect immediately. The SIS must explicitly reload its components to apply any changes.

Extension References (SIS REM)

You can use the SIS REM module to view, remove, configure, or create extension references.

What are SIS extension references?

An extension reference identifies an extension component. There are two types of extension component supported by the SIS:

service composition selection extension component, used during the triggering phase
interceptor extension component, used in composition interceptors.

SIS extension components are implemented as JAIN SLEE services, and an extension reference identifies an extension component using its SLEE service component identifier.

For details, see Managing Extension References in the SIS Administration Guide.

To manage extension references:

1

From the SIS instance page, select Extension Refs.

A list of Extension Refs installed in the selected instance displays.

2

To…

Do this:

View the details of an extension reference

Click it.
That extension reference’s details display.
To display a dependent or service ID, click it.

Remove the selected extension reference

Click Remove.
SIS REM module prompts you to confirm removing.
Click OK.
SIS REM module removes the extension reference from the selected SIS instance.

You can’t remove an extension reference that has dependents.

Configure the selected extension reference

Click Edit.
An Edit ExtensionRef dialog box displays.
Change the extension reference’s Service and/or Default Timeout, and click Save.
SIS REM module saves your changes.

Create a new extension reference

Click Create.
Extension reference entry fields display.
Enter a name for it.
Select a type (interceptor or SCS).
Select a service.
Click Add.
The SIS REM module adds the extension reference.

Changes to SIS extension references do not take effect immediately. The SIS must explicitly reload its components to apply any changes.

Network Interfaces (SIS REM)

You can use the SIS REM module to view, enable and disable, create, edit, and remove network interfaces.

What are network interfaces?

A network interface definition describes the properties of a network connection point. It includes:

a name, used as a unique identifier for the network interface
a type, either IN or SIP
zero or more configuration properties
the current state of the network interface, either ENABLED or DISABLED.

For details, see Managing Network Interfaces in the SIS Administration Guide.

To manage network interfaces:

1

From the SIS instance page, select Network Interfaces.

A list of Network Interfaces in the selected instance displays.

2

To…

Do this:

View the details of a network interface

Click it.

That network interface’s details display.

Edit the selected network interface definition

Click Edit.
An Edit Network Interface dialog box displays.
Change network interface details, and click Save.
SIS REM module saves your changes.

Activate or deactivate a network interface

Click activate or deactivate
SIS REM module changes the state of that network interface.

Remove a network interface

If it’s active, deactivate it (see above).
Click Remove.
SIS REM module removes the network interface definition.

Create a new network interface

Click Create.
Network interface entry fields display.
Enter the network interface details.
Click Add.
The SIS REM module adds the network interface.

Changes to SIS network interface components do not take effect immediately. The SIS must explicitly reload its components to apply any changes.
Network interfaces do not support active reconfiguration. On reload, if the SIS instance is active, an alarm will be raised to indicate that it must be deactivated and reactivated before the changes will take effect.

Network Routes (SIS REM)

You can use the SIS REM module to create, edit, and remove network routes.

What are network routes?

A network route identifies when a particular network interface will be used when an outbound network dialog is created. It includes:

a rule, used to determine when the network route is selected
the name of the network interface selected if the rule is satisfied
an ordered position within the routing table.

The SIS evaluates network route rules in position order, starting from position 0, until a rule matches.

For details, see Managing Network Routes in the SIS Administration Guide.

To manage network routes:

1

From the SIS instance page, select Network Routes.

A list of Network Routes in the selected instance displays.

Click to view the details of a route’s network interface.

2

To… Do this:

Edit a network route

Click to highlight it.
Click Edit.
An Edit Network Route dialog box displays.
Change the configuration, and click Save.

SIS REM module saves your changes.

When a network route’s position changes, SIS repositions it in the list, shifting any other network routes accordingly.

Remove a network route:

Click to highlight it.
Click Remove.
SIS REM module removes that network route.

Create a default network route

Click Create.
Network route entry fields display.
Check the Default Route box
Select the Network Interface to use as default.
Click Add.
The SIS REM module inserts the default network route into the list.

At most one default route may be configured in a single SIS instance.

Create a new network route

Click Create.
Network route entry fields display.
Enter the network route details.
- For SIP, the rule type selected may be ip, domain, regex, all, or none.
  If the rule type is ip, domain, or regex, a value must be entered for the rule.
- For IN, the rule type selected may be protocol, orig-address, or dest-address.
  A value must always be entered.
  
  IN also allows multiple rules:
  - To add a rule, click Add Rule.
    A new Rule field displays.
    
    Enter rule details.
  - To remove a rule, click Remove.
Click Add.
The SIS REM module inserts the network route into the list at the specified position, and increments the position of the network route currently at that position (if any) and any subsequent network routes.

Changes to SIS network interface components do not take effect immediately. The SIS must explicitly reload its components to apply any changes.
Network interfaces do not support active reconfiguration. On reload, if the SIS instance is active, an alarm will be raised to indicate that it must be deactivated and reactivated before the changes will take effect.

Managing Subscriptions

You can use SIS REM Module to manage:

address subscriptions
service key subscriptions

Address Subscriptions (SIS REM)

You can use the SIS REM module to find, edit, remove, and install address subscriptions.

What are address subscriptions?

Address subscriptions can be used by triggers during composition selection to select a composition based on an address contained in the initial event.

For details, see Managing Address Subscriptions in the SIS Administration Guide.

To manage address subscriptions:

1

From the SIS instance page, select Address Subscriptions.

The Address Subscriptions page displays.

2

To…

Do this:

Find an address subscription

Click for whether you want to find by Name or Address.
Type the name or address you want to find (must be an exact match).
Click Find.
REM displays the address details.

To see details of the address’s originating, terminating, or third-party composition, click it.

See all address subscriptions

Click Show All.
REM lists all address subscriptions.

Use with caution — when there are very many subscriptions, viewing them all can temporarily impact Rhino performance.

Edit an address subscription

Click to highlight it.
Click Edit.
An Edit Address Subscription dialog box displays.
Enter or select the details you want to change, and click Save.
SIS REM module saves your changes.

Remove an address subscription

Click to highlight it.
Click Remove.
SIS REM module removes that address subscription.

Install a new address subscription

Click Install.
Address subscription entry fields display.
Enter or select the address subscription details.

SIS audit function will fail and raise alarms if compositions referenced in subscriptions do not exist.

To reference a composition that does not exist in the SIS, select Other… from the drop-down menu, and enter the composition’s name, vendor, and version.

Click Add.
The SIS REM module installs the subscription.

Service Key Subscriptions (SIS REM)

You can use the SIS REM module to find, edit, remove, and install service key subscriptions.

What are service key subscriptions?

Service key subscriptions can be used by triggers during composition selection to select a composition based on the service key contained in the initial event.

For details, see Managing Service Key Subscriptions in the SIS Administration Guide.

This is a SIS feature for IN.

To manage service key subscriptions:

1

From the SIS instance page, select Service Key Subscriptions.

The Service Key Subscriptions page displays.

2

To…

Do this:

Find a service key subscription

Click for whether you want to find by Name or Service Key.
Type the name or service key you want to find (must be an exact match).
Click Find.
REM displays the service key subscription details.

To see details of the service key subscription’s originating, terminating, or third-party composition, click it.

See all service key subscriptions

Click Show All.
REM lists all service key subscriptions.

Use with caution — when there are very many subscriptions, viewing them all can temporarily impact Rhino performance.

Edit a service key subscription

Click to highlight it.
Click Edit.
An Edit Service Key Subscription dialog box displays.
Enter or select the details you want to change, and click Save.
SIS REM module saves your changes.

Remove a service key subscription

Click to highlight it.
Click Remove.
SIS REM module removes that service key subscription.

Install a new service key subscription

Click Install.
Service key subscription entry fields display.

Enter or select the service key subscription details.

The SIS audit function will fail and raise alarms if compositions referenced in subscriptions do not exist.

To reference a composition that does not exist in the SIS, select Other… from the drop-down menu, and enter the composition’s name, vendor, and version.

Click Add.
The SIS REM module installs the subscription.

Managing Configuration

You can use SIS REM Module to manage:

SIS configuration (settings common to all components)
trigger address tracing

SIS Configuration (SIS REM)

You can use the SIS REM module to verify and edit configuration settings.

What can you configure for all components?

All components in a SIS instance share these configuration settings:

Description
Default Service Timeout
Fine Grained Tracing
Audit Level
Concatenated FCI Interaction Mode Delimiter (IN)
Originating Macro (SIP)

For details, see Managing SIS Configuration in the SIS Administration Guide.

To manage SIS configuration:

1

From the SIS instance page, select SIS Configuration.

The SIS Configuration page displays.

2

To…

Do this:

Audit SIS components

Click Verify Components.

SIS REM verifies dependencies for all components installed in the SIS, checking dependency links between them and repairing broken ones (if possible).

For details, see SIS audit function in the SIS Administration Guide.

Edit configuration settings

Click Edit.
Settings entry fields display.
Enter or select the details you want to change, and click Save.
SIS REM module saves your changes.

Trigger Address Tracing (SIS REM)

You can use the SIS REM module to find, edit, remove, and add trigger address tracing profiles; and to set trigger selectors.

Managing debug logging levels for trigger addresses

You can enable debug tracing for selected calls using trigger address tracing. For example, to enable debug logging for a particular MSISDN:

Make sure the address selectors include the initial request signaling parameter where you expect the MSISDN to appear (for example, Calling Party Number or Called Party Number).
Set the debug level for the MSISDN trigger address as appropriate.

The effect of trigger address tracing is the same as assigning a fine-grained tracing level to an address subscription, but trigger address tracing is more flexible in that many more different signaling parameters are available to trigger debug logging, and a subscription does not have to be selected in order to enable the debug logging.

For details see Managing Trigger Address Tracing in the SIS Administration Guide.

To manage trigger address tracing:

1

From the SIS instance page, select Trigger Address Tracing.

The Trigger Address Tracing page displays.

2

To…

Do this:

To find a trigger address tracing profile

Enter the address and click Find.

SIS REM displays those trigger address tracing settings (exact matches only).

To show all trigger address tracing

Click Show All.

SIS REM lists all trigger address tracing profiles on the selected SIS instance.

To edit trigger address tracing details

Click to highlight the profile you want to edit, and click Edit.

An Edit Trigger Address dialog box displays.

Change the debug level and/or whether audit logging is enabled, and click Save.

SIS REM module saves your changes.

Removing debug tracing and disabling audit logging will remove the trigger address tracing for this address.

To remove a trigger address tracing profile

Click to highlight it, and click Remove.

SIS REM removes the trigger address tracing profile.

To add a new trigger address tracing details

Click Add.

Trigger address profile entry fields display.

Enter the address, debug level, and whether audit logging is enabled, and click Add.

SIS REM module saves the trigger address tracing profile.

A profile must have a debug level and/or audit logging.

To set trigger selectors

Click Selectors.

Trigger selector entry fields display for each trigger type.

To add a selector for a trigger type, click Add Selector, and select it from the dropdown list.
To change a selector, select it from the dropdown list.
To remove a selector, click Remove.
To save your settings, click Save (or click Revert to undo your changes).

SIS REM module saves your settings.