Professional Documents
Culture Documents
Manual
Document Status: Release
Document Version: 1.0
Release Date: 04/21/2011
Template: RK_TEM_DP_SMG_01_01
Template Effective Date: 03/20/2009
Table of Contents
Formatting Styles
The following formatting styles are used in this document to represent different elements
and types of information:
Formatting Styles
Formatting Element or
Examples
Description Information Type
Arial Field names (Includes Type your name into the User Name field.
drop-down lists, For example:
check boxes, radial - Select Personal from the Bundle Type
buttons, and other drop-down list.
lists and selections)
API method or Use the addSubscriber method in the API
operation names
Calibri Bold Button Names Click New, Save, Delete
Emphasis to a word The connection status must be monitored at
all times.
Menu options and Select Carrier > Access > Change Password
paths
(Each Stage of the
path separated by a
‘>’ character)
Calibri Bold References to other Platform Operation User Guide
Italics documents or source
material
Screen, window, pop- The Holiday screen is used to configure dates
up, and tab names that the application will recognize as valid
(First letter holidays.
capitalized)
Formatting Element or
Examples
Description Information Type
Special Icons
The following special icons are used in this document to alert the reader to important
pieces of information:
Special Icons
Icons Description
Contact
Address or Number Description
Method
Table of Contents
About this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13
Document Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13
Document Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13
Document Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
Document Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Document Purpose
This document serves as a Reference Manual for Redknee's Messaging solution.. This
document provides you the details description of the various important call flows, the
sequence and the protocols that are used in those call flows. In addition this document
also provides you the GUI Administration and the configuration tasks.
In particular the document focuses on the configurations or customizations required for
the database or GUI used by Redknee Messaging solution. The guide also documents the
default structure of the Redknee platform and the administration as well as setup and
maintenance tasks associated with it.
The purpose of this guide is to help you to:
• Understand the basic architecture and functionality of Redknee Messaging solution.
• Learn about the Redknee Messaging solution and how to use them in your production
environment.
Document Audience
The following audiences are intended to use this document:
• IT and operations teams that are responsible for administration of Redknee Messaging
solution, GUI and database.
• Third party vendors whose applications integrate with Redknee Messaging solution,
provides data for Redknee Messaging solution, or use data from Redknee Messaging
solution. Such vendors must have the knowledge of configuration and provisioning
workflow of Redknee Messaging solution.
• Any other personnel whose job functions include one of the above.
Pre-requisites
It is recommended that the user must have the following knowledge, skills, and
experience before reading this document:
• Working knowledge of the operator’s network topology and the interconnections
between the operator’s components and third party vendors.
• Working knowledge of the services provided using the Redknee Messaging solution
and associated business rules.
• Working knowledge of the system architecture and deployed Redknee Messaging
solution.
• Administrative privileges for the required Redknee Messaging solution interfaces.
• Basic proficiency in using one of the following web browsers:
- Microsoft® Windows® Internet Explorer® 7 (or up)
- Mozilla Firefox™ 2.0 (or up)
Document Scope
The scope of this document includes information that will help you understand and use
the product after it has been installed and pre-configured by Redknee. The scope includes
the following major topics:
• Redknee platform administration tasks associated with Messaging solution.
• Redknee common GUI administration tasks associated with Messaging solution.
• Database administration tasks associated with Messaging solution.
• Specific Redknee Messaging solution configuration and administration task.
Some features and functions of Redknee Messaging solution are optional and
may not be applicable to all deployments. Such features must be reviewed be-
fore implementation.
Optional Content
The following topics are not covered by this document but may be available in other
referenced documents (see references):
• Functional specifications
• Installation instructions
• Application programming interface (API) descriptions
Any other out-of-scope content is not covered by any part of the Redknee Messaging
solution documentation suite.
Document Structure
This document is divided into the following chapters:
Chapter Description
About this Document Provides information about the purpose of the document, audience, and
scope of the document.
Solution Overview Provides information about the main concepts, high-level architecture, and
cash flow in Redknee Messaging solution.
GUI Administration Provides information about the structure and tasks of the GUI components
of Redknee Messaging solution.
References
The latest versions of the following documents should be used in conjunction with this
document. This provides other useful supplementary information about the product.
Reference Description
SCL Reference Guide Lists and describes all reference information relating to
SCL field descriptions, file formats, SNMP alarms, Event
Records and so on.
Table of Contents
Messaging Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Messaging Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
Call Flows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
Bill on Submit (BOS) Call Flows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
Messaging Overview
Messaging component continues to provide network operators with a powerful,
configurable, manageable and flexible messaging platform to support enhanced
messaging services.
The modular build of the Messaging allows operators to address the routing, load sharing,
store and forward, session data manager, and also access management requirements of
their own messaging offerings. It provides a very scalable and cost effective way to
manage traffic increases, including a sizeable allowance for usage spikes, and support of
enhanced messaging services such as: televoting, gaming, information alerts, ringtone
downloads, e-mail, animation, and so on.
This also supports a true converged billing scenario with real time rating and charging
capabilities, as well as both prepaid and postpaid billing scenarios, with real-time rating
and charging applied to prepaid subscriber accounts.
Overview
Messaging Architecture
The Messaging component supports a modular architecture which can be configured as
per your current needs and evolve to meet the future requirements.
In addition to providing rating, routing and store-and-forward functions, it also supports a
variety of value-added messaging services that might be introduced by the network
operator.
The Messaging Gateway sends and receives messages with SMPP/UCP or GSM/IS-41 MAP
network elements. It is specifically designed to be a central point of connectivity and
management for messaging traffic. Connected to any variety of Messagings, ESMEs and
LAs, Messaging component supports numerous sources and destinations for messages.
This also provides GSM/IS-41 compliant SMS Mobile Origination/Termination interfaces
for MO and MT SMS through the Mobile SS7 network. SMS messages are received through
these interfaces and sent to and from MSCs or Messagings.
The MT SMS portion of the interface supports SS7-MAP signaling with the service
network’s Home Location Register (HLR). Subscriber information such as user location and
user status is retrieved to route the SMS message to the mobile recipient.
Messaging component also supports IN-SS7 signaling protocols such as INAP and TCP/IP
based interfaces to facilitate the integration with a network operator’s IN platform, such
as the Prepaid Service Control Point and other billing platforms, for handling prepaid and
postpaid account billing transactions.
Real-time billing transactions manage the prepaid charging and balance deductions made
for all SMS messages sent or received by the mobile subscriber.
For more information on various protocols, you may refer the following sites on the
internet.
SMPP Protocol - http://www.smssolutions.net/tutorials/smpp/
INAP Protocol:
http://www.item.ntnu.no/fag/ttm4130/stottelitteratur/IN.pdf
The internet reference provided here are just indicative and Redknee do not have any
control, guarantee, warranty either implicit or explicit on the the information available.
You may refer any other information per your choice.
Call Flows
MO - MT Successful Scenario
The following figure explains the MO to MT successful call flow.
4. Hub forwards the message to URCS for Rating and charging over CORBA protocol
5. SMS-Hub sends the message to MT over SMPP protocol
6. MT delivers the message over SS7 to handset
In this scenario from MSC through SS7 the message is sent to ESME
1. ESME over SMPP protocol triggers it to SMS-Hub
2. SMS-Hub internally checks the cache
3. Hub sends the message to URCS for Rating and charging over CORBA interface.
4. SMS-Hub sends the message to MT over SMPP protocol
5. MT delivers the message over SS7 to handset
In this senario
1. SMS-MO/ESME triggers the message to Hub over SMPP protocol.
2. Hub checks the internal cache and simultaneously triggers the message to URCS for
Rating and Charging over SMPP
3. Hub then sends the message to SMS-MT over CORBA interface.
4. MT delivers the message to handset over SS7
5. If the message is not deliver, then MT resends the message back to Hub
6. Hub sends it to Store and Forward module to store the message.
In this senario
1. Once the message is stored in Store and Forward , after a interval of time that is
configured in the store and forward module, it again tries and sends the message to
Hub.
2. Hub triggers it to MT for delivery.
3. MT sends the message over SS7 to handset.
4. In case of the message delivery receipt is enabled - then MT > HUB >ESME this route
is done over SMPP
5. In case delivery report is enabled for message coming from MO - MT generates the
report and sends over SS7 to originating MSIDN
Table of Contents
Messaging GUI Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-29
Mobile Originator (MO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-30
SMS-Hub Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-31
Connectivity Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-31
Messaging Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-59
Routing Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-81
Configuration Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-92
Connection Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-98
SMS-MT Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106
Event Record (ER) Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106
Configuring Time Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-107
Store and Forward (SnF) Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-109
Managing the MSISDN Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-109
Configuring Retry Algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-110
CORBA Connection Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-111
SMPP Connection Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
Configuring Delivery Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-114
Searching for MSISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-116
MIM Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-119
Configuring DB Utilization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-119
Configuring Relay Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-120
SDM Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-124
Searching Multipart Session Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-124
Searching Session Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-126
Xover Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-128
Configuring X- Over settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-128
SMPP Error Code -Result Code Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-131
There is no GUI for SCL-MO, as all the task related to SCL-MO are one time
task and done during deployment.
SMS-Hub Administration
SMS-Hub is the most intelligent application of the messaging component that handles the
routing of all messages. This accepts messages from ESMEs over SMPP and also accepts
SMPP messages from SMS-MO application.
SMS-Hub application:
- Handles black/white listing.
- Decides where SMS messages needs to be routed.
- Conducts number normalization.
- Has a connection to URCS for rating purposes.
- Has a connection to Store and Forward for SMS retry.
- Connects to MO and MT application, and SMSC.
- Handles throttling.
- Configures the message validity period to override the validity period set for the
message.
Connectivity Management
Connectivity Management deals with configurations of ESME transmitter and receiver
profiles, SMT profiles, and SMSC profiles (SMPP and UCP).
Task
To configure settings for ESME and SMSC.
Context
This provides general properties and configuration of the connections.
Pre-Requisites
None.
Steps
Perform the following steps to configure the general settings for ESME and SMSC:
1. Login to AppSmshub GUI.
2. Navigate to Connectivity Management > General. The following screen appears:
The following table provides the description of the checkboxes. Depending upon the
requirement, check-mark the checkbox to enable the field.
ESME Transmitter/Transceiver Bind Reject SMS-Hub raises a SNMP trap in case of an unsuccessful bind
Trap transmitter request.
ESME Originating Address Verification for SMS-Hub verifies the origination address for transmitters and
Transmitter/Transceiver transceivers.
ESME Keep-alive Event Records for SMS-Hub generates Event Records for enquire link messages to
transmitters / transceivers and from ESME Transmitters.
ESME Receiver Bind Reject Trap SMS-Hub generates SNMP trap on a bind rejection.
ESME Keep-alive Event Records for SMS-Hub generates Event Records for keep alive messages for
receivers ESME receivers.
SMSC Keep-alive Event Records for SMS-Hub generates event records for keep alive messages for
transmitters SMSC transmitters.
SMSC Keep-alive Event Records for SMS-Hub generates event records for keep alive messages for
receivers SMSC receivers.
Add EMG Message ID to ER 473 Addition of the 23rd field to the 473 ER.
3. Specify the maximum size of incoming SMPP messages in the Maximum SMPP
Message Length (bytes) textbox. An SMPP message with message length greater than
the specified value is considered as invalid and the corresponding SMPP connection is
disconnected.
4. Click Update. The entries are updated and the page refreshes with the message
Updated: class com.redknee.app.smshub.EsmeSmscConfig.
5. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To set up ESME Receiver Profile.
Context
The ESME Receiver Manager sends SMPP receiver bind connections to the SMS-Hub.
ESME Receivers connect to the SMS-Hub to receive messages from an operator's SMSC(s).
The ESME rx can only receive a deliver_sm messages.
Pre-Requisites
Before performing this task, you need to establish the TCP/IP network.
Steps
Perform the following steps to set up ESME Receiver profile:
1. Login to AppSmshub GUI.
2. Navigate to Connectivity Management > ESME Connection Profiles > Receiver
Profiles. The existing entries of ESME Receiver profile are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.
5. Enter the unique identifier of the profile in the ID textbox. It is provisioned by the
network operator, and is defined in the range from 5000-9999.
6. Enter an integer that defines routing rules in the Priority textbox. The value one is of
highest priority.
Bind Type is auto populated and is not editable. By default the value is Re-
ceiver
7. Select the type of ESME connection to peg an OM from the Profile Type drop-down
list. By default it is set to None, means no OM will be pegged.
8. Enter the name of the ESME in the Info textbox. Event Record regarding this ESME
have to have this parameter.
9. Enter the system identification number requesting a bind to the iHub for login
purpose in the System ID textbox.
10. Enter the type of system requesting a bind to the iHub for login purpose in the System
Type field.
11. Enter the version of SMPP used (in hexadecimal) in the Interface Version field. Default
value of Interface Version is 34.
12. Enter Password for the ESME Profile to prevent improper use in the Password textbox.
13. Check-mark the Enable checkbox to accept the ESME bind request, or clear otherwise.
Profile that are not active cannot be used to login.
14. Enter the maximum number of ESME Receiver connections allowed to the iHub
cluster in the Maximum Connections textbox. Default value of Maximum Connections
is one(1).
15. Check-mark Enquiry link Enabled checkbox to send the enquire link messages to
ESME partner to verify the status of the connections, or clear otherwise.
16. Enter the time interval in milliseconds at which enquire link messages should be sent
in the Enquire Link Interval textbox.
17. Check mark the Terminating Addresses checkbox to create routing rules. The address
can be either an exact address or an address prefix followed by a wildcard character
(%). If Regular Expressions are enabled in Advanced Configurations, then regex
support is provided. This block of parameters defines the routable Address, TON and
NPI to the ESME. The single parameters can be numeric and alphanumeric.
18. Enter Routing Keyword in the textbox, this is used for routing rules. It can be either an
exact match or a prefix followed by a wildcard character (%). If Regular Expressions are
enabled in Advanced Configurations, then regex support is provided. It is case
insensitive.
19. Enter Virtual SMSC value to define an optional TLV with the tag SM_RP_DA (0x2001).
20. Enter the numeric value that represents protocol identifier in the PID textbox. This is
used in routing rules. It is the part of SMPP message.
21. Enter Esm Class for routing that this receiver should be configured to receive the
messages in the Esm Class textbox.
22. Enter the Data Coding Scheme for routing in the DC Scheme textbox.
23. Check-mark the Enable Service Type Override checkbox to replace the service type
value in incoming messages by the new value, or clear otherwise.
24. Enter Service Type Override Value in the textbox. If the service type override feature
is enabled, service type of incoming messages will be overridden by this value.
25. Check-mark Buffer Type checkbox, if the buffer is circular. Circular indicates when the
buffer is full, then the older messages are over-written. Clear the checkbox, If the
buffer is fixed sized queue. Fixed size queue indicates new messages are rejected
when the buffer is full.
26. Enter an integer that specifies the size that is the number of messages SMS-Hub can
store per ESME Receiver interface in the Message Buffer size textbox. If secondary is
used then this value should be zero(0).
27. Enter an integer that defines the maximum number of messages that the profile can
handle before throttling occurs in the Throttle Rate textbox.
28. Check-mark the Remove Redknee TLVs checkbox to remove Redknee TLVs if the
message is destined for an external ESME, or clear otherwise.
29. Select ESME Type from the drop-down list. The extended routing allows delivering a
message to the Secondary ESME if it cannot be delivered to the Primary one. The
options are Primary/Secondary.
30. Check-mark the Extended Routing Enable checkbox to enable re-routing of messages
to the secondary ESME, or clear otherwise. This is applicable to the Primary ESME
Receiver only.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure ESME Transceiver profiles.
Context
An ESME Transceiver can be used in place of a ESME Transmitter and ESME Receiver pair.
The ESME Transceiver can send a submit_sm and also receive a deliver_sm.
Pre-Requisites
None.
Steps
Perform the following steps to configure ESME Transceiver profile:
1. Login to AppSmshub GUI.
2. Navigate to Connectivity Management > ESME Connection Profiles > Transceiver
Profiles. The existing ESME Transceiver profile are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.
5. Enter the unique ID that identifies the profile. It is provisioned by the network
operator, and the value should be greater than or equal to 20000
6. Enter an integer used in routing rules in the Priority textbox. A value one is of the
highest priority.
Bind Type is auto populated and is not editable. By default the value is
Transceiver.
7. Select Tx Profile Type from the drop-down list to peg OMs. By default the value is set
to None.
8. Select Rx Profile Type from the drop-down list to peg OMs. By default the value is set
to None.
9. Enter the name of the ESME in the Info textbox. Event Record regarding this ESME
have to have this parameter.
10. Enter the system identification number requesting a bind to the SMS-Hub for login
purpose in the System ID field.
11. Enter the type of system requesting a bind to the iHub for login purpose in the System
Type field.
12. Enter the version of SMPP used (in hexadecimal) in the Interface Version field.The
default value is 34.
13. Enter password for the ESME Profile to prevent improper use in the Password Field.
14. Check-mark the Enable checkbox to accept the ESME bind request, clear otherwise.
Profile that are not active cannot be used to login.
15. Enter the maximum number of ESME Receiver connections allowed to the iHub
cluster in the Maximum Connections field. Default value is one(1).
16. Check-mark Enquiry link Enabled checkbox to send the enquire link messages to
ESME partner to verify the status of the connection, clear otherwise.
17. Enter the time interval in milliseconds at which enquire link messages should be sent
in the Enquire Link Interval textbox.
18. Default Origination Address indicates that when incoming messages do not specify a
source address, this address is used as a default. It consists of Address, TON, NPI. In
the Address textbox specify MSISDN of Originating address. In the TON textbox,
specify TON of Originating address, by default the value is -1. In the NPI textbox,
specify NPI of Originating address, by default the value is -1.
19. The Transmitter Allowed Source Addresses is verified only if the ESME Originating
Address Verification for transmitters/transceivers parameter is enabled in
Connectivity Management/General settings. This validates the incoming messages
against the supplied list of the source address of incoming messages. Enter source
address allowed by the transmitter in the Address textbox, TON and NPI of the source
address allowed by the transmitter in the TON and NPI textbox respectively. By default
its value is -1.
20. Terminating Addresses is the list of terminating (destination) address to be used to
create routing rules. The address can be either an exact address or an address prefix
followed by a wildcard character (%). If Regular Expressions are enabled in Advanced
Configurations, then regex support is provided. This defines the routable Address,
TON and NPI to the ESME. The single parameters can be numeric and alphanumeric.
Enter terminating address in the Address textbox, TON and NPI of the terminating
address in the TON and NPI textbox respectively. By default its value is -1.
21. Enter Routing Keyword in a textbox, this is used for routing rules. It can be either an
exact match or a prefix followed by a wildcard character (%). If Regular Expressions are
29. Check-mark the Remove Redknee TLVs checkbox to remove Redknee TLVs if the
message is destined for an external ESME, or clear otherwise.
30. Check-mark the Enable Service Type verification checkbox to accept the incoming
messages if the service type matches any of the service types provisioned in the
Service Type List.
31. Enter the value of service type in the Value textbox. The value should not be of more
than five characters. Allowed Service Type consists of the Value field and the
messages are validated against the values in the list.
32. Check-mark the Enable Service Type Override checkbox to replace the service type
value in incoming messages by the new value, or clear otherwise.
33. Enter the Service Type Override Value in the textbox. If the service type override
feature is enabled, service type of incoming messages will be overridden by this value.
34. Trigger List is the list of triggers to be activated for this profile. It consists of:
- Trigger Name: It is an drop-down list in which triggers are selected from the
configured triggers.
- Reject Bind: Rejects Bind requests for this profile if the trigger is not connected.
- Trigger Only: Results in asynchronous triggering. Stop on Fail and Failure Return
Codes are not applicable for this.
- Stop On Fail: Indicates whether to continue with the remaining triggers in the list
or stop if the current one fails.
- Reject Message: Indicates whether to reject the original message for which this
trigger was sent. If Reject Message checkbox is enable, then the failure return
code is matched and once matched original message is rejected.
- Positive Response: Generates trigger on positive response.
- Negative Response: Generates trigger on negative response.
- Failure Return Code for Failure: This is valid only when Stop on Fail is enabled.This
defines the return codes which would indicate failure. It has regular expression
support always enabled.
35. Select ESME Type from the drop-down list. The extended routing allows delivering a
message to the Secondary ESME if it cannot be delivered to the Primary one. The
options are Primary/Secondary.
36. Check-mark the Extended Routing Enable checkbox to enable re-routing of messages
to the secondary ESME, or clear otherwise. This is applicable to the Primary ESME
transceiver only..
37. TLV List consists of list of TLVs to be added. Only billing TLVs can be added. It is defined
by the Tag and Value fields.
38. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure ESME Transmitter Profile.
Context
The external entity that connects as an ESME has to connect as a Transmitter profile. The
ESME tx can only send as submit_sm.
Pre-Requisites
None.
Steps
Perform the following steps to configure ESME Transmitter profile:
1. Login to AppSmshub GUI.
2. Navigate to Connectivity Management > ESME Connection Profiles > Transmitter
Profiles. The existing ESME Transmitter profile are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.
5. Enter unique ID that identifies the profile. It is provisioned by the network operator,
and is defined in the range from 0000 to 4999.
Bind Type is auto populated and is not editable. By default the value is
Transmitter.
6. Select Profile Type from the drop-down list to peg OMs.By default the value is set to
None.
7. Enter the name of the ESME in the Info textbox. Event Record regarding this ESME
have to have this parameter.
8. Enter the system identification number requesting a bind to the SMS-Hub for login
purpose in the System ID field.
9. Enter the type of system requesting a bind to the iHub for login purpose in the System
Type field.
10. Enter the version of SMPP used (in hexadecimal) in the Interface Version field.The
default value is 34.
11. Enter password for the ESME Profile to prevent improper use in the Password Field.
12. Check-mark the Enable checkbox to accept the ESME bind request, clear otherwise.
Profile that are not active cannot be used to login.
13. Enter the maximum number of ESME Transmitter connections allowed to the iHub
cluster in the Maximum Connections field. Default value is one(1).
14. Check-mark Enquiry link Enabled checkbox to send the enquire link messages to
ESME partner to verify the status of the connection, clear otherwise.
15. Enter the time interval in milliseconds at which enquire link messages should be sent
in the Enquire Link Interval textbox.
16. Default Origination Address indicates that when incoming messages do not specify a
source address, this address is used as a default. It consists of Address, TON, NPI. In
the Address textbox specify MSISDN of Originating address. In the TON textbox,
specify TON of Originating address, by default the value is -1. In the NPI textbox,
specify NPI of Originating address, by default the value is -1.
17. The Transmitter Allowed Source Addresses is verified only if the ESME Originating
Address Verification for transmitters/transceivers parameter is enabled in
Connectivity Management/General settings. This validates the incoming messages
against the supplied list of the source address of incoming messages. Enter source
address allowed by the transmitter in the Address textbox, TON and NPI of the source
address allowed by the transmitter in the TON and NPI textbox respectively. By default
its value is -1.
18. Check-mark the Enable Service Type verification checkbox to accept the incoming
messages if the service type matches any of the service types provisioned in the
Service Type List.
19. Check-mark the Allowed Service Types checkbox to enable the rule, or clear
otherwise. Enter the value of service type in the Value field. The value should not be
of more than five characters.
20. Check-mark the Enable Service Type Override checkbox to replace the service type
value in incoming messages by the new value, or clear otherwise.
21. Enter Service Type Override Value in the textbox. If the service type override feature
is enabled, service type of incoming messages will be overridden by this value.
22. Enter an integer that defines the maximum number of messages that the profile can
handle before throttling occurs in the Throttle Rate textbox.
23. Select Partitioning Rule from the drop-down list. The origination/destination MSISDN
is considered for matching the routing rules. The options are None/Originator/
Destination.
24. Trigger List is the list of triggers to be activated for this profile. It consists of:
- Trigger Name: It is an drop-down list in which triggers are selected from the
configured triggers.
- Reject Bind: Rejects Bind requests for this profile if the trigger is not connected.
- Trigger Only: Results in asynchronous triggering. Stop on Fail and Failure Return
Codes are not applicable for this.
- Stop On Fail: Indicates whether to continue with the remaining triggers in the list
or stop if the current one fails.
- Reject Message: Indicates whether to reject the original message for which this
trigger was sent. If Reject Message checkbox is enable, then the failure return
code is matched and once matched original message is rejected.
- Positive Response: Generates trigger on positive response.
- Negative Response: Generates trigger on negative response.
- Failure Return Code for Failure: This is valid only when Stop on Fail is enabled.
This defines the return codes which would indicate failure. It has regular
expression support always enabled.
- Partition Identifier: This is the partitioning Id for which the trigger is sent and is
used only in case of Partitioning Routing. It supports wild card characters.
- Rule Id: This is the Rule Id for which the trigger is to be sent. This field is always
enabled and it supports regular expression. Blank is treated as a catch all (just like
".*").
25. TLV List consists of list of TLVs to be added. Only billing TLVs can be added. It is defined
by the Tag and Value fields.
26. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure SMPP receiver bind connections to the SMSCs.
Context
SMS-Hub connects to the external SMSC through the SMPP profile. One Profile is needed
for each connection that the SMS-Hub wants to initiate with the external SMSC.
Pre-Requisites
Before performing this task, you need to the know Login ID, Host name and Port number
of the SMSC.
Steps
Perform the following steps to configure SMPP profile:
1. Login to AppSmshub GUI.
2. Navigate to Connectivity Management > SMSC Connection Profiles > SMPP Profiles.
The existing SMPP profile are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry. The following screen appears:
5. Select Group Name that routing rules will use from the drop-down list. The group
name comes from the configuration in Connectivity Management, SMSC connection
Profiles, SMSC Groups.
6. Enter the unique identifier for SMSC instance in the Instance textbox.
7. Enter host name or IP address of the SMSC in the Host textbox. This parameter can be
obtained from the XOver module.
8. Enter port number of the SMSC that the SMS-Hub binds in the Port textbox. This
parameter can be obtained from the XOver module.
9. Specify system info of the profile in the Info textbox, this identifies name SMS-Hub
binding to SMSC.
10. Enter the system identification number requesting a bind to the SMS-Hub for login
purpose in the System ID textbox.
11. Enter password for the SMPP Profile to prevent improper use in the Password
textbox.
12. Enter the type of system requesting a bind to the SMS-Hub for login purpose in the
SystemType textbox. The default value is SMPP.
13. Enter the version of SMPP used (in hexadecimal) in the Interface Version textbox. The
default value is 34.
14. Check-mark the Profile Enabled checkbox to activate SMS-Hub on system start up,
clear otherwise.
15. Enter an integer that defines the maximum number of messages that the profile can
handle before throttling occurs in the Throttle Rate textbox. It is rate (measured in
messages per second) at which messages are transmitted from SMS-Hub to SMSC.
16. Check-mark Enquiry link Enabled checkbox to send the enquire link messages to
ESME partner to verify the status of the connection, clear otherwise.
17. Enter the time interval in milliseconds at which enquire link messages should be sent
in the Enquire Link Interval textbox.
18. Check-mark the Enable Service Type Verification checkbox to reject the incoming
messages, if the service type does not match any of the service types provisioned in
the Service Type List, clear otherwise.
This field is visible only if the Group Name is selected as Receiver Connec-
tion.
19. Enter the value of service type in the Value textbox. It should not be more than 5
characters.
Allowed Service Types field is visible if the service type verification is en-
abled, then service type of incoming messages are validated against the val-
ues in this list. If the value is not found in this list, then the message is
rejected.
20. Check-mark the Use Payload checkbox to store the original UCP message into the
SMPP message payload, or clear otherwise.
21. Check-mark the Remove Redknee TLVs checkbox to remove Redknee TLVs if the
message is destined for an external ESME, or clear otherwise.
22. Select Partitioning Rule from the drop-down list. The origination/destination MSISDN
is considered for matching the routing rules. The options are None/Originator/
Destination.
23. Trigger List, Esm Class for Delivery Notification and Trigger on Delivery Notification
fields are visible if the Group Name is selected as Rx (Receiver Connection).
• Trigger List is the list of triggers to be activated for this profile. It consists of:
- Trigger Name: It is an drop-down list in which triggers are selected from the
configured triggers.
- Reject Bind: Rejects Bind requests for this profile if the trigger is not connected.
- Trigger Only: Results in asynchronous triggering. Stop on Fail and Failure Return
Codes are not applicable for this.
- Stop On Fail: Indicates whether to continue with the remaining triggers in the list
or stop if the current one fails.
- Reject Message: Indicates whether to reject the original message for which this
trigger was sent. If Reject Message checkbox is enabled, then the failure return
code is matched and once matched original message is rejected.
- Positive Response: Generates trigger on positive response.
- Negative Response: Generates trigger on negative response.
- Failure Return Code for Failure: This is valid only when Stop on Fail is enabled.
This defines the return codes which would indicate failure. The regular expression
support is always enabled.
- Partition Identifier: This is the partitioning Id for which the trigger is sent and is
used only in case of Partitioning Routing. It supports wild card characters.
- Rule Id: This is the Rule Id for which the trigger is to be sent. This field is always
enabled and it supports regular expression.
• ESM Class for Delivery Notification: This provides the values of esm class for which the
delivery notification has arrived
• Trigger on Delivery Notification: This sends trigger to a trigger profile on receiving
delivery notification. It consists of:
- Trigger Name: Trigger is to be selected from configured triggers.
24. Partition Identifier: This is the partitioning Id for which the trigger is sent and is used
only in case of Partitioning Routing. It supports wild card characters.
25. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure special message routing.
Context
The special SMSC group of connections are used to send the special message primitives,
such as Replace, Cancel, Query Submit Sm with replace flag. Special Message Routing
provides the SMSC group name that is used for the special messages to be relayed to the
Store and Forward or the external SMSC.
For example: If the message is to be forwarded to the SNF application then this menu can
be simply be configured to use the “Store and Forward” Group which is also used for the
SF direct connection as well, in turn is used to send messages to External SMSC.
Pre-requisite
Following are the pre-requisites of the task:
• Create SMSC group under Connectivity management >SMSC Connection Profiles >
SMSC groups.
• Create a SMPP Profile under Connectivity management > SMSC Connection Profiles >
SMPP Profile.
Steps
Perform the following steps to configure the special message routing:
1. Login to AppSmshub GUI.
2. Navigate to Connectivity Management > SMSC Connection Profiles > Special
Message Routing. The following screen appears:
3. Check-mark the Enable Special Message Routing checkbox to enable the routing of
special message (cancel_sm, query_sm, or replace_sm) to SMSC group.
4. Select the SMSC group from the Special Message Route drop-down list.
5. Click Update. The entry is updated and the page refreshes with the message
Updated: class
com.redknee.app.smshub.smsc.SpecialSmscGroupConfig
6. Click Save.
Expected Result
The entries are saved successfully and the confirmation message appears.
Task
To configure the outbound connections used for the UCP messages.
Context
The SMSC Transceiver Manager is responsible for SMS-Hub UCP transceiver connections
to the SMSC(s). SMSC Transceivers connects to an operator's SMSC(s) to submit messages
from Large Accounts (LAs). The SMS-Hub manages and controls SMSC Transceiver
connections, providing throttling and connection management services that reduce
network impact and consolidate UCP data flows. Therefore the SMSC Transceiver Manager
provides the following Connection management functionality:
• Establishing and maintaining connections
• Throttling
The SMSC Transceiver Manager manages and maintains the UCP connection with SMSC(s).
A UCP connection to a SMSC must be established before messages can be submitted to it
- UCP-60 is used to login to the Large Account
- UCP-31 maintains the connection.
Pre-requisite
Following are the pre-requisites of the task:
• Create SMSC profile for Authentication.
• SMSC Transceiver profile must be in enabled state.
Steps
Perform the following steps to configure UCP Profile:
1. Login AppSmshub GUI.
2. Navigate to Connectivity Management > SMSC Connection Profile > UCP Profiles.
The existing SMSC connection configuration are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.The following screen appears:
Field Description
Group Name The group name that routing rules will use.
Key Name of SMSC within the group.
Host IP address of the SMSC.
Port Port address of the SMSC.
Password The password is for security and will prevent improper use.
Version Number UCP protocol version number, cannot be editable.Default
value is 0100.
Address Code Originator Address of the LA. This value is used during authentication.
Originator Type of Originator TON of the LA. This value is used during
Number authentication.
Originator Numbering Originator NPI of the LA. This is used during authentication.
Plan
Subtype of Operation An indicator for the subtype operation in a Session
Management Operation.
Subtype of UCP_60 operation can be
1 – open session (supported)
2 – reserved
3 – change password (supported)
4 – open provisioning session (not supported)
5 – reserved
6 – change provisioning password (not supported)
Originator Protocol Allows Originator Protocol Identifier
Identifier - 00 for Mobile station
- 39 for PC application
Field Description
Expected Result
The entries are saved successfully and the confirmation message appears.
Task
To configure SMSC groups.
Context
The SMSC group can be either a Tx, Rx or TRx connection depending on whether it has to
send a submit_sm or receive a deliver_sm respectively. For the external SMSC connections
the SMSC Group and the SMPP profiles are used.
There could be multiple SMPP profiles created under the same group. The Routing type is
then used to load balance between the SMPP connections under each Group.
Pre-requisites
None.
Steps
Perform the following steps to configure SMSC Group:
1. Login AppSmshub GUI.
2. Navigate to Connectivity Management > SMSC Connection Profiles > SMSC Group.
The existing SMSC Group entries are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete a entry.
4. Click New to create a new entry. The following screen appears:
5. Enter the name used in the routing rules in the Group Name textbox.
6. Select either SMPP or SMPP_PLUS protocol that is used by SMSC group from the
Protocol drop-down list. Other protocols are not supported by SMSC Group.
7. Select Bind Type from the drop-down list. The options are Transmitter/Receiver/
Transceiver. Changes to the bind type affects the configuration of the routing tables.
8. Select Tx Profile Type from the drop-down list. The options are None/MtSmscTx/
SmscTx/SfSmscTx/XoverSmscTx. This field is visible only if Bind Type is set to
Transmitter. It is used to peg outgoing messages OM, and defines the type of SMSC
connection.
9. Select Rx Profile type from the drop-down list. The options are None/MtSmscRx/
SmscRx/SfSmscRx/XoverSmscRx.T his field is visible only if Bind Type is set to
Receiver. It is used to peg incoming deliver_sm messages OM, and defines the type of
SMSC connection.
10. Select Routing Type from the drop-down list. This balances the load mechanism
within the connection group. By default, method is Round Robin type.
11. Select Group Type from the drop-down list. The options are Primary/Secondary
SMSC. The extended routing allows iHub to deliver a message to the Secondary Group
in the case when it cannot be delivered to any SMSC in the Primary Group. This is not
applicable to the Receiver. Secondary is selected only if the Extended Routing rules
are enabled that is set to True. The value specified here (Primary, or Secondary SMSC)
controls the visibility of other fields in this page.
12. Extended Routing Enable field is applicable to the Primary SMSC Transmitter or
Transceiver Group only. Enables re-routing to the Secondary Group SMSCs. Clear the
Extended Routing Enable checkbox when Primary group of SMSC is used.
13. Select Secondary Group Name field, this is applicable to the Primary SMSC
Transmitter Group only. The name of secondary Routing Group that will be used for
routing messages that can not be delivered to any SMSC in the Primary Group
14. Check-mark the Overwrite Registered Delivery checkbox to overwrite the registered
delivery flag in the message. If set to false, it sets the corresponding bits for registered
delivery flag.
15. Select the Smsc Registered Delivery from the drop-down list, to configure all
messages that are sent to the secondary routing destination requests for SMPP
Delivery Receipts.
16. Select the Sme Registered Delivery from the drop-down list, to configure all messages
that are sent to the secondary routing destination requests for SS7 Status Reports or
SS7 Phase 1 Delivery Reports.
17. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure the profile for SMT client.
Context
SMT Profile is used for client connection over UCP protocol.
Pre-Requisites
None
Steps
Perform the following steps to configure SMT Profile:
1. Login AppSmshub GUI.
2. Navigate to Connectivity Management > SMT Profiles. The existing SMT Client
configuration entries are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.
Refer to the following table for field and its description:
Field Description
Field Description
Field Description
Throttle Rate Maximum number of messages per second allowed for each SMT (LA) before
throttling (active reject) occurs.
Enquire Link Enabled Indicates whether enquire links is to be sent to the LA partner to verify the
status of the connection.
Inactivity Timeout Specifies the maximum time interval between transactions before an SMPP
entity assumes that the session is no longer active.This timer may be active on
communicating SMPP entity (that is, SMSC or ESME)
Session Init Timeout The time in milliseconds to wait for a session to be validated/authenticated
Enquire Link Timeout The interval in milliseconds between enquire/alert messages
Response Timeout The maximum time in milliseconds to wait for a response after an outbind is
sent to an SMT Receiver profile.
UCP Delivery Command Indicates that SMPP Deliver SM is mapped to UCP 52. Otherwise it is mapped to
UCP 01.
UCP-60 for Rx Profile Defines whether UCP-60 based authentication is required for Rx profile.
check to send a UCP-60 prior to a UCP-52, clear to not send UCP-60.
CP 53 DST Value for Buffered Configured DST (delivery status) value for buffered messages.
Messages
SMSB Trigger Indicates whether the trigger is sent to SMSB or not for billing.
Receiver Routing Info A list of routing rules for this receiver routing
This consist of following parameters:
• Receiver Address Coding-Address Coding for generating receiver rules
• Routing TON-TON of the routable address
• Routing NPI-NPI of the routable address
• Routing ESM Class-The ESM class of messages that can be handled by this
SMT profile
• Routing Data Coding Schema-The Data Coding Schema of messages that can
be handled by this SMT profile
• Routing Keyword-The keyword for messages that can be routed to this UCP
profile
• Routing NPID-The numeric PID for messages that can be routed to this UCP
profile
5. Click Save.
Expected Result
The entries are saved successfully and the confirmation message appears.
Messaging Management
SMS-Hub provides a filter to control and manage traffic passing through it. You can create
rules to allow or restrict the traffic by configuring parameters for:
Black list - Block messages coming from particular MSISDN, all messages coming from an
MSC, or all messages coming from an ESME ID.
White list - Allows traffic from particular MSISDN, MSC, or an ESME ID.
You can use a combination of Blacklist and Whitelist to manage traffic routing through
SMS-Hub.
Task
To map the address as on-net or off-net.
Context
Mapping the address helps in identifying the subscriber as off-net or on-net.
Pre-Requisite
Before performing this task, you need to know the number ranges for on-net and off-net
subscriber.
Steps
Perform the following steps to map address:
1. Login AppSmshub GUI.
2. Navigate to Messaging Management > General > Address Mapping. The following
screen appears:
The Address Mapping dialogue box consists of Address list, this contains the list of
addresses that are to be mapped.
3. Enter the address to be mapped as on-net or off-net in the Address textbox.
4. Check mark the On Net checkbox to map the address as on Net, or clear otherwise (to
be map as off-net).
5. Click Update. The entries are updated with the message.
Updated: class com.redknee.app.smshub.AddressMapping
6. Click Save.
Expected Result
The entries are saved successfully and the confirmation message appears.
Task
To configure baring rule for service provider.
Context
Barring Rule restricts the services for the numbers that are defined in Barring Source or
Barring Destination. The service provider id and barring plan are fetched from subscription
profile from URCS.
Pre-Requisites
None.
Steps
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > General > Barring. The existing entries are
listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry. The following screen appears:
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure general settings to manage the traffic.
Context
General Settings is used to identify the network for delivery of message.
Pre-Requisites
None.
Steps
Perform the following steps to configure general settings:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > General > General Configs. The following
screen appears:
5. Disable CDMA Delivery Reports and Receipt checkbox indicates that the CDMA
messages will not generate delivery report, status reports, delivery receipt. Check to
not generate the report or clear otherwise.
6. Rate Multipart Messages As one checkbox indicates that the Multipart messages are
treated as one and is charged as one. check if you want to Multipart messages to be
rated as one, or clear otherwise.
7. Click Update. The entries are updated and the page refreshes with the message,
Updated: class com.redknee.app.smshub.MsgMgmtConfig.
8. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To map the Message Destination Number with network type.
Context
This is used for mapping a series of MSISDN to a particular network type.
Pre-Requisites
Before performing this task, the number range that needs to be mapped should be
enabled in the General Configuration page.
Steps
Perform the following steps to map message destination number:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > General >Message Destination Number
Mapping. The existing Mapping table are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.The following screen appears:
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure the SMSC default validity for the message.
Context
SMS-Hub resets the validity_period for all submit_sm message received from the ESME
Transmitter Manager, ESME Transceiver Manager or the Large Account Transceiver
Manager.
Validity Period Reset feature is set, indicates that the validity period is overwritten with
the configured value.The value to be overwritten has the absolute time-format and is a
minimum function of:
- validity period of the message or
Pre-requisite
None.
Steps
Perform the following steps to reset message validity period:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > General > Message Validity Period Reset. The
following screen appears:
3. Select the option as Relative or Absolute for representing time as per smpp standards
for submit_sm message.
4. Enable checkbox indicates that whether or not to overwrite validity period to
submit_sm. Check to overwrite the message validity period or clear otherwise.
5. Enter the number of Days, Hours, Minutes, and Seconds in the New Validity Period
offset from the current time in the Days, Hours, Minutes and Seconds textbox
respectively.
6. Overwrite message Validity to data_sm indicates to overwrite message validity to
data_sm. If set to false, message validity gets updated using qos_time_to_live tlv
value. If qos_time_to_live tlv is not present in data_sm, message validity is updated
using this configuration.
7. Enable checkbox indicates that whether or not to overwrite validity period to data_sm
or. Check to overwrite the message validity period or clear otherwise.
8. Enter the number of Days, Hours, Minutes, and Seconds in the New Validity Period
offset from the current time in the Days, Hours, Minutes and Seconds textbox
respectively.
9. Click Update. The entries are updated and the page refreshes with the message:
Updated: class com.redknee.app.smshub.ValidityPeriodConfig.
10. Click Save.
Expected Result
The entries are saved successfully and the confirmation message appears.
Task
To configure MNP Rule Id.
Context
MNP configuration is used to route MNP numbers to external SMSC.
Pre-requisite
None.
Steps
Perform the following steps to configure MNP default rule:
Expected Result
The entries are saved successfully and the confirmation message appears.
Task
To map Receiver error codes with error messages.
Context
Receiver Error code Mapping is used to map the receiver error codes for which the SMS-
Hub routes the message to the secondary ESME (if configured in the profile).
Pre-requisite
Before performing this task, you need to create Receiver Connection Profile.
Steps
Perform the following steps to map receiver error codes:
5. Enter the error code value to which the description is to be mapped in the Error Code
Value textbox. If a receiver connection's response command status matches the value
specified in this error code field, then an attempt is made to route the original request
using the secondary route (if one exists) defined in the receiver connection profile. It
accepts only integer values.
6. Specify the description of the error code in the Error Code Description textbox.
7. Click Save.
Expected Result
The entries are saved successfully and the confirmation message appears.
Task
To map Transmitter error codes with error messages.
Context
Transmitter Error code Mapping is used to map the transmitter error codes for which the
SMS-Hub routes the message to the secondary ESME (if configured in the profile).
Pre-requisite
Before performing this task, you need to create Transmitter Connection Profile.
Steps
Perform the following steps to map transmitter error codes:
1. Login AppSmshub GUI.
2. Navigate to Messaging Management > General > Transmitter Error Code Mapping.
The existing entries are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry. The following screen appears:
5. Enter the error code value to which the description is to be mapped in the Error Code
Value textbox. If a transmitter connection's response command status matches the
value specified in this error code field, then an attempt is made to route the original
request using the secondary route (if one exists) defined in the transmitter connection
profile. It accepts only integer values.
6. Specify the description of the error code in the Error Code Description textbox.
7. Click Save.
Expected Result
The entries are saved successfully and the confirmation message appears.
Task
To configure normalization rules for destination address.
Context
The conversion of incoming and outgoing MSISDNs into suitable formats is known as
Normalization. Typically, you must configure an entire set of different normalization rules
that handles different conversions in different situations. Each rule has a specific set of
criteria that must be matched for normalization to take place.
SMS-Hub supports normalization for both origination addresses and termination
addresses for correct address formatting routing. Normalization functions are only
provided in routing from the ESME/LA to SMSC (that is transmitter connections).
Pre-Requisites
Before performing this task, you need to know the number range that requires to be
normalized.
Steps
Perform the following steps to configure normalization rules for destination address:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > Normalization > Destination Address
Normalization. The existing entries are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.The following screen appears:
5. Enter Priority for this rule in the textbox. One is of highest priority and is processed
first, and each rule is processed incrementally after that. This value is not necessarily
unique; time of creation (not shown) is used as a tie breaker value.
6. Select the Action to be performed from the drop-down list. This specifies the type of
normalization to be performed. The options are Replace address prefix/Prepend to
address prefix. Replace will replace one or more digits/chars in the address. Prep end
will add one or more digits/chars to the front of the address.
7. Enter ESME ID of the profile that is processing the current message in the textbox.
Normalization rules can also be applied to all incoming messages by specifying the
wildcard digit (-1). Supports Regex if enabled in advanced configuration.
8. Enter the destination/termination address (MSISDN or short code) of the subscriber in
the Address field. When Regex is Enabled, use proper regular expression or%.
9. Enter the termination TON of the subscriber in the TON field.
10. Enter the termination NPI of the subscriber in the NPI field.
11. Enter Reference Address in the textbox for normalizing a number based on the other
number. For Destination address normalization, use Source address here. Supports
Regex if enabled in advanced configuration. When Regex is Enabled, use proper
regular expression or%.
12. Enter Reference TON in the textbox for normalizing. When doing Destination
normalization, use SOURCE ton here. For regex or when not required, use value as -1.
13. Enter Reference NPI in the textbox for normalizing. When doing Destination
normalization, use Source ton here. For regex or when not required, use value as -1.
14. Enter Reference Length in the textbox for normalizing. When doing Destination
normalization, use Source ton here. For regex or when not required, use value as -1.
15. Enter the address after normalization in the Translated Address textbox. If Regular
expressions are Enabled, use proper regex or%.
16. Enter TON after normalization in the Translated TON field.
17. Enter NPI after normalization in the Translated NPI field.
18. Enter Msc ID in the textbox. It is used as a matching criteria for normalization.
Supports Regex if enabled in advanced configuration.
19. Enter the length of MSISDN being normalized in the Length textbox. This is used as a
matching criteria for normalization
20. Enter the description of the normalization in the Description field.
21. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure normalization rules for source address.
Context
The conversion of incoming and outgoing MSISDNs into suitable formats is known as
Normalization. Typically, you must configure an entire set of different normalization rules
that handles different conversions in different situations. Each rule has a specific set of
criteria that must be matched for normalization to take place.
SMS-Hub supports normalization for both origination addresses and termination
addresses for correct address formatting routing. Normalization functions are only
provided in routing from the ESME/LA to SMSC (that is transmitter connections)
Pre-Requisites
Before performing this task, you need to know the source address that needs to be
normalized.
Steps
Perform the following steps to configure normalization rules for source address:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > Normalization > Source Address
Normalization. The existing entries are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.The following screen appears:
5. Enter Priority for this rule in the textbox. One is of highest priority and is processed
first, and each rule is processed incrementally after that. This value is not necessarily
unique; time of creation (not shown) is used as a tie breaker value.
6. Select the Action to be perform from the drop-down list. This specifies the type of
normalization to be performed. The options are Replace address prefix/Prepend to
address prefix. Replace will replace one or more digits/chars in the address. Prep end
will add one or more digits/chars to the front of the address.
7. Enter ESME ID of the profile that is processing the current message in the textbox.
Normalization rules can also be applied to all incoming messages by specifying the
wildcard digit (-1). Supports Regex if enabled in advanced configuration.
8. Enter the Source address (MSISDN or short code) of the subscriber in the Address
field. When Regex is Enabled, use proper regular expression or%.
9. Enter the Source TON of the subscriber in the TON field.
10. Enter the Source NPI of the subscriber in the NPI field.
11. Enter Reference Address in the textbox for normalizing a number based on the other
number. For Source address normalization, use Destination address here. Supports
Regex if enabled in advanced configuration. When Regex is Enabled, use proper
regular expression or%.
12. Enter Reference TON in the textbox for normalizing. When doing Source
normalization, use Destination ton here. For regex or when not required, use -1
13. Enter Reference NPI in the textbox for normalizing. When doing Source normalization,
use Destination ton here. For regex or when not required, use -1
14. Enter Reference Length in the textbox for normalizing. When doing Source
normalization, use Destination ton here. For regex or when not required, use -1
15. Enter Translated Address in the textbox. This is the address after normalization. If
Regular expressions are Enabled, use proper regex or%.
16. Enter TON after normalization in the Translated TON field
17. Enter NPI after normalization in the Translated NPI field.
18. Enter Msc ID in the textbox. It is used as a matching criteria for normalization.
Supports Regex if enabled in advanced configuration.
19. Enter Length in the textbox. This is the length of MSISDN being normalized used as a
matching criteria for normalization
20. Enter the description of the normalization in the Description field.
21. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure message blacklists.
Context
iHub offers multiple blacklist mechanisms. The rules can be configured per ESME id based
or per MSC id based. Both originating and destination MSISDN are checked for black
listing. Also Service Centre could be blacklisted. These are not intended for use on a per
subscriber basis.TON and NPI are not applicable to SMSC addresses.
Submit_sm messages that are not blacklisted are allowed to continue processing through
the SMS-Hub. If the message is blocked, the SMS-Hub returns a submit_sm_resp message
with an error code back to the originating party.
Pre-Requisites
Before performing this task, you need to know the number range that needs to be
blacklisted.
Steps
Perform the following steps to configure blacklisted message:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > Normalization > Black List The existing entries
are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.The following screen appears:
5. Enter identification number of the entry in the ID textbox, it can take any positive
integer values.
6. Select Type from the drop-down list. Perform blacklisting based on Originating
Address/Destination Address/Service Center address. By default, the value for this
field is black list based on Originating Address.
7. Enter the id of the profile that is submitting the message in the Esme ID text box. This
address verification rule only applies to this ESME. To make the rule apply to all
ESMEs, enter -1. Supports Regex if enabled in advanced configuration.
8. Enter Address that is to be verified in the Address textbox. It can be either an exact
address or an address prefix followed by a wildcard character (.*). If Regular
Expressions are enabled in Advanced Configurations, then regex support is provided.
9. Enter type of number to be verified in the TON textbox. This field does not apply to
the SC Address verification. Use -1 to ignore TON.
10. Enter the number plan indicator to be verified in the NPI textbox. This field does not
apply to the SC Address verification. Use -1 to ignore NPI.
11. Enter id of MSc to be verified in the MscID textbox. This field does not apply to the SC
Address verification. Use -1 to ignore MscID.
12. Enter a readable Description of this address verification item.
13. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To verify the message for Whitelist.
Context
Whitelists are used per Originating, Destination, or Service Centre address. Whitelists are
not intended for use on a per subscriber basis. TON and NPI are not applicable to SMSC
addresses.
Whitelisting of source, destination, and service centre addresses are applied
independently. Whitelisting is to be applied first, and takes precedence over blacklisting.
When a source address is whitelisted, source address blacklisting will not need to be
applied; destination address and service centre address blacklisting will still need to be
checked. Regular Expressions shall be used for address fields.
Pre-Requisites
Before performing this task, you need to know the number range that needs to be
whitelisted.
Steps
Perform the following steps to configure whitelisted message
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > Normalization > White list The existing entries
are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.The following screen appears:
5. Enter identification number of the entry in the ID textbox, can take any positive
integer values.
6. Select Type from the drop-down list. Perform blacklisting based on Originating
Address/Destination Address/Service Center address.
7. Enter the id of the profile that is submitting the message in the Esme ID text box. This
address verification rule only applies to this ESME. To make the rule apply to all
ESMEs, enter -1. Supports Regex if enabled in advanced configuration.
8. Enter address that is to be verified in the Address textbox. It can be either an exact
address or an address prefix followed by a wildcard character (.*). If Regular
Expressions are enabled in Advanced Configurations, then regex support is provided.
9. Enter type of number to be verified in the TON textbox. This field does not apply to
the SC Address verification. Use -1 to ignore TON.
10. Enter the number plan indicator to be verified in the NPI textbox. This field does not
apply to the SC Address verification. Use -1 to ignore NPI.
11. Enter id of MSc to be verified in the MscID textbox. This field does not apply to the SC
Address verification. Use -1 to ignore MscID.
12. Enter a readable Description of this address verification item.
13. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure the parameters for subscription state handling.
Context
SCL-Hub allows you to define the subscription state of subscriber and accordingly actions
are configured for that particular subscriber state. This configuration is SPID based.
Pre-Requisites
Before performing this task, you must configure the service provider.
Steps
Perform the following steps to configure subscription state handling:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > General > Subscription State Configuration.
The existing entries are listed in tabular form.
3. To view, edit, or delete an entry, use the Action buttons on the right.
4. To create an entry, click New The following screen appears:
Expected result
The entries are saved successfully and the confirmation message appears.
Routing Management
Routing Management basically tells you about how routing rules are managed by SMS-
Hub. SMS-Hub supports routing in two directions:
- SMSC to ESME/LA (Receiver)
Task
To configure Number Plan Area (NPA) routing calculation.
Context
NPA routing is used when subscribers are stored in external storage, in that case SMS-Hub
routes message to external SMSC for delivery.
SMS-Hub supports an NPA routing table for routing destination numbers based on the NPA
digits. The NPA routing table is used to determine the route if the destination is not found
in the subscriber database. The destination route will either be out to the local mobile
network via SS7 or to an SMSC serving as an Inter-carrier or International gateway. The
NPA routing table supports regular expressions
Pre-Requisites
Before performing this task, you need to know the number range that requires NPA
routing.
Steps
Perform the following steps to calculate NPA Routing:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > Routing Management > NPA Calculation
Configuration. The existing entries are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.The following screen appears:
9. Enter the Allowed Destination TON in the textbox. NPA will be calculated only if the
Destination TON matches this field
10. Enter Allowed Destination NPI in the textbox. NPA will be calculated only if the
Destination NPI matches this field
11. Enter the position of the digits in number that specifies the NPA code in the NPA
Position textbox.This includes Start position and End position of the NPA code.
12. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure Number Plan Area routing
Context
NPA routing allows you to intelligently route traffic to your gateways or your local SMSC
for delivery of message. Two components to NPA routing are, an NPA table and the
subscriber database. SMS-Hub is available to receive message processing requests.
MSISDNS are in E.164 format in the SMPP message. A route is determined for the message
based on the routing table, otherwise rejected.
Pre-Requisites
Before performing this task, you need to configure NPA List and zone in the NPA
Calculation configuration page.
Steps
Perform the following steps to configure NPA routing:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > Routing Management > NPA Routing. The
existing entries are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry.The following screen appears:
5. Enter the unique serial identification number for this entry in the ID textbox.
6. Enter the zone identification number for this entry in the Zone ID textbox.
7. NPA List displays the list of NPA values mapping to the zone. Enter the NPA values
mapping to the zone in the NPA textbox.
8. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure rules that route messages from a transmitter profile to an SMSC Group
Context
When a submit_sm arrives on any ESME after all normalization, black list, whitelist, SMSB
trigger, generic trigger checks, the transmitter routing rules are checked to find the
appropriate SMSC location.
Rules are considered in order. The first rule that matches a given SMS event is used and all
other rules are ignored.If no rules matches, the message are sent to the default Routing
Destination if available, otherwise the message are discarded and the sender receives a
NACK. %is the wildcard character.
You can insert, change or delete rules. The rules are match first
Pre-Requisites
Before performing this task, you need to configure Transmitter profile.
Steps
Perform the following steps to configure transmitter routing rules:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > Routing Management > Transmitter Router.
The existing entries are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry. The following screen appears:
5. Enter the unique identification number within the Transmitter Rule list in the Rule ID
textbox
6. Enter the sequence (order) of rules to be processed in the Priority textbox. One is of
highest priority and is processed first, and each rule is processed incrementally after
that. This value is not necessarily unique; time of creation (not shown) is used as a tie
breaker value.
7. Enter the identification number of incoming ESME in the ESME ID textbox. The value is
obtained from ESME transmitter profile. Supports Regex if enabled in advanced
configuration.
8. Select the name of SMSC transmitter group that is to be routed from the Routing
Destination drop-down list.If zero then the message is discarded.
9. Enter the Originating address (MSISDN or short code) of the subscriber in the
Origination MSISDN textbox. When Regex is enabled, use proper regular expression,
otherwise% is used as the wildcard.
10. Enter the TON of Originating subscriber in the Origination TON textbox.Ignore if the
value is set to -1.
11. Enter the NPI of Originating subscriber in the Origination NPI textbox.Ignore if the
value is set to -1.
12. Enter the terminating address (MSISDN or short code) of the subscriber in the
Destination MSISDN textbox. When Regex is enabled, use proper regular expression,
otherwise% is used as the wildcard.
13. Enter the TON of terminating subscriber in the Destination TON textbox.Ignore if the
value is set to -1.
14. Enter the NPI of terminating subscriber in the Destination NPI textbox. Ignore if the
value is set to -1.
15. Enter the Command Id of the message in the textbox. When regex is on, this field has
to be a valid regular expression, otherwise% is used as the wildcard.
16. Enter the Protocol Identification number in the PID textbox. Supports Regex if enabled
in advanced configuration.
17. Enter the class to which ESME belongs in the ESME Class textbox. Supports Regex if
enabled in advanced configuration.
18. Enter Data Coding scheme in the textbox to encode the message.
19. Enter KeyWord in the textbox. If the message text starts with the keyword, then the
message will be allowed for this route. Supports regular expression matching. If
Regular Expressions are disabled, use the value -1 or%.
20. Enter optional TLV value for routing messages to a fixed destination in the Virtual
SMSC textbox. When Regex is Enabled, use proper regular expression or.*
21. Select the day that this rule applies from the Day drop-down list. This can be one of:
Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Weekdays (Mon-
Fri), Week-ends (Sat, Sun), Holidays (see Holiday table), Every-day (week).
22. Select the start time based on local system time (HH:MM:SS format), when the rule
takes effect from the Start Time drop-down list.
23. Select the end time, based on local system time (HH:MM:SS format), when the rule
stops applying from the End Time drop-down list.
24. Enter the zone id identification number for routing in the Zone ID textbox. If Regular
Expressions are disabled, use the value -1 or%.
25. Enter Routing MTP/SCCP Error in the textbox. If the message contains a User Error
code, it will be routed to the specified destination. This supports regular expressions
when enabled.
26. Enter the description for the routing rule in the Description textbox.
27. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To configure rules that route messages from a Receiver profile to an SMSC Group.
Context
When a deliver_sm arrives on any SMSC after all normalization / black list / whitelist /
SMSB trigger / generic trigger checks the Receiver routing rules are checked to find the
appropriate ESME location. The rules are first match.
Pre-Requisites
Before performing this task, you need to configure Receiver profile and SMSC profile.
Steps
Perform the following steps to configure Receiver routing rules:
1. Login to AppSmshub GUI.
2. Navigate to Messaging Management > Routing Management > Receiver Router. The
existing entries are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry. The following screen appears:
5. Enter the unique identification number within the Receiver router rule list in the Rule
ID textbox.
6. Enter the sequence (order) of rules to be processed in the Priority textbox. One is of
highest priority and is processed first, and each rule is processed incrementally after
that. This value is not necessarily unique; time of creation (not shown) is used as a tie
breaker value.
7. Select the destination route of the message when it matches this rule from the ESME
Destination drop-down list. This parameter is from ‘ESME receiver profile’.
8. Enter the terminating address (MSISDN or short code) of the subscriber in the
Destination MSISDN textbox. When Regex is enabled, use proper regular expression,
otherwise% is used as the wildcard. The list consists of entries in SMSC group with
bind type as Receiver
9. Enter the TON of terminating subscriber in the Destination TON textbox.Ignore if the
value is set to -1.
10. Enter the NPI of terminating subscriber in the Destination NPI textbox.Ignore if the
value is set to -1.
11. Enter KeyWord in the textbox. If the message text starts with the keyword, then the
message will be allowed for this route. Supports regular expression matching. Use
proper regex or%.
12. Enter the instance Name of the incoming SMSC in the SMSC Origination textbox.
Supports regular expression when enabled. Use proper regular expression or%.
13. Enter optional TLV value for routing messages to a fixed destination in the Virtual
SMSC textbox. When Regex is Enabled, use proper regular expression or%.
14. Enter the Protocol Identification number in the PID textbox. Supports Regex if enabled
in advanced configuration.
15. Enter the class to which ESME belongs in the ESME Class textbox. Supports Regex if
enabled in advanced configuration.
16. Enter Data Coding scheme in the textbox to encode the message.
17. Enter the zone identification number for routing in the Zone ID textbox. If Regular
Expressions are disabled, use the value -1, otherwise use a proper regex or%.
18. Enter Routing MTP/SCCP Error in the textbox. If the message contains a User Error
code, it will be routed to the specified destination. This supports regular expressions
when enabled.
19. Enter the description for the routing rule in the Description textbox.
20. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Configuration Management
Configuring Delimiter
Task
To configure the delimiter for the files.
Context
Delimiter defines the character that is used to separate the files. For example,
'\t' , '\\' ,'"' and special characters. This is used while importing/ exporting the files.
Pre-Requisites
None
Steps
Perform the following steps to configure the files delimiter:
1. Login to AppSmshub GUI.
2. Navigate to Configuration Management > Delimiter Config. The following screen
appears:
3. Define the Delimiter. Valid delimiters are '\t' , '\\' ,'"' and special characters.
4. Click Save.
Expected Result
The delimiters are successfully saved.
Task
To export the files.
Context
The files are exported to the defined location.
Pre-Requisites
none
Steps
Perform the following steps to import the files:
1. Login to AppSmshub GUI.
2. Navigate to Configuration Management > Export. The following screen appears:
3. Check-mark the checkbox for the files that you need to export.
4. Specify the name of the file in the File Name textbox.
The File Name is not mandatory parameter. It is used as a suffix to fixed File
Name.
5. Enter the directory name in the Export Directory textbox. This is the path where the
file is exported.
6. Click Export.
Expected Result
The file is exported successfully.
Task
To import the files.
Context
The files are imported to the specified destination.
The sample input file format:
(Key_Cls)com.redknee.app.smshub.BarringClassName_com.redkne
e.app.smshub.Barring_.CSV
The syntax for the file is:
<SPID><TAB><#ofEntries><TAB><BarringID><TAB><Source address
in quotes><TAB><Destination address in quotes>
The bold part can be repeated with a tab between each.
Pre-Requisites
None.
Steps
1. Login to AppSmshub GUI.
2. Navigate to Configuration Management > Import. The following screen appears:
Expected Result
The files are imported successfully.
Connection Status
Connection Status provides a simple summary for status of connection information of
different profiles like ESMEs, SMSC, Receiver, transmitter, transceiver and SMT.
Task
To view the list of all Active ESME profiles entries in the system.
Context
An ESME registered with a SMSC has an active SMPP connection for the submission and
delivery of messages over the network connection. All active ESME connections at
SCLHUB can be viewed on the ESME Profiles page. An ESME can bind with the SMSC as a
Transmitter (called ESME Transmitter), Receiver (called ESME Receiver) or Transceiver
(called ESME Transceiver) depending on the ESME bind type.
Active ESME Profile provides a simple summary connection information of ESMEs
Pre-Requisites
Before performing this task, you need to create an ESME profile.
Steps
Perform the following steps to view the Active ESME Profile:
1. Login to AppSmshub GUI.
2. Navigate to Connection Status > Active ESME Profiles. The following screen appears:
Field Description
Id Specifies the Identification number of ESME Profile. Every ESME has to have a unique ID.
This parameter is provisioned by the network operator. The ESME ID is defined in the
range from 0000 to 4999
Bind Type This is the connection type (bind type) of SMPP Session. Either Receiver, Transmitter or
Transceivers.
Connection Provides the information of ESME connection as:
Information • Node ID- Node Identification number of iHub to which the ESME is bound.
• Client IP Address - Defines the IP address of ESME.
• Individual Active Connection -Provides the total number of Individual active
connections for the selected IP address on particular node.
• Disconnect Status -Shows the status of rating rule either enabled or disabled.
Max Connections Provides maximum number of connections for this profile
Active Connections Provides current number of active ESME connections for the selected profile to or from
the iHub server. The number of active ESME connection is the number of active
connection on the clustered node, and not just on the local node.
Action Action to be performed on ESME Profile
Expected Results
The ESME Profile is displayed.
Task
To view a list of all available receivers in the system.
Context
Active Receiver Connection shows ESME/LA receiver connections by node name.
Pre-Requisites
Before performing this task, you need to create an ESME Profile.
Steps
Perform the following steps to view the Active Receiver Connections:
1. Login to AppSmshub GUI.
2. Navigate to Connection Status > Active Receiver Connections. The following screen
appears:
Field Description
Expected Results
The required Active Receiver Connection is displayed.
Task
To view a list of all Active SMSC profile entries in the system
Context
Active SMSC Profile defines the active SMSC connections to SMSHUB. Any connection to
which SMSHUB sends a bind (Tx/Rx/TxRx) qualifies as an SMSC connection.
Pre-Requisites
Before performing this task, you need to create SMSC Profile.
Steps
Perform the following steps to view the Active SMSC Profile:
1. Login to AppSmshub GUI.
1. Navigate to Connection Status >Active SMSC Profiles. The following screen appears:
Field Description
Field Description
Expected Results
The SMSC status is displayed.
Task
To view a list of all Active SMT profile entries in the system
Context
An SMT Profile provides a simple summary for connection information of ESMEs.
Pre-Requisites
Before performing this task, you need to create an SMT Profile.
Steps
Perform the following steps to view the Active SMT Profile:
1. Login to AppSmshub GUI.
2. Navigate to Connection Status > Active SMT Profiles. The following screen appears:
Field Description
Expected Results
The profile summary is displayed.
Task
To view the service status.
Context
This shows the different status of the services with the SMS-Hub.
Pre-Requisites
Before performing this task, you need to configure the SF Corba Server, Session Data
Manager Client applications and the status of these application needs to be UP (that is in
running mode).
Steps
Perform the following steps to view service status:
1. Login to AppSmshub GUI.
2. Navigate to Connection Status > Service Status. The following screen appears:
Field Description
Name Specifies the name of the service that is monitoring the process.
Status Indicates the status of the service, whether UP or Down. It also
displays the URCS status.
Expected Result
You can successfully view the status of the service.
Task
To view the trigger connection status.
Context
This is a generic SMSC type connection over which SMSHUB sends triggers.
Pre-Requisites
Before performing this task, you need to configure the trigger in the ESME profile.
Steps
Perform the following steps to view the trigger connection status:
1. Login to AppSmshub GUI.
2. Navigate to Connection Status > Trigger Connection Status. The following screen
appears:
Field Description
Expected Results
Triggerwise connection status is viewed.
SMS-MT Configuration
Mobile Terminating (MT) application handles all Mobile Terminated traffic. This
application interfaces with the GMSC over SS7 for submitting short messages.
Task
To configure Event Record parameters.
Context
ER Configuration helps you to enable/disable the optional parameters. The optional
parameters are enlisted below.
Pre-requisites
None.
Steps
Perform the following steps to configure the optional parameters in ER:
1. Login to AppSmsmt GUI.
2. Navigate to Admin Control > ER Config. The following screen appears:
For example, (Optional: SMS-Hub SnF Integration) Indicates if one of the follow-up
actions has been triggered:
• 0=None;
• 1=Rerouted;
• 2=Delivery Receipt;
• 3=Rerouted and Delivery Receipt;
• 4=Delivery Acknowledgement;
• 5=Rerouted and Delivery Acknowledgement
4. Primary/Secondary checkbox indicates that whether or not the message Id is to be
included in ER. If enabled, the message is routed to the MT application as a Primary/
Secondary Routing Destination by SMS-Hub.
5. Check mark the Service Type checkbox to include the service type message in ER, or
clear otherwise.
6. Check mark the Keyword checkbox to include the keyword of the message in ER, or
clear otherwise.
7. Click Update. The page refreshes with the message
Updated: class com.redknee.app.smsmt.ErConfig
8. Click Save.
Expected Result
The entries are saved successfully and the confirmation message appears.
Task
To configure and manage MSC addresses and their corresponding time zone.
Context
Time Zone Management is used to configure any time zone adjustments that need to be
done while delivering the message.The local MSC timestamp feature is enabled, each MSC
is configured to have a specific time zone
Pre-Requisites
Before performing this task, you need to know the list of MSC GT address and the country
wise time zone value.
Steps
Perform the following steps to configure time zone:
1. Login to AppSmsmt GUI.
2. Navigate to SMS-MT configuration > Time Zone Management. The following screen
appears:
3. Check-mark the Local MSC Timestamp checkbox to use the local MSC time as service
centre time stamp.
4. GT Timezone Pair displays the list of MSC Global Translations (GT) and their
corresponding timezone.
5. Enter the MSC address in the textbox. A regular expression can be specified here if
required.
6. Select Time zone from the drop-down list that corresponds to the given MSC GT
address.
7. Click Update. The entries are updated and the page refreshes with the message as:
Updated: class com.redknee.app.smsmt.GtTimezoneMgmt
8. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To manage MSISDN queue.
Context
You can perform the Query MSISDN Queue, Kick Retry MSISDN Queue, Remove MSISDN
Queue actions for managing MSISDN queues. After performing an action on a MSISDN
queue, the screen refreshes with a status update.
Pre-Requisites
Before performing this task, you need to create a MSISDN Queue.
Steps
Perform the following steps to manage MSISDN queue:
1. Login to AppSmssf GUI.
2. Navigate to Administration > Queue Administration. The following screen appears:
Expected Results
After performing an action on a MSISDN queue, the screen refreshes with a status update.
Task
To configure retry algorithms for message resending.
Context
Store and Forward application retries delivery attempts for stored messages. Messages
are retried until they are expired. This application supports a GUI configurable retry
algorithm with multiple retry attempts and configurable delays per attempt. Retry
Algorithm defines after what time the messages needs to be retried. The Retry delay time
is added to the current time to calculate the next retry time.
Pre-Requisites
None.
Steps
Perform the following steps to configure Retry Algorithm:
1. Login to AppSmssf GUI.
2. Navigate to App Configuration > Cron Service > Retry Algorithm Configuration, the
existing entries are listed in tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a new entry. The following screen appears:
5. Enter the unique identifier for this profile in the Algorithm ID textbox. It is four digit
number in the range 0000 to 9999.
6. Specify the small descriptive note of this retry algorithm in the Description textbox.
7. In the Retry Scheme dialogue box multiple instances of the following are configurable
in pairs:
• Retry_Attempt- Number of retry attempt
• Retry_Delay- Delay in seconds/minutes/hours/days from the last retry attempt.
• Action- Action to follow after unsuccessful retry.
8. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To view the status of corba connection.
Context
Corba Connection status displays the status of SMS-Hub and the time and date since it is
up.
Pre-Requisite
None
Steps
Perform the following steps to view the corba connection status:
1. Login to AppSmssf GUI.
2. Navigate to Connection Status > CORBA Connection Status. The following screen
appears:
Field Description
Expected Result
You can successfully view the connection status.
Task
To view the status of SMPP connection.
Context
SMPP Connection status displays the status of all SMPP connection either connected or
not connected along with their detailed information as Connection type, Connection Node
ID, Profile ID. The figure below with red mark shows the connection status.
Pre-Requisite
None
Steps
Perform the following steps to view the SMPP connection status:
1. Login to AppSmssf GUI.
2. Navigate to Connection Status > SMPP Connection Status. The following screen
appears:
Field Description
Expected Result
You can successfully view the SMPP connection status.
Task
To configure messages and timeouts for delivery notifications.
Context
Snf application generates delivery notifications if required by the incoming message.
Delivery notifications are generated under the following conditions:
• Incoming messages if received from SCL over SMSC transmitter connection with
Originator_Indicator TLV set to 1 (iHUB)- Delivery notification with status,,ENROUTE.
is generated.
• Incoming message if received from SCL over ESME receiver connection- Delivery
notification with status 'PENDING' is generated.
• Message is successfully retried- Message is deleted from queue and delivery
notification with status „DELIVERED. is generated.
• Message expired: Message is deleted from queue and delivery notification with status
„EXPIRED. is generated.
• Permanent GSM error (for MT messages only): All messages are deleted from queue
and delivery notification with status „UNDELIVERABLE. is generated as required by
message.
Delivery Notifications will not be generated for incoming messages where service_type is
'MTSR' or 'MTDR'.
SnF application support the following delivery notification types:
- GSM Phase 2/2+ Status Report
- GSM Phase 1 Delivery Receipt
- CDMA Delivery Acknowledgement
- SMPP Delivery Report for ESME notification
- All delivery notifications are submitted to SCL for further routing and delivery.
Pre-Requisite
None.
Steps
Perform following steps to configure Delivery Notification parameters:
1. Login to AppSmssf GUI.
3. Use Custom Delivery Ack checkox indicates that the SnF application generates Delivery
Acknowledgement messages that are sent over SS7 by SCL. This acknowledgment
delivery report is created using the text template configured in the GUI. Check to
generate the report, or clear otherwise.
If the check for box is not selected, then delivery ack/report is sent contain-
ing the original short message.
4. Enter the format of delivery report (phase 1 report) in the Delivery Report Text for
Successful Delivery textbox. The keywords [DEST], [SUBMIT_TIME], [DONE_TIME] can
only be replaced, rest remains the same.
5. Enter the format of delivery report (phase 1 report) in the Delivery Report Text for
Pending Delivery textbox. The keywords [DEST], [SUBMIT_TIME], [ERR_DES], [ERR]
can only be replaced, rest remains the same.
6. Enter the format of delivery report (phase 1 report) in the Delivery Report Text for
Unsuccessful Delivery textbox. The keywords [DEST], [SUBMIT_TIME], [ERR_DES],
[ERR] can only be replaced, rest remains the same.
7. Enter the format of delivery report (phase 1 report) in the Delivery Report Text for
Expired Messages textbox. The keywords [DEST], [SUBMIT_TIME] can only be
replaced, rest remains the same.
8. Enter the time duration in milliseconds in the Message Validity Period textbox that
defines the validity period of the message after which the message is considered as
expired.Message validity period is used in reports and receipts.
9. Enter the Data Coding to encode the message in the textbox. This is used in reports
and receipts.
10. Positive Notification Enabled checkbox indicates that the positive reports and
receipts can be turned on and off with this option. Check to turn on the reports, or
clear otherwise.
11. Intermediate Notification Enabled checkbox indicates that the Intermediate reports
and receipts can be turned on and off with this option. Intermediate reports are
defined as those that are not a negative or positive acknowledgement of the original
message. Check to turn on the reports, or clear otherwise.
12. Negative Notification Enabled checkbox indicates that the negative reports and
receipts can be turned on and off with this option.
13. Click Update.
Expected Result
The entries are saved successfully and the confirmation message appears.
Task
To search for a MSISDN.
Context
MSISDN search is done to know the detailed information for the particular MSISDN, such
as submission time, validity period, message status and so on.
The details of information are enlisted below in the table.
Pre-Requisites
Before performing this task, you need to know the MSISDN for which detailed information
is required.
Steps
Perform the following steps to search for a MSISDN:
3. Enter the Terminating MSISDN of the message of which you need the information in
the Term-MSISDN textbox.
4. Enter the Originating MSISDN of the message of which you need the information in
the Orig-MSISDN textbox.
5. Enter the number that defines the limit that you want for this search in the Result
Limit textbox.
6. Click Search. The page refreshes and the table is displayed with the detailed
information of the required MSISDN.
Refer to following table for field and its description
Field Description
Field Description
Retry Attempt he number of retry attempts a message has had in the retry profile.
Total Retry Attempts The total number of retry attempts made for this message.
Validity Period Validity Period
Status Message Status in the queue
Expected Results
The MSISDN search is done successfully.
MIM Configuration
The messaging solution uses the external SMSC, external SMSC ID and the ESME ID
assigned to the ESME message, to map for the smooth flow of information.
When delivery receipts are received by messaging solution (SCL) from external SMSC, SCL
needs to replace the message id in the SMPP delivery_receipt primitive with the one SCL
had originally generated when message was submitted from an ESME/LA to SCL.
AppMsgidmap performs two way responsibility of storing the internal (generated by SCL)
message id against the external (generated by external SMSC) message id when message
is sent out to an external SMSC and replacing external message id with the internal
message id when a delivery receipt is received from external SMSC. Thus Message ID
Mapper helps in Smooth Flow of Information.
Configuring DB Utilization
Task
To configure MIM Database Settings.
Context
AppMsgidmap performs two way responsibility of storing the internal (generated by SCL)
message id against the external (generated by external SMSC) message id when message
is sent out to an external SMSC and replacing external message id with the internal
message id when a delivery receipt is received from external SMSC. The two messages IDs
assigned to messages are stored in database.
Pre-Requisites
Before performing this task, you need to store the storage format in XDB.
Steps
Perform the following steps to configure the parameters for MIM database settings:
1. Login to AppMsgidmap GUI.
2. Navigate to Message Id Mapper > DB Utilization Config, The following screen
appears:
3. Enter the numeric value that defines the number of records stored in database in the
Database Size textbox.
4. Enter the numeric value that defines the low threshold for the Resource Utilization
Alarm to be cleared in percentage of the DB Size in the DB Low Threshold textbox.
5. Enter the numeric value that defines the High threshold for the Resource Utilization
Alarm to be raised in percentage of the DB Size in the DB High Threshold textbox
6. Enter the time in milliseconds required for checking database high or low threshold in
the DB Util Checkout Time (Milliseconds) textbox
7. Enter the time in milliseconds that checks the database connection Up or Down in the
DB Connection Checkout Time (Milliseconds) textbox.
8. Click Update. The entries are updated and the page refreshes with the message as:
Updated: class
com.redknee.app.msgidmap.DBUtilizationConfig.
9. Click Save.
Expected Results
The entries are saved successfully and the confirmation message appears.
Task
To Configure relay connections and settings for the Message ID Map application.
Context
Message ID Map can have multiple relays each relay have mapping (outgoing) and
unmapping (incoming) relay. Each relay can have pair of Rx and Tx connections towards
iHub and towards external SMSC. For every transaction handled by Message ID Map
module, an ER 487- 'Message Event' is generated. There is a one to one mapping with the
Mapping / unmapping pair.
Pre-Requisites
Before performing this task, you need to configure Tx/Rx connections at SMS-Hub.
Steps
Perform the following steps to configure relay profile for MIM:
1. Login to AppMsgidmap GUI.
2. Navigate to Message Id Mapper > Relay Profile. The existing entries are listed in
tabular form.
3. Click the Action button on the right, to view, edit, or delete an entry.
4. Click New to create a New entry.
5. Enter unique identifier for the relay in the Relay Id textbox. Use alphanumeric_name
so that message can be easily identified.
6. Mapping Relay is used to configure submit_sm path to external SMSC. The message id
of the message coming on this relay will be mapped to that of the response. It defines
both Incoming and outgoing Relay Connection Profile
7. Unmapping relay is used to configure the deliver_sm path from external SMSC to
SMS-Hub. The message id in the message coming on this relay will be replaced by the
one from the map. It defines both Incoming and outgoing Relay Connection Profile
Refer to the following table for field and its description for Mapping and Unmapping Realy
incoming and outgoing connection Profile:
Field Description
Field Description
Field Description
Expected Results
The entries are saved successfully and the confirmation message appears.
SDM Configuration
Session Data Manager (SDM) application allows temporary storage of any kind of data for
any stateless application which typically requires some storage for some time. Generally it
is seen that any application which is necessarily designed to be stateless requires some
information which it has processed in earlier execution cycle. To process in future it needs
the same old data, to cater the need of such scenario this (SDM) application is framed.
This stores any type of data for any time of storage. SDM has two proprietary interface
StoreSessionSubmit_sm() and RetrieveSessionDeliver_Sm() to processes the multi-part
messages in conjuction with SCL Voice.
Task
To search for Multipart Session Data.
Context
SCL Voice supports multipart messages and is charged as one. Multipart Session Data
Search is used to search all session information related to one multi part messasge.This
search is either on the SAR_REF_ID (parent entry) or on the MSG_ID (child entry) basis.
Searching Multipart Session Data has the facility of matching and retrieving partial strings.
Say for example if you provide a session id like “B” the search will search for all session id
that start with B and provide the results. Its parameters are logically defined, so a logical
search goes about searching in the database (DB) as Session ID, App ID and validity period.
This also has special feature of DELETE ALL, this means that If the search returns a list of
the session ids the delete all button deletes all of them at the same time.
Pre-Requisites
Before performing this task, you need check for database connection that is, the database
connection should be UP.
Steps
Perform the following steps to search multipart session data:
1. Login AppSessiondatamanager GUI.
2. Navigate to Session Data Manager > Multipart Session Data search. The following
screen appears:
3. Select the radio button to search Multipart Session stored from Selection field. Search
can be done using either MessageID or SarRefID. If you select SAR_REF_ID radio
button, then SDM displays the master entry associated and if you select the MSG_ID
radio button, then SDM displays the child entry.
4. Enter the value for the selected criteria in the Parameter textbox.
5. Enter the duration in yyMMddHHmmss format up to which multipart session data
search is considered to be valid in the Session Validity textbox. All data valid up to this
time stamp is selected. Blank is used to ignore the field during search.
6. Enter the maximum records to be displayed for a successful search in the Search Limit
textbox.
7. Click Search, this displays the Search Data of the Multipart Session as:
- SAR REF ID- The SAR REF ID of the multipart record returned as search result.
- Message ID-The message ID of the record returned as search result.
- Session Validity-The time stamp until which this record is valid in the database.
- Fragment Timestamp-The unique timestamp for all fragments of the same
multipart message.
- Message Count-The number of outstanding messages for this multipart message.
Outstanding implies those fragments which have a pending acknowledgement.
- Session Data-The Session Data of the record returned as search result. This field is
hidden from view because of size constraints. The Session data can be a typically
large object of generic type, so this field is not displayed. The first three fields are
enough to precisely locate a session data.
Expected Results
The required entries of Multipart Session Data is searched.
Task
To search for Session Data entries.
Context
Session Data Search helps to search and manually delete expired sessions. This is used to
just search, and delete a particular session or search and delete all expired messages.
Searching Session Data has the facility of matching and retrieving partial strings. Say for
example if you provide a session id like “B” the search will search for all session id that
start with B and provide the results.Its parameters are logically defined, so a logical search
goes about searching in the DB as Session ID, App ID and validity period. This also has
special feature of DELETE ALL, this means that If the search returns a list of the session ids
the delete all button deletes all of them at the same time.
Pre-Requisites
Before performing this task, you need check for database connection that is, the database
connection should be UP.
Steps
1. Login AppSessiondatamanager GUI.
2. Navigate to Session Data Manager> Session Data search, the following screen
appears:
3. Enter unique identifier of the session that acts as a key to search entries in Database in
the Session ID textbox.
4. Enter the unique identifier of the application that calls the interface in the Application
ID textbox.
5. Enter the duration in yyMMddHHmmss format up to which session data search is
considered to be valid in the Session Validity textbox. All data valid UPTO this time
stamp is selected. Blank is used to ignore the field during search.
6. Enter the maximum records to be displayed for a successful search in the Search Limit
textbox.
7. Click Search.
Expected Results
The Search Data is displayed.
Xover Configuration
X-Over Module is designed to route messages between similar connection type, routing
between ESMEs and between SMSCs. X-over converts the Submit_sm to Deliver_sm and
vice versa to ensure smoother communication between ESME and SMSC.
Task
To configure X-Over Settings.
Context
The X-Over extends the functionality of the SMS-Hub by enabling routing between ESMEs
and between SMSCs.
Pre-Requisites
None.
Steps
Perform the following steps to configure X-over settings:
1. Login to AppSmshubXover GUI.
2. Navigate to General Configuration > X-over Configuration. The following screen
appears:
3. Enter the format of the Phase 1 delivery report message in the Phase 1 Delivery
Report Template textbox. This message is used on successful delivery of messages.
Expected Results
The entries are saved successfully and the confirmation message appears.
Term Description
Term Description
Term Description
IN Intelligent Network
MO Mobile Originated
Term Description
Term Description