Download as pdf or txt
Download as pdf or txt
You are on page 1of 116

VMS Local Roaming Data

16th December 2013

PROPRIETARY AND CONFIDENTIAL


THIS MATERIAL IS THE PROPRIETARY PROPERTY OF AND CONFIDENTIAL TO SYNIVERSE TECHNOLOGIES, INC. (SYNIVERSE).
DISCLOSURE OUTSIDE OF SYNIVERSE IS PROHIBITED EXCEPT BY LICENSE AGREEMENT OR OTHER CONFIDENTIALITY
AGREEMENT.

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

 Denotes registration in the United States

All other companies’ marks and names are the trademarks or service marks of the respective company.

© Syniverse Technologies, Inc.


All rights reserved under U.S. and international copyright laws.
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

DOCUMENT CONTROL

Title: VMS Local Roaming Data


Category: Technical Specification
Identification: TS/VMS/LRD/20131216/1.0 Version: 1.0
Document Type: Restricted Public Document Status: Definitive
Distributed to: Release
Date
Drafted by: Kin Cheung Maintained By: Production Development
Approved By: Interpreted By: Production Development

MODIFICATION HISTORY

Date Version Revised by Description of Changes


--/--/2013 1.0 Kin Cheung First issue

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

10. IN integration .................................................................................................................. 6


10.1 Service Subscription .................................................................................................................................6
10.2 Service Manual Un-subscription ...............................................................................................................7
10.3 Auto Un-subscription due to service expired ............................................................................................8

11. LRD System Architecture .................................................................................................. 9


11.1 Component architecture ..........................................................................................................................9
11.2 Network Connectivity ............................................................................................................................. 10

12. Service Flow................................................................................................................... 10


12.1 WSM flow............................................................................................................................................... 10
Non-LRD users (with data service and roaming agreement) ...............................................................10
Non-LRD users (without roaming agreement) .....................................................................................12
Non-LRD users (with data service and roaming agreement), CS only device type ..............................13
12.2 LRD service subscription flow ................................................................................................................. 13
Subscription via USSD ...........................................................................................................................13
Subscription / Cancellation via Web.....................................................................................................14
Subscription via Web before landing in VN ..........................................................................................15
12.3 LRD service unsubscription flow ............................................................................................................. 16
Unsubscription flow..............................................................................................................................16
12.4 LRD service activation/inactivation flow ................................................................................................ 17
LRD service activation,LU .....................................................................................................................17
LRD service inactivation, CL (switching networks) ...............................................................................19
13. GTM .............................................................................................................................. 20
13.1 System Network Connectivity ................................................................................................................ 20
13.2 High availability ...................................................................................................................................... 20
13.3 Work flow logic ...................................................................................................................................... 21

3
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

13.4 GTM TDR Format .................................................................................................................................... 21

14. USSD EA ......................................................................................................................... 22


14.1 Architecture diagram.............................................................................................................................. 23
14.2 Work flow logic ...................................................................................................................................... 23
14.3 Logs ........................................................................................................................................................ 23
14.4 USSD EA Transaction detail record (USSDEA TDR) .................................................................................. 24
14.5 API Transaction detail record (API TDR).................................................................................................. 27

15. LRD Core ........................................................................................................................ 28


15.1 RESTful XML/HTTP API ........................................................................................................................... 28
Service subscription ..............................................................................................................................28
Service unsubscription .........................................................................................................................30
Service subscription renewal ................................................................................................................32
Subscription query................................................................................................................................33
Change language ..................................................................................................................................34
Cancel registration page redirection ....................................................................................................36
15.2 LRD service provisioning ......................................................................................................................... 37
Operator blacklist and whitelist ...........................................................................................................37
Subscription state .................................................................................................................................37
Service subscription ..............................................................................................................................38
Service unsubscription .........................................................................................................................39
Subscription query................................................................................................................................40
Change language ..................................................................................................................................40
Subscription renewal ............................................................................................................................41
Cancel registration page redirection ....................................................................................................41
15.3 Probe TDR Event handling ...................................................................................................................... 42
LocationUpdate event handling ...........................................................................................................42
CancelLocation event handling ............................................................................................................43
15.4 Probe TDR Collation Processor ............................................................................................................... 43
LocationUpdate event ..........................................................................................................................43
CancelLocation event ...........................................................................................................................44
Probe TDR Format ................................................................................................................................44
15.5 Subscription balance query integration .................................................................................................. 47
15.6 Virtual MSISDN lifecycle management ................................................................................................... 47

16. TCAP GW ....................................................................................................................... 48


17. WSM ............................................................................................................................. 49
17.1 Dispatch windows .................................................................................................................................. 49
17.2 WSM Blacklists ....................................................................................................................................... 50
MCC/MNC Blacklist...............................................................................................................................50
IMSI Blacklist.........................................................................................................................................50
MSISDN Blacklist ...................................................................................................................................50
17.3 WSM Whitelists ...................................................................................................................................... 50
MCC/MNC Whitelist .............................................................................................................................50
IMSI Whitelist .......................................................................................................................................51
MSISDN Whitelist .................................................................................................................................51
17.4 WSM Blacklist/Whitelist Logic ................................................................................................................ 51
17.5 WSM global parameters ......................................................................................................................... 51

18. LRD Console ................................................................................................................... 52


18.1 Site map ................................................................................................................................................. 53
18.2 Profile management ............................................................................................................................... 54

4
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

18.3 Virtual MSISDN management ................................................................................................................. 57


Virtual MSISDN pool .............................................................................................................................57
Single Virtual MSISDN, Multiple IMSI mapping ....................................................................................59
18.4 WSM management ................................................................................................................................. 60
WSM parameter configuration ............................................................................................................60
WSM dispatch window configuration ..................................................................................................61
WSM whitelist management ................................................................................................................62
WSM blacklist management .................................................................................................................65
18.5 SMS template management ................................................................................................................... 68
SMS Template .......................................................................................................................................68
SMS Language management ................................................................................................................70
18.6 Operator management ........................................................................................................................... 70
Whitelist management .........................................................................................................................70
Blacklist management ..........................................................................................................................73
18.7 Audit trail log ......................................................................................................................................... 75
18.8 User management .................................................................................................................................. 76
User 76
User Group ...........................................................................................................................................77
User Role ..............................................................................................................................................77
18.9 Parameter configurations ....................................................................................................................... 78
18.10 Reporting ............................................................................................................................................... 79
Hourly, Daily, Monthly USSD Usage by Service Code Report ...............................................................79
Hourly, Daily, Monthly Successful/Reject/Timeout or Failure USSD Transaction Report ....................80
Hourly, Daily, Monthly LRD Activity Summary Report .........................................................................81
Hourly LRD Status Snapshot Report .....................................................................................................82
Hourly, Daily, Monthly SMS Notification Report ..................................................................................83
Hourly, Daily, Monthly TCAP Statistics Report .....................................................................................84
Monthly LRD subscriber snapshot report.............................................................................................85
19. OAM .............................................................................................................................. 85
19.1 Alarms .................................................................................................................................................... 85
LRD core alarms ....................................................................................................................................85
GTM alarms ..........................................................................................................................................86
20. Appendix ....................................................................................................................... 86
20.1 Mobile Country Codes (MCC) ................................................................................................................. 86
20.2 Database schema ................................................................................................................................... 91
SUBSCRIBER_PROFILE ...........................................................................................................................91
SUBSCRIBER_PROFILE_HISTORY ...........................................................................................................92
PHONES ................................................................................................................................................93
TMP_OPT_OUT .....................................................................................................................................93
TMP_LU_HISTORY ................................................................................................................................93
LANGUAGE............................................................................................................................................93
MCC_LANGUAGE_MAP ........................................................................................................................94
MCC 94
SMS_TEMPLATE ....................................................................................................................................94
VIRTUAL_MSISDN_POOL ......................................................................................................................95
SVMMI_VIRTUAL_MSISDN ...................................................................................................................95
SVMMI_IMSI_MAPPING .......................................................................................................................95
WSM_DISPATCH_WINDOW .................................................................................................................95
TMP_WSM_DISPATCH..........................................................................................................................96
WSM_MCC_MNC_WHITELIST ..............................................................................................................96

5
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

WSM_MSISDN_ WHITELIST ..................................................................................................................96


WSM_IMSI_ WHITELIST ........................................................................................................................96
WSM_MCC_MNC_BLACKLIST ...............................................................................................................97
WSM_MSISDN_BLACKLIST ...................................................................................................................97
WSM_IMSI_BLACKLIST .........................................................................................................................97
OP_MCC_MNC _WHITELIST .................................................................................................................97
OP_APN _ WHITELIST ...........................................................................................................................98
OP_MCC_MNC _BLACKLIST ..................................................................................................................98
OP_APN _BLACKLIST .............................................................................................................................98
GLOBAL_PARAMETER ...........................................................................................................................98
HOURLY_USSD_USAGE .........................................................................................................................99
DAILY_USSD_USAGE .............................................................................................................................99
MONTHLY_USSD_USAGE......................................................................................................................99
HOURLY_USSD_TRANSACTION ............................................................................................................99
DAILY_USSD_ TRANSACTION ..............................................................................................................100
MONTHLY_USSD_ TRANSACTION ......................................................................................................100
HOURLY_LRD_ACTIVITY ......................................................................................................................100
DAILY_LRD_ACTIVITY ..........................................................................................................................101
MONTHLY_LRD_ACTIVITY...................................................................................................................101
HOURLY_LRD_STATUS_SNAPSHOT ....................................................................................................102
HOURLY_SMS_NOTIFICATION ............................................................................................................102
DAILY_SMS_NOTIFICATION ................................................................................................................102
MONTHLY_SMS_NOTIFICATION .........................................................................................................102
HOURLY_TCAP_STATISTICS ................................................................................................................103
DAILY_ TCAP_STATISTICS....................................................................................................................103
MONTHLY_ TCAP_STATISTICS ............................................................................................................103
20.3 XML/HTTP ............................................................................................................................................ 105
WADL 105
XSD 106
Return Code ........................................................................................................................................107
20.4 Web Configuration Notification Type ................................................................................................... 107

6
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Figure 1 LRD platform component architecture ............................................................................................... 9


Figure 2 LRD network connectivity.................................................................................................................. 10
Figure 3 WSM flow for non-LRD subscribers (with data service and roaming agreement) ............................ 11
Figure 4 WSM flow for non-LRD users (without roaming agreement) ........................................................... 12
Figure 5 LRD service subscription flow via USSD ............................................................................................. 14
Figure 6 Non-LRD subscriber, Web registration / Cancellation....................................................................... 15
Figure 7 LRD service unsubscription flow........................................................................................................ 17
Figure 8 LRD subscriber, LocationUpdate flow ............................................................................................... 19
Figure 9 LRD subscriber, CancelLocation flow ................................................................................................. 19
Figure 10. GTM network architecture for visiting operator ........................................................................... 20
Figure 11. GTM layer-3 deployment with VRRP topology .............................................................................. 20
Figure 12 Subscription state lifeline (cancellation & expired) ........................................................................ 37
Figure 13 LRD service subscription flow .......................................................................................................... 38
Figure 14 LRD service un-subscription flow .................................................................................................... 39
Figure 15 LRD service query flow .................................................................................................................... 40
Figure 16 LRD service language change flow .................................................................................................. 40
Figure 17 Subscription renewal ....................................................................................................................... 41
Figure 18 Cancel registration page redirection flow ....................................................................................... 42
Figure 19 LocationUpdate event handling flow .............................................................................................. 42
Figure 20 CancelLocation event handling flow ............................................................................................... 43
Figure 21 Tapping probe SOAP message types ............................................................................................... 44
Figure 22: Software Module Diagram ............................................................................................................. 48
Figure 23 WSM logic flow ................................................................................................................................ 49
Figure 24 - Console Design .............................................................................................................................. 53
Figure 25 WSM MCC/MNC whitelist ............................................................................................................... 62
Figure 26 WSM MSISDN whitelist ................................................................................................................... 63
Figure 27 WSM IMSI whitelist ......................................................................................................................... 64
Figure 28 WSM MCC/MNC blacklist ................................................................................................................ 65
Figure 29 WSM MSISDN blacklist .................................................................................................................... 66
Figure 30 SMS template management ............................................................................................................ 68
Figure 31 Add and Edit SMS template ............................................................................................................. 69
Figure 32 Default SMS language. MCC and Language mapping...................................................................... 70
Figure 33 Operator IMSI whitelist ................................................................................................................... 71
Figure 34 Operator APN whitelist ................................................................................................................... 72
Figure 35 Operator IMSI blacklist .................................................................................................................... 73
Figure 36 Operator APN blacklist .................................................................................................................... 74
Figure 37 Audit trail log ................................................................................................................................... 75
Figure 38 - User Privilege................................................................................................................................. 76
Figure 39 User management ........................................................................................................................... 77
Figure 40 User group management................................................................................................................. 77
Figure 41 User role management .................................................................................................................... 78
Figure 42 WSM Parameter configuration........................................................................................................ 78

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

3.12 User Management


3.13 Audit Trail Log

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

HP P2000 600GB 6G SAS 15K 3.5in ENT HDD 6


HP Rdnt 2m,10A,C13-C14 Jmpr Cord 2
4 Rack 1

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

8. Performance and sizing capacity


Subject Performance/sizing capacity
PDP context creation requests 30 TPS
Concurrent users 100K
Registered subscribers 600k
Tapping probe TDR messages 100TPS

9. Device detection
Device types are categorized into the following types:
1. CS-only
2. PS-only
3. CS and PS

Device type detection is achieved in 2 steps.


1. LRD platform queries VMS ADC system over a XML API with home MSISDNs and thereby obtains device
brands and model numbers, e.g. “Apple iPhone 4”.
2. With the device brands and model numbers combined, LRD platform queries the local database to obtain the
device types, e.g. CS-only, PS-only or CS-PS.

ADC system is a system currently available at VMS. The device name to device type mappings are managed in the LRD
local database.

9.1 ADC QUERY-SUBSCRIBER-HANDSET API


9.1.1 Description
Query the DMC Database to retrieve the last known subscriber handset (IMEI), the handset information (Brand and
Model) and the IMSI of the subscriber, based on the MSISDN provided as input parameter.

4
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

9.1.2 Input parameters


NAME DESCRIPTION MANDATORY COMMENTS
MSISDN Subscriber MSISDN YES MSISDN can be supplied in
either international
format, either domestic
format

9.1.3 Output parameters


NAME DESCRIPTION MANDATORY COMMENTS
MSISDN Subscriber MSISDN YES International format
IMSI Subscriber IMSI YES

IMEI Subscriber IMEI YES The IMEI carried over the


network and stored in the
MCTEL DMC Database. Can
be 14, 15 (IMEI+CD) or 16
digits (IMEI+SVN).
BRANDNAME Brand of the subscriber’s YES “Unknown” is
returned if the TAC is not
handset yet provisioned in the DMC
database
MODELNAME Model of the subscriber’s YES “Unknown” is
returned if the TAC is not
handset provisioned in the DMC
database

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>

9.1.5 Status Codes


The table below describes the status codes returned by the MCTEL DMC Webservices: Status code convention:
2xx successful processing of a request
3xx internal error
4xx [UA] error
5xx [MDM] error

STATUS CODE STATUS DESCRIPTION


200 OK
201 OK – no action performed
301 Internal error
401 Bad parameters values
402 Missing parameters

5
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

403 Unsupported action type


404 Invalid request
405 Unrecognized TAC
407 MSISDN not in database
407 IMSI not in database
407 IMEI not in database
412 Invalid MSISDN, e.g. in an unsupported range or not belonging to host operator
413 Invalid IMSI, e.g. in an unsupported range or not belonging to host operator
501 Database error, please try again later

10. IN integration
LRD platform integrates with VMS IN system through a telnet MML API.

10.1 Service Subscription

LRD Platform VMS IN

subscribe() Update
- IMSI
- VMSISDN
- Credits b/f

Figure 1 IN integration – LRD service subscription

 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;

10.2 Service Manual Un-subscription


LRD Platform VMS IN

unsubscribe()
Update
- VMSISDN

Credits c/f

Figure 2 IN integration – LRD service manual un-subscription


 Upon service un-subcription, LRD platform will update VMS IN with the following details of the subscriber
o VMSISDN
o IMSI (empty)
 Second, LRD platform will obtain the remaining balance of the subscriber and save in the local LRD database.
 The remaining balance will be added back to the IN for the same subscriber in the next service subscription.
 Subscribers are considered to be the same by their IMSIs.

MML command:

Change IMSI
MODACNT,MSISDN=<msisdn>, IMSI=<imsi>;

Account Information Query


DISACNT,MSISDN=<msisdn>;

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>;

10.3 Auto Un-subscription due to service expired

LRD Platform VMS IN

Service expired
(e.g. 30 days)

Update
- VMSISDN

Credits c/f

Figure 3 IN integration – LRD service auto un-subscription due to service expired


 LRD service expiration is controlled by a global configuration parameter which can be configured through the
LRD web console. Please see Parameter configurations.
 Upon service expired, LRD platform will update VMS IN with the following details of the subscribers:
o IMSI (empty)
o VMSISDN
 Service expiration is checked based on the subscription date of the service, which is the date when the
subscriber subscribed the service.
 The IN integration is identical to Service Manual Un-subscription.

8
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

11. LRD System Architecture


11.1 Component architecture

VMS Application Server

XML/HTTP :8000

Web Portal USSD EA XML/HTTP :8000


LRD Core
API USSD
SMPP :5000 TDR
USSD GW Menu Engine Web console
USSD TDR
Report Parser
SMPP TCP :5432 SMPP client
Telnet :21
IN TCAP client

SMPP :5018

SMSC GTP-C :2123


GTM TCP :5432

GGSN TCP :5432 MQ :61616


GTP-C :2123 consume() INTM :8081

GRX
Database Server
GTP-C :2123
MAP (e.g. ISD)

SGSN
Probe TDR
Collation Processor Tcap GW

Postgres
Message Queue NewNet

TDR Probe SOAP :8823 TDR SOAP receiver

Storage

DB
datafiles

Figure 4 LRD platform component architecture

9
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

11.2 Network Connectivity

Figure 5 LRD network connectivity

12. Service Flow


12.1 WSM flow
Non-LRD users (with data service and roaming agreement)
The following diagram describes the flow of WSM where it begins from a device initially sends an “Attach
request” to VMS’s PLMN.

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

Attach Request LocationUpdate


ISD request
ISD response
Attach accept LocationUpdate response

GMM Attach Request LocationUpdate_GPRS


GMM Attach accept LocationUpdate_GPRS Response

LU, ISD
Query

WSM via SMSC


CS + PS

Override ISD with


After this, the registration page APN
user can decide
to subscribe to
LRD or not
Override ISD with
PS Only

registration page APN


GTM Gatekeeper

Activate PDP context Create PDP request Create PDP request

Activate PDP context accept Create PDP response

Internet Access GTP-U


VMS Registration Page

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

Non-LRD users (without roaming agreement)


The following diagram describes the WSM flow where it originates from a device initially sends an “Attach
request” to VMS’s PLMN.
Inbound roamer without roaming agreement (Non-LRD user)

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

Figure 7 WSM flow for non-LRD users (without roaming agreement)

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

4. Device type is not a concern

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.

12.2 LRD service subscription flow


Subscription via USSD
The following diagram describes the flow where a user subscribes to LRD service using USSD.

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

Subscribe to LRD Subscribe to LRD

Subscription accepted

User must LU again by switching from/to flight mode

Probe
Attach request LocationUpdate

ISD GTM intercepts


TDR the request from
activate heading to home
Activation SMS (via SMSC) GGSN and route
it to local GGSN
GMM Attach Request
ISD override

Create PDP Context Request


failed

Create PDP Context Request


ISD override
succeeded

Create PDP Context Request

PDU GTP-U

Figure 8 LRD service subscription flow via USSD

Subscription / Cancellation via Web

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

Terminal Tapping LRD VMS Web


VLR SGSN IN GTM GGSN HLR GGSN
Device Probe Platform Portal

Attach Request LocationUpdate


ISD request
ISD response
Attach accept LocationUpdate response
LU, ISD

ISD override (reg. page APN)

activate
Activate PDP context

Create PDP request


ISD Override

Create PDP context request (with reg. page APN)


Failed
ISD Override
Succeeded

Create PDP context request

Redirected to VMS
Web Portal by the
Activate PDP context accept Create PDP Response Local GGSN

PDU GTP-U PDU

“Cancel” registration page on VMS web portal

CancelLocation cancelReg over XML/HTTP


Cancel

Activate PDP context Create PDP context Create PDP context

PDU GTP-U

Subscribe
Subscribe

After “Subscribed”, the web page


should instruct user to switch between
flight mode. Please see “LRD Service
Activation” flow

Figure 9 Non-LRD subscriber, Web registration / Cancellation

Subscription via Web before landing in VN

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

VMS Web Tapping LRD


Web Broswer VLR IN SGSN GTM GGSN HLR GGSN
Portal Probe Platform

Subscribers in home country

1. No IMSI recorded
Personal User

Subscribe Subscribe(MSISDN) for the user yet


2. a virtual MSISDN is
User must provide: already assigned.
- MSISDN
Corporate 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

Attach Request LocationUpdate


ISD request/response
Attach accept LocationUpdate response

For Personal user,


Obtain IMSI by
LU, ISD MSISDN and store
on DB
Override ISD
activate Modify the
original request
Activate PDP context and redirect it to
the local GGSN
ISD Override
Failed

Create PDP request


ISD Override
Succeeded

Create PDP request

PDU GTP-U

12.3 LRD service unsubscription flow


Unsubscription flow
The following diagram describes how a user unsubscribes LRD service.

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

Terminal USSD LRD


SGSN IN GTM GGSN HLR GGSN
Device GW/Web Platform

Unsubscribe LRD Unsubscribe LRD


CancelLocation

deactivate
Unsubscription accept

SMS (via SMSC)

Attach Request LocationUpdate


Attach accept LocationUpdate response

GMM Attach LocationUpdate_GPRS

Activate PDP context Create PDP context request Create PDP context request
Activate PDP context accept Create PDP context Response
PDU GTP-U

Figure 10 LRD service unsubscription flow

12.4 LRD service activation/inactivation flow


LRD service activation,LU

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

Activate PDP context Create PDP request


ISD override Successful

Activate PDP context accept Create PDP Response

GTP-U

Activate PDP context Create PDP request


ISD override unsuccessful
GTM gatekeeper

Activate PDP context accept Create PDP request (change packet header)
Create PDP Response Create PDP Response

GTP-U

 LRD service is activated upon LU and inactivated upon CL.


 Due to delays in the tapping probe and message collation processing, LU between a device and home
network is likely to be finished before LRD platform is able to override ISD at the local SGSN.
 In case, LRD platform is not able to override ISD at SGSN in time, GTM will come into play. When GTM detects
a “Create PDP context request” that is made from a LRD subscriber, GTM will interfere and forward the
request to the local GGSN to prevent it from going back to home network.
 For GTM connectivity and routing logics, please see System Network Connectivity.
 On the other hand, once LU is captured successfully at LRD platform, LRD platform will send an overriding ISD
with a single designated APN, for example, “VMS.APN”, to SGSN.
 An “Activation SMS” is sent to the subscriber upon successful LU (for PS+CS type devices only).
 When a subscriber is out of the VMS network, the LRD service is inactivated for the user. Being out of the
network is detected by the following logics:

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

Activate PDP context Create PDP request


ISD override Successful

Activate PDP context accept Create PDP Response

GTP-U

Activate PDP context Create PDP request


ISD override unsuccessful
GTM gatekeeper

Activate PDP context accept Create PDP request (change packet header)
Create PDP Response Create PDP Response

GTP-U

Figure 11 LRD subscriber, LocationUpdate flow

LRD service inactivation, CL (switching networks)

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

Inactivation SMS (via SMSC)

Figure 12 LRD subscriber, CancelLocation flow


 When a subscriber is out of the VMS network, the LRD service is inactivated for the user. Being out of the
network is detected by the following logics:
o A CancelLocation tapped by the probe and no LocationUpdate for the same subscriber within the
next 3 seconds.
 An “Inactivation SMS” is sent to the subscriber when the service is inactivated (for PS+CS type devices only).

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

Mobile RAN Gn GRX Gp GGSN Gi Internet


SGSN GTM
Device

Figure 13. GTM network architecture for visiting operator

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.

192.168.10.1 192.168.10.2 192.168.10.3


next-hop - next-hop -
SGSN Layer-3 GTM Layer-3 GGSN
> >
switch switch

GTM server’s route table must be configured to route outgoing GTP packets to the correct ‘next-hop’.

13.2 High availability


When deployed in layer-3 mode, high-availability is provided by the Virtual Router Redundancy Protocol (VRRP)
protocol. VRRP is similar to the Cisco HSRP protocol to provide network routing fail-over. Two GTM are deployed in
active-standby manner. A VRRP daemon is running on the GTM servers to provide a virtual server (with virtual IP
address) for SGSN and GGSN to set as ‘next-hop’ gateway. The following diagram illustrates a sample configuration.

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 SGSN, the following default route is defined:


route add –net 192.168.154.0 netmask 255.255.255.0 gw 172.16.101.10 eth1
In GGSN, the following default route is defined:
route add –net 172.16.101.0 netmask 255.255.255.0 gw 192.168.154.10 eth1

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.

13.3 Work flow logic


GTM intercepts GTP-C message between SGSN and
GGSN.
GTP-C

If GTM finds a CreatePDPContext request from an


inbound roamer that has already registered to LRD CreatePDPContext
Request
service, GTM will route the CreatePDPContext request to
VGGSN by rewriting the destination IP in the packet
header. Otherwise, GTM will do nothing and let the
packets go back to the network interface and route to MCC/MNC
Yes
blacklist
home.

No

Yes APN blacklist

No

No LRD subscribed Yes

Route Route
CreatePDPContext CreatePDPContext
request to next hop, request to next hop,
(GRX) (VGGSN)

end

13.4 GTM TDR Format


Filename GtmTdr-YYYYMMDD.csv (e.g. GtmTdr-20130801.csv)
Field-separator Comma-separated-values (csv)
Record-separator 0x0A (line feed)

Field Format Descriptions


Date/Time YYYYMMDD-HH:MM:SS
Msg-Type Integer(2) GTP message type
Teid HexByte (4) GTP Message Tunnel ID
IMSI Char (15) International Mobile Subscriber Identity
Teid-Ctrl-DL HexByte (4) Downlink Tunnel ID (Control channel)
Teid-DataI-DL HexByte (4) Downlink Tunnel ID (DataI channel)

21
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

NSAPI Integer NSAPI


Pre-MSISDN Varchar (20) Pre-translation MSISDN (original)
Post-MSISDN Varchar (20) Post-translation MSISDN (virtual)
Pre-APN Varchar (40) Pre-translation APN
Post-APN Varchar (40) Post-translation APN
Src-IP-Addr Varchar (15) Source IP address (SGSN)
Pre-Dst-IP-Addr Varchar (15) Pre-translation Destination IP address (GGSN)
Post-Dst-IP-Addr Varchar (15) Post-translation Destination IP address (GGSN)
Action-Id Integer 0: no action
1: VGGSN page APN
2: registration page APN
Status-Code Integer Status code
0: success

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

14.1 USSD Menu


An USSD menu is triggered by a single short code *800#

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

14.2 Architecture diagram

USSD Gateway Application Server

USSD EA LRD Core


SMPP/TCPIP
SMPP Handler

USSD EA Core

Client Handler XML/HTTP

14.3 Work flow logic


Work flow logic is yet to be confirmed

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.

14.4.2 System log format

Field Name Format Field Description


Length

Event Date String characters of 15 Event Date


(YYYYMMDD hhmmss) where
YYYYMMDD represents year,
month, day and hhmmss
represents hour, minute, second

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

14.4.3 Log File Naming Convention

Filename Description
SYSTEM.LOG Runtime logfile

23
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

SYSTEM.yyyymmdd Archived logfile

Where:
yyyymmdd = timestamp

14.5 USSD EA Transaction detail record (USSDEA TDR)


14.5.1 Transaction Detail Record Details

Transaction Detail Record (TDR) will be rotated and backup daily with the following details:

1. Event Start Date


2. Event Start Time
3. Event End Date
4. Event End Time
5. Event Operation (PUSSR/PUSSD/USSR/USSN)
6. Event Type (MO)
7. Transaction ID
8. Short Code
9. Total Messages
10. MSISDN
11. HLR Address
12. VLR Address
13. IMSI
14. Cell ID
15. Menu ID
16. Menu Node ID
17. Menu Version
18. Product Type
19. Cause Code
20. USSD String (Whitespaces and Special Characters will be converted)

14.5.2 Transaction Detail Record Formatting

Field Name Format Field Description


Length

Event Start String characters of 8 Event Start Date


Date
(YYYYMMDD) where YYYYMMDD
represents year, month, day and
hhmmss.zzz represents hour,
minute, second, millisecond

Event Start String characters of (hhmmss.zzz) 10 Event Start Time


Time where
hhmmss.zzz represents hour,
minute, second, millisecond

Event End String characters of 8 Event End Date

24
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Date (YYYYMMDD)

Event End String characters of (hhmmss.zzz) 10 Event End Time


Date

Event Option String characters (left justified) 5 PUSSR/PUSSD/USSR/USSN

Event Type Strings characters 2 MO – Mobile trigger

Transaction ID Hexadecimal (left filled with ‘0’) 8 Internal Reference Transaction Number

Short Code Character (left justified) 3 Service code trigger by the mobile.

Total Integer (left justified 3 Number of message through the transaction


Messages

MSISDN String characters (left justified) 15 Mobile Subscriber Number

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

Cell ID String character (left justified) 5 Cell ID

Menu ID String character (left justified) 20 Menu Tree ID

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

Product Type String character (left justified) 10 Product type

Cause Code Hexadecimal (left filled with ‘0’) 8 Termination Reason

USSD Request Original user initiating string 30 Character (left justified), three dashes if not
String exists

14.5.3 TDR File Naming Convention

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

14.5.4 iMenu Transaction Detail Record samples

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

14.6 API Transaction detail record (API TDR)


14.6.1 API Transaction Detail Record Details

API Transaction Detail Record (TDR) will be rotated and backup daily with the following details:

1. Event Creation Date


2. Event Creation Time
3. Event Start Date
4. Event Start Time
5. Event End Date
6. Event End Time
7. MSISDN
8. Source Point Code
9. Destination Point Code
10. Sequence Number
11. Interface Name
12. Command Name
13. Cause Code

14.6.2 API Transaction Detail Record Formatting

Field Name Format Field Description


Length

Event Creation String characters of 8 Event Creation Date


Date
(YYYYMMDD) where YYYYMMDD
represents year, month, day and
hhmmss represents hour, minute,
second, millisecond

Event Creation String characters of (hhmmss) 8 Event Creation Time


Time where
hhmmss represents hour, minute,
second, millisecond

Event Start String characters of 8 Event Start Date


Date
(YYYYMMDD) where YYYYMMDD
represents year, month, day and
hhmmss represents hour, minute,
second, millisecond

Event Start String characters of (hhmmss) 8 Event Start Time


Time where
hhmmss represents hour, minute,
second, millisecond

Event End String characters of 8 Event End Date


Date
(YYYYMMDD)

27
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Event End String characters of (hhmmss) 8 Event End Time


Date

MSISDN String characters (left justified) 15 Mobile Subscriber Number

Source Point String characters (left justified) 4 ID of message source


Code

Destination String characters (left justified) 4 ID of message destination


Point Code

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

Cause Code Hexadecimal (left filled with ‘0’) 8 Termination Reason

14.6.3 API TDR File Naming Convention

Filename Description
APICONVERTER_TDR.LOG Runtime logfile
APICONVERTER_TDR.yyyymmdd Archived logfile

Where:
yyyymmdd = timestamp

14.6.4 API Transaction Detail Record samples

20110729 17:18:02 20110729 17:18:02 20110729 17:18:02 92231447 0002 0003 00000005 HTTP
charge 00000000

15. LRD Core


15.1 RESTful XML/HTTP API
This is a RESTful web service that consumes and produces XML over HTTP. It offers the following web
services and will be described in the following sections.

WADL: WADL
XSD: XSD

Service subscription

This web service function is used to subscribe user to LRD service.

28
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Service URL Error! Hyperlink reference not valid.?


HTTP Method POST

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

<?xml version="1.0" encoding="UTF-8"


standalone="yes"?><lrdServiceResponse><subscriberProfile><imsi>460101234567890</imsi><language>en</languag
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
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

returnCode Return Code Description


0 No error
1001 Invalid parameters
2001 User is blacklisted
2002 User has already subscribed to LRD service
2004 Virtual MSISDN is exhausted

HTTP Return Code Description


200 OK Request has been processed. Refer to returnCode for any error
occured
403 NOT FOUND Wrong resource URL
405 Method Not Allowed Wrong HTTP method. “POST” 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>
<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.

Service URL Error! Hyperlink reference not valid.?


HTTP Method POST

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

<?xml version="1.0" encoding="UTF-8"


standalone="yes"?><lrdServiceResponse><subscriberProfile><imsi>460101234567890</imsi><language>en</languag
e><msisdn>911624925096</msisdn><state>TERMINATED</state><status>INACTIVE</status><channel>USSD</chann
el><subscriptionEndDate>2013-09-06 11:49:45</subscriptionEndDate><subscriptionStartDate>2013-09-06
11:40:54</subscriptionStartDate><vmsisdn>85291234560</vmsisdn></subscriberProfile><returnCode>0</returnCod
e></lrdServiceResponse>

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

HTTP Return Code Description


200 OK Request has been processed. Refer to returnCode for any error
occured
403 NOT FOUND Wrong resource URL
405 Method Not Allowed Wrong HTTP method. “POST” 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>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

Service subscription renewal

This web service function is used to renew LRD service subscription.

Service URL http://<ip>:<port>/lrd/lrdservice/renew?


HTTP Method POST

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

<?xml version="1.0" encoding="UTF-8"


standalone="yes"?><lrdServiceResponse><subscriberProfile><imsi>460101234567890</imsi><language>en</languag
e><msisdn>911624925096</msisdn><state>SUBSCRIBED</state><status>INACTIVE</status><channel>USSD</channe
l><subscriptionEndDate>2013-09-06 11:49:45</subscriptionEndDate><subscriptionStartDate>2013-09-06
11:40:54</subscriptionStartDate><vmsisdn>85291234560</vmsisdn></subscriberProfile><returnCode>0</returnCod
e></lrdServiceResponse>

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

2001 User is blacklisted


2003 User has not subscribed to LRD service

HTTP Return Code Description


200 OK Request has been processed. Refer to returnCode for any error
occured
403 NOT FOUND Wrong resource URL
405 Method Not Allowed Wrong HTTP method. “POST” 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>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.

Service URL Error! Hyperlink reference not valid.?


HTTP Method GET

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

<?xml version="1.0" encoding="UTF-8"


standalone="yes"?><lrdServiceResponse><subscriberProfile><imsi>460101234567890</imsi><language>en</languag

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>

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 yet subscribed to LRD service

HTTP Return Code Description


200 OK Request has been processed. Refer to returnCode for any error
occured
403 NOT FOUND Wrong resource URL
405 Method Not Allowed Wrong HTTP method. “GET” 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>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.

Service URL http://<ip>:<port>/lrd/lrdservice/changelang?

34
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

HTTP Method POST

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

<?xml version="1.0" encoding="UTF-8"


standalone="yes"?><lrdServiceResponse><subscriberProfile><imsi>460101234567890</imsi><language>zh</languag
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>

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)
returnCode Return Code Description
0 No error
1001 Invalid parameters
2001 User is blacklisted
2003 User has not subscribed to LRD service

HTTP Return Code Description

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>

Cancel registration page redirection

This web service function is used to stop LRD from redirecting user to the LRD service registration page.

Service URL http://<ip>:<port>/lrd/lrdservice/cancelreg?


HTTP Method POST

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

<?xml version="1.0" encoding="UTF-8"


standalone="yes"?><lrdServiceResponse<returnCode>0</returnCode></lrdServiceResponse>

36
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Output Parameter Name Format


returnCode Return Code Description
0 No error
1001 Invalid parameters
2001 User is blacklisted
2002 User has already subscribed to LRD service

HTTP Return Code Description


200 OK Request has been processed. Refer to returnCode for any error
occured
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.

15.2 LRD service provisioning


Operator blacklist and whitelist
The following blacklist/whitelist logics apply to both operator APN blacklist/whitelist as well as operator
IMSI blacklist/whitelist

Not listed Allowed


Whitelisted only Allowed
Blacklisted only Blocked
Whitelisted + Blacklisted Allowed

Subscription state

Subscription cancellation lifeline Subscription expired lifeline

SUBSCRIBED
State

TERMINATED

UNSUBSCRIBED

Subscribe Unsubscribe Purge Subscribe Service expired Purge

Provisioning events Provisioning events

Figure 15 Subscription state lifeline (cancellation & expired)


Subscription state Description
SUBSCRIBED This is the initial subscription state that a subscriber begins with.

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.

USSD **123*1# Web


1. Validations:
a) Check parameters, if missing parameters, reject request.
b) Check MSISDN format, if invalid, reject request. LRD Service
c) Check if IMSI is available. Subscription
a. If not, look up tapped TDR with MSISDN. If still
unavailable, reject request.
b. Check IMSI format, if invalid, reject request Check LRD
d) Check the user LRD service subscription. If already service
Not Exists
subscribed, reject request. subscription
By IMSI Exists
e) Check MCC and MNC against a predefined blacklist. If Parameter
blacklisted, reject request. valid?
2. Assign virtual MSISDN
a. “Single Virtual MSISDN to multiple IMSI” is first Yes

to be looked at for the subscriber IMSI.


MCC/MNC Check state
Single Virtual MSISDN, Multiple IMSI mapping Black listed?
b. If not found, a virtual MSISDN will be drawn
from the virtual MSISDN pool. No SUBSCRIBED
TERMINATED
Virtual MSISDN pool
c. If the pool is exhausted, reject request. Subscribe LRD
service and saved in
3. Provision user profile on database DB LRD service already
a. If language is not chosen, the MCC in the IMSI subscribed error
will be used to determine the SMS language for
the subscriber. Send SMS to notify
for successful
SMS Language management subscription and tell
b. If the chosen language is invalid, reject request. the subscriber to
turn on and off the
4. Persist subscribe profile in database device
a. if a new subscriber, insert a new subscriber
profile on DB end
b. if an existing subscriber profile in the state
of ”TERMINATED”, change the state to
“SUBSCRIBED” and update the subscriber profile Figure 16 LRD service subscription flow
record on DB.
5. Send confirmation SMS to the user
a. If channel is “WEB”, skip this step since VMS will
send SMS.

38
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

6. Return result code “0” and user profile information

Service unsubscription

1. Validations: USSD **123*2# Web


a) Check parameters, if missing parameters, reject
request.
b) Check MSISDN format, if invalid, reject request LRD Service
Unsubscription
c) Check the user LRD service subscription. If not yet
subscribed, reject request.
2. Provision user profile on database. Subscriber state
will be set to ‘TERMINATED’
Check LRD
3. Send confirmation SMS to the user service
4. end Not Exists Exists
subscription
By MSISDN
Parameter
LRD service not yet valid?
subscribed error
Yes

Terminate LRD
service and saved in
DB

Send SMS to notify


for successful
termination and tell
the subscriber to
turn on and off the
device

end

Figure 17 LRD service un-subscription flow

39
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Subscription query

1. Validations: USSD **123*3# Web


a) Check parameters, if missing parameters, reject
request.
b) Check MSISDN format, if invalid, reject request. LRD Service Query
c) Check the user LRD service subscription. If not yet
subscribed, reject request.

2. Retrieve user profile from database Check LRD


3. end service
Not Exists Exists
subscription
By MSISDN

Parameter
LRD service not yet valid?
subscribed error

Retrieve user profile


from DB

end

Figure 18 LRD service query flow

Change language

1. Validations: USSD **123*4# Web


2. Check parameters, if missing parameters, reject
request.
3. Check MSISDN format, language code and region LRD Service
Language change
code, if invalid, reject request.
4. Check the user LRD service subscription. If not yet
subscribed, reject request.
5. Update language code and region code in user
Check LRD
profile on database service
6. end Not Exists Exists
subscription
By MSISDN

Parameter
LRD service not yet valid?
subscribed error

Yes

Update user profile


on DB

end

Figure 19 LRD service language change flow

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

Update LRD service


and saved in DB

Send SMS to notify


for successful
subscription
renewal

end

Figure 20 Subscription renewal

Cancel registration page redirection


This is designed to be called by VMS web portal
when inbound roamers decide not to subscribe LRD Web
service and press the “Cancel” button on the LRD
registration page. Registration page
cancelled
1. Validations:
a) Check the user LRD service subscription. If
already subscribed, reject request.
2. Insert MSISDN to registration page redirection opt- Check LRD
out list service
Not Exists Exists
subscription
3. end
By MSISDN
Parameter
Insert registration valid?
page redirection
opt-out
Yes

LRD service already


subscribed error

end

41
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Figure 21 Cancel registration page redirection flow

15.3 Probe TDR Event handling


A Probe TDR event handler resides in the LRD core. It listens to the message queue that is embedded inside
the Probe TDR Collation Processor. It actively listens to messages from the message queue and processes
them asynchronously.

LocationUpdate event handling


The following diagram describes the flow after a LocationUpdate event arrives at the message queue after
the Probe TDR Collation Processor has collated the LocationUpdate event related SOAP messages.
UpdateLocation
event

Blacklisted?

No

Check DB for
Not Exists Exists
LRD subscription

Inject ISD to SGSN


Inject ISD to SGSN with
1. actual MSISDN
existing info on DB
2. Reg. page APN
1. virtual MSISDN
3. IMSI
2. VGGSN APN
3. IMSI

Save MSISDN & IMSI


mapping
Update subscriber
profile on DB
WSM
Blacklisted?

No Send SMS to
notify user
Send WSM

end

Figure 22 LocationUpdate event handling flow


 For non-subscribers with PS devices
o LRD platform will inject an ISD to the SGSN based on a set of pre-defined ISD parameters
along with the MSISDN and IMSI which are included in the “UpdateLocation” event.
o The MSISDN used in the ISD is the actual MSISDN of the inbound roamer.
o Inside the GPRS Subscription Data of the ISD, it contains only the APN of the VMS
registration page.
o MSISDN and IMSI mappings retrieved from “UpdateLocation” events are saved on the
database. These mappings will be used when inbound roamers subscribe the service
through the web where only MSISDN is available.
o MSISDN and IMSI mappings are purged periodically. This period is controlled by the “LU
History Period” parameter that can be defined through the web console. Please see
Parameter configurations.
o First-time WSM messages are sent to inbound roamers for their first LU in VMS network.
For subsequent LU, reminder WSM message are sent instead. WSM is controlled by a set
of parameters. Please see WSM global parameters.

42
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

 For existing subscribers


o LRD platform will inject an ISD to the SGSN based on a set of pre-defined ISD parameters
along with the MSISDN and IMSI which are included in the “UpdateLocation” event.
o The MSISDN used in the ISD is the virtual MSISDN that is assigned to the subscriber in the
service subscription.
o Inside the GPRS Subscription Data of the ISD, it contains only the APN of the VMS local
GGSN.
o For every LU, LRD platform will record the timestamp for the subscribers on the database.
o After successfully overriding ISD, LRD platform will send a service activation SMS to the
subscriber to notify the user that LRD service has been activated successfully.

CancelLocation event handling


The following diagram describes the flow after a CancelLocation event arrives at the message queue after
the Probe TDR Collation Processor has collated the CancelLocation event related SOAP messages.

CancelLocation
event

Yes Blacklisted

No

Check LRD
Not Exists service Exists
subscription

Send CL to local
SGSN

Send SMS to
warn user

end

Figure 23 CancelLocation event handling flow


 Upon CancelLocation event, LRD platform will send a MAP_CANCEL_LOCATION to the local
SGSN.
 After a MAP_CANCEL_LOCATION is successfully sent, a service deactivation SMS is sent to the
subscriber and warn the subscriber that LRD service is no longer active.

15.4 Probe TDR Collation Processor


There are two types of messages:
1. LocationUpdate event
2. CancelLocation event.

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)

15.4.1 Device detection


Device type Method
PS and CS sendLU_gprs occurs within 3 seconds after sendLU and sendISD
CS only sendLU_gprs does not occur within 3 seconds after sendLU and sendISD

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.

Probe TDR Format


Tapping probe provides tapped data to LRD platform through a SOAP/HTTP interface

Figure 24 Tapping probe SOAP message types

<?xml version="1.0" encoding="UTF-8" ?>


<wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="tns:ns"
xmlns:s="http://www.w3.org/2001/XMLSchema" targetNamespace="tns:ns"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
<wsdl:types>
<s:schema elementFormDefault="qualified" targetNamespace="tns:ns">
<s:element name="sendLU">
<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="sendCL">

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

15.5 Subscription balance query integration


Yet to be confirmed

15.6 Virtual MSISDN lifecycle management


The pool of virtual MSISDN is managed by integrating with IN dump files provided by VMS IN in a daily basis.
LRD platform will read the dump files and synchronize the data in the files with the virtual MSISDN data on
the database.

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.

Software Module Description

TransactionInfo
Clent Application #1

TcapGatway

NewNet TCAP API Call Clent Application #2

Clent Application #3
NewNet TCAP Layer

SS7 Platform Application Server(s)

Figure 25: Software Module Diagram

Software Module Description


TcapGateway  Core module which
 Store TransactionInfo(s), TcapPackage(s)
 Make use of Vender Specific TCAP API Call to handle SS7 TCAP
messages and events
 Accept connections and handle messages from clients
NewNet TCAP API Call  Used to communicate with the NewNet TCAP layer, for example:
 Registration TCAP layer
 Send and receive TCAP messages to and from TCAP layer
 Extract TCAP messages into SCCP part, dialogue portion and
component portion
TransactionInfo  Used to store the transaction related information, for example:
 Transaction start time
 Originating side
 Client application owner’s specific information
 Invoke ID and operation code mapping
TcapPackage  Used for TCAP messages encoding / decoding to INTM format
 Read protocol stack file for:
 Different application parts (e.g. MAP, INAP)
 Different INTM encoding / decoding methods

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

Figure 26 WSM logic flow

17.1 Dispatch windows


WSMs are sent according to a set of 24 dispatch windows. Each dispatch window covers an hour long
period.

Dispatch Window Open/Closed


00:00 to 00:59
01:00 to 01:59
02:00 to 02:59
03:00 to 03:59

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

17.2 WSM Blacklists


WSM consists of the following blacklists that can be used to prevent WSM from sending WSM messages to
a particular set of subscribers.

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.

17.3 WSM Whitelists


WSM consists of the following whitelists that can be used to allow WSM to send WSM messages to a
particular set of subscribers.

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.

17.4 WSM Blacklist/Whitelist Logic


The following table explains how blacklist and whitelist logics are applied in WSM

Not listed Allowed


Whitelisted only Allowed
Blacklisted only Blocked
Whitelisted + Blacklisted Allowed

17.5 WSM global parameters


The following configuration parameters can be used to control the behaviors of WSM.

WSM_MAX_SEND_COUNT This parameter controls the maximum number of


WSM, including reminder WSM, message that WSM
will send to the same potential subscriber.
WSM_COOLDOWN_MIN This parameter controls the maximum frequency
WSM will send WSM message, including reminder
WSM, to the same potential subscriber.
WSM_MAX_SEND_PERIOD_DAY This parameter controls how frequent WSM will
reset the WSM_MAX_SEND_COUNT counter.

51
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

18. LRD Console

52
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

18.1 Site map

Login Main

Profile Single Virtual


Management MSISDN,
Multiple IMSI Virtual
MSISDN
Virtual management
MSISDN WSM Param.
Config.
WSM Dispatch
WSM Window Config.
Management WSM Blacklist
Management

SMS SMS Language


SMS Template
Management Management

Operator IMSI Blacklist APN Blacklist


Blacklist

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

Figure 27 - Console Design

53
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

18.2 Profile management

1. This page allows console user to manage LRD service subscriber.


2. It allows console user to subscribe or terminate service and modify SMS language of the subscriber.
3. A “Subscribe” section, Subscribing a new subscriber, the following attributes should be inputted:
a. IMSI
b. +MSISDN, eg. +[849000012345 ]
c. SMS Langauge

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

4. A “Search” section, search criteria include:


a. IMSI
b. MSISDN
c. Virtual MSISDN
d. Subscription status
e. Subscription state
f. Subscription start date (from)
g. Subscription start date (to)
h. Subscription end date (from)
i. Subscription end date (to)
5. A “List” section, A list of subscriber is displayed with following details
a. MSISDN
b. IMSI
c. Virtual MSISDN assigned
d. SMS language
e. Subscription status
f. Subscription state
g. Subscription start date
h. Subscription end date

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

6. When a subscriber is selected, more details of subscriber is displayed, including


a. IMSI,
b. MSISDN
c. virtual MSISDN
d. Status,
e. State, ,
f. SMS language.
g. Last LU
h. Last CL
7. When a subscriber is selected, only “SMS language” is editable. A “Unsubscribe” button will display
and allow user to unsubscribe the selected user.
8. Subscriber detail is only editable when the subscribed is in “SUBSCRIBED” state.
9. SMS language of subscribers should map to SMS language set on SMS template page. Default
language will be the language used to send WSM.

Database table schema: SUBSCRIBER_PROFILE

56
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

18.3 Virtual MSISDN management


Virtual MSISDN pool

57
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

1. This page allows console user to manage a pool of virtual MSISDNs.


2. The pool of virtual MSISDNs is managed in a list of “From” and “To” ranges
3. This page should include the following functions:
a. A section for user to create a range of virtual MSISDN by the following methods
i. Form inputs (“From” and “To”)
ii. File imports for multiple records ( csv in the fomat of “<from>,<to>”). File import
will replace all records. It is equivalent to “Delete” and then “Insert”.
For example:
99990001,99991000
99995001,99996000

iii. Validation checking


1. Must be alpha-numeric
2. MSISDN must not start with “0”, (e.g. 09990001)
3. “To” value must be larger than “From” value
4. Single record, check for range overlapping with existing records, if so, error
display
5. Multiple records, check for range overlapping with existing records, if any
of the ranges is overlapping, reject the whole csv, and display error
indicating the last range record which caused the error.
b. A section for user to view, edit and remove the list of existing virtual MSISDN pool
i. View logic
1. Datatable with lazy loading model should be used, edit/remove buttons on
the right of each record.
2. Edit, will bring up a modal window
3. Remove, will bring up a confirmation window
4. Virtual MSISDN “From” and “To” columns should be “filterable” for client
side shortlisting. Datatable in primefaces offers this feature.
ii. Validation
1. Edit/remove, if it consequently excludes any virtual MSISDN that is already
assigned to a subscriber, prompt for error
c. A section for user download the complete list of existing virtual MSISDN pool into csv file

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

Database table schema: VIRTUAL_MSISDN_POOL

Single Virtual MSISDN, Multiple IMSI mapping

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.

18.4 WSM management


WSM parameter configuration
Redirect to Parameter configurations WSM section

60
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

WSM dispatch window configuration

1. This page allows console user to configure WSM dispatch window.


2. Dispatch windows are separated into 24 windows. Each window is an hour long.
Time range (inclusive) WSM allowed
00:00 – 00:59 Yes
01:00 – 01:59 No
02:00 – 02:59 No

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

WSM whitelist management


1. This page allows console user to manage WSM whitelist.
2. It allows user to add, modify or remove whitelist.
3. A table showing MCC/MNC whitelist is displayed.

Figure 28 WSM MCC/MNC whitelist

+ MCC MNC Edit/Delete


Afghanistan (412) 01 {pen} {cross}
Albania (276) {pen} {cross}
a. Add button, popup modal window for input
i. Validation
1. Check duplications
2. MCC must be 3 alpha.
3. MNC must be either 2 alpha or 3 alpha, or empty. Empty means wildcard
4. Maximum number of whitelist records is 500
b. Bulk insert, file import will replace all records. It is equivalent to “Delete” and then “Insert”.
csv file format:
412,01
276,
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

62
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

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
412,01
276,
4. A table showing MSISDN range whitelist is displayed.

Figure 29 WSM MSISDN whitelist

+ MSISDN Prefix Edit/Delete


84912340 {pen} {cross}
84912341 {pen} {cross}
a. Add button, popup modal window for input
i. Validation
1. Check duplications
2. MSISDN Prefix must be alpha-numeric.
3. MSISDN Prefix must not overlap with the existing values
4. Maximum number of whitelist records is 500
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

63
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

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

5. A table showing IMSI range whitelist is displayed.

Figure 30 WSM IMSI whitelist

+ IMSI Prefix Edit/Delete


4520191 {pen} {cross}
4520291 {pen} {cross}

a. Add button, popup modal window for input


i. Validation
1. Check duplications
2. IMSI Prefix must be alpha-numeric.
3. IMSI Prefix must not overlap with the existing values
4. Maximum number of whitelist records is 500
b. Bulk insert, file import will replace all records. It is equivalent to “Delete” and then “Insert”.
csv file format:
4520191
4520291
i. Validation
1. Same validation as a)
2. If any record fails the above, rollback all whole operation and display error

64
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

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
4520191
4520291

WSM blacklist management


6. This page allows console user to manage WSM blacklist.
7. It allows user to add, modify or remove blacklist.
8. A table showing MCC/MNC blacklist is displayed.

Figure 31 WSM MCC/MNC blacklist

+ MCC MNC Edit/Delete


Afghanistan (412) 01 {pen} {cross}
Albania (276) {pen} {cross}
a. Add button, popup modal window for input
i. Validation
1. Check duplications
2. MCC must be 3 alpha, refer to Mobile Country Codes (MCC)
3. MNC must be either 2 alpha or 3 alpha, or empty. Empty means wildcard
4. Maximum number of blacklist records is 500
b. Bulk insert, file import will replace all records. It is equivalent to “Delete” and then “Insert”.

65
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

csv file format:


412,01
276,
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
412,01
276,
9. A table showing MSISDN range blacklist is displayed.

Figure 32 WSM MSISDN blacklist


+ MSISDN Prefix Edit/Delete
84912340 {pen} {cross}
84912341 {pen} {cross}
a. Add button, popup modal window for input
i. Validation
1. Check duplications
2. MSISDN Prefix must be alpha-numeric.
3. MSISDN Prefix must not overlap with the existing values
4. Maximum number of blacklist records is 500

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

10. A table showing IMSI range blacklist is displayed.

+ IMSI Prefix Edit/Delete


4520191 {pen} {cross}
4520291 {pen} {cross}

a. Add button, popup modal window for input


i. Validation
1. Check duplications
2. IMSI Prefix must be alpha-numeric.
3. IMSI Prefix must not overlap with the existing values

67
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

4. Maximum number of blacklist records is 500


b. Bulk insert, file import will replace all records. It is equivalent to “Delete” and then “Insert”.
csv file format:
4520191
4520291
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
4520191
4520291

18.5 SMS template management


SMS Template

Figure 33 SMS template management

68
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Figure 34 Add and Edit SMS template


1. This page allows console user to manage SMS templates.
2. It allows user to add, modify or remove SMS template and group them by languages.
3. These SMS templates will be used in WSM configuration to map with different country, MCC.
4. These templates consist of tags that could be replaced for customization, e.g. {msisdn}, {imsi}.
5. SMS templates can be edited through a text editor that supports multiple languages.
6. A character counter to show the current number of characters in the template
7. When adding a SMS template, the following attributes should be inputted:
a. Language
Sample dropdown list:
Selecting <new> will bring up a modal window to add a new language, which will go to
LANGUAGE database table
Language
<new>
English (en)
Vietnamese (vn)
b. SMS type
i. Welcome SMS
ii. Reminder SMS
iii. Subscription success SMS
iv. Un-subscription success SMS
v. Activation SMS
vi. Inactivation SMS
c. SMS template

69
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

SMS Language management

Figure 35 Default SMS language. MCC and Language mapping


a. Default language, select one of the options in b) as the default language
Default Language: [ Select default language ▼] save
 Show growl message when saved successfully

Database schema & parameter name: GLOBAL_PARAMETERS. DEFAULT_LANGUAGE

b. A section that allows user to insert/update/delete language records in LANGUAGE


+ Name Description Edit / Delete
en English {pen} {cross}
vn Vietnamese {pen} {cross }
 Show growl message when saved successfully
 Deleting the default language is prohibited
 “Name” is unique, mapped to LANGUAGE.NAME

c. MCC language mapping, this sub-section related to b)


 When a row is selected in b), a MCC language mapping table, similar to below, will display and allow
user manage a list of MCC that is a mapping against the selected language.
For example:
+ MCC Language Edit / Delete
Pakistan (410) English (en) {pen} {cross}
Palau (552) Vietnamese (vn) {pen} {cross }
 When no row is selected in b), this section will display a message saying that “Please select a
language above to manage MCC language mapping”
 MCC, refer to Mobile Country Codes (MCC)

Database schema: MCC_LANGUAGE_MAP

18.6 Operator management


Whitelist management

70
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

18.6.1.1 IMSI whitelist management

Figure 36 Operator IMSI whitelist


1. It allows user to add, modify or remove whitelist.
2. A table showing MCC/MNC whitelist is displayed.
+ MCC MNC Edit/Delete
Pakistan (410) 01 {pen} {cross}
Palau (552) {pen} {cross}
a. Add button, popup modal window for input
i. Validation
1. Check duplications
2. MCC must be 3 alpha
3. MNC must be either 2 alpha or 3 alpha, or empty. Empty means wildcard
4. Maximum number of whitelist records is 500
b. Bulk insert, file import will replace all records. It is equivalent to “Delete” and then “Insert”.
csv file format:
412,01
276,
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
412,01
276,

71
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Database table schema: OP_MCC_MNC _WHITELIST

18.6.1.2 APN whitelist management

Figure 37 Operator APN whitelist


1. This page allows console user to manage APN whitelist.
2. It allows user to add, modify or remove APN whitelist.
3. A table showing APN whitelist is displayed.
+ MCC MNC APN Edit/Delete
Afghanistan (412) 01 TELSTRA.DEFAUL {pen} {cross}
Afghanistan (412) 01 TELSTRA.IPH {pen} {cross}
a. Add button, popup modal window for input
i. Validation
1. Check duplications
2. (required) MCC must be 3 alpha
3. (required) MNC must be either 2 alpha or 3 alpha, or empty.
4. (required) APN must not overlap with the existing values
5. Maximum number of whitelist records is 500
b. Bulk insert, file import will replace all records. It is equivalent to “Delete” and then “Insert”.
csv file format:
412,01,TELSTRA.DEFAUL
412,01,TELSTRA.IPH
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

72
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

i. Popup confirmation dialog


e. A button to download the list of data into a csv file
412,01,TELSTRA.DEFAUL
412,01,TELSTRA.IPH

Database table schema: OP_APN _ WHITELIST

Blacklist management
18.6.2 IMSI blacklist management

Figure 38 Operator IMSI blacklist


3. It allows user to add, modify or remove blacklist.
4. A table showing MCC/MNC blacklist is displayed.
+ MCC MNC Edit/Delete
Pakistan (410) 01 {pen} {cross}
Palau (552) {pen} {cross}
a. Add button, popup modal window for input
i. Validation
1. Check duplications
2. MCC must be 3 alpha, refer to Mobile Country Codes (MCC)
3. MNC must be either 2 alpha or 3 alpha, or empty. Empty means wildcard
4. Maximum number of blacklist records is 500
b. Bulk insert, file import will replace all records. It is equivalent to “Delete” and then “Insert”.
csv file format:
412,01
276,
i. Validation

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

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
412,01
276,

Database table schema: OP_MCC_MNC _BLACKLIST

18.6.3 APN blacklist management

Figure 39 Operator APN blacklist


4. This page allows console user to manage APN blacklist.
5. It allows user to add, modify or remove APN blacklist.
6. A table showing APN blacklist is displayed.
+ MCC MNC APN Edit/Delete
Afghanistan (412) 01 TELSTRA.DEFAUL {pen} {cross}
Afghanistan (412) 01 TELSTRA.IPH {pen} {cross}
a. Add button, popup modal window for input
i. Validation
1. Check duplications
2. (required) MCC must be 3 alpha, refer to Mobile Country Codes (MCC)

74
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

3. (required) MNC must be either 2 alpha or 3 alpha, or empty.


4. (required) APN must not overlap with the existing values
5. Maximum number of blacklist records is 500
b. Bulk insert, file import will replace all records. It is equivalent to “Delete” and then “Insert”.
csv file format:
412,01,TELSTRA.DEFAUL
412,01,TELSTRA.IPH
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
412,01,TELSTRA.DEFAUL
412,01,TELSTRA.IPH

Database table schema: OP_APN _BLACKLIST

18.7 Audit trail log


1. This page displays audit trail logs.
2. All user activities performed on the LRD Console are logged as audit trail log in database.
3. Audi trail log can be searched by event time, user id, logged-in IP address, console page on which it
is performed.

Figure 40 Audit trail log

75
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

18.8 User management

UserID GroupID

n 1
Belong User
Console User
To Group

GroupID
Group
Role
RoleID

n 1
User User
Right Has Role

ID RoleID

Figure 41 - User Privilege

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

Figure 42 User management

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

Figure 43 User group management

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.

Figure 44 User role management

18.9 Parameter configurations

Figure 45 WSM Parameter configuration


Separated by sections on the same page
1. APN Redirection

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

Hourly, Daily, Monthly USSD Usage by Service Code Report


Hourly

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

Database table schema: HOURLY_USSD_USAGE

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

Hourly, Daily, Monthly Successful/Reject/Timeout or Failure USSD Transaction Report

Begin- End-time Successful Rejected Timeout or failed Total


time

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

Rejected reasons include:


- blacklisted

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

Database table schema: HOURLY_USSD_TRANSACTION


Database table schema: DAILY_USSD_ TRANSACTION
Database table schema: MONTHLY_USSD_ TRANSACTION

Hourly, Daily, Monthly LRD Activity Summary Report

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

Database table schema: HOURLY_LRD_ACTIVITY


Database table schema: DAILY_LRD_ACTIVITY
Database table schema: MONTHLY_LRD_ACTIVITY

Hourly LRD Status Snapshot Report

Date Subscribed Active Inactive

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”

Database table schema: HOURLY_LRD_STATUS_SNAPSHOT

82
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Hourly, Daily, Monthly SMS Notification Report

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

Database table schema: HOURLY_SMS_NOTIFICATION


Database table schema: DAILY_SMS_NOTIFICATION
Database table schema: MONTHLY_SMS_NOTIFICATION

83
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Hourly, Daily, Monthly TCAP Statistics Report

Begin-time End-time ISD Success ISD Failure CL Success CL Failure Total

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

Database table schema: HOURLY_TCAP_STATISTICS


Database table schema: DAILY_ TCAP_STATISTICS
Database table schema: MONTHLY_ TCAP_STATISTICS

84
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

Monthly LRD subscriber snapshot report

IMSI VMSISDN MSISDN Status State Subscription Subscription Subscription


start date end date Channel

Database table schema: SUBSCRIBER_PROFILE & SUBSCRIBER_PROFILE_HISTORY

 Search by “Subscription Start Date”

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

SVRAP-LRD-TRAP.MIB SVRAP-GEN-TRAP.MIB SVRAP-SMI.mib

Alarm Alarm Alarm Message Situation for alarm trapName/trapDescription


ID Level

85
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

1 INFO LRD core system startup System startup success sysStartUpSuccessNotification


successfully
2 MAJOR LRD core system startup failure System startup Fail sysStartUpFailNotification
1001 MAJOR GTM SNMP connection failure LRD core fails to connect lrdGtmSnmpConnFailure
to GTM over SNMP
1002 MAJOR Probe MQ connection failure LRD core fails to connect lrdProbeMQConnFailure
to probe MQ server
1003 MAJOR Tcap GW connection failure LRD core fails to connect lrdTcapGWConnFailure
to TCAP GW
1004 MAJOR Database connection failure LRD core fails to connect lrdDbConnFailure
to database
1501 MAJOR NMS SNMP connection failure LRD core fails to connect lrdNmsSnmpConnFailure
to external NMS over
SNMP
1502 MAJOR SMSC connection failure LRD core fails to connect lrdSmscConnFailure
to SMSC
2001 CLEAR GTM SNMP connection LRD core to GTM over lrdGtmSnmpConnResumed
Resumed SNMP connection
resumed
2002 CLEAR Probe MQ connection LRD core to probe MQ lrdProbeMQConnResumed
Resumed server connection
resumed
2003 CLEAR Tcap GW connection Resumed LRD core to TCAP GW lrdTcapGWConnResumed
connection resumed
2004 CLEAR Database connection Resumed LRD core to database lrdDbConnResumed
connection resumed
2501 CLEAR NMS SNMP connection LRD core to external lrdNmsSnmpConnResumed
Resumed NMS over SNMP
connection resumed
2502 CLEAR SMSC connection Resumed LRD core to SMSC lrdSmscConnResumed
connection resumed

GTM alarms

SVRAP-GTM-APP-TRAP.MIB SVRAP-GEN-TRAP.MIB SVRAP-SMI.mib

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

20.2 Database schema


SUBSCRIBER_PROFILE
Column Name Column Type Nullable Description
MSISDN String(40) No Primary Key

91
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

MSISDN in the user profile of the user


IMSI String(20) No IMSI in the user profile of the user
VMSISDN String(40) No Virtual MSISDN assigned for LRD service
STATUS String(20) No Status of LRD service user profile
ACTIVE: Active
INACTIVE: Inactive
OUT_OF_CREDITS: Out of Credits
STATE String(20) 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
LANGUAGE String(20) Yes Language
FK: LANGUAGE.NAME
DEVICE_TYPE String(10) Yes CS: CS only
CSPS: CS&PS
PS: PS only
LAST_LU Date Yes Last location update timestamp
LAST_CL Date Yes Last cancel location timestamp
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

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

LANGUAGE String(20) Yes Language


FK: LANGUAGE.NAME
DEVICE_TYPE String(10) Yes CS: CS only
CSPS: CS&PS
PS: PS only
LAST_LU Date Yes Last location update timestamp
LAST_CL Date Yes Last cancel location timestamp
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

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

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_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

Refer to: Mobile Country Codes (MCC)


Name String(40) No Name of the MCC, e.g. Vietnam
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

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

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

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

UPDATE_BY String No User name who last updates this record

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

VALUE String(100) No Parameter value


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

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

Begin datetime of the hour


END DATE No End datetime of the hour
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

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

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

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

ACTIVATION_ SMS Integer No Number of activation SMS sent


INACTIVATION_ SMS Integer No Number of inactivation SMS sent
TOTAL Integer No Sum of all

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:

DB Column TDR Column


LOG_DT {Date/Time}

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}

Column Name Column Type Nullable Description


ID LONG No Primary Key
LOG_DT DATE No Begin datetime of the hour
MSISDN String(20) No MSISDN of the subscriber
IMSI String(40) No IMSI of the subscriber
VMSISDN String(20) No Virtual MSISDN of the subscriber
PRE_APN String(100) No Number of ISD successfully sent
POST_APN String(100) No Number of ISD failed to send
PRE_DEST_IP String(50) No Number of CL successfully sent
POST_DEST_IP String(50) No Number of CL failed to send
ACTION Integer No Action id
0: no action
1: VGGSN page APN
2: registration page APN

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:

DB Column TDR Column


LOG_DT {Date/Time}
LOGGER “GTM”
MSISDN {Pre-MSISDN}
VMSISDN {Post-MSISDN}
IMSI {IMSI}
DETAILS {Post-APN} + “: PDPContextRequest redirected.“

Tengine
TBC

Column Name Column Type Nullable Description


ID LONG No Primary Key
LOG_DT DATE No Log record timestamp
LOGGER String (20) No Logger name
MSISDN String(40) No MSISDN of the subscriber
IMSI String(20) No IMSI of the subscriber
VMSISDN String(40) No Virtual MSISDN of the subscriber

104
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

DETAILS String (200) Yes Log details

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:element name="subscriberProfile" type="subscriberProfile"/>

<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

20.4 Web Configuration Notification Type


Notification Name Description
WSM_PARAMETER A notification of changes on WSM related parameters. Parameter
configurations
WSM_DISPATCH_WINDOW A notification of changes on WSM dispatch windows. WSM dispatch
window configuration
WSM_BLACKLIST_MCC_MNC A notification of changes on WSM MCC/MNC blacklist. WSM
blacklist management
WSM_BLACKLIST_MSISDN A notification of changes on WSM MSISDN blacklist. WSM blacklist
management
WSM_BLACKLIST_IMSI A notification of changes on WSM IMSI blacklist. WSM blacklist
management
WSM_WHITELIST_MCC_MNC A notification of changes on WSM MCC/MNC whitelist. WSM
whitelist management
WSM_ WHITELIST _MSISDN A notification of changes on WSM MSISDN whitelist. WSM whitelist
management
WSM_ WHITELIST _IMSI A notification of changes on WSM IMSI whitelist. WSM whitelist
management
WSM_TEMPLATE A notification of changes on WSM SMS templates, which include
WSM SMS template and WSM remainder SMS template. SMS
Template

107
Syniverse Asia Pacific Limited – Proprietary & Confidential
VMS Local Roaming Data TS/VMS/LRD/20131216/1.0

VMSISDN_MULTI_IMSI_MAPPING A notification of changes on single virtual MSISDN multiple IMSI


mappings. Single Virtual MSISDN, Multiple IMSI mapping
SMS_TEMPLATE A notification of changes on SMS templates other than WSM
templates. SMS Template
SMS_LANGUAGE_PARAMETER A notification of changes on SMS language parameters. SMS
Language management
SMS_LANGUAGE_MAPPING A notification of changes on SMS language mappings. SMS
Language management
VIRTUAL_MSISDN_POOL A notification of changes on virtual MSISDN pool. Virtual MSISDN
management
OPERATOR_WHITELIST_IMSI A notification of changes on operator IMSI whitelist. IMSI whitelist
management
OPERATOR_ WHITELIST _APN A notification of changes on operator APN whitelist. APN whitelist
management
OPERATOR_BLACKLIST_IMSI A notification of changes on operator IMSI blacklist. IMSI blacklist
management
OPERATOR_BLACKLIST_APN A notification of changes on operator APN blacklist. APN blacklist
management
APN_REDIRECT_PARAMETER A notification of changes on APN redirect related parameters.
Parameter configurations
LRD_SERVICE_PARAMETER A notification of changes on LRD service related parameters.
Parameter configurations

--- End of document ---

108
Syniverse Asia Pacific Limited – Proprietary & Confidential

You might also like