Sie sind auf Seite 1von 740

Home Location Register

(Linux) V1.1
Support Guide
2

HLR

ii

Vodafone Limited
Vodafone House
The Connection
Newbury
Berkshire
RG14 2FN
England
Tel: +44 (0)1635 33251
Fax: +44 (0)1635 686486
Email: Documentation Development@vodafone.com
2007 Vodafone Limited.
All rights reserved. Copyright in the whole and every part of this document belongs to
Vodafone Limited (the Owner) and may not be used, sold, transferred, copied or reproduced
in whole or in part in any manner or form or in or on any media to any person without the prior
written consent of the Owner.
Product names used in this document are for identification purposes only and may be
trademarks of their respective companies.
Owing to Vodafone Limiteds policy of continual improvement of its products, the information
contained in this document is subject to change at any time and without notice.

Document Information
Document Number

Issue

Date

S/W
Version

TD/TS/HLR/4330

07/06

V1.1

Notes
Changes due to DB Sync, Admin
Forwarding, Soft SDM, Next Generation
Voicemail

Related Documentation
For Information
About

See

Intended Audience

Linux commands
mentioned in the
document

man pages for the relevant


command. For example, to
see details of the logview
command, enter the
command man logview
at the Linux prompt.

Support staff.

SNMP Agent

HLR SNMP Agent Users


Manual and PDS SNMP
Agent Developers Manual.

Support staff and developers.

Home Location Register (Linux) V1.1 Support Guide

Changes from the previous issue

iii

Changes from the previous issue


Major changes from the previous issue of this Guide are:

Alarms:
New PDSD and MGTA alarms: see page 145 to page 156, and page 161.

Tables
There were changes to the following tables:
adm_client page 463
hlr_config page 471
pds_config page 523
pipc page 527
hlr_definitions page 493 (Note: this table has been renamed to pds_defs)
voicemail page 560
ussd page 534

USSD Information
There were changes to the USSD description in USSD Information on page 627

Home Location Register (Linux) V1.1 Support Guide

iv

Home Location Register (Linux) V1.1 Support Guide

Changes from the previous issue

Quick Contents
Changes from the previous issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Using this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Chapter 1

Overview of the HLR . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Chapter 2

HLR Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Chapter 3

System Architecture . . . . . . . . . . . . . . . . . . . . . . . . . 71

Chapter 4

Support Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Chapter 5

Identifying Problems . . . . . . . . . . . . . . . . . . . . . . . . . 85

Chapter 6

Using Support Interfaces . . . . . . . . . . . . . . . . . . . . . 97

Chapter 7

Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Chapter 8

SIGTRAN Configuration . . . . . . . . . . . . . . . . . . . . . 167

Chapter 9

Administration Interface . . . . . . . . . . . . . . . . . . . . . 175

Chapter 10

List of HLR Administration Commands. . . . . . . . . 189

Chapter 11

SIM Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Chapter 12

Subscriber Commands . . . . . . . . . . . . . . . . . . . . . . 205

Chapter 13

Overlapping IMSI Commands. . . . . . . . . . . . . . . . . 273

Chapter 14

MSISDN Commands . . . . . . . . . . . . . . . . . . . . . . . . 279

Chapter 15

Service Request Number Commands . . . . . . . . . . 289

Chapter 16

PDP Context Commands . . . . . . . . . . . . . . . . . . . . 297

Chapter 17

Basic Service Commands. . . . . . . . . . . . . . . . . . . . 309

Chapter 18

Supplementary Service Commands . . . . . . . . . . . 315

Home Location Register (Linux) V1.1 Support Guide

vi

Quick Contents

Chapter 19

CAMEL Commands . . . . . . . . . . . . . . . . . . . . . . . . . 331

Chapter 20

Network Entity Command . . . . . . . . . . . . . . . . . . . . 409

Chapter 21

P Number Commands . . . . . . . . . . . . . . . . . . . . . . . 415

Chapter 22

Subscriber Data Move (SDM) Commands . . . . . . . 419

Chapter 23

General Commands. . . . . . . . . . . . . . . . . . . . . . . . . 425

Chapter 24

Table Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . 451

Appendix A

Using PULSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569

Appendix B

Interpreting SCCP Addresses . . . . . . . . . . . . . . . . 577

Appendix C

Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . 583

Appendix D

Backing-up the HLR Database . . . . . . . . . . . . . . . . 585

Appendix E

Basic and Supplementary Services . . . . . . . . . . . . 591

Appendix F

Quality of Service . . . . . . . . . . . . . . . . . . . . . . . . . . 601

Appendix G

Attribute Bit Numbers in the Subscriber Database611

Appendix H

USSD Information . . . . . . . . . . . . . . . . . . . . . . . . . . 627

Appendix I

Operator Determined Bars . . . . . . . . . . . . . . . . . . . 647

Appendix J

Performance Checks . . . . . . . . . . . . . . . . . . . . . . . . 653

Appendix K

Event Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655

Appendix L

Backing Up PDS Platforms . . . . . . . . . . . . . . . . . . . 679

Appendix M

GSM Number Definitions . . . . . . . . . . . . . . . . . . . . 685

Appendix N

Abbreviations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Readers Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719

Home Location Register (Linux) V1.1 Support Guide

vii

Contents
Changes from the previous issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Quick Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Using this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Levels of Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xviii
Conventions Used in this Document . . . . . . . . . . . . . . . . . . . . . . xx

Chapter 1

Overview of the HLR . . . . . . . . . . . . . . . . . . . . . . . . . . 1


Introduction to the HLR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Network Signalling and the HLR . . . . . . . . . . . . . . . . . . . . . .3
Consequences of an HLR Failure . . . . . . . . . . . . . . . . . . . . .4
Summary of Subscriber and Configuration Data . . . . . . . . . .4
Network Services Provided by the HLR . . . . . . . . . . . . . . . . . . . . .6
Anonymous Call Reject (ACR). . . . . . . . . . . . . . . . . . . . . . . .6
Call Forwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Number Translation for Call Forwarding . . . . . . . . . . . . . . . .8
Forward-To Number Behaviour Modes . . . . . . . . . . . . . . . . .8
Barring Forward-To Numbers . . . . . . . . . . . . . . . . . . . . . . . .9
Default Call Forwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Explicit Call Transfer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
CAMEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
CAMEL Phases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Vodafone Services and CAMEL . . . . . . . . . . . . . . . . . . . . .17
CAMEL Signalling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
Downloaded CAMEL Data . . . . . . . . . . . . . . . . . . . . . . . . . .21
CAMEL Phase One Example - PAYT Roaming. . . . . . . . . .26
General Packet Radio Service (GPRS) . . . . . . . . . . . . . . . . . . . .29
Linked Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
Administration Commands for Linked Subscriptions . . . . . .31
Home Zone Charging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
Signalling for Home Zone Charging. . . . . . . . . . . . . . . . . . .34
Location Based Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Mobile Terminated Location Requests . . . . . . . . . . . . . . . .37
Subscriber Location Privacy Profile (SLPP). . . . . . . . . . . . .37
Registering Subscribers with the LES . . . . . . . . . . . . . . . . .38

Home Location Register (Linux) V1.1 Support Guide

viii

Contents

Mobile Number Portability (MNP) . . . . . . . . . . . . . . . . . . . . . . . . .40


HLR Data Changes When a Subscriber Migrates . . . . . . . .41
Signalling for Location Based Services . . . . . . . . . . . . . . . .44
MultiSIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Administration Commands for MultiSIM. . . . . . . . . . . . . . . .47
Incoming Call to MultiSIM Subscription . . . . . . . . . . . . . . . .48
Incoming SMS to a MultiSIM Subscription. . . . . . . . . . . . . .48
Alert Service Centre for a MultiSIM Subscription. . . . . . . . .49
PrePay Service Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Mobile Originated SMS Messages. . . . . . . . . . . . . . . . . . . .51
Mobile Terminated SMS Messages . . . . . . . . . . . . . . . . . . .53
Mobile Terminated Calls . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Service Provider Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
Control of Access to Premium Rate/Content . . . . . . . . . . . . . . . .61
Control by Charging Rate . . . . . . . . . . . . . . . . . . . . . . . . . .61
Access Control While Roaming . . . . . . . . . . . . . . . . . . . . . .63
Video Telephony . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64

Chapter 2

HLR Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Alarms Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
SNMP Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

Chapter 3

System Architecture . . . . . . . . . . . . . . . . . . . . . . . . . 71
Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73
Directory Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
Directory Paths Defined in PDS. . . . . . . . . . . . . . . . . . . . . .74
Logical Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
Database File Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

Chapter 4

Support Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Connecting to the HLR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
The Remote Engineer Interface . . . . . . . . . . . . . . . . . . . . . . . . . .80
The pds_manager Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83
Accessing the Administration Interface . . . . . . . . . . . . . . . .83

Chapter 5

Identifying Problems . . . . . . . . . . . . . . . . . . . . . . . . . 85
Identifying and Investigating Problems. . . . . . . . . . . . . . . . . . . . .85

Home Location Register (Linux) V1.1 Support Guide

Contents

ix

Possible Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87


Software Start-up Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88
Lack of Disk Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88
Start-Up Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89
Computer Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91
Data Network Communication Failure . . . . . . . . . . . . . . . . . . . . .91
SIGTRAN Network Connection Failure . . . . . . . . . . . . . . . . . . . .91
Interface Card Failure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92
Investigation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . .92
Database Corruption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93
Alarm Flooding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94
Event Log Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95

Chapter 6

Using Support Interfaces . . . . . . . . . . . . . . . . . . . . . 97


Problem Solving Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
Checking HLR Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98
Making IncomingTest Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
Showing HLR Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
Automatic Cutovers (Live Node). . . . . . . . . . . . . . . . . . . . . . . . .104
Automatic Restarts (Standby Nodes) . . . . . . . . . . . . . . . . . . . . .105
Showing M3UA Association . . . . . . . . . . . . . . . . . . . . . . . . . . . .106
Peer-to-Peer (IPSP) Mode. . . . . . . . . . . . . . . . . . . . . . . . .106
Signalling Gateway Mode . . . . . . . . . . . . . . . . . . . . . . . . .111
Controlling the HLR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
Restarting the HLR Application . . . . . . . . . . . . . . . . . . . . . . . . .115
Cutting-over the HLR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116
Stopping the HLR Application. . . . . . . . . . . . . . . . . . . . . . . . . . .117
Restoring the HLR Database . . . . . . . . . . . . . . . . . . . . . . . . . . .118
Checking and Managing the HLR. . . . . . . . . . . . . . . . . . . . . . . .120
Checking for the Live Node . . . . . . . . . . . . . . . . . . . . . . . . . . . .121
Displaying System Status Graphs . . . . . . . . . . . . . . . . . . . . . . .122
Displaying Hardware/Software Versions . . . . . . . . . . . . . . . . . .125
Showing Install History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
Displaying an Availability Report . . . . . . . . . . . . . . . . . . . . . . . .127
Setting the System Date and Time. . . . . . . . . . . . . . . . . . . . . . .129
Viewing Service Request Numbers . . . . . . . . . . . . . . . . . . . . . .130
Viewing HLR Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131

Chapter 7

Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Home Location Register (Linux) V1.1 Support Guide

Contents

Alarm Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134


Alarm Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135
Alarm Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136
Viewing Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137
Alarm Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138

Chapter 8

SIGTRAN Configuration . . . . . . . . . . . . . . . . . . . . . 167


SIGTRAN and the Vodafone Application . . . . . . . . . . . . . . . . . .170
Vodafone pds_i_s7mp Process . . . . . . . . . . . . . . . . . . . . .170
SIGTRAN Startup and Configuration . . . . . . . . . . . . . . . . . . . . .172
Updating SIGTRAN Configuration Files . . . . . . . . . . . . . . . . . . .173

Chapter 9

Administration Interface . . . . . . . . . . . . . . . . . . . . . 175


Client Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175
Accessing the Administration Interface . . . . . . . . . . . . . . . . . . .176
Command Notation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .177
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178
Response Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179
Response Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179

Chapter 10

List of HLR Administration Commands. . . . . . . . . 189

Chapter 11

SIM Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193


ADD:SIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194
REMOVE:SIM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196
UPDATE:SIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198

Chapter 12

Subscriber Commands . . . . . . . . . . . . . . . . . . . . . . 205


CREATE:SUB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206
COPY:SUB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208
DELETE:SUB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
LOCK:SUB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .213
UNLOCK:SUB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214
UPDATE:SUB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215
UPDATE:ZONELIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .228
VIEW:SUB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .231
AUCUPDATE:SUB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .266
SET:TRACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .269

Chapter 13

Overlapping IMSI Commands. . . . . . . . . . . . . . . . . 273

Home Location Register (Linux) V1.1 Support Guide

Contents

xi

ADD:OVERLAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .274
REPLACE:OVERLAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .276
REMOVE:OVERLAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .278

Chapter 14

MSISDN Commands . . . . . . . . . . . . . . . . . . . . . . . . 279


ADD:MSISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .280
REMOVE:MSISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .282
UPDATE:MSISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .284
VIEW:MSISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .286

Chapter 15

Service Request Number Commands . . . . . . . . . . 289


CREATE:SRN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .290
DELETE:SRN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .291
UPDATE:SRN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .292
VIEW:SRN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .294

Chapter 16

PDP Context Commands . . . . . . . . . . . . . . . . . . . . 297


ADD:PDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .298
SET:PDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .300
UPDATE:PDP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .302
REMOVE:PDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .306

Chapter 17

Basic Service Commands. . . . . . . . . . . . . . . . . . . . 309


ADD:SERVICE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .310
REMOVE:SERVICE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .312

Chapter 18

Supplementary Service Commands . . . . . . . . . . . 315


PROVISION:SS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .318
WITHDRAW:SS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .320
REGISTER:SS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .322
ERASE:SS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .325
ACTIVATE:SS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .327
DEACTIVATE:SS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .329

Chapter 19

CAMEL Commands . . . . . . . . . . . . . . . . . . . . . . . . . 331


ADD:CAMEL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .332
SET:CAMEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .362
REMOVE:CAMEL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .373
UPDATE:CAMEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .375

Home Location Register (Linux) V1.1 Support Guide

xii

Chapter 20

Contents

Network Entity Command . . . . . . . . . . . . . . . . . . . . 409


VIEW:NETWORK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .409

Chapter 21

P Number Commands . . . . . . . . . . . . . . . . . . . . . . . 415


ADD:PNUM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .416
REMOVE:PNUM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .418

Chapter 22

Subscriber Data Move (SDM) Commands . . . . . . . 419


EXECUTE:SDM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .420
COMPLETE:SDM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .422
ROLLBACK:SDM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .423

Chapter 23

General Commands. . . . . . . . . . . . . . . . . . . . . . . . . 425


INITIATE:ALERT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .426
INITIATE:CANCEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .428
INITIATE:RESET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .430
SET:DATABASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .432
SET:MWD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .433
ADD:BAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .435
REMOVE:BAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .437
RESET:SEED. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .439
SET:SEED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .440
UPDATE:IMEI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .441
UPDATE:LCN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .443
UPDATE:LOCATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .445
VIEW:INFO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .448

Chapter 24

Table Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . 451


HLR Data Tables Quick Reference . . . . . . . . . . . . . . . . . . . . . .452
Table Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .454
Changing Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .456
Table Maintenance Commands . . . . . . . . . . . . . . . . . . . . . . . . .460
HLR Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .463
adm_client Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .463
Address String Convert (ascvt) Table . . . . . . . . . . . . . . . .465
Bearer Capabilities (bca) Table . . . . . . . . . . . . . . . . . . . . .465
B Number Table (bnum) . . . . . . . . . . . . . . . . . . . . . . . . . .466
C Number Table (cnum) . . . . . . . . . . . . . . . . . . . . . . . . . .467
C Number Behaviour Table (cnum_bhvr) . . . . . . . . . . . . .469

Home Location Register (Linux) V1.1 Support Guide

Contents

xiii

hlr_config Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .471


pds_defs Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .493
hlr_node Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .495
hsscfg Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .495
SIGTRAN Event Configuration Table (pds_sigtran_event) 502
io_convert Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .503
timer Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .505
Master Key (mkey) and Transport Key (tkey) Tables . . . .508
msrnpfx Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .508
MVNO Identification (mvno_id) Table . . . . . . . . . . . . . . . .508
Network Entity (netent) Table . . . . . . . . . . . . . . . . . . . . . .509
Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .509
PDS Configuration (pds_config) Table . . . . . . . . . . . . . . .523
pipc Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .527
sccpr_node Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .528
sdm_dest Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .529
SMS Barring (smsbar) Table . . . . . . . . . . . . . . . . . . . . . . .529
SMS Barring Response (smsbar_resp) Table . . . . . . . . . .530
Service Provider (sp) Table . . . . . . . . . . . . . . . . . . . . . . . .532
SS7 Configuration (ss7cfg) Table . . . . . . . . . . . . . . . . . . .533
SS7 Event Configuration File (pds_ss7_event) . . . . . . . . .534
Unstructured Supplementary Service Data (ussd) Table. .534
voicemail Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .560

Appendix A

Using PULSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569


Setting Up PULSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .570
Network Entity Information. . . . . . . . . . . . . . . . . . . . . . . . .570
Starting PULSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .571
PULSE Menu Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .573
PULSE Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .574

Appendix B

Interpreting SCCP Addresses . . . . . . . . . . . . . . . . 577


Formatted SCCP Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . .578
Unformatted SCCP Addresses. . . . . . . . . . . . . . . . . . . . . . . . . .579

Appendix C

Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . 583

Appendix D

Backing-up the HLR Database . . . . . . . . . . . . . . . . 585


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .585
Creating a New Database . . . . . . . . . . . . . . . . . . . . . . . . .585

Home Location Register (Linux) V1.1 Support Guide

xiv

Contents

Automatic Secure to Disk Mechanism . . . . . . . . . . . . . . . . . . . .586


Automatic Backup Mechanism . . . . . . . . . . . . . . . . . . . . . . . . . .586
Standby Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .588
External Backup Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . .589
Determining the Valid Backup . . . . . . . . . . . . . . . . . . . . . . . . . .589

Appendix E

Basic and Supplementary Services . . . . . . . . . . . . 591


Basic Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .591
Supplementary Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .594
Backward Compatibility of TICK and TICKROAM . . . . . . .599

Appendix F

Quality of Service . . . . . . . . . . . . . . . . . . . . . . . . . . 601

Appendix G

Attribute Bit Numbers in the Subscriber Database611


Basic Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .611
Supplementary Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .613
Supplementary Service Notification flags . . . . . . . . . . . . .614
Supplementary Service Behaviour Modes. . . . . . . . . . . . .615
Operator Determined Bars . . . . . . . . . . . . . . . . . . . . . . . . . . . . .616
Visited MSC Flags and Network Entity Attributes. . . . . . . . . . . .618
CAMEL Phases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .620
Unsupported Application Context Names . . . . . . . . . . . . . . . . .621
CAMEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .624
Unsupported Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .625

Appendix H

USSD Information . . . . . . . . . . . . . . . . . . . . . . . . . . 627


USSDs Processed by the HLR. . . . . . . . . . . . . . . . . . . . . . . . . .628
SMS Bureau/Respond Plus . . . . . . . . . . . . . . . . . . . . . . . .628
Last Caller Information. . . . . . . . . . . . . . . . . . . . . . . . . . . .630
Calling Line Identity Restriction . . . . . . . . . . . . . . . . . . . . .632
CLIP Restriction Override . . . . . . . . . . . . . . . . . . . . . . . . .633
Anonymous Call Reject (ACR). . . . . . . . . . . . . . . . . . . . . .635
RECALL Voicemail Service . . . . . . . . . . . . . . . . . . . . . . . .635
Service Provider Information . . . . . . . . . . . . . . . . . . . . . . .637
Location Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . .637
Operation and Maintenance Information . . . . . . . . . . . . . .637
On/Off Net Information. . . . . . . . . . . . . . . . . . . . . . . . . . . .638
MultiSIM Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .638
NGVM Phase 1a Services . . . . . . . . . . . . . . . . . . . . . . . . .640
USSDs Processed Outside the HLR . . . . . . . . . . . . . . . . . . . . .642

Home Location Register (Linux) V1.1 Support Guide

Contents

xv

Call Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .642


Linked Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . .642
PAYT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .643
Positioning Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .643
NGVM Phase 1b Services . . . . . . . . . . . . . . . . . . . . . . . . .644
USSD Callback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .645
Missed Call Server Commands . . . . . . . . . . . . . . . . . . . . .645
Chameleon Commands . . . . . . . . . . . . . . . . . . . . . . . . . . .646
MVPN Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .646

Appendix I

Operator Determined Bars . . . . . . . . . . . . . . . . . . . 647


ODB Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .648
IN Bars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .651

Appendix J

Performance Checks . . . . . . . . . . . . . . . . . . . . . . . . 653

Appendix K

Event Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655


Event Logging Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . .655
How to Use Event Log Files. . . . . . . . . . . . . . . . . . . . . . . .656
Configuring Log Masks . . . . . . . . . . . . . . . . . . . . . . . . . . .657
Example Event Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .662

Appendix L

Backing Up PDS Platforms . . . . . . . . . . . . . . . . . . . 679


Subscriber Database and System Log Files . . . . . . . . . . . . . . .680
Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .681
Process Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .682
Crash Dump Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .683
Restoring a Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .684

Appendix M

GSM Number Definitions . . . . . . . . . . . . . . . . . . . . 685

Appendix N

Abbreviations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Readers Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719

Home Location Register (Linux) V1.1 Support Guide

xvi

Home Location Register (Linux) V1.1 Support Guide

Contents

xvii

Using this Guide


This guide describes the Linux version of the Home Location Register
(HLR) in a GSM network. It is for network staff who manage and
maintain the GSM HLR.
If you want to...

You should see...

See a definition of an acronym or


abbreviation.

Appendix N, Abbreviations on page 689.

Find out if this is the correct Document


for the HLR system you are using.

Accessing the Administration Interface on page 176 and the


VIEW:INFO command description on page 448.
Also see Displaying Hardware/Software Versions on page 125.

Find out what changes have been


made to this Guide since the previous
issue.

Changes from the previous issue on page 1.

Get an overview of the HLR.

Chapter 1, Overview of the HLR.

Connect to an HLR node and use the


HLR accounts.

Chapter 4, Support Interfaces.

Identify problems with the HLR.

Chapter 5, Identifying Problems.

Deal with alarms raised by the HLR.

Chapter 7, Alarms.

Correct problems on the HLR.

Chapter 6, Using Support Interfaces.

Use the Administration Interface.

Chapter 9, Administration Interface.

Use the Table Maintenance Interface.

Chapter 24, Table Maintenance.

Comment on this document.

the Readers Comments form at the back of the Guide and return
it to the address given.

Important Notes

Note that this Guide:


Describes the HLR configuration as shipped by Vodafone. It may be
supplemented or even replaced by local documentation.
Provides advice on how to identify and fix common problems with
the HLR. However, it cannot cover every circumstance that could
affect the system.
If this Guide does not describe a problem you encounter, check first
with your local operating procedures before taking any other action.

Home Location Register (Linux) V1.1 Support Guide

xviii

Using this Guide

Levels of Support
There are three levels of support - First, Second and Third. Higher
levels of support require greater expertise, and run a higher risk of
damage if unauthorised personnel access the platform, or support staff
make mistakes.
First line support is the responsibility of the network operator, and
typically provided using the Remote Engineer account, which grants
limited access to the system.
Second and Third line support are provided by Vodafone in the
United Kingdom, using the pds_manager account, which grants
command-line access to the system. See The pds_manager
Account on page 83 for details.
Note: Some network operators provide their own Second-line support.
Depending on the severity of the problem, you may need to escalate or
report the problem to the next level of support.

Escalating and Reporting Problems


If you cannot solve a problem using either the procedures in this
Document or your local operating procedures you should pass it to the
next line of support (see Levels of Support above). Either:
escalate the problem - pass it on immediately
report the problem - pass it on:
- immediately, if it occurs during normal working hours.
- at the start of the next working day, if it occurs out of normal
working hours.
Whether you escalate or report a problem depends on its severity.
Escalate only those problems that have a serious impact on
network operation or quality of service. Report all other problems.
Whether you escalate or report a problem you should provide as much
information as possible:
details of any relevant alarms
what you have done so far to investigate the problem
any other relevant information.

Home Location Register (Linux) V1.1 Support Guide

Using this Guide

xix

Alarm Reporting
You should consult your local OMC documentation for more information
on your alarm interface. Figure 44 on page 134 shows some of the
alternatives for distributing alarms.

ISAAC
This Guide assumes that you are using Vodafones International
Subscriber Administration And Control system (ISAAC) to provide GSM
Administration Centre (ADC) functionality in your network. If you are
using a different ADC system, the subscriber administration interface
may be different. See your local documentation for details.

Home Location Register (Linux) V1.1 Support Guide

xx

Using this Guide

Conventions Used in this Document


The following type faces have special uses in this Guide:
Typeface

Used For

variable

a variable which you should substitute with the required value.

system output

command, file and directory names, file contents, system prompts


and responses.

0HQXWH[W

menu options, GUI window text, and alarm codes and text.

user input

text which you should type in exactly as shown.

The following abbreviations are used to represent keystrokes:


Abbreviation

Means

CTRL+X

Hold down the CTRL key and then press the second key (X in this
example).

SHIFT+X

Hold down the SHIFT key and then press the second key (X in this
example).

Home Location Register (Linux) V1.1 Support Guide

Chapter 1

Overview of the HLR


This chapter provides:
A quick summary of the role of the HLR in the GSM network. See
Introduction to the HLR on page 2.
Brief descriptions of the services that the HLR provides to the GSM
network. See Network Services Provided by the HLR on page 6.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

Introduction to the HLR


This section explains:
What HLR means and its purpose
External connections to the HLR
Network signalling that involves the HLR (see page 3)
Data in the HLR (see page 4)

What HLR Means

HLR means Home Location Register.

Why the HLR is


Needed

A network typically has millions of subscribers and the network must


contain, somewhere, a database with a record for each individual
subscriber. This database is known as an HLR. A record contains
which network services a subscriber can use, such as speech and
short messages, and the current location of the subscriber. Network
services can be enabled or disabled by the network operator.
When a subscriber receives a call, the HLR provides the subscribers
current location so the call can be connected, or diverts the call to the
subscribers mailbox so that the caller can leave a message. The HLR
must therefore keep track of subscribers as they move around. The
subscriber database is usually spread over many HLRs because one is
not big enough to hold every subscriber, and would represent a
significant risk if it should fail.

Figure 1. How the HLR Connects to Network Entities


Mailbox Location
Register

MSC/VLR
Alarm
Monitoring and
Admin.
Commands

HLR

SGSN

Short Message
Service Centre

SEP

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

Network Signalling and the HLR


The HLR receives and sends messages in the following cases:

Subscriber
Changes
Location

When a subscriber moves from one VLR to another, the new VLR
sends an update location message to the HLR to inform the HLR of the
subscribers new location, and the HLR downloads data, such as the
services that the subscriber can use, to the VLR.
Update Location
Mobile Handset
IMSI (Update
Location)

Incoming Call

Send Subscriber Data to VLR

An incoming call finds the called subscriber using a send routing


information message to the HLR. The HLR signals to the VLR that the
subscriber is registered on, and that VLR replies with a roaming
number, which enables the network to connect the call.
Incoming
call to an
MSISDN

Provide Roaming
Number

Send Routing
Information

VLR

HLR
Roaming
Number

Roaming
Number

Location Based
Services

HLR

A request for location information is made by sending a send routing


information for LCS (location services) message to the HLR, which
returns the address of the VLR that the subscriber is registered on.
Request location Send Routing Information for LCS
information for
an MSISDN

HLR

VLR address

A VLR address is not returned for certain types of subscriber, for


example if the MSISDN sent to the HLR is a published number for a
linked subscription.

Forward a Call

If a subscriber diverts calls to a forwarding number or a mailbox


number, the HLR stores the forwarding or mailbox number. Incoming
calls are then connected using this number.
Send Routing Information
Incoming call to
an MSISDN

HLR
Forwarding or Mailbox Number

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

Linked
Subscriptions

A linked subscription contains two or more mobile handsets that are


called using a single published number. Calls to the published number
are connected to whichever handset is nominated to receive calls. The
diagram below shows the linked subscription configuration for the UK
network.

HLR
(nominated number)
Send Routing
Information

Incoming call to
an MSISDN

HLR
(published number)

SEP

Roaming Number

Consequences of an HLR Failure


If an HLR fails, mobile handsets on that HLR (perhaps 1,000,000
subscribers or beyond) cannot receive calls because the incoming call
cannot find them. Handset authentication will not be possible for
outgoing calls, but MSCs are usually allowed to reuse authentication
triplets and permit the call. Handsets on that HLR cannot register on a
new VLR and will, therefore, be unable to make or receive calls if they
move to a new VLR location.

Summary of Subscriber and Configuration Data


Subscriber Data
IMSI

Published MSISDN

List of ODBs

VLR Characteristics

Location Data

GPRS Settings

List of Basic Services

Tracing Settings

Message Waiting Data

Call Forwarding Settings

List of Supplementary Services

CAMEL Settings

Configuration
Data
Address String Convert Table
(ASCVT)

Used to convert address strings to international format.

B Number Table

Numbers to check for IN originated calls.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

Bearer Capabilities Table (BCA)

Bearer Capability is sent to the VLR during call setup to


establish correct characteristics for the type incoming call.
The BCA table has various entries for text, speech and
data.

C Number Behaviour Table

forward-to number translation that can be applied to


individual subscribers.

C Number Table

Numbers that cannot be forwarded to.

HLR Configuration Table

The HLR is configurable to adapt to changes in number


prefixes and network services.

SIGTRAN Configuration Table

SIGTRAN configuration information.

E.164 Conversion Numbers Table

E.164 conversion numbers.

Master Key and Transport Key


Tables

Tables used for subscriber key encryption (SKE).

Mobile Station Roaming


NumberPrefix Table

Lists prefixes of roaming numbers used by subscribers.

Network Entity Table

Configuration of other entities in the network, including


global titles and logging setup.

PDS Configuration Table

Global title of the HLR, used when sending messages to


other entities, logging masks and a default IMSI used when
an exported subscriber causes a message to be sent to
another network.

Service Provider Table

Lists a code, text containing name and telephone number,


and voicemail message code for all service providers.

SS7 Configuration and SS7 Event


Configuration Tables

Define SS7 links, destinations and events.

Timer Table

Configures all HLR timers, such as delays between


Voicemail alerts.

Unstructured Supplementary
Service Table

Contains unstructured supplementary service names, and


the key presses and response syntax for each service.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

Network Services Provided by the HLR


This section describes the services that the HLR provides to the
network:
Anonymous Call Reject (ACR) on page 6
Call Forwarding on page 7
CAMEL on page 13
Control of Access to Premium Rate/Content on page 61
Explicit Call Transfer on page 11
General Packet Radio Service (GPRS) on page 29
Home Zone Charging on page 33
Location Based Services on page 36
Mobile Number Portability (MNP) on page 40
MultiSIM on page 46
Service Provider Services on page 56
Video Telephony on page 64

Anonymous Call Reject (ACR)


Note: Although USSD tokens have been added for the ACR service,
this service is not yet available to subscribers.
A subscriber might not want to receive calls from callers who have
withheld their calling line identity, or CLI. One possible use of this
service is to prevent nuisance calls.
ACR is a Vodafone proprietary supplementary service and is enabled
and disabled by the subscriber using USSD commands. ACR is not
downloaded to the VLR or sent to the GMSC, because anonymous
calls can be rejected at the HLR.

Handling
Anonymous
Calls

A call to a customer who has the ACR service activated fails at the HLR
if the CLI is withheld by the CLI Restriction supplementary service (see
Calling Line Identity Restriction on page 632), or if a callers number is
withheld. The callers number includes checking the calling party
number (CgPN), and the generic number (GN) or presentation number
(PN) or both (see Displayed Number on page 631).
The HLR returns a CallBarred error to the SRI request if calling party
information has been withheld. The handling of the CallBarred error
depends on the network. Vodafone UK adds extra information to the

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

CallBarred error to indicate the reason that the call was rejected. This
reason is then translated by the MSC into a message telling the caller
why the call failed.

ACR and Last


caller
Information

The HLR does not update last caller information if a call attempt fails
because the callers number was withheld. As a result, no record exists
that the call was made.

ACR and
OVERRIDE

The purpose of the OVERRIDE service is to display the callers


number, even if the caller withheld that number. It therefore does not
make sense for a customer with OVERRIDE to use the ACR service to
reject anonymous calls.
The HLR does not prevent a subscriber having both ACR and
OVERRIDE services but a call does not fail due to ACR for a customer
with OVERRIDE.

Interaction of
ACR and CAMEL

Because ACR is a supplementary service, CAMEL takes precedence


over ACR, so that CAMEL services will still be invoked even if a callers
number is withheld.
Note: The PDS HLR does not differentiate between call types
(determined by basic service group) when ACR is provisioned.
Note: Voicemail alerts will be blocked if the CLI is determined to be
withheld.
The USSD commands used to control the ACR service are defined in
Anonymous Call Reject (ACR) on page 635.

Call Forwarding
Mobile handset menus allow subscribers to forward calls to a new
number, known as a forward-to number or C number. All calls can be
forwarded, or calls can be forwarded depending on certain conditions,
such as if the called party is busy with another call.
In order to forward calls, a subscriber must have the necessary call
forwarding supplementary services provisioned (see Supplementary
Services on page 594).

Standard
Forward-To
Numbers

A standard forward-to number conforms to the E.164 standard. E.164


standard numbers have up to 15 digits, consisting of a country code, a
national destination code and a subscriber number:
44 385 106099

Country
code

National
destination code

Subscriber
number

Home Location Register (Linux) V1.1 Support Guide

Non-Standard
Forward-To
Numbers

Chapter 1 Overview of the HLR

forward-to numbers that do not conform to E.164 can be used in a


subscribers home network if the following conditions are met:
The subscriber has the Ability to Register Special/Extended
Numbers in Call-forwards (ARSENIC) supplementary service
The FTN length is within the range defined by FTN_SE_MIN_LEN,
FTN_SE_MAX_LEN in the hlr_config Table
Roamed subscribers can forward to non-E.164 numbers provided the
network where they are registered supports CAMEL phase 2. The
subscriber must have:
The ARSENIC supplementary service
CAMEL subscription data, including a CCH of 2 or above (CAMEL
Capability Handling, which identifies a CAMEL phase)
The translation information (TIF_CSI) flag, which controls whether
the subscriber can register non-E.164 forward-to numbers, must be
TRUE

Divert
Dependence on
VLRs

Diverts that use ARSENIC or CAMEL require that the VLR supports
these capabilities. If not, a subscribers handset might indicate that a
divert has been registered, but the divert will not work.
Also, the VIEW:SUB (page 231) command might indicate that diverts
have been registered even though the diverts could not be downloaded
to the VLR because the VLR does not support ARSENIC or the
required phase of CAMEL.

Number Translation for Call Forwarding


Translation of forward-to numbers depends on whether the forward-to
number (C number) is a standard E.164 number or not.

Standard
Forward-To
Numbers

Standard diverts are not translated if a subscriber has a CNUM_BHVR


value of 0 (zero). If CNUM_BHVR is not zero, the forward-to number is
translated according to the C Number Behaviour Table (cnum_bhvr)
(see page 469).

Non-Standard
Forward-To
Numbers

Non standard forward-to numbers are not translated by the C number


behaviour table. Number translation is done by another network entity
(the SEP in the Vodafone UK network) as the call is being set up.

Forward-To Number Behaviour Modes


The HLR categorises forward-to numbers into behaviour modes GSM,
SMSB, RECALL and SE.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

GSM applies to standard forward-to numbers, SMSB is a divert for the


(Respond Plus) short message bureau service, RECALL is for the
Voicemail service and SE means special/extended (and applies to
non-standard forward-to numbers).
SE diverts are further categorised into behaviour modes by the value of
the SE_FLAGS parameter, as described in Table 1 below.
Table 1. Special/Extended Forward-to Number Behaviour Modes
SE Behaviour
Mode

Conditions

Description

Subscriber does not have the


Mobile Virtual Private Network Full
Number Plan (MVPN_FNP)
supplementary service

SE_CAMEL

FTN is the same as the


subscribers MSISDN or published
number (PNUM)
or
FTN is barred in the [CNUMSE]
section of the C Number Table
(cnum)

CAMEL_ONLY

The FTN will not be registered if the FTN is


barred in the [CNUMCAMEL] section of the C
Number Table (cnum).
The FTN can only be downloaded as CAMEL.
This means the subscriber must be registered
on a CAMEL 2 supporting network, have a CCH
of 2 or above and have a TIF_CSI value of
TRUE.

Subscriber has the Mobile Virtual


Private Network Full Number Plan
(MVPN_FNP) supplementary
service
or
FTN is barred in the
[CNUMCAMEL] section of the C
Number Table (cnum)

SE_ONLY

FTN cannot be downloaded as CAMEL.


Diverts use the Ability to Register Special/
Extended Numbers in Call-forwards (ARSENIC)
supplementary service and work only in the
home network.

The basic behaviour mode (GSM, SMSB, RECALL or SE) can be set
using the REGISTER:SS command (see page 322). If the behaviour
mode is set to SE, SE_FLAGS is set as described in Table 1.
Other behaviour modes for non-standard forward-to numbers cannot
be overridden using an administration command, they are derived
internally by the HLR according to the subscribers supplementary
services, the C number table, and the forward-to number itself.

Barring Forward-To Numbers


The HLR prevents subscribers registering certain forward-to numbers,
such as emergency numbers, using the C Number Table (cnum) (see
page 469).
If a forward-to number is not special/extended, the call is checked for
incoming and outgoing bars before it is allowed to continue.
If a forward-to number is special/extended, the HLR cannot bar an
outgoing call that depends on the location of the final outgoing number,
such as bar outgoing international calls (BOIC). The final outgoing

Home Location Register (Linux) V1.1 Support Guide

10

Chapter 1 Overview of the HLR

number is determined by the CAMEL server (SEP in the UK network),


so the HLR cannot check the location of the call destination. However,
such calls can be barred by the CAMEL server.

Default Call Forwarding


Default Call Forwarding allows calls to be forwarded to default numbers
when the normal call diverts are not set.
A different default number can be specified for each divert:
busy
no reply
not reachable
Default Call Forwarding is implemented using the supplementary
services DCFB, DCFNRC, and DCFNRY.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

11

Explicit Call Transfer


Explicit call transfer (ECT) allows a party involved in two calls to
connect those two calls together and then disconnect. This can be
used for call transfer, where party A, who has a call in progress with
party B, calls party C, connects B to C and then disconnects. Call
transfer is illustrated in Figure 2 below.
Figure 2. Explicit Call Transfer
Call Answered

Call Answered
or Alerting

Call transfer is a supplementary service, called ECT, that requires


basic service TS11 (see Basic and Supplementary Services on
page 591). Most of the call transfer functionality is provided by the
MSCs.
Explicit call transfer uses the following operator determined bars
(ODBs): ODBECT, ODBECTC, ODBECTCI, ODBECTCZ, ODBECTC2
and ODBECTSM. See Operator Determined Bars on page 647.
The ECT supplementary service can be specified in the <ss_code>
field of the ADD:CAMEL (page 332) and UPDATE:CAMEL (page 375)
commands. Specifying ECT as an <ss_code> enables CAMEL
services when ECT is invoked.Network signalling for call transfer is
shown in Figure 3 below.

Home Location Register (Linux) V1.1 Support Guide

12

Chapter 1 Overview of the HLR

Figure 3. Signalling for Call Transfer


Handset
A

MSC A

ECT request

VLR A

MSC B

Handset
B

Call C

Call C

info request
info ack

Checks performed in
VLR and MSC. If OK,
connect calls.

notification (retrieve)

notification (retrieve)

notification (ECT) (alerting)


notification (ECT) (alerting)
notification (ECT)
(active, Rdn)

notification (ECT) (active, Rdn)

ECT ack
disconnect request A - B
disconnect request A-C
CONNECT

A idle, B hears C ringing


ANSWER

CONNECT ACK
notification (ECT) (active, Rdn)
notification (ECT) (active, Rdn)

B connected to C, idle

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

13

CAMEL
What CAMEL
Means

CAMEL means Customised Applications for Mobile networks


Enhanced Logic.
CAMEL allows the home network to monitor and control calls when a
subscriber is roamed. CAMEL services are specific to individual
subscribers and are, therefore, linked to a specific IMSI or MSISDN.
CAMEL allows numbers dialled to be modified during call set-up, and
monitoring of call answer and disconnect. CAMEL has been
standardised in various phases, with progressively increasing
capabilities, and not all of them are implemented in the HLR (see
CAMEL Phases on page 14 and Vodafone Services and CAMEL on
page 17).

CAMEL Network
Entities

CAMEL services introduce two new entities into the GSM network, the
service switching function (gsmSSF) and the service control function
(gsmSCF). The service switching function is implemented in existing
MSCs and, in the UK network, the service control function is
implemented in the Vodafone Service Execution Platform (SEP).
gsmSCF
(SEP in the UK)
gsmSSF

MSC/VLR

HLR

Subscription
Information

CAMEL subscription information indicates how and when to trigger


CAMEL enquiries. CAMEL subscription information (CSI) is grouped
according to services, such as SS-CSI for supplementary services and
O-CSI for mobile originated (outgoing) calls.

CAMEL in this
Guide

Subscriber data for CAMEL services is administered using the


commands described in Chapter 19, CAMEL Commands on page 331.

Home Location Register (Linux) V1.1 Support Guide

14

Chapter 1 Overview of the HLR

CAMEL Phases
Phase
1
(GSM
release
96)

Subscription
Information
O-CSI (originating
CAMEL
subscription
information)
T-CSI (terminating
CAMEL
subscription
information)

Signalling and Detection Points

Functions

Signalling:

Visited
network

Home
network

Outgoing

VMSC

CAMEL

Release call
Connect to other destination
continue unchanged
Anytime interrogation (ATI) of
the HLR for subscriber
location and state
Note: CAMEL can release a call
at any time, regardless of calling
or called party actions, provided
that CAMEL has ongoing control
of the call. If the CAMEL dialogue
has ended, CAMEL cannot affect
the call.

Incoming

GMSC

CAMEL

Note: A CAMEL dialogue is started by


a trigger detection point (TDP). Event
detection points (EDPs), such as
answer or busy, occur during the
CAMEL dialogue.
Trigger detection points, outgoing
calls:
Collected information
Trigger detection points, incoming
calls:
Terminating attempt authorized
Event detection points:
Answer (notify and continue)
Disconnect (notify or report and
wait for instructions to release
connect or continue)

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

Phase
2
(GSM
release
97)

Subscription
Information
SS-CSI
(supplementary
service CSI) for:
* Explicit call
transfer
* Multiparty
* Call deflection
TIF-CSI
(translation
information flag
CSI) for registering
a short forward-to
number
U-CSI/UG-CSI
(forward outgoing
USSD/originate
USSD to the
subscriber via
HLR), allowing the
subscriber to
interact with
CAMEL services

15

Signalling and Detection Points

Functions

Signalling:
same as phase 1.

Inserting announcements and


receiving DTMF digits
(entering a PIN number after
an announcement, for
example)
Subscriber location down to
cell ID
CAMEL sets alerting pattern
Download call duration
Set charging information in
VMSC (outgoing call) or
GMSC (incoming call)

Event detection points:


Abandon
Answer
Busy (used for busy and not
reachable)
Disconnect
No answer
Route select failure (originating
only)

Home Location Register (Linux) V1.1 Support Guide

16

Phase
3
(3G
release
99)

Chapter 1 Overview of the HLR

Subscription
Information
D-CSI (subscribed
dialled services)
N-CSI (services on
a per network
basis)
VT-CSI (incoming
calls trigger at the
VMSC, which
gives CAMEL
more call
information)
GPRS-CSI
(CAMEL controls
GPRS sessions)
MOSMS-CSI
(CAMEL controls
outgoing SMS
messages)
M-CSI (informs
CAMEL of mobility
management
events)

Signalling and Detection Points

Functions

Signalling:

Anytime modification and


more powerful interrogation of
HLR data. Includes:
* Anytime modification (ATM)
of CSI, call forwarding, call
barring or ODB data
* Anytime subscription
interrogation (ATSI), which
checks bars, call forwarding
and CAMEL subscription
information (CS)
* Notify subscriber data
change (NSDC). The CAMEL
server maintains a copy of
subscriber data and the HLR
notifies the server if bars, call
forwarding or CSIs change.
Anytime interrogation (ATI) of
the gateway mobile location
centre (GMLC)
CAMEL can suppress
supplementary services on a
per-call basis
CAMEL can withhold CLI
CAMEL can alter or remove
CUG information
CAMEL can be informed of
progress of a Call Completion
to Busy Subscriber (CCBS),
which is the GSM equivalent
of ringing back if the called
number is busy

incoming
CAMEL (more call
information is available at
VMSC than GMSC)
CAMEL
home
network

GMSC

VMSC
visited
network

Trigger detection points, outgoing


calls (additional to those in phase 2):
Analysed information
Route select failure (also a phase 2
event detection point)
Trigger detection points, incoming
calls (additional to those in phase 2):
Terminating no answer
Terminating busy
Event detection points:
same as phase 2.

4
(3G
release
5)

MTSMS-CSI
(CAMEL controls
incoming SMS
messages)
MG-CSI (mobility
management for
GPRS CSI)

Signalling:
same as phase 3.
Event detection points (additional to
those in phase 3):
Alerting
Change of position
Mid-call

(3G
release
6)

Home Location Register (Linux) V1.1 Support Guide

Call party handling


Control of incoming short
messages
Retrieval of location
information, Any Time
Interrogation of SGSNs (in
addition to MSCs)

Enhanced subscribed dialled


services

Chapter 1 Overview of the HLR

17

Vodafone Services and CAMEL


Phase

Subscription Information

O-CSI identifies:
* CAMEL support is required
* CAMEL services
environments used to support
CAMEL
* Operator specific service
information
T-CSI is not used because
incoming calls do not use
CAMEL (Vodafone UK only)

Signalling and Detection Points

Visited
network
Outgoing

VMSC

CAMEL

Vodafone Service
PAYT roaming:
*An outgoing call attempt
by a roamed prepay
subscriber triggers an
enquiry to the SEP
* Incoming calls to
roamed pre-pay
subscribers do not use
CAMEL, they use the
TICKROAM
supplementary service
(Vodafone UK only)

SEP

O-CSI identifies everything in


phase 1 plus:
* Checking a called number
before making a CAMEL
enquiry
* Checking the length of a
called number before making
a CAMEL enquiry
* forward-to numbers that do
not have the standard E.164
format
* Phase of CAMEL to use
TIF-CSI (translation
information flag CSI) for:
* Register a short forward-to
number (VLR must support
CAMEL phase 2)
* A TIF-CSI value of TRUE
allows a subscriber to register
FTNs that are non-standard
because they are not in E.164
format. Modifying the
TIF_CSI from TRUE to
FALSE makes any
non-standard CAMEL FTNs
quiescent.
SS-CSI (supplementary
service CSI) for:
* Explicit call transfer
* Multiparty
* Call deflection

same as phase 1.

Forward-to numbers in
non-standard format
CAMEL enquiry
triggered by called
number
CAMEL enquiry
triggered by called
number length
Multiparty calls

Home Location Register (Linux) V1.1 Support Guide

18

Chapter 1 Overview of the HLR

Phase

Subscription Information

The Vodafone HLR supports the


following subscription
information for CAMEL phase 3,
but no services currently use
phase 3:
D-CSI (subscribed dialled
services)
GPRS-CSI (CAMEL controls
GPRS sessions)
M-CSI (informs CAMEL of
mobility management events)
MOSMS-CSI (CAMEL
controls outgoing SMS
messages)
T-CSI (terminating CAMEL
subscription information)
U-CSI (informs CAMEL of
USSD events on a per
subscriber basis)
UG-CSI U-CSI (informs
CAMEL of USSD events and
applies to all subscribers)
VT-CSI (incoming calls trigger
at the VMSC, which gives
CAMEL more call
information)

Vodafone services using CAMEL


phase 4 have not yet been
implemented.

Signalling and Detection Points

Vodafone Service
No Vodafone services use
CAMEL phase 3.

Incoming
CAMEL (more call
information is available at
VMSC than GMSC)
CAMEL
Home
network

GMSC

VMSC
Visited
network

same as phase 3.

Vodafone services using


CAMEL phase 4 have not
yet been implemented.

CAMEL Signalling
The CAMEL standard allows control of both outgoing calls (known as
mobile originated) and incoming calls (known as mobile terminated).

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

19

Figure 4. Mobile Originated (Outgoing) Calls


BSS

MSC

call setup

VLR

send info for


outgoing call

complete call, send


O-CSI data

gsmSSF

gsmSCF

VLR checks CAMEL subscription. Outgoing bars


are checked, except for conditional ones such as
ODBOICXHC (outgoing international calls except
to home country), because CAMEL processing may
change the called number

call proceeding
comfort message
MSC receives
O-CSI data, so
must invoke
CAMEL before
proceeding with
invoke gsmSSF

gsmSSF invoked

detection point collected information


(includes all information about the call)
initial detection point (DP)

connect
connect

MSC changes call parameters


as per connect message and
checks conditional bars
send info for
outgoing call

complete call using


roaming number

gsmSCF can arm detection


point, such as call answer,
which allows CAMEL to
maintain control of the call,
followed by:
Connect - changes have
been made to call data
Continue - no changes
have been made to call
data
Release - end the call

initial addressing message to destination exchange

Home Location Register (Linux) V1.1 Support Guide

20

Chapter 1 Overview of the HLR

Figure 5. Mobile Terminated (Incoming) Calls


GMSC

gsmSSF

gsmSCF

HLR

VLR

VMSC

initial addressing message


from originating exchange
IAM includes call
information
send routing information (SRI)

The SRI contains the


CAMEL phases
supported by GMSC

SRI acknowledgement including T-CSI data, O-CSI TDP4


data, CAMEL2 criteria and D-CSI data

Note: If T-CSI is returned and the subscriber has the


retrieve subscriber state and location information flag set,
subscriber state and location information is returned in the
SRI ack message.

invoke gsmSSF

HLR checks the Network Entity (netent) Table,


the unsupported application context learning list
(UAL list) and the supported CAMEL phases in
the SRI message and uses the lowest of the
three as the CAMEL phase supported by the
GMSC. The HLR then returns the correct
CAMEL subscription information.
Note: If the subscriber has the Terminating IN
Category Key in Home network (HOMETICK) or
Terminating IN Category Key when Roamed
(ROAMTICK) attribute, then this service is
invoked instead of CAMEL

MSC receives CSI data, so


invokes CAMEL before
proceeding with the call

gsmSSF invoked

DP termination
attempt authorized

contains all of the


call information

Initial DP

contains all of the


call information

T-CSI data has already been


downloaded and CAMEL processing
completed. Suppress T-CSI prevents
T-CSI data being downloaded again.

connect (can include


charging information)
connect

Note: SRI can contain parameters


for suppression of announcements
and alerting pattern. The HLR

send routing information

suppress T-CSI
provide roaming
number

send routing information acknowledge,


including roaming number

The PRN message


includes the supported
CAMEL phases

provide roaming number


acknowledge

initial addressing message to visited MSC

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

21

Downloaded CAMEL Data


For mobile originated (outgoing) calls, CAMEL subscription information
must be held in the visited VLR (or SGSN for a GPRS subscriber),
because the HLR in the home network is not involved in signalling for
outgoing calls.
For mobile terminated (incoming) calls, if CAMEL is invoked at the VLR
in the visited network rather than at the GMSC in the home network,
CAMEL data must be held in the visited VLR.
Table 2 lists CAMEL subscription information (CSI) downloaded to the
visited VLR or SGSN in response to, say, an update location message.
Table 2. CAMEL Data Downloaded to a VLR or SGSN
CAMEL CSI

Description

Downloaded To

O-CSI

Used to invoke CAMEL for mobile originated calls

VLR and GMSC

T-CSI

Used to invoke CAMEL for mobile terminated calls

GMSC only

GPRS-CSI

Used to invoke CAMEL for GPRS sessions

SGSN

MOSMS-CSI

Used to invoke CAMEL for outgoing SMS messages. The HLR does
not distinguish between an SGSN and VLR when invoking
unsupported behaviour bars

SGSN and VLR

D-CSI

Used to invoke CAMEL for dialled subscribed services

VLR and GMSC

VT-CSI

Used to invoke CAMEL at the VLR in the visited network for mobile
terminated (incoming) calls

VLR

M-CSI

Used to invoke CAMEL for mobility management

VLR

SS-CSI

Used to invoke CAMEL for supplementary services

VLR

Home Location Register (Linux) V1.1 Support Guide

22

Chapter 1 Overview of the HLR

CAMEL download can be affected by CAMEL support in the network or


the combination of services a subscriber has. Operator determined
bars might be applied or CAMEL data might not be downloaded at all.
Factors that affect CAMEL download are:
The CAMEL phase supported by the visited VLR or SGSN where a
subscriber is registered. See How VLR and SGSN CAMEL Support
Affects Services on page 22.
The interaction between different trigger detection points within a
single type of CAMEL subscription information. See Interaction of
Multiple CAMEL Trigger Detection Points on page 23.
The interaction between different types of CSI. See Interaction
Between Multiple CAMEL Subscription Types on page 24.
Whether the subscriber has the Originating IN Category Key (OICK)
supplementary service. See CAMEL Interaction with OICK on
page 25.
Whether the subscriber has the Terminating IN Category Key (TICK)
supplementary service. See CAMEL Interaction with TICK on
page 26.

How VLR and SGSN CAMEL Support Affects Services


For CAMEL services to work, the visited VLR or SGSN must support
the phase of CAMEL that the service requires. Therefore, the CAMEL
phase supported by the VLR will affect what CAMEL data is
downloaded, in response to an UpdateLocation message for example.

CAMEL
Capability
Handling

Each CAMEL trigger detection point (TDP) has a CAMEL Capability


Handling (CCH) attribute, which defines a minimum CAMEL phase for
support of the TDP, a threshold above which the TDP is fully supported
and a maximum above which a TDP is not supported. A TDP also
includes two lists of bars, one used if the VLR or SGSN does not
support the minimum CAMEL phase defined by CCH and one list used
if the VLR or SGSN supports at least the minimum but less than the
phase required for full support.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

23

Figure 6. How CAMEL Capability Handling (CCH) Controls Data Download


maximum
CAMEL service fully supported

CAMEL data downloaded, no bars

threshold

CAMEL data downloaded


LC_UNSUPP_BH bars invoked

CAMEL service partly supported

CAMEL data not downloaded


NO_SVC_UNSUPP_BH bars invoked

minimum
CAMEL service not supported

CCH increasing
For example, if a TDP has a CCH of {2 3 4} and the VLR where the
subscriber is registered in the visited network supports CAMEL phase
2, CAMEL data is downloaded but the bars defined by
LC_UNSUPP_BH are invoked. If the subscriber then moves to a VLR
that supports CAMEL phase 3 or 4, the TDP will be fully supported and
no bars will be invoked.

Interaction of Multiple CAMEL Trigger Detection Points


For the purpose of downloading CAMEL data to a VLR, trigger
detection points (TDPs) are grouped by the CAMEL subscription
information (CSI) type they apply to. For example, the TDPs OCSI_2
and OCSI_4 are for originating calls and the TDPs for GPRS are
GPRSCSI_1, GPRSCSI_2, GPRSCSI_11, GPRSCSI_12, and
GPRSCSI_14.
For a particular CAMEL subscription information (CSI) type, the HLR
can use only one CAMEL capability handling (CCH) value. Therefore, if
a subscriber has more than one TDP from the same CSI type, all TDPs
behave as though the network supports the lowest of the maximums
defined by the CCH value for each TDP.

Home Location Register (Linux) V1.1 Support Guide

24

Chapter 1 Overview of the HLR

For example, if OCSI_2 has a CCH of {1 1 2} and OCSI_4 has a CCH


of {2 3 4}, a maximum CAMEL phase of 2 is assumed. Even if a
subscriber registers on a VLR that supports CAMEL phase 3.

CCH = {1 1 2}

OCSI_2
Lowest maximum is 2, so
VLR support of CAMEL
phase 2 is assumed
OCSI_4
CCH = {2 3 4}

The effect of a VLR supporting a lower CAMEL phase than required is


described in How VLR and SGSN CAMEL Support Affects Services on
page 22.

Interaction Between Multiple CAMEL Subscription Types


Adding a new CSI type to a subscriber can adversely affect an existing
CAMEL service. For example, a subscriber with the OCSI_2 TDP can
register on a VLR that supports CAMEL phase 1 or greater and make
calls.

OCSI_2
CCH = {1 1 2}

VLR Supports
CAMEL Phase 2

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

25

If the same subscriber is then given the mobile originated SMS CSI, the
VLR does not support the required phase of CAMEL (phase 3) and
bars are invoked, which might prevent the subscriber making calls.

MOSMS_CSI
CCH = {3 3 3}

invokes NO_SVC_UNSUPP_BH bars

VLR Supports
CAMEL Phase 2

OCSI_2
CCH = {1 1 2}

CAMEL Interaction with OICK


If the subscriber has Originating IN Category Key (OICK) and is in an
OICK supporting network, OICK will always be downloaded.
Regardless of whether the subscriber has CAMEL O-CSI data, OICK
overrides O-CSI data at all CAMEL phases so that OICK services are
provided but mobile originating CAMEL services are not. For example,
CAMEL 2 FTNs (see Non-Standard Forward-To Numbers on page 8)
cannot be downloaded if the subscriber has OICK and the network
supports OICK.
Even though OICK overrides O-CSI data, O-CSI TDP4 has its own
unsupported behaviour that is invoked independently of OICK and
might adversely affect OICK behaviour if a network entity does not
have the CAMEL support needed by O-CSI TDP4. Some service
reduction is therefore a risk if a subscriber has both OICK and O-CSI
TDP4.
If a subscriber has OICK but OICK is not supported by the VLR,
download depends on the CAMEL support of the VLR.
Interaction between CAMEL O-CSI data and OICK is shown in the
table below.
Subscriber has OICK, VLR does not
Support OICK

Subscriber has OICK, VLR


Supports OICK

O-CSI not supported

Invoke unsupported OICK

OICK downloaded, O-CSI not


downloaded

O-CSI supported or
partially supported

Ignore OICK data and refer to CAMEL


O-CSI data to invoke bars.

OICK downloaded, O-CSI not


downloaded

Unlike CAMEL services for mobile originated calls, CAMEL services for
mobile originated SMS messages, for mobility management and for
supplementary services can be downloaded alongside OICK.

Home Location Register (Linux) V1.1 Support Guide

26

Chapter 1 Overview of the HLR

Therefore, any bars invoked as a result of insufficient CAMEL support


for MOSMS-CSI might adversely affect OICK services.

CAMEL Interaction with TICK


If the SendRoutingInformation message to the HLR indicates that the
GMSC supports the Ericsson proprietary Terminating IN Category Key
(TICK) functionality, and the subscriber has a non-zero HOMETICK or
ROAMTICK attribute, then T-CSI data is not sent to the GMSC. TICK
processing in invoked regardless of whether the subscriber has O-CSI,
T-CSI or D-CSI.
TICK functionality can be supported in the home network or in a visited
network, but whether TICK processing is invoked, and the kind of TICK
processing invoked, depends on the subscribers HOMETICK and
ROAMTICK attributes. Values of zero indicate that the subscriber does
not have TICK, and no processing should be invoked.
ROAMTICK is used for the pre-pay roaming service, so pre-pay
subscribers who are able to roam cannot use CAMEL services for
mobile terminated calls or dialled subscribed services. Vodafone UK
does not use any of these CAMEL services.
O-CSI data is returned to the GMSC during a mobile terminated call to
allow a mobile originated CAMEL service to modify the terminated call.
For example, O-CSI data is used if the HLR forwards calls to
non-standard numbers.

CAMEL Support Checking by Unsupported Application


Context Learning (UAL)
The CAMEL phases not supported by a VLR or an SGSN are specified
in the Network Entity (netent) Table (see page 509). If signalling
between the HLR and a VLR or SGSN indicates that a certain phase is
not supported, the unsupported application context learning (UAL) list
will keep track of this lower CAMEL support. Note, however, that if an
entity subsequently supports a higher phase, the UAL list will not
change to reflect the higher support.
Similarly, if an SGSN or VLR does not return supported CAMEL phase
information, then the UAL list will record that CAMEL is not supported.
The HLR will not attempt to download CAMEL data again until the
UAL_RETRY period specified in the PDS Configuration (pds_config)
Table (see page 523) has elapsed and CAMEL support is rechecked.

CAMEL Phase One Example - PAYT Roaming


A pre-pay subscriber who roams to a network that supports CAMEL
can make outgoing calls in the same way as a contract subscriber. An
outgoing call follows these steps:

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

27

1. Pre-pay subscriber registers on visited network (Figure 7)


2. Vodafone HLR downloads CAMEL data to the visited MSC where
the subscriber is registered
3. Pre-pay subscriber makes an outgoing call (Figure 8)
4. Visited MSC forwards call information to a SEP in the Vodafone UK
network
5. SEP checks the cost of connecting the called number against
subscriber credit and whether roaming is allowed to the visited MSC
6. call is connected or released
Figure 7 shows downloading CAMEL service data to the visited MSC.
Figure 7. The HLR and CAMEL - Downloading CAMEL Service Data to a VMSC
Home PLMN

Visited PLMN

update location

HLR

VMSC

CAMEL
Service
Data

subscriber registers
subscriber data
(including CAMEL data)

CAMEL service
environment (CSE),
SEP in the UK

Figure 8 shows how CAMEL is used to control an outgoing call.

Home Location Register (Linux) V1.1 Support Guide

28

Chapter 1 Overview of the HLR

Figure 8. HLR and CAMEL - Modifying an Outgoing Call

Home PLMN

HLR

CAMEL
Service
Data

Visited PLMN

VMSC
forward call data
for processing

CAMEL
Service
Data

outgoing call

connect call

CAMEL service
environment (CSE),
SEP in the UK
initial addressing message
to destination exchange

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

29

General Packet Radio Service (GPRS)


The general packet radio service (GPRS) provides data services, such
as e-mail and remote access to corporate networks, to mobile
subscribers. GPRS uses the same radio equipment and HLR as the
rest of the GSM network, but is otherwise completely separate (see
Figure 9).
Figure 9. The HLR and GPRS

GSM Network
VLR
Radio
Equipment

HLR

SGSN
GPRS Network

Other
Network

The HLR stores two subscriber locations, one for GPRS and one for
the rest of the GSM network. The HLR also keeps a list of the packet
data services for a subscriber in a similar way to the list of basic and
supplementary services.
Mobile originated GPRS is supported, but mobile terminated is not.
However, both mobile originated and mobile terminated short message
service (SMS) are supported for GPRS.

Home Location Register (Linux) V1.1 Support Guide

30

Chapter 1 Overview of the HLR

Linked Subscriptions
Two options are available to subscribers who want two or more mobile
handsets in the same subscription, a MultiSIM subscription (see
page 46) or a linked subscription. Linked subscriptions have two
variants called automotive twin SIM (ATS) and mutually exclusive
secondary SIM (MESS).
Callers to a linked subscription dial a single published number which is
routed, by the network, to one of the handsets belonging to the linked
subscription. Which handset receives calls is nominated by the
subscriber. Figure 10 shows the network configuration for the UK.
Figure 10. Routing to a Linked Subscription

HLR
(nominated number)
Send Routing Information

Incoming call to
a published
MSISDN

HLR
(published number)

SEP

Roaming Number

As an example, the linked subscription (ATS only) USSD codes for the
UK Vodafone network are listed in Table 3.
Table 3. Example Linked Subscription USSD Codes
To

Enter the Code

The Successful Response is

Nominate yourself

*131#

SIM ID is nominated

Nominate another member

*131*ID#

SIM ID is nominated

See who is nominated

*#131#

SIM ID is nominated

Find out your member ID

*#130#

I am SIM ID

ID is the member ID

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

ATS Linked
Subscription

31

An ATS linked subscription allows incoming calls to use either the


published number for the linked subscription, or the MSISDN of any
member. Members of an ATS subscription are able to make and
receive calls at any time, regardless of whether other members have
calls in progress.
ATS
MSISDN
Call

Published
Number
Nominated

Call

MESS Linked
Subscription

MSISDN

A MESS linked subscription allows calls to the published number only.


The MSISDNs of individual members will not usually be known to
callers, but any calls to these MSISDNs, a wrong number for example,
will be treated as though the called subscriber does not exist. Only the
nominated subscriber can make or receive calls, even if a
non-nominated member has a secondary number, a fax number for
example. However, members can, at any time, control diverts, set
calling line identification restriction, activate and deactivate SMS and
carry out other similar operations.
MESS

MSISDN
(hidden)
Published
Number

Nominated

MSISDN
(hidden)
Call not allowed

Administration Commands for Linked Subscriptions


A linked subscription is created in two steps.
1. Create a subscription with the LINKED supplementary service. This
subscription has no associated handset, it simply provides an
MSISDN that can be used as the published number (PNUM) to link
other subscriptions together.

Home Location Register (Linux) V1.1 Support Guide

32

Chapter 1 Overview of the HLR

2. Link existing subscriptions to the published number in step 1.


The subscription with the LINKED supplementary service is created as
follows.
CREATE:SUB,000000000000110,07712345678,TS11;
PROVISION:SS,IMSI,000000000000110,LINKED;
Specify that the published number is downloaded to the VLR.
UPDATE:SUB,MSISDN,00000000012,DNLD_P,PNUM;
Specify that the published number is returned in response to an enquiry
for a subscribers own MSISDN.
UPDATE:SUB,MSISDN,00000000012,OWNM_P,PNUM;
Subscribers are then added to this linked subscription using an
UPDATE:SUB command. For example, to add the subscription with
MSISDN 077 11111111, the following command is used.
UPDATE:SUB,MSISDN,07711111111,PNUM,07712345678;

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

33

Home Zone Charging


GSM allows a network operator to define geographical areas, known as
zones, within the home or other network. The area served by a single
VLR or SGSN can be divided into several zones, or larger areas can be
defined containing areas served by one or more VLRs or SGSNs.
These geographical areas can be outside the home network but all
zones must be in one network. Home zone charging is based on GSM
regional subscriptions.
Home zone charging uses the regional subscription data to allow call
charges to vary with the location of the subscriber. For example, a
subscriber could be given cheaper calls when at home or in the office.

Home Zone
Charging in this
Guide

Each subscriber has an individual zone code list which is added and
updated using the UPDATE:ZONELIST command (see page 228). The
zone codes for a subscriber can be viewed using the VIEW:SUB
command (see page 231) and a VLR or SGSN can be checked for
support of regional subscriptions using the VIEW:NETWORK
command (see page 409). Services that are not supported by a VLR or
SGSN are defined in the Network Entity (netent) Table (see page 509)
and in the Unsupported Application Context Learning (UAL) list.

Defining Zones

Zone codes are specified in a list that starts with a country code (CC)
and national destination code (NDC) combination followed by the
codes themselves. The first check made by home zone charging is that
the CC-NDC combination matches the CC and NDC of the global title
of the VLR or SGSN where a subscriber is registered. In the Vodafone
UK network, for example, many VLR global titles start 447785.
Zones are then defined within this CC-NDC area based on GSM cells,
but do not use cell IDs. Each cell is assigned one or more zone codes
which can be compared with a subscribers zone code list.
For home zone charging, the comparison is used to determine call
costs based on a subscribers zone data as shown in the example in
Figure 11 on page 34.

Home Location Register (Linux) V1.1 Support Guide

34

Chapter 1 Overview of the HLR

Figure 11. Assigning Zone Codes in the Home Network

Cell ID = 2
zone code(s): 100
Cell ID = 3
VLR or SGSN
global title: 447785 123456

Cell ID = 1

zone code(s): 200

zone code(s): 100


subscriber:
CC-NDC: 447785
zone code 100

Cell ID = 4
zone code(s): 200

The subscriber registered on this VLR or SGSN is charged a different rate when in
cells 1 and 2 than when in cells 3 and 4
Note: Cell sizes can vary with environmental conditions, and zones for GPRS and
GSM services do not necessarily cover the same physical areas.

Signalling for Home Zone Charging


The HLR stores regional subscription data for each subscriber, which is
downloaded when a subscriber registers on a VLR.
The VLR compares the subscribers regional subscription data with its
own to determine how a subscriber will be charged, or whether the
subscriber will be allowed to register at all.
Note: The VLR determines how regional subscription data is used, for
charging or roaming control for example, not the HLR.
Signalling for regional subscription data is shown in Figure 12 below. If
an attempt to download regional subscription data results in an error,
the Unsupported Application Context Learning (UAL) table is updated
to indicate that the VLR/SGSN does not support regional subscriptions.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

35

Figure 12. Home Zone Charging Signalling


mobile
handset

VLR /
SGSN

register

HLR

UpdateLocation or
UpdateLocationGPRS
HLR checks:
download subscriber
data, including regional
subscription data

that the country code (CC) and


national dialling code (NDC) of the
zone code matches those of the
VLR/SGSN global title
the entry in the NETENT table for
the VLR/SGSN to ensure that
regional subscription (REGSUB) is
not an unsupported service

VLR/SGSN compares subscribers


regional subscription data with its
own to determine whether to bar
registration or apply zone related
charging.

Network Support
Required for
Home Zone
Charging

the unsupported application


context learning (UAL) table to
ensure that regional subscription
in not an unsupported service

Home zone is an Ericsson proprietary capability and requires Ericsson


VLR and SGSN versions that support home zone charging.

Home Location Register (Linux) V1.1 Support Guide

36

Chapter 1 Overview of the HLR

Location Based Services


The HLR is compliant to the 3GPP R99 standards for location services
and supports Location Services using different methods, such as Time
of Arrival (TOA), Enhanced Observed Time Difference (E-OTD) and
Assisted Global Positioning System (A-GPS).
Privacy data of subscribers will be controllable through USSD
Subscriber privacy profile is extended substantially from two
Boolean flags (PAI, and PAI_CTRL) to a structure called the
Subscriber Location Privacy Profile (SLPP) (see the description of
Subscriber Location Privacy Profile (SLPP) on page 37), which
specifies which networks or services are allowed to locate each
subscriber.
HLR handling of the AnyTimeInterrogation (ATI) and
SRIforLocationServices messages for exported subscribers allow
support of number portability for location services. Therefore,
subscribers who have moved to Vodafone from other networks and
subscribers who have moved their accounts from Vodafone to
another network can use location services.
A subscriber controls privacy data using a USSD commands, which
are described in Positioning Services on page 643.
Figure 13. Network Entities for Location Services
HLR in other
network

Forwarded ATI or
SRIforLCS

Entity in other
network

ATI

TCP/IP
interface

LES

HLR
Relayed USSD
requests and
responses

Download subscriber location


privacy profile (SLPP)
USSD requests and responses

SRIforLCS

GMLC

MSC/VLR

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

37

Mobile Terminated Location Requests


The LES requests positioning of a subscriber through the GMLC from
the HLR and MSC.
If the GMLC does not contain the VMSC or IMSI of a subscriber, it
interrogates the HLR using an SRIforLCS message. The HLR
responds with SRIforLCSack.
The GMLC then sends a ProvideSubscriberLocation (PSL) message to
the VMSC. The VMSC responds with the location in PSLack.
Figure 14. Requesting the Position of a Subscriber
LES

1. Request
Subscriber Position

4. Provide Subscriber
Location

MSC/VLR

6. Return
Subscriber Position

2. SRIforLCS

GMLC
5. Provide Subscriber
Location
Acknowledgement

HLR

3. SRIforLCS
Acknowledgement

Subscriber Location Privacy Profile (SLPP)


The subscriber privacy profile is no longer simply the PAI flag (see
page 221), it is a structure that can allow or disallow selected services
and networks.
The subscriber location privacy profile is downloaded to the VLR when
the HLR updates subscriber information. The SLPP contains two types
of information:
A list of clients that are allowed to request location information from
the HLR.
A list of mobile location centres (MLCs). This list can be used to
optionally restrict the MLCs that are allowed to communicate with
the HLR.
The SLPP data is not stored in the HLR database: it is retrieved from a
data table on the HLR and sent to the VLR.
The HLR can be configured to download flags, SLPP or both, but the
default configuration is to download SLPP only.
2

Home Location Register (Linux) V1.1 Support Guide

38

Chapter 1 Overview of the HLR

The SLPP data is not stored in the HLR database. Instead, the existing
PAI flag is read from the HLR database and this indicates either
"positioning allowed" or "positioning not allowed". One of two SLPP
profiles is then downloaded, to either allow or disallow location
services. SLPP profiles are defined by entries in the hlr_config Table,
which are described in Configuration of Location Based Services on
page 490. The same profiles are used for all subscribers and are
configurable using table maintenance.

Privacy in the Location Enabling Server (LES)


Subscribers send USSD commands to query or change the privacy flag
in the LES. The HLR uses a mask to convert the USSD string into a
text message, which it sends to the LES over TCP/IP using HTTP. The
LES returns a text response to the HLR over the same interface; the
HLR converts this to a USSD using another text mask. The HLR then
sends this USSD response to the subscriber.
The following USSDs control location privacy:
Query privacy Flag the subscriber sends this USSD to see
whether privacy is enable or disabled for them.
Enable Location Services Flag the subscriber sends this USSD to
set its privacy flag.
Disable Location Services Flag the subscriber sends this USSD to
clear its privacy flag.
Initialise Location Services create an entry on the LES for the
subscriber.
The USSD commands are described in Positioning Services on
page 643.
The subscriber controls whether position information is returned by the
MSC/VLR to the GMPC by enabling or disabling positioning using
USSD commands (see Positioning Services on page 643). However,
the mobile positioning centre can override the PAI flag and SLPP Data
using a positioning override indicator (POI) flag and force the MSC/VLR
to return positioning data to the GMLC. This override is useful for
emergency centres to find a subscribers location even though that
subscriber has disallowed positioning.

Registering Subscribers with the LES


Initially, all subscribers are unknown to the LES. When a subscriber
sends a Query or Modify USSD, the LES responds with "Unknown
Subscriber". The HLR converts this to a USSD response message
asking the subscriber to use the "Initialise" service to create an entry for
them in the LES. Once the entry is created, the subscriber can use the
Query and Modify USSDs.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

39

The LES needs to initialise each subscriber once only, and the
subscribers must provision themselves by responding to a message
such as "Welcome to Location Services. Use *#123 to start using the
service".
Once the subscriber has done this, the LES will have an entry for the
subscriber and the subscriber will never have to use this message
again. If they do, the LES will re-initialise the subscriber in a similar way
to the first initialisation, with location services allowed.

Mobile Number Portability (MNP)


When an AnyTimeInterrogation (ATI) or SRIforLocationServices
(SRIforLCS) request is received at the HLR for an exported subscriber,
the HLR will forward these requests onto the network where the
subscriber resides.
The Network Entity (netent) Table (see page 509) determines whether
the HLR replies to ATI or SRIforLCS messages from other networks
using the ALLOW_ATI and ALLOW_POS attributes.

Location Based Services and this Guide


Providing
Location
Information to
Other Entities

The ALLOW_ATI and ALLOW_POS attributes in the Network Entity


(netent) Table determine whether the HLR responds to
AnytimeInterrogation or SRIforLCS messages from other networks.

Subscriber
Control of
Service

Subscribers use USSD commands to enable or disable positioning


services, as described in Positioning Services on page 643.

Subscriber
Location Privacy
Profile (SLPP)

A number of entries in the hlr_config Table define the Subscriber


Location Privacy Profile (SLPP): LCS_CLI, ADDRESS address,
GMLC_RES restriction, NOTIFY_USER notification and
LCS_GMLC_ID.

Positioning Data
Downloaded to
the VLR

Each VLR listed in the Network Entity (netent) Table has an


LCS_DOWNLOAD attribute that specifies whether the HLR should
download the positioning allowed indicator (PAI) flag, the subscriber
location privacy profile (SLPP) data, or both, to the VLR.
LCS_DOWNLOAD in the hlr_config Table specifies whether the HLR
should download the positioning allowed indicator (PAI) flag, the
subscriber location privacy profile (SLPP) data, or both, to a VLR that
does not have an LCS_DOWNLOAD attribute defined in the Network
Entity (netent) Table.

Home Location Register (Linux) V1.1 Support Guide

40

Chapter 1 Overview of the HLR

Mobile Number Portability (MNP)


Allowing subscribers to move from one mobile network to another,
known as Mobile Number Portability (MNP), is a regulatory requirement
and must be provided by UK network operators.
Subscribers must be able to change networks easily and cheaply to
encourage operators to compete in the areas of services, quality and
prices.
Because migrated subscribers are given a new SIM and IMSI by their
new network, migration affects only services that depend on the
subscribers MSISDN, which are:
incoming voice calls
incoming SMS messages
attempt to set message waiting data
requests for location information
HLR Data Changes When a Subscriber Migrates on page 41 describes
the effect of MNP on the HLR.
Signalling for Subscribers Migrated from Vodafone to Another Network
on page 41 describes incoming call signalling for subscribers who have
left Vodafone.
Signalling for Subscribers Migrated from Another Network to Vodafone
on page 42 describes incoming call signalling for subscribers who have
joined Vodafone from another network.
Signalling for SMS and Message Waiting Data on page 43 describes
the effect of MNP on short messages and on message waiting data,
which is used, for example, by Voicemail.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

41

HLR Data Changes When a Subscriber Migrates


Subscribers can either migrate to Vodafone from another network, or
from Vodafone to another network. The effect of migration is shown in
Table 4.
Table 4. Effect of Subscriber Migration
Account Move

Other
Network
Vodafone

Vodafone

Other
Network

SIM and MSISDN

HLR Changes

Vodafone SIM
Vodafone IMSI
Other networks
MSISDN is
assigned to the
Vodafone SIM

Create a new subscriber using the


MSISDN from the subscribers previous
network (see CREATE:SUB on
page 206)
MSISDNs from other networks (which
appear as the calling line identity (CLI)
when subscribers make calls) might be
restricted to particular Vodafone HLRs
see Signalling for Subscribers Migrated
from Another Network to Vodafone on
page 42 for handling of an incoming call

Other networks
SIM
Other networks
IMSI
Vodafone
MSISDN

add Vodafone MSISDN to the list of


service request numbers (SRNs) (see
CREATE:SRN on page 290)
add a corresponding MSISDN, which
identifies the subscriber and has a
44799x prefix (see Table 5) for the
Other Network, to the list of service
access numbers (SANs)
the Other Network uses the Vodafone
MSISDN (which appears as the calling
line identity (CLI) when the subscriber
makes calls)
see Signalling for Subscribers Migrated
from Vodafone to Another Network on
page 41 for handling of an incoming call

Table 5. UK Networks and MNP Prefix


Network

Prefix

O2

447991

T-Mobile

447992

Orange

447993

Vodafone

447994

Dolphin Telecom

447995

Hutchison 3G

447996

BT MVNO (Quad-7)

447997

Signalling for Subscribers Migrated from Vodafone to

Home Location Register (Linux) V1.1 Support Guide

42

Chapter 1 Overview of the HLR

Another Network
If a call is made to a subscriber who has moved account to another
network, the HLR must forward the call to the subscribers new
network.
Figure 15 shows signalling for an incoming call for a subscriber who
has moved account to another network. The HLR processing involved
is called donor direct routing override function, or D-DROF.
Figure 15. Incoming Call to Subscriber Migrated to Other Network
Vodafone

Other Network

3. MSISDN not found. Compare


MSISDN with SRN list, find
corresponding SAN

HLR

HLR
4. Send routing information
acknowledge contains
intermediate routing number
(IRN) = SAN = 44799x +
MSISDN

2. Send routing
information for
MSISDN

44799x is a prefix for number


portability specified by the
regulatory authority. x
identifies the network (see
Table 5)
1. Incoming call

GMSC

6. Remove
44799x prefix

5. IRN and connect voice


circuit. Vodafone has no
further involvement in call

GMSC

Signalling for Subscribers Migrated from Another Network


to Vodafone
If a subscriber has moved to Vodafone from another network, incoming
calls to that subscriber must be forced to connect to a Vodafone
GMSC.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

43

Calls can be connected to the Vodafone network in one of two ways:


Like Vodafone, the Other Network performs donor DROF, as shown
in Figure 15. No special processing is required in the Vodafone
network other than removing the 447994 prefix that indicates a
number moved to Vodafone from another network.
Unlike Vodafone, the Other Network does not perform donor DROF.
The Vodafone network must perform recipient direct routing override
function (R-DROF), as shown in Figure 16.
Note: Although donor DROF (Figure 15) reduces signalling between
networks, it places a processing burden on the network that has lost
the migrated subscriber. Therefore, recipient DROF (Figure 16) is
mandatory and donor DROF is optional. In the UK, only Vodafone and
Orange perform donor DROF.
Figure 16. Incoming Call to Subscriber Migrated to Vodafone
Vodafone

Other Network

3. MSISDN has
moved to Vodafone,
forward SRI

4. Forward
SRI

HLR

8. Send routing
information for
MSISDN

FMSC

signalling
relay function

SRF

5. send routing information


acknowledge contains intermediate
routing number (IRN) = 447994 +
MSISDN
The prefix of the MSISDN is changed as
specified by entries MNP_PFX_1
MNP_PFX_2 MNP_PFX_3 in the
hlr_config Table.

2. Send routing
information for
MSISDN

7. Remove
447994 prefix

GMSC

6. IRN and connect voice


circuit. Other Network has no
further involvement in call

1. Incoming call

GMSC

Signalling for SMS and Message Waiting Data


Roamed subscribers can receive messages via the Short Message
Service (SMS) only if they roam to a network that has a roaming
agreement with both Vodafone and the Other Network.

Home Location Register (Linux) V1.1 Support Guide

44

Chapter 1 Overview of the HLR

If a subscriber has moved from another network to Vodafone, send


routing information (SRI) for SMS messages and set message waiting
data messages are processed as normal, except for removing the
roaming prefix if necessary (Figure 17).
Figure 17. Incoming SMS or MWD to Subscriber Migrated to Vodafone
Vodafone

Other Network

2. Remove 447994
prefix and forward SRI
for SMS or set MWD
to HLR

HLR

1. Incoming send routing


information for SMS (SRISM)
or set MWD (SRIMWD)

GMSC

3. Process SRI for


SMS or set MWD
in normal way

If a subscriber has moved from Vodafone to another network, the HLR


must add a 44799x prefix (see Table 5) to re-route the message.
Figure 18. Incoming SMS or MWD to Subscriber Migrated to Other Network
Other Network

Vodafone
3. MSISDN not found. Compare
MSISDN with SRN list, find
corresponding SAN

HLR

2. SRI for SMS or


set MWD

1. Incoming SRI for


SMS or set MWD

GMSC

FMSC

HLR

4. SRI for SMS or set MWD


for 44799x + SAN (MSISDN)
44799x is a prefix for number
portability specified by the
regulatory authority. x
identifies the network (see

Signalling for Location Based Services


The HLR might receive requests for location information from a GMLC.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

45

If a subscriber has moved from another network to Vodafone,


AnyTimeInterrogation messages and SRIforLocationServices
(SRIforLCS) messages and set message waiting data messages are
processed as normal, except for removing the roaming prefix if
necessary (Figure 19).
Figure 19. Incoming ATI or SRIforLCS to Subscriber Migrated to Vodafone
Vodafone

Other Network

2. Remove 447994
prefix and forward
SRIfor for SMS or set
MWD to HLR

HLR

1. Incoming ATI or SRIforLCS

GMSC

3. Process ATI or
SRIforLCS in
normal way

If a subscriber has moved from Vodafone to another network, the HLR


must add a 44799x prefix (see Table 5) to re-route the message.
Figure 20. Incoming ATI or SRIforLCS to Subscriber Migrated to Other Network
Other Network

Vodafone
3. MSISDN not found. Compare
MSISDN with SRN list, find
corresponding SAN

HLR

2. ATI or
SRIforLCS

HLR

4. ATI or SRIforLCS for


44799x + SAN (MSISDN)

1. Incoming ATI or
SRIforLCS

GMSC

FMSC

44799x is a prefix for number


portability specified by the
regulatory authority. x
identifies the network (see

Home Location Register (Linux) V1.1 Support Guide

46

Chapter 1 Overview of the HLR

MultiSIM
The MultiSIM service allows one subscriber to have several mobile
handsets, all of which are called using the same published number. For
example, the subscriber can choose to receive calls via a car phone or
a mobile handset in a similar way to linked subscriptions (see page 30).
Unlike linked subscriptions, all data used by the MultiSIM service is
stored within the HLR, which means that no signalling to other network
elements is required to provide the service. Only one set of
subscription data is held and is duplicated for each SIM in the MultiSIM
subscription. Up to 10 SIMs can be linked in one MultiSIM subscription,
and each SIM is given an identifier, called a SIM ID, which is a number
from 0 to 9.

Receiving Calls

The handset that will receive calls is nominated by the subscriber by


entering a USSD command (see MultiSIM Service on page 638).
Outgoing calls can be made from any handset at any time.
Although a particular handset will usually be used for a particular basic
service (for example voice, fax or data), the HLR does not restrict which
handset can be nominated to receive calls for which basic service
group (BSG). The administration interface can update the nomination
for a SIM for a particular BSG, for example to correct problems or
investigate faults.
The subscriber can interrogate the HLR using USSDs to find out both
the currently nominated SIM ID, and the ID of the mobile that sent the
nomination request. The response includes a list of which SIMs are
nominated for which BSGs since BSGs can be allocated to different
SIMs.

Published
Numbers

A MultiSIM subscription has only one set of MSISDNs (one for speech,
one for data and so on), each SIM does not have its own MSISDN and
can be reached only when nominated to do so by the subscriber and
only using the published MSISDN. Any existing subscription can be
converted into a MultiSIM subscription by simply adding SIMs to it. The
published number for the subscription does not change.
An IMSI, and therefore a SIM, cannot belong to more than one
subscription. To move a SIM from one MultiSIM subscription to another,
the SIM must be removed and then added to the MultiSIM subscription.

Basic Service
Groups

USSDs are used to nominate the handset that sends the USSD (called
grab) or to nominate a handset other than the one sending the USSD
(called grant) by including the SIM ID of the handset to nominate. The
nominated handset can also be changed using the NOMINATED_SIM
attribute in the UPDATE:SUB administration command (see page 215).
USSD nomination changes can grab and grant a nomination to a SIM
for any or all BSGs.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

47

For a description of USSD commands for MultiSIM, see MultiSIM


Service on page 638.

Stolen SIMs

If a SIM is stolen, it must be removed from the subscription; the SIM


cannot be barred.

Overlapping IMSI It is possible to apply an overlapping IMSI as for a normal SIM. This will
apply to an individual SIM in the group, and will allow the old SIM
record to be deleted once the new SIM has been used or when the
REPLACE:OVERLAP administration command has been used (see
page 276).

Last Caller
Number

The last caller number can be identified as for a normal subscription, on


top of which MultiSIM introduces data that identifies the SIM ID that the
call was routed to. This helps customer care identify and trace service
problems.

Tracing activity

A trace on a subscription is selected by identifying an MSISDN, which


results in a trace of information for all SIMs related to that MSISDN.

VAMPIRE and
MIS

In the Vodafone UK network, the HLR logs the nomination change data
to the VAMPIRE interface for use by Customer Care and Service
Provider Support. This is very similar to the logging currently provided
by the SEP.

Administration Commands for MultiSIM


The administration command below creates a MultiSIM subscription
with two members.
The first member already has a subscription and has an MSISDN of
077 12 345678. The second member has an IMSI of 234 15
1021000899.
The following ADD:SIM command adds the second member to the first
members subscription. Both SIMS have the same MSISDN and both
can make calls.
ADD:SIM,MSISDN,07712345678,234151021000899,1;
The last parameter is the sim_id. The first member has a sim_id of
0, and then the next SIM can have a SIM ID of between 1and 9. If the
sim_id is not specified, the next available one is used.
All calls made to the MSISDN will route to the nominated SIM for the
SPEECH basic service group. Different SIMS can be nominated for
different basic service groups, such as SMS, FAX and DATA; for
example, a subscriber might have 10 SIMS each nominated to receive
different services.
SIM 0 is the default and receives all calls unless the nomination for a
basic service group is changed using one of the USSD commands
described in MultiSIM Service on page 638.

Home Location Register (Linux) V1.1 Support Guide

48

Chapter 1 Overview of the HLR

Incoming Call to MultiSIM Subscription


The older linked subscription services are checked before MultiSIM
and therefore take precedence over MultiSIM.
The HLR checks the number of SIMs in a subscription, and if this
number is greater than 1, the HLR looks up the nominated IMSI and
uses it in the ProvideRoamingNumber message sent to the VLR.
Figure 21. Signalling for an Incoming Call
SMSC

HLR

SRI (send routing information) for


MSISDN

MSC/VLR

> 1 SIM, so use the


nominated IMSI

PRN (provide roaming


number) for nominated IMSI

Roaming number (RN)


SRI result (roaming number)

Incoming SMS to a MultiSIM Subscription


The diagram below shows signalling for an SMS sent to a MultiSIM
subscriber. The HLR returns the IMSI and the location of the nominated
SIM.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

49

Figure 22. Signalling for an Incoming SMS


GMSC

HLR

SRI (send routing information) for


MSISDN

VLR

> 1 SIM, so use the


nominated IMSI

SRISM result (nominated IMSI)

FSM (nominated IMSI)

FSM result

Alert Service Centre for a MultiSIM Subscription


For a MultiSIM subscription, the decision whether to alert service
centres (such as text message centres) that a subscriber is ready to
receive messages must consider which SIM is nominated.
Service centres can be alerted in the following situations:
A handset is switched on and registers with a VLR, which sends a
NoteSubscriberPresent/ReadyForSM message to the HLR.
A subscriber moves to a new VLR, which sends an UpdateLocation
message to the HLR.
The nominated SIM is changed, either by a USSD or by an
administration command.
The message waiting data (MWD) expires on the HLR (see
SET:MWD on page 433).
For both the NoteSubscriberPresent and UpdateLocation cases, the
HLR checks whether the subscription has more than one SIM and if so,
whether the IMSI in the message is the nominated IMSI.
If the IMSI is part of a MultiSIM subscription and the IMSI in the
message is the nominated IMSI, then the SIM is ready to receive
messages and an AlertServiceCentre message is sent.
If the IMSI is part of a MultiSIM subscription but is not the nominated
SIM, then service centres are not alerted.

Home Location Register (Linux) V1.1 Support Guide

50

Chapter 1 Overview of the HLR

If the nominated SIM changes, then the HLR checks for any message
waiting data for the new nominated SIM. If the SIM has message
waiting data, the relevant service centres are alerted.
Figure 23. Signalling for Alerting a Service Centre
MSC/VLR

HLR

NoteSubscriberPresent
ReadyForSM (IMSI)

Service Centre

If > 1 SIM, message waiting


data exists and IMSI is the
nominated IMSI
Alert Service Centre (MSISDN)

UpdateLocation (IMSI)
If > 1 SIM, message waiting
data exists and IMSI is the
nominated IMSI
Alert Service Centre (MSISDN)

USSD nominate IMSI (grab or


grant)

If > 1 SIM and message waiting data


exists for new nominated IMSI, and new
nominated IMSI is reachable
Alert Service Centre (MSISDN)

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

51

PrePay Service Support


The HLR interacts with the prepay system in the following cases:
Mobile Originated SMS Messages on page 51
Mobile Terminated SMS Messages on page 53
Mobile Terminated Calls on page 55
Whether the HLR send messages to the prepay system depends on
the following attributes in the hlr_config Table:
CIC_IF_MO_SMS
CIC_IF_MT_CALL
CIC_IF_MT_SMS
SMS_REALTIME_BILLING
And also on whether the subscriber has the PREPAY_IC
supplementary service (see page 597).

Mobile Originated SMS Messages


When a prepay subscriber sends an SMS message, the HLR must
check that the subscriber has credit before allowing the SMS to be
delivered. The message used to check for credit depends on three
factors:
Whether the subscriber has the PREPAY_IC supplementary service
Which of the CIC_IF_MO_SMS and SMS_REALTIME_BILLING
attributes the HLR has in the hlr_config Table
Whether the sendRoutingInformationforSM message contains the
PAYT extension container

MO Message
Submitted

The HLR sends an MOSMSSubmitted message to the PAM after


receiving a sendRoutingInformationforSM MAP message, for a mobile
originated SMS.

Home Location Register (Linux) V1.1 Support Guide

52

Chapter 1 Overview of the HLR

MOSMSSubmitted is sent only if the HLR has


SMS_REALTIME_BILLING in the hlr_config Table and the SRIforSM
message contains the PAYT extension.
SMSC

SRIforSM

SRIforSM Res

MOSMSSubmitted

HLR

PAM
MOSMSSubmittedResp

Check Incoming
Call

The HLR sends a CheckIncomingCall to the PAM after receiving a


sendRoutingInformationforSM MAP message, for a mobile originated
SMS.
CheckIncomingCall is sent only if the subscriber has the PREPAY_IC
supplementary service provisioned and the HLR is configured with
CIC_IF_MO_SMS in the hlr_config Table, or the HLR is configured with
SMS_REALTIME_BILLING in the hlr_config Table, and the
sendRoutingInformationforSM does not contain the PAYT extension
container.

SMSC

SRIforSM

SRIforSM Res

CheckIncomingCall

HLR

PAM
CheckIncomingCallResp

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

53

Mobile Terminated SMS Messages


When a prepay subscriber is sent an SMS message, the HLR must
check that the subscriber has credit before delivering the SMS, in case
the subscriber is required to have airtime credit, or the SMS is to be
reverse-charged. The message used to check for credit depends on
three factors:
Whether the subscriber has the PREPAY_IC supplementary service
Which of the CIC_IF_MT_SMS and SMS_REALTIME_BILLING
attributes the HLR has in the hlr_config Table
Whether the sendRoutingInformationforSM message contains the
PAYT extension container

MT Message
Submitted

The HLR sends a MTSMSSubmitted message to the PAM after


receiving a sendRoutingInformationforSM MAP message, for a mobile
originated SMS.
MTSMSSubmitted is sent only if the HLR has
SMS_REALTIME_BILLING in the hlr_config Table and the SRIforSM
message contains the PAYT extension.
SMS GMSC
SRIforSM

SRIforSMRes

MTSMSSubmitted

HLR

PAM
MTSMSSubmittedResp

Check Incoming
Call

The HLR sends a CheckIncomingCall message to the PAM after


receiving a sendRoutingInformationforSM MAP message, for a mobile
terminated SMS.
The HLR sends the CheckIncomingCall message only if the subscriber
has the PREPAY_IC supplementary service provisioned and the HLR is
configured with CIC_IF_MT_SMS in the hlr_config Table, or the HLR is
configured with SMS_REALTIME_BILLING in the hlr_config Table, and
the sendRoutingInformationforSM message does not contain the PAYT
extension container.

Home Location Register (Linux) V1.1 Support Guide

54

Chapter 1 Overview of the HLR

SMSC

SRIforSM

SRIforSM Res

CheckIncomingCall

HLR

PAM
CheckIncomingCallResp

MT Message
Delivered

The HLR sends an MTSMSDelivered message to the PAM after


receiving a reportSMDeliveryStatus MAP message for a mobile
terminated SMS.
The HLR sends the MTSMSDelivered message only if the
reportSMDelivery status reports successful delivery and debit required.
The subscriber must also have the PREPAY_IC supplementary service
provisioned and the HLR must be configured with
SMS_REALTIME_BILLING in the hlr_config Table.

SMS GMSC

1. ReportSMDeliveryStatus

SRIforSM Res

MTSMSDelivered

HLR

PAM
MTSMSDeliveredResp

Note: At this point the SMS has already been delivered, so the HLR
can no longer control whether the subscriber receives the SMS.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

55

Mobile Terminated Calls


When a prepay subscriber receives a call, the HLR must check that the
subscriber has credit before connecting the call, in case the subscriber
is required to have airtime credit, or is barred. The HLR checks for
credit by sending a CheckIncomingCall message to the PAM.

Check Incoming
Call

The HLR sends a CheckIncomingCall message to the PAM after


receiving a sendRoutingInformation MAP message for a mobile
terminated call.
The HLR sends the CheckIncomingCall message only if the subscriber
has the PREPAY_IC supplementary service provisioned and the HLR is
configured with CIC_IF_MT_CALL in the hlr_config Table.

SMSC

SRIforSM

SRIforSM Res

CheckIncomingCall

HLR

PAM
CheckIncomingCallResp

Home Location Register (Linux) V1.1 Support Guide

56

Chapter 1 Overview of the HLR

Service Provider Services


In addition to selling phones with its own brand, Vodafone supplies
off-the-shelf phones in boxes, which work on the Vodafone network, to
be sold by other organizations, known as service providers, or SPs.
These boxes carry the service providers brand and, if a customer calls
a help line for example, must appear to be a product of the service
provider, not of Vodafone.
To enable customers to hear network announcements and receive
service specific to the service provider that supplied their telephone,
the HLR can route calls to the SPs customer care centres, IVRs and
credit lines.
A subscribers service provider is identified by the SPCODE subscriber
attribute (see page 222).
The HLR is involved in the following interactions between subscriber
and service provider:
Routing Calls to Service Provider Bar on page 56
Call Service Provider Using a Short Code on page 57
USSD Signalling for Service Provider Enquiry on page 58
Signalling for Voicemail Personalization on page 59

Routing Calls to Service Provider Bar


This feature enables a service provider to re-route outgoing calls from a
customer. It can be used, for example, to bar calls from contract
customers who are overdue in settling their account: outgoing calls
from this customer are re-routed to the service providers customer
care division, who can encourage them to settle their account.
The service provider places the bar using ISAAC. This causes the HLR
to download a particular OICK value to the MSC.
The OICK value causes outgoing calls to trigger an enquiry from the
MSC to an IN platform that can modify the call parameters. In the
Vodafone UK network, this IN platform is the SEP. This enquiry allows
the call to be re-routed, to customer care for a service provider for
example, as shown in Figure 24 on page 57.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

57

Figure 24. Route to Service Provider Bar


Mobile
Handset

MSC

SEP

HLR

outgoing call

SRI with route to SP


bar (RTSPB) prefix
ATI

ATI result

SRI result (SP number)

Note: The SEP could send enquiries to other network platforms, as


well as the HLR, before deciding how to route the call.

Default Call Forwarding


This feature allows a service provider to set default values for the three
voice call forward diverts:
busy
no reply
not reachable
This can be used to ensure that unanswered calls are diverted to the
subscribers voicemail service, for example.
A default voice divert is only active when there is no corresponding
active divert.

Call Service Provider Using a Short Code


Subscribers can call their service provider using a short code. The
dialled short code is translated into the service providers number by a
separate IN platform, which is the SEP in the Vodafone UK network.
Figure 25 on page 58 shows signalling for short code dialling to a
service provider.

Home Location Register (Linux) V1.1 Support Guide

58

Chapter 1 Overview of the HLR

Figure 25. Short Code Dialling to a Service Provider


Mobile
Handset

MSC

SEP

HLR

dial service providers


short code
SRI with short code
prefix
ATI

ATI result (service


providers ID)
SRI result (SP number)

USSD Signalling for Service Provider Enquiry


Subscribers can enter a USSD code to find out the name and contact
telephone number of their service provider. The USSD for service
provider information is relayed to the SEP for processing, as shown in
Figure 26 on page 59.

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

59

Figure 26. USSD for Service Provider Information


mobile
handset

MSC

HLR

SEP

USSD for Service


Provider Information
USSD for Service
Provider Information
USSD for Service
Provider Information

ATI for Service


Provider Information

ATI result (service


providers ID)

USSD Text

USSD Text
Text

The HLR holds service provider information in the Service Provider (sp)
Table (see page 532), which the SEP can use, or modify if necessary,
to pass to the subscriber.

Signalling for Voicemail Personalization


When a subscriber is connected to the Vodafone network, a mailbox is
allocated for their voicemail and is personalised using a Vodafone
message, which is played when a subscriber accesses the mailbox.
For service providers other than Vodafone, the message includes the
name of the service provider.
The network entity that personalizes the mailbox is the MLR, but
because it must personalise a voicemail box using a message for the
correct service provider, and the service provider is stored in the HLR,
the MLR sends an enquiry to the HLR.

Home Location Register (Linux) V1.1 Support Guide

60

Chapter 1 Overview of the HLR

Figure 27. Personalise Mailbox with Service Provider Message


ISAAC

MXE

MLR

HLR

CREATE:MAILBOX
create mailbox
ATI

ATI result
Personalise

Acknowledge
Set diverts

Acknowledge
OK

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

61

Control of Access to Premium Rate/Content


The HLR can bar voice calls and SMS messages if a subscriber is not
configured to access premium rate or content (such as adult content).
Access control in the HLR restricts access to content from voice calls,
SMS, MMS and the internet. The HLR uses the ODBOPENT bar for
voice and the ODBOPENTSMS bar for SMS and MMS. ISAAC
interprets voice, SMS and MMS bars as ODBOPENT.
Subscribers can request that the adult content bar be removed,
provided that they can prove their age.

Control by Charging Rate


A subscriber can choose to block all premium rate SMS messages, and
thereby ensure that they are never charged for such messages.
The charging rate of an SMS message is indicated in the SRIforSM
message sent from the SMSC to the HLR. This rate is looked up in the
SMS Barring (smsbar) Table (page 529) to determine whether any
charging bars apply; if they do, a call barred response is returned to the
SMSC, and the SMS is not delivered.
Barring allows SMS charging to be categorized into two levels, high
and low, which correspond to bars ODBPREMSMSHI and
ODBPREMSMSLO. These bars are not provisioned by default, the
subscriber must ask the network operator to add them.

Control by Content
The content of an SMS message is indicated in the SRIforSM message
sent from the SMSC to the HLR. This content type is then looked up in
the SMS Barring (smsbar) Table (see page 529) to determine whether
any content bars apply. If a subscriber has an applicable content bar, a
call barred response is returned to the SMSC, and the SMS is not
delivered.

Control by Source and Destination


Note: This barring method is applied if the HLR cannot bar according
to the charging rate or the content.
The source or destination of an SMS message is indicated, in the form
of a short code, in the SRIforSM message sent from the SMSC to the
HLR. This short code is then looked up in the SMS Barring (smsbar)
Table to determine whether any content bars apply. If a subscriber has
an applicable content bar, a call barred response is returned to the
SMSC, and the SMS is not delivered.

Home Location Register (Linux) V1.1 Support Guide

62

Chapter 1 Overview of the HLR

Access Control Signalling


Control is provided by signalling between the HLR and the Short
Message Service Centre (SMSC).
Figure 28. Barring for Mobile Terminated (MT) SMS Messages

send SMS

SMSC

SRIforSM

Content
Provider

SRIforSM message contains the originating


short code, which identifies the Content
Provider, the content and the charging
information.
Content Provider short codes, content, and
charging types are listed in the SMS Barring
(smsbar) Table (see page 529). If any of the
relevant information is missing from the
SRIforSM, the HLR bars on shortcode by
price or content.

HLR

If subscriber has content or


premium rate bars, the HLR
returns a call barred result to the
SMSC, and the SMS is not
delivered.
A monthly report lists SMS
messages that were not
delivered so that the Content
Provider cannot claim the
charges for them.

Figure 29. Barring for Mobile Originated (MO) SMS Messages


send SMS

Content
Provider

SMSC

SRIforSM message containing the destination


short code which identifies the Content
Provider, and content and charging
information.

If subscriber has content or


premium rate bars, the HLR
returns a call barred result to the
SMSC, and the SMS is not
delivered.
The subscriber is then sent a
class 0 SMS message containing
the RESPONSE entry in the
SMS Barring (smsbar) Table
(see page 529).

Content Provider short codes, content, and


charging types are listed in the SMS Barring
(smsbar) Table (see page 529).

HLR

Informing the Subscriber that Content was Barred


The subscriber is sent a class 0 SMS message containing the
RESPONSE entry in the SMS Barring (smsbar) Table (see page 530).

Home Location Register (Linux) V1.1 Support Guide

Chapter 1 Overview of the HLR

63

A class 0 message is displayed immediately on the subscribers


handset, without the subscriber having to retrieve it. The SMS is not
submitted to the Vodafone SMSC, it is sent directly from the HLR (via
the visited MSC). If this SMS does not get through, no further attempts
are made.

Limitations of Access Control


Subscribers may still be able to receive adult content SMS messages
from, or send them to, another network. This is inherent in the
interaction between the SMSC and the HLR.

Access Control While Roaming


Both mobile originated and mobile terminated SMS and MMS
messages continue to be controlled while a subscriber is roaming
because these messages are still controlled by the Vodafone SMSC/
MMSC.

Home Location Register (Linux) V1.1 Support Guide

64

Chapter 1 Overview of the HLR

Video Telephony
Subscribers to the third generation (UMTS) network have the capability
to make calls that use both voice and pictures, known as video
telephony. Video telephony is provided by basic service BS30, which
can be provided using the ADD:SERVICE administration command.

Network
Requirements

Video telephony requires the following:


the subscriber has service BS30
the VLR supports BS30
the VLR supports application contexts:
- V3_AND_ABOVE
- NETWORK_LOC_UP_V3
- SUBSCRIBER_DATA_MNGT_V3
VLR support of basic services is listed under UNSUPP_BS in the
[PROFILE <profile_name>] section of the Network Entity (netent) Table
(see page 509).
VLR support of application contexts is listed under UNSUPP_AC in the
Network Entity (netent) Table.

Unsupported
If a VLR is upgraded, the Network Entity (netent) Table might indicate
that
the VLR does not support video telephony even though it does.
Application
Context Learning The HLR periodically checks network entities and maintains an
unsupported application context learning (UAL) list containing up to
date capabilities of network entities without having to update the
NETENT table.
The period between updates of the UAL list is specified by the
UAL_RETRY parameter in the PDS Configuration (pds_config) Table
(see page 523).

Home Location Register (Linux) V1.1 Support Guide

65

Chapter 2

HLR Interfaces
The HLR has these interfaces, illustrated in Figure 30 on page 66:
Administration centre interface, which allows subscriber data to be
controlled.
Operations and Maintenance Centre interface used to report
platform alarms, and allow support staff to connect to the platform to
check operation and correct faults.
Figure 31 on page 68 shows the alarms interface in more detail.
SIGTRAN Network interface, which handles the messages used in
the GSM network to send call routing and short message routing
requests, USSD commands and other events to and from other
network entities.
Figure 30 on page 66 shows the interface with the SIGTRAN
network in more detail.
Some HLR parameters can be configured by the subscriber via
USSD commands, and other interfaces provide regular off-node
backups of the subscriber database, and logging of signalling
events.

Home Location Register (Linux) V1.1 Support Guide

66

Chapter 2 HLR Interfaces

Figure 30. HLR Interfaces and Accounts


Administration
Centre (ADC)
Number and Service
Administration

IP to ISAAC
admin port

HLR

ISAAC

Operations and
Maintenance (O&M)

Customer
Care

TCPIP

IN_VIEW

SNMP
First-Line
Support

SNMP agent

Alarms

MMI
Second-Line
Support
Manage system,
including network
configuration

Subscribers
USSDs

Remote Engineer
web server

pds_manager
account

Off-Node Backup
Subscriber Database
Event Logging
Network Services
TCPIP
IVS

Table 6 describes the network elements connected to the HLR.

Home Location Register (Linux) V1.1 Support Guide

Chapter 2 HLR Interfaces

67

Table 6. Network Elements Connected to the HLR


Name

Network Component

Function

ADC

Administration Centre

Manages subscriber data and connections to the HLR.

CGSN

Combined GPRS Support


Node

Effectively synonymous with SGSN.

GMPC

Gateway Mobile Positioning


Centre

Connection to the Internet portal to authenticate and find the


position of a mobile subscriber.

GMSC

Gateway Mobile
Switching Centre

Controls routing of mobile terminated calls.

IVS

IN_VIEW Server

Used by customer care and support staff in the Operations


and Maintenance Centre (OMC) to view data on the HLR.

LES

Location Enabling Server

Controls privacy of subscribers using location-based


services.

MCS

Missed Call Server

Runs the application supporting the missed calls SMS


service, delivering text message notifications of missed calls
due to being busy or not reachable or due to voicemail
slamdown.

MLR

Mailbox Location Register

Manages mailbox allocation and subscriber message


services.

MMSC

MultiMedia Message Centre

Manages the multimedia message service.

OMC

Operations and
Maintenance Centre

Monitors the operation of the HLR.

OTA

Over The Air server

Sends special SMS messages to subscribers to change


their handset settings (via the SIM).

PAM

Prepayment Account Manager

Holds and manages credit for prepay subscribers.

PCM

Prepayment Call Manager

Routes messages to the PAM that holds a particular prepay


subscribers account.

SAP

Service Access Point

Used as a lookup to determine the MLR to which a


subscribers voicemail mailbox is connected.

SCCP
Relay

Signalling Connection
Control Part Relay

Controls IMSI-based message routing to the HLR.

SDN/
ISR

SMS Distribution Node/


Intelligent SMS router

Load-balances SMS traffic between SMSCs.

SEP

Service Execution Point

Generic entity that manages network services.

SGSN

Serving GPRS Support Node

General Packet Radio Service (GPRS) network entity


geographically close to the subscriber. Keeps a copy of
subscriber data.

SMSC

Short Message Service Centre

Manages the short message service.

SRP

Service Relay Point

Determines on which SEP a subscriber is connected.

VLR

Visitor Location Register

GSM network entity geographically close to the subscriber.


Keeps a copy of subscriber data.

Home Location Register (Linux) V1.1 Support Guide

68

Chapter 2 HLR Interfaces

Alarms Interfaces
The HLR interfaces with an Operations and Maintenance (OMC) centre
are illustrated in Figure 31 below.
Figure 31. Alarms Interface

HLR
SNMP feed for TeMIP

print to pds_alarms

TeMIP
Operations and Maintenance
(O & M) Interfaces

Support

Manage System,
including
network
configuration

Home Location Register (Linux) V1.1 Support Guide

Set up
test
phones

Chapter 2 HLR Interfaces

69

SNMP Agent
The SNMP agent provides to the upper layers of NMS information
concerning the hardware, the operating system and the application. In
order to achieve this, the SNMP agent has a hierarchic architecture
composed of master agent, a PM (Performance Monitoring) subagent
and a FM (Fault Management) subagent.
The SNMP master agent is the SNMP front end that handles all the
interactions with the SNMP manager. This master agent processes all
the requests concerning the hardware and operating system, and
forwards the PM- or FM-related ones to the PM or FM subagent
respectively using the AgentX protocol. The subagents process such
requests and deliver the responses back to the master agent, which in
turn does the same with the originating SNMP manager.
The PM subagent deals with the application layer variables, which are
monitored at a higher layer in NMS. The PM subagent obtains those
variables from the application by means of the Pulse interface.
The FM subagents task is to provide NMS with the fault management
information from the application. This information is obtained from the
PDS application through the syslogd interface.
Use the following commands to manage the SNMP master agent and
subagents:
Agent

Command

Arguments

SNMP Master Agent

snmpd

PM Subagent

pmsnmpx

FM Subagent

fmsnmpx

start to start the agent


stop to stop the agent
restart to restart the agent
condrestart to restart the agent
only if it is already running
reload to reload the agents
configuration files
status to show the status of the
agent

See the man pages for more information about these commands.
For more about SNMP on the HLR, see the documents HLR SNMP
Agent Users Manual and PDS SNMP Agent Developers Manual.

Home Location Register (Linux) V1.1 Support Guide

70

Chapter 2 HLR Interfaces

Credit checking for


prepay calls and SMS

Subscriber location
privacy control

PAM
PAM
PCM

PAM
PAM
PAM

TCP/IP Network Interface


LES

Home Location Register (Linux) V1.1 Support Guide

71

Chapter 3

System Architecture
The HLR uses a standard hardware and software platform called the
Linux VodaSCP, which has the architecture shown in Figure 32.

Figure 32. HLR Architecture


HLR
application

SIGTRAN
stack

Linux

Core
Packet
Network

Data
network

SIGTRAN
network

O&M

Home Location Register (Linux) V1.1 Support Guide

72

Chapter 3 System Architecture

Software
The software consists of:
the Red Hat Enterprise Linux operating system.
SIGTRAN communications software, which provides the interface to
the SIGTRAN signalling network (see Chapter 8, SIGTRAN
Configuration).
HLR application software and database, which provides the HLR
functionality.

Home Location Register (Linux) V1.1 Support Guide

Chapter 3 System Architecture

73

Hardware
The hardware is an HP computer system, which provides the
processing power and the following network interfaces:
SIGTRAN connections to other network entities such as the VLR/
MSC and SCCP Relay.
inter-computer (Ethernet) connections to the OMC and ADC. The
interfaces can be used either with Vodafones own ADC (ISAAC)
and OMC (TeMIP via TCP/IP, or with any other compatible ADC or
OMC.

Home Location Register (Linux) V1.1 Support Guide

74

Chapter 3 System Architecture

Directory Structure
All nodes have the same directory structure. All directories are local to
each node, with no shared disk space in the cluster.
Figure 33. Platform Directory Structure
E n trie s a re m a d e in th e
in itta b file a n d s y s lo g d file
to e n s u re th e a p p lic a tio n is
s ta rte d a t s y s te m b o o t,
a n d c o rre c t lo g g in g
o p e ra tio n .
v o d a fo n e

e tc

in itta b
s y s lo g d .c o n f
opt

pds
p d s 1 _ x .x .x
snm p
conf
m ib s
s n m p d .c o n f

hom e
sysconf

pds_ m anager
opt

c ro n .d
in it.d

v o d a fo n e

lo g ro ta te .d

pds
p d s 1 x .x .x

p ro file .d
udev
b in
d a ta

x in it.d
re g is te r_ b a c k u p
sdf
ta b le s
c u rre n t
w o rk in g

e tc
lib e x e c
s ta te
lo g
m an
m an
s y s c o n fs c rip ts

var

ta b le s e ts
lo g

te m p la te s
pds
p d s 1 _ x .x .x
aux
a v a ila b ility _ y e a r_ n o .d a t
p d s _ a la rm s
p d s _ a la rm s .n
p d s _ s ta rtu p
p d s _ s ta rtu p .n
P D S .lo g
P D S .lo g .n
p ro c e s s _ n a m e ...

ru n
p d s 1 _ x .x .x
lib
opt

v o d a fo n e
p d s 1 _ x .x .x
d a ta b a s e file s ...
pds_ on
sdf
ta b le s
re g is te r_ b a c k u p
= s y m b o lic lin k

Directory Paths Defined in PDS


The following paths are defined:
logdir

/opt/vodafone/pds/log

cfgdir

opt/vodafone/pds/etc

Home Location Register (Linux) V1.1 Support Guide

Chapter 3 System Architecture

75

comdir

/opt/vodafone/pds/bin

exedir

/opt/vodafone/pds/libexec

shrdir

/opt/vodafone/pds/data

statedir

/opt/vodafone/pds/state

sdfdir

/opt/vodafone/pds/data/sdf

sdmdir

/tmp

Home Location Register (Linux) V1.1 Support Guide

76

Chapter 3 System Architecture

Logical Databases
Each HLR database has a logical database name (referred to as
log_db_name in configuration file templates).
This name identifies the database in the network consisting of multiple
HLRs, and enables future DR Triad features to move the database from
one HLR to another without losing its identify.
Note: log_db_name is case-sensitive. You are recommended to use
only uppercase characters, as the rest of the database file names are
written in uppercase.
In this release, each Linux HLR will handle only one logical database.
In future releases, each HLR node will be able to serve/slave multiple
databases in DR Triad configuration.
For more information about logical databases, see Appendix D,
Backing-up the HLR Database.

Database File Names


The database file names are:
$shrdir/
<log_db_name>_HLRD_FILE

the database file

$shrdir/
<log_db_name>_HLRD_SAVED.BK1,
$shrdir/
<log_db_name>_HLRD_SAVED.BK2

The database backup files

$shrdir/register_backup/
<log_db_name>_HLRD_FILE.BAK

The backup file for


copying off node.

Home Location Register (Linux) V1.1 Support Guide

Chapter 3 System Architecture

77

Fault Tolerance
The following features provide the HLRs fault tolerance:

Component
Duplication

Most HLR components are duplicated within the system, so if one fails
the system can continue to operate.

Cutovers

The HLR is designed to operate in a cluster in live/standby


configuration. If the live HLR node should fail the standby node
becomes live and take up all the load. The failed node attempts to
recover automatically and become the new standby node.

Database
Backups

The HLR application writes subscriber data from memory to disk at


regular intervals. This ensures that, even if there is a total power loss,
the HLR database will restart from a recent copy.

The HLR also writes the subscriber data into two alternating backup
files that are checked for consistency. The last consistent copy is not
overwritten until a new consistent copy exists. This ensures that, in the
event of database corruption, a recent consistent copy will exist.
Note: A manual backup facility must be set up by the system manager.
See External Backup Procedure on page 589 for details.

Alarms

The HLR application sends an alarm to the OMC whenever any system
components fail. See Chapter 7, Alarms for details of the alarms
generated by the HLR.

Home Location Register (Linux) V1.1 Support Guide

78

Home Location Register (Linux) V1.1 Support Guide

Chapter 3 System Architecture

79

Chapter 4

Support Interfaces
This chapter describes the HLR User Interface, including how to:
connect to an HLR node. See The Remote Engineer Interface
below.
log on to and use Remote Engineer and pds_manager. See The
Remote Engineer Interface on page 80 and The pds_manager
Account on page 83.

Connecting to the HLR


You can connect to the HLR in two ways:
The Remote Engineer web page (see page 80) gives first-line
support staff access to a restricted menu of facilities.
The pds_manager account (see page 83) gives second-line support
staff full operating-system access to the HLRs commands, data and
diagnostic utilities. It also gives access to the Administration
interface for users managing the HLR database.

Home Location Register (Linux) V1.1 Support Guide

80

Chapter 4 Support Interfaces

The Remote Engineer Interface


The Remote Engineer interface consists of a set of web pages that
provides a menu of options which lets first-line support staff control the
HLR and obtain status information about it.

Creating Remote Engineer Logins: User Manager


Remote Engineer logins are created using the User Manager web
page. This page allows users to create logins/passwords for the
Remote Engineer web page, and assign roles to the logins. The role
assigned determines what tasks the Remote Engineer user can
perform.
To log on to the User Manager web site:
1. Enter the following URL in your web browser:
http://platform.vfl.vodafone:8080/user-manager/
Replace platform with the name of the platform.
2. Enter your login and password, and then click /RJ,Q. The main menu
is displayed (see Figure 34).
Figure 34. User Manager Main Menu

Click $GG8VHU to add new Remote Engineer users.

Logging On to the Remote Engineer Web Site


To do this:
1. Enter the following URL in your web browser:

Home Location Register (Linux) V1.1 Support Guide

Chapter 4 Support Interfaces

81

http://platform .vfl.vodafone:8080/remote-eng/do/
systemOverview
Replace platform with the name of the platform.
2. Enter your login and password, and then click /RJ,Q. The main menu
is displayed (see Figure 35).
Note: The items that appear on the main menu depend on the role that
has been assigned to the login in User Manager.
The page title displays the name of the IN node you are managing. To
manage a different node on the same platform, select it in the dropdown menu at the top of the page.
Figure 35. Remote Engineer Main Menu

Logging Off from Remote Engineer


To log off, click /RJ2XW in the banner at the top of the page.

Home Location Register (Linux) V1.1 Support Guide

82

Chapter 4 Support Interfaces

Figure 36. Logging out of Remote Engineer

Using the Remote Engineer Menu


The Main Menu has two main sections:
System details
Allows you to view aspects of the system (for example, show
processes)
Actions
Allows you to manage the system (for example, restart the software)
The options are summarised in Table 7.
Table 7. Remote Engineer Main Menu
Main Menu Option

Function

6\VWHPGHWDLOV
3URFHVVHV

Display the processes running on the system, including CPU and memory usage.
Allows you to filter the processes displayed. See Showing HLR Processes.

+DUGZDUH6RIWZDUH
9HUVLRQV

Display details of the hardware and system software, including installation dates.

,QVWDOO+LVWRU\

View a list of all software packages installed, and when they were installed.

1RGH6WDWLVWLFV

Display graphs of CPU utilisation, network I/O, block device I/O, memory
allocation, and disk utilization.

$YDLODELOLW\5HSRUWV

Display statistics on downtime and outages.

7DEOH9LHZ

Displays the contents of the configuration tables described in Chapter 24, Table
Maintenance.

$FWLRQV
5HVWDUW3'6

Restart the PDS software.

5XQGEFKHFN

Run the dbcheck utility.

5XQGEYLHZ

Run the dbview utility.

5XQVUQYLHZ

Run the srnview utility.

&UHDWH6,*75$16')V

Create SIGTRAN Screen Definition Files. See Appendix A, Using PULSE.

&UHDWH1HWZRUN(QWLW\
6')V

Create Network Entity Screen Definition Files. Appendix A, Using PULSE.

Home Location Register (Linux) V1.1 Support Guide

Chapter 4 Support Interfaces

83

The pds_manager Account


The pds_manager account provides direct access to the HLR, allowing
you to:
use diagnostic utilities such as PULSE
examine data files
access the Administration and Table Maintenance interfaces
check the traffic between the HLR and the SIGTRAN network.
Access to the pds_manager account may be controlled by local
operating procedures.

Logging On to pds_manager
To log on the pds_manager:
1. Enter the following command:
ssh pds_manager@nodename
2. At the Password: prompt, enter the pds_manager account
password.
The system prompt is displayed.
If the banner shows anything other than S/W RELEASE VNNNN, report
to the next line of support that the platform software is not an approved
release.

Logging Off from pds_manager


To log off, enter exit

Accessing the Administration Interface


For how to access the administration interface from the pds_manager
account, see Accessing the Administration Interface on page 176.

Home Location Register (Linux) V1.1 Support Guide

84

Home Location Register (Linux) V1.1 Support Guide

Chapter 4 Support Interfaces

85

Chapter 5

Identifying Problems
This chapter describes how to deal with problems on the HLR,
including how to:
identify the problem, and the steps you should take to investigate
and fix it. See below.
deal with common problems. See page 87.
check event log files. See page 95.
Use this chapter in conjunction with the following chapters in this guide:
Chapter 6, Using Support Interfaces, describes all the procedures
and commands you may need to use.
Chapter 7, Alarms, describes every critical and major HLR alarm.

Identifying and Investigating Problems


Problems with the HLR may be indicated by:
HLR alarms raised on TeMIP.
Alarms indicate specific problems on specific HLRs. If an alarm is
shown, find the description of the alarm in Chapter 7, Alarms and
follow the instructions given there. Flooding of TeMIP by alarms is
described on page 94.
Complaints from:
- Customers connected to a specific HLR about interruptions to
service.
- Administration staff that they cannot access the HLR interface.
If complaints are received about interruptions to services or access
to the HLR, follow the procedure in Figure 37 on page 86.

Home Location Register (Linux) V1.1 Support Guide

86

Chapter 5 Identifying Problems

Figure 37. First-line Problem Investigation Procedure


START

Make test calls to check if


the HLR is providing any
service to the network.
See page 99.

Do all
test calls
succeed?

NO

Check the status of


HLRs connections to
the SIGTRAN network.
See page 114

YES

All network
connections
OK?

NO

Identify and fix the


cause of any network
problems.
See page 91

NO

Restart the HLR as


required.
See page 115

YES
Check the status of the
HLR software
processes.
See page 100

Are all
processes
OK?

YES

Is
network service
affected?

YES

Escalate the problem


to second-line
support.
See page xviii

NO
If the mobile equipment is
not blacklisted, report the
problem to second-line
support.

Home Location Register (Linux) V1.1 Support Guide

STOP

Chapter 5 Identifying Problems

87

Possible Problems
This section describes possible problems and how to deal with them. It
assumes that you have access to the pds_manager account.
The problems covered are:
Software Start-up Failure on page 88
Computer Failure on page 91
Data Network Communication Failure on page 91
SIGTRAN Network Connection Failure on page 91
Database Corruption on page 93
Alarm Flooding on page 94.

Home Location Register (Linux) V1.1 Support Guide

88

Chapter 5 Identifying Problems

Software Start-up Failure


Software start-up failure must be dealt with by second-line support. If
the HLR application fails to start correctly:
1. Check that the node has not run out of disk space. See below.
2. Examine the start-up log files to find out more about the source of
the problem. See page 89.
3. Check that the nodes resources are not exhausted.

Lack of Disk Space


When the HLR restarts it creates a log file for each process in the /
opt/vodafone/pds/log/aux directory. If the disk is full, then the
HLR processes will not be able to start.
Check the amount of disk space by using the command
df
An example output from this command is shown below:
Filesystem

1K-blocks

Used

Availabl
e

Use%

Mounted
on

/dev/mapper/
rootvglv_root

20642428

521280

19072572

3%

/dev/cciss/
c0d0p1

101086

22757

73110

24%

/boot

none

8126960

441576

7685384

6%

/dev/shm

/dev/mapper/
rootvg-lv_vf

20642428

269048

19324804

2%

/opt/
vodafone

/dev/mapper/
rootvg-lv_tmp

4128448

41652

3877084

2%

/tmp

/dev/mapper/
rootvg-lv_usr

5160576

1650552

3247880

34%

/usr

/dev/mapper/
rootvg-lv_var

4128448

640668

3278068

17%

/var

To view more detail about the file usage on each disk, use the following
command:
du -a|more

aux log files

The disk used by the aux log is mounted on /var. If this disk is full or
nearly full it is necessary to purge the aux files using the command:

Home Location Register (Linux) V1.1 Support Guide

Chapter 5 Identifying Problems

89

aux_purge -k 3
This retains the aux files for the last three startup instances. Note that
aux files are purged automatically each night, so if there are excessive
files, there must be an underlying fault which will require escalating to
the next level of support.

Core dump files

The location and naming convention for core dump files is in:
/proc/sys/kernel/core_pattern
The default setting is:
/var/lib/cores.in/%h.%p-%e.core
Where %h = host name, %p = process name, %e is process id.
The daemon corewatchd processes the core dump files when they are
created.
The daemon configuration is in:
/etc/sysconfig/corewatchd
The daemon calls the Perl script /usr/libexec/corewatch/
process_core.pl, which zips the core dump file and puts it in /var/
lib/cores.out/.
Therefore, with the corewatch service running, you should never see a
core dump file in cores.in.
Note: While a process has a core dump, no new dumps will be
created. When you have finished analysing the core dump file,
remember to remove it.

Start-Up Log Files


Whenever the HLR is restarted, each PDS process writes output to the
/opt/vodafone/pds/log/pds_startup file through the system
logger (syslog).
If you have software startup problems, examine this file for the cause of
the problem.
To monitor system startup in real time, enter the following command:
tail -f /opt/vodafone/pds/log/pds_startup
This prints startup information live to the terminal. Press CTRL+C to
stop the feed.
The tail command starts by printing the last 10 or so lines followed by
the live feed. If you want to view more history to start with, add -n
number_of_lines to the tail command as follows:
tail -f -n 1000 /opt/vodafone/pds/log/pds_startup

Home Location Register (Linux) V1.1 Support Guide

90

Chapter 5 Identifying Problems

The startup file is rotated daily. The previous files are called
pds_startup.1 (from yesterday), pds_startup.2 (the day before),
and so on up to pds_startup.5 (although the limit is configurable).To
analyse these files, use a text editor.

Home Location Register (Linux) V1.1 Support Guide

Chapter 5 Identifying Problems

91

Computer Failure
If an HLR node fails, you cannot log on to it. If the live node fails, an
automatic cutover will take place. See page 104.
Escalate the problem to the relevant support team. The HLR
application starts automatically when the node is restarted.

Data Network Communication Failure


Data network communication failures are caused by problems with:
the HLRs local Ethernet
the communication path to the ADC and OMC beyond the local
Ethernet.
These could have one or more of the following effects:
If the link to the OMC fails, no HLR alarms are received or displayed
by the OMC. The first sign of network problems may be customer
complaints.
If the link to the ADC fails, no subscriber administration operations
can take place. (If ISAAC is in use, this causes the ISAAC queue to
stall.)
HLRs have a dual Ethernet, so service can continue unless both
Ethernets fail (although failure on one Ethernet might disrupt traffic on
the other one).
Any network communication failures must be fixed urgently.
Escalate the problem to your network support department.

SIGTRAN Network Connection Failure


The HLRs SIGTRAN connections can fail in several ways. These
include:
Interface Card Failure on page 92
External CPN Failure
Faults in the CPN are beyond the scope of this document. See your
local operating procedures and documentation for more information.

Home Location Register (Linux) V1.1 Support Guide

92

Chapter 5 Identifying Problems

Interface Card Failure


Interface cards provide connections to the CPN. Each card has
physical ports, which are handled by SIGTRAN as follows:
Each communication port is connected to the red or blue CPN
network.
Each M3UA association is mapped to either the red or blue CPN.
Each remote endpoint is reachable through both the red and blue
networks, so service should not be affected, although traffic on the
remaining association will increase.
Symptoms of interface card problems are:
M3UA associations being shown as down. See Showing M3UA
Association on page 106 for more details on checking M3UA
availability.
If test calls are unsuccessful, check the status of all ports on the
node (see Showing M3UA Association on page 106).

Investigation Procedure
pds_
manager

Use PULSE to check the status of the HLRs SIGTRAN network


connections and the card associated with each link.
If the port is not operating correctly, the fault is probably in the interface
card or CPN.
If an interface card is not operating normally, escalate the problem to
the department responsible for maintaining HLR hardware.
When a port is returned to service:
Several SIGTRAN event alarms (A3, or Minor) may be shown (if
events have been enabled).
The M3UA association is shown as established. See Showing
M3UA Association on page 106 for how to check M3UA availability.

Home Location Register (Linux) V1.1 Support Guide

Chapter 5 Identifying Problems

93

Database Corruption
Database corruption may cause one or more alarms, indicating specific
areas of corruption and/or consistency check failures (see Chapter 7,
Alarms).
Escalate these alarms to third-line support. If the database cannot be
fixed, it will have to be recovered from the most recent backup copy
(see page 118). See Appendix D, Backing-up the HLR Database for
information on database securing and the HLRs backup mechanisms.

Removing Disks

The HLRs disks contain information vital to network security. If,


following a major disk failure, the database cannot be restored, it must
be copied from backup to a new disk. The disks must never be taken
off-site from the HLR installation. Any failed disks must be
physically destroyed on-site using the local procedures for
sensitive media.

Home Location Register (Linux) V1.1 Support Guide

94

Chapter 5 Identifying Problems

Alarm Flooding
Alarms that occur frequently and repeatedly can fill (flood) the TeMIP
display making it difficult for operators to see other alarms. Alarms
must be dealt with from the TeMIP user interface.
Alarms that flood TeMIP should be reported rather than escalated.
Alarms should be escalated rather than reported if:
they are database corruption alarms
hundreds of SIGTRAN-related alarms occur in each hour.

Home Location Register (Linux) V1.1 Support Guide

Chapter 5 Identifying Problems

95

Event Log Files


An event is a message exchanged by the HLR across its interface to:
the SIGTRAN network
the ADC (normally ISAAC).
The OMCS process logs these events in a series of binary files in the
/var/log/pds directory.
The current log file is named PDS.log, and old log files are named
PDS.log.log_file_no. The log file number is incremented each
time a new log is written. For example, PDS.log, PDS.log.1,
PDS.log.2 and so on. The maximum value of log_file_no is
configurable (default = 9): once this maximum is reached, the oldest file
is overwritten.
Log files can be rotated manually using the pds rotate command: see
the relevant man page for more information.
See Appendix K, Event Log Files for examples of how to interpret event
log files.

Viewing Event Log Files


To access the event log files you must first log in to the HLR using
pds_manager. See Chapter 4, Support Interfaces for details of how to
do this.
Event log files are written in binary format. Therefore, to view a log file,
or create a text version of it, you must use the logview utility (see Using
logview to examine log files below).
You can use logview in real time, to view events as they are being
logged, or you can use it to examine historical log files.

Using logview in
real time

To view start the display of logs as they are being written, enter:
logview -n nodename
where nodename is the name of the platform.
To end the display, enter CTRL+c.

Home Location Register (Linux) V1.1 Support Guide

96

Chapter 5 Identifying Problems

An example of the logs displayed is:

Using logview to
examine log files

You can view the log file directly, or create a text version of it.
To view the file, enter:
logview log_file | less
where log_file is the full path and file name of the file you want to
view. Use the arrow keys to navigate through the document, and use q
to quit.
Create a text version of a log file using the command:
logview log_file -o output
output is the name of a text file.
log_file is the name of the log file that you want to create a text
version of.
You can now view the text copy of the log file using a text editor or print
it to a printer. Full options are available in the logview man pages.
To view the current log file, you must first force the OMCS process to
create a new current log file. To do this, use the following command:
pds rotate
This causes the OMCS process to rotate its backup log files, and
rename the current log file to PDS.log.1.

Home Location Register (Linux) V1.1 Support Guide

97

Chapter 6

Using Support Interfaces


This chapter describes procedures you use to check that the HLR is
working properly.
For more information about how to diagnose problems with the HLR
and when to use these procedures, see Chapter 5, Identifying
Problems.

Problem Solving Procedures


The following information is provided for each problem solving
procedure:
The purpose of the procedure
Availability (if applicable) - on which node(s) the procedure can be
used
Procedure - what to do
Results - the expected results of the procedure.
The procedures are grouped into the following sections:
Checking HLR Status on page 98.
Controlling the HLR on page 114.
Checking and Managing the HLR on page 120.

When to Use PULSE


Procedures in this section use Remote Engineer or the pds_manager
account, but you can also use the PULSE utility to obtain information
about the traffic between the HLR and the SIGTRAN network. See
Appendix A, Using PULSE for details.

When to Use Remote Engineer


Remote Engineer is a web-based, password-controlled monitoring
utility. It provides limited access to the platform, and so avoids the risk
of adversely affecting network services. Remote Engineer also
provides quick, point-and-click access to many common support tasks.

Home Location Register (Linux) V1.1 Support Guide

98

Chapter 6 Using Support Interfaces

Checking HLR Status


Use the following procedures to determine the status of the HLR.
Making IncomingTest Calls. Is the HLR providing any service to the
network? See page 99.
Showing HLR Processes. Check that the HLR application is running
correctly. See page 100.
Showing M3UA Association. Check the HLRs SIGTRAN
associations. See page 106 and Using PULSE on page 569.
Controlling the HLR. Check the HLRs remote destinations. See
page 114 and Using PULSE on page 569.

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

99

Making IncomingTest Calls


Incoming test calls let you check the HLRs network service by using
the communications path to and from the HLR, and its basic
functionality.
Note: Outgoing calls are not effective tests of the GSM HLR. Switching
a test mobile off and on and then making a call does not necessarily
involve any communication with the HLR. The test SIM may still be
registered on the VLR even when the mobile phone is switched off. An
outgoing test call may succeed even if the HLR has failed.
To make incoming test calls, you need:
a GSM mobile phone, containing a test SIM with an IMSI that is
connected on this HLR. Dial *#101# to make sure that the test SIM
is on the correct HLR.
another phone (mobile or fixed) to make the test call.

Procedure
Repeat the procedure at least ten times.
1. Switch on the mobile phone containing the test SIM.
2. Using the other phone, call the test SIMs number. If the call
connection works, the mobile phone with the test SIM will ring.

Results
After making test calls, take action as follows:
If all the test calls fail, the HLR is not providing any service to the
network.
Immediately check the status of the HLRs connections to the
SIGTRAN network. See Showing M3UA Association on page 106.
If some of the calls fail, the HLR is still working but some
subscribers may be experiencing interruptions to or loss of service.
Check the status of the HLRs connections to the SIGTRAN
network. See Showing M3UA Association on page 106.
If all test calls succeed, the HLR is servicing the network. If you are
investigating a problem, report that test calls succeeded to
second-line support.

Home Location Register (Linux) V1.1 Support Guide

100

Chapter 6 Using Support Interfaces

Showing HLR Processes


Certain processes must be running on the HLR for it to work properly.
Use this procedure to show the HLR processes running on an HLR
node and check that they are all present.
Both live and standby nodes run the same processes, so it is not
possible to distinguish between live and standby nodes by listing
processes. See Checking for the Live Node on page 121 for how to
distinguish between nodes.

Availability
Use on either a live or standby node.

Procedure
Remote Engineer Click 3URFHVVHV.
pds_manager

Enter the command:


ss pds

Results
A list of HLR processes running on the node is displayed:
Figure 38 on page 101 shows an example of the ss pds command.
Figure 39 on page 102 shows an example of displaying processes
using the Remote Engineer web page.
You can filter the processes in the display by command name. You can
also specify how often the display is refreshed.
If processes are consistently showing 75% or greater CPU usage,
there may be a system problem.

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

101

Figure 38. Extract from ss pds command output

The columns in the output are as follows:


PID: Process ID, unique for each process.
PGID: Process Group ID.
The same PGID will be used for MGTA and all its children (1462 in
the above example).
Another one is used for pds_boot, pds_i_boot and the alarm server
process (2690 in the above example).
STAT is process status. See the man page for ps for the meaning of
each character.
COMMAND is the name of the executable.
STARTED is the date and time when started. If started on the
current day, only the time is displayed.
%CPU and %MEM are the percentages of resource usage for CPU
and physical memory.
VSZ, SZ and RSS are different measures of memory utilization.See
the man page for ps for the exact meaning.
# is the incarnation number assigned by pds_i_boot.

Incarnation
number

Each time pds_i_boot is started it picks a new incarnation number


based on the contents of the pds/log/aux directory. If the directory is
empty, it will start with "1".

Home Location Register (Linux) V1.1 Support Guide

102

Chapter 6 Using Support Interfaces

When pds_i_boot starts other processes, it uses this number for each
process. Each time it restarts the processes, it increments the number.
In the example, pds_i_boot was started with 21 and has restarted the
other processes several times as can be seen by the number "47". If,
however, the child processes restart very quickly, pds_i_boot will only
increment the number three times and then reuse the number until the
system has run for at least 10 seconds without restart.
When you examine the contents of pds/log/pds_startup, each
process displays its incarnation number in brackets, for example:
... MGTA(47) ......
Figure 39. Remote Engineer Show Processes on Node

If the HLR is working properly, the processes shown in Table 8 will be


running. If any of these processes are not running, take the action
indicated.

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

103

Table 8. Processes on a Stable HLR


Software
Component
HLR

Processes

Notes

pds_boot
pds_i_boot
pds_i_alarmsv
pds_i_mgta
pds_i_omcs
pds_i_s7mp
pds_i_hssp
pds_i_mp
pds_i_hlrd
psd_i_hlra
pds_i_adm_hlr
pds_i_pmsnmpx
pds_i_fmsnmpx
pds_i_tcpip

The I/O count for the


pds_i_hlra
processes should
increase over a few
seconds.

Action Required if Any


Processes are Missing
If any processes are missing, the
HLR has failed.

The two pds boot processes ensure that the platform restarts after a
shutdown, or power outage.
The alarm server process handles the generation of platform alarms
for all other processes.
The mgta process monitors processes, to detect failures. If a
process fails, MGTA starts a secure to disk and stops all processes,
which are subsequently restarted by pds boot.
The omcs process handles logging for all processes.
The s7mp process handles configuration and reconfiguration of the
SIGTRAN stack.
The hssp process is the SIGTRAN stack implementation.
The mp (maintenance) process backs up the HLR database to disk
and verifies the backup.
The hlrd process provides the database functionality.
The hlra process provides the HLR application functionality.
The adm process provides the administration interface.
The two snmp processes supply fault and performance metrics via
SNMP to a suitable off node client.
The tcpip process handles TCPIP client connections to other
systems like the Location Enabling Server (LES) and also inter-HLR
connectivity used for database synchronization.
Note: The Pid should remain the same each time the display is
checked. If it does not, the process is unstable, and further
investigation should be carried out.

Home Location Register (Linux) V1.1 Support Guide

104

Chapter 6 Using Support Interfaces

Automatic Cutovers (Live Node)


If any fatal event occurs or any HLR process fails on the live node:
1. The standby node automatically takes over as the new live node.
2. The failed node restarts automatically and becomes the new
standby node.
Figure 40 on page 105 shows the sequence of events during a cutover.
After a cutover, check that:
1. The appropriate processes are running on both the live and standby
nodes (see page 100).
2. Any administrative interfaces with other systems (for example: the
ISAAC queue or interface to the X.25 administration manager
(XAM), which maps X.25 request packets to HLR administration
commands) are redirected to the new live node. See your local
operating procedures for information about how to do this.
If the automatic cutover fails, manually cutover the HLR to activate the
standby node. See page 116.
Note: If the HLR fails to start successfully on the standby node, the
original live node attempts to become the live node again when it
recovers. If the HLR still fails to start correctly, see Software Start-up
Failure on page 88 for more information on how to diagnose the fault.

DBSYNC

The live and standby node have no shared disk. The database is
synchronized from live to standby on a regular basis. In most cutover
cases, the live node will send the last database updates to the standby
node before shutting down. In some failure cases (particularly failure of
the live database process), the standby node will go live without the
latest changes. In most cases this will be no more than one second of
data changes lost.

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

105

Automatic Restarts (Standby Nodes)


The HLR automatically restarts for any fatal reasons, such as an
internal software error or a process dying unexpectedly.
Note: A restart on the live node triggers an automatic cutover, causing
the sequence of events described on page 104.
The restart is handled by the pds_i_boot process, which performs
system housekeeping and restarts the HLR. Figure 40 on page 105
shows the sequence of events during an automatic restart (of a
standby node).
Figure 40. Sequence of Events during an Automatic Restart of a Standby Node
NODE A (Standby)

OMC Alarms

HLR processes start


to disappear

600 Process fail


(NODE A)

Time

No HLR processes
present except
pds_boot

Up to 15 minutes (to
allow any failed HLR
process to dump)

608 Node going live

All HLR standby


processes present

(NODE A)
30 secs

601 Startup complete


(NODE A)
Note: Alarm 601 does not
appear on the standby node

Home Location Register (Linux) V1.1 Support Guide

106

Chapter 6 Using Support Interfaces

Showing M3UA Association


Use this procedure to show the status of M3UA associations.
The procedure uses PULSE (see Appendix A, Using PULSE). You
navigate through the PULSE screens by selecting the letter
corresponding to the moption you require. In this procedure, x,y
means select the x option from the PULSE main menu, followed by the
y option.
The procedure differs according to whether the HLR is connected in a
peer-to-peer (IPSP) mode, or through a signalling gateway.
The meanings of the State columns in the displays are given in List of
possible States in IPSP mode and List of possible States in Signalling
Gateway mode.

Peer-to-Peer (IPSP) Mode


First check that the point code is accessible. Start PULSE and select
d,j:

If the point code is accessible, then it is possible for the HLR to signal
to the remote PC. This is not the same as having all SIGTRAN links
available.

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

107

To check if all SIGTRAN links are available for IPSP to IPSP


(peer-to-peer mode), start PULSE and navigate to the association
states by selecting d,g:

For signalling between the HLR and MSC, at least one connection
must have the connection state ESTABLISHED, and both the local and
remote ASP states must be ACTIVE. The point codes correspond to
the remote entity. In this case there are two connections to point code
108.
Check the IPSP M3UA statistics by selecting f,a:

Home Location Register (Linux) V1.1 Support Guide

108

Chapter 6 Using Support Interfaces

Choose the letter of the PC you wish to view. A normal Ericsson MSC
should have two ASPs with one connection to each:

Option a shows the first M3UA connection. The connections state


mirrors that shown on the Connections PULSE screen, and should be
ESTABLISHED. The Last reset shows the time and date the
connection was created. No PDUs sent/recd and No Bytes
sent/recd should be seen to increase every 5 seconds if signalling is
being exchanged on this connection. Note that, in overload conditions,
the frequency of statistics gathering decreases in order to free CPU for
the application.

List of possible
States in IPSP
mode

Table 9. Point Code States


ACCESSIBLE

Point Code is accessible

CONGESTED

Point Code is accessible but congested

INACCESSIBLE

Point Code is not accessible

Table 10. Lcl ASP States


DOWN

Local ASP down

INACTIVE

Local ASP inactive

ACTIVE

Local ASP active

PENDING

Local ASP pending

INSUF RES AC

Insufficient resource

INVALID

Internal software error

ALT ASP ACTIVE

Alternative ASP active

FAILURE

Local ASP failed

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

109

Table 11. Connection States


DOWN

Connection down

BEING ESTABLISH

Connection being established

ESTABLISHED

Connection established

CONG LEVEL 1

Connection in congestion, level 1

CONG LEVEL 2

Connection in congestion, level 2

CONG LEVEL 3

Connection in congestion, level 3

RESTARTED

Connection restarted at remote end

INV STATE

Internal software error. Requires


platform restart. Escalate to Second
Line Support.

Table 12. State UPD Types


API IND

Last activity was a management API

INVALID

Connection down

STATS REQ

Last activity was a statistics request

integer

These values are incremented by


SIGTRAN events

Table 13. Rem ASP States

ASP DELETED

ASP deleted (not configured)

ADD REM ASP REQ

Add remote ASP requested

REM ASP CREATED

Remote ASP created

REM AS CREATED

Remote AS created

WAIT FOR ADD TO AS

Waiting for add ASP to AS response


from stack

ADD ASP TO AS REQ

Add ASP to AS requested

SET EXCHG MODE REQ

Set exchange mode requested

CONF OPTIONAL PARAM REQ

Configure optional parameters


requested

ADD RC TO AS REQ

Add routing context to local AS


requested

CONNECT REQUESTED

Connect requested to remote ASP

WAIT FOR CONNECT

Waiting for connection up

ASP UP REQUESTED

Send ASPUP requested

ASP UP SENT

ASPUP sent

Home Location Register (Linux) V1.1 Support Guide

110

Chapter 6 Using Support Interfaces

Table 13. Rem ASP States


WAIT FOR REG

Wait for application registration

WAIT FOR REG IN ASPIA

Wait for application registration in


ASPIA state

ASPDN REC

ASPDN received

ASPAC REQUESTED

Send ASPAC requested

WAIT ASPAC ERROR


WAIT ASPUP

Wait for ASPAC to be received

ASPAC SENT

ASPAC sent

ASP ACTIVE

Remote ASP active

ASPIA REC

ASPIA received

ASPIA REQUESTED

Send ASPIA requested

ASPIA SENT

ASPIA sent

DOWN REQUESTED

Send Connection Down requested

DOWN SENT

Connection Down sent

DISC REQUESTED

Send Disconnect requested

DISC SENT

Disconnect sent

WAIT CFG AS RESP

Wait for configure AS response

RMV ASP FROM AS REQ

Remove remote ASP from remote AS


request

DEL REM ASP REQ

Delet remote ASP requested

WAIT DELETE ERR

Internal software error. Requires


platform restart. Escalate to Second
Line Support.

WAIT FOR ASPIA ERR


WAIT ASPUP ERROR1
WAIT ASPUP ERROR2
WAIT FOR CONN ERR

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

111

Signalling Gateway Mode


Start PULSE and navigate to the association states ASP - SG by
selecting d,i:

The signalling gateway ID matches the IDs given in the hsscfg file.
There must be at least one connection to a signalling gateway in order
to allow any PCs defined on that gateway to work.
View M3UA statistics via the signalling gateway by selecting d,h:

Home Location Register (Linux) V1.1 Support Guide

112

Chapter 6 Using Support Interfaces

Select the page of interest, for example, a:

Further screenshot tbs when signalling gateways are working???


Check with Will.

List of possible
States in
Signalling
Gateway mode

In addition to the following table, Table 9, Table 10, Table 11 and


Table 12 also apply to Signalling Gateway mode.
Table 14. Rem SGP States
DEL REM SGP REQ

Selete remote SGP request

SGP DELETED

Remote SGP deleted

ADD REM SGP REQ

Add remote SGP request

REM SGP CREATED

Remote SGP created

REM SG CREATED

Remote SG created

WAIT FOR ADD TO SG

Waiting for ADD remote SGP to remote


SG response

ADD SGP TO SG REQ

Add remote SGP to remote SG request

CONF OPTIONAL PARAM REQ

Configure optional parameters request

ADD RC TO AS REQ

Add routing context to local AS request

CONNECT REQUESTED

Send Connect requested

WAIT FOR CONNECT

Waiting for connect

ASP UP REQUESTED

Send ASPUP requested

ASP UP SENT

ASPUP sent

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

113

Table 14. Rem SGP States


WAIT FOR REG

Wait for application registration

ASPAC REQUESTED

Send ASPAC requested

ASPDN REC

ASPDN received

ASPAC SENT

ASPAC sent

ASP ACTIVE

ASP active

ASPIA REQUESTED

Send ASPIA requested

ASPIA SENT

ASPIA sent

ASP DOWN REQUESTED

Send ASPDN requested

ASP DOWN SENT

ASPDN sent

DISCONNECT REQUESTED

Send Disconnect requested

DISCONNECT SENT

Disconnect sent

WAIT FOR CFG SG RESP

Waiting for Configure SG response

RMV SGP FROM SG REQ

Send Remove remote SGP from


remote SG request

WAIT FOR CONNECT ERROR

Internal software error. Requires


platform restart. Escalate to Second
Line Support.

WAIT FOR L_ASPUP ERROR


WAIT FOR L_ASPAC ERROR

Home Location Register (Linux) V1.1 Support Guide

114

Chapter 6 Using Support Interfaces

Controlling the HLR


Use the following procedures to control the HLR.
Restarting the HLR Application. Restart the HLR processes that
make up the application. See page 115.
Cutting-over the HLR. Cutover the HLR from the live to the standby
side. See page 116.
pds_manager account users can also use the following procedures:
Stopping the HLR Application. Stop the HLR processes. See
page 117.
Restoring the HLR Database. Recover the database from a backup.
See page 118.

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

115

Restarting the HLR Application


Restart the HLR application if any required HLR processes are not
running (see Table 8 on page 103). The restart:
1. Stops any PDS processes currently running.
2. Starts the alarm server and MGTA process. The MGTA
process then starts all the other pds_i_xxx processes listed in
Table 8 on page 103.

Availability
Use this procedure on any node. Restarting the HLR application on the
live node causes an automatic cutover (see page 104).

Procedure
Remote Engineer Click 5HVWDUW3'6
pds_manager

Enter the command:


pds start

Results
When the restart is complete, Alarm 2601: Node Out of Live Service
CEASE should be displayed, and the correct PDS processes should be
running. Check this using Showing HLR Processes on page 100.
If the  6WDUWXSFRPSOHWHalarm is displayed, there must subsequently be
a /RJLFDOGDWDEDVHQDPHFKDQJLQJVWDWHWR$&7,9( alarm, to indicate at
least one logical database has started successfully. If the alarm is not
displayed, there may not be any databases defined in the PDS_DEFS
table. If the alarm indicates a state change to INACTIVE, the database
has not started successfully.

what are the equivalent Linux alarms in above para??

Home Location Register (Linux) V1.1 Support Guide

116

Chapter 6 Using Support Interfaces

Cutting-over the HLR


Cutover the HLR from the live node to the standby node:
if an automatic cutover (see page 105) has failed.
as required. For example as part of a software upgrade procedure,
or if restoring the database from a backup copy.

Availability
Use this procedure on the live node.
Note: Check that the HLR on the standby node is working properly
(see page 100 and page 106) before you attempt to cutover to it.

Procedure
Remote Engineer Click5HVWDUW3'6
pds_manager

1. Enter the command:


pds start

Results
The cutover should start the sequence of events shown in Figure 40 on
page 105. After a cutover:
1. Check that the appropriate processes are running on both the live
and standby nodes. See Showing HLR Processes on page 100.
2. Ensure that any administrative interfaces to or from other systems
(for example: the ISAAC queue or interface to the X.25
administration manager (XAM), which maps X.25 request packets to
HLR administration commands) are redirected to the new live node.
See your local operating procedures.
3. If the 601 Startup complete alarm is displayed, there must
subsequently be a 2425 Logical database name changing state to
ACTIVE alarm, to indicate at least one logical database has started
successfully. If the alarm is not displayed, there may not be any
databases defined in the PDS_DEFS table. If the alarm indicates a
state change to INACTIVE, the database has not started
successfully.
Note: If the HLR fails to start successfully on the standby node, the
original live node attempts to become the live node again when it
recovers. If the HLR still fails to start correctly, see Software Start-up
Failure on page 88 for more information on how to diagnose the fault.

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

117

Stopping the HLR Application


You should stop the HLR application if there are severe system
problems. This procedure stops the HLR application on a node without
immediately restarting it.

Availability
Use this procedure on any node. Stopping the HLR on the live node
triggers an automatic cutover if the standby node is running correctly,
(see page 104).

Procedure
Remote Engineer You cannot stop the HLR processes from the Remote Engineer web
page.
If you want to restart the HLR application, use the procedure described
on page 115.
If you want to stop the HLR application without restarting it, escalate
the problem to second-line support.

pds_manager

1. Enter the commands:


pds stop

Results
All HLR processes on the node will stop. Check this using Showing
HLR Processes on page 100: the MGTA process and all its children
should not be listed, although the pds_boot, pds_i_boot, and some
other processes may still be shown.

Home Location Register (Linux) V1.1 Support Guide

118

Chapter 6 Using Support Interfaces

Restoring the HLR Database


This procedure restores the HLR database from the most recent
backup copy. If no backup copy exists, or if the backup copies are also
corrupted, a previous version of the database must be restored, either
from the register_backup_dir directory, or from external backups.
See Appendix D, Backing-up the HLR Database for more information.
Note: Any changes made to HLR subscriber data since the backup
copy was created are lost when the database is restored:
Changes made because of network activity (such as subscriber
controlled supplementary services), are permanently lost.
The administration centre (the ISAAC system in Vodafone UK)
must be informed, so that they can regenerate any changes
since the database was backed up.

Availability
Use this procedure on the live and the standby node.

Procedure
Remote Engineer You cannot restore the HLR database from the Remote Engineer
account.
If the HLR database needs to be restored, escalate the problem to
second-line support.

pds_manager

1. On the standby node, enter the command:


pds stop
2. Repeat this command on the live node.
Any HLR processes currently running will now be stopped.
3. Set your default directory to /opt/vodafone/pds/data using
the command:
cd /opt/vodafone/pds/data
4. Determine which is the most recent valid backup copy of the
database by looking at the name of the backup indicator file
logical_db_name_GOODBACKUPIS.BKn in the /opt/
vodafone/pds/data directory. See Table 57 on page 587.
5. Rename the existing database using the command:
mv LOG1_HLRD_FILE LOG1_HLRD_FILE.REPLACED

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

119

6. Copy the most recent backup of the database to the disk image
using the command:
mv backup_file LOG1_HLRD_FILE
backup_file is either LOG1_HLRD_SAVED.BK1 or
LOG1_HLRD_SAVED.BK2.
Note: If the disk has insufficient free space for the database file, delete
the corrupt database REPLACED_HLRD_FILE and then copy the most
recent backup to disk.
7. Use pds start to start the live node.
When restart on the live node is complete, a 2601: Node Out of Live
Service CEASEalarm appears.
8. Use pds start to start the standby node.
9. Check that the correct PDS processes are running. (See Showing
HLR Processes on page 100.)
If the alarm is not displayed or the right processes do not appear, the
application has failed to start correctly. See Software Start-up
Failure on page 88 for more information on how to diagnose the
fault.
10.Check (using PULSE) that the database is served on the live node,
and slaved on the slave node.
If the standby node fails to slave, stop the node, delete/rename its
database file and all backups, and restart the standby node. It will
create a new copy of the database file and new backups.
11.Tell the ADC that the database has been restored, so that they can
regenerate any changes made to HLR subscriber data since the
backup copy was created.

Results
The HLR database has been restored and no further corruption alarms
should appear.

Home Location Register (Linux) V1.1 Support Guide

120

Chapter 6 Using Support Interfaces

Checking and Managing the HLR


Use the following procedures to check and manage the HLR from the
Remote Engineer account.
Checking for the Live Node. Check whether a node is the live or
standby node. See page 121.
The following procedures access the Remote Engineer Utility,
providing HLR status and performance information.
- Displaying System Status Graphs on page 122
- Showing HLR Processes on page 100
Displaying Hardware/Software Versions. Check the software on the
HLR. See page 125.
Showing Install History. Check a log of software installation. See
page 126.
Displaying an Availability Report. View a log of platform down time
and reasons for outages. See page 127.
Setting the System Date and Time. Set the local time on the HLR.
See page 129.
Viewing Service Request Numbers. View the SRN and SAN
information. See page 130.
Viewing HLR Tables. View the contents of the HLRs tables. See
page 131.

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

121

Checking for the Live Node


A text file called pds_l_live in the pds/state directory indicates the live
state as TRUE or FALSE.

Availability
Use this procedure on either node.

Procedure
Remote Engineer The banner displayed above the Remote Engineer main menu
indicates whether the current node is live or standby.

pds_manager

Enter:
cat /opt/vodafone/pds/state/pds_l_live

Results
The value stored in pds/state/pds_1_live is one of the following:
TRUE this is the live node.
FALSE this is the standby node.

Home Location Register (Linux) V1.1 Support Guide

122

Chapter 6 Using Support Interfaces

Displaying System Status Graphs


You can display system statistics in graphical form. These are updated
in real-time and allow you to check the system performance.

Availability
Use this procedure on any node.

Procedure
Remote Engineer Click 1RGH6WDWLVWLFV

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

123

Results
A set of graphs is displayed, as listed below. Click GD\, ZHHN, PRQWK,
or \HDU to determine the time period over which the data is gathered.
&388WLOL]DWLRQ shows system loading in terms of CPU usage. If this is
consistently 75% or more, the node is reaching its processing
capacity and the system may need reconfiguring. Alternatively, a
process may be stuck in a loop.

1HWZRUN,2(kbytes/sec) shows the utilization of all network


connections (SIGTRAN, admin, and O&M).

%ORFN'HYLFH,2is the utilization of disk I/O.

0HPRU\$OORFDWLRQis the total memory available, and current memory

Home Location Register (Linux) V1.1 Support Guide

124

Chapter 6 Using Support Interfaces

usage.

'LVN8WLOL]DWLRQis the total disk space available, and current disk


usage.

6XEVFULEHUV
6XEVFULEHUVZLWK)DLOXUHV
&DOOV5HSOLFDWLRQV
7UDQVDFWLRQV
/RFDWLRQ8SGDWHV6XEVFULEHU,QVHUWV
$XWKHQWLFDWLRQ06515HTXHVWV
6065RXWLQJ'HOLYHU\5HSRUWV

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

125

Displaying Hardware/Software Versions


This displays details of the hardware platform and the operating system
software on the node.

Availability
Use this procedure on any node.

Procedure
Remote Engineer Click +DUGZDUH6RIWZDUH9HUVLRQV

Results
Details of the hardware (including BIOS and PCI devices) are shown,
together with details of the operating system.

Home Location Register (Linux) V1.1 Support Guide

126

Chapter 6 Using Support Interfaces

Showing Install History


This displays a log of software installed on the platform.

Procedure
Remote Engineer Click ,QVWDOO+LVWRU\

Results
The software installation log file is displayed.

The right-hand half of the software installation log lists the names of
installed software packages.
The left-hand half of the log file comprises the installation date.

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

127

Displaying an Availability Report


For each month in the year, the availability report lists the amount of
time the platform was serving the network.
Note: The availability report does not necessarily show service
availability because a disaster recovery platform might be covering for
a failed or shutdown platform.

Availability
The availability report relates to the individual node. The report is
produced by the pds_i_mgta process.

Procedure
Remote Engineer Click $YDLODELOLW\5HSRUWV
pds_manager

The availability report is in the directory /opt/vodafone/pds/log.


To view the availability report, enter:
cd /opt/vodafone/pds/log
less availability_yyyy.dat
where yyyy is a year (2006 or later).

Results
For each month in the year, the availability report lists the total number
of seconds in the month, followed by the number of seconds of uptime
and downtime. Uptime and downtime are also shown as a percentage
of the total time in the month.

List of Outages

The summary of uptime and downtime are followed by a list of all


outages which caused the downtime, the length of the downtime in
seconds and the reason for the outage.

Scheduled and
Unscheduled
Outages

Downtime is subdivided into scheduled and unscheduled outages, to


indicate how much network service time is lost because of platform
problems.
If the platform is stopped by support staff using pds stop or any other
support command, the downtime is classed as scheduled.
An example availability report is shown in Figure 41 on page 128.

Home Location Register (Linux) V1.1 Support Guide

128

Chapter 6 Using Support Interfaces

Figure 41. Example Availability Report

Entries in brackets are text typed in when


the pds stop command prompts for a
reason why the command is being used.

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

129

Setting the System Date and Time


The HLR uses Network Time Protocol (NTP) software to synchronise
its system time to a reference source providing co-ordinated universal
time (UTC).
You need to set the system time when configuring a new HLR or when
the local time changes.
For more on system times and how to set them, see Appendix C, Time
Synchronization.

Availability
Use this procedure only on the standby nodes.

Home Location Register (Linux) V1.1 Support Guide

130

Chapter 6 Using Support Interfaces

Viewing Service Request Numbers


This procedure describes viewing the HLRs Service Request Numbers
(SRNs) and Service Access Numbers (SANs).
The HLR keeps a list of Service Request Numbers (SRNs) and their
corresponding Service Access Numbers (SANs). These are used for
services such as directory enquiries and information numbers and also
for numbers exported to another network (see Mobile Number
Portability (MNP) on page 40). SRNs are allocated by the HLR. When
the HLR receives a Send Routing Information request for a SRN, it
returns the SAN in place of the roaming number. For more information
on SRNs, see Service Request Number Commands on page 289.

??changes needed for logical databases???

Availability
Use this procedure only on a live node.

Procedure
Remote Engineer Click 6\VWHP8WLOLWLHV /LYH%(3RQO\ > 6HUYLFH1XPEHU 0/5RQO\ 
The service request numbers and corresponding service access
number are displayed. Figure 42 shows an example.
Figure 42. Service Request Number View Example
GSM HLRDatabase SRN Dump:V0400 Node:SLIGO2
SRN
447785123456
447785123457
447785123455
23451234567890
12345678
123456789012
1234567890123
12345678901234

10-MAR-2004 10:47

SAN
447785123456
447785123457
447785123455
23451234567895
12345678901
12345678901
12345678901
12345678901

Press <Return> to continue

Note: Since mobile number portability (MNP) uses an SRN for every
subscriber exported to another network, the output from this command
might be a very long list.

pds_manager

Enter the following commands:


cd /opt/vodafone/pds
./libexec/hlru_srnview logical_db_name

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

131

Viewing HLR Tables


Use this option to list the tables present on the HLR and display their
contents. For full details of HLR tables see Chapter 24, Table
Maintenance.

Procedure
Remote Engineer Click 7DEOH9LHZ

Results
The Table View is displayed, an example is shown in Figure 43.
Figure 43. Table View Menu
HLR on AHLR01
THIS IS THE LIVE NODE
Table View Menu

(Currently selected table is ASCVT)

FACILITY

OPTION

View Table.........................................1
Display status of Table............................2
Change table viewed................................3
Return to previous menu............................4
Choose Option :
Currently available tables are:
ASCVT
BNUM
USSD
BCA
IO_CONVERT MSRNPFX

CNUM
HLR_CONFIG
TKEY

MKEY
PDS_CONFIG
NETENT
SP
CNUM_BHVR SS7CFG

Note: of For the TKEY and MKEY tables, The 7DEOH9LHZoption only
displays the first field in the specified table.
Use the drop-down menu to select the table you want to view, and click
6KRZ.

pds_manager

Enter the following commands:


cd /opt/vodafone/pds
./libexec/hlru_tableview -table=tablename
logical_db_name

Home Location Register (Linux) V1.1 Support Guide

132

Home Location Register (Linux) V1.1 Support Guide

Chapter 6 Using Support Interfaces

133

Chapter 7

Alarms
This chapter describes the HLR alarms. It contains:
A description of the HLR alarm classes (see page 135).
Details of every A1 and A2 HLR alarm (see page 138).

Home Location Register (Linux) V1.1 Support Guide

134

Chapter 7 Alarms

Alarm Distribution
The alarm architecture is shown in Figure 44. The syslogd process
reads alarms generated by the PDS applications, and writes them to
the alarm clients. Alarms can be distributed to:
a file. All alarms are written, in text format, to /var/log/pds/
pds_alarms. This file is rotated daily: old files are renamed /var/
log/pds/pds_alarms.n, where n is a number indicating how old
the file is (in days).
The rotation is controlled by the logrotate utility, configured in
/etc/logrotate.d/syslog.
the SNMP alarm client. Alarms read by this client are filtered to
exclude Minor (A3) alarms. This client is mainly for First Line
Support staff. See SNMP Agent for more information on SNMP.
A TCP/IP client such as TeMIP.
PDS processes and alarm clients and servers are arranged as shown
in Figure 44 below.
How alarms are distributed is configured when the HLR software is
installed or upgraded, and cannot then be changed by the network
operator. Alarm distribution is not limited to one route; a system can be
configured to use any combination of the distribution options.
Figure 44. Alarm Distribution
PDS processes

Alarm Server
Process

syslogd

TCP/IP socket server


for TeMIP

File

Home Location Register (Linux) V1.1 Support Guide

SNMP

Chapter 7 Alarms

135

Alarm Classes
HLRA and HLRD alarms are classified as either A1, A2 or A3.

A1 - Critical Alarm
A critical alarm indicates an HLR component failure which may prevent
the HLR from providing any service to the network.
Critical alarms require immediate attention to rectify the fault.

A2 - Major Alarm
A major alarm indicates an HLR component failure which may disrupt
the HLRs service to the network.

A3 - Minor Alarm
A minor alarm indicates either:
an HLR component failure, which is unlikely to cause any disruption
of the HLRs service to the network.
an information message.

Home Location Register (Linux) V1.1 Support Guide

136

Chapter 7 Alarms

Alarm Types
There are four alarm types:
Event alarms
Event alarms signal an event, such as a failed signal. These are fire
and forget alarms.
Condition alarms
These alarms indicate a condition, and can be raised or ceased,
indicating a change of state. An example of a condition alarm is a
signal overload: this would be raised when the platform could no
longer queue new transactions, and would be ceased once the
resource to queue new transactions was restored.
Instance alarms
These alarms are similar to condition alarms, but there may be a
number of instances of the same condition. For example, a failed
SIGTRAN Association is an instance alarm: there would be one
instance for each SIGTRAN Association that is configured.
Summary alarms
These alarms encapsulate several instances of a condition in a
single condition, and is intended to be used by First Line Support
staff only.
Each instance of the summary alarm has a corresponding Minor
(A3) condition alarm, but the summary alarm is only triggered when
a predefined number of the individual alarms are triggered.
An example summary alarm is Database Resource Exhausted.
Each database pool corresponds to an instance of the condition,
generating its own Minor condition alarm. On the first of these Minor
alarms, a Summary alarm is raised, and is only ceased when all
instances have ceased.

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

137

Viewing Alarms
You can view alarms by viewing one of the alarms files, or you can see
alarms as they are generated, in realtime.

Viewing alarms
in realtime

To view alarms as they are generated, issue the following command:

Viewing alarm
files

You can view alarms on the live node by viewing the file /var/log/
pds/pds_alarms, using any standard utility for viewing text files. For
example:

tail -f /var/log/pds/pds_alarms

less /var/log/pds/pds_alarms
To see historical alarms, replace the file name with /var/log/pds/
pds_alarms.n, where n is between 1 and 9, and lower values
indicate more recent alarms.

Example

Below is an extract from an example alarms file:

Alarm: 297 (Component: HLRA Event: 7 Severity: A3)


Time: 10-SEP-2001 13:16:48.62
Data: TC-U_Abort caused in UPDATE_LOCATIONISD,IMSI:234150000000000,MSISDN:44385100101,LA:4206,RA:GT(106)VLR.TT0.E164.+443
85000300
Alarm: 292 (Component: HLRA Event: 2 Severity: A3)
Time: 10-SEP-2001 13:21:05.58
Data: An Unsupported Service Failure caused by UPDATE_LOCATION(ISD
result),LA:GT()HLR.TT0.E164.+44385016199,RA:GT(106)VLR.TT0.E164.+44385000300,me
ssage:

Home Location Register (Linux) V1.1 Support Guide

138

Chapter 7 Alarms

Alarm Descriptions
This section lists all the A1 and A2 HLR alarms in ascending order by
alarm code.
For each alarm, the information in Table 15 is provided.
Table 15. Alarm Descriptions Format
Item

Description

Alarm Code

The identifying alarm number.

Alarm Text

Either:
the summary alarm text
the phrase Internal software diagnostic message, used to describe a group of similar
alarms without specifying the exact text of each.

Alarm Class

The alarm class. See page 135 for a definition of the HLR alarm classes.

Alarm Type

The type of alarm: see Alarm Types.

Full Text

The full text of the alarm.

Description

A description of what the alarm means, its possible causes, and its effects.

Response

Information on how to identify and rectify the problem. Where appropriate, response
information is provided separately for:
First line support staff who access the HLR using the Remote Engineer account.
Second line support staff: who access the HLR using the pds_manager account.

2236

AUTH_SEQUENCE_NUM_CHANGED

Class:
Type:
Full text:
Description:

A2
Event
Authentication sequence number manually changed
The 3G authentication sequence number has been manually changed.
This may have been done for legitimate reasons if a sequence number
had become desynchronised with that on a subscribers handset.
This is alarmed as there may have been a security breach.
There is no service loss.

Response:

First Line Support:


Report to Second Line Support.
Second Line Support:
If the Authentication Sequence number has been changed manually for
good reason then ignore this message. If the manual change is not
accounted for, report to the appropriate security department.

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

2305

139

AUTH_SEED_CHANGED

Class:
Type:
Full text:
Description:

A2
Event
Authentication seed changed
The authentication seed for generating random numbers (as part of
authentication triplets) has been manually changed. This may have
been done for legitimate reasons.
This is alarmed as there may have been a security breach.
There is no service loss.

Response:

First Line Support:


Report to Second Line Support.
Second Line Support:
If the Authentication Seed has been changed or reset for good reason
then ignore this message. If the manual change is not accounted for,
report to the appropriate security department.

2306

SKE_LOGGING_ON

Class:
Type:
Full text:
Description:

A2
Condition
SKE Logging on
Logging of Subscriber Key Encryption is on. This may present a
security risk. This is caused by configuration at node-start time. The
node must be restarted for any configuration changes to take effect.
This does not correspond to any service loss.

Response:

First Line Support:


Check logging is required. If not, it will need to be disabled and the
platform cutover during low traffic hours. Report to Second Line
Support.
Second Line Support:
If SKE Logging is not required, this should be turned off to prevent a
security risk. This would require a reconfiguration and restart at the
next convinient point. Report to Third Line Support.

Home Location Register (Linux) V1.1 Support Guide

140

Chapter 7 Alarms

2326

ADMIN_TASKS_EXHAUSTED

Class:
Type:
Full text:
Description:

A1
Condition
Administration tasks exhausted
There are a no free administration tasks available. There is an
imminent risk that the platform will subsequently become overloaded
by Provisioning Traffic.
This may be caused by a performance degradation of the application or
live database server, a platform resource problem, a hardware fault or
an abnormally high loading of provisioning traffic.
There is a loss of provisioning capabilities. This corresponds to a major
service loss.

Response:

First Line Support:


Escalate to Second Line Support.
Second Line Support:
Check level of Admin overloading by navigating PULSE as follows:
Details, ADMA, Seizer and checking the number of tasks in use.
Also check the number/rate of Admin commands received from each
client as follows: Details, ADMP. Prepare to disconnect any Admin
users with abnormally high numbers of commands, if appropriate.
If problem persists, escalate to Third Line Support.

2327

ADMIN_TASKS_LOW

Class:
Type:
Full text:
Description:

A2
Condition
Administration tasks low
There are a low number of free administration tasks available. There is
considerable risk that all administration tasks will be exhausted and
subsequently overloaded by Provisioning Traffic.
This may be caused by a performance degradation of the application or
live database server, a platform resource problem, a hardware fault or
an abnormally high loading of provisioning traffic.
There is no service loss though there is an imminent risk of loss of
provisioning capabilities. This would correspond to a major service
loss.

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

Response:

141

First Line Support:


Report to Second Line Support.
Second Line Support:
Check level of Admin overloading by navigating PULSE as follows:
Details, ADMA, Seizer and checking the number of tasks in use.
Also check the number/rate of Admin commands received from each
client as follows: Details, ADMP. Prepare to disconnect any Admin
users with abnormally high numbers of commands, if appropriate.
If problem persists, report to Third Line Support.

2350

LIVE_DATABASE_RESOURCE_EXHAUSTED

Class:
Type:
Full text:
Description:

A1
Summary
Live database resource exhausted
The live database has no remaining capacity. Further updates will be
disabled. (Updates may result from signals traffic or subscriber
provisioning. The latter is more likely to fill capacity, particularly if new
subscribers are created.)
This is a major service loss. It will be impossible to add further
subscribers and it is likely that subscriber data will not be able to be
updated. Signals may also be affected.

Response:

First Line Support:


Escalate to Second Line Support. Do not allow any SDM to this
platform.
Second Line Support:
Execute an SDM as a matter of urgency to move subscriber data from
this HLR to an HLR that has sufficient capacity. Check database
capacity on the SDM destination using the database utility, DBVIEW.

2351

DATABASE_SERVER_TASKS_EXHAUSTED

Class:
Type:
Full text:
Description:

A1
Condition
Live database server tasks exhausted
The live database server is overloaded with tasks, and can process no
new tasks.

Home Location Register (Linux) V1.1 Support Guide

142

Chapter 7 Alarms

There is serious service degradation that may soon lead to critical


service loss.
First Line Support:
Escalate to Second Line Support.
Second Line Support:

Response:

Check Platform loading by analysing HLRA tasks, Signals load and


Admin load using PULSE: Navigate to Details, HLRA, HLRA Control,
View Tasks to check HLRA tasks; Details, SS7I, Throttle Control to
check the Signals Loading; Details, ADMA, Seizer to check the
Admin loading.
Also check system on the command line. Check for any locked
subscribers using the database utility, Sublocks. Escalate to Third Line
Support.

2352

DATABASE_SERVER_TASKS_LOW

Class:
Type:
Full text:
Description:

A2
Condition
Live database server tasks low
The live database server is nearly overloaded with tasks. There is
considerable risk that the database may become overloaded and
unable to cope with any new tasks.
There is no service loss, although there is a considerable risk of serious
service degradation and subsequent service loss.

Response:

First Line Support:


Escalate to Second Line Support.
Second Line Support:
Check Platform loading by analysing HLRA tasks, Signals load and
Admin load using PULSE: Navigate to Details, HLRA, HLRA Control,
View Tasks to check HLRA tasks; Details, SS7I, Throttle Control to
check the Signals Loading; Details, ADMA, Seizer to check the
Admin loading.
Also check system on the command line. Check for any locked
subscribers using the database utility, Sublocks. If the problem
persists, escalate to Third Line Support.

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

2353

143

LIVE_DATABASE_ RESOURCE_LOW

Class:
Type:
Full text:
Description:

A2
Summary
Live database resource low
The live database is low on capacity. There is a high risk that further
updates to the database will render it full. (Updates may result from
signals traffic or subscriber provisioning. The latter is more likely to fill
capacity, particularly if new subscribers are created.)
There is no loss of service, although a risk to major service loss is high.

Response:

First Line Support:


Report to Second Line Support. Do not allow any SDM to this platform.
Second Line Support:
Do not allow any SDM to this platform. Stop any SDM that may be in
progress. Check database capacity on the SDM destination using
DBVIEW. Prepare to redistribute subscribers from this node using
SDM.

2354

LIVE_DATABASE_NOT_SECURED

Class:
Type:
Full text:
Description:

Response:

A2
Condition
Secured Live Database is out of date
The Live Database has not been secured recently. This means that the
database copy on disk may be out of date, and should be considered a
risk of service degradation.
First Line Support:
Escalate to Second Line Support.
Second Line Support:
Monitor the rate at which secures are made, and when the last secure
was made. Do this by navigating PULSE as follows: Details, HLRD,
DB Secure (use option 8 to navigate between required pages). This
will also indicate how long secures are taking. Check disk performance
and performance of HLRD process. If problem persists, escalate to
Third Line Support.

Home Location Register (Linux) V1.1 Support Guide

144

Chapter 7 Alarms

2357

BACKUP_DATABASE_CORRUPT

Class:
Type:
Full text:
Description:

A1
Condition
Backup database corrupt
The backup database is corrupt, indicating that the live database is
also likely to be corrupt. This will have an unpredictable effect on the
function of the platform.
This should be considered a critical loss of service.

Response:

First Line Support:


Escalate to Second Line Support.
Second Line Support:
Prepare to resort to the last good backup database at the nearest
opportunity. The last good backup will be slightly out-of-date and so
ISAAC commands may need to be replayed from the time at which it
was created. Escalate to Third Line Support.

2371

LIVE_DATABASE_NOT_BACKED_UP

Class:
Type:
Full text:
Description:

Response:

A2
Condition
Secured Live Database Backup is out of date
The backup of the live database has not been recently secured to disk.
This means that if the live database file is lost, the backup file may not
accurately represent an up-to-date picture of subscription data. This
should be considered a minor risk to service degradation.
First Line Support:
Escalate to Second Line Support.
Second Line Support:
Monitor the rate at which backups are made, and when the last backup
was made. Do this by navigating PULSE as follows: Details, HLRD,
DB Secure (use option 8 to navigate between required pages). This
will also indicate how long secures are taking. Check disk performance
and performance of HLRD process. If problem persists, escalate to
Third Line Support.

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

2397

145

Invalid database ID

Class:

A1

Type

please supply alarm types for alarms 2397-2426


Full Text:

Invalid database id: this node: Logical_Db/Db_Version/


Db_init_time, server Physical_HLR: Logical_Db/Db_Version/
Db_init_time

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

An attempt was made to synchronize two databases (master and


slave) which have different database IDs.This is detected at the slave
having received the database id from the active database.

Response:

First-line support:
Report the alarm to second-line support.
Second-line support:
Check configuration. Report to third-line support.

2398
Class:
Full Text:

Invalid sequence number


A1
Invalid database sequence number Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

An active database is loaded with a sequence number of zero.


It is tantamount to an internal software error.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Escalate to the alarm to third-line support.

2399
Class:
Full Text:

Invalid database loaded


A1
Invalid database loaded

Home Location Register (Linux) V1.1 Support Guide

146

Chapter 7 Alarms

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

An attempt was made to load a corrupt database.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2400
Class:
Full Text:

Database load failed


A1
Database load failed Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

The load operation for a database failed for any reason.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2401
Class:
Full Text:

Logical database name file error


A1
Logical database name file error

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

The attempt to write to the log_db_name.NAME file in the


PDS_L_SHRDIR directory failed.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2402
Class:
Full Text:

Database server failed


A1
Database server failed Logical_Db

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

147

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

An attempt to create a database server (for the interface with database


utilities) failed.
It is tantamount to an internal software error.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Escalate the alarm to third-line support.

2403
Class:
Full Text:

Database frozen - operation discarded


A1
Database frozen - operation discarded Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

A database operation was attempted when the database was frozen on


account of control being switched from it (active to slave) to another
database being promoted (slave to active).
It is tantamount to an internal software error.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Escalate the alarm to third-line support.

2404
Class:
Full Text:

Invalid journal
A1
Invalid journal Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

A journal was received where the sequence number has not


incremented correctly, or where the database ID is invalid.
It is tantamount to an internal software error.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:

Home Location Register (Linux) V1.1 Support Guide

148

Chapter 7 Alarms

Escalate the alarm to third-line support.

2405
Class:
Full Text:

Corrupt journal
A1
Corrupt journal Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

A journal was received containing invalid size information.


It is tantamount to an internal software error.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Escalate the alarm to third-line support.

2406
Class:
Full Text:

Change to server despite incomplete


transaction
A1
Change to server despite incomplete transaction Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

The communications failed when a database was being handed over


from an active database to a slave which is synchronizing off it.In spite
of this alarm being raised, the slave will take over as an active
database.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2407
Class:
Full Text:

No database agent task available


A1
No database agent task available

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

149

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

Insufficient database agent tasks were available to allow a logical


server database to communicate with the required slaves, as specified
in the PDS_DEFS table.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2408
Class:
Full Text:

Number of used database agents has


exceeded its threshold
A1
The number of used database agents has exceeded its
threshold

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

The number of database agent tasks in use for a logical database


exceeded the upper threshold defined in the node configuration file.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2409
Class:
Full Text:

Number of used database agents has


returned within its lower threshold
A1
The number of used database agents has returned within its
lower threshold

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

The number of database agent tasks in use for a logical database


returned within the lower threshold defined in the node configuration
file, having previously exceeded the upper threshold.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:

Home Location Register (Linux) V1.1 Support Guide

150

Chapter 7 Alarms

Determine the problem, and escalate to third-line support if necessary.

2410
Class:
Full Text:

An invalid database agent index has been


received
A1
An invalid database agent index has been received

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

There was an error in the database agent seizer such that an invalid
database agent task index was received.
It is tantamount to an internal software error.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Escalate the alarm to third-line support.

2411
Class:
Full Text:

Database sync request from invalid slave


A1
Database sync request from invalid slave Logical_Db
slave_physical_name

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

A database sync request was received by an active database from a


slave which is not listed in its PDS_DEFS table as a valid slave for this
server.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2412
Class:
Full Text:

Unknown service
A1
Unknown service Logical_Db

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

151

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

A slave database was not able to locate a physical machine running


the same logical database as a server.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2413
Class:
Full Text:

Database manager timeout


A1
Database manager timeout Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

The database manager task for a slave database timeed out when
communicating with an active database.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.
When the problem is resolved, ensure that DB synchronization has
been re-established, by checking the relevant PULSE counters. This is
particularly important in the live-standby case, to ensure the standby is
synchronized.

2414
Class:
Full Text:

Server signal discarded in slave mode


A1
Server signal discarded since not in server state, trigger =
trigger_name, received by routine routine_name

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

A database operation was attempted when the database is running as


a slave.
It is tantamount to an internal software error.

Response:

First-line support:
Escalate the alarm to second-line support.

Home Location Register (Linux) V1.1 Support Guide

152

Chapter 7 Alarms

Second-line support:
Escalate the alarm to third-line support.

2415
Class:
Full Text:

Database sync request for invalid logical


database
A1
Database sync request for invalid logical database
updating_Db_name Agent_Logical_Db_name
Physical_node_name

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

An attempt was made to initiate DB sync by a slave to a server where


the logical database names differ. It is raised by the active database
having received a sync request for a logical database with the wrong
name.
It is tantamount to an internal software error.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Escalate the alarm to third-line support.

2416
Class:
Full Text:

Cannot page update


A1
Cannot page update Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

An attempt was made to carry out page updating, but no map had yet
been secured; this is a problem since page updating uses the last
secured map to carry out synchronization.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

2417
Class:
Full Text:

153

Page update fail


A1
Page update fail Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

Page updating failed because the secured map being used was
overwritten during the page updating process, or an invalid page
number was identified during the request map processing.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2418
Class:
Full Text:

Uninitialised database
A1
Uninitialised database Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

An attempt was made to synchronize a database to a slave which


already has a database file in PDS_L_SHRDIR, but which is
uninitialized (for example, it was created during a previous sync, but
page updating did not complete).

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2419
Class:
Full Text:

Database agent comms failure


A1
Database agent comms failure Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

The database manager task for an active database timed out when
communicating with a slave database.

Home Location Register (Linux) V1.1 Support Guide

154

Chapter 7 Alarms

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.
When the problem is resolved, ensure that DB synchronization has
been re-established, by checking the relevant PULSE counters. This is
particularly important in the live-standby case, to ensure the standby is
synchronized.

2420
Class:
Full Text:

Newer copy of database exists


A1
A newer copy of database Logical_Db exists on node
Slave_physical_name. This node will cut over now...

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

A newer copy of a database exists on the standby node, thus causing a


cutover (so long as the yield to slave limit has not been exceeded: see
the PDS_CONFIG table for more details).

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2421
Class:
Full Text:

Synchronisation to server will overwrite data


A1
Synchronisation of Logical_Db to server Physical_node will
overwrite data for sequence numbers start_Seq to end_Seq

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

A server, when processing the map received from a slave, discovered


that it is necessary to overwrite data on the slave.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

2422
Class:

155

Internal software error


A1

Component:

MGTA (PDS_Pnnnn_MGTA)

Description:

There is an internal software error within the MGTA component. It will


be raised in the following cases
Too many application processes registering on startup
Too many database processes registering on startup
Too many slaves in PDS_DEFS table
Duplicate slaves in the PDS_DEFS table

Response:

First-line support:
Report the alarm to second-line support.
Second-line support:
If the problem persists, report to third-line support.

2423
Class:
Full Text:

Active database too old, update deferred


A1
Active database too old, update deferred until later for
Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

A server, when processing the map received from a slave, discovered


that the slave has an unacceptable amount of data needing to be
overwritten.
The slave will defer the update until the server has the same sequence
number as the slave.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2424
Class:
Full Text:

Database ID logical error


A1
Database id logical name error: file name: Logical_Db, file

Home Location Register (Linux) V1.1 Support Guide

156

Chapter 7 Alarms

content: Db_name
Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

The database logical name in the .BIN file does not correspond to that
in the file name.
It is raised when trying to load such a database in either active or slave
modes.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Determine the problem, and escalate to third-line support if necessary.

2425
Class:
Full Text:

Logical database name changing state to


state
A1
Logical database Logical_Db changing state to
active_slave_inactive

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

This alarm will be raised when entering a new database state (active,
slave, inactive).
When a database is promoted to server, then this alarm will be raised
immediately.
When a database is removed, it will be raised following the secure.
When a database is changed to slave, it will be raised after initial
handshaking. It will be carried out at this time rather than immediately
so as to avoid raising the alarm repeatedly if this handshaking fails and
is thus retried.
An INACTIVE alarm is raised when the database is a slave running on
the standby server. The SLAVE alarm is raised only when it goes live.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Check whether the database should have changed state. If not,
escalate the alarm to third-line support.

2426

Last secured map error for logical database

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

Class:
Full Text:

157

name
A1
Last secured map error for logical database Logical_Db

Component:

PDSD (PDS_Pnnnn_PDSD)

Description:

The last secured map was detected to be in use when it was not
expected to be.
It is tantamount to an internal software error.

Response:

First-line support:
Escalate the alarm to second-line support.
Second-line support:
Escalate the alarm to third-line support.

2464

ASP_UNAVAILABLE

Class:
Type:

A2
Instance

Full text:

<instance id>:Application server process unavailable, <asp identifier>

Description:

The indicated SIGTRAN ASP is unavailable. This may be due to a


broken SIGTRAN association, or due to the remote ASP being out of
service.
This may be caused by an association fault or a fault in the remote
entity.
This should not be considered as a major service loss by itself. It will
result in a reduction in traffic capacity and redundancy to/from the
corresponding destination entity.

Response:

First Line Support:


Check SIGTRAN TCPIP/IP interface hardware. Check destination
platform, and for any network problems. If problem cannot be resolved,
report to Second Line Support. ASP states can be analysed using
PULSE: navigate to Sigtran, Association States.
Second Line Support:
Check SIGTRAN TCPIP/IP interface hardware. Check destination
platform, and for any network problems. If problem cannot be resolved,
report to Third Line Support. ASP states can be analysed using
PULSE: navigate to Sigtran, Association States.

Home Location Register (Linux) V1.1 Support Guide

158

Chapter 7 Alarms

2465

DESTINATION_ UNAVAILABLE

Class:
Type:
Full text:
Description:

A2
Instance
<instance id>:Destination unavailable, <destination identifier>
The indicated Application Server (that is, destination) is unavailable.
This may be due all of its ASPs (or a critical number of them) being
unavailable, or a combination of association faults.
This is a loss of service to/from the indicated remote entity.

Response:

First Line Support:


Check SIGTRAN TCPIP/IP interface hardware. Check destination
platform and for any network problems. If problem cannot be resolved,
escalate to Second Line Support.
Second Line Support:
Check SIGTRAN TCPIP/IP interface hardware. Check destination
platform, and for any network problems. If problem cannot be resolved,
escalate to Third Line Support.

2466

DESTINATION_ CONGESTED

Class:
Type:
Full text:
Description:

A2
Instance
<instance id>:Destination congested, <destination identifier>
The indicated Application Server (that is, destination) is congested.
This may be due to all of its ASPs (or a critical number of them) being
congested, or a combination of association faults.
This is a reduction in service to/from the indicated remote entity.

Response:

First Line Support:


Check SIGTRAN TCPIP/IP interface hardware. Check destination
platform and network. If problem persists and cannot be resolved,
escalate to Second Line Support.
Second Line Support:
Check SIGTRAN TCPIP/IP interface hardware. Check destination
platform, and for any network problems. If problem persists and cannot
be resolved, escalate to Third Line Support.

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

2467

159

ASSOCIATION_ FAULT

Class:
Type:
Full text:
Description:

A2
Instance
<instance id>:Association fault, <association identifier>
A fault has occurred with the indicated SIGTRAN SCTP association.
This implies a hardware or configuration fault. The fault may not
necessarily be on this platform.
This should not be considered as a service loss, although there may be
a loss of redundancy. This could be caused by a network or hardware
fault, or a configuration error.

Response:

First Line Support:


Check SIGTRAN TCP/IP interface hardware. Check destination
platform, and for any network problems. If problem cannot be resolved,
report to Second Line Support.
Second Line Support:
Check SIGTRAN TCP/IP interface hardware. Check destination
platform, and for any network problems. If problem cannot be resolved,
report to Third Line Support.

2468

ALL_DESTINATIONS_UNAVAILABLE

Class:
Type:
Full text:
Description:

A1
Condition
All destinations unavailable
All remote Application Servers (that is, destinations) are unavailable.
This is unlikely to be caused by a fault in all destination entities. This
may be an application fault or a network problem.
This is a critical service outage.

Response:

First Line Support:


Check SIGTRAN TCP/IP interface hardware. Check for major network
faults. Check local platform. Escalate to Second Line Support.
Second Line Support:
Check SIGTRAN TCP/IP interface hardware. Check for major network
faults. Check local platform. Escalate to Third Line Support.

Home Location Register (Linux) V1.1 Support Guide

160

Chapter 7 Alarms

2601

NO_LIVE_SERVICE

Class:
Type:
Full text:
Description:

A1
Condition
Node out of live service (<reason>)
This node is allocated for live service but is not providing any. This
indicates a total service loss for the entire platform.
This alarm is not intended to indicate whether the application is
stopped. However, it may indicate that the application is stopping,
starting or in a failed state. The reason in the alarm text will indicate the
exact state.
The alarm client is responsible for monitoring whether the application is
running (this may be through the use of the Heartbeat alarm).

Response:

First Line Support:


Check the reason for the node being out of service. If a cutover has
occurred or the node has been manually started, allow enough time for
the application to activate and provide service.
If a cutover occurred, report to Second Line Support. If the alarm is not
cleared after a short period or if it is persistently raised, escalate to
Second Line Support.
Second Line Support:
Check the reason for the node being out of service. If a cutover has
ocurred or the node has been manually started, allow enough time for
the application to activate and provide service.
If a cutover occurred, report to Third Line Support. If the alarm is not
cleared after a short period, or if it is persistently raised, escalate to
Third Line Support.

2603

NO_STANDBY_SERVICE

Class:
Type:
Full text:
Description:

A2
Condition
Node out of standby service (<reason>).
This node is allocated for standby service but is not providing any. This
indicates a lack of redundancy for platform service.
This alarm is not intended to indicate whether the application is
stopped. However, it may indicate that the application is stopping,
starting or in a failed state. The reason in the alarm text will indicate the
exact state.

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

161

The alarm client is responsible for monitoring whether the application is


running (this may be through the use of the Heartbeat minor alarm).
This indicates no service loss, but does indicate a significant risk of
total service loss if the other node of the platform fails.

Response:

First Line Support:


If a cutover has occurred or the node has been manually started/
restarted, allow enough time for the application to activate and provide
standby service.
If the alarm is not cleared after a short period or if it is persistently
raised, escalate to Second Line Support. If the alarm was caused by an
automatic restart (that is, failure) of the standby node then report to
Second Line Support.
Second Line Support:
If a cutover has ocurred or the node has been manually started/
restarted, allow enough time for the application to activate and provide
standby service.
If the alarm is not cleared after a short period or if it is persistently
raised, escalate to Third Line Support. If the alarm was caused by an
automatic restart (that is, failure) of the standby node, then report to
Third Line Support.

2611

Not enough database processes

Class:

A1

Type

please supply alarm type

Component:

MGTA (PDS_Pnnnn_MGTA)

Description:

There are not enough database processes to support the contents of


the PDS_DEFS table.
Note that sufficient processes are needed to allow any existing logical
databases to close (which may take a little time since this involves a
secure to disk) and any new logical databases to start.

Response:

First-line support:
Report the alarm to second-line support.
Second-line support:
If the problem persists, report to third-line support.

Home Location Register (Linux) V1.1 Support Guide

162

Chapter 7 Alarms

2679

APPLICATION_TASKS_LOW

Class:
Type:
Full text:
Description:

A2
Condition
Application tasks low
There are a low number of free application tasks available. There is
considerable risk that all application tasks will be exhausted and
subsequently become overloaded by Signals traffic.
This may be caused by a performance degradation of the live database
server, a platform resource problem, a hardware fault, or one or more
remote entities taking a long time to respond to the HLR (or failing to
respond and thus timing out).
There is no service loss though there is imminent risk of serious service
degradation and subsequent service loss.

Response:

First Line Support:


Report to Second Line Support.

2680

APPLICATION_TASKS_EXHAUSTED

Class:
Type:
Full text:
Description:

A1
Condition
Application tasks exhausted
There are no free application tasks available. There is an imminent risk
that the platform will subsequently become overloaded by Signals
traffic.
This may be caused by a performance degradation of the live database
server, a platform resource problem, a hardware fault, or one or more
remote entities taking a long time to respond to the HLR (or failing to
respond and thus timing out).
There is serious service degradation and imminent risk of a total
service loss.

Response:

First Line Support:


Escalate to Second Line Support.

2701

TCPIP_TASKS_EXHAUSTED

Class:
Type:

A2
Condition

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

Full text:
Description:

163

TCP/IP tasks exhausted


There are no free tasks for handling TCP/IP transactions. The platform
has become overloaded by TCP/IP traffic.
There is s service loss for TCP/IP traffic and those application-based
services that depend upon it.
This constitutes a minor service loss.
Some services such as Location Services and Automatic Device
Detection may be lost.

Response:

First Line Support:


Escalate to Second Line Support.
Second Line Support:
Check level of transactions that may use TCP/IP transactions, to try to
understand TCP/IP transaction loading. If problem persists, then
escalate to Third Line Support.

2702

TCPIP_TASKS_LOW

Class:
Type:
Full text:
Description:

A2
Condition
TCP/IP tasks low
There is a low number of free tasks for handling TCP/IP transactions.
There is an imminent risk that the platform will subsequently become
unable to handle further TCP/IP transactions.
There is no service loss, although there is a risk of imminent service
loss for TCP/IP traffic and those application-based services that
depend on it. This would constitute a minor service loss.
Some services such as Location Services and Automatic Device
Detection may be affected by this.

Response:

First Line Support:


Report to Second Line Support.
Second Line Support:
Check level of transactions that may use TCP/IP transactions, to try to
understand TCP/IP transaction loading. If problem persists, then report
to Third Line Support.

Home Location Register (Linux) V1.1 Support Guide

164

Chapter 7 Alarms

2721

TRAFFIC_OVERLOAD

Class:
Type:
Full text:
Description:

A1
Condition
Signal traffic overload
The rate of incoming signals traffic is too high for the performance of
the application. The application is overloaded and can process no new
signals. New signals are discarded.
This may be caused by abnormally high levels of traffic, possibly as a
result of having provisioned too many subscribers on this platform. It
may equally be caused by platform resource problems, a hardware
fault, or excessive network traffic caused by a nationally or
internationally significant event.
There is total loss of signal traffic service. This constitutes a critical
service loss.

Response:

First Line Support:


Escalate to Second Line Support.
Second Line Support:
Check the number of subscribers in the live database using the
database utility, DBVIEW. If this is abnormally high, consider executing
an SDM for some of these, to reduce the load. Check for uneven
distribution of signals load across source nodes.
Also check for hardware faults and system performance on the
command line (particularly check HLRA and HLRD process
performances).
If problem persists, escalate to Third Line Support.

2722

HIGH_TRAFFIC_LOAD

Class:
Type:
Full text:
Description:

A2
Condition
High signal traffic load
The rate of incoming signals traffic is very high for the performance of
the application. The application is close to becoming overloaded.
This may be caused by abnormally high levels of traffic, possibly as a
result of having provisioned too many subscribers on this platform. It
may equally be caused by platform resource problems, a hardware
fault., or excessive network traffic caused by a nationally or
internationally significant event.

Home Location Register (Linux) V1.1 Support Guide

Chapter 7 Alarms

165

There is no service loss though there is an imminent risk of total signal


traffic service loss. This would constitute a critical service loss.

Response:

First Line Support:


Report to Second Line Support.
Second Line Support:
Check the number of subscribers in the live database using the
Database utility, DBVIEW. If this is abnormally high, consider executing
an SDM for some of these to reduce the load. Check for uneven
distribution of signals load across source nodes.
Also check for hardware faults and system performance on the
command line (particularly check HLRA and HLRD process
performances).
If problem persists, report to Third Line Support.

4000

APPLICATION_WARNING

Class:
Type:
Full text:
Description:

A2
Event
Application warning: <event>
This alarm is used as a catch all for general events that need to be
captured.
This does not indicate any service loss, although the event may imply a
maintenance issue that could potentially lead to a more serious failure.

Response:

First Line Support:


Report to Second Line Support.
Second Line Support:
Report to Third Line Support.

Class:
Type:
Full text:
Description:

SLAVE_DATABASE_CORRUPT
A2
Instance
DR-triad slave database corrupt <database name>
A DR-Triad Slave Database is corrupted. This means that there may be
no redundancy for the corresponding Master Database on another HLR
in the Triad.

Home Location Register (Linux) V1.1 Support Guide

166

Chapter 7 Alarms

This indicates no loss of service, but does indicate a high risk that the
corresponding Master HLR node has no Disaster Recovery capability.

Response:

Check there is another good slave database for the corresponding


Master HLR. Report to Second Line Support.

ALARMS_RESET
Class:
Type:
Full text:
Description:

A2
Clear All
Alarms reset
This alarm will be used by the SNMP agent as a trigger to cease all
raised alarms and those corresponding values in the MIB. This will be
transmitted on application startup by the Alarm Server (see below). It is
the first alarm transmitted.
This indicates no service loss and will be invisible to First Line Support.
Other alarm interfaces should also use this alarm to cease all raised
alarms.

Response:

Not applicable.

Home Location Register (Linux) V1.1 Support Guide

167

Chapter 8

SIGTRAN Configuration
SIGTRAN is a high speed signalling transport mechanism that allows
SS7 traffic to be carried over IP. This means that overloading of C7
Signalling Transfer Points (STPs) connecting the HLRs, SCCP Relays
and MSCs can be avoided, as the link is now over the IP network.
SIGTRAN removes the bottleneck limiting the number of subscribers
an IN node can handle. This leads to a doubling in the number of
subscribers that each database can hold.
The SIGTRAN configuration table is described in hsscfg Table on
page 495.

Stack Layers and Implementation


SIGTRAN consists of general signalling layers at the bottom of the
stack and specific communications layers at the top. The layers used
depend on the stacks used by the remote entity and the type of
deployment and control required.
The layer at the bottom of the stack is the Stream Control Transmission
Protocol (SCTP) which runs over IP. The M3UA layer is used to
connect the HLR to the MSCs based on the Point Code of the entity
(see Figure 45).
Figure 45. M3UA and M2UA layers
SCCP

SCCP

M3UA

MTP3

End-to-end communications

SCTP

MTP2

Communications between
adjacent nodes

SIGTRAN provides APIs to any upper layers (such as SCCP) so that


they can function in the normal manner. The IP layer deals with
addressing and getting packets to the destination. SCTP provides
connections to the remote system. M3UA replaces the MTP3 and
MTP2 layers, and instead interfaces to SCTP, accepting point codes
and other data that SCCP sends. M3UA uses the concept of
Application Servers (AS) and Application Server Processes (ASP) as
end-points. The HLR and SCCP Relay is the AS while the HLRA and
SCCPA processes represent the ASP.

Home Location Register (Linux) V1.1 Support Guide

168

Chapter 8 SIGTRAN Configuration

The ASP on the live side is active (ASP-ACTIVE state) as is the AS.
The ASP on the stand-by side is in the ASP-INACTIVE state. The
following ASP states apply:
DOWN
INACTIVE
ACTIVE
The AS has the following states:
DOWN
INACTIVE
ACTIVE
PENDING
During a cutover, the new live side becomes ASP-ACTIVE and the old
live side becomes ASP-INACTIVE. The SCTP layer on each node
maintains the connection to 2 Ethernet cards providing IP connectivity,
thus independently linking the connection to the remote systems.

SIGTRAN
Processes

A new process called HSSP maintained by MGTA controls the


SIGTRAN functionality.

Signalling Gateway (SG) Mode


The HLR can talk to entities that do not have SIGTRAN capability, by
operating in SG mode.
The HLR has the ability to communicate over SIGTRAN to both remote
IPSPs (IPSP-IPSP mode) and remote SGs (ASP-SG mode). A remote
IPSP is, for example, an SCCP Relay or an MSC that has an
application running over M3UA. A remote SG contains remote SGPs,
and they in turn talk to classical SS7 entities.
Figure 46 illustrates how an HLR can communicate with an SCCP
Relay in IPSP-IPSP mode, and with non-SIGTRAN entities in ASP-SG
mode.

Home Location Register (Linux) V1.1 Support Guide

Chapter 8 SIGTRAN Configuration

169

Figure 46.

HLR

IP network

Signalling
Gateway

SS7 network

SCCPR

Home Location Register (Linux) V1.1 Support Guide

170

Chapter 8 SIGTRAN Configuration

SIGTRAN and the Vodafone Application


The SIGTRAN software supplied by Flextronics provides:
an interface that allows the HLR application to send and receive
messages.
an interface that allows the Vodafone S7MP process to control and
configure SIGTRAN (see Vodafone pds_i_s7mp Process on
page 170).

SIGTRAN on the
VodaSCP
Platform

Figure 47 below shows how SIGTRAN fits in with the HLR application.

Figure 47. How SIGTRAN fits in with the HLRR

HSSP Process
HLR Application
HLRA

SIGTRAN
Management
Application
S7MP

SIGTRAN counter
tables

SIGTRAN API
functions

SIGTRAN
Management
API functions

SIGTRAN Stack

Pulse Utility

Vodafone pds_i_s7mp Process


The S7MP process, pds_i_s7mp, starts at system startup and
communicates with the SIGTRAN process pds_i_hssp.

Home Location Register (Linux) V1.1 Support Guide

Chapter 8 SIGTRAN Configuration

171

The S7MP process uses the SIGTRAN configuration table hsscfg.dat


to configure the SIGTRAN stack on the platform.
During system startup, pds_i_s7mp:
Configures the HSSP process via the management API to create
the necessary remote entites in the local SIGTRAN stack.
Depending on whether each remote ASP is configured as a client or
server:
Via the management API, triggers the sending of ASPUP and
ASPAC to bring the SIGTRAN associations live.
Waits for incoming ASPUP and ASPAC.
When the platform is in service, pds_i_s7mp:
Monitors SIGTRAN events passed back to it via the management
API.
Acts on SIGTRAN events by raising alarms.
Regularly retrieves statistical information from the SIGTRAN stack
and updates the SIGTRAN counters for use by the PULSE utility.

Home Location Register (Linux) V1.1 Support Guide

172

Chapter 8 SIGTRAN Configuration

SIGTRAN Startup and Configuration


Management process MGTA starts each of the PDS processes,
activates each process and expects to get an acknowledgement
response from each one in turn. If an acknowledgement response is
not received within the expected time period, the platform will restart.
The S7MP process reads the hsscfg.dat file, and once the HSSP
ready signal is received, S7MP configures the SIGTRAN stack.
The HLRA application registers with the HSSP process once the
database is loaded into memory. The S7MP process receives an
indication from the stack that the application is available, and will then
acknowledge ASPAC requests from clients, or send ASPUP/ASPAC
requests to servers, so bringing the SIGTRAN signalling up, and the
platform into service.
Figure 48. SIGTRAN Startup
MGTA
startup
sequence
1

OMCS

S7MP
HSSP
Ready signal

HSSP

MP

HLRD

ADM

HLRA

Home Location Register (Linux) V1.1 Support Guide

Application
registration

Chapter 8 SIGTRAN Configuration

173

Updating SIGTRAN Configuration Files


SIGTRAN configuration changes are made by editing the SIGTRAN
Configuration Table (hsscfg) (see page 495) using the table change
procedure described in Changing Tables on page 456.
Remote AS/ASPs can be added or removed without stopping and
restarting the system. Any other changes require a complete system
stop and restart as described in Restarting the HLR Application on
page 115.
After editing the SIGTRAN Configuration Table, the VERIFY:TABLE
command (see page 462) checks the syntax of remote AS and ASPs
and generates error messages if the syntax of the edited table is
incorrect.
When the REPLACE:TABLE command (see page 461) is used for the
updated SIGTRAN Configuration Table, the new table is checked to
determine whether the system must be restarted, as shown below:
Figure 49. Updating SIGTRAN Configuration
replace:table,hsscfg

Compare new configuration


with the Table in Memory

System restart
needed?

Yes

Refuse table replace with an


error message indicating that
a pds restart is required

No

Send SIGTRAN configuration


changes to PDS management
process (pds_i_mgta)

Copy hsscfg table to Table in


Memory and Table File

Remote Engineer The SIGTRAN configuration files cannot be updated from the Remote
Engineer account.

Home Location Register (Linux) V1.1 Support Guide

174

Home Location Register (Linux) V1.1 Support Guide

Chapter 8 SIGTRAN Configuration

175

Chapter 9

Administration Interface
This chapter describes the HLR Administration Interface used to
manage the HLR subscriber database. It includes:
Client Types below.
Accessing the Administration Interface on page 176.
Command Notation on page 177.
Command Syntax on page 178.
Response Syntax on page 179.

Client Types
Several clients use the administration interface, including:
Interactive session.
Administration Replication for forwarding commands from master to
slave nodes.
ISAAC, the International Subscriber Administration and Control
System used to maintain IMSI details.
IN_VIEW, the utility used to browse subscriber details.
Network test.
MMI.
TM, for table maintenance
PIRR, the Packet Inspection, Rating and Reservation element,
which can use the ADD:BAR and REMOVE:BAR commands to
disconnect data sessions, when a PrePay subscribers credit runs
out for example.
Every admp process has a client type associated with it, and the client
type is specified on the command line when an admp process is
started. Client types are defined in the adm_client data table.

Home Location Register (Linux) V1.1 Support Guide

176

Chapter 9 Administration Interface

Accessing the Administration Interface


To access the Administration Interface enter:
admp (-c <client_type>) (-t <transport_type>)
where:
Parameter

Values

Default

Description

client_type

Client name
string

INTERACTIVE

Client types are listed in the adm_client


Table.
The adm_client Table lists the
commands the client is allowed to use
and the default timeout.

transport_type

INTERACTIVE
TCPIP

INTERACTIVE

INTERACTIVE - an interactive session,


such as is used by support staff.
TCPIP - connection through the TCP/IP
interface.

The command prompt is displayed:


(node_name)adm>
node_name is the name of the HLR node.
To exit, enter:
exit <ret>

Home Location Register (Linux) V1.1 Support Guide

Chapter 9 Administration Interface

177

Command Notation
The commands in this appendix are written using the following
notation:
Literal items - text you should type exactly as shown is written in
upper-case. For example:
VIEW:SUB
Note: You can enter administration commands using either upper or
lower case letters.
Variables (except for dates and times) are shown in lower-case
italic text. Underscores are used instead of spaces between words.
For example:
service_id
Optional items (parts of the command or response lines that may
be omitted, such as flags) are enclosed in parentheses. For
example:
(prefix)
Alternative items, where you must choose one literal or variable
from a list, are separated by vertical bars, |. For example:
INCOMING|OUTGOING
means choose either INCOMING or OUTGOING, but not both.
Braces {} surrounding a parameter show that you can enter more
than one, each separated from the next by a comma.
Note: All commands and responses occupy a single line in the
Interface. However, some of the format descriptions in this appendix
are so long that they are shown on two lines.

Home Location Register (Linux) V1.1 Support Guide

178

Chapter 9 Administration Interface

Command Syntax
Commands on the HLR have the format:
verb:object{,(parameter)};(comment)
Note: The general commands, EXIT, HELP and INFO, do not have
the above format.
- object is what the command acts on; for example a record in
the HLR database.
- verb describes the action performed on the object; for example:
VIEW displays details of an object.
- parameter modifies the action of the verb. They are mostly
variables and literal flags. Separate parameters with a comma.
- comment is any character string.
A command can have up to 20 parameters.
The command line must not exceed 256 characters, including
comments.
All commands must end with a semi-colon.
Any text on the same line, but following the semi-colon terminator is
treated as a comment and ignored by the parser.
Each missing optional parameter must be replaced by a comma,
except for any immediately before the terminating semi-colon.
Note: Likewise, commas are not displayed for missing optional
parameters at the ends of command responses.
Tabs and spaces are ignored, except where they are part of a
parameter.

Home Location Register (Linux) V1.1 Support Guide

Chapter 9 Administration Interface

179

Response Syntax
The general form of response to an administration command is:
C2:message_id{,user_message};
C1:status_code,error_code;
- status_code is a 5-digit code indicating that a command was
successful, or that it failed because, for example, the command
was not known or contained a syntax error. See Table 16 below.
- error_code is a 5-digit code indicating that the command was
successful, or that it failed for a data-related reason, such as a
lack of space in the database. See Table 17 on page 180.
- message_id is a 5-digit code that indicates the kind of
information returned by the command (location information or
supplementary services for example), or a reason for failure. See
Table 18 on page 186.
- user_message is data returned by the command.

Response Codes
C1 Messages

C1 messages are known as command completion messages and show


that the command has been processed.
Table 16. C1 status_code Values

status_code

error_code

Text and Meaning

00000

See Table 17

Success - the command worked correctly.

00001

Non serious error - a minor error occurred.

00002

Serious error - a major error occurred.

00003

00001

Syntax violation - command is not correct for the


platforms information protocol.

00004

00001

Unknown command - the command verb or object type


is not recognised.

00005

00001

Invalid command for this user type - you are not


authorised to use this command.

00006

00000 too few parameters


00001 too many parameters

Incorrect number of parameters - you have entered too


many or too few parameters.

00007

Specifies position of first


invalid parameter

Invalid parameter value - the value specified is not


supported.

00008

00001

Internal software error.

Home Location Register (Linux) V1.1 Support Guide

180

Chapter 9 Administration Interface

The error_code relates the command failure to the subscriber data.


Table 17 describes the HLR error_code values.
Table 17. C1 error_code Values
error_code

Message

Meaning/Action

00000

Success

The command has completed successfully.

00001

Subscriber IMSI already in use

The IMSI is already in the database, check the


IMSI to be used.

00002

Record not found

The specified item is not in the database.

00004

Subscriber MSISDN already in use

The MSISDN is already in the database, check


the MSISDN to be used.

00006

Unable to create subscriber

The database is full. Contact your support


services immediately.

00007

Subscriber MSISDN /IMSI


mismatch

The IMSI and MSISDN for the subscriber do


not match. Specify the correct identity for the
subscribers number.

00008

Overlapping IMSI not pending for


any subscriber

The IMSI specified is not waiting to be used by


a subscriber, it is the current IMSI for the
subscriber.

00009

Overlapping IMSI already in use

The IMSI is already in the database, check the


IMSI to be used.

00011

Subscriber already has overlapping


IMSI

The subscriber has already been assigned an


overlapping IMSI.

00012

Subscriber IMSI/overlapping IMSI


mismatch.

The IMSI and the Overlapping IMSI for the


subscriber do not match. Specify the correct
identity for the subscriber.

00019

Service request number already in


use

The SRN is already in the database, check the


SRN to be used.

00021

Service request number/service


access number mismatch

The SRN and SAN do not match. Specify the


numbers so that they match.

00022

Duplicate Zone Codes Specified

The same zone code was specified twice in a


zone code list. Make sure that all zone codes in
the list are different.

00023

Data missing error

You have not specified the forward-to number


in the command. Specify the FTN value in the
command.

00024

Unexpected data value error

One of the parameters specified is out of range


or has an illegal value. For example: forward-to
number is disallowed or the timer does not
have a value that is a multiple of 5. Re-enter
the command giving the correct parameter
values.

Home Location Register (Linux) V1.1 Support Guide

Chapter 9 Administration Interface

181

Table 17. C1 error_code Values (Continued)


error_code

Message

Meaning/Action

00025

Illegal SS operation error

Either:
The basic service group specified contained no
basic services subscribed to by the subscriber
and applicable to the supplementary service
concerned.
Or:
The request is inappropriate to the
supplementary service specified.

00026

SS error status

The service is not provisioned.

00027

Bearer service not provisioned

The basic service or basic service group


specified contains no basic service subscribed
to by the subscriber.

00028

Teleservice not provisioned

The basic service or basic service group


specified contains no basic service subscribed
to by the subscriber.

00029

Subscriber has maximum zone lists

The number of zone lists allowed for a


subscriber was exceeded. A zone list identifies
geographical areas as part of regional
subscription data (used for home zone
charging). One zone list corresponds to one
country code (CC) and national destination
code (NDC) combination.

00033

Cannot update authentication


algorithm and key separately

You must specify both the algorithm and key in


the command or omit both of them.

00036

Subscriber already has P number

The published number already exists in the


database.

00038

Duplicate MSISDN specified

The MSISDN is the same as one already in the


database. Specify another number for the
MSISDN.

00039

Unable to add overlapping IMSI

00041

Unable to add MSISDN

The database is full. Contact your support


services immediately.

00043

Unable to create service request


number

00044

Unable to add P number

00046

Incorrect number of MSISDNs


specified

You have specified the wrong number of


MSISDNs for the template. Specify the correct
number for the template.

00047

Cannot remove main MSISDN

You cannot remove the main MSISDN without


deleting the entire subscriber record.

The database is full. Contact your support


services immediately.

Home Location Register (Linux) V1.1 Support Guide

182

Chapter 9 Administration Interface

Table 17. C1 error_code Values (Continued)


error_code

Message

Meaning/Action

00048

Unable to register supplementary


service

00049

Unable to erase supplementary


service

The database is full or the VLR interworking


connection has failed. An alarm will display
what has happened. Escalate the problem to
your support services.

00050

Unable to activate supplementary


service

00051

Unable to deactivate
supplementary service

00053

Cannot copy template with PNUM

Attempt to create a subscriber using a template


with a PNUM that is already in the database.
Use a different value for PNUM.

00055

Unable to access subscriber record

The record is locked in another update, try


again later. If the problem persists, treat as
error_code 00099.

00058

CSI TDP combination not in use by


subscriber

An attempt was made to remove information


associated with a CAMEL trigger detection
point (TDP) but the TDP is not used by the
subscriber.

00059

BC title not known

The BC title specified is not known by the HLR.


Specify the correct text for the BC title.

00060

Unable to initiate Cancel Location

The cancel location has failed, re-enter the


command.

00061

HLR updated but Subscriber Data


download failed

The HLR database has been updated, but the


subscriber is still registered on the VLR.

00062

Invalid identifier for encryption key


or integrity key

The encryption key or integrity key identifier is


invalid. Check that the value of the identifier is
correct.

00063

Integrity key not held in HLR table

The transport key corresponding to the key


identifier cannot be found or is invalid. Check
that the key identifier is correct.

00064

Integrity check algorithm not found


for given key

The algorithm corresponding to the key


identifier cannot be found. Check that the value
of the key identifier is correct.

00065

Integrity check failed

The authentication data integrity check has


failed. Contact your support services
immediately.

00066

Encryption key not held in HLR


table

The transport key corresponding to the key


identifier cannot be found or is invalid. Check
that the key identifier is correct.

00067

Encryption algorithm not found for


given key

The algorithm corresponding to the key


identifier cannot be found. Check that the value
of the key identifier is correct.

00068

Encryption/decryption algorithm
internal error

An internal error has occurred when decrypting


the subscriber key. Contact your support
services immediately.

Home Location Register (Linux) V1.1 Support Guide

Chapter 9 Administration Interface

183

Table 17. C1 error_code Values (Continued)


error_code

Message

Meaning/Action

00099

Internal software error

There is a software fault, report it to your


support services.

00100

Cannot remove published DN

The published MSISDN is not in the database.

00101

Invalid parameter value

An invalid parameter value was specified.

00114

Configurable CAMEL GSMSCF GT


unavailable

The HLR received a request to update the


CAMEL GSMSCF Global Title to the
configurable value defined in the hlr_config
table. This field was not present when the table
was loaded, so the command failed.

00115

Sequence number should be


updated to a higher value

The HLR received a request to update the


sequence number to a value lower than or
equal to the subscriber sequence number.
Check the value of the sequence number.

00116

Unable to allocate resource

The database is full. Contact your support


services immediately.

00118

Subscriber already has maximum


number of PDP contexts

An attempt to provide a subscriber with a


GPRS service failed because the subscriber
already has the maximum number of services,
defined by MAX_PDP in the hlr_config table
(see page 477).

00119

Incorrect address for PDP type

The address specified for a PDP context did


not match the TYPE attribute of the context.
Check that the address is correct.

00120

Context ID not in use by subscriber

An attempt was made to change a PDP context


that the subscriber does not have. Check that
the context is correct.

00121

Unable to enable PDP context, type


not set

A PDP context cannot be enabled unless the


type of address the PDP context uses has
been specified. Make sure that the address
type is correct.

00122

Subscriber already has the


maximum number of service
centres

When using the SET:MWD command, an


attempt was made to set more than the
maximum permitted number of MSISDNs.

00123

Subscriber already has the


maximum number of MSISDNs

When using the ADD:MSISDN command, an


attempt was made to set more than the
maximum permitted number of MWD records.

00124

Invalid CCH and CAMEL data


combination

An attempt is being made to add CAMEL data


for CAMEL subscription information (CSI) that
cannot have that data, because of its CAMEL
capability handling (CCH) values (see
page 334 for an example). To add the data, first
change the CCH to appropriate values.

00125

Attempt to remove mandatory CSI


data

An attempt was made to remove mandatory


data associated with particular CAMEL
subscription information (CSI).

Home Location Register (Linux) V1.1 Support Guide

184

Chapter 9 Administration Interface

Table 17. C1 error_code Values (Continued)


error_code

Message

Meaning/Action

00126

Number of CAMEL basic service


criteria exceeded

For CAMEL 3, a particular CSI is not allowed to


have more than 5 associated basic service
criteria values.

00127

SIM ID is already in use

The SIM identity specified for the new SIM (an


integer from 0 to 9) is used by another SIM in
the MultiSIM subscription.

00128

Unable to allocate a new SIM

The new SIM cannot be added. Either the


subscription already has 10 SIMs (the
maximum allowed), or the HLR database has
run out of resource. If the subscriber does not
already have 10 SIMs, contact your support
services immediately.

00129

SIM ID does not match IMSI

The SIM identity specified does not match the


identity stored in the HLR for that IMSI.

00130

Unable to initiate alert

00131

SIM still has nomination

The SIM cannot be removed because it is the


last SIM left in the subscription or because it is
still nominated for one or more basic services.

00132

SIM ID not in use

The SIM identity specified has not been


assigned to an IMSI.

00133

Unable to set encryption ROAMED

Encryption cannot be disabled for a roamed


subscriber.

00134

Encryption already at specified


state

An attempt was made to enable encryption for


a subscriber with encryption already enabled,
or disable encryption for a subscriber with
encryption already disabled.

00135

Unable to set/cancel TIMER

The HLR is unable to set a timer. This is an


internal software error. Contact your support
services immediately.

00137

Unable to set trace

00142

HLR file not found.

The SDM configuration file is not found. The


SDM cannot be performed.

00143

SDM file not found.

The specified SDM configuration file is not


found. The SDM cannot be performed.

00144

Invalid HLR node file format.

The SDM configuration file is badly formatted.


The SDM cannot be performed.

00145

Invalid SDM file format.

The specified SDM configuration file is badly


formatted. The SDM cannot be performed.

00146

Unknown destination HLR.

The destination HLR is not specified in the


SDM configuration file. The SDM cannot be
performed.

00147

Invalid HLR configuration data.

The HLR configuration data in hlr_config is


invalid.

00148

Failed to create template IMSI.

The Template IMSI could not be created for the


SDM. The SDM cannot be performed.

Home Location Register (Linux) V1.1 Support Guide

Chapter 9 Administration Interface

185

Table 17. C1 error_code Values (Continued)


error_code

Message

Meaning/Action

00149

Failure to allocate required SDM


replications.

The SDM cannot allocate enough tasks. The


SDM cannot be performed.

00150

Failure to establish TCPIP link.

The TCPIP link for forwarding SDM Admin


commands to the destination HLR could not be
established.

00151

TCPIP link failure.

TCPIP link failure when source HLR


communicating with either destination HLR or
SCCPR.

00152

Failed to open log file.

SDM log file could not be opened.

00153

Cannot delete template IMSI.

Failure to delete template IMSI following SDM.

00154

Cannot SDM to specified HLR.

Cannot SDM to specified HLR since source


and destination HLR must be different.

00155

Emlpp default priority greater than


maximum allowed.

00156

Unable to reset recache bit and


initiate trigger to NBS.

00157

Could not update data for pending


SIM.

00158

Unknown off node PIPC service.

00165

Admin Forward got bad response.

The response received by the source HLR from


the destination HLR was not recognized.

00166

Admin Forward got no response.

The source HLR received no response from


the destination HLR.

00167

Invalid database.

The database specified is not active.

00168

Admin Forward failed because of


TCP error.

The source HLR was unable to forward the


command to the destination HLR because of a
network error.

00169

Admin Forward disallowed for this


command.

This command cannot be forwarded.

00170

Soft SDM Aborted.

Soft SDM was aborted manually, by changing


the SDM_STOP flag in the hlr_config table to
TRUE during Soft SDM.

00171

Soft SDM Disabled.

Soft SDM is disallowed, because the value of


the SDM_STOP flag in the hlr_config table was
set to TRUE before Soft SDM was started.

00172

MSISDN has no country code.

The MSISDN used to format the divert contains


the wrong country code, indicating that
published number of a linked subscription is
wrong in the member record.

00173

ISDN cannot be formatted.

The length of the divert is more than 15 digits.


This is probably because the prefix defined in
the [DIVERT_FORMAT] section of the
voicemail table is too long.

Home Location Register (Linux) V1.1 Support Guide

186

C2 Messages

Chapter 9 Administration Interface

C2 messages are known as user messages and have the format:


C2:message_id,{user_message};
user_message is the data returned in response to the command and
Table 18 lists message_id values.
For details of the user message responses, see the Response section
of the VIEW:SUB command.
Table 18. Supported message_id Values
message_id

Associated user_message

00001
00002
00003

Access denied - maximum number of users exceeded


Access denied - platform not running
Access denied - software failure
Session aborted by application
Session disconnected for admin reconfiguration

00010

IMSI View

00011

<type>,<value> where type is IMSI or MSISDN, and value


is the corresponding value.

00012

Supplementary Services View

00013

General Subscriber Data View

00014

Voicemail Information

00015

MSISDN Basic Services View

00016

Subscriber Basic Services View

00017

Subscriber Supplementary Service Status View

00018

Service Centres View

00019

Last Caller Information View

00020

Network Entity View

00023

Published Number View

00024

Trace Information

00028

IMSI or MSISDN information

00029

PDP Context Information

00030

Home Zone Information

00040

Location View

00041

Ericsson PSI Information

00042

Provide Subscriber Information (PSI) Information

00043

IN Service View

00044

O-CSI CAMEL Information

00045

GPRS-CSI CAMEL Information

Home Location Register (Linux) V1.1 Support Guide

Chapter 9 Administration Interface

187

Table 18. Supported message_id Values (Continued)

message_id

Associated user_message

00046

MOSMS-CSI CAMEL Information

00047

T-CSI CAMEL Information

00048

D-CSI CAMEL Information

00049

VT-CSI CAMEL Information

00050

M-CSI CAMEL Information

00051

SS-CSI CAMEL Information

00052

U-CSI CAMEL Information

Home Location Register (Linux) V1.1 Support Guide

188

Home Location Register (Linux) V1.1 Support Guide

Chapter 9 Administration Interface

189

Chapter 10

List of HLR Administration


Commands

The table below lists the administration commands for the HLR, apart
from table maintenance commands: these are described in Chapter 24.
Command

Description

See

ACTIVATE:SS

Activate a supplementary service. For example, call barring.

page 327

ADD:BAR

Add an individual operator determined bar for a subscriber.

page 435

ADD:CAMEL

Add CAMEL data for a subscriber

page 332

ADD:MSISDN

Add an MSISDN to a subscriber record.

page 280

ADD:OVERLAP

Add an overlapping IMSI to a subscriber record.

page 274

ADD:PDP

Add a single blank PDP context to a subscriber.

page 298

ADD:PNUM

Add a published (P) number to a subscriber record.

page 416

ADD:SERVICE

Adds a basic service to a subscriber record.

page 310

ADD:SIM

Add a SIM to an existing subscription

page 194

AUCUPDATE:SUB

Update the authentication data in the integrated HLR/AUC


database.

page 266

COMPLETE:SDM

Completes the process of moving subscribers from one HLR


to another, by deleting them from the source HLR.

page 422

COPY:SUB

Create a subscriber record from an existing subscriber


template.

page 208

CREATE:SRN

Create a service request number (SRN) in the database.

page 290

CREATE:SUB

Create a subscriber record in the database.

page 206

DEACTIVATE:SS

Deactivate a supplementary service.

page 329

DELETE:SRN

Deletes a service request number from the database.

page 291

DELETE:SUB

Delete a subscriber record and all associated records, for


example MSISDN information, from the database.

page 211

ERASE:SS

Erase a supplementary service.

page 325

EXECUTE:SDM

Moves a subscriber or range of subscribers to a different


HLR.

page 420

INITIATE:ALERT

Unlock the short message service

page 426

INITIATE:CANCEL

Initiate a cancel location for a specified subscriber on a


specified VLR (or SGSN).

page 428

INITIATE:RESET

Send a Reset MAP message to a specified VLR from a


specified HLR.

page 430

LOCK:SUB

Lock a subscriber record in the database.

page 213

Home Location Register (Linux) V1.1 Support Guide

190

Chapter 10 List of HLR Administration Commands

Command

Description

See

PROVISION:SS

Gives a subscriber the ability to use a supplementary service.

page 318

REGISTER:SS

Register and activate an individual call forwarding service.

page 322

REMOVE:BAR

Remove an individual operator determined bar for a


subscriber.

page 437

REMOVE:CAMEL

Remove CAMEL subscription information from a subscriber.

page 373

REMOVE:MSISDN

Remove an MSISDN from a subscriber record.

page 282

REMOVE:OVERLAP

Remove an overlapping IMSI from the database.

page 278

REMOVE:PDP

Remove a PDP Context from a subscriber.

page 306

REMOVE:PNUM

Remove a published number (P number) from a subscriber


record.

page 418

REMOVE:SERVICE

Remove a basic service from a subscribers record.

page 312

REMOVE:SIM

Remove a SIM from a MultiSIM subscription

page 196

REPLACE:OVERLAP

Force an overlapping IMSI to become the current IMSI and


delete the existing IMSI.

page 276

RESET:SEED

Reset the initial random number generated by the HLR, using


a random means.

page 439

ROLLBACK:SDM

Rolls back moving subscribers between HLRs, in case of


failure.

page 423

SET:CAMEL

Sets CAMEL data for subscriber.

page 362

SET:MWD

Forces message waiting data to be associated with an


MSISDN.

page 433

SET:PDP

Set PDP data.

page 300

SET:SEED

Set the next random number generated by the HLR to a


specific value.

page 440

SET:TRACE

Log transaction or SS7 events to log files.

page 269

UNLOCK:SUB

Unlock a subscriber record in the database.

page 214

UPDATE:CAMEL

Modify subscriber information associated with CAMEL


services.

page 375

UPDATE:IMEI

Change the values of the IMEI fields.

page 441

UPDATE:LCN

Updates the last calling information for a subscriber.

page 443

UPDATE:LOCATION

Updates the location information for a subscriber.

page 445

UPDATE:MSISDN

Update the bearer capability (BC) title associated with the


MSISDN.

page 284

UPDATE:PDP

Populate a new PDP context with data, or change an existing


profile.

page 302

UPDATE:SIM

Specify whether SIM is 2G or 3G, or update authentication


parameters or message waiting information.

page 198

UPDATE:SRN

Update service request number (SRN) attributes.

page 292

UPDATE:SUB

Update subscriber attributes in the database.

page 215

Home Location Register (Linux) V1.1 Support Guide

Chapter 10 List of HLR Administration Commands

191

Command

Description

See

UPDATE:ZONELIST

Update the zone code list used for home zone charging.

page 228

VIEW:INFO

Display information about the platform.

page 448

VIEW:MSISDN

Display the attributes of a specified MSISDN.

page 286

VIEW:NETWORK

Display data associated with a network entity.

page 409

VIEW:SRN

Display the Service Access Number (SAN) associated with


the service request number in the database and its Trace
Status.

page 294

VIEW:SUB

Display subscriber attributes in the database.

page 231

WITHDRAW:SS

Remove a supplementary service from a subscriber.

page 320

Home Location Register (Linux) V1.1 Support Guide

192

Chapter 10 List of HLR Administration Commands

Home Location Register (Linux) V1.1 Support Guide

193

Chapter 11

SIM Commands

Subscriber Identity Modules (SIMs) can be one of two types, those for
the second generation (2G) network and those for the third generation
(3G) UMTS network. Authentication works differently in the two
network types, and authentication information for a SIM can be
configured via the administration interface.

Command

Description

Page

ADD:SIM

Adds a SIM to an existing subscription


(see MultiSIM on page 46)

page 194

REMOVE:SIM

Remove a SIM from a MultiSIM


subscription

page 196

UPDATE:SIM

Change the SIM type, SIM identity or


authentication parameters

page 198

Home Location Register (Linux) V1.1 Support Guide

194

Chapter 11 SIM Commands

ADD:SIM
Add a SIM to a MultiSIM subscription (see MultiSIM on page 46). The
added SIM has the same published number (MSISDN) as the existing
subscription.

Syntax
ADD:SIM,IMSI|MSISDN,<key_value>,<new_imsi>,
(<sim_id>);

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether <key_value> is an IMSI or an MSISDN

<key_value>

MSISDN or IMSI that identifies an existing subscription.


The new SIM is added to this existing subscription

<new_imsi>

The IMSI of the new SIM

<sim_id>

Integer from 0 to 9. Specifies the SIM identity of the added SIM. If <sim_id> is not
specified, then the first free ID is used.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 11 SIM Commands

195

Errors
<error_code>

<error_message>

00001

Subscriber IMSI already in use. A new IMSI was specified that is used by an existing
subscriber.

00002

Record not found.

00099

Internal software error.

00127

SIM ID is already in use. The SIM identity specified for the new SIM (an integer from 0
to 9) is used by another SIM in the MultiSIM subscription.

00128

Unable to allocate a new SIM. The new SIM cannot be added. Either the subscription
already has 10 SIMs (the maximum allowed), or the HLR database has run out of
resource.

Example
In this example, an IMSI is successfully added to a subscription:
ADD:SIM,MSISDN,123412341234,123451234512346,3;
GSM HLR - SIM Added
Subscriber IMSI

- 123451234512346

In this example, the MSISDN specified does not exist:


ADD:SIM,MSISDN,123412341233,123451234512347,1;
C1:00002,00005,Subscriber MSISDN not in use;

Home Location Register (Linux) V1.1 Support Guide

196

Chapter 11 SIM Commands

REMOVE:SIM
Remove a SIM from a MultiSIM subscription (see MultiSIM on page 46)
subscription.

Syntax
REMOVE:SIM,<imsi>,(<sim_id>);

Parameters
Parameter

Meaning

<imsi>

IMSI that identifies the SIM to remove

<sim_id>

Integer from 0 to 9. Specifies the SIM identity of the SIM to remove

If <sim_id> is specified, the SIM will be removed only if <sim_id>


matches the one stored in the HLR for the specified <imsi>. If
<sim_id> is not specified, the SIM with the specified <imsi> will be
deleted regardless of its SIM identity.
Note: It is not possible to remove a SIM that is still nominated for any
basic service groups (BSGs).
To remove a SIM that is still nominated, you must first remove its
nominations. It is not, therefore, possible to remove the last SIM in a
subscription, because its nominations cannot be removed.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 11 SIM Commands

197

Errors
<error_code>

<error_message>

00002

Record not found.

00099

Internal software error. An internal error has occurred; escalate to the next line of
support.

00129

<sim_id> does not match IMSI. The SIM identity specified does not match the identity
stored in the HLR for that IMSI.

00131

SIM still has nomination.

Example
This example shows an attempt to remove a SIM, but with the wrong
SIM identity specified:
REMOVE:SIM,123451234512346,1;
C1:00002,00129,SIM ID does not match IMSI;

The SIM is successfully removed without specifying the SIM ID:


REMOVE:SIM,123451234512346;
GSM HLR - SIM Removed
Subscriber IMSI

- (none)

An attempt to remove the last SIM in the subscription fails:


REMOVE:SIM,123451234512345;
C1:00002,00131,Unable to remove nominated SIM;

Home Location Register (Linux) V1.1 Support Guide

198

Chapter 11 SIM Commands

UPDATE:SIM
The UPDATE:SIM command can change the type of a SIM, its SIM
identity (used for MultiSIM subscriptions) and its authentication
attributes.

Syntax
UPDATE:SIM,<imsi>,<attribute>,<value>,
{(<value>)};

Parameters
Parameter

Meaning

<imsi>

IMSI or overlapping IMSI associated with the SIM

<attribute>

Attribute name indicating the SIM type, SIM identity, or an authentication


attribute to change. See the table below.

<value>

Value for <attribute>. See the table below.

Table 19. Authentication Attributes


Attribute

Values

Default

Description

AUTH

NONE or a series of
values that configure
authentication

(mandatory)

NONE disables authentication.


See Authentication Parameters on
page 200 for a description of authentication
parameters.

CS_IND

0 to 15

Circuit switched used to identify


authentication vectors stored on a third
generation SIM (USIM). A USIM can store
up to 16 vectors. This index can be
manually updated to keep sequence
numbers in the correct order if subscriber
data is moved between network entities.

MCEF

TRUE/FALSE

FALSE

Memory Capacity Exceeded Flag.


Indicates whether delivery of a mobile
terminated short message failed because
of lack of capacity in the mobile station
(handset).
no alerts are sent if this flag is set
this flag does not prevent the HLR
returning routing information for a short
message

Home Location Register (Linux) V1.1 Support Guide

Chapter 11 SIM Commands

199

Table 19. Authentication Attributes (Continued)


Attribute

Values

Default

Description

MNRF

TRUE/FALSE

FALSE

Mobile station Not Reachable Flag.


Indicates whether delivery of a non-GPRS
mobile terminated short message failed
because a subscriber was absent.
if this flag is set, the HLR does not
return an MSC address as routing
information
this flag is cleared if the HLR receives
an alert stimulus, so this flag does not
prevent alerts

MNRG

TRUE/FALSE

FALSE

Mobile station Not Reachable for GPRS.


Indicates whether delivery of a GPRS
mobile terminated short message failed
because a subscriber was absent.
if this flag is set, the HLR does not
return an SGSN address as routing
information
this flag is cleared if the HLR receives
an alert stimulus, so this flag does not
prevent alerts

MNRR_GPRS

NO_GSM_PAGE_RESP,
IMSI_DETACHED,
ROAM_RESTRICT,
DEREG_GSM,
MSPURGED_GSM,
NO_GPRS_PAGE_RESP,
GPRS_DETACHED,
DEREG_GPRS,
MSPURGES_GPRS,
UNK_GSM_SUB,
UNK_GPRS_SUB, NONE

NONE

Mobile station not reachable reason for a


GPRS subscriber. Value indicates why the
previous SMS delivery attempt failed. For
the numerical value in the subscriber
database for each reason, see SMS
Absence Reasons on page 623.
NO_GSM_PAGE_RESP - No paging
response via MSC
IMSI_DETACHED - IMSI detached
ROAM_RESTRICT - Roaming restriction
DEREG_GSM - Deregistered in the HLR
for non-GPRS
MSPURGED_GSM - MS purged for
non-GPRS
NO_GPRS_PAGE_RESP - No paging
response via the SGSN
GPRS_DETACHED - GPRS detached
DEREG_GPRS - Deregistered in the HLR
for GPRS
MSPURGES_GPRS - MS purged for
GPRS
UNK_GSM_SUB - Unidentified subscriber
via the MSC
UNK_GPRS_SUB - Unidentified
subscriber via the SGSN
NONE - (not GSM standard)

Home Location Register (Linux) V1.1 Support Guide

200

Chapter 11 SIM Commands

Table 19. Authentication Attributes (Continued)


Attribute

Values

Default

Description

MNRR_GSM

NO_GSM_PAGE_RESP,
IMSI_DETACHED,
ROAM_RESTRICT,
DEREG_GSM,
MSPURGED_GSM,
NO_GPRS_PAGE_RESP,
GPRS_DETACHED,
DEREG_GPRS,
MSPURGES_GPRS,
UNK_GSM_SUB,
UNK_GPRS_SUB, NONE

NONE

Mobile station not reachable reason for a


GSM subscriber. Value indicates why the
previous SMS delivery attempt failed. For
the numerical value in the subscriber
database for each reason, see SMS
Absence Reasons on page 623.
NO_GSM_PAGE_RESP - No paging
response via MSC
IMSI_DETACHED - IMSI detached
ROAM_RESTRICT - Roaming restriction
DEREG_GSM - Deregistered in the HLR
for non-GPRS
MSPURGED_GSM - MS purged for
non-GPRS
NO_GPRS_PAGE_RESP - No paging
response via the SGSN
GPRS_DETACHED - GPRS detached
DEREG_GPRS - Deregistered in the HLR
for GPRS
MSPURGES_GPRS - MS purged for
GPRS
UNK_GSM_SUB - Unknown subscriber via
the MSC
UNK_GPRS_SUB - Unknown subscriber
via the SGSN
NONE - (not GSM standard)

PS_IND

0 to 15

Packet switched index similar to CS_IND.

SIMTYPE

SIM/USIM

SIM

Type of SIM
SIM - second generation (2G) network
USIM - third generation (3G) network

SIMID

0 to 9

(none)

SIM identity of one SIM in a MultiSIM


subscription. A MultiSIM subscription can
have up to 10 SIMs

SQN

0 to 243-1

Sequence number for SIM (2G) or USIM


(3G) subscriber authentication

Authentication
Parameters

The command that specifies authentication parameters for a subscriber


has two forms, depending whether subscriber key encryption (SKE) is
used.
If subscriber key encryption is used, enter:
UPDATE:SIM,<imsi>,AUTH,<algorithm>,<encrypted_ki>
,<encryption_key_identifier>,<integrity_check>,<in
tegrity_key_identifier>;
If SKE is not used, enter:
UPDATE:SIM,<imsi>,AUTH,<algorithm>,<ki>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 11 SIM Commands

Parameter

201

Values

<imsi>

Default

Description

(mandatory)

Subscribers IMSI or
overlapping IMSI.

<algorithm>

1, 2, 3 or NONE

(mandatory)

1 - A38 algorithm, version 1


2 - test algorithm
3 - UMTS algorithm
NONE - removes
authentication from the
subscriber

<ki>

32 character text string


containing characters
0 to 9 and A to F

(mandatory if
SKE not used)

Authentication key.

<encrypted_ki>

32 character text string


containing characters
0 to 9 and A to F

(mandatory if
SKE used)

Encrypted authentication key.

<encryption_key_id
entifier>

0x0000 to 0xFFFF

(mandatory if
SKE used)

Encryption key identifier.

<integrity_check>

0x00000000 to
0xFFFFFFFF

(mandatory if
SKE used)

Integrity checksum.

<integrity_key_ide
ntifier>

0x0000 to 0xFFFF

(mandatory if
SKE used)

Integrity key identifier.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

202

Chapter 11 SIM Commands

Errors
<error_code>

<error_message>

00002

Record not found.

00033

Cannot update authentication algorithm and key separately.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00062

Invalid identifier for encryption key or integrity key .1

00063

Integrity key not held in HLR table. 1

00064

Integrity check algorithm not found for given key. 1

00065

Integrity check failed. 1

00066

Encryption key not held in HLR table. 1

00067

Encryption algorithm not found for given key. 1

00068

Encryption / decryption algorithm internal error.

00099

Internal software error.

00115

Sequence number should be updated to a higher value

00127

SIM ID already in use. The SIM identity specified in the command is already used by
another SIM in the subscription.

00129

SIM ID does not match IMSI.

00131

SIM still has nomination.


1

Only if SKE is operational.

Example
UMTS SIM

To specify a third generation (3G) SIM, enter:


UPDATE:SIM,000001111122222,SIMTYPE,USIM;
GSM PDS - SIM Updated
Subscriber IMSI

SIM Identity

- 000001111122222

To specify a SIM identity, which is used in MultiSIM subscriptions,


enter:
UPDATE:SIM,000001111122222,SIMID,5;
GSM PDS - SIM Updated
Subscriber IMSI

Home Location Register (Linux) V1.1 Support Guide

- 000001111122222

Chapter 11 SIM Commands

Authentication
Information

203

To update authentication information for a subscriber who does not


have subscriber key encryption, enter:
UPDATE:SIM,000001111122222,AUTH,1,0000000000111111
1111222222222233;
GSM PDS - SIM Updated
Subscriber IMSI

- 000001111122222

To update authentication information for a subscriber who has


subscriber key encryption, enter:
UPDATE:SIM,000001111122222,AUTH,1,0000000000111111
1111222222222233,9999,99999999,AAAA;
GSM PDS - SIM Updated
Subscriber IMSI

- 000001111122222

The example below returns an error because the


<integrity_key_identifier> has only 3 digits:
UPDATE:SIM,000001111122222,AUTH,1,0000000000111111
1111222222222233,9999,99999999,ABC;
C1:00007,00007,Invalid parameter value;

Home Location Register (Linux) V1.1 Support Guide

204

Home Location Register (Linux) V1.1 Support Guide

Chapter 11 SIM Commands

205

Chapter 12

Subscriber Commands

Subscriber commands let you change subscriber information in the


HLR database.

Command

Description

Page

AUCUPDATE:SUB

Updates the authentication data in the integrated HLR/AUC


database

page 266

COPY:SUB

Creates a subscriber record using an existing subscriber as a


template

page 208

CREATE:SUB

Creates a subscriber record

page 206

DELETE:SUB

Deletes a subscriber record and all associated records

page 211

LOCK:SUB

This command locks a subscriber record in the database.


This command is for development and is not used in normal
operation

page 213

SET:TRACE

Logs transaction or SS7 events to log files, to the screen (for


real-time tracing), or makes event records available to
off-platform tracing (for TIMON tracing)

page 269

UNLOCK:SUB

This command unlocks a subscriber record in the database.


This command is for development and is not used in normal
operation.

page 214

UPDATE:SUB

Updates subscriber attributes in the database

page 215

UPDATE:ZONELIST

Updates a zone code list for a subscriber

page 228

VIEW:SUB

Displays subscriber attributes in the database

page 231

Home Location Register (Linux) V1.1 Support Guide

206

Chapter 12 Subscriber Commands

CREATE:SUB
The CREATE:SUB command creates a subscriber record in the database.

Syntax
CREATE:SUB,<imsi>,<msisdn>,<bc_title>;

Parameters
Parameter

Meaning

<imsi>

Subscriber IMSI

<msisdn>

Main MSISDN

<bc_title>

Text (up to 16 characters) containing the Bearer Capability title associated with the main
MSISDN

Every MSISDN record must be associated with a <bc_title>. This


name is used to locate a Bearer Capability Allocation in the BCA table.
See Bearer Capabilities (bca) table for details of this table.

MultiSIM
Subscriptions

When a new subscriber is created, the default SIM ID (used to


distinguish SIMs in a MultiSIM subscription) is 0 (zero). See MultiSIM
on page 46 for a description of MultiSIM subscriptions.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

207

Errors
<error_code>

<error_message>

00001

Subscriber IMSI already in use.

00004

Subscriber MSISDN already in use.

00038

Duplicate MSISDN specified.

00046

Incorrect number of MSISDNs specified.

00053

Cannot copy template with PNUM.

00055

Unable to access subscriber record.

00059

BC title not known.

00099

Internal software error.

00116

Unable to allocate resource.

Example
To create a subscriber with a specified IMSI and MSISDN and
associate the main MSISDN with the telephony service (TS11):
CREATE:SUB,111112222233333,11111222223,TS11;
GSM PDS - Subscriber Created
Subscriber IMSI - 111112222233333
Main MSISDN- 11111222223

Home Location Register (Linux) V1.1 Support Guide

208

Chapter 12 Subscriber Commands

COPY:SUB
The COPY:SUB command creates a subscriber record using an existing
subscriber as a template.
Using a template allows you to create a record without having to
specify all the services for each subscriber.

Syntax
COPY:SUB,<template_imsi>,<imsi>,
<main_msisdn>,{<msisdn>};

Parameters
Parameter

Meaning

<template_imsi>

IMSI of the subscriber to be used as a template

<imsi>

IMSI of the new subscriber record

<main_msisdn>

The subscribers main MSISDN

{<msisdn>}

Additional MSISDNs to be added to the record. As many MSISDNs must be


specified as there are in the template subscriber record. A maximum of 4 additional
MSISDNs can be specified. MSISDNs cannot be omitted in the middle of the
MSISDN list. All MSISDNs must be different.

The COPY command must have the same number of MSISDNs as the
template. Additional duplicates must not be specified. MSISDNs can be
added as specified in ADD:MSISDN on page 280.
The new subscribers secondary MSISDNs contain basic services
assigned to the templates secondary MSISDNs, in the same order as
displayed by a VIEW:SUB command.
The COPY command fails if the subscriber template has a bearer
capability title that is not recognised. For example, if a bearer capability
title for the templates <main_msisdn> is removed from the BCA
table.
The COPY command also fails if the subscriber used as a template is a
member of a linked subscription, indicated by the presence of a
published number (PNUM). However, the template is allowed to
contain values for LINKED_TYPE, OWNM_P and DNLD_P, which are
attributes used by a linked subscription.
All PDP contexts are copied, but static addresses in PDP contexts are
not copied. Not all PDP contexts have a static address, but a static
address can be specified using the UPDATE:PDP admin command.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

MultiSIM
subscriptions

209

If the <template_imsi> is any IMSI in a MultiSIM group, the command


will succeed but only the subscription data will be copied, and a new
single IMSI with SIM ID of 0 (zero) is created for the new subscription.
See MultiSIM on page 46 for a description of MultiSIM subscriptions.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00001

Subscriber IMSI already in use.

00004

Subscriber MSISDN already in use.

00038

Duplicate MSISDN specified.

00046

Incorrect number of MSISDNs specified.

00053

Cannot copy template with PNUM.

00055

Unable to access subscriber record.

00059

BC title not known.

00099

Internal software error.

00116

Unable to allocate resource.

Example
To create a subscriber record from an existing subscriber template:
COPY:SUB,123456789012345,123456789012346,
44370123456;
GSM PDS - Subscriber Created from Template
Subscriber IMSI - 123456789012346
Main MSISDN - 44370123456
In this second example, repeating the command fails because the new
IMSI for the subscriber is already in the database.
COPY:SUB,123456789012345,123456789012346,
44370123457;
C1:00002,00001,Subscriber IMSI already in use.
Re-enter the command with the correct value for the IMSI.

Home Location Register (Linux) V1.1 Support Guide

210

Chapter 12 Subscriber Commands

COPY:SUB,123456789012345,123456789012344,
44370123457;
GSM PDS - Subscriber Created from Template
Subscriber IMSI - 123456789012344
Main MSISDN - 44370123456

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

211

DELETE:SUB
The DELETE:SUB command deletes a subscriber record and all
associated records (for example: MSISDN information) from the
database. The IMSI used is either the actual one or the overlapping
IMSI, and the MSISDN may be any allocated to the subscriber. The
IMSI specifies the subscriber to be deleted, the MSISDN is optionally
used as confirmation. The command is rejected if the MSISDN
specified does not belong to the subscriber.
To cancel the subscribers registration on a VLR, this command should
be preceded by an UPDATE:SUB,...,ADMIN,DISABLED; command to
initiate a registration cancellation. See UPDATE:SUB on page 215.

Syntax
DELETE:SUB,<imsi>(,<any_msisdn>);

Parameters
Parameter

Meaning

<imsi>

Subscriber IMSI

<any_msisdn>

Optional field containing one of the subscribers MSISDNs

If a MSISDN parameter is used, the subscriber is disconnected only if


the MSISDN specified matches the IMSI. If there is no match, the
command is rejected.

MultiSIM
Subscriptions

If the <imsi> is part of a MultiSIM subscription, DELETE:SUB deletes all


SIMs that are part of that subscription. See MultiSIM on page 46 for a
description of MultiSIM subscriptions.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

212

Chapter 12 Subscriber Commands

Errors
<error_code>

<error_message>

00002

Record not found.

00007

Subscriber MSISDN/IMSI mismatch.

00055

Unable to access subscriber record.

00099

Internal software error.

Example
To delete a subscriber record:
DELETE:SUB,123456789012346,44370123456;
GSM PDS - Subscriber Deleted
Subscriber IMSI - 123456789012346

DELETE:SUB,123456789012345;
C1:00002,00002,Record not found;
The specified IMSI is not in the database. Re-enter the command with
the correct value for the IMSI.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

213

LOCK:SUB
This command locks a subscriber record in the database. The
subscriber record may be accessed by either IMSI or MSISDN. The
IMSI used may be either the actual or the overlapping IMSI, and the
MSISDN may be any of those allocated to the subscriber.
This command is for development; it is not used in normal operation.

Syntax
LOCK:SUB,IMSI|MSISDN,<key_value>;

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00099

Internal software error.

Example
LOCK:SUB,MSISDN,123412341234;
GSM PDS - Subscriber Locked

Home Location Register (Linux) V1.1 Support Guide

214

Chapter 12 Subscriber Commands

UNLOCK:SUB
This command unlocks a subscriber record in the database. The
subscriber record may be accessed by either IMSI or MSISDN. The
IMSI used may be either the actual or the overlapping IMSI, and the
MSISDN may be any of those allocated to the subscriber.
This command is for development; it is not used in normal operation.

Syntax
UNLOCK:SUB,IMSI|MSISDN,<key_value>;

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00099

Internal software error.

Example
UNLOCK:SUB,MSISDN,123412341234;
GSM PDS - Subscriber Unlocked

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

215

UPDATE:SUB
The UPDATE:SUB command updates subscriber attributes in the
database. Access to the record is by the IMSI (actual or overlapping) or
any MSISDN allocated to the subscriber. If the subscriber is registered
on a VLR or SGSN, the VLR and/or SGSN is also updated. Table 20 list
the attributes.

Syntax
To update a subscriber record, enter:
UPDATE:SUB,IMSI|MSISDN,<key_value>,
<attribute>,<value>;
Enter a separate command for each attribute that you want to update.

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether the <key_value> number, which identifies the subscription, is an IMSI
or MSISDN

<key_value>

IMSI or MSISDN of the subscription

<attribute>

Attribute to be changed (see Table 20)

<value>

New value for the attribute

Table 20. UPDATE:SUB Attribute Values


<attribute>

<value>

Default

Meaning

ADMIN

DISABLED/ENABLED

DISABLED

Administration status.

BADPWDCTR

0 to 3

Counts the number of times that a


subscriber enters the wrong call
barring password.

CATEGORY

PAYPHONE,
NORMAL, PRIORITY,
TEST or V0 to V255

NORMAL

Type of phone.

CFBCP

NOTIFY/NONOTIFY

NONOTIFY

Call forwarding busy calling party.


Whether the calling party is notified
that a call is being diverted.

CFBFP

NOTIFY/NONOTIFY

NONOTIFY

Call forwarding busy forwarding


party. Whether the forwarding party
is notified that a call is being
diverted.

Home Location Register (Linux) V1.1 Support Guide

216

Chapter 12 Subscriber Commands

Table 20. UPDATE:SUB Attribute Values (Continued)


<attribute>

<value>

Default

Meaning

CFNRCCP

NOTIFY/NONOTIFY

NONOTIFY

Call forwarding not reachable


calling party. Whether the calling
party is notified that a call is being
diverted.

CFNRYCP

NOTIFY/NONOTIFY

NONOTIFY

Call forwarding no reply calling


party. Whether the calling party is
notified that a call is being diverted.

CFNRYFP

NOTIFY/NONOTIFY

NONOTIFY

Call forwarding no reply forwarding


party. Whether the forwarding party
is notified that a call is being
diverted.

CFUCP

NOTIFY/NONOTIFY

NONOTIFY

Call forwarding unconditional


calling party. Whether the calling
party is notified that a call is being
diverted.

CNUM_BHVR

0 to 31

Number that selects a type of


forward-to number translation or
barring defined in the C Number
Behaviour table. 0 (zero) indicates
no C number conversion (see C
Number Behaviour Table
(CNUM_BHVR).

CTRL_SS

NO/YES

NO

Flag containing control


supplementary service barring
status which indicates whether the
subscriber can control
supplementary services barring,
using a password procedure. See
also BADPWDCTR.

DNLD_P

PNUM/OWN

EMLPP_PRIORITY

0 to 6

???

The call precedence value at which


an eMLPP subscriber makes calls.
See the description of
EMLPP_DFLT_PRIORITY in the
HLR_CONFIG table for a
description of the values.

GPRS_SUB_RESTR

decimal 0 to 65535 or
hexadecimal 0x0000 to
0xFFFF

Roaming restriction placed on the


GPRS side of a subscription.
Similar to the GSM_SUB_RESTR
attribute

For a member of a linked


subscription, specifies which
number is downloaded to the VLR.
PNUM - published number
downloaded to the VLR
OWN - subscribers own (routing/
member) MSISDN downloaded to
the VLR .

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

217

Table 20. UPDATE:SUB Attribute Values (Continued)


<attribute>

<value>

Default

Meaning

GSM_SUB_RESTR

decimal 0 to 65535 or
hexadecimal 0x0000 to
0xFFFF

Subscription restriction number,


which restricts the use of
subscriber roaming.
GSM_SUB_RESTR accesses the
same bitmask as the obsolete
SUB_RESTR attribute.

GROUP

0 (zero)

0 (zero)

No longer used. Should be 0


(zero).

HOMETICK

0 (or NONE) to 999

Terminating IN Category Key when


in Home network. This replaces
TICK and the associated
supplementary services.
HOMETICK allows the GMSC to
perform specific processing when a
customer receives an incoming
call. If provisioned, the HOMETICK
value is returned in response to an
SRI message.

IMEI

CLEAR and null

null

When set to CLEAR, removes the


IMEI from the VLR.

LINKED_TYPE

ATS/MESS

MSRN_PFX_ID

0 to 16

Number for the MSRN prefix index.


A value of 0 (zero) indicates NONE

MWD_RACE_TIMER

decimal 0 to (232-1)

Number of seconds since 01/01/


1991.

NAM

GSM, GPRS, or
GSM_GPRS

GSM

Network Access Mode.


GSM - subscriber only has access
to standard GSM network and
hence must only register on a VLR/
MSC.
GPRS - subscriber only has access
to the GPRS network and hence
must only register on a SGSN (or
VLR with GPRS capability).
GSM_GPRS - subscriber has
access to both the GSM and GPRS
networks.

Type of linked subscription.


ATS - automotive twin SIM
MESS - mutually exclusive
secondary SIM.

Home Location Register (Linux) V1.1 Support Guide

218

Chapter 12 Subscriber Commands

Table 20. UPDATE:SUB Attribute Values (Continued)


<attribute>

<value>

NO_SVC_UNSUPP_
BH

+{<odb> <odb>...}
-{<odb> <odb>...}
{<odb> <odb>...}
{}
for example,
{<odbaoc> <odbaic>}
bars both outgoing and
incoming calls

Default

Home Location Register (Linux) V1.1 Support Guide

Meaning
Behaviour if the subscriber has
OICK but the VLR does not support
OICK.
This value is also used by the
OCSI_2 CAMEL trigger detection
point. See ADD:CAMEL on
page 332 and UPDATE:CAMEL on
page 375.
<odb> is an operator determined
bar (ODB).
{} removes all bars.
+ adds one bar
- removes one bar
{<odb> <odb>... } replaces any
existing list of bars
The HLR invokes the ODBs if the
subscriber registers on a VLR that
does not support OICK.
See Appendix I, Operator
Determined Bars for descriptions of
ODBs.

Chapter 12 Subscriber Commands

219

Table 20. UPDATE:SUB Attribute Values (Continued)


<attribute>

<value>

Default

Meaning

NOMINATED_SIM

<sim_id>, {(SPEECH)
(SMS) (FAX) (DCICA)
(DCICS) (PADACC)
(DPACK) (UNREST)
(AUXSPEECH)}

(none)

Nominated SIM in a MultiSIM


subscription (see page 46) and the
basic service groups (BSGs)
handled by that SIM.
<sim_id> - SIM identity. Integer
from 0 to 9
If no SIM has the specified
<sim_id>, an error is returned.
<sim_id> is followed by a list of one
or more basic service groups
(BSGs) to be assigned to the SIM:
SPEECH - voice calls
SMS - short messages
FAX - facsimile
DCICA - data circuit (modem)
DCICS - data circuit (synchronous)
PADACC - dedicated PAD access
DPACK - dedicated data packet
UNREST - 12 kbits/s unrestricted
digital
AUXSPEECH - obsolescent
If no basic service groups are
specified, indicated by omitting the
parameter altogether, the SIM is
nominated for all BSGs.
The SIM is nominated for all
specified BSGs regardless of
whether the subscription has those
BSGs, provided the (<sim_id> is
valid). If a BSG is added to a SIM
later, the nomination is applied to
an incoming message for that
BSG.

NOTIFY_CB

TRUE or FALSE

FALSE

Flag to control whether the CAMEL


Service Environment (CSE) is
notified if call barring (CB) data is
changed.
The CSE is notified by a
Notification of Subscriber Data
Change message, which is sent if
call barring data changes. The
entities that receive the message
are defined by the CB_NOTIFY
parameter in the HLR_CONFIG
Table

Home Location Register (Linux) V1.1 Support Guide

220

Chapter 12 Subscriber Commands

Table 20. UPDATE:SUB Attribute Values (Continued)


<attribute>

<value>

Default

Meaning

NOTIFY_CF

TRUE or FALSE

FALSE

Flag to control whether the CAMEL


Service Environment (CSE) is
notified if call forwarding (CF) data
is changed.
The CSE is notified by a
Notification of Subscriber Data
Change message, which is sent if
call forwarding data changes. The
entities that receive the message
are defined by the CF_NOTIFY
parameter in theHLR_CONFIG
Table

NOTIFY_ODB

TRUE or FALSE

FALSE

Flag to control whether the CAMEL


Service Environment (CSE) is
notified if operator determined bar
(ODB) data is changed.
The CSE is notified by a
Notification of Subscriber Data
Change message, which is sent if
operator determined bar data
changes. The entities that receive
the message are defined by the
ODB_NOTIFY parameter in the
HLR_CONFIG Table

OICK

0 to 999

Originating Intelligent Network


Category Key. This value selects
one IN service or a combination of
IN services. 0 (zero) disables
OICK.

OVERRIDE

TRUE/FALSE

FALSE

Controls Calling Line Identification


presentation. Values are TRUE/
FALSE depending on whether the
subscriber is allowed to override
the CLI restriction of an incoming
call.
See CLIP Restriction Override on
page 633.

OWNM_P

PNUM/ OWN

Home Location Register (Linux) V1.1 Support Guide

For a member of a linked


subscription, specifies which
number is returned in response to
an OWN_MSISDN USSD.
PNUM - published number is
returned
OWN - subscribers own (routing/
member) MSISDN is returned
For a member of a mutually
exclusive secondary SIM linked
subscription, OWNM_P should
always have the value PNUM.

Chapter 12 Subscriber Commands

221

Table 20. UPDATE:SUB Attribute Values (Continued)


<attribute>

<value>

Default

Meaning

PAI

OFF or ON

ON

Positioning Allowed Indicator.


Shows whether a subscriber can
use mobile positioning services.
OFF - positioning services not
allowed
ON - positioning services allowed
Both PAI and the Subscriber
Location Privacy Profile (SLPP)
must allow positioning services.
PAI defaults to ON to allow the
Location Enabling Server (LES) to
control privacy. See page 36 for a
description of location based
services.

PAI_CTRL

OFF or ON

ON

Positioning Allowed Indicator


Control Flag. Determines whether
a subscriber can control PAI.
OFF - subscriber not allowed to
control PAI
ON - subscriber allowed to control
PAI

PNUM

MSISDN

PRES_MODE

DEF_ALLOW
DEF_RESTR
PERMANENT

The published number for a linked


subscription.
If NONE is specified, the published
number is removed from the group
member subscriber. (Can also be
done using the REMOVE:PNUM
command).
If a published number value is
supplied, but the subscriber has no
PNUM to update, a PNUM with the
specified value is added to the
subscriber. (Can also be done
using the ADD:PNUM command).
PERMANENT

Presentation mode.
This relates to the Calling Line
Identification Restriction service.
DEF_ALLOW - The subscribers
directory number is displayed by
the called party.
DEF_RESTR - The subscribers
directory number is not displayed
by the called party.
PERMANENT - The subscribers
directory number is permanently
not displayed by the called party.
This status can be changed only
using an administration command,
not from the subscribers handset.
(see Calling Line Identity
Restriction on page 632)

Home Location Register (Linux) V1.1 Support Guide

222

Chapter 12 Subscriber Commands

Table 20. UPDATE:SUB Attribute Values (Continued)


<attribute>

<value>

Default

Meaning

PRIORITY

0 to 255 except for


invalid values 0 to 3,
64 to 67, 128 to 131
and 192 to 195

Value for PRIORITY


supplementary service. Bits 3 to 6
(4 bits in total) of the 8-bit
PRIORITY indicate the priority
(other bits are flags or spare bits)
and must be non-zero. Some
values of PRIORITY are therefore
invalid.

PWD

0000 to 9999

0000

Number for the password.

ROAMTICK

0 (or NONE) to 999

Terminating IN Category Key when


Roamed to another network. This
replaces TICK and the associated
supplementary services.
ROAMTICK allows the GMSC to
perform specific processing when a
customer receives an incoming
call. If provisioned, the ROAMTICK
value is returned in response to an
SRI message.

SPCODE

8 to 10 alphanumeric
characters, usually two
letters followed by six
digits

(no default)

Service Provider code (if available),


which identifies the subscribers
service provider
Service provider details are listed
in the Service Provider (SP) Table.
Services that depend on the
service provider are described in
Service Provider Services on
page 56.

SUBTYPE

0 to 127

Value for SUBTYPE supplementary


service.

SUB_RESTR

decimal 0 to 65535 or
hexadecimal 0x0000 to
0xFFFF

The Subscription Restriction Status


is a bitmask that indicates whether
a subscriber can register in a
geographical location, as a way to
control roaming.
Every VLR or PLMN has a
corresponding bitmask which
indicates its geographical location.
SUB_RESTR has been
superseded by the
GSM_SUB_RESTR attribute, but it
can still be specified.

TICK

0 (or NONE) to 999

Terminating IN Category Key


supplementary service. This has
been replaced by HOMETICK and
ROAMTICK, but is retained for
backward compatibility.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

223

Table 20. UPDATE:SUB Attribute Values (Continued)


<attribute>

<value>

TRACE

0 to 255 or
+<trace_flag> or
-<trace_flag>

TRANSFER_OF_SM

VIA_MSC or
VIA_SGSN

Default

Meaning
Trace flags are SUB_SS7 (for
network which traces all SS7
events)/ SUB_TRAN (for
transaction tracing)/TIMON (for
TiMON tracing)/REALTIME (for real
time tracing), B0, B1, B2 or B3.
See also SET:TRACE on
page 269.

VIA_SGSN

Some gateway MSCs connected to


text messaging centres do not
support GPRS. Therefore, a GMSC
indicates whether it supports
GPRS when requesting routing
information for an SMS message. If
the GMSC does not support
GPRS, the HLR refers to
TRANSFER_OF_SM to decide
how to reroute the short message.
This attribute is used to optimize
speed, cost and reliability of
delivering messages to
subscribers.
VIA_MSC - transfer of SM via MSC
VIA_SGSN - transfer of SM via
SGSN

Home Location Register (Linux) V1.1 Support Guide

224

Chapter 12 Subscriber Commands

Table 20. UPDATE:SUB Attribute Values (Continued)


<attribute>

<value>

Default

Meaning

VMTYPE

NONE, BTCVM,
BTVM, RECALL, UM,
NGVM, BTNOMI, or
GREEN

(none)

The type of Voicemail service for


subscribers. Currently the only
supported values are BTCVM (BT
Converged Voicemail), NGVM, and
NONE (indicating that the
subscriber doers not have
voicemail). Setting it to any other
value is similar to setting it to
NONE (although it indicates that
the subscriber does have
voicemail, and so will affect the
response of the HLR to certain
messages).
If the VMTYPE attribute is
specified, the command can take
the additional, optional, parameter,
<diverts>. This can take the
following values:
ALLDIVS
Clears any existing diverts before
enabling the diverts specified in the
voicemail table for this vmtype.
NODIVS
No existing diverts are changed.
RECALLDIVS
Existing diverts that have RECALL
behaviour, or GSM behaviour and
match the mailbox number
returned in an MLR Lookup
request, are modified: they are
cleared if a new divert format is
defined in the voicemail table.
Otherwise the divert is set to the
new FTN.
For example:
UPDATE:SUB,MSISDN,
44375453264,VMTYPE,NGVM,
ALLDIVS;

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

225

Errors
<error_code>

<error_message>

00002

Record not found.

00024

Unexpected data value error.

00044

Unable to add P number.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

00114

Configurable CAMEL GSMSCF GT unavailable.

00132

SIM ID not in use.

00155

Emlpp default priority greater than maximum


allowed.

00172

MSISDN has no country code.

00173

ISDN cannot be formatted.

Example
Migrating Linked
Subscriptions

Migrate a subscriber from a mutually exclusive secondary SIM (MESS)


linked subscription to an automotive twin SIM (ATS) linked subscription
as follows:
UPDATE:SUB,IMSI|MSISDN,<key_value>,LINKED_TYPE,ATS;

The HLR removes the MESS subscriptions IN bar, if any, thereby


allowing the subscriber to make outgoing calls.
An ATS subscriber can be migrated to a MESS linked subscription in a
similar way. However, because the HLR applies IN bars to members of
a MESS linked subscription, disable ATS members before migrating as
follows:
UPDATE:SUB,IMSI|MSISDN,<key_value>,ADMIN,DISABLED;

Providing and
Withdrawing
CAMEL

Provide CAMEL (Customized Applications for Mobile network


Enhanced Logic) services using the ADD:CAMEL, REMOVE:CAMEL
and UPDATE:CAMEL commands.
For backward compatibility, CAMEL services can be provided and
removed using a series of UPDATE:SUB commands, as described
below. However, ADD:CAMEL, REMOVE:CAMEL and
UPDATE:CAMEL commands should be used instead.

Home Location Register (Linux) V1.1 Support Guide

226

Provisioning
OICK

Chapter 12 Subscriber Commands

This example provisions a subscriber with OICK. If CAMEL is not


supported, the OICK service has an associated unsupported behaviour
which invokes an operator determined bar to prevent the subscriber
from originating calls (see Appendix I, Operator Determined Bars).
UPDATE:SUB,IMSI,<imsi>,OICK,3;
UPDATE:SUB,IMSI,<imsi>,NO_SVC_UNSUPP_BH,+ODBAOC;

Changing a
MultiSIM
Subscription

A MultiSIM subscription has up to 10 SIMs assigned to the same


MSISDN, with the option of assigning particular basic service groups
(BSGs) to each SIM. The general form of the command to assign BSGs
to nominated SIMs is:
UPDATE:SUB,IMSI|MSISDN,<key_value>,NOMSIM,
<sim_id>,{(SPEECH) (SMS) (FAX) (DCICA) (DCICS)
(PADACC) (DPACK) (UNREST) (AUXSPEECH)};
If no basic service groups are specified, that is, the braces are empty,
all basic service groups are assigned to the SIM.
This example assigns speech calls and SMS messages to SIM 0 and
all other BSGs to SIM1:
UPDATE:SUB,IMSI|MSISDN,<key_value>,NOMSIM,0,
{SPEECH SMS};
UPDATE:SUB,IMSI|MSISDN,<key_value>,NOMSIM,0,
{FAX DCICA DCICS PADACC DPACK UNREST AUXSPEECH};
This example assigns all basic service groups to SIM 0:
UPDATE:SUB,IMSI|MSISDN,<key_value>,NOMSIM,0,{};

Tracing

This turns off the TRACE attribute for a subscriber:


UPDATE:SUB,IMSI,123456789012345,TRACE,0;
GSM PDS - Subscriber Updated
Subscriber IMSI - 123456789012345
123456789012345

= Subscriber IMSI

In this example the specified IMSI is not in the database:


UPDATE:SUB,IMSI,123456789012344,TRACE,0;
C1:00002,00002,Record not found;
123456789012344

= Subscriber IMSI

Re-enter the command with the correct value for the IMSI.

Changing
Voicemail
configuration

The following are examples of commands used to change a


subscribers voicemail configuration:
UPDATE:SUB,MSISDN,44375453264,VMTYPE,NGVM;

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

227

UPDATE:SUB,MSISDN,44375453264,VMTYPE,NGVM,ALLDIVS;
UPDATE:SUB,MSISDN,44375453264,VMTYPE,NGVM,NODIVS;
UPDATE:SUB,MSISDN,44375453264,VMTYPE,NGVM,
RECALLDIVS;

Home Location Register (Linux) V1.1 Support Guide

228

Chapter 12 Subscriber Commands

UPDATE:ZONELIST
The UPDATE:ZONELIST command updates a zone code list for a
subscriber.
A zone code list completely replaces any existing list for the specified
CC-NDC combination. If no zone code is specified, the zone code list is
removed.

Syntax
UPDATE:ZONELIST,IMSI|MSISDN,<key_value>,<cc_ndc>
(,<zc>) (,<zc>)(,<zc>)(,<zc>)(,<zc>)(,<zc>)(,<zc>)
(,<zc>) (,<zc>)(,<zc>);

Parameters
Parameter

Description

IMSI|MSISDN

Indicates whether <key_value> used to locate subscriber record is an IMSI or an


MSISDN.

<key_value>

Numeric field containing either the subscriber IMSI, overlapping IMSI or MSISDN.

<cc_ndc>

Numeric field containing a country code (2 or 3 digits) and national destination number
(usually 3 or 4 digits). VLRs and SGSNs with a CC and NDC that match <cc_ndc>
contain the zones identified by zone codes.

<zc>

Numeric field. Optional zone code of 0 to 65535. The zone code identifies a
geographical area within the area covered by VLRs and SGSNs that have the CC and
NDC combination defined by <cc_ndc>. Zone code values and how they are used are
defined by the network operator.

Adding a Zone
Code List

If at least one zone code is specified for a CC-NDC combination, and


the subscriber does not already have a zone code list for that CC-NDC
combination, then a zone code list is added.
Provided that the subscriber does not already have the maximum
number of zone code lists, the list is stored against the subscriber.

Removing a
Zone Code List

If a CC-NDC combination is specified without any zone codes, the list


for the CC-NDC combination is removed.
Even if the subscriber does not have a list for the specified CC-NDC
combination, the removal is considered successful and an error is not
returned.

Replacing a Zone
Code List

If at least one zone code is specified for a CC-NDC combination the


subscriber already has, then that zone code list is completely replaced
by the new zone codes.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

229

Note: The result of adding, removing or updating a zone code list is


compared with the data in the VLR/SGSN where the subscriber is
registered. If the two differ, changes to the subscriber data are
downloaded to the VLR/SGSN.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found.

00022

Duplicate zone codes specified.

00029

Subscriber has maximum zone lists.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download


failed.

00099

Internal software error.

00116

Unable to allocate resource.

Example
This is an example of adding zone code 100 for the 44 1635 country
code plus area code combination.
UPDATE:ZONELIST,IMSI,123451234512345,441635,100;
GSM HLR - Zone list added/ updated/ removed
MSISDN

- 123412341234

This example shows that one subscriber cannot be given a zone code
list for more than one country code plus area code combination.
UPDATE:ZONELIST,IMSI,123451234512345,441793,200;
C1:00002,00029,Subscriber has maximum zone lists;

Home Location Register (Linux) V1.1 Support Guide

230

Chapter 12 Subscriber Commands

This example shows that the same zone code cannot be specified
twice.
UPDATE:ZONELIST,IMSI,123451234512345,441635,100,
100;
C1:00002,00022,Duplicate zone codes specified;

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

231

VIEW:SUB
The VIEW:SUB command displays subscriber attributes in the database.
Access to the record is by the IMSI (actual or overlapping) or any
MSISDN allocated to the subscriber.

Syntax
VIEW:SUB,IMSI|MSISDN,<key_value>,
(ENQUIRE|NOENQUIRE);

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether the <key_value> number, which identifies the subscription, is an


IMSI or MSISDN

<key_value>

Number of the subscriber IMSI or MSISDN

ENQUIRE

Request subscriber data from the MLR (if the subscriber has RECALL SS), and VLR (if
the subscriber has a circuit switched (CS) location).

NOENQUIRE

Do not request subscriber data from the MLR or VLR

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;
C2 responses are grouped by the kind of data they contain and are
listed in the table below.
Code

Parameters

C2:00010

,<imsi> ,(<pend_imsi>) ,(<exptime>) ,<MCEF> ,<MNRF> ,<MNRG> ,<MNRR_GSM>


,<MNRR_GPRS> ,<SIM_Type> ,<SIM_ID> ,<NOM_BSG> ,<sequence_number> ,<IMEISV>
,<source> ,<CS-Current>,<PS-Current> ,<recache> ,<time>;

C2:00012

<CFUCP> ,<CFBCP> ,<CFNRYCP> ,<pres_mode> ,<CFNRCCP> ,<CFBFP> ,<CFNRYFP>


,<override> ,<SS_prov> ,<ODB> , ,<PRIORITY> ,<SUBTYPE>;

C2:00013

,<locked> ,<admin> ,<group> ,<ctrl_SS_bar> ,<GSM_sub_restr> ,<MS_Cat> ,<trace>


,<MSRN_pfx_id> ,<bad_pw_cnt> ,<pword> ,<serv_cen_count> ,<Service_Provider_Code> , ,
,<NAM> ,<GPRS_sub_restr> ,<PAI> ,<PAI_ctrl> ,<transfer_of_sm> ,<cnum_behaviour>
,<notify_cf> ,<notify_odb> ,<notify_cb> ,<encryption> ,<acr> ,<sdm_dest> ,<MWD Race
Timer> ,<emlpp max> ,<emlpp default>,<vmtype>;

C2:00014

,<MLR_GT> ,<MLR_name> ,<MBX>;

C2:00015

,<msisdn> ,<BC_title> ,(<BS>) ,(<BSG>);

C2:00016

,<basic_services>;

Home Location Register (Linux) V1.1 Support Guide

232

Chapter 12 Subscriber Commands

Code

Parameters

C2:00017

,<BSG_mask> ,<Reg_mask> ,<Act_mask> ,<QHLR_mask> ,(<CFNRy_FTN>)


,(<CFNRC_FTN>) ,(<CFB_FTN>) ,(<CFU_FTN>) ,(<CFNRy_behaviour>)
,(<CFNRc_behaviour>) ,(<CFB_behaviour>) ,(<CFU_behaviour>) ,(<CFNRy_timer>)
,(<CFNRy_se_flags>) ,
(<CFNRc_se_flags>) ,(<CFB_se_flags>) ,(<CFU_se_flags>);

C2:00019

,(<last_caller>) ,<action> ,<call_time> ,(<CLI_status>) ,(<BS_used>) ,(<SIM_ID>)


,(<Pres_Num>) ,(<Pres_num_status>),(<Erasure_Flag>);

C2:00023

,(<P_num> ,<linked_type> ,<ownm_p> ,<dnld_p>);

C2:00028

<IMSI_or_MSISDN>,<IMSI> or <SIM>

C2:00029

,<Context_id> ,<PDP_state> ,<PDP_type> ,<apn> ,(<static_address>) ,<QoS> ,<Free_APN>


,<VPLMN_allowed> ,<ExtQoS> ,<Charging_Char>;

C2:00030

,<ccndc> ,<zone_code> ,(<zone_code>) ,(<zone_code>) ,(<zone_code>) ,(<zone_code>)


,(<zone_code>) ,(<zone_code>) ,(<zone_code>) ,(<zone_code>) ,(<zone_code>);

C2:00031

,<timer_timestamp> ,<timer_action>;

C2:00039

,<dest_num_1> ,<dest_num_2> ,<dest_num_3> ,<dest_num_4> ,<dest_num_5>


,<dest_num_6> ,<dest_num_7> ,<dest_num_8> ,<dest_num_9> ,<dest_num_10>
,<dest_num_len_1> ,<dest_num_len_2> ,<dest_num_len_3>;

C2:00040

,<locstat> ,<location_operation> ,<acttime> ,<imsi> ,<flavour> ,<entity_title>


,<entity_timezone> ,<entity_flags> ,<Map_version> ,(<EMAP>) ,(<Unsupp_ODB>)
,(<Unsupp_SS>) ,(<Unsupp_BS>) ,(<p1>) ,(<p2>) ,(<p3>) ,(<p4>) ,(<p5>) ,(<p6>) ,(<p7>)
,<Unsupp_pos> ,(<downloaded_CCHs>) ,<CSI_TDPs_in_use> ,(<Unsupp_serv>)
,(<gprs_esi>);

C2:00042

,<PSI_status> ,<PSI_VLR> ,<PSI_loc_number> ,<PSI_loc_age> ,<PSI_cell_or_sai_id>


,<PSI_lai> ,<PSI_geographic> ,<PSI_sub_state> ,<PSI_nr_reason> ,<PSI_selected_LSA>
,<PSI_MSC> ,<PSI_geodetic> ,<PSI_current_loc> ,<PSI_SAI_present>;

C2:00043

,<OICK> ,<no_svc_unsupp_bh>,<Hometick>,<Roamtick>;

C2:00044

,<CSI_TDP> ,<CAMEL_key> ,<GSMSCF> ,<default_call_handling>


,<lower_CAMEL_unsupp_bh> , ,<CCH> ,<TIF_CSI> ,<match_type> , , , , , , , , , , , ,
,<no_svc_unsupp_bh> ,<o_cause_val> ,<basic_service_criteria> ,<call_type> ,<CSI_active>
,<CSE_notify>;

C2:00045

,<CSI_TDP> ,<CAMEL_key> ,<GSMSCF> ,<default_sh> ,<lower_CAMEL_unsupp_bh>


,<no_svc_unsupp_bh> ,<CCH> ,<CSI_active> ,<CSE_notify>;

C2:00046

,<CSI_TDP> ,<CAMEL_key> ,<GSMSCF> ,<default_smsh> ,<lower_CAMEL_unsupp_bh>


,<no_svc_unsupp_bh> ,<CCH> ,<CSI_active> ,<CSE_notify>;

C2:00047

,<CSI_TDP> ,<CAMEL_key> ,<GSMSCF> ,<default_ch> ,<lower_CAMEL_unsupp_bh>


,<no_svc_unsupp_bh> ,<CCH> ,<CSI_active> ,<CSE_notify> ,<t_cause_val>
,<basic_service> <PSI_LOC_INTER>;

C2:00048

,<instance> ,<DN> ,<CAMEL_key> ,<GSMSCF> ,<default_ch> ,<lower_CAMEL_unsupp_bh>


,<no_svc_unsupp_bh> ,<CCH> ,<CSI_active> ,<CSE_notify>;

C2:00049

,<CSI_TDP> ,<CAMEL_key> ,<GSMSCF> ,<default_ch> ,<lower_CAMEL_unsupp_bh>


,<no_svc_unsupp_bh> ,<CCH> ,<CSI_active> ,<CSE_notify> ,<vt_cause_val>
,<basic_service>;

C2:00050

,<mobility_triggers> ,<CAMEL_key> ,<GSMSCF> ,<lower_CAMEL_unsupp_bh>


,<no_svc_unsupp_bh> ,<CCH> ,<CSI_active> ,<CSE_notify>;

C2:00051

,<SS_list> ,<GSMSCF> ,<lower_CAMEL_unsupp_bh> ,<no_svc_unsupp_bh> ,<CCH>


,<CSI_active> ,<CSE_notify>;

C2:00052

,<uGSMscf> ,<ussd_code> ,<uGSMscf> ,<ussd_code> <uGSMscf> ,<ussd_code>


,<uGSMscf> ,<ussd_code> ,<uGSMscf> ,<ussd_code>;

The C2:00014 response is not be sent if the subscriber does not have
Voicemail provisioned.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

233

If Voicemail is provisioned, but the service fails because the SAP did
not return an MLR name for an MSISDN, a C2:00014,,,; response is
returned, which has all parameter positions empty.
If Voicemail is provisioned but the response from the SAP or MLR
indicates no mailbox, the response is
C2:00014,<mlr_gt>,<mlr_name>,;.
<mlr_name> is looked up in the Network Entity (NETENT) Table using
<mlr_gt>. <mlr_gt> is the global title of the SAP in some no-mailbox

cases.
Multiple C2:00015 messages might be returned because one message
is required per MSISDN associated with the subscriber. The first
MSISDN specified is the main MSISDN.
Multiple C2:00029 messages might be returned because one message
is required per PDP associated with the subscriber.
The C2:00017 response will be returned only if the subscriber has at
least one supplementary service provisioned.
Zero or more C2:00040 responses are returned, one for each IMSI in
the subscription, and each is optionally paired with a C2:00042
response, which gives more information about the location in the
C2:00040 response.
The CAMEL responses C2:00044, C2:00045, C2:00046, C2:00047,
C2:00048, C2:00049, C2:00050 and C2:00051 are returned only if the
subscriber has CAMEL data.
Table 21 lists the Response Parameters.
Table 21. VIEW:SUB Response Parameters
Parameter

Values

Default

Meaning

ACR

CLEAR or SET

CLEAR

Anonymous Call Reject. If SET, all


calls that withold the CLI are rejected.

ACT MASK

0x0000 to 0xFFFF

Number (4 digit hex) prefixed by 0x


representing the supplementary
services which are active

ACT TIME

valid time

Time of the last registration attempt in


format dd-mmm-yyyy hh:mm:ss

ACTION
ADMIN
APN

Action taken for last call, for example:


CFU_RECALL
DISABLED/ENABLED

DISABLED

Administration status.
Access Point Name. Octet string
(2..63 octets). A label that follows DNS
naming conventions and identifies the
point where a GPRS call connects to
an external packet data network.

Home Location Register (Linux) V1.1 Support Guide

234

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

BADPWDCTR

0 to 3

Default

BASIC SERVICES

BASIC_SERVICE

Meaning
Counts the number of times that a
subscriber enters the wrong call
barring password.
Text for each basic service indicating
whether or not the service has been
subscribed to

{<basic_service>
<basic_service>...}

Basic service criteria for the OCSI_2


CAMEL trigger detection point (see
page 377).
Requires a maximum CCH of 2 or
higher.
This attribute is a set of up to 5 basic
services, with each one separated by
a space. The set is enclosed in
braces.
The five basic service codes are all
different.

BC TITLE

Text for BC data for MSISDN in BCA


table

BS

Basic service to be used for a call for


the specified MSISDN

BS USED

any basic service

Basic service used for last incoming


call as a text string (for example:
TS11). See Appendix E, Basic and
Supplementary Services for details of
these services

BSG

Basic Service Group to which the


specified service belongs

BSG MASK

Number (3 digit hex) prefixed by 0x


representing a bit mask of the Basic
Service Group to which the
subsequent supplementary services
information applies

CALL TIME

Time of last incoming call with the


format: dd-mmm-yyyy hh:mm:ss

CALL_TYPE

FORWARDED
NOTFORWARDED
NONE

Home Location Register (Linux) V1.1 Support Guide

Requires a max. CCH of 2 or higher.


Identifies whether the call must be a
forwarded call.
NONE removes CALL_TYPE criteria
data from the subscriber.

Chapter 12 Subscriber Commands

235

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

CAMEL_DEF_CH

CONTINUE/RELEASE

Default call handling parameter.


Default call handling depends on the
IN services the subscriber has. If any
one service identifies that the call
should be released, then the default
call handling value will be RELEASE,
otherwise it will be CONTINUE.
Default call handling for each CAMEL
subscription information type is
administered using the ADD:CAMEL
and UPDATE:CAMEL commands.

CAMEL_GSMSCF_GT

a global title or DEFAULT

Global title of the network entity that


controls the CAMEL service or
DEFAULT, which selects the default
global title defined in the
HLR_CONFIG table.
The global title for each CAMEL
subscription information type is
administered using the ADD:CAMEL
and UPDATE:CAMEL commands.

CATEGORY

PAYPHONE, NORMAL,
PRIORITY, TEST or V0 to
V255

Type of phone.

CCH

Three integers separated


by hyphens:
minimum-maximumthreshold
where
minimum-maximumthreshold are CAMEL
phases

Depends on
the CAMEL
trigger
detection
point.
For OCSI_2,
default is:
1-1-3

CAMEL capability handling defined as


a list of 3 values, separated by
hyphens. The list has the format:
minimum-threshold-maximum
The list is optional, but if the list is
present, all values must be specified.
CCH determines how the HLR
downloads a TDP and which bars will
be invoked at each possible download
phase. See Figure 6 on page 23 for
the effect of CCH on CAMEL services.
minimum: CAMEL phase at which the
TDP was introduced according to
MAP specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL
data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

CC_NDC

2 digit CC and usually 3


or 4 digit NDC. For
example 447785

None.

Country Code (CC) and National


Destination Code (NDC). Compared
with the global title of a VLR or SGSN
to identify a region for home zone
charging (see page 33). One
CC_NDC is the unique key to a zone
code list.

Default

Meaning

Home Location Register (Linux) V1.1 Support Guide

236

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

CFB FTN

Meaning
Optional number, containing
forward-to number to be used in the
case of number busy. Field is omitted
if subscriber has no CFB forward-to
number registered

CFBCP

NOTIFY/NONOTIFY

Call forwarding busy calling party.


Whether the calling party is notified
that a call is being diverted.

CFBFP

NOTIFY/NONOTIFY

Call forwarding busy forwarding party.


Whether the forwarding party is
notified that a call is being diverted.

CFNRC FTN

CFNRCCP

Optional number, containing


forward-to number to be used in the
case of number not reachable. Field is
omitted if subscriber has no CFNRC
forward-to number registered.
NOTIFY/NONOTIFY

Call forwarding not reachable calling


party. Whether the calling party is
notified that a call is being diverted.

CFNRY BEHAVIOUR/
CFNRC BEHAVIOUR/CFB
BEHAVIOUR/
CFU BEHAVIOUR

Code indicating the behaviour for the


corresponding call forward (for
example: GSM, RECALL, SMSB, SE).
See Forward-To Number Behaviour
Modes on page 8.

CFNRY FTN

Optional number, containing the


forward-to number to be used in the
case of no reply. Field is omitted if
subscriber has no CFNRY forward-to
number registered.

CFNRYCP

NOTIFY/NONOTIFY

Call forwarding no reply calling party.


Whether the calling party is notified
that a call is being diverted.

CFNRYFP

NOTIFY/NONOTIFY

Call forwarding no reply forwarding


party. Whether the forwarding party is
notified that a call is being diverted.

CFNRY TIMER

Number containing CFNRY timer


value. Present if supplementary
service CFNRY is provisioned.

CFU FTN

Optional number, containing


forward-to number to be used in
unconditional circumstances. Field is
omitted if subscriber has no CFU
forward-to number registered

CFUCP

NOTIFY/NONOTIFY

Home Location Register (Linux) V1.1 Support Guide

Call forwarding unconditional calling


party. Whether the calling party is
notified that a call is being diverted.

Chapter 12 Subscriber Commands

237

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning
Text indicating charging
characteristics (HOT_BILLING,
PREPAID, FLAT_RATE or NORMAL).
Space-delimited set enclosed in
braces {}.

CHARGING

CLI STATUS

NOT_RESTRICTED,
RESTRICTED,
NOT_PRESENT or
NOT_CONTROLLABLE

CNUM_BHVR

0 to 31

Number that selects a type of


forward-to number translation or
barring defined in the C Number
Behaviour table. 0 (zero) indicates no
C number conversion (see C Number
Behaviour Table (CNUM_BHVR).

CS-CURRENT

TRUE or FALSE

FALSE

Depicts if the last UPL/CS-PSI


message contained a valid IMEI-SV.

CSI_ACTIVE

TRUE or FALSE

TRUE

Not used by the HLR..

CSI_NOTIFY

TRUE or FALSE

FALSE

Flag to control whether the CAMEL


Service Environment (CSE) is notified
if CAMEL subscription information
(CSI) is changed.
The CSE is notified by a Notification of
Subscriber Data Change message,
which is sent if CAMEL subscription
information changes. The entities that
receive the message are defined by
the CSI_NOTIFY parameter in the
SCCP_CONFIG Table.
Not used by the HLR.
Many CAMEL services ignore this
parameter.

Calling Line Identity Status of the last


caller.
This relates to the Calling Line
Identification Restriction service.
NOT_RESTRICTED - The callers
directory number is displayed by
the called party.
RESTRICTED - The callers
directory number was deliberately
withheld from the called party.
NOT_PRESENT - The caller does
not have the Calling Line Identity
Restriction service.
NOT_CONTROLLABLE - The
Calling Line Identity was not
available because the call was from
a PABX or otherwise connected by
network equipment unable to
provide the callers directory
number.
See Calling Line Identity Restriction
on page 632.

Home Location Register (Linux) V1.1 Support Guide

238

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

CSI_TDP

call_typeCSI_n
where:
calltype is, for example O
for outgoing calls or
GPRS for GPRS calls
and n is the trigger
detection point number.

None

CAMEL services are provided for


various call types (for example,
outgoing, GPRS, mobile originated
SMS) and a CAMEL service is
invoked by a particular trigger within
that call type.

CSI_TDPs_in_use

hexadecimal number

Indicates which CSI_TDPs are in use

CTRL_SS

NO/YES

Flag containing control supplementary


service barring status which indicates
whether the subscriber can control
supplementary services barring, using
a password procedure. See also
BADPWDCTR.

DB_LOCK

FREE/LOCKED

Locked flag.

DEFAULT_CH

Text field. CONTINUE or


RELEASE

Identifies whether a call will continue


or be released if an error occurs
during call setup.
Calls can be allowed to continue or
stopped, depending on subscriber
type, such as whether a subscriber is
pre-pay or contract.

DEFAULT_SH

Text field. CONTINUE or


RELEASE

None.
Mandatory
Field

Identifies whether a GPRS session


will continue or be released if an error
occurs during setup.
Sessions can be allowed to continue
or stopped, depending on subscriber
type, such as whether a subscriber is
pre-pay or contract.

DEFAULT_SMSH

Text field. CONTINUE or


RELEASE

None.
Mandatory
Field

Identifies whether an SMS message


will continue or be released if an error
occurs.
Messages can be allowed to continue
or stopped, depending on subscriber
type, such as whether a subscriber is
pre-pay or contract.

DEST_NUM

Comma separated list of


10 destination numbers
or NONE

DEST_NUM_LEN

Comma separated list of


three destination number
lengths or NONE

DN

ISDN number

Numeric fields. A CAMEL enquiry may


be initiated if a called number prefix
matches a specified DEST_NUM.
NONE means there is no destination
number at that position in the list.
First entry
must be
specified

Home Location Register (Linux) V1.1 Support Guide

Numeric fields. A CAMEL enquiry may


be initiated if the length of a called
number matches a specified
DEST_NUM_LEN. NONE means
there is no destination number length
at that position in the list.
Dialled number for dialled subscribed
service. A CAMEL service is invoked if
this number is dialled.

Chapter 12 Subscriber Commands

239

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

DNLD_P

PNUM/OWN

For a member of a linked subscription,


specifies which number is downloaded
to the VLR.
PNUM - published number
downloaded to the VLR
OWN - subscribers own (routing/
member) MSISDN downloaded to the
VLR .

DOWNLOADED CCHs

Text

List of the CAMEL call handling


capability (CCH) values downloaded
for each trigger detection point
(CSI_TDP).

EMAP IN USE

YES/NO

Whether the network entity on which


the subscriber attempted to register
has agreed to use EMAP by using it at
registration time.

EMLPP DEFAULT

0 to 6

None

The default call precedence value at


which an eMLPP subscriber makes
calls.

EMLPP MAX

0 to 6

None

The maximum call precedence value


at which an eMLPP subscriber can
use to make priority calls.

ENTITY FLAGS

0x00 to 0xFF

Optional field containing 8


hexadecimal numbers with a bit for
each VMSC/SGSN attribute

ENTITY TIMEZONE

Number indicating the time zone of the


VLR or SGSN

ENTITY TITLE

valid global title

ERASURE_FLAG

TRUE or FALSE

EXPTIME

time in format:
dd-mmm-yyyy hh:mm:ss

Meaning

Optional number field containing the


global title of the VLR or SGSN
FALSE

Optional text field. Indicates whether


the subscriber has sent a request to
erase the last caller number.
Optional time of expiry for pending
IMSI.

Home Location Register (Linux) V1.1 Support Guide

240

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning
13 numbers, separated by hyphens,
each representing an extended quality
of service (QoS) parameter. It has the
format:
a-b-c-d-e-f-g-h-i-j-k-l-m
a to m are integers in the range 0 to
the following maximum values:
a=255; b=7; c=3; d=7; e=255; f=255;
g=255; h=15; i=15; j=63; k=3; l=255;
m=255
a=allocation/retention priority; b=
traffic class; c=delivery order;
d=delivery of erroneous SDU;
e=maximum SDU size; f=max bit rate
for uplink; g=max bit rate for downlink;
h=residual BER; i=SDU error ratio;
j=transfer delay; k=traffic handling
priority; l=guaranteed bit rate for
uplink; m=guaranteed bit rate for
downlink.

EXT_QOS

FLAVOUR

GSM or GPRS

Text field indicating the type of


location.

FREE_APN

TRUE or FALSE

Text field that indicates whether this


PDP context is free or chargeable

GPRS_ESI

YES or NO

None

GPRS Enhancement Support


Indicator

GPRS_SUB_RESTR

Roaming restriction placed on the


GPRS side of a subscription. Similar
to the GSM_SUB_RESTR attribute

GPRS UnsupportedSS

Bitmask similar to the GSM UNSUPP


SS bitmask. Currently, GPRS does
not support any supplementary
services.

GPRS UnsupportedODB

Bitmask (as for GSM). Unsupported


Operator Determined Bars. GPRS
supports seven ODBs:
BAOC, BOIC, BOICXHC, HPLMN1,
HPLMN2, HPLMN3, HPLMN4

GPRS UnsupportedBS

Bitmask similar to the GSM UNSUPP


BS bitmask. Most basic services and
teleservices are unsupported by
GPRS. However, the bit for TS22
could be set if the SGSN does not
support MO SMS.

GROUP

0 (zero)

GSMSCF_ADDR

A valid global title or the


reserved word DEFAULT.

0 (zero)

Home Location Register (Linux) V1.1 Support Guide

No longer used. Should be 0 (zero).


Numeric field containing the global
title of network entity (a SEP in the
Vodafone UK network) that invokes
CAMEL service logic.

Chapter 12 Subscriber Commands

241

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

GPRS_SUB_RESTR

decimal 0 to 65535 or
hexadecimal 0x0000 to
0xFFFF

Roaming restriction placed on the


GPRS side of a subscription. Similar
to the GSM_SUB_RESTR attribute

GSM_SUB_RESTR

decimal 0 to 65535 or
hexadecimal 0x0000 to
0xFFFF

Subscription restriction number, which


restricts the use of subscriber
roaming.

HOMETICK

Terminating IN Category Key when in


Home network. This replaces TICK
and the associated supplementary
services.
HOMETICK allows the GMSC to
perform specific processing when a
customer receives an incoming call. If
provisioned, the HOMETICK value is
returned in response to an SRI
message.

IMEISV

version number

IMEI software version.

IMSI

valid IMSI

Number for the IMSI

IMSI_or_MSISDN

IMSI or MSISDN

Indicates whether the following value


is an IMSI or an MSISDN

INSTANCE

1, 2 or 3

Applies to D-CSI only (see page 345).


Indicates the instance of D-CSI.

LAST CALLER

LC_UNSUPP_BH

Number containing the Calling Line


Identity (CLI) presented by the Send
Routing Information (SRI) of the last
incoming call.
None

{<odb> <odb>...}
for example, {<odbaoc>
<odbaic>} bars all
outgoing and incoming
calls

LINKED_TYPE

LMSID

ATS or MESS

Service bars to be invoked if the


subscriber has CAMEL services for
outgoing calls and the VLR on which
registration is attempted supports
CAMEL at a lower phase than
required.
{<odb> <odb>...} is a list of operator
determined bars, each separated by a
space. See Appendix I, Operator
Determined Bars.
Type of linked subscription.
ATS - automotive twin SIM
MESS - mutually exclusive
secondary SIM..
Optional number (8 digit hex)
containing the local mobile station id

Home Location Register (Linux) V1.1 Support Guide

242

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

LOCATION OPERATION

ADM, DSD, ISD, NMS,


PMS, RSD, SNP, UPL

Default

Meaning
Name of the operation that set the
current location status.:
ADM - admin. process
DSD - delete subscriber data
ISD - insert subscriber data
NMS - note MS present
PMS - purge MS
RSD - restore data
SNP - send parameters
UPL - update location /update
location GPRS

LOCSTAT

Location status for the subscriber


which is one of the following:
ABANDONED
AC_CONFLICT
ADMIN_CHANGED
ADMIN_DISABLED
BLACK_LISTED
DECSS7_SENDF
INVALID
ISD_DSD_FAIL
PURGED
REGISTERED
REGISTERED?
ROAM_ODB
ROAM_STOPPED
RR_UNSUPFEATURE
TIMEOUT
UNKNOWN_IN_VLR
UNSUP_POS
UNSUP_SVC_RESTR
See Table 22 on page 259 for bit
numbers and an explanation of each
value.

MAP VERSION

Optional field that indicates which


MAP version the entity supports.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

243

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

MATCH_TYPE

ENABLING, INHIBITING
or NONE

MBX

Default

Meaning
Identifies to the VLR whether CAMEL
originating criteria data for the TDP is
to be considered when the subscriber
makes a call. NONE retains all
originating criteria for the specified
TDP, but this criteria data is not
downloaded to the VLR.
ENABLING - CAMEL enquiry is
initiated if a DEST_NUM_LEN of 5 is
specified and a 5-digit number is
dialled.
INHIBITING - CAMEL enquiry is
initiated if a DEST_NUM_LEN of 5 is
specified and a number which is not
5-digits long is dialled.
Optional number field containing the
subscribers mailbox number

MCEF

TRUE/FALSE

Memory Capacity Exceeded Flag.


Indicates whether delivery of a mobile
terminated short message failed
because of lack of capacity in the
mobile station (handset).
no alerts are sent if this flag is set
this flag does not prevent the HLR
returning routing information for a
short message

MLR_GT

Optional number field containing the


global title of the MLR that manages
the subscribers mailbox

MLR_NAME

Optional field containing the name of


the MLR that manages the
subscribers mailbox

MNRF

TRUE/FALSE

Mobile station Not Reachable Flag.


Indicates whether delivery of a
non-GPRS mobile terminated short
message failed because a subscriber
was absent.
if this flag is set, the HLR does not
return an MSC address as routing
information
this flag is cleared if the HLR
receives an alert stimulus, so this
flag does not prevent alerts

Home Location Register (Linux) V1.1 Support Guide

244

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

MNRG

TRUE/FALSE

MNRR_GPRS

NO_GSM_PAGE_RESP,
IMSI_DETACHED,
ROAM_RESTRICT,
DEREG_GSM,
MSPURGED_GSM,
NO_GPRS_PAGE_RES
P, GPRS_DETACHED,
DEREG_GPRS,
MSPURGES_GPRS,
UNK_GSM_SUB,
UNK_GPRS_SUB,
NONE

Default

Meaning
Mobile station Not Reachable for
GPRS. Indicates whether delivery of a
GPRS mobile terminated short
message failed because a subscriber
was absent.
if this flag is set, the HLR does not
return an SGSN address as routing
information
this flag is cleared if the HLR
receives an alert stimulus, so this
flag does not prevent alerts

NONE - (not
GSM
standard)

Home Location Register (Linux) V1.1 Support Guide

Mobile station not reachable reason


for a GPRS subscriber. Value
indicates why the previous SMS
delivery attempt failed. For the
numerical value in the subscriber
database for each reason, see SMS
Absence Reasons on page 595.
NO_GSM_PAGE_RESP - No
paging response via MSC
IMSI_DETACHED - IMSI detached
ROAM_RESTRICT - Roaming
restriction
DEREG_GSM - Deregistered in the
HLR for non-GPRS
MSPURGED_GSM - MS purged
for non-GPRS
NO_GPRS_PAGE_RESP - No
paging response via the SGSN
GPRS_DETACHED - GPRS
detached
DEREG_GPRS - Deregistered in
the HLR for GPRS
MSPURGES_GPRS - MS purged
for GPRS
UNK_GSM_SUB - Unknown
subscriber via the MSC
UNK_GPRS_SUB - Unknown
subscriber via the SGSN
NONE - (not GSM standard)

Chapter 12 Subscriber Commands

245

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

MNRR_GSM

NO_GSM_PAGE_RESP,
IMSI_DETACHED,
ROAM_RESTRICT,
DEREG_GSM,
MSPURGED_GSM,
NO_GPRS_PAGE_RES
P, GPRS_DETACHED,
DEREG_GPRS,
MSPURGES_GPRS,
UNK_GSM_SUB,
UNK_GPRS_SUB,
NONE

NONE

Mobile station not reachable reason


for a GSM subscriber. Value indicates
why the previous SMS delivery
attempt failed. For the numerical value
in the subscriber database for each
reason, see SMS Absence Reasons
on page 595.
NO_GSM_PAGE_RESP - No
paging response via MSC
IMSI_DETACHED - IMSI detached
ROAM_RESTRICT - Roaming
restriction
DEREG_GSM - Deregistered in the
HLR for non-GPRS
MSPURGED_GSM - MS purged
for non-GPRS
NO_GPRS_PAGE_RESP - No
paging response via the SGSN
GPRS_DETACHED - GPRS
detached
DEREG_GPRS - Deregistered in
the HLR for GPRS
MSPURGES_GPRS - MS purged
for GPRS
UNK_GSM_SUB - Unknown
subscriber via the MSC
UNK_GPRS_SUB - Unknown
subscriber via the SGSN
NONE - (not GSM standard)

MOBILITY_TRIG

{mob_trig> <mob_trig>...}
For example,
{IMSI_ATTACH
LOC_UPD_SAME_VLR}
sets IMSI attach and
location update in same
VLR triggers

Set of mobility triggers, of which 5


values are defined by GSM.
At least one value must be present.
{mob_trig> <mob_trig>...} is a list of
mobility triggers, each separated by a
space.
LOC_UPD_SAME_VLR: location
update in same VLR
LOC_UPD_OTHER_VLR: location
update to other VLR
IMSI_ATTACH: IMSI attach
INIT_IMSI_DETACH: MS initiated
IMSI detach
NWK_INIT_IMSI_DETACH:
network initiated IMSI detach
For bit numbers in the subscriber
database, see Mobility Triggers on
page 623.

MS CAT

Phone category. The values are


NORMAL/PRIORITY/TEST/
PAYPHONE (see CCITT Q763) or
V0...V255 for other values

MSC

Optional location MSC number

Home Location Register (Linux) V1.1 Support Guide

246

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

MSISDN

MSISDN allocated to the subscriber

MSRN_PFX_ID

Number for the MSRN prefix index. A


value of 0 (zero) indicates NONE

MWD RACE TIMER

decimal 0 to (232-1)

NAM

Number of seconds since 01/01/1991.

Network Access Mode.


GSM - subscriber only has access
to standard GSM network and
hence must only register on a VLR/
MSC.
GPRS - subscriber only has access
to the GPRS network and hence
must only register on a SGSN (or
VLR with GPRS capability).
GSM_GPRS - subscriber has
access to both the GSM and GPRS
networks.

NO_MWD

Decimal number up to 19

Number of service centres which have


messages waiting for associated
MSISDN

NO_SVC_UNSUPP_BH

{<odb> <odb>...}
for example, {<odbaoc>
<odbaic>} bars both
outgoing and incoming
calls

The meaning of
NO_SVC_UNSUPP_BH depends on
whether it is shown as part of a
CAMEL trigger detection point (TDP)
or for OICK.
For a CAMEL TDP:
Operator determined bars (ODBs) to
be invoked if the subscriber has a
CAMEL service and the VLR on which
registration is attempted does not
support the minimum required CAMEL
phase.
See Appendix I, Operator Determined
Bars for descriptions of ODBs.
For OICK:
Behaviour if the subscriber has OICK
but the VLR does not support OICK.
See CAMEL Interaction with OICK on
page 25 for a description of OICK
interaction with CAMEL.

NOM_BSG

{<basic_service_group>
<basic_service_group>...
}

(none

The basic service groups (BSGs) for


which the SIM is nominated to receive
calls.
{} indicates that the SIM is not
nominated to receive any calls.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

247

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

NOTIFY_CB

TRUE or FALSE

FALSE

Flag to control whether the CAMEL


Service Environment (CSE) is notified
if call barring (CB) data is changed.
The CSE is notified by a Notification of
Subscriber Data Change message,
which is sent if call barring data
changes. The entities that receive the
message are defined by the
CB_NOTIFY parameter in the
HLR_CONFIG Table

NOTIFY_CF

TRUE or FALSE

FALSE

Flag to control whether the CAMEL


Service Environment (CSE) is notified
if call forwarding (CF) data is changed.
The CSE is notified by a Notification of
Subscriber Data Change message,
which is sent if call forwarding data
changes. The entities that receive the
message are defined by the
CF_NOTIFY parameter in
theHLR_CONFIG Table

NOTIFY_ODB

TRUE or FALSE

FALSE

Flag to control whether the CAMEL


Service Environment (CSE) is notified
if operator determined bar (ODB) data
is changed.
The CSE is notified by a Notification of
Subscriber Data Change message,
which is sent if operator determined
bar data changes. The entities that
receive the message are defined by
the ODB_NOTIFY parameter in the
HLR_CONFIG Table

NR_Cond_Timer

O_CAUSE_VAL

Number, containing the no reply


condition timer. Takes values 5 - 30
(specified in seconds)
<o_cause_val>
-<o_cause_val>
-<o_cause_val>
-<o_cause_val><o_cause_val>
For example, 0-1-127-3-4
a value of 0 (zero) means
no value

Used by the OCSI_4 CAMEL trigger


detection point (see page 377).
This attribute contains reasons for call
processing failure is a list of 5 integers
separated by hyphens.
All 5 values must be present, but a
value of 0 (zero) can be specified to
indicate no value.
Not all 127 values are defined. The
HLR does not restrict any values, it is
assumed provisioning will only attempt
to update using valid O_CAUSE_VAL
values.
The HLR will not enforce unique
values.

Home Location Register (Linux) V1.1 Support Guide

248

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

OCSI_DNLD

TRUE or FALSE

FALSE

No longer used. Identified whether


O-CSI is downloaded when the
subscriber registers on a VLR which
supports a lower phase of CAMEL
than required by the subscriber. This
function is now provided by using
multiple CCH values instead of only
one.

ODB

Operator Determined Bar value(s) as


defined in Appendix I, Operator
Determined Bars.

OICK

Originating Intelligent Network


Category Key. This value selects one
IN service or a combination of IN
services. 0 (zero) disables OICK.

OPERATION STATUS

Operation that set the current location


status as a string of up to three
characters. For example: UPL, RSD,
ADM, ISD, DSD, SNP, PMS, NMS

OVERRIDE

TRUE or FALSE

Controls Calling Line Identification


presentation. Values are TRUE/
FALSE depending on whether the
subscriber is allowed to override the
CLI restriction of an incoming call..
See CLIP Restriction Override on
page 633.

OWNM_P

For a member of a linked subscription,


specifies which number is returned in
response to an OWN_MSISDN
USSD.
PNUM - published number is returned
OWN - subscribers own (routing/
member) MSISDN is returned

P1

Optional.
If FLAVOUR is GSM - VLR number
If FLAVOUR is GPRS - SGSN number

P2

Optional.
If FLAVOUR is GSM - MSC number
If FLAVOUR is GPRS - SGSN
address

P3

Optional.
If FLAVOUR is GSM - LMSID number
If FLAVOUR is GPRS - field empty

P4

Optional.
If FLAVOUR is GSM - hexadecimal
induced SS (BSG bitmask)
If FLAVOUR is GPRS - field empty

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

249

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

P5

Optional.
If FLAVOUR is GSM - hexadecimal
CFB quiescence (BSG bitmask)
If FLAVOUR is GPRS - field empty

P6

Optional.
If FLAVOUR is GSM - hexadecimal
CFNRY quiescence (BSG bitmask)
If FLAVOUR is GPRS - field empty

P7

Optional.
If FLAVOUR is GSM - hexadecimal
CFNRC quiescence (BSG bitmask)
If FLAVOUR is GPRS - field empty

PAI

OFF or ON

ON

Positioning Allowed Indicator. Shows


whether a subscriber can use mobile
positioning services.
OFF - positioning services not allowed
ON - positioning services allowed
Both PAI and the Subscriber Location
Privacy Profile (SLPP) must allow
positioning services.
PAI defaults to ON to allow the
Location Enabling Server (LES) to
control privacy. See page 36 for a
description of location based services.

PAI_CTRL

OFF or ON

ON

Positioning Allowed Indicator Control


Flag. Determines whether a
subscriber can control PAI.
OFF - subscriber not allowed to
control PAI
ON - subscriber allowed to control PAI

PASSWORD

Password that a subscriber enters to


perform call barring. Values are
0000...9999

PDP Address

Octet String (1..16 octets). This field


stores the network address used by
the subscriber. The address can be in
X121, Ipv4 or Ipv6 format. This field
does not include the type of address,
but it can be implied from the PDP
type. The PDP address is empty if
dynamic addressing is allowed.

PDP Context ID

Integer 1...50. Identifier for a given


PDP context, unique to the subscriber.

PDP Context Status

ENABLED or DISABLED. An internal


variable to either allow or stop a PDP
context being used in the network.

PDP Type

This is the type of packet network that


the context is to be used with.
Values are IPv6 or IPv4.

Home Location Register (Linux) V1.1 Support Guide

250

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

PEND IMSI

Optional number for the PENDING


IMSI

PNUM

The published number for a linked


subscription.
If NONE is specified, the published
number is removed from the group
member subscriber. (Can also be
done using the REMOVE:PNUM
command).
If a published number value is
supplied, but the subscriber has no
PNUM to update, a PNUM with the
specified value is added to the
subscriber. (Can also be done using
the ADD:PNUM command).

PRES_MODE

DEF_ALLOW
DEF_RESTR
PERMANENT

Presentation mode.
This relates to the Calling Line
Identification Restriction service.
DEF_ALLOW - The subscribers
directory number is displayed by
the called party.
DEF_RESTR - The subscribers
directory number is not displayed
by the called party.
PERMANENT - The subscribers
directory number is permanently
not displayed by the called party.
This status can be changed only
using an administration command,
not from the subscribers handset.
(see Calling Line Identity Restriction
on page 632)

PRES_NUM

<MSISDN>

(none)

Optional number field. Contains the


presentation number or generic
number contained in the
SendRoutingInformation message for
the last incoming call. (see Last Caller
Information on page 630)

PRES_NUM_STATUS

Text string from the


Unstructured
Supplementary Service
Data (USSD) Table

(no default)

Optional text field. Indicates the calling


line identity (CLI) status of the
presentation number (PRES_NUM).
See Calling Line Identity Restriction
on page 632.

PRIORITY

0 to 255 except for invalid


values 0 to 3, 64 to 67,
128 to 131 and 192 to
195

PS-CURRENT

TRUE or FALSE

Value for PRIORITY supplementary


service. Bits 3 to 6 (4 bits in total) of
the 8-bit PRIORITY indicate the
priority (other bits are flags or spare
bits) and must be non-zero. Some
values of PRIORITY are therefore
invalid.
FALSE

Home Location Register (Linux) V1.1 Support Guide

Depicts if the last UPL/PS-PSI


message contained a valid IMEI-SV.

Chapter 12 Subscriber Commands

251

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

PSI_CELL_OR_SAI_ID

Up to 7 octets (14 digit


hexadecimal number)

(optional)

Cell ID or service area ID

PSI_CURRENT_LOC

TRUE or FALSE

(optional)

TRUE the
current_location_retrieved field was
present in the
ProvideSubscriberInformation result.
FALSE the
current_location_retrieved field was
absent from the
ProvideSubscriberInformation result.

PSI_GEODETIC

Up to 10 octets (20 digit


hexadecimal number)

(optional)

Gives geodetic information.

PSI_GEOGRAPHICAL

Up to 8 octets (16 digit


hexadecimal number)

(optional)

Gives geographical information.

PSI_LAI

Up to 5 octets (10 digit


hexadecimal number)

(optional)

Gives location area information.

PSI_LOC_AGE

0 to 32767

(optional)

The age of location information in


minutes.

PSI_LOC_INFO

TRUE or FALSE

FALSE

Defines whether a
ProvideSubscriberInformation
message is sent to the VLR if the HLR
receives a SendRoutingInformation
message from a GMSC for
terminating CAMEL (T-CSI).

(optional)

Subscriber number information

PSI_LOC_NUMBER
PSI_MSC

MSC address

(optional)

MSC address

PSI_NR_REASON

Text field
MS_PURGED,
IMSI_DETACHED,
RESTRICTED_AREA,
NOT_REGISTERED,
INVALID

(optional)

The reason why a subscriber was not


reachable
MS_PURGED - Purged by VLR/
SGSN
IMSI_DETACHED - Subscriber
explicitly IMSI detached
RESTRICTED_AREA - Subscriber
is roamed into area where service
is restricted
NOT_REGISTERED - Subscriber
is not registered
INVALID - No Reason for Not
Reachable is available

PSI_SAI_PRESENT

TRUE or FALSE

(optional)

TRUE the SAI_present field was


present in the PSI result.
FALSE the SAI_present field was
absent in the PSI result.

PSI_SELECTED_LSA

Up to 3 octets (6 digit
hexadecimal number)

(optional)

The identity of the selected LSA.

Home Location Register (Linux) V1.1 Support Guide

252

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

PSI_STATUS

NOT_REGISTERED,
NOT_SUPPORTED,
CHILD_FAIL,
SEND_FAIL, VALID,
FAILED, VLR_BLACK,
UNKNOWN_IN_VLR

Provide Subscriber Information status


which is one of the following:
NOT_REGISTERED: Subscriber
not registered on VLR/SGSN.
NOT_SUPPORTED: VLR does not
support EMAP and/or PSI.
CHILD_FAIL: Failure to allocate
child task.
SEND_FAIL: Failure to send
encoded PSI.
VALID: Successful PSI request.
FAILED: Failure due to: no
response/invalid signal/abandoned/
finish/error from VLR.
VLR_BLACK: VLR is black listed,
PSI initiation will fail.
UNKNOWN_IN_VLR: VLR has no
knowledge of subscriber.

PSI_SUB_STATE

ASSUMED_IDLE,
CAMEL_BUSY,
NOT_PROVIDED,
NOT_REACHABLE,
NOT_SUPPORTED

Current subscriber state.


ASSUMED_IDLE - Subscriber is
idle (but may be out of contact).
CAMEL_BUSY - Subscriber is in
BUSY state i.e. a call.
NOT_PROVIDED - The state is not
supplied.
NOT_REACHABLE - The
Subscriber is known to be
unreachable.

PSI_VLR

Global title

PWD

0000-9999

Number for the password.

Q MASK

0000-FFFF

Number (4 digit hex) prefixed by 0x


representing a bit set for each
supplementary services in a quiescent
state.

QHLR MASK

0000-FFFF

Number (4 digit hex) prefixed by 0x


representing a bit mask of the
supplementary services which are in a
quiescent state.

(optional)

QOS

Meaning

International format of VLR address.

5 numbers, separated by hyphens,


each representing a quality of service
(QoS) parameter. It has the format:
a-b-c-d-e
a to e are integers in the range 0 to
the following maximum values:
a=4; b=5; c=9; d=3; e=31
a=Delay class, b=Reliability class,
c=Peak throughput, d=Precedence
class and e=Mean throughput.
The HLR stores this value but does
not interpret it.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

253

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

QUI STAT
RECACHE

Meaning
Text giving quiescent status for each
of the supplementary services.

TRUE or FALSE

None

This bit, if set, would force the HLR to


send a trigger to NBS at receipt of new
UPL/UGL message (irrespective of
whether IMEI-SV has changed).

REG MASK

Number (4 digit hex) prefixed by 0x


representing the supplementary
services which are registered

ROAMTICK

Terminating IN Category Key when


Roamed to another network. This
replaces TICK and the associated
supplementary services.
ROAMTICK allows the GMSC to
perform specific processing when a
customer receives an incoming call. If
provisioned, the ROAMTICK value is
returned in response to an SRI
message.

SDM_DEST

HLR name

Name of the HLR to which subscribers


have been moved in an SDM.

SE_FLAGS

SE_CAMEL,
CAMEL_ONLY,
SE_ONLY

SE_CAMEL

Identifies the category of a special


extended (SE) divert as one of:
SE_CAMEL - divert can be
downloaded as CAMEL or
ARSENIC
CAMEL_ONLY - divert can be
downloaded as CAMEL but not
ARSENIC
SE_ONLY - divert can be
downloaded as ARSENIC but not
CAMEL
See Forward-To Number Behaviour
Modes on page 8.

SERV_CEN_COUNT

SERVICE_KEY

Number of service centres that have


messages waiting for specified
MSISDN(s)
0 to 231-1

Represents either a single CAMEL


service or multiple CAMEL services.

SGSN Address

The IP address of the SGSN in the


format indicated by PDP Type.

SGSN Entity Flags

Bitmask, as for GSM. These flags are


populated from the network entity
table. All values supported by the HLR
are supported for GPRS:
HPLMN, LOG_SCCP,
LOG_TRANSACTION, LOG_SS7,
BLACK, EMAP

Home Location Register (Linux) V1.1 Support Guide

254

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

SGSN Last Operation

This field gives the last attempted


operation on the subscriber that
affected the location status. Possible
values are:
Administration, Update Location,
Restore Data, Send Parameters,
Insert Subscriber Data, Delete
Subscriber Data, PurgeMS, Note MS
Presence
These are the same values seen with
GSM. That is, PurgeMS for GPRS is
shown as PurgeMS.

SGSN Location Status

GPRS location status for the


subscriber which is one of the
following:
ABANDONED
AC_CONFLICT
ADMIN_CHANGED
ADMIN_DISABLED
BLACK_LISTED
DECSS7_SENDF
INVALID
ISD_DSD_FAIL
PURGED
REGISTERED
REGISTERED?
ROAM_ODB
ROAM_STOPPED
RR_UNSUPFEATURE
TIMEOUT
UNKNOWN_IN_SGSN
UNSUP_POS
UNSUP_SVC_RESTR
See Table 22 on page 259 for an
explanation of each value.

SGSN Number

Global title or signalling point code of


the SGSN

SGSN Suspect Bit

This bit is set if the location status is


registered but the HLR has just
received a Send Parameter / Auth Info
for another SGSN - hence the HLR
suspects that the subscriber will soon
change location.

SGSN Timestamp

Integer. The GSM timestamp of the


last activity which updated the location
information for this subscriber.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

255

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

SIM ID

0 to 9

0 for new
subscriber

Identity of the SIM to distinguish it


from other SIMs in a MultiSIM
subscription (see MultiSIM on
page 46)
The SIM ID is shown as part of last
caller information (see LAST CALLER
on page 241) to identify which SIM in
a MultiSIM subscription was called.

SIMTYPE

SIM/USIM

SOURCE

UPL, UGL, EIR, CS-PSI,


PS-PSI, ADMIN, or
NONE

Type of SIM
SIM - second generation (2G) network
USIM - third generation (3G) network
NONE

SPCODE

SQN

Service Provider code (if available),


which identifies the subscribers
service provider
0

0 to 243-1

SS INDUCED

SS_LIST

Source of IMEI-SV. For current


release, only UPL, UGL, ADMIN, or
NONE is stored in this field. If source
is NONE, then the value of IMEI-SV is
treated as UNKNOWN.

Sequence number for SIM (2G) or


USIM (3G) subscriber authentication
Text for each supplementary service
that has been induced for the
subscriber as a result of being
registered on a network entity which
does not support a particular ODB or
SS
Set of SS codes, of which many
values are defined by GSM.

{<ss_code>
<ss_code>...}
For example, {mpty}

SS PROV

Text for each supplementary service


provisioned.

SUBTYPE

Value for SUBTYPE supplementary


service.

T_CAUSE_VAL

TDP

<t_cause_val>
-<t_cause_val><t_cause_val>
-<t_cause_val><t_cause_val>
For example, ,
0-1-127-3-4
a value of 0 (zero) means
no value

Used by the TCSI_13, TCSI_14


CAMEL trigger detection points (see
page 390).
This attribute contains reasons for call
processing failure and is a list of 5
integers separated by hyphens.
a value of 0 (zero) means no value
Not all 127 values are defined. The
HLR does not restrict any values, it is
assumed provisioning will only attempt
to update using valid T_CAUSE_VAL
values.
The HLR will not enforce unique
values.
See CSI_TDP on page 238

Home Location Register (Linux) V1.1 Support Guide

256

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

TIF_CSI

TRUE or FALSE

Default

Meaning
Text field.Translation Information Flag
- CAMEL Service Information.
A translation information flag
(TIF_CSI) value of TRUE indicates
that when the subscriber registers a
forwarded-to-number (FTN), the HLR
shall not attempt to perform any
translation, number format checks,
prohibited FTN checks or call barring
checks.
A TIF_CSI flag value of FALSE
indicates that translation is needed in
the HLR and the usual procedure
applies, including call barring checks.
A value of TRUE allows a subscriber
to register FTNs that are non-standard
because they are not in E.164 format,
such as FTNS for a virtual private
network (VPN).
See Number Translation for Call
Forwarding on page 8.

TIME

Time when location status updated


with the format dd-mmm-yyyy
hh:mm:ss

TIME ZONE

Signed number showing the difference


in half hours between the local time of
the network entity on which the
subscriber is registered and the local
time on the HLR.

TIMER

timestamp, action pair


timestamp is a date and
time in the format:
dd-mmm-yyyy
hh:mm:ss.cc
action is SMS_ALERT

Creation
time of
MWD

TRACE

Home Location Register (Linux) V1.1 Support Guide

Text string. Timestamp paired with an


action to take when the timer expires.
dd - day of the month (01 to 31)
mmm - first three letters of month in
upper case
yyyy - year
hh - hour (00 to 23)
mm - minute (00 to 59)
ss - second (00 to 59)
cc - hundredths of a second (00 to 99)
SMS_ALERT is the only possible
value for the action.
Trace flags are SUB_SS7 (for network
which traces all SS7 events)/
SUB_TRAN (for transaction tracing)/
TIMON (for TiMON tracing)/
REALTIME (for real time tracing), B0,
B1, B2 or B3. See also SET:TRACE
on page 269.

Chapter 12 Subscriber Commands

257

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

TRANSFER_OF_SM

VIA_MSC or VIA_SGSN

VIA_SGSN

Some gateway MSCs connected to


text messaging centres do not support
GPRS. Therefore, a GMSC indicates
whether it supports GPRS when
requesting routing information for an
SMS message. If the GMSC does not
support GPRS, the HLR refers to
TRANSFER_OF_SM to decide how to
reroute the short message. This
attribute is used to optimize speed,
cost and reliability of delivering
messages to subscribers.
VIA_MSC - transfer of SM via MSC
VIA_SGSN - transfer of SM via SGSN

UNSUPP BS

Optional hexadecimal number


indicating any basic services that are
not supported by the entity.

UNSUPP ODB

Operator Determined Bars not


supported by the subscribers VMSC.

UNSUPP_SERV

MULTISIM, REGSUB or
ROAMED

UNSUPP SS

Bit mask that indicates whether


services are supported. Bit numbers
and values are:
0 - MULTISIM - many SIMs linked
to a single published number used
for linked subscriptions (see
page 36 and page 40)
1 - ROAMED - pre-pay roaming call
back service
2 - REGSUB regional subscription
used for home zone charging (see
page 40)
Supplementary Services not
supported by the subscribers VMSC

USSD_CODE

String of up to 16
characters.
Typically *#nnn#, where n
is a digit

Code used to invoke a particular


CAMEL USSD service.
Up to 5 <ussd_code> <gsmscf_addr>
pairs can be specified

V3 PSI AGE

0 to 32767

The age of location information in


minutes.

V3 PSI CELLID

Optional 7-octet cell identity

V3 PSI GEO INFO

Optional 8-octet geographical


information field

V3 PSI LAI

Optional 5-octet location area identity

Home Location Register (Linux) V1.1 Support Guide

258

Chapter 12 Subscriber Commands

Table 21. VIEW:SUB Response Parameters (Continued)


Parameter

Values

Default

Meaning

V3 PSI NR REASON

Optional reason that the subscriber


was not reachable:
MS PURGED
IMSI DETACHED
RESTRICTED_AREA
NOT_REGISTERED
INVALID

V3 PSI SUB STATE

Optional current subscriber state

VLR

Optional location VLR number.

VLR TITLE

Name (as a string of up to 20


characters) of the network entity on
which the subscriber has attempted to
register.

VMSC

VMSC attributes supported by the


network entity

VMTYPE

NONE, BTCVM, BTVM,


RECALL, UM, NGVM,
BTNOMI, or GREEN

NONE

VPLMN Allowed

Type of Voicemail service provisioned


for the subscriber. For this version
only NONE and BTCVM are
meaningful.
TRUE or FALSE. Specifies whether a
subscriber is allowed to use the APN
in the home network only, or in a
visited network also.

VT_CAUSE_VAL

<vt_cause_val><vt_cause_val><vt_cause_val><vt_cause_val>
-<vt_cause_val>
where vt_cause_val is an
integer from 1 to 127
0 (zero) indicates no
vt_cause_value
for example,
2-3-23-111-34

ZONE CODE

0 to 65535

Used by the VTCSI_13 and VTCSI_14


CAMEL trigger detection points for
VMSC triggered CAMEL services (see
page 397).
This attribute contains reasons for call
processing failure is a list of 5 integers
separated by hyphens.
All 5 values must be present, but a
value of 0 (zero) can be specified to
indicate no value.
Not all 127 values are defined. The
HLR does not restrict any values, it is
assumed provisioning will only attempt
to update using valid
VT_CAUSE_VAL values.
The HLR will not enforce unique
values.
None

A zone code is used to define an area


within the home network, or an entire
non-home network, used for home
zone charging (see page 33).

Note: Not all the unprovisioned subscriber response parameters listed


in Table 21 are returned in the response text.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

259

Table 22. Location Status Values


Value

Meaning

ABANDONED

This is not a normal status and represents a network fault in either


HPLMN or VPLMN.
The subscriber is not registered.
During the management of subscriber data, using either
InsertSubscriberData or DeleteSubscriberData, whether stand alone,
or framed (within an UpdateLocation, UpdateLocationGPRS or
RestoreData transaction), the HLR received an unexpected transaction
termination (e.g. TC-ABORT, TC-REJECT) from the VLR or SGSN.
The HLR will attempt a CancelLocation transaction, and expect the MS
to retry registration.

AC_CONFLICT

This is not a normal status and represents a network fault in the


VPLMN.
The subscriber is not registered.
This indicates a non-compliant VLR and might require notification to
the originator of the VLR software.
During the management of subscriber data, using stand alone
InsertSubscriberData (ISD) or DeleteSubscriberData (DSD), the VLR
or SGSN attempted to revert the subscriberDataMngtContext from the
version defined by the original networkLocUpContext or
gprsLocationUpdateContext.
This is forbidden by the GSM specifications and is not permitted by the
HLR, to ensure safe management of downloaded data.
The HLR will attempt a CancelLocation transaction and expect the MS
to retry registration.

ADMIN_CHANGED

This is a normal status and does not represent a fault.


The subscriber is not registered.
The subscriber was registered on a VLR and/or SGSN but the
execution of an administration operation required that the VLR/SGSN
record be cancelled by a CancelLocation transaction to ensure
satisfactory control of the VLR/SGSN data. This status does not mean
that re-registering will be prevented, merely that it was not possible for
the HLR to adequately alter the VLR/SGSN data via MAP. No attempt
to re-register has yet been received. This status is also set by an
UPDATE:SUB command which sets ADMIN.ENABLED when
previously disabled, to help MT calls prompt paging.

ADMIN_DISABLED

This is a normal status and does not represent a fault.


The subscriber is available for admin. operations but disabled on the
network. This state is set by:
An UPDATE:SUB command which set ADMIN.DISABLED (Operation
ADM) An UpdateLocation transaction when the subscriber is admin.
disabled (Operation UPL) An UpdateLocationGPRS transaction when
the subscriber is admin. disabled(0peration RSD) A RestoreData
transaction when the subscriber is admin. disabled (Operation UPL)
The subscriber is not registered.

Home Location Register (Linux) V1.1 Support Guide

260

Chapter 12 Subscriber Commands

Table 22. Location Status Values


Value

Meaning

BLACK_LISTED

This is not a normal status and represents a configuration fault in the


HPLMN; one would black list existing entities in most unusual
conditions, and all such registrations would normally be cancelled first.
The subscriber is not registered in the HLR, but may or may not have a
VLR/SGSN record.
During the management of subscriber data, using stand alone
InsertSubscriberData or DeleteSubscriberData, the network entity
record identified by the VLR or SQSN global title is now identified as
Black Listed in the Network Entity (NETENT) table, hence no MSU
may be sent towards it.
The HLR will attempt a CancelLocation transaction but this too will
encounter the Black Listed condition and not be sent.

DECSS7_SENDF

This is not a normal status and represents a network fault in the


HPLMN, usually in the IN7 part of the HLR.
During the management of subscriber data, using either
InsertSubscriberData or DeleteSubscriberData, whether stand alone,
or framed (within an UpdateLocation, UpdateLocationGPRS or
RestoreData transaction), the HLR encountered an error in
transmission from its SS7 layer such as Destination Inaccessible or
more likely, internal confusion of the IN7 product.
The HLR will attempt a CancelLocation transaction and expect the MS
to retry registration. Depending on the fault, the CancelLocation might
encounter the same failure. The subscriber is not registered in the
HLR, but may or may not be registered in the VLR or SGSN.

INVALID

This is a normal status and does not represent a fault.


The subscriber is not registered.
There is no location information for either Circuit Switched (GSM) or
Packet Switched (GPRS) access. This is a new subscriber whose HLR
has never performed an UpdateLocation or UpdateLocationGPRS
transaction for that subscriber.
The timestamp contains information about when the subscriber record
was created in the HLR.

ISD_DSD_FAIL

This is not a normal status and represents a network fault in either


HPLMN or VPLMN.
The subscriber is not registered.
During the management of subscriber data, using either
InsertSubscriberData or DeleteSubscriberData, whether stand alone,
or framed (within an UpdateLocation, UpdateLocationGPRS or
RestoreData transaction), the HLR received an unexpected error
response from the VLR or SGSN.
The HLR will attempt a CancelLocation transaction and expect the MS
to retry registration.

PURGED

This is a normal status and does not represent a fault.


The subscriber is not registered.
The HLR received a PurgeMS message from the VLR/SGSN.
The VLR/SGSM may choose to purge subscribers according to MSC
configuration, for example, when the MS performs an IMSI Detach
operation.
If the MS fails to contact the MSC within the Purging Timeout set within
the MSC. If the MSC needs a new record for another MS, and the
purged MS was the oldest to have been in contact.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

261

Table 22. Location Status Values


Value

Meaning

REGISTERED

This is a normal status and does not represent a fault.


The subscriber is probably registered.
Subscriber has registered, and is assumed by the HLR to still be
registered.
If the MS loses contact with the MSC, or if the MS performs an IMSI
Detach, but MS Purging is not enabled in the MSC, then the MS will
actually be not registered, but the HLR will be unaware of this.

REGISTERED?

This means the same as REGISTERED except that the current


location of the subscriber is SUSPECT, because a request for
authentication vectors has come from a VLR whose Calling GT does
not match the VLR stored for the current location.
It indicates that a Location Update sequence is probably under way,
and an UpdateLocation transaction can shortly be expected, which will
reset the status to REGISTERED.

ROAM_ODB

This is a normal status and does not represent a fault.


The subscriber is not registered.
Subscriber is not allowed to roam due to at least one active Operator
Determined Bar (ODB) .

ROAM_STOPPED

This is a normal status and does not represent a fault.


The subscriber is not registered.
Subscriber is not allowed to roam due to roaming limitations, the
subscribers SUB_RESTR and the VLR Network entity SUB_RESTR
have no roaming service in common (Circuit Switched), the
subscribers GPRS_SUB_RESTR and the SGSN Network entity
SUB_RESTR have no roaming service in common (Packet Switched).

RR_UNSUPFEATURE

This is not a normal status and represents a network fault in either


HPLMN or VPLMN.
The subscriber is not registered.
During the management of subscriber data, using
InsertSubscriberData whether stand alone, or framed (within an
UpdateLocation, UpdateLocationGPRS or RestoreData transaction),
the HLR received a response indicating that a service downloaded to
the VLR/SGSN was not supported in the VLR/SGSN. This means that
this registration attempt must be abandoned and the HLR record of
unsupported services for the VLR/SGSN updated. The HLR will
attempt a CancelLocation transaction and expect the MS to retry
registration. That may succeed using service substitution, or result in
UNSUP_SVC_RESTR depending on the severity of the unsupported
service.

TIMEOUT

This is not a normal status and represents a network fault in either


HPLMN or VPLMN.
The subscriber is not registered.
During the management of subscriber data, using either
InsertSubscriberData or DeleteSubscriberData, whether stand alone,
or framed (within an UpdateLocation, UpdateLocationGPRS or
RestoreData transaction), the HLR timed out awaiting a response from
the VLR or SGSN.
The HLR will attempt a CancelLocation transaction and expect the MS
to retry registration.

Home Location Register (Linux) V1.1 Support Guide

262

Chapter 12 Subscriber Commands

Table 22. Location Status Values


Value

Meaning

UNKNOWN_IN_VLR/SGSN

This is a normal status and indicates that the VLR/SGSN has purged
the record without informing the HLR.
The subscriber is not registered.
During the management of subscriber data, using stand alone
InsertSubscriberData or DeleteSubscriberData, the HLR received an
UnidentifiedSubscriber error response from the VLR or SGSN,
indicating that the VLR or SGSN no longer has a record for the
subscriber.

UNSUP_POS

Indicates whether positioning services are not supported. Positioning


services require MAP3, EMAP and positioning subscriber data must
have been successfully downloaded to the VLR.

UNSUP_SVC_RESTR

This is a normal status and does not represent a fault.


The subscriber is not registered.
The subscriber was not allowed to register because the VLR /SGSN
did not support a critical service (required to permit roaming) even after
all defined substitution rules had been followed.

Note: For location status bit numbers in the bitmask in the subscriber
database, see Location Status on page 619 of Appendix G, Attribute
Bit Numbers in the Subscriber Database.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

263

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00099

Internal software error.

Example
The example below is for a newly created subscriber, and illustrates the
default values for the SIM and basic service groups resulting from the
MultiSIM service (see MultiSIM on page 46).

Home Location Register (Linux) V1.1 Support Guide

264

A newly created
subscriber is
given a SIM ID of
0 (zero) and all
basic service
groups are
assigned to the
same SIM

Chapter 12 Subscriber Commands

VIEW:SUB,MSISDN,123412341234;
IMSI:
123451234512345 Pending:
Exp:
MCEF:
FALSE MNRF:
FALSE MNRG:
FALSE
MNRR_GSM: NONE
MNRR_GPRS: NONE
SIM Type: SIM
SIM_ID: 0
NOM_BSG : {SPEECH SMS FAX DCICA DCICS PADACC DPACK UNREST
AUXSPEECH}

Flav:
GSM Status: INVALID (ADM)
18-NOV-2002 14:52:08
Entity: ( LOCAL)
123451234512345
UnspPos:
VLR No:
MSC No:
Camel capability handling for CSIs in use:

MAP:

Time:

EMAP:

IMSI:

Flav:
GPRS Status: INVALID (ADM)
18-NOV-2002 14:52:08
Entity: ( LOCAL)
123451234512345
UnspPos:
SGSN No:
SGSN Addr:
Camel capability handling for CSIs in use:

MAP:

Time:

EMAP:

IMSI:

DB_Lock:
Sub_Res:
No_MWD: 0
C-Bhvr :
Ctrl: ON
GPRSSub_res
SP Code:

FREE
Admin: DISABLED Group: 0x00 Ctrl_SS_Bar: NO
0x0000 Cat:
NORMAL
Trace:
0 MSRN_Pfx_Id: 0
0

Pwd:

0000

Bad:

0x0000 TransferSM: VIA_MSC

CFU_CP : NONOTIFY CFB_CP: NONOTIFY


Pres_mode: PERMANENT
CFNRc_CP: NONOTIFY CFB_FP: NONOTIFY
Override : FALSE
TICK
: 0
PRIORITY: 0
OICK

LMSID:

PAI: OFF
NAM: GSM

CFNRy_CP: NONOTIFY
CFNRy_FP: NONOTIFY
SUBTYPE : 0

: 0

No calls since: 18-NOV-2002 14:52:08

MSISDN: 123412341234
BSG: SPEECH

BC Title: TS11

BS: TS11

The example below shows the result of creating a subscription with


more than one SIM using the ADD:SIM command.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

This MultiSIM
subscription has 2
SIMS, with ID 0
and 1.

VIEW:SUB,MSISDN,123412341234;
IMSI:
123451234512345 Pending:
Exp:
MCEF:
FALSE MNRF:
FALSE MNRG:
FALSE
MNRR_GSM: NONE
MNRR_GPRS: NONE
SIM Type: SIM
SIM_ID: 0
NOM_BSG : {SPEECH SMS FAX DCICA DCICS PADACC DPACK UNREST
AUXSPEECH}

Use the
UPDATE:SUB
command with the
NOMINATED_SIM
(see page 219)
attribute to
nominate basic
service groups for
SIM 1.

IMSI:
123451234512346 Pending:
MCEF:
FALSE MNRF:
FALSE
MNRR_GSM: NONE
SIM Type: SIM
SIM_ID: 1
NOM_BSG : {}

Circuit switched
(CS) and packet
switched (PS)
location
information is
shown for both
SIMs in the
MultiSIM
subscription.

265

Exp:
MNRG:
FALSE
MNRR_GPRS: NONE

Flav:
GSM Status: INVALID (ADM)
18-NOV-2002 14:52:08
Entity: ( LOCAL)
123451234512345
UnspPos:
VLR No:
MSC No:
Camel capability handling for CSIs in use:

MAP:

Time:

EMAP:

IMSI:

Flav:
GPRS Status: INVALID (ADM)
18-NOV-2002 14:52:08
Entity: ( LOCAL)
123451234512345
UnspPos:
SGSN No:
SGSN Addr:
Camel capability handling for CSIs in use:

MAP:

Time:

EMAP:

IMSI:

Flav:
GSM Status: INVALID (ADM)
18-NOV-2002 15:02:56
Entity: ( LOCAL)
123451234512346
UnspPos:
VLR No:
MSC No:
Camel capability handling for CSIs in use:

MAP:

Time:

EMAP:

IMSI:

Flav:
GPRS Status: INVALID (ADM)
18-NOV-2002 15:02:56
Entity: ( LOCAL)
123451234512346
UnspPos:
SGSN No:
SGSN Addr:
Camel capability handling for CSIs in use:
.
.
.

MAP:

Time:

EMAP:

IMSI:

LMSID:

LMSID:

Home Location Register (Linux) V1.1 Support Guide

266

Chapter 12 Subscriber Commands

AUCUPDATE:SUB
The AUCUPDATE:SUB command updates the authentication data in the
integrated HLR/AUC database.

Syntax
AUCUPDATE:SUB,<imsi>,<algorithm>,<ki>,<enc_id>,
<check>,<int_id>;

Parameters
Parameter

Meaning

<imsi>

Subscriber IMSI or overlapping IMSI

<algorithm>

Version of the A38 authentication algorithm used. Specify a value of 1 for this algorithm

<ki>

Unique security key (Ki). Ki must be a string of 32 characters in the range 0-9 & A-F

<enc_id>

Encryption key identifier and is a string of 4 characters in the range 0-9 & A-F

<check>

Integrity check value and a string of 8 characters in the range 0-9 & A-F

<int_id>

Integrity key identifier and a string of 4 characters in the range 0-9 & A-F

The <imsi> must be specified.


The <algorithm> and <ki> parameters must be specified together or
not at all. If <algorithm> and <ki> are omitted, any existing
authentication data is erased.
The other parameters are optional, and are ignored, if SKE is not
operational. If SKE is operational, they must be specified.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

267

Errors
<error_code>

<error_message>

00002

Record not found.

00033

Cannot update authentication algorithm and key separately.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00062

Invalid identifier for encryption key or integrity key1.

00063

Integrity key not held in HLR table1.

00064

Integrity check algorithm not found for given key1.

00065

Integrity check failed1.

00066

Encryption key not held in HLR table1.

00067

Encryption algorithm not found for given key1.

00068

Encryption/decryption algorithm internal error.

00099

Internal software error.


1

Only if SKE is operational.

Example
In this example of updating authentication data, the IMSI specified is
not in the database.
AUCUPDATE:SUB,123456789012345,1,
123456789012345678901234567890FF,
1901,ABCD1234,0901;
C1:00002,0002,Record not found;
Re-enter the command with the correct value for the IMSI.
AUCUPDATE:SUB,123456789012346,1,
123456789012345678901234567890FF,
1901,ABCD1234,0901;
GSM PDS - Subscriber AUC Data Updated
Subscriber IMSI - 123456789012346

Value

Description

123456789012346

Subscriber IMSI

Version number of the A38 algorithm

123456789012345678901234567890FF

Authentication key

Home Location Register (Linux) V1.1 Support Guide

268

Chapter 12 Subscriber Commands

Value

Description

1901

Encryption key identifier

ABCD1234

Integrity check value

0901

Integrity key identifier

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

269

SET:TRACE
Tracing logs transaction or SS7 events to log files (see Appendix K,
Event Log Files), to the screen (for real-time tracing), or makes event
records available to off-platform tracing (for TIMON tracing).
The SET:TRACE command enables tracing using a specific key number.

Syntax
SET:TRACE,<key_type>,<key_value>,<trace_value>;

Parameters
Parameter

Description

<key_type>

IMSI, MSISDN, PNUM, MIN (GIPC only), or SRN

<key_value>

Up to 15 digit IMSI, MSISDN, PNUM, MIN (GIPC only), or SRN

+<trace_value>,
-<trace_value> or
<decimal_number>

trace value is one of: SUB_TRAN, SUB_SS7, TIMON,


REALTIME, B3, B2, B1, B0 (see Table 23)

Table 23. Trace Values

TIMON

Value

Function

SUB_TRAN

Subscriber trace transaction events

SUB_SS7

Subscriber trace network events

TIMON

TiMON trace events

REALTIME

Real time trace events

B3, B2

Bits 2 and 3 are spare

B1, B0

Reserved for GSM trace, but currently unused

Tracking Initiation and MONitoring (TIMON) is software that starts and


stops network-wide tracing of an individual key, for example a
subscribers MSISDN, and stores, processes and displays the tracing
data that it collects. TIMON collects data from MSCs, HLRs and SCCP
Relays.
TIMON is a powerful tool for investigating problems experienced by
individual subscribers. For an individual MSISDN, MSCs list calls made
and received, and the HLR adds information such as changes of
location.

Home Location Register (Linux) V1.1 Support Guide

270

Chapter 12 Subscriber Commands

Figure 50. TIMON Signalling


Web
Server

Web Client

Trace Repository
Database

Network Control System

MSC

TIMON Tracing
Linked
Subscriptions

HLR

SCCPR

TIMON tracing of a linked subscription must trace the published


number for the linked subscription and all linked subscription members.

Response
C2:00024,<filter_type>,<filter_value>;
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

<filter_type> BNUM, IMSI, MSISDN, PNUM OR SRN.


<filter_value> the value that is used for the specified type of
filter.

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

271

Errors
<error_code>

<error_message>

00002

Record not found.

00099

Internal software error.

00137

Unable to set trace.

Example
Tracing
Subscriber
Events

These are examples of failed commands.


SET:TRACE,MSISDN,44775123456;
C1:00006,00003,Incorrect number of parameters;

SET:TRACE,MSISDN,44775123456,+TIMON;
C1:00002,00002,Record not found;
This is an example of a successful command for setting tracing.
SET:TRACE,MSISDN,44775000123,+TIMON;
Filter: 44775000123

(SRN)

This is an example of a successful command for removal of tracing.


SET:TRACE,MSISDN,44775000123,-TIMON;
Filter: 44775000123

(SRN)

Value

Definition

Filter: 4477500123

Lists the number used as the key for tracing, and


any other numbers associated with this key.

(SRN)

The number used as the key for tracing is a Service


Request Number or SRN. Other possible values are
IMSI, MSISDN, PNUM.

Home Location Register (Linux) V1.1 Support Guide

272

Home Location Register (Linux) V1.1 Support Guide

Chapter 12 Subscriber Commands

273

Chapter 13

Overlapping IMSI Commands

An overlapping IMSI is needed if a subscriber changes to a new SIM.


Command

Description

ADD:OVERLAP

Adds an overlapping IMSI to


the subscriber record

page 274

REPLACE:OVERLAP

Forces an overlapping IMSI


to become the current IMSI
and deletes the existing IMSI

page 276

REMOVE:OVERLAP

Removes an overlapping
IMSI from the database

page 278

Providing a New SIM


If a subscriber is supplied with a new SIM, the IMSI of the new SIM is
assigned to the subscribers existing SIM to make the new SIM usable
immediately, avoiding a changeover period when the subscriber would
not be able to use the network. The IMSI of the new SIM is called an
overlapping IMSI.

Subscription
Directory Number
(MSISDN)

SIM

New SIM

(IMSI)

(Overlapping IMSI)

The first time that the overlapping IMSI is used by an update location
operation, the overlapping IMSI becomes the actual IMSI and the
previous IMSI record is deleted. Overlapping IMSI commands enable
you to add, remove and replace overlapping IMSI information in the
subscriber record. The overlapping IMSI is assigned to the current IMSI
in the same manner as the original IMSI is to the MSISDN.

Home Location Register (Linux) V1.1 Support Guide

274

Chapter 13 Overlapping IMSI Commands

ADD:OVERLAP
Adds an overlapping IMSI to the subscriber record. Only one
overlapping IMSI can be associated with the record, any attempts to
add a second one are rejected.

Syntax
ADD:OVERLAP,<current_imsi>,
<overlap_imsi>(,<expiry_timeout>);

Parameters
Parameter

Meaning

<current_imsi>

Number of the subscribers current IMSI

<overlap_imsi>

Number of the overlapping IMSI

<expiry_timeout>

Timeout value in days. Values are 0 to 254, the default is 30.

If the overlapping IMSI is still not in use after this time, an HLR counter
is incremented each time the current IMSI is used for an update
location operation. The default timeout value is 30 days.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found

00009

Overlapping IMSI already in use

00011

Subscriber already has overlapping IMSI

00055

Unable to access subscriber record

00099

Internal software error

00116

Unable to allocate resource

Example
ADD:OVERLAP,123456789012345,234567890123456;

Home Location Register (Linux) V1.1 Support Guide

Chapter 13 Overlapping IMSI Commands

275

GSM PDS - Overlapping IMSI Added


Subscriber IMSI - 123456789012345
Overlapping IMSI - 234567890123456

Home Location Register (Linux) V1.1 Support Guide

276

Chapter 13 Overlapping IMSI Commands

REPLACE:OVERLAP
Forces an overlapping IMSI to become the current IMSI and deletes
the existing IMSI.

Syntax
REPLACE:OVERLAP,<current_imsi>,<overlap_imsi>;

Parameters
Parameter

Meaning

<current_imsi>

Number of the subscribers current IMSI

<overlap_imsi>

Number of the overlapping IMSI

The command is accepted only if both IMSI values are for the same
subscriber, and if <overlap_imsi> has previously been set up as an
overlapping IMSI for <current_imsi>.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00008

Overlapping IMSI not pending for any subscriber.

00012

Subscriber IMSI/overlapping IMSI mismatch.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data Download failed.

00099

Internal software error.

Home Location Register (Linux) V1.1 Support Guide

Chapter 13 Overlapping IMSI Commands

277

Example
To replace a current IMSI with an overlapping IMSI:
REPLACE:OVERLAP,123456789012347,234567890123456;
GSM PDS - Overlapping IMSI Replaced
Subscriber IMSI - 123456789012347
Overlapping IMSI - 234567890123456

Home Location Register (Linux) V1.1 Support Guide

278

Chapter 13 Overlapping IMSI Commands

REMOVE:OVERLAP
Removes an overlapping IMSI from the database.

Syntax
REMOVE:OVERLAP,<current_imsi>,<overlap_imsi>;
Parameter

Meaning

<current_imsi>

Number of the subscribers current IMSI

<overlap_imsi>

Number of the overlapping IMSI

If both parameters are included, the command is accepted only if they


are for the same subscriber.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00008

Overlapping IMSI not pending for any subscriber.

00055

Unable to access subscriber record.

00099

Internal software error.

Example
To remove an overlapping IMSI:
REMOVE:OVERLAP,123456789012345,234567890123456;
GSM PDS - Overlapping IMSI Removed
Subscriber IMSI - 123456789012345
Overlapping IMSI - 234567890123456

Home Location Register (Linux) V1.1 Support Guide

279

Chapter 14

MSISDN Commands

These commands allow you to add, remove, update and view a


subscribers MSISDN. See Basic Service Commands on page 309 for
details on adding services to your MSISDN.

Command

Description

Page

ADD:MSISDN

Adds a SIM to an existing subscription (see MultiSIM on


page 46)

page 280

REMOVE:MSISDN

Remove a SIM from a MultiSIM subscription

page 282

UPDATE:MSISDN

Change the SIM type, SIM identity or authentication parameters

page 284

VIEW:MSISDN

Displays the attributes of the specified MSISDN

page 286

Home Location Register (Linux) V1.1 Support Guide

280

Chapter 14 MSISDN Commands

ADD:MSISDN
The ADD:MSISDN command adds an MSISDN to the subscriber record.
The new MSISDN does not have any associated Basic Services.

Syntax
ADD:MSISDN,<imsi>,<msisdn>,<bc_title>;

Parameters
Parameter

Meaning

<imsi>

Subscriber IMSI

<msisdn>

New or secondary MSISDN

<bc_title>

Text (of up to 16 characters) containing the Bearer Capability title associated with the main
MSISDN

Every MSISDN record must be associated with a bearer capability


title. This name is used to locate a Bearer Capability Allocation in a
table. See Bearer Capabilities (bca) table for details of this table.
See Appendix E, Basic and Supplementary Services for details of
the Bearer Services.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 14 MSISDN Commands

281

Errors
<error_code>

<error_message>

00002

Record not found.

00004

Subscriber MSISDN already in use.

00055

Unable to access subscriber record.

00059

BC title not known.

00099

Internal software error.

00116

Unable to allocate resource

00123

Subscriber already has max number of MSISDNs.

Example
To add a new MSISDN
ADD:MSISDN,123456789012345,44370123456,BS26;
GSM PDS - MSISDN Added
Subscriber IMSI - 123456789012345
MSISDN - 44370123456

Value

Definition

123456789012345

Subscriber IMSI

44370123456

New or secondary MSISDN

BS26

Bearer capability title for the MSISDN

Home Location Register (Linux) V1.1 Support Guide

282

Chapter 14 MSISDN Commands

REMOVE:MSISDN
The REMOVE:MSISDN command removes an MSISDN from a subscriber
record. You cannot remove the subscribers main MSISDN: you must
delete the subscriber to do this.

Syntax
REMOVE:MSISDN,<imsi>,<msisdn>;

Parameters
Parameter

Meaning

<imsi>

Subscriber IMSI

<msisdn>

MSISDN to remove

If the IMSI parameter is specified, the MSISDN will only be removed if it


corresponds to the same subscriber IMSI. If there is no match, the
command is rejected.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00007

Subscriber MSISDN/IMSI mismatch.

00047

Cannot remove main MSISDN.

00055

Unable to access subscriber record.

00099

Internal software error.

Example
To remove an MSISDN:
REMOVE:MSISDN,123456789012345,44370123456;
GSM PDS - MSISDN Removed
Subscriber IMSI - 123456789012345

Home Location Register (Linux) V1.1 Support Guide

Chapter 14 MSISDN Commands

283

MSISDN - 44370123456

Value

Definition

123456789012345

Subscriber IMSI

44370123456

MSISDN

Home Location Register (Linux) V1.1 Support Guide

284

Chapter 14 MSISDN Commands

UPDATE:MSISDN
The UPDATE:MSISDN command updates the bearer capability title
associated with the MSISDN.

Syntax
UPDATE:MSISDN,<msisdn>,<bc_title>;

Parameters
Parameter

Meaning

<msisdn>

Main MSISDN

<bc_title>

Text containing the Bearer Capability title associated with the MSISDN

Responses
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00055

Unable to access subscriber record

00059

BC title not known.

00099

Internal software error

00116

Unable to allocate resource

Example
In this example the specified bearer capability title is not known:
UPDATE:MSISDN,44370123455,BS126;
C1:00002,00059,BC title not known;
Value

Description

44370123455

Main MSISDN

BS126

BC title

Home Location Register (Linux) V1.1 Support Guide

Chapter 14 MSISDN Commands

285

Re-enter the command with the correct value for the bearer capability
title.
UPDATE:MSISDN,44370123456,BS26;
GSM PDS - MSISDN Updated
MSISDN - 44370123456

Value

Description

44370123456

Main MSISDN

BS26

BC title

Home Location Register (Linux) V1.1 Support Guide

286

Chapter 14 MSISDN Commands

VIEW:MSISDN
The VIEW:MSISDN command displays the attributes of the specified
MSISDN.

Syntax
VIEW:MSISDN,<msisdn>;

Parameters
Parameter

Description

<msisdn>

Main MSISDN

Response
C2:00015,<msisdn>,<bc_title>,<basic_service>,
<basic_service_group>;
This is followed by a line for each MWD associated with the subscriber
(if none are associated, none of these lines is returned):
C2:00018,<serv_centre>,<mwd_timestamp>;
the response ends with the line:
C1:00000,00000;
Parameter

Description

<msisdn>

Main MSISDN

<bc_title>

The bearer capability title associated with the MSISDN

<basic_service>

Text indicating basic service associated with MSISDN

<basic_service_group>

Basic service groups are listed in Basic Services on page 591

<serv_centre>

Numeric field, contains service centre numbers. A maximum of 19 service


centres can be specified

<mwd_timestamp>

The timestamp on the MWD (one for each service centre)

Errors
If there is an error, the fowllowing line is returned:
C1:00002,<eror_code>,(<timestamp>),

Home Location Register (Linux) V1.1 Support Guide

Chapter 14 MSISDN Commands

287

<error_message>;
<error_code>

<error_message>

00055

Unable to access subscriber record.

00099

Internal software error.

Example
To view the MSISDN:
VIEW:MSISDN,44370123456;
MSISDN: 44370123456 BC TITLE: TS11 BS: TS11
BSG: SPEECH
Service centres: 44370112233
44370112244
Value

Description

44370123456

Main MSISDN

BC TITLE

Text containing the Bearer Capability title associated with


the MSISDN

BS

Basic Service

BSG

Basic Service Group to which the Basic Service belongs

Service centres

The service centre numbers that the HLR has been told
to set message waiting for the MSISDN. A maximum of 8
service centres per message can be specified.

See Appendix E, Basic and Supplementary Services for details.

Home Location Register (Linux) V1.1 Support Guide

288

Home Location Register (Linux) V1.1 Support Guide

Chapter 14 MSISDN Commands

289

Chapter 15

Service Request Number


Commands

Use the following commands to create, delete and view the Service
Request Numbers in the database. The HLR maintains a list of Service
Request Numbers (SRNs) and their corresponding Service Access
Numbers (SANs). The numbers are used for services such as directory
enquiries and for numbers of subscribers who have exported to another
network. SRNs are allocated by the HLR. When the HLR receives a
Send Routing Information request for an SRN, it returns the SAN in
place of the roaming number.
Command

Description

Page

CREATE:SRN

Creates an SRN in the database

page 29
0

DELETE:SRN

Deletes an SRN from the database

page 29
1

UPDATE:SRN

Updates an SRNs attributes

page 29
2

VIEW:SRN

Displays the SAN (Service Access Number) and the trace status associated
with an SRN

page 29
4

Home Location Register (Linux) V1.1 Support Guide

290

Chapter 15 Service Request Number Commands

CREATE:SRN
The CREATE:SRN command creates an SRN in the database.

Syntax
CREATE:SRN,<srn>,(<san>);
Parameter

Description

<srn>

Service request number (of 8 to 11 digits)

<san>

Service access number (of 11 to 15 digits)

If the service access number is not specified, it is set up to be identical


to the service request number.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00019

Service request number already in use.

00099

Internal software error

00116

Unable to allocate resource

Example
To create an SRN:
CREATE:SRN,12345678,12345678901;
GSM PDS - Service Request Number Created
Service Request Number - 12345678
Value

Definition

12345678

SRN

12345678901

SAN

Home Location Register (Linux) V1.1 Support Guide

Chapter 15 Service Request Number Commands

291

DELETE:SRN
The DELETE:SRN command deletes an SRN from the database.

Syntax
DELETE:SRN,<srn>,(<san>);

Parameters
Parameter

Meaning

<srn>

Service request number (of 8 to 11 digits)

<san>

Service access number (of 11 to 15 digits)

If both numbers are specified, the service request number is deleted


only if it matches the service access number. If there is no match, the
command is rejected.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00021

Service request number / service access number mismatch.

00099

Internal software error.

Example
To delete an SRN:
DELETE:SRN,12345678;
GSM PDS - Service Request Number Deleted
Service Request Number - 12345678

Home Location Register (Linux) V1.1 Support Guide

292

Chapter 15 Service Request Number Commands

UPDATE:SRN
The UPDATE:SRN command updates an SRNs attributes.

Syntax
UPDATE:SRN,<srn>,<attribute>,<value>;

Parameters
Parameter

Description

<srn>

Service request number (of 8 to 11 digits)

<attribute>

Attribute to be changed

<value>

Value for the attribute

The only attribute currently supported is TRACE. The attribute values


are the same as for the UPDATE:SUB command. See Table 20 on
page 215.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00099

Internal software error.

Example
To update an SRN:
UPDATE:SRN,12345678,TRACE,0;
GSM PDS - Service Request Number Updated
Service Request Number - 12345678
Value

Description

12345678

SRN

Home Location Register (Linux) V1.1 Support Guide

Chapter 15 Service Request Number Commands

Value

Description

TRACE,0

TRACE attribute has been turned off for the service request
number

293

Home Location Register (Linux) V1.1 Support Guide

294

Chapter 15 Service Request Number Commands

VIEW:SRN
The VIEW:SRN command displays the SAN (Service Access Number)
associated with the service request number in the database, and the
trace status.

Syntax
VIEW:SRN,<srn>;

Parameters
Parameter

Description

<srn>

Service request number (8 to 11 digits)

Response
C2:00000,00061,<srn>,<san>,<trace>;
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;
Parameter

Description

<srn>

Service request number (same format as MSISDN).

<san>

Numeric field, contains service access number.

<trace>

ASCII text field. Indicates trace status.

<sdm_dest>

Name of SDM destination HLR (if SRN moved).

Errors
<error_code>

<error_message>

00099

Internal software error

Example
To display the SAN:
VIEW:SRN,12345678;

SRN: 12345678, SAN: 12345678901,


SDMed to: GHLRA

Home Location Register (Linux) V1.1 Support Guide

TRACE: 0

Chapter 15 Service Request Number Commands

295

Value

Description

12345678

SRN

12345678901

SAN

Trace Status

Value for the trace attribute

GHLRA

Name of SDM destination HLR (if SRN moved)

Home Location Register (Linux) V1.1 Support Guide

296

Chapter 15 Service Request Number Commands

Home Location Register (Linux) V1.1 Support Guide

297

Chapter 16

PDP Context Commands

Use the following commands to add, update and remove Packet Data
Protocol Contexts (PDP Contexts). The HLR maintains a list of PDP
contexts, which define which data services the subscriber can use via
the General Packet Radio Service (GPRS). The maximum number of
PDP contexts that a subscriber can have is defined by MAX_PDP in
the HLR_CONFIG table.

Command

Description

Page

ADD:PDP

Adds a single blank PDP context to a subscriber

page 298

SET:PDP

Sets PDP data

page 300

UPDATE:PDP

Populates a new PDP context with data, or changes an existing


profile

page 302

REMOVE:PDP

Removes a PDP Context from a specified subscriber

page 306

Home Location Register (Linux) V1.1 Support Guide

298

Chapter 16 PDP Context Commands

ADD:PDP
The ADD:PDP command adds a single blank PDP context to a
subscriber using the <pdp_id> PDP context identity.
The PDP context allocated will initially be DISABLED and, therefore,
cannot be used and will not initiate subscriber data download. In order
to use the PDP Context, it must be populated with data and activated
using the UPDATE:PDP command (see page 302).

Syntax
ADD:PDP,IMSI|MSISDN,<key_value>,<pdp_id>;
This command causes the HLR to allocate a blank (or default) PDP.

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether the <key_value> used to locate the subscriber record is an IMSI or
MSISDN.

<key_value>

Numeric field containing either the subscriber IMSI (or overlapping IMSI) or MSISDN

<pdp_id>

Number from 1 to 50 indicating the identifier for a new subscriber PDP context

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 16 PDP Context Commands

299

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00099

Internal software error.

00116

Unable to allocate resource.

00118

Subscriber already has maximum number of PDP Contexts.

00119

Incorrect address for PDP type.

Example
To add a PDP context:
ADD:PDP,MSISDN,123412341234,1;
GSM PDS - PDP Added
MSISDN

- 123412341234

The PDP context must be from 1 to 50. The command below attempts
to set a value of 0:
ADD:PDP,MSISDN,123412341234,0;
C1:00007,00003,Invalid parameter value;

Home Location Register (Linux) V1.1 Support Guide

300

Chapter 16 PDP Context Commands

SET:PDP
This command is used to set PDP data..

Syntax
SET:PDP,<key_type>,<key>,<pdp_id>,(<state>),
(<type>),(<address>),(<apn>),(<free_apn>),
(<ext_qos_flag>),(<qos>),(<ext_qos>),(<charging>),
(<vplmn_allow>);

Parameters
Parameter

Meaning

<key_type>

IMSI or MSISDN.

<key>

Number for IMSI or MSISDN.

<pdp_id>

Identity of PDP (value 1 to 50).

<state>

Status of PDP context: ENABLED or DISABLED.

<type>

Type of PDP context: IPV4 or IPV6. (This can be determined from the format of
<address>, but is kept for consistency with UPDATE:PDP.

<address>

Static address for the PDP context. The reserved address NONE removes any
address already specified. Address is specified in IP V4 or V6 as indicated by

<type>.
<apn>

Access point name.

<free_apn>

Flag indicating whether PDP context is free of charge: TRUE or FALSE.

<ext_qos_flag>

Flag indicating whether quality of service extension is used: TRUE or FALSE.

<qos>

Quality of service, in format a-b-c-d-e.

<ext_qos>

Extended quality of service, in format a-b-c-d-e-f-g-h-i-j-k-l-m.

<charging>

Charging statistics: HOT_BILLING, PREPAID, FLAT_RATE, NORMAL. Space


delimited set enclosed in braces {}.

<vplmn_allow>

Flag indicating whether VPLMN is allowed: TRUE or FALSE.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 16 PDP Context Commands

301

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00099

Internal software error.

00116

Unable to allocate resource.

00119

Incorrect address for PDP type.

00121

Unable to enable PDP context, type not set.

Example
SER:PDP,IMSI,234150000000000,1,ENABLED,IPV4,,
w.a.com,FALSE,1-1-1-1-1,1-1-1-1-1-1-1-1-1-1-1-1-1,
{HOT_BILLING],FALSE;
GSM PDS - PDP Set

Home Location Register (Linux) V1.1 Support Guide

302

Chapter 16 PDP Context Commands

UPDATE:PDP
Update to populate a new PDP context with data, or to change an
existing profile.
To populate a new PDP context, add to the PDP context using a
number of UPDATE:PDP commands, finishing by changing the state to
ENABLED so that the PDP context can be used.
If UPDATE:PDP is used to change two or more fields of an existing PDP
context, DISABLE the PDP context first, change the fields using
UPDATE:PDP commands, and then re-enable the PDP context.
Disabling the context avoids needless download of all interim changes
to the PDP-Context to the SGSN.
Changing a PDP context sometimes changes the HLR maintained
SGSN image, thereby causing a download of data to the SGSN.
Changing the STATE of a PDP context will result in its insertion or
deletion from the SGSN.

Syntax
UPDATE:PDP,IMSI|MSISDN,<key_value>,<pdp_id>,
<attribute>,<value>;

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether the <key_value> used to locate the subscriber record is an IMSI or
MSISDN.

<key_value>

Numeric field containing either the subscriber IMSI (or overlapping IMSI) or MSISDN

<pdp_id>

Numeric value indicating the identifier for a new subscriber PDP context (Value in the
range 1..50)

<attribute>

Text field indicating the precise field to update within the specified PDP Context. See
Table 24 below.

<value>

Type and permissible values depend on the value of <attribute>. See Table 24 below.

Table 24. PDP Context Attributes


<attribute>

<value>

ADDRESS

Optional text giving static address for the PDP Context. The reserved address NONE
removes any address already specified, in IPV4 or IPV6 format, for the PDP Context.

APN

Text indicating the access point name.

CHARGING

Text indicating charging characteristics (HOT_BILLING, PREPAID, FLAT_RATE or


NORMAL). Space-delimited set enclosed in braces {}.

Home Location Register (Linux) V1.1 Support Guide

Chapter 16 PDP Context Commands

303

Table 24. PDP Context Attributes


<attribute>

<value>

EXT_QOS

13 numbers, separated by hyphens, each representing an extended quality of service


(QoS) parameter. It has the format:
a-b-c-d-e-f-g-h-i-j-k-l-m
a to m are integers in the range 0 to the following maximum values:
a=255; b=7; c=3; d=7; e=255; f=255; g=255; h=15; i=15; j=63; k=3; l=255; m=255
Each number specifies a different quality of service parameter, such as bit rate and
priority.

FREE_APN

Text indicating whether the PDP Context is free of charge. (TRUE/FALSE).

QOS

5 fields that indicate the quality of service (see Table 21 on page 233 meanings of the
fields).

STATE

Text indicating the status of the PDP Context (ENABLED / DISABLED)

TYPE

Text indicating the type of PDP Context (IPV4 / IPV6)

VPLMN_ALLOW

Text field indicating whether the VPLMN is allowed or not. (TRUE / FALSE).

When using the UPDATE:PDP command, remember that:


A PDP context STATE can not be ENABLED unless TYPE is
specified.
A PDP address must be in the format specified by the TYPE
attribute. Therefore, TYPE must be set before adding a PDP
address. A PDP Context is initially created with no value for TYPE
and therefore cannot have an address associated with it. See PDP
Address Types below.
The TYPE of a PDP context cannot be changed if there is an
associated PDP address. Therefore, any addresses must be
removed before changing a PDP type by entering:
UPDATE:PDP, IMSI|MSISDN, <key_value>, <pdp_id>,
ADDRESS, NONE;

PDP Address
Types

The HLR only allows the specification of IPv4 and IPv6 addresses.

IPv4 Addresses

The format of an IPv4 address is:


nnn.nnn.nnn.nnn
where nnn is a decimal number between 0 and 255
IPv4 addressing is a subset of IPv6 addressing and therefore IPv4
addresses can be expressed in IPv6 format. However, the HLR does
not allow address formats to be interchangeable, and does not accept
or display an IPv4 address in an IPv6 format.

IPv6 Addresses

The format of an IPv6 address is:


xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx

Home Location Register (Linux) V1.1 Support Guide

304

Chapter 16 PDP Context Commands

where: xxxx is a hexadecimal number from 0 to FFFF


IPv6 addresses can be compressed by substituting :: for long strings
of zeros. However, :: must only be used once in the address, as
shown in the examples in the table below.
Uncompressed

Compressed

1080:0:0:0:8:800:200C:417A

1080::8:800:200C:417A

FF01:0:0:0:0:0:0:43

FF01::43

0:0:0:0:0:0:0:1

::1

0:0:0:0:0:0:0:0

::

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download


failed.

00099

Internal software error.

00116

Unable to allocate resource.

00119

Incorrect address for PDP type.

00120

Context Id not in use by subscriber.

00121

Unable to enable PDP context, type not set.

Example
An IP address cannot be specified for a PDP context until the TYPE
attribute has been specified:

UPDATE:PDP,MSISDN,123412341234,1,ADDRESS,100.13.12
3.20;
C1:00002,00119,Incorrect address for PDP type;

Home Location Register (Linux) V1.1 Support Guide

Chapter 16 PDP Context Commands

305

To specify a type of IP address for PDP context number 1:


UPDATE:PDP,MSISDN,123412341234,1,TYPE,IPV4;
GSM PDS - PDP Updated
MSISDN

- 123412341234

An IP address can now be specified:


UPDATE:PDP,MSISDN,123412341234,1,ADDRESS,100.13.12
3.20;
GSM PDS - PDP Updated
MSISDN

- 123412341234

Home Location Register (Linux) V1.1 Support Guide

306

Chapter 16 PDP Context Commands

REMOVE:PDP
The REMOVE:PDP command removes a PDP Context from a
specified subscriber.
Removing a PDP context sometimes changes the HLR maintained
SGSN image, thereby causing a download of data to the SGSN.

Syntax
REMOVE:PDP,IMSI|MSISDN,<key_value>,<pdp_id>;

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether the <key_value> used to locate the subscriber record is an IMSI or
MSISDN.

<key_value>

Numeric field containing either the subscriber IMSI (or overlapping IMSI) or MSISDN.

<pdp_id>

Number from 1 to 50 or *. Indicates the identifier for a new subscriber PDP context. *
removes all PDP contexts for a subscriber.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
To remove PDP context 1:
REMOVE:PDP,MSISDN,123412341234,1;
GSM PDS - PDP Removed

Home Location Register (Linux) V1.1 Support Guide

Chapter 16 PDP Context Commands

MSISDN

307

- 123412341234

Home Location Register (Linux) V1.1 Support Guide

308

Home Location Register (Linux) V1.1 Support Guide

Chapter 16 PDP Context Commands

309

Chapter 17

Basic Service Commands

You can add or delete basic services to and from a subscribers record
as you require. Basic services provide the main speech and data
services for the subscriber. See Appendix E, Basic and Supplementary
Services for details of the basic services for the HLR.

Command

Description

ADD:SERVICE

Adds a basic service to the


subscribers record

page 310

REMOVE:SERVICE

Removes a basic service from the


subscribers record

page 312

Home Location Register (Linux) V1.1 Support Guide

310

Chapter 17 Basic Service Commands

ADD:SERVICE
The ADD:SERVICE command adds a basic service to the subscribers
record.

Syntax
ADD:SERVICE,MSISDN|IMSI,<key_value>,<bs>;
Parameter

Meaning

MSISDN|IMSI

IMSI or MSISDN, whichever is used to locate the subscriber record

<key_value>

IMSI or MSISDN (depending on the key)

<bs>

The basic service as specified in Appendix E, Basic and Supplementary Services.

Note: Mandatory services (for example, the emergency services) must


be added using this command. These services are not set-up
automatically.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
In this example of adding a basic service to a subscriber record, the
MSISDN is not in use:
ADD:SERVICE,MSISDN,44370123456,TS12;

Home Location Register (Linux) V1.1 Support Guide

Chapter 17 Basic Service Commands

311

C1:00002,00005,Subscriber MSISDN not in use;


Value

Definition

44370123456

Main MSISDN

TS12

Service to be added

Reissue the command with the correct MSISDN.


This example adds service TS12 (the emergency service) to the
subscribers IMSI.
ADD:SERVICE,IMSI,123456789012345,TS12;
GSM PDS - Basic Service Added
Subscriber IMSI - 123456789012345

Value

Definition

123456789012345

Subscriber IMSI

TS12

Service to be added

Home Location Register (Linux) V1.1 Support Guide

312

Chapter 17 Basic Service Commands

REMOVE:SERVICE
The REMOVE:SERVICE command removes a basic service from the
subscribers record.

Syntax
REMOVE:SERVICE,MSISDN|IMSI,<key_value>,<bs>;
Parameter

Meaning

MSISDN|IMSI

IMSI or MSISDN, whichever is used to locate the subscriber record

<key_value>

IMSI or MSISDN (depending on the key)

<bs>

The basic service as specified in Appendix E, Basic and


Supplementary Services

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
This example shows removing service TS22 (the Short Message,
Mobile Originated service) from the subscribers MSISDN.
REMOVE:SERVICE,MSISDN,44370123456,TS22;
GSM PDS - Basic Service Removed

Home Location Register (Linux) V1.1 Support Guide

Chapter 17 Basic Service Commands

313

Subscriber IMSI - 123456789012345

Value

Definition

123456789012345

Subscriber IMSI

44370123456

Main MSISDN

Home Location Register (Linux) V1.1 Support Guide

314

Home Location Register (Linux) V1.1 Support Guide

Chapter 17 Basic Service Commands

315

Chapter 18

Supplementary Service
Commands

These commands are for supplementary subscriber services; a range


of subscriber and service provider options. See Appendix E, Basic and
Supplementary Services for details of the services supported by the
HLR.
Command

Description

PROVISION:SS

Gives the subscriber the ability


to use a specified
supplementary service

page 318

WITHDRAW:SS

Removes a supplementary
service from a subscriber

page 320

REGISTER:SS

Registers and activates an


individual call forwarding service

page 322

ERASE:SS

Erases a service

page 325

ACTIVATE:SS

Activates a supplementary
service

page 327

DEACTIVATE:SS

Deactivates a supplementary
service

page 329

The table below shows which commands apply to which services.


Table 25. Supplementary Services and Commands
Supplementary
Service

PROVISION

WITHDRAW

REGISTER

ERASE

ACTIVATE

DEACTIVATE

ACR

YES

YES

NO

NO

YES

YES

AOCC

YES

YES

NO

NO

NO

NO

AOCI

YES

YES

NO

NO

NO

NO

ARSENIC

YES

YES

NO

NO

NO

NO

BAIC

YES

YES

NO

NO

YES

YES

BAOC

YES

YES

NO

NO

YES

YES

BICROAM

YES

YES

NO

NO

YES

YES

BOIC

YES

YES

NO

NO

YES

YES

BOICXHC

YES

YES

NO

NO

YES

YES

CFB

YES

YES

YES

YES

YES

YES

CFNRC

YES

YES

YES

YES

YES

YES

CFNRY

YES

YES

YES

YES

YES

YES

Home Location Register (Linux) V1.1 Support Guide

316

Chapter 18 Supplementary Service Commands

Table 25. Supplementary Services and Commands (Continued)


Supplementary
Service

PROVISION

WITHDRAW

REGISTER

ERASE

ACTIVATE

DEACTIVATE

CFU

YES

YES

YES

YES

YES

YES

CLIP

YES

YES

NO

NO

NO

NO

CLIR

YES

YES

NO

NO

NO

NO

COLP

YES

YES

NO

NO

NO

NO

COLR

YES

YES

NO

NO

NO

NO

CW

YES

YES

NO

NO

YES

YES

DCFB

YES

YES

YES

YES

NO

NO

DCFNRY

YES

YES

YES

YES

NO

NO

DCFNRC

YES

YES

YES

YES

NO

NO

ECT

YES

YES

NO

NO

NO

NO

HOLD

YES

YES

NO

NO

NO

NO

LINKED

YES

YES

NO

NO

NO

NO

MPTY

YES

YES

NO

NO

NO

NO

MVPN_FNP

YES

YES

NO

NO

NO

NO

OICK

Not a supplementary service. See UPDATE:SUB on page 215.

OIN

YES

YES

NO

NO

NO

NO

PREPAY_IC

YES

YES

NO

NO

NO

NO

PRIORITY

YES

YES

NO

NO

NO

NO

RECALL

YES

YES

NO

NO

NO

NO

SMSB

YES

YES

NO

NO

NO

NO

SUBTYPE

YES

YES

NO

NO

NO

NO

TICK

YES

YES

NO

NO

NO

NO

TICKROAM

YES

YES

NO

NO

NO

NO

TRIG_A

YES

YES

NO

NO

NO

NO

TRIG_B

YES

YES

NO

NO

NO

NO

TRIG_C

YES

YES

NO

NO

NO

NO

Home Location Register (Linux) V1.1 Support Guide

Chapter 18 Supplementary Service Commands

317

Command Meanings
Commands for supplementary services are grouped into 3 pairs with
different purposes:
Command Pair

Meaning

PROVISION/WITHDRAW

PROVISION permits a subscriber to use a supplementary service and assigns


service parameters to the subscriber, but does not specify parameter values.
WITHDRAW removes a supplementary service and its parameters.

REGISTER/ERASE

REGISTER defines parameters that a supplementary service requires, such


as a forwarding number for call forwarding services. ERASE removes service
parameters.

ACTIVATE/DEACTIVATE

ACTIVATE switches on a supplementary service. DEACTIVATE switches off a


supplementary service without removing the service or changing its
parameters.

Note: The network operator can allow subscribers to define


supplementary service parameters and to activate and deactivate
services from a mobile handset. Subscribers cannot provision or
withdraw supplementary services.

Home Location Register (Linux) V1.1 Support Guide

318

Chapter 18 Supplementary Service Commands

PROVISION:SS
The PROVISION:SS command gives the subscriber the ability to use a
specified supplementary service.

Syntax
PROVISION:SS,MSISDN|IMSI,<key_value>,<ss>;
Parameter

Meaning

IMSI|MSISDN

Indicates whether the <key_value> number, which


identifies the subscription, is an IMSI or MSISDN

<key_value>

IMSI or MSISDN

<ss>

Supplementary service code. See Appendix E, Basic


and Supplementary Services for details of the values of
supplementary services supported by the HLR.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;
Note: Specifying OICK as a supplementary service always returns a
success, although it performs no action on the HLR.

Errors
<error_code>

<error_message>

00002

Record not found.

00036

Subscriber already has P number.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
This example shows provisioning the subscriber with the
supplementary service CFU (Call Forwarding Unconditional).
PROVISION:SS,IMSI,123456789012345,CFU;

Home Location Register (Linux) V1.1 Support Guide

Chapter 18 Supplementary Service Commands

319

GSM PDS - Supplementary Service Provisioned


Subscriber IMSI - 123456789012345

Home Location Register (Linux) V1.1 Support Guide

320

Chapter 18 Supplementary Service Commands

WITHDRAW:SS
The WITHDRAW:SS command removes a supplementary service from
a subscriber. Once a service is withdrawn, it cannot be used by the
subscriber. Withdrawing a service automatically deactivates and
erases it.

Syntax
WITHDRAW:SS,MSISDN|IMSI,<key_value>,<ss>;

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether the <key_value> number, which identifies the subscription, is an IMSI
or MSISDN

<key_value>

IMSI or MSISDN (depending on the key)

<ss>

Supplementary service code

See Appendix E, Basic and Supplementary Services for details of the


values of supplementary services supported by the HLR.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;
Note: specifying OICK as a supplementary service always returns
success, although it performs no action on the HLR.

Home Location Register (Linux) V1.1 Support Guide

Chapter 18 Supplementary Service Commands

321

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
This example shows withdrawing the supplementary service CFU (Call
Forwarding Unconditional) from the subscriber. Once a service is
withdrawn, it has to be provisioned again before it can be used by the
subscriber.
WITHDRAW:SS,IMSI,123456789012345,CFU;
GSM PDS - Supplementary Service Withdrawn
Subscriber IMSI - 123456789012345

Home Location Register (Linux) V1.1 Support Guide

322

Chapter 18 Supplementary Service Commands

REGISTER:SS
The REGISTER:SS command registers and activates an individual call
forwarding service. It is used either by the service provider or the
subscriber (using an equivalent network message). For an overview of
call forwarding, see Call Forwarding on page 7.

Syntax
REGISTER:SS,IMSI|MSISDN,<key_value>,
<ss>,(<bsg>),<ftn>,(<timer>),(<ss_mode>);

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether the <key_value> number, which identifies the subscription, is an IMSI
or MSISDN

<key_value>

IMSI or MSISDN (depending on the key)

<ss>

Text indicating the supplementary service to register (Supplementary Services on


page 594 lists supplementary services)

<bsg>

Basic Service Group - see Appendix E, Basic and Supplementary Services for details of
the basic services supported by the HLR

<ftn>

The forwarded to number (C-number) in international format. If the number is to a private


wire or virtual private network, the number is preceded by a hyphen (-). <ftn> is checked
against the C Number Table (CNUM) to make sure that the forward-to number is allowed.
The HLR analyses the forward-to number to derive an <ftn> behaviour mode, which
identifies the type of call forwarding being set.:
If <ftn> is a hyphen (-) followed by the SMS Bureau service short code (122 in the UK)
the number of the SMS Bureau service operator becomes the forward-to number and
the behaviour mode is set to SMSB. The subscriber does not have the MVPN_FNP
supplementary service, and a match is not found in the Address String Convert
(ASCVT) Table.
If <ftn> is a hyphen (-) followed by the RECALL short code (121 in the UK), and the
subscriber has the RECALL service, the forward-to number is the mailbox number. The
subscriber does not have the MVPN_FNP supplementary service, and a match is not
found in the Address String Convert (ASCVT) Table.
If <ftn> begins with a hyphen (-) and the forward-to number is not the SMSB or
RECALL number, the behaviour mode of the divert is set to SE. The subscriber has the
MVPN_FNP supplementary service, or a match is not found in the Address String
Convert (ASCVT) Table, the forward-to number is not the SMSB or RECALL short
code, and the subscriber has the ARSENIC supplementary service provisioned.
If the <ftn> does not begin with a hyphen (-), the behaviour mode is set to GSM. The
subscriber does not have MVPN_FNP supplementary service, and a match is found in
the Address String Convert (ASCVT) Table.
Behaviour modes are described in Table 26 on page 323 and can be overridden using the
<SS_MODE> parameter.
For an overview of call forwarding, see Call Forwarding on page 7.

<timer>

No reply condition timer. Values are 5 to 30 seconds in 5 second steps.

<ss_mode>

Optional parameter to override the behaviour mode derived from the <ftn>. Values for the
behaviour mode are GSM, RECALL, SE, and SMSB, described in Table 26.

Home Location Register (Linux) V1.1 Support Guide

Chapter 18 Supplementary Service Commands

323

Table 26. Supplementary Service Behaviour Modes


Behaviour
Mode

Description

GSM

Normal forward-to behaviour. Behaviour mode set via the subscribers handset, or by the
administration centre. The forward-to number itself is stored in the HLR.

SMSB

SMS Bureau. Behaviour mode set via USSD or via divert special. The forward-to number is
the subscribers own MSISDN with a known prefix.
The forward-to number as displayed by the VIEW:SUB admin command, and by enquiry from
the handset, is not the same as the number returned in the response to the SRI that the HLR
had received. The forward-to number is shown as the value of the SMSB_OPERATOR_NUM
field in the hlr_config table. The number actually returned is xxxyyyyyyyyyyyy, where xxx is the
value of the SMSB_PREFIX field in the hlr_config table, and yyyyyyyyyyyy is the subscribers
MSISDN number.

RECALL

Normal divert behaviour. Behaviour mode set via the MLR. The number stored within the
database is the diverted to number.

SE

Special Extended. Behaviour mode set by a subscriber with the ARSENIC supplementary
service (Ability to Register Special/Extended Numbers in Call-forwards), CAMEL or both
ARSENIC and CAMEL. The number stored within the database is the forward-to number.
The HLR further categorizes the SE behaviour mode internally as described in Forward-To
Number Behaviour Modes on page 8. These internal SE behaviour modes cannot be changed
using an administration command, but can be viewed using the VIEW:SUB command.

If the basic service group is not specified, the command applies to all
the subscribers basic service groups. For example, the basic service
group speech applies to the telephony basic service.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

324

Chapter 18 Supplementary Service Commands

Errors
<error_code>

<error_message>

00002

Record not found.

00023

Data missing error.

00024

Unexpected data value error.

00025

Illegal SS operation error.

00026

SS error status.

00027

Bearer service not provisioned.

00028

Teleservice not provisioned.

00048

Unable to register supplementary service

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
In this example CFNRY (Call Forwarding on No Reply) is set for the
subscriber for the speech basic service group, with a 20 second timer
value and behaviour mode special extended.
REGISTER:SS,MSISDN,44370123456,CFNRY,SPEECH,
23456789012,20,SE;
GSM PDS - Supplementary Service Registered
Subscriber IMSI - 123456789012345
Value

Definition

44370123456

Subscriber MSISDN

23456789012

Forwarded to number

123456789012345

Subscriber IMSI

Home Location Register (Linux) V1.1 Support Guide

Chapter 18 Supplementary Service Commands

325

ERASE:SS
The ERASE:SS command erases a service. It is used either by the
service provider or the subscriber (using an equivalent network
message) to delete information supplied to a service. Erased services
are deactivated.

Syntax
ERASE:SS,IMSI|MSISDN,<key_value>,<ss>,(<bsg>);

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether the <key_value> number, which identifies the subscription, is an


IMSI or MSISDN

<key_value>

IMSI or MSISDN (depending on the key)

<ss>

Supplementary service code. See Appendix E, Basic and Supplementary Services.

<bsg>

Basic service group. See Appendix E, Basic and Supplementary Services.

If the basic service group is not specified, the command applies to all
the subscribers basic service groups. For example, the basic service
group speech applies to the telephony basic service.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

326

Chapter 18 Supplementary Service Commands

Errors
<error_code>

<error_message>

00002

Record not found.

00024

Unexpected data value error.

00025

Illegal SS operation error.

00026

SS error status.

00049

Unable to erase supplementary service.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
In this example CFNRY (Call Forwarding on No Reply) is erased for the
subscriber for the speech basic service group.
ERASE:SS,MSISDN,44370123456,CFNRY,SPEECH;
GSM PDS - Supplementary Service Erased
Subscriber IMSI - 123456789012345
Value

Definition

44370123456

Subscriber MSISDN

123456789012345

Subscriber IMSI

Home Location Register (Linux) V1.1 Support Guide

Chapter 18 Supplementary Service Commands

327

ACTIVATE:SS
The ACTIVATE:SS command activates a supplementary service. For
example: call barring. It is used either by the service provider or the
subscriber (using an equivalent network message).

Syntax
ACTIVATE:SS,IMSI|MSISDN,<key_value>,<ss>,(<bsg>);

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether an IMSI or the MSISDN is used to locate the subscriber record

<key_value>

IMSI or MSISDN

<ss>

Service code. For <ss> values, see Supplementary Services on page 594.

<bsg>

Basic service group

If the basic service group is not specified, the command applies to all
the subscribers basic service groups. For example, the basic service
group speech applies to the telephony basic service.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

328

Chapter 18 Supplementary Service Commands

Errors
<error_code>

<error_message>

00002

Record not found.

00024

Unexpected data value error.

00025

Illegal SS operation error.

00026

SS error status.

00050

Unable to activate supplementary service.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
In this example the BOICXHC (Bar all Outgoing International Calls
except those to Home Country) is activated for the basic service group
called speech.
ACTIVATE:SS,MSISDN,44370123456,BOICXHC,SPEECH;
GSM PDS - Supplementary Service Activated
Subscriber IMSI - 123456789012345
Value

Definition

44370123456

Subscriber MSISDN

123456789012345

Subscriber IMSI

Home Location Register (Linux) V1.1 Support Guide

Chapter 18 Supplementary Service Commands

329

DEACTIVATE:SS
The DEACTIVATE:SS command deactivates a supplementary service.
It is used either by the service provider or the subscriber (using an
equivalent network message). The service can be reactivated when the
subscriber wants to use it again.

Syntax
DEACTIVATE:SS,IMSI|MSISDN,<key_value>,<ss>,(<bsg>)
;

Parameters
Parameter

Meaning

IMSI|MSISDN

Indicates whether the <key_value> number, which identifies the subscription, is


an IMSI or MSISDN

<key_value>

IMSI or MSISDN (depending on the key)

<ss>

Service code

<bsg>

Basic service group. See Appendix E, Basic and Supplementary Services.

If the basic service group is not specified, the command applies to all
the subscribers basic service groups. For example, the basic service
group speech applies to the telephony basic service.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

330

Chapter 18 Supplementary Service Commands

Errors
<error_code>

<error_message>

00002

Record not found.

00024

Unexpected data value error.

00025

Illegal SS operation error.

00026

SS error status.

00051

Unable to deactivate supplementary service.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
In this example the BOICXHC (Bar all Outgoing International Calls
except those to Home Country) is deactivated for the basic service
group called speech.
DEACTIVATE:SS,MSISDN,44370123456,BOICXHC,SPEECH;
GSM PDS - Supplementary Service Deactivated
Subscriber IMSI - 123456789012345
Value

Definition

44370123456

Subscriber MSISDN

123456789012345

Subscriber IMSI

Home Location Register (Linux) V1.1 Support Guide

331

Chapter 19

CAMEL Commands

These commands control services enabled by Customised


Applications for Mobile Enhanced Logic (CAMEL).
Command

Description

ADD:CAMEL

Adds CAMEL subscription


information

page 332

REMOVE:CAMEL

Remove a specific CAMEL


subscription information trigger
detection point data from a
subscriber

page 373

SET:CAMEL

Sets CAMEL subscription


information for a subscriber.

page 362

UPDATE:CAMEL

Changes subscription information


for a CAMEL trigger detection point
(TDP)

page 375

CAMEL is used when a subscriber is roamed outside the home


network, and allows the home network to monitor and control calls.
Uses of CAMEL include roaming for pre-pay subscribers and special
numbers, such as 121 to retrieve Voicemail, that work everywhere.

CAMEL Triggers

CAMEL services can be triggered by mobile originated (outgoing) calls,


mobile terminated (incoming) calls, GPRS sessions and other events.
Each type of event is known as a trigger detection point (TDP) and has
its own CAMEL data.

Home Location Register (Linux) V1.1 Support Guide

332

Chapter 19 CAMEL Commands

ADD:CAMEL
The ADD:CAMEL command adds CAMEL subscription information (CSI)
data for a trigger detection point (TDP) and sets any unspecified
CAMEL data to initial values.
Command parameters vary depending on the type of CAMEL
subscription information (CSI) being added. The HLR supports the
following types of CSI:
Originating CSI (O-CSI), see page 332.
GPRS CSI (GPRS-CSI), see page 336.
Mobile Originated SMS CSI (MOSMS-CSI), see page 339.
Terminating CSI (T-CSI), see page 342.
Dialled Subscribed Services CSI (D-CSI), see page 345.
VMSC Trigger CSI (VT-CSI), see page 348.
Mobility Management CSI (M-CSI), see page 351.
Supplementary Service CSI (SS-CSI), see page 355.
Unstructured Supplementary Service Data CSI (U-CSI), see
page 359.
Some examples of specifying CAMEL services are shown on
page 358.

CAMEL Service
Behaviour

The behaviour of CAMEL services depends on subscriber data and on


which CAMEL phases are supported by the VLR or SGSN the
subscriber is registered on.
See How VLR and SGSN CAMEL Support Affects Services on
page 22 for how VLR and SGSN support of CAMEL affects services.
See Interaction of Multiple CAMEL Trigger Detection Points on
page 23 for how multiple trigger detection points (TDP) for a call
type affects services.
See Interaction Between Multiple CAMEL Subscription Types on
page 24 for how specifying CAMEL for multiple call types affects
services.

Originating CSI (O-CSI)


Syntax
ADD:CAMEL,IMSI|MSISDN, <key_value>, OCSI_<tdp>,
<gsmscf_addr>, <service_key>, <default_ch>,

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

333

{<cch>}, {<no_svc_unsupp_bh>}, {<lc_unsupp_bh>},


(<csi_active>), (<cse_notify>);

Parameters
Table 27. ADD:CAMEL Parameters for O-CSI
Parameter

Values

Default

Mandatory
/Optional

IMSI|MSISDN

IMSI or
MSISDN

None

Mandatory

Text field that indicates whether


the number <key_value>, used
to locate a subscriber record, is
an IMSI or an MSISDN.

<key_value>

IMSI digits or
MSISDN digits

None

Mandatory

Numeric field containing either


the subscriber IMSI or MSISDN

OCSI_<tdp>

OCSI_2 or
OCSI_4

None

Mandatory

OCSI_2 triggers when CAMEL


subscription information has
been collected and analysed.
OCSI_4 triggers if establishing
the call fails

<gsmscf_addr>

A valid global
title or the
reserved word
DEFAULT.

None

Mandatory

Numeric field containing the


global title of network entity that
invokes CAMEL service logic for
originating calls.
DEFAULT indicates that the
global title defined by the
CAMEL_GSMSCF entry in the
hlr_config Table.

<service_key>

Numeric field. 0
to 231- 1.

None

Mandatory

Represents either a single


CAMEL service or multiple
CAMEL services.

<default_ch>

Text field.
CONTINUE or
RELEASE

None

Mandatory

Identifies whether a call will


continue or be released if an
error occurs during call setup.
Calls can be allowed to continue
or stopped, depending on
subscriber type, such as
whether a subscriber is pre-pay
or contract.

Description

Home Location Register (Linux) V1.1 Support Guide

334

Chapter 19 CAMEL Commands

Table 27. ADD:CAMEL Parameters for O-CSI (Continued)


Parameter

Values

Default

Mandatory
/Optional

<cch>

For OCSI_2:
minimum is 1, 2
or 3
threshold is 1, 2
or 3
maximum is 1,
2 or 3

3-3-3

Optional

CAMEL capability handling


defined as a list of 3 values,
separated by hyphens. The list
has the format:
minimum-threshold-maximum
The list is optional, but if the list
is present, all values must be
specified.
Determines how the HLR
downloads a TDP and which
bars will be invoked at each
possible download phase.
minimum: CAMEL phase at
which the TDP was introduced
according to MAP specifications.
threshold: Permissible CAP
protocol levels capable of
supporting CAMEL data
maximum: Maximum HLR
CAMEL support.
The CCH list must conform to :
minimum <= threshold <=
maximum

None

Optional

Previously only provisioned for


CAMEL via UPDATE:SUB
command.
Trigger detection point OCSI_2
does not use this value. OCSI_2
uses the value specified for the
OICK supplementary service
using the UPDATE:SUB
command. See
NO_SVC_UNSUPP_BH on
page 218.
Service bars to be invoked if the
subscriber has CAMEL services
for originating calls, and the VLR
on which registration is
attempted does not support
CAMEL.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

For OCSI_4:
minimum is 3
threshold is 3
maximum is 3

<no_svc_unsupp_bh>

{<odb>
<odb>...}
{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Home Location Register (Linux) V1.1 Support Guide

Description

Chapter 19 CAMEL Commands

335

Table 27. ADD:CAMEL Parameters for O-CSI (Continued)


Parameter

Values

Default

Mandatory
/Optional

<lc_unsupp_bh>

{<odb>
<odb>...}
{}

None

Optional

Service bars to be invoked if the


subscriber has CAMEL services
for outgoing calls and the VLR
on which registration is
attempted supports CAMEL at a
lower phase than required.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Description

<csi_active>

TRUE/FALSE

TRUE

Optional

Not used by the HLR.

<cse_notify>

TRUE/FALSE

FALSE

Optional

Not used by the HLR.


Defines whether a change to
CSI data causes a Note
Subscriber Data Modified MAP
message to be sent to the
platforms that provide the
CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the
message are defined by the
CSI_NOTIFY parameter in the
hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

336

Chapter 19 CAMEL Commands

GPRS CSI (GPRS-CSI)


Syntax
ADD:CAMEL,IMSI|MSISDN, <key_value>, GPRSCSI_<tdp>,
<gsmscf_addr>, <service_key>, <default_sh>,
{<cch>}, {<no_svc_unsupp_bh>}, {<lc_unsupp_bh>},
(<csi_active>), (<cse_notify>);

Parameters
Table 28. ADD:CAMEL Parameters for GPRS_<TDP>
Parameter

Values

Default

Mandatory
/Optional

IMSI|MSISDN

IMSI or
MSISDN

None

Mandatory

Text field that indicates whether


the number <key_value>, used
to locate a subscriber record, is
an IMSI or an MSISDN.

<key_value>

IMSI digits or
MSISDN digits

None

Mandatory

Numeric field containing either


the subscriber IMSI or MSISDN.

GPRSCSI_<tdp>

GPRSCSI_1,
GPRSCSI_2,
GPRSCSI_11,
GPRSCSI_12,
GPRSCSI_14,

None

Mandatory

GPRSCSI_1 triggers when a


subscriber attaches.
GPRSCSI_2 triggers when a
subscriber attaches in a new
position.
GPRSCSI_11 triggers when a
subscriber establishes a PDP
context.
GPRSCSI_12 triggers when
establishing a PDP context is
acknowledged.
GPRSCSI_14 triggers when a
PDP context changes position.

<gsmscf_addr>

A valid global
title or the
reserved word
DEFAULT.

None

Mandatory

Numeric field containing the


global title of network entity that
invokes CAMEL service logic for
GPRS sessions and PDP
contexts.
DEFAULT indicates that the
global title defined by the
CAMEL_GSMSCF entry in the
hlr_config Table.

<service_key>

Numeric field. 0
to 231- 1.

None

Mandatory

Represents either a single


CAMEL GPRS service or
multiple CAMEL GPRS services.

Home Location Register (Linux) V1.1 Support Guide

Description

Chapter 19 CAMEL Commands

337

Table 28. ADD:CAMEL Parameters for GPRS_<TDP> (Continued)


Parameter

Values

Default

Mandatory
/Optional

<default_sh>

Text field.
CONTINUE or
RELEASE

None

Mandatory

Identifies whether a GPRS


session will continue or be
released if an error occurs
during setup.
Sessions can be allowed to
continue or stopped, depending
on subscriber type, such as
whether a subscriber is pre-pay
or contract.

<cch>

3-3-3

3-3-3

Optional

CAMEL capability handling


defined as a list of 3 values,
separated by hyphens. The list
has the format:
minimum-threshold-maximum
The list is optional, but if the list
is present, all values must be
specified.
CCH determines how the HLR
downloads a TDP and which
bars will be invoked at each
possible download phase.
minimum: CAMEL phase at
which the TDP was introduced
according to MAP specifications.
threshold: Permissible CAP
protocol levels capable of
supporting CAMEL data
maximum: Maximum HLR
CAMEL support.
The CCH list must conform to :
minimum <= threshold <=
maximum

<no_svc_unsupp_bh>

{<odb>
<odb>...}

None

Optional

Previously only provisioned for


CAMEL via UPDATE:SUB
command.
Service bars to be invoked if the
subscriber has CAMEL services
for GPRS and registers on an
SGSN that does not support the
CAMEL phase indicated by
<cch> above.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Description

Home Location Register (Linux) V1.1 Support Guide

338

Chapter 19 CAMEL Commands

Table 28. ADD:CAMEL Parameters for GPRS_<TDP> (Continued)


Mandatory
/Optional

Parameter

Values

Default

<lc_unsupp_bh>

{<odb>
<odb>...}
{}

No bars
induced

Optional

Service bars to be invoked if the


subscriber has CAMEL services
for GPRS and registers on an
SGSN that supports CAMEL but
at a phase lower than the
CAMEL phase indicated by
<cch> above.
<LC_UNSUPP_BH> is a list of
operator determined bars
(ODBs). If absent, no bars are
induced.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Description

<csi_active>

TRUE/FALSE

TRUE

Optional

Not used by the HLR.

<cse_notify>

TRUE/FALSE

FALSE

Optional

Not used by the HLR.


Defines whether a change to
CSI data causes a Note
Subscriber Data Modified MAP
message to be sent to the
platforms that provide the
CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the
message are defined by the
CSI_NOTIFY parameter in the
hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

339

Mobile Originated SMS CSI (MOSMS-CSI)


Syntax
ADD:CAMEL,IMSI|MSISDN, <key_val>, MOSMS_<tdp>,
<gsmscf_addr>, <service_key>, <default_smsh>,
{<cch>}, {<no_svc_unsupp_bh>}, {<lc_unsupp_bh>},
(<csi_active>), (<cse_notify>);

Parameters
Table 29. ADD:CAMEL Parameters for MOSMS-CSI
Parameter

Values

Default

Mandatory
/Optional

IMSI|MSISDN

IMSI or
MSISDN

None

Mandatory

Text field that indicates whether


the number <key_value>, used
to locate a subscriber record, is
an IMSI or an MSISDN.

<key_value>

IMSI digits or
MSISDN digits

None

Mandatory

Numeric field containing either


the subscriber IMSI or MSISDN

MOSMSCSI_<tdp>

MOSMSCSI_1

None

Mandatory

MOSMSCSI_1 triggers when


MOSMSCSI data has been
collected and analysed.

<gsmscf_addr>

A valid global
title or the
reserved word
DEFAULT.

None

Mandatory

Numeric field containing the


global title of network entity that
invokes the CAMEL service logic
for mobile originated SMS
messages.
DEFAULT indicates that the
global title defined by the
CAMEL_GSMSCF entry in the
SCCP_CONFIG Table.

<service_key>

Numeric field. 0
to 231- 1.

None

Mandatory

Represents either a single


CAMEL service or multiple
CAMEL services.

<default_smsh>

Text field.
CONTINUE or
RELEASE

None

Mandatory

Identifies whether an SMS


message will continue or be
released if an error occurs.
Messages can be allowed to
continue or stopped, depending
on subscriber type, such as
whether a subscriber is pre-pay
or contract.

Description

Home Location Register (Linux) V1.1 Support Guide

340

Chapter 19 CAMEL Commands

Table 29. ADD:CAMEL Parameters for MOSMS-CSI


Parameter

Values

Default

Mandatory
/Optional

<cch>

3-3-3

3-3-3

Optional

CAMEL capability handling


defined as a list of 3 values,
separated by hyphens. The list
has the format:
minimum-threshold-maximum
The list is optional, but if the list
is present, all values must be
specified.
Determines how the HLR
downloads a TDP and which
bars will be invoked at each
possible download phase.
minimum: CAMEL phase at
which the TDP was introduced
according to MAP specifications.
threshold: Permissible CAP
protocol levels capable of
supporting CAMEL data
maximum: Maximum HLR
CAMEL support.
The CCH list must conform to :
minimum <= threshold <=
maximum

<no_svc_unsupp_bh>

{<odb>
<odb>...}

No bars
induced

Optional

Previously only provisioned for


CAMEL via UPDATE:SUB
command.
Service bars to be invoked if the
subscriber has CAMEL services
for mobile originated SMS and
registers on an SGSN or VLR
that does not support the
CAMEL phase indicated by
<cch> above.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Home Location Register (Linux) V1.1 Support Guide

Description

Chapter 19 CAMEL Commands

341

Table 29. ADD:CAMEL Parameters for MOSMS-CSI


Mandatory
/Optional

Parameter

Values

Default

<lc_unsupp_bh>

{<odb>
<odb>...}

No bars
induced

Optional

Service bars to be invoked if the


subscriber has CAMEL services
for mobile originated SMS and
registers on an SGSN or VLR
that supports CAMEL but at a
phase indicated by <cch>
above.
<LC_UNSUPP_BH> is a list of
one or more an operator
determined bars (ODBs). If
absent, no bars are induced.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Description

<csi_active>

TRUE/FALSE

TRUE

Optional

Not used by the HLR.

<cse_notify>

TRUE/FALSE

FALSE

Optional

Not used by the HLR.


The entities that receive the
message are defined by the
CSI_NOTIFY parameter in the
hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

342

Chapter 19 CAMEL Commands

Terminating CSI (T-CSI)


Syntax
ADD:CAMEL, IMSI|MSISDN, <key_val>, TCSI_<tdp>,
<gsmscf_addr>, <service_key>, <default_ch>,
{<cch>}, {<no_svc_unsupp_bh>}, {<lc_unsupp_bh>},
(<csi_active>), (<cse_notify>), (<psi_loc_info>);

Parameters
Table 30. ADD:CAMEL Parameters for T-CSI_<TDP>
Parameter

Values

Default

Mandatory
/Optional

IMSI|MSISDN

IMSI or
MSISDN

None

Mandatory

Text field that indicates whether


the number <key_value>, used
to locate a subscriber record, is
an IMSI or an MSISDN.

<key_value>

IMSI digits or
MSISDN digits

None

Mandatory

Numeric field containing either


the subscriber IMSI or MSISDN

TCSI_<tdp>

TCSI_12
TCSI_13
TCSI_14

None

Mandatory

TCSI_12 triggers when CAMEL


subscription information has
been collected and analysed.
TCSI_13 triggers if the called
party is busy.
TCSI_14 triggers if the called
party does not answer within a
time limit.

<gsmscf_addr>

A valid global
title or the
reserved word
DEFAULT.

None

Mandatory

Numeric field containing the


global title of network entity that
invokes the CAMEL service logic
for mobile terminated calls. The
CAMEL service logic is invoked
at the GMSC, which is where the
call enters the home network.
DEFAULT indicates that the
global title defined by the
CAMEL_GSMSCF entry in the
hlr_config Table.

<service_key>

Numeric field. 0
to 231- 1.

None

Mandatory

Represents either a single


CAMEL service or multiple
CAMEL services.

<default_ch>

Text field.
CONTINUE or
RELEASE

None

Mandatory

Identifies whether a call will


continue or be released if an
error occurs during call setup.
Calls can be allowed to continue
or stopped depending on
subscriber type, such as
whether a subscriber is pre-pay
or contract.

Home Location Register (Linux) V1.1 Support Guide

Description

Chapter 19 CAMEL Commands

343

Table 30. ADD:CAMEL Parameters for T-CSI_<TDP> (Continued)


Parameter

Values

Default

<cch>

For TCSI_12:
minimum is 1, 2
or 3
threshold is 1, 2
or 3
maximum is 1,
2 or 3

For
TCSI_12:
1-1-3

For TCSI_13
and TCSI_14:
minimum is 3
threshold is 3
maximum is 3

<no_svc_unsupp_bh>

{<odb>
<odb>...}
{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Mandatory
/Optional
Optional

CAMEL capability handling


defined as a list of 3 values,
separated by hyphens. The list
has the format:
minimum-threshold-maximum
The list is optional, but if the list
is present, all values must be
specified.
Determines how the HLR
downloads a TDP and which
bars will be invoked at each
possible download phase.
minimum: CAMEL phase at
which the TDP was introduced
according to MAP specifications.
threshold: Permissible CAP
protocol levels capable of
supporting CAMEL data
maximum: Maximum HLR
CAMEL support.
The CCH list must conform to :
minimum <= threshold <=
maximum

Optional

Previously only provisioned for


CAMEL via UPDATE:SUB
command.
Service bars to be invoked if the
subscriber has CAMEL services
for terminating calls and the SRI
message from the GMSC
indicates that the CAMEL phase
indicated by <cch> above is
unsupported.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

For
TCSI_13
and
TCSI_14:
3-3-3

None

Description

Home Location Register (Linux) V1.1 Support Guide

344

Chapter 19 CAMEL Commands

Table 30. ADD:CAMEL Parameters for T-CSI_<TDP> (Continued)


Parameter

Values

Default

Mandatory
/Optional

<lc_unsupp_bh>

{<odb>
<odb>...}

None

Optional

Service bars to be invoked if the


subscriber has CAMEL services
for terminating calls and the SRI
message from the GMSC
indicates that CAMEL is
supported but lower than the
CAMEL phase indicated by
<cch> above.
<LC_UNSUPP_BH> takes one
or more an operator determined
bar (ODB) values. If absent, no
bars are induced.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Description

<csi_active>

TRUE/FALSE

TRUE

Optional

Not used by the HLR.

<cse_notify>

TRUE/FALSE

FALSE

Optional

Not used by the HLR.


Defines whether a change to
CSI data causes a Note
Subscriber Data Modified MAP
message to be sent to the
platforms that provide the
CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the
message are defined by the
CSI_NOTIFY parameter in the
hlr_config Table.

<psi_loc_info>

TRUE/FALSE

FALSE

Optional

Defines whether a
ProvideSubscriberInformation
message is sent to the VLR if
the HLR receives a
SendRoutingInformation
message from a GMSC for
terminating CAMEL (T-CSI).

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

345

Dialled Subscribed Services CSI (D-CSI)


Syntax
ADD:CAMEL, IMSI|MSISDN, <key_value>, DCSI_<dn>,
<gsmscf_addr>, <service_key>, <dn>, <default_ch>,
{<cch>}, {<no_svc_unsupp_bh>}, {lc_unsupp_bh>},
(<csi_active>), (<cse_notify>));

Parameters
Table 31. ADD:CAMEL Parameters for D-CSI
Parameter

Values

Default

Mandatory
/Optional

IMSI|MSISDN

IMSI or
MSISDN

None

Mandatory

Text field that indicates whether


the number <key_value>, used
to locate a subscriber record, is
an IMSI or an MSISDN.

<key_value>

IMSI digits or
MSISDN digits

None

Mandatory

Numeric field containing either


the subscriber IMSI or MSISDN

DCSI_<dn_instance>

DCSI_1
DCSI_2
DCSI_3

None

Mandatory

<gsmscf_addr>

A valid global
title or the
reserved word
DEFAULT.

None

Mandatory

Numeric field containing the


global title of network entity that
invokes the CAMEL service logic
for dialled subscribed services.
DEFAULT indicates that the
global title defined by the
CAMEL_GSMSCF entry in the
SCCP_CONFIG Table.

<service_key>

Numeric field. 0
to 231- 1.

None

Mandatory

Represents either a single


CAMEL service or multiple
CAMEL services.

<dn>

ISDN number

None

Mandatory

Dialled number for dialled


subscribed service. A CAMEL
service is invoked if this number
is dialled.

<default_ch>

Text field.
CONTINUE or
RELEASE

None

Mandatory

Identifies whether a call will


continue or be released if an
error occurs during call setup.
Calls can be allowed to continue
or stopped depending on
subscriber type, such as
whether a subscriber is pre-pay
or contract.

Description

Home Location Register (Linux) V1.1 Support Guide

346

Chapter 19 CAMEL Commands

Table 31. ADD:CAMEL Parameters for D-CSI


Parameter

Values

Default

Mandatory
/Optional

<cch>

3-3-3

3-3-3

Optional

CAMEL capability handling


defined as a list of 3 values,
separated by hyphens. The list
has the format:
minimum-threshold-maximum
The list is optional, but if the list
is present, all values must be
specified.
Determines how the HLR
downloads a TDP and which
bars will be invoked at each
possible download phase.
minimum: CAMEL phase at
which the TDP was introduced
according to MAP specifications.
threshold: Permissible CAP
protocol levels capable of
supporting CAMEL data
maximum: Maximum HLR
CAMEL support.
The CCH list must conform to :
minimum <= threshold <=
maximum

<no_svc_unsupp_bh>

{<odb>
<odb>...}

None

Optional

Previously only provisioned for


CAMEL via UPDATE:SUB
command.
Service bars to be invoked if the
subscriber has CAMEL for
dialled subscribed services and
registers on a VLR that does not
support the CAMEL phase
indicated by <cch> above.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Home Location Register (Linux) V1.1 Support Guide

Description

Chapter 19 CAMEL Commands

347

Table 31. ADD:CAMEL Parameters for D-CSI


Parameter

Values

Default

Mandatory
/Optional

<lc_unsupp_bh>

{<odb>
<odb>...}

None

Optional

Service bars to be invoked if the


subscriber has CAMEL for
dialled subscribed services and
registers on a VLR that supports
CAMEL but below the CAMEL
phase indicated by <cch>
above.
<lc_unsupp_bh> takes one or
more an operator determined
bar (ODB) values. If absent, no
bars are induced.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Description

<csi_active>

TRUE/FALSE

TRUE

Optional

Not used by the HLR.

<cse_notify>

TRUE/FALSE

FALSE

Optional

Not used by the HLR.


Defines whether a change to
CSI data causes a Note
Subscriber Data Modified MAP
message to be sent to the
platforms that provide the
CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the
message are defined by the
CSI_NOTIFY parameter in the
hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

348

Chapter 19 CAMEL Commands

VMSC Trigger CSI (VT-CSI)


Syntax
ADD:CAMEL, IMSI|MSISDN, <key_value>, VTCSI_<tdp>,
<gsmscf_addr>, <service_key>, <default_ch>,
{<cch>}, {<no_svc_unsupp_bh>}, {lc_unsupp_bh>},
(<csi_active>), (<cse_notify>);

Parameters
Table 32. ADD:CAMEL Parameters for VT-CSI
Parameter

Values

Default

Mandatory
/Optional

IMSI|MSISDN

IMSI or
MSISDN

None

Mandatory

Text field that indicates whether


the number <key_value>, used
to locate a subscriber record, is
an IMSI or an MSISDN.

<key_value>

IMSI digits or
MSISDN digits

None

Mandatory

Numeric field containing either


the subscriber IMSI or MSISDN

VTCSI_<tdp>

VTCSI_12
VTCSI_13
VTCSI_14

None

Mandatory

VTCSI_12 triggers when


CAMEL subscription information
has been collected and
analysed.
VTCSI_13 triggers if the called
party is busy.
VTCSI_14 triggers if the called
party does not answer within a
time limit.

<gsmscf_addr>

A valid global
title or the
reserved word
DEFAULT.

None

Mandatory

Numeric field containing the


global title of network entity that
invokes the CAMEL service logic
for mobile terminated calls. The
CAMEL service logic is invoked
at the VMSC, which is within the
visited network.
DEFAULT indicates that the
global title defined by the
CAMEL_GSMSCF entry in the
SCCP_CONFIG Table.

<service_key>

Numeric field. 0
to 231- 1.

None

Mandatory

Represents either a single


CAMEL service or multiple
CAMEL services.

<default_ch>

Text field.
CONTINUE or
RELEASE

None

Mandatory

Identifies whether a call will


continue or be released if an
error occurs during call setup.
Calls can be allowed to continue
or stopped depending on
subscriber type, such as
whether a subscriber is pre-pay
or contract.

Home Location Register (Linux) V1.1 Support Guide

Description

Chapter 19 CAMEL Commands

349

Table 32. ADD:CAMEL Parameters for VT-CSI (Continued)


Parameter

Values

Default

Mandatory
/Optional

<cch>

3-3-3

3-3-3

Optional

CAMEL capability handling


defined as a list of 3 values,
separated by hyphens. The list
has the format:
minimum-threshold-maximum
The list is optional, but if the list
is present, all values must be
specified.
Determines how the HLR
downloads a TDP and which
bars will be invoked at each
possible download phase.
minimum: CAMEL phase at
which the TDP was introduced
according to MAP specifications.
threshold: Permissible CAP
protocol levels capable of
supporting CAMEL data
maximum: Maximum HLR
CAMEL support.
The CCH list must conform to :
minimum <= threshold <=
maximum

<no_svc_unsupp_bh>

{<odb>
<odb>...}

None

Optional

Previously only provisioned for


CAMEL via UPDATE:SUB
command.
Service bars to be invoked if the
subscriber has CAMEL services
for VMSC triggered terminating
calls and is registered on a VLR
that does not support the
CAMEL phase indicated by
<cch> above.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Description

Home Location Register (Linux) V1.1 Support Guide

350

Chapter 19 CAMEL Commands

Table 32. ADD:CAMEL Parameters for VT-CSI (Continued)


Parameter

Values

Default

Mandatory
/Optional

<lc_unsupp_bh>

{<odb>
<odb>...}

None

Optional

Service bars to be invoked if the


subscriber has CAMEL services
for VMSC triggered terminating
calls and is registered on a VLR
that supports CAMEL but below
the CAMEL phase indicated by
<cch> above.
<lc_unsupp_bh> takes one or
more an operator determined
bar (ODB) values. If absent, no
bars are induced.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Description

<csi_active>

TRUE/FALSE

TRUE

Optional

Not used by the HLR.

<cse_notify>

TRUE/FALSE

FALSE

Optional

Not used by the HLR.


Defines whether a change to
CSI data causes a Note
Subscriber Data Modified MAP
message to be sent to the
platforms that provide the
CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the
message are defined by the
CSI_NOTIFY parameter in the
hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

351

Mobility Management CSI (M-CSI)


Syntax
ADD:CAMEL, IMSI|MSISDN, <key_value>, MCSI,
<gsmscf_addr>, <service_key>, <mobility_trig>,
{<cch>}, {<no_svc_unsupp_bh>}, {lc_unsupp_bh>},
(<csi_active>), (<cse_notify>);

Parameters
Table 33. ADD:CAMEL Parameters for M-CSI
Parameter

Values

Default

Mandatory
/Optional

IMSI|MSISDN

IMSI or
MSISDN

None

Mandatory

Text field that indicates whether


the number <key_value>, used
to locate a subscriber record, is
an IMSI or an MSISDN.

<key_value>

IMSI digits or
MSISDN digits

None

Mandatory

Numeric field containing either


the subscriber IMSI or MSISDN

MCSI

MCSI

None

Mandatory

MCSI specifies that the


subscription information is for
mobility management. Mobility
management does not have
Trigger Detection Points (TDPs).

<gsmscf_addr>

A valid global
title or the
reserved word
DEFAULT.

None

Mandatory

Numeric field containing the


global title of network entity that
invokes the CAMEL service logic
for mobility management.
DEFAULT indicates the global
title defined by the
CAMEL_GSMSCF entry in the
SCCP_CONFIG Table.

<service_key>

Numeric field. 0
to 231- 1.

None

Mandatory

Represents either a single


CAMEL service or multiple
CAMEL services.

Description

Home Location Register (Linux) V1.1 Support Guide

352

Chapter 19 CAMEL Commands

Table 33. ADD:CAMEL Parameters for M-CSI (Continued)


Parameter

Values

Default

Mandatory
/Optional

{<mobility_trig>}

{mob_trig>
<mob_trig>...}
For example,
{IMSI_ATTACH
LOC_UPD_SA
ME_VLR} sets
IMSI attach
and location
update in same
VLR triggers

None

Mandatory

Set of mobility triggers, of which


5 values are defined by GSM.
At least one value must be
present.
{mob_trig> <mob_trig>...} is a
list of mobility triggers, each
separated by a space.
LOC_UPD_SAME_VLR:
location update in same VLR
LOC_UPD_OTHER_VLR:
location update to other VLR
IMSI_ATTACH: IMSI attach
INIT_IMSI_DETACH: MS
initiated IMSI detach
NWK_INIT_IMSI_DETACH:
network initiated IMSI detach
For bit numbers in the subscriber
database, see Mobility Triggers
on page 623.

<cch>

3-3-3

3-3-3

Optional

For M-CSI, CCH is used in


subscriber data download
calculations but not downloaded
to the VLR.
CAMEL capability handling
defined as a list of 3 values,
separated by hyphens. The list
has the format:
minimum-threshold-maximum
The list is optional, but if the list
is present, all values must be
specified.
Determines how the HLR
downloads a TDP and which
bars will be invoked at each
possible download phase.
minimum: CAMEL phase at
which the TDP was introduced
according to MAP specifications.
threshold: Permissible CAP
protocol levels capable of
supporting CAMEL data
maximum: Maximum HLR
CAMEL support.
The CCH list must conform to :
minimum <= threshold <=
maximum

Home Location Register (Linux) V1.1 Support Guide

Description

Chapter 19 CAMEL Commands

353

Table 33. ADD:CAMEL Parameters for M-CSI (Continued)


Parameter

Values

Default

Mandatory
/Optional

<no_svc_unsupp_bh>

{<odb>
<odb>...}

None

Optional

Previously only provisioned for


CAMEL via UPDATE:SUB
command.
Service bars to be invoked if the
subscriber has CAMEL services
for mobility management and is
registered on a VLR that does
not support the CAMEL phase
indicated by <cch> above.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

None

Optional

Service bars to be invoked if the


subscriber has CAMEL services
for mobility management and is
registered on a VLR that
supports but below the CAMEL
phase indicated by <cch>
above.
<odb> is an operator determined
bar (ODB).
<lc_unsupp_bh> takes one or
more an operator determined
bar (ODB) values. If absent, no
bars are induced.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

TRUE

Optional

Not used by the HLR.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

<lc_unsupp_bh>

{<odb>
<odb>...}
{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

<csi_active>

TRUE/FALSE

Description

Home Location Register (Linux) V1.1 Support Guide

354

Chapter 19 CAMEL Commands

Table 33. ADD:CAMEL Parameters for M-CSI (Continued)


Parameter

Values

Default

Mandatory
/Optional

<cse_notify>

TRUE/FALSE

FALSE

Optional

Home Location Register (Linux) V1.1 Support Guide

Description
Not used by the HLR.
Defines whether a change to
CSI data causes a Note
Subscriber Data Modified MAP
message to be sent to the
platforms that provide the
CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the
message are defined by the
CSI_NOTIFY parameter in the
hlr_config Table.

Chapter 19 CAMEL Commands

355

Supplementary Service CSI (SS-CSI)


Syntax
ADD:CAMEL, IMSI|MSISDN, <key_value>, SSCSI,
<gsmscf_addr>, {<ss_code>}, {<cch>},
{<no_svc_unsupp_bh>}, {lc_unsupp_bh>},
(<csi_active>), (<cse_notify>);

Parameters
Table 34. ADD:CAMEL Parameters for SS-CSI
Parameter

Values

Default

Mandatory
/Optional

IMSI|MSISDN

IMSI or
MSISDN

None

Mandatory

Text field that indicates whether


the number <key_value>, used
to locate a subscriber record, is
an IMSI or an MSISDN.

<key_value>

IMSI digits or
MSISDN digits

None

Mandatory

Numeric field containing either


the subscriber IMSI or MSISDN

SSCSI

SSCSI

None

Mandatory

SSCSI specifies that the


subscription information is for
supplementary services.
Supplementary services do not
have Trigger Detection Points
(TDPs).

<gsmscf_addr>

A valid global
title or the
reserved word
DEFAULT.

None

Mandatory

Numeric field containing the


global title of network entity that
invokes the CAMEL service logic
for supplementary services.
DEFAULT indicates the global
title defined by the
CAMEL_GSMSCF entry in the
SCCP_CONFIG Table.

<ss_code>

{<ss_code>
<ss_code>...}
For example,
{mpty}

None

Mandatory

Set of SS codes, of which many


values are defined by GSM.
Values are enclosed within
braces, with each one separated
by a space.
Multi-party (code mpty) and
Explicit Call Transfer (code ect)
are supported within the HLR.

Description

Home Location Register (Linux) V1.1 Support Guide

356

Chapter 19 CAMEL Commands

Table 34. ADD:CAMEL Parameters for SS-CSI (Continued)


Parameter

Values

Default

Mandatory
/Optional

<cch>

minimum 2 or 3
threshold 2 or 3
maximum 2 or 3
For example,
2-2-3

2-2-3

Optional

For SS-CSI, CCH is used in


subscriber data download
calculations but not downloaded
to the VLR.
CAMEL capability handling
defined as a list of 3 values,
separated by hyphens. The list
has the format:
minimum-threshold-maximum
The list is optional, but if the list
is present, all values must be
specified.
Determines how the HLR
downloads a TDP and which
bars will be invoked at each
possible download phase.
minimum: CAMEL phase at
which the TDP was introduced
according to MAP specifications.
threshold: Permissible CAP
protocol levels capable of
supporting CAMEL data
maximum: Maximum HLR
CAMEL support.
The CCH list must conform to :
minimum <= threshold <=
maximum

<no_svc_unsupp_bh>

{<odb>
<odb>...}

None

Optional

Previously only provisioned for


CAMEL via UPDATE:SUB
command.
Service bars to be invoked if the
subscriber has CAMEL services
for supplementary services and
is registered on a VLR that does
not support the CAMEL phase
indicated by <cch> above.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Home Location Register (Linux) V1.1 Support Guide

Description

Chapter 19 CAMEL Commands

357

Table 34. ADD:CAMEL Parameters for SS-CSI (Continued)


Parameter

Values

Default

Mandatory
/Optional

<lc_unsupp_bh>

{<odb>
<odb>...}

None

Optional

Service bars to be invoked if the


subscriber has CAMEL services
for supplementary services and
is registered on a VLR that
supports CAMEL but below the
CAMEL phase indicated by
<cch> above.
<odb> is an operator determined
bar (ODB).
<lc_unsupp_bh> takes one or
more an operator determined
bar (ODB) values. If absent, no
bars are induced.
{<odb> <odb>...} is a list of
operator determined bars, each
separated by a space.
<odb> is an operator determined
bar.
{} removes all bars.
{<odb> <odb>... } replaces any
existing list of bars.
See Appendix I, Operator
Determined Bars.

{}
for example,
{<odbaoc>
<odbaic>} bars
all outgoing and
incoming calls

Description

<csi_active>

TRUE/FALSE

TRUE

Optional

Not used by the HLR.

<cse_notify>

TRUE/FALSE

FALSE

Optional

Not used by the HLR.


Defines whether a change to
CSI data causes a Note
Subscriber Data Modified MAP
message to be sent to the
platforms that provide the
CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the
message are defined by the
CSI_NOTIFY parameter in the
hlr_config Table.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

358

Chapter 19 CAMEL Commands

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed

00099

Internal software error.

00114

Configurable CAMEL GSMSCF GT unavailable

00116

Unable to allocate resource

Examples
Provision
CAMEL Phase 1

In this example, a subscriber is provisioned with a CAMEL service


which requires a minimum of CAMEL phase 1 capability. The service
has an unsupported behaviour associated, which causes an operator
determined bar to prevent outgoing calls if the VLR that the subscriber
is registered on does not support CAMEL phase 1.
ADD:CAMEL,IMSI,123451234512346,OCSI_2,DEFAULT,1,
CONTINUE,1-1-3,{ODBAOC};
GSM PDS - CAMEL added
MSISDN

- 123412341235

All CAMEL phase 2 data is set to initial values.

Provision
CAMEL Phase 2

In this example, a subscriber is provisioned with a CAMEL phase 2


service, allowing non-standard CAMEL FTNs. The CAMEL phase 2
service has an unsupported behaviour, which causes an operator
determined bar to prevent outgoing calls if the VLR that the subscriber
is registered on does not support CAMEL phase 2. There is no lower
CAMEL unsupported behaviour.
Provision CAMEL phase 2:
ADD:CAMEL,IMSI,000001111122222,OCSI_2,DEFAULT,1,
RELEASE,2-2-3,{ODBAOC};
GSM PDS - CAMEL added
MSISDN

- 444455556666

UPDATE:CAMEL,IMSI,000001111122222,OCSI_2,TIF_CSI,
TRUE;
The remaining CAMEL phase 2 data is set to initial values.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

Migrate from
CAMEL Phase 1
to Full CAMEL
Phase 2 Service

359

In this example, the CAMEL phase 1 service of a subscriber is


enhanced to a service which requires full CAMEL phase 2 capability.
The service has a lower CAMEL unsupported behaviour
(LC_UNSUPP_BH) associated, which causes an operator determined bar
to prevent outgoing calls if the VLR that the subscriber is registered on
supports CAMEL phase 1 but not phase 2. The service also requires a
CAMEL enquiry to be initiated whenever the subscriber dials a 5 or 6
digit number, or the number dialled is prefixed with either 987 or 12345.
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,LC_UNSUPP_BH,
+{ODBAOC};
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,LC_UNSUPP_BH,
+{ODBMOXSMS};
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,CCH,1-2-2;
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,TIF_CSI,TRUE;
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,MATCH_TYPE,
ENABLING;
UPDATE:CAMEL,IMSI,<imsi>,2,DEST_NUM,987,12345,NONE
,NONE,NONE,NONE,NONE,NONE,NONE,NONE;
UPDATE:CAMEL,IMSI,<imsi>,2,DEST_NUM_LEN,5,6,NONE;

Migrate from
CAMEL Phase 2
to Phase 1

In this example, a subscriber is migrated from CAMEL phase 2 to


phase 1
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,BASIC_SERVICE,{};
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,DEST_NUM,NONE,
NONE,NONE,NONE,NONE,NONE,NONE,NONE,NONE,NONE;
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,DEST_NUM_LEN,NONE,
NONE,NONE;
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,MATCH_TYPE,NONE;
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,CALL_TYPE,NONE;
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,TIF_CSI,FALSE;
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,LC_UNSUPP_BH,{};
UPDATE:CAMEL,IMSI,<imsi>,OCSI_2,CCH,1-1-3;

Unstructured Supplementary Service Data CSI (U-CSI)


Syntax
ADD:CAMEL, IMSI|MSISDN, <key_value>, UCSI,
<gsmscf_addr>, <ussd_code> (, <gsmscf_addr>,

Home Location Register (Linux) V1.1 Support Guide

360

Chapter 19 CAMEL Commands

<ussd_code>, <gsmscf_addr>, <ussd_code>,


<gsmscf_addr>, <ussd_code>, <gsmscf_addr>,
<ussd_code>);

Parameters
Table 35. ADD:CAMEL Parameters for U-CSI
Parameter

Values

Default

Mandatory/
Optional

IMSI|MSISDN

IMSI or
MSISDN

None

Mandatory

Text field that indicates


whether the number
<key_value>, used to
locate a subscriber record,
is an IMSI or an MSISDN.

<key_value>

IMSI digits or
MSISDN digits

None

Mandatory

Numeric field containing


either the subscriber IMSI
or MSISDN.

<ussd_code>

String of up to
16 characters.
Typically
*#nnn#, where
n is a digit

None

At least one
<ussd_code>
<gsmscf_addr>
pair must be
specified

Code used to invoke a


particular USSD service.
Up to 5 <ussd_code>
<gsmscf_addr> pairs can
be specified

<gsmscf_addr>

A valid global
title or the
reserved word
DEFAULT.

None

At least one
<ussd_code>
<gsmscf_addr>
pair must be
specified

Numeric field containing


the global title of network
entity that invokes the
CAMEL service logic for
supplementary services.
DEFAULT indicates the
global title defined by the
CAMEL_GSMSCF entry in
the hlr_config Table.

Description

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

361

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed

00099

Internal software error.

00114

Configurable CAMEL GSMSCF GT unavailable

00116

Unable to allocate resource

Examples
The following command adds the USSD command *#7777# to the
U-CSI CAMEL data.
ADD:CAMEL, MSISDN, 123412341234, UCSI, DEFAULT,
*#7777#;
GSM PDS - CAMEL added
The added CAMEL data can be viewed using a VIEW:SUB command,
as shown in the example below.
VIEW:SUB,MSISDN, 123412341234;
IMSI:
123451234512345
Pending:
.
.
.
CAMEL UCSI INFO:
GSMSCF Address(1):
44385016450
Code(1):
*#7777#
GSMSCF Address(2):
Code(2):
GSMSCF Address(3):
Code(3):
GSMSCF Address(4):
Code(4):
GSMSCF Address(5):
Code(5):

USSD
USSD
USSD
USSD
USSD

No calls since: 11-JUN-2003 08:48:15

Home Location Register (Linux) V1.1 Support Guide

362

Chapter 19 CAMEL Commands

SET:CAMEL
The SET:CAMEL command sets CAMEL subscription information.
Command parameters vary depending on the type of CAMEL
subscription information (CSI) being added, as described in
ADD:CAMEL on page 332. The parameters are also as described in
that section.

Originating CSI (O-CSI), TDP 2


Syntax
SET:CAMEL,<key_type>,<key_value>,OCSI_<tdp>,
(<gsmscf_addr>),(<service_key>),(<default_ch>),
(<cch>),(<no_svc_unsupp_bh>),(<lc_unsupp_bh>),
(<csi_active>),(<cse_notify>),(<tif_csi>),
(<match_type>),(<basic_service>),(<call_type>),
(<dest_num_len0>),(<dest_num_len1>),
(<dest_num_len2>),(<dest_num0>),(<dest_num0>),
(<dest_num1>),(<dest_num2>),(<dest_num3>),
(<dest_num4>),(<dest_num5>),(<dest_num6>),
(<dest_num7>),(<dest_num8>),(<dest_num9>);

Originating CSI (O-CSI), TDP 4


Syntax
SET:CAMEL,<key_type>,<key_value>,OCSI_<tdp>,
(<gsmscf_addr>),(<service_key>),(<default_ch>),
(<cch>),(<no_svc_unsupp_bh>),(<lc_unsupp_bh>),
(<csi_active>),(<cse_notify>),(<o_cause_val>);

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

363

GPRS CSI (GPRS-CSI)


Syntax
SET:CAMEL,<key_type>,<key_value>,GPRSCSI_<tdp>,
(<gsmscf_addr>),(<service_key>),(<default_ch>),
(<cch>),(<no_svc_unsupp_bh>),(<lc_unsupp_bh>),
(<csi_active>),(<cse_notify>);

Home Location Register (Linux) V1.1 Support Guide

364

Chapter 19 CAMEL Commands

Mobile Originated SMS CSI (MOSMS-CSI)


Syntax
SET:CAMEL,<key_type>,<key_value>,MOSMSCSI_<tdp>,
(<gsmscf_addr>),(<service_key>),(<default_smsh>),
(<cch>),(<no_svc_unsupp_bh>),(<lc_unsupp_bh>),
(<csi_active>),(<cse_notify>);

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

365

Terminating CSI (T-CSI), TDP 12


Syntax
SET:CAMEL,<key_type>,<key_value>,TCSI_<tdp>,
(<gsmscf_addr>),(<service_key>),(<default_ch>),
(<cch>),(<no_svc_unsupp_bh>),(<lc_unsupp_bh>),
(<csi_active>),(<cse_notify>),(<psi_loc_info>),
(<basic_service>);

Home Location Register (Linux) V1.1 Support Guide

366

Chapter 19 CAMEL Commands

Terminating CSI (T-CSI), TDP 13 and 14


Syntax
SET:CAMEL,<key_type>,<key_value>,TCSI_<tdp>,
(<gsmscf_addr>),(<service_key>),(<default_ch>),
(<cch>),(<no_svc_unsupp_bh>),(<lc_unsupp_bh>),
(<csi_active>),(<cse_notify>),(<psi_loc_info>),
(<t_cause_val>);

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

367

Dialled Subscribed Services CSI (D-CSI)


Syntax
SET:CAMEL,<key_type>,<key_value>,DCSI_<tdp>,
(<gsmscf_addr>),(<service_key>),(<dn>),
(<default_ch>),(<cch>),(<no_svc_unsupp_bh>),
(<lc_unsupp_bh>),(<csi_active>),(<cse_notify>);

Home Location Register (Linux) V1.1 Support Guide

368

Chapter 19 CAMEL Commands

VMSC Trigger CSI (VT-CSI), TDP 12


Syntax
SET:CAMEL,<key_type>,<key_value>,VTCSI_<tdp>,
(<gsmscf_addr>),(<service_key>),(<default_ch>),
(<cch>),(<no_svc_unsupp_bh>),(<lc_unsupp_bh>),
(<csi_active>),(<cse_notify>),(<basic_service>);

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

369

VMSC Trigger CSI (VT-CSI), TDP 13 and 14


Syntax
SET:CAMEL,<key_type>,<key_value>,VTCSI_<tdp>,
(<gsmscf_addr>),(<service_key>),(<default_ch>),
(<cch>),(<no_svc_unsupp_bh>),(<lc_unsupp_bh>),
(<csi_active>),(<cse_notify>),(<vt_cause_val>);

Home Location Register (Linux) V1.1 Support Guide

370

Chapter 19 CAMEL Commands

Mobility Management CSI (M-CSI)


Syntax
SET:CAMEL,<key_type>,<key_value>,MCSI_<tdp>,
(<gsmscf_addr>),(<service_key>),(<mobility_trig>),
(<cch>),(<no_svc_unsupp_bh>),(<lc_unsupp_bh>),
(<csi_active>),(<cse_notify>);

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

371

Supplementary Service CSI (SS-CSI)


Syntax
SET:CAMEL,<key_type>,<key_value>,SSCSI_<tdp>,
(<gsmscf_addr>),(<ss_code>),
(<cch>),(<no_svc_unsupp_bh>),(<lc_unsupp_bh>),
(<csi_active>),(<cse_notify>);

Unstructured Supplementary Service Data CSI (U-CSI)


Syntax
SET:CAMEL,<key_type>,<key_value>,UCSI_<tdp>,
(<gsmscf_addr>),(<ussd_code>),
(<gsmscf_addr>),(<ussd_code>),
(<gsmscf_addr>),(<ussd_code>),
(<gsmscf_addr>),(<ussd_code>),
(<gsmscf_addr>),(<ussd_code>);

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

372

Chapter 19 CAMEL Commands

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00099

Internal software error.

00114

Configurable CAMEL GSMSCF GT unavailable.

00116

Unable to allocate resource.

00124

Invalid CCH and CAMEL data combination.

00125

Attempt to remove mandatory CSI data.

00126

Number of CAMEL basic service criteria


exceeded.

Example
SET:CAMEL,MSISDN,44385100101,SSCSI,99999999999999,
{MPTY ECT},3-3-3,{ODBAIC ODBOIC},
{ODBAIC ODBOIC},TRUE,TRUE;
GSM PDS - CAMEL Set

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

373

REMOVE:CAMEL
This new command will remove a specific CSI TDP data from a
subscriber.
The removal of all CAMEL data does not disrupt any existing
non-standard CAMEL FTNs from the HLR database. The HLR
continues to control download and invocation of forwarding numbers.

Syntax
REMOVE:CAMEL,IMSI|MSISDN,<key_value>,<
csi_type_tdp>;

Parameters
Parameter

Meaning

IMSI|MSISDN

Text field. Indicates whether the number <key_value>, used to locate a subscriber
record, is an IMSI or an MSISDN.

<key_value>

Numeric field containing either the subscriber IMSI or MSISDN

<csi_type_tdp>

Specifies the trigger detection point for which CAMEL data will be removed.
Possible values for <csi_type_tdp> are listed in the table below.

<csi_type_tdp>

Description

OCSI_2
OCSI_4
OCSI_ALL

Removes the instance of originating CAMEL subscription information (O-CSI)


identified by the TDP value.
O_CSI_ALL removes all O-CSI TDPs from a subscriber

GPRSCSI_1
GPRSCSI_2
GPRSCSI_11
GPRSCSI_12
GPRSCSI_14
GPRSCSI_ALL

Removes the instance of GPRS CAMEL subscription information (GPRS-CSI)


identified by the TDP value from a subscriber.
GPRS_CSI_ALL removes all GPRS-CSI TDPs from a subscriber

MOSMSCSI_1
MOSMSCSI_ALL

Removes the instance of mobile originated CAMEL subscription information


(MOSMS-CSI) identified by the TDP value from a subscriber. Since only
MOSMS_CSI_1 is supported in this release, this effectively removes MOSMS from
the subscriber. MOSMS_CSI_ALL removes all MOSMS-CSI TDPs from the
subscriber.

TCSI_12
TCSI_13
TCSI_14
TCSI_ALL

Removes the instance of terminating CAMEL subscription information (T-CSI)


identified by the TDP value from a subscriber.
T_CSI_ALL removes all T-CSI TDPs from a subscriber.

Home Location Register (Linux) V1.1 Support Guide

374

Chapter 19 CAMEL Commands

DCSI_1
DCSI_2
DCSI_3
DCSI_ALL

Removes the instance of dialled subscribed services CAMEL subscription


information (D-CSI) identified by the DN instance value from a subscriber.
D_CSI_ALL removes all instances of D-CSI from a subscriber

VTCSI_12
VTCSI_13
VTCSI_14
VTCSI_ALL

Removes the instance of VMSC trigger CAMEL subscription information (VT-CSI)


identified by the TDP value from a subscriber.
T_CSI_ALL removes all VT-CSI TDPs from a subscriber

MCSI

Removes mobility management CAMEL data (M-CSI) from a subscriber

SSCSI

Removes supplementary service CAMEL subscription information (SS-CSI) from a


subscriber

ALL

Removes all CAMEL data from a subscriber

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
To remove CAMEL service data from a subscriber, enter:
REMOVE:CAMEL,IMSI,000001111122222,2;
GSM PDS - CAMEL removed
MSISDN

Home Location Register (Linux) V1.1 Support Guide

- 444455556666

Chapter 19 CAMEL Commands

375

UPDATE:CAMEL
This command changes subscription information for a CAMEL trigger
detection point (TDP).
This command modifies CAMEL service data provisioned against a
subscriber. The command format varies according to the attribute being
modified and the CAMEL subscription information (CSI) to which it
belongs. As a result, this command can have a different format for each
CSI, with different attributes or attribute parameters for different trigger
detection points (TDPs).
The basic common command syntax for the command is given below,
followed by the different allowable attributes and their values for each
CSI.

Syntax
UPDATE:CAMEL,IMSI|MSISDN,<key_value>,
<csi_type_tdp>, <attribute>, <attribute_value>,
{(<attribute_value>)};

Parameters
Parameter

Meaning

IMSI|MSISDN

Text field. Values are IMSI or MSISDN. Indicates whether the number
<key_value>, used to locate a subscriber record, is an IMSI or an MSISDN.

<key_value>

Numeric field containing either the subscriber IMSI or MSISDN

<csi_type_tdp>

Indicates the CAMEL subscription information (CSI) trigger detection point list to
be modified. Examples of TDPs are OCSI_2 and OCSI_4.
CAMEL attributes vary depending on the trigger detection point (TDP).
The sections below list CAMEL attributes for each different TDP.

<attribute>
<attribute_value>

Text field. Specifies the attribute to be modified. See Attribute Values on


page 376 for <attribute> and values.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

376

Chapter 19 CAMEL Commands

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00058

CSI TDP combination not in use by subscriber

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

00114

Configurable CAMEL GSMSCF GT unavailable.

00116

Unable to allocate resource.

00124

Invalid CCH and CAMEL data combination

00125

Attempt to remove mandatory CSI data

00126

Number of CAMEL basic service criteria exceeded

Attribute Values
The syntax of the UPDATE:CAMEL command is the same for all types
of CAMEL subscription information (CSI) being added, but the
attributes vary. The HLR supports the following types of CSI:
Originating CSI (O-CSI), see page 377.
GPRS CSI (GPRS-CSI), see page 386.
Mobile Originated SMS CSI (MOSMS-CSI), see page 388.
Terminating CSI (T-CSI), see page 390.
Dialled Subscribed Services CSI (D-CSI), see page 395.
VMSC Triggered CSI (VT-CSI), see page 397.
Mobility Management CSI (M-CSI), see page 402.
Supplementary Service CSI (SS-CSI), see page 405.
Unstructured Supplementary Service Data CSI (UCSI), see
page 407.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

CAMEL Service
Behaviour

377

The behaviour of CAMEL services depends on subscriber data and on


which CAMEL phases are supported by the VLR or SGSN the
subscriber is registered on.
See How VLR and SGSN CAMEL Support Affects Services on
page 22 for how VLR and SGSN support of CAMEL affects services.
See Interaction of Multiple CAMEL Trigger Detection Points on
page 23 for how multiple trigger detection points (TDP) for a call
type affects services.
See Interaction Between Multiple CAMEL Subscription Types on
page 24 for how specifying CAMEL for multiple call types affects
services.

Originating CSI (O-CSI)


CAMEL attribute values depend on the trigger detection point
(parameter <csi_type_tdp>).
OCSI_2 triggers when CAMEL subscription information has been
collected and analysed. See Table 36 below for attribute values.
OCSI_4 triggers if establishing a call fails. See Table 37 on
page 382 for attribute values.
Originating CSI and supplementary service CSI data are linked;
changing either causes both to be downloaded to the VLR.
Table 36. UPDATE:CAMEL Attribute Values for OCSI_2
Attribute Name

Values

Default

Meaning

BASIC_SERVICE

{<basic_service>
<basic_service>...}
or
+{<basic_service>
<basic_service>...}
or
-{<basic_service>
<basic_service>...}
or
{}
Up to 5 basic services
can be specified
For example,
+{bs20 bs21} adds
basic services 20 and
21

None

Requires a maximum CCH of 2 or


higher.
This attribute is a set of up to 5 basic
services, with each one separated by a
space. The set is enclosed in braces.
{<basic_service> <basic_service>...}
replaces any existing set of basic
services.
+{<basic_service> <basic_service>...}
adds to any existing set of basic
services.
-{<basic_service> <basic_service>...}
removes services from any existing set
of basic services.
"{}" removes all basic service criteria
data.
The five basic service codes are all
different.

Home Location Register (Linux) V1.1 Support Guide

378

Chapter 19 CAMEL Commands

Table 36. UPDATE:CAMEL Attribute Values for OCSI_2 (Continued)


Attribute Name

Values

CALL_TYPE

FORWARDED
NOTFORWARDED
NONE

CCH

minimum-threshold-ma
ximum
minimum is 1, 2 or 3
threshold is 1, 2 or 3
maximum is 1, 2 or 3
For example, 1-1-3
Before setting
maximum CCH to 1:

Default

Meaning
Requires a max. CCH of 2 or higher.
Identifies whether the call must be a
forwarded call.
NONE removes CALL_TYPE criteria
data from the subscriber.

3-3-3

Remove
BASIC_SERVICE
criteria,
DEST_NUM criteria,
DEST_NUM_LEN
criteria
Set CALL_TYPE
and MATCH_TYPE
to NONE
Set TIF_CSI to
FALSE

CAMEL capability handling defined as a


list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum
All values must be specified.
CCH determines how the HLR
downloads a TDP and which bars will
be invoked at each possible download
phase. See Figure 6 on page 23 for the
effect of CCH on CAMEL services.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL
data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.


Defines whether a change to CSI data
causes a Note Subscriber Data
Modified MAP message to be sent to
the platforms that provide the CAMEL
service logic (the gsmSCF, which is the
SEP in the Vodafone UK network).
The entities that receive the message
are defined by the CSI_NOTIFY
parameter in the hlr_config Table.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

DEFAULT_CH

Text field. CONTINUE


or RELEASE

Identifies whether a call will continue or


be released if an error occurs during
call setup.
Calls can be allowed to continue or
stopped, depending on subscriber type,
such as whether a subscriber is pre-pay
or contract.

DEST_NUM

Comma separated list


of 10 destination
numbers or NONE

Numeric fields. A CAMEL enquiry may


be initiated if a called number prefix
matches a specified DEST_NUM.
NONE means there is no destination
number at that position in the list.
Omitted values are left unchanged.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

379

Table 36. UPDATE:CAMEL Attribute Values for OCSI_2 (Continued)


Attribute Name

Values

Default

Meaning

DEST_NUM_LEN

Comma separated list


of three destination
number lengths or
NONE

First
entry
must be
specified

Numeric fields. A CAMEL enquiry may


be initiated if the length of a called
number matches a specified
DEST_NUM_LEN. NONE means there
is no destination number length at that
position in the list.
The first entry must be specified.
Omitted values are left unchanged.

GSMSCF_ADDR

A valid global title or


the reserved word
DEFAULT.

Numeric field containing the global title


of network entity that invokes CAMEL
service logic for originating calls.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry
in the hlr_config Table.

LC_UNSUPP_BH

{<odb> <odb>...}
or
+{<odb> <odb>...}
or
-{<odb> <odb>...}
or
{}

Service bars to be invoked if the


subscriber has CAMEL services for
outgoing calls and the VLR on which
registration is attempted supports
CAMEL at a lower phase than required.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined
bars.
-{<odb> <odb>...} removes bars from
any existing set of operator determined
bars.
"{}" removes all operator determined
bar data.
See Appendix I, Operator Determined
Bars.

for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

MATCH_TYPE

ENABLING,
INHIBITING or NONE

Identifies to the VLR whether CAMEL


originating criteria data for the TDP is to
be considered when the subscriber
makes a call. NONE retains all
originating criteria for the specified TDP,
but this criteria data is not downloaded
to the VLR.
ENABLING - CAMEL enquiry is initiated
if a DEST_NUM_LEN of 5 is specified
and a 5-digit number is dialled.
INHIBITING - CAMEL enquiry is
initiated if a DEST_NUM_LEN of 5 is
specified and a number which is not
5-digits long is dialled.

Home Location Register (Linux) V1.1 Support Guide

380

Chapter 19 CAMEL Commands

Table 36. UPDATE:CAMEL Attribute Values for OCSI_2 (Continued)


Attribute Name

Values

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
or
+{<odb> <odb>...}
or
-{<odb> <odb>...}
or
{}

Default

for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

SERVICE_KEY

0 to 231-1

Home Location Register (Linux) V1.1 Support Guide

Meaning
Previously specified for CAMEL via
UPDATE:SUB command.
Trigger detection point OCSI_2 does
not use this value. OCSI_2 uses the
value specified for the OICK
supplementary service using the
UPDATE:SUB command. See
NO_SVC_UNSUPP_BH on page 219.
Service bars to be invoked if the
subscriber has CAMEL services for
originating calls and the VLR on which
registration is attempted does not
support CAMEL.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined
bars.
-{<odb> <odb>...} removes bars from
any existing set of operator determined
bars.
"{}" removes all operator determined
bar data.
See Appendix I, Operator Determined
Bars.
Represents either a single CAMEL
service or multiple CAMEL services.

Chapter 19 CAMEL Commands

381

Table 36. UPDATE:CAMEL Attribute Values for OCSI_2 (Continued)


Attribute Name

Values

TIF_CSI

TRUE or FALSE

Default

Meaning
Text field.Translation Information Flag CAMEL Service Information.
A translation information flag (TIF_CSI)
value of TRUE indicates that when the
subscriber registers a
forwarded-to-number (FTN), the HLR
shall not attempt to perform any
translation, number format checks,
prohibited FTN checks or call barring
checks.
A TIF_CSI flag value of FALSE
indicates that translation is needed in
the HLR and the usual procedure
applies, including call barring checks.
A value of TRUE allows a subscriber to
register FTNs that are non-standard
because they are not in E.164 format,
such as FTNS for a virtual private
network (VPN).
See Number Translation for Call
Forwarding on page 8.
Modifying the TIF_CSI from TRUE to
FALSE makes any non-standard
CAMEL FTNs quiescent.

Home Location Register (Linux) V1.1 Support Guide

382

Chapter 19 CAMEL Commands

Table 37. UPDATE:CAMEL Attribute Values for OCSI_4


Attribute Name

Values

Default

Meaning

CCH

Three integers
separated by hyphens:
minimum-maximumthreshold
minimum is 3
threshold is 3
maximum is 3

3-3-3

CAMEL capability handling defined as a


list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum
All values must be specified.
Determines how the HLR downloads a
TDP and which bars will be invoked at
each possible download phase.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

DEFAULT_CH

CONTINUE or
RELEASE

Identifies whether a call will continue or


be released if an error occurs during call
setup.
Calls can be allowed to continue or
stopped, depending on subscriber type,
such as whether a subscriber is pre-pay
or contract.

GSMSCF_ADDR

A valid global title or the


reserved word
DEFAULT.

Numeric field containing the global title of


network entity that invokes CAMEL
service logic for originating calls.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry in
the hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

383

Table 37. UPDATE:CAMEL Attribute Values for OCSI_4 (Continued)


Attribute Name

Values

Default

Meaning

LC_UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

None

Service bars to be invoked if the


subscriber has CAMEL services for
outgoing calls and the VLR on which
registration is attempted supports CAMEL
at a lower phase than required.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

MATCH_TYPE

ENABLING,
INHIBITING or NONE

Identifies to the VLR whether CAMEL


originating criteria data for the TDP is to
be considered when the subscriber
makes a call. NONE retains all originating
criteria for the specified TDP, but this
criteria data is not downloaded to the
VLR.
ENABLING - CAMEL enquiry is initiated if
a DEST_NUM_LEN of 5 is specified and
a 5-digit number is dialled.
INHIBITING - CAMEL enquiry is initiated
if a DEST_NUM_LEN of 5 is specified
and a number which is not 5-digits long is
dialled.

Home Location Register (Linux) V1.1 Support Guide

384

Chapter 19 CAMEL Commands

Table 37. UPDATE:CAMEL Attribute Values for OCSI_4 (Continued)


Attribute Name

Values

Default

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

Previously specified for CAMEL via


UPDATE:SUB command.
Service bars to be invoked if the
subscriber has CAMEL services for
originating calls and the VLR on which
registration is attempted does not support
CAMEL.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

O_CAUSE_VAL

<o_cause_val>
-<o_cause_val>
-<o_cause_val>
-<o_cause_val><o_cause_val>
where <o_cause_val>
is an integer from 1 to
127
For example,
0-1-127-3-4
a value of 0 (zero)
means no value

This attribute contains reasons for call


processing failure is a list of 5 integers
separated by hyphens.
<o_cause_val> is an integer from 1 to
127.
All 5 values must be present, but a value
of 0 (zero) can be specified to indicate no
value.
Not all 127 values are defined. The HLR
does not restrict any values, it is assumed
provisioning will only attempt to update
using valid O_CAUSE_VAL values.
The HLR will not enforce unique values.

SERVICE_KEY

0 to 231-1

Numeric field. Represents either a single


CAMEL service or multiple CAMEL
services.

Home Location Register (Linux) V1.1 Support Guide

Meaning

Chapter 19 CAMEL Commands

385

Table 37. UPDATE:CAMEL Attribute Values for OCSI_4 (Continued)


Attribute Name

Values

TIF_CSI

TRUE or FALSE

Default

Meaning
Text field.Translation Information Flag CAMEL Service Information.
A translation information flag (TIF_CSI)
value of TRUE indicates that when the
subscriber registers a
forwarded-to-number (FTN), the HLR
shall not attempt to perform any
translation, number format checks,
prohibited FTN checks or call barring
checks.
A TIF_CSI flag value of FALSE indicates
that translation is needed in the HLR and
the usual procedure applies, including
call barring checks.
A value of TRUE allows a subscriber to
register FTNs that are non-standard
because they are not in E.164 format,
such as FTNS for a virtual private network
(VPN). See Number Translation for Call
Forwarding on page 8.
Modifying the TIF_CSI from TRUE to
FALSE makes any non-standard CAMEL
FTNs quiescent.

Home Location Register (Linux) V1.1 Support Guide

386

Chapter 19 CAMEL Commands

GPRS CSI (GPRS-CSI)


The trigger detection points (parameter <csi_type_tdp>) possible
for GPRS CSI are GPRSCSI_1 GPRSCSI_2 GPRSCSI_11
GPRSCSI_12 GPRSCSI_14.
Table 38. UPDATE:CAMEL Attribute Values for GPRSCSI_<tdp>
Attribute Name

Values

Default

Meaning

CCH

Three integers
separated by hyphens:
minimum-maximumthreshold
minimum is 3
threshold is 3
maximum 3

3-3-3

CAMEL capability handling defined as a


list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum
The list is optional, but if the list is
present, all values must be specified.
Determines how the HLR downloads a
TDP and which bars will be invoked at
each possible download phase.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.


Defines whether a change to CSI data
causes a Note Subscriber Data Modified
MAP message to be sent to the platforms
that provide the CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the message are
defined by the CSI_NOTIFY parameter in
the hlr_config Table.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

DEFAULT_SH

CONTINUE or
RELEASE

Identifies whether a GPRS session will


continue or be released if an error occurs
during setup.
Sessions can be allowed to continue or
stopped, depending on subscriber type,
such as whether a subscriber is pre-pay
or contract.

GSMSCF_ADDR

A valid global title or the


reserved word
DEFAULT.

Numeric field containing the global title of


network entity that invokes CAMEL
service logic for GPRS sessions and PDP
contexts.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry in
the hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

387

Table 38. UPDATE:CAMEL Attribute Values for GPRSCSI_<tdp> (Continued)


Attribute Name

Values

LC_UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

Service bars to be invoked if the


subscriber has CAMEL services for
GPRS and registers on an SGSN that
supports CAMEL but at a phase lower
than the CAMEL phase indicated by
<cch> above.
<LC_UNSUPP_BH> is a list of operator
determined bars (ODBs). If absent, no
bars are induced.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

Previously specified for CAMEL via


UPDATE:SUB command.
Service bars to be invoked if the
subscriber has CAMEL services for
GPRS and registers on an SGSN that
does not support the CAMEL phase
indicated by <cch> above.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

SERVICE_KEY

0 to 231-1

Represents either a single CAMEL GPRS


service or multiple CAMEL GPRS
services.

Default

Meaning

Home Location Register (Linux) V1.1 Support Guide

388

Chapter 19 CAMEL Commands

Mobile Originated SMS CSI (MOSMS-CSI)


The trigger detection point (parameter <csi_type_tdp>) possible for
mobile originated SMS CSI is MOSMSCSI_1.
Table 39. UPDATE:CAMEL Attribute Values for MOSMSCSI_1
Attribute Name

Values

Default

Meaning

CCH

Three integers
separated by hyphens:
minimum-maximumthreshold
minimum is 3
threshold is 3
maximum is 3

3-3-3

CAMEL capability handling defined as a


list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum
The list is optional, but if the list is
present, all values must be specified.
Determines how the HLR downloads a
TDP and which bars will be invoked at
each possible download phase.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.


Defines whether a change to CSI data
causes a Note Subscriber Data Modified
MAP message to be sent to the platforms
that provide the CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the message are
defined by the CSI_NOTIFY parameter in
the hlr_config Table.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

DEFAULT_SMSH

CONTINUE or
RELEASE

Identifies whether an SMS message will


continue or be released if an error occurs.
Messages can be allowed to continue or
stopped, depending on subscriber type,
such as whether a subscriber is pre-pay
or contract.

GSMSCF_ADDR

A valid global title or the


reserved word
DEFAULT.

Numeric field containing the global title of


network entity that invokes the CAMEL
service logic for mobile originated SMS
messages.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry in
the hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

389

Table 39. UPDATE:CAMEL Attribute Values for MOSMSCSI_1


Attribute Name

Values

Default

Meaning

LC_UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

0 (no bars
induced)

Service bars to be invoked if the


subscriber has CAMEL services for
mobile originated SMS and registers on
an SGSN or VLR that supports CAMEL
but at a phase indicated by <cch> above.
<LC_UNSUPP_BH> is a list of one or
more an operator determined bars
(ODBs). If absent, no bars are induced.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

SERVICE_KEY

0 to 231-1

Previously only provisioned for CAMEL


via UPDATE:SUB command.
Service bars to be invoked if the
subscriber has CAMEL services for
mobile originated SMS and registers on
an SGSN or VLR that does not support
the CAMEL phase indicated by <cch>
above.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

Home Location Register (Linux) V1.1 Support Guide

390

Chapter 19 CAMEL Commands

Terminating CSI (T-CSI)


CAMEL attribute values depend on the trigger detection point
(parameter <csi_type_tdp>) .
TCSI_12 triggers when CAMEL subscription information has been
collected and analysed. See Table 40 below.
TCSI_13 triggers if the called party is busy. See Table 41 on
page 392.
TCSI_14 triggers if the called party does not answer within a time
limit. See Table 41 on page 392.
Table 40. UPDATE:CAMEL Attribute Values for TCSI_12
Attribute Name

Values

BASIC_SERVICE

{<basic_service>
<basic_service>...}
+{<basic_service>
<basic_service>...}
-{<basic_service>
<basic_service>...}
{}
Up to 5 basic services
can be specified
For example, +{bs20
bs21} adds basic
services 20 and 21

CCH

Three integers
separated by hyphens:
minimum-maximumthreshold
minimum is 1, 2 or 3
threshold is 1, 2 or 3
maximum is 1, 2 or 3

Default

Meaning
Requires a maximum CCH of 2 or higher.
This attribute is a set of up to 5 basic
services, with each one separated by a
space. The set is enclosed in braces.
+{<basic_service> <basic_service>...}
adds to any existing set of basic services.
-{<basic_service> <basic_service>...}
removes services from any existing set of
basic services.
"{}" removes all basic service criteria
data.

3-3-3

BASIC_SERVICE
criteria must be
removed before
maximum CCH is set to
2 or lower.

Home Location Register (Linux) V1.1 Support Guide

CAMEL capability handling defined as a


list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum
All values must be specified.
Determines how the HLR downloads a
TDP and which bars will be invoked at
each possible download phase.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

Chapter 19 CAMEL Commands

391

Table 40. UPDATE:CAMEL Attribute Values for TCSI_12


Attribute Name

Values

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.


Defines whether a change to CSI data
causes a Note Subscriber Data Modified
MAP message to be sent to the platforms
that provide the CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the message are
defined by the CSI_NOTIFY parameter in
the hlr_config Table.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

DEFAULT_CH

CONTINUE or
RELEASE

Identifies whether a call will continue or


be released if an error occurs during call
setup.
Calls can be allowed to continue or
stopped, depending on subscriber type,
such as whether a subscriber is pre-pay
or contract.

GSMSCF_ADDR

A valid global title or the


reserved word
DEFAULT.

Numeric field containing the global title of


network entity that invokes the CAMEL
service logic for mobile terminated calls.
The CAMEL service logic is invoked at
the GMSC, which is where the call enters
the home network.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry in
the hlr_config Table.

LC_UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

Default

0 (no bars
induced)

Meaning

Service bars to be invoked if the


subscriber has CAMEL services for
terminating calls and the SRI message
from the GMSC indicates that CAMEL is
supported but lower than the CAMEL
phase indicated by <cch> above.
<LC_UNSUPP_BH> is a list of one or
more an operator determined bars
(ODBs). If absent, no bars are induced.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

Home Location Register (Linux) V1.1 Support Guide

392

Chapter 19 CAMEL Commands

Table 40. UPDATE:CAMEL Attribute Values for TCSI_12


Attribute Name

Values

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

PSI_LOC_INFO

TRUE/FALSE

SERVICE_KEY

0 to 231-1

Default

Meaning
Previously only provisioned for CAMEL
via UPDATE:SUB command.
Service bars to be invoked if the
subscriber has CAMEL services for
terminating calls and the SRI message
from the GMSC indicates that the CAMEL
phase indicated by <cch> above is
unsupported.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

FALSE

Defines whether a
ProvideSubscriberInformation message
is sent to the VLR if the HLR receives a
SendRoutingInformation message from a
GMSC for terminating CAMEL (T-CSI).

Table 41. UPDATE:CAMEL Attribute Values for TCSI_13 and TCSI_14


Attribute Name

Values

Default

Meaning

CCH

Three integers
separated by hyphens:
minimum-maximumthreshold
minimum is 3
threshold is 3
maximum is 3

3-3-3

CAMEL capability handling defined as a


list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum}
The list is optional, but if the list is
present, all values must be specified.
Determines how the HLR downloads a
TDP and which bars will be invoked at
each possible download phase.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

T_CAUSE_VAL criteria
must be removed
before maximum CCH
is set to 2 or lower.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

393

Table 41. UPDATE:CAMEL Attribute Values for TCSI_13 and TCSI_14 (Continued)
Attribute Name

Values

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.


Defines whether a change to CSI data
causes a Note Subscriber Data Modified
MAP message to be sent to the platforms
that provide the CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the message are
defined by the CSI_NOTIFY parameter in
the hlr_config Table.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

DEFAULT_CH

CONTINUE or
RELEASE

Identifies whether a call will continue or


be released if an error occurs during call
setup.
Calls can be allowed to continue or
stopped, depending on subscriber type,
such as whether a subscriber is pre-pay
or contract.

GSMSCF_ADDR

A valid global title or the


reserved word
DEFAULT.

Numeric field containing the global title of


network entity that invokes the CAMEL
service logic for mobile terminated calls.
The CAMEL service logic is invoked at
the GMSC, which is where the call enters
the home network.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry in
the hlr_config Table.

LC_UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

Default

(no bars
induced)

Meaning

Service bars to be invoked if the


subscriber has CAMEL services for
terminating calls and the SRI message
from the GMSC indicates that CAMEL is
supported but lower than the CAMEL
phase indicated by <cch> above.
<LC_UNSUPP_BH> is a list of one or
more an operator determined bars
(ODBs). If absent, no bars are induced.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

Home Location Register (Linux) V1.1 Support Guide

394

Chapter 19 CAMEL Commands

Table 41. UPDATE:CAMEL Attribute Values for TCSI_13 and TCSI_14 (Continued)
Attribute Name

Values

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

PSI_LOC_INFO

TRUE/FALSE

SERVICE_KEY

0 to 231-1

T_CAUSE_VAL

<t_cause_val>
-<t_cause_val><t_cause_val>
-<t_cause_val><t_cause_val>

Default

Meaning
Previously only provisioned for CAMEL
via UPDATE:SUB command.
Service bars to be invoked if the
subscriber has CAMEL services for
terminating calls and the SRI message
from the GMSC indicates that the CAMEL
phase indicated by <cch> above is
unsupported.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

FALSE

For example, ,
0-1-127-3-4
a value of 0 (zero)
means no value

Home Location Register (Linux) V1.1 Support Guide

Defines whether a
ProvideSubscriberInformation message
is sent to the VLR if the HLR receives a
SendRoutingInformation message from a
GMSC for terminating CAMEL (T-CSI).

This attribute contains reasons for call


processing failure and is a list of 5
integers separated by hyphens.
<t_cause_val> is an integer from 1 to
127.
All 5 values must be present, but a value
of 0 (zero) can be specified to indicate no
value.
Not all 127 values are defined. The HLR
does not restrict any values, it is assumed
provisioning will only attempt to update
using valid T_CAUSE_VAL values.
The HLR will not enforce unique values.

Chapter 19 CAMEL Commands

395

Dialled Subscribed Services CSI (D-CSI)


Table 42. UPDATE:CAMEL Attribute Values for DCSI_1, DCSI_2 and DCSI_3
Attribute Name

Values

Default

Meaning

CCH

Three integers
separated by hyphens:
minimum-maximumthreshold
minimum is 3
threshold is 3
maximum is 3

3-3-3

CAMEL capability handling defined as a


list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum
The list is optional, but if the list is
present, all values must be specified.
Determines how the HLR downloads a
TDP and which bars will be invoked at
each possible download phase.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.


Defines whether a change to CSI data
causes a Note Subscriber Data Modified
MAP message to be sent to the platforms
that provide the CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the message are
defined by the CSI_NOTIFY parameter in
the hlr_config Table.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

DEFAULT_CH

CONTINUE or
RELEASE

Identifies whether a call will continue or


be released if an error occurs during call
setup.
Calls can be allowed to continue or
stopped, depending on subscriber type,
such as whether a subscriber is pre-pay
or contract.

DN

ISDN number

Dialled number for dialled subscribed


service. A CAMEL service is invoked if
this number is dialled.

GSMSCF_ADDR

A valid global title or the


reserved word
DEFAULT.

Numeric field containing the global title of


network entity that invokes the CAMEL
service logic for dialled subscribed
services.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry in
the hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

396

Chapter 19 CAMEL Commands

Table 42. UPDATE:CAMEL Attribute Values for DCSI_1, DCSI_2 and DCSI_3 (Continued)
Attribute Name

Values

Default

Meaning

LC_UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

(no bars
induced)

Service bars to be invoked if the


subscriber has CAMEL for dialled
subscribed services and registers on a
VLR that supports CAMEL but below the
CAMEL phase indicated by <cch> above.
<lc_unsupp_bh> takes one or more an
operator determined bar (ODB) values. If
absent, no bars are induced.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

SERVICE_KEY

0 to 231-1

Home Location Register (Linux) V1.1 Support Guide

Previously only provisioned for CAMEL


via UPDATE:SUB command.
Service bars to be invoked if the
subscriber has CAMEL for dialled
subscribed services and registers on a
VLR that does not support the CAMEL
phase indicated by <cch> above.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

Chapter 19 CAMEL Commands

397

VMSC Triggered CSI (VT-CSI)


Table 43. UPDATE:CAMEL Attribute Values for VTCSI_12
Attribute Name

Values

BASIC_SERVICE

{<basic_service>
<basic_service>...}
+{<basic_service>
<basic_service>...}
-{<basic_service>
<basic_service>...}
{}
Up to 5 basic services
can be specified
For example, +{bs20
bs21} adds basic
services 20 and 21

CCH

Three integers
separated by hyphens:
minimum-maximumthreshold
minimum is 3
threshold is 3
maximum is 3

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.


Defines whether a change to CSI data
causes a Note Subscriber Data Modified
MAP message to be sent to the platforms
that provide the CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the message are
defined by the CSI_NOTIFY parameter in
the hlr_config Table.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

Default

Meaning
This attribute is a set of up to 5 basic
services, with each one separated by a
space. The set is enclosed in braces.
+{<basic_service> <basic_service>...}
adds to any existing set of basic services.
-{<basic_service> <basic_service>...}
removes services from any existing set of
basic services.
"{}" removes all basic service criteria
data.

3-3-3

CAMEL capability handling defined as a


list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum
The list is optional, but if the list is
present, all values must be specified.
Determines how the HLR downloads a
TDP and which bars will be invoked at
each possible download phase.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

Home Location Register (Linux) V1.1 Support Guide

398

Chapter 19 CAMEL Commands

Table 43. UPDATE:CAMEL Attribute Values for VTCSI_12 (Continued)


Attribute Name

Values

Default

DEFAULT_CH

CONTINUE or
RELEASE

Identifies whether a call will continue or


be released if an error occurs during call
setup.
Calls can be allowed to continue or
stopped, depending on subscriber type,
such as whether a subscriber is pre-pay
or contract.

GSMSCF_ADDR

A valid global title or the


reserved word
DEFAULT.

Numeric field containing the global title of


network entity that invokes the CAMEL
service logic for mobile terminated calls.
The CAMEL service logic is invoked at
the VMSC, which is within the visited
network.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry in
the hlr_config Table.

LC_UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

0 (no bars
induced)

Home Location Register (Linux) V1.1 Support Guide

Meaning

Service bars to be invoked if the


subscriber has CAMEL services for
VMSC triggered terminating calls and is
registered on a VLR that supports
CAMEL but below the CAMEL phase
indicated by <cch> above.
<lc_unsupp_bh> takes one or more an
operator determined bar (ODB) values. If
absent, no bars are induced.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

Chapter 19 CAMEL Commands

399

Table 43. UPDATE:CAMEL Attribute Values for VTCSI_12 (Continued)


Attribute Name

Values

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

SERVICE_KEY

0 to 231-1

Default

Meaning
Previously only provisioned for CAMEL
via UPDATE:SUB command.
Service bars to be invoked if the
subscriber has CAMEL services for
VMSC triggered terminating calls and is
registered on a VLR that does not support
the CAMEL phase indicated by <cch>
above.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

Table 44. UPDATE:CAMEL Attribute Values for VTCSI_13 and VTCSI_14


Attribute Name

Values

Default

Meaning

CCH

Three integers
separated by hyphens:
minimum-maximumthreshold
minimum is 3
threshold is 3
maximum is 3

3-3-3

CAMEL capability handling defined as a


list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum
The list is optional, but if the list is
present, all values must be specified.
Determines how the HLR downloads a
TDP and which bars will be invoked at
each possible download phase.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

Home Location Register (Linux) V1.1 Support Guide

400

Chapter 19 CAMEL Commands

Table 44. UPDATE:CAMEL Attribute Values for VTCSI_13 and VTCSI_14 (Continued)
Attribute Name

Values

Default

DEFAULT_CH

CONTINUE or
RELEASE

Identifies whether a call will continue or


be released if an error occurs during call
setup.
Calls can be allowed to continue or
stopped, depending on subscriber type,
such as whether a subscriber is pre-pay
or contract.

GSMSCF_ADDR

A valid global title or the


reserved word
DEFAULT.

Numeric field containing the global title of


network entity that invokes the CAMEL
service logic for mobile terminated calls.
The CAMEL service logic is invoked at
the VMSC, which is within the visited
network.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry in
the hlr_config Table.

LC_UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

0 (no bars
induced)

Home Location Register (Linux) V1.1 Support Guide

Meaning

Service bars to be invoked if the


subscriber has CAMEL services for
VMSC triggered terminating calls and is
registered on a VLR that supports
CAMEL but below the CAMEL phase
indicated by <cch> above.
<lc_unsupp_bh> takes one or more an
operator determined bar (ODB) values. If
absent, no bars are induced.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

Chapter 19 CAMEL Commands

401

Table 44. UPDATE:CAMEL Attribute Values for VTCSI_13 and VTCSI_14 (Continued)
Attribute Name

Values

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

SERVICE_KEY

0 to 231-1

VT_CAUSE_VAL

<vt_cause_val><vt_cause_val><vt_cause_val><vt_cause_val>
-<vt_cause_val>
for example,
2-3-23-111-34
where vt_cause_val is
an integer from 1 to 127
0 (zero) indicates no
vt_cause_value

Default

Meaning
Previously only provisioned for CAMEL
via UPDATE:SUB command.
Service bars to be invoked if the
subscriber has CAMEL services for
VMSC triggered terminating calls and is
registered on a VLR that does not support
the CAMEL phase indicated by <cch>
above.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

This attribute contains reasons for call


processing failure is a list of 5 integers
separated by hyphens.
<VT_CAUSE_VAL> is an integer from 1
to 127.
All 5 values must be present, but a value
of 0 (zero) can be specified to indicate no
value.
Not all 127 values are defined. The HLR
does not restrict any values, it is assumed
provisioning will only attempt to update
using valid VT_CAUSE_VAL values.
The HLR will not enforce unique values.

Home Location Register (Linux) V1.1 Support Guide

402

Chapter 19 CAMEL Commands

Mobility Management CSI (M-CSI)


Table 45. UPDATE:CAMEL Attribute Values for MCSI
Attribute Name

Values

Default

Meaning

CCH

Three integers
separated by hyphens:
minimum-maximumthreshold
minimum is 3
threshold is 3
maximum is 3

3-3-3

For M-CSI, CCH is used in subscriber


data download calculations but not
downloaded to the VLR.
CAMEL capability handling defined as a
list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum
The list is optional, but if the list is
present, all values must be specified.
Determines how the HLR downloads a
TDP and which bars will be invoked at
each possible download phase.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.


Defines whether a change to CSI data
causes a Note Subscriber Data Modified
MAP message to be sent to the platforms
that provide the CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the message are
defined by the CSI_NOTIFY parameter in
the hlr_config Table.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

DEFAULT_CH

CONTINUE or
RELEASE

Identifies whether a call will continue or


be released if an error occurs during call
setup.
Calls can be allowed to continue or
stopped, depending on subscriber type,
such as whether a subscriber is pre-pay
or contract.

GSMSCF_ADDR

A valid global title or the


reserved word
DEFAULT.

Numeric field containing the global title of


network entity that invokes the CAMEL
service logic for mobility management.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry in
the hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

403

Table 45. UPDATE:CAMEL Attribute Values for MCSI (Continued)


Attribute Name

Values

Default

Meaning

LC_UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

0 (no bars
induced)

Service bars to be invoked if the


subscriber has CAMEL services for
mobility management and is registered
on a VLR that supports but below the
CAMEL phase indicated by <cch> above.
<lc_unsupp_bh> takes one or more an
operator determined bar (ODB) values. If
absent, no bars are induced.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

MOBILITY_TRIG

{mob_trig>
<mob_trig>...}
+{mob_trig>
<mob_trig>...}
-{mob_trig>
<mob_trig>...}
For example,
{IMSI_ATTACH
LOC_UPD_SAME_VL
R} sets IMSI attach
and location update in
same VLR triggers

Set of mobility triggers, of which 5 values


are defined by GSM.
At least one value must be present.
{mob_trig> <mob_trig>...} is a list of
mobility triggers, each separated by a
space.
LOC_UPD_SAME_VLR: location update
in same VLR
LOC_UPD_OTHER_VLR: location
update to other VLR
IMSI_ATTACH: IMSI attach
INIT_IMSI_DETACH: MS initiated IMSI
detach
NWK_INIT_IMSI_DETACH: network
initiated IMSI detach
For bit numbers in the subscriber
database, see Mobility Triggers on
page 623.

Home Location Register (Linux) V1.1 Support Guide

404

Chapter 19 CAMEL Commands

Table 45. UPDATE:CAMEL Attribute Values for MCSI (Continued)


Attribute Name

Values

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

SERVICE_KEY

0 to 231-1

Default

Home Location Register (Linux) V1.1 Support Guide

Meaning
Previously only provisioned for CAMEL
via UPDATE:SUB command.
Service bars to be invoked if the
subscriber has CAMEL services for
mobility management and is registered
on a VLR that does not support the
CAMEL phase indicated by <cch> above.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

Chapter 19 CAMEL Commands

405

Supplementary Service CSI (SS-CSI)


Originating CSI and supplementary service CSI data are linked;
changing either causes both to be downloaded to the VLR.
Table 46. UPDATE:CAMEL Attribute Values for SSCSI
Attribute Name

Values

Default

Meaning

CCH

Three integers
separated by hyphens:
minimum-maximumthreshold
minimum 2 or 3
threshold 2 or 3
maximum 2 or 3

3-3-3

For SS-CSI, CCH is used in subscriber


data download calculations but not
downloaded to the VLR.
CAMEL capability handling defined as a
list of 3 values, separated by hyphens.
The list has the format:
minimum-threshold-maximum
The list is optional, but if the list is
present, all values must be specified.
Determines how the HLR downloads a
TDP and which bars will be invoked at
each possible download phase.
minimum: CAMEL phase at which the
TDP was introduced according to MAP
specifications.
threshold: Permissible CAP protocol
levels capable of supporting CAMEL data
maximum: Maximum HLR CAMEL
support.
The CCH list must conform to :
minimum <= threshold <= maximum

CSE_NOTIFY

TRUE
FALSE

Not used by the HLR.


Defines whether a change to CSI data
causes a Note Subscriber Data Modified
MAP message to be sent to the platforms
that provide the CAMEL service logic (the
gsmSCF, which is the SEP in the
Vodafone UK network).
The entities that receive the message are
defined by the CSI_NOTIFY parameter in
the hlr_config Table.

CSI_ACTIVE

TRUE
FALSE

Not used by the HLR.

GSMSCF_ADDR

A valid global title or the


reserved word
DEFAULT.

Numeric field containing the global title of


network entity that invokes the CAMEL
service logic for supplementary services.
DEFAULT indicates that the global title
defined by the CAMEL_GSMSCF entry in
the hlr_config Table.

Home Location Register (Linux) V1.1 Support Guide

406

Chapter 19 CAMEL Commands

Table 46. UPDATE:CAMEL Attribute Values for SSCSI (Continued)


Attribute Name

Values

Default

Meaning

LC_UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

(no bars
induced)

Service bars to be invoked if the


subscriber has CAMEL services for
supplementary services and is registered
on a VLR that supports CAMEL but below
the CAMEL phase indicated by <cch>
above.
<lc_unsupp_bh> takes one or more an
operator determined bar (ODB) values. If
absent, no bars are induced.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

NO_SVC_
UNSUPP_BH

{<odb> <odb>...}
+{<odb> <odb>...}
-{<odb> <odb>...}
{}
for example,
-{<odbaoc> <odbaic>}
removes barring of all
outgoing and incoming
calls from any existing
list of bars

Previously only provisioned for CAMEL


via UPDATE:SUB command.
Service bars to be invoked if the
subscriber has CAMEL services for
supplementary services and is registered
on a VLR that does not support the
CAMEL phase indicated by <cch> above.
This attribute is a set of operator
determined bars, with each one
separated by a space. The set is
enclosed in braces.
{<odb> <odb>...} replaces any existing
set of operator determined bars.
+{<odb> <odb>...} adds bars to any
existing set of operator determined bars.
-{<odb> <odb>...} removes bars from any
existing set of operator determined bars.
"{}" removes all operator determined bar
data.
See Appendix I, Operator Determined
Bars.

SS_CODE

{<ss_code>
<ss_code>...}
For example, {mpty}

Set of SS codes, of which many values


are defined by GSM.
Values are enclosed within braces, with
each one separated by a space.
Multi-party (code mpty) and Explicit Call
Transfer (code ect) are supported within
the HLR.

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

407

Unstructured Supplementary Service Data CSI (UCSI)


Originating CSI and supplementary service CSI data are linked;
changing either causes both to be downloaded to the VLR.
Table 47. UPDATE:CAMEL Attribute Values for UCSI
Attribute Name

Values

Default

Meaning

USSD

<gsmscf_addr>,
<ussd_code> pair

None

<gsmscf_addr> is the global title of the


CAMEL Service Control Function
platform (the SEP in the Vodafone UK
network) that processes the USSD
service code defined by <ussd_code>.

Home Location Register (Linux) V1.1 Support Guide

408

Home Location Register (Linux) V1.1 Support Guide

Chapter 19 CAMEL Commands

409

Chapter 20

Network Entity Command

This command allows you to view network entity database information.


A network entity is a part of the network with which the HLR
communicates (for example, an MSC or VLR).

VIEW:NETWORK
The VIEW:NETWORK command displays the data associated with a
network entity.

Syntax
VIEW:NETWORK,<global_title>,(<ssn>);

Parameters
Parameter

Meaning

<global_
title>

The

<ssn>

An optional parameter to specify the sub-system number of


interest, specified as a number 0-255 or an entity name, for
example, MSC, VLR and so on. When this parameter is present,
one C2:0020 response is generated for the entity matching this
combination of GT and SSN. When this parameter is missing,
there can be more than one response if multiple entities with
different SSNs are defined for the GT.

global title used to identify the entity.

The command returns the entity name, the name of its attribute profile,
global title, point codes and point code list name, time zone and
network entity attributes. The command also returns any operator
determined bars, supplementary services, application contexts, basic
services and CAMEL phases that the entity does not support. Network
entity parameters are described in detail in the Network Entity
(NETENT) Table section of the Table Maintenance chapter.

Response

C2:00020,

<name>,

<global_title>,

<point_codes>,

<PC_list>,

<time_zone>,

<sub_rest>,

<attributes>,

<profile>,

<Unsupp_ODB>,

<Unsupp_SS>,

Home Location Register (Linux) V1.1 Support Guide

410

Chapter 20 Network Entity Command

<Unsupp_AC>,

<Unsupp_BS>,

<Unsupp_CAMEL>,

(<unsupported_serv>);

<SSNs>

C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 20 Network Entity Command

411

Parameter

Values

Description

<name>

Text up to 20 characters

Name of the network entity.

<global title>

Valid global title

Numeric field holding network entity global title

<point_codes>

List of up to 4 point codes.


Each point code is a
number up to 5 digits long.

Point codes used when addressing messages to the


entity. A field is absent if a point code for the entity
does not exist.

<PC_list>

Text

Name of a point code profile in the [PCLIST


<pclist_name>] section of the Network Entity
(NETENT) Table, which lists point codes used by the
network entity.

<time_zone>

Number of half hour units

The number of half-hour units by which the HLR time


differs from the time at the network entity.

<sub_rest>

2-digit hexadecimal
number

Subscription restriction status used to control


roaming. See GSM_SUB_RESTR on page 217 and
GPRS_SUB_RESTR on page 216.

<attributes>

Up to 8-digit hexadecimal
number

Each bit in this field indicates whether the entity


supports a particular feature.
The Attributes in a NETENT Profile table
summarises the available attributes.
For bit numbers of attributes in the HLR database,
see Visited MSC Flags and Network Entity Attributes
on page 618.

<profile>

Text

The name of the Network Entity (NETENT) Table


profile used by this entity. See the [PROFILE
<profile_name>] section.

<unsupp_ODB>

Up to 12-digit hexadecimal
number

Indicates any Operator Determined Barring (ODB)


types that are not supported by the Network Entity.
See Appendix I, Operator Determined Bars for a
description of each ODB.
For bit numbers of operator determined bars in the
HLR database, see Operator Determined Bars on
page 616 in Appendix G, Attribute Bit Numbers in
the Subscriber Database.

<unsupp_SS>

Up to 10-digit hexadecimal
number

Supplementary Services that are not supported by


the Network Entity
See Supplementary Services on page 594 in
Appendix E, Basic and Supplementary Services for
a description of each supplementary service.
For bit numbers of supplementary services in the
HLR database, see Supplementary Services on
page 613 in Appendix G, Attribute Bit Numbers in
the Subscriber Database.

<unsupp_AC>

Up to 16-digit hexadecimal
number

See the Application Contexts table for a description


of each application context.
For bit numbers of application contexts in the HLR
database, see Supplementary Services on page 613
in Appendix G, Attribute Bit Numbers in the
Subscriber Database.

Home Location Register (Linux) V1.1 Support Guide

412

Chapter 20 Network Entity Command

Parameter

Values

Description

<unsupp_BS>

Up to 9-digit hexadecimal
number

Any Basic Services which are not supported by the


Network Entity.
For a description of each basic service, see
Appendix E, Basic and Supplementary Services on
page 591.
For bit numbers of basic services in the HLR
database, see Basic Services on page 611 in
Appendix G, Attribute Bit Numbers in the Subscriber
Database.

<unsupp_CAMEL>

One hexadecimal digit

Specifies the CAMEL phases not supported.


Bit numbers and CAMEL phases are:
PH1
PH2
PH3
For bit numbers of CAMEL phases in the HLR
database, see CAMEL Phases on page 620 in
Appendix G, Attribute Bit Numbers in the Subscriber
Database.
Hex field that indicates the services not supported
by the network entity.
Bit numbers and unsupported services are:
MULTISIM
ROAMED
REGIONAL SUBSCRIPTION
For bit numbers of unsupported services in the HLR
database, see Unsupported Services on page 625 in
Appendix G, Attribute Bit Numbers in the Subscriber
Database.

<unsupp_serv>

All of the response parameters are described in the table Attributes in a


NETENT Profile.

Errors
<error_code>

<error_message>

00099

Internal software error.

Note that although the error code C1:00002,00035 is valid, it will never
be seen by the user when performed on a IN with a default network
entity defined. In this case, the information returned will be on the
default network entity.

Example
VIEW:NETWORK,44775;
Name:UK_Entity
Profile:VLR1

Home Location Register (Linux) V1.1 Support Guide

Chapter 20 Network Entity Command

413

GT:4477512345
PCs:805 869 804
PC-list:DEFAULT_GT
Time-zone:LOCAL
Sub. res:0x01
Attributes:{TSMS HPLMN VODACAT OSMS OR}
Unsupp. ODB:{ODBOPENT ODBOPINFO}
Unsupp. SS:{CLIP CLIR}
Unsupp. AC:{SUBSCRIBER_INFO_ENQUIRY_V3}
Unsupp. BS:{BS20}
Unsupp. CAMEL:{PH1 PH2}
Unsupp. SERV:{REGSUB}

Home Location Register (Linux) V1.1 Support Guide

414

Home Location Register (Linux) V1.1 Support Guide

Chapter 20 Network Entity Command

415

Chapter 21

P Number Commands

Use these commands to add and remove the P (published) number for
a subscriber.
Command

Description

ADD:PNUM

Adds a published number to a


subscriber record

page 416

REMOVE:PNUM

Removes a published number from a


subscriber record

page 418

The P number is used when a subscriber has a linked subscription.


Subscribers belonging to the same group have the same P number, but
each subscriber has their own directory number record containing the P
number.

Home Location Register (Linux) V1.1 Support Guide

416

Chapter 21 P Number Commands

ADD:PNUM
Note: This command has been retained for backward compatibility. If
possible, use UPDATE:SUB instead (see page 215).
The ADD:PNUM command adds a published (P) number to a subscriber
record.

Syntax
ADD:PNUM,IMSI|MSISDN,<key_value>,<pnum>;

Parameters
Parameter

Meaning

IMSI|MSISDN

IMSI or MSISDN, whichever is used to locate the subscriber record

<key_value>

IMSI or MSISDN (depending on the key)

<pnum>

Value for the P number

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found.

00036

Subscriber already has P number.

00044

Unable to add P number.

00055

Unable to access subscriber record.

00099

Internal software error.

Example
To add a P number:
ADD:PNUM,IMSI,234567890123456,447756666666;
GSM PDS - P Number Added

Home Location Register (Linux) V1.1 Support Guide

Chapter 21 P Number Commands

417

Subscriber IMSI - 234567890123456


PNUM
- 447756666666

Value

Definition

234567890123456

Subscriber IMSI

447756666666

Value for the P number

Home Location Register (Linux) V1.1 Support Guide

418

Chapter 21 P Number Commands

REMOVE:PNUM
Note: This command has been retained for backward compatibility. If
possible, use UPDATE:SUB instead (see page 215).
The REMOVE:PNUM command removes a published (P) number from a
subscriber record.

Syntax
REMOVE:PNUM,IMSI|MSISDN,<key_value>;

Parameters
Parameter

Meaning

IMSI|MSISDN

IMSI or MSISDN, whichever is used to locate the subscriber record

<key_value>

IMSI or MSISDN (depending on the key)

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Record not found.

00055

Unable to access subscriber record.

00099

Internal software error.

Example
To remove a P number:
REMOVE:PNUM,IMSI,234567890123456;
GSM PDS - P Number Removed
Subscriber IMSI - 234567890123456

Home Location Register (Linux) V1.1 Support Guide

419

Chapter 22

Subscriber Data Move (SDM)


Commands

These commands are used to move a subscriber or range of


subscribers from one HLR to another.
Command

Description

Page

COMPLETE:SDM

Completes the process of moving subscribers from one HLR to


another, by deleting them from the source HLR.

page 422

EXECUTE:SDM

Moves a subscriber or range of subscribers to a different HLR.

page 420

ROLLBACK:SDM

Rolls back moving subscribers between HLRs, in case of


failure.

page 423

The EXECUTE:SDM command is used to commence the process of


moving the subscribers. The COMPLETE:SDM command is used once
the subscribers have been successfully moved (as assessed by
referring to PULSE counters and log files). If the subscriber move fails,
the ROLLBACK:SDM is used to roll back the changes.

Home Location Register (Linux) V1.1 Support Guide

420

Chapter 22 Subscriber Data Move (SDM) Commands

EXECUTE:SDM
The EXECUTE:SDM command initiates the process of moving a
subscriber or range of subscribers to a different HLR.

Syntax
EXECUTE:SDM,<SDM_file>,<dest_HLR>

SDM File Format

Parameter

Meaning

<SDM_file>

The file, located in the directory pds_l_sdmdir, that


contains the global title and IP addresses of all HLRs,
and template IMSI, and a list of all subscribers and
ranges to be moved. See below for the format of this file.

<dest_HLR>

The HLR to which all subscribers specified in the above


file are to be moved.

[TEMPLATE_IMSI]
<IMSI>
[SUBSCRIBERS]
<Range_1_start> <Range_1_end>
<Range_2_start> <Range_2_end>
.
.
<Range_n_start> <Range_n_end>
<Subscriber_1>
<Subscriber_2>
.
.
<Subscriber_n>
The table can contain number ranges, individual numbers, or a mixture
of the two.
The maximum number of entries is 500. The IMSI must have 15 digits.
The MSISDNs in the subscriber ranges can have up to 15 digits. Lines
can be commented out by inserting ! at the beginning of the line.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 22 Subscriber Data Move (SDM) Commands

421

Errors
<error_code>

<error_message>

00142

HLR file not found.

00143

SDM file not found.

00144

Invalid HLR node file format.

00145

Invalid SDM file format.

00146

Unknown destination HLR.

00147

Invalid HLR configuration data.

00148

Failed to create template IMSI.

00149

Failure to allocate required SDM replications.

00150

Failure to establish TCPIP link.

00151

TCPIP link failure.

00152

Failed to open log file.

00153

Cannot delete template IMSI.

00154

Cannot SDM to specified HLR

Example
EXECUTE:SDM,sdm_file_a,HLRAA;

Home Location Register (Linux) V1.1 Support Guide

422

Chapter 22 Subscriber Data Move (SDM) Commands

COMPLETE:SDM
The COMPLETE:SDM command is run from the source HLR. It
completes the SDM by removing the subscribers from the source HLR.

Syntax
COMPLETE:SDM,<SDM_file>,<dest_HLR>;
Parameters are as for EXECUTE:SDM above.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00142

HLR file not found.

00143

SDM file not found.

00144

Invalid HLR node file format.

00145

Invalid SDM file format.

00146

Unknown destination HLR.

00152

Failed to open log file.

Example
COMPLETE:SDM,sdm_file_a,HLRAA;

Home Location Register (Linux) V1.1 Support Guide

Chapter 22 Subscriber Data Move (SDM) Commands

423

ROLLBACK:SDM
The ROLLBACK:SDM command is run on the source HLR. It is used
following an SDM failure.

Syntax
ROLLBACK:SDM,<SDM_File>,<dest_HLR>;
Parameters are as for EXECUTE:SDM above.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00142

HLR file not found.

00143

SDM file not found.

00144

Invalid HLR node file format.

00145

Invalid SDM file format.

00146

Unknown destination HLR.

00147

Invalid HLR configuration data.

00148

Failed to create template IMSI.

00149

Failure to allocate required SDM replications.

00150

Failure to establish TCPIP link.

00151

TCPIP link failure.

00152

Failed to open log file.

Example
ROLLBACK:SDM,sdm_file_a,HLRAA;

Home Location Register (Linux) V1.1 Support Guide

424

Chapter 22 Subscriber Data Move (SDM) Commands

Home Location Register (Linux) V1.1 Support Guide

425

Chapter 23

General Commands

Use the following commands for other administration activities.


Command

Description

Page

ADD:BAR

Adds an individual operator determined bar for the subscriber

page 435

INITIATE:ALERT

Forces the HLR to attempt to send any waiting SMS messages

page 426

INITIATE:CANCEL

Initiates a cancel location for a specified subscriber on a


specified VLR or SGSN

page 428

INITIATE:RESET

Sends a Reset MAP message to a specified VLR from a


specified HLR

page 430

REMOVE:BAR

Removes an individual operator determined bar for the


subscriber

page 437

RESET:SEED

Resets the initial value of the random number using a random


means

page 439

SET:DATABASE

Changes the database to which subsequent commands are


directed

page 432

SET:MWD

Specifies a message waiting data (MWD) service centre for an


MSISDN

page 433

SET:SEED

Set the next random number generated by the HLR to a specific


value

page 440

UPDATE:IMEI

Change the values of the IMEI fields

page 441

UPDATE:LCN

Updates the last calling information for a subscriber

page 443

UPDATE:LOCATION

Updates the location information for a subscriber

page 445

VIEW:INFO

Displays information about the platform

page 448

Can someone supply detail;s of the RESOLVE:ONPIPC and


VIEW:ONPIPC commands??

Home Location Register (Linux) V1.1 Support Guide

426

Chapter 23 General Commands

INITIATE:ALERT
If a subscriber is sent an SMS and is not reachable, a message waiting
data flag is set in the subscribers VLR to indicate that the VLR should
notify the HLR when that subscriber becomes available again.
If this message waiting data flag is cleared, or not set, before the HLR
has forwarded the SMS to the subscriber, the VLR will never notify the
HLR that the subscriber has become available, the SMS will remain
undelivered, and might eventually be deleted from the sending text
message centre, the HLR or both.
If the subscriber moves to a new location, an update location message
is sent, which causes HLR to check message waiting data for the
subscriber and send the SMS.
If the subscriber does not move, the INITIATE:ALERT command can
be used to force the HLR to attempt contact the service centre, to
instruct it to try to send any waiting SMS messages.

Syntax
INITIATE:ALERT,<key_type>,<key_value>;

Parameters
Parameter

Meaning

key_type

IMSI or MSISDN, whichever is used to locate the subscriber record

<key_value>

IMSI or MSISDN (depending on the key)

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

427

Errors
<error_code>

<error_message>

00002

Subscriber IMSI not in use.

00005

Subscriber MSISDN not in use.

00055

Unable to access subscriber record.

00099

Internal software error.

00130

Unable to initiate alert.

Example
To force an alert to be sent:
INITIATE:ALERT,IMSI,123456789012345;
GSM PDS - Alerts Initiated
Subscriber IMSI

- 123456789012345

Home Location Register (Linux) V1.1 Support Guide

428

Chapter 23 General Commands

INITIATE:CANCEL
The INITIATE:CANCEL command initiates a cancel location for a
specified subscriber on a specified VLR or SGSN. It allows deletion of
the VLR record when the HLR record has removed the subscribers
registered status.

Syntax
INITIATE:CANCEL,<imsi>,<num>,<location_flavour>;

Parameters
Parameter

Meaning

<imsi>

Subscriber IMSI

<num>

VLR global title for a GSM location, or SGSN global title for a GPRS location.

<location_flavour>

(GSM/GPRS) Optional parameter indicating whether to cancel a GSM or GPRS


location. If this parameter is not specified, GSM is assumed.

The subscriber IMSI does not need to be in the HLR database. This
operation does not update the HLR database.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00060

Unable to initiate Cancel Location.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
To delete a VLR record:
INITIATE:CANCEL,123456789012345,12345678901;
GSM PDS - Cancel Location Initiated

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

429

Subscriber IMSI - 123456789012345

Value

Definition

123456789012345

Subscriber IMSI

12345678901

VLR number

Home Location Register (Linux) V1.1 Support Guide

430

Chapter 23 General Commands

INITIATE:RESET
The INITIATE:RESET command sends a Reset MAP message to a
specified VLR from a specified HLR. All subscribers that belong to the
specified HLR have their records deleted from the VLR.
INITIATE:RESET is similar to INITIATE:CANCEL but for multiple
subscribers.

Syntax
INITIATE:RESET,<hlr_gt>,<vlr_gt>;

Parameters
Parameter

Meaning

<hlr_gt>

Global Title of the HLR

<vlr_gt>

Global Title of the VLR

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;
Note: This does not apply to an SGSN.

Errors
<error_code>

<error_message>

00099

Internal software error.

Example
To send a Reset MAP message:
INITIATE:RESET,44775123456,44775234561;
GSM PDS - Reset Initiated
Global Title - 44775123456
Value

Definition

44775123456

Global Title of the HLR

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

431

Value

Definition

44775234561

Global Title of the VLR

Home Location Register (Linux) V1.1 Support Guide

432

Chapter 23 General Commands

SET:DATABASE
The SET:DATABASE command specifies the database to which
subsequent commands will be directed.

Syntax
SET:DATABASE,<log_db_name>;

Parameters
Parameter

Values

Default

Meaning

<log_db_name>

Logical
database name

If the
platform
has only
one
database,
this is the
default

Logical name of the HLR database to which


subsequent commands will be directed.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00167

Invalid .database.

Example
SET:DATABASE,LHLRA1;

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

433

SET:MWD
The SET:MWD command specifies a message waiting data (MWD)
service centre for an MSISDN. A service centre is an entity such as an
MLR or text messaging centre (TMC).

Syntax
SET:MWD,<msisdn>,<service_centre>;

Parameters
Parameter

Values

Default

Meaning

<msisdn>

Valid MSISDN

(none)

Number field containing the subscribers


MSISDN

<service_centre>

Valid global title

(none)

Number field. The global title identifies the


service centre that has message waiting data for
the subscriber.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00005

Subscriber MSISDN not in use.

00055

Unable to access subscriber record.

00099

Internal software error.

00116

Unable to allocate resource

00122

Subscriber already has max number of Service Centres.

Example
To set message waiting data:
SET:MWD,44370123456,44775234561;
GSM PDS - MWD set

Home Location Register (Linux) V1.1 Support Guide

434

Chapter 23 General Commands

Global Title - 44775123456


Value

Definition

44370123456

Subscribers MSISDN

44775234561

Global Title of the service centre

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

435

ADD:BAR
The ADD:BAR command adds an individual operator determined bar
for the subscriber.
Any bars imposed on a GPRS subscription that have no meaning in the
scope of GPRS will be ignored.
Any ODB which affects the HLR maintained VLR/SGSN image will
cause a download to the relevant VLR/SGSN.

Syntax
ADD:BAR,<key_type>,<key_value>,<odb>;

Parameters
Parameter

Meaning

key_type

IMSI or MSISDN, whichever is used to locate the subscriber record

<key_value>

IMSI or MSISDN (depending on the key)

<odb>

Operator determined bar parameter (see Appendix I, Operator Determined Bars)

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Subscriber IMSI not in use.

00005

Subscriber MSISDN not in use.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal Software error.

Example
To apply a bar:
ADD:BAR,IMSI,123456789012345,ODBOIC;

Home Location Register (Linux) V1.1 Support Guide

436

Chapter 23 General Commands

GSM PDS - Operator Determined Bar Added


Subscriber IMSI - 123456789012345
In this case the subscriber is barred from making international calls.
If ADD:BAR causes subscriber data download to a VLR but the
download fails, error 00061, HLR updated but Subscriber Data
download failed, will occur.

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

437

REMOVE:BAR
The REMOVE:BAR command removes an individual operator
determined bar for the subscriber.
Any ODBs imposed on a GPRS subscription, which have no meaning
in the scope of GPRS, are ignored.
Any ODB which affects the HLR maintained VLR/SGSN image requires
a download to the relevant VLR/SGSN.

Syntax
REMOVE:BAR,<key_type>,<key_value>,<odb>;

Parameters
Parameter

Meaning

key_type

IMSI or MSISDN, whichever is used to locate the subscriber record

<key_value>

IMSI or MSISDN (depending on the key type)

<odb>

Operator determined bar parameter (see Appendix I, Operator Determined Bars)

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Subscriber IMSI not in use.

00005

Subscriber MSISDN not in use.

00055

Unable to access subscriber record.

00061

HLR updated but Subscriber Data download failed.

00099

Internal software error.

Example
To remove a bar:
REMOVE:BAR,IMSI,123456789012345,ODBOIC;

Home Location Register (Linux) V1.1 Support Guide

438

Chapter 23 General Commands

GSM PDS - Operator Determined Bar Removed


Subscriber IMSI - 123456789012345
In this case the subscriber is no longer barred from making
international calls.
If REMOVE:BAR causes subscriber data download to a VLR/SGSN but
the download fails, error 00061, HLR updated but Subscriber Data
download failed will occur.

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

439

RESET:SEED
This command resets the initial value of the random number using a
random means.

Syntax
RESET:SEED;
This command has no parameters.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00099

Internal software error.

Example
RESET:SEED;
GSM PDS - AUC Seed Reset

Home Location Register (Linux) V1.1 Support Guide

440

Chapter 23 General Commands

SET:SEED
This command can be used to set the next random number generated
by the HLR to a specific value.

Syntax
SET:SEED,<random_num>;

Parameters
Parameter

Meaning

<random_num>

ASCII text string of 32 characters in range 0 to 9 and A to F.


The next random number to be generated by the HLR.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00099

Internal software error.

Example
SET:SEED,12345678901234567890123456789012;
GSM PDS - AUC Seed Set
SEED - 12345678901234567890123456789012

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

441

UPDATE:IMEI
This command is used to change the value of one or more IMEI fields.
It also initiates a trigger to NBS.

Syntax
UPDATE:IMEI,<key_type>,<key_value>,(<IMEI>),
(<source>),(<time>),(<CSC>),(<PSC>),(<recache>),
(<update_NBS>);

Parameters
Parameter

Meaning

<key_type>

IMSI or MSISDN.

<key_value>

Value of IMSI or MSISDN.

<IMEI>

A valid IMEI-SV.

<source>

Source of the IMEI-SV: one of: UPL, UGL, EIR, CS-PSI, PS-PSI, ADMIN, NONE.
NONE indicates that the IMEI-SV is invalid.

<time>

Timestamp.

<CSC>

Value of Circuit Switched Current: TRUE or FALSE.

<PSC>

Value of Packet Switched Current: TRUE or FALSE.

<recache>

Value of Recache flag: TRUE or FALSE.

<update_NBS>

Determines whether the command forces an immediate trigger to NBS: TRUE or


FALSE.

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

442

Chapter 23 General Commands

Errors
<error_code>

<error_message>

00156

Unable to reset recache bit and initiate trigger to


NBS.

00157

Could not update data for pending SIM.

Example
UPDATE:IMEI,IMSI,234150000000001,1234567890567890,
UPL,NOW,TRUE,TRUE,TRUE,TRUE;
GSM PDS - IMEI Data Updated

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

443

UPDATE:LCN
This command updates the last calling information.

Syntax
UPDATE:LCN,<msisdn>,(<last_caller>),(<pres_num>),
(<LCN_time>),(<LCN_action>),(<LCN_pres_ind>)
(<LCPN_pres_ind>),(<LCN_type>),(<LCN_SIM_id>),
(<LCN_erase>);

Parameters
Parameter

Meaning

<msisdn>

Number for the MSISDN.

<last_caller>

Number containing the CLI presented by SRI of last incoming call.

<pres_num>

Presentation number in the SRI of last incoming call.

<LCN_time>

LCN timestamp (seconds since 01/01/1991).

<LCN_action>

LCN action taken for last call (for example, CFU_RECALL).

<LCN_pres_ind>

CLI status of last caller: RESTRICTED,


NOT_RESTRICTED_NOT_CONTROLLABLE, NOT_PRESENT.

<LCPN_pres_ind>

CLI status of presentation number: RESTRICTED,


NOT_RESTRICTED_NOT_CONTROLLABLE, NOT_PRESENT.

<LCN_type>

Basic service used by last incoming call.

<LCN_SIM_id>

Identity of SIM, with a value of 0 to 9.

<LCN_erase>

LCN erase flag: FALSE (Erase clear), or TRUE (Erase Set)

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Home Location Register (Linux) V1.1 Support Guide

444

Chapter 23 General Commands

Errors
<error_code>

<error_message>

00002

Subscriber IMSI not in use.

00055

Unable to access subscriber record.

00099

Internal software error.

Example
UPDATE:LCN,44385000000,44345678901,
4456789012345,31-DEC-2004,FAIL_ACR,NOT_PRESENT,NOT
_PRESENT,BS30,9,TRUE
GSM PDS - Last Calling Number updated

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

445

UPDATE:LOCATION
This command updates the location information.

Syntax
GSM

GPRS

UPDATE:LCN,<imsi>,GSM,(<vlr>),(<msc>),(<status>),
(<suspect>),(<operation>),(<time>),
(<map_version>),(<emap>),(<entity_flags>),
(<unsupp_bs>),(<unsupp_ss>),(<unsupp_odb>),
(<unsupp_serv>),(<unsupp_camel>),(<unsupp_pos>),
(<LMSID>);
UPDATE:LCN,<imsi>,GPRS,<sgsn_number>,(<sgsn_addr>),
(<status>),(<suspect>),(<operation>),(<time>),
(<map_version>),(<emap>),(<entity_flags>),
(<unsupp_bs>),(<unsupp_ss>),(<unsupp_odb>),
(<unsupp_serv>),(<unsupp_camel>),(<unsupp_pos>),
(<LMSID>);

Parameters
Parameter

Meaning

<imsi>

Number for the IMSI.

<vlr>

VLR number of type ISDN.

<msc>

MSC number of type ISDN.

<sgsn_number>

SGSN number of type ISDN.

<sgsn_addr>

IP address of SGSN (IP V6 or V4)

<status>

Location status for subscriber: ABANDONED, AC_CONFLICT,


ADMIN_CHANGED, ADMIN_DISABLED, BLACK_LISTED, DECSS7_SENDF,
INVALID, ISD_DSD_FAIL, PURGED, REGISTERED, REGISTERED?,
ROAM_ODB_ROAM_STOPPED, RR_UNSUPFEATURE, TIMEOUT,
UNKNMOWN_IN_VLR, UNSUP_POS, UNSUP_SVS_RESTR.

<suspect>

Suspect:TRUE or FALSE.

<operation>

Operation that set the current location service (excluding SDM): ADM (admin
process), DSD (delete subscriber data), ISD (insert subscriber data), NMS (note
MS present), PMS (purge MS), RSD (restore data), SNP (send parameters),
UPL (update location/update location GPRS).

<time>

Registration timestamp (seconds since 01/01/1991).

<map_version>

Map version whose value indicates which MAP version the entity used for
registration.

<emap>

Emap Boolean flag which indicates whether the network entity on which the
subscriber attempted to register has agreed to use EMAP by using it at
registration time: TRUE or FALSE.

Home Location Register (Linux) V1.1 Support Guide

446

Chapter 23 General Commands

Parameter

Meaning

<entity_flags>

List of entity flags enclosed in braces {}. See Visited MSC Flags and Network
Entity Attributes on page 618.

<unsupp_bs>

List of unsupported basic services enclosed in braces {}. See Basic and
Supplementary Services on page 591.

<unsupp_ss>

List of unsupported supplementary services enclosed in braces {}. See Basic


and Supplementary Services on page 591.

<unsupp_odb>

List of unsupported operator determined bars enclosed in braces {}. See


Operator Determined Bars on page 647.

<unsupp_serv>

List of unsupported service flags enclosed in braces {}. 0: MULTISIM (many


SIMs linked to a single published number used for linked subscriptions), 1:
ROAMED (pre-pay roaming call back service), 2: REGSUB (regional
subscription used for home zone charging).

<unsupp_camel>

List of unsupported CAMEL flags enclosed in braces {}. PH1: Phase 1, PH2:
Phase 2, PH3: Phase 3.

<unsupp_pos>

Unsupported position: TRUE or FALSE.

<LMSID>

LMSID (octet string with length 4).

Response
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;

Errors
<error_code>

<error_message>

00002

Subscriber IMSI not in use.

00055

Unable to access subscriber record.

00099

Internal software error.

Example
For GSM update:
UPDATE:LOCATION,234150000000000,GSM,11111111,
11111111,ABANDONED,FALSE,ADM,01-JAN-1998,1,FALSE,
FALSE,{OR HPLMN OSMS},{TS11 BS30},{CFU CFB},
{ODBAIC},{REG_SUB ROAMED},{PH1},FALSE,11111111;
GSM PDS - Location updated
For GPRS update:

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

447

UPDATE:LOCATION,234150000000000,GPRS,
123456789012345,255.255.255.255,
UNSUP_SVC_RESTR,TRUE,UPL,31-DEC-2005,23:59:59.99,
3,TRUE,FALSE,{MMR VODACPC TSMS},{TS11 BS30},
{CFU CFB},{ODBAIC ODBAOC},{MULTISIM},
{PH1 PH2 PH3},TRUE
GSM PDS - Location updated

Home Location Register (Linux) V1.1 Support Guide

448

Chapter 23 General Commands

VIEW:INFO
The VIEW:INFO command displays information about the platform.

Syntax
VIEW:INFO;
Note: this command does not have any parameters.

Response
C2:00000,00065,<platform>,<pds_version>,<platform_
version>,<platform_name>;
C1:00000,00000;
or
C1:00002,<error_code>,<error_message>;
Parameter

Description

<platform>

Text field specifying the platform type. unknown if information is not available.

<pds_version>

Text field specifying the PDS version of software currently supported by the
platform. unknown if information is not available.

<platform_version>

Text field specifying the application version of software currently supported by


the platform. unknown if information is not available.

<platform_name>

Text field specifying the platform name.

Errors
<error_code>

<error_message>

00099

Internal software error

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

449

Example
To display platform information:
VIEW:INFO;
GSM PDS Platform Information
Platform

- HLR

PDS Version

- V0510

Platform Version

- V7.20

Platform Name: HANTS2

Home Location Register (Linux) V1.1 Support Guide

450

Home Location Register (Linux) V1.1 Support Guide

Chapter 23 General Commands

451

Chapter 24

Table Maintenance

The network operator configures each HLR for a specific network using
data tables. This chapter explains how to maintain these data tables. It
includes:
A quick reference to descriptions of each HLR data table (see HLR
Data Tables Quick Reference on page 452).
Types of table, their filenames and locations (see Table Files on
page 454).
The process used to maintain the tables (see Changing Tables on
page 456).
The table maintenance commands used in the table maintenance
process (see Table Maintenance Commands on page 460).
A description of the contents of each table (see HLR Tables on
page 463).

Home Location Register (Linux) V1.1 Support Guide

452

Chapter 24 Table Maintenance

HLR Data Tables Quick Reference


The table below lists the HLR data tables. Most of the HLR tables are
located in the /var/opt/vodafone/pds/tables directory (see
Directory Structure on page 74).
Table

File Name

Description

See

Administration Client

adm_client.dat

Names and parameters of all


administration client types.

page 463

Address String
Convert

ascvt.dat

Used to convert address strings to


international format.

page 465

Bearer Capabilities

bca.dat

Data downloaded to a VLR to help


set up basic services.

page 465

B Number

bnum.dat

Identifies entertainment numbers


and special behaviour numbers.
Used to check call barring and
supplementary services.

page 466

C Number

cnum.dat

Numbers that cannot be diverted


to.

page 467

C Number Behaviour

cnum_bhvr.dat

Types of forward-to number


translation, which can be applied
to individual subscribers.

page 469

HLR Configuration

hlr_config.dat

HLR configuration data.

page 471

HLR_NODE table

hlr_node.dat

Contains the names, global titles


and both IP addresses for all
HLRs.

page 495

HSSCFG
Configuration

hsscfg.dat

Defines SIGTRAN connections.

page 495

SIGTRAN Event
Configuration

pds_sigtran_event

Configures SIGTRAN events.

page 502

E.164 Conversion
Numbers

io_convert.dat

Conversion of MSISDNs to cope


with numbering convention
change.

page 503

Master Key

mkey.dat

Used by subscriber key encryption


(SKE).

page 508

Mobile Station
Roaming Number
Prefix

msrnpfx.dat

Lists prefixes used by roamed


subscribers.

page 508

MVNO Identification

mvno_id.dat

Maps IMSI data to a MVNO.

page 508

Network Entity

netent.dat

Lists names and attributes of all


network entities that can
communicate with the HLR.

page 509

PDS Configuration

pds_config.dat

Configuration common to all PDS


nodes.

page 523

PDS Definitions

pds_defs

Contains the HLR global title.

page 493

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

453

Table

File Name

Description

See

PIPC

pipc.dat

Lists those nodes with which the


Off-Node PIPC Router process
maintains permanent connection.

page 527

SCCPR Node

sccpr_node.dat

Configures the Administration


replications system.

page 528

SDM Destinations

sdm_dest.dat

Used in the SDM process, and lists


destination HLRs.

page 529

SMS Barring

smsbar.dat

Determines the barring applied to


SMS messages.

page 529

SMS Barring
Responses

smsbar_resp

Specifies the responses sent when


an SMS bar is applied.

page 530

Service Provider

sp.dat

Lists all service providers.

page 532

SS7 Configuration

ss7cfg.dat

Defines SS7 links and destinations

page 533

SS7 Event
Configuration

pds_ss7_event

Defines SS7 events. This file does


not use the table maintenance
commands and is in directory
/etc/opt/vodafone/pds

page 534

Timer

timer.dat

Configures all HLR timers

page 505

Transport Key

tkey.dat

Used by subscriber key encryption


(SKE)

page 508

Unstructured
Supplementary
Service Data

ussd.dat

Information about unstructured


supplementary services data
(USSD).

page 534

Voicemail

voicemail.dat

Contains Voicemail configuration


data.

page 560

Home Location Register (Linux) V1.1 Support Guide

454

Chapter 24 Table Maintenance

Table Files
Master copies of table files are kept on disk in ASCII table files with
.dat extensions. Information in the tables is loaded into memory from
the current directory /var/opt/vodafone/pds/tables/
current at system start-up, where it is used by the HLR processes.

Table Instances

Each HLR table exists as three instances (listed in Table 48). All three
instances of a table are referred to by the same table identifier: the
Table File name without the .dat extension. You can access each
instance using Table Maintenance commands (see Table Maintenance
Commands on page 460) but you can only change the working file,
which is a disk copy of the table file. When you are satisfied that your
changes are correct, you can permanently update the table file with the
contents of the working file.
You can view the table files using standard operating-system tools, for
example, the less command.
Table 48. Table File Instances

Instance

Description

Table File

Static, master copy of the Table, held on disk in the current directory and loaded into
memory on system start-up.

Table in
Memory

Memory copy of the Table File: the data used by the system. Modified using the
REPLACE:TABLE command and created at system start-up.

Working File

Disk copy of the Table File in the working directory, /var/opt/vodafone/pds/


tables/working, which you can change without affecting system operation. Created
using standard operating-system tools to copy the corresponding file from the current
directory.
You can do the following to the Working File:
edit it - using a text editor
check for format/syntax errors using the VERIFY:TABLE command before attempting to
load the data
overwrite the Table File and Table in Memory with it - using the REPLACE:TABLE
command

Commands

Table maintenance commands can be issued using admp to update


table information, without stopping and restarting the HLR. The
commands are described on page 456.
Figure 51, below, shows the relationship between the table instances,
and the table maintenance commands.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

455

Figure 51. Relationships of Table Instances and Maintenance Commands

Table
in
memory

REPLACE:TABLE

User Supplied
File

VERIFY:TABLE

HLR start-up
REPLACE:TABLE
Working File

Table File
(current)

Data movement

Table maintenance commands are listed in Table 49 below. A full


description is given in Table Maintenance Commands on page 460.
Table 49. Table Maintenance Commands
Command

Effect

ANALYSE:TABLE

For use by third-line support only. This generates an ASCII dump of the table in
memory for problem analysis. The resulting file is not compatible with the load
format.

DEVSTATUS:TABLE

Show whether the Table in Memory contains data from the Working File or the Table
File, and whether REPLACE:TABLE has been used or the system restarted. Also
shows the percentage of the Table in use. See page 461.

REPLACE:TABLE

Replace the data in the Table in Memory and the Table File with the data from the
Working File or a user-specified file. See page 461.

VERIFY:TABLE

This does a load to nowhere using the Working File or a user-specified file; it is
therefore similar to REPLACE:TABLE, but without altering the data being used by
the live system. It is used to check for format/syntax errors before attempting to load
the data for real with REPLACE:TABLE. See page 462.

Home Location Register (Linux) V1.1 Support Guide

456

Chapter 24 Table Maintenance

Changing Tables
This section describes how to change a table. A flowchart summarising
the procedure is shown in Figure 52 on page 457. The Table
Maintenance commands are described in Table Maintenance
Commands on page 460.
Note: You can use the DEVSTATUS:TABLE command at any time
during the procedure:

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

457

Figure 52. Procedure for Updating a Table


START

Copy the table from


the current to the
working directory

Obtain new Table File,


for example, on a USB
drive

Edit the copied file

VERIFY:TABLE
Verify Working File

Test data

No

Data
correct?

Yes
REPLACE:TABLE
Overwrite Table File
and Table in Memory
with Working File or
specified external file

STOP

Home Location Register (Linux) V1.1 Support Guide

458

Chapter 24 Table Maintenance

Changing the Data


1. Identify the changes required to the Table.
2. Log in as pds_manager.
3. Create a Working File from the Table File by copying it.
4. Create a separate backup copy of the table file.
5. Use one of the standard Linux editors (for example vim) to amend
the Working File. Once you have completed and checked the
changes, exit the editor.
6. Use VERIFY:TABLE to check for format and syntax errors in the
edited working file.
7. Use REPLACE:TABLE to replace the data in the Table with that from
the Working File.
If the data from the Working File contains errors, these are reported,
including the error type and line number, in an .err file in the
working directory, /var/opt/vodafone/pds/tables/working,
and the table is not replaced. In this case, repeat step 5 to step 7.
Note: If the Network Entity (netent) Table is replaced using the
REPLACE:TABLE command, screen definition files (SDFs) for the
PULSE utility are regenerated automatically.

Testing the Data


1. Check that the new information in the Table does not cause
problems with the operation of the HLR.
- If the HLR fails after a REPLACE:TABLE command, you can
reload the original data from your backup version of the Table
File.
Each time a table is replaced, a backup copy of the replaced
table is created in /opt/vodafone/pds/data/tables/
backup, called tablename.dat_YYYYMMDDHHMMSS,
whereYYYYMMDDHHMMSS is the date and time the table was
replaced. Rename the last good backup version of the table by
deleting the date and time information, and then reload it using
another REPLACE:TABLE command.
2. If the HLR restarts during the test period, identify the cause of the
restart before taking any action.
- If the restart had nothing to do with the Table, check the status of
the Table before continuing (use DEVSTATUS:TABLE).
- If the changes to the file caused the restart, correct the file by
following step 5 to step 7 of Changing the Data above.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

459

3. Use DEVSTATUS:TABLE to check that the Table is correct.


Note: The REPLACE:TABLE command only replaces the Table in
Memory and Table File on a single node. REPLACE:TABLE must be
run on both live and standby nodes.

Home Location Register (Linux) V1.1 Support Guide

460

Chapter 24 Table Maintenance

Table Maintenance Commands


This section describes the Table Maintenance commands listed in
Table 49 on page 455.

Connecting to
Table
Maintenance

To issue table maintenance commands, you must use an admp client


of type TM.
Log on to the HLR and issue the following command:
admp -c TM
You can now issue the table maintenance commands listed in theTable
Maintenance Commands table.

ANALYSE:TABLE
This command creates an ASCII file with details of the Table in
Memory, together with a summary of internal table management
information.
Note: The output files produced by the ANALYSE:TABLE command
cannot be used as input files for the REPLACE:TABLE command.
The command format is:
ANALYSE:TABLE,table,(file_name);
The file_name argument allows the user to specify the path and file
name for the results of analysis. If the file_name argument is
omitted, the results of analysis are written to:
/opt/vodafone/pds/data/tables/working/
table_name.ana

Error Messages

The error messages are:


Message

Meaning

An IO error
occurred

The command is unable to write to the output file.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

461

DEVSTATUS:TABLE
This command displays the following information about the operation
and non-operation sides of a table in memory:
Whether the side is currently in use.
When the table was loaded.
How the side was loaded (INIT = loaded at startup, REPLACE =
loaded using the REPLACE:TABLE command).
The status of the data in that side (LOADED = side contains valid
data, EMPTY = side contains no data, CORRUPT = the result of a
failed REPLACE:TABLE command due to invalid data).
Table-specific information, such as usage data.

Command
Format

The command format is:


DEVSTATUS:TABLE,table

Example Output

Node: JONAH1 Current_index:

Usage

Timestamp

Command

Status

Num Client Types

0
*

10-APR-2006
11:10

INIT

LOADED

10-APR-2006
11:10

INIT

EMPTY

GSM PDS - Devstatus table success

REPLACE:TABLE
This command replaces the data in the Table in Memory and the Table
File with the data from a file. Tables are replaced on both live and
standby nodes automatically, so this command needs to be used on
one node only.
The optional OVERRIDE argument lets you use REPLACE:TABLE even
when the Table is being accessed by the application. You can only use
it if you specify a file explicitly on the command line.
If you do not specify a file explicitly, the default is a file with the same
name as the table file (in lower case), with an extension of .dat, in the
working directory. For example, /var/opt/vodafone/pds/
tables/working/bca.dat.
If the file you specify does not start with /, it is interpreted as relative to
the working directory, /var/opt/vodafone/pds/tables/
working.

Home Location Register (Linux) V1.1 Support Guide

462

Chapter 24 Table Maintenance

If the file you specify is in the working directory, it is deleted after the
table is replaced. Otherwise, the file is not deleted.
Note: You should never edit a file directly in the current directory, as
this will have unpredictable results.

Command
Format

The command format is:


REPLACE:TABLE,table,(file),(OVERRIDE);

Error Messages
Message

Meaning

Specified table is
still in use

The specified table is in use, and the OVERRIDE argument


was not specified. No action is taken, and the system state
is unaffected.

Unable to parse
specified file

The format of the file is invalid, or the command parser


could not read it. The table is not loaded, no notifications
are sent, and the system state is unaffected.

Failed to perform
table update
action

The tables own post-update processing failed. The table is


successfully loaded into the non-operational side, interested
users have been notified pre-update, and the table side in
use has been flipped (that is, the new data is in use).
However, post-update user notifications have not taken
place, and the system state may be inconsistent.

Timeout waiting
for response
from interested
user

An interested user failed to respond to its notification in time


(10 seconds). An alarm is raised identifying the user that did
not respond. This error may be raised either before or after
the table side in use is flipped, and the system state may be
inconsistent.

VERIFY:TABLE
This command does a load to nowhere using the specified file; it is
therefore similar to REPLACE:TABLE, but without altering the data
being used by the live system.
Use it to check for format/syntax errors in the file before attempting to
load the data for real with REPLACE:TABLE.

Command
Format

The command format is:


VERIFY:TABLE,table,(file);

Error Messages
Message

Meaning

Unable to parse
specified file

The file contains invalid data, or the command was unable


to read it.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

463

HLR Tables
This section describes the tables used by the HLR.
Note: The tables shown are examples, your own may be different.
Each record in each table must be on a single line. Comment lines are
allowed. (Use ! as the first character on each comment line.)

adm_client Table
The ADM_CLIENT table contains the names of the clients that are
allowed to connect to the HLR. The table specifies a maximum number
of each client type that can be connected at any one time, and lists the
administration commands that each client type is allowed to use.
An attempt to start an administration session with a client type not listed
in this table, or no client type specified at all, will fail and return an error
message.
This table contains one section per client type, and up to 32 different
client types can be defined.
[CLIENT_TYPE client_type_name]
CLIENT_TYPE_NUMBER type_number
MAX_CLIENTS max_clients
MAX_CLIENTS max_clients
TIMEOUT timeout_value
LIVE_ONLY live_only_value
TCP_PORT port_number
STRIP_C2 strip_c2_value
ALLOW command
ALLOW command
ALLOW command
ALLOW command

Home Location Register (Linux) V1.1 Support Guide

464

Item

Chapter 24 Table Maintenance

Values

Default

client_type_name

Description
Client type names must be
specified because there is no
default name.
A maximum of 32 different client
types can be specified.
Examples of client types are:
INTERACTIVE
ISAAC
INVIEW
NET_TEST
TM

type_number

Any 32-bit
integer

(none)

Required for SCCPRs performing


admin mediation.

max_clients

1 to 135

(none)

Maximum number of this client


type that can be connected at one
time.
Although the maximum is 135, the
sum of all max_clients values for
all client types must not exceed
135, otherwise the table will not
load and an error message will be
returned.

timeout_value

0 to 86400

Number of seconds to wait for a


command before the ADMP client
aborts. A value of 0 means it will
not time out.

live_only_value

TRUE or
FALSE

TRUE

TRUE means the client type can


connect only to the live node;
FALSE means the client type can
connect to the live or the standby
node. This should only be set to
FALSE for the TM client type.

(none)

This field is required for those


clients that are allowed admin
mediation. It specifies the port on
the HLR that the client can route
to.

port_number

strip_c2_value

TRUE or
FALSE

command

An HLR
administration
command

Optional parameter to control


whether C2 responses are sent out
to certain client types.
(none)

Home Location Register (Linux) V1.1 Support Guide

An administration command that


can be used by a client of type
client_type_name.
If an invalid ADM command is
specified, the table will not load.
Clients can use only the
commands listed: if they try to use
one not listed the command will
fail.

Chapter 24 Table Maintenance

465

Address String Convert (ascvt) Table


The Address String Convert (ascvt) table contains data used to convert
address strings to international format. The format of entries in the
table is:
<NAI> <prefix> <number_of_skip_digits>
<new_prefix>
Item

Values

Default

Description

<NAI>

Nature of Address Indicator

<prefix>

Prefix for the NAI

<number_of_
skip_digits>

Number of digits to remove from the


start of the number

<new_prefix>

New prefix to be added to the number

The table has a maximum of 50 entries.

Example

! Table Format:
! Nature of Address Indicator Prefix to match
new prefix
! Maximum of 50 entries
!
NAI_INTERNATIONAL NONE 0 NONE
NAI_NATIONAL NONE 0 44
NAI_UNKNOWN 00 2 NONE
NAI_UNKNOWN 0 1 44

No. skip digits

Bearer Capabilities (bca) Table


The bca (Bearer CApabilities) table contains numbers which are
downloaded to the VLR to help it set the correct basic services for
incoming calls.
The bca table consists of:
A BC Title, which is text containing the Bearer Capability title (of up
to 16 characters) associated with a MSISDN. Every MSISDN record
must be associated with a BC TITLE.
A tag identifying the basic service.
A backup basic service.
Two digit hex numbers that represent the physical characteristics of
the communications link.
Also, a BC title entry can be marked, with an asterisk, as the default
service to be used for the specified BS.
Each entry has the format:
<BC_Title> <BS>[*] <Backup_BS>|NONE <octet_1>

Home Location Register (Linux) V1.1 Support Guide

466

Chapter 24 Table Maintenance

<octet_2>...<octet_n>
where n is a maximum of 16.
The optional asterisk following a BS field indicates that the entry is the
default entry for the basic service specified in the BS field. If more than
one BC title is marked as the default for a single BS, the table will fail to
load.
If a backup service is associated with the BC title, it is specified in the
Backup BS field, otherwise this field contains NONE and the default
backup service (indicated by the asterisk) is used. If the <Backup_BS>
field contains NONE and no default is indicated, a warning is raised
when the table is loaded.
Figure 53. Example bca Table Entries
TS11 TS11* NONE 0x04 0x01 0xA0
BS26 BS26* NONE 0x04 0x07 0xA2 0x88 0x81 0x21 0x15 0x63 0xE8
BS20 BS20 BS26 0x01 0x02 0x03 0x04 0x05 0x06 0x06 0x07 0x08

See Appendix E, Basic and Supplementary Services for details of the


basic services.

B Number Table (bnum)


The B number table (bnum) identifies called numbers as information,
entertainment, or having one of four special behaviours HPLMN1 to
HPLMN4. The B number table is used in a similar way to operator
determined barring (see Appendix I, Operator Determined Bars) to
check that a call to a particular number is allowed.
The B number table is referred to for services that require an intelligent
node to make a call on behalf of a subscriber, such as the service that
can divert calls to any number.
Figure 54. Example B Number Table
[BARRING]
441 ODBHPLMN1
448 ODBOPENT
44898 ODBOPENT ODBOPINFO ODBHPLMN1 ODBHPLMN2 ODBHPLMN3 ODBHPLMN4
33898 ODBOPENT ODBOPINFO ODBHPLMN1 ODBHPLMN2 ODBHPLMN3 ODBHPLMN4
34898 ODBOPENT ODBOPINFO ODBHPLMN1 ODBHPLMN2 ODBHPLMN3 ODBHPLMN4
44123 ODBHPLMN1 ODBHPLMN2 ODBHPLMN3 ODBHPLMN4
33123 ODBHPLMN1 ODBHPLMN2 ODBHPLMN3 ODBHPLMN4
34123 ODBHPLMN1 ODBHPLMN2 ODBHPLMN3 ODBHPLMN4
449 ODBOPINFO
33144 ODBHPLMN1 ODBHPLMN2 ODBHPLMN3 ODBOPENT

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

467

C Number Table (cnum)


The C number table (cnum) lists numbers that calls cannot be
forwarded to when diverted, such as the emergency services numbers
(999 and 112). The C number table is a list of numbers (in ascending
order) or the start of a number that you wish to be invalid on divert.
Sections in the C number table impose different restrictions.
For diverts using SE (Special/Extended) behaviour, [CNUMSE] is
used by all subscribers.
For diverts using GSM behaviour, [CNUM0] is used by all
subscribers, and [CNUM1], [CNUM2] and [CNUM3] by those
subscribers with operator determined bars (ODBs) provisioned.
For diverts used in the support of non-standard forward-to numbers
(FTNs) for CAMEL subscribers, [CNUMCAMEL] is used. See
Forward-To Number Behaviour Modes on page 8 for a description of
how the [CNUMCAMEL] section affects call forwarding.
For diverts used in a mobile virtual private network (MVPN) that
uses a full number plan (FNP), [CNUMFNP] is used. A full number
plan means that numbers beginning 0, 1 and 9 can be used in the
private network.
Diverts with SMSB and RECALL behaviour are not checked by any
section in the CNUM table.
Diverts validated or translated by the TRIG_C service are not
checked by any section in the CNUM table.

Example

!================================================
!
CNUM Table
!================================================
!
Table Name:
CNUM
!
Platform:
GSM HLR
!
Version:
4.50
!
!
Created By:
Denise Witchalls
!
On:
27 October 2000
!
!
Updated By:
Andy Galinski
!
On:
18 April 2001
!
! This table contains all invalid c-numbers
!
!===================================================
! CNUM0 - all invalid c-numbers for subs who have ODBCNUM0
!===================================================
!
[CNUM0]
0
440
441203
441222
441232
441238
441247
441265
441266
441365
441396
441399
441426
441459
441504
441523
441574
441648
441662
441693

Home Location Register (Linux) V1.1 Support Guide

468

Chapter 24 Table Maintenance

441703
441705
44171
441762
44181
441820
441846
441849
441861
441868
441893
441960
4421
4422
4425
4426
4427
4430
4431
4432
44331
44336
44338
44345
4435
4436
4437
4438
44391
44392
44393
44394
44395
44396
44397
44398
44399
4440
44410
44411
4442
4443
4444
4445
44460
44461
444624
44463
44464
44465
44466
44467
44468
44469
4447
4448
4449
445
446
4480
4481
4482
4483
44840
44841
44842
44843
44844
44846
44847
44848
44849
4485
4486
44871
44881
4489
449
!
!===================================================
! CNUM1 - all invalid c-numbers for subs who have ODBCNUM1
! subs not allowed to set international diverts
!===================================================
!
[CNUM1]
1
2
3
40
41
42
43
45
46
47
48
49

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

469

5
6
7
8
9
!
!===================================================
! CNUM2 - all invalid c-numbers for subs who have ODBCNUM2
!===================================================
!
[CNUM2]
!
!===================================================
! CNUM3 - all invalid c-numbers for subs who have ODBCNUM3
!===================================================
!
[CNUM3]
[CNUMCAMEL]
! This section is used to validate diverts for CAMEL
999
!
!===================================================
! CNUMSE - for the ARSENIC SS provision
!===================================================
!
[CNUMSE]
0
1
333
99
!
!===================================================
! CNUMFNP -This section is used to validate Special/Extended diverts
!===================================================
!
[CNUMFNP]
999
!
!================================
! EOF CNUM.DAT
!================================

C Number Behaviour Table (cnum_bhvr)


The C number behaviour table defines different types of translation of
forward-to numbers that can be applied to individual subscribers.
If a subscriber diverts calls to a new number, and the divert is not a
special/extended divert (see Call Forwarding on page 7), the C number
behaviour table can be used to translate the new number or bar it
before the C number table (see C Number Table (cnum) on page 467)
is checked for prohibited numbers.
Each subscriber has a new attribute called CNUM_BHVR which can
take values 0 to 31. A value of 0 indicates that no conversion is
required for that subscriber. Any other value indicates that a conversion
is required, as described in the C number behaviour table.

Table Structure

Each C number behaviour (called a category value) except zero is


defined in its own section, headed [CNUM BEHAVIOUR cv] where cv is
the category value from 0 to 31.
The [CNUM BEHAVIOUR cv] section contains a list of strings of digits
which are compared with the initial digits of a forwarded-to number. If
the digits match, the forwarded-to number is either barred or translated
as follows:
xxxx

BAR

Home Location Register (Linux) V1.1 Support Guide

470

Chapter 24 Table Maintenance

forward-to numbers beginning xxxx are barred. xxxx is a number from 1


to 16 digits long.
xxxx

TRANSLATE

yyy

forward-to numbers beginning xxxx are translated by removing the first


n digits from xxxx and replacing them with yyy, where: xxxx is from 1 to
16 digits long, n is a number from 0 to 10 and yyy is a number 0 to 10
digits long.
An example C number behaviour table is shown below.
Figure 55. Example C Number Table
!================================================
!
CNUM_BHVR Table
!================================================
!
Table Name:
CNUM_BHVR
!
Platform:
GSM HLR
!
Version:
v5.0
!
!
Created By:
Tariq Aslam
!
On:
27 May 2001
!
!
Updated By:
!
On:
!
! CNUM_BHVR Table implements the new FTN Conversion Function for
! RegisterSS Functionality
!
! Example CNUM_BHVR.DAT file
!
! [CNUM BEHAVIOUR 1]
! 0 TRANSLATE 1 44
! 00 TRANSLATE 2 44
! 9 BAR
! [CNUM BEHAVIOUR 2]
! 0 TRANSLATE 1 44
! 00 TRANSLATE 2 44
!
!
! Subscribers with CNUM BEHAVIOUR category of 1 that specify a FTN
! beginning with one or two zeros will have the 0s removed and
! a prefix of 44 used instead
! In addition, subscribers may not specify an FTN beginning with 9
!
! Subscribers with CNUM BEHAVIOUR category of 2 have the same behaviour
! as those with a category of 1, with the exception that they are not
! prevented from specifying FTNs beginning with a 9
!
!=========================================================

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

471

hlr_config Table
The hlr_config table contains information about the set-up of the HLR.
Table 50 lists its contents and gives a default value for each item. If no
default value is listed, then the default for that item is zero.
Sections specific to location based services are described below the
table.
Table 50. Contents of the hlr_config table
Item

Values

Default

Description

ADD_MAX_RETRY

0 to 20

Maximum number of retries for


ADD trigger before raising an
alarm. 0 indicates the HLR will not
retransmit the trigger.

ADD_MIN_ALRM_DURATION

0 to 65535

Minimum period, in seconds, that


should elapse before another alarm
for ADD trigger delivery failure
could be raised. 65535 indicates
the HLR will never raise alarms for
ADD trigger delivery failure.

ADD_RETRY_TIMER

1 to 3600

Timeout value, in seconds, for


retransmission of ADD trigger if the
acknowledgement is not received.

ADM_FWD_NUM_RETRY

0 to 512

Number of retries to attempt if


Admin Forwarding to any node of a
platform fails. Note that the HLR will
attempt this number of retries on
each node of the platform.

ADM_FWD_TIMEOUT

1 to 65535

10

Timeout value, in seconds, for a


response from a destination system
when Admin Forwarding.

ADMIN_FORWARD

TRUE or FALSE

TRUE

Enables Admin Forwarding, that is,


forwarding of administration
commands to a destination system.

ALERT_MAX_REPEATS

0 to 65535

The maximum number of times an


alert is repeated for the SMS
service.

ALERT_REPEAT_INT

0.000 to
65535.000

The interval, in seconds, between


service centre alert repeats for the
SMS service.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

ANUM_CPC

0x00 to 0xFF

0x00

A-number Calling Party Category


value which is recognised as an
Alert and Deliver request. Used to
deliver RECALL Alert and Deliver
messages to Pre-Payment System
subscribers.
See also
PPS_ALERT_DELIVER_PFX

Home Location Register (Linux) V1.1 Support Guide

472

Chapter 24 Table Maintenance

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

BNR_GT

global title 1 to
16 digits long

(none)

Global title of entity used for on-net,


off-net USSD service.

BS30_ASSUME_VT

TRUE or FALSE

CALLBACK_CPC

0x00 to 0xFF

(none)

If the calling party category (CPC)


in a send routing information (SRI)
message is equal to
CALLBACK_CPC, the HLR
processes the SRI in a manner
specific to call setup for a USSD
callback call. If CALLBACK_CPC is
omitted, the USSD callback service
is disabled.

CAMEL_GSMSCF

global title 1 to
16 digits long

(none)

Global Title of the network entity


that contains the CAMEL service
logic. (In the Vodafone UK network,
the SEP provides CAMEL
services.)

CANCEL_RETRY_PERIOD

0.000 to
65535.000

60

Specifies the retry period in


seconds for the
NUM_OF_CANCEL operation.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

CB_NOTIFY

global_title,
global_title,...
global_title

(none)

Comma-separated list of from 0 to


10 global titles.
CAMEL Service Control Function
(gsmSCF) addresses that must be
notified if call barring data is
changed.

CF_BAR_PFX

0000 to 9999

(none)

Used by call forwarding settings for


corporate services. Prefix applied to
a roaming number in response to
an incoming SRI for a subscriber
with a divert set to a barred number.

Assume a Video Telephony call if


basic service BS30 is used.
This attribute is checked if the HLR
receives an SRI with the NSI
parameter containing a 4 octet
ISDN Bearer Capability indicating
64kbit/s UDI.
TRUE the call is treated as a
Video Telephony call and the HLR
creates the VT PLMN BC in the
resulting PRN
FALSE the call is treated as a 64k
UDI call.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

473

Table 50. Contents of the hlr_config table


Item

Values

CF_NOTIFY

global_title,
global_title,...
global_title

CFU_ENQ_PFX

0000 to 9999

(none)

Used by call forwarding settings for


corporate services. Prefix added to
the B-number in an SRI enquiry
made when invoking an
unconditional divert.

CFNRC_ENQ_PFX

0000 to 9999

(none)

Used by call forwarding settings for


corporate services. Prefix added to
the B-number in an SRI enquiry
made when invoking a CFNRc
divert.

CFNRY_TIMER

5 to 30 in
multiples of 5

15

Timeout in seconds for call


forwarding no reply (CFNRy)
diverts. For voicemail diverts, the
value in the voicemail table is used.

CIC_IF_MO_SMS

TRUE/FALSE

FALSE

Whether to check incoming call for


a PAYT mobile originated short
message (SMS).

CIC_IF_MT_CALL

TRUE/FALSE

TRUE

Whether to check incoming call for


a PAYT mobile terminated call.
Default is TRUE.

CIC_IF_MT_SMS

TRUE/FALSE

FALSE

Whether to check incoming call for


a PAYT mobile terminated short
message (SMS).

CLIR_ALLOW_SHORT_CODE

number 0 to 40
digits long

(none)

Code used with the CLIR (Calling


Line Identification Restriction)
Supplementary Service. Must not
start with a zero.
Short code to identify callers
number by default.
See Appendix E, Basic and
Supplementary Services for more
information.

CLIR_PERM_SHORT_CODE

number 0 to 40
digits long

(none)

Code used with the CLIR (Calling


Line Identification Restriction)
Supplementary Service. Must not
start with a zero.
Short code to never send callers
number. This setting cannot be
reversed by the subscriber
See Appendix E, Basic and
Supplementary Services for more
information.

Default

Description
Comma-separated list of from 0 to
10 global titles.
CAMEL Service Control Function
(gsmSCF) addresses that must be
notified if call forwarding data is
changed.

Home Location Register (Linux) V1.1 Support Guide

474

Chapter 24 Table Maintenance

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

CLIR_RESTR_SHORT_CODE

number 0 to 40
digits long

(none)

Code used with the CLIR (Calling


Line Identification Restriction)
Supplementary Service. Must not
start with a zero.
Short code to not identify callers
number by default.
See Appendix E, Basic and
Supplementary Services for more
information.

CRITICAL_SS

any
supplementary
service (see
Appendix E on
page 591)

AOCC,
OIN

List of supplementary services


supported by a VLR. If the
subscriber has a service
provisioned that is not supported by
the VLR/SGSN, the subscriber
cannot register on that VLR/SGSN.
Default is advice of charge
(charging) (AOCC) and Originating
Intelligent Network (OIN).

CSI_NOTIFY

global_title,
global_title,...
global_title

(none)

Comma-separated list of from 0 to


10 global titles.
CAMEL Service Control Function
(gsmSCF) addresses that must be
notified if CAMEL subscription
information (CSI) is changed.

CT_GT

global title 1 to
16 digits long

(none)

Global title of the network entity that


provides the call transfer service.
Call transfer is provided in the
Vodafone UK network by the
Service Execution Point (SEP).

DATA_COMPRESSION

TRUE/FALSE

FALSE

Turns V.24bis data compression for


data calls on or off.
TRUE - turns on data compression
FALSE - turns off data compression
The MSC must support data
compression, which is defined by
the COMPRESS_ENB attribute in
the [PROFILE <profile_name>]
section of the Network Entity
(netent) Table.

DEFAULT_CFB_FTN

global title 1 to
16 digits long

(none)

Global title for Default Call


Forwarding when Busy.

DEFAULT_CFNRC_FTN

global title 1 to
16 digits long

(none)

Global title for Default Call


Forwarding when Not Reachable.

DEFAULT_CFNRY_FTN

global title 1 to
16 digits long

(none)

Global title for Default Call


Forwarding when No Reply.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

475

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

DIVERT_BSG

a whitespace
separated list of
the following
items:

Bit mask for list of basic service


groups (BSGs) on which diverts can
be registered. The default of zero
means that all diverts can be
registered.

SPEECH
SMS
FAX
DCICA
DCICS
PADACC
DPACK
UNREST
AUXSPEECH
NONE
DUMMY_FTN

number 1 to 16
digits long

(none)

forward-to number used to check


that divert has been set when using
the CLIR facility.

EMLPP_DFLT_PRIORITY

0 to 6

(none)

The default call precedence value


at which an eMLPP subscriber
makes calls, if the value has not
been specified when the subscriber
was created.
The values have the following
meanings (listed from highest
eMLPP priority to lowest):
6: eMLPP priority A (for network
internal use)
5: eMLPP priority B (for network
internal use, or for subscription)
0: eMLPP priority 0 (for
subscription)
1: eMLPP priority 1 (for
subscription)
2: eMLPP priority 2 (for
subscription)
3: eMLPP priority 3 (for
subscription)
4: eMLPP priority 4 (for
subscription)

EMLPP_MAX_PRIORITY

0 to 6

(none)

The maximum call precedence


value at which an eMLPP
subscriber makes calls, if the value
has not been specified when the
subscriber was created. See
description of
EMLPP_DFLT_PRIORITY for
values.

FTN_INT_MIN_LEN

0 to 14

Minimum length for forward-to


Numbers for International format
FTNs. Must be less than
FTN_INT_MAX_LEN.

Home Location Register (Linux) V1.1 Support Guide

476

Chapter 24 Table Maintenance

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

FTN_INT_MAX_LEN

1 to 15

15

Maximum length for forward-to


Numbers for International format
FTNs. Must be greater than
FTN_INT_MIN_LEN.

FTN_SE_MIN_LEN

0 to 14

Minimum length for forward-to


Numbers for SE format FTNs. Must
be less than FTN_SE_MAX_LEN.

FTN_SE_MAX_LEN

1 to 15

15

Maximum length for forward-to


Numbers for SE format FTNs. Must
be greater than
FTN_SE_MIN_LEN.

GENERIC_USSD_GT

global title 1 to
16 digits long

(none)

Global Title of the platform that


receives generic USSD commands.

IC_ENQ_PFX

0 to 9999

(none)

Prefix (up to 4 digits) applied to


B-number in SRI enquiry made
during call processing.

LCS_CLI
ID_STRING id_string
ADDRESS address
GMLC_RES restriction
NOTIFY_USER notification

List of up to 4
location services
clients

(none)

Clients that are allowed to do


location-based requests to the
MSC.
See Configuration of Location
Based Services on page 490 for a
description of this section.

LCS_DOWNLOAD

SLPP, PAI

SLPP

Specifies whether to download the


positioning allowed indicator (PAI),
subscriber location privacy profile
(SLPP) data, or both.
See Configuration of Location
Based Services on page 490 for a
description of this section. See also
Location Based Services on
page 36.

LCS_GMLC_ID

9-digit number

(none)

A GMLC identity string. Up to 5


identity strings can be listed. Part of
the subscriber location privacy
profile (SLPP) downloaded to a
VLR. See Configuration of Location
Based Services on page 490 for a
description of this section.

LINKSUB_ATI_FWD

TRUE/FALSE

FALSE

Determines whether ATI messages


are forwarded to the SEP when
received by the published number
of a linked subscription.

LINKSUB_GT

global title 1 to
16 digits long

(none)

Global title of the platform that


receives messages as a result of
calls to a P number.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

477

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

LINKSUB_PH2

TRUE/FALSE

FALSE

Configures linked subscriptions to


allow for separate releases of the
HLR and the SEP.
TRUE - Last Caller Number (LCN)
USSD is forwarded to the SEP.
Prevents the HLR from recording
the last caller number if the SRI
does not have the Linked
Subscription tag.
FALSE - Last Caller Number (LCN)
USSD is not to be forwarded to the
SEP.
The last caller information for any
SRI that does not contain the
Linked Subscription tag is recorded.

MAX_CALL_FORWARDS

1 to 5

Maximum number of consecutive


call forward operations before divert
is ignored. Prevents infinite loops
and long chains of call forwarding.

MAX_MSISDN_USSDLEN

0 to 150

Maximum length of the string that


returns MSISDNs in response to an
OWN_MSISDN request for a basic
service group (BSG).

MAX_NUM_MSISDN

0 to 4

Maximum number of MSISDNs that


can be returned by an
OWN_MSISDN request for a basic
service group (BSG).

MAX_PDP

0 to 50

Integer from 0 to 50. Defines the


maximum number of PDP contexts
a subscriber can have. A PDP
context defines a GPRS service.

MLR_LOOKUP

1216

(none)

Short code to retrieve Voicemail.


Even if a subscriber has Unified
Messaging, this short code
retrieves Voicemail in the same way
as the 3-digit Voicemail code 121.

MLR_SRI

TRUE/FALSE

FALSE

Special SRI processing for MLR


sourced operations (TRUE/FALSE).

MNP_PFX_1
MNP_PFX_2
MNP_PFX_3

MNP_PFX_1:
447
MNP_PFX_2:
44
MNP_PFX_3:
447994

(none)

Prefixes used for number portability


translation. Used to change the
prefix of an SRI repsonse for a
subscriber who has moved their
account to Vodafone from another
network. Digits MNP_PFX_1 or
MNP_PFX_2 are removed and
replaced by MNP_PFX_3, which is
specified by the regulatory authority
for the UK Vodafone network. If the
first two digits do not match
MNP_PFX_1 or MNP_PFX_2, the
HLR returns a System Failure
message.

Home Location Register (Linux) V1.1 Support Guide

478

Chapter 24 Table Maintenance

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

NBS_ADD_PORT

Valid TCP port,


less than 65535

80

Port at which NBS would receive


the ADD triggers.

NBS_ADD_URI

valid URI

empty

Universal Resource Identifier at


NBS to transmit the ADD trigger.
Default indicates this functionality is
not used.

NBS_IP_1, NBS_IP_2

IP addresses

0.0.0.0

Two IP addresses of the NBS.


Default indicates this functionality is
not used.

NMS_SMW_TIME

1 to 60

The race time in seconds between


a valid SMW occurring soon after
an NMS.

NO_ADPCM_PFX

0 to 9999

Prefix applied to ensure that routing


between MSCs does not use
ADPCM (Adaptive Differential Pulse
Code Modulation).

NO_CIC_FOR_SMS

TRUE/FALSE

FALSE

FALSE the HLR will only send a


MobileOriginatedSMSSubmitted
(MOSS) or
MobileTerminatedSMSSubmitted
(MTSS) message to the PAM if real
time billing is enabled (by the
SMS_REALTIME_BILLING
parameter in this table) and the
PAYT extension container is
present in the SRIforSM message.
If this is not the case, the HLR will
send a CheckIncomingCall
message.
TRUE the
MobileOriginatedSMSSubmitted
(MOSS) or
MobileTerminatedSMSSubmitted
(MTSS) message will be sent to the
PAM for credit checking, regardless
of whether there is a PAYT
extension container. However, If
real time billing is not enabled (by
the SMS_REALTIME_BILLING
parameter in this table), then the
CheckIncomingCall (CIC) message
will still be sent regardless of the
NO_CIC_FOR_SMS value.
Note: NO_CIC_FOR_SMS is a
temporary parameter that will be
removed when PAMs that accept
MTSS and MOSS messages
without the information in the PAYT
extension container are rolled out.
Behaviour will then be as if
MO_CIC_FOR_SMS is TRUE.

NSI_METHOD

DERIVE/
IGNORE/PASS

IGNORE

Determines how network signalling


information (NSI) is processed.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

479

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

NSI_SPEECH_OVERRIDE

TRUE/FALSE

FALSE

If the incoming SRI contains


network signalling information
(NSI), the HLR can use this to work
out the call type. Some networks
always use the speech call type
even when sending data. If this
value is set to TRUE, then if speech
is sent the HLR ignores the NSI and
uses the MSISDN type to work out
the call type.

NSI_UIMI

UIMI_NO
UIMI_1
UIMI_2
UIMI_3
UIMI_4

UIMI_
NO

The NSI UIMI value is used to set


the UIMI (user initiated modification
indication) field in the NSI (network
signalling information) part of a
provideRoamingNumber message.
The NSI field is used to tell the VLR
what sort of call is about to be set
up including, for example, a data
rate.
In the HLRCFG table it takes the
values UIMI_NO, UIMI_1, UIMI_2,
UIMI_3, UIMI_4 indicating user
initiated modification is not allowed
or required, or user initiated
modification up to x traffic channels
is allowed or may be requested
(where x is 1, 2, 3 or 4).

NUM_OF_CANCEL

0 to 255

Number of cancel location attempts.


CANCEL_RETRY_PERIOD
specifies the retry period, in
seconds, for this operation.

ODB_NOTIFY

global_title,
global_title,...
global_title

None

Comma-separated list of from 0 to


10 global titles.
CAMEL Service Control Function
(gsmSCF) addresses that must be
notified if operator determined bar
data (ODB) is changed.

PAP_FAILURE_PFX

0 to 9999

Prefix (up to 4 digits) for the PAP


(PPS Application Part) for the
Pre-Payment System.
PAP_FAILURE_PFX is used if the
PAP transaction timer expires
before a response to a
CheckIncomingCall message is
received or another error occurs in
the dialogue.

PAP_GT

global title 1 to
16 digits long

(none)

Global Title for the PAP entity.

Home Location Register (Linux) V1.1 Support Guide

480

Chapter 24 Table Maintenance

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

PAP_NOCREDIT_PFX

0 to 9999

Prefix (up to 4 digits) for the PAP


(PPS Application Part) for the
Pre-Payment System.
PAP_NOCREDIT_PFX is used if
creditAvailable parameter in the
CheckIncomingCall Response is
false.

PAP_TRAN_TYPE

0 to 255

Specifies the translation type used


when sending PAP messages.

PAP_UNKNOWNACC_PFX

0 to 9999

Prefix (up to 4 digits) for the PAP


(PPS Application Part) for the
Pre-Payment System.
PAP_UNKNOWNACC_PFX is used
if an UnknownAccount response is
received.

PPS_ALERT_DELIVER_PFX

0 to 9999

Prefix applied to PPS Alert and


Deliver SRI response. Used to
deliver RECALL Alert and Deliver
messages to Pre-Payment System
subscribers.
See also ANUM_CPC.

PRN_VERSION

1 to 3

MAP version tried first for provide


roaming number.

RAPID_UPL

0 to 65535

15

If an update location takes less than


this number of seconds, it is
considered to be rapid. This
measurement is used for
determining cell boundaries.

RECALL_EOS_LEN

2 to 5

(none)

Number of digits in the MLR end of


selection (EOS). For example, 4.

RECALL_MEDIATOR_GT

global title 1 to
16 digits long

(none)

Global title of the network entity


used as a mediator to match a
subscriber MSISDN to an MLR. The
Service Access Point (SAP) is used
for this purpose in the Vodafone UK
network.

REG_ENQ_PFX

0 to 9999

(none)

Used by call forwarding settings for


corporate services. Prefix added to
a proposed forward-to number
(FTN) to form the B-number used in
a TRIG C SRI. The prefix indicates,
to the Group Services Platform
(GSP), the reason for the enquiry
RegisterSS in cases where
TRIG_A, TRIG_B and TRIG_C
share a GSP.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

481

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

RETURN_FWD_VIOLATION

TRUE/FALSE

FALSE

Defines how to respond if a call has


been forwarded the maximum
number of times, defined by the
MAX_CALL_FORWARDS
parameter.
TRUE - return a call forwarding
violation response
FALSE - route the call to the final
forward-to number when the
maximum number of forwards was
reached. This can be used to alert
subscribers despite them having
calls forwarded to their mailbox.

ROAMING_NOT_ALLOWED

TRUE/FALSE

FALSE

Controls the response to an


UpdateLocation message from a
network that the subscriber is not
allowed to roam to.
ROAMING_NOT_ALLOWED can
be overridden by the
ROAM_UNKSUB attribute (see
page 517) in the Network Entity
(netent) Table.
TRUE RoamingNotAllowed
(PLMNNotAllowed) response
returned
MAP specifies that
RoamingNotAllowed should be
returned. This response puts the
subscribers SIM in the forbidden
list for the PLMN, which locks the
SIM out of that network and forces
network reselection.
If a country contains a CAMEL
supporting network and a USSD
only network for PrePay roaming,
then the CAMEL network is
preferred. TRUE makes sure that
RoamingNotAllowed is returned so
that the subscriber has to reselect a
network that supports CAMEL.
FALSE UnknownSubscriber
response returned
The SIM is not put in the forbidden
list for the PLMN, and is not locked
out of the network. The SIM is not
forced to reselect a network.

Home Location Register (Linux) V1.1 Support Guide

482

Chapter 24 Table Maintenance

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

ROAMING_RELAY_GT

global title 1 to
16 digits long

(none)

Global title of the SMS roaming


relay. The HLR supplies this as the
global title to which messages for all
roamed subscribers should be
forwarded, where the originating
SMSC is not from the home
network.

SDM_CANCEL_SGSN

ALL, ROAMED,
NONE

ALL

Indicates whether a cancel location


is to take place for SGSN locations
for each subscriber. If the value is
ALL, then a cancel location
command is sent for SGSN
locations for all subscribers. If the
value is ROAMED, then a cancel
location command is sent for SGSN
locations where the subscriber is
roamed. If the value is NONE, then
a cancel location command is not
sent for any SGSN locations.

SDM_CANCEL_VLR

ALL, ROAMED,
NONE

ALL

Indicates whether a cancel location


is to take place for VLR locations for
each subscriber. If the value is ALL,
then a cancel location command is
sent for VLR locations for all
subscribers. If the value is
ROAMED, then a cancel location
command is sent for VLR locations
where the subscriber is roamed. If
the value is NONE, then a cancel
location command is not sent for
any VLR locations.

SDM_HLR_PORT

Integer

The source HLR will communicate


with the destination HLR by means
of a number of TCP/IP connections.
A connection will be needed for
each SDM replication. However
only one port number is required for
handling this. The
SDM_HLR_PORT value indicates
the port number.

SDM_HLR_TRANS_TIME

Integer
(milliseconds)

The minimum time between


commands being transferred to
HLR by a single SDM replication.
When set to zero, there will be no
regulation of the rate at which
commands are transferred.The
value must be greater than or equal
to zero. Unlike other configuration
values, this will be able to be
changed during an existing SDM.

SDM_HLR_UPD_TIME

Integer
(seconds)

60

Indicates the period in which a


response from destination HLR will
be awaited.The value must be
greater than zero.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

483

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

SDM_PROC_SRN

TRUE/FALSE

TRUE

Indicates whether SRNs are to be


moved when carrying out a Soft
SDM.

SDM_RELAY_PORT

Integer

The source HLR will communicate


with relays by means of a number
of TCP/IP connections. A
connection will be needed for each
SDM replication to each master
relay. These will have client type
SDM_UPD_RLY. The
SDM_RLY_PORT value indicates
the port number for
SDM_UPD_RLY connections.

SDM_RELAY_UPD_TIME

Integer
(seconds)

60

Indicates the period in which


responses from relays will be
awaited. The value must be greater
than zero.

SDM_REPS

Integer

10

Indicates the number of SDM


replications that will be used in a
single Soft SDM procedure for
transferring data from the source to
destination HLR.

SDM_STOP

TRUE or FALSE

FALSE

Indicates that Soft SDMs are not


permitted from this HLR. If the value
is set to TRUE while a Soft SDM is
in progress, it is aborted.

SDM_UPD_ALL_MASTERS

TRUE or FALSE

TRUE

Indicates whether both Master


Relays are updated during SDM, or
only one.

SE_FTN_PFX

number 1 to 20
digits long

(none)

Prefix used for Special/Extended


Divert Number. Consists of a
configurable prefix and the Nature
of Address Indicator.

SGSN_ALG_LIST

(val)(-val)(-val)
...(val)
where val is
geA0 to geA7

(none)

Encryption algorithm list for an


SGSN, listed in order of priority. Up
to 8 algorithms can be specified.
The algorithm list is downloaded to
visited networks only. If the SGSN
where the subscriber is registered
does not support preferred
algorithm lists, the HLR can
download Roaming Restricted In
SGSN Due To Unsupported
Feature and prevent the subscriber
from registering.
The UNSUPP_ENCRYPT_
BEHAVIOUR entry, also in the
hlr_config Table, determines
whether a subscriber is allowed to
register.

Home Location Register (Linux) V1.1 Support Guide

484

Chapter 24 Table Maintenance

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

SGSN_DIS_ENC

NO_
ENCRYPTION

(none)

Indicates to the SGSN that


encryption is disabled.

SINGLE_GT_CALLING

TRUE or FALSE

TRUE

If TRUE, the HLR will send the


single HLR global title as its global
title in all messages it sends out. If
FALSE, the HLR will send its
physical global title.

SINGLE_GT_HLR_NUMBER

TRUE or FALSE

TRUE

If TRUE, the HLR will return the


single global title in update location,
update location for GPRS and
restore data responses. If FALSE,
the HLR will return its own single
global title in update location,
update location for GPRS and
restore data responses.

SMS_REALTIME_BILLING

TRUE or FALSE

FALSE

Indicates whether old or new PAP


messages are used in SMS
processing, and therefore whether
SMS real time billing is active.

SMSB_OPERATOR_NUM

number 1 to 16
digits long.

(none)

Used with the SMS Bureau Service.


Divert number displayed on
handset. See also Appendix H,
USSD Information on page 627.

SMSB_PREFIX

0 to 9999

(none)

Used with the SMS Bureau Service.


Prefix for MSISDN so that the MSC
diverts calls to the SMSB. See also
Appendix H, USSD Information on
page 627.

SMSB_SHORT_CODE

number 1 to 40
digits long.

(none)

Used with the SMS Bureau Service.


Short code to set divert to SMSB.
Value must not start with a zero.
See also Appendix H, USSD
Information on page 627.

SMSDD_PAP_SUPP

TRUE or FALSE

FALSE

Specifies whether the PAM


supports the SMS Direct Delivery
Reserve/Confirm/ Release PAP
messages.
If the value is TRUE and the SDN
uses the extension container in the
SRISM, a reserve message is sent
to the PAM.

SMSDD_RES_ID

Hex number, 0 to
FFFFFFFFFFFF
FFFFFFFFFFFF

SN_QUINTUPLETS

1 or 2

Default reservation ID used by the


SMS Direct Delivery service if the
PAM does not support the SMS
Direct Delivery Reserve/Confirm/
Release PAP messages.
1

Home Location Register (Linux) V1.1 Support Guide

The number of UMTS


authentication quintuplets that fit in
the response to a
sendAuthenticationInformation
message.

Chapter 24 Table Maintenance

485

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

SQN_DEC

1 to 500,000

500

UMTS authentication quintuplets


are numbered with a sequence
number to ensure that they are not
reused. SQN_DEC is a decrement
to the sequence number applied for
testing only.

SQN_INC_LARGE

1 to 500,000

10,000

Used for UMTS subscriber


authentication. UMTS
authentication quintuplets are
numbered with a sequence number
to ensure that they are not reused.
SQN_INC_LARGE is a large
increment to the sequence number
which is applied, for example, after
recovery of an HLR database.

SQN_INC_SMALL

1 to 2000

500

Used for UMTS subscriber


authentication. UMTS
authentication quintuplets are
numbered with a sequence number
to ensure that they are not reused.
SQN_SMALL is a small increment
to the sequence number which is
applied, for example, after
subscriber data is moved to a
different HLR.

SQN_RESET

500,000 to
243-1

242-1

Used for UMTS subscriber


authentication. UMTS
authentication quintuplets are
numbered with a sequence number
to ensure that they are not reused.
SQN_RESET is a value to set the
sequence number to (or if already
at that value then 243-1). Used only
during catastrophic
resynchronisation conditions to
switch off authentication sequence
checking.

SRI_RESTORATION

TRUE/FALSE

FALSE

This flag controls a number of failed


registration types and determines
whether, even though a registration
failed, a VLR returns a roaming
number, restores data to the HLR
and pages a subscriber.

SSOP_RESULT

TRUE/FALSE

TRUE

Extended response to SS
operations other than Register SS.

SUSPECT_DELAY

0.000 to 5.000

The delay in seconds before an SRI


is considered to be suspect.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

SUSPECT_TRIES

0 to 10

Number of delay attempts per SRI.

Home Location Register (Linux) V1.1 Support Guide

486

Chapter 24 Table Maintenance

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

TIMEOUT_ASC

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction alert service
centre.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_BSA_OUT

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction begin
subscriber activity.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_CIC

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction check incoming
call.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_CNL

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction cancel location.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_DSD

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction delete
subscriber data.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_FSM

1.000 to 60.000

15

Timeout field used for the HLR


capability to send short messages.
Defines the timeout, in seconds, for
receiving a result from the
ForwardShortMessage MAP
message.

TIMEOUT_GET

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction get password.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_ISD

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction insert
subscriber data.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

487

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

TIMEOUT_MOSS

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction mobile
originated short message
submitted.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_MTSD

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction mobile
terminated short message
delivered.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_MTSS

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction mobile
terminated short message
submitted.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_PRN

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction provide
roaming number.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_PSI

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction provide
subscriber information.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_SAI

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction send
authentication information.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

TIMEOUT_SRI_OUT

1.000 to 60.000

15

Timeout, in seconds, for HLR


initiated transaction send routing
information.
Time can be specified to 3 decimal
places, which allows timing to the
nearest millisecond.

Home Location Register (Linux) V1.1 Support Guide

488

Chapter 24 Table Maintenance

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

TIME_ZONE

-47 to 48

Time difference from GMT as a


number of quarter hours.
TIME_ZONE is used to generate a
time stamp for a class 0 SMS, such
as the response sent when
controlling access to certain content
types (see Control of Access to
Premium Rate/Content on
page 61).

TRIG_A_CALL_BAR_PFX

Used by the triggers that divert calls


to corporate services. Call-barred
prefix checked for in a roaming
number in response to SRI
enquiries triggered by TRIG_A.

TRIG_A_FAIL_BEHAVIOUR

FAIL/ALLOW

FAIL

Used by the triggers that divert calls


to corporate services. Action taken
when there is a failure during a
TRIG_A initiated enquiry.

TRIG_A_GT

number 1 to 16
digits long

(none)

Used by the triggers that divert calls


to corporate services. Specifies the
global title of the entity to which SRI
enquiries triggered by the TRIG_A
supplementary service are initiated.

TRIG_B_CALL_BAR_PFX

0 to 9999

Used by the triggers that divert calls


to corporate services. Call-barred
prefix checked for in a roaming
number in response to SRI
enquiries triggered by TRIG_B or
SE divert behaviour.

TRIG_B_GT

global title 1 to
16 digits long

(none)

Used by the triggers that divert calls


to corporate services. Specifies the
global title of the entity to which SRI
enquiries triggered by the TRIG_B
supplementary service or SE divert
behaviour are initiated.

TRIG_C_CALL_BAR_PFX

0 to 9999

Used by the triggers that divert calls


to corporate services. Leading
digits of a roaming number used to
indicate that forward-to number
(FTN) is not allowed.

TRIG_C_GT

global title 1 to
16 digits long

(none)

Used by the triggers that divert calls


to corporate services. Global title of
the network entity that provides
TRIG C interworking. The Group
Services Platform (GSP) provides
this interworking in the Vodafone
UK network.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

489

Table 50. Contents of the hlr_config table


Item

Values

Default

Description

UMTS_ALG_LIST

(val)(-val)(-val)
...(val)
where val is
ueA0 to ueA15

(none)

Encryption algorithm list for a VLR/


SGSN, listed in order of priority. Up
to 16 algorithms can be specified.
The algorithm list is downloaded to
visited networks only. If the SGSN
or VLR where the subscriber is
registered does not support
preferred algorithm lists, the HLR
can download Roaming Restricted
Due To Unsupported Feature or
Roaming Restricted In SGSN Due
To Unsupported Feature and
prevent the subscriber from
registering.
The UNSUPP_ENCRYPT_
BEHAVIOUR entry, also in the
hlr_config Table, determines
whether a subscriber is allowed to
register.

UMTS_ALGORITHM

1 or 2

Indicates the algorithm used for


UMTS authentication. The
algorithm should not be set to 2
without prior authorisation.

UMTS_DIS_ENC

TRUE or FALSE

(none)

Indicates to the VLR/SGSN that


encryption is disabled.

UNSUPP_ENCRYPT_
BEHAVIOUR

ALLOW or
DENY

DENY

Determines whether a subscriber is


allowed to register on a VLR or
SGSN that does not support
preferred algorithm lists.

VLR_ALG_LIST

(val)(-val)(-val)
...(val)
where val is
gsmA50 to
gsmA57

(none)

Encryption algorithm list for a VLR,


listed in order of priority. Up to 8
algorithms can be specified.
The algorithm list is downloaded to
visited networks only. If the SGSN
or VLR where the subscriber is
registered does not support
preferred algorithm lists, the HLR
can download Roaming Restricted
Due To Unsupported Feature or
Roaming Restricted In SGSN Due
To Unsupported Feature and
prevent the subscriber from
registering.
The UNSUPP_ENCRYPT_
BEHAVIOUR entry, also in the
hlr_config Table, determines
whether a subscriber is allowed to
register.

VLR_DIS_ENC

TRUE or FALSE

(none)

Indicates to the VLR that encryption


is disabled.

VLR_TRIPLETS

0 to 5

Number of authentication triplets


sent to the VLR in each response.

Home Location Register (Linux) V1.1 Support Guide

490

Chapter 24 Table Maintenance

Configuration of Location Based Services


SLPP Data

Location based services for a subscriber are configured by a


Subscriber Location Privacy Profile (SLPP), which is downloaded to the
VLR where the subscriber registers.

LCS_
DOWNLOAD

For each VLR, the LCS_DOWNLOAD attribute in the Network Entity


(netent) Table (see page 509) determines whether the HLR downloads
the positioning allowed indicator (PAI) flag or subscriber location
privacy profile (SLPP) data, or both.
The LCS_DOWNLOAD entry in the hlr_config Table specifies
behaviour for entities that do not have an LCS_DOWNLOAD attribute
in the NETENT table. The HLR uses the same profile for all
subscribers, and this is defined in the [LCS_CLI] and [LCS_GMLC_ID]
sections of the hlr_config table.

LCS_CLI Heading
Parameters below the LCS_CLI heading specify from 0 to 4 clients that
are allowed to send an SRIforLCS message to the HLR. The format of
this section is:
LCS_CLI
ID_STRING id_string
ADDRESS address
GMLC_RES restriction
NOTIFY_USER notification
All the parameters are mandatory. They are described below:
Parameter

Values

Description

ID_STRING

A text string of 1- 20
characters

The LCS_CLI identifier.

ADDRESS

Global title of the


entity

Global title of a client allowed to send SRIforLCS messages to


the HLR.
Clients are Gateway Mobile Location Centres (GMLCs) that
forward-on location requests from Location Enabling Servers
(LESs).

GMLC_RES

ANY, LISTED,
HPLMN

Restriction on GMLCs allowed to send SRIforLCS messages


to the HLR.
ANY all GMLCs.
LISTED GMLCs listed in the LCS_GMLC section described
below.
HPLMN GMLCs in home network

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

491

Parameter

Values

Description

NOTIFY_USER

ALLOW_WITH,
ALLOW_WITHOUT,
ALLOW_GRANTED,
ALLOW_NORESP

The following are sent in the SLPP to the VLR:


ALLOW_WITH notifyLocationAllowed
ALLOW_WITHOUT optional value omitted
ALLOW_GRANTED
notifyAndVerify-LocationNotAllowedIfNoResponse
ALLOW_NORESP
notifyAndVerify-LocationAllowedIfNoResponse

LCS_GMLC_ID Entries
The LCS_GMLC_ID entries list from 0 to 5 GMLC addresses, which
can be used to limit the GMLCs that are allowed to request location
information from the MSC. These GMLC addresses are downloaded to
a VLR as part of the subscriber location privacy profile (SLPP).
The format of this section is:
LCS_GMLC_ID
GMLC_address
Parameter

Values

Default

Description

LCS_GMLC_ID

Valid global title

None

Specifies a GMLC that is allowed to request


information from the MSC.

Example

Example

LCS_DOWNLOAD
PAI SLPP
!
LCS_GMLC_ID
111111111
LCS_GMLC_ID
222222222
LCS_GMLC_ID
333333333
LCS_GMLC_ID
444444444
LCS_GMLC_ID
555555555
!
LCS_CLI
ID_STRING 1
ADDRESS
GMLC_RES
NOTIFY_USER
!
LCS_CLI
ID_STRING 2
ADDRESS
GMLC_RES
NOTIFY_USER
!
LCS_CLI
ID_STRING 3
ADDRESS
GMLC_RES
NOTIFY_USER
!
LCS_CLI
ID_STRING 4
ADDRESS
GMLC_RES
NOTIFY_USER

91111111
ANY
ALLOW_WITH

922222222
LISTED
ALLOW_WITHOUT

933333333
HPLMN
ALLOW_GRANTED

944444444
ANY
ALLOW_NORESP

! Short Message Service codes


SMSB_SHORT_CODE
122
SMSB_PREFIX
001
! COUNTRY SPECIFIC
SMSB_OPERATOR_NUM

Home Location Register (Linux) V1.1 Support Guide

492

Chapter 24 Table Maintenance

447836000000
!
NUM_OF_CANCEL
1
CANCEL_RETRY_PERIOD
15
NO_ADPCM_PFX
000
!
! CLIR set by CFU short codes
CLIR_ALLOW_SHORT_CODE
1472
CLIR_RESTR_SHORT_CODE
1473
! Standard interrogate status of CLIR is set in VLR
! but noted here for completeness
! *#31#
DUMMY_FTN
0000
! PAP values
PAP_NOCREDIT_PFX
002
PAP_UNKNOWNACC_PFX
002
PAP_FAILURE_PFX
002
PAP_TRAN_TYPE
254
! Country specific PAP global title
PAP_GT
44385019300
! **************************
ALERT_MAX_REPEATS
2
ALERT_REPEAT_INT
1
ALERT_FAIL_ACTION
KEEP
TIMEOUT_ASC
1
TIMEOUT_MOSS
15
TIMEOUT_MTSS
15
TIMEOUT_MTSD
15
TIMEOUT_CNL
15
TIMEOUT_DSD
15
TIMEOUT_ISD
15
SQN_INC_SMALL
500
SQN_INC_LARGE
100000
SQN_DEC
500
SQN_RESET
4398046511103
SN_QUINTUPLETS
2
TIMEOUT_SAI
15
UMTS_ALGORITHM
1
TIMEOUT_PRN
10
TIMEOUT_GET
15
TIMEOUT_CIC
7
TIMEOUT_SRI_OUT
15
TIMEOUT_BSA_OUT
15
! **************************
CFNRY_TIMER
15
VLR_TRIPLETS
4
! **************************
NSI_SPEECH_OVERRIDE
FALSE
NSI_METHOD
IGNORE
NSI_UIMI
UIMI_NO
! **************************
!
CRITICAL_SS
AOCC OIN
FTN_INT_MIN_LEN
3
FTN_INT_MAX_LEN
15
FTN_SE_MIN_LEN

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

493

3
FTN_SE_MAX_LEN
15
RETURN_FWD_VIOLATION
FALSE
NMS_SMW_TIME
5
!SKE_OPERATIONAL_STATUS
!TRUE
MLR_SRI
TRUE
SSOP_RESULT
TRUE
!
! THE FOLLOWING ARE DUMMY VALUES THE REAL ONES ARE TO BE DECIDED
ANUM_CPC
F0
PPS_ALERT_DELIVER_PFX
109
!
!MNP PREFIX SETTINGS
MNP_PFX_1
447
MNP_PFX_2
44
MNP_PFX_3
447994
! LINKSUB TOKENS
LINKSUB_GT
44385016333
SE_FTN_PFX
+/0
!PARAMETERS USED TO TRY AND REDUCE SUSPECT_VLR COUNT
SUSPECT_TRIES
4
SUSPECT_DELAY
1
!
! MO SMS credit checking
!
CIC_IF_MO_SMS
TRUE
CIC_IF_MT_SMS
TRUE
GENERIC_USSD_GT
44385016333
RAPID_UPL
15
RECALL_MEDIATOR_GT
RECALL_SHORT_CODE_1
121
RECALL_SHORT_CODE_2
1571
CT_GT
44385016333
! TRIG_C_GT
!
! TRIG_C_CALL_BAR_PFX
!
! REG_ENQ_PFX
!
MAX_PDP
50
PRN_VERSION
1
CAMEL_GSMSCF
44385016450
LINKSUB_PH2
FALSE
RECALL_EOS_LEN
4
MAX_NUM_MSISDN
4
MAX_MSISDN_USSDLEN
150
CALLBACK_CPC
EF
SMS_REALTIME_BILLING
TRUE

pds_defs Table
This table defines the logical and physical HLRs in the network.

Table format

[HLR_MAPPING]
<Physical_HLR_Name> <Logical_HLR_Name> <State>

Home Location Register (Linux) V1.1 Support Guide

494

Chapter 24 Table Maintenance

[SCCPR_MAPPING]
<Physical_SCCPR_Name> <Logical_SCCPR_Name> <State>
[EIR_MAPPING]
<Physical_EIR_Name> <Logical_EIR_Name> <State>
[LOGICAL_HLR]
<Logical_HLR_Name> <Logical_HLR_GT>
[PHYSICAL_HLR <single_HLR_Global_Title>]
<Physical_HLR_Name> <Own_GT> <HLR_index>
<Node_1_IP_Address> <Node_2_IP_Address>

MAPPING
sections

The [HLR_MAPPING], {SCCPR_MAPPING] and [EIR_MAPPING]


sections provide the mapping between the Physical HLR/SCCPR/EIR
and the Logical HLR/SCCPR/EIR (that is, the logical databases), as
well as the state of each Logical HLR/SCCPR/EIR.
The state can be ACTIVE or SLAVE.
HLRs can support multiple ACTIVE logical databases; all other
platforms can support only one ACTIVE logical database. All platforms
can support multiple SLAVE logical databases (assuming there is
sufficient contiguous disk space available). Note that the Physical HLR
Name must be in capital letters..
The maximum number of mappings (for all types) is 300.
Except for HLRs, the Logical_platform_Name must be of the form
L<platform_name>, for example LSCCRT1 on SCCRT1.

[LOGICAL_
This section defines the GT for each logical platform. The GT on all
platform] section platforms except for the HLR should be the same as the OWN_GT
defined in the pds_config table.

[PHYSICAL_
HLR] section

This section defines the GT, unique HLR index and the IP addresses of
the two BEPs.The GT must match the OWN_GT value specified in the
pds_config table. The unique HLR index must be between 1 and 63.
Note that the Physical HLR Name must be in capital letters.

Example

[HLR_MAPPING]
DHLRV LHDB11 ACTIVE
DHLRZ LHDB12 ACTIVE
DHLRZ LHDB11 SLAVE
[SCCPR_MAPPING]
[EIR_MAPPING]
[LOGICAL_HLR]
LHDB11 447785011807
LHDB12 447785011808

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

495

[PHYSICAL_HLR 44487999999]
DHLRV 44385016411 26 10.9.8.7 10.9.8.8
DHLRZ 44385016412 27 10.0.1.1 10.0.1.2

Admin
Forwarding for
Soft SDM

The [PHYSICAL_HLR] section specifies the IP addresses of the live


and standby BEP nodes.
If Admin Forwarding has previously been used successfully then
commands will be forwarded to the IP address last used. Otherwise,
Admin Forwarding will attempt to forward commands to the first IP
address specified.
If a non-command-specific error (for example, a TCP error) is returned,
then the alternative IP address will be used instead (after any retries,
see hlr_config table). If the second IP address also fails (after any
retries), an error is returned to the originator.

hlr_node Table
The configuration file hlr_node.dat is used in soft SDM. It is stored in
the $sdmdir directory and contains the names, global titles and both IP
addresses for all HLRs.
The format is:

[HLR]

<HLR name A>

<GT A>

<IP Addr 1 A> <IP Addr 2 A>

<HLR name B>

<GT B>

<IP Addr 1 B> <IP Addr 2 B>

<HLR name C>

<GT C>

<IP Addr 1 C> <IP Addr 2 C>

<GT n>

<IP Addr 1 n> <IP Addr 2 n>

.
.

<HLR name n>

The maximum number of HLRs is 100. HLR names must not be


duplicated. GT will have at most 15 digits. IP address will be IPV4. A
line can be commented out by inserting the ! character at the start of
the line.

hsscfg Table
The start of the hsscfg table contains the two logmasks to control the
amount of logging for the HSSP process, and the SIGTRAN
component of S7MP. This is followed by the definition of the local PC
and the local SSN:
[HSSP_LOG_MASK 0x01A00630]
[S7MP_LOG_MASK 0x0006E1AA]

Home Location Register (Linux) V1.1 Support Guide

496

Chapter 24 Table Maintenance

[LOCAL_PC local_pc]
LOCAL_SSN local_ssn
When setting up communication to a remote Ericsson MSC (one IP
address per ASP, and two ASPs per AS), use the following:
[LOCAL_ASP nodename]
PORT port
local_ip_red
local_ip_blue
...
!Remote MSCs PC and SSN
[REMOTE_PC remote_pc]
REMOTE_SSN remote_ssn
!Remote MSC AS and ASP config
!One AS, Two ASPs, one IP address per ASP
[AS remote_pc]
TXRC routing_context MODE LOADSHARE/OVERRIDE
MIN_ACT_ASP 1
ASP port RXRC routing_context SERVER/CLIENT
in_str out_str SE/DE LCL_IP_ADDR 1
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS remote_ip_red
ASP port RXRC routing _ontext SERVER/CLIENT
in_str out_str SE/DE LCL_IP_ADDR 2
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS remote_ip_blue LCL_IP_ADDR 2
Note that LCL_IP_ADDR 1 (referring to local_ip_red) is specified
for the MSCs red address, and LCL_IP_ADDR 2 (referring to
local_ip_blue) is specified for the MSCs blue address. This
ensures that when the HLR connects to the MSCs red addressed ASP,
it uses the local red address, and when it connects to the MSCs blue
addressed ASP, it uses the local blue address.
Where there are multiple IP addresses per ASP (that is, a multi-homed
end-point), ensure that the LCL_IP_ADDR values are all the same
within that ASP, for example:
...

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

497

[LOCAL_ASP nodename]
PORT port
local_ip_red
local_ip_blue
!Remote MSC PC and SSN
[REMOTE_PC remote_pc]
REMOTE_SSN remote_ssn
!Remote MSC AS and ASP config
!One AS, one ASP, two IP addresses
[AS remote_pc]
TXRC routing_context MODE LOADSHARE MIN_ACT_ASP 1
ASP port RXRC routing_context SERVER/CLIENT
in_str out_str SE/DE LCL_IP_ADDR 1
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS remote_ip_red
ADDRESS remote_ip_blue
This simply ensures that when the HLR connects to the remote entity,
the local_ip_red address will be used to send the INIT message to
the remote entity, and the remote entity address to be targeted will be
the first one in the ASP list, that is, remote_ip_red. This behaviour is
the standard Flextronics stack behaviour as if LCL_IP_ADDR were not
specified.
Signalling gateways are defined as follows:
[SG_REMOTE_PC remote_sg_pc]
REMOTE_SSN remote_sg_ssn
SG 1 PRIO 1
SG 2 PRIO 1

[SG 1]
MODE LOADSHARE PRIMARY_SGP 1
SGP 1 port RXRC routing_context SERVER/CLIENT
in_str out_str LCL_IP_ADDR 1
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS remote_ip_red

Home Location Register (Linux) V1.1 Support Guide

498

Chapter 24 Table Maintenance

ADDRESS remote_ip_blue

[SG 2]
MODE LOADSHARE PRIMARY_SGP 1
SGP 1 port RXRC routing_context SERVER/CLIENT
in_str out_str LCL_IP_ADDR 1
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS remote_ip_red
ADDRESS remote_ip_blue
The point codes to be reachable via a signalling gateway are defined
as SG_REMOTE_PC, along with the SSNs applicable. The signalling
gateway(s) to reach this point are then defined, using the signalling
gateway identity (1 or 2 in this example), followed by a priority. The
gateways can be configured to be loadsharing (both priority 1) or
primary/secondary, where one SG would be given the priority value of
2.
The SGs themselves are set up in a similar way to the IPSP mode, with
port, unique routing context, and in/out streams.
Table Entry

Description

local_pc

Point code of local node.

local_ssn

Subsystem number of local node.


SSNs can be defined as a list for each remote PC definition. The names used for the
REMOTE_PC and SSN LIST must match one another, for example:
[SSN_LIST MSC]
6 7 8
[REMOTE_PC 104]
REMOTE_SSN MSC

remote_pc

Point code of remote node.

remote_ssn

Subsystem number for remote node.

nodename

Alpha-numeric character string; if it matches the local nodename, the ASP is created.

remote_sg_pc

Point code of platform reachable via SG. Contains a list of SSNs configured on that
PC, and a list of SGs through which the PC is reachable. Each SG has an associated
priority (the greater the value, the higher the priority).

port

Defines the port used.

routing_context

Defines the routing context for that particular association. The routing context must
be unique for each association on the HLR.

in_str, out_str

Define the number of input and output streams.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

499

Table Entry

Description

SERVER/CLIENT

If the remote end is defined as a CLIENT, local ASP acts as a server when setting up
an SCTP association to the remote SGP/ASP. If it is defined as a SERVER, the local
ASP acts as a client.

LOADSHARE/
OVERRIDE

When more than one ASP/SGP is defined they can be configured to work in parallel
(LOADSHARE), or primary/secondary (OVERRIDE).

SE/DE

Exchange mode. SE is Single Exchange; DE is Double Exchange. Ensure the


remote end is capable of handling the mode set on the HLR.

SEND_RC

(Optional) 0 means that PDS will not send Routing Context (RC) for this particular
remote ASP/SGP. 1 means that PDS will send RC to the remote ASP/SGP.

SEND_AS_MODE

(Optional) 0 means that PDS will not send AS traffic mode (TM) for this particular
remote ASP/SGP. 1 means that PDS will send TM to the remote ASP/SGP.

SEND_NA

(Optional) 0 means that PDS will not send Network Appearance (NA) for this
particular remote ASP/SGP. 1 means that PDS will send NA to the remote ASP/SGP.

If optional parameters are sent, then the remote end must have the
same optional parameters set.
Note: For the HLR to receive traffic, the remote PC of the transmitting
entity must be listed in the hsscfg file, either as part of a remote ASP/
SGP definition, or as a REMOTE_PC, or SG_REMOTE_PC.

Example hsscfg
file

[HSSP_LOG_MASK 0x00000000]
[S7MP_LOG_MASK 0x00000000]

[REMOTE_PC 1602]
REMOTE_SSN 149

[REMOTE_PC 2418]
REMOTE_SSN 6

[LOCAL_PC 449]
LOCAL_SSN 6

[SSN_LIST MSC]
8

[SSN_LIST HLR]
6

Home Location Register (Linux) V1.1 Support Guide

500

Chapter 24 Table Maintenance

[SSN_LIST RELAY]
6 7 8

[SSN_LIST MLR]
249

[LOCAL_ASP HLR1]
PORT 2905
10.222.192.66
10.222.200.66

[LOCAL_ASP HLR2]
PORT 2905
10.222.192.67
10.222.200.67

! Receive traffic from PC 3006


[REMOTE_PC 3006]
REMOTE_SSN MSC

! Point code 1775 accessible via SG2 and SG 4


[SG_REMOTE_PC 1775]
REMOTE_SSN 6 7 8
SG 2 PRIO 1
SG 4 PRIO 1

[REMOTE_PC 14101]
REMOTE_SSN 6 7 8

!MSC1

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

501

[AS 14101]
TXRC 2 MODE LOADSHARE MIN_ACT_ASP 1
ASP 2905 RXRC 2 SERVER 17 17 SE LCL_IP_ADDR 1
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS 10.222.192.94
ASP 2905 RXRC 2 SERVER 17 17 SE LCL_IP_ADDR 2
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS 10.222.200.94

!MSC2
[AS 3006]
TXRC 3 MODE LOADSHARE MIN_ACT_ASP 1
ASP 2905 RXRC 3 SERVER 17 17 SE LCL_IP_ADDR 1
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS 10.222.192.75
ADDRESS 10.222.200.75
ASP 2905 RXRC 3 SERVER 17 17 SE LCL_IP_ADDR 1
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS 10.222.192.76
ADDRESS 10.222.200.76

!SG-A
[SG 2]
MODE LOADSHARE PRIMARY_SGP 1
SGP 1 6000 RXRC 1000 SERVER 17 17 LCL_IP_ADDR 1
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS 10.222.192.123
ADDRESS 10.222.200.123

!SG-C
[SG 4]

Home Location Register (Linux) V1.1 Support Guide

502

Chapter 24 Table Maintenance

MODE LOADSHARE PRIMARY_SGP 1


SGP 1 6000 RXRC 1001 SERVER 17 17 LCL_IP_ADDR 1
SEND_RC 0 SEND_AS_MODE 0 SEND_NA 0
ADDRESS 10.222.192.61
ADDRESS 10.222.200.61

SIGTRAN Event Configuration Table (pds_sigtran_event)


Event enabling allows the requesting process to see any SIGTRAN
events as they occur.
The Event Configuration File (ECF), pds_sigtran_event, lists
events that are enabled for the pds_i_s7mp process. If an event is
reported, the s7mp process will either log it, raise an alarm, or if the
event is serious enough to be defined as FATAL in
pds_sigtran_event, will suicide the application on the node where
the serious event was raised. The Event Configuration File is in
directory /opt/vodafone/pds/etc.
Note: An SS7 ECF (pds_ss7_cfg) must also exist to enable events.
This can be a dummy file; that is, although it must contain valid data, it
is not used, and can be minimal.
Note: Events enabled using the interactive S7MP utility do not affect
the PDSnnnn_S7MP process.
See Chapter 7, Alarms for details of the alarms raised by IN7 events.

Event
Configuration
File Format

The format of the ECF is:

Event
Configuration
File Contents

Table 51 describes the information in the event configuration file.

ENTITY <entity_type> <default_severity>


<event_name> <severity>
...
...

Table 51. Event Configuration File Contents


Item

Values

entity_type

Home Location Register (Linux) V1.1 Support Guide

Meaning/Action
SIGTRAN entity name.

Chapter 24 Table Maintenance

503

Table 51. Event Configuration File Contents


Item

Values

Meaning/Action

Default severity/
severity

OFF

Event not enabled. If the


default severity is OFF,
then events in the list for
the entity type have to be
set to one of the other
values in order to be
enabled.

INFO

Log it.

MINOR

Raise an A3 alarm.

MAJOR

Raise an A1 alarm.

FATAL

Restart PDS.

Event
Configuration
Definitions
Example

Changing the
Event
Configuration
File

LCL_AS_STATE_IND
REM_AS_STATE_IND
LCL_ASP_STATE_IND
REM_ASP_STATE_IND
CONN_STATE_IND
M3UA_ERROR_IND
SCCP_STATUS_IND
SS_EVNT_RPT_ON
ENABLE_STATS ON

MINOR
MINOR
MAJOR
MAJOR
MAJOR
MAJOR
MAJOR SP_EVNT_RPT_ON

The Event Configuration file is changed only rarely, when.


The level of alarms generated by the platform needs to be changed.
The format is changed by a new version of software.

io_convert Table
The io_convert table specifies E.164 number conversion to cope with
changes in the convention for issuing published numbers for mobile
handsets. The table contains two data sections:
[INBOUND] - for conversion to the internal database format
[OUTBOUND] - for conversion from the internal database format

Example

!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!

File generated from the E164_CONV.DAT file to be


used in v4.32 fix kit c.
File containing data for E.164 conversion for
support of Parallel Running
phase 1
Description: This file is loaded up by the MGTA
on platform startup.
The data in the file is loaded into tables in
the SMA of the main application image, and the
SMA for the ADM image of the platform.
Record Format:
<original pfx value> <new pfx value>
A maximum of 1000 entries is allowed.
Example:
4477701 443701

Home Location Register (Linux) V1.1 Support Guide

504

Chapter 24 Table Maintenance

!Section1
[INBOUND]
44370 447770
443740 4477740
443741 4477741
443742 4477742
443743 4477743
443744 4477744
!Oftel specified
443746 4477746
443747 4477747
443748 4477748
443749 4477749
44378 447778
44385 447785
44401 447701
44402 447702
44403 447703
44410 447710
44411 447711
44421 447721
44441 447741
44467 447767
44468 447768
44498 447798
44585 447885
44589 447889
44802 447802
44831 447831
44836 447836
44850 447850
44860 447860
44930 447930
!Oftel specified
449561 4479561
449562 4479562
449563 4479563
449564 4479564
449565 4479565
449566 4479566
!Oftel specified
449568 4479568
449569 4479569
44958 447958
44961 447961
44966 447966
44973 447973
44976 447976
!Section2
[OUTBOUND]
447770 44370
4477740 443740
4477741 443741
4477742 443742
4477743 443743
4477744 443744
!Oftel specified
4477746 443746
4477747 443747
4477748 443748
4477749 443749
447778 44378
447785 44385
447701 44401
447702 44402
447703 44403
447710 44410
447711 44411
447721 44421
447741 44441
447767 44467
447768 44468
447798 44498
447885 44585
447889 44589
447802 44802
447831 44831
447836 44836
447850 44850
447860 44860
447930 44930
!Oftel specified
4479561 449561
4479562 449562
4479563 449563
4479564 449564
4479565 449565
4479566 449566

GAP here

GAP here

GAP here

GAP here

GAP here

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

505

timer Table
The Timer table has two sections, [MWD] and [ENCRYPTION]. The
[MWD] section has two purposes:
Ensure that multiple timer events do not all happen at the same time
and adversely affect HLR performance
Insert a time delay between alert events to prevent alerts failing
because a service centre is busy with a previous alert
The [ENCRYPTION] section has the following purpose:
Limit the time that encryption is disabled. Each timer for disabled
encryption is individual to a subscriber
Delays are specified in OpenVMS delta time format, defined as follows:
dddd hh:mm:ss.cc

where:
Parameter

Values

Description

dddd

0000 to 9999

days

hh

00 to 23

hours

mm

00 to 59

minutes

ss

00 to 59

seconds

cc

00 to 99

hundredths of a second

Days must be specified, even if they are zero


Hours and minutes may be omitted with a default value of zero
If leading fields are omitted, the punctuation must still be specified
The hundredths of a second (cc) field is validated but is ignored

[MWD]
The [MWD] section controls whether SMSCs are prioritised and
contains delay times, to prevent multiple simultaneous timer events,
and to insert delays between alert attempts.
Parameter

Values

Default

Description

ALERT_HPLMN_PRIORITY

TRUE or FALSE

FALSE

TRUE - SMSCs in the home


network are alerted before
SMSCs in other networks
FALSE - SMSCs are not
prioritised according to which
network they belong to when
alerting

Home Location Register (Linux) V1.1 Support Guide

506

Chapter 24 Table Maintenance

Parameter

Values

Default

Description

ALERT_DELAY_RECALL

0000 00:00:00 to
0000 00:00:59.99

0000 00:00:01
(1 second)

Delay time in OpenVMS delta


time format:
dddd hh:mm:ss.cc
First delay time after a
Voicemail alert.
A delay of zero indicates an
immediate alert.

ALERT_DELAY_HPLMN

0000 00:00:00 to
0000 00:00:59.99

0000 00:00:01
(1 second)

Delay time in in OpenVMS


delta time format. Time
interval between alerts from
SMSCs in the home network.
If ALERT_HPLMN_PRIORITY
is FALSE or omitted, this field
is ignored.
A delay of zero indicates an
immediate alert.

ALERT_DELAY_OTHER

0000 00:00:00 to
0000 00:00:59.99

0000 00:00:01
(1 second)

Delay time in seconds. Time


interval between alerts from
SMSCs outside the home
network.
This is the delay used for all
networks if
ALERT_HPLMN_PRIORITY
is FALSE or omitted.
A delay of zero indicates an
immediate alert.

MWD_EXPIRY_DELAY

0000 00:00:01 to
9999 23:59:59.99

0000 72:00:00
(72 hours)

Time in seconds. The lifetime


of message waiting data. After
the specified delay, an attempt
is made to deliver the
message. Regardless of
whether the attempt is
successful, message waiting
data is deleted as a result.
If zero is specified, no expiry
timer is created and message
waiting data is deleted with no
new attempt to deliver the
message.

[ENCRYPTION]
Note: This section is included for future HLR support of encryption
disabling. The contents of this table section are not currently used.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

507

Places a limit on the time that a subscriber can have encryption


disabled. The [ENCRYPTION] section contains a single entry for the
expiry time in hours.
Parameter

Values

Default

Description

EXPIRY

24 to 168

24

Time in hours. Limits the


time that a subscriber has
encryption disabled.

Example

!================================================
!
Performance Group Test Table
!================================================
!
Table Name:
TIMER
!
Platform:
GSM HLR
!
Version:
6.20
!
!
Created By:
M. Stanley
!
On:
3 October 2002
!
!
Updated By:
!
On:
!
!================================================
!
For Testing Only - Do Not Put Live
!================================================
!
[MWD]
!
ALERT_HPLMN_PRIORITY
TRUE
ALERT_DELAY_RECALL
0 00:00:00.00
ALERT_DELAY_HPLMN
0 00:00:00.00
ALERT_DELAY_OTHER
0 00:00:00.00
MWD_EXPIRY_DELAY
0 00:00:00.00
!
[ENCRYPTION]
!
EXPIRY
0000 01:00:00
!

Home Location Register (Linux) V1.1 Support Guide

508

Chapter 24 Table Maintenance

Master Key (mkey) and Transport Key (tkey) Tables


The mkey (Master Key) and tkey (Transport Key) tables are used by
the Subscriber Key Encryption (SKE) operation. Each line in these
tables consists of two items separated by a single space. The first item
is a 4 hexadecimal character identifier, the second is the data (which is
16 or 48 hexadecimal characters in length).
The mkey Table contains master keys used for decoding the
transport keys (TKEY) loaded on to the HLR.
The tkey table contains transport keys used in decoding a
subscriber key when loaded onto the HLR by the AUCUPDATE:SUB
Administration commands.
Figure 56. mkeyExample
1D01
3D01
0D01
2D01

56789ABCDEF0123456789ABCDEF1234567890ABCDEF01234
A9876543210FEDCBA9876543210ABCDEF0123456789ABCDE
56789ABCDEF01234
F0123456789ABCDE

Figure 57. tkeyExample


1901
3901
0901
2901

56789ABCDEF0123456789ABCDEF0123456789ABCDEF01234
F0123456789ABCDEF0123456789ABCDEF0123456789ABCDE
56789ABCDEF01234
A9876543210FEDCB

msrnpfx Table
The msrnpfx table lists the prefixes of roaming numbers used by
subscribers.

Example

1, 111

MVNO Identification (mvno_id) Table


This table allows mapping of an IMSI to a MVNO. The HLR will use a
subscribers IMSI to match an IMSI prefix. The longest match will be
used if more than one match is possible.

Table Format

[IMSI]
<imsi_prefix> <MVNO_name>
.
.
... more imsi_prefixes ...

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

509

The table can contain from 0 to 100 IMSI prefixes, and up to 10 MVNO
names.
No IMSI prefix can be repeated.
The MVNO_name can be up to 16 characters.

Network Entity (netent) Table


The Network Entity (netent) table lists all network entities that can send
messages to the HLR or receive messages from it. For each entity, the
netent table includes the global title, name and the name of a profile
which lists attributes that define the services the entity supports.
Attributes are grouped into named profiles so that attributes common to
many MSCs, VLRs, and SGSNs are easy to maintain and apply.
Sections do not have to be in any particular order, but sections must be
complete. The end of each section is identified either by the start of the
next section, or by the end of the file.

Table Structure
The [ENTITIES] section list the network entities and refers to the
[PROFILE] and [PCLIST] sections to specify point codes and attributes
for the listed entities.
The [TEST DATA] section is optional and, if present, prevents the table
from loading.

Home Location Register (Linux) V1.1 Support Guide

510

Chapter 24 Table Maintenance

Figure 58. Table Structure


[PROFILE <profile_name>]

attributes that apply to network entities, such as unsupported services and whether
Ericsson MAP is supported. (See [PROFILE <profile_name>] on page 512).

[PCLIST <pclist_name>]

complete list of HLRs in the network, and point codes. (See [PCLIST
<pclist_name>] on page 521)

[DEFAULT_NE]
lists the point code(s) and attributes of the default network entity. (See
[DEFAULT_NE] on page 520)

[SCCPSEG]
contains a parameter that defines whether the platform uses message
segmentation in the SCCP layer. (See [SCCPSEG] on page 521)

[ENTITIES]
list of all network entities that can exchange messages with the HLR (see
[ENTITIES] on page 511). The format of each entry is as follows:

global
title

name

time
zone

point code(s) or
name of point
code list

profile
name

additional
attributes

[TEST DATA]
Optional section. Indicates the table contains test data and is, therefore, invalid.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

511

[ENTITIES]
Example entries in the [ENTITIES] section of the NETENT table are
shown below.
Figure 59. ENTITIES Example
Start of the list of entities
Entity name
Global title

[ENTITIES]
44385
!
44385011200
44802

Attribute profile
name

Point code(s) or
name of point
code list

VF-Default

DEFAULT_GT VLR3

VF-Woking
0 946 VLR1
UK-O2 0 817,878 MINIMUM OSMS RDROF

Time zone
Additional attributes

Each entity has the following parameters:


<global_title>
<entity_name>
<time_zone>
<point_code(s)>
<attribute_profile>
<additional_attributes>

Parameter

Meaning

Global Title

Number for the network entity global title. The same global title can
appear more than once in this section, provided all profiles specify
distinct SSNs. (A profile without an SSN is a catch-all, and will be
taken as all other SSNs, after specific SSNs are taken into account.)

Entity Name

Text giving name of entity.

Time Zone

Time difference, in half-hour units, between the PDS platform and the
network entity.

Point Codes

The point codes themselves or the name of a point code list defined in
the netent table. See [PCLIST <pclist_name>] on page 521.

Attribute Profile

Network entity attributes are gathered together into named profiles


and the profile name can then be associated with the network entity.
This avoids listing all attributes and therefore helps keep network
entity definitions on one line. See [PROFILE <profile_name>] on
page 512. Table 53 on page 513 lists the network entity attributes that
can appear in a profile.
This field can be a single profile, or a comma-separated list of
profiles. All profiles in a list must specify a distinct SSN. (A profile
without an SSN is a catch-all, and will be taken as all other SSNs,
after specific SSNs are taken into account.)

Additional Attributes

Optional attributes required where the network entity instance has


minor variations to the profile (maximum 3 additional attributes).
Table 53 on page 513 lists the network entity attributes that can
appear in a profile.

Home Location Register (Linux) V1.1 Support Guide

512

Chapter 24 Table Maintenance

[PROFILE <profile_name>]
As the number of features supported across the network increases,
more attributes are needed to define how each network entity is
configured. However, attributes must all be listed on one line of the
netent table.
Because many network entities have identical attributes or differ for
only a few attributes, common attributes are extracted into named
profiles. This profile name is then assigned to a network entity instead
of the list of attributes, reducing the length of the line.
For the HLR platform, not all NETENT tables for each platform type are
identical. Each PAM Global Title maps to two PCM point codes; this
mapping differs with each HLR and the default Global Title translation
entities are not the same for all HLRs.
The profile includes the subscription restriction status, which is
mandatory for all network entity instances, so every entity must be
associated with a profile name. The netent table will fail to load if any
network entity instance does not have a recognised profile.

Profile Format

A profile is identified by [PROFILE <profile_name>]. Fields within a


profile begin with the keywords listed in Table 52, followed by a single
attribute or a list of associated attributes, separated by white space.
Table 52. Keywords in a netent Profile

Keyword

Description

ATTRIB

Network entity attributes. See Table 53 for details.

EXTENDS

Specifies the name of an existing profile, to be copied into the new


one. If this keyword is present, it must be the first keyword in the
profile.

LCS_DOWNLOAD

Indicates whether the HLR should download the positioning allowed


indicator (PAI) flag or subscriber location privacy profile (SLPP)
data, or both, to the VLR.
PAI download the positioning allowed indicator
SLPP download SLPP data
See Location Based Services on page 36.

RESTR

The Subscription Restriction Status is a bitmask that indicates the


geographical location of a VLR or PLMN as a way to control
roaming. Each subscriber has a corresponding bitmask used to
determine whether a subscriber can register on the VLR or PLMN.
RESTR can be specified as a hexadecimal number, from 0x0000 to
0xFFFF, or as a decimal number, from 0 to 65536.
The Subscription Restriction Status is compared with the subscriber
attributes GPRS_SUB_RESTR and GSM_SUB_RESTR subscriber
attributes, which are specified using the UPDATE:SUB command.

SCCPSEG

Indicates whether message segmentation in the SCCP layer is


enabled.
0 - SCCP segmentation disabled
1- SCCP segmentation enabled

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

513

Table 52. Keywords in a netent Profile (Continued)


Keyword

Description

SSN

Specifies one or more SCCP subsystem numbers that the profile will
apply to. Subsystem numbers may be specified either as numbers
between 0 and 255 or as names such as "MSC", "VLR", "SGSN"
and so on. If SSN is not specified, the profile applies to all SSNs (or
all other SSNs when the GT range is given more than one profile:
see page 511).

UNSUPP_ODB

Operator Determined Bars NOT supported on the network entity.


See Appendix I, Operator Determined Bars.

UNSUPP_BS

Basic Services and Tele Services NOT supported on the network


entity. See Table 59 on page 591.

UNSUPP_SS

Supplementary Services NOT supported on the network entity. See


Table 60.

UNSUPP_AC

Application contexts NOT supported on the network entity. See


Table 54 on page 518.

UNSUPP_CAMEL

Phases of CAMEL NOT supported on the network entity. If a foreign


VLR supports CAMEL phase 1 and Ericsson Extended CAMEL, it
must appear to support CAMEL phase 1 only. This prevents the
foreign VLR from using the OICK data only and ignoring CAMEL
information. The HLR supports CAMEL phase 3, so PH3 must be
specified for any network entity that does not.

UNSUPP_SERV

Bit mask that indicates whether services are supported. Bit numbers
and values are:
0 - MULTISIM - many SIMs linked to a single published number
used for linked subscriptions
1 - ROAMED - pre-pay roaming call back service
2 - REGSUB regional subscription used for home zone charging
(see page 33)

The subscription restriction value must be present within the profile. All
other fields are optional and are required only if values are associated
with the fields.
A field can be specified on more than one line to make sure that lists of
attributes all fit on one line, for example:
ATTRIB EMAP
ATTRIB HPLMN
Note: For the bit numbers in the database bitmask that stores network
entity attributes, see Visited MSC Flags and Network Entity Attributes
on page 618.
Table 53. Attributes in a netent Profile

Attribute

Description

ADD

Entity is allowed to receive


IMEI-SV from a network entity.

ADPCM_PFX

Prefix added to returned RN/


MSISDN/FTN on a data call to
avoid ADPCM.

Home Location Register (Linux) V1.1 Support Guide

514

Chapter 24 Table Maintenance

Table 53. Attributes in a netent Profile (Continued)


Attribute

Description

ALLOW_ATI

Entity is allowed to receive a


response from
AnytimeInterrogation messages.
Generally, entities in the home
network will have this attribute.
If location services are available
to roamed subscribers, entities
outside the home network will
probably have this attribute.
See Location Based Services on
page 36.

ALLOW_ATSI

Entity is allowed to receive a


response from
AnytimeSubscriptionInterrogation
messages. Generally, entities in
the home network will have this
attribute. BT Mobile Converged
Voicemail subscribers must have
this attribute on any entity they
register on in order to have
voicemails deposited while
roaming.

ALLOW_POS

Entity is allowed to receive a


response from
SendRoutingInformationForLocati
onServices messages.
If location services are available
to roamed subscribers, entities
outside the home network will
probably have this attribute.
See Location Based Services on
page 36.

BLACK

Entity is black-listed. All incoming


messages from the entity are
ignored and outgoing messages
are discarded.

COMPRESS_ENB

MSC supports V.42bis data


compression for data calls. The
entity can indicate Data
Compression in the
NetworkSignallingInfo element of
the SendRoutingInfo message.
Whether the HLR uses
compression is controlled by the
DATA_COMPRESSION
parameter in the hlr_config Table
(see page 474).

EMAP

If granted, additional information


fields in incoming messages are
decoded as EMAP.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

515

Table 53. Attributes in a netent Profile (Continued)

Attribute

Description

HPLMN

Entity is part of the home PLMN,


for BICROAM quiescence, for
example.

LCS_DOWNLOAD

Specifies whether the HLR


downloads to a VLR, the
positioning allowed indicator
(PAI), subscriber location privacy
profile (SLPP) data, or both.

LOG_SCCP

An SCCP log record is logged if


the entity is involved (see
Appendix K, Event Log Files for
examples of logging).

LOG_SS7

An SS7 log record is logged if


the entity is involved (see
Appendix K, Event Log Files for
examples of logging). Several
levels of logging are possible:
transaction, SS7 event and
abandons.

LOG_TRANSACTION

A transaction log record is


logged if the entity is involved (see
Appendix K, Event Log Files for
examples of logging).

MLR

Entity is a Messenger Location


Register. If a subscriber has
message waiting data (MWD),
MLRs in the MWD are notified
immediately (using an
AlertServiceCentre message) if
an unreachable subscriber
becomes reachable again. The
MLR can then send an SMS or
other alert to the subscriber, to
indicate that Voicemail is waiting.
Mutually exclusive to the
RECALL_TMC flag.

MMR

Used for special SRI processing;


for example, on-net, off-net
charging.

NO_CANCEL

A Cancel Location will not be sent


from the HLR if the subscriber is
unknown to the HLR.

NO_SUSPECT

The Suspect Location handling


procedure will not be invoked.
This ensures that the entity gets
an immediate response to the
Send Authentication messages
that it sends.

Home Location Register (Linux) V1.1 Support Guide

516

Chapter 24 Table Maintenance

Table 53. Attributes in a netent Profile (Continued)


Attribute

Description

OR

Optimal Routing in use. Only


switches that have the OR flag
can return a roaming number in
response to an SRI. To route the
call via the home network, which
also keeps control of the call in
the home network, the called
subscribers MSISDN is returned.

OSMS

Originating SMS. if granted,


SRISMS will be processed. If not
granted, SRISMS and SMW are
responded to as unknown
subscriber.

RDROF

Used for number portability. If


present, the HLR must invoke a
Recipient DROF (Direct Routing
Override Function) to return
onward routing information to the
donor network.

REAL_SRI

Entity will only send real SRIs;


that is, GSM standard SRI
messages used to route calls.

RECALL_TMC

Entity is a text message centre


(TMC) used to send text alerts for
the Voicemail service. If a
subscriber has message waiting
data (MWD), RECALL_TMCs in
the MWD are notified immediately
(using an AlertServiceCentre
message) when an unreachable
subscriber becomes reachable
again. The RECALL_TMC can
then send an SMS to the
subscriber, to indicate that
Voicemail is waiting. Mutually
exclusive to the MLR flag.
AlertServiceCentre messages
might have priority over those for
an ordinary SMSC.
This attribute and the VM attribute
are mutually exclusive.

RN_PFX

Roaming Number Prefix. Network


entities can prefix roaming
numbers, allowing more control
over call routing.

ROAMING_RELAY

(Optional) SMS Roaming Relay.


The HLR supplies this as the
global title to which messages for
all roamed subscribers should be
forwarded, where the originating
SMSC is not from the home
network.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

517

Table 53. Attributes in a netent Profile (Continued)

Attribute

Description

ROAM_ORB

If the subscriber has roamed the


dialled MSISDN is returned to the
entity instead of the roaming
number.

ROAM_UNKSUB

If roaming to this entity is barred,


return the UnknownSubscriber
error even if the
ROAMING_NOT_ALLOWED
entry (see page 481) in the
hlr_config Table specifies the
RoamingNotAllowed error.
Vodafone UK uses this attribute to
ensure that subscribers who are
not allowed to register on UMTS
(3G) network entities do not
receive a RoamingNotAllowed
message, which would prevent
their handsets from subsequently
registering on a GSM (2G)
network.

ROUTE_ON_PC

Messages are routed using a


point code and not a global title.

SIGTRAN

Use of SIGTRAN to communicate


with remote entity rather than
SS7.

TSMS

Terminating Short Message


Service. The entity can receive
SMS messages. HLR checks for
this attribute before returning an
MSC or SGSN (or both) address
in response to a
SendRoutingInfoForSM message.
HLR also ensures that TS21
(mobile terminated SMS) is not
listed as an unsupported basic
service (UNSUPPORTED BS).
This attribute is a super set of
both TSMS_CS and TSMS_PS.

TSMS_CS

Terminating Short Message


Service for Circuit switched
bearer. Circuit switched entity can
receive SMS messages. HLR
checks for this attribute before
returning an MSC address in
response to a
SendRoutingInfoForSM message.
HLR also ensures that TS21
(mobile terminated SMS) is not
listed as an unsupported basic
service (UNSUPPORTED BS).
Note this is overridden by TSMS.

Home Location Register (Linux) V1.1 Support Guide

518

Chapter 24 Table Maintenance

Table 53. Attributes in a netent Profile (Continued)


Attribute

Description

TSMS_PS

Terminating Short Message


Service for packet switched
bearer. Packet switched entity can
receive SMS messages. HLR
checks for this attribute before
returning an SGSN address in
response to a
SendRoutingInfoForSM message.
HLR also ensures that TS21
(mobile terminated SMS) is not
listed as an unsupported basic
service (UNSUPPORTED BS).
Note this is overridden by TSMS.

VM

Entity is an MLR, an NGVM


Provisioning Server, or an NGVM
Availability Server. If a subscriber
has message waiting data
(MWD), servers in the MWD are
notified immediately (using an
AlertServiceCentre message) if
an unreachable subscriber
becomes reachable again. The
server can then send an SMS or
other alert to the subscriber, to
indicate that Voicemail is waiting.
Mutually exclusive to the
RECALL_TMC flag.

VODACPC

Permits entity to use special


CallingPartyCategory values. This
attribute applies to the Service
Access Point (SAP).

VODACAT

Allows the entity to interpret the


category subscriber data item in
a Vodafone customized way.

A network entity might not support all application contexts and,


therefore, might not support services that depend on a high level
application context. Unsupported application contexts (see Table 54
below) are listed in the UNSUPP_AC section of a profile.
Table 54. Application Contexts
Application Context

Bit

Description

ANY_TIME_INFO_ENQUIRY_V3

37

Used between gsmSCF and HLR for any time


information (ATI) enquiry procedures.

ANY_TIME_INFO_HANDLING_V3

48

Used between gsmSCF and HLR for any time


information (ATI) handling procedures.

AUTHENTICATION_FAILURE_REPORT_V3

46

Used if authentication fails between the


serving network and a mobile station.

ERI_LOCATION_SVC_GATEWAY_V3

47

Used to process Send Location Information for


LCS (SLI) messages, where LCS means
location services.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

519

Table 54. Application Contexts


Application Context

Bit

Description

GPRS_LOCATION_UPDATE_V3

40

Used between HLR and SGSN for location


updating procedures.

IMSI_RETRIEVAL_V2

31

Used for IMSI retrieval between HLR and VLR.

INFO_RETRIEVAL_V2

20

Used for authentication information retrieval


between HLR and VLR or between HLR and
SGSN.

INFO_RETRIEVAL_V3

45

Used for authentication information retrieval


between HLR and VLR or between HLR and
SGSN.

INTER_VLR_INFO_RETRIEVAL_V2

21

Used for information retrieval between VLRs.

LOCATION_CANCELLATION_V2

16

Used between HLR and VLR or between HLR


and SGSN for location cancellation.

LOCATION_CANCELLATION_V3

38

Used between HLR and VLR or between HLR


and SGSN for location cancellation.

LOCATION_INFO_RETRIEVAL_V2

18

Used between the GMSC and HLR when


retrieving location information.

LOCATION_INFO_RETRIEVAL_V3

42

Used between the GMSC and HLR when


retrieving location information.

MS_PURGING_V2

32

Used between HLR and VLR or between HLR


and SGSN for MS purging procedures.

MS_PURGING_V3

39

Used between HLR and VLR or between HLR


and SGSN for MS purging procedures.

MWD_MNGT_V2

29

Used between HLR and VLR for short


message waiting data management
procedures.

MWD_MNGT_V3

43

Used between HLR and VLR for short


message waiting data management
procedures.

NETWORK_FUNCTIONAL_SS_V2

24

Used for functional-like SS handling


procedures between HLR and VLR.

NETWORK_LOC_UP_V2

15

Used between HLR and VLR for location


updating.

NETWORK_LOC_UP_V3

41

Used between HLR and VLR for location


updating.

NETWORK_UNSTRUCTURED_SS_V2

25

Used for handling stimuli-like procedures


between HLR and VLR.

PSI_V2

33

Provide subscriber information.


Ericsson-specific application context.

RESET_V2

19

Used between HLR and VLR or between HLR


and SGSN for location register restart.

ROAMING_NUMBER_ENQUIRY_V2

17

Used between the HLR and VLR for roaming


number enquiries.

Home Location Register (Linux) V1.1 Support Guide

520

Chapter 24 Table Maintenance

Table 54. Application Contexts


Application Context

Bit

Description

ROAMING_NUMBER_ENQUIRY_V3

34

Used between the HLR and VLR/SGSN for


roaming number enquiries.

SHORT_MSG_ALERT_V2

28

Used for short message alerting procedures.

SHORT_MSG_GATEWAY_V2

26

Used for short message gateway procedures.

SHORT_MSG_GATEWAY_V3

44

Used for short message gateway procedures.

SHORT_MSG_MO_RELAY_V2

27

Used between MSC and IWMSC or between


SGSN and IWMSC for mobile originating short
message relay procedures.

SHORT_MSG_MT_RELAY_V2

30

Used between GMSC and MSC or between


GMSC and SGSN for mobile terminating short
message relay procedures.

SUBSCRIBER_DATA_MNGT_V2

22

Used for standalone subscriber data


management between HLR and VLR or
between HLR and SGSN.

SUBSCRIBER_DATA_MNGT_V3

36

Used for standalone subscriber data


management between HLR and VLR or
between HLR and SGSN.

SUBSCRIBER_INFO_ENQUIRY_V3

35

Used between HLR and VLR/SGSN for


subscriber information enquiry procedures.

TRACING_V2

23

Used for standalone tracing control between


HLR and VLR or between HLR and SGSN.

V2_AND_ABOVE

15 to
47

All application contexts above MAP1


unsupported.

V3_AND_ABOVE

34 to
47

All application contexts above MAP2


unsupported.

Note: For the bit numbers in the database bit mask that store
application contexts, see Unsupported Application Context Names on
page 621.

[DEFAULT_NE]
The default network entity must be present and is usually first in the list
of network entities. The [DEFAULT_NE] lists the point code(s) and
attributes applied to messages exchanged with any entity that is not
listed elsewhere in the NETENT table.
For the Vodafone network, entity instances are listed within the netent
table in the following order:
1. Vodafone VLRs
2. Vodafone special entities
3. Foreign VLRs
Any other requirements, including mobile number portability (MNP)

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

521

[SCCPSEG]
Network entities that support the WhiteBook version of the SCCP
protocol are able to divide up long messages for transmission and
reassemble them at their destination. The [SCCPSEG] section controls
whether a platform uses this capability or not.
Note: SCCP segmentation can be disabled even if the platform and
the entity it is communicating with both support WhiteBook SCCP.
The [SCCPSEG] section contains the following parameter:
Parameter

Values

Default

Meaning

GLOBAL_SCCPSEG

0 (zero) or 1

0 (zero)

0 - SCCP segmentation disabled


1 - SCCP segmentation enabled

Other parameters related to SCCP segmentation are SCCPSEG in the


Service Provider (sp) Table (see page 532), PROTOCOL CLASS,
QOS_RET_ON_ERR and SCCPSEG_UAL in the PDS Configuration
(pds_config) Table (see page 523) and SCCPSEG in the [PROFILE
<profile_name>] section of the Network Entity (netent) Table (see
page 509).
If SCCP segmentation is disabled but one or more network entities
support SCCP segmentation, as indicated by the SCCPSEG keyword
in the profile for the entity, the VERIFY:TABLE table maintenance
command (see page 462) generates a warning message.

[PCLIST <pclist_name>]
This section contains a list of HLRs, and the point codes they use for
routing messages to other entity types.
Point codes can be entered as the point codes themselves, or as the
name of a point code list defined elsewhere in the netent table. To allow
the same NETENT table to be used on all HLRs, each [PCLIST]
section contains one entry for each HLR. An HLR looks up its own
name in the list and uses those point codes. If the platform does not
find its name in the list, it uses the point codes listed by the OTHER
entry.
The point code of any HLR listed in this table must also appear in the
HLRs hsscfg table (page 495).

Home Location Register (Linux) V1.1 Support Guide

522

Chapter 24 Table Maintenance

Figure 60. Looking Up Point Codes


GHLRD uses these
point codes and ignores
all others

[PCLIST DEFAULT_GT]
GHLRB,805,869,804
GHLRC,805,869,804
GHLRD,805,869,804
GHLRY,805,869,804
GHLRZ,805,869,804
DHLRB,805,869,804
DHLRE,805,869,804
OTHER,805,869,804

OTHER is an optional final entry, but must


be at the end of the list if it is included.
These point codes are used if the netent
table is loaded on an entity that is not one
of those listed above OTHER
uses point codes from
[PCLIST DEFAULT_GT]

[ENTITIES]
44385016004
44385016303

VF-GMLRA
VF-GMLRB

0
0

DEFAULT_GT MLR
DEFAULT_GT MLR

<pclist_name> in the [PCLIST <pclist_name>] section must be


unique and entries in the list must be a node name followed by 1, 2, 3
or 4 comma separated point codes. Node names can be listed with or
without the node number, so that GHLRA1 and GHLRA are both valid.
If an OTHER entry is included (which defines the point codes to use if
the netent table is loaded on an entity not listed in the [PCLIST]
section) it must be at the end of the list.
Because a network entity searches each [PCLIST] section for its own
name, every [PCLIST] section must contain either the name of the
entity or an OTHER entry, otherwise the table will fail to load. For
example, if the netent table is loaded on HLRD, each [PCLIST]
section must contain an HLRD entry, an OTHER entry or both.

Network Entity
Rules of Loading

The network entity table must comply with the rules listed below, in
order to be successfully loaded at platform start-up or following a
REPLACE:TABLE request.

Number

Rule

All section headings must be correctly enclosed in square brackets.

A profile name must be unique and its length must not exceed 20 characters. A point code list
name must be unique and its length must not exceed 20 characters.

Point code lists must have the correct format.

A profile must have the correct format and contain the subscription restriction field.

The subscription restriction value must be between 0 and 65535.

The attributes, unsupported ODBs, unsupported SSs, unsupported BSs, unsupported ACs and
unsupported CAMEL phases must be recognised values.

Mandatory [DEFAULT_NE] and [ENTITIES] must be present.

The [DEFAULT_NE] section must have the correct format.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

523

Number

Rule

All network entity instances, including DEFAULT_NE must have the correct format and must
vary from a profile by more than 3 attributes.

10

A network entity must be assigned a known profile name.

11

A profile must contain a valid subscription restriction value.

12

Global title length must be valid and must not contain non-decimal digits.

13

Network entity title length must not exceed 20 characters.

14

Time zone value must be between 24 and -24.

15

Headings [DEFAULT_NE] and [ENTITIES] must only appear once.

[TEST DATA]
Optional section that forces table loading to fail if it is in the table file. It
indicates the table contains test data and is, therefore, invalid. If the
table contains the [TEST DATA] section header, replace the table
with the correct table for the live platform.

PDS Configuration (pds_config) Table


This table contains information common to all PDS IN nodes (although
they may not all use the data it contains). It includes log mask and
timeout information plus the GT of the entity. Table 55 lists the contents
of the table.
Table 55. Contents of the pds_config Table
Parameter

Values

Default

Description

ADMIN_THROTTLE_
THRESHOLD

0 to 100

Specifies the percentage free space


in the database caches below which
throttling of admin commands starts
to occur. When missing or set to 0,
no throttling occurs: admin
commands are executed at full
speed regardless of the free space
in the database caches. Higher
values are more intrusive: throttling
starts when there is more space left
in the database caches. The delay
applied to each admin command
rises from zero up to 10 seconds as
the free space continues to fall.
When the database is secured the
free space rises and the delay drops
back to zero.
Under normal circumstances, the
value should be set to 20.

Home Location Register (Linux) V1.1 Support Guide

524

Chapter 24 Table Maintenance

Table 55. Contents of the pds_config Table


Parameter

Values

Default

Description

DB_AGT_LOAD_
TIMEOUT

1 to 65535

300

The database agent timeout, in


seconds, used by database servers
when waiting for slave databases to
load.

DB_AGT_TIMEOUT

1 to 65535

10

The database agent timeout, in


seconds, used by database servers.

DB_BACKUP_
PERIOD

1 to 3240000

240

The database backup period, in


seconds.

DB_MGR_TIMEOUT

1 to 65535

10

The database manager timeout, in


seconds, used by database slaves.

DB_SECURE_
PERIOD

1 to 900

The database secure period, in


seconds.

DBSYNC_ANALYSIS

TRUE or FALSE

TRUE

Determines whether the slaves


analyse the DBSYNC data received
from the server, and populate
journal counters for the database.

DBSYNC_TRIMMING

TRUE or FALSE

TRUE

Determines whether the server


removes unchanged data from the
journals sent to the slaves, so
reducing network traffic.

DEFAULT_IMSI

Default IMSI for SAN and SRN


operations.

JOURNAL_PERIOD

1 to 900

Journal period, in seconds.

JOURNAL_
THRESHOLD

30000 to 40000

39000

The journal size threshold beyond


which the existing journal is closed
and another started.

LOCK_TIMEOUT

Log masks

Controls the delay before a


transaction waiting for a locked
subscriber record will give up, and
raise an alarm.
0000 to FFFF

Home Location Register (Linux) V1.1 Support Guide

Masks used to control logging


facilities on the HLR. These are:
ADMA_LOG_MASK - for
administration event logging
APP_SS7_LOG_MASK - for SS7
logging
APP_LOG_MASK - for general
logging
DB_LOG_MASK - for database
event logging
NET_LOG_MASK - for network
event logging
TRAN_LOG_MASK - for
transaction logging
SS7I_LOG_MASK - for SS7I
logging.
Appendix K, Event Log Files
describes how these masks work.

Chapter 24 Table Maintenance

525

Table 55. Contents of the pds_config Table


Parameter

Values

Default

Description

ONPIPC_CONN_
TIMEOUT

1 to 32767

60 s

Timeout value when carrying out a


connection.

ONPIPC_FAIL_
TIMEOUT

1 to 32767

10

Timeout value, in seconds,when


determining the delay before
retrying following a failure.

ONPIPC_IGNORE_
LOCAL

TRUE or FALSE

FALSE

Note: this parameter should not be


set on live platforms: it is for testing
only.
If TRUE, the contents of the local
service table are ignored when
attempting to resolve an Off-node
PIPC service, and a resolve
message is sent to all machines.
This allows reflector testing to be
carried out.

ONPIPC_PORT_NUM

1 to 32767

Port number to be used when


carrying out Off-Node PIPC
communications.

ONPIPC_SERV_
TIMEOUT

1 to 32767

Timeout value, in seconds, when


resolving service names.

OWN_GT

valid global title

OWN_GT2

valid global title

If OWN_GT2 is
not specified,
OWN_GT is
used for all
messages.

Optional second global title for the


HLR; used to provide two linksets to
a signalling transfer point (STP).
OWN_GT2 must have the same CC
(country code) (see GSM Number
Definitions on page 685) as
OWN_GT.

PAGE_UPD_BATCH

The number of MAP_UPDATE


messages sent in a batch from
server to slave and awaiting
response. The parameter is
optional, but the only valid value is
1.

PROTOCOL CLASS

0 (zero) or 1

SCCP protocol class

QOS_RET_ON_ERR

TRUE or FALSE

FALSE

TRUE - for every first extended unit


data (XUDT) packet, a packet is
returned to the sender of a
segmented SS7 message to
indicate that transmission failed
FALSE - nothing is returned to the
sender of a segmented SS7
message to indicate that
transmission failed. The sender
must rely on a time out.
This flag applies to SCCP class 1
messages; it does not affect SCCP
class 0 messages.

Used to identify this network entity


when sending messages to others
in the network.

Home Location Register (Linux) V1.1 Support Guide

526

Chapter 24 Table Maintenance

Table 55. Contents of the pds_config Table


Parameter

Values

Default

Description

SCCPSEG_UAL

TRUE or FALSE

FALSE

TRUE - unsupported application


context learning is enabled for
SCCP segmentation
FALSE - unsupported application
context learning (UAL) is disabled
for SCCP segmentation

SINGLE_DB_
IGNORE_GT

TRUE or FALSE

TRUE

Determines the behaviour when


there is a single active database. If
TRUE, an SS7 message will be
forwarded to the database
irrespective of the GT specified in
the message. If FALSE, the
message is discarded if the GT is
incorrect.

SS7I_UDFCFG_MASK
UAL_RETRY

IN7 user distribution function


configuration control.
Time in the
format:
d hh:mm:ss.cc

Delay used by unsupported


application context learning (UAL) to
determine when support of an
attribute by a network entity is
rechecked. Specified in the
OpenVMS delta time in format
d hh:mm:ss.cc

VIEW_TIMEOUT

YIELD_TO_SLAVE_
LIMIT

Example

Timer for controlling delay before


the view of locked subscriber record
completes.
Minimum value 0

600

The threshold for the increase in


sequence number. If the sequence
number has increased to a value
equal to or greater than this number
since system startup, a cutover will
not take place even if a more
up-to-date database is detected on
the standby side of a pair of nodes.

! SITE SPECIFIC auchlr global title


OWN_GT
44385016086
LOCK_TIMEOUT
70
VIEW_TIMEOUT
15
SS7I_LOG_MASK
FFFFFBFE
TRAN_LOG_MASK
00000000
APP_LOG_MASK
FFFFFFFE
!
! Log masks
APP_SS7_LOG_MASK
FFFFBBFE
! Log mask for ADMA events
ADMA_LOG_MASK

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

527

FFFFFFFF
! Default IMSI
DEFAULT_IMSI
234150000000000
UAL_RETRY
1
SCCPSEG_UAL
FALSE
QOS_RET_ON_ERROR
FALSE
PROTOCOL_CLASS
0

pipc Table
The PIPC table lists the node names and associated IP addresses of
those nodes with which the Off-Node PIPC Router process will
maintain permanent connections.
Table entries have the format:
<node_name> <IP_address>
where:
Parameter

Description

node_name

The name of the node (maximum 15 characters); a


maximum of 16 node_names may be specified.

IP_address

Optional entry, specifying the IP address in IPV4 format.

If synchronization between the live and standby nodes is enabled, then


this table should specify the two local BEP nodes.
To support synchronization with other platforms, this table should
specify any nodes to or from which the database is to be synchronized.
Note that you can include the local node in the table, which will be
ignored. In this way you can deploy the same table across a group of
HLRs.

Example 1

DB Sync enabled:
[NODES]
DHLRZ1

10.1.1.1

DHLRZ2

10.1.1.2

DHLRW1

10.1.2.1

DHLRW2

10.1.2.2

DHLRV1
DHLRV2

Home Location Register (Linux) V1.1 Support Guide

528

Chapter 24 Table Maintenance

DHLRZ is the local node (for synchronization between live and


standby).
DHLRW and DHLRV could be acting as slaves or servers (the
PDS_DEFS table defines which platforms are slaves and which are
servers).

Example 2

DB Sync disabled:
[NODES}
DHLRZ1

10.1.1.1

DHLRZ2

10.1.1.2

DHLRI1
DHLRI2
This platform is not capable of fully supporting DB Sync so there is no
synchronization between the live and standby nodes.
Also, DHLRZ and DHLRI should be slave platforms, as defined in the
PDS_DEFS table.

sccpr_node Table
This table contains details of the master SCCP Relays. It also contains
references to every other (slave) SCCP Relay in the network. The file
includes the SCCP Relay name, port number and IP address.
The first two entries reference the master SCCP Relays: the first is the
primary master SCCP Relay; the second is the secondary master
SCCP Relay.
When the HLR receives any of the commands UPDATE:ROUTE,
EXPORT:SUB, or IMPORT:SUB, it forwards the command, using TCP/
IP, to the primary master relay, and awaits a response. If it receives an
error during forwarding, such as TCP/IP failure or timeout, it does not
resend the messsage, but instead returns a Relay Message
Forwarding Failed error to ISAAC, and raises an alarm.

Example

!Master Relays
SCCRE1 21630 10.33.52.64
SCCRG2 21630 10.33.52.65
!All remaining Relays
SCCRF1 21630 10.33.52.60
SCCRA2 21630 10.33.52.63
...
...

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

529

sdm_dest Table
This table is used in the SDM process, and lists destination HLRs.
For each HLR listed, the following information is specified:
HLR name
HLR global title
HLR IP address
The table is limited to 15 entries.

SMS Barring (smsbar) Table


The SMS barring table (smsbar.dat) is used by the HLR to determine
the barring applied when an SRIforSM message is received. By editing
the contents of the table you can configure SMS barring.

Table Format

The table has a section for each barring criterion (short code, content
or charging). Within each section is a list of OD bars that, if the
subscriber has them, causes the SMS to be barred when that criterion
is met. The HLR applies the content and charge criteria preferentially.
[SHORTCODE]
<shortcode_prefix> <ODB> <ODB>... <ODB>
<shortcode_prefix> <ODB> <ODB>... <ODB>
.
.
<shortcode_prefix> <ODB> <ODB>... <ODB>
[CONTENT]
<content_type> <ODB> <ODB>... <ODB>
<content_type> <ODB> <ODB>... <ODB>
.
.
<content_type> <ODB> <ODB>... <ODB>
[CHARGE]
<charge_type> <ODB> <ODB>... <ODB>
<charge_type> <ODB> <ODB>... <ODB>
.
.

Home Location Register (Linux) V1.1 Support Guide

530

Chapter 24 Table Maintenance

<charge_type> <ODB> <ODB>... <ODB>


Section

Description

[SHORTCODE]

Contains a list of up to 500 shortcode prefixes. No prefix may be repeated. Each


prefix must be between 3 and 9 characters. Next to each short code is a
space-delimited list of zero or more ODBs.
If any of these ODBs are provisioned for the subscriber, that shortcode will be barred.
Any of the content or charge OD bars can appear in this section.

[CONTENT]

Contains a list of content types (currently only one type: Adult). No content type may
be repeated. Next to each short code is a space-delimited list of zero or more ODBs.
The only applicable bar is ODBOPENTSMS.
If any of these ODBs are provisioned for the subscriber, that shortcode will be barred.

[CHARGE]

Contains a list of charge types (currently Hirate or Lowrate). No charge type may be
repeated. Next to each short code is a space-delimited list of zero or more ODBs. The
only applicable bars are ODBPREMSMSHI and ODBPREMSMSLO).
If any of these ODBs are provisioned for the subscriber, that shortcode will be barred.

Example

[SHORTCODE]
691 ODBOPENTSMS
[CONTENT]
Adult ODBOPENTSMS
[CHARGE]
Lowrate ODBPREMSMSLO
Hirate ODBPREMSMSHI ODBPREMSMSLO

SMS Barring Response (smsbar_resp) Table


The SMS barring response table (smsbar_resp.dat) is used by the HLR
to determine the response sent in a short message when an SMS bar
is applied.

Table Format

[URL]
<URL_name> <URL>
[HYPERLINK]
<hyperlink_name> <URL_name> <title>
[DEFAULT]
CLASS_0 <content>
CLASS_1 <content>
[DEFAULT_SHORTCODE]
CLASS_0 <content>

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

531

CLASS_1 <content>
[DEFAULT_CONTENT]
CLASS_0 <content>
CLASS_1 <content>
[DEFAULT_CHARGE]
CLASS_0 <content>
CLASS_1 <content>
[<MVNO>_DEFAULT]
CLASS_0 <content>
CLASS_1 <content>
[<MVNO>_SHORTCODE]
CLASS_0 <content>
CLASS_1 <content>
[<MVNO>_CONTENT]
CLASS_0 <content>
CLASS_1 <content>
[<MVNO>_CHARGE]
CLASS_0 <content>
CLASS_1 <content>
... more MVNOs
All sections are optional, apart from [DEFAULT]. The CLASS_0 content
must be defined in this section.
CLASS_0 <content> must be a maximum of 160 characters, and
cannot contain hyperlinks.
CLASS_1 <content> can contain one hyperlink that the user can
access; to include a hyperlink, insert the text
%HYPERLINK(<hyperlink_name>) in the content, where
hyperlink_name is the name of a hyperlink defined in the [HYPERLINK]
section. CLASS_1 content must be a maximum of 160 characters plus
any hyperlink.
CLASS_0 and CLASS_1 values are optional; however, if both values
are specified, CLASS_0 must precede CLASS_1.
In the [HYPERLINK] section, the maximum length for any URL and
hyperlink name combination is 255 characters.

Home Location Register (Linux) V1.1 Support Guide

532

Chapter 24 Table Maintenance

To define an empty message, you can leave the section empty, omit the
<content>, or set it to an empty string ().
The table is searched for the most specific message that matches the
class, MVNO, and barring reason. The defaults are used if there is no
more specific match.

Example

[DEFAULT]
CLASS_0

"The SMS has been Barred"

[DEFAULT_SHORTCODE]
CLASS_0
"The SMS has been Barred, please call
your operator for more information"
[DEFAULT_CONTENT]
CLASS_0
"The SMS has been Barred on content,
please call your operator"
[DEFAULT_CHARGE]
CLASS_0
"The SMS has been Barred on charge,
please call your operator"
[BTDIAMOND_DEFAULT]
CLASS_0
"The SMS has been barred by
BTDIAMOND"
CLASS_1
"The SMS has been barred by
BTDIAMOND"
[BTDIAMOND_CONTENT]
CLASS_1
"CLASS_1 Please call BTDIAMOND or
access %HYPERLINK(BT_LINK) for content"
[URL]
BTWEB

"http://www.btdiamond.co.uk"

[HYPERLINK]
BT_LINK BTWEB "for more information"

Service Provider (sp) Table


The sp (Service Provider) table lists service provider identities, some
text about the service provider and an identity code for the
service-provider-specific message used to personalise voicemail. The
text, which describes the service provider, is returned to a subscriber in
response to a service provider enquiry USSD command (See Appendix
H, USSD Information).

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

533

The table has two sections, headed [DEFAULT] and [SP]:


Section

Description

[DEFAULT]

Service provider used if a subscribers SPCODE


attribute, which is the <SP_Identity> parameter in the
SP table, is not specified. Specify one service provider
in this section

[SP]

Lists up to 5000 service providers. Might contain more


than one entry per service provider to provide different
levels of service within a service provider

Entries in the sptable have the following format:


<SP_Identity> <USSD_text> <SP_VM_Identity>
where:
Parameter

Values

Description

<SP_identity>

aannnnnn

Identity of the service provider. 8 to 10 alphanumeric


characters, usually two letters (aa) followed by six digits
(nnnnnn).

<USSD_text>

string up to 48
characters

Usually the name and telephone number of the service


provider

<SP_VM_Identity>

0 to 99

Identifies a voicemail message for the service provider

Example

! Example SP.DAT file


[DEFAULT]
V090000000 "Vodafone" 0
[SP]
ZZ12345678
V090000000
V090000001
AA76706067
XX11111111
QQ99999999

"Red Network"
12
"TALKLAND-Business" 4
"TALKLAND-Metro"
1
"Blue Network"
78
"Green Network"
99
"Up to 48 characters"
61

SS7 Configuration (ss7cfg) Table


The SS7 configuration table (ss7cfg.dat) defines linksets. A minimum
SS7 configuration is required, which defines juist one linkset, as
follows:
OPC <originating point code>
SSN 9
TRUNK 1 PT37A1
LINKSET 1 999 0 LINK 0 PT37A1 1

Home Location Register (Linux) V1.1 Support Guide

534

Chapter 24 Table Maintenance

SS7 Event Configuration File (pds_ss7_event)


A minimal SS7 event configuration file is required, as follows:
ENTITY
ENTITY
ENTITY
ENTITY
ENTITY
ENTITY
ENTITY
ENTITY
ENTITY
ENTITY
ENTITY
ENTITY
ENTITY

SS7_K_FEP_SUBSYSTEM MINOR
SS7_K_MTP2 MINOR
SS7_K_DATA_LINK OFF
SS7_K_MTP3 MINOR
SS7_K_DESTINATION MINOR
SS7_K_ROUTE MINOR
SS7_K_LINKSET MAJOR
SS7_K_LINK MINOR
SS7_K_SCCP MINOR
SS7_K_APPLICATION MINOR
SS7_K_TCAP_FEP MINOR
SS7_K_BEP_SUBSYSTEM MINOR
SS7_K_SCCP_BEP MINOR

Unstructured Supplementary Service Data (ussd) Table


The USSD (Unstructured Supplementary Service Data) table contains
information about USSD services. See Appendix H, USSD Information
for a description of USSD services. The table consists of the named
sections listed in Table 56.
Table 56. Sections in the USSD Table
Section

Description

[FORWARD_USSD]

USSD commands that set up a dialogue between a mobile handset and an


intelligent node. Once the HLR has set up the dialogue, it plays no further
part in message exchange between the handset and the intelligent node.

[FORWARD_FAIL_TEXT]

Text for failure conditions of commands in the [FORWARD_USSD] section.

[U-CSI]

USSD codes and CAMEL Service Control Function (gsmSCF) addresses


that apply on a per subscriber basis.

[UG-CSI]

USSD codes and CAMEL Service Control Function (gsmSCF) addresses


that apply to all subscribers.

[PROCESSED_USSD]

Contains the USSD commands that are processed by the HLR itself.

[RELAYED_USSD]

USSD commands that are forwarded by the HLR for processing by another
intelligent node.

[RELAYED_FAIL_TEXT]

Text for failure conditions of commands in the [RELAYED_USSD],


[RELAYED_TCPIP_USSD], [U-CSI], or [UG-CSI] sections.

[GT <GT_NAME>]

Global title name that identifies the platform or platforms that process
commands in the [RELAYED_USSD], [RELAYED_USSD], [U-CSI], and
[UG-CSI] sections. This section can contain selection criteria to check that
the USSD command can be forwarded.

[RANGE <RANGE_NAME>]

Contains MSISDN ranges. <RANGE_NAME> is used to match a selection


criteria for a global title listed inside a [GT <GT_NAME>] section.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

535

Table 56. Sections in the USSD Table


Section

Description

[[RELAYED_TCPIP_
USSD]

USSD commands that are relayed in XML for processing by


an Application Service Provider.

[[ASP<ASP_NAME>]

Connection information of an Application Service Provider


that processes commands from the
[RELAYED_TCPIP_USSD] section.

[[CVT_USSD
<CONVERSION_
NAME>]

Conversion of a USSD command from the


[RELAYED_TCPIP_USSD] section to the XML request to be
sent to the Application Service Provider.

[[CVT_RESP
<CONVERSION_
NAME>]

Conversion of an XML response from the Application Service


Provider to the USSD command response of a command
from the [RELAYED_TCPIP_USSD] section.

[[REPLY_USSD]

USSD commands that only require a simple USSD reply.

[[REPLY_TEXT]

Reply text for commands in the [REPLY_USSD] section.


Each USSD command is defined for either a single voicemail type, or
all voicemail types that have not been specifically listed for that
command.
The USSD table must obey the following rules:
Each USSD command must be unique for a given voicemail type
across the [FORWARD_USSD], [PROCESSED_USSD], [REPLY_USSD],
[RELAYED_USSD], [RELAYED_TCPIP_USSD], [UG-CSI] and [U-CSI]
sections.
A maximum of 300 USSDs may be specified across the
[FORWARD_USSD], [RELAYED_USSD], [UG-CSI] and [U-CSI]
sections. The other sections have their own limits.

[FORWARD_USSD]
The [FORWARD_USSD] section in the USSD table allows the HLR to
connect a mobile station to a third party node, after which the HLR
drops out of the message exchange (see Figure 61 on page 536).

Home Location Register (Linux) V1.1 Support Guide

536

Chapter 24 Table Maintenance

Figure 61. Signalling for Forward USSD


USSD
Table
check USSD

mobile
handset

HLR

MSC

intelligent
node

USSD *#2345#
USSD *#2345#

Continued Dialogue

End

USSDs in the [FORWARD_USSD] section of the USSD table have the


format:
<COMMAND> <NAME> <FAIL_TEXT> <GT_NAME>
(NOTU_CMD:<ALTERNATIVE_PROCESSED_USSD>)
(VMTYPE:<VOICEMAIL_TYPE>)
where:
<COMMAND>

A USSD command string entered into a handset. A


<COMMAND> listed with a trailing minus (-) is a prefix,
which must match the beginning of the command
typed into the handset.

<NAME>

A string of 20 characters or less, in quotes, which


identifies the command. This string appears on
PULSE screens and in logging information.

<FAIL_TEXT>

A case sensitive label for the text to return if the


USSD fails. This label (upper case recommended)
must be defined in the [FORWARD_FAIL_TEXT]
section. One or more USSD commands can use the
same <FAIL_TEXT> label.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

537

<GT_NAME>

A case sensitive label for the global title of the


network entity that processes the USSD command.
This label (upper case recommended) must be
defined in a [GT <GT_NAME>] section of the table.
One or more USSD commands can use the same
<GT_NAME>.

NOTU_CMD:
<ALTERNATIVE_
PROCESSED_
USSD>

Optional parameter that specifies a


[PROCESSED_USSD] command to use if the
subscription does not support the [FORWARD_USSD].
This is described more fully in the [RELAYED_USSD]
section.
The HLR refers to selection criteria, required
supplementary services and other criteria in the [GT
<GT_NAME>] (see [GT <GT_NAME>]) to determine
whether the [FORWARD_USSD] is supported.

VMTYPE:
<VOICEMAIL_
TYPE>

Optional parameter that specifies the voicemail type.


Valid voicemail types are BTNOMI, NGVM, BTCVM
or OTHER. The value "OTHER" indicates all
voicemail types except those listed elsewhere for the
same USSD command string. If the field is missing
then OTHER is assumed.

Example

In the example below, the USSD command *#920# is labelled


DEFAULTS; this label is used in logging files and by the PULSE utility.
The command then refers to FWD_FAIL in the [FORWARD_FAIL_TEXT]
section for the text to use if the command cannot be executed.
The HLR forwards the command to the entity defined in the global title
section named [GT DEFAULT]. If the subscribers MSISDN is within the
range defined in [RANGE PREPAY_1] section, the command is
forwarded to global title 44385123456.
The mobile handset then exchanges messages with the node with
global title 44385123456 with no further intervention by the HLR.

[FORWARD_USSD]
*#920# "DEFAULTS" FWD_FAIL DEFAULT
!
[FORWARD_FAIL_TEXT]
FWD_FAIL "USSD Forward Service is not available"
!
[GT DEFAULT]
!
USE_PAP_TT TRUE
GT 44385123456 OICK:1,2,4-8
GT 44385123456 RANGE:PREPAY_1
!
[RANGE PREPAY_1]
44385100100 44385100104

Home Location Register (Linux) V1.1 Support Guide

538

Chapter 24 Table Maintenance

[PROCESSED_USSD]
USSDs in the [PROCESSED_USSD] section of the USSD table are listed
in pairs, with an optional VMTYPE on a command:
<TOKEN> <VALUE> (VMTYPE:<VOICEMAIL_TYPE>)
where:
<TOKEN>

A name given to the <VALUE> which identifies its


purpose.

<VALUE>

A USSD command string entered into a handset or a


text response of no more than 160 characters.

VMTYPE:
<VOICEMAIL_
TYPE>

Optional parameter for a USSD command token that


specifies the voicemail type. Valid voicemail types are
BTNOMI, NGVM, BTCVM or OTHER. The value
"OTHER" indicates all voicemail types except those
listed elsewhere for the same USSD command
string. If the field is missing then OTHER is assumed.
See Appendix H, USSD Information for a description of USSD services
that can be defined in this section.

[RELAYED_USSD]
USSDs in the [RELAYED_USSD] section of the USSD table have the
format:
<COMMAND> <NAME> <FAIL_TEXT> <GT_NAME>
(NOTU_CMD:<ALTERNATIVE_PROCESSED_USSD>)
(VMTYPE:<VOICEMAIL_TYPE>)
where:
<COMMAND>

A USSD command string entered into a handset. A


<COMMAND> listed with a trailing minus (-) is a prefix,
which must match the beginning of the command
typed into the handset.

<NAME>

A string of 20 characters or less, in quotes, which


identifies the command. This string appears on
PULSE screens and in logging information.

<FAIL_TEXT>

A case sensitive label for the text to return if the


USSD fails. This label (upper case recommended)
must be defined in the [RELAYED_FAIL_TEXT]
section. One or more USSD commands can use the
same <FAIL_TEXT> label.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

539

<GT_NAME>

A case sensitive label for global title of the network


entity that processes the USSD command. This label
(upper case recommended) must be defined in a [GT
<GT_NAME>] section of the table. One or more USSD
commands can use the same <GT_NAME>.

NOTU_CMD:
<ALTERNATIVE_
PROCESSED_
USSD>

Optional parameter that specifies a


[PROCESSED_USSD] command to use if the
subscription does not support the [RELAYED_USSD].
This parameter allows the linked subscriptions and
MultiSIM services to run in parallel, even though they
use the same USSD command strings.
The HLR refers to selection criteria, required
supplementary services and other criteria in the [GT
<GT_NAME>] (see [GT <GT_NAME>]) to determine
whether the [RELAYED_USSD] is supported.

VMTYPE:
<VOICEMAIL_
TYPE>

Optional parameter that specifies the voicemail type.


Valid voicemail types are BTNOMI, NGVM, BTCVM
or OTHER. The value "OTHER" indicates all
voicemail types except those listed elsewhere for the
same USSD command string. If the field is missing
then OTHER is assumed.

Parallel Running
of Linked
Subscriptions
and MultiSIM

Both linked subscriptions and MultiSIM use the same USSD strings, so
the USSD table must be flexible to allow:
The linked subscription service to run in parallel with the MultiSIM
service, using the same USSD command strings
The linked subscription service to be removed and replaced with the
MultiSIM service
The <ALTERNATIVE_PROCESSED_USSD> is the solution to these
requirements. USSD commands for linked subscriptions and MultiSIM
are initially matched to the entries in the [RELAYED_USSD] section. If
the relayed USSD is not available, the equivalent MultiSIM command in
the [PROCESSED_USSD] section is used.
The MultiSIM command names are commented out so that the same
command name does not appear twice in the table.
When the linked subscription service is discontinued, the MultiSIM
entries in the [PROCESSED_USSD] must be uncommented and the
linked subscriptions entries removed from the [RELAYED_USSD]
section.

Home Location Register (Linux) V1.1 Support Guide

540

Chapter 24 Table Maintenance

The figure below shows the sections of the USSD table used by the
linked subscription and MultiSIM services:
[PROCESSED_USSD]
.
.
! *******************************
! Processed MultiSIM Service
!
!MULTI_NOM_SIM_CMD *131MULTI_NOM_SIM_TEXT "SIM %d is nominated"
MULTI_NOM_SIM_NONE "SIM %d does not exist"

Alternative PROCESSED_USSD

!MULTI_FIND_NOM_CMD *#131MULTI_FIND_NOM_TEXT "SIM %d for %s" !%s represents the BSG list
!MULTI_MY_ID_CMD
MULTI_MY_ID_TEXT

*#130#
"I am SIM %d"

MULTI_NOTU
"Only 1 SIM"
MULTI_FAIL
"Failed to obtain"
.
.
[RELAYED_USSD]
.
.
!******************************
! MultiSim service
*131# "LS Nominate Me" LSUB_FAIL LSUB_GT NOTU_CMD:MULTI_NOM_SIM_CMD
*131*- "LS Nominate SIM" LSUB_FAIL LSUB_GT NOTU_CMD:MULTI_NOM_SIM_CMD
*#131# "LS Who Nominated" LSUB_FAIL LSUB_GT NOTU_CMD:MULTI_FIND_NOM_CMD
*#130# "LS Who am I"
LSUB_FAIL LSUB_GT NOTU_CMD:MULTI_MY_ID_CMD
.

[FORWARD_FAIL_TEXT]
The [FORWARD_FAIL_TEXT] section defines text messages for failure
conditions. The [FORWARD_FAIL_TEXT] section is not mandatory, but
should be included to support a [FORWARD_USSD] section.
Failure messages are listed as:
<TOKEN> <TEXT>
where:
<TOKEN>

A label of 20 characters or fewer that identifies the


error text. <TOKEN> must not contain any white
space and must be unique within the
[FORWARD_FAIL_TEXT] section. If <TOKEN> is not
referred to from the [FORWARD_USSD] section, a
warning message is generated.

<TEXT>

A quoted string of 512 characters or fewer. <TEXT>


must not be an empty string, and indicates the
reason for a failure.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

541

[RELAYED_FAIL_TEXT]
The [RELAYED_FAIL_TEXT] section defines text messages for failure
conditions. The [RELAYED_FAIL_TEXT] section is not mandatory, but
should be included to support a [RELAYED_USSD], [U-CSI] or
[UG-CSI] section.
Failure messages are listed as:
<TOKEN> <7(;7>
where:
<TOKEN>

A label of 20 characters or fewer that identifies the


error text. <TOKEN> must not contain any white
space and must be unique within the
[RELAYED_FAIL_TEXT] section. If <TOKEN> is not
referred to from the [RELAYED_USSD] section, a
warning message is generated.

<TEXT>

A quoted string of 512 characters or fewer. <TEXT>


must not be an empty string, and indicates the
reason for a failure.

[U-CSI]
This section contains USSD commands that inform CAMEL of USSD
events, and apply on a per subscriber basis. Only one entry should be
defined. The command strings are specified in the individual subscriber
data.
The USSD command in the [U-CSI] section of the USSD table has the
format:
<NAME> <FAIL_TEXT> <GT_NAME>
where:

<NAME>

A quoted string of 20 characters or fewer. <NAME>


must not be an empty string, and is used to log
commands.

<FAIL_TEXT>

A reference to an entry in the


[FORWARD_FAIL_TEXT] section.

<GT_NAME>

A reference to an entry in the [GT <GT_NAME>]


section which identifies the CAMEL service platform
(gsmSCF) that handles this USSD command. The
global title specified is overridden if a U-CSI global
title is specified in individual subscriber data.

Home Location Register (Linux) V1.1 Support Guide

542

Chapter 24 Table Maintenance

[UG-CSI]
This section contains USSD commands that inform CAMEL of USSD
events and apply to all subscribers.
USSD commands in the [UG-CSI] section of the USSD table have the
format:
<COMMAND> <NAME> <FAIL_TEXT> <GT_NAME>
where:
<COMMAND>

A string of up to 16 characters, usually with format


*#nnn# where nnn is 3 digits. <COMMAND> can be
any combination of *,# and numbers in any order; it
must not contain any white space and must be
unique within the USSD table.

<NAME>

A string, in quotes, of 20 characters or fewer. <NAME>


must not be an empty string and is used to log
commands.

<FAIL_TEXT>

A reference to an entry in the


[FORWARD_FAIL_TEXT] section.

<GT_NAME>

A reference to an entry in the [GT <GT_NAME>]


section which identifies the CAMEL service platform
(gsmSCF) that handles this USSD command.

[REPLY_USSD]
This section contains USSD commands that define simple USSD
replies.
USSD commands in the [REPLY_USSD] section of the USSD table
have the format:
<COMMAND> <NAME> <REPLY_TEXT_ID>
(VMTYPE:<VOICEMAIL_TYPE>)
where:
<COMMAND>

A USSD command string entered into a handset. A


<COMMAND> listed with a trailing minus (-) is a prefix,
which must match the beginning of the command
typed into the handset.

<NAME>

A string, in quotes, of 20 characters or fewer. <NAME>


must not be an empty string and is used to log
commands.

<REPLY_TEXT_
ID>

A reference to an entry in the [REPLY_TEXT] section.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

543

Optional parameter that specifies the voicemail type.


Valid voicemail types are BTNOMI, NGVM, BTCVM
or OTHER. The value "OTHER" indicates all
voicemail types except those listed elsewhere for the
same USSD command string. If the field is missing
then OTHER is assumed.

VMTYPE:
<VOICEMAIL_
TYPE>

Up to 300 commands are allowed in this section.

[REPLY_TEXT]
The [REPLY_TEXT] section defines text responses for commands in
the [REPLY_USSD] section.
Messages are listed as:
<TOKEN> <TEXT>
where:
<TOKEN>

A label of 20 characters or fewer that identifies the


text. <TOKEN> must not contain any white space and
must be unique within the [REPLY_TEXT] section. If
<TOKEN> is not referred to from the [REPLY_USSD]
section, a warning message is generated.

<TEXT>

A quoted string of 512 characters or fewer. <TEXT>


must not be an empty string and indicates the reply
text.

[GT <GT_NAME>]
The [GT <GT_NAME>] section specifies global titles that are the
destinations of relayed and forwarded USSD commands. Also, the
network operator can use the [GT_<GT_NAME>] section to configure
USSD command behaviour depending on a subscribers
supplementary services, ranges of MSISDNs and other criteria.
The [GT <GT_NAME>] section has the format:
[GT <GT_NAME>]
(USE_PAP_TT
(MSISDN
(NOTUTEXT
(VERSION

[TRUE | FALSE])

[CLI | MAIN | NONE])


"Up to 512 characters of text")
[MAP_V1 | MAP_V2 | SAME])

(UNEXPECTED_DATA [TC_ERROR | FAIL_TEXT])


(REQUIRED_SS [Any space separated SS])

Home Location Register (Linux) V1.1 Support Guide

544

Chapter 24 Table Maintenance

(REQUIRED_SERVICE [MULTISIM | REG_SUB | ROAMED])


(GT <GT>

(<selection_criteria>))

There can be more than one GT line.


The GT <selection_criteria> can by one of:
OICK:<min_value>(-<max_value>)(,<min_value>
(-<max_value>))
RANGE:<range_name>
DEFAULT
The example shown later demonstrates how this section is used.

[RANGE <RANGE_NAME>]
The [RANGE <RANGE_NAME>] section specifies MSISDN ranges as part
of the selection criteria of the [GT <GT_NAME] section. The MSISDN
ranges are listed in pairs:
<LOWER_MSISDN> <HIGHER_MSISDN>

[RELAYED_TCPIP_USSD]
USSDs in the [RELAYED_TCPIP_USSD] section of the USSD table
have the format:
<COMMAND> <NAME> <FAIL_TEXT> <ASP_NAME>
<CONVERSION_USSD_REQUEST> <CONVERSION_USSD_RESPONSE>
(VMTYPE:<VOICEMAIL_TYPE>)
where:
<COMMAND>

A USSD command string entered into a handset. A


<COMMAND> listed with a trailing minus (-) is a prefix,
which must match the beginning of the command
typed into the handset.

<NAME>

A string of 20 characters or fewer, in quotes, which


identifies the command. This string appears on
PULSE screens and in logging information.

<FAIL_TEXT>

A case sensitive label for the text to return if the


USSD fails. This label (upper case recommended)
must be defined in the [RELAYED_FAIL_TEXT]
section. One or more USSD commands can use the
same <FAIL_TEXT> label.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

545

<ASP_NAME>

A case sensitive label for the Application Service


Provider information. This label (upper case
recommended) must be defined in a [ASP
<ASP_NAME>] section of the table. One or more
USSD commands can use the same <ASP_NAME>.

<CONVERSION_
USSD_REQUEST>

A case sensitive label for defining how the command


is converted into the XML request sent to the
Application Service Provider. This label (upper case
recommended) must be defined in a [CVT_USSD
<CONVERSION_NAME>] section of the table. One or
more USSD commands can use the same
<CONVERSION_NAME>.

<CONVERSION_
USSD_
RESPONSE>

A case sensitive label for defining how the XML


response from the Application Service Provider is
converted into the USSD command response. This
label (upper case recommended) must be defined in
a [RESP_USSD <CONVERSION_NAME>] section of the
table. One or more USSD commands can use the
same <CONVERSION_NAME>.

<VMTYPE:
<VOICEMAIL_
TYPE>

Optional parameter that specifies the voicemail type.


Valid voicemail types are BTNOMI, NGVM, BTCVM
or OTHER. The value "OTHER" indicates all
voicemail types except those listed elsewhere for the
same USSD command string. If the field is missing
then OTHER is assumed.
Up to 500 commands are allowed in this section.

[ASP <ASP_NAME>]
Each Application Service Provider (ASP) is defined in an [ASP
<ASP_NAME>] section with the following format:
[ASP <ASP_NAME>]
IP_ADDR <address>
IP_PORT <port>
SERVICE <service>
CLIENT_ID <client_id>
CLIENT_PWD <password>
(CONNECTION_TYPE <connection_type>)
(CONNECTION_TIMEOUT <connection_timeout>)
(CONTENT_TYPE <content_type>)

Home Location Register (Linux) V1.1 Support Guide

546

Chapter 24 Table Maintenance

where:
Parameter

Values

Description

<ASP_NAME>

String of up to 20
characters

Label to identify ASP.

<address>

IPv4 address in dotted


notation

IP address of the ASP.

<port>

0 to 65535

TCP/IP port of the


socket connection on
the ASP.

<service>

String of up to 40
characters

The name of the


service on the ASP. No
spaces are allowed.

<client_id>

String of up to 40
characters

The client id string. No


spaces are allowed.

<password>

String of up to 40
characters

Any password string.


No spaces are allowed.

<connection_
type>

"SINGLE_SHOT",
"EXCLUSIVE", or
"SHARED

Type of connection. If
not specified,
"SINGLE_SHOT" is
assumed.

<connection_
timeout>

0 to 65535

Connection timeout in
seconds. If not
specified, 10 is
assumed.

<content_type
>

"application/
x-www-formurlencoded" or
"text/xml

Value of the HTTP


content-type header
field. If not specified,
"application/
x-www-formurlencoded" is
assumed.

Up to 10 ASPs can be defined.

Example

[ASP NGVM]
IP_ADDR

172.26.128.10

IP_PORT

710

SERVICE

/hlrussd

CLIENT_ID

HLR

CLIENT_PWD

vodafone

CONNECTION_TYPE

SHARED

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

547

CONNECTION_TIMEOUT 10
CONTENT_TYPE

text/xml

[CVT_USSD <CONVERSION_NAME>]
The conversion from USSD to an HTTP Request Message is defined
with the following format:
[CVT_USSD <conversion_name>]
<mask_string>
<mask_string>

where:
Parameter

Values

Description

<conversio
n_name>

String of up to 20
characters

Label to identify the conversion.

<mask_
string>

String of up to
1024 characters
containing any of
the variables:
%MSISDN%,
%CLID%,
%CLPWD%,
%CLADDR%,
%CLPORT%,
%CLSERV%,
%USSD%

The mask strings each define one line of the


XML request. They may contain any of the
predefined variable names (in upper case)
between two percent (%) characters; for
example: %MSISDN%. The variables are
replaced in the XML request with the
appropriate field. If an unknown variable
name is encountered, it is copied as text.
%MSISDN% - MSISDN of the subscriber that
sent the USSD
%CLID% - ASP client ID
%CLPWD% - ASP client password
%CLADDR% - ASP IP address
%CLPORT% - ASP IP port
%CLSERV% - ASP Service Name.
%USSD% - USSD code from the incoming
message
All preceding and trailing white space is
removed from the mask string. The mask
string is then appended directly to the
previous one. No line-feed (LF), carriage
return (CR), or trailing spaces (SP) are
added, regardless of how the mask appears
in the [CVT_USSD <conversion_name>]
section.

Up to 10 conversions can be defined.

Home Location Register (Linux) V1.1 Support Guide

548

Chapter 24 Table Maintenance

The end of the mask is indicated by the start of the next section. An
empty line in the file is not added to the mask.
No special characters are supported for this release.

Example

The following section defines how to convert a request to Enable


Subscriber Privacy on the LES:
[CVT_USSD LES_ENA_REQ]
&context=<?xml version="1.0"?>
<!DOCTYPE CTXT SYSTEM "MLAP_CTXT.DTD">
<HDR ver="1.0">
<CLIENT>
<ID>%CLID%</ID>
<PWD>%CLPWD%</PWD>
<SERVICEID>0005</SERVICEID>
<SERVICETYPE service_type_type="ACTIVE"/>
</CLIENT>
</HDR>
&method=SSR
&body=<?xml version="1.0"?>
<!DOCTYPE SSR SYSTEM "MLAP_SSR.DTD">
<SSR ver="1.0">
<SD>
<MSID msid_type="MSISDN">%MSISDN%</MSID>
<LM lm_status="on"/>
</SD>
</SSR>
The conversion mask is presented as a long character array in the
application. The application will copy the mask into a buffer, replacing
the variables with their values. The maximum length of this buffer is not
defined. It should be allocated dynamically and properly released after
use.
The HTTP message header is generated automatically using the
definition of the ASP specified for the USSD and the length of the
generated message buffer.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

549

[CVT_RESP <conversion_name>]
The conversion from HTTP Response message to USSD in the
application starts with an HTTP message body received from the TCP/
IP process.
[CVT_RESP <conversion_name>]
XML_RES

<XML_entity_name>

SUCCESS_VAL

<success_value>

USSD_RESP

<success_response>

(XML_VAL <XML_value>)
(ALT_USSD_RESP<alternative_response>)
where:
Parameter

Values

Description

<conversion
_name>

String of up to 20
characters

Label to identify the conversion.

<XML_
entity_
name >

String of up to
512 characters

Name of XML entity in the response to get


the value from. For example,
/MSA/RESULT/res_code
The name is not case sensitive.

<success_
value>

String of up to
512 characters

If the value associated with the


<XML_entry_name> equals the
<success_value>, then the USSD
command was successful and
<success_response> is returned.
If the value does not match
<success_value>, or any other failure
occurs, the USSD_FAIL_TEXT specified for
this USSD service is returned.

<success_
response>

Quoted string of
up to 512
characters. The
string may
contain the
variable
%XML_VAL%

The text response returned to the subscriber


if the USSD was successful. If %XML_VAL% is
defined, it will be replaced by the text from
the response associated with the
<XML_value> field.

<XML_value>

String of up to
512 characters

Name of XML entity in the response to get


the value which replaces the %XML_VAL%
field in the <success_response>

Home Location Register (Linux) V1.1 Support Guide

550

Chapter 24 Table Maintenance

Parameter

Values

Description

<alternativ
e_
response>

Quoted string of
up to 512
characters

The text response returned to the subscriber.


if the value of the <XML_entity_name>
field matches the <success_value> but
the <success_response> string could not
be formatted because it contains a
%XML_VAL% field but the <XML_value>
entity could not be found in the XML
response.

Up to 10 conversions can be defined.

Example

The following defines the conversion mask for a response to Enable


Subscriber Privacy on the LES:
[CVT_RESP LES_ENA_RESP]
XML_RES

/MSA/RESULT/res_code

SUCCESS_VAL

XML_VAL

/MSA/MSISDN

USSD_RESP

"LCS Enabled for %XML_VAL%".

This will work if the incoming HTTP message is expected to look like
this:
HTTP/1.1SP200SPOKCRLFDate:SPMonSP11SPAugSP2003SP09:12:32CRLF
Content-Length:SP531CRLFConnection:SPCloseCRLF
Content-Type:SPtext/xmlCRLFCRLF<xmlSPversion="1.0"?>LF
<!DOCTYPESPMSASPSYSTEMSP"MLAP_MSA.DTD"><MSASPver="1.0">LF
<RESULTSPres_code="0"SP/><MSISDN>4478881112343</MSISDN>LF</MSA>
In this stream, the HTTP message body is all the characters following
the CRLFCRLF sequence. The body is interpreted as XML to read the
XML_RES entity, and its value is 0 in this example. This matches
SUCCESS_VAL, so USSD_RESP is returned to the subscriber with
%XML_VAL% replaced by the MSISDN, that is, "LCS Enabled for
4478881112343".

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

551

Example
The example shows some sample entries in each USSD table section,
showing commands for:
looking up a mobile's MSISDN.
looking up the subscriber's HLR.
the message returned if a pay as you talk (PAYT) USSD command
fails.
the global title that PAYT USSD commands are forwarded to,
including some selection criteria that determine whether the
command can be processed.
MSISDN ranges for a PAYT USSD service.
a PAYT service as an example of a relayed service.
querying an NGVM mailbox.
setting NGVM diverts.
See Appendix H, USSD Information for full details of the contents of the
USSD table.
The USSD table in the example is in a single file, but is shown as split
into [PROCESSED_USSD] and [RELAYED_USSD] sections to explain
their different formats.
Figure 62. Example USSD Table ([PROCESSED_USSD])
[PROCESSED_USSD]
! ****************************************************
! Own MSISDN Service
! ****************************************************
OWN_MSISDN_CMD
*878#
OWN_MSISDN_TEXT
"Phone number is 0%s"
OWN_MSISDN_BSG_CMD
*878*OWN_MSISDN_BSG_TEXT
"%s"
OWN_MSISDN_BSG_TOO_MANY_TEXT "Too many MSISDNs requested"
OWN_MSISDN_BSG_TOO_MUCH_TEXT "Too much data requested"
OWN_MSISDN_BSG_EMPTY_TEXT "No MSISDN for specified service"
OWN_MSISDN_BSG_INV_MMI_TEXT "Invalid service code"
OWN_MSISDN_BSG_INV_FORM_TEXT "Invalid format - Use *#100*xy# or *#100#
"
!
! ****************************************************
! Own HLR Service
! ****************************************************
HLR_ID_CMD
*500#
HLR_ID_TEXT
"HLR %s %04x %s"

The [PROCESSED_USSD] section does not refer to any other section in


the USSD table.

Home Location Register (Linux) V1.1 Support Guide

552

Chapter 24 Table Maintenance

The example includes the command that subscribers use to find out
their own MSISDN (*878#), and the command to find out which HLR
they are connected on (*500#).
Figure 63. Example USSD Table ([RELAYED_USSD])
[RELAYED_USSD]
! *****************************************************
! PAYT Service
! *****************************************************
*999#"PAYT Cmd 0" PAYT_FAIL CLICK_PAYT_GT
*999*"PAYT Cmd 1" PAYT_FAIL CLICK_PAYT_GT
[RELAYED_FAIL_TEXT]
PAYT_FAIL
"\x01PAYT Service is not available"
[RANGE CLICK_PAYT_SMSC]
20105000000 20105999999
20101000000 20101999999
[GT CLICK_PAYT_GT]
MSISDN
NONE
NOTUTEXT
"Service not available"
VERSION
MAP_V1
UNEXPECTED_DATA FAIL_TEXT
GT 20105996510 RANGE:CLICK_PAYT_SMSC

The [RELAYED_USSD] section refers to other sections in the USSD


table.
In the example, the USSD command *999# is labelled "PAYT Cmd 0";
this label is used in log files and by the PULSE utility.
The command then refers to PAYT_FAIL in the
[RELAYED_FAIL_TEXT] section for the text to use if the command
cannot be executed.
The HLR forwards the *999# command to the entity defined in the
global title section named [GT CLICK_PAYT_GT]. If the subscribers
MSISDN is within the range defined in [RANGE CLICK_PAYT_SMSC]
section, the command is forwarded to global title 20105996510.

Example USSD
Table

[PROCESSED_USSD]
!********************************
! Own msisdn Service
OWN_MSISDN_CMD

*#100#

OWN_MSISDN_TEXT

"0%s"

!
!********************************
! Own msisdn BSG Service

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

553

!
OWN_MSISDN_BSG_CMD

*#100*-

OWN_MSISDN_BSG_TEXT

"%s"

OWN_MSISDN_BSG_TOO_MANY_TEXT
requested"

"Too many MSISDNs

OWN_MSISDN_BSG_TOO_MUCH_TEXT
requested"

"Too much data

OWN_MSISDN_BSG_EMPTY_TEXT
specified service"

"No MSISDN for

OWN_MSISDN_BSG_INV_MMI_TEXT
code"

"Invalid service

OWN_MSISDN_BSG_INV_FORM_TEXT
Use *#100*XY# or *#100*#"

"Invalid format -

!
! *******************************
! HLR Node Name Service
!
HLR_ID_CMD

*#101#

HLR_ID_TEXT

"%s %04X %s"

!
! *******************************
! VLR Network Name Service
!
VLR_ID_CMD

*#102#

VLR_ID_TEXT

"%s %s"

VLR_ID_FAIL_TEXT
service unavailable"

"VLR network name

!
! *******************************
! Local Time

TIME_CMD

*#103#

TIME_TEXT

"%s"

TIME_FAIL_TEXT
unavailable"

"Local time service

Home Location Register (Linux) V1.1 Support Guide

554

Chapter 24 Table Maintenance

!
! *******************************
! MLR Node Name Service
!
MLR_ID_CMD

*#104#

MLR_ID_TEXT

"%s %s"

MLR_ID_FAIL_TEXT

"MLR Service Failed"

MLR_ID_NONE_TEXT

"No Mailbox"

MLR_ID_NOTU_TEXT

"No Voicemail"

!
! *******************************
! bureau service
!
SMSB_ON_CMD

*122#

SMSB_OFF_CMD

#122#

SMSB_ON_TEXT
On"

"Divert to Respond+

SMSB_OFF_TEXT
Off"

"Divert to Respond+

SMSB_FAIL_TEXT

"REQUEST FAILED"

SMSB_NO_SMS_BS
Service"

"Sorry, no SMS Basic

!
! *******************************
! Last Calling number service
!
!LAST_CALL_CMD1

*#1471#

LAST_CALL_CMD2

*#147#

NO_SRI_TEXT

"No calls since"

LAST_RESTRICTED_TEXT

"Number withheld"

LAST_NO_NUMBER_TEXT

"Number unavailable"

LAST_NOT_CONT_TEXT
controlled"

"Number not

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

555

LAST_SERVICE_FAIL_TEXT
failed"

"Last call service

LAST_SPEECH_TEXT

" "

LAST_FAX_TEXT

"F"

LAST_DATA_TEXT

"D"

!
! *******************************
! Voicemail Service
!
RECALL_CMD(0)

*#1210#

RECALL_CMD(1)

*#1211#

RECALL_CMD(2)

*#1212#

RECALL_CMD(3)

*#1213#

RECALL_CMD(7)

*#1217#

RECALL_CMD(8)

*#1218#

RECALL_CMD(9)

*#1219#

RECALL_RES(1)

"You have no mail box"

RECALL_RES(10)
cleared"

"Voicemail diverts

RECALL_RES(11)
clear failed"

"Voicemail diverts

RECALL_RES(12)
set"

"Voicemail diverts

RECALL_RES(13)
set failed"

"Voicemail diverts

RECALL_RES(14)
Voicemail diverts set"

"Unconditional

RECALL_RES(15)
"Unconditional
Voicemail diverts set failed"
RECALL_RES(16)
Voicemail diverts cleared"

"Unconditional

RECALL_RES(17)
"Unconditional
Voicemail diverts clear failed"
RECALL_RES(24)
use in the UK"

"Voice alert set for

Home Location Register (Linux) V1.1 Support Guide

556

Chapter 24 Table Maintenance

RECALL_RES(25)
failed"

"Voice alert set

RECALL_RES(26)

"SMS alert set"

RECALL_RES(27)
failed"

"SMS alert set

RECALL_RES(28)
set for use in the UK"

"Alert and deliver

RECALL_RES(29)
set failed"

"Alert and deliver

RECALL_FAIL_TEXT
service failed"

"Voicemail via USSD

RECALL_NOTU_TEXT

"No Voicemail"

RECALL_NONE_TEXT

"No mailbox"

!
! *******************************
! Failed command
!
UNKNOWN_TEXT

"Unknown command"

!
! *******************************
! Positioning service
MPS_ENABLED_CMD

*110#

MPS_DISABLED_CMD

#110#

MPS_QUERY_CMD

*#110#

!
MPS_ALL_SUPP_CTRL_TEXT
"Positioning
Allowed, Supported, Controllable"
MPS_ALL_NOTSUPP_CTRL_TEXT
"Positioning
Allowed, Not Supported, Controllable"
MPS_ALL_SUPP_NOTCTRL_TEXT
"Positioning
Allowed, Supported, Not Controllable"
MPS_ALL_NOTSUPP_NOTCTRL_TEXT "Positioning
Allowed, Not Supported, Not Controllable"
MPS_DIS_CTRL_TEXT
Disallowed, Controllable"

Home Location Register (Linux) V1.1 Support Guide

"Positioning

Chapter 24 Table Maintenance

557

MPS_DIS_NOTCTRL_TEXT
"Positioning
Disallowed, Not Controllable"
MPS_NOTCTRL_TEXT
Controllable"

"Positioning Not

!
!******************************
[RELAYED_USSD]
! Callback USSD
*#123*-"Callback"

CALLBACK_FAIL CALLBACK_GT

! *****************************
! MultiSim service
*#130# "LS Who am I"
LINKEDSUB_GT

LINKEDSUB_FAIL

*131#
"LS Nominate Me"
LINKEDSUB_GT

LINKEDSUB_FAIL

*131*- "LS Nominate SIM"


LINKEDSUB_GT

LINKEDSUB_FAIL

*#131# "LS Who Nominated"


LINKEDSUB_GT

LINKEDSUB_FAIL

!
!******************************
! PAYT service
*#134*#1345-

"PAYT Command 1"


"PAYT Command 2"

PAYT_FAIL

PAYT_GT

PAYT_FAIL

PAYT_GT

!
!******************************
! CT service
*4#

"Call Transfer"

CT_FAIL

CT_GT

!
! *****************************
!
[RELAYED_FAIL_TEXT]
LINKEDSUB_FAIL

"MULTI SIM SERVICE FAILURE"

Home Location Register (Linux) V1.1 Support Guide

558

Chapter 24 Table Maintenance

PAYT_FAIL

"\x01PAYT Service is not available"

CT_FAIL
available"

"\x01Call Transfer Service is not

CALLBACK_FAIL

"Service not currently available"

NGVM_GEN_FAIL "Setting Diverts Failed"


!
[GT PAYT_GT]
! Translation Type used, and SS of PAYT must be
supported
USE_PAP_TT

TRUE

MSISDN

MAIN

NOTUTEXT

"NOT APPLICABLE"

VERSION

MAP_V1

UNEXPECTED_DATA FAIL_TEXT
REQUIRED_SS

PREPAY_IC

GT 44385019300
!
[GT CT_GT]
!All USSD
selection

can be forwarded, there is no basis for

!be it SS, Service or selection criteria


MSISDN

CLI

VERSION

MAP_V1

UNEXPECTED_DATA FAIL_TEXT
GT 44385016333
!
[GT LINKEDSUB_GT]
MSISDN

MAIN

NOTUTEXT

"NOT APPLICABLE"

VERSION

MAP_V1

UNEXPECTED_DATA

FAIL_TEXT

REQUIRED_SERVICE MULTISIM

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

559

GT 44385016333
!
[GT CALLBACK_GT]
MSISDN

MAIN

NOTUTEXT
directly"

"Please dial the destination

VERSION

MAP_V1

UNEXPECTED_DATA

FAIL_TEXT

REQUIRED_SERVICE ROAMED
REQUIRED_SS

PREPAY_IC

GT 44385016450
!
!******************************
!
[RELAYED_TCPIP_USSD]
*#1211#
"Set dvts to mbx"NGVM_GEN_FAIL NGVM
NGVM_1211_REQ NGVM_GEN_RESP VMTYPE:NGVM
*#121*1# "Set dvts to mbx"NGVM_GEN_FAIL NGVM
NGVM_1211_REQ NGVM_GEN_RESP VMTYPE:NGVM
!
[ASP NGVM]
IP_ADDR

172.26.128.10

IP_PORT

710

SERVICE

/hlrussd

CLIENT_ID

HLRTEST2

CLIENT_PWD

ussd

CONNECTION_TYPE

SHARED

CONNECTION_TIMEOUT 10
CONTENT_TYPE

text/xml

!
[CVT_USSD NGVM_1211_REQ]
<?xml version="1.0" ?>

Home Location Register (Linux) V1.1 Support Guide

560

Chapter 24 Table Maintenance

<HLRUSSDRequest>
<subscriberID>%MSISDN%</subscriberID>
<ussdString>*#121*1#</ussdString>
</HLRUSSDRequest>
!
[CVT_RESP NGVM_GEN_RESP]
XML_RES

/HLRUSSDResponse/successIndicator

SUCCESS_VAL

true

XML_VAL

/HLRUSSDResponse/ussdResponse

USSD_RESP

"%XML_VAL%"

ALT_USSD_RESP

"Done"

!
!******************************
!
[REPLY_USSD]
*#104#
"Query mailbox number"
VMTYPE:NGVM

NGVM_ID

!
[REPLY_TEXT}
NGVM_ID

"Voicemail 0123456789"

voicemail Table
The voicemail.dat table contains Voicemail configuration data. It
defines the action that will be performed on receipt of a specific
shortcode. Such action depends on the value of the shortcode and the
subscribers Voicemail Type Indicator.

Table Format

[SRIACTIONS]
<Bnum> <vmtype> <Action> <AddData> <Flags>
.
.
.
[REGSSACTIONS]
<FTN> <vmtype> <Action> <AddData> <Flags>
.
.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

561

.
[INTSSACTIONS]
<Divert> <vmtype> <OwnResp> <OtherResp>
.
.
[DIVERT_FORMAT]
<vmtype> <Divert> <Flags>
.
.
.
[VMTYPE_vmtype]
CFNRY_TIMER <timer_value>
EOS_DIV_SUCCESS <div_success_value>
EOS_INT_ERROR <int_error_value>
.
.
.

[SRIACTIONS] section
This section shows the behaviour to shortcodes in an SRI message. If
the B number/vmtype combination is not listed here but the B number
matches some entry with a different vmtype, the message is forwarded
to the MLR with the B number untouched. If the B number does not
match any entry, the SRI is treated as a normal call.
Each line in this section contains the space seperated fields:
<Bnum> <vmtype> <Action> <AddData> <Flags>

Parameter

Description

<Bnum>

Defines the format of the B number to be matched in the incoming


SRI. The format is <NAI>/<Num>[MSISDN]
<NAI>

Nature of Address Indicator. One of:


+ (International E.164)
Net (Network E.164)
Nat (National E.164)
Unk (unknown E.164)
<hex><hex> (2 hex digits defining the NAI)

<Num>

Digits of the B number to match.

<MSISDN>

Optional. <MSISDN>, which represents


an MSISDN without a lead 0 or a country
code.

Home Location Register (Linux) V1.1 Support Guide

562

Chapter 24 Table Maintenance

Parameter

Description

<vmtype>

The vmtype to be matched in the incoming SRI. The value


OTHER indicates all vmtypes except those listed previously.

<Action>

Defines the action to be performed. One of:


FWDMLR

Forward SRI to MLR with B number


untouched. This is the default behaviour.
AddData must be NONE.

RESPRN

Respond with an SRI. AddData defines the


format of the RN.

SETDIV

Set conditional speech diverts to format of


AddData.NAI must be blank or Nul/.

CLEARDIV

Clear conditional or unconditional speech


diverts if the format matches AddData. NAI
must be blank or Nul/.

SETUNCDIV

Set unconditional speech diverts to the


format of AddData. NAI must be blank or
Nul/.

CLEARUNCDIV

Clear unconditional speech diverts if the


format matches AddData. NAI must be
blank or Nul/.

NORMSRI

Treat as a normal SRI. Note that


NORMSRI entries are ignored when
determining whether the B number is a
shortcode or a shortcode followed by
MSISDN, in order to look up the subscriber
in the database.

<AddData>

The format of this field depends on the action.


For RESPRN: <NAI>/<Num> [<MSISDN>]
For divert handling actions: [Nul/]<Num>[<MSISDN>]
For FWDMLR and NORMSRI: NONE
<NAI> and <Num> are as described for <Bnum>.
<MSISDN>: Optional. <MSISDN>, which represents an
MSISDN without a lead 0 or a country code. For a linked
subscriber, the MSISDN is that of the published number.

<Flags>

Defines a space-separated list of flags which control the


bahaviour of the action:
BTCVM

Identifies the BTCVM shortcodes so that


the appropriate counters can be set.

DACC

Identifies a BTCVM shortcode as Direct


Access so that the appropriate counter can
be set.

DDEP

Increment the voicemail direct deposit


counter.

PFXO

Only the prefix needs to match the


AddData format during a CLEARDIV or
CLEARUNCDIV operation. Otherwise the
MSISDN must match that of the subscriber.

RTVL

Increment the voicemail retrieval counter.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

563

[REGSSACTIONS] section
This section shows the behaviour to voicemail shortcodes in a
REGISTERSS MAP message. If the shortcode/vmtype combination is
not listed here (for example, 111), the shortcode will not be recognized
as a voicemail shortcode. SMSB and CLIR shortcodes are still defined
in hlr_config.dat.
Each line in this section contains the space seperated fields:
<FTN> <vmtype> <Action> <AddData> <Flags>

Parameter

Description

<FTN>

Defines the format of the FTN to be matched in the incoming


REGISTERSS. The format is <NAI>/<Num>[MSISDN]
<NAI>

Nature of Address Indicator. One of:


+ (International E.164)
Net (Network E.164)
Nat (National E.164)
Unk (unknown E.164)
<hex><hex> (2 hex digits defining the NAI)

<Num>

Digits of the FTN to match.

<MSISDN>

Optional. <MSISDN>, which represents


an MSISDN without a lead 0 or a country
code.

<vmtype>

The vmtype to be matched in the incoming REGISTERSS. The


value OTHER indicates all vmtypes except those listed
previously.

<Action>

Defines the action to be performed. One of:


RECALL

Send SRI to MLR with the B number set to


the MLR_LOOKUP value defined in
hlr_config.dat. Set the requested divert to
the returned mailbox. AddData must be
NONE.

GETMBX

Send SRI to MLR with the B number set to


the format AddData with a national NAI
and 0 inserted between the prefix and
<FTNMSISDN>. If the MLR responds with
a mailbox, this is stored in the requested
divert. Otherwise the requested divert is
set to the format of AddData.

SETDIV

Set requested diverts to the format of


AddData.

NORMREG

Treat as a normal FTN and not a voicemail


shortcode or voicemail shortcode followed
by MSISDN.

Home Location Register (Linux) V1.1 Support Guide

564

Chapter 24 Table Maintenance

Parameter

Description

<AddData>

The format of this field depends on the action.


For SETDIV and GETMBX: [Nul/]<Num>[<MSISDN> |
<FTNMSISDN>]
For RECALL and NORMREG: NONE
<Num> is as described for <FTN>.
<FTNMSISDN> is the text <FTNMSISDN>, which represents
the MSISDN without a lead 0 or country code. The MSISDN is
that used in the FTN.
<MSISDN>: Optional. <MSISDN>, which represents an
MSISDN without a lead 0 or a country code. For a linked
subscriber, the MSISDN is that of the published number.

<Flags>

Defines a space-separated list of flags which control the


bahaviour of the action:
REC1

Increment the RECALL 1 Lookup counter.

REC2

Increment the RECALL 2 Lookup counter.

REC3

Increment the RECALL 3 Lookup counter.

[INTSSACTIONS] section
This section defines the behaviour when an INTERROGATESS
message is used to examine a divert. If the divert/vmtype combination
is not listed here (for example, 1571<MSISDN>), the divert will be
returned in the response as stored. The NAI and any prefixes will
depend on the supplementary services defined.
Each line in this section contains the space seperated fields:
<Divert> <vmtype> <OwnResp> <OtherResp>
Parameter

Description

<Divert>

Defines the format of the stored divert to be matched. The format


is <Num>[MSISDN]

<vmtype>

<Num>

Digits of the divert to match.

<MSISDN>

Optional. <MSISDN>, which represents


an MSISDN without a lead 0 or a country
code.

The vmtype to be matched. The value OTHER indicates all


vmtypes except those listed previously.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

565

Parameter

Description

<OwnResp>

Defines the format of the response if the divert does not contain
an MSISDN, or if the MSISDN in the divert is the subscribers
MSISDN (or that of the published number, for a linked
subscriber).
The format of this field is:
<NAI>/<Num>[<MSISDN>], where <NAI> is the Nature of
Address Indicator. One of:
+ (International E.164)
Net (Network E.164)
Nat (National E.164)
Unk (unknown E.164)
<hex><hex> (2 hex digits defining the NAI)

<OtherResp>

Defines the format of the response if the MSISDN in the divert is


not the subscribers MSISDN. The format is the same as
<OwnResp>.

[DIVERT_FORMAT] section
This section defines the format of Voicemail diverts for each voicemail
type. It is used when setting and clearing diverts using the
UPDATE:SUB,VMTYPE admin command. It is also used to validate the
erasing of diverts by a Voicemail box using the ERASESS message.
Each line in this section contains the space seperated fields:
<vmtype> <Divert> <Flags>
Parameter

Description

<vmtype>

The vmtype to be matched. Cannot take the values OTHER or


NONE.

<Divert>

Defines the format of the stored divert to be matched. The format


is <Num>[MSISDN]

<Flags>

<Num>

Digits of the divert to match.

<MSISDN>

Optional. <MSISDN>, which represents


an MSISDN without a lead 0 or a country
code. For linked subscribers, the MSISDN
is that of the published number.

Defines a space-separated list of flags which control the


bahaviour of the UPDATE:SUB,VMTYPE command.:
PFXO

Only the prefix needs to match the Divert


format when clearing diverts. Otherwise,
the MSISDN must match that of the
subscriber.

[VMTYPE_vmtype] section
The following sections define vmtype-specific defaults. The table can
have a separate section for each defined vmtype.

Home Location Register (Linux) V1.1 Support Guide

566

Chapter 24 Table Maintenance

Replace vmtype in the section header with the actual vmtype, or


OTHER.The values under the section VMTYPE_OTHER are used if
none is defined for a specific vmtype.
In each section, the following may be defined:
Parameter

Description

CFNRY_TIMER

Timer value (in seconds) to use when setting the CFNRY


divert. 5 to 30 in multiples of 5. Default is 15.

EOS_DIV_SUCCESS

End of selection code to send if the diverts have been


successfully changed using an SRI shortcode. Dafault is
1067.

EOS_INT_ERROR

End of selection code to send if the diverts were not


updated due to an internal software error. Default is 1051.

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

Example

567

:
[SRIACTIONS]
!BNum
Nat/1571
Nat/15710
Nat/15711
Nat/15712
Nat/15713
Nat/1571
Nat/15710
Nat/15711
Nat/15712
Nat/15713
Nat/121
Nat/1210
Nat/1211
Nat/1212
Nat/1213
Nat/1214
Nat/1215
Nat/1217
Nat/1218
Nat/1219
Nat/1210<MSISDN>
Nat/12144<MSISDN>
Nat/21212
Nat/21212
Nat/242

vmtype
BTCVM
BTCVM
BTCVM
BTCVM
BTCVM
OTHER
OTHER
OTHER
OTHER
OTHER
NGVM
NGVM
NGVM
NGVM
NGVM
NGVM
NGVM
NGVM
NGVM
NGVM
NGVM
NGVM
NGVM
OTHER
OTHER

[ RE G SS AC T IO N S]
! FT N
U nk / 15 71
U nk / 12 1
U nk / 12 1
U nk / 24 2
U nk / 15 71
U nk / 12 10 < MS I SD N >
U nk / 12 10 < MS I SD N >
U nk / 12 14 4 <M S IS D N>
U nk / 12 14 4 <M S IS D N>

Action
AddData
RESPRN
+/01571<MSISDN>
CLEARDIV
Nul/1571<MSISDN>
SETDIV
Nul/1571<MSISDN>
SETUNCDIV Nul/1571<MSISDN>
CLEARUNCDIV Nul/1571<MSISDN>
FWDMLR
NONE
FWDMLR
NONE
FWDMLR
NONE
FWDMLR
NONE
FWDMLR
NONE
RESPRN
Nat/121A<MSISDN>
RESPRN
Nat/1210<MSISDN>
RESPRN
Nat/1211<MSISDN>
RESPRN
Nat/1212<MSISDN>
RESPRN
Nat/1213<MSISDN>
RESPRN
Nat/1214<MSISDN>
RESPRN
Nat/1215<MSISDN>
RESPRN
Nat/1217<MSISDN>
RESPRN
Nat/1218<MSISDN>
RESPRN
Nat/1219<MSISDN>
RESPRN
Nat/121B<MSISDN>
RESPRN
Nat/121B<MSISDN>
RESPRN
Nat/121C<MSISDN>
RESPRN
Nat/21212
FWDMLR
NONE

v mt y pe
B TC V M
N GV M
O TH E R
O TH E R
O TH E R
B TC V M
O TH E R
B TC V M
O TH E R

A ct i on
S ET D IV
S ET D IV
R EC A LL
R EC A LL
R EC A LL
N OR M RE G
G ET M BX
N OR M RE G
G ET M BX

[INTSSACTIONS]
!Divert
vmtype OwnResp
121<MSISDN>
NGVM
Unk/121
[DIVERT_FORMAT]
!vmtype
Divert
BTCVM
1571<MSISDN>
NGVM
121<MSISDN>

[VMTYPE_OTHER]
CFNRY_TIMER
EOS_DIV_SUCCESS
EOS_INT_ERROR

15
1067
1051

[VMTYPE_BTCVM]
CFNRY_TIMER
EOS_DIV_SUCCESS
EOS_INT_ERROR

15
1067
1051

[VMTYPE_NGVM]
CFNRY_TIMER

15

Flags
BTCVM DACC
BTCVM PFXO
BTCVM
BTCVM PFXO
BTCVM
BTCVM
BTCVM
BTCVM
BTCVM
BTCVM
RTVL

DDEP
DDEP

Ad dD a ta
15 71 < MS I SD N >
12 1< M SI S DN >
NO NE
NO NE
NO NE
NO NE
12 1< F TN M SI S DN >
NO NE
12 1< F TN M SI S DN >

F la gs

R EC 1
R EC 2
R EC 3

OtherResp
Unk/1210<MSISDN>

Flags
PFXO

Home Location Register (Linux) V1.1 Support Guide

568

Home Location Register (Linux) V1.1 Support Guide

Chapter 24 Table Maintenance

569

Appendix A Using PULSE


PULSE is a platform monitoring tool which collects data and displays it
from the pds_manager account, according to text-based Screen
Definition Files (SDFs). This appendix explains how to:
Generate the screen definition files (SDFs) that PULSE uses to
display information (see Setting Up PULSE on page 570)
Start PULSE and navigate through the menu tree (see PULSE
Menu Tree on page 573)
For how to access the pds_manager account, see page 83.

Home Location Register (Linux) V1.1 Support Guide

570

Appendix A Using PULSE

Setting Up PULSE
If PULSE has not been pre-configured, the screen definition files
(SDFs), which define PULSE displays, must be generated.

Network Entity Information


The screen definition files (SDFs) used for Network Entities are
generated by a utility. If you use REPLACE:TABLE to update the
Network Entity (netent) Table the utility is run automatically.
You can run the utility manually, from the pds_manager account by
entering:
/opt/vodafone/pds/libexec/pdsu_create_ne_menu

Home Location Register (Linux) V1.1 Support Guide

Appendix A Using PULSE

571

Starting PULSE
To start PULSE enter:
pulse
The PULSE Main Menu (shown in Figure 64) is displayed.
Figure 64. PULSE Main Menu

PULSE consists of several screens, each with the same general layout.
Select the option you require by pressing the key corresponding to the
highlighted letter for that option.

Node Information
PULSE displays information about the node below the main menu.
PULSE
Information

Values

Description

Type

Distributed
Monolithic

Distributed - fault-tolerant platform with more than one node


Monolithic - standalone single-node platform

Startup

Cold (as Live)


Warm (as Standby)

Cold (as Live) - the live node started up as the live node
Warm (as Standby) - the live node became the live node as
the result of a cutover

Home Location Register (Linux) V1.1 Support Guide

572

PULSE
Information
State

Appendix A Using PULSE

Values

Description

Starting
Live
Standby
Cutover (Going Live)
Live (Standby Failed)
Live (Standby Ready)

Starting - node is starting up


Live - live node in a single node platform
Standby - standby node in a distributed platform
Cutover (Going Live) - node is starting as live because of a
cutover
Live (Standby Failed) - live node that is also running the
maintenance process (MP). The standby node is not running
Live (Standby Ready) - live node that is not running the
maintenance process (MP). The standby node is running

PULSE Information
PULSE can run in different display modes and the time between
PULSE screen updates can be set when PULSE is started.
Node
Information

Values

Description

Time

Time of day in
HH:MM:SS DDMMM-YYYY format

Time when the PULSE screen was last updated

Mode

ACTUAL
DELTA
SCREEN

ACTUAL - the actual value of the data is shown.


DELTA - the difference between the last and the current data value
is shown. This is good indication of system activity.
SCREEN - the accumulated totals of the data values since the
PULSE screen was activated are shown.
Use <return> on any screen to cycle between display modes.

Rate

0 to 86399 (24
hours)

Number of seconds between updates of PULSE screens. Defined


when PULSE is started by entering pulse -r rate

Moving to other
Screens

A status bar along the bottom of each screen identifies the function
keys which you can use to change to another screen or return to the
main menu.
Note: The function keys differ according to the screen displayed. Be
careful to choose the one you want.

Exiting PULSE

Exit PULSE by entering:


CTRL+Z

Home Location Register (Linux) V1.1 Support Guide

Appendix A Using PULSE

573

PULSE Menu Tree


Summary Menu

General

Gives an overview of platform messages,


administration commands and database use. See
page 574 for a description of this screen.

Activity

Gives a regularly updated summary of message


activity in and out of the HLR.

Traffic
Admin
Incoming Calls
Registration and Roaming
Details Menu

Information on HLR Application


(HLRA)

Displays counters for various transactions.

Information on HLR Database (HLRD)

Displays counts of events that involved the HLR


database.

Information on signalling interface


Information on Current Admin. Clients
(ADMP)
Admin. Client History (ADMI)
Admin. Command Information
(ADMA)
Run Time System (RTIS)
Management Application (MGTA)
Log files (LOGGER)

Displays the status of logging events to the event


logging file. See page 575

Network Entities
SIGTRAN

Displays the names and Global Titles of entities


connected to the HLR
M3UA index
SCCP information
SCCP Q752 information
HSSP signalling information
HSSP traffic information IPSP
HSSP user distribution
Association states
M3UA SGP states ASP_SG
Association states ASP-SG
PC information

Home Location Register (Linux) V1.1 Support Guide

574

Appendix A Using PULSE

PULSE Summary
Counts on the summary screen to indicate whether the platform is
overloaded and is processing messages and administration
commands.
Figure 65. HLR Summary Screen
GENERAL HLR SUMMARY
a
MAP ind
b
SS7I
ADMIN INTERFACE
upl
213798348 free
1951
d
ADM Application
sri
227643661 in use
49 Total commands
3263197
snp
210541 hlra not idle
48
e
Cmds issued per session
nms
733964 Allocate OK
1177692243 No.sessions <10 cmds
213776
ssm
21182087 Allocate Fail
0 No.sessions 10..20 cmds
10704
smw
390032 Octets TX
2689209523 No.sessions 20..30 cmds
3199
rsd
560711 Octets RX
3147581249 No.sessions 30..40 cmds
4428
sai
258781313 MSU TX
1578244086 No.sessions 40..50 cmds
3866
bsa
3577516 MSU RX
1577386882 No.sessions >50 cmds
6851
reg
604417 Excess Load
0
era
824253 BEP Shed
0
f
DATABASE
pus
12248388 No Task
0 Performance totals
a
MAP req
Overload Active
False Requests
1734947871
cnl
203450678 Overload Events
0 Success
885042610
isd
1099424 INBQ Length
0 Granted
748483404
dsd
47336 INBQ High Water
990 Released
98465705
prn
220473131 INBQ Last Peak
439 Queued
839608
asc
1167986
c
Network Entities
bsa
934 NE[0] OPEN
322 entries
Secure requests
67022
pus
934 NE[1] CLOSED
Securing
F6:Previous
|F7:Next
|F8:Details menu|F9:Summary menu|F10:Main menu

Signalling

The Signalling section summarizes the tasks available to process


incoming and outgoing messages. In Figure 65, 1951 tasks are free to
process messages. All tasks might be used if a large number of
messages arrive at the platform and these incoming messages cause
the platform to generate a large number of outgoing messages.
The Allocate Fail count may be non-zero on system startup. However, if
it continues to increase, a traffic overload may have caused the
platform to run out of free tasks, a software fault may have occurred, or
one or more entities may be taking a long time to respond.
Octets TX, Octets RX, MSU TX and MSU RX give totals of data
transmitted and received in terms of 8-bit octets and message
signalling units (MSUs). If these counts are not increasing, the platform
is not receiving and/or transmitting messages.
Overload Active indicates whether the platform is discarding messages
because the platform has reached its limit of message traffic that it can
process.

Home Location Register (Linux) V1.1 Support Guide

Appendix A Using PULSE

575

Overload Events counts the number of times that an overload event


occurs, where the platform has reached the limit of message traffic that
it can process.
INBQ Length means inbound queue length and is the number of
messages waiting to be processed by the platform and INBQ High
Water shows the highest value reached by INBQ Length.

DATABASE

The Requests count indicates the number of read/write operations to


the database. Use <return> or CTRL+M to select DELTA mode to
check how many times the database is being accessed per PULSE
sampling period. A few requests per transaction is normal.

ADMIN Interface

Total commands is the number of administration commands processed


by the platform. If this count is not increasing, then the platform is not
processing administration commands.

Cmds Issued Per


Session

Each administration interface command session is opened, processes


some commands, and then closes. This section categorizes
administration sessions depending on how many commands were
processed. Typically, sessions used for support or customer care will
have a low command count and sessions used to connect or modify
subscribers will have a high command count.
Note: The number of administration sessions open at one time is
limited. If all available sessions are being used, customer care and
support staff will be unable to open a new administration session.

Figure 66. Main Menu > Details Menu > Log files (LOGGER)

This screen summarizes logging of events to file


PDS.log.log_file_no in the directory /opt/vodafone/pds/log.

Home Location Register (Linux) V1.1 Support Guide

576

Home Location Register (Linux) V1.1 Support Guide

Appendix A Using PULSE

577

Appendix B Interpreting SCCP Addresses


A Calling Party Address (the message source) or Called Party Address
(the message destination) are sometimes provided by the HLR in an
alarm message or event log file.
Note: These SCCP addresses are provided by SIGTRAN to the HLR
application and are not necessarily identical to those used on the live
network. Source address point codes may be changed or inserted.
There is also an MTP3 point code, which is not visible in a SCCP
address, but which may be used for routing.
Addresses are displayed either:
formatted, if the HLR application can decode the raw SCCP address
unformatted, if the HLR application cannot decode the raw SCCP
address.
The following sections describe these address formats.

Home Location Register (Linux) V1.1 Support Guide

578

Appendix B Interpreting SCCP Addresses

Formatted SCCP Addresses


A formatted address is displayed as:
<ROUTING_INDICATOR><POINT_CODE><SUB_SYSTEM_NUMBER>
.<GT_FORMAT>.<GT>

Example

Address Component

Contents

ROUTING_INDICATOR

Shows if the message is being routed by Global


Title, Point Code or Sub-System Number.

POINT_CODE (PC)

The Point Code used to access the entity. (This is


not always displayed.)

SUB-SYSTEM
NUMBER

The type of entity

GT_FORMAT

Shows if the Global Title displayed is in E.164 or


E.214 (IMSI-derived) format.

GT

The Global Title of the entity, in either national or


international format.

The Calling Party Address:


GT(807)VLR.E164.+44385016807
indicates a message which has been sent by a VLR with an E.164
Global Title of +44385016807. The message is routed on Global Title
using Point Code 807.

Home Location Register (Linux) V1.1 Support Guide

Appendix B Interpreting SCCP Addresses

579

Unformatted SCCP Addresses


An unformatted address is displayed as a numeric string. This string
can be interpreted to determine the following information about the
source/destination entity:
Point Code (PC)
Sub-System Number (SSN)
Global Title (GT).
This section illustrates how to analyse SCCP addresses, using two
examples:
13250307001204947101350000 (Figure 67)
5206001104443204729001 (Figure 68)
The address consists of these components: address format, PC,
SSN, GT format and GT.
The digits in the PC and GT components must be manipulated as
shown.
The values and meanings of the address format, SSN and GT
format components are shown.

Home Location Register (Linux) V1.1 Support Guide

580

Appendix B Interpreting SCCP Addresses

Figure 67. Interpreting the Example Source SCCP Address


Source address is: 13250307001204947101350000
Address format
PC
SSN
1
3

2
5

0
3

0
7

GT format

0
0

0
4

Global Title (GT)

2 - All digits of GT are significant.


1 - Ignore the last digit of the global
title.
1 - E.164 Global Title
7 - E.214 (i.e. IMSI-derived) Global Title

06 - HLR
07 - VLR
08 - MSC
09 - EIR
10 - AUC

0
3

2
5

= 0x0325 hexadecimal = 805 decimal

13 = Address comprises PC, SSN, GT (Route on Global Title)


52 = Address comprises SSN, GT (Route on MTP3 Point Code - not shown in SCCP message)
43 = Address comprises PC, SSN (Route on SCCP Point Code)

The message source is a VLR with E.164 GT +491710530000, accessible via


SCCP PC 805. The message is routed on Global Title.
Figure 68 illustrates the same analysis applied to the destination
address.
Note: The last digit of the GT (the last but one digit of the GT
component - a 0) is discarded, and that the message is routed on the
MTP3 Point Code (which is not displayed as part of the SCCP
message).

Home Location Register (Linux) V1.1 Support Guide

Appendix B Interpreting SCCP Addresses

581

Figure 68. Interpreting the Example Destination SCCP Address


Destination address is: 5206001104443204729001
Address format
PC
SSN
5
2

0
6

0
0

GT format

0
4

Global Title (GT)

1- Ignore last digit of Global Title

1- E.164 Global Title

06 - HLR
07 - VLR
08 - MSC
09 - EIR
10 - AUC

There is no PC supplied in this address

52 = Address comprises SSN, GT (Route on MTP3 Point Code - not shown in SCCP message)

The message destination is the HLR with E.164 GT +4423402709191. No SCCP PC is


supplied. The message is routed on MTP3 PC.

Home Location Register (Linux) V1.1 Support Guide

582

Appendix B Interpreting SCCP Addresses

Home Location Register (Linux) V1.1 Support Guide

583

Appendix C Time Synchronization


The standardized VodaSCP platform uses Network Time Protocol
(NTP) software to synchronise the system time to another server or
reference source providing co-ordinated universal time (UTC), such as
radio, satellite receiver or modem. NTP is typically accurate to within a
few tens of milliseconds per day.
Figure 69. Time Synchronization Using NTP

Time Server

Time Server

Time Server

Time Server

VodaSCP systems

Home Location Register (Linux) V1.1 Support Guide

584

Appendix C Time Synchronization

SET TIME
On nodes that do not have NTP, users can set the system time from the
pds_manager login (described below).
Setting the time immediately sets the node time to the specified value.
You should set the time only on the standby node.

Using
pds_manager

To set the node time, enter:


date --set yyyymmdd hh:mm:ss
where:
yyyy = the year
mm = the month, for example 01 = January
dd = the day date, for example 01
hh = the hour
mm = the minutes
ss= the seconds

Using SET TIME


on an NTP Node

If you use the date command to change the time on a node that uses
NTP:
if you set it to be an hour or less different from the NTP time (in
either direction), the system time gradually returns to the time
defined by the time server.
if you set it to be more than an hour different from the NTP time (the
exact number of seconds is defined in the NTP software
documentation), the NTP software shuts down and the time on the
node is no longer under its control.
You are strongly discouraged from doing this.

Home Location Register (Linux) V1.1 Support Guide

585

Appendix D Backing-up the HLR


Database
This appendix describes the database backup mechanisms used by
the Linux GSM HLR.

Overview
When the live node starts, it loads the database specified in the
[HLR_MAPPING] section of the pds_defs.dat table. It loads the
database from the file:
$shrdir/log_db_name_HLRD_FILE

Creating a New Database


To create a new database, use the following command:
hlru_dbinit log_db_name
For example:
hlru_dbinit LHDB01
This creates the file:
$shrdir/LHDB01_HLRD_FILE
The size of the database (that is, the number of records in each table,
and so on) is determined by the file $cfgdir/db_size.dat.

Home Location Register (Linux) V1.1 Support Guide

586

Appendix D Backing-up the HLR Database

Automatic Secure to Disk Mechanism


The HLR regularly copies any changes to the database (resulting from
network or administration centre activity) back to the disk file
logical_db_name_HLRD_FILE.

Automatic Backup Mechanism


The HLR automatically creates regular backups of the database.
The automatic backup is performed by the HLRD process, on the live
node.
1. The HLRD process backs up the current database file
logical_db_name_HLRD_FILE to
logical_db_name_HLRD_SAVED.BK1 or
logical_db_name_HLRD_SAVED.BK2 (preserving the most up-todate- backup, and overwriting the expired one), in the /opt/
vodafone/pds/data directory.
2. The HLRD process informs the maintenance process (MP) when the
backup is completed.
3. The MP process invokes the pds_i_mp sub-process.

Home Location Register (Linux) V1.1 Support Guide

Appendix D Backing-up the HLR Database

587

pds_i_mp Sub-Process
The pds_i_mp sub-process:
1. Performs a consistency check on the
logical_db_name_HLRD_SAVED.BKn file backed up by the
HLRD process:
- If the consistency check passes, pds_i_mp marks the backup as
valid and resets the backup indicator file
logical_db_name_GOODBACKUPIS.BKn, as shown in
Table 57.
Table 57. Backup Status After a Successful Consistency Check
File Backed Up by
HLRD

Valid Backup

Backup Indicator

logical_db_
name_

logical_db_
name_HLRD_SAVED

logical_db_name
_GOODBACKUPIS.BK1

HLRD_SAVED.BK1

.BK1

logical_db_
name_

logical_db_
name_HLRD_SAVED

D_SAVED.BK2

.BK2

logical_db_name
_GOODBACKUPIS.BK2

If the check shows inconsistencies, pds_i_mp raises a 2357


BACKUP_DATABASE_CORRUPT alarm.
Table 58 shows the backup status after a failed consistency check.
Table 58. Backup Status After a Failed Consistency Check
File Backed Up by
HLRD

Valid Backup

Backup Indicator

logical_db_
name_

logical_db_
name_HLRD_SAV

logical_db_name
_GOODBACKUPIS.BK2

HLRD_SAVED.BK1

ED.BK2

logical_db_
name_

logical_db_
name_HLRD_SAV

HLRD_SAVED.BK2

ED.BK1

logical_db_name
_GOODBACKUPIS.BK1

2. If the secondary backup filelogical_db_name_ HLRD_FILE.BAK


exists, pds_i_mp does nothing.
Iflogical_db_name_ HLRD_FILE.BAK does not exist,
pds_i_mp:
i. Copies the valid backup to the filelogical_db_name_
HLRD_FILE.TMP.
ii. On completion of the copy, renameslogical_db_name_
HLRD_FILE.TMP tological_db_name_ HLRD_FILE.BAK in
the same directory.

Home Location Register (Linux) V1.1 Support Guide

588

Secondary
Backup File

Appendix D Backing-up the HLR Database

The secondary backup file,logical_db_name_ HLRD_FILE.BAK, is


used to make external backups of the database (see below). It is
created fromlogical_db_name_ HLRD_FILE.TMP only after a valid
backup has been copied. This ensures thatlogical_db_name_
HLRD_FILE.BAK contains a complete record of the database, and
prevents an external backup being made of a file that is still being
written.
Note: Using the mv command rather than cp keeps files contiguous,
preventing disk fragmentation.

Standby Node
The standby node has no access to the database files on the live node.
Therefore, the standby node needs to maintain its own copy of the
database.
When the standby node starts, it checks the [HLR_MAPPING] section
of the pds_defs.dat table to determine which logical database it
should synchronize from the live side.
If you have just create/copied a new logical database file on to the live
node, the standby node should start with no database file at all, or with
a copy of the same database file (or a renamed copy of any one of its
backup files from the live node). If there is no database file, the standby
node will create a new file.
The standby node establishes a connection with the live side through
which it receives regular updates. The standby node, just like the live
node, secures, backs up and checks consistency of its own database
files.
Note: Do not use the hlru_dbinit command to create the database for
the standby node. Each database file created with hlru_dbinit has a
unique id and you will not be able to use two files created with the same
logical database name for live/standby operation. You should therefore
start the standby node with nothing or a copy of the file from the live
node.

Home Location Register (Linux) V1.1 Support Guide

Appendix D Backing-up the HLR Database

589

External Backup Procedure


In addition to the HLRs automatic backup mechanism, regular external
backups of the HLR database must be made to ensure that the
database can be successfully restored if required (for example, in the
event of a major RAID array failure).
The external backup process is performed using a daily cron job which:
1. Renames the filelogical_db_name_ HLRD_FILE.BAK
tological_db_name_ HLRD_FILE.TMP in the /opt/vodafone/
pds/data/register_backup directory. This ensures that
pds_i_mp process creates an up-to-date copy of the database after
the next automatic backup (see page 586).
2. Waits a few minutes until the automatic backup mechanism recreateslogical_db_name_ HLRD_FILE.BAK.
3. Copies the filelogical_db_name_ HLRD_FILE.BAK from the /
opt/vodafone/pds/data/register_backup directory to a
different system.
Note: The system acting as a database repository must have
passwordless sftp enabled on it. The offnode_db_backup script
performs the actual backup. Edit this file to change the remote backup
node, account, and directory.

Determining the Valid Backup


To find out which backup copy of the database is currently valid (for
example, before restoring the database from a backup copy):
Determine the current status of the database backups by looking at
the backup indicator file logical_db_name_GOODBACKUPIS.BKn
in the /opt/vodafone/pds/data directory, as shown in Table 57
on page 587.
Determine when this backup was made by looking at the modified
date of logical_db_name_GOODBACKUPIS.BKn.

Home Location Register (Linux) V1.1 Support Guide

590

Appendix D Backing-up the HLR Database

Home Location Register (Linux) V1.1 Support Guide

591

Appendix E Basic and Supplementary


Services
This appendix lists the Basic and Supplementary Services used by the
HLR.

Basic Services
Table 59 lists the Basic Service Groups and Basic Services supported
by the HLR:
Basic Service Group codes are used with Administration
commands. See Chapter 9, Administration Interface.
Telephony Services are prefixed TS.
Bearer Services are prefixed BS.
Table 59. Supported Basic Service Groups and Basic Services
Bit

Basic Service Group

Bit

Basic
Service

Description

Speech - SPEECH

TS11

Telephony

TS12

Emergency

TS21

Short message, mobile terminated

TS22

Short message, mobile originated

TS23

Cell broadcast

TS61

Alternate speech and facsimile Group


3

TS62

Automatic facsimile Group 3

Short Message Service - SMS

Facsimile - FAX

Home Location Register (Linux) V1.1 Support Guide

592

Appendix E Basic and Supplementary Services

Table 59. Supported Basic Service Groups and Basic Services (Continued)
Bit

Basic Service Group

Bit

Basic
Service

All Data Circuit - Async - DCICA


(BS21 to BS26 mutually exclusive
to BS20)

32

BS20

High Speed Circuit Switched Data HSCSD (mutually exclusive to BS21


to BS26). Allows one data call to use
more than one traffic channel, giving
speeds over 9.6kbit/s.

BS21

Data circuit, duplex asynchronous 300


bit/s

BS22

Data circuit, duplex asynchronous


1200 bit/s

BS23

Data circuit, duplex asynchronous


1200/75 bit/s

10

BS24

Data circuit, duplex asynchronous


2400 bit/s

11

BS25

Data circuit, duplex asynchronous


4800 bit/s

12

BS26

Data circuit, duplex asynchronous


9600 bit/s

13

BS61A

Alternate speech/unrestricted data


(async)

14

BS81A

Speech followed by data (async)

15

BS31

Data circuit, duplex synchronous 1200


bit/s

16

BS32

Data circuit, duplex synchronous 2400


bit/s

17

BS33

Data circuit, duplex synchronous 4800


bit/s

18

BS34

Data circuit, duplex synchronous 9600


bit/s

19

BS61S

Alternate speech/unrestricted data


(sync)

20

BS81S

Speech followed by data (sync)

33

BS30

Video Telephony (mutually exclusive


to BS31 to BS34). 64kbps data to
allow video with voice calls

All Data Circuit - Sync - DCICS


(BS31 to BS34 mutually exclusive
to BS30)

Home Location Register (Linux) V1.1 Support Guide

Description

Appendix E Basic and Supplementary Services

593

Table 59. Supported Basic Service Groups and Basic Services (Continued)
Bit

Basic Service Group

Bit

Basic
Service

All PAD Access - PADACC

21

BS41

PAD access circuit, asynchronous 300


bit/s

22

BS42

PAD access circuit, asynchronous


1200 bit/s

23

BS43

PAD access circuit, asynchronous


1200/75 bit/s

24

BS44

PAD access circuit, asynchronous


2400 bit/s

25

BS45

PAD access circuit, asynchronous


4800 bit/s

26

BS46

PAD access circuit, asynchronous


9600 bit/s

27

BS51

Data packet, duplex synchronous


2400 bit/s

28

BS52

Data packet, duplex synchronous


4800 bit/s

29

BS53

Data packet, duplex synchronous


9600 bit/s

All Data Packet - DPACK

Description

12kbit/s Unres. Digital - UNREST

30

BS71

12 Kbit/s unrestricted digital

Auxiliary Speech (AUXSPEECH)

31

TSD1

Dual numbering

Note: For bit numbers of basic services and basic service groups in
the HLR database, see Basic Services on page 611 in Appendix G,
Attribute Bit Numbers in the Subscriber Database.

Home Location Register (Linux) V1.1 Support Guide

594

Appendix E Basic and Supplementary Services

Supplementary Services
Table 60 lists the supplementary services supported by the HLR. The
Supplementary Service codes are used with Administration
commands. See Chapter 9, Administration Interface.
Table 60. Supported Supplementary Services
Supplementary
Service

Meaning

Description

ADD

Automatic
Device
Detection

Allows systems to be configured for subscribers, before they use the


services provided by them. For example, can be used by Automatic
Device Configuration (ADC) to configure phones correctly based on
their capability.

AOCI

Advice of
Charge

Allows the mobile to calculate the cost of the call. There are two
versions:
Information. Calculate the cost in real time for display as the
charge is incurred. (The MSC does not require an
acknowledgement from the mobile station.)
Charging. Calculate the cost for private charging purposes, for
example: a hire-phone. (The MSC requires an acknowledgement
from the mobile station.)
The two variants of this service, Information and Charging, are
mutually exclusive.

ARSENIC

Ability to
Register
Special/
Extended
Numbers in
Call-forwards

Allows a subscriber to register a divert (FTN) to a number that would


not normally be allowed (such as an extension number). This
number is a Special/Extended (SE) type (see Forward-To Number
Behaviour Modes on page 8). If this service is provisioned, the FTN
is marked as having SE behaviour and the HLR will initiate an SRI to
another platform to enquire how the divert should proceed. If a
subscriber has this service provisioned and the FTN can be
translated to an international number, the [CNUMSE] section of the
C-number table is by-passed and the [CNUM0] section is checked
instead.
The ARSENIC service needs special local network capabilities and
is therefore an unsupported supplementary service on all foreign
VLRs and PLMNs. However, a subscriber with CAMEL phase 2
subscription data and the TIF_CSI flag set to TRUE can divert to
Special/Extended numbers when roamed, if the visited network
supports CAMEL phase 2.

BAIC

Barring
Incoming
Calls

BICROAM

Bar Incoming
Calls when
Roamed
outside home
country

This service may prevent incoming calls including those forwarded to


the subscriber. The service may be provisioned with any combination
of two different barring programs:
All incoming calls
All incoming calls when roamed outside the home PLMN
For each basic service group the service may be applied with any
provisioned barring program.
The subscriber may be granted permission to control both incoming
and outgoing call barring by using a password (supplementary
service barring), or this may be restricted to the service provider
(operator determined barring, ODB).

AOCC

Home Location Register (Linux) V1.1 Support Guide

Appendix E Basic and Supplementary Services

595

Table 60. Supported Supplementary Services (Continued)


Supplementary
Service

Meaning

Description

BAOC

Barring of
Outgoing
Calls

BOIC

Bar Outgoing
International
Calls

BOICXHC

Bar Outgoing
International
Calls except
to Home
Country

Prevents outgoing calls from the subscriber, including forwarding of


incoming calls. The service may be provisioned with any
combination of three different barring programs:
All outgoing calls
All outgoing international calls
All outgoing international calls except those to the home PLMN
country
For each basic service group the service may be applied with any
provisioned barring program.
The subscriber may be granted permission to control both incoming
and outgoing call barring by using a password (supplementary
service barring), or this may be restricted to the service provider
(operator determined barring, ODB).

CFB

Call
Forwarding
on MS Busy

Allows the subscriber to redirect incoming calls to another number if


the subscriber is already busy with another call. The service can be
configured to notify or not notify the calling party, and/or the
forwarding party, of the redirection.

CFNRC

Call
Forwarding
on Not
Reachable

Allows the subscriber to redirect incoming calls to another number if


the subscriber is not reachable. The service can be configured to
notify or not notify the calling party of the redirection.

CFNRY

Call
Forwarding
on No Reply

Allows the subscriber to redirect incoming calls to another number if


the subscriber does not answer the call within a specified time. The
service can be configured to notify or not notify the calling party, and/
or the forwarding party, of the redirection.

CFU

Call
Forwarding
Unconditional

Allows the subscriber to redirect all incoming calls to another


number. The service can be configured to notify or not notify the
calling party of the redirection.

CLIP

Calling Line
Identification
Presentation

Allows a subscriber to display a callers directory number, unless


prevented from doing so by the caller.

CLIR

Calling Line
Identification
Restriction

Allows a subscriber to prevent their directory number being


displayed by the called party. The restriction can be permanently
applied to all calls.

COLP

Connected
Line
Identification
Presentation

Allows a subscriber to display a called number, unless prevented


from doing so by the called party. This is useful if calls are diverted or
one published number connects to many member numbers.

COLR

Connected
Line
Identification
Restriction

Allows a subscriber to prevent their directory number being


displayed by the calling party. The restriction can be permanently
applied to all calls.

CW

Call Waiting

Allows the subscriber to be notified of an incoming call when they are


busy with another call.

DCFB

Default Call
Forwarding
when Busy

When a number is busy, allows a call to be forwarded to a default


number specified by the service provider.

Home Location Register (Linux) V1.1 Support Guide

596

Appendix E Basic and Supplementary Services

Table 60. Supported Supplementary Services (Continued)


Supplementary
Service

Meaning

Description

DCFNRC

Default Call
Forwarding
when Not
Reachable

When a number is not reachable, allows a call to be forwarded to a


default number specified by the service provider.

DCFNRY

Default Call
Forwarding
when No
Reply

When a number is not answered, allows a call to be forwarded to a


default number specified by the service provider.

ECT

Explicit call
transfer

Allows a subscriber forward an incoming or outgoing call to a third


party.

EMLPP

Enhanced
Multi-Level
Precedence
and Preemption

Allows providers to supply a priority service to specific customers or


groups of customers. These customers will have an enhanced
service in terms of call setup, handover, and in loaded or congested
situations.

FMC1

Fixed Mobile
Convergence
1

Identifies a subscriber as belonging to an MVNO.

HOLD

Call Holding

Allows a subscriber to interrupt and resume an existing call, perhaps


to accept a waiting call or make outgoing calls.

LCN

Last caller
number

When subscribers have this service provisioned, they have the ability
to erase the LCN, meaning it cannot be obtained by another
subscriber. This is controlled by a USSD. When this service is used,
the LCN is not removed at the HLR, but an erasure flag is set.

LINKED

Linked
Subscriptions

Used for linked subscribers, indicating that the subscriber is a P


(published) number.

MPTY

Multi-Party

This service requires the Call Holding supplementary service. It


allows the subscriber to communicate with several other parties
simultaneously (for example: a conference call).

MVPN_FNP

Mobile Virtual
Private
Network Full
Number Plan

Allows a subscriber to forward to any number, including numbers


beginning 0,1 or 9, as part of a private number plan overlaid on the
Vodafone network. The MVPN_FNP service removes any
restrictions on the numbers used in a private numbering plan except
for numbers listed in the [CNUMFNP] section of the C number table.

OICK

Originating IN
Category Key

Provides flexible routing and handling of originating calls. May also


be downloaded to a VLR on registration in response to an UPL
message that indicates support for EMAP. It is also used as SRI
response (if supported) for diverts.

OIN

Originating
Intelligent
Network

Used with the Group Services Platform (GSP). When a subscriber


who has OIN set attempts to make a call, the VLR/MSC will route the
call to the GSP.

OVERRIDE

CLIP
Restriction
Override

Allows authorised users, such as emergency services, to display the


calling line identity (CLI), regardless of whether it was withheld.
OVERRIDE is a flag associated with the CLIP supplementary service
and is set using the UPDATE:SUB command (page 215). See CLIP
Restriction Override on page 633.

Home Location Register (Linux) V1.1 Support Guide

Appendix E Basic and Supplementary Services

597

Table 60. Supported Supplementary Services (Continued)


Supplementary
Service
PREPAY_IC

Meaning

Description

PrePayment
Incoming Call

Used with the PrePayment System (PPS). When the SRI for the
incoming call for a PPS subscriber is received by the HLR, the HLR
sends a message to the Prepayment Account Manager (PAM) to
request the account status of the subscriber before the call can be
received. The PAM will return a status message which is one of the
following:
No Credit
Credit
Unknown Account
The call can be received only if the subscriber has a credit status.

PRIORITY
RBT

Used by the MSC/VLR to prioritise access to the networks radio


resources.
Ringback
Tones

If the subscriber has this service provisioned, they can change the
ringing tone that the calling party hears.

RECALL

Allows use of special diverts to MLR/Voicemail.

SMSB

Permits the setting of unconditional divert to SMS bureau.

SUBTYPE

Used in the SRI response if supported. May also be downloaded to a


VLR on registration in response to an UPL message that indicates
support for EMAP.

TICK

Terminating
IN Category
Key

TICK is a proprietary Ericsson trigger which allows the GMSC to


perform specific processing when a subscriber receives an incoming
call. If TICK is provisioned, the TICK value is returned in response to
an SRI message.
The Vodafone UK network combines TICK processing with a
TICKROAM supplementary service to allow roamed pre-pay
customers to receive calls.
The TICK supplementary service has been replaced by the
subscriber attributes HOMETICK and ROAMTICK. TICK has been
retained for backward compatibility of administration commands and
can still be provisioned, but is interpreted as the combination of
HOMETICK and ROAMTICK attributes that gives the same
behaviour as the TICK supplementary service. For a description of
how TICK is interpreted, see Backward Compatibility of TICK and
TICKROAM on page 599.

TICKROAM

Terminating
IN Category
Key when
Roamed

Allows Pay As You Talk customers to roam internationally.


TICKROAM is a filter for the TICK supplementary service. It has no
services of its own; it simply allows TICK services to work when a
subscriber is roamed.
The TICKROAM supplementary service has been replaced by the
subscriber attribute ROAMTICK. TICKROAM can still be
provisioned, but is interpreted as the ROAMTICK attribute value that
gives the same behaviour as the TICKROAM supplementary service.

TRIG_A

Trigger on
A-number

Allows the HLR to initiate an SRI to another platform such as the


Group Services Platform (GSP) to enquire how the call should
proceed.

Home Location Register (Linux) V1.1 Support Guide

598

Appendix E Basic and Supplementary Services

Table 60. Supported Supplementary Services (Continued)


Supplementary
Service

Meaning

Description

TRIG_B

Trigger on
B-number

Unconditional diverts and in some cases CFNRC diverts are done on


the HLR. This service allows the HLR to initiate an SRI to another
platform to enquire how the divert should proceed. Use of this
service allows the use of diverts to, for example, an office extension
number.

TRIG_C

Trigger on
C-number

Allows the HLR to initiate an enquiry to another platform when a


subscriber registers a divert. The response determines how the HLR
handles the divert.

Home Location Register (Linux) V1.1 Support Guide

Appendix E Basic and Supplementary Services

599

Backward Compatibility of TICK and TICKROAM


The TICK and TICKROAM supplementary services have been
replaced with the HOMETICK and ROAMTICK subscriber attributes,
but the PROVISION:SS and WITHDRAW:SS administration
commands still accept these supplementary services.
The effects of provisioning the TICK and TICKROAM supplementary
services are summarised in Table 61.
Table 61. Effects of TICK and TICKROAM Supplementary Services
TICK Value

Supplementary Services

HOMETICK

ROAMTICK

TICK and TICKROAM

TICK

TICKROAM

NONE

ANY COMBINATION

If the TICK supplementary service is provisioned, both HOMETICK


and ROAMTICK are made equal to the TICK value.
If either TICK or TICKROAM is withdrawn, both HOMETICK and
ROAMTICK are set to 0 (zero).
If the TICKROAM supplementary service is provisioned,
ROAMTICK are made equal to the TICK value and HOMETICK is
set to 0 (zero).
The values of HOMETICK and ROAMTICK are not altered if a
subscriber deregisters from the network.

Home Location Register (Linux) V1.1 Support Guide

600

Appendix E Basic and Supplementary Services

Home Location Register (Linux) V1.1 Support Guide

601

Appendix F Quality of Service


This appendix describes the content of the quality of service
information element associated with every subscriber.

Quality of Service Information Element


Quality of service settings are stored in 3 octets as shown below.
Bit Number
8

Delay
Class

Peak
Throughput

1
Spare
Octet

2
0

3
Spare

Reliability
Class
0

Spare

Precedence
Class
Mean
throughput

The following tables describe the values currently assigned to the


above fields. No meaning is inferred by the HLR. The HLR does not
restrict the sub fields to values given here in an attempt to make it
future proof; the only restriction for each field is the maximum number
that can be stored in the number of bits.
Quality of Service is displayed and entered in the following format: "a-b-c-d-e"
where
a = Delay Class
b = Reliability Class
c = Peak Throughput
d = Precedence Class
e = Mean Throughput

Home Location Register (Linux) V1.1 Support Guide

602

Appendix F Quality of Service

Delay (Maximum Values)


SDU size: 128 octets

SDU size: 1024 octets

Delay Class

Mean Transfer
Delay (sec)

95 percentile
Delay (sec)

Mean Transfer
Delay (sec)

95 percentile
Delay (sec)

1. (Predictive)

< 0.5

< 1.5

<2

<7

2. (Predictive)

<5

< 25

< 15

< 75

3. (Predictive)

< 50

< 250

< 75

< 375

4. (Best Effort)

Unspecified

Table 62. Reliability Class values (QoS)


Reliability Class

Traffic Type

Non real-time traffic, error-sensitive application that cannot cope with data loss.

Non real-time traffic, error-sensitive application that can cope with infrequent data loss.

Non real-time traffic, error-sensitive application that can cope with data loss, GMM/SM,
and SMS.

Real-time traffic, error-sensitive application that can cope with data loss.

Real-time traffic, error non-sensitive application that can cope with data loss.

Table 63. Peak Throughput Class values (QoS)


Peak Throughput
Class

Peak Throughput in octets per second

Up to 1 000 (8 kbit/s).

Up to 2 000 (16 kbit/s).

Up to 4 000 (32 kbit/s).

Up to 8 000 (64 kbit/s).

Up to 16 000 (128 kbit/s).

Up to 32 000 (256 kbit/s).

Up to 64 000 (512 kbit/s).

Up to 128 000 (1 024 kbit/s).

Up to 256 000 (2 048 kbit/s).

Home Location Register (Linux) V1.1 Support Guide

Appendix F Quality of Service

603

Table 64. Precedence Class values (QoS)


Precedence

Precedence
Name

High priority

Service commitments shall be maintained ahead of precedence classes


2 and 3.

Normal priority

Service commitments shall be maintained ahead of precedence class 3.

Low priority

Service commitments shall be maintained after precedence classes 1


and 2.

Interpretation

Table 65. Mean Throughput Class values (QoS)

Mean Throughput in octets per hour

100 (~0.22 bit/s).

200 (~0.44 bit/s).

500 (~1.11 bit/s).

1 000 (~2.2 bit/s).

2 000 (~4.4 bit/s).

5 000 (~11.1 bit/s).

10 000 (~22 bit/s).

20 000 (~44 bit/s).

50 000 (~111 bit/s).

10

100 000 (~0.22 kbit/s).

11

200 000 (~0.44 kbit/s).

12

500 000 (~1.11 kbit/s).

13

1 000 000 (~2.2 kbit/s).

14

2 000 000 (~4.4 kbit/s).

15

5 000 000 (~11.1 kbit/s).

16

10 000 000 (~22 kbit/s).

17

20 000 000 (~44 kbit/s).

18

50 000 000 (~111 kbit/s).

31

Best effort.

Home Location Register (Linux) V1.1 Support Guide

604

Appendix F Quality of Service

Allocation / Retention Priority


Traffic Class

Delivery order

Delivery of erroneous SDU

Maximum SDU size


Maximum bit rate for uplink
Maximum bit rate for downlink
Residual BER

SDU error ratio

Transfer delay

Traffic Handling priority

Guaranteed bit rate for uplink


Guaranteed bit rate for downlink

Extended Quality of Service Content Information


The following information is extracted from 3GPP TS 23.107, QoS
Concept and Architecture and 3GPP TS 24.008, Core Network
Protocols stage 3. More detailed information can be found in these
specifications.
The HLR infers no meaning upon this data. The HLR does not restrict
the sub fields to values given here, in an attempt to make it future
proof; the only restriction for each field is the maximum number that
can be stored in the number of bits.
Quality of Service is displayed and entered in the following format:
a-b-c-d-e-f-g-h-i-j-k-l-m

Where:
a is Allocation/Retention Priority
b is Traffic Class
c is Delivery Order
d is Delivery of Erroneous SDU
e is Maximum SDU size
f is Max bit rate for uplink
g is Max bit rate for downlink
h is Residual BER
i is SDU Error Ratio
j is Transfer Delay

Home Location Register (Linux) V1.1 Support Guide

Appendix F Quality of Service

605

k is Traffic Handling Priority


l is Guaranteed bit rate for Up
m is Guaranteed bit rate for downlink

Allocation /
Retention
Priority

The allocation/retention priority octet encodes each priority level


defined in 23.107 as the binary value of the priority level.

Traffic Class

Bits
876
In MS to network direction:
000
Subscribed traffic class
In network to MS direction:
000
Reserved
In MS to network direction and in network to MS direction :
001
Conversational class
010
Streaming class
011
Interactive class
100
Background class
111
Reserved

Delivery Order

Bits
543
In MS to network direction:
00
Subscribed delivery order
In network to MS direction:
00
Reserved
In MS to network direction and in network to MS direction :
01
With delivery order (yes)
10
Without delivery order (no)
11
Reserved
The network shall map all other values not explicitly defined onto one of
the values defined in this version of the protocol. The network shall
return a negotiated value which is explicitly defined in this version of
this protocol.

Delivery of
Erroneous SDUs

Bits
321
In MS to network direction:
000
Subscribed delivery of erroneous SDUs
In network to MS direction:
000
Reserved

Home Location Register (Linux) V1.1 Support Guide

606

Appendix F Quality of Service

In MS to network direction and in network to MS direction :


001
No detect (-)
010
Erroneous SDUs are delivered (yes)
011
Erroneous SDUs are not delivered (no)
111
Reserved
The network shall map all other values not explicitly defined onto one of
the values defined in this version of the protocol. The network shall
return a negotiated value which is explicitly defined in this version of
this protocol.

Maximum SDU
Size

In MS to network direction:
00000000
11111111

Subscribed maximum SDU size


Reserved

In network to MS direction:
00000000
11111111

Reserved
Reserved

In MS to network direction and in network to MS direction :


For values in the range 00000001 to 10010110 the Maximum SDU size
value is binary coded in 8 bits, using a granularity of 10 octets, giving a
range of values from 10 octets to 1500 octets.
Values above 10010110 are as below:
10010111

1502 octets

10011000

1510 octets

10011001

1520 octets

The network shall map all other values not explicitly defined onto one of
the values defined in this version of the protocol. The network shall
return a negotiated value which is explicitly defined in this version of
this protocol.

Maximum Bit
Rate For Uplink

Bits
87654321
In MS to network direction:
0 0 0 0 0 0 0 0Subscribed maximum bit rate for uplink
In network to MS direction:
0 0 0 0 0 0 0 0Reserved
In MS to network direction and in network to MS direction :
0 0 0 0 0 0 0 1 The maximum bit rate is binary coded in 8 bits, using a
granularity of 1 kbps
0 0 1 1 1 1 1 1giving a range of values from 1 kbps to 63 kbps in 1 kbps
increments.

Home Location Register (Linux) V1.1 Support Guide

Appendix F Quality of Service

607

0 1 0 0 0 0 0 0 The maximum bit rate is 64 kbps + ((the binary coded


value in 8 bits 01000000) * 8 kbps)
0 1 1 1 1 1 1 1giving a range of values from 64 kbps to 568 kbps in 8
kbps increments.
1 0 0 0 0 0 0 0 The maximum bit rate is 576 kbps + ((the binary coded
value in 8 bits 10000000) * 64 kbps)
1 1 1 1 1 1 1 0giving a range of values from 576 kbps to 8640 kbps in
64 kbps increments.
1 1 1 1 1 1 1 10kbps

Maximum Bit
Rate For
Downlink

Coding is identical to that of Maximum bit rate for uplink.

Residual Bit
Error Rate (BER)

Bits
8765
In MS to network direction:
0000
Subscribed residual BER
In network to MS direction:
0000
Reserved
In MS to network direction and in network to MS direction :
The Residual BER value consists of 4 bits. The range is from 5*10-2 to
6*10-8.
0001
5*10-2
0010
1*10-2
0011
5*10-3
0100
4*10-3
0101
1*10-3
0110
1*10-4
0111
1*10-5
1000
1*10-6
1001
6*10-8
1111
Reserved
The network shall map all other values not explicitly defined onto one of
the values defined in this version of the protocol. The network shall
return a negotiated value which is explicitly defined in this version of the
protocol.

SDU Error Ratio

Bits
4321
In MS to network direction:
0000
Subscribed SDU error ratio

Home Location Register (Linux) V1.1 Support Guide

608

Appendix F Quality of Service

In network to MS direction:
0000
Reserved
In MS to network direction and in network to MS direction :
The SDU error ratio value consists of 4 bits. The range is from 1*10-1 to
1*10-6.
0001
1*10-2
0010
7*10-3
0011
1*10-3
0100
1*10-4
0101
1*10-5
0110
1*10-6
0111
1*10-1
1111
Reserved
The network shall map all other values not explicitly defined onto one of
the values defined in this version of the protocol. The network shall
return a negotiated value, which is explicitly defined in this version of
the protocol.

Transfer Delay

Bits
876543
In MS to network direction:
0 0 0 0 0 0 Subscribed transfer delay
In network to MS direction:
0 0 0 0 0 0 Reserved
In MS to network direction and in network to MS direction :
0 0 0 0 0 1 The Transfer delay is binary coded in 6 bits, using a
granularity of 10ms
0 0 1 1 1 1giving a range of values from 10 ms to 150 ms in 10 ms
increments
0 1 0 0 0 0 The transfer delay is 200 ms + ((the binary coded value in 6
bits 010000) * 50ms)
0 1 1 1 1 1 giving a range of values from 200 ms to 950 ms in 50ms
increments
1 0 0 0 0 0 The transfer delay is 1000 ms + ((the binary coded value in
6 bits 100000) * 100ms)
1 1 1 1 1 0 giving a range of values from 1000 ms to 4100 ms in 100ms
increments
1 1 1 1 1 1 Reserved
The Transfer delay value is ignored if the Traffic Class is Interactive
class or Background class.

Home Location Register (Linux) V1.1 Support Guide

Appendix F Quality of Service

Traffic Handling
Priority

609

Bits
21
In MS to network direction:
00
Subscribed traffic handling priority
In network to MS direction:
00
Reserved
In MS to network direction and in network to MS direction :
01
Priority level 1
10
Priority level 2
11
Priority level 3
The Traffic handling priority value is ignored if the Traffic Class is
Conversation class, Streaming class or Background class.

Guaranteed Bit
Rate For Uplink

Coding is identical to that of Maximum bit rate for uplink.

Guaranteed Bit
Rate For
Downlink

Coding is identical to that of Maximum bit rate for uplink.

The Guaranteed bit rate for uplink value is ignored if the Traffic Class is
Interactive class or Background class, or Maximum bit rate for uplink is
set to 0 kbps.

The Guaranteed bit rate for downlink value is ignored if the Traffic
Class is Interactive class or Background class, or Maximum bit rate for
downlink is set to 0 kbps.

Home Location Register (Linux) V1.1 Support Guide

610

Home Location Register (Linux) V1.1 Support Guide

Appendix F Quality of Service

611

Appendix G Attribute Bit Numbers in the


Subscriber Database
This appendix describes subscriber attributes in terms of bit positions in
bit fields in the subscriber database.

Basic Services
The subscriber database contains one bit field for basic service groups
and another for the basic services themselves. A subscriber can have
multiple basic service groups and basic services by setting the relevant
bits.

Service Groups
Bit

Basic Service Group

Speech - SPEECH

Short Message Service - SMS

Facsimile - FAX

All Data Circuit - Async - DCICA (BS21 to BS26 mutually exclusive to BS20)

All Data Circuit - Sync - DCICS (BS31 to BS34 mutually exclusive to BS30)

All PAD Access - PADACC

All Data Packet - DPACK

12kbit/s Unres. Digital - UNREST

Auxiliary Speech (AUXSPEECH)

Services
Bit

Basic
Service

Description

TS11

Telephony

TS12

Emergency

TS21

Short message, mobile terminated

TS22

Short message, mobile originated

TS23

Cell broadcast

PS21

Short message, packet switched mobile terminated

Home Location Register (Linux) V1.1 Support Guide

612

Appendix G Attribute Bit Numbers in the Subscriber Database

Basic
Service

Description

PS22

Short message, packet switched mobile originated

TS61

Alternate speech and facsimile Group 3

TS62

Automatic facsimile Group 3

BS21

Data circuit, duplex asynchronous 300 bit/s

BS22

Data circuit, duplex asynchronous 1200 bit/s

BS23

Data circuit, duplex asynchronous 1200/75 bit/s

10

BS24

Data circuit, duplex asynchronous 2400 bit/s

11

BS25

Data circuit, duplex asynchronous 4800 bit/s

12

BS26

Data circuit, duplex asynchronous 9600 bit/s

13

BS61A

Alternate speech/unrestricted data (async)

14

BS81A

Speech followed by data (async)

15

BS31

Data circuit, duplex synchronous 1200 bit/s

16

BS32

Data circuit, duplex synchronous 2400 bit/s

17

BS33

Data circuit, duplex synchronous 4800 bit/s

18

BS34

Data circuit, duplex synchronous 9600 bit/s

19

BS61S

Alternate speech/unrestricted data (sync)

20

BS81S

Speech followed by data (sync)

21

BS41

PAD access circuit, asynchronous 300 bit/s

22

BS42

PAD access circuit, asynchronous 1200 bit/s

23

BS43

PAD access circuit, asynchronous 1200/75 bit/s

24

BS44

PAD access circuit, asynchronous 2400 bit/s

25

BS45

PAD access circuit, asynchronous 4800 bit/s

26

BS46

PAD access circuit, asynchronous 9600 bit/s

27

BS51

Data packet, duplex synchronous 2400 bit/s

28

BS52

Data packet, duplex synchronous 4800 bit/s

29

BS53

Data packet, duplex synchronous 9600 bit/s

30

BS71

12 Kbit/s unrestricted digital

31

TSD1

Dual numbering

32

BS20

High Speed Circuit Switched Data - HSCSD (mutually exclusive to BS21 to BS26).
Allows one data call to use more than one traffic channel, giving speeds over 9.6kbit/s.

33

BS30

Video Telephony (mutually exclusive to BS31 to BS34). 64kbps data to allow video with
voice calls

Bit

Home Location Register (Linux) V1.1 Support Guide

Appendix G Attribute Bit Numbers in the Subscriber Database

613

Supplementary Services
For detailed descriptions of supplementary services, see
Supplementary Services on page 594.

Bit

Supplementary
Service

Meaning

CFNRY

Call Forwarding on No Reply

CFNRC

Call Forwarding on Not Reachable

CFB

Call Forwarding on MS Busy

CFU

Call Forwarding Unconditional

CW

Call Waiting

BAOC

Barring of Outgoing Calls

/BOIC

Bar Outgoing International Calls

/BOICXHC

Bar Outgoing International Calls eXcept to Home Country

BAIC

Barring Incoming Calls

BICROAM

Bar Incoming Calls when Roamed outside home country

10

CLIP

Calling Line Identification Presentation

11

CLIR

Calling Line Identification Restriction

12

AOCI

Advice of Charge Information

13

AOCC

Advice of Charge Charging

14

HOLD

Call Holding

15

MPTY

Multi-Party

16

OIN

Originating Intelligent Network

17

PREPAY_IC

PrePayment Incoming Call

18

COLP

Connected Line Identification Presentation

19

COLR

Connected Line Identification Restriction

20

ARSENIC

Ability to Register Special/Extended Numbers in Call-forwards

21

TRIG_A

Trigger on A-number

22

TRIG_B

Trigger on B-number

23

OICK

Originating IN Category Key

24

TICK

Terminating IN Category Key

25

PRIORITY

26

SUBTYPE

27

RECALL

28

LINKED

Linked Subscriptions

Home Location Register (Linux) V1.1 Support Guide

614

Appendix G Attribute Bit Numbers in the Subscriber Database

Bit

Supplementary
Service

29

SMSB

30

TICKROAM

Terminating IN Category Key when Roamed

31

TRIG_C

Trigger on C-number

32

MVPN_FNP

Mobile Virtual Private Network Full Number Plan

33

ECT

Explicit Call Transfer

34

ACR

Anonymous Call Reject

35

CALL_UNREL

36

DCFB

Default Call Forward Busy

37

DCFNRY

Default Call Forward No Reply

38

DCFNRC

Default Call Forward Not Reachable

39

FMC1

Currently used for BT Diamond subscribers

40

EMLPP

Enhanced Multi-Level Precedence and Pre-emption

41

DEFAULT_CF

Used for setting DCF if subscriber does not provision own call
forwards

42

RBT

RingBack Tones

43

LCN

Last Caller Number

44

ADD

Automatic Device Detection

Meaning

Supplementary Service Notification flags


Notification flags can be displayed by the VIEW:SUB command (see
page 231) and are described in Table 60 on page 594.
Bit

Notification Flag

CFUCP

CFBCP

CFBFP

CFNRYCP

CFNRYFP

CFNRCCP

Home Location Register (Linux) V1.1 Support Guide

Appendix G Attribute Bit Numbers in the Subscriber Database

615

Supplementary Service Behaviour Modes


For a detailed description of behaviour modes, see Table 26 on
page 323.

Behaviour
Mode

Value

GSM

SMSB

RECALL

SE

Home Location Register (Linux) V1.1 Support Guide

616

Appendix G Attribute Bit Numbers in the Subscriber Database

Operator Determined Bars


For a detailed description of operator determined bars, see Appendix I,
Operator Determined Bars on page 647.
Bit

Bar
ODBHPLMN1-4 are bars that can be configured by the home PLMN.
These bars do not affect diverts.

ODBAOC

ODBOIC

ODBOICXHC

ODBOCROAM

ODBAIC

ODBICROAM

ODBROAMHP

ODBROAMHC

ODBOPINFO

ODBOPENT

10

ODBSS

11

ODBHPLMN1

12

ODBHPLMN2

13

ODBHPLMN3

14

ODBHPLMN4

15

ODBCNUM1

16

ODBCNUM2

17

ODBCNUM3

18

ODBXENOSMS

19

ODBICRXSMS

20

ODBINBAOC

21

ODBINBOIC

22

ODBINBOICXHC

23

ODBINBAIC

24

ODBINBICROAM

25

ODBINBOCROAM

26

ODBINBOPENT

27

ODBINBOPINFO

Home Location Register (Linux) V1.1 Support Guide

Appendix G Attribute Bit Numbers in the Subscriber Database

Bit

Bar

28

ODBINBSS

29

ODBINLS

30

ODBINPAYT

31

ODBINMOSMS

32

ODBINMTSMS

33

ODBPREMROAM

34

ODBMOSMSROAM

35

ODBCFVLRROAM

36

ODBROAMALL

37

ODBMOXSMS

38

ODBMOXSMSROAM

39

ODBGSM

40

ODBGPRS

41

ODBOZC

42

ODBOZCXHC

43

ODBOZICXHC

44

ODBICROAZ

45

ODBNICBAOC

46 to 61

ODBMOSMS_00 to ODBMOSMS_15

62

ODBECT

63

ODBECTC

64

ODBECTCI

65

ODBECTCZ

66

ODBECTC2

67

ODBECTSM

68

BOPENTSMS

69

PREMSMSLO

70

PREMSMSHI

71

RTOSPBAR

72

DCF

617

Home Location Register (Linux) V1.1 Support Guide

618

Appendix G Attribute Bit Numbers in the Subscriber Database

Visited MSC Flags and Network Entity Attributes


For a detailed description of network entity attributes, see the netent
table in the Table Maintenance chapter..
Bit

Name

TSMS

HPLMN

VODACAT

TSMS_CS

TSMS_PS

5-10

Unused

11

ROAM_RELAY

12

SIGTRAN

13

RECALL_TMC

14

ROAM_UNKSUB

15

COMPRESS_ENB

16

VODACPC

17

ROUTE_ON_PC

18

RDROF

19

MMR

20

LOG_SCCP

21

LOG_TRANSACTION

22

LOG_SS7

23

BLACK

24

EMAP

25

Spare

26

MLR

27

OSMS

28

ROAM_ORB

29

ADPCM_PFX

30

OR

31

RN_PFX

Home Location Register (Linux) V1.1 Support Guide

Appendix G Attribute Bit Numbers in the Subscriber Database

619

Location Status
For a detailed description of location status, see Table 22 on page 259.

Bit

Location Status

INVALID

ADMIN_DISABLED

ADMIN_CHANGED

ROAM_STOPPED

ROAM_ODB

UNSUP_SVC_RESTR

REGISTERED

PURGED

ISD_DSD_FAIL

TIMEOUT

10

ABANDONED

11

RR_UNSUP

12

AC_CONFLICT

13

BLACK_LISTED

14

DECSS7_SENDF

15

UNKNOWN_IN_VLR

Home Location Register (Linux) V1.1 Support Guide

620

Appendix G Attribute Bit Numbers in the Subscriber Database

CAMEL Phases
Supported CAMEL phases are returned by the VIEW:NETWORK
command (see page 409).
Bit

CAMEL Phase

PH1

PH2

PH3

Home Location Register (Linux) V1.1 Support Guide

Appendix G Attribute Bit Numbers in the Subscriber Database

621

Unsupported Application Context Names


Application contexts are attributes of network entities in the Network
Entity (NETENT) Table. For a description of application contexts, see
the netent table description in the Table Maintenance chapter.

Bit

Unsupported Application Context

NETWORK_LOC_UP_V1

LOCATION_CANCELLATION_V1

ROAMING_NUMBER_ENQUIRY_V1

SUBSCRIBER_DATA_MNGT_V1

INFO_RETRIEVAL_V1

NETWORK_FUNCTIONAL_SS_V1

LOCATION_INFO_RETRIEVAL_V1

RESET_V1

10

TRACING_V1

11

SHORT_MSG_GATEWAY_V1

12

SHORT_MSG_RELAY_V1

13

MWD_MNGT_V1

14

SHORT_MSG_ALERT_V1

15

NETWORK_LOC_UP_V2

16

LOCATION_CANCELLATION_V2

17

ROAMING_NUMBER_ENQUIRY_V2

18

LOCATION_INFO_RETRIEVAL_V2

19

RESET_V2

20

INFO_RETRIEVAL_V2

21

INTER_VLR_INFO_RETRIEVAL_V2

22

SUBSCRIBER_DATA_MNGT_V2

23

TRACING_V2

24

NETWORK_FUNCTIONAL_SS_V2

25

NETWORK_UNSTRUCTURED_SS_V2

26

SHORT MSG_GATEWAY_V2

27

SHORT MSG_MO_RELAY_V2

28

SHORT MSG_ALERT_V2

29

MWD_MNGT_V2

30

SHORT_MSG_MT_RELAY_V2

Home Location Register (Linux) V1.1 Support Guide

622

Appendix G Attribute Bit Numbers in the Subscriber Database

Bit

Unsupported Application Context

31

IMSI_RETRIEVAL_V2

32

MS_PURGING_V2

33

PSI_V2

34

ROAMING_NUMBER_ENQUIRY_V3

35

SUBSCRIBER_INFO_ENQUIRY_V3

36

SUBSCRIBER_DATA_MNGT_V3

37

ANY_TIME_INFO_ENQUIRY_V3

38

LOCATION_CANCELLATION_V3

39

MS_PURGING_V3

40

GPRS_LOCATION_UPDATE_V3

41

NETWORK_LOC_UP_V3

42

LOCATION_INFO_RETRIEVAL_V3

43

MWD_MNGT_V3

44

SHORT_MSG_GATEWAY_V3

45

INFO_RETRIEVAL_V3

46

AUTHENTICATION_FAILURE_REPORT_V3

47

ERI_LOCATION_SVC_GATEWAY_CONTEXT_V3

15 to 47

V2_AND_ABOVE

34-47

V3_AND_ABOVE

Home Location Register (Linux) V1.1 Support Guide

Appendix G Attribute Bit Numbers in the Subscriber Database

623

SMS Absence Reasons


SMS absence reasons are displayed by the VIEW:SUB command
alongside the mobile station not reachable reason attributes
(MNRR_GPRS for GPRS and MNRR_GSM for GSM). MNRR_GPRS
and MNRR_GSM can be modified using the UPDATE:SIM command.
For detailed description of each reason, see MNRR_GPRS on
page 199 and MNRR_GSM on page 200.
Code

Value

NO_GSM_PAGE_RESP

IMSI_DETACHED

ROAM_RESTRICT

DEREG_GSM

MSPURGED_GSM

NO_GPRS_PAGE_RESP

GPRS_DETACHED

DEREG_GPRS

MSPURGES_GPRS

UNK_GSM_SUB

UNK_GPRS_SUB

10

NONE

255

Mobility Triggers
Mobility triggers are viewed using the VIEW:SUB command, added
using the ADD:CAMEL command and modified using the
UPDATE:CAMEL command.
For a description of mobility triggers, see the {<mobility_trig>} entry in
Table 33 on page 351.

Bit

Code

LOC_UPD_SAME_VLR

LOC_UPD_OTHER_VLR

IMSI_ATTACH

INIT_IMSI_DETACH

NWK_INIT_IMSI_DETACH

Home Location Register (Linux) V1.1 Support Guide

624

Appendix G Attribute Bit Numbers in the Subscriber Database

CAMEL
CAMEL data is controlled using the ADD:CAMEL, REMOVE:CAMEL
and UPDATE:CAMEL commands.

SS Codes for CAMEL


Supplementary service codes are part of Supplementary Service CSI
(SS-CSI) data.
Bit

Supplementary Service

Description

15

MPTY

Multiparty

CAMEL Trigger Detection Point Combinations


Trigger detection points (TDPs) provide configuration data for CAMEL
services. A subscriber can have multiple CAMEL TDPs by setting bits
in this bitmask.
Bit

CSI TDP

OCSI_2

OCSI_4

GPRSCSI_1

GPRSCSI_2

GPRSCSI_11

GPRSCSI_12

GPRSCSI_14

MOSMSCSI_1

VTCSI_12

VTCSI_13

11

VTCSI_14

12

TCSI_12

14

TCSI_13

15

TCSI_14

16

DCSI_1

17

DCSI_2

16

DCSI_3

17

SSCS1

18

MCSI1

Home Location Register (Linux) V1.1 Support Guide

Appendix G Attribute Bit Numbers in the Subscriber Database

625

Unsupported Services
Unsupported services are listed alongside the UNSUPP_SERV
attribute in the Network Entity (NETENT) Table.

Bit

Service

Multi-SIM

Roamed

Regional Subscription

Home Location Register (Linux) V1.1 Support Guide

626

Appendix G Attribute Bit Numbers in the Subscriber Database

Home Location Register (Linux) V1.1 Support Guide

627

Appendix H USSD Information


The HLR supports several additional services, which are configurable
in the USSD (Unstructured Supplementary Service Data) table.
The USSD services are divided into:
Services processed by the HLR, which are listed in the
[PROCESSED_USSD] section of the USSD table. See USSDs
Processed by the HLR below.
Services forwarded by the HLR to another intelligent node for
processing, and which are listed in the [RELAYED_USSD] section of
the USSD table. See USSDs Processed Outside the HLR on
page 642.
Positioning and Next Generation Voicemail (NGVM) services,
described in the [RELAYED_TCPIP_USSD] section of the USSD
table. See Positioning Services and NGVM Phase 1a Services.
Services for which the HLR sets up a dialogue between the mobile
handset and an intelligent node and then takes no further part in the
dialogue. These services are listed in the [FORWARD_USSD]
section of the USSD table.

Home Location Register (Linux) V1.1 Support Guide

628

Appendix H USSD Information

USSDs Processed by the HLR


USSDs processed by the HLR are listed in the [PROCESSED_USSD]
section of the USSD table as <TOKEN> <VALUE> pairs, where
<VALUE> is a USSD command string typed into a handset or a text
response of no more than 160 characters. <TOKEN> is a name given
to the <VALUE> which identifies its purpose.
A few services that only require a simple response are defined in the
[REPLY_USSD] section of the USSD table.

SMS Bureau/Respond Plus


When a subscriber activates their SMS Bureau Service, all calls are
unconditionally diverted to an operator. The operator takes a message,
which is forwarded to the subscriber using the GSM short message
service. The subscribers MSISDN is available to the operator so that
their personal greeting can be used. The call is diverted to a
configurable prefix plus the MSISDN. The prefix is recognised by the
MSC which routes the call to the bureau, which extracts the
subscribers MSISDN.
Activating the SMS Bureau Service replaces any CFU set with the SMS
bureau operator enquiry number in international format. This allows the
user to check the divert facility to see if the service is set. Setting a valid
CFU will deactivate the SMS Bureau Service and register the new CFU
in the usual way.

Enabling the
Bureau Service

The SMS Bureau Service can be enabled by any of the following:


Entering the USSD (for example, *122#) on the handset, followed by
send. This information is sent to the HLR.
Set the call forward unconditional to the prefix (for example 122)
from the phone menu on the handset. This enables phones without
USSD capability to turn on the bureau service without using an
operator or having to know the divert number of the service.
Set the CFU to the value (for example, -122) using the
Administration Interface (see REGISTER:SS on page 322 and
include the value as a parameter in the command).

Disabling the
Bureau Service

The SMS Bureau Service can be disabled by any of the following:


Entering the value (for example, #122#) on the handset, followed by
send
Setting a valid CFU in the usual way
Clearing the CFU in the usual way

Home Location Register (Linux) V1.1 Support Guide

Appendix H USSD Information

Use of Behaviour
Mode

629

Each divert set has a behaviour mode which is displayed by the VIEW
SUB command (see VIEW:SUB on page 231). The behaviour is
displayed as:
GSM (the default)
SMSB for the SMS Bureau Service
RECALL for the voicemail service or
SE for Special/Extended.

TOKEN

Example VALUE

Description

SMSB_ON_CMD

*122#

Activate Respond Plus Command.

SMSB_OFF_CMD

#122#

Deactivated Respond Plus Command.

SMSB_ON_TEXT

"BUREAU ON"

Text response when activated.

SMSB_OFF_TEXT

"BUREAU OFF"

Text response when deactivated.

SMSB_FAIL_TEXT

"REQUEST FAILED"

Response if subscriber has not got speech


basic service, or appropriate supplementary
services.

SMSB_NO_SMS_BS

"Sorry, no SMS Basic Service"

Response if subscriber has not got SMS basic


service.

MSISDN
Retrieval

USSD commands allow subscribers to retrieve their MSISDNs,


including MSISDNs for Fax and data services.

TOKEN

Example VALUE

Description

OWN_MSISDN_CMD

*#100#

Main MSISDN retrieval command.

OWN_MSISDN_TEXT

"This phones number is 0%s"

Text response containing the MSISDN

OWN_MSISDN_BSG_
CMD

*#100*<MMI_code>#

Command to retrieve MSISDN for given


basic service group. See Table 66 on
page 630 for a list of 2-digit <MMI_code>
values.

OWN_MSISDN_BSG_
TEXT

"%s"

Text response containing the requested


MSISDN.

OWN_MSISDN_BSG_
TOO_MANY_TEXT

"Too many MSISDNs


requested"

Text response for too many MSISDNs

OWN_MSISDN_BSG_
TOO_MUCH_TEXT

"Too much data requested"

Text response for USSD string length


exceeded.

OWN_MSISDN_BSG_
EMPTY_TEXT

"No MSISDN for specified


service"

Text response for no MSISDN.

OWN_MSISDN_BSG_I
NV_MMI_TEXT

"Invalid service code"

Text response for invalid MMI specified.

OWN_MSISDN_BSG_I
NV_FORM_TEXT

"Invalid format - Use


*#100*XY# or *#100*#"

Text response for invalid format USSD.

Home Location Register (Linux) V1.1 Support Guide

630

Appendix H USSD Information

Table 66. MMI Codes for Retrieving MSISDNs Using *#100*


Service

MMI Code

All teleservices (SPEECH, FAX and SMS)

10

Telephony (SPEECH)

11

All data teleservices (FAX and SMS)

12

Facsimile services (FAX)

13

Short Message Services (SMS)

16

All teleservices except SMS (SPEECH and FAX)

19

All bearer services

20

All asynchronous services

21

All synchronous services

22

All data circuit synchronous services

24

All data circuit asynchronous services

25

All dedicated packet access services

26

All dedicated PAD access services

27

Last Caller Information


This service lets the subscriber obtain information about the last call to
the subscriber, including:
The number of the caller
Time of last call
Type of call received

MultiSIM
Subscriptions

If the SIM called is one member of a MultiSIM subscription, the last


caller number service returns information for the last call to the
published number.
The HLR records the callers MSISDN and the SIM identity (SIM ID) of
the SIM that the call was routed to. The SIM ID is not displayed on the
called subscribers handset in response to a last caller enquiry USSD
command, but it can be checked by customer care if a query arises.
If a MultiSIM subscriber makes an outgoing call, the SIM ID is not part
of the calling line identity and cannot be displayed by the called party or
by customer care.

Linked
Subscriptions

A subscriber can be part of a linked subscription, such as the


automotive twin SIM (ATS) service or the mutually exclusive secondary
SIM service (MESS), where a published number is associated with two
or more MSISDNs.

Home Location Register (Linux) V1.1 Support Guide

Appendix H USSD Information

631

For a MESS service subscriber, the information returned by the last


calling number service is for the last call to the published number.
For an ATS service subscriber, the information returned by the last
calling number service can be for the last call to the published number
or to the subscribers own MSISDN, depending on how the network is
configured.

Displayed
Number

The last caller service displays one of three types of caller number:

Number Type

Description

Network number

Callers number passed in the Calling Party Number parameter of a


SendRoutingInformation (SRI)

Generic number

Callers number provided by a special connection arrangement. For


example, a PABX user might have a special arrangement to insert
their private wire number in the generic number field.

Presentation number

For example, a number inserted by a company that owns a PBX. In


the UK, the presentation number could be an 0870 number, which is
not tied to any geographical location.

The HLR determines which number to display as the last caller using
the following rules:
Presentation
Number

Network Number

Displayed Last Caller


Number

AVAILABLE

AVAILABLE, UNAVAILABLE or WITHHELD

presentation number

WITHHELD

AVAILABLE, UNAVAILABLE or WITHHELD

Withheld

UNAVAILABLE

AVAILABLE

network number

UNAVAILABLE

WITHHELD

Withheld

UNAVAILABLE

UNAVAILABLE

Unavailable

LCN Erase Flag

This flag is attached to the Last Caller Information so that it can be


erased. When erased, a subscriber is prevented from accessing the
Last Caller Information.

USSD Table
Tokens

The table below list tokens in the USSD table for the last caller service.

TOKEN

Example VALUE

Description

LAST_CALL _CMD1

*#1471#

1st format command for retrieval of last calling


number.

LAST_CALL _CMD2

*#147#

2nd format command for retrieval of last calling


number.

LAST_NUMBER_ERASED_
TEXT

"Last called
number erased

Text response when the LCN has been erased.

Home Location Register (Linux) V1.1 Support Guide

632

Appendix H USSD Information

NO_SRI_TEXT

"No calls since"

Text response for no last call information.

LAST_ RESTRICTED_TEXT

"Number withheld"

If caller withheld their number, this text is


displayed.

LAST_ NO_NUMBER_TEXT

"No number
available"

A number was not present in last call

LAST_ NOT_CONT_TEXT

"Number not
controlled"

A number supplied, but not controllable by


sender (for example, sender is calling from a
network that does not permit subscribers to
withold their number).

LAST_ SERVICE_FAIL_TEXT

"Last call service


failed"

Displayed if other table entries are not correctly


configured.

LAST_ SPEECH_TEXT

Text response for last speech call. Similar to


LAST_ DATA_TEXT

LAST_ FAX_TEXT

Text response for last fax call. Similar to LAST_


DATA_TEXT

LAST_ DATA_TEXT

Text displayed if last call was data. For


example:
Information
Text or Number
available
DDMmmYY HH:MM
Call type

Display on phone
No number
22Mar98 08:55
D

LCN_ERASE_SET_CMD

*#747#

Set the Erase LCN flag.

LCN_ERASE_CLEAR_CMD

*#748#

Clear the Erase LCN flag.

LCN_ERASE_QUERY_CMD

*#749#

Query the state of the Erase LCN flag.

LCN_ERASE_SET_TEXT

"Last Caller
Number Erase Flag
Set

Response to the LCN_ERASE_SET_CMD or


LCN_ERASE_QUERY_CMD.

LCN_ERASE_CLEAR_TEXT

"Last Caller
Number Erase Flag
Clear

Response to the LCN_ERASE_CLEAR_CMD


or LCN_ERASE_QUERY_CMD.

LCN_ERASE_FAIL_TEXT

"Last Caller Erase


Flag Change Not
Possible"

Response to the LCN_ERASE_SET_CMD or


LCN_ERASE_CLEAR_CMD if the flag could
not be changed.

Calling Line Identity Restriction


This service controls CLIR (Calling Line Identity Restriction), which the
subscriber uses to prevent their directory number being displayed by
the called party.
RESTRICTED (CLIR_DEF_RESTR_CMD) means that the subscribers
number is not seen by the called party unless the subscriber adds a
special prefix to the called number.

Home Location Register (Linux) V1.1 Support Guide

Appendix H USSD Information

633

ALLOWED (CLIR_DEF_ALLOW_CMD) means that the called party


can see the subscribers number unless the subscriber adds a special
prefix to the called number.
PERMANENT (CLIR_PERMANENT_CMD) means that RESTRICTED
is permanently applied to all calls and can be changed only using an
administration command, not from the subscribers handset.
Note: If a subscribers number was withheld, to prevent it being
displayed by the called party, TIMON does not log the calling number.
TIMON does, however, log how the rules for calling line identity (CLI)
were interpreted when determining whether to provide the callers
number. (See SET:TRACE on page 269).
The subscriber can select the CLIR service using USSD short codes or
CFU short codes.
TOKEN

Example VALUE

Description

CLIR_DEF_ALLOW_CMD

*1472#

Command to default CLI to ALLOWED. The


subscribers directory number is displayed by
the called party.

CLIR_DEF_RESTR_CMD

*1473#

Command to default CLI to RESTRICTED.


The subscribers directory number is not
displayed by the called party.

CLIR_PERMANENT_CMD

*1474#

Command to default CLI to be permanently


RESTRICTED. The subscribers directory
number is not displayed by the called party
and the restriction can be removed only using
an administration command.

CLIR_ENQUIRE_CMD

*1475#

Command to query the CLI mode.

CLIR_DEF_ALLOW_TEXT

Reveal On

Text response indicating successful selection


of allowed CLI.

CLIR_DEF_RESTR_TEXT

Reveal Off

Text response indicating successful selection


of restricted CLI.

CLIR_PERMANENT_TEXT

Reveal
Permanently Off

Text response indicating successful selection


of permanently restricted CLI.

CLIR_NO_CONTROL_TEXT

Sorry, No Control
Allowed

Text response indicating that no control of


CLIR is allowed.

CLIR_CTR_FAIL_TEXT

Reveal Control
Service Failure

Text response indicating invalid presentation


mode.

CLIP Restriction Override


The CLIP supplementary service allows the callers number to be
displayed by the called party before answering the call. However, the
caller can use the CLI Restriction service (CLIR) to prevent their
number from being displayed. Instead, a message that the caller has
withheld their number might be displayed.

Home Location Register (Linux) V1.1 Support Guide

634

Appendix H USSD Information

OVERRIDE is a flag associated with the CLIP supplementary service


and is set using the UPDATE:SUB command (page 215).
The OVERRIDE flag allows authorised users, such as emergency
services, to display whatever calling number is available, regardless of
whether the caller withheld the number.

Data Returned by
OVERRIDE

The OVERRIDE service returns the following information, if available,


in the USSD response from the HLR:
Date and time of last call
Network number with CLI classification and call type
Presentation number with CLI classification
Indication that the number was withheld and is available due to the
override capability
The response to the USSD request for a last caller number is:
<network_number>
<network_number_CLI_classification>
<network_number_override> <presentation_number>
<presentation_number_CLI_Classification>
<presentation_number_override> <time>

Parameter

Values

Description

network_number

MSISDN or string

Either the network number or a


string indicating why there is no
number.

network_number_CLI_
classification

AVAILABLE, UNAVAILABLE or
WITHHELD

Status of the network number.

network_number_
override

string

Indicates whether the network


number was withheld. (The
OVERRIDE service displays the
network number regardless of
whether it was withheld.)

presentation_number

MSISDN or string

Either the presentation number


or a string indicating why there is
no number.

presentation_number_
CLI_Classification

AVAILABLE, UNAVAILABLE or
WITHHELD

Status of the presentation


number.

presentation_number_
override

string

Indicates whether the


presentation number was
withheld. (The OVERRIDE
service displays the network
number regardless of whether it
was withheld.)

time

Home Location Register (Linux) V1.1 Support Guide

Formatted time of the last call.

Appendix H USSD Information

Monitoring
Customers with
OVERRIDE

635

The IMSIVIEW utility can be used to generate a report of all


subscribers with the OVERRIDE service.

Anonymous Call Reject (ACR)


Anonymous call reject (ACR) is a Vodafone proprietary supplementary
service and is enabled and disabled by the subscriber using USSD
commands.
For a description of the ACR service, see Anonymous Call Reject
(ACR) on page 6.
TOKEN

Example VALUE

Description

ACR_SET_CMD

*#991#

ACR activation request

ACR_SET_TEXT

ACR Set

Successful ACR activation response or reply


from query if ACR activated

ACR_FAIL_TEXT

ACR set failed

ACR activation failure if ACR SS is not


provisioned

ACR_CLEAR_CMD

*#992#

ACR deactivation request

ACR_CLEAR_TEXT

ACR cleared

Successful ACR deactivation response or reply


from query if ACR deactivated

ACR_QUERY_CMD

*#993#

ACR interrogation request

RECALL Voicemail Service


The RECALL voicemail service allows subscribers who are unable to
answer a call directly to use a mailbox system to receive and store
messages. In the UK this service is called RECALL. The message
service uses a Mailbox Location Register (MLR) for message
management.
TOKEN

Example VALUE

Description

RECALL_CMD(0)

#1210#

Clear diverts to mailbox command.

RECALL_CMD(1)

*1211#

Set diverts to mailbox command.

RECALL_CMD(2)

*1212#

Set CFU divert to mailbox.

RECALL_CMD(3)

#1213#

Clear CFU divert to mailbox.

RECALL_CMD(4)

#1214#

Clear GROUP NOTIFY.

RECALL_CMD(5)

#1215#

Set GROUP NOTIFY.

RECALL_CMD(7)

*1217#

Set voice notification to mailbox.

RECALL_CMD(8)

*1218#

Set SMS notification to mailbox.

RECALL_CMD(9)

*1219#

Set alert and deliver notification to mailbox.

Home Location Register (Linux) V1.1 Support Guide

636

Appendix H USSD Information

TOKEN

Example VALUE

Description

RECALL_RES(1)

You have no mailbox

Subscriber does not have mailbox allocated.

RECALL_RES(2)

MLR Parse Failure

MLR does not understand request from HLR.

RECALL_RES(10)

Recall Diverts Cleared

Diverts to mailbox cleared successfully.

RECALL_RES(11)

Recall Diverts Clear Failed

Failed to clear diverts to mailbox.

RECALL_RES(12)

Recall Diverts Set

Divert to mailbox set.

RECALL_RES(13)

Recall Diverts Set Failed

Failed to set diverts to mailbox.

RECALL_RES(14)

Unconditional Recall Diverts Set

Unconditional divert to mailbox set.

RECALL_RES(15)

Unconditional Recall Diverts Set


Failed

Failed to set unconditional divert to mailbox.

RECALL_RES(16)

Unconditional Recall Diverts


Cleared

Unconditional divert to mailbox cleared.

RECALL_RES(17)

Unconditional Recall Diverts


Clear Failed

Failed to clear unconditional divert to


mailbox.

RECALL_RES(18)

Group Notify Cleared

Group Notify, for a linked subscriptions


mailbox, has been cleared.

RECALL_RES(19)

Group Notify Clear Failed

An attempt to clear Group Notify, for a linked


subscriptions mailbox, failed.

RECALL_RES(20)

Group Notify Set

Group Notify, for a linked subscriptions


mailbox, has been set.

RECALL_RES(21)

Group Notify Set Failed

An attempt to set Group Notify, for a linked


subscriptions mailbox, failed.

RECALL_RES(24)

Voice Alert Set

Voice alert set for mailbox. Subscriber is


alerted that messages are waiting by voice.

RECALL_RES(25)

Voice Alert Set Failed

Failed to set voice alert.

RECALL_RES(26)

SMS Alert Set

SMS alert set for mailbox. Subscriber is


alerted that messages are waiting by SMS.

RECALL_RES(27)

SMS Alert Set Failed

Failed to set SMS alert.

RECALL_RES(28)

Alert and Deliver Set

Alert and deliver set for mailbox. Subscriber


alerted and messages delivered without the
need to enter message retrieval code.

RECALL_RES(29)

Alert and Deliver Set Failed

Failed to set alert and deliver.

RECALL_FAIL_
TEXT

"Voicemail via USSD service


failed

Response if the command could not be


actioned successfully.

RECALL_NOTU_
TEXT

"No Voicemail

Response if the subscriber does not have the


RECALL supplementary service provisioned.

RECALL_NONE_
TEXT

"No mailbox

Response if the subscriber does not have a


RECALL mailbox.

Home Location Register (Linux) V1.1 Support Guide

Appendix H USSD Information

637

Service Provider Information


A service provider command with a number of text responses is
available on the HLR, but this USSD service is not used by Vodafone.
TOKEN

Example VALUE

Description

SPINFO_CMD

*#800#

Command to retrieve service provider information.

SPINFO_OK_TEXT

SP name: %s

Text response containing service provider information.


The response text is from the Service Provider (SP)
Table.

SPINFO_FAIL_TEXT

SP Info service failed

Text response indicating invalid SP code.

Location Information
This service allows a subscriber to access their VLR and SGSN
location information. The response will be of the form:
CS:<number_string> <name_string>
<loc_status_string> time_string/n
PS:<number_string> <name_string>
<loc_status_string> time_string
TOKEN

Example VALUE

Description

LOCINFO_CMD

*#105#

Command to retrieve the VLR and SGSN location


information.

LOCINFO1_TEXT

"CS:%s\nPS:%s

General format of the response.

LOCINFO2_TEXT

"%s %s %s %s"

Format of the location information displayed on each


line.

Operation and Maintenance Information


The following tokens are available for operational and maintenance
information.
TOKEN

Example VALUE

Description

HLR_ID_CMD

*#101#

Command to retrieve the name of the HLR that


hosts the subscribers SIM

HLR_ID_TEXT

"%s %04X %s"

Text response indicating host HLR.

VLR_ID_CMD

*#102#

Command to retrieve the name of the VLR where


the subscriber is currently registered

VLR_ID_TEXT

"%s %s"

Text response indicating current VLR.

VLR_ID_FAIL_TEXT

"VLR network name


service unavailable"

Text response indicating failure to obtain VLR


information.

Home Location Register (Linux) V1.1 Support Guide

638

Appendix H USSD Information

TIME_CMD

*#103#

Command to retrieve local time.

TIME_TEXT

"%s"

Text response indicating local time.

TIME_FAIL_TEXT

"Local time service


unavailable"

Text response indicating failure to obtain time


information.

MLR_ID_CMD

*#104#

Command to retrieve host MLR and mailbox


number.

MLR_ID_TEXT

"%s %s"

Text response indicating the host MLR.

MLR_ID_FAIL_TEXT

"MLR Service Failed"

Text response indicating failure to obtain mailbox


information.

MLR_ID_NONE_TEXT

"No Mailbox"

Text response indicating that the subscriber does


not have a voice mailbox.

MLR_ID_NOTU_TEXT

"No RECALL"

Text response indicating that the subscriber does


not have the RECALL supplementary service.

UNKNOWN_TEXT

Command Unknown

Text response indicating that a USSD command


was not recognized.

On/Off Net Information


The following tokens are available for on/off network information. (Note
that although the tokens are supported, the functionality is not yet
supported by the HLR).
TOKEN

Example VALUE

Description

ONNET_CMD

*#111-

On/off net information command

ONNET_BADNUM_TEXT

"Invalid Number given"

Text response for bad number in


command.

ONNET_ON_TEXT

"ON-net"

Text response if MSISDN is defined in the


HPLMN.

ONNET_OFF_TEXT

"OFF-net"

Text response if MSISDN if not defined in


the HPLMN.

ONNET_HELP_TEXT

"%s*0%s#"

Text response for net help.

ONNET_FAIL_TEXT

"Service Failure"

Text response if failure to perform


request.

MultiSIM Service
The MultiSIM service allows a published MSISDN to be associated with
more than one SIM.
The subscriber nominates which SIM will receive calls, or other
services, using USSD commands.
TOKEN

Example VALUE

Description

MULTI_NOM_CMD

*131-

Nominate the requesting SIM for all BSGs

Home Location Register (Linux) V1.1 Support Guide

Appendix H USSD Information

639

TOKEN

Example VALUE

Description

MULTI_NOM_SIM_TEXT

SIM %d is nominated

Message confirming that a SIM has been


nominated

MULTI_NOM_SIM_NONE

SIM %d does not


exist

None of the SIMs in the MultiSIM


subscription has the ID specified in the
nominate command

MULTI_FIND_NOM_CMD

*#131-

Find which SIM is nominated for which


basic service groups (BSGs)

MULTI_FIND_NOM_TEXT

SIM %d for %s

%s represents the BSG list

MULTI_MY_ID_CMD

*#130#

Find ID of requesting SIM

MULTI_MY_ID_TEXT

I am SIM %d

Message that returns the ID of the SIM

MULTI_NOTU

Only 1 SIM

Subscriber does not use the MultiSIM


service

MULTI_INV_NOMINATE_FORM
AT

Invalid command
format

The format of the nomination command is


incorrect

MULTI_INV_QUERY_FORMAT

Invalid command
format

The format of the query command is


incorrect

MULTI_INV_MMI_FORMAT

Unknown basic
service group

The specified <bsg_mmi> codes are


incorrect

MULTI_EMPTY_TEXT

None

The command does not return any values,


for example if no SIM is nominated for a
specified basic service group

MULTI_TOO_MUCH_TEXT

Response too big

The response to the command is too big


to transmit to the handset

Note: The hyphen (-) at the end of a command string represents


characters that continue the USSD command.
The table below lists a possible set of USSD commands.
Command

Description

*131-

- represents continuation characters, such as *<id>*<mmi_bsg># and


*<mmi_bsg>#.

*131#

Nominate the requesting SIM for all BSGs

*131**<mmi_bsg>#

Nominate requesting SIM for given BSGs. Table 67 on page 640 lists the
<mmi_bsg> codes

*131*<id>*#

Nominate given SIM for all BSGs

*131*<id>*<mmi_bsg>#

Nominate given SIM for given BSGs. Table 67 on page 640 lists the
<mmi_bsg> codes

*#131#

Find nomination for all BSGs

*#131*<mmi_bsg>#

Find nomination for specified BSGs. Table 67 on page 640 lists the <mmi_bsg>
codes

*#130#

Find ID of requesting SIM

Home Location Register (Linux) V1.1 Support Guide

640

Appendix H USSD Information

The HLR application expects a terminating # for nominating the requesting


SIM for all BSGs, or an *<id>*<mmi_bsg># continuation string where
<id> and <mmi_bsg> are optional parameters, for operations on a SIM ID
for particular BSGs (as shown above).

Table 67. MultiSIM Codes for Basic Service Groups


mmi_bsg

Basic Service Groups

<no code>

SPEECH SMS FAX DCICA DCICS PADACC DPACK UNREST AUXSPEECH

10

SPEECH FAX SMS

11

SPEECH

12

FAX SMS

13

FAX

16

SMS

19

SPEECH FAX

17

exception not supported

18

exception not supported

20

DCICA DCICS PADACC DPACK UNREST

21

DCICA PADACC

22

DCICS DPACK

24

DCICS

25

DCICA

26

DPACK (not in 22.030)

27

PADACC (not in 22.030)

99

exception not supported

NGVM Phase 1a Services


Subscribers of RECALL Voicemail can use USSD commands to
manage their voicemail preferences. See RECALL Voicemail Service
for details. During phase 1a of the Next Generation Voicemail
deployment, subscribers will not be able to use these USSD
commands and so the HLR should be configured to respond with a
suitable response to tell the user to use the equivalent shortcode.
See NGVM Phase 1b Services for an explanation of the phase 1b
services.
The MLR_ID_CMD should also behave differently for NGVM
subscribers. In this case, the HLR responds with the NGVM long dial
number.These responses are defined in the [REPLY_USSD] section of
the USSD table as <COMMAND> <NAME> <REPLY_TEXT_ID>
(VMTYPE:<VOICEMAIL_TYPE>) . Since the responses only apply to
NGVM subscribers, the optional VMTYPE:NGVM field should be
defined.
Home Location Register (Linux) V1.1 Support Guide

Appendix H USSD Information

Example
COMMAND

641

Example NAME

Example REPLY_TEXT

Description

*#104#

"Query mailbox
number

"Voicemail 44375123456

Query mailbox
number.

*#1210#

"Cl dvts to mbx

"This functionality is not


available at the moment,
please dial 1210 instead

Clear diverts to
mailbox
command.

*#1211#

"Set dvts to mbx

"This functionality is not


available at the moment,
please dial 1211 instead

Set diverts to
mailbox.

*#1212#

"Set CFU dvt to


mbx

"This functionality is not


available at the moment,
please dial 1212 instead

Set CFU divert to


mailbox.

*#1213#

"Cl CFU dvt to mbx

"This functionality is not


available at the moment,
please dial 1213 instead

Clear CFU divert


to mailbox.

*#1214#

"Cl grp notify

"This functionality is not


available at the moment,
please dial 1214 instead

Clear Group
Notify.

*#1215#

"Set grp notify

"This functionality is not


available at the moment,
please dial 1215 instead

Set Group Notify.

*#1217#

"Set v nfy to mbx

"This functionality is not


available at the moment

Set Voice
notification to
mailbox.

*#1218#

"Set SMS vfy to


mbx

"This functionality is not


available at the moment

Set SMS
notification to
mailbox.

*#1219#

"Set a+d nfy to mbx

"This functionality is not


available at the moment

Set alert and


deliver notification
to mailbox.

Home Location Register (Linux) V1.1 Support Guide

642

Appendix H USSD Information

USSDs Processed Outside the HLR


USSDs not processed by the HLR are listed in the [RELAYED_USSD],
[RELAYED_TCPIP_USSD] and [FORWARD_USSD] sections of the
USSD table. The format of the sections are defined in the Table
Maintenance chapter, but all contain <COMMAND>, <NAME> and
<FAIL_TEXT> fields, along with a field to define the processor that
handles the request. In the case of [RELAYED_TCPIP_USSD],
additional fields are required to define the format of the request and
response.

Call Transfer
The Call Transfer USSD is defined in the [RELAYED_USSD] section
and is relayed to the specified Call Transfer Service global title. This
should match the CT_GT defined the HLR configuration table.
COMMAND

NAME

FAIL_TEXT

Description

*140#

Call
Transfer

"\x01Call Transfer
Service is not available"

Command for call transfer

Linked Subscriptions
These USSDs are provided so that members of linked subscriptions
can perform various functions that may include nomination and denomination of members within the group. These commands are defined
in the [RELAYED_USSD] section and are relayed to the specified
global title. This should match the LINKSUB_GT defined in the HLR
configuration table.
Only those subscribers with a PNUM specified will be forwarded. (Note
that this is not a supplementary service).
COMMAND

NAME

FAIL_TEXT

Description

*131#

"LS Nominate Me"

Multi SIM service failure

Nominate current mobile


handset

*131*<ID>#

"LS Nominate SIM"

Multi SIM service failure

Nominate SIM identified by


<ID>

*#131#

"LS Who Nominated"

Multi SIM service failure

Enquire which is the currently


nominated handset

*#130#

"LS Who am I"

Multi SIM service failure

Displays the SIM <ID> of the


current handset

Home Location Register (Linux) V1.1 Support Guide

Appendix H USSD Information

643

PAYT
PAYT USSD commands are defined in the [RELAYED_USSD] section
and allow subscribers to check the status of their account. The GT
should match the PAP_GT defined in the HLR configuration table.
COMMAND

NAME

FAIL_TEXT

Description

*#1345#-

PAYT Cmd 1

Pay As You Talk USSD


Service Failed

Returns the subscribers remaining call


credit.

*#134#-

PAYT Cmd 2"

Pay As You Talk USSD


Service Failed

Returns the subscribers remaining


access time.

Positioning Services
Positioning services use the address of the VLR that the subscriber is
registered on. Such services are only available for a VLR that supports
MAP3, EMAP and mobile positioning services.
Location information cannot be provided for the following types of
MSISDN:
service request number (SRN)
published number of a linked subscription
administration barred subscriber
GPRS only subscriber
The following [PROCESSED_USSD] codes enable and disable the
positioning services:
TOKEN

Example
VALUE

MPS_ENABLED_CMD

*120#

Sets the Position Allowed Indicator (PAI) to ON,


which allows the subscriber to use mobile
positioning services.

MPS_DISABLED_CMD

#120#

Sets the Position Allowed Indicator (PAI) to


OFF, which prevents the subscriber from using
mobile positioning services.

MPS_QUERY_CMD

*#120#

Displays the value of the PAI flag, which


determines whether a subscriber can use
MPS_ENABLED_CMD and
MPS_DISABLED_CMD to change the value of
PAI.

MPS_ALL_SUPP_CTRL_TEXT

"Positioning Allowed"

MPS_ALL_NOTSUPP_CTRL_TEXT

"Positioning Allowed"

MPS_ALL_SUPP_NOTCTRL_TEXT

"Positioning Allowed"

MPS_ALL_NOTSUPP_NOTCTRL_TEXT

"Positioning Allowed"

Description

Home Location Register (Linux) V1.1 Support Guide

644

Appendix H USSD Information

TOKEN

Example
VALUE

MPS_DIS_CTRL_TEXT

"Positioning Disallowed"

MPS_DIS_NOTCTRL_TEXT

"Positioning Disallowed"

MPS_NOTCTRL_TEXT

"Positioning Not Controllable"

Subscriber
Location Privacy
Profile

Description

Subscribers can control the privacy of their location data on the LES
using USSDs. These are defined in the [RELAYED_TCPIP_USSD]
section. The commands are relayed to the Location Enabling Server in
XML.

Example
VALUE

Example
Name

Description

*#500#

LES Get Sub

Returns the status of the subscribers location privacy status.

*#500*

LES Set Sub

Allows the subscriber to use mobile positioning services.

#500#

LES Dis Prv

Prevents the subscriber from using mobile positioning services.

*500#

LES Ena Prv

Create an entry in the LES for the subscriber.

Privacy in the Location Enabling Server (LES) on page 38 describes


how these commands work.

Changing the Privacy Flag


text message over
TCP/IP using HTTP

USSD query to
change privacy flag

HLR
USSD response to
change privacy flag

LES
text response over
TCP/IP using HTTP

NGVM Phase 1b Services


After phase 1b of the Next Generation Voicemail deployment,
subscribers will once again be able to use USSD codes to manage
their voicemail preferences. The commands are defined in the
[RELAYED_TCPIP_USSD] section and are relayed to the NGVM
Provisioning Server.

Home Location Register (Linux) V1.1 Support Guide

Appendix H USSD Information

645

Since these actions only apply to NGVM subscribers and use the same
codes as used by subscribers of RECALL Voicemail, the optional
VMTYPE:NGVM field should be specified. See RECALL Voicemail
Service for details of the RECALL services.
Example
COMMAND

Example NAME

Description

*#1210#

"Cl dvts to mbx

Clear diverts to mailbox command.

*#1211#

"Set dvts to mbx

Set diverts to mailbox.

*#1212#

"Set CFU dvt to mbx

Set CFU divert to mailbox.

*#1213#

"Cl CFU dvt to mbx

Clear CFU divert to mailbox.

*#1214#

"Cl grp notify

Clear Group Notify.

*#1215#

"Set grp notify

Set Group Notify.

*#1217#

"Set v nfy to mbx

Set Voice notification to mailbox.

*#1218#

"Set SMS vfy to mbx

Set SMS notification to mailbox.

*#1219#

"Set a+d nfy to mbx

Set alert and deliver notification to


mailbox.

USSD Callback
The USSD callback command is defined in the [RELAYED_USSD]
section and allows a prepay subscriber to make calls when roamed
outside the home network (on a non-CAMEL network). The GT should
match the CAMEL_GSMSCF defined in the HLR configuration table.
COMMAND

NAME

FAIL_TEXT

Description

*#123*<called_
number>#-

PAYT USSD
Callback

PAYT Callback
Service Failed

Command is relayed to the service


execution platform (SEP) that supports
the USSD callback service. The SEP
then controls credit checking and
callback to the subscriber.

Missed Call Server Commands


These commands are defined in the [RELAYED_USSD] section and
are relayed to the Missed Call Server.

COMMAND

NAME

FAIL_TEXT

Description

*148#

"MCS On

"MCS USSD Failure

Turn Slam down On.

#148#

"MCS Off

"MCS USSD Failure

Turn Slam down Off.

*#148#

"MCS Setting

"MCS USSD Failure

Query Slam down setting.

*148*1#

"MCS On Single

"MCS USSD Failure

Home Location Register (Linux) V1.1 Support Guide

646

Appendix H USSD Information

COMMAND

NAME

FAIL_TEXT

*148*2#

"MCS On Multiple

"MCS USSD Failure

Description

Chameleon Commands
Chameleon allows two MSISDNs on a single SIM. These commands
are defined in the [RELAYED_USSD] section and are relayed to the
SEP.
COMMAND

NAME

FAIL_TEXT

*149*1*1#

"Work + Home

"Network Error for dual


line. Please contact
customer support.

*149*1*2#

"Work

"Network Error for dual


line. Please contact
customer support.

*149*2*1#

"Home + Work

"Network Error for dual


line. Please contact
customer support.

*149*2*2#

"Home

"Network Error for dual


line. Please contact
customer support.

Description

MVPN Services
These commands are defined in the [RELAYED_USSD] section and
are relayed to the SEP.
COMMAND

NAME

FAIL_TEXT

Description

*#111*-

"MVPN Service
Status

"Service not currently


available

Query MVPN status.

*111*-

"Enable MVPN
Services

"Service not currently


available

Enable MVPN.

#111*-

"Disable MVPN
Service

"Service not currently


available

Disable MVPN.

*111#

"Call Pick Up

"Service not currently


available

Home Location Register (Linux) V1.1 Support Guide

647

Appendix I

Operator Determined Bars

This appendix lists the operator determined bars (ODBs) used to


control the capabilities of individual subscriptions. Bars are applied to
subscribers using the administration interface (see ADD:BAR on
page 435 and REMOVE:BAR on page 437).

Home Location Register (Linux) V1.1 Support Guide

648

Appendix I Operator Determined Bars

ODB Names
The table below lists the names of operator determined bars and
describes what they do.
Bar

Description

ODBAIC

Bar all incoming calls.

ODBAOC

Bar all outgoing calls.

ODBCFVLRROAM

Suppress diverts in VLR when roamed outside home PLMN. HLR diverts are
still allowed.

ODBCNUM1

Bar registration of diverts which match entries in C-number table one (CNUM1).

ODBCNUM2

Bar registration of diverts which match entries C-number table two (CNUM2).

ODBCNUM3

Bar registration of diverts which match entries in C-number table three


(CNUM3).

ODBDCF

Bar the activation of any default call forwards that have been set. See Default
Call Forwarding on page 57.

ODBECT

Bar any call transfer.


Only one of the bars ODBECT, ODBECTC, ODBECTCI, and ODBECTCZ. can
be in force at any time. The order of precedence of these bars is:
ODBECT (highest)
ODBECTC
ODBECTCI
ODBECTCZ (lowest)

ODBECTC

Bar call transfer where at least one of the two calls is charged to the served
subscriber. The served subscriber uses the ECT supplementary service and
transfers the call. The served subscriber is subscriber A in Figure 2 on page 11.
Only one of the bars ODBECT, ODBECTC, ODBECTCI, and ODBECTCZ. can
be in force at any time. The order of precedence of these bars is:
ODBECT (highest)
ODBECTC
ODBECTCI
ODBECTCZ (lowest)

ODBECTCI

Bar call transfer if at least one of the two calls is charged to the served
subscriber at international rates.
Only one of the bars ODBECT, ODBECTC, ODBECTCI, and ODBECTCZ. can
be in force at any time. The order of precedence of these bars is:
ODBECT (highest)
ODBECTC
ODBECTCI
ODBECTCZ (lowest)

ODBECTCZ

Bar call transfer if at least one of the two calls is charged to the served
subscriber at inter-zonal rates.
Only one of the bars ODBECT, ODBECTC, ODBECTCI, and ODBECTCZ. can
be in force at any time. The order of precedence of these bars is:
ODBECT (highest)
ODBECTC
ODBECTCI
ODBECTCZ (lowest)

Home Location Register (Linux) V1.1 Support Guide

Appendix I Operator Determined Bars

649

Bar

Description

ODBECTC2

Bar call transfer if both calls are charged to the served subscriber.

ODBECTSM

Bar call transfer if the served subscriber already has a transferred call at the
same MSC/VLR.

ODBGPRS

Bar all GPRS activity

ODBGSM

Bar all GSM activity

ODBHPLMN1-4 are bars that can be configured by the home PLMN. These bars do not affect diverts.
ODBHPLMN1

HPLMN specific bars

ODBHPLMN2
ODBHPLMN3
ODBHPLMN4
ODBICROAM

Bar all incoming calls when roamed out of home PLMN.

ODBICROAZ

Bar incoming calls when roamed out of the zone that contains the home PLMN.

ODBICRXSMS

Bars all incoming calls when roamed outside the home PLMN, but permits MTSMS

ODBMOSMS_00 to
ODBMOSMS_15

Bar mobile originated SMS to premium rate services. 16 bars are available to
allow flexibility, to bar some tariffs but not others for example.

ODBMOSMSROAM

Bar mobile originated SMS when roamed.

ODBMOXSMS

Bar all mobile originated calls except SMS.

ODBMOXSMSROAM

Bar all mobile originated calls except mobile originated SMS when roamed.

ODBNICBAOC

Bar all outgoing calls that are network initiated calls. All outgoing calls that are
subject to a TestCallCase message are barred.
For example, the Vodafone UK Prepay roaming service uses the TestCallCase
message sent from the SEP to the HLR to ensure that the subscriber is allowed
to call the dialled number (the subscriber might be barred from making outgoing
calls in the home network).

ODBOCROAM

Bar all outgoing calls when roamed out of home PLMN.

ODBOIC

Bar all outgoing international calls.

ODBOICXHC

Bar all outgoing international calls except to home PLMN country.

ODBOPENT

Bar outgoing premium rate calls (entertainment).

ODBOPENTSMS

Bar adult content SMS messages.

ODBOPINFO

Bar outgoing premium rate calls (information).

ODBOZC

Bar outgoing interzonal calls.

ODBOZCXHC

Bar outgoing interzonal calls except to home PLMN country.

ODBOZICXHC

Bar outgoing international calls except to home PLMN country. Also, bar
outgoing interzonal calls. This means:
international calls to any country other than the home PLMN country do not
work, regardless of the subscribers location.
international calls to the home PLMN country work only if a subscriber is in
the zone containing the home country

Home Location Register (Linux) V1.1 Support Guide

650

Appendix I Operator Determined Bars

Bar

Description

ODBPREMROAM

Bar premium rate calls when roamed.

ODBPREMSMSHI

Bar higher cost premium rate SMS messages.

ODBPREMSMSLO

Bar lower cost premium rate SMS messages.

ODBROAMALL

Prevents a subscriber registering anywhere, including the home PLMN.

ODBROAMHC

Bar roaming out of home PLMN country.

ODBROAMHP

Bar roaming out of home PLMN.

ODBSS

Bar subscriber supplementary service management.

ODBXENOSMS

Bar all outgoing international SMS calls except to home PLMN.

Home Location Register (Linux) V1.1 Support Guide

Appendix I Operator Determined Bars

651

IN Bars
The ODBIN bars below are equivalent to the GSM standard bars with
the same name (except for the letters BIN). ODBIN bars can be set and
removed by other network entities without interfering with the GSM
bars set by the network operator. The ODBIN bars can be controlled
from the administration interface (see commands ADD:BAR and
REMOVE:BAR in Chapter 23, General Commands).
Bit

Bar

Description

23

ODBINBAIC

Bar all incoming calls

20

ODBINBAOC

Bar all outgoing calls

24

ODBINBICROAM

Bar all incoming calls when roamed out of home PLMN

25

ODBINBOCROAM

Bar all outgoing international calls except when roamed out of home PLMN

21

ODBINBOIC

Bar all incoming calls

22

ODBINBOICXHC

Bar all outgoing international calls except to home PLMN

26

ODBINBOPENT

Bar outgoing premium rate calls (entertainment)

27

ODBINBOPINFO

Bar outgoing premium rate calls (information)

28

ODBINBSS

Bar subscriber supplementary service management

29

ODBINLS

Bar incoming for non-nominated member of a mutually exclusive secondary


SIM (MESS) member.

31

ODBINMOSMS

Bar mobile originated SMS, whether roamed or not.

32

ODBINMTSMS

Bar mobile terminated SMS, whether roamed or not.

30

ODBINPAYT

For Pay As You Talk subscribers, bar PDPs that are not free of charge.

Home Location Register (Linux) V1.1 Support Guide

652

Home Location Register (Linux) V1.1 Support Guide

Appendix I Operator Determined Bars

653

Appendix J Performance Checks


To provide normal service to the network, the platform must not be
overloaded. This appendix lists platform loading checks to be made
once a week.
Check

Procedure

CPU usage of the HLRA process must be not


more than 50% when averaged over 120s
during a busy period.

The System Manager should perform this check.

Application processes should not be memorypaging during the sample.

The System Manager must perform this check.

Use logview to view the cyclic buffer of event


logging records,
PDS.log.log_file_no in the/opt/
vodafone/pds/log directory.

See Viewing Event Log Files on page 95, or run the


PULSE utility (see page 569) and select 'HWDLOVPHQX > /RJ
ILOHV /2**(5 .

During a busy period, run PULSE with an


interval of 10 seconds and check the general
summary screen for normal HLR operation.

View the availability report, which shows


platform downtime per month.

Support accounts can display current CPU load as


follows:
From Remote Engineer, click 1RGH6WDWLVWLFV and examine
the CPU Utilization graph.

To run PULSE with an interval of 10s, log in using the

pds_manager account and type pulse -r 10. How


to check the counts on the summary screen is described
in Appendix A, Using PULSE, page 569.
See Displaying an Availability Report on page 127.

Home Location Register (Linux) V1.1 Support Guide

654

Home Location Register (Linux) V1.1 Support Guide

Appendix J Performance Checks

655

Appendix K Event Log Files


This appendix describes the HLR event log files.
Note: Event log files provide extensive, low-level information about
HLR activity, much of which is relevant only to third-line support staff.
Consequently, the information in this appendix is selective: it does not
describe every item that may be encountered in a log file. Rather, it
discusses only the elements that are of most use in second-line
support activities.

Event Logging Framework


An event is a message exchanged by the HLR across its interface to
the IP network and the ADC (normally ISAAC).
The OMCS process logs these events in a series of binary files in the
/var/log/pds directory.
The current log file is named PDS.log, and old log files are named
PDS.log.log_file_no. The log file number is incremented each
time a new log is written. For example, PDS.log, PDS.log.1,
PDS.log.2 and so on. The maximum value of log_file_no is
configurable (default = 9): once this maximum is reached, the oldest file
is overwritten.

Using logview

You can view the contents of the log files in human-readable form by
running the logview utility from the pds_manager account. See Viewing
Event Log Files on page 95 for how to view the log files.
The processes, files, and the masks used to filter the information as it is
logged are summarised in Figure 70 on page 656.

Home Location Register (Linux) V1.1 Support Guide

656

Appendix K Event Log Files

Figure 70. Event Logging Processes, Masks and Files


Processes:
PDS_Pnnnn_ADM
PDS_Pnnnn_MGTA
PDS_Pnnnn_MP
PDS_Pnnnn_S7MP

Log Masks:
ADMA_LOG_MASK
OpenVMS
Mailbox for
Log Data

APP_SS7_LOG_MASK
APP_LOG_MASK

PDS_Pnnnn_HLRA
TRAN_LOG_MASK
Log Server
Process:
AS_LOG

SS7I_LOG_MASK

Configure masks using


PDS_CONFIG table

Text filtering, for


example by MSISDN

TIMON

Log Client
Process:
AC_LOGn

RTTRACE

Log Files
GSM_nnn.LOG

How to Use Event Log Files


Because event log files can be configured to record most messages
that the HLR exchanges with the network and ADC, they can be useful
in troubleshooting problems with the HLR. For example:
connection problems with specific number ranges
individual subscriber problems, such as being unable to set/clear
diverts.
However, to be able to use the information contained in log files, you
need to know:
the aspect of HLR functionality involved. For example, if a
subscriber is having problems, whether the problem is updating
location, setting/clearing diverts, receiving calls or whatever.
the signalling messages involved in that functionality. For example,
when a subscriber updates location, the HLR must insert subscriber
data in the VLR.

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

657

When looking at event log files you should consider the following
points:
Messages may not be logged in the order they are processed by the
HLR.
Duplicate events may occur, generated by different suboperations of
the same operation.

Configuring Log Masks


The log masks give some control over what is logged to the event log
files. The logging masks alone do not determine what is written to the
event log file. Certain administration commands can affect this, and bit
1 of the APP_LOG_MASK (Table 69 on page 657) must be set to 1.
Many mask bits determine whether failures are written to the log file or
discarded.
If bit 0 (zero) of a log mask is set to 1, no events controlled by that log
will be discarded, regardless of the values of the other bits. Logging
events puts a load on the HLR, so take care not to overload a live
platform when logging events.

Table 68. ADMA_LOG_MASK


Bit

Description

Bit 0

Log every ADMA transaction

Bit 1

Log only failed ADMA transactions

Bit 2

Log only ADMA transactions with internal software errors

Bit 3

Subscriber has RealTime trace

Bit 4

Subscriber has TiMON trace

Bit 5

Subscriber has interactive trace

Table 69. APP_LOG_MASK

Bit

Description

Bit 0

Platform-wide trace of transaction

Bit 1

Subscriber trace of transaction

Bit 2

Network entity trace of transaction

Bit 3

RealTime trace of transaction

Bit 4

TiMON trace of transaction

Bit 5

Trace of specific transaction

Bit 6

Transaction failures

Home Location Register (Linux) V1.1 Support Guide

658

Appendix K Event Log Files

Table 69. APP_LOG_MASK (Continued)


Bit

Description

Bit 7

Transactions to blacklisted NEs

Bit 8

Invalid signal received

Bit 9

IMSI promotion

Bit 10

UPL changing country code

Bit 11

Register FTN outside home CC

Bit 12

SS operation

Bit 13

UPL, status not REGISTERED

Bit 14

Transaction queued for lock

Bit 15

Transaction DBupdate deferred

Bit 16

Owned lock awaited by another

Bit 17

Couldnt derive a BS from network signalling information (NSI)

Bit 18

Couldnt derive a BC from network signalling information (NSI)

Bit 19

Couldnt derive a BC from network signalling information (NSI)

Bit 20

Couldn't derive a BC from network signalling information (NSI)

Bit 21

Expired IMSI in Update Location or Update GPRS Location

Bit 22

Conflicting TDP data causes a degradation of a CAMEL service

Bit 23

The IMEI is non-white, or is white as a result of IMSI or duplicate


override

Bit 24

An SDM forwarded UDT

Bit 25

An MSU not using the HLRs own global title in the called party
address

Table 70. APP_SS7_LOG_MASK


Bit

Description

Bit 0

Platform-wide trace of SS7

Bit 1

Subscriber Trace of SS7

Bit 2

Network entity trace of SS7

Bit 3

RealTime trace of SS7

Bit 4

TiMON trace of SS7

Bit 5

Decoding failure, ASN.1 or oper

Bit 6

Decoding problem, continuing

Bit 7

ISD result, unsupported service

Bit 8

Invoke (unknown operation)

Bit 9

Previous invoke caused failure

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

659

Table 70. APP_SS7_LOG_MASK (Continued)


Bit

Description

Bit 10

Read subscriber - RecordNotFound

Bit 11

Failure to send via SS7I

Bit 12

AC incorrect for operation

Bit 13

No. of invokes per begin wrong

Bit 14

Oper. not supported in Ver.

Bit 15

Abandon occurred

Bit 16

Rx ResultNotLast

Bit 17

Continue/End mismatch

Bit 18

Component ID mismatch

Bit 19

Invoke not liked - coding?

Table 71. DB_LOG_MASK


Bit

Description

Bit 0

Log all I/O events (e.g. securing database to file)

Bit 1

Log all file access events (e.g. attempts to open and close files)

Bit 2

Log Database Manager State Changes (that is, change of state


from Slave to Active)

Bit 3

Log Database Manager State-machine internals

Bit 4

Log Database Agent Activation (for example, failed DB Sync)

Bit 5

Log Database Agent State-machine internals

Bit 6

Log Database Data Overwritten

Table 72. NET_LOG_MASK

Bit

Description

Bit 0

Log every network operation

Bit 1

Log connections

Bit 2

Log messages

Bit 3

Log Off-Node PIPC Registration

Bit 4

Log Off-Node PIPC Resolution

Bit 5

Log Off-Node PIPC TCPIP

Bit 6

Log Off-Node PIPC input TCPIP

Home Location Register (Linux) V1.1 Support Guide

660

Appendix K Event Log Files

Table 73. SS7I_LOG_MASK


Bit

Description

Bit 0

Log every SS7I transaction

Bit 1

Log SS7 failures to decode messages

Bit 2

Log failure to decode dialogue portion of TCAP message

Bit 3

Log messages with badly structured message components

Bit 4

Log application context negotiation failure

Bit 5

Log receipt of unknown MAP message type

Bit 6

Log receipt of invalid destination dialogue id

Bit 7

Illegal lengths in UDT

Bit 8

Entity trace

Bit 9

Log messages discarded by BEP if in overload

Bit 10

IN7 UDF (user distribution function) successfully routed incoming


messages

Bit 11

IN7 UDF failure to route incoming messages

Bit 12

IN7 UDF in receipt of user message

Bit 13

Application copy changed state (overload on/off)

Bit 14

Log message received from blacklisted entity

Bit 15

Log message with bad calling address

Bit 16

Log message if deemed new, but not TC_BEGIN

Bit 17

Continue/End mismatch

Bit 18

Component ID Mismatch

Bit 19

Invoke not liked

Bit 20-23

Not defined

Bit 24-31

Do not affect logging. Used to control application counters.

Table 74. TRAN_LOG_MASK


Bit

Description

Bit 0

Log no transactions

Bit 1

Default

Bit 2

AlertServiceCentre

Bit 3

UpdateLocation

Bit 4

RestoreData

Bit 5

SendParameters

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

661

Table 74. TRAN_LOG_MASK (Continued)

Bit

Description

Bit 6

SendAuthenticationInformation

Bit 7

SendAuthenticationVectors

Bit 8

PurgeMS

Bit 9

NoteMSPresent

Bit 10

SendRoutingInformation

Bit 11

SupplementaryServices

Bit 12

RegisterSS

Bit 13

EraseSS

Bit 14

ActivateSS

Bit 15

DeactivateSS

Bit 16

InterrogateSS

Bit 17

RegisterPassword

Bit 18

SSUserData

Bit 19

SSUserData Out

Bit 20

TCP Out

Bit 21

SetMessageWaitingData

Bit 22

SRIforPositioning

Bit 23

SRIforSM All

Bit 24

SRIforSM MO

Bit 25

SRIforSM MT

Bit 26

ProvideRoamingNumber

Bit 27

CancelLocation

Bit 28

InsertSubscriberData

Bit 29

DeleteSubscriberData

Bit 30

InitiateCancel

Bit 31

View Subscriber

Bit 32

ProvideSubscriberInformation

Bit 33

View MSISDN

Bit 34

Update Subscriber

Bit 35

ADM_Service

Bit 36

Repl_Olap

Bit 37

Authentication

Home Location Register (Linux) V1.1 Support Guide

662

Appendix K Event Log Files

Example Event Logs


The following examples illustrate event logging for:
an administration command.
a subscriber moving to a new VLR, which causes the VLR to send
the HLR a message to update the subscribers location.
an incoming call, which causes the VLR to send the HLR a
SendRoutingInformation message.
an incoming SMS message, which causes the SMSC to send the
HLR a SendRoutingInformationSM message.

Example One - An Administration Command


Figure 71 shows an event log for the ADD:SERVICE administration
command used to give the subscriber the telephony basic service.

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

663

Figure 71. ADD:SERVICE Command Event


ADD:SERVICE command

Administration
Centre

length is the length of


this entry in the log file
Event: includes the
word TRANSACTION if
the log entry is for a
complete transaction and
not just a single event
Transaction was initiated
by the administration
command handler task
(ADMA_HANDLER)

This transaction did


not generate any
other transactions
If any of the bits listed in
Why logged: are
Enabled:, the event is
logged.
Each Enabled: entry
corresponds to a bit in a
logging bitmask that has
been set to 1 via the PDS
Configuration (pds_config)
Table.

RX Remote Addr:
Remote
Addr: fields are empty
and TX

because the transaction did


not involve communication
with another network entity
Administration command
was ADD:SERVICE
Basic service TS11
(telephony) was added

HLR

Each log entry


starts with a date
27-MAR-2000 07:30:55.28,DATA Version: V0300, PID:
20C0262E, SEQ: 4, Status:0
HLRA: HLRA_APPLICATION(1)
(length = 172 bytes)
Event: HLRA_M_LOG_TRANSACTION
Own Task:
01010025:09030001 (HLRA_APPLICATION(1))
Duration:
0.096 seconds
Parent Task:
01010023:16030003 (ADMA_HANDLER(3))
Children:
0
Why logged:
{TRANS_ALWAYS TRANS_TRACE}
Enabled:
{TRANS_ALWAYS TRANS_SUB_TRACE
TRANS_NE_TRACE TRANS_REALTIME TRANS_TIMON TRANS_TRACE
TRANS_FAIL TRANS_BLACK INVALID PROMOTE ROAM INT_FTN
UPL_RAPID UPL_SAME UPL_FAIL QUEUED DEFERRED BLOCKER NO_BS
NO_DERIVE NSI_DECODE_FAIL EXPIRED_IMSI}
RX Remote Addr:
TX Remote Addr:
Original Dest:
Appl. Context:
UNKNOWN
Revert AC:
UNKNOWN
IN7 Status:
(none)
IMSI:
234151231231231
MSISDN:
44385123123
Application:
HLRA_SIG_M_SIMPLE_CMD
Protocol:
MAP
Operation:
(none)
Error reason:
(none)
Response:
HLRA_SIG_M_SIMPLE_ACK
Invoked ODB:
000000000000
Invoked SS:
0000000000
Sub Group:
0
Transaction type: ADM_SERVICE
Subscriber Key
Specified MSISDN: 44385123123
Command: ADDSERVICE
BS:{TS11}

Home Location Register (Linux) V1.1 Support Guide

664

Appendix K Event Log Files

Example Two - Subscriber Moves to a New VLR


Figure 73 shows an event log when a subscriber moves to a new
location which causes the new VLR for the subscriber to send an
update location message to the HLR.
The following messages and replies appear in the event log file:
1. The VLR sends the HLR an update location message
2. The HLR sends the VLR an insert subscriber data message
3. The VLR sends the HLR an acknowledgement for the insert
subscriber data message
The insert subscriber data message does not produce a transaction
log when it has finished because it is completely within the update
location transaction. However, an insert subscriber data message
does sometimes produce a transaction log for example, if
subscriber data is inserted as a result of an administration
command.
4. The HLR sends the VLR an acknowledgement for the update
location message
5. The completed update location transaction is logged
Figure 72. Events Logged During an Update Location Transaction
Update Location

VLR

HLR

1. Event logged

HLR

2. Event logged

HLR

3. Event logged

HLR

4. Event logged

Insert Subscriber Data

VLR
Insert Subscriber Data
Acknowledge

VLR

Update Location Acknowledge

VLR

5. Update Location
transaction logged

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

665

Figure 73. Update Location Event


Update Location

VLR

Because this event involves


communication between two
network entities, a remote
address (the VLR) and a local
address (the HLR) are listed

The update location uses version


3 (V3) of the MAP protocol

Operation: shows that this is


an update location message
Check for ALWAYS in
Enabled: list of logging
masks
Because ALWAYS is listed as
Enabled:, the event is logged

Data sent from the


VLR to the HLR

HLR

27-MAR-2000 07:30:57.47,DATA Version: V0300, PID:


20C0262E, SEQ: 9, Status:0
HLRA: HLRA_APPLICATION(5)
(length = 108 bytes)
Event: HLRA_M_LOG_SS7
Remote Address: GT()VLR.TT0.E164.+44385444444
1207001104448345444404
Local Address:
GT(201)HLR.TT0.E164.+44385016091
13C90006001104448305619001
Appl. Context:
NETWORK_LOC_UP_V3
IMSI:
234151231231231
MSISDN:
44385123123
Application:
TCAP_SIG_M_INVOKE
Trigger:
TCAP_SIG_M_INVOKE
Protocol:
MAP
Operation:
UPDATE_LOCATION
Error reason:
(none)
Why logged:
{ALWAYS}
Enabled:
{ALWAYS SUB_TRACE NE_TRACE REALTIME
TIMON DECODE_FAIL DECODE_PROBLEM ISD_FAIL UNKNOWN_OPER
PREV_PROBLEM RS_RNF SENDF AC_CRAP COMP_MISMATCH
BAD_VERSION ABANDON RESULTNL DIAG_ERR COMPID_FAIL
PROTOCOL}
Received Message
Message data (length = 30 bytes):
301c040832141532211332f18107914483050000f004079144834
54444f4

Home Location Register (Linux) V1.1 Support Guide

666

Appendix K Event Log Files

Figure 74. Insert Subscriber Data Event


Insert Subscriber Data

VLR

Message uses the MAP


version 3 (V3) protocol

Operation: shows
that this was an insert
subscriber data message

Subscriber data sent from


the HLR to the VLR

HLR

27-MAR-2000 07:30:57.53,DATA Version: V0300, PID:


20C0262E, SEQ: 11, Status:0
HLRA: HLRA_APPLICATION(5)
(length = 189 bytes)
Event: HLRA_M_LOG_SS7
Remote Address: GT(101)VLR.TT0.E164.+44385444444
13650007001104448345444404
Local Address:
GT()HLR.TT0.E164.+44385016091
1206001104448305619001
Appl. Context:
NETWORK_LOC_UP_V3
IMSI:
234151231231231
MSISDN:
44385123123
Application:
TCAP_SIG_M_INVOKE
Trigger:
TCAP_SIG_M_INVOKE
Protocol:
MAP
Operation:
INSERT_SUB_DATA
Error reason:
(none)
Why logged:
{ALWAYS}
Enabled:
{ALWAYS SUB_TRACE NE_TRACE REALTIME TIMON
DECODE_FAIL DECODE_PROBLEM ISD_FAIL UNKNOWN_OPER
PREV_PROBLEM RS_RNF SENDF AC_CRAP COMP_MISMATCH
BAD_VERSION ABANDON RESULTNL DIAG_ERR COMPID_FAIL
PROTOCOL}
Transmit Status: SS7_NORMAL
Message data (length = 111 bytes):
656d4804250100054904000000006b2a2828060700118605010101a01
d611b80020780a1090607
04000001000103a203020100a305a1030201006c33a13102010102010
730298107914483153221
f382010a830100a606040111040112a710a306040114840100a306040
112840100

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

667

Figure 75. Insert Subscriber Data Acknowledgement


Insert Subscriber Data
Acknowledgement

VLR

RESULT in the
Trigger: entry
indicates that this
message is an
acknowledgement (ack)
message

Operation: is
returned in the

Message data.
Because no Message
data was returned, no
operation is shown.

Some acknowledgement
messages have no
message data

HLR

27-MAR-2000 07:30:57.62,DATA Version: V0300, PID:


20C0262E, SEQ: 13, Status:0
HLRA: HLRA_APPLICATION(5)
(length = 78 bytes)
Event: HLRA_M_LOG_SS7
Remote Address: GT()VLR.TT0.E164.+44385444444
1207001104448345444404
Local Address:
GT(201)HLR.TT0.E164.+44385016091
13C90006001104448305619001
Appl. Context:
NETWORK_LOC_UP_V3
IMSI:
234151231231231
MSISDN:
44385123123
Application:
TCAP_SIG_M_INVOKE
Trigger:
TCAP_SIG_M_RESULT
Protocol:
MAP
Operation:
(none)
Error reason:
(none)
Why logged:
{ALWAYS}
Enabled:
{ALWAYS SUB_TRACE NE_TRACE REALTIME TIMON
DECODE_FAIL DECODE_PROBLEM ISD_FAIL UNKNOWN_OPER
PREV_PROBLEM RS_RNF SENDF AC_CRAP COMP_MISMATCH
BAD_VERSION ABANDON RESULTNL DIAG_ERR COMPID_FAIL
PROTOCOL}
Received Message
Message data (length = 0 bytes):

Note: It is not always clear which message an acknowledgement message is replying to.

Home Location Register (Linux) V1.1 Support Guide

668

Appendix K Event Log Files

Figure 76. Update Location Acknowledgement


Update Location Acknowledge

VLR

RESULT in the
Trigger: entry
indicates that this
message is an
acknowledgement (ack)
message

Operation:
indicates that this
acknowledgement is for
update location

Update Location
acknowledge data sent
from the HLR to the VLR

HLR

27-MAR-2000 07:30:57.63,DATA Version: V0300, PID:


20C0262E, SEQ: 15, Status:0
HLRA: HLRA_APPLICATION(5)
(length = 109 bytes)
Event: HLRA_M_LOG_SS7
Remote Address: GT(101)VLR.TT0.E164.+44385444444
13650007001104448345444404
Local Address:
GT()HLR.TT0.E164.+44385016091
1206001104448305619001
Appl. Context:
NETWORK_LOC_UP_V3
IMSI:
234151231231231
MSISDN:
44385123123
Application:
TCAP_SIG_M_INVOKE
Trigger:
TCAP_SIG_M_RESULT
Protocol:
MAP
Operation:
UPDATE_LOCATION
Error reason:
(none)
Why logged:
{ALWAYS}
Enabled:
{ALWAYS SUB_TRACE NE_TRACE REALTIME TIMON
DECODE_FAIL DECODE_PROBLEM ISD_FAIL UNKNOWN_OPER
PREV_PROBLEM RS_RNF SENDF AC_CRAP COMP_MISMATCH
BAD_VERSION ABANDON RESULTNL DIAG_ERR COMPID_FAIL
PROTOCOL}
Transmit Status: SS7_NORMAL
Message data (length = 31 bytes):
641d4904000000006c15a213020101300e02010230090407914483056
190f1

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

669

Figure 77. Update Location Transaction


5. Update Location
transaction logged

Operation:
indicates that this
transaction log is for
update location

27-MAR-2000 07:30:57.63,DATA Version: V0300, PID:


20C0262E, SEQ: 16, Status:0
HLRA: HLRA_APPLICATION(5)
(length = 404 bytes)
Event: HLRA_M_LOG_TRANSACTION
Own Task:
01010025:09030005 (HLRA_APPLICATION(5))
Duration:
0.245 seconds
Parent Task:
00000000:00000000 ((none))
Children:
0
Why logged:
{TRANS_ALWAYS TRANS_TRACE}
Enabled:
{TRANS_ALWAYS TRANS_SUB_TRACE
TRANS_NE_TRACE TRANS_REALTIME TRANS_TIMON TRANS_TRACE
TRANS_FAIL TRANS_BLACK INVALID PROMOTE ROAM INT_FTN
UPL_RAPID UPL_SAME UPL_FAIL QUEUED DEFERRED BLOCKER NO_BS
NO_DERIVE NSI_DECODE_FAIL EXPIRED_IMSI}
RX Remote Addr: GT()VLR.TT0.E164.+44385444444
1207001104448345444404
TX Remote Addr: GT(101)VLR.TT0.E164.+44385444444
13650007001104448345444404
Original Dest: GT(201)HLR.TT0.E164.+44385016091
13C90006001104448305619001
Appl. Context:
NETWORK_LOC_UP_V3
Revert AC:
UNKNOWN
IN7 Status:
SS7_NORMAL
IMSI:
234151231231231
MSISDN:
44385123123
Application:
TCAP_SIG_M_INVOKE
Protocol:
MAP
Operation:
UPDATE_LOCATION
Error reason:
(none)
Response:
TCAP_SIG_M_RESULT
.

Home Location Register (Linux) V1.1 Support Guide

670

Appendix K Event Log Files

Example Three - Subscriber Receives a Call


Figure 78 shows the events logged when a subscriber receives a call,
which causes an MSC to send a send routing information message to
the subscribers HLR, and the subscribers HLR to send a provide
roaming number message to the VLR where the subscriber is
registered.
The following messages and replies appear in the event log file:
1. The MSC sends the HLR a send routing information message
2. The HLR sends the VLR a provide roaming number message
3. The VLR sends the HLR a reply to the provide roaming number
message, which includes the roaming number
4. The completed provide roaming number transaction produces a
transaction log
5. The HLR sends the VLR a reply to the send routing information
message which includes the roaming number
6. The completed send routing information transaction produces a
transaction log
Figure 78. Events Logged During an Incoming Call
Send Routing Information

MSC

HLR

1. Event logged

HLR

2. Event logged

HLR

3. Event logged

Provide Roaming Number

VLR
Reply to Provide Roaming
Number

VLR

4. Provide Roaming Number


transaction logged
Send Routing Information Reply

MSC

HLR

5. Event logged

6. Send Routing Information


transaction logged

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

671

Figure 79. Send Routing Information Event


Send Routing Information

MSC

Operation:
indicates that this is a
send routing information
message

HLR

27-MAR-2000 07:30:57.79,DATA Version: V0300, PID:


20C0262E, SEQ: 18, Status:0
HLRA: HLRA_APPLICATION(6)
(length = 98 bytes)
Event: HLRA_M_LOG_SS7
Remote Address: GT()MSC.TT0.E164.+44385000000
1208001104448305000000
Local Address:
GT(201)HLR.TT0.E164.+44385016091
13C90006001104448305619001
Appl. Context:
LOCATION_INFO_RETRIEVAL_V3
IMSI:
(none)
MSISDN:
44385123123
Application:
TCAP_SIG_M_INVOKE
Trigger:
TCAP_SIG_M_INVOKE
Protocol:
MAP
Operation:
SEND_ROUTING_INFO
Error reason:
(none)
Why logged:
{ALWAYS}
Enabled:
{ALWAYS SUB_TRACE NE_TRACE REALTIME TIMON
DECODE_FAIL DECODE_PROBLEM ISD_FAIL UNKNOWN_OPER
PREV_PROBLEM RS_RNF SENDF AC_CRAP COMP_MISMATCH
BAD_VERSION ABANDON RESULTNL DIAG_ERR COMPID_FAIL
PROTOCOL}
Received Message
Message data (length = 20 bytes):
30128007914483153221f38607914483050000f0

Home Location Register (Linux) V1.1 Support Guide

672

Appendix K Event Log Files

Figure 80. Provide Roaming Number Event


Provide Roaming Number

VLR

Operation:
indicates that this is a
provide roaming number
message

HLR

27-MAR-2000 07:30:57.80,DATA Version: V0300, PID:


20C0262E, SEQ: 20, Status:0
HLRA: HLRA_APPLICATION(7)
(length = 168 bytes)
Event: HLRA_M_LOG_SS7
Remote Address: GT(101)VLR.TT0.E164.+44385444444
13650007001104448345444404
Local Address:
GT()HLR.TT0.E164.+44385016091
1206001104448305619001
Appl. Context:
ROAMING_NUMBER_ENQUIRY_V3
IMSI:
234151231231231
MSISDN:
44385123123
Application:
HLRA_SIG_M_INITIATE_OG
Trigger:
TCAP_SIG_M_INVOKE
Protocol:
MAP
Operation:
PROVIDE_ROAMING_NO
Error reason:
(none)
Why logged:
{ALWAYS}
Enabled:
{ALWAYS SUB_TRACE NE_TRACE REALTIME TIMON
DECODE_FAIL DECODE_PROBLEM ISD_FAIL UNKNOWN_OPER
PREV_PROBLEM RS_RNF SENDF AC_CRAP COMP_MISMATCH
BAD_VERSION ABANDON RESULTNL DIAG_ERR COMPID_FAIL
PROTOCOL}
Transmit Status: SS7_NORMAL
Message data (length = 90 bytes):
62584804250100076b1e281c060700118605010101a011600f8002078
0a1090607040000010003
036c30a12e0201010201043026800832141532211332f181079144830
50000f0a5080a01010403
0401a08807914483050000f0

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

673

Figure 81. Provide Roaming Number Reply Event


Provide Roaming Number
Reply

VLR

RESULT indicates that


this is the reply to the
provide roaming number
enquiry

Roaming number
returned to the HLR

HLR

27-MAR-2000 07:30:57.93,DATA Version: V0300, PID:


20C0262E, SEQ: 22, Status:0
HLRA: HLRA_APPLICATION(7)
(length = 89 bytes)
Event: HLRA_M_LOG_SS7
Remote Address: GT()VLR.TT0.E164.+44385444444
1207001104448345444404
Local Address:
GT(201)HLR.TT0.E164.+44385016091
13C90006001104448305619001
Appl. Context:
ROAMING_NUMBER_ENQUIRY_V3
IMSI:
234151231231231
MSISDN:
44385123123
Application:
HLRA_SIG_M_INITIATE_OG
Trigger:
TCAP_SIG_M_RESULT
Protocol:
MAP
Operation:
PROVIDE_ROAMING_NO
Error reason:
(none)
Why logged:
{ALWAYS}
Enabled:
{ALWAYS SUB_TRACE NE_TRACE REALTIME TIMON
DECODE_FAIL DECODE_PROBLEM ISD_FAIL UNKNOWN_OPER
PREV_PROBLEM RS_RNF SENDF AC_CRAP COMP_MISMATCH
BAD_VERSION ABANDON RESULTNL DIAG_ERR COMPID_FAIL
PROTOCOL}
Received Message
Message data (length = 11 bytes):
30090407914483959999f9

Home Location Register (Linux) V1.1 Support Guide

674

Appendix K Event Log Files

Figure 82. Provide Roaming Number Transaction


4. Provide Roaming Number
transaction logged

This is a log of the


completed provide
roaming number
transaction

This was a provide


roaming number
(PRN) transaction

27-MAR-2000 07:30:57.93,DATA Version: V0300, PID:


20C0262E, SEQ: 23, Status:0
HLRA: HLRA_APPLICATION(7)
(length = 688 bytes)
Event: HLRA_M_LOG_TRANSACTION
Own Task:
01010025:09030007 (HLRA_APPLICATION(7))
Duration:
0.147 seconds
Parent Task:
01010025:09030006 (HLRA_APPLICATION(6))
Children:
0
Why logged:
{TRANS_ALWAYS TRANS_TRACE}
Enabled:
{TRANS_ALWAYS TRANS_SUB_TRACE
TRANS_NE_TRACE TRANS_REALTIME TRANS_TIMON TRANS_TRACE
TRANS_FAIL TRANS_BLACK INVALID PROMOTE ROAM INT_FTN
UPL_RAPID UPL_SAME UPL_FAIL QUEUED DEFERRED BLOCKER NO_BS
NO_DERIVE NSI_DECODE_FAIL EXPIRED_IMSI}
RX Remote Addr: GT()VLR.TT0.E164.+44385444444
1207001104448345444404
TX Remote Addr: GT(101)VLR.TT0.E164.+44385444444
13650007001104448345444404
Original Dest: GT(101)VLR.TT0.E164.+44385444444
13650007001104448345444404
Appl. Context:
ROAMING_NUMBER_ENQUIRY_V3
Revert AC:
ROAMING_NUMBER_ENQUIRY_V3
IN7 Status:
SS7_NORMAL
IMSI:
234151231231231
MSISDN:
44385123123
Application:
HLRA_SIG_M_INITIATE_OG
Protocol:
MAP
Operation:
PROVIDE_ROAMING_NO
Error reason:
(none)
Response:
TCAP_SIG_M_RESULT
.
.
Transaction type: PRN

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

675

Figure 83. Send Routing Information Reply


Send Routing Information Reply

MSC

RESULT indicates
that this event is a
response

This response is to
the send routing
information message

This is the routing


information returned
to the MSC

HLR

27-MAR-2000 07:30:57.99,DATA Version: V0300, PID:


20C0262E, SEQ: 25, Status:0
HLRA: HLRA_APPLICATION(6)
(length = 163 bytes)
Event: HLRA_M_LOG_SS7
Remote Address: GT(101)MSC.TT0.E164.+44385000000
13650008001104448305000000
Local Address:
GT()HLR.TT0.E164.+44385016091
1206001104448305619001
Appl. Context:
LOCATION_INFO_RETRIEVAL_V3
IMSI:
234151231231231
MSISDN:
44385123123
Application:
TCAP_SIG_M_INVOKE
Trigger:
TCAP_SIG_M_RESULT
Protocol:
MAP
Operation:
SEND_ROUTING_INFO
Error reason:
(none)
Why logged:
{ALWAYS}
Enabled:
{ALWAYS SUB_TRACE NE_TRACE REALTIME TIMON
DECODE_FAIL DECODE_PROBLEM ISD_FAIL UNKNOWN_OPER
PREV_PROBLEM RS_RNF SENDF AC_CRAP COMP_MISMATCH
BAD_VERSION ABANDON RESULTNL DIAG_ERR COMPID_FAIL
PROTOCOL}
Transmit Status: SS7_NORMAL
Message data (length = 85 bytes):
64534904000000006b2a2828060700118605010101a01d611b8002078
0a1090607040000010005
03a203020100a305a1030201006c1fa21d0201013018020116a313890
832141532211332f10407
914483959999f9

Home Location Register (Linux) V1.1 Support Guide

676

Appendix K Event Log Files

Figure 84. Send Routing Information Transaction


6. Send Routing Information
transaction logged

TRANSACTION
indicates that this is a
transaction log
This transaction
generated one child
task, which was the
provide roaming
number transaction

Transaction type was


send routing
information (SRI)

27-MAR-2000 07:30:57.99,DATA Version: V0300, PID: 20C0262E, SEQ: 26, Status:0


HLRA: HLRA_APPLICATION(6)
(length = 404 bytes)
Event: HLRA_M_LOG_TRANSACTION
Own Task:
01010025:09030006 (HLRA_APPLICATION(6))
Duration:
0.266 seconds
Parent Task:
00000000:00000000 ((none))
Children:
1
Why logged:
{TRANS_ALWAYS TRANS_TRACE}
Enabled:
{TRANS_ALWAYS TRANS_SUB_TRACE TRANS_NE_TRACE TRANS_REALTIME TRANS_TIMON
TRANS_TRACE TRANS_FAIL TRANS_BLACK INVALID PROMOTE ROAM INT_FTN UPL_RAPID UPL_SAME UPL_FAIL
QUEUED DEFERRED BLOCKER NO_BS NO_DERIVE NSI_DECODE_FAIL EXPIRED_IMSI}
RX Remote Addr: GT()MSC.TT0.E164.+44385000000
1208001104448305000000
TX Remote Addr: GT(101)MSC.TT0.E164.+44385000000 13650008001104448305000000
Original Dest: GT(201)HLR.TT0.E164.+44385016091 13C90006001104448305619001
Appl. Context:
LOCATION_INFO_RETRIEVAL_V3
Revert AC:
UNKNOWN
IN7 Status:
SS7_NORMAL
IMSI:
234151231231231
MSISDN:
44385123123
Application:
TCAP_SIG_M_INVOKE
Protocol:
MAP
Operation:
SEND_ROUTING_INFO
Error reason:
(none)
Response:
TCAP_SIG_M_RESULT
Invoked ODB:
000000000000
Invoked SS:
0000000000
Sub Group:
0
Transaction type: SRI
B Number:
+44385123123
No. of Fwd: 0
A Number:
(none)
Pres Ind:
NOT_PRESENT
CPC:
(none)
Location Information
Status: REGISTERED
Operation: UPL
When: 27-MAR-2000 07:30:57
Flavour: GSM
MAP Ver: 3
EMAP:TRUE
IMSI: 234151231231231
VLR Number: 44385444444
LMSID: (none)
MSC Number: 44385000000
Unsupported ODB:
000000000000
Unsupported SS:
0000000000
Unsupported BS:
000000000
Unsupported CAMEL: 2 {PH2}
Entity Flags:
00080F8E {TSMS HPLMN VODACAT EMAP OSMS ADPCM_PFX OR}
Last Call Information (Written to DB)
Call Action
: SUCCESS_RN_OK
Call Time
: 27-MAR-2000 07:30:57
Calling Number : (none)
Presentation Ind: NOT_PRESENT
Call Type
: TS11
NSI Information
How BS Identified: BY MSISDN
BS Used:
TS11
GSM BC Derived:
FALSE
Sent IMSI: 234151231231231
RN:
+44385999999
FTN:
(none)
(Database: GSM (none))
FwdOpt:
(none)
Registered: (none)
SRI Type:
NORMAL_SRI
OICK:
0 Not supported
TICK:
0 Not supported
SUBTYPE: 65535 Not supported
Suspect Delays: 0
Special Behaviour Ind:
NONE
Extended Camel:
FALSE
Gmsc Address:
+44385000000
Call Ref Number:

Home Location Register (Linux) V1.1 Support Guide

Appendix K Event Log Files

677

Example 4 - Subscriber Receives an SMS


In order to deliver a mobile terminated SMS, the HLR is sent a Send
Routing Information for SM message so that the short message can be
routed to the correct VLR or SGSN.
Figure 85. Send Routing Information for Short Message Transaction

TRANSACTION
indicates that this is a
transaction log
This transaction did
not generate any
other transactions

Transaction type was


send routing
information for SMS
(SRISMS)

14-NOV-2004 13:58:09.93,DATA Version: V0420, PID:


0002A257, SEQ: 45, Status:0
HLRA: HLRA_APPLICATION(24)
(length = 664 bytes)
Event: HLRA_M_LOG_TRANSACTION
Own Task:
01020045:09030018 (HLRA_APPLICATION(24))
Duration:
0.198 seconds
Parent Task:
00000000:00000000 ((none))
Children:
0
Why logged:
{TRANS_ALWAYS TRANS_TRACE}
Enabled:
{TRANS_ALWAYS TRANS_SUB_TRACE
TRANS_NE_TRACE TRANS_REALTIME TRA?
RX Remote Addr: GT(102)MSC.TT0.E164.+44385000001
13660008001104448305000001
TX Remote Addr: GT(102)MSC.TT0.E164.+44385000001
13660008001104448305000001
Original Dest: 4206
4206
Appl. Context:
BLUEBOOK
Revert AC:
UNKNOWN
IN7 Status:
SS7_NORMAL
IMSI:
234150000000000
MSISDN:
44385100101
Application:
TCAP_SIG_M_INVOKE
Protocol:
MAP
Operation:
SEND_ROUT_INFO_FOR_SMS
Error reason:
(none)
Response:
TCAP_SIG_M_RESULT
Invoked ODB:
000000000000000000
Invoked SS:
0000000000
Sub Group:
0

Home Location Register (Linux) V1.1 Support Guide

678

The type of SRISM,


either mobile
originated (MO) or
mobile terminated
(MT)

SMS is not a
Voicemail alert

Circuit switched (CS)


information, including
location status

Packet switched (PS)


information, including
location status

An InformServiceCentre
(ISC) required value.
TRUE means that extra
information about the
subscription is sent, such
as message waiting data
(MWD) fields

If a subscriber is absent,
a reason is sent in the
reply to the SRISM
message, usually
including the MWD
Fields (see
UPDATE:SIM on
page 198 for a
description of these

Appendix K Event Log Files

Transaction type: SSM_MT


B Number:
+44385100101
Svc Ctr:
44385008621
(Raw: 91/
44385008621)
Priority:
FALSE
MAP Ver:
1
From MLR:
FALSE
BSG used:
SMS
GPRS Supp Ind.:
FALSE
PAYT Extensions not present
CS Location Information
Status: REGISTERED
Operation: UPL
When: 14NOV-2004 13:58:09
Flavour: GSM
MAP Ver: 3
EMAP:FALSE
IMSI:
234150000000000
VLR Number: 44385000203
LMSID:
MSC Number:
44385000003
Unsupported ODB:
000000000000000000
Unsupported SS:
0006810000 {OIN OICK PRIORITY
SUBTYPE}
Unsupported BS:
000000000
Unsupported Services:
00
Unsupported CAMEL: 7 {PH1 PH2 PH3}
Entity Flags:
000C1915 {TSMS HPLMN VODACAT OSMS
OR}
Unsupported Position: TRUE
PS Location Information
Status: INVALID
Operation: ADM
When: 14NOV-2004 13:58:08
Flavour: GPRS
MAP Ver: 0
EMAP:FALSE
IMSI:
234150000000000
ISC Required
FALSE
Absent Info
FALSE
MWD Fields
MNRF:
FALSE
MNRG:
FALSE
MCEF:
FALSE
MNRR GSM:
NONE
MNRR GPRS:
NONE
Fields Changed:
FALSE
MWD Set:
FALSE
Special Behaviour Ind:
NONE

MWD Set: indicates


whether the HLR stored
the service centre
address. FALSE
indicates that the SMS
was sent successfully.

Home Location Register (Linux) V1.1 Support Guide

679

Appendix L Backing Up PDS Platforms


This appendix lists files that should be regularly backed up off a PDS
platform.
Backups are needed for:
Disaster recovery
To keep a history of log files to investigate problems
To keep a copy of a platform before an upgrade
To keep a copy of a platform after an upgrade
To safeguard against disk fragmentation of databases, which can
happen when upgrading.

Backup
Frequency

Backup frequency depends on file type as follows:


Back up the subscriber database and system log files, listed in
Table 75, automatically every day using a script that implements the
External Backup Procedure in Appendix D, Backing-up the HLR
Database.
Back up the configuration files listed in Table 76, once a week.

Diagnostic Files

Diagnostic files do not have to be backed up, but are required to


diagnose problems:
Table 77 lists process log files. If a failure occurs, copy these files off
platform and use them to diagnose the problem.
Crash Dump Files on page 683 describes files dumped if a platform
or application crashes. If a failure occurs, copy these files off
platform and use them to diagnose the problem.

Organizing
Backup

When commissioning a new platform, you must consider an initial


backup schedule. Remember that although most file locations are
common to all platforms, some locations are platform specific.
Note: The customer or the commissioning engineer must keep a
record of which disks and directories backups are made to.

Home Location Register (Linux) V1.1 Support Guide

680

Appendix L Backing Up PDS Platforms

Subscriber Database and System Log Files


Back up the subscriber database and important system log files once
every 24 hours, and keep the two most recent backups.
Table 75. Subscriber Database and System Log Files
Directory

File Name

File Description

/opt/vodafone/pds/data/register_backup

HLRD_FILE.BAK

HLR database backup

/var/log

messages

System error messages,


security messages.

Home Location Register (Linux) V1.1 Support Guide

Appendix L Backing Up PDS Platforms

681

Configuration Files
Back up the configuration files once a week at a time of day when the
network is not busy. Keep the two most recent backups.
Table 76. System Configuration Files
Directory

File Name

File Description

$cfgdir

pds_ss7_event

Defines which SS7 events


are monitored (file is
required but obsolete)

mgta_node_config.dat

Platform configuration file

pds.conf

Platform configuration file

auth_config.dat

Authentication configuration

sigtran_event_cfg.dat

SIGTRAN configuration files

sctp_init_cfg.dat
sctp_prot_params.dat

Home Location Register (Linux) V1.1 Support Guide

682

Appendix L Backing Up PDS Platforms

Process Log Files


Log files are used to diagnose failures in SIGTRAN or the PDS
application and do not need to be backed up. If a failure occurs, make
copies of the log files so that they can be used to diagnose the failure.
Table 77. Process Log Files
Directory

File Name

File Description

$logdir/
pds_startup
$shrdir/tables/
working

pds_i_mgta.n.log

(text) Output file for management process. Gives


a log of what processes were started and
stopped, and which initiated a shutdown.

pds_i_adm.n.log

(text) Output files for other PDS processes.


Contains diagnostic information including failure
reasons. Find which one to look at from MGTA
log, then find out why platform crashed from this.

pds_i_hlra.n.log
pds_i_mp.n.log
pds_i_hlrd.n.log
pds_i_s7mp.n.log
pds_i_tcpip.n.log
PDS.log.n

(binary) Cyclic buffer of event logging records,


view with logview

nnnn.err

(text) Record of format errors causing table


maintenance load failures

In the above file names, n is the startup instance.

Home Location Register (Linux) V1.1 Support Guide

Appendix L Backing Up PDS Platforms

683

Crash Dump Files


Provide copies of application dump files to Support when reporting a
crash.
Crash dump files are stored in /home/pds_manager, and have a file
extension of .core. They are binary files, and can be viewed using the
Linux gdb utility.

Home Location Register (Linux) V1.1 Support Guide

684

Appendix L Backing Up PDS Platforms

Restoring a Backup
If the subscriber database is corrupted or has to be restored to recover
from disk failure, log in using the pds_manager account and restore the
database as described in Chapter 6, Using Support Interfaces.
For all other restores, call support.

Home Location Register (Linux) V1.1 Support Guide

685

Appendix M GSM Number Definitions


Number

Means

Description

CC

Country code

Example:
44=UK

E.164

Example:
44 1635 106099
Country code, one to three digits (44=UK) + national destination
code, also known as area code (1635) + subscriber number (106099)
Total length <= 15 digits. This number is unique throughout the entire
public switched telephone network world, not just the GSM world.
An MSISDN is associated with a nature of address indicator (NAI),
which indicates the type of call, as national, international, new or
unknown. The NAI is not part of the E.164 standard.

E.212

Number that is unique to a mobile handset.


234 15 1021000899
Mobile country code. Always three digits and Identifies a country
(234=UK). Matches, one-to-one, a country code, such as 44 for the
UK.
Mobile network code. 15=Vodafone UK. Matches, one-to-one, an
area code for the network, such as 7785 for Vodafone UK.
<=10 digits. Mobile station identity number (MSIN, see separate
entry). The GSM specifications allow the MSIN part of the number to
use only sufficient digits to identify the handset. The Vodafone
network insists on all 10 digits being included.
Total length = 15 digits. This number is unique throughout the GSM
world.

E.214

Example:
44 385 1021000899
Country code, one to three digits (44=UK) + national destination
code, also known as area code (385), both taken from the E.164
standard + mobile station identity number (MSIN) taken from the
E.212 standard. (106099)
Total length <= 16 digits. This number is unique throughout the GSM
world.

GT

Global Title
Defined by E.214
standard

Example:
44 385 1021000899
Country code, one to three digits (44=UK) + national destination
code, also known as area code (385), both taken from the E.164
standard + mobile station identity number (MSIN) taken from the
E.212 standard. (106099)
Total length <= 16 digits. This number is unique throughout the GSM
world.

IMEI

International Mobile
Equipment Identity

TAC+FAC+SN
Type Approval Code (6 digits) + Final Assembly Code (2 digits) +
Sequence Number (6 digits) and an optional spare digit (SP). The SP
is replaced with a 0 by the HLR.
Used by an Equipment Identity Register (EIR) to authenticate a
mobile handset.

Home Location Register (Linux) V1.1 Support Guide

686

Appendix M GSM Number Definitions

Number

Means

Description

IMSI

International Mobile
Station Identity
Defined by E.212
standard

Number that is unique to a mobile handset.


234 15 1021000899
Mobile country code. Always three digits and Identifies a country
(234=UK). Matches, one-to-one, a country code, such as 44 for the
UK.
Mobile network code. 15=Vodafone UK. Matches, one-to-one, an
area code for the network, such as 7785 for Vodafone UK.
<=10 digits. Mobile station identity number (MSIN, see separate
entry).
Total length = 15 digits. This number is unique throughout the GSM
world.

LAI

Location area
identity.

When a mobile station updates its location, it sends its IMSI (in the
form of a TMSI) and its LAI to the MSC/VLR. The MSC/VLR then
knows what location to page is the mobile station receives an
incoming call.
Example:
234 15 3
Mobile country code. (234=UK) + Mobile network code
(15=Vodafone) + Location area code (3)

MCC

Mobile country
code.

Example: 234=UK

MNC

Mobile network code


(not mobile national
code).

Example: 15=Vodafone
A code that identifies a network provider.

MSIN

Mobile station
identity number

<= 10 digits. This number is unique within a given mobile network.

MSISDN

Mobile Station
Integrated Services
Digital Network
Number
Defined by E.164
standard

Example:
44 1635 106099
Country code, one to three digits (44=UK) + national destination
code, also known as area code (1635) + subscriber number (106099)
Total length <= 15 digits. This number is unique throughout the entire
public switched telephone network world, not just the GSM world.
An MSISDN is associated with a nature of address indicator (NAI),
which indicates the type of call, as national, international, new or
unknown. The NAI is not part of the E.164 standard.

MSRN

Mobile station
roaming number

Used to route a call to a mobile handset. The HLR knows which


MSC/VLR the handset is connected to, but no more. The HLR
therefore asks the VLR to allocate a short lived number to the
terminating handset so that the call can be connected. Once,
connected, the MSRN is no longer needed and can be used to set up
another call.
Example:
Same format as MSISDN.
44 385 020059

NDC

National destination
code.
Also known as area
code.

Examples are 01635, or 1635 if the leading zero is removed to form


an international number (see MSISDN above).

Home Location Register (Linux) V1.1 Support Guide

Appendix M GSM Number Definitions

687

Number

Means

Description

NNG

National Number
Group

Used by PSTN networks (such as BT) to identify an area. e.g.,


441635 for Newbury. A 4-digit NNG is 448363, a 5-digit NNG is
4478363.

SN

Subscriber number.

Part of an MSISDN after the national code and area code (see
MSISDN on page 686)

TMSI

Temporary mobile
station identity.

Security measure. When a mobile handset first identifies itself to the


network, it uses its IMSI. The VLR then supplies that handset with a
TMSI to use instead of its IMSI, to avoid repeatedly transmitting the
subscribers IMSI over the air interface. When the network is paging a
mobile handset that has an incoming call, the network uses a TMSI
and not the IMSI for the handset. The TMSI is changed each time it is
used over the air interface.
Example:
Same format as IMSI.

Home Location Register (Linux) V1.1 Support Guide

688

Home Location Register (Linux) V1.1 Support Guide

Appendix M GSM Number Definitions

689

Appendix N Abbreviations
All abbreviations in this document are defined in the table below.
Abbreviation

Definition

ADC

Administration Centre

ADD

Automatic Device Detection

ADPCM

Adaptive Differential PCM (pulse code modulation)

AOCC

Advice of Charge (Charging)

AOCI

Advice of Charge (Information)

APC

Announcement Preconnection

APN

Access Point Name

AS

Application Server

ASCII

American Standard Code for Information Interchange

ASP

Application Server Process

AST-DR

Announcement Service Terminal Digital speech Random (an announcement device).

ATI

Any Time Interrogator

ATS

Automotive Twin SIM

AUC

Authentication Centre

BCSM

Basic Call State Model

BEP

Back End Processor

BNR

B-Number Relay

BS

Basic Service

BSG

Basic Service Group

BSS

Base Station System

CAMEL

Customized Applications for Mobile network Enhanced Logic

CAP

CAMEL Application Part

CC

Country Code

CCH

CAMEL Capability Handling

CCITT

International Telegraph and Telephone Consultative Committee

CCN

Current Called Number

CDS

Circuit Duplex Synchronous

CEIR

Central Equipment Identity Register

CFB

Call Forward on Busy

CFNRc

Call Forward Not Reachable

Home Location Register (Linux) V1.1 Support Guide

690

Appendix N Abbreviations

Abbreviation

Definition

CFNRy

Call Forward on No Reply

CFU

Call Forward Unconditional

CHIC

Check Incoming Call Message

CLI

Calling Line Identity

COL

Connected Line Identity

CoS

Class of Service

CPC

Calling Party Category

CPN

Core Packet Network

CPU

Central Processing Unit

CSAI

Corporate Services Administration Interface (the MAS GUI)

CSC

CUG Services Centre

CSE

CAMEL Service Environment

CUG

Closed User Group

CVS

Connection View State

DAT

Digital Audio Tape. Magnetic data storage

DDROF

Donor Direct Routing Override Function

DNS

Domain Name System

DP

Detection Point

DPC

Destination Point Code

DROF

Direct Routing Override Function

DT

Data Transcript

DTC

Data Terminal Controller (HP)

DTM

Distributed Transaction Manager

DTMF

Dual-Tone Multi-Frequency

DVD

Digital Versatile Disc. Optical data storage

E.164

CCITT Recommendation E.164, Numbering plan for the ISDN system

E.212

CCITT Recommendation E.212, International Mobile Station Identity (IMSI)

E.214

CCITT Recommendation E.214, Structure of the land mobile global title for the Signalling
Connection Control Part (SCCP)

ECF

Event Configuration File

ECT

Explicit Call Transfer

EIR

Equipment Identity Register

eMLPP

Enhanced Multi-Level Precedence and Pre-emption

ENUP

Ericsson National User Part

EOS

End of Selection

Home Location Register (Linux) V1.1 Support Guide

Appendix N Abbreviations

691

Abbreviation

Definition

ETSI

European Telecommunications Standards Institute

F&F

Friends and Family Service for PAYT

FAFF

Filter and Format Function

FDDI

Fibre Distributed Data Interface

FEP

Front End Processor

FMSC

Frontier Mobile Switching Centre

FSM

Forward Short Message

FTN

forward-to Number

FTP

File Transfer Protocol

G.703

ITU-T Recommendation for the physical/electrical characteristics of hierarchical digital


interfaces

GCS

Global Cellular Service

GESI

GPRS Enhancement Support Indicator

GHLR

GSM HLR

GID

Group Identifier (used by IVPN service).

GIPC

GSM/IS41 Protocol Converter

GLAP

Global LAP

GMD

Global Mediation Database

GMPC

Gateway Mobile Positioning Centre

GMSC

Gateway Mobile Switching Centre

GMT

Greenwich Mean Time

GNP

Global Number Plan

GPRS

General Packet Radio Services

GSM

Global System for Mobile Communications

GSP

Group Services Platform

GT

Global Title

GUI

Graphical User Interface

HLR

Home Location Register

HP

Hewlett Packard

HPLMN

Home Public Land Mobile Network

HPSG

Hewlett Packard ServiceGuard software

HP SS7

Hewlett Packards implementation of SS7

HP-UX

Hewlett Packards Unix Operating System

HSCSD

High Speed Circuit Switched Data

IA

Initiate Alert

Home Location Register (Linux) V1.1 Support Guide

692

Appendix N Abbreviations

Abbreviation

Definition

IAN

IN Access Node (a simplex SEP)

ICA

Incoming Call Attendant

IDP

Initial DP

IIOP

Internet Inter-ORB Protocol

IMEI

International Mobile Equipment Identification

IMEI-SV

International Mobile Equipment Identification - Software Version

IMP

International Mediation Platform

IMSI

International Mobile Station Identity

IMW

Inform Message Waiting

IN

Intelligent Networking

INAP

Intelligent Networking Application Part

INOSS

IN Node Operation Support System (OSS)

INSG

IN Support Group

IN_VIEW

A tool for inspecting subscription details.

IP

Internet Protocol

IREG

International Regulations

IRN

Intermediate Routing Number

IRP

International Roaming Platform

ISAAC

International Subscriber Administration and Control System

ISDN

Integrated Services Digital Network

ITDS

Information Technology Desktop Services

ITU-T

International Telecommunications Union Telecommunications (was CCITT)

IUP

Interconnect User Part

IVPN

International VPN

IVR

Interactive Voice Response Answering System

IVS

IN_VIEW Server

IWMSC

Interworking Mobile Switching Centre

Ki

Security Key for IMSI

LAI

Location Area Identity

LAMS

Local Alarms Management System

LAN

Local Area Network

LAP

Locator Application Part

LCN

Last Calling Number

LPC

Local Point Code

Home Location Register (Linux) V1.1 Support Guide

Appendix N Abbreviations

693

Abbreviation

Definition

LSISDN

Local Station Integrated Services Digital Network number

LVD

Local Voicemail Deposit

MAP

Mobile Application Part

MAS

MVPN Administration System

MCC

Mobile Country Code

MCEF

Memory Capacity Exceeded Flag

MCS

Missed Calls Server

MESS

Mutually Exclusive Secondary SIM

MGT

Mobile Global Title

MIP

Management Interface Protocol

MLR

Mailbox Location Register

MLRM

MLR Mediator

MMS

Multi-media Messaging Service

MMSC

Multi-media Messaging Service Centre

MNC

Mobile Network Code

MNP

Mobile Number Portability

MNRF

Mobile not Reachable for GSM

MNRG

Mobile not Reachable for GPRS

MNRR

Mobile not Reachable Reason

MO

Mobile Originated

MREM

Mobile Routing Enquiry Message

MROM

Mobile Routing Message

MROR

Mobile Routing Reject Message

MS

Mobile Station

MSC

Mobile Switching Centre

MSISDN

Mobile Station Integrated Services Digital Network number

MSRN

Mobile Station Roaming Number

MSU

Message Signalling Unit

MT

Mobile Terminated

MTP

Message Transfer Part

MTUP

Mobile Telephony User Part

MVNO

Mobile Virtual Network Operator

MVPN

Mobile Virtual Private Network

MW

Message Waiting

Home Location Register (Linux) V1.1 Support Guide

694

Appendix N Abbreviations

Abbreviation

Definition

MWD

Message Waiting Data service centre for an MSISDN

NACS

Network Administration and Control System

NAI

Network Access Identifier

NAM

Network Access Mode

NBS

Network Basic Service

NDC

National Destination Code

NEED

Nodal End to End Data

NGVM

Next Generation Voicemail

NHM

Network Health Monitor

NI

Network Initiated

NICS

Network Information and Control System

NINI

NICS Intelligent Node Interface

NIS

Network Information System

NMS

Note Mobile Station

NNG

National Number Group

NOC

Network Operations Centre

NPS

NGVM Provisioning Server

NS

Network Systems Group

NTP

Network Timing Protocol

NTPD

Network Timing Protocol Daemon

O&M

Operations and Maintenance

OCN

Original Called Number

OCOCB

Operator Controlled Outgoing Call Barring

O-CSI

Originating CAMEL Subscription Information

OICK

Originating IN Category Key

OIN

Originating Intelligent Network

OLO

Other Licensed Operator

OMC

Operations and Maintenance Centre

OPC

Originating Point Code

ORB

Optimal Routing Barring

OSS

Operation Support System (INOSS)

OSS

Operator Specific Service

PABX

Private Automated Branch Exchange

PAM

PrePayment Account Manager

Home Location Register (Linux) V1.1 Support Guide

Appendix N Abbreviations

695

Abbreviation

Definition

PAP

PrePayment Application Part

PAS

PrePayment Administration System

PAYT

Pay As You Talk service

PC

Point Code

PCM

PrePayment Call Manager

PDN

Physical Device Number of SIU port

PDP

Packet Data Protocol

PDS

PLMN Database System

PF4B

Perfect Fit For Business (MVPN)

PIN

Personal Identification Number

PIPC

PDS Inter Process Communication

PIRR

Packet Inspection Rating and Reservation system

PLMN

Public Land Mobile Network

PLN

Physical Link Number

PMS

PAM Mediation System

PNP

Private Numbering Plan

PoCoM

Polycentre Console Manager

PPBS

PrePayment Business Server

PPS

Pre-Payment System

PRN

Provide Roaming Number

PRNack

PRN Acknowledgement

PSI

Provide Subscriber Information

PSTN

Public Switched Telephone Network

PW

Private Wire

RMI

Remote Method Invocation

QOS

Quality of Service

RAG

Restricted Access Group

RAM

Random Access Memory

RDROF

Recipient Direct Routing Override Function

RI

Routing Information

RJ-45

A serial connector, used for the 10Mbps connection to the data network

RN

Roaming Number

ROM

Read-only Memory

RSZI

Regional Subscription Zone Identity

Home Location Register (Linux) V1.1 Support Guide

696

Appendix N Abbreviations

Abbreviation

Definition

S7MP

System Number 7 Management Program

SAM

Service Administration Mediator

SAN

Service Access Number

SAP

Service Access Point

SCCP

Signalling Connection Control Part

SCCPR

SCCP Relay

SCP

Service Control Point

SCSI

Small Computer Systems Interface

SCTP

Stream Control Transmission Protocol

SDF

Screen Definition File

SDL

Specification and Description Language

SDM

Subscriber Data Move

SEP

Service Execution Point

SGSN

Serving GPRS Support Node

SIC

Signalling Interface Card

SIM

Subscriber Identity Module

SIOS

Status Indication (Out of Service)

SIU

SS7 Interface Unit

SKE

Subscriber Key Encryption

SKERTL

Subscriber Key Encryption Run Time Library

SLC

Signalling Link Code

SLI

Send Routing Information for LCS (location services)

SLS

Signalling Link Selection

SME

Short Message Entity

SMPC

Serving Mobile Positioning Centre

SMS

Short Message Service

SMSC

Short Message Service Centre

SMW

Set Message Waiting

SMWD

Set Message Waiting Data

SPID

Service Provider Identifier

SRI

Send Routing Information

SRIRes

Send Routing Information Result

SRN

Service Request Number

SRP

Service Relay Point

Home Location Register (Linux) V1.1 Support Guide

Appendix N Abbreviations

697

Abbreviation

Definition

SS

Supplementary Service

SS7

Signalling System Number 7

SSA

Subsystem Allowed (SCCP message)

SSC

Service Status Control (protocol)

SSF

Service Switching Function

SSN

Subsystem Number

STP

Signalling Transfer Point

TACS

Total Access Communication System

TAP

Transferred Account Procedure

TC

Transaction Capabilities or short for TCAP

TCAP

Transaction Capabilities Application Part

TCL

Traffic Class

TCP

Transmission Control Protocol

TDP

Trigger Detection Point

TeMIP

Telecommunications Management Information Platform

TICK

Terminating IN Category Key

TIF_CSI

Translation Information Flag Camel Service Information

TIMON

Tracking Initiation and Monitoring

TMC

Text Messaging Centre

TPIT

Technical Platform Integrity Tool

TSC

Transit Switching Centre or Telecoms Signalling Card

TSU

Telecoms Signalling Unit

UAL

Unsupported Application Context Learning

UDF

User Distribution Function

UDT

User DataGram

UDTS

Management Data Message

ULTRAN

UMTS Radio Access Network

URL

Uniform Resource Locator

USSD

Unstructured Supplementary Service Data

UTC

Universal Coordinated Time

VAP

Vodafone Application Part

VASP

Value Added Service Provider

VCS

Vodafone Console System

VIR

VAP/IUP Relay

Home Location Register (Linux) V1.1 Support Guide

698

Appendix N Abbreviations

Abbreviation

Definition

VLR

Visitor Location Register

VM

Voice Messenger

VMID

Voice Messenger Identifier

VMS

Virtual Memory System (OpenVMS)

VMSC

Visited Mobile Switching Centre

VodaSCP

Vodafone Service Control Point

VPLMN

Visited PLMN

VPN

Virtual Private Network

VSS2

Vodalink Server System 2

WOMBAT

Wireless Office Management and Business Administration Tool

XAM

X.25 Administration Manager

XML

Extensible Markup Language

XPath

A language for finding information in an XML document

XPC

X.25 Protocol Converter

XSLT

Extensible Stylesheet Language for Transformations

XUDT

Extended Unit Data

ZC

Zone Code

Home Location Register (Linux) V1.1 Support Guide

Index

Symbols

to

699

Index
Symbols
*#101# 99

A
RECALL
See also voicemail
ABANDONED 242, 254, 259
abbreviations 689
AC_CONFLICT 242, 254, 259
AC_LOG 656
access control 61, 63
by charging rate 61
by content 61
by source and destination 61
limitations 63
roaming 63
signalling 62
accounts
product_manager 83
Remote Engineer 80
ACR 6, 614, 635
CAMEL interaction 7
last caller information 7
OVERRIDE 7
ACR supplementary service 315
acronyms 689
ACT MASK 233
ACT TIME 233
ACTION 233
ACTIVATE:SS 327
ADC xix, 67
ADD 513, 594
ADD:BAR 435
ADD:CAMEL 332
ADD:MSISDN 280
ADD:OVERLAP 274
ADD:PDP 298
ADD:PNUM 416
ADD:SERVICE 310
ADD:SIM 194
ADD_MAX_RETRY 471
ADD_MIN_ALRM_DURATION 471
ADD_RETRY_TIMER 471
address
PDP, types 303
SCCP, interpreting 577
ADDRESS, PDP 302
adm process 103
adm_client table 463
ADM_FWD_NUM_RETRY 471

ADM_FWD_TIMEOUT 471
ADMA 573, 657
ADMA_HANDLER 663
ADMA_LOG_MASK 524, 656
ADMI 573
ADMIN 215
ADMIN DISABLED 211, 225
Admin Forward 185
Admin Forwarding 471, 495
ADMIN_CHANGED 242, 254, 259
ADMIN_DISABLED 242, 254, 259
ADMIN_FORWARD 471
ADMIN_THROTTLE_ THRESHOLD 523
administration
client definition 463
administration centre 67
administration commands. See commands
administration interface 83, 175, 176, 279
admp 176, 573
ADPCM_PFX 513
adult content. See access control
alarm code
2236 138
2305 139
2306 139
2326 140
2327 140
2350 141
2351 141
2352 142
2353 143
2354 143
2357 144
2371 144
2397 145
2398 145
2399 145
2400 146
2401 146
2402 146
2403 147
2404 147
2405 148
2406 148
2407 148
2408 149
2409 149
2410 150
2411 150
2412 150
2413 151

Home Location Register (Linux) V1.1 Support Guide

700

2414 151
2415 152
2416 152
2417 153
2418 153
2419 153
2420 154
2421 154
2423 155
2424 155
2425 156
2426 156
2464 157
2465 158
2466 158
2467 159
2468 159
2601 160
2603 160
2611 155, 161
2679 162
2680 162
2701 162
2702 163
2721 164
2722 164
4000 165
alarm server process 103
alarm text
146, 149
active database too old, update
deferred 155
ADMIN_TASKS_EXHAUSTED 140
ADMIN_TASKS_LOW 140
ALARMS_RESET 166
ALL_DESTINATIONS_UNAVAILABLE 159
an invalid database agent index has been
received 150
APPLICATION_ WARNING 165
APPLICATION_TASKS_EXHAUSTED 162
APPLICATION_TASKS_LOW 162
ASP_UNAVAILABLE 157
ASSOCIATION_ FAULT 159
AUTH_SEED_CHANGED 139
AUTH_SEQUENCE_NUM_CHANGED 13
8
BACKUP_DATABASE_ CORRUPT 144
cannot page update 152
change to server despite incomplete
transaction 148
corrupt journal 148
database agent comms failure 153
database frozen - operation discarded 147
database ID logical error 155
database load failed 146
database manager timeout 151

to

Index

database sync request for invalid logical


database 152
database sync request from invalid
slave 150
DATABASE_SERVER_TASKS_EXHAUST
ED 141
DATABASE_SERVER_TASKS_LOW 142
DESTINATION_ CONGESTED 158
DESTINATION_ UNAVAILABLE 158
HIGH_TRAFFIC_LOAD 164
internal software error 155
invalid database ID 145
invalid database loaded 145
invalid journal 147
invalid sequence number 145
last secured map error for logical
database 156
LIVE_DATABASE_ RESOURCE_
EXHAUSTED 141
LIVE_DATABASE_
RESOURCE_LOW 143
LIVE_DATABASE_NOT_BACKED_UP 14
4
LIVE_DATABASE_NOT_SECURED 143
logical database changing state to 156
Logical database name file error 146
newer copy of database exists 154
no database agent task available 148
NO_LIVE_SERVICE 160
NO_STANDBY_ SERVICE 160
not enough database processes 161
number of used database agents has
returned within its lower
threshold 149
page update fail 153
server signal discarded in slave mode 151
SKE_LOGGING_ON 139
SLAVE_DATABASE_ CORRUPT 165
synchronisation to server will overwrite
data 154
TCPIP_TASKS_EXHAUSTED 162
TCPIP_TASKS_LOW 163
TRAFFIC_OVERLOAD 164
uninitialised database 153
unknown service 150
alarms
classes 135
codes 138
critical 135
distribution 134
flooding 94
interface 134
major 135
minor 135
processes 134
reporting xix

Home Location Register (Linux) V1.1 Support Guide

Index

types 136
viewing 137
ALERT 426
ALERT_MAX_REPEATS 471
ALERT_REPEAT_INT 471
algorithm, authentication 266
ALLOW 463
ALLOW_ATI 514
ALLOW_ATSI 514
ALLOW_POS 514
ANALYSE:TABLE 460
ANALYSE:TABLE, table maintenance 460
anonymous call reject. See ACR
ANUM_CPC 471
ANY_TIME_INFO_ENQUIRY_V3 518
ANY_TIME_INFO_HANDLING_V3 518
AOCC 315, 594, 613
AOCI 315, 594, 613
APN 233, 302
APN, and VPLMN allowed 258
APP_LOG_MASK 524, 656
APP_SS7_LOG_MASK 524, 656
application contexts
and VIEW:NETWORK command 409
ARSENIC 8, 315, 594, 613
ARSENIC, and SE_FLAGS 253
AS_LOG 656
ASC_FAIL 508
ascvt table 4, 465
ASN.1 658
ASP 535, 545
ATI 57, 58, 59, 60
ATM
CAMEL phase 16
ATS 630
ATS and LINKED_TYPE 217, 241
ATS linked subscription 31
ATS, migrating from MESS 225
ATS, migrating to MESS 225
ATSI
CAMEL phase 16
ATTRIB 512
AUC 266
AUCUPDATE 508
AUCUPDATE:SUB 266
AUTH 198
AUTH_CONFIG.DAT 681
authentication
sequence number 200
authentication algorithm 266
Authentication/MSRN Requests 124
AUTHENTICATION_FAILURE_REPORT_V3 5
18
automotive twin SIM (ATS) 31
aux log files 88
AUXSPEECH 219

to

701

availability report 127

B
B number table 466
backup
automatic 586
database 104, 585
database, determining valid 589
external 589
file 588
of PDS platforms 679
organizing 679
restoring 684
backup tables 458
BADPWDCTR 215
BAIC 315, 594, 613
BAOC 240, 315, 595, 613
BAR 469
BAR, adding 435
BAR, removing 437
barring 647
call forward numbers 9
barring FTNs 9
basic service
commands 309
BASIC SERVICES 234
basic services 591
BC TITLE 206, 234, 280, 465
BC TITLE and COPY:SUB 208
BCA 5, 206
BCA and COPY:SUB 208
bca table 465
BCA, and BC TITLE 234
bearer capabilities 465
behaviour modes, FTNs 8
BICROAM 315, 594, 613
BLACK 514
BLACK, and SGSN entity flags 253
BLACK_LISTED 260
BLACK_LISTED, and LOCSTAT 242
BLACK_LISTED, and SGSN status 254
Block Device I/O 123
BNR_GT 472
bnum 466
B-number table 466
BOIC 315, 595, 613
BOIC, and GPRS unsupported bars 240
BOICXHC 315, 595, 613
BOICXHC, ACTIVATE:SS example 328
BOICXHC, and GPRS unsupported bars 240
BOICXHC, DEACTIVATE:SS example 330
BOPENTSMS 617
BS 234
BS USED 234
BS30_ASSUME_VT 472
BS61A 592, 612

Home Location Register (Linux) V1.1 Support Guide

702

BS61S 592, 612


BS81A 592, 612
BS81S 592, 612
BSG 234
BSG and ACTIVATE:SS 327
BSG MASK 234
BSG, and DEACTIVATE:SS 329
BSG, and ERASE:SS 325
BSG, and Pn parameter 249
BSG, and REGISTER:SS 322
BSG, and VIEW:MSISDN 287
BSS 19
bureau service 628

C
C Number Behaviour Table 469
C number table 467
call forwarding 7, 10
barring 9
forward-to number behaviour modes 8
number translation 8
VLR divert dependence 8
See also call transfer
call forwarding, number translation 8
call forwarding, signalling 3
CALL TIME 234
call transfer 11, 642
See also call forwarding
CALL_UNREL 614
CALLBACK_CPC 472
CALLER 241
calling line identity restriction 632
Calls Replications 124
CAMEL 13, 334, 337, 378, 382, 386, 388, 390,
392, 395, 397, 399, 402, 405
ADD:CAMEL command 189
and TIF_CSI 381, 385
anonymous call reject interaction 7
commands 331
destination number (DEST_NUM) 378
destination number length
(DEST_NUM_LEN) 379
effect of VLR, SGSN on services 22
matching destination number length
(MATCH_TYPE) 379, 383
migrate from phase one to phase two 359
migrate to phase one 359
multiple CAMEL subscription
information 24
multiple TDPs 23
network entities 13
OICK interaction 226
OICK supplementary service 25
provide and withdraw 225
REMOVE:CAMEL command 190, 373
service environment 27

to

Index

service execution platform (SEP) 13


service key 384
subscription information 13
TICK supplementary service interaction 26
trigger detection point 14
unsupported application learning 26
UPDATE:CAMEL command 190, 375
VIEW:NETWORK example 413
VLR and SGSN support 22
CAMEL capability handling, control of data
download 23
CAMEL data download 21
CAMEL phase 14
CAMEL phases 14
CAMEL service example, PAYT roaming 26
CAMEL signalling 18
CAMEL subscription types, interaction
between 24
CAMEL support, checking by UAL 26
CAMEL trigger detection points, interaction 23
CAMEL, and TIF_CSI 17
CAMEL, data downloaded 21
CAMEL, definition 13
CAMEL, OICK interaction 25
CAMEL, TICK interaction 26
CAMEL, VLR and SGSN support 22
CAMEL, Vodafone services 17, 18
CAMEL_GSMSCF 472
CAMEL_ONLY 9, 253
CANCEL 428
CANCEL_RETRY_PERIOD 472
CATEGORY 215
CB_NOTIFY 472
CC 685
CC_NDC 235
CCBS 16
CCH 334, 378, 382, 386, 388, 390, 392, 395,
397, 399, 402, 405
CCH. See also CAMEL capability handling
CF_BAR_PFX 472
CF_NOTIFY 473
CFB 595, 613
CFB BEHAVIOUR 236
CFB FTN 236
CFB supplementary service 315
CFB, and Pn parameter 249
CFBCP 215, 236
CFBFP 215, 236
cfgdir 74
cfgdir/db_size.dat 585
CFNR 598
CFNRC 595, 613
CFNRC BEHAVIOUR 236
CFNRC FTN 236
CFNRC supplementary service 315
CFNRC_ENQ_PFX 473

Home Location Register (Linux) V1.1 Support Guide

Index

CFNRCCP 216, 236


CFNRY 595, 613
CFNRY BEHAVIOUR 236
CFNRY FTN 236
CFNRY supplementary service 315
CFNRY TIMER 236
CFNRY, and Pn parameter 249
CFNRY, ERASE:SS example 326
CFNRY, REGISTER:SS example 324
CFNRY_TIMER 473
CFNRYCP 216, 236
CFNRYFP 216, 236
CFU 316, 321, 595, 613, 628, 633
CFU BEHAVIOUR 236
CFU FTN 236
CFU, PROVISION:SS example 318
CFU_ENQ_PFX 473
CFUCP 216, 236
Chameleon commands 646
CHARGING 302
checking
performance 653
CHILD_FAIL, PSI STATUS 252
CIC_IF_MO_SMS 473
CIC_IF_MT_CALL 473
CIC_IF_MT_SMS 473
CLI 16
presentation restriction override. See
CLIPRO
CLI STATUS 237
CLI, last caller 241
CLI, override allowed flag 220
ClickGSM, alarms 134
CLIENT_TYPE 463
CLIENT_TYPE_NUMBER 463
CLIP 595, 613
CLIP supplementary service 316
CLIPRO 596, 633
CLIR 595, 613, 632
CLIR supplementary service 316
CLIR_ALLOW_SHORT_CODE 473
CLIR_CTR_FAIL_TEXT 633
CLIR_DEF_ALLOW_CMD 633
CLIR_DEF_ALLOW_TEXT 633
CLIR_DEF_RESTR_CMD 633
CLIR_DEF_RESTR_TEXT 633
CLIR_ENQUIRE_CMD 633
CLIR_NO_CONTROL_TEXT 633
CLIR_PERM_SHORT_CODE 473
CLIR_PERMANENT_CMD 633
CLIR_PERMANENT_TEXT 633
CLIR_RESTR_SHORT_CODE 474
[CNUMn] section 467
CNUM barring 648
[CNUM BEHAVIOUR] section 469
cnum, table 467

to

703

CNUM_BHVR 237
cnum_bhvr table 469
[CNUM0] and ARSENIC 594
[CNUMCAMEL] and forward-to numbers 9
[CNUMCAMEL] section 469
[CNUMFNP] and MVPN 596
[CNUMFNP] section 469
[CNUMSE] and ARSENIC 594
[CNUMSE] section 469
COLP 595, 613
COLP supplementary service 316
COLR 595, 613
COLR supplementary service 316
comdir 75
commands
ACTIVATE:SS 327
ADD:BAR 435
ADD:CAMEL 332
ADD:MSISDN 280
ADD:OVERLAP 274
ADD:PDP 298
ADD:PNUM 416
ADD:SERVICE 310
ADD:SIM 194
ANALYSE:TABLE 460
AUCUPDATE:SUB 266
basic service 309
COPY:SUB 208
CREATE:SRN 290
CREATE:SUB 206
date --set 584
DEACTIVATE:SS 329
DELETE:SRN 291
DELETE:SUB 211
DEVSTATUS:TABLE 461
ERASE:SS 325
error codes 180
IMPORT:SUB 213
INITIATE:ALERT 426
INITIATE:CANCEL 428
INITIATE:RESET 430
LOCK:SUB 213
MSISDN 279
overlapping IMSI 273
P number 415
PDP context 297
PROVISION:SS 318
REGISTER:SS 322
REMOVE:BAR 437
REMOVE:CAMEL 373
REMOVE:MSISDN 282
REMOVE:OVERLAP 278
REMOVE:PDP 306
REMOVE:PNUM 418
REMOVE:SERVICE 312
REPLACE:OVERLAP 276

Home Location Register (Linux) V1.1 Support Guide

704

REPLACE:TABLE 461
responses 179
service request number 289
SET:MWD 433
SET:TRACE 269
subscriber 205
subscriber data move 419
summary table 189
supplementary service 315
syntax 178
table instances and 455
table maintenance 460
table maintenance, format 460
UNLOCK:SUB 214
UPDATE:CAMEL 375
UPDATE:MSISDN 284
UPDATE:PDP 302
UPDATE:SIM 198
UPDATE:SRN 292
UPDATE:SUB 215
UPDATE:ZONELIST 228
user information messages 186
VERIFY:TABLE 462
VIEW:INFO 448
VIEW:MSISDN 286
VIEW:NETWORK 409
VIEW:SRN 294
VIEW:SUB 231
WITHDRAW:SS 320
communication
failure 91
COMPLETE:SDM 422
COMPRESS_ENB 514
computer failure 91
condition alarms 136
configuration data, summary 4
configuration files 681
connecting 79
connection failure, SS7 network 91
connections, network entities 2
CONTINUE, CAMEL default call handling 378,
382, 386, 388, 391, 393, 395, 398, 400,
402
COPY:SUB 208
core dump files 89
CPU load, checking 653
CPU utilization 123
CREATE 60
CREATE:MAILBOX 60
CREATE:SRN 290
CREATE:SUB 206
CRITICAL_SS 474
CS_IND 198
CSE 27
CSE_NOTIFY 335
CSI 24

to

Index

CSI_ACTIVE 237, 335


CSI_NOTIFY 237, 474
CSI_TDP 238
CSIs, interaction between 24
CT_CMD 642
CT_GT 474
CTRL_SS 216
CUG 16
current directory 454
current log file 96
cutovers
automatic 104
manual 116
CVT_RESP 535, 549
CVT_USSD 535, 547
CW 595, 613
CW supplementary service 316

D
data network failure 91
DATA_COMPRESSION 474
database
backup, determining valid 589
corruption 93
restoring 118
secondary backup file 588
database backup 104
database synchronization 104
databases 76
date and time, setting 129
date --set 584
DB_AGT_LOAD_ TIMEOUT 524
DB_AGT_TIMEOUT 524
DB_BACKUP_ PERIOD 524
DB_LOCK 238
DB_LOG_MASK 524
DB_MGR_TIMEOUT 524
DB_SECURE_ PERIOD 524
DBSYNC_ANALYSIS 524
DBSYNC_TRIMMING 524
DCF 617
DCFB 316, 595, 614
DCFNRC 316, 596, 614
DCFNRY 316, 594, 596, 614
DCICA 219, 592, 611
DCICS 219, 592, 611
D-CSI 16, 21
DCSI_DN_INSTANCE 345
DDMmmYY 632
DEACTIVATE:SS 329
DECSS7_SENDF 260
DECSS7_SENDF, location status 242
DECSS7_SENDF, SGSN status 254
DEF_ALLOW, calling line identification 221
DEF_CH 378, 382, 386, 388, 391, 393, 395,
398, 400, 402

Home Location Register (Linux) V1.1 Support Guide

Index

DEF_RESTR, calling line identification 221


[DEFAULT] section, service provider table 533
default call forwarding 10, 57
DEFAULT_CFB_FTN 474
DEFAULT_CFNRC_FTN 474
DEFAULT_CFNRY_FTN 474
DEFAULT_CH 333
DEFAULT_IMSI 524
[DEFAULT_NE] section, netent table 510, 520
DEFAULT_SH 337
DEFAULT_SMSH 339
delete subscriber data 242, 248
DELETE:SRN 291
DELETE:SUB 211
delta mode 575
DEREG_GPRS 199, 200
DEREG_GSM 199, 200
DEST_NUM 378
DEST_NUM_LEN 379
DEVSTATUS:TABLE 461
df 88
dialled subscribed services, CAMEL TDP 345
directories 74
structure 74
directory paths 74
disk
removing 93
space 88
Disk Utilization 124
DIVERT_BSG 475
DIVERT_FORMAT 561
diverts 57
diverts, VLR dependence 8
DN 395
DNLD_P 208, 216
DNS 233
documentation ii
DOWNLOADED CCHs 239
DPACK 219, 593, 611
DSD 242, 248
DTMF 15
DUMMY_FTN 475
dump files, crash 683

E
E.164 685
E.212 685
E.214 685
ECT 596, 614
See also call transfer
ECT supplementary service 316
EDP 14
EIR 685
EMAP 239, 252, 253, 262, 510, 514, 596, 643
EMLPP 596
EMLPP_DFLT_PRIORITY 475

to

705

EMLPP_MAX_PRIORITY 475
[ENCRYPTION] section, timer table 506
encryption key identifier 266
ENGAGED 508
[ENTITIES] section, netent table 510, 511
ENTITY 502
ENTITY FLAGS 239
entity global title 239
ENTITY TIMEZONE 239
ENTITY TITLE 239
ERASE:SS 325
ERASURE_FLAG 239
ERI_LOCATION_SVC_GATEWAY_V3 518
Ericsson MAP 239, 510, 596, 643
.ERR files, backup 682
error messages 179
errors
administration interface 180
event alarms 136
event log files 95
EXECUTE:SDM 420
exedir 75
exit command 83
EXPIRY 274
expiry time, pending IMSI 239
explicit call transfer. See call transfer
EXPTIME 239
EXT_QOS 303
EXTENDS 512
external backup 589

F
FAC 685
failure
computer 91
data network communication 91
interface card 92
SS7 network connection 91
failure of PRODUCT, consequences 4
failure, consequences 4
fast cutover 104
fault tolerant BEP 571
FAX 219, 591, 611, 630
feedback form 719
files
crash dump 683
current log 96
event log 95, 656, 662
platform configuration 683
process log 682
secondary backup 588
start-up log 89
subscriber database 680
system configuration 681
system log 680
table 463

Home Location Register (Linux) V1.1 Support Guide

706

FLAVOUR 240
FMC1 596, 614
fmsnmpx 69
FNP 467
FORWARD_FAIL_TEXT 534, 540
FORWARD_USSD 534, 535
forward-to numbers. See FTNs
FREE_APN 240, 303
FTN 322, 563, 594
FTN, CAMEL 358
FTN, error 00023 180
FTN_INT_MAX_LEN 476
FTN_INT_MIN_LEN 475
FTN_SE_MAX_LEN 476
FTN_SE_MIN_LEN 476
FTNs
barring 9
behaviour modes 8
non- standard 8
non-standard 8
standard 7, 8
full number plan 467

G
gateway MSC and GPRS 223
general packet radio service 29
generating PULSE SDFs 570
GENERIC_USSD_GT 476
GIPC, and SET:TRACE 269
global title of entity 239
GLOBAL_SCCPSEG 521
glossary 689
GMLC 16
GMSC 14, 67
GMSC and GPRS support 223
GPRS 16, 29, 643
CAMEL TDP 336
trigger detection point 336
GPRS and the PRODUCT 29
GPRS location status 254
GPRS or GSM location 240
GPRS UnsupportedSS 240
GPRS, access point name (APN) 233
GPRS, barring 649
GPRS, maximum PDP contexts 183
GPRS, network access mode (NAM) 217
GPRS, PDP contexts 297
GPRS, transfer of SMS 223
GPRS, unsupported bars 240
GPRS, unsupported basic services 240
GPRS_DETACHED 199, 200
GPRS_LOCATION_UPDATE_V3 519
GPRS_SUB_RESTR 216
GPRS-CSI 16, 18, 21
GPRSCSI_TDP 336
GROUP 217

to

Index

GROUP NOTIFY 635


GSM 323
number definitions 685
GSM or GPRS location 240
GSM, barring 649
GSM, network access mode 217
GSM, subscriber FLAVOUR 240
GSM_GPRS, network access mode 217
GSM_SUB_RESTR 217
GSMSCF_ADDR 333, 379, 382, 386, 388, 391,
393, 395, 398, 400, 402, 405
GSP 596
GT format 578
GT_NAME 534, 543

H
HLR_ID_CMD 637
HLR_ID_TEXT 637
hlr_node Table 495
HLRA 573
HOLD 316, 596, 613
home zone charging 33
home zone charging, signalling 34
home zones, defining 33
HOMETICK 217
HPLMN 515
HPLMN specific bars 649
HPLMN, SGSN entity flags 253
HPLMN1 to HPLMN4 240, 466
HSCSD 592, 612
hsscfg table 495
hssp process 103

I
IAM 20
IC_ENQ_PFX 476
IMEI 685
IMPORT:SUB 213
IMSI 241, 686
IMSI, overlapping 273
IMSI, pending, expiry time 239
IMSI_DETACHED 199, 200
IMSI_RETRIEVAL_V2 519
[INBOUND] section 503
incarnation number 101
incoming call, signalling 3
INFO event severity 503
INFO_RETRIEVAL_V2 519
INFO_RETRIEVAL_V3 519
INITIATE:ALERT 426
INITIATE:CANCEL 428
INITIATE:CANCEL command 428
INITIATE:RESET 430
installation history 126
INSTANCE 241
instance alarms 136

Home Location Register (Linux) V1.1 Support Guide

Index

INTER_VLR_INFO_RETRIEVAL_V2 519
interface
accessing administration 176
administration 175, 176, 279
card 92
interfaces
alarm 134
interpreting SCCP address
EIR 580, 581
INTSSACTIONS 561
INVALID location status 260
IO_CONVERT 5
IP address 302, 303
IPSP 106
ISAAC xix, 104, 116
ISAAC queue 91
ISAAC, personalise mailbox 60
ISD 242, 248
ISD_DSD_FAIL location status 260
IVR 56
IVS 67

J
JOURNAL_ THRESHOLD 524
JOURNAL_PERIOD 524

L
LAI 257, 686
LAST CALLER 241
last caller
MultiSIM subscriptions 630
last caller information
anonymous call reject interaction 7
last caller information USSDs 630
LAST_CALL_CMD1 631
LAST_CALL_CMD2 631
LAST_DATA_TEXT 632
LAST_FAX_TEXT 632
LAST_NO_NUMBER_TEXT 632
LAST_NOT_CONT_TEXT 632
LAST_RESTRICTED_TEXT 632
LAST_SERVICE_FAIL_TEXT 632
LAST_SPEECH_TEXT 632
LC_UNSUPP_BH 335, 379, 383, 387, 389,
391, 393, 396, 398, 400, 403, 406
LCN 596
LCS 3
LCS_DOWNLOAD, netent table 512
LCS_DOWNLOAD, PRODUCT_CONFIG
table 476
LCS_GMLC_ID 476
LES 67, 221
privacy 38
registering subscribers 38
LES Dis Prv 644
LES Ena Prv 644

to

707

LES Get Sub 644


LES Set Sub 644
LINKED 596, 613
linked subscriptions
ATS 31
key administration commands 31
MESS 630
SEP 4, 30
SIM 30
USSDs 30
LINKED supplementary service 316
LINKED_TYPE 208, 217, 225
LINKSUB_ATI_FWD 476
LINKSUB_GT 476
LINKSUB_PH2 477
LIVE_ONLY 463
LMSID 241, 248
location area identity 257
location based services 36
mobile number portability 44
location based services, USSD 38
location based services. See services
location enabling server. See LES
LOCATION OPERATION 242
location services
mobile terminated 37
network entities 36
location status 242
location update 3
Location Updates/Subscriber Inserts 124
location, MSC number 245
LOCATION_CANCELLATION_V2 519
LOCATION_CANCELLATION_V3 519
LOCATION_FLAVOUR 428
LOCATION_INFO_RETRIEVAL_V2 519
LOCATION_INFO_RETRIEVAL_V3 519
LOCK:SUB 213
LOCK_TIMEOUT 524
LOCSTAT 242
log file
current 96
event 95, 655
start-up 89
structure 662
log files 682
LOG_SCCP 253, 515
LOG_SS7 253, 515
LOG_TRANSACTION 253, 515
logdir 74
LOGGER 575
logging
administration command example 662
configuring log masks 657
event 655
example event logs 662
incoming call example 670

Home Location Register (Linux) V1.1 Support Guide

708

update location example 664


logical databases 76
logrotate 134
logview 96
logview, for performance checking 653

M
M2UA 167
M3UA 92, 167
maintenance process 103
MAP VERSION 242
MAP, unknown message logging 660
MAP3 643
MAP3, and unsupported positioning
services 262
MAP3, in event logs 666
MATCH_TYPE 379, 383
MAX_CALL_FORWARDS 477
MAX_CLIENTS 463
MAX_MSISDN_USSDLEN 477
MAX_NUM_MSISDN 477
MAX_PDP 477
MBX 243
MCC 686
MCEF 198
M-CSI 16, 21
MCSI 351
Memory Allocation 123
menus
PULSE main menu 571
Remote Engineer 81
table view 131
MESS 31, 217, 241, 630
MESS barring 651
MESS, migrating from ATS 225
MESS, migrating to ATS 225
message waiting data, setting 433
message waiting data, signalling for subscribers
who migrate to or from Vodafone 43
messages, error 179, 186
MG-CSI 16
mgta process 103
mgta_node_config.dat 681
migrated subscribers, SMS and message
waiting data signalling 43
migration away from Vodafone, subscriber
signalling 41
migration to Vodafone, subscriber signalling 42
missed call server commands 645
MKEY 5
mkey table 508
MLR 60, 67, 433, 597
MLR global title 243
MLR USSD messages 635, 638
MLR_GT 243
MLR_ID_CMD 638

to

Index

MLR_ID_FAIL_TEXT 638
MLR_ID_NONE_TEXT 638
MLR_ID_NOTU_TEXT 638
MLR_ID_TEXT 638
MLR_NAME 243
MLR_SRI 477
MMI codes for MSISDNs 630
MMR 515
MNC 686
MNP 39, 40, 44, 45, 130
location based services 44
See also mobile number portability
MNP_PFX1 to MNP_PFX3 477
MNRF 199
MNRG 199
MNRR_GPRS 199
MNRR_GSM 200
mobile number portability 40, 45
mobile number portability. See MNP
mobile terminated calls
prepay signalling 55
mobility management 351
MOBILITY_TRIG 352
MOSMS 16
MOSMS-CSI 16, 21
MOSMSCSI_TDP 339
mp (maintenance) process 103
MPS_ALL_NOTSUPP_CTRL_TEXT 643
MPS_ALL_NOTSUPP_NOTCTRL_TEXT 643
MPS_ALL_SUPP_CTRL_TEXT 643
MPS_ALL_SUPP_NOTCTRL_TEXT 643
MPS_DIS_CTRL_TEXT 644
MPS_DIS_NOTCTRL_TEXT 644
MPS_DISABLED_CMD 643
MPS_ENABLED_CMD 643
MPS_NOTCTRL_TEXT 644
MPS_QUERY_CMD 643
MPTY 316, 596, 613
MS CAT 245
MS_PURGING_V2 519
MS_PURGING_V3 519
MSC, gateway, and GPRS support 223
MSC, subscriber location 245
MSIN 686
MSISDN 246, 686
retrieval USSDs 629
MSISDN retrieval 629
MSISDN retrieval USSDs 630
MSISDN: commands 279
MSPURGED_GSM 199, 200
MSPURGES_GPRS 199, 200
MSRN 686
MSRN_PFX_ID 217
MSRNPFX 5
msrnpfx table 508
MSU 574

Home Location Register (Linux) V1.1 Support Guide

Index

MTP3 point code 577


MTSMS-CSI 16
MULTISIM 513
MultiSIM
last caller 630
USSD commands 638
MultiSIM, key administration commands 47
mutually exclusive secondary SIM (MESS) 31
MVNO 508
MVPN and C number table 467
MVPN services 646
MVPN_FNP 596, 614
[MWD] section, timer table 505
MWD, setting 433
MWD_MNGT_Vn 519
MXE 60, 528

N
NAI 465, 686
NAM 217
national number group. See NNG
NBS_ADD_PORT 478
NBS_ADD_URI 478
NBS_IP_1, NBS_IP_2 478
N-CSI 16
NDC 686
netent 5
netent table 509
netent, and unsupported application context
learning 64
network
connection failure, SS7 91
network entity
commands 409
network entity (netent) table 458
network entity connections 2
network entity table 509
Network I/O 123
network services, provided by the PRODUCT 6
network signalling 3, 4
network time protocol 129, 583
NETWORK, view entity 409
NETWORK_FUNCTIONAL_SS_V2 519
NETWORK_LOC_UP_V2 519
NETWORK_LOC_UP_V3 519
NETWORK_UNSTRUCTURED_SS_V2 519
NGVM Availability Server 518
NGVM Provisioning Server 518
NMS 242, 248
NMS_SMW_TIME 478
NNG 687
NO_ADPCM_PFX 478
NO_CANCEL 515
NO_CIC_FOR_SMS 478
NO_GPRS_PAGE_RESP 199, 200
NO_GSM_PAGE_RESP 199, 200

to

709

NO_MWD 246
NO_SRI_TEXT 632
NO_SUSPECT 515
NO_SVC_UNSUPP_BH 218, 334, 380, 384,
387, 389, 392, 394, 396, 399, 401, 404,
406
nodes
startup 571
states 572
types 571
NOM_BSG 246
NOMINATED_SIM 219
NORMAL, phone category 215
NOT_CONTROLLABLE 237
NOT_PRESENT 237
NOT_REGISTERED 252, 258
NOT_RESTRICTED, CLI STATUS 237
NOT_SUPPORTED 252
NOTIFY_CB 219, 247
NOTIFY_CF 220, 247
NOTIFY_ODB 220, 247
NR_Cond_Timer 247
NSDC
CAMEL phase 16
NSI_METHOD 478
NSI_SPEECH_OVERRIDE 479
NSI_UIMI 479
NTP 129, 583
NUM_OF_CANCEL 479
number translation, call forwarding 8

O
O_CAUSE_VAL 384
O-CSI 14, 21
O-CSI, and Vodafone services 17
OCSI_DNLD 248
OCSI_TDP 333
ODB 218, 248, 437, 467
ODB, GPRS unsupported 240
ODB_NOTIFY 479
ODBAIC 616, 648
ODBAOC 226, 616, 648
ODBCFVLRROAM 617, 648
ODBCNUM1 616, 648
ODBCNUM2 616, 648
ODBCNUM3 616, 648
ODBDCF 648
ODBECT 617, 648
ODBECTC 617, 648
ODBECTC2 617, 649
ODBECTCI 617, 648
ODBECTCZ 617, 648
ODBECTSM 617, 649
ODBGPRS 617, 649
ODBGSM 617, 649
ODBHPLMN1 to ODBHPLMN4 616, 649

Home Location Register (Linux) V1.1 Support Guide

710

ODBICROAM 616, 649


ODBICROAZ 617, 649
ODBICRXSMS 616, 649
ODBIN bars 651
ODBINBAIC 651
ODBINBAOC 651
ODBINBICROAM 651
ODBINBOCROAM 651
ODBINBOIC 651
ODBINBOICXHC 651
ODBINBOPENT 651
ODBINBOPINFO 651
ODBINBSS 651
ODBINLS 651
ODBINMOSMS 651
ODBINMTSMS 651
ODBINPAYT 651
ODBMOSMSROAM 617, 649
ODBMOXSMS 359, 617, 649
ODBMOXSMSROAM 617, 649
ODBNICBAOC 617, 649
ODBOCROAM 616, 649
ODBOIC 435, 437, 616, 649
ODBOICXHC 616, 649
ODBOICXHC and CAMEL 19
ODBOPENT 616, 649
ODBOPENTSMS 649
ODBOPINFO 616, 649
ODBOZC 617, 649
ODBOZCXHC 617, 649
ODBOZICXHC 617, 649
ODBPREMROAM 617, 650
ODBPREMSMSHI 650
ODBPREMSMSLO 650
ODBROAMALL 617, 650
ODBROAMHC 616, 650
ODBROAMHP 616, 650
ODBs 648
ODBSS 616, 650
ODBXENOSMS 616, 650
Off-Node PIPC Router process 453
OICK 25, 220, 596, 613
CAMEL interaction 25
OICK and supplementary services 316
OICK, CAMEL interaction 25
OICK, provisioning 226
OICK, service provider bar. See service provider
bar
OIN 596, 613
OIN supplementary service 316
OMC 67, 91
OMCS 95, 96, 655
omcs process 103
on-net/off-net information USSDs 638
ONNET_BADNUM_TEXT 638
ONNET_CMD 638

to

Index

ONNET_FAIL_TEXT 638
ONNET_HELP_TEXT 638
ONNET_OFF_TEXT 638
ONNET_ON_TEXT 638
ONPIPC_CONN_TIMEOUT 525
ONPIPC_FAIL_ TIMEOUT 525
ONPIPC_IGNORE_ LOCAL 525
ONPIPC_PORT_NUM 525
ONPIPC_SERV_TIMEOUT 525
OPERATION STATUS 248
operator determined bars 647
See also BAR 647
OSMS 413, 516
OTHER 522
[OUTBOUND] section, io_convert table 503
OVERLAP 274, 276, 278
overlapping IMSI 273
OVERRIDE 220
anonymous call reject interaction 7
OWN_GT 525
OWN_GT2 525
OWN_MSISDN 220
OWN_MSISDN_BSG_CMD 629
OWN_MSISDN_BSG_EMPTY_TEXT 629
OWN_MSISDN_BSG_INV_FORM_TEXT 629
OWN_MSISDN_BSG_INV_MMI_TEXT 629
OWN_MSISDN_BSG_TEXT 629
OWN_MSISDN_BSG_TOO_MANY_TEXT 629
OWN_MSISDN_BSG_TOO_MUCH_TEXT 629
OWN_MSISDN_CMD 629
OWN_MSISDN_TEXT 629
OWNM_P 208, 220

P
P number
commands 415
P1 248
P2 248
P3 248
P4 248
P5 249
P6 249
P7 249
PAD 593, 612, 630
PADACC 219, 593, 611
PAGE_UPD_BATCH 525
PAI 221
PAI flag 38
PAI USSDs 643
PAI_CTRL 221
PAM 67, 512, 597
PAP_FAILURE_PFX 479
PAP_GT 479
PAP_NOCREDIT_PFX 480
PAP_TRAN_TYPE 480
PAP_UNKNOWNACC_PFX 480

Home Location Register (Linux) V1.1 Support Guide

Index

PASSWORD 249
paths 74
PAYPHONE, phone category 215, 245
PAYT
mobile terminated calls 55
PRODUCT interaction 51
SMS signalling 51, 54
USSDs 643
PAYT roaming 17, 26
SEP 17, 27
VMSC 27
PAYT roaming, CAMEL service example 26, 28
[PCLIST] section, netent table 521
PCM 67, 512
PDP 190, 208, 297, 302, 303
address 249
address types 303
addresses 303
administration commands 297
barring 651
context ID 249
context status 249
PDP ADDRESS 302
PDP Type 249
PDP_ID 306
pds boot processes 103
pds.conf 681
pds_alarms 68
pds_config 5
pds_config table 523
PDS_CONFIG table, and event logs 656
pds_defs table 493
pds_i_boot 105
pds_i_mp 587
pds_i_mp process 586
PDS_L_LGNDIR 681
pds_manager
account 83
logging off 83
logging on 83
password 83
pds_manager account 83
PDS_Pnnnn_ADM.LOG 682
PDS_Pnnnn_HLRA.LOG 682
PDS_Pnnnn_HLRD.LOG 682
PDS_Pnnnn_MGTA and SIGTRAN
changes 173
PDS_Pnnnn_MGTA.LOG 682
PDS_Pnnnn_MP.LOG 682
PDS_Pnnnn_S7MP.LOG 682
pds_sigtran_event table 502
pds_ss7_event 534, 681
peer-to-peer mode 106
PEND IMSI 250
PENDING IMSI 250
pending IMSI, expiry time 239

to

711

performance checks 653


PERMANENT, calling line identity 221
personalise mailbox 60
PIN number 15
pipc table 527
platform availability report 127
PLMN 595
PMS 242
PMS, operation status 248
pmsnmpx 69
PNUM 208, 216, 221, 642
PNUM and forward-to numbers 9
PNUM, adding 416
PNUM, tracing 269
POI flag 38
point code 578
portability, mobile number. See MNP
positioning allowed indicator 38
positioning override indicator 38
positioning services 643
positioning. See location services
PPS 597
PPS_ALERT_DELIVER_PFX 480
premium rate content. See access control
PREMSMSHI 617
PREMSMSLO 617
prepay service. See PAYT
prepay. See PAYT
PREPAY_IC 316, 597, 613
PRES_MODE 221
PRES_NUM 250
PRES_NUM_STATUS 250
PRIORITY 222, 597, 613
PRIORITY supplementary service 316
PRIORITY, type of phone 215
PRN_VERSION 480
problems
escalating and reporting xviii
identifying 85
investigation 86
quick reference 98
solving 97
process log files 682
[PROCESSED_USSD] section, USSD
table 628
PROCESSED_USSD 534, 538
processes 77
adm 103
alarm server 103
hssp 103
mgta 103
mp (maintenance) 103
omcs 103
pds boot 103
s7mp 103
snmp 103

Home Location Register (Linux) V1.1 Support Guide

712

PRODUCT
alarms 133
checking 98
checking status 98
connecting 80
controlling 114
data in the 4
database, restoring 118
definition 2
destination status 114
displaying processes 100
GPRS 29
managing 120
network entity connections 2
network services provided by 6
network signalling 3
platform hardware 73
platform software 72
quick summary 2
restarting 115
software, displaying versions 125
stopping 117
tables 463
user interface 79
what it does 2
PRODUCT failure, consequences 4
product manager
account 83
PRODUCT overview 1
PRODUCT, failure consequences 4
product_config table 471
PRODUCTD_FILE 119
PRODUCTD_FILE.BAK 680
PRODUCTD_SAVED.BKn 119
[PROFILE] section, netent table 512
PROVISION:SS 318
PS_IND 200
PSI_CELL_OR_SAI_ID 251
PSI_CURRENT_LOC 251
PSI_GEODETIC 251
PSI_GEOGRAPHICAL 251
PSI_LAI 251
PSI_LOC_AGE 251
PSI_LOC_INFO 251, 392, 394
PSI_LOC_NUMBER 251
PSI_MSC 251
PSI_NR_REASON 251
PSI_SAI_PRESENT 251
PSI_SELECTED_LSA 251
PSI_STATUS 252
PSI_SUB_STATE 252
PSI_V2 519
PSI_VLR 252
PULSE 569
display mode 572
exiting 572

to

Index

main menu 571


menu tree 573
navigation 572
setting up 570
starting 571
summary screen 574
update rate 572
PULSE, display SS7 traffic 97
PULSE, when to use 97
PURGED location status 260
PURGED, subscriber not reachable reason 258
PWD 222

Q
Q MASK 252
QHLR MASK 252
QOS 252, 303
QUI STAT 253

R
RANGE 534, 544
[RANGES] section, MLR_NUMRANGE
table 498
RAPID_UPL 480
RBT 597
RDROF 516
readers comments form 719
REAL_SRI 516
REALTIME tracing 269
RECALL 236, 322, 323, 467, 597, 613, 629,
635
forward-to number behaviour 9
USSD commands 635
RECALL voicemail 635
RECALL_CMD(n) 635
RECALL_EOS_LEN 480
RECALL_MEDIATOR_GT 480
RECALL_RES(n) 636
REG MASK 253
REG_ENQ_PFX 480
regional subscriptions. See home zone charging
REGISTER:SS 322
register_backup directory 680
register_backup_dir 118
REGISTERED location status 261
REGISTERED? 261
REGSSACTIONS 560
REGSUB 513
RELAYED_FAIL_TEXT 534, 541
RELAYED_TCPIP_USSD 535, 544
[RELAYED_USSD] section, USSD table 627
RELAYED_USSD 534, 538
Remote Engineer xviii, 80
account 80
logging off 81
logging on 80

Home Location Register (Linux) V1.1 Support Guide

Index

logins 80
main menu 81
when to use 97
REMOVE:BAR 437
REMOVE:CAMEL 373
REMOVE:MSISDN 282
REMOVE:OVERLAP 278
REMOVE:PDP 306
REMOVE:PNUM 418
REMOVE:SERVICE 312
REPLACE:OVERLAP 276
REPLACE:TABLE 461
REPLY TEXT 535, 543
REPLY_USSD 535, 542
RESET_V2 519
restart
automatic 105
PRODUCT application 115
restoring, PRODUCT database 118
RESTR 512
RESTRICTED 237
RESTRICTED_AREA 258
RETURN_FWD_VIOLATION 481
RN_PFX 516
ROAM_ODB 242, 254, 261
ROAM_ORB 517
ROAM_RESTRICT 199, 200
ROAM_STOPPED 242, 254, 261
ROAM_UNKSUB 517
ROAMED 513
roaming
access control while 63
ROAMING_NOT_ALLOWED 481
ROAMING_NUMBER_ENQUIRY_V2 519
ROAMING_NUMBER_ENQUIRY_V3 520
ROAMING_RELAY 516
ROAMING_RELAY_GT 482
ROAMTICK 222
ROLLBACK:SDM 423
ROUTE_ON_PC 517
ROUTING_INDICATOR 578
RR_UNSUPFEATURE 242, 254, 261
RSD 242, 248
RTIS 573
RTOSPBAR 617
RTSPB 57
RTTRACE 656

S
s7mp process 103
SAN 120, 130, 180, 191, 289, 294, 295
SAVED 119
SCCP address
destination 581
EIR 580, 581
formatted 578

to

713

source 580
unformatted 579
SCCP Relay 67, 269
[SCCPSEG] section, netent table 510, 521
SCCPSEG 512
screen definition files 569
sdfdir 75
SDFs 458, 569
generating 570
SDM
commands 419
SDM_CANCEL_SGSN 482
SDM_CANCEL_VLR 482
sdm_dest Table 529
SDM_HLR_PORT 482
SDM_HLR_TRANS_TIME 482
SDM_HLR_UPD_TIME 482
SDM_PROC_SRN 483
SDM_RELAY_PORT 483
SDM_RELAY_UPD_TIME 483
SDM_REPS 483
SDM_STOP 185
SDM_UPD_ALL_MASTERS 483
sdmdir 75
SE_CAMEL 9, 253
SE_FLAGS 253
SE_FTN_PFX 483
SE_ONLY 9, 253
secure to disk 586
SEND_FAIL 252
SEND_RC 503
SEP 56, 57, 58, 67
and CAMEL 13
linked subscriptions 4, 30
PAYT roaming 17, 27
sequence number, authentication 200
SERV_CEN_COUNT 253
service access number 120, 130
service commands
basic 309
supplementary 315
service execution point. See SEP
service provider
USSD enquiry 58
service provider bar, routing calls 56
service provider enquiry USSD, signalling 58,
59
service provider identity 533
service provider information, retrieval
USSD 637
service provider information, USSDs 637
service provider services 56
service provider voicemail identifier 533
service provider, signalling for short code
dialling 57, 58
service request number 130

Home Location Register (Linux) V1.1 Support Guide

714

commands 289
viewing 130
service switching function, and CAMEL
signalling 13
SERVICE_CENTRE 433
SERVICE_KEY 380, 384, 387, 389, 392, 394,
396, 399, 401, 404
SERVICE_KEY, CAMEL 333
SERVICES 234
services
basic 591
call forwarding 7, 10
CAMEL 13, 28
GPRS 29
home zone charging 33, 35
linked subscriptions 31
location based 36, 39
location based, signalling 3
mobile number portability 40, 44, 45
supplementary 594
Vodafone CAMEL 17, 18
services. See network services
serving GPRS support node 29, 67
SET
DATABASE 432
SET:CAMEL 362
SET:MWD 433
SET:PDP 300
SET:TRACE 269
setting time and date 129
SG mode 168
SGSN 29, 67, 199, 217, 223, 239, 240, 248,
253, 254, 262, 302, 306, 428
last operation 254
location status 254
suspect bit 254
timestamp 254
SGSN CAMEL support, effect on services 22
SGSN, CAMEL support 22
SGSN_ALG_LIST 483
SGSN_DIS_ENC 484
SGSNs
CAMEL support 22
short code dialling a service provider,
signalling 57, 58
short message service. See SMS
SHORT_MSG_ALERT_V2 520
SHORT_MSG_GATEWAY_V2 520
SHORT_MSG_GATEWAY_V3 520
SHORT_MSG_MO_RELAY_V2 520
SHORT_MSG_MT_RELAY_V2 520
show
destination status 114
M3UA association 106
platform availability report 127
software install history 126

to

Index

shrdir 75
signalling 574
signalling gateway mode 111, 168
signalling, CAMEL 18, 20
signalling, home zone charging 34
signalling, network 3, 4
signalling, service provider enquiry USSD 58,
59
signalling, short code dialling a service
provider 57, 58
signalling, SMS and message waiting data for
migrated subscribers 43
signalling, subscribers migrated to another
network 41
signalling, subscribers migrated to Vodafone 42
signalling, voicemail personalization 59
SIGTRAN 167, 517
configuration 167
network connection failure 91
updating configuration 173
SIGTRAN layers 167
SIGTRAN processes 168
SIM 190, 198, 200, 203, 217, 220, 273
SIM ID 255
SIM identity, linked subscriptions 642
SIM, linked subscriptions 30
SIM, providing new 273
SIM, test 99
SIM_ID 219
SIMID 200
SIMTYPE 200
SINGLE_DB_ IGNORE_GT 526
SINGLE_GT_CALLING 484
SINGLE_GT_HLR_NUMBER 484
SKE 5, 200, 266, 508
SLPP 37, 39, 221
SM_EXPIRED 508
SMS 199, 200, 219, 223, 240, 591, 597, 611,
630
CAMEL phase 3 16
CAMEL phase 4 16
CAMEL trigger detection point 339
event logging example 677
linked subscriptions 31
premium rate. See access control
prepay signalling 51
SMS barring 649, 651
See also specific ODBs
SMS barring responses 530
SMS bureau service 628
SMS bureau service, enabling and
disabling 628
SMS Routing/Delivery Reports 124
SMS, retrieving MSISDN for 630
SMS, signalling for subscribers who migrate to or
from Vodafone 43

Home Location Register (Linux) V1.1 Support Guide

Index

SMS_REALTIME_BILLING 484
SMSB 322, 323, 467, 597, 614, 629
SMSB supplementary service 316
SMSB, call forward behaviour 236
SMSB_FAIL_TEXT 629
SMSB_NO_SMS_BS 629
SMSB_OFF_CMD 629
SMSB_OFF_TEXT 629
SMSB_ON_CMD 629
SMSB_ON_TEXT 629
SMSB_OPERATOR_NUM 484
SMSB_PREFIX 484
SMSB_SHORT_CODE 484
smsbar table 529
smsbar_resp table 530
SMSC 67
SN 685
SN_QUINTUPLETS 484
SNMP Agent 69
snmp processes 103
snmpd 69
SNP 242
Soft SDM 185
software
displaying versions 125
install history 126
start-up failure 88
versions 125
solving problems 97
SP identity 533
sp table 532
SP voicemail identifier 533
SPCODE 222
SPEECH 219, 591, 611
SPEECH, retrieving MSISDNs 630
SPINFO_CMD 637
SPINFO_FAIL_TEXT 637
SPINFO_OK_TEXT 637
SQN 200
SQN_DEC 485
SQN_INC_LARGE 485
SQN_INC_SMALL 485
SQN_RESET 485
SRI_RESTORATION 485
SRIACTIONS 560
SRISM, event logging 677, 678
SRN 130, 180, 269, 271, 290
viewing 130
SRN, and positioning services 643
ss comand 100
SS INDUCED 255
SS PROV 255
SS_CODE 355
SS_LIST 255
SS_MODE 322
SS7_EVENT_CFG.DAT 502

to

715

ss7cfg table 533


SS7I
logging failure to send 659
logging transactions 660
SS7I_LOG_MASK 524, 656
SS7I_UDFCFG_MASK 526
SS-CSI 15, 21
SSCSI 355
SSF, CAMEL signalling 13
SSN 513, 579
SSOP_RESULT 485
START 457
start-up log files 89
STATE, PDP context 302
statedir 75
status graphs 121, 122
stopping
PRODUCT 117
STRIP_C2 463
SUB RESTR 222
SUB_SS7 223, 269
SUB_SYSTEM 578
SUB_TRAN 223, 269
subscriber
commands 205
template 208
tracing 269
subscriber data move
commands 419
subscriber data move commands 419
subscriber data, summary 4
subscriber key encryption 5
subscriber location privacy profile. See SLPP
subscriber migration, SMS and message waiting
data signalling 43
SUBSCRIBER_DATA_MNGT_V2 520
SUBSCRIBER_DATA_MNGT_V3 520
SUBSCRIBER_INFO_ENQUIRY_V3 520
Subscribers 124
subscribers migrated away from Vodafone,
signalling 41
subscribers migrated to Vodafone, signalling 42
Subscribers with Failures 124
SUBSCRIPTION 273
subscription data, CAMEL 13
sub-system number 579
SUBTYPE 222, 316, 597, 613
summary alarms 136
supplementary service
commands 315
supplementary services 594
ARSENIC 8
support accounts, using 97
support levels xviii
SUSPECT_DELAY 485
SUSPECT_TRIES 485

Home Location Register (Linux) V1.1 Support Guide

716

synchronization
database 104
system
availability 127
date and time 129
status graphs 121, 122

T
table
hsscfg 495
table data
testing 458
updating 457
table maintenance commands 460
table view menu 131
tables
adm_client 463
ascvt 4, 465
backup 458
bca 465
bnum 466
changing 456
cnum 467
cnum_bhvr 469
hsscfg 495
instances 455
maintenance commands 460
mkey 508
msrnpfx 508
netent 509
PDS definitions 493
pds_config 523
product_config 471
sccpr_node 528
sp 532
timer 505, 507
tkey 508
updating 457
ussd 534
voicemail 560
TAC 685
TC_BEGIN, event logging 660
TCAP, logging decode failure 660
T-CSI 14, 21
TCSI_TDP 342
TDP 14, 255, 373, 379, 383
multiple 23
TDPs, interaction 23
TeMIP 85, 134
TEMPLATE 208
terminating calls
CAMEL TDP 342
test calls 99
[TEST DATA] section, MLR_NUMRANGE
table 498
[TEST DATA] section, netent table 509, 523

to

Index

test SIM 99
TEST, type of phone 215
TICK 222, 597, 613
CAMEL interaction 26
TICK supplementary service 316
TICK, CAMEL interaction 26
TICKROAM 17, 316, 597, 614
TIF-CSI 15, 381, 385
TIF-CSI, and Vodafone services 17
TIME 256
time and date, setting 129
time synchronization 583
TIME ZONE 256
time zone 239
TIME_CMD 638
TIME_FAIL_TEXT 638
TIME_TEXT 638
TIME_ZONE 488
TIMEOUT 463
TIMEOUT, location status 261
TIMEOUT, overlapping IMSI 274
TIMEOUT_ASC 486
TIMEOUT_BSA_OUT 486
TIMEOUT_CIC 486
TIMEOUT_CNL 486
TIMEOUT_DSD 486
TIMEOUT_FSM 486
TIMEOUT_GET 486
TIMEOUT_ISD 486
TIMEOUT_MOSS 487
TIMEOUT_MTSD 487
TIMEOUT_MTSS 487
TIMEOUT_PRN 487
TIMEOUT_PSI 487
TIMEOUT_SAI 487
TIMEOUT_SRI_OUT 487
TIMER 256, 322
timer table 505
TIMON 223, 269
TKEY 5, 131
tkey table 508
TMC 433
TMSI 687
TRACE 223
tracing
subscriber 269
TIMON 269
tracing, using UPDATE:SUB command 226
TRACING_V2 520
TRAN_LOG_MASK 524, 656
Transactions 124
TRANSFER_OF_SM 223
TRANSLATE 470
TRIG_A 316, 597, 613
TRIG_A_CALL_BAR_PFX 488
TRIG_A_FAIL_BEHAVIOUR 488

Home Location Register (Linux) V1.1 Support Guide

Index

TRIG_A_GT 488
TRIG_B 316, 598, 613
TRIG_B_CALL_BAR_PFX 488
TRIG_B_GT 488
TRIG_C 316, 467, 598, 614
TRIG_C_CALL_BAR_PFX 488
TRIG_C_GT 488
trigger detection point. See TDPs
trigger detection points, multiple 23
TSMS 517
TYPE, PDP context 303

U
UAL 26, 64
UAL, CAMEL support checking 26
UAL_RETRY 526
U-CSI 15, 534, 541
UDF event logging 660
UDT, logging illegal lengths 660
UG-CSI 15, 534, 542
UMTS 64, 193, 201
video telephony 64
UMTS_ALG_LIST 489
UMTS_ALGORITHM 489
UMTS_DIS_ENC 489
UNK_GPRS_SUB 199, 200
UNK_GSM_SUB 199, 200
UNKNOWN_IN_SGSN 254, 262
UNKNOWN_IN_VLR 242, 252, 262
UNKNOWN_TEXT 638
UNLOCK:SUB 214
UNREST 219, 593, 611
UNSUP_POS 262
UNSUP_SVC_RESTR 262
UNSUPP BS 257
UNSUPP ODB 257
UNSUPP SS 257
UNSUPP_AC 513, 518
UNSUPP_BS 513
UNSUPP_CAMEL 513
UNSUPP_ODB 513
UNSUPP_SERV 513
UNSUPP_SS 513
unsupported application context learning 26,
64, 526
unsupported application context learning. See
UAL
update location 3
UPDATE:CAMEL 375
UPDATE:IMEI 441
UPDATE:LCN 443
UPDATE:LOCATION 445
UPDATE:MSISDN 284
UPDATE:PDP 302
UPDATE:SIM 198
UPDATE:SRN 292

to

717

UPDATE:SUB 215
UPDATE:ZONELIST 228
updating tables 457
UPL 242, 596
user access 79
User Manager 80
USIM 198, 200
USSD
location based services 38
MultiSIM 638
ussd
table 534
USSD service provider enquiry, signalling 58
USSD table
ASP section 535, 545
CVT_RESP section 535, 549
CVT_USSD section 535, 547
FORWARD_FAIL_TEXT section 534, 540
FORWARD_USSD section 534, 535
GT_NAME section 534, 543
PROCESSED_USSD section 534, 538
RANGE section 534, 544
RELAYED_FAIL_TEXT section 534, 541
RELAYED_TCPIP_USSD section 535, 544
RELAYED_USSD section 534, 538
REPLY_TEXT section 535, 543
REPLY_USSD section 535, 542
U-CSI section 534, 541
UG-CSI section 534, 542
ussd table 5, 534
USSD_CODE 257
USSDs 627
bureau service 628
call transfer 642
calling line identity restriction 632
CAMEL phase 2 15
Chameleon commands 646
last caller information 630
linked subscription 30
location information 637
missed call server commands 645
MSISDN retrieval 629
MVPN services 646
NGVM Phase 1a services 640
NGVM Phase 1b services 644
on-net/off-net information 638
operation and maintenance information 637
PAYT 643
positioning services 643
processed by the PRODUCT 628
processed outside the PRODUCT 642
service provider enquiry 58
service provider information 637
voicemail 635

Home Location Register (Linux) V1.1 Support Guide

718

V
V2_AND_ABOVE application context 520
V3 PSI AGE 257
V3 PSI CELLID 257
V3 PSI GEO INFO 257
V3 PSI LAI 257
V3 PSI NR REASON 258
V3 PSI SUB STATE 258
V3_AND_ABOVE application context 520
VERIFY:TABLE 462
VIA_MSC 223
VIA_SGSN 223
video telephony 64
See also BS30_ASSUME_VT 472
VIEW:INFO 448
VIEW:MSISDN 286
VIEW:NETWORK 409
VIEW:SRN 294
VIEW:SUB 231
VIEW_TIMEOUT 526
viewing
configuration tables 131
event log files 95
VLR 258, 648
VLR CAMEL support, effect on services 22
VLR TITLE 258
VLR, CAMEL support 22
VLR, name retrieval 637
VLR, reset subscribers 430
VLR_BLACK, PSI_STATUS 252
VLR_DIS_ENC 489
VLR_ID_CMD 637
VLR_ID_FAIL_TEXT 637
VLR_ID_TEXT 637
VLR_TRIPLETS 489
VLRs
CAMEL support 22
VLRs, influence on diverts 8
VM 518
VMSC 258
VMSC and CAMEL 17
VMSC and PAYT roaming 27
VMSC triggered CAMEL 348
VMTYPE 224
vmtype 562, 564
VODACAT 413, 518
VODACPC 518
Vodafone, CAMEL services 17, 18
VodaSCP
platform software 72
setting time 583
voicemail 226
voicemail personalization, signalling 59, 60
voicemail table 560
Voicemail Type Indicator 560
voicemail, USSDs 635

to

Index

VPLMN allowed, GPRS APN 258


VPN 381, 385
VT-CSI 16, 21
VTCSI_TDP 348

W
WITHDRAW:SS 320
working directory, tables 454

X
XAM 104, 116

Y
YIELD_TO_SLAVE_ LIMIT 526

Z
ZONE CODE 258
zones. See home zones

Home Location Register (Linux) V1.1 Support Guide

25

Readers Comments
Our aim at Vodafone is to supply you with high quality documentation which meets your
needs. To help us achieve this, please complete this form and return it to us if you have any
corrections, observations, or suggestions for improvements to this document.
Thank you for your help.
Name:

Department:

Company:

Date:

Address:
Tel:
Email Address:

Please rate this document for:

Excellent

Good

Fair

Poor

Accuracy does the product work as described?


Completeness does it provide sufficient information?
Clarity is the information easy to understand?
Organisation is it well-structured and easy to follow?
Figures are there enough and are they useful?
Examples are there enough and are they useful?
Layout does the page layout make it easy to use?

Have you discovered any errors in this document? Please describe below:
Page

Description

(Please turn over)

Home Location Register (Linux) V1.1 Support Guide


Vodafone Group. C2 Company Confidential

26

Readers Comments

Do you have any additional comments or suggestions to improve this document? (Please
continue on a separate sheet if necessary):

Please return this form to:


Technical Authors
Technology Information Systems
Faraday House
The Connection
Newbury
Berkshire,
RG14 2FN,
England
Fax: +44 (0)1635 686486
Email: Documentation Development@vodafone.com

Home Location Register (Linux) V1.1 Support Guide


Vodafone Group. C2 Company Confidential

Das könnte Ihnen auch gefallen