Professional Documents
Culture Documents
TS - VMS LRD v1.0 Draft 20140103
TS - VMS LRD v1.0 Draft 20140103
THE INFORMATION CONTAINED HEREIN IS NON-BINDING AND PROVIDED FOR BUDGETARY PURPOSES ONLY.
NOTWITHSTANDING ANYTHING IN THE RFP (IF APPLICABLE) TO THE CONTRARY, THE FINAL TERMS AND CONDITIONS
GOVERNING THE ACTUAL SERVICES AND PRODUCTS TO BE PROVIDED, AS WELL AS THE RIGHTS AND OBLIGATIONS OF THE
PARTIES, SHALL BE COVERED BY A SEPARATE AND DISTINCT AGREEMENT TO BE NEGOTIATED BY THE PARTIES. NOTHING
HEREIN SHOULD BE CONSTRUED AS OBLIGATING EITHER PARTY TO THE OTHER FOR ANY PURPOSE WHATSOEVER.
THE PROVISION OF ANY NETWORK ELEMENTS, COMPONENTS AND/OR SERVICES DEFINED IN THIS PROPOSAL, IS SUBJECT TO
ALL APPLICABLE FEDERAL, STATE, AND LOCAL LAWS, STATUTES, RULES, AND REGULATIONS.
INFORMATION CONTAINED IN THIS PROPOSAL, INCLUDING BUT NOT LIMITED TO PRICING AND EXCLUDING HARDWARE
CONFIGURATION (IF APPLICABLE), IS VALID FOR NINETY (90) DAYS FROM THE DATE SET FORTH ON THE FRONT OF THIS
PROPOSAL.
The following are services, software products, service marks, and/or trademarks of Syniverse Technologies,
Inc.:
® SM
ACCESS inpack
® ®
ACCESS S&E INPort
® SM
ACCESSibility INPosition
® SM
Brience LATALink
SM ®
CCNS Phone Me Anywhere Plus
SM ®
Crossroads PMA Plus
SM ®
EDT RoamerXchange
SM ®
Electronic Data Transport SmartChallenge
® ®
Encrypt-A-Key SOLUTIONS
SM ®
Fleet-On-Track Solutions Without Limits
® TM
FMR Plus S.T.A.R.S. STREAMLINER
® ®
Follow Me Roaming Plus S.T.A.R.S. STREAMLINER Terminal Access Reporting System
® ®
FraudChallenger STREAMLINER
® SM
FraudForce Syniverse
®
FraudInterceptor Syniverse logo
®
FraudManager Syniverse Spark design
SM SM
Fraud Resource Center Syniverse Connections
® SM
FraudX UniRoam
®
InForum Visibility
® SM
INLink Whatever It Takes
All other companies’ marks and names are the trademarks or service marks of the respective company.
DOCUMENT CONTROL
MODIFICATION HISTORY
2
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Contents
1. Introduction..................................................................................................................... 1
2. Related Document ........................................................................................................... 1
3. Abbreviation .................................................................................................................... 1
4. Function Summary ........................................................................................................... 2
5. Hardware specifications ................................................................................................... 3
6. OS.................................................................................................................................... 4
7. Resilience ........................................................................................................................ 4
8. Performance and sizing capacity ...................................................................................... 4
9. Device detection .............................................................................................................. 4
9.1 ADC QUERY-SUBSCRIBER-HANDSET API ...................................................................................................4
3
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
4
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
5
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
6
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
7
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
1. Introduction
This document is the technical specification for VMS Local roaming data, LRD, system.
2. Related Document
SVR-VMS-LRD-SoW 1.10.pdf
3. Abbreviation
Throughout the document, the following abbreviations may be used:
Term Description
LRD Local roaming data
1
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
4. Function Summary
Item Feature
LRD Core
1.1 XML/HTTP Provisioning API
LRD subscription
LRD unsubscription
LRD subscription query
LRD subscription renewal
Change language
Registration page cancel
1.2 SMS Notification
LRD subscription SMS
LRD unsubscription SMS
LRD service activation SMS
LRD service inactivation SMS
1.3 WSM
WSM SMS
WSM Reminder SMS
1.4 Probe TDR Collation and handling
LU and ISD collation and handling
CL and out-of-network detection and handling
GTM
2.1 Bill shock safeguard
2.2 Registration page redirection and opt-out
LRD Console
3.1 Profile management
3.2 Single Virtual MSISDN, multiple IMSI
3.3 Virtual MSISDN management
3.4 WSM Blacklist/whitelist management
3.5 WSM Dispatch Windows
3.6 SMS Template
3.7 SMS Language management
3.8 Operator APN blacklist
3.9 Operator IMSI blacklist/whitelist (MCC+MNC)
3.10 Reports
- USSD Usage reports (Hourly, Daily, Monthly)
- USSD Transaction (Hourly, Daily, Monthly)
- LRD Activity Summary (Hourly, Daily, Monthly)
- LRD Status Snapshot
- SMS Notification (Hourly, Daily, Monthly)
- LRD Subscriber Snapshot
- Tcap Activity (Hourly, Daily, Monthly)
3.11 Global Parameter Configuration
2
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
USSD EA
4.1 LRD subscription
LRD unsubscription
LRD subscription query
LRD subscription renewal
Change language
5. Hardware specifications
Hardware Qty
1 Database Server 2
HP DL380p Gen8 8-SFF CTO Server 1
HP DL380p Gen8 E5-2609 FIO Kit 1
HP DL380p Gen8 E5-2609 Kit 1
HP 4GB 1Rx4 PC3L-10600R-9 Kit 9
HP 300GB 6G SAS 10K 2.5in SC ENT HDD 4
HP 12.7mm SATA DVD ROM Jb Kit 1
HP Ethernet 1GbE 4P 331FLR FIO Adptr 1
HP Rdnt 2m,10A,C13-C14 Jmpr Cord 2
HP 512MB FBWC for P-Series Smart Array 1
HP Ethernet 1Gb 2P 361T Adptr 1
HP 2U SFF BB Rail Gen8 Kit 1
HP 82E 8Gb Dual-port PCI-e FC HBA 2
HP 460W CS Plat PL Ht Plg Pwr Supply Kit 2
2 LRD - Application Server 2
HP DL380p Gen8 8-SFF CTO Server 1
HP DL380p Gen8 E5-2609 FIO Kit 1
HP DL380p Gen8 E5-2609 Kit 1
HP 4GB 1Rx4 PC3L-10600R-9 Kit 9
HP 300GB 6G SAS 10K 2.5in SC ENT HDD 4
HP 12.7mm SATA DVD ROM Jb Kit 1
HP Ethernet 1GbE 4P 331FLR FIO Adptr 1
HP Rdnt 2m,10A,C13-C14 Jmpr Cord 2
HP 512MB FBWC for P-Series Smart Array 1
HP Ethernet 1Gb 2P 361T Adptr 1
HP 2U SFF BB Rail Gen8 Kit 1
HP 460W CS Plat PL Ht Plg Pwr Supply Kit 2
3 External Storage P2000 1
HP P2000 G3 MSA FC Dual Cntrl LFF Array 1
3
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
6. OS
Application servers
RedHat Linux Enterprise with High Availability option
Database servers
RedHat Linux Enterprise with High Availability & Resilience option
7. Resilience
Servers Quantity Configuration
Application Server 2 Active-Standby
Database Server 2 Active-Standby and resilience storage
External Storage 1 Active
Switch 2 Active-Active
9. Device detection
Device types are categorized into the following types:
1. CS-only
2. PS-only
3. CS and PS
ADC system is a system currently available at VMS. The device name to device type mappings are managed in the LRD
local database.
4
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
9.1.4 Examples
Query:
<action type="QUERY-SUBSCRIBER-HANDSET">
<parm name="MSISDN" value="+337921688881" />
</action>
Response:
<response>
<result code="200" desc="OK">
<record>
<parm name="MSISDN" value="+337921688881" />
<parm name="IMSI" value="123456789012345" />
<parm name="IMEI" value="123456789012345" />
<parm name="BRANDNAME" value="Nokia" />
<parm name="MODELNAME" value="E71" />
</record>
</result>
</response>
5
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
10. IN integration
LRD platform integrates with VMS IN system through a telnet MML API.
subscribe() Update
- IMSI
- VMSISDN
- Credits b/f
Upon service subscription, LRD platform will update VMS IN with the following details of the subscriber
o IMSI
o VMSISDN
o Credit b/f (remaining credits from the previous visit)
Credit b/f, are stored in the VMS local database after subscribers un-subscribe the service along with their
home MSISDN as well as IMSI.
Credit b/f, are retrieved based on the subscribed home MSISDN.
For new subscribers, the credit b/f are zero.
MML command:
Change IMSI
MODACNT,MSISDN=<msisdn>, IMSI=<imsi>;
Change CREDIT
MODACNT,MSISDN=<msisdn>, CREDIT=<credit>;
Activate Account
6
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
MODACNT,MSISDN=<msisdn>, A_CURSTA=ACTIF;
Example:
request 1:
modacnt,msisdn=904674791,imsi=452010162941818;
response 1:
ACCOUNT NUMBER UPDATED;
request 2:
modacnt,msisdn=904674791,credit=0;
response 2:
ACCOUNT NUMBER UPDATED;
request 3:
modacnt,msisdn=904674791, A_CURSTA=ACTIF;
response 3:
ACCOUNT NUMBER UPDATED;
unsubscribe()
Update
- VMSISDN
Credits c/f
MML command:
Change IMSI
MODACNT,MSISDN=<msisdn>, IMSI=<imsi>;
7
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Example:
request 1
modacnt,msisdn=904674791,imsi=@;
response 1
ACCOUNT NUMBER UPDATED;
request 2
disacnt,msisdn=904674791;
response 2
MSISDN=936177889,IMSI=452010101616424,<OMITTED>,CREDIT=3634290,<OMITTED>;
Service expired
(e.g. 30 days)
Update
- VMSISDN
Credits c/f
8
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
XML/HTTP :8000
SMPP :5018
GRX
Database Server
GTP-C :2123
MAP (e.g. ISD)
SGSN
Probe TDR
Collation Processor Tcap GW
Postgres
Message Queue NewNet
Storage
DB
datafiles
9
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
This flow applies to the case where it has the following attributes:
1. Not subscribed to LRD service
2. With data service
3. With roaming agreement with VMS
4. PS-only and PS+CS type devices
10
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Inbound roamer with data service and roaming agreement (Non-LRD user, PS-only and PS+CS type devices)
VMS Home
Terminal Tapping
VLR SGSN LRD Platform ADC GTM GGSN HLR GGSN
Device Probe
LU, ISD
Query
Figure 6 WSM flow for non-LRD subscribers (with data service and roaming agreement)
For non-LRD subscribers coming into VMS network for the first time, LRD platform will perform the following
actions based the device types:
o CS + PS devices
Welcome short message:
A welcome short message is sent to the device via the local SMSC.
For first time LU, for example, just arriving at the airport, the device will receive a
“First-time WSM”.
Other than the first time LU, the device will receive “Reminder WSM”
Override ISD: LRD platform will override ISD to the local SGSN with the following
parameters:
APN: “VMS registration page APN”
MSISDN: no change
GTM as the gatekeeper.
When overriding ISD does not succeed, GTM will modify PDP context creation
requests and redirect them to the local GGSN with the following parameters.
o APN: “VMS registration page APN”
o Destination IP: Local GGSN
o MSISDN: no change
o SGSN Addr: no change
11
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
When users access the internet, they will be redirected to the VMS registration
page by the local GGSN.
For subscription / registration page cancellation via the Web, please see
Subscription / Cancellation via Web
o PS Only devices
LRD platform will override ISD to the local SGSN with the following parameters:
APN: “VMS registration page APN”
MSISDN: no change
GTM as the gatekeeper. When overriding ISD does not succeed, GTM will redirect modify
PDP context creation requests and redirect them to the local GGSN with the following
parameters.
APN: “VMS registration page APN”
Destination IP: Local GGSN
MSISDN: no change
SGSN Addr: no change
When the users try to access the internet, they will be redirected to the VMS registration
page.
For subscription / registration page cancellation via the Web, please see Subscription /
Cancellation via Web
VMS Home
Terminal Tapping
VLR SGSN LRD Platform GTM HLR GGSN
Device Probe
Attach Request
LocationUpdate
ISD request
ISD response
LocationUpdate response
Attach Reject Without roaming
agreement, the
TDR device is detached as
soon as it receives an
Detached “Attach reject”
from VMS response from home.
network
This flow applies to the case where it has the following attributes:
1. Not subscribed to LRD service
2. With or without data service
3. Without roaming agreement with VMS
12
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
If the home operator of the user does not have a roaming agreement with VMS, the device will detach from
VMS network as soon as it receives an “attached reject” response from the home network, there is nothing LRD
platform can do to maintain connection with the device and therefore LRD service is unavailable to these users.
Non-LRD users (with data service and roaming agreement), CS only device type
LRD service is unavailable to CS only users.
Note: VMS’s MSC will assumedly intercept related LRD USSD commands entered by inbound roamers and send them
to the USSA EA on LRD platform.
Once a user has successfully subscribed to LRD service, VMS will send a confirmation SMS to the user stating he/she
has successfully subscribed to LRD service and the expiry date/time.
After a user has been subscribed to LRD service, the user will need to manually force the device to re-establish LU by
switching back and forth from flight mode to activate the service.
After the user has successfully re-established LU and activate the LRD service, LRD platform will send a service
activation SMS to notify the subscriber that the service is now activated and ready to use.
13
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Inbound roamer with data service and roaming agreement, LRD service USSD subscription flow
VMS Home
Terminal
VLR USSD GW LRD Platform IN SGSN GTM GGSN HLR GGSN
Device
Subscription accepted
Probe
Attach request LocationUpdate
PDU GTP-U
The following diagram describes how a non-LRD subscriber is directed to the LRD registration page after
LocationUpdate. After a user has reached to the LRD registration page, the user has two options.
1. Subscribe to LRD service
a. VMS should instruct the subscriber to switch between flight mode to activate LRD service, via the
VMS web portal or SMS.
b. Since VMS will send a subscription confirmation SMS to the subscriber, LRD platform will not send
another subscription SMS to the subscriber separately.
2. Choose “Cancel” on the registration page and allow the user’s roaming data routed back to home network
a. If the user chooses not to subscribe to LRD service, the user will need to click on a button, such as a
“Cancel” button the page.
b. VMS should call LRD’s XML API, cancelreg, so that LRD platform will send a CancelLocation to the
local SGSN to tear down the subscriber’s subscriber profile to enable them to roam back to the
home network, e.g. after the “Cancel” button has been pressed.
c. The same user will be opted-in for registration page redirection after a period of time. There is a
global parameter, “Registration page opt-out”, on the web console that can control when the user
can be opted-in again. Please see Parameter configurations.
14
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Inbound roamer with data service and roaming agreement (Non-LRD user, PS-only & CS+PS Devices, Web Registration / Cancellation)
VMS Home
activate
Activate PDP context
Redirected to VMS
Web Portal by the
Activate PDP context accept Create PDP Response Local GGSN
PDU GTP-U
Subscribe
Subscribe
The following diagram describes the flow how an inbound roamer subscribes to LRD service before landing in Vietnam.
Although from the user perspective, subscribing LRD service before landing in Vietnam or after are virtually identical.
For LRD platform, there are special logics that need to be taken care of.
Before subscribers land in Vietnam, LRD platform has no way to obtain the MSISDN as well as the IMSI of the
subscribers, therefore, when subscribing the service through the web, the handling for personal subscribers and
corporate subscribers are different.
For personal subscribers, they must provide their MSISDN to LRD platform at service subscription. At this point, LRD
platform will subscribe the users only by their MSISDN and a virtual MSISDN is assigned to them from a pool of virtual
MSISDN accordingly. Whereas, the IMSI of these subscribers are obtained after they have landed in Vietnam, that is,
after they have established LU and ISD in VMS’s network and the tapping probe subsequently provides the MSISDN as
well as IMSI of the subscribers to LRD platform.
15
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
After the MSISDN as well as the IMSI of the subscribers are successfully obtained by LRD platform, overriding ISDs will
then be able to be performed.
For corporate subscribers, the logic flow is different. Because of the “Single virtual MSISDN, multiple IMSI”, the IMSI of
the subscribers must be obtained at the time the users subscribe to the service, as a virtual MSSIDN must be assigned
at this point.
After the subscribers have landed in Vietnam, they will be able to use LRD service without any further registration.
LRD service Subscription through Web before landing in VN (Non-LRD user, Web Registration)
VMS Home
1. No IMSI recorded
Personal User
1. IMSI is recorded
Subscribe Subscribe(MSISDN, IMSI) 2. a virtual MSISDN
is already assigned.
User must provide:
- MSISDN &
- IMSI
Subscribers land in VN
Terminal
Device
PDU GTP-U
16
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Once a user unsubscribes LRD service, a SMS will be sent to the user to confirm that the service has been
unsubscribed successfully. Followed by the confirmation SMS, a CancelLocation will be sent to SGSN to reset the
user’s PDP context so that the data traffic will go back to home network from then on.
Inbound roamer with data service and roaming agreement, LRD service USSD unsubscription flow
VMS Home
deactivate
Unsubscription accept
Activate PDP context Create PDP context request Create PDP context request
Activate PDP context accept Create PDP context Response
PDU GTP-U
The following diagram describes the flows for LRD service subscribers on the events of LU.
17
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
VMS Home
Terminal
VLR SGSN GGSN Tapping Probe LRD Platform GTM HLR GGSN
Device
Attach Request
LocationUpdate
ISD request
ISD response
LocationUpdate response
Attach accept
TDR
Business logic
ISD
GTP-U
Activate PDP context accept Create PDP request (change packet header)
Create PDP Response Create PDP Response
GTP-U
18
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
VMS Home
Terminal
VLR SGSN GGSN Tapping Probe LRD Platform GTM HLR GGSN
Device
Attach Request
LocationUpdate
ISD request
ISD response
LocationUpdate response
Attach accept
TDR
Business logic
ISD
GTP-U
Activate PDP context accept Create PDP request (change packet header)
Create PDP Response Create PDP Response
GTP-U
The following diagram describes the flows for LRD service subscribers on the events of CL.
VMS Home
Terminal
VLR SGSN Tapping Probe LRD Platform GTM GGSN HLR GGSN
Device
CancelLocation
CL
Cancel Location
19
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
13. GTM
13.1 System Network Connectivity
The following diagram illustrates the network configuration of the deployment at VMS:
VMS Home
Network GGSN Network
GTM will be deployed to operate on GTP-C only and as a layer-3 gateway in the ISO/OSI network model. In this mode,
GTM is assigned with an IP address. GTP packets are routed in and out GTM via ‘next-hop’ configurations. The
following diagram illustrates the network connectivity.
GTM server’s route table must be configured to route outgoing GTP packets to the correct ‘next-hop’.
172.16.101.128 192.168.154.128
172.16.101.1
192.168.154.129
GTM
(active)
VRRP
Virtual server Virtual server
SGSN GGSN
172.16.101.10 192.168.154.10
GTM
(standby)
172.16.101.130 192.168.154.130
Figure 14. GTM layer-3 deployment with VRRP topology
20
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
In normal operation, the active GTM takes the virtual IP address of the virtual servers. When the active GTM fails, the
standby GTM automatically takes up the virtual IP address of the virtual servers. Both SGSN and GGSN does not need
to reconfigure its network routes.
No
No
Route Route
CreatePDPContext CreatePDPContext
request to next hop, request to next hop,
(GRX) (VGGSN)
end
21
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
14. USSD EA
It communicates with USSD Gateway by using SMPP over TCP/IP and allows communicating with LRD core using
RESTful XML/HTTP API
1. Subscribe
2. Unsubscribe
3. Subscription Query
4. Change Language
1. English
2. Chinese
3. Spanish
4. Japanese
5. Portuguese
6. German
7. Arabic
8. French
9. Russian
10. Korean
22
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
USSD EA Core
14.4 Logs
The following logging files will be generated by the system
14.4.1 System log
System log will be provided for application healthiness.
Logging Level Logging Level e.g. FATAL, WARN, 5 Regarding the severity on the issue
INFO, DEBUG
Detail log String variable Detail log on the issue required logging
message
Filename Description
SYSTEM.LOG Runtime logfile
23
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Where:
yyyymmdd = timestamp
Transaction Detail Record (TDR) will be rotated and backup daily with the following details:
24
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Date (YYYYMMDD)
Transaction ID Hexadecimal (left filled with ‘0’) 8 Internal Reference Transaction Number
Short Code Character (left justified) 3 Service code trigger by the mobile.
HLR Address String characters (left justified), 15 HLR Address (exist only in mobile initiated
three dashes if not exists USSD)
VLR Address String characters (left justified), 15 VLR Address (exist only in mobile initiated
three dashes if not exists USSD)
IMSI String characters (left justified), 15 IMSI (exist only in mobile initiated USSD)
three dashes if not exists
Menu Node ID String character (left justified) 20 Last Menu ID that the subscriber visited.
Menu Version String character (left justified) 4 Update Menu Tree version number
USSD Request Original user initiating string 30 Character (left justified), three dashes if not
String exists
Filename Description
IMENU_TDR.LOG Runtime logfile
IMENU_TDR.yyyymmdd Archived logfile
Where:
yyyymmdd = timestamp
25
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
20110718 11:52:27 20110718 11:52:28 PUSSR MO 00000009 999 003 92231447 12345601 12345601
123456789012345 1 21000 21001 12 00008005 *999#
26
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
API Transaction Detail Record (TDR) will be rotated and backup daily with the following details:
27
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Sequence String characters (left justified) 8 Sequence Number internal to API TDR
Number
Interface String characters (left justified) 10 Interface name defined in iMenu, e.g. HTTP
Name
Command String characters (left justified) 20 Command name defined in iMenu, e.g.
Name rbt_charge
Filename Description
APICONVERTER_TDR.LOG Runtime logfile
APICONVERTER_TDR.yyyymmdd Archived logfile
Where:
yyyymmdd = timestamp
20110729 17:18:02 20110729 17:18:02 20110729 17:18:02 92231447 0002 0003 00000005 HTTP
charge 00000000
WADL: WADL
XSD: XSD
Service subscription
28
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Request
Input Parameter Name Format Remarks
msisdn String Mandatory
imsi String Optional
language String Optional
channel String Optional
Example Request:
POST /lrd/lrdservice/subscribe HTTP/1.1
Content-Type: application/x-www-form-urlencoded
User-Agent: Java/1.7.0_25
Host: 127.0.0.1:8080
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive
Content-Length: 65
msisdn=911624925096&language=en&imsi=460101234567890&channel=USSD
Example Response:
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 408
Date: Fri, 06 Sep 2013 03:40:54 GMT
Response
Output Parameter Name Format
subscriberProfile Optional. Exists only returnCode is 0
msisdn Original MSISDN of the user
imsi IMSI of the user
vmsisdn Virtual MSISDN assigned for LRD service.
status LRD service status of the user.
state LRD service state of the user.
subscribtionStartDate String (yyyy-MM-dd hh:mm:ss).
subscribtionEndDate String (yyyy-MM-dd hh:mm:ss).
language SMS Language, user defined on web console.
channel Subscription channel.
(USSD, WEB, UNKNOWN)
29
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Response example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lrdServiceResponse>
<subscriberProfile>
<imsi>54020152723596</imsi>
<msisdn>911624925096</msisdn>
<vmsisdn>911900000001</vmsisdn>
<state>SUBSCRIBED</state>
<status>ACTIVE</status>
<channel>USSD</channel>
<language>en_US</language>
<subscriptionStartDate>2013-08-09 05:04:12</subscriptionStartDate>
</subscriberProfile>
<returnCode>0</returnCode>
</lrdServiceResponse>
Service unsubscription
This web service function is used to unsubscribe user from LRD service.
Request
Parameter Name Format
msisdn String
Example Request:
POST /lrd/lrdservice/unsubscribe HTTP/1.1
Content-Type: application/x-www-form-urlencoded
User-Agent: Java/1.7.0_25
Host: 127.0.0.1:8080
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive
Content-Length: 20
msisdn=911624925096
Example Response:
HTTP/1.1 200 OK
30
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 472
Date: Fri, 06 Sep 2013 03:49:45 GMT
Response
Output Parameter Name Format
subscriberProfile Optional. Exists only returnCode is 0
msisdn Original MSISDN of the user
imsi IMSI of the user
vmsisdn Virtual MSISDN assigned for LRD service.
status LRD service status of the user.
state LRD service state of the user.
subscribtionStartDate String (yyyy-MM-dd hh:mm:ss).
subscribtionEndDate String (yyyy-MM-dd hh:mm:ss).
language SMS Language, user defined on web console.
channel Subscription channel.
(USSD, WEB, UNKNOWN)
return code Return Code Description
0 No error
1001 Invalid parameters
2001 User is blacklisted
2003 User has not subscribed to LRD service
Response example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lrdServiceResponse>
<subscriberProfile>
<imsi>54020152723596</imsi>
<msisdn>911624925096</msisdn>
<vmsisdn>911900000001</vmsisdn>
<state>UNSUBSCRIBED</state>
<status>INACTIVE</status>
<language>en_US</language>
<channel>USSD</channel>
<subscriptionStartDate>2013-08-09 05:04:12</subscriptionStartDate>
<subscriptionEndDate>2013-08-10 15:12:14</subscriptionEndDate>
</subscriberProfile>
<returnCode>0</returnCode>
</lrdServiceResponse>
31
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Request
Parameter Name Format
msisdn String
Example Request:
POST /lrd/lrdservice/renew HTTP/1.1
Content-Type: application/x-www-form-urlencoded
User-Agent: Java/1.7.0_25
Host: 127.0.0.1:8080
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive
Content-Length: 20
msisdn=911624925096
Example Response:
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 472
Date: Fri, 06 Sep 2013 03:49:45 GMT
Response
Output Parameter Name Format
subscriberProfile Optional. Exists only returnCode is 0
msisdn Original MSISDN of the user
imsi IMSI of the user
vmsisdn Virtual MSISDN assigned for LRD service.
status LRD service status of the user.
state LRD service state of the user.
subscribtionStartDate String (yyyy-MM-dd hh:mm:ss).
subscribtionEndDate String (yyyy-MM-dd hh:mm:ss).
language SMS Language, user defined on web console.
channel Subscription channel.
(USSD, WEB, UNKNOWN)
return code Return Code Description
0 No error
1001 Invalid parameters
32
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Response example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lrdServiceResponse>
<subscriberProfile>
<imsi>54020152723596</imsi>
<msisdn>911624925096</msisdn>
<vmsisdn>911900000001</vmsisdn>
<state>SUBSCRIBED</state>
<status>INACTIVE</status>
<language>en_US</language>
<channel>USSD</channel>
<subscriptionStartDate>2013-08-09 05:04:12</subscriptionStartDate>
<subscriptionEndDate>2013-08-10 15:12:14</subscriptionEndDate>
</subscriberProfile>
<returnCode>0</returnCode>
</lrdServiceResponse>
Subscription query
This web service function is used to retrieve LRD user profile information.
Request
Parameter Name Format
msisdn String
Example Request:
GET /lrd/lrdservice/query?msisdn=911624925096 HTTP/1.1
User-Agent: Java/1.7.0_25
Host: 127.0.0.1:8080
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive
Example Response:
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 408
Date: Fri, 06 Sep 2013 03:40:54 GMT
33
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
e><msisdn>911624925096</msisdn><state>SUBSCRIBED</state><status>ACTIVE</status><channel>USSD</channel>
<subscriptionStartDate>2013-09-06
11:40:54</subscriptionStartDate><vmsisdn>85291234560</vmsisdn></subscriberProfile><returnCode>0</returnCod
e></lrdServiceResponse>
Response example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lrdServiceResponse>
<subscriberProfile>
<imsi>54020152723596</imsi>
<msisdn>911624925096</msisdn>
<vmsisdn>911900000001</vmsisdn>
<state>UNSUBSCRIBED</state>
<status>INACTIVE</status>
<language>en_US</language>
<channel>USSD</channel>
<subscriptionStartDate>2013-08-09 05:04:12</subscriptionStartDate>
<subscriptionEndDate>2013-08-10 15:12:14</subscriptionEndDate>
</subscriberProfile>
<returnCode>0</returnCode>
</lrdServiceResponse>
Change language
This web service function is used to change preferred language in a LRD user profile.
34
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Request
Parameter Name Format
imsi String
language SMS Language, user defined on web console
Example:
POST /lrd/lrdservice/changelang HTTP/1.1
Content-Type: application/x-www-form-urlencoded
User-Agent: Java/1.7.0_25
Host: 127.0.0.1:8080
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive
Content-Length: 32
language=zh&msisdn=911624925096
Example Response:
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 408
Date: Fri, 06 Sep 2013 03:40:54 GMT
35
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
200 OK Request has been processed. Refer to returnCode for any error
occurred
403 NOT FOUND Wrong resource URL
405 Method Not Allowed Wrong HTTP method. “PUT” is expected
500 INTERNAL_SERVER_ERROR Request was unsuccessful. Internal server error occurred. Please try
again later.
Response example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lrdServiceResponse>
<subscriberProfile>
<imsi>54020152723596</imsi>
<msisdn>911624925096</msisdn>
<vmsisdn>911900000001</vmsisdn>
<state>SUBSCRIBED</state>
<status>ACTIVE</status>
<language>zh_TW</language>
<channel>USSD</channel>
<subscriptionStartDate>2013-08-09 05:04:12</subscriptionStartDate>
<subscriptionEndDate></subscriptionEndDate>
</subscriberProfile>
<returnCode>0</returnCode>
</lrdServiceResponse>
This web service function is used to stop LRD from redirecting user to the LRD service registration page.
Request
Parameter Name Format
msisdn String
Example Request:
POST /lrd/lrdservice/cancelreg HTTP/1.1
Content-Type: application/x-www-form-urlencoded
User-Agent: Java/1.7.0_25
Host: 127.0.0.1:8080
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive
Content-Length: 20
msisdn=911624925096
Example Response:
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 408
Date: Fri, 06 Sep 2013 03:40:54 GMT
36
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Subscription state
SUBSCRIBED
State
TERMINATED
UNSUBSCRIBED
Under the following provisioning event, a user state will be changed this state.
1. Subscribe
37
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
If a user is in the state of “TERMINATED”, upon the event of “Subscribe”, the state
will return to “SUBSCRIBED”.
TERMINATED Under the following provisioning events, a user state will be changed this state.
1. Unsubscribe
2. Service expired
The service duration can be configured on the web console. For the service
duration configuration, please see Parameter configurations.
UNSUBSCRIBED This is the final state of a subscriber.
Under the following provisioning event, a user state will be changed this state.
1. Purge
After a period of “terminated cool-down” time counted based on the subscription
end date of subscriber profile, a selected group of terminated subscribers is purged
automatically and their states are set to this state. For the “terminated cool-down”
configuration, please see Parameter configurations.
Service subscription
Service subscription can be done via USSA and Web.
38
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Service unsubscription
Terminate LRD
service and saved in
DB
end
39
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Subscription query
Parameter
LRD service not yet valid?
subscribed error
end
Change language
Parameter
LRD service not yet valid?
subscribed error
Yes
end
40
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Subscription renewal
This is designed to be called by VMS when LRD
subscribers renew subscription by, for example, VMS
topping up the account.
LRD Service
1. Validations: Subscription
a) Check parameters, if missing parameters, reject Renewal
request.
b) Check MSISDN format, language code and region
code, if invalid, reject request. Check LRD
c) Check the user LRD service subscription. If not yet service
Not Exists Exists
subscribed, reject request. subscription
By MSISDN
2. Update subscription profile on database
3. end Parameter
LRD service not yet valid?
subscribed error
Yes
end
end
41
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Blacklisted?
No
Check DB for
Not Exists Exists
LRD subscription
No Send SMS to
notify user
Send WSM
end
42
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
CancelLocation
event
Yes Blacklisted
No
Check LRD
Not Exists service Exists
subscription
Send CL to local
SGSN
Send SMS to
warn user
end
LocationUpdate event
A LocationUpdate event is collated based on the following SOAP messages sent from the probe server. The
SOAP messages are corresponded using the “tid” in each SOAP message.
a) sendLU
b) sendISD
43
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
c) sendLU_gprs (TBC)
CancelLocation event
A CancelLocation event is collated based on the following SOAP messages sent from the probe server.
a) sendCL
b) sendLU
A sendCL alone message does not incur a CancelLocation event. Instead, a CancelLocation event incurs only
when there is no sendLU message occurs for the same IMSI within the next 3 seconds after a sendCL
message.
44
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="tid" type="s:string"></s:element>
<s:element minOccurs="1" maxOccurs="1" name="imsi" type="s:string"></s:element>
<s:element minOccurs="1" maxOccurs="1" name="cdpa" type="s:string"></s:element>
<s:element minOccurs="1" maxOccurs="1" name="cgpa" type="s:string"></s:element>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="sendISD">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="tid" type="s:string"></s:element>
<s:element minOccurs="1" maxOccurs="1" name="msisdn" type="s:string"></s:element>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="sendLUResponse">
<s:complexType>
<s:sequence>
<s:element name="response" nillable="true" type="tns:result"></s:element>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="sendCLResponse">
<s:complexType>
<s:sequence>
<s:element name="response" nillable="true" type="tns:result"></s:element>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="sendISDResponse">
<s:complexType>
<s:sequence>
<s:element name="response" nillable="true" type="tns:result"></s:element>
</s:sequence>
</s:complexType>
</s:element>
<s:complexType name="result">
<s:sequence>
<s:element minOccurs="1" name="responseCode" type="s:int"></s:element>
</s:sequence>
</s:complexType>
</s:schema>
</wsdl:types>
<wsdl:message name="sendLU">
<wsdl:part name="parameters" element="tns:sendLU"></wsdl:part>
</wsdl:message>
<wsdl:message name="sendLUResponse">
<wsdl:part name="parameters" element="tns:sendLUResponse"></wsdl:part>
</wsdl:message>
<wsdl:message name="sendCL">
<wsdl:part name="parameters" element="tns:sendCL"></wsdl:part>
</wsdl:message>
<wsdl:message name="sendCLResponse">
<wsdl:part name="parameters" element="tns:sendCLResponse"></wsdl:part>
</wsdl:message>
45
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
<wsdl:message name="sendISD">
<wsdl:part name="parameters" element="tns:sendISD"></wsdl:part>
</wsdl:message>
<wsdl:message name="sendISDResponse">
<wsdl:part name="parameters" element="tns:sendISDResponse"></wsdl:part>
</wsdl:message>
<wsdl:portType name="SOAP_MCA">
<wsdl:operation name="sendLU">
<wsdl:input message="tns:sendLU"></wsdl:input>
<wsdl:output message="tns:sendLUResponse"></wsdl:output>
</wsdl:operation>
<wsdl:operation name="sendCL">
<wsdl:input message="tns:sendCL"></wsdl:input>
<wsdl:output message="tns:sendCLResponse"></wsdl:output>
</wsdl:operation>
<wsdl:operation name="sendISD">
<wsdl:input message="tns:sendISD"></wsdl:input>
<wsdl:output message="tns:sendISDResponse"></wsdl:output>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="SOAP_MCA" type="tns:SOAP_MCA">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http"></soap:binding>
<wsdl:operation name="sendLU">
<soap:operation soapAction="" style="document"></soap:operation>
<wsdl:input>
<soap:body use="literal"></soap:body>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"></soap:body>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="sendCL">
<soap:operation soapAction="" style="document"></soap:operation>
<wsdl:input>
<soap:body use="literal"></soap:body>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"></soap:body>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="sendISD">
<soap:operation soapAction="" style="document"></soap:operation>
<wsdl:input>
<soap:body use="literal"></soap:body>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"></soap:body>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="SOAP_MCA">
<wsdl:port name="SOAP_MCA" binding="tns:SOAP_MCA">
<soap:address location="http://localhost:8823"></soap:address>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
46
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
TBC
47
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
16. TCAP GW
TCAP Gateway is a software module that acts as a gateway between SS7 network (e.g. HLR, VLR, MSC) and
client application on TCAP signals (e.g. MAP or INAP signals). It also acts as a middleware between our
applications and NewNet TCAP stack.
One of the main purposes of using TCAP Gateway is to handle all the transaction co-relation and
manipulate the TCAP messages, and so it can be used as a MAP Gateway or an INAP/CAP Gateway.
In this project, it is to transmit ISD (Insert Subscriber Info) message to SGSN.
TransactionInfo
Clent Application #1
TcapGatway
Clent Application #3
NewNet TCAP Layer
48
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
17. WSM
The following section describes the logic behind sending WSM to inbound roamers who has not yet
subscribed to LRD service.
The service flows that lead to triggering a WSM to inbound roamers is described in WSM flow.
Within Dispatch
Windows
Yes
Yes
Blacklisted
No
Exists in
WSM_RECORD?
Max WSM
Yes
reached?
Send new WSM No
No
Send reminder
WSM
Increase WSM
counter
end
49
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
04:00 to 04:59
05:00 to 05:59
06:00 to 06:59
07:00 to 07:59
08:00 to 08:59
09:00 to 09:59
10:00 to 10:59
11:00 to 11:59
12:00 to 12:59
13:00 to 13:59
14:00 to 14:59
15:00 to 15:59
16:00 to 16:59
17:00 to 17:59
18:00 to 18:59
19:00 to 19:59
20:00 to 20:59
21:00 to 21:59
22:00 to 22:59
23:00 to 23:59
MCC/MNC Blacklist
MC/MNC blacklist is used to prevent WSM from sending WSM messages to subscribers who are from
particular countries and/or operators.
IMSI Blacklist
IMSI blacklist is used to prevent WSM from sending WSM messages to subscribers whose IMSIs have
particular prefixes.
MSISDN Blacklist
MSISDN blacklist is used to present WSM from sending WSM messages to subscribers whose MSISDN have
particular prefix.
MCC/MNC Whitelist
MC/MNC whitelist is used to allow WSM to send WSM messages to subscribers who are from particular
countries and/or operators.
50
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
IMSI Whitelist
IMSI whitelist is used to allow WSM to send WSM messages to subscribers whose IMSIs have particular
prefixes.
MSISDN Whitelist
MSISDN whitelist is used to allow WSM to send WSM messages to subscribers whose MSISDNs have
particular prefixes.
51
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
52
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Login Main
USSD Usage
Report
Report
USSD Transaction
Report
Activity
Summary Report
Status Snapshot
Report
SMS Notification
Report
TCAP statistics
Report
Parameter
Configuration
Console
User
Management
User Group
User Role
Audit Trail
53
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Validation:
IMSI is alpha numeric, length must be between 14 and 15
MSISDN is alpha numeric, length must be between 3 and 19
54
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Different subscriber status is displayed in different color for the ease of users.
Subscriber status includes:
Active: currently using LRD service
In-active: currently not using LRD service
Subscriber state includes:
Subscribed
Unsubscribed
IMSI MSISDN Virtual SMS Status State Subscription Subscription
MSISDN language start date end date
55
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
56
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
57
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
58
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
For example:
99990001,99991000
99995001,99996000
…
d. A section for user to search if a range of virtual MSISDNs are “available” (not yet assigned
to any subscribers) or unavailable (already assigned to a subscriber). Such checking should
be done against the SUBSCRIBER_PROFILE table.
i. Searching only by “From” and omitting “To” is equivalent to searching a single
record.
ii. Limit the range to 100
iii. Results display in a datatable:
1. Virtual MSISDN
2. Availability (yes: {tick}, no: {cross}), displayed by image
3. IMSI
4. MISDN
5. Sub. Status
6. Sub. State
7. Sub. Start
8. Sub. End
1. This page allows console user to manage virtual MSISDN and IMSI mappings.
2. A section for searching. Search criteria include:
a. Virtual MSISDN
59
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
i. Searchable by prefix
ii. Will result in a list of matched virtual MSISDNs.
b. IMSI
i. Searchable by prefix
ii. Will result in a list of virtual MSISDN which contains the matched IMSIs.
3. Multiple IMSI could be map to a single virtual MSISDN. It allows user to add, modify or remove a
mapping and add or remove an IMSI from a mapping.
4. A list of MSISDN is displayed by default. Default list size is 20.
a. List size is selectable by “20, 50, 100”
b. Columns include
i. Virtual MSISDN
ii. # of IMSI
iii. Action buttons, (view, edit, delete)
5. When selecting a MSISDN, a list of IMSI is shown.
6. Mapping modification validations:
a. Adding a new IMSI to a Virtual MSISDN that has already been assigned to a subscriber is
allowed.
b. Editing or removing a Virtual MSISDN that has already been assigned to a subscriber is
prohibited.
c. Editing or removing an IMSI that is belonged to a current subscriber from a Virtual MSISDN
mapping is prohibited
7. Console user could input mapping entry individually or batch upload through a file.
File Format:
MSISDN1, IMSI11, IMSI12, IMSI13…
MSISDN2, IMSI21, IMSI22, IMSI23…
8. Exporting mapping record is also allowed. A file with above format will be exported.
60
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
3. SMS messages are stored and only delivered until an acceptable time windows become available.
61
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
62
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
63
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
64
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
65
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
66
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
b. Bulk insert, file import will replace all records. It is equivalent to “Delete” and then “Insert”.
csv file format:
84912340
84912341
i. Validation
1. Same validation as a)
2. If any record fails the above, rollback all whole operation and display error
c. {pen} image, for edit
i. Popup modal for edit
ii. Apply same validation checking as above
d. {cross} image for delete
i. Popup confirmation dialog
e. A button to download the list of data into a csv file
84912340
84912341
67
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
68
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
69
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
70
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
71
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
72
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Blacklist management
18.6.2 IMSI blacklist management
73
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
1. Same validation as a)
2. If any record fails the above, rollback all whole operation and display error
74
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
75
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
UserID GroupID
n 1
Belong User
Console User
To Group
GroupID
Group
Role
RoleID
n 1
User User
Right Has Role
ID RoleID
User
1. This page allows system administrators to manage user accounts.
2. It allows administrators to add, modify or remove user.
3. Details of user accounts are displayed.
4. User account could be suspend or re-active through user management page.
5. Individual user password could be modified.
6. When adding a user, the following attributes should be inputted:
a. User ID
b. Username
c. Password
d. User Status (Active or Inactive)
e. User Group
76
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
User Group
1. This page allows system administrators to manage user groups.
2. It allows administrators to view, add, modify or remove user group and add role to or remove role
from this user group.
3. Details of user groups and its roles are displayed.
4. When adding a group, the following attributes should be inputted:
a. Group ID
b. Group Name
User Role
1. This page allows system administrators to manage user roles.
77
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
2. It allows administrators to view, add, modify or remove roles. Modifying user rights of the role is
also allowed.
3. When adding a role, the following attributes should be inputted:
a. Role ID
b. Role Name
4. When a new role is added, all privilege is assumed to be “NONE”.
5. User right consists of page ID and access level. “Write” access right permits user to modify on that
page. “Read” only grant “read-only” right to that page. “None” means users are not able to view
that page.
78
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
a. VGGSN APN
b. Registration page APN
c. Registration page opt-out period (hours)
2. WSM
a. Maximum number of WSM allowed
b. Maximum number of WSM allowed period (days)
c. Cool down between WSM (minutes)
3. LRD Service
a. Service duration (days)
b. Terminated cool-down (days)
c. LU history period (days)
Database table schema: GLOBAL_PARAMETERS
18.10 Reporting
Different reports are separated by tabs
For all reports, the page should allow users to
o search by date range
o choose report type, (hourly, daily, monthly), be aware of begin time and end time formats
o downloadable to csv files
o display in datatable with pagination
Datasheet
Begin-time The beginning of record time of the statistics entry
End-time The end of record time of the statistics entry
Service Code 1 The number of occurrence of “Service Code 1” within the recorded time
Service Code 2 The number of occurrence of “Service Code 2” within the recorded time
Service Code 3 The number of occurrence of “Service Code 3” within the recorded time
Service Code 4 The number of occurrence of “Service Code 4” within the recorded time
Total The sum of the number of occurrences of all service code within the
79
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
recorded time
Daily
Begin- End-time Service Service Code 2 Service Code 3 Service Code 4 Total
time Code 1
2013-1-1 2013-1-2
2013-1-2 2013-1-3
Database table schema: DAILY_USSD_USAGE
Monthly
Begin- End-time Service Service Service Code 3 Service Code 4 Total
time Code 1 Code 2
2013-1-1 2013-1-31
2013-2-1 2013-2-28
Database table schema: MONTHLY_USSD_USAGE
Datasheet
Begin-time The beginning of record time of the statistics entry
End-time The end of record time of the statistics entry
Successful The number of successful request handling within the recorded time
Rejected The number of rejected request within the recorded time
80
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
- invalid IMSI
- invalid MSISDN
- or other business rule violations
Timeout or Failed The number of failed handling caused by internal errors within the
recorded time
Total The sum of the number of occurrences of the above within the
recorded time
Begin- End- Subscription Subscription Un- Un- Query Query Change Change Activation Activation Inactivation Inactivation
time time Success Failure subscripti subscrip Success Failure language language Success Failure Success Failure
on tion Success Failure
Success Failure
Datasheet
Begin-time The beginning of record time of the statistics entry
End-time The end of record time of the statistics entry
Subscription Success The number of successful subscriptions within the recorded time
Subscription Failure The number of unsuccessful subscriptions due to internal errors within
the recorded time
Un-subscription Success The number of successful un-subscriptions within the recorded time
Un-subscription Success The number of unsuccessful un-subscriptions due to internal errors
within the recorded time
Query Success The number of successful queries within the recorded time
81
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Query Failure The number of unsuccessful queries due to internal errors within the
recorded time
Change language success The number of successful language changes within the recorded time
Change language failure The number of unsuccessful language changes due to internal errors
within the recorded time
Activation success The number of successful service activations within the recorded time
Activation failure The number of unsuccessful service activations due to internal errors
within the recorded time
Inactivation Success The number of successful service inactivation within the recorded time
Inactivation Failure The number of successful service inactivation due to internal errors
within the recorded time
Datasheet
Date The time of the snapshot taken
Subscribed The number of users in state of “SUBSCRIBED”
Active The number of users in state of “SUBSCRIBED” and status of “ACTIVE”
Inactive The number of users in state of “SUBSCRIBED” and status of
“INACTIVE”
82
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Begin- End- Welcome Reminder Subscription SMS Unsubscription Activation SMS Inactivation Total
time time SMS SMS SMS SMS
Datasheet
Begin-time The beginning of record time of the statistics entry
End-time The end of record time of the statistics entry
Welcome SMS The number of initial WSM sent within the recorded time
Reminder SMS The number of reminder WSM sent within the recorded time
Subscription SMS The number of subscription SMS sent within the recorded time
Unsubscription SMS The number of unsubscription SMS sent within the recorded time
Activation SMS The number of activation SMS sent within the recorded time
Inactivation SMS The number of inactivation SMS sent within the recorded time
Total The sum of the number of occurrences of the above within the recorded time
83
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Datasheet
Begin-time The beginning of record time of the statistics entry
End-time The end of record time of the statistics entry
ISD Success The number of InsertSubscriberData successfully sent within the recorded time
ISD Failure The number of InsertSubscriberData failed to send within the recorded time
CL Success The number of CancelLocation successfully sent within the recorded time
CL Failure The number of CancelLocation fail to send within the recorded time
Total The sum of the number of occurrences of the above within the recorded time
84
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
Datasheet
IMSI IMSI of the subscriber
MSISDN MSISDN of the subscriber
Virtual MSISDN Virtual MSISDN of the subscriber
Status Current status of the subscriber
State Current state of the subscriber
Subscription start date Subscription start date of the subscriber
Subscription end date Subscription end date of the subscriber
Subscription channel Subscription channel of the subscriber
19. OAM
19.1 Alarms
LRD core alarms
85
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
GTM alarms
20. Appendix
20.1 Mobile Country Codes (MCC)
Code Country
001 Test networks
202 Greece
204 Netherlands
206 Belgium
208 France
212 Monaco
86
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
213 Andorra
214 Spain
216 Hungary
218 Bosnia and Herzegovina
219 Croatia
220 Serbia
222 Italy
225 Vatican City State
226 Romania
228 Czech Republic
230 Tschechien
231 Slovakia
232 Austria
234 United Kingdom
235 United Kingdom
238 Denmark
240 Sweden
242 Norway
244 Finland
246 Lithuania
247 Latvia
248 Estonia
250 Russian Federation
255 Ukraine
257 Belarus
259 Moldova
260 Poland
262 Germany
266 Gibraltar (UK)
268 Portugal
270 Luxembourg
272 Ireland
274 Iceland
276 Albania
278 Malta
280 Cyprus
282 Georgia
283 Armenia
284 Bulgaria
286 Turkey
288 Faroe Islands (Denmark)
290 Greenland (Denmark)
292 San Marino
293 Slovenia
294 Republic of Macedonia
295 Liechtenstein
297 Montenegro
87
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
302 Canada
308 Saint Pierre and Miquelon (France)
310 USA
311 USA
312 USA
313 USA
314 USA
315 USA
316 USA
330 Puerto Rico (US)
332 United States Virgin Islands (US)
334 Mexico
338 Jamaica
340 Guadeloupe (France)
340 Martinique (France)
342 Barbados
344 Antigua und Barbuda
346 Cayman Islands (UK)
348 British Virgin Islands (UK)
350 Bermuda (UK)
352 Grenada
354 Montserrat (UK)
356 St. Kitts and Nevis
358 St. Lucia
360 Saint Vincent and the Grenadines
362 Netherlands Antilles (Netherlands)
363 Aruba (Netherlands)
364 Bahamas
365 Anguilla
366 Dominica
368 Cuba
370 Dominican Republic
372 Haiti
374 Trinidad and Tobago
376 Turks and Caicos Islands (UK)
400 Azerbaijani Republic
401 Kazakhstan
402 Bhutan
404 India
405 India
410 Pakistan
412 Afghanistan
413 Sri Lanka
414 Myanmar
415 Lebanon
416 Jordan
417 Syria
88
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
418 Iraq
419 Kuwait
420 Saudi Arabia
421 Yemen
422 Oman
424 United Arab Emirates
425 Israel
426 Bahrein
427 Qatar
428 Mongolia
429 Nepal
430 United Arab Emirates
431 United Arab Emirates
432 Iran
434 Uzbekistan
436 Tajikistan
437 Kyrgyz Republic
438 Turkmenistan
440 Japan
441 Japan
450 Korea, South
452 Viet Nam
454 Hong Kong (PRC)
455 Macao (PRC)
456 Cambodia
457 Laos
460 China
461 China
466 Taiwan
467 Korea, North
470 Bangladesh
472 Maldives
502 Malaysia
505 Australia
510 Indonesia
514 East Timor
515 Philippines
520 Thailand
525 Singapore
528 Brunei
530 New Zealand
534 Northern Mariana Islands (US)
535 Guam (US)
536 Nauru
537 Papua New Guinea
539 Tonga
540 Solomon Islands
89
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
541 Vanuatu
542 Fiji
543 Wallis and Futuna (France)
544 American Samoa (US)
545 Kiribati
546 New Caledonia (France)
547 French Polynesia (France)
548 Cook Islands (NZ)
549 Samoa
550 Federated States of Micronesia
551 Marshall Islands
552 Palau
602 Egypt
603 Algeria
604 Morocco
605 Tunisia
606 Libya
607 Gambia
608 Senegal
609 Mauritania
610 Mali
611 Guinea
612 Côte d'Ivoire
613 Burkina Faso
614 Niger
615 Togolese Republic
616 Benin
617 Mauritius
618 Liberia
619 Sierra Leone
620 Ghana
621 Nigeria
622 Chad
623 Central African Republic
624 Cameroon
625 Cape Verde
626 São Tomé and Príncipe
627 Equatorial Guinea
628 Gabonese Republic
629 Republic of the Congo
630 Democratic Republic of the Congo
631 Angola
632 Guinea-Bissau
633 Seychelles
634 Sudan
635 Rwandese Republic
636 Ethiopia
90
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
637 Somalia
638 Djibouti
639 Kenya
640 Tanzania
641 Uganda
642 Burundi
643 Mozambique
645 Zambia
646 Madagascar
647 Réunion (France)
648 Zimbabwe
649 Namibia
650 Malawi
651 Lesotho
652 Botswana
653 Swaziland
654 Comoros
655 South Africa
657 Eritrea
702 Belize
704 Guatemala
706 El Salvador
708 Honduras
710 Nicaragua
712 Costa Rica
714 Panama
716 Peru
722 Argentina
724 Brazil
730 Chile
732 Colombia
734 Venezuela
736 Bolivia
738 Guyana
740 Ecuador
742 French Guiana (France)
744 Paraguay
746 Suriname
748 Uruguay
901 World-wide
91
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
SUBSCRIBER_PROFILE_HISTORY
Column Name Column Type Nullable Description
ID Long No Primary Key
IMSI String(20) No IMSI in the user profile of the user
MSISDN String(40) No MSISDN in the user profile of the user
VMSISDN String(40) No Virtual MSISDN assigned for LRD service
STATUS String(10) No Status of LRD service user profile
ACTIVE: Active
INACTIVE: Inactive
OUT_OF_CREDITS: Out of Credits
STATE String(10) No State of LRD service user profile
SUBSCRIBED: Subscribed
TERMINATED: Terminated
UNSUBSCRIBED: Unsubscribed
SUB_START_DATE Date No Subscription Start Date
SUB_END_DATE Date Yes Subscription End Date
SUB_CHANNEL String(10) No Subscription channel
USSD: USSD
WEB: Web
UNKNOWN: Unknown
92
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
PHONES
Column Name Column Type Nullable Description
URL String(80) No Primary Key
The URL of the handset device database
NAME String(255) No The brand name and model name of a device
PS Boolean No Package switch capability
CS Boolean No Circle switch capability
TMP_OPT_OUT
Column Name Column Type Nullable Description
MSISDN String(20) No Primary Key (composite)
MSISDN in the user profile of the user
OPT_OUT_TYPE String(20) No Primary Key (composite)
RP: Registration page APN redirection
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No Application module that creates this record
UPDATE_BY String No Application module that last updates this record
TMP_LU_HISTORY
Column Name Column Type Nullable Description
MSISDN String(40) No Primary Key
MSISDN captured in LU/ISD
IMSI String(20) No IMSI captured in LU/ISD
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No Application module that creates this record
UPDATE_BY String No Application module that last updates this record
LANGUAGE
Column Name Column Type Nullable Description
NAME String(20) No Primary Key
Identity of the language
DESCRIPTION String(80) No Description of the language
93
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
MCC_LANGUAGE_MAP
Column Name Column Type Nullable Description
MCC String(20) No Primary Key
FK: MCC.MCC
LANGUAGE String(20) No Identity of the language
FK: LANGUAGE.NAME
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No Application module that creates this record
UPDATE_BY String No Application module that last updates this record
MCC
Column Name Column Type Nullable Description
MCC String(10) No Primary Key (composite)
MCC
SMS_TEMPLATE
Column Name Column Type Nullable Description
ID Long No Primary Key (composite)
Identity of the record
TYPE String(20) No Primary Key (composite)
Type of the SMS template
WELCOME_SMS
REMINDER_SMS
SUB_SUCCESS_SMS
UNSUB_SUCCESS_SMS
ACTIVATION_SMS
INACTIVATION_SMS
LANGUAGE String(20) No Primary Key (composite)
Language of the SMS template
FK: LANGUAGE.NAME
BODY String(1024) No Content of the SMS body
CREATE_DATE Date No Date of creation of this record
94
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
VIRTUAL_MSISDN_POOL
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
RANGE_FROM String(40) No Virtual MSISDN range from
RANGE_TO String(40) No Virtual MSISDN range to
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
SVMMI_VIRTUAL_MSISDN
Column Name Column Type Nullable Description
VMSISDN String(40) No Primary Key
Virtual MSISDN
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
SVMMI_IMSI_MAPPING
Column Name Column Type Nullable Description
VMSISDN String(40) No Primary Key (composite)
Virtual MSISDN
FK: SVMMI_VIRTUAL_MSISDN.VMSISDN
IMSI String(20) No Primary Key (composite)
IMSI
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
WSM_DISPATCH_WINDOW
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
NAME String(40) No Name of the dispatch window
ALLOWED Boolean No WSM is allowed to send within the
window
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
95
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
TMP_WSM_DISPATCH
Column Name Column Type Nullable Description
IMSI String(20) No Primary Key
IMSI of the subscriber
MSISDN String(40) No MSISDN of the subscriber
LAST_SENT Date Yes Last WSM sent for the subscriber
COUNT Integer Yes Number of WSM sent for the subscriber
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
WSM_MCC_MNC_WHITELIST
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
MCC String(10) No MCC in IMSI
FK: MCC.MCC
MNC String(10) Yes MNC in IMSI
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
WSM_MSISDN_ WHITELIST
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
MSISDN_PREFIX String(40) No MSISDN Prefix
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
WSM_IMSI_ WHITELIST
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
IMSI_PREFIX String(20) No IMSI Prefix
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
96
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
WSM_MCC_MNC_BLACKLIST
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
MCC String(10) No MCC in IMSI
FK: MCC.MCC
MNC String(10) Yes MNC in IMSI
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
WSM_MSISDN_BLACKLIST
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
MSISDN_PREFIX String(40) No MSISDN Prefix
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
WSM_IMSI_BLACKLIST
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
IMSI_PREFIX String(20) No IMSI Prefix
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
OP_MCC_MNC _WHITELIST
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
MCC String(10) No MCC in IMSI
FK: MCC.MCC
MNC String(10) Yes MNC in IMSI
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
97
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
OP_APN _ WHITELIST
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
MCC_MNC String(20) NO MCC/MNC in IMSI
APN String(100) No APN
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
OP_MCC_MNC _BLACKLIST
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
MCC String(10) No MCC in IMSI
FK: MCC.MCC
MNC String(10) Yes MNC in IMSI
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
OP_APN _BLACKLIST
Column Name Column Type Nullable Description
ID Long No Primary Key
Identity of the record
MCC_MNC String(20) NO MCC/MNC in IMSI
APN String(100) No APN
CREATE_DATE Date No Date of creation of this record
UPDATE_DATE Date No Date of last modification of this record
CREATE_BY String No User name who creates this record
UPDATE_BY String No User name who last updates this record
GLOBAL_PARAMETER
Column Name Column Type Nullable Description
NAME String(100) No Primary Key
Global parameter names:
“REDIRECTION_VGGSN_APN”
“REDIRECTION_REGISTRATION_APN”
“REDIRECTION_TMPOPTOUT_PERIOD_DAY”
“WSM_MAX_SEND_COUNT“
“WSM_MAX_SEND_PERIOD_DAY”
“WSM_COOLDOWN_MIN”
“DEFAULT_LANGUAGE”
“TERMINATED_COOLDOWN_DAY”
“SERVICE_DURATION_DAY”
“LU_HISTORY_PERIOD_DAY”
98
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
HOURLY_USSD_USAGE
This table is populated by USSA EA
Column Name Column Type Nullable Description
BEGIN DATE No Primary Key
Begin datetime of the hour
END DATE No End datetime of the hour
SERVICE_CODE_1 Integer No Column name yet to be confirmed
SERVICE_CODE_2 Integer No Column name yet to be confirmed
SERVICE_CODE_3 Integer No Column name yet to be confirmed
SERVICE_CODE_4 Integer No Column name yet to be confirmed
TOTAL Integer No Sum of service code 1 to 4
DAILY_USSD_USAGE
This table is populated by a scheduled task that is triggered daily, EOD, by a scheduler
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the day
END_DT DATE No End datetime of the day
SERVICE_CODE_1 Integer No Column name yet to be confirmed
SERVICE_CODE_2 Integer No Column name yet to be confirmed
SERVICE_CODE_3 Integer No Column name yet to be confirmed
SERVICE_CODE_4 Integer No Column name yet to be confirmed
TOTAL Integer No Sum of service code 1 to 4
MONTHLY_USSD_USAGE
This table is populated by a scheduled task that is triggered monthly, EOM, by a scheduler
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the month
END_DT DATE No End datetime of the month
SERVICE_CODE_1 Integer No Column name yet to be confirmed
SERVICE_CODE_2 Integer No Column name yet to be confirmed
SERVICE_CODE_3 Integer No Column name yet to be confirmed
SERVICE_CODE_4 Integer No Column name yet to be confirmed
TOTAL Integer No Sum of service code 1 to 4
HOURLY_USSD_TRANSACTION
This table is populated by USSA EA
Column Name Column Type Nullable Description
BEGIN DATE No Primary Key
99
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
DAILY_USSD_ TRANSACTION
This table is populated by a scheduled task that is triggered daily, EOD, by a scheduler
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the day
END_DT DATE No End datetime of the day
SUCCESSFUL Integer No Column name yet to be confirmed
REJECTED Integer No Column name yet to be confirmed
TIMEOUT_OR_FAILED Integer No Column name yet to be confirmed
TOTAL Integer No Sum of SUCCESSFUL, REJECTED and
TIMEOUT_OT_FAILED
MONTHLY_USSD_ TRANSACTION
This table is populated by a scheduled task that is triggered monthly, EOM, by a scheduler
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the month
END_DT DATE No End datetime of the month
SUCCESSFUL Integer No Column name yet to be confirmed
REJECTED Integer No Column name yet to be confirmed
TIMEOUT_OR_FAILED Integer No Column name yet to be confirmed
TOTAL Integer No Sum of SUCCESSFUL, REJECTED and
TIMEOUT_OT_FAILED
HOURLY_LRD_ACTIVITY
This table is populated by LRD core
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the hour
END_DT DATE No End datetime of the hour
SUBSCRIPTION_SUCCESS Integer No Number of successful subscription
SUBSCRIPTION_FAILURE Integer No Number of failed subscription
UNSUBSCRIPTION_SUCCESS Integer No Number of successful unsubscription
UNSUBSCRIPTION_FAILURE Integer No Number of failed unsubscription
QUERY_SUCCESS Integer No Number of successful query
QUERY _FAILURE Integer No Number of failed query
CHANGE_LANGUAGE_SUCCESS Integer No Number of successful language change
CHANGE_LANGUAGE _FAILURE Integer No Number of failed language change
100
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
DAILY_LRD_ACTIVITY
This table is populated by a scheduled task that is triggered daily, EOD, by a scheduler
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the day
END_DT DATE No End datetime of the day
SUBSCRIPTION_SUCCESS Integer No Number of successful subscription
SUBSCRIPTION_FAILURE Integer No Number of failed subscription
UNSUBSCRIPTION_SUCCESS Integer No Number of successful unsubscription
UNSUBSCRIPTION_FAILURE Integer No Number of failed unsubscription
QUERY_SUCCESS Integer No Number of successful query
QUERY _FAILURE Integer No Number of failed query
CHANGE_LANGUAGE_SUCCESS Integer No Number of successful language change
CHANGE_LANGUAGE _FAILURE Integer No Number of failed language change
ACTIVATION_SUCCESS Integer No Number of successful activation
ACTIVATION _FAILURE Integer No Number of failed activation
INACTIVATION_SUCCESS Integer No Number of successful inactivation
INACTIVATION _FAILURE Integer No Number of failed inactivation
TOTAL Integer No Sum of all
MONTHLY_LRD_ACTIVITY
This table is populated by a scheduled task that is triggered monthly, EOM, by a scheduler
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the month
END_DT DATE No End datetime of the month
SUBSCRIPTION_SUCCESS Integer No Number of successful subscription
SUBSCRIPTION_FAILURE Integer No Number of failed subscription
UNSUBSCRIPTION_SUCCESS Integer No Number of successful unsubscription
UNSUBSCRIPTION_FAILURE Integer No Number of failed unsubscription
QUERY_SUCCESS Integer No Number of successful query
QUERY _FAILURE Integer No Number of failed query
CHANGE_LANGUAGE_SUCCESS Integer No Number of successful language change
CHANGE_LANGUAGE _FAILURE Integer No Number of failed language change
ACTIVATION_SUCCESS Integer No Number of successful activation
ACTIVATION _FAILURE Integer No Number of failed activation
INACTIVATION_SUCCESS Integer No Number of successful inactivation
INACTIVATION _FAILURE Integer No Number of failed inactivation
TOTAL Integer No Sum of all
101
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
HOURLY_LRD_STATUS_SNAPSHOT
This table is populated by a scheduled task that is triggered hourly by a scheduler
Column Name Column Type Nullable Description
DATE_DT DATE No Primary Key
Beginning of every hour
SUBSCRIBED Integer No Number of user subscribed to LRD
service
ACTIVE Integer No Number of active subscribers
INACTIVE Integer No Number of inactive subscribers
HOURLY_SMS_NOTIFICATION
This table is populated by LRD core
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the hour
END_DT DATE No End datetime of the hour
WELCOME_SMS Integer No Number of welcome SMS sent
REMINDER_SMS Integer No Number of reminder SMS sent
SUBSCRIPTION_ SMS Integer No Number of subscription SMS sent
UNSUBSCRIPTION_ SMS Integer No Number of unsubscription SMS sent
ACTIVATION_ SMS Integer No Number of activation SMS sent
INACTIVATION_ SMS Integer No Number of inactivation SMS sent
TOTAL Integer No Sum of all
DAILY_SMS_NOTIFICATION
This table is populated by a scheduled task that is triggered daily, EOD, a scheduler
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the day
END_DT DATE No End datetime of the day
WELCOME_SMS Integer No Number of welcome SMS sent
SUBSCRIPTION_ SMS Integer No Number of subscription SMS sent
UNSUBSCRIPTION_ SMS Integer No Number of unsubscription SMS sent
ACTIVATION_ SMS Integer No Number of activation SMS sent
INACTIVATION_ SMS Integer No Number of inactivation SMS sent
TOTAL Integer No Sum of all
MONTHLY_SMS_NOTIFICATION
This table is populated by a scheduled task that is triggered monthly, EOM, by a scheduler
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the month
END_DT DATE No End datetime of the month
WELCOME_SMS Integer No Number of welcome SMS sent
SUBSCRIPTION_ SMS Integer No Number of subscription SMS sent
UNSUBSCRIPTION_ SMS Integer No Number of unsubscription SMS sent
102
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
HOURLY_TCAP_STATISTICS
This table is populated by LRD core
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the hour
END_DT DATE No End datetime of the hour
ISD_SUCCESS Integer No Number of ISD successfully sent
ISD_FAILURE Integer No Number of ISD failed to send
CL_SUCCESS Integer No Number of CL successfully sent
CL_FAILURE Integer No Number of CL failed to send
TOTAL Integer No Sum of all
DAILY_ TCAP_STATISTICS
This table is populated by a scheduled task that is triggered daily, EOD, a scheduler
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the day
END_DT DATE No End datetime of the day
ISD_SUCCESS Integer No Number of ISD successfully sent
ISD_FAILURE Integer No Number of ISD failed to send
CL_SUCCESS Integer No Number of CL successfully sent
CL_FAILURE Integer No Number of CL failed to send
TOTAL Integer No Sum of all
MONTHLY_ TCAP_STATISTICS
This table is populated by a scheduled task that is triggered monthly, EOM, by a scheduler
Column Name Column Type Nullable Description
BEGIN_DT DATE No Primary Key
Begin datetime of the month
END_DT DATE No End datetime of the month
ISD_SUCCESS Integer No Number of ISD successfully sent
ISD_FAILURE Integer No Number of ISD failed to send
CL_SUCCESS Integer No Number of CL successfully sent
CL_FAILURE Integer No Number of CL failed to send
TOTAL Integer No Sum of all
GTM_ACTIVITY_LOG
This table is populated by data collector at the end of the day by parsing daily rolling TDR files from GTM.
Data mappings:
103
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
MSISDN {Pre-MSISDN}
VMSISDN {Post-MSISDN}
IMSI {IMSI}
PRE_APN {Pre-APN}
POST_APN {Post-APN }
PRE_DEST_IP {Pre-Dst-IP-Addr}
POST_DEST_IP {Post-Dst-IP-Addr}
ACTION {Action-Id}
ACTIVITY_LOGS
This table is populated by Data collector
GTM
Activity logs from GTM are populated by the following logics
Action-Id is not “0”
Data mappings:
Tengine
TBC
104
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
20.3 XML/HTTP
WADL
<application xmlns="http://wadl.dev.java.net/2009/02">
<resources base="http://localhost:8080/lrd/lrdservice/">
<resource path="">
<resource path="/query">
<method id="query" name="GET">
<request>
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="msisdn"
style="query" type="xs:string" />
</request>
<response>
<representation mediaType="application/xml" />
</response>
</method>
</resource>
<resource path="/unsubscribe">
<method id="unsubscribe" name="POST">
<request>
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="msisdn"
style="query" type="xs:string" />
</request>
<response>
<representation mediaType="application/xml" />
</response>
</method>
</resource>
<resource path="/changelang">
<method id="changelang" name="POST">
<request>
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="msisdn"
style="query" type="xs:string" />
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="language"
style="query" type="xs:string" />
</request>
<response>
<representation mediaType="application/xml" />
</response>
</method>
</resource>
<resource path="/cancelreg">
<method id="cancelreg" name="POST">
<request>
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="msisdn"
style="query" type="xs:string" />
</request>
<response>
<representation mediaType="application/xml" />
</response>
</method>
</resource>
<resource path="/renew">
<method id="renew" name="POST">
<request>
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="msisdn"
style="query" type="xs:string" />
</request>
<response>
<representation mediaType="application/xml" />
</response>
105
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
</method>
</resource>
<resource path="/subscribe">
<method id="subscribe" name="POST">
<request>
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="msisdn"
style="query" type="xs:string" />
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="imsi"
style="query" type="xs:string" />
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="language"
style="query" type="xs:string" />
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="channel"
style="query" type="xs:string" />
</request>
<response>
<representation mediaType="application/xml" />
</response>
</method>
</resource>
</resource>
</resources>
</application>
XSD
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="lrdServiceResponse">
<xs:complexType>
<xs:sequence>
<xs:element ref="subscriberProfile" minOccurs="0"/>
<xs:element name="returnCode" type="lrdServiceReturnCode" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="subscriberProfile">
<xs:sequence>
<xs:element name="imsi" type="xs:string" minOccurs="0"/>
<xs:element name="language" type="xs:string" minOccurs="0"/>
<xs:element name="msisdn" type="xs:string" minOccurs="0"/>
<xs:element name="state" type="subscriberProfileState" minOccurs="0"/>
<xs:element name="status" type="subscriberProfileStatus" minOccurs="0"/>
<xs:element name="channel" type="subscriptionChannel" minOccurs="0"/>
<xs:element name="subscriptionEndDate" type="xs:string" minOccurs="0"/>
<xs:element name="subscriptionStartDate" type="xs:string" minOccurs="0"/>
<xs:element name="vmsisdn" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="subscriberProfileState">
<xs:restriction base="xs:string">
<xs:enumeration value="SUBSCRIBED"/>
<xs:enumeration value="UNSUBSCRIBED"/>
<xs:enumeration value="TERMINATED"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="subscriberProfileStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="ACTIVE"/>
<xs:enumeration value="INACTIVE"/>
106
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
<xs:enumeration value="OUT_OF_CREDITS"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="subscriptionChannel">
<xs:restriction base="xs:string">
<xs:enumeration value="USSD"/>
<xs:enumeration value="WEB"/>
<xs:enumeration value="UNKNOWN"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="lrdServiceReturnCode">
<xs:restriction base="xs:string">
<xs:enumeration value="0"/>
<xs:enumeration value="1001"/>
<xs:enumeration value="2001"/>
<xs:enumeration value="2002"/>
<xs:enumeration value="2003"/>
<xs:enumeration value="2004"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
Return Code
Return Code Description
0 No error
1001 Invalid parameters
2001 User is blacklisted
2002 User has already subscribed to LRD service
2003 User has not yet subscribed to LRD service
2004 Virtual MSISDN pool is exhausted
107
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0
108
Syniverse Asia Pacific Limited – Proprietary & Confidential