User-interaction defaults

imssf-displayuigeneralconfiguration

Command

 
imssf-displayuigeneralconfiguration
     Display general IM-SSF configuration related to user interaction

Example

To display the general user-interaction related configuration:

[Rhino@localhost (#1)] imssf-displayuigeneralconfiguration
General UI configuration
Default: Media Server Address : mediaserver.local.net:1234
Default: Route Direct         : false
IpRoutingAddress Format       : 'IPAddress,CorrelationID,ScfID', corrID length = 4 digits, scfID length = 2 digits

imssf-configuredefaultmediaserveraddress

Command

 
imssf-configuredefaultmediaserveraddress <host:port>
     Provision the default address used for media server by the IM-SSF. The media
     server is used as a part of user interaction.

Example

To provision the default media server to use:

[Rhino@localhost (#1)] imssf-configuredefaultmediaserveraddress mediaserver.local.net:1234
Set default media server address mediaserver.local.net:1234

imssf-configuredefaultmediaserverrouting

Command

 
imssf-configuredefaultmediaserverrouting <true/false>
     Configure the default routing behaviour of the IM-SSF - whether it routes back
     to the S-CSCF, or directly to the media server.

Example

To configure the IM-SSF so that it does not route to the media server directly by default:

[Rhino@localhost (#1)] imssf-configuredefaultmediaserverrouting false
Set default media server route-direct to false

imssf-configureassistingsspiproutingaddressformat

Command

 
imssf-configureassistingsspiproutingaddressformat <ICS|ICS|CIS|CSI|SIC|SCI>
         <CorrelationID-length> <ScfID-length>
     Configure how the IM-SSF should parse the assistingSSPIPRoutingAddress in
     an EstablishTemporaryConnection message, in the case that correlation ID
     and scf ID are encoding in this parameter. The first parameter defines the
     layout of the assistingSSPIPRoutingAddress Address (I=IpAddress,
     C=CorrelationID, S=ScfID)

Example

To define the layout of the assistingSSPIPRoutingAddress as IpAddress/CorrelationID/ScfID, with correlation ID of 4 digits and and ScfID of 2 digits:

[Rhino@localhost (#1)] imssf-configureassistingsspiproutingaddressformat ICS 4 2
Set assistingSSPIPRoutingAddress format to: 'IPAddress,CorrelationID,ScfID', with correlation ID of 4 digits and scf ID of 2 digits

Media server address maps

The IM-SSF maintains a table of media server configuration properties that are mapped from the IP addresses provided by the SCP. This means the IM-SSF can support a number of different media servers if required. The IM-SSF will use default values if a mapping for an SCP-supplied address provided has not been provisioned.

imssf-addmediaserveraddressmapping

Command

 
imssf-addmediaserveraddressmapping <SS7Address> <media-server host:port>
         <route-direct (true/false)>
     Add an entry into the media server address map. This map is a lookup
     table of the ss7 address provided by the SCP to the ip address
     (+ other configuration properties). The IM-SSF looks in this table
     during user-interaction processing. If no entry is found, then the
     defaults are applied.

Example

To add a media server address mapping for '5421784584575':

[Rhino@localhost (#1)] imssf-addmediaserveraddressmapping 5421784584575 mediasever2.local.net:1234 true
Added media server address mapping for 5421784584575

imssf-removemediaserveraddressmapping

Command

 
imssf-removemediaserveraddressmapping <SS7Address>
     Remove an entry from the media server address map.

Example

To remove a media server address mapping for 5421784584797:

[Rhino@localhost (#1)] imssf-removemediaserveraddressmapping 5421784584797
Removed media server address mapping for 5421784584797

imssf-displaymediaserveraddressmapping

Command

 
imssf-displaymediaserveraddressmapping
     Display the media server address map.

Example

To display all media server address mappings:

[Rhino@localhost (#1)] imssf-displaymediaserveraddressmapping
CldPN           MediaServerHostPort          RouteDirect
-----------  ---------------------------  ------------
 5421784584797   mediasever3.local.net:1234          true
 5421784584575   mediasever2.local.net:1234          true
2 rows

Message announcement maps

The IM-SSF maintains a translation table to map announcement-related properties received by the SCP into equivalent properties that are provided to a media server. These commands support tasks related to managing this mapping.

imssf-addmessageannouncementmapping

Command

 
imsssfaddmessageannouncementmapping <key> <scheme> <mimetype>
        <announcementURL> <locale>
     Add an entry into the message announcement map. This map is a lookup
     table of a key (derived from the message ID) to properties used to
     build the play URL sent to the media server

Example

To add a message announcement mapping for 'msg-50':

[Rhino@localhost (#1)] imssf-addmessageannouncementmapping msg-50 sips audio/mpeg3 file://message50.mp3 en_NZ
Added Message mapping for msg-50

imssf-removemessageannouncementmapping

Command

 
imssf-removemessageannouncementmapping <key>
     Remove an entry from the message announcement map.

Example

To remove a message mapping for msg-50:

[Rhino@localhost (#1)] imssf-removemessageannouncementmapping msg-50
Removed message mapping for msg-50

imssf-displaymessageannouncementmapping

Command

 
imssf-displaymessageannouncementmapping
     Display the tone announcement map.

Example

To display all provisioned message mappings:

[Rhino@localhost (#1)] imssf-displaymessageannouncementmapping
MsgKey   AnnouncementURL        MimeType      Scheme   locale
-------  ---------------------  ------------  -------  -------
 msg-60   file://message60.mp3   audio/mpeg3     sips    en_NZ
 msg-50   file://message50.mp3   audio/mpeg3     sips    en_NZ
2 rows

Building the message 'key'

The key of the message announcement map is derived from the message ID provided by the SCP. We apply the following rules to build a message 'key':

MessageID

Message type Key Example 
ID_ELEMENTARY_MESSAGE_ID
 
msg-<eID.MessageID>
 
msg-<ID>
 
ID_ELEMENTARY_MESSAGE_IDS
 
msg-<eIDs.MessageIDs[0]>(-<eIDs.MessageIDs[x]>)*
 
msg-<ID1>-<ID2>-…​-<IDn>
 
ID_TEXT
 
msg-<tID.MessageContent>
 
msg-<msg content>
 
ID_VARIABLE_MESSAGE
 
msg-<vID.ElementaryMessageID>(-<*VariablePartKey*(vParts[x])>)*
 
msg-<vpart1>-<vpart2>-…​-<vpartn>

VariablePartKey

Variable part type sub-key 
VARIABLE_PART_INTEGER
 
vp.Value
 
VARIABLE_PART_NUMBER
 
vp.Number.Address
 
VARIABLE_PART_TIME
 
vpTime.Hour + "_" + vpTime.Minute
 
VARIABLE_PART_DATE
 
vpDate.Day + "" + vpDate.Month + "" + vpDate.Year
 
VARIABLE_PART_PRICE
 
vpKey = vp.PriceCents

Tone announcement maps

The IM-SSF maintains a translation table to map tone-related properties received by the SCP into equivalent properties that are provided to a media server. These commands support tasks related to managing this mapping.

imssf-addtoneannouncementmapping

Command

 
imssf-addtoneannouncementmapping <toneID> <scheme> <mimetype> <toneURL>
     Add an entry into the tone announcement map. This map is a lookup
     table of a ToneID to properties used to build the play URL sent to
     the media server

Example

To add a tone mapping for Tone with ID '60':

[Rhino@localhost (#1)] imssf-addtoneannouncementmapping 60 sips audio/mpeg3 file://tone60.mp3
Added Tone mapping for 60

imssf-removetoneannouncementmapping

Command

 
imssf-removetoneannouncementmapping <toneID>
     Remove an entry from the tone announcement map.

Example

To remove a Tone mapping for Tone with ID 60:

[Rhino@localhost (#1)] imssf-removetoneannouncementmapping 60
Removed tone mapping for 60

imssf-displaytoneannouncementmapping

Command

 
imssf-displaytoneannouncementmapping
     Display the tone announcement map.

Example

To display all tone announcement mappings:

[Rhino@localhost (#1)] imssf-displaytoneannouncementmapping
ToneID   MimeType      Scheme   ToneURL
-------  ------------  -------  ------------------
     60   audio/mpeg3     sips   file://tone60.mp3
     50   audio/mpeg3     sips   file://tone50.mp3
2 rows

Acting as an Assisting-SSP

If the IM-SSF received an EstablishTemporaryConnection message from an SCP it will act as the assisting SSP and send the SCP an AssistRequestInstructions message on a second dialog. These commands allow the administrator to influence the properties of the AssistRequestInstructions message the IM-SSF will send.

  • IPAvailable is used for INAP protocols and is an OCTET string that has operator-specific encoding and length.

  • IPSSPCapabilities is used for CAMEL protocols and is a OCTET string that has operator-specific encoding and length of 4.

In some cases the EstablishTemporaryConnection message may contain enough information for the IM-SSF to contact a media server directly, instead of acting as an assisting SSP and initiating the second dialog with AssistRequestInstructions. In these cases the default assisting SSF behaviour can be disabled using imssf-disableassistingssfbehaviour, and the IM-SSF will contact the media server immediately based on the information in the EstablishTemporaryConnection.

imssf-addariipavailable

Command

 
imssf-addariipavailable <assistingSSPRoutingAddress> <ipavailable (hexEncodedString)>
     Configuree the AssistRequestInstructions IpAvailable to use when the IM-SSF is
     acting as an assisting SSF related to an assistingSSPRoutingAddress provided by
     the SCP in an EstablishTemporaryConnection.

Example

To set the IPAvailable parameter to use when acting as the assisting SSP '5421784584575':

[Rhino@localhost (#1)] imssf-addariipavailable 5421784584575 71
Added ARI Ip Available for 5421784584575 of '71'

imssf-addariipsspcapabilities

Command

 
imssf-addariipsspcapabilities <assistingSSPRoutingAddress>
        <ipsspcapabilities (hexEncodedString)>
     Configure the AssistRequestInstructions IpSSPCapabilities to use
     when the IM-SSF is acting as an assisting SSF related to an
     assistingSSPRoutingAddress provided by the SCP in an
     EstablishTemporaryConnection.

Example

To set the IPSSPCapabilities parameter to use when acting as the assisting SSP '5421784584797':

[Rhino@localhost (#1)] imssf-addariipsspcapabilities 5421784584797 93
Added ARI IP SSP Capabilities for 5421784584575 of '93'

imssf-removeariproperties

Command

 
imssf-removeariproperties <assistingSSPRoutingAddress>
     Remove all AssistRequestInstructions related properties associated with an
     assistingSSPRoutingAddress provided by the SCP

Example

To remove IPSSPCapabilities and IPAvailable configured for the IM-SSF when acting as the assisting SSP '5421784584575':

[Rhino@localhost (#1)] imssf-removeariproperties 5421784584575
Removed ARI SSP Capabilities for 5421784584575

imssf-enableassistingssfbehaviour

Command

 
imssf-enableassistingssfbehaviour <assistingSSPRoutingAddress>
     Instruct the IM-SSF that assisting SSF behaviour is enabled for this
     assistingSSPRoutingAddress. When an EstablishTemporaryConnection
     request is received for this address, the IM-SSF will use
     AssistRequestInstructions, and will wait for instructions before
     contacting the SIP media server.

Example

To enable assisting SSF behaviour for the assisting SSP address '5421784584575':

[Rhino@localhost (#1)] imssf-enableassistingssfbehaviour 5421784584575
Enabled Assisting-SSF behaviour for 5421784584575

imssf-disableassistingssfbehaviour

Command

 
imssf-disableassistingssfbehaviour <assistingSSPRoutingAddress>
     Instruct the IM-SSF that assisting SSF behaviour is disabled for
     this assistingSSPRoutingAddress. When an EstablishTemporaryConnection
     request is received for this address, the IM-SSF will not use
     AssistRequestInstructions, and will contact the SIP media server
     immediately instead.

Example

To disable assisting SSF behaviour for the assisting SSP address '5421784584575':

[Rhino@localhost (#1)] imssf-disableassistingssfbehaviour 5421784584575
Disabled Assisting-SSF behaviour for 5421784584575

imssf-displayariproperties

Command

 
imssf-displayariproperties
     Display all AssistRequestInstructions related properties.

Example

To display all ARI related properties:

[Rhino@localhost (#1)] imssf-displayariproperties
AssistingSSPIPRoutingAddress   AssistingSSFBehaviourNotRequired   HasIPAvailable   HasIPSSPCapabilities   IPAvailable   IPSSPCapabilities
-----------------------------  ---------------------------------  ---------------  ---------------------  ------------  ------------------
                5421784584797                              false            false                   true                                93
                5421784584575                              false             true                  false            71
2 rows
Previous page Next page